VICPSYNC

Data Structures
struct	VICPSYNC_Params
	The module configuration structure for VICPSYNC implementation. More...
Defines
#define	VICPSYNC_GTNAME   "ti.sdo.fc.vicpsync"
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 }
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.
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.

---

Define Documentation

#define VICPSYNC_GTNAME   "ti.sdo.fc.vicpsync"

Name to identify the GT module

---

Enumeration Type Documentation

enum VICPSYNC_ResourceType

Resource types for which the API can be called.

Enumerator:

VICPSYNC_IMX0
VICPSYNC_IMX1
VICPSYNC_MJCP
VICPSYNC_NSF

enum VICPSYNC_InterruptLine

Interrupt line that can be specified for each Resource type.

Enumerator:

VICPSYNC_FIXED	Use dedicated line for this resource
VICPSYNC_FLEXIBLE	Use generic interrupt line for this resource

enum VICPSYNC_InterruptType

Interrupt type that can be specified for each Resource type.

Enumerator:

VICPSYNC_IRQ	Regular Interrupt Request
VICPSYNC_FIQ	Fast Interrupt Request

enum VICPSYNC_Status

Enumerator:

VICPSYNC_OK	Success
VICPSYNC_EFAIL	general failure
VICPSYNC_ENORESOURCE	resources not owned to be able to configure this interrupt

---

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:

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

Returns:

VICPSYNC_Status Returns status of this call.

---

Variable Documentation

VICPSYNC_Params VICPSYNC_PARAMS

Default module configuration structure (defined in vicpsync.c).