PDK Documentation
Functions
Application Interfaces
Board Library » Board Device Library » Board Device Common Library

Introduction

Functions

void Board_delay (uint32_t delayCycles)
 Delay generation function. More...
 
Board_STATUS Board_i2c16BitRegRd (void *handle, uint32_t slaveAddr, uint16_t regAddr, uint8_t *regData, uint8_t numOfBytes, uint8_t byteOrdSel, uint32_t i2cTimeout)
 I2C 16-bit register read function. More...
 
Board_STATUS Board_i2c16BitRegWr (void *handle, uint32_t slaveAddr, uint16_t regAddr, uint8_t *regData, uint8_t numOfBytes, uint8_t byteOrdSel, uint32_t i2cTimeout)
 I2C 16-bit register write function. More...
 
Board_STATUS Board_i2c8BitRegRd (void *handle, uint32_t slaveAddr, uint8_t regAddr, uint8_t *regData, uint8_t numOfBytes, uint32_t i2cTimeout)
 I2C 8-bit register read function. More...
 
Board_STATUS Board_i2c8BitRegWr (void *handle, uint32_t slaveAddr, uint8_t regAddr, uint8_t *regData, uint8_t numOfBytes, uint32_t i2cTimeout)
 I2C 8-bit register write function. More...
 
Board_STATUS Board_i2c10bit16bitRegRd (void *handle, uint32_t slaveAddr, uint16_t regAddr, uint16_t *regData, uint32_t i2cTimeout)
 I2C 10-bit slave address register read function. More...
 
Board_STATUS Board_i2c10bit16bitRegWr (void *handle, uint32_t slaveAddr, uint16_t regAddr, uint16_t regData, uint32_t i2cTimeout)
 I2C 10-bit slave address register write function. More...
 

Function Documentation

◆ Board_delay()

void Board_delay ( uint32_t  delayCycles)

Delay generation function.

This function is used to generates delay proportional to user specified delay cycles.

Parameters
delayCycles[IN] Number of delay cycles.

◆ Board_i2c16BitRegRd()

Board_STATUS Board_i2c16BitRegRd ( void *  handle,
uint32_t  slaveAddr,
uint16_t  regAddr,
uint8_t *  regData,
uint8_t  numOfBytes,
uint8_t  byteOrdSel,
uint32_t  i2cTimeout 
)

I2C 16-bit register read function.

This function is used to read the 16-bit data from the i2c device registers

Parameters
handle[IN] Low level driver handle
slaveAddr[IN] I2C slave address
regAddr[IN] I2C register offset address
regData[OUT] I2C register data buffer
numOfBytes[IN] Receive data width
byteOrdSel[IN] Register address byte order select
i2cTimeout[IN] I2C driver timeout value
Returns
BOARD_SOK in case of success or appropriate error code.

◆ Board_i2c16BitRegWr()

Board_STATUS Board_i2c16BitRegWr ( void *  handle,
uint32_t  slaveAddr,
uint16_t  regAddr,
uint8_t *  regData,
uint8_t  numOfBytes,
uint8_t  byteOrdSel,
uint32_t  i2cTimeout 
)

I2C 16-bit register write function.

This function is used to write the data on the i2c device registers

Parameters
handle[IN] Low level driver handle
slaveAddr[IN] I2C slave address
regAddr[IN] I2C register offset address
regData[IN] I2C register data buffer
numOfBytes[IN] Receive data width
byteOrdSel[IN] Register address byte order select
i2cTimeout[IN] I2C driver timeout value
Returns
BOARD_SOK in case of success or appropriate error code.

◆ Board_i2c8BitRegRd()

Board_STATUS Board_i2c8BitRegRd ( void *  handle,
uint32_t  slaveAddr,
uint8_t  regAddr,
uint8_t *  regData,
uint8_t  numOfBytes,
uint32_t  i2cTimeout 
)

I2C 8-bit register read function.

This function is used to read the 8-bit data from the i2c device registers

Parameters
handle[IN] Low level driver handle
slaveAddr[IN] I2C slave address
regAddr[IN] I2C register offset address
regData[OUT] I2C register data buffer
numOfBytes[IN] Receive data width
i2cTimeout[IN] I2C driver timeout value
Returns
BOARD_SOK in case of success or appropriate error code.

◆ Board_i2c8BitRegWr()

Board_STATUS Board_i2c8BitRegWr ( void *  handle,
uint32_t  slaveAddr,
uint8_t  regAddr,
uint8_t *  regData,
uint8_t  numOfBytes,
uint32_t  i2cTimeout 
)

I2C 8-bit register write function.

This function is used to write the 8-bit data on the i2c device registers

Parameters
handle[IN] Low level driver handle
slaveAddr[IN] I2C slave address
regAddr[IN] I2C register offset address
regData[IN] I2C register data buffer
numOfBytes[IN] Transmit data width
i2cTimeout[IN] I2C driver timeout value
Returns
BOARD_SOK in case of success or appropriate error code.

◆ Board_i2c10bit16bitRegRd()

Board_STATUS Board_i2c10bit16bitRegRd ( void *  handle,
uint32_t  slaveAddr,
uint16_t  regAddr,
uint16_t *  regData,
uint32_t  i2cTimeout 
)

I2C 10-bit slave address register read function.

This function is used to write the 8-bit data on the i2c device registers

Parameters
handle[IN] Low level driver handle
slaveAddr[IN] I2C slave address
regAddr[IN] I2C register offset address
regData[IN] I2C register data buffer
i2cTimeout[IN] I2C driver timeout value
Returns
BOARD_SOK in case of success or appropriate error code.

◆ Board_i2c10bit16bitRegWr()

Board_STATUS Board_i2c10bit16bitRegWr ( void *  handle,
uint32_t  slaveAddr,
uint16_t  regAddr,
uint16_t  regData,
uint32_t  i2cTimeout 
)

I2C 10-bit slave address register write function.

This function is used to write the 8-bit data on the i2c device registers

Parameters
handle[IN] Low level driver handle
slaveAddr[IN] I2C slave address
regAddr[IN] I2C register offset address
regData[IN] I2C register data buffer
i2cTimeout[IN] I2C driver timeout value
Returns
BOARD_SOK in case of success or appropriate error code.