Camera_api

Functions
void	CameraReset (unsigned long ulBase)
void	CameraParamsConfig (unsigned long ulBase, unsigned long ulHSPol, unsigned long ulVSPol, unsigned long ulFlags)
void	CameraXClkConfig (unsigned long ulBase, unsigned long ulCamClkIn, unsigned long ulXClk)
void	CameraXClkSet (unsigned long ulBase, unsigned char bXClkFlags)
void	CameraDMAEnable (unsigned long ulBase)
void	CameraDMADisable (unsigned long ulBase)
void	CameraThresholdSet (unsigned long ulBase, unsigned long ulThreshold)
void	CameraIntRegister (unsigned long ulBase, void(*pfnHandler)(void))
void	CameraIntUnregister (unsigned long ulBase)
void	CameraIntEnable (unsigned long ulBase, unsigned long ulIntFlags)
void	CameraIntDisable (unsigned long ulBase, unsigned long ulIntFlags)
unsigned long	CameraIntStatus (unsigned long ulBase)
void	CameraIntClear (unsigned long ulBase, unsigned long ulIntFlags)
void	CameraCaptureStart (unsigned long ulBase)
void	CameraCaptureStop (unsigned long ulBase, tBoolean bImmediate)
void	CameraBufferRead (unsigned long ulBase, unsigned long *pBuffer, unsigned char ucSize)

Detailed Description

Function Documentation

void CameraBufferRead	(	unsigned long	ulBase,
		unsigned long *	pBuffer,
		unsigned char	ucSize
	)

Reads the camera buffer (FIFO)

Parameters

ulBase	is the base address of the camera module.
pBuffer	is the pointer to the read buffer
ucSize	specifies the size to data to be read

This function reads the camera buffer (FIFO).

Returns

None.

void CameraCaptureStart

(

unsigned long

ulBase

)

Starts image capture

Parameters

ulBase

is the base address of the camera module.

This function starts the image capture over the configured camera interface This function should be called after configuring the camera module completele

Returns

None.

void CameraCaptureStop	(	unsigned long	ulBase,
		tBoolean	bImmediate
	)

Stops image capture

Parameters

ulBase	is the base address of the camera module.
bImmediate	is true to stop capture imeediately else flase.

This function stops the image capture over the camera interface. The capture is stopped either immediatelt or at the end of current frame based on bImmediate parameter.

Returns

None.

void CameraDMADisable

(

unsigned long

ulBase

)

Disable camera DMA

Parameters

ulBase

is the base address of the camera module.

This function masks transfer request to DMA from camera.

Returns

None.

void CameraDMAEnable

(

unsigned long

ulBase

)

Enable camera DMA

Parameters

ulBase

is the base address of the camera module.

This function enables transfer request to DMA from camera. DMA specific configuration has to be done seperately.

Returns

None.

void CameraIntClear	(	unsigned long	ulBase,
		unsigned long	ulIntFlags
	)

Clears individual camera interrupt sources.

Parameters

ulBase	is the base address of the camera module.
ulIntFlags	is the bit mask of the interrupt sources to be Clears.

This function Clears individual camera interrupt sources.

The parameter ulIntFlags should be logical OR of one or more of the values as defined in CameraIntEnable().

Returns

None.

void CameraIntDisable	(	unsigned long	ulBase,
		unsigned long	ulIntFlags
	)

Disables individual camera interrupt sources.

Parameters

ulBase	is the base address of the camera module.
ulIntFlags	is the bit mask of the interrupt sources to be disabled.

This function disables individual camera interrupt sources.

The parameter ulIntFlags should be logical OR of one or more of the values as defined in CameraIntEnable().

Returns

None.

void CameraIntEnable	(	unsigned long	ulBase,
		unsigned long	ulIntFlags
	)

Enables individual camera interrupt sources.

Parameters

ulBase	is the base address of the camera module.
ulIntFlags	is the bit mask of the interrupt sources to be enabled.

This function enables individual camera interrupt sources.

the parameter ulIntFlags should be logical OR of one or more of the following:

• CAM_INT_DMA
• CAM_INT_FE
• CAM_INT_FSC_ERR
• CAM_INT_FIFO_NOEMPTY
• CAM_INT_FIFO_FULL
• CAM_INT_FIFO_THR
• CAM_INT_FIFO_OF
• CAN_INT_FIFO_UR

Returns

None.

void CameraIntRegister	(	unsigned long	ulBase,
		void(*)(void)	pfnHandler
	)

Register camera interrupt handler

Parameters

ulBase	is the base address of the camera module.
pfnHandler	hold pointer to interrupt handler

This function registers and enables global camera interrupt from the interrupt controller. Individual camera interrupts source should be enabled using

See also

CameraIntEnable().

Returns

None.

unsigned long CameraIntStatus

(

unsigned long

ulBase

)

Returns the current interrupt status,

Parameters

ulBase	is the base address of the camera module.
ulBase	is the base address of the camera module.

This functions returns the current interrupt status for the camera.

Returns

Returns the current interrupt status, enumerated as a bit field of values described in CameraIntEnable().

void CameraIntUnregister

(

unsigned long

ulBase

)

Un-Register camera interrupt handler

Parameters

ulBase

is the base address of the camera module.

This function unregisters and disables global camera interrupt from the interrupt controller.

Returns

None.

void CameraParamsConfig	(	unsigned long	ulBase,
		unsigned long	ulHSPol,
		unsigned long	ulVSPol,
		unsigned long	ulFlags
	)

Configures camera parameters

Parameters

ulBase	is the base address of the camera module.
ulHSPol	sets the HSync polarity
ulVSPol	sets the VSync polarity
ulFlags	are configuration flags

This function sets different camera parameters.

The parameter ulHSPol should be on the follwoing:

• CAM_HS_POL_HI
• CAM_HS_POL_LO

The parameter ulVSPol should be on the follwoing:

• CAM_VS_POL_HI
• CAM_VS_POL_LO

The parameter ulFlags can be logical OR of one or more of the follwoing or 0:

• CAM_PCLK_RISE_EDGE
• CAM_PCLK_FALL_EDGE
• CAM_ORDERCAM_SWAP
• CAM_NOBT_SYNCHRO
• CAM_IF_SYNCHRO

Returns

None.

void CameraReset

(

unsigned long

ulBase

)

Resets the Camera core

Parameters

ulBase

is the base address of the camera module.

This function resets the camera core

Returns

None.

void CameraThresholdSet	(	unsigned long	ulBase,
		unsigned long	ulThreshold
	)

Sets the FIFO threshold for DMA transfer request

Parameters

ulBase	is the base address of the camera module.
ulThreshold	specifies the FIFO threshold

This function sets the FIFO threshold for DMA transfer request. Parameter ulThreshold can range from 1 - 64

Returns

None.

void CameraXClkConfig	(	unsigned long	ulBase,
		unsigned long	ulCamClkIn,
		unsigned long	ulXClk
	)

Set the internal clock divider

Parameters

ulBase	is the base address of the camera module.
ulCamClkIn	is input to camera module
ulXClk	defines the output required

This function sets the internal clock divider based on ulCamClkIn to generate XCLK as specified be ulXClk. Maximum suppoter division is 30

Returns

None.

void CameraXClkSet	(	unsigned long	ulBase,
		unsigned char	bXClkFlags
	)

Sets the internal divide in specified mode

Parameters

ulBase	is the base address of the camera module.
bXClkFlags	decides the divide mode

This function sets the internal divide in specified mode.

The parameter bXClkFlags should be one of the following :

• CAM_XCLK_STABLE_LO
• CAM_XCLK_STABLE_HI
• CAM_XCLK_DIV_BYPASS

Returns

None.