PDK API Guide for J721E
common.h File Reference

Introduction

The macro definitions and function prototypes which are common across different board devices.

Go to the source code of this file.

Data Structures

struct  Board_FpdRmtDevObj
 FPD remote device object structure. More...
 
struct  Board_FpdModuleObj
 FPD module object structure. More...
 
struct  Board_I2cRegProgObj
 FPD remote device object structure. More...
 

Macros

#define BOARD_DEVICES_CONFIG_END   (-1)
 
#define BOARD_DEVICES_STS_LOG(x, ...)
 
#define BOARD_DEVICES_ERR_LOG(x, ...)
 
#define BOARD_FPD_MAX_REMOTE_SENSOR_DEVICES   (8U)
 
#define BOARD_FPD_MODE_DISABLE   (0U)
 
#define BOARD_FPD_MODE_ENABLE   (1U)
 
#define BOARD_FPD_MODE_NORMAL   (0U)
 
#define BOARD_FPD_MODE_RESET   (1U)
 
#define BOARD_FPD_KBPS_100   (0x64U)
 
#define BOARD_FPD_KBPS_400   (0x32U)
 
#define BOARD_I2C_REG_ADDR_MSB_FIRST   (0x0U)
 
#define BOARD_I2C_REG_ADDR_LSB_FIRST   (0x1U)
 
#define ONE_MILLI_SEC   (1U)
 
#define BOARD_FPD_I2C_CFG_DELAY   (5 * ONE_MILLI_SEC)
 
#define BOARD_I2C_TRANSACTION_TIMEOUT   (2000U)
 

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...