SDMA Manager
Detailed Description
This is the API for the SDMA Manager.
Define Documentation
#define SDMA_VERSION 0x01010000U |
#define SDMA_IOCMAGIC 0x0000fb00 |
#define SDMA_IOCCMDMASK 0x000000ff |
#define SDMA_IOCREQUESTDMA 1 |
#define SDMA_IOCRELEASEDMA 2 |
#define SDMA_IOCWAITFORCOMPLETION 3 |
#define SDMA_IOCGETVERSION 4 |
Enumeration Type Documentation
Status codes for SDMA API return values.
- Enumerator:
SDMA_OK |
OK
|
SDMA_EFAIL |
general failure
|
SDMA_ENOCHANNEL |
no channels available
|
SDMA_ENOINIT |
SDMA_init() not called
|
Function Documentation
Returns available logical channels.
- Parameters:
-
| numChannels | number of requested channels. |
| chanArray | pointer to SDMA_ChannelDescriptor storage of sufficient size to hold numChannels descriptors. All structure array fields are filled by this API (in other words, no fields need to be filled by the caller prior to the call). |
- See also:
- SDMA_freeChannels()
Frees previously requested logical channels.
- Parameters:
-
| numChannels | number of requested channels. |
| chanArray | pointer to SDMA_ChannelDescriptor storage of sufficient size to hold numChannels descriptors. This will typically be the same pointer passed to SDMA_getChannels(). |
- See also:
- SDMA_getChannels()
Waits for the transfer corresponding to this descriptor to complete.
- Parameters:
-
| channel | pointer to the single channel for which to wait. |
- See also:
- SDMA_check()
Checks the status of the transfer corresponding to this descriptor and returns it in the *pcompleted field.
- Parameters:
-
| channel | pointer to single channel to check. |
| pcompleted | pointer to completion status. |
- See also:
- SDMA_wait()
int SDMA_getVersion |
( |
void |
|
) |
|
Retrieve version from SDMA driver.
- Returns:
- Installed SDMA driver's version number.
- Precondition:
- Must have called SDMA_init()