Application Interfaces

Introduction

Application Interfaces provided by DS90UB960 FPD-Link device library.

Functions
Board_STATUS	Board_fpdUb960WriteReg (void *handle, uint32_t slaveAddr, uint8_t regAddr, uint8_t regData)
	UB960 register write function. More...
Board_STATUS	Board_fpdUb960ReadReg (void *handle, uint32_t slaveAddr, uint8_t regAddr, uint8_t *regData)
	UB960 register read fuunction. More...
void	Board_fpdU960GetI2CAddr (uint8_t *chNum, uint8_t *i2cAddr, uint32_t csiInst)
	Get ub960 i2c address. More...
Board_STATUS	Board_fpdUb960CfgPG (void *handle, Board_FpdModuleObj *fpdModParams, uint32_t pgType)
	FPD ub960 pattern generation configurations. More...
Board_STATUS	Board_fpdUb960DesInit (void *handle, Board_FpdModuleObj *fpdModParams)
	Initializes the FPD UB960 module. More...
Board_STATUS	Board_fpdUb960DesInitFusionBoardTIDA1130 (void *handle, Board_FpdModuleObj *fpdModParams)
	Initializes the FPD UB960 module for OV2775 sensor module. More...
Board_STATUS	Board_fpdUb960Cfg (void *handle, Board_FpdModuleObj *fpdModParams, Board_I2cRegProgObj *ub960Cfg)
	FPD ub960 configurations. More...

Function Documentation

Board_STATUS Board_fpdUb960WriteReg	(	void *	handle,
		uint32_t	slaveAddr,
		uint8_t	regAddr,
		uint8_t	regData
	)

UB960 register write function.

Parameters

handle	[IN] I2C driver handle
slaveAddr	[IN] Device slave address
regAddr	[IN] Register offset address
regData	[IN] Register data

Returns

BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb960ReadReg	(	void *	handle,
		uint32_t	slaveAddr,
		uint8_t	regAddr,
		uint8_t *	regData
	)

UB960 register read fuunction.

Parameters

handle	[IN] I2C driver handle
slaveAddr	[IN] Device slave address
regAddr	[IN] Register offset address
regData	[OUT] Register data pointer

Returns

BOARD_SOK in case of success or appropriate error code.

void Board_fpdU960GetI2CAddr	(	uint8_t *	chNum,
		uint8_t *	i2cAddr,
		uint32_t	csiInst
	)

Get ub960 i2c address.

This function is used to get the I2C address and channel details of UB960 module.

Parameters

chNum	[IN] buffer to hold i2c channel number
i2cAddr	[IN] buffer to hold i2c address
csiInst	[IN] CSIRX Instance See BOARD_csiInst for more details.

Returns

In case of wrong parameters, chNum and i2cAddr are sent back as '0'.

Board_STATUS Board_fpdUb960CfgPG	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint32_t	pgType
	)

FPD ub960 pattern generation configurations.

This function is used for configuring the pattern generator for FPD UB960

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
pgType	[IN] Pattern Generation Type See DESUB960_patternType for details.

Returns

BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb960DesInit	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams
	)

Initializes the FPD UB960 module.

This function is used to initialize the fpd ub960 module

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params ] *

Returns

BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb960DesInitFusionBoardTIDA1130	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams
	)

Initializes the FPD UB960 module for OV2775 sensor module.

This function is used to initialize the fpd ub960 module for OV2775 sensor

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params ] *

Returns

BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb960Cfg	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		Board_I2cRegProgObj *	ub960Cfg
	)

FPD ub960 configurations.

This function is used for configuring the FPD UB960 de-serializer

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
ub960Cfg	[IN] Configuration Info

Returns

BOARD_SOK in case of success or appropriate error code.