Introduction

Application Interfaces provided by DS90UB926 FPD-Link device library.

Functions
Board_STATUS	Board_fpdUb926SetI2SChBEnableModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	I2S channel-B enable mode control. More...

Board_STATUS	Board_fpdUb926SetI2SChBOverrideModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	I2S channel-B override mode control. More...

Board_STATUS	Board_fpdUb926SetI2STransportSelModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	I2S Transport select mode control. More...

Board_STATUS	Board_fpdUb926SetI2SGenModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	I2S generation mode control. More...

Board_STATUS	Board_fpdUb926SetPassRGBModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	Pass RGB mode control. More...

Board_STATUS	Board_fpdUb926SetOverrideFCConfigModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	Override forward channel configuation mode control. More...

Board_STATUS	Board_fpdUb926SetRGB18bitModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	RGB 18-bit mode control. More...

Board_STATUS	Board_fpdUb926GetPLLLockStatus (void handle, Board_FpdModuleObj fpdModParams, bool *pllLockStatus)
	Get PLL lock status. More...

Board_STATUS	Board_fpdUb926RmtSerSlvDevAliasIdCfg (void handle, Board_FpdModuleObj fpdModParams, Board_FpdRmtDevObj *fpdRmtParams)
	Remote serializer slave device id config. More...

Board_STATUS	Board_fpdUb926SetI2CPassThrAllModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	I2C pass through all mode control. More...

Board_STATUS	Board_fpdUb926SetI2CPassThrModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	I2C pass through mode control. More...

Board_STATUS	Board_fpdUb926SetI2CBusFreq (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgBitRate)
	I2C bus frequency set. More...

Board_STATUS	Board_fpdUb926SetBackChModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	Deserializer back channel mode control. More...

Board_STATUS	Board_fpdUb926SetDigitalRst1ModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	Deserializer digital reset1 mode control. More...

Board_STATUS	Board_fpdUb926SetRmtAutoPwrDwnModeCtrl (void handle, Board_FpdModuleObj fpdModParams, uint8_t cfgMode)
	Remote auto-power down mode control. More...

void	Board_fpdUb926GetI2CAddr (uint8_t domain, uint8_t chNum, uint8_t *i2cAddr)
	Get ub926 i2c address. More...

Function Documentation

Board_STATUS Board_fpdUb926SetI2SChBEnableModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

I2S channel-B enable mode control.

This function is used for configuring the deserializer I2S Channel-B mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetI2SChBOverrideModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

I2S channel-B override mode control.

This function is used for configuring the deserializer I2S Channel-B override mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetI2STransportSelModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

I2S Transport select mode control.

This function is used for configuring the deserializer I2S transport select mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetI2SGenModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

I2S generation mode control.

This function is used for configuring the deserializer I2S generation mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetPassRGBModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

Pass RGB mode control.

This function is used for configuring the deserializer RGB pass mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetOverrideFCConfigModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

Override forward channel configuation mode control.

This function is used for configuring the deserializer override forward channel mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetRGB18bitModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

RGB 18-bit mode control.

This function is used for configuring the deserializer RGB 18-bit mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926GetPLLLockStatus	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		bool *	pllLockStatus
	)

Get PLL lock status.

This function is used for reading the deserializer PLL lock status

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
pllLockStatus	[IN/OUT] Buffer to hold PLL lock status

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926RmtSerSlvDevAliasIdCfg	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		Board_FpdRmtDevObj *	fpdRmtParams
	)

Remote serializer slave device id config.

This function is used for configuring the remote serializer slave device ID

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
fpdRmtParams	[IN] structure holding the fpd params

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetI2CPassThrAllModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

I2C pass through all mode control.

This function is used for configuring the deserializer I2C pass through all mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetI2CPassThrModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

I2C pass through mode control.

This function is used for configuring the deserializer I2C pass through mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetI2CBusFreq	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgBitRate
	)

I2C bus frequency set.

This function is used for setting the deserializer I2C bus frequency

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgBitRate	[IN] Indicates I2C serial clock frequency config modes BOARD_FPD_KBPS_100 - 100 KBPS BOARD_FPD_KBPS_400 - 400 KBPS

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetBackChModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

Deserializer back channel mode control.

This function is used for configuring the deserializer back channel mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetDigitalRst1ModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

Deserializer digital reset1 mode control.

This function is used for configuring the deserializer digital reset1 mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

Board_STATUS Board_fpdUb926SetRmtAutoPwrDwnModeCtrl	(	void *	handle,
		Board_FpdModuleObj *	fpdModParams,
		uint8_t	cfgMode
	)

Remote auto-power down mode control.

This function is used for configuring the deserializer auto power down mode

Parameters

handle	[IN] Low level driver handle
fpdModParams	[IN] FPD module params
cfgMode	[IN] Config mode - Indicates Enable or Disable

Returns: BOARD_SOK in case of success or appropriate error code.

void Board_fpdUb926GetI2CAddr	(	uint8_t *	domain,
		uint8_t *	chNum,
		uint8_t *	i2cAddr
	)

Get ub926 i2c address.

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

Parameters

domain	[IN] I2C instance domain
chNum	[IN] buffer to hold i2c channel number
i2cAddr	[IN] buffer to hold i2c address

Returns: BOARD_SOK in case of success or appropriate error code.

Introduction

Functions

Function Documentation