MTB CAT5 Peripheral driver library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Typedefs | Functions
Functions
DMAC (Direct Memory Access Controller)

General Description

Typedefs

typedef void(* BTSS_DMAC_CALLBACK_t )(void *arg)
 Callback func is called when a DMA transfer has completed. More...
 

Functions

UINT8 btss_dmac_init (void)
 Function btss_dmac_init. More...
 
UINT8 btss_dmac_getAppFirstChannel (void)
 Function btss_dmac_getAppFirstChannel. More...
 
void btss_dmac_setPeripheralDMACSync (UINT8 signal, BOOL32 sync_not_required)
 Function btss_dmac_setPeripheralDMACSync. More...
 
BOOL32 btss_dmac_requestTransfer (BTSS_DMAC_APP_REQUEST_t *dmaReq)
 Function btss_dmac_requestTransfer. More...
 
void btss_dmac_killTransfer (BTSS_DMAC_APP_REQUEST_t *dmaReq)
 Function btss_dmac_killTransfer. More...
 
void btss_dmac_dmaReqSetSrc (BTSS_DMAC_APP_REQUEST_t *dmaReq, UINT32 src)
 Function btss_dmac_dmaReqSetSrc. More...
 
void btss_dmac_dmaReqSetDst (BTSS_DMAC_APP_REQUEST_t *dmaReq, UINT32 dst)
 Function btss_dmac_dmaReqSetDst. More...
 
void btss_dmac_dmaReqSetChannel (BTSS_DMAC_APP_REQUEST_t *dmaReq, UINT8 channel)
 Function btss_dmac_dmaReqSetChannel. More...
 
void btss_dmac_dmaReqSetLLI (BTSS_DMAC_APP_REQUEST_t *dmaReq, BTSS_DMAC_LLI_DESC_t *next_lli)
 Function btss_dmac_dmaReqSetLLI. More...
 
void btss_dmac_dmaReqSetControl (BTSS_DMAC_APP_REQUEST_t *dmaReq, BTSS_DMAC_CONTROL_REG_t control)
 Function btss_dmac_dmaReqSetControl. More...
 
void btss_dmac_dmaReqSetConfig (BTSS_DMAC_APP_REQUEST_t *dmaReq, BTSS_DMAC_CONFIG_REG_t config)
 Function btss_dmac_dmaReqSetConfig. More...
 
void btss_dmac_dmaReqSetLength (BTSS_DMAC_APP_REQUEST_t *dmaReq, UINT16 length)
 Function btss_dmac_dmaReqSetLength. More...
 
void btss_dmac_dmaReqSetCallback (BTSS_DMAC_APP_REQUEST_t *dmaReq, BTSS_DMAC_CALLBACK_t callback, void *arg)
 Function btss_dmac_dmaReqSetCallback. More...
 
BTSS_DMAC_REQ_STATUS_t btss_dmac_dmaReqGetStatus (BTSS_DMAC_APP_REQUEST_t *dmaReq)
 Function btss_dmac_dmaReqGetStatus. More...
 

Typedef Documentation

typedef void(* BTSS_DMAC_CALLBACK_t)(void *arg)

Callback func is called when a DMA transfer has completed.

Function Documentation

UINT8 btss_dmac_init ( void  )

Function btss_dmac_init.

Initialize BTSS DMAC

Parameters
none
Returns
First free DMA channel
UINT8 btss_dmac_getAppFirstChannel ( void  )

Function btss_dmac_getAppFirstChannel.

Get App usable DMA channel's starting number

Parameters
none
Returns
First free DMA channel
void btss_dmac_setPeripheralDMACSync ( UINT8  signal,
BOOL32  sync_not_required 
)

Function btss_dmac_setPeripheralDMACSync.

Enables or disables synchronization logic for the DMA request Use synchronization logic when the peripheral generating the DMA request runs on a different clock to the DMAC/CPU. For peripherals running on the same clock as DMAC, disabling the synchronization logic improves the DMA response time.

Parameters
[in]signal: DMA request signal
[in]sync_not_requiredFALSE - Enables sync, TRUE - Disables sync
Returns
none
BOOL32 btss_dmac_requestTransfer ( BTSS_DMAC_APP_REQUEST_t *  dmaReq)

Function btss_dmac_requestTransfer.

Posts DMA request to the DMAC HW.

Parameters
[in]dmaReq: DMA request input
Returns
1 - Success, 0 - Failure
void btss_dmac_killTransfer ( BTSS_DMAC_APP_REQUEST_t *  dmaReq)

Function btss_dmac_killTransfer.

Kill the requested DMA transfer

Parameters
[in]dmaReq: DMA request input
Returns
none
void btss_dmac_dmaReqSetSrc ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
UINT32  src 
)

Function btss_dmac_dmaReqSetSrc.

Sets the source address parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]src: Source address - Aligned to src transfer size parameter
Returns
none
void btss_dmac_dmaReqSetDst ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
UINT32  dst 
)

Function btss_dmac_dmaReqSetDst.

Sets the destination address parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]dst: Destination address
Returns
none
void btss_dmac_dmaReqSetChannel ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
UINT8  channel 
)

Function btss_dmac_dmaReqSetChannel.

Sets the channel parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]channel: DMA channel
Returns
none
void btss_dmac_dmaReqSetLLI ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
BTSS_DMAC_LLI_DESC_t *  next_lli 
)

Function btss_dmac_dmaReqSetLLI.

Sets the next linked DMA descriptor parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]next_lli: Next DMA descriptor
Returns
none
void btss_dmac_dmaReqSetControl ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
BTSS_DMAC_CONTROL_REG_t  control 
)

Function btss_dmac_dmaReqSetControl.

Sets the control register parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]control: DMA control register configuration
Returns
none
void btss_dmac_dmaReqSetConfig ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
BTSS_DMAC_CONFIG_REG_t  config 
)

Function btss_dmac_dmaReqSetConfig.

Sets the config register parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]config: DMA config register configuration
Returns
none
void btss_dmac_dmaReqSetLength ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
UINT16  length 
)

Function btss_dmac_dmaReqSetLength.

Sets the length parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]length: DMA transfer length
Returns
none
void btss_dmac_dmaReqSetCallback ( BTSS_DMAC_APP_REQUEST_t *  dmaReq,
BTSS_DMAC_CALLBACK_t  callback,
void *  arg 
)

Function btss_dmac_dmaReqSetCallback.

Sets the callback and arg parameter in dmaReq

Parameters
[in]dmaReq: DMA request input
[in]callback: Callback on completing DMA transfer
[in]arg: Argument to be passed back with callback
Returns
none
BTSS_DMAC_REQ_STATUS_t btss_dmac_dmaReqGetStatus ( BTSS_DMAC_APP_REQUEST_t *  dmaReq)

Function btss_dmac_dmaReqGetStatus.

Gets the status of DMAC transfer

Parameters
[in]dmaReq: DMA request input
Returns
none