| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IDma.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2014-2015, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21
22#pragma once
23
24#ifndef AAX_IDMA_H
25#define AAX_IDMA_H
26
27#include "AAX.h"
28
29
30#ifndef AAX_DMA_API
31# ifdef _MSC_VER
32# define AAX_DMA_API __cdecl
33# else
34# define AAX_DMA_API
35# endif
36#endif // AAX_DMA_API
37
49 class AAX_IDma
50{
51 public:
52 enum EState
53 {
54 eState_Error = -1,
55 eState_Init = 0,
56 eState_Running = 1,
57 eState_Complete = 2,
58 eState_Pending = 3
59 };
60
61 // WARNING! These need to be kept in sync with the TI dMAX microcode EventType IDs!
67 enum EMode
68 {
69 eMode_Error = -1,
70
71 eMode_Burst = 6,
72 eMode_Gather = 10,
73 eMode_Scatter = 11,
74
75 };
76
77
78 public:
79 virtual ~AAX_IDma() {}
80
82
97 virtual AAX_Result AAX_DMA_API PostRequest() = 0;
112 virtual int32_t AAX_DMA_API IsTransferComplete() = 0;
119 virtual AAX_Result AAX_DMA_API SetDmaState( EState iState ) = 0;
122 virtual EState AAX_DMA_API GetDmaState() const = 0;
127 virtual EMode AAX_DMA_API GetDmaMode() const = 0;
129
130
132
145 virtual AAX_Result AAX_DMA_API SetSrc( int8_t * iSrc ) = 0;
148 virtual int8_t * AAX_DMA_API GetSrc() = 0;
157 virtual AAX_Result AAX_DMA_API SetDst( int8_t * iDst ) = 0;
160 virtual int8_t * AAX_DMA_API GetDst() = 0;
161
169 virtual AAX_Result AAX_DMA_API SetBurstLength( int32_t iBurstLengthBytes ) = 0;
172 virtual int32_t AAX_DMA_API GetBurstLength() = 0;
185 virtual AAX_Result AAX_DMA_API SetNumBursts( int32_t iNumBursts ) = 0;
188 virtual int32_t AAX_DMA_API GetNumBursts() = 0;
196 virtual AAX_Result AAX_DMA_API SetTransferSize( int32_t iTransferSizeBytes ) = 0;
199 virtual int32_t AAX_DMA_API GetTransferSize() = 0;
201
202
204
214 virtual AAX_Result AAX_DMA_API SetFifoBuffer( int8_t * iFifoBase ) = 0;
217 virtual int8_t * AAX_DMA_API GetFifoBuffer() = 0;
222 virtual AAX_Result AAX_DMA_API SetLinearBuffer( int8_t * iLinearBase ) = 0;
225 virtual int8_t * AAX_DMA_API GetLinearBuffer() = 0;
238 virtual AAX_Result AAX_DMA_API SetOffsetTable( const int32_t * iOffsetTable ) = 0;
241 virtual const int32_t * AAX_DMA_API GetOffsetTable() = 0;
248 virtual AAX_Result AAX_DMA_API SetNumOffsets( int32_t iNumOffsets ) = 0;
251 virtual int32_t AAX_DMA_API GetNumOffsets() = 0;
261 virtual AAX_Result AAX_DMA_API SetBaseOffset( int32_t iBaseOffsetBytes ) = 0;
264 virtual int32_t AAX_DMA_API GetBaseOffset() = 0;
272 virtual AAX_Result AAX_DMA_API SetFifoSize( int32_t iSizeBytes ) = 0;
275 virtual int32_t AAX_DMA_API GetFifoSize() = 0;
277};
278
279
280
281#endif // AAX_IDMA_H
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_DMA_API
#define AAX_DMA_API
Definition: AAX_IDma.h:34
AAX_IDma
Cross-platform interface for access to the host's direct memory access (DMA) facilities.
Definition: AAX_IDma.h:50
AAX_IDma::SetNumBursts
virtual AAX_Result AAX_DMA_API SetNumBursts(int32_t iNumBursts)=0
Sets the number of bursts to perform before giving up priority to other DMA transfers.
AAX_IDma::GetBaseOffset
virtual int32_t AAX_DMA_API GetBaseOffset()=0
Gets the relative base offset into the FIFO where transfers will begin.
AAX_IDma::GetLinearBuffer
virtual int8_t *AAX_DMA_API GetLinearBuffer()=0
Gets the address of the linear buffer for the DMA transfer.
AAX_IDma::GetTransferSize
virtual int32_t AAX_DMA_API GetTransferSize()=0
Gets the size of the whole transfer, in Bytes.
AAX_IDma::GetSrc
virtual int8_t *AAX_DMA_API GetSrc()=0
Gets the address of the source buffer.
AAX_IDma::IsTransferComplete
virtual int32_t AAX_DMA_API IsTransferComplete()=0
Query whether a transfer has completed.
AAX_IDma::SetDmaState
virtual AAX_Result AAX_DMA_API SetDmaState(EState iState)=0
Sets the DMA State.
AAX_IDma::SetTransferSize
virtual AAX_Result AAX_DMA_API SetTransferSize(int32_t iTransferSizeBytes)=0
Sets the size of the whole transfer.
AAX_IDma::GetNumOffsets
virtual int32_t AAX_DMA_API GetNumOffsets()=0
Gets the number of offets in the offset table.
AAX_IDma::SetNumOffsets
virtual AAX_Result AAX_DMA_API SetNumOffsets(int32_t iNumOffsets)=0
Sets the number of offets in the offset table.
AAX_IDma::EState
EState
Definition: AAX_IDma.h:53
AAX_IDma::eState_Complete
@ eState_Complete
Definition: AAX_IDma.h:57
AAX_IDma::eState_Init
@ eState_Init
Definition: AAX_IDma.h:55
AAX_IDma::eState_Error
@ eState_Error
Definition: AAX_IDma.h:54
AAX_IDma::eState_Running
@ eState_Running
Definition: AAX_IDma.h:56
AAX_IDma::eState_Pending
@ eState_Pending
Definition: AAX_IDma.h:58
AAX_IDma::~AAX_IDma
virtual ~AAX_IDma()
Definition: AAX_IDma.h:79
AAX_IDma::SetDst
virtual AAX_Result AAX_DMA_API SetDst(int8_t *iDst)=0
Sets the address of the destination buffer.
AAX_IDma::SetSrc
virtual AAX_Result AAX_DMA_API SetSrc(int8_t *iSrc)=0
Sets the address of the source buffer.
AAX_IDma::GetFifoBuffer
virtual int8_t *AAX_DMA_API GetFifoBuffer()=0
Gets the address of the FIFO buffer for the DMA transfer.
AAX_IDma::SetFifoSize
virtual AAX_Result AAX_DMA_API SetFifoSize(int32_t iSizeBytes)=0
Sets the size of the FIFO buffer, in bytes.
AAX_IDma::SetOffsetTable
virtual AAX_Result AAX_DMA_API SetOffsetTable(const int32_t *iOffsetTable)=0
Sets the offset table for the DMA transfer.
AAX_IDma::GetDmaMode
virtual EMode AAX_DMA_API GetDmaMode() const =0
Inquire to find the mode of the DMA instance.
AAX_IDma::GetOffsetTable
virtual const int32_t *AAX_DMA_API GetOffsetTable()=0
Gets the offset table for the DMA transfer.
AAX_IDma::GetDst
virtual int8_t *AAX_DMA_API GetDst()=0
Gets the address of the destination buffer.
AAX_IDma::GetFifoSize
virtual int32_t AAX_DMA_API GetFifoSize()=0
Gets the size of the FIFO buffer, in bytes.
AAX_IDma::GetDmaState
virtual EState AAX_DMA_API GetDmaState() const =0
Inquire to find the state of the DMA instance.
AAX_IDma::SetBaseOffset
virtual AAX_Result AAX_DMA_API SetBaseOffset(int32_t iBaseOffsetBytes)=0
Sets the relative base offset into the FIFO where transfers will begin.
AAX_IDma::GetBurstLength
virtual int32_t AAX_DMA_API GetBurstLength()=0
Gets the length of each burst.
AAX_IDma::PostRequest
virtual AAX_Result AAX_DMA_API PostRequest()=0
Posts the transfer request to the DMA server.
AAX_IDma::SetBurstLength
virtual AAX_Result AAX_DMA_API SetBurstLength(int32_t iBurstLengthBytes)=0
Sets the length of each burst.
AAX_IDma::SetLinearBuffer
virtual AAX_Result AAX_DMA_API SetLinearBuffer(int8_t *iLinearBase)=0
Sets the address of the linear buffer for the DMA transfer (usually the internal memory block)
AAX_IDma::GetNumBursts
virtual int32_t AAX_DMA_API GetNumBursts()=0
Gets the number of bursts to perform before giving up priority to other DMA transfers.
AAX_IDma::EMode
EMode
DMA mode IDs.
Definition: AAX_IDma.h:68
AAX_IDma::eMode_Burst
@ eMode_Burst
Burst mode (uncommon)
Definition: AAX_IDma.h:71
AAX_IDma::eMode_Error
@ eMode_Error
Definition: AAX_IDma.h:69
AAX_IDma::eMode_Scatter
@ eMode_Scatter
Scatter mode.
Definition: AAX_IDma.h:73
AAX_IDma::eMode_Gather
@ eMode_Gather
Gather mode.
Definition: AAX_IDma.h:72
AAX_IDma::SetFifoBuffer
virtual AAX_Result AAX_DMA_API SetFifoBuffer(int8_t *iFifoBase)=0
Sets the address of the FIFO buffer for the DMA transfer (usually the external memory block)