I2C 是一种串行同步半双工通信协议,总线上可以同时挂载多个主机和从机。I2C 总线由串行数据线 (SDA) 和串行时钟线 (SCL) 线构成。这些线都需要上拉电阻。
I2C 具有简单且制造成本低廉等优点,主要用于低速外围设备的短距离通信(一英尺以内)。
I2C 驱动支持的平台包括 FT2000/4、D2000、E2000。
I2C 驱动程序管理在 I2C 总线上设备的通信,该驱动程序具备以下功能:
以下部分将指导您完成 I2C 驱动的硬件配置:
以下部分将指导您完成 I2C 驱动的软件配置:
typedef struct
{
u32 instance_id; /* Device instance id */
uintptr base_addr; /* Device base address */
u32 irq_num; /* Device interrupt id */
u32 irq_prority; /* Device interrupt priority */
u32 ref_clk_hz; /* Input reference clock frequency in Hz */
u32 work_mode; /* Device work mode Slave or Master */
u32 slave_addr; /* Slave Address writing/reading to/from */
boolean use_7bit_addr; /* Slave in-chip address offset in 7bit or 10bit */
u32 speed_rate; /* I2C speed rate */
} FI2cConfig; /* Device configure setting */
typedef struct
{
FI2cConfig config; /* Current active configs */
u32 is_ready; /* Device is initialized and ready */
volatile u32 status;
FI2cFrameTX txframe;
FI2cFrameRX rxframe;
/** only apply to master device **/
/* Master interrupt handler */
FI2cEvtHandler master_evt_handlers[FI2C_MASTER_INTR_EVT_NUM];
/** only apply to slave device **/
/* Slave interrupt handler */
FI2cEvtHandler slave_evt_handlers[FI2C_SLAVE_INTR_EVT_NUM];
} FI2c; /* Device instance */
模块错误码编号 0x10b0000
[0x0] FI2C_SUCCESS : fi2c success
[0x10b0001] FI2C_ERR_INVAL_PARM : fi2c invalid input parameters
[0x10b0002] FI2C_ERR_NOT_READY : fi2c driver not ready
[0x10b0001] FI2C_ERR_INVAL_PARM : fi2c invalid input parameters
[0x10b0003] FI2C_ERR_TIMEOUT : fi2c wait timeout
[0x10b0004] FI2C_ERR_NOT_SUPPORT : fi2c non support operation
[0x10b0005] FI2C_ERR_INVAL_STATE : fi2c invalid state
const FI2cConfig *FI2cLookupConfig(u32 instance_id);
Note:
- 用户需要修改配置参数时,可以通过修改返回的FI2cConfig副本,作为FI2cCfgInitialize函数的入参,
Input:
- u32 instance_id, 当前控制的I2C控制器实例号
Return:
- const FI2cConfig *, 返回驱动默认参数, NULL表示失败
FError FI2cCfgInitialize(FI2c *instance_p, const FI2cConfig *cofig_p);
Note:
- 此函数会将驱动实例中的所有数据全部重置,同时会进行I2C控制器的重置,请不要在I2C数据传输过程中调用此函数
Input:
- FI2c *instance_p, I2C驱动实例数据
- const FI2cConfig *cofig_p, I2C驱动配置数据
Return:
FError,参考6.2章错误码定义
void FI2cDeInitialize(FI2c *instance_p);
Note:
- 此函数会将驱动实例中的所有数据全部重置,
Input:
- FI2c *instance_p, I2C驱动实例数据
Return:
无
const char *FI2cErrorToMessage(FError error);
Note:
- 请输入属于FI2C模块的错误码,否则返回的错误信息为空
Input:
- {FError} error, I2C输入错误码
Return:
- {const char *}, 错误码信息,NULL表示失败
FError FI2cMasterReadPoll(FI2c *instance_p, u32 mem_addr, u8 mem_byte_len, u8 *buf_p, u32 buf_len);
Note: - 请先初始化I2C驱动再调用此函数 - 请在Master工作模式下调用此函数
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} inchip_addr 从机的内部偏移地址 - @param {u8} mem_byte_len, Size of internal memory address 1->8bit ~ 4->32bit - @param {u8} *buf_p 读目的缓冲区 - @param {int} buf_len 读目的缓冲区长度
Return: - @return {FError *} 返回错误码
FError FI2cMasterReadIntr(FI2c *instance_p, u32 mem_addr, u8 mem_byte_len, u8 *buf_p, u32 buf_len);
Note: - 请先初始化I2C驱动再调用此函数 - 请在Master工作模式下调用此函数
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} inchip_addr 从机的内部偏移地址 - @param {u8} *buf_p 读目的缓冲区 - @param {u8} mem_byte_len, Size of internal memory address 1->8bit ~ 4->32bit - @param {int} buf_len 读目的缓冲区长度
Return: - @return {FError *} 返回错误码
FError FI2cMasterWriteIntr(FI2c *instance_p, u32 mem_addr, u8 mem_byte_len, const u8 *buf_p, u32 buf_len);
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} inchip_addr 从机的内部偏移地址 - @param {u8} mem_byte_len, Size of internal memory address 1->8bit ~ 4->32bit - @param {u8} *buf_p 写源缓冲区 - @param {size_t} buf_len 写源缓冲区长度
Return: - @return {FError *} 返回错误码
FError FError FI2cMasterWritePoll(FI2c *instance_p, u32 mem_addr, u8 mem_byte_len, const u8 *buf_p, u32 buf_len);
Note: - 请先初始化I2C驱动再调用此函数 - 请在Master工作模式下调用此函数
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} inchip_addr 从机的内部偏移地址 - @param {u8} mem_byte_len, Size of internal memory address 1->8bit ~ 4->32bit - @param {u8} *buf_p 写源缓冲区 - @param {size_t} buf_len 写源缓冲区长度
Return: - @return {FError *} 返回错误码
u32 FI2cGetIntr(FI2c *instance_p);
Note: - 请先初始化I2C驱动再调用此函数
Input: - @param {FI2c} *instance_p I2C驱动实例数据
Return: - @return {u32} 中断状态寄存器的值
FError FI2cMasterSetupIntr(FI2c *instance_p,u32 mask);
Note: - 请先初始化I2C驱动再调用此函数 - 请在Master工作模式下调用此函数
Input: - {FI2c} *instance_p I2C驱动实例数据 - {u32} mask 需要操作的中断寄存器位 Return: - {FError *} 返回错误码
void FI2cMasterRegisterIntrHandler(FI2c *instance_p, u32 evt, FI2cEvtHandler handler);
Note: 无
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} evt 中断事件,参考 FI2C_MASTER_INTR_EVT_NUM - @param {FI2cEvtHandler} handler 中断事件回调函数
Return:
无
FError FI2cSlaveSetupIntr(FI2c *instance_p);
Note: - 请先初始化I2C驱动再调用此函数 - 请在Slave工作模式下调用此函数
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} evt 中断事件,参考 FI2C_MASTER_INTR_EVT_NUM - @param {FI2cEvtHandler} handler 中断事件回调函数
Return: - {FError *} 返回错误码
void FI2cSlaveRegisterIntrHandler(FI2c *instance_p, u32 evt, FI2cEvtHandler handler);
Note: 无
Input: - @param {FI2c} *instance_p I2C驱动实例数据 - @param {u32} evt 中断事件,参考 FI2C_SLAVE_INTR_EVT_NUM - @param {FI2cEvtHandler} handler 中断事件回调函数
Return:
无
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。