SCPY - Functional library for SDMA resources

Functions
void	SCPY_init ()
	SCPY initialization API.
void	SCPY_exit ()
	SCPY finalization API.
void	SCPY_configure (IRES_SDMA_Handle logicalChannel, SCPY_Params *params)
	Configures transfer on a particular logical handle.
void	SCPY_start (IRES_SDMA_Handle logicalChannel)
	Starts a transfer previously configured on a channel.
void	SCPY_wait (IRES_SDMA_Handle logicalChannel)
	Wait for the transfer to complete.
Bool	SCPY_complete (IRES_SDMA_Handle logicalChannel)
	Returns status of transfer on the logical channel.
Defines
#define	OMAP_DMA_DATA_TYPE_S8   0x00
#define	OMAP_DMA_DATA_TYPE_S16   0x01
#define	OMAP_DMA_DATA_TYPE_S32   0x02
#define	OMAP_DMA_PORT_EMIFF   0x00
#define	OMAP_DMA_AMODE_POST_CONST   0x00
#define	OMAP_DMA_AMODE_POST_INC   0x01
#define	OMAP_DMA_AMODE_POST_SINGLE_INDEX   0x02
#define	OMAP_DMA_AMODE_POST_DOUBLE_INDEX   0x03
#define	OMAP_DMA_SYNC_MODE_ELEMENT   0x00
	To identify mode of sychronization of transfer.
#define	OMAP_DMA_SYNC_MODE_FRAME   0x01
#define	OMAP_DMA_SYNC_MODE_BLOCK   0x02
#define	OMAP_DMA_SYNC_TYPE_DEST   0x00
#define	OMAP_DMA_SYNC_TYPE_SRC   0x01
Data Structures
struct	SCPY_AddrParams
	Parameters of Address (source or destination) of transfer. More...
struct	SCPY_TransferParams
	Details of Transfer. More...
struct	SCPY_Params
Typedefs
typedef struct SCPY_AddrParams	SCPY_AddrParams
	Parameters of Address (source or destination) of transfer.
typedef struct SCPY_TransferParams	SCPY_TransferParams
	Details of Transfer.
typedef struct SCPY_Params	SCPY_Params

---

Detailed Description

The SCPY module provides a list of SDMA operations an algorithm can perform on logical SDMA channels it acquires through the IRES_SDMA protocol. Examples of SCPY operations include channel configuration, SDMA transfer scheduling, and SDMA transfer synchronization.

---

Function Documentation

void SCPY_init

(

)

SCPY initialization API.

void SCPY_exit

(

)

SCPY finalization API.

void SCPY_configure	(	IRES_SDMA_Handle	logicalChannel,
		SCPY_Params *	params
	)

Configures transfer on a particular logical handle.

Parameters:

[in]	logicalChannel	Handle to the logical channel on which transfer will be configured
[in]	params	Params to describe the transfer, src/dst addresses, sychronization mode, transfer dimensions etc.

void SCPY_start

(

IRES_SDMA_Handle

logicalChannel )

Starts a transfer previously configured on a channel.

Parameters:

[in]

logicalChannel

Previously configured logical channel on which to start the transfer.

void SCPY_wait

(

IRES_SDMA_Handle

logicalChannel )

Wait for the transfer to complete.

Parameters:

[in]

logicalChannel

Logical channel on which transfer is ongoing.

Bool SCPY_complete

(

IRES_SDMA_Handle

logicalChannel )

Returns status of transfer on the logical channel.

Parameters:

[in]

logicalChannel

Logical channel on which transfer is ongoing.

Return values:

TRUE	Transfer completed
FALSE	Transfer in progress

---

Define Documentation

#define OMAP_DMA_DATA_TYPE_S8   0x00

#define OMAP_DMA_DATA_TYPE_S16   0x01

#define OMAP_DMA_DATA_TYPE_S32   0x02

#define OMAP_DMA_PORT_EMIFF   0x00

#define OMAP_DMA_AMODE_POST_CONST   0x00

#define OMAP_DMA_AMODE_POST_INC   0x01

#define OMAP_DMA_AMODE_POST_SINGLE_INDEX   0x02

#define OMAP_DMA_AMODE_POST_DOUBLE_INDEX   0x03

#define OMAP_DMA_SYNC_MODE_ELEMENT   0x00

To identify mode of sychronization of transfer.

#define OMAP_DMA_SYNC_MODE_FRAME   0x01

#define OMAP_DMA_SYNC_MODE_BLOCK   0x02

#define OMAP_DMA_SYNC_TYPE_DEST   0x00

#define OMAP_DMA_SYNC_TYPE_SRC   0x01

---

Typedef Documentation

typedef struct SCPY_AddrParams SCPY_AddrParams

Parameters of Address (source or destination) of transfer.

typedef struct SCPY_TransferParams SCPY_TransferParams

Details of Transfer.

typedef struct SCPY_Params SCPY_Params