HDVICPSYNC

Data Structures
struct	HDVICPSYNC_Params
	The module configuration structure for HDVICPSYNC implementation. More...
Defines
#define	HDVICPSYNC_GTNAME   "ti.sdo.fc.hdvicpsync"
	Name to identify the GT module.
Enumerations
enum	HDVICPSYNC_InterruptType {   HDVICPSYNC_IRQ,   HDVICPSYNC_FIQ }
	Interrupt type that can be specified for each Resource type. More...
enum	HDVICPSYNC_Status {   HDVICPSYNC_OK,   HDVICPSYNC_EFAIL,   HDVICPSYNC_ENORESOURCE }
Functions
HDVICPSYNC_Status	HDVICPSYNC_start (IALG_Handle handle, HDVICPSYNC_InterruptType intType, IRES_HDVICP_Handle hdvicpHandle)
	This function is used to mark the beginning of HDVICP coprocessor usage by the algorithm.
HDVICPSYNC_Status	HDVICPSYNC_wait (IRES_HDVICP_Handle hdvicpHandle)
	This is the top level function that allows the ARM-side algorithm to wait for the Kaleido (frame) interrupt to fire.
HDVICPSYNC_Status	HDVICPSYNC_unregister (IRES_HDVICP_Handle hdvicpHandle)
	This is the top level function that allows the ARM-side algorithms to explicitly unregister a particular interrupt handler for ISRS registerd via a call to HDVICPSYNC_start API.
Bool	HDVICPSYNC_done (IRES_HDVICP_Handle hdvicpHandle)
	This is the top level function that allows the ARM-side algorithm to return a status indicating if a Kaleido interrupt has fired (frame has been processed) since HDVICPSYNC_start was called.
Variables
HDVICPSYNC_Params	HDVICPSYNC_PARAMS
	Default module configuration structure (defined in hdvicpsync.c).

---

Detailed Description

HDVICPSYNC provides framework support for synchronization between codec and HDVICP coprocessor usage. This module is used by frameworks or applications which have xDAIS algorithms that use HDVICP hardware accelerators.

---

Define Documentation

#define HDVICPSYNC_GTNAME   "ti.sdo.fc.hdvicpsync"

Name to identify the GT module.

---

Enumeration Type Documentation

enum HDVICPSYNC_InterruptType

Interrupt type that can be specified for each Resource type.

Enumerator:

HDVICPSYNC_IRQ	Regular Interrupt Request
HDVICPSYNC_FIQ	Fast Interrupt Request

enum HDVICPSYNC_Status

Enumerator:

HDVICPSYNC_OK	Success
HDVICPSYNC_EFAIL	general failure
HDVICPSYNC_ENORESOURCE	resources not owned to be able to configure the interrupt

---

Function Documentation

HDVICPSYNC_Status HDVICPSYNC_start	(	IALG_Handle	handle,
		HDVICPSYNC_InterruptType	intType,
		IRES_HDVICP_Handle	hdvicpHandle
	)

This function is used to mark the beginning of HDVICP coprocessor usage by the algorithm.

Parameters:

	handle	Algorithm handle
	intType	Interrupt Type
	hdvicpHandle	Pointer to the hdvicp handle.

Returns:

none

Note:

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

HDVICPSYNC_Status HDVICPSYNC_wait

(

IRES_HDVICP_Handle

hdvicpHandle

)

This is the top level function that allows the ARM-side algorithm to wait for the Kaleido (frame) interrupt to fire.

Parameters:

hdvicpHandle

void pointer to the hdvicp handle.

Returns:

none

Note:

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

HDVICPSYNC_Status HDVICPSYNC_unregister

(

IRES_HDVICP_Handle

hdvicpHandle

)

This is the top level function that allows the ARM-side algorithms to explicitly unregister a particular interrupt handler for ISRS registerd via a call to HDVICPSYNC_start API.

Parameters:

hdvicpHandle

void pointer to the hdvicp handle.

Returns:

HDVICPSYNC_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 HDVICPSYNC_done

(

IRES_HDVICP_Handle

hdvicpHandle

)

This is the top level function that allows the ARM-side algorithm to return a status indicating if a Kaleido interrupt has fired (frame has been processed) since HDVICPSYNC_start was called.

Parameters:

hdvicpHandle

void pointer to the hdvicp handle.

Returns:

none

Note:

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

---

Variable Documentation

HDVICPSYNC_Params HDVICPSYNC_PARAMS

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