Functions
VICPSYNC_Status	VICPSYNC_start (IALG_Handle handle, VICPSYNC_ResourceType res, VICPSYNC_InterruptType intType, VICPSYNC_InterruptLine intLine, IRES_VICP2_Handle vicpHandle)
	This is the top level function that allows ARM-side algorithms to mark beginning of the usage of individual functional units of VICP.
VICPSYNC_Status	VICPSYNC_wait (IRES_VICP2_Handle vicpHandle, VICPSYNC_ResourceType res)
	This is the top level function that allows the ARM-side algorithms to wait for interrupt corresponding to the functional unit of the VICP to fire.
Bool	VICPSYNC_done (IRES_VICP2_Handle vicpHandle, VICPSYNC_ResourceType res)
	This is the top level function that allows the ARM-side algorithms to query the status of the interrupt corresponding to the functional unit that was configured using VICPSYNC_start call.
VICPSYNC_Status	VICPSYNC_unregister (IRES_VICP2_Handle vicpHandle, VICPSYNC_ResourceType res)
	This is the top level function that allows the ARM-side algorithms to unregister the ISR associated with the VICP resource that may have been previously registered via a call to VICPSYNC_start.
Defines
#define	VICPSYNC_GTNAME "ti.sdo.fc.vicpsync"
Data Structures
struct	VICPSYNC_Params
	The module configuration structure for VICPSYNC implementation. More...
Typedefs
typedef struct VICPSYNC_Params	VICPSYNC_Params
	The module configuration structure for VICPSYNC implementation.
typedef enum VICPSYNC_ResourceType	VICPSYNC_ResourceType
	Resource types for which the API can be called.
typedef enum VICPSYNC_InterruptLine	VICPSYNC_InterruptLine
	Interrupt line that can be specified for each Resource type.
typedef enum VICPSYNC_InterruptType	VICPSYNC_InterruptType
	Interrupt type that can be specified for each Resource type.
typedef enum VICPSYNC_Status	VICPSYNC_Status
Enumerations
enum	VICPSYNC_ResourceType { VICPSYNC_IMX0, VICPSYNC_IMX1, VICPSYNC_MJCP, VICPSYNC_NSF }
	Resource types for which the API can be called. More...
enum	VICPSYNC_InterruptLine { VICPSYNC_FIXED, VICPSYNC_FLEXIBLE }
	Interrupt line that can be specified for each Resource type. More...
enum	VICPSYNC_InterruptType { VICPSYNC_IRQ, VICPSYNC_FIQ }
	Interrupt type that can be specified for each Resource type. More...
enum	VICPSYNC_Status { VICPSYNC_OK, VICPSYNC_EFAIL, VICPSYNC_ENORESOURCE }
Variables
VICPSYNC_Params	VICPSYNC_PARAMS
	Default module configuration structure (defined in vicpsync.c)

Detailed Description

This module is used by frameworks or applications which have xDAIS algorithms that use VICP hardware accelerators.

Function Documentation

VICPSYNC_Status VICPSYNC_start	(	IALG_Handle	handle,
		VICPSYNC_ResourceType	res,
		VICPSYNC_InterruptType	intType,
		VICPSYNC_InterruptLine	intLine,
		IRES_VICP2_Handle	vicpHandle
	)

This is the top level function that allows ARM-side algorithms to mark beginning of the usage of individual functional units of VICP.

Parameters:

handle	Algorithm handle
res	Particular function unit of the VICP to configure
intType	Type of interrupt (FIQ/IRQ) to configure
intLine	Interrupt line to use (Fixed/Flexible)
vicpHandle	void pointer to the vicp handle.

Returns:: VICPSYNC_Status Returns status of this call.

Note:: This function will be called from the algorithm but the implementation will lie in the application.

VICPSYNC_Status VICPSYNC_wait	(	IRES_VICP2_Handle	vicpHandle,
		VICPSYNC_ResourceType	res
	)

This is the top level function that allows the ARM-side algorithms to wait for interrupt corresponding to the functional unit of the VICP to fire.

Parameters:

vicpHandle	void pointer to the vicp handle.
res	Particular function unit of the VICP that has been configured to respond to interrupt.

Returns:: VICPSYNC_Status Returns status of this call

Note:: As per XDM, this function will be called from the algorithm but the implementation will lie in the application.

Bool VICPSYNC_done	(	IRES_VICP2_Handle	vicpHandle,
		VICPSYNC_ResourceType	res
	)

This is the top level function that allows the ARM-side algorithms to query the status of the interrupt corresponding to the functional unit that was configured using VICPSYNC_start call.

Parameters:

vicpHandle	void pointer to the vicp handle.
res	Particular functional unit of the VICP to query for status of interrupt.

Returns:: Bool value indicating if the interrupt has fired yet.

Note:: As per XDM, this function will be called from the algorithm but the implementation will lie in the application.

VICPSYNC_Status VICPSYNC_unregister	(	IRES_VICP2_Handle	vicpHandle,
		VICPSYNC_ResourceType	res
	)

This is the top level function that allows the ARM-side algorithms to unregister the ISR associated with the VICP resource that may have been previously registered via a call to VICPSYNC_start.

Parameters: