i2c.h

I2C总线在多机通信中的应用介绍了I2C总线的结构、工作原理、数据传输方式

#ifndef I2C_H
#define I2C_H
	
enum TI2CErrorCode
{
	IE_OK,		           //0 正常
	IE_IN_PROGRESS,        //1 正在操作
	IE_TIME_OUT,		   //2 执行等待超时
	IE_DEVICE_ERROR,       //3 读写器件过程中出错
	IE_INALID_WRITE_MODE,  //4 中断进入写模式，但是没有字节可写
	IE_INALID_READ_MODE,   //5 中断进入读模式，但是没有字节可读
	IE_CANNOT_SEND_START_STOP,//6 无法发送停止条件或者起始条件，总线紊乱了。内部会自动复位
	IE_UNKOWN_ISR_STATE	   //7 发生了未知原因的中断
};	

//I2C 总线速度设置
#define FI2C0		350000
//I2C 总线一次可以添加几个操作
#define MAX_I2C_OPERATION_COUNT 5


class CAbsI2CBus
{
public:
	/*----------------- 添加I2C总线的操作 --------------------------
	参数说明：
	   slave_addr - I2c总线设备的地址
	   buf - 读写的缓冲区
	   len - 缓冲区长度
	   append_stop - 读写完毕后是否发送停止条件
	返回：
	  如果成功添加了操作，则返回true，否则返回false
	说明：
	  操作添加后不会立刻执行，而是在调用Execute 时执行
	  如果调用 Execute 时不等待，则调用者必须保证buf指向的内容保持有效。
	  执行 Execute 后，再调用 AddOp_xx 函数则以前添加的操作都将被覆盖
	StartXXXX 函数：
	  . 先发送起始条件（如果上次没有结束，自动先发送停止条件
	  . 再发送从机地址
	  . 可选是否发送数据
	  . 可选的是否发送停止条件
	ContinueXXXX 函数：
	  . 如果上次也是读写，才能成功添加该操作
	  . 读写后可选择是否发送停止条件
	有关STOP的说明：
	  . StartRead, StartWrite 结束后如果不附加STOP，则可以继续调用 ContinueRead 和 ContinueWrite。
	  . StartRead 后如果不附加 STOP，而马上调用 StartWrite, 则必须附加STOP，程序会自动
	    再多读取一个字节并且不返回确认，然后才能发送停止条件. 	 
	------------------------------------------------------------*/
	virtual bool AddOp_StartRead(uint8 slave_addr, __packed uint8 *buf, int len, bool append_stop) = 0;
	virtual bool AddOp_StartWrite(uint8 slave_addr, __packed uint8 *buf, int len, bool append_stop) = 0;
	virtual bool AddOp_ContinueRead(__packed uint8 *buf, int len, bool append_stop) = 0;
	virtual bool AddOp_ContinueWrite(__packed uint8 *buf, int len, bool append_stop) = 0;
	virtual bool AddOp_Stop() = 0;//发送停止条件
	/*----------------- 执行I2C总线操作 --------------------------
	参数说明：
	   time_out_in_ms - 执行超时时间。例如EEPROM 写操作需要5毫秒。
	   block - 是否等待总线操作完毕后才退出。
	           如果为 true，则等待直到I2C总线操作完成或者超时才返回
	           如果为 false，则启动总线操作后立刻返回。调用者必须保证
	           操作的缓冲区保持有效（例如StartWrite 函数的buf 所指向的内容），
	           否则会产生意外结果。
	返回：
	  返回错误代码。正常为 IE_OK
	说明：
	  如果连续调用 Execute 函数，则重新开始执行上次添加好的操作，而如果当前的操作
	  正在执行，则先发送停止条件。
	例子：
	  读取24C64：
	  1. 发送起始条件＋从机地址写＋内存地址＋停止  
	     AddOp_StartWrite(0XA0, &addr, 1,true);
	  2. 发送起始条件＋从机地址读＋读取N字节
	     AddOp_StartRead(0XA0, buf, len,true);
	  3. 启动操作
	     Execute();
	------------------------------------------------------------*/
	virtual TI2CErrorCode Execute(uint32 time_out_in_ms = 20, bool block=true) = 0;
	/*----------------- 读取操作结果 --------------------------
	参数说明：
	   time_out_in_ms - 执行超时时间。例如EEPROM 写操作需要5毫秒。
	   block - 是否等待总线操作完毕后才退出。
	           如果为 true，则等待直到I2C总线操作完成或者超时才返回
	           如果为 false，则检查结果后立刻返回。调用者必须保证
	           操作的缓冲区保持有效（例如StartWrite 函数的buf 所指向的内容），
	           否则会产生意外结果。
	返回：
	  返回错误代码。正常为 IE_OK，如果正在等待则返回 IE_IN_PROGRESS
	说明：
	  如果执行过程中遇到错误，则先发送停止条件。
	------------------------------------------------------------*/
	virtual TI2CErrorCode GetResult(uint32 time_out_in_ms = 20, bool block=true) = 0;
	//总线初始化，如果发生错误可以再次初始化
	//注意：I2C的引脚功能初始化必须有用户完成
	virtual bool Init() = 0;
};	

class CAbsI2CBus *GetI2CBus();

#endif