VICP Manager

---

Detailed Description

This is the API for the VICP Manager.

Defines
#define	VICP_VERSION   0x01000000
Enumerations
enum	VICP_Status {   VICP_OK = 0,   VICP_EFAIL,   VICP_ENOCHANNEL,   VICP_ENOINIT }
	Status codes for VICP API return values. More...
enum	VICP_ResourceType {   VICP_IMX0,   VICP_IMX1,   VICP_MJCP,   VICP_NSF,   VICP_HDVICP0,   VICP_HDVICP1 }
	Resource types to be used for all APIs. More...
enum	VICP_InterruptLine {   VICP_FIXED,   VICP_FLEXIBLE }
	Source of VICP resource interrupt. More...
enum	VICP_InterruptType {   VICP_IRQ,   VICP_FIQ }
	Type of ARM interrupt support. More...
Functions
int	VICP_init (void)
	VICP initialization API.
int	VICP_exit (void)
	VICP finalization API.
VICP_Status	VICP_register (VICP_ResourceType resource, VICP_InterruptLine intrLine, VICP_InterruptType intrType)
	Registers resource with requested interrupt type.
VICP_Status	VICP_unregister (VICP_ResourceType resource)
	Frees previously requested resource.
VICP_Status	VICP_wait (VICP_ResourceType resource)
	Waits for the transfer corresponding to this resource to complete.
VICP_Status	VICP_done (VICP_ResourceType resource, int *done)
	Checks if the transfer corresponding to this resource is complete.

---

Define Documentation

#define VICP_VERSION   0x01000000

---

Enumeration Type Documentation

enum VICP_Status

Status codes for VICP API return values.

Enumerator:

VICP_OK	OK
VICP_EFAIL	general failure
VICP_ENOCHANNEL	no channels available
VICP_ENOINIT	VICP_init() not called

enum VICP_ResourceType

Resource types to be used for all APIs.

Enumerator:

VICP_IMX0
VICP_IMX1
VICP_MJCP
VICP_NSF
VICP_HDVICP0
VICP_HDVICP1

enum VICP_InterruptLine

Source of VICP resource interrupt.

Remarks:

VICP_FIXED tells the IRQ driver to use the interrupt that's dedicated for use with the particular VICP_ResourceType.

VICP_FLEXIBLE tells the IRQ driver to use the "flexible" VICP interrupt, which can be driven by all VICP_ResourceType except VICP_MJCP.

Enumerator:

VICP_FIXED
VICP_FLEXIBLE

enum VICP_InterruptType

Type of ARM interrupt support.

Enumerator:

VICP_IRQ
VICP_FIQ

---

Function Documentation

int VICP_init

(

void

)

VICP initialization API.

int VICP_exit

(

void

)

VICP finalization API.

VICP_Status VICP_register	(	VICP_ResourceType	resource,
		VICP_InterruptLine	intrLine,
		VICP_InterruptType	intrType
	)

Registers resource with requested interrupt type.

VICP_Status VICP_unregister

(

VICP_ResourceType

resource

)

Frees previously requested resource.

VICP_Status VICP_wait

(

VICP_ResourceType

resource

)

Waits for the transfer corresponding to this resource to complete.

VICP_Status VICP_done	(	VICP_ResourceType	resource,
		int *	done
	)

Checks if the transfer corresponding to this resource is complete.

---

Copyright 2009, Texas Instruments Incorporated