AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IDma.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2014-2015 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
25 #pragma once
26 
27 #ifndef AAX_IDMA_H
28 #define AAX_IDMA_H
29 
30 #include "AAX.h"
31 
32 
33 #ifndef AAX_DMA_API
34 # ifdef _MSC_VER
35 # define AAX_DMA_API __cdecl
36 # else
37 # define AAX_DMA_API
38 # endif
39 #endif // AAX_DMA_API
40 
52 class AAX_IDma
53 {
54 public:
55  enum EState
56  {
61  eState_Pending = 3
62  };
63 
64  // WARNING! These need to be kept in sync with the TI dMAX microcode EventType IDs!
70  enum EMode
71  {
73 
75  eMode_Gather = 10,
77 
78  };
79 
80 
81 public:
82  virtual ~AAX_IDma() {}
83 
85 
115  virtual int32_t AAX_DMA_API IsTransferComplete() = 0;
122  virtual AAX_Result AAX_DMA_API SetDmaState( EState iState ) = 0;
125  virtual EState AAX_DMA_API GetDmaState() const = 0;
130  virtual EMode AAX_DMA_API GetDmaMode() const = 0;
132 
133 
135 
148  virtual AAX_Result AAX_DMA_API SetSrc( int8_t * iSrc ) = 0;
151  virtual int8_t * AAX_DMA_API GetSrc() = 0;
160  virtual AAX_Result AAX_DMA_API SetDst( int8_t * iDst ) = 0;
163  virtual int8_t * AAX_DMA_API GetDst() = 0;
164 
172  virtual AAX_Result AAX_DMA_API SetBurstLength( int32_t iBurstLengthBytes ) = 0;
175  virtual int32_t AAX_DMA_API GetBurstLength() = 0;
188  virtual AAX_Result AAX_DMA_API SetNumBursts( int32_t iNumBursts ) = 0;
191  virtual int32_t AAX_DMA_API GetNumBursts() = 0;
199  virtual AAX_Result AAX_DMA_API SetTransferSize( int32_t iTransferSizeBytes ) = 0;
202  virtual int32_t AAX_DMA_API GetTransferSize() = 0;
204 
205 
207 
217  virtual AAX_Result AAX_DMA_API SetFifoBuffer( int8_t * iFifoBase ) = 0;
220  virtual int8_t * AAX_DMA_API GetFifoBuffer() = 0;
225  virtual AAX_Result AAX_DMA_API SetLinearBuffer( int8_t * iLinearBase ) = 0;
228  virtual int8_t * AAX_DMA_API GetLinearBuffer() = 0;
241  virtual AAX_Result AAX_DMA_API SetOffsetTable( const int32_t * iOffsetTable ) = 0;
244  virtual const int32_t * AAX_DMA_API GetOffsetTable() = 0;
251  virtual AAX_Result AAX_DMA_API SetNumOffsets( int32_t iNumOffsets ) = 0;
254  virtual int32_t AAX_DMA_API GetNumOffsets() = 0;
264  virtual AAX_Result AAX_DMA_API SetBaseOffset( int32_t iBaseOffsetBytes ) = 0;
267  virtual int32_t AAX_DMA_API GetBaseOffset() = 0;
275  virtual AAX_Result AAX_DMA_API SetFifoSize( int32_t iSizeBytes ) = 0;
278  virtual int32_t AAX_DMA_API GetFifoSize() = 0;
280 };
281 
282 
283 
284 #endif // AAX_IDMA_H
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:337
#define AAX_DMA_API
Definition: AAX_IDma.h:37
Cross-platform interface for access to the host's direct memory access (DMA) facilities.
Definition: AAX_IDma.h:53
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.
virtual int8_t *AAX_DMA_API GetDst()=0
Gets the address of the destination buffer.
virtual int32_t AAX_DMA_API GetBaseOffset()=0
Gets the relative base offset into the FIFO where transfers will begin.
virtual int32_t AAX_DMA_API GetTransferSize()=0
Gets the size of the whole transfer, in Bytes.
virtual int32_t AAX_DMA_API IsTransferComplete()=0
Query whether a transfer has completed.
virtual AAX_Result AAX_DMA_API SetDmaState(EState iState)=0
Sets the DMA State.
virtual AAX_Result AAX_DMA_API SetTransferSize(int32_t iTransferSizeBytes)=0
Sets the size of the whole transfer.
virtual int32_t AAX_DMA_API GetNumOffsets()=0
Gets the number of offets in the offset table.
virtual AAX_Result AAX_DMA_API SetNumOffsets(int32_t iNumOffsets)=0
Sets the number of offets in the offset table.
virtual int8_t *AAX_DMA_API GetLinearBuffer()=0
Gets the address of the linear buffer for the DMA transfer.
EState
Definition: AAX_IDma.h:56
@ eState_Complete
Definition: AAX_IDma.h:60
@ eState_Init
Definition: AAX_IDma.h:58
@ eState_Error
Definition: AAX_IDma.h:57
@ eState_Running
Definition: AAX_IDma.h:59
@ eState_Pending
Definition: AAX_IDma.h:61
virtual ~AAX_IDma()
Definition: AAX_IDma.h:82
virtual AAX_Result AAX_DMA_API SetDst(int8_t *iDst)=0
Sets the address of the destination buffer.
virtual AAX_Result AAX_DMA_API SetSrc(int8_t *iSrc)=0
Sets the address of the source buffer.
virtual AAX_Result AAX_DMA_API SetFifoSize(int32_t iSizeBytes)=0
Sets the size of the FIFO buffer, in bytes.
virtual AAX_Result AAX_DMA_API SetOffsetTable(const int32_t *iOffsetTable)=0
Sets the offset table for the DMA transfer.
virtual EMode AAX_DMA_API GetDmaMode() const =0
Inquire to find the mode of the DMA instance.
virtual int32_t AAX_DMA_API GetFifoSize()=0
Gets the size of the FIFO buffer, in bytes.
virtual const int32_t *AAX_DMA_API GetOffsetTable()=0
Gets the offset table for the DMA transfer.
virtual EState AAX_DMA_API GetDmaState() const =0
Inquire to find the state of the DMA instance.
virtual AAX_Result AAX_DMA_API SetBaseOffset(int32_t iBaseOffsetBytes)=0
Sets the relative base offset into the FIFO where transfers will begin.
virtual int32_t AAX_DMA_API GetBurstLength()=0
Gets the length of each burst.
virtual AAX_Result AAX_DMA_API PostRequest()=0
Posts the transfer request to the DMA server.
virtual AAX_Result AAX_DMA_API SetBurstLength(int32_t iBurstLengthBytes)=0
Sets the length of each burst.
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)
virtual int32_t AAX_DMA_API GetNumBursts()=0
Gets the number of bursts to perform before giving up priority to other DMA transfers.
virtual int8_t *AAX_DMA_API GetSrc()=0
Gets the address of the source buffer.
virtual int8_t *AAX_DMA_API GetFifoBuffer()=0
Gets the address of the FIFO buffer for the DMA transfer.
EMode
DMA mode IDs.
Definition: AAX_IDma.h:71
@ eMode_Burst
Burst mode (uncommon)
Definition: AAX_IDma.h:74
@ eMode_Error
Definition: AAX_IDma.h:72
@ eMode_Scatter
Scatter mode.
Definition: AAX_IDma.h:76
@ eMode_Gather
Gather mode.
Definition: AAX_IDma.h:75
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)