摘要：I2C (內置于集成電路)是一種2線接口，實現集成電路之間的雙向通信。本應用筆記介紹MAXQ2000微控制器的軟件I2C驅動器，它采用微控制器的任意GPIO引腳，支持100kHz或400kHz的I2C通信。MAXQ系列微控制器具有高速、靈活的GPIO模塊以及獨立的I/O供電，適用于逐位控制等應用。

引言

I2C (內置集成電路)是一種2線接口，實現集成電路之間的雙向通信。本應用筆記介紹maxqi2c庫，它是MAXQ2000微控制器(μC)的軟件I2C驅動。

maxqi2c庫采用擴展C語言編寫，由MAXQ的IAR嵌入式平臺編譯。它由兩個文件組成：maxqi2c.h和maxqi2c.c。當這些文件包含在MAXQ2000固件工程時，使用μC的任意GPIO引腳，便可實現100kHz或者400kHz靈活的I2C通信。

MAXQ系列的微控制器具有高速、靈活的GPIO模塊以及獨立的I/O供電，適用于位拆裂等應用。

本應用筆記討論的實例工程文件可以從Maxim Integrated Products網站下載。

配置maxqi2c庫

用戶應將maxqi2c庫文件(maxqi2c.h和maxqi2c.c)復制到MAXQ2000工程目錄中，對文件進行配置，建立所需的I2C接口。通過編輯以下代碼(清單1)實現所有的配置，該代碼位于maxqi2c.h源文件的開始：

清單1. maxi2c.h用戶定義代碼。

/* USER MUST CUSTOMIZE THE FOLLOWING DEFINE STMTS - START */
  // Enter the port used for SDA and SCL
  #define SDA_PORT               0
  #define SCL_PORT               0

  // Enter the pin used for SDA and SCL
  #define SDA_PORT_BIT           0
  #define SCL_PORT_BIT           1

  // Uncomment one of these define statements to select I2C bus speed
  #define I2C_400_KHZ
  //#define I2C_100_KHZ
  
  // Comment out the following define statement to disable clock
  // stretching in i2cRecv()
  #define I2C_CLOCK_STRETCHING
/* USER MUST CUSTOMIZE THE FOLLOWING DEFINE STMTS - END   */

注釋：用戶定義代碼編譯時實現，因此，運行時間固定。

選擇SCL和SDA引腳

需選擇兩個GPIO引腳用作SCL和SDA。為SCL和SDA選擇了I/O之后，必須對SDA_PORT和SCL_PORT定義語句進行編輯，以反映SDA和SCL所需的端口。也必須對SDA_PORT_BIT和SCL_PORT_BIT定義語句進行編輯，以反映SDA和SCL所需的引腳(在所選端口上)。

上面清單1中的源代碼在I/O端口0分配引腳0，作為SDA，在I/O端口0分配引腳1，作為SCL。

選擇通信速率

通過注釋I2C_400_KHZ和I2C_100_KHZ兩個定義語句之一來選擇通信速率。

清單1的源代碼通過400kHz I2C總線初始化maxqi2c庫，進行通信。由于I2C接口是逐位控制，通信速率實際略低于400kHz (或者，另一種選擇100kHz)。為達到全速400kHz通信，固件設計人員必須學習maxi2c庫，去掉某些源代碼，發揮庫的靈活性。

注釋：maxqi2c庫包括時延以滿足I2C規范。這些時延在maxqi2c.c文件的開始，假設MAXQ2000具有20MHz系統時鐘；如果采用了速率較低的時鐘，可以減小時延。

使用時鐘擴展

maxqi2c庫的時鐘擴展僅在調用i2cRecv()函數開始傳送時(地址傳輸完畢，經過地址確認后，或者在傳送開始時)使用。因此，I2C傳送可以采用以下格式的時鐘擴展：

[S] [ADDR] [R] [A] [clock stretch] [DATA0] [A] ... [DATAN-1] [A]
or
[clock stretch] [DATA0] [A] ... [DATAN-1] [N] [P]
or
[clock stretch] [DATA0] [A] ... [DATAN-1] [A]

使用maxqi2c一節中的i2cRecv()說明，maxqi2c庫使用實例一節中的代碼解釋了怎樣產生這些格式的I2C命令。

要使能時鐘擴展，則不應注釋掉I2C_CLOCK_STRETCHING定義聲明。如果不需要時鐘擴展，通過注釋掉I2C_CLOCK_STRETCHING定義語句禁用它。禁用時鐘擴展會稍微提高maxqi2c庫i2cRecv()函數的速率。

上面清單1的源代碼使能時鐘擴展。

使用maxqi2c

由4個函數實現maxqi2c庫從軟件I2C驅動發送和接收數據：i2cInit()、i2cIsAddrPresent()、i2cSend()和i2cRecv()。這些函數的文檔也包含在maxqi2c.h文件中。

這些函數都不需要正式的參數，而是采用4個全局變量為這些函數存儲參數：i2cData (無符號字符 *)、i2cDataLen (無符號整數)、i2cDataAddr (無符號字符)和i2cDataTerm (無符號字符)。該方法在函數調用時不進行數據復制，從而支持固件以更快的速率運行。4個用作maxqi2c庫參數的全局變量是：i2cData (無符號字符 *)、i2cDataLen (無符號整數)、i2cDataAddr (無符號字符)和i2cDataTerm (無符號字符)。

i2cInit()

必須在調用任何其他maxqi2c函數之前調用該函數。它初始化maxqi2c.h文件中用戶定義代碼所選擇的端口引腳。該函數不需要參數(局部或者全局)，不返回數值。

i2cIsAddrPresent()

該函數使MAXQ2000能夠查詢I2C總線，以確定是否有特定地址的器件。該函數有一個參數――全局變量i2cDataAddr，它必須由器件地址裝入，查詢I2C總線是否有器件。該函數還返回一個數值(無符號字符類型)。如果找到了給定地址的器件，該數值等于I2C_XMIT_OK，如果沒有找到給定地址的器件，則等于I2C_XMIT_FAILED。

為確定在I2C總線上是否有特定器件，i2cIsAddrPresent()按照下面的格式發送一個I2C命令：

[S] [ADDR] [W] [A] [P]

i2cSend()

該函數使MAXQ2000能夠通過軟件I2C驅動向器件傳送數據。i2cSend()需要以下4個參數(均為全局變量)來初始化：

• i2cData (無符號字符 *)：被傳送字節陣列的第一個字節指針。
• i2cDataLen (無符號整數)：向I2C總線傳送的字節數(不包括器件地址)。
• i2cDataAddr (無符號字符)：數據將被傳送到的器件的地址。注意，如果該變量設置為0，將不發送地址，傳送I2C數據。
• i2cDataTerm (無符號字符)：I2C傳送如何結束。調用i2cSend(): I2C_TERM_NONE或者I2C_TERM_STOP時，該變量可以取兩個值。

在I2C總線上向器件傳送數據的格式取決于4個全局變量的取值。表1列出了這些全局變量不同取值時的I2C命令格式。

表1. i2cSend()送出的I2C命令

i2cDataLen(hex)	i2cDataAddr(hex)	i2cDataTerm	I2C Command Format
0x0002	0x7E	I2C_TERM_STOP	[S] [ADDR] [W] [A] [DATA0] [A] [DATA1] [P]
0x0002	0x7E	I2C_TERM_NONE	[S] [ADDR] [W] [A] [DATA0] [A] [DATA1] [A]
0x0002	0x00	I2C_TERM_NONE	[DATA0] [A] [DATA1] [A]
0x0002	0x00	I2C_TERM_STOP	[DATA0] [A] [DATA1] [A] [P]

注釋：表1中的最后3個格式顯示了i2cSend()怎樣向I2C總線上的同一個器件連續發送數據。

如果尋址器件每一字節作出應答，i2cSend()函數返回一個等于I2C_XMIT_OK的數值(無符號字符類型)，如果尋址器件每字節沒有應答，返回值則等于I2C_XMIT_FAILED。當一個字節沒有得到應答時，函數將立即返回。

i2cRecv()

該函數使MAXQ2000能夠使用軟件I2C驅動從器件接收數據。i2cRecv()函數需要以下4個參數(均為全局變量)來初始化：

• i2cData (無符號字符 *)：存儲接收數據陣列的第一個字節指針。
• i2cDataLen (無符號整數)：從I2>C總線上接收到的字節數(不包括器件地址)。
• i2cDataAddr (無符號字符)：將要接收數據的器件地址。注意，如果該變量設置為0，將不發送地址，接收I2C數據。
• i2cDataTerm (無符號字符)：I2C傳送如何結束。調用i2cRecv(): I2C_TERM_NONE、 I2C_TERM_ACK或者I2C_TERM_NACK_AND_STOP時，該變量可以取三個值。

在I2C總線上從器件接收數據的格式取決于4個全局變量的取值。表2列出了這些全局變量不同取值時的I2C命令格式。

表2. 禁用時鐘擴展，i2cRecv()發送的I2C命令

i2cDataLen(hex)	i2cDataAddr(hex)	i2cDataTerm	I2C Command Format
0x0002	0x7E	I2C_TERM_NACK_AND_STOP	[S] [ADDR] [R] [A] [DATA0] [A] [DATA1] [N] [P]
0x0002	0x7E	I2C_TERM_ACK	[S] [ADDR] [R] [A] [DATA0] [A] [DATA1] [A]
0x0002	0x00	I2C_TERM_ACK	[DATA0] [A] [DATA1] [A]
0x0002	0x00	I2C_TERM_NACK_AND_STOP	[DATA0] [A] [DATA1] [N] [P]

注釋：表2中的最后3個格式顯示了i2cRecv()怎樣從I2C總線上的同一個器件連續接收數據。

如果地址作為I2C命令的一部分進行發送，沒有得到應答，i2cRecv()函數返回一個等于I2C_XMIT_FAILED的數值(無符號字符)，否則，返回I2C_XMIT_OK。

帶有時鐘擴展的maxqi2c庫使用實例

以下實例顯示了怎樣利用maxqi2c庫從MAX1169 ADC接收16位采樣，由MAXQ的RS-232端口，將這些數據傳送至PC。

原理

采用MAX1169 ADC評估板和MAXQ2000評估板(Rev B)實現了該實例。圖1顯示了兩塊評估板的連接。MAXQ2000 I/O端口的引腳0和引腳1 (分別在J2-30和J2-28)用作I2C總線上的主機SDA和SCL線。


圖1. MAX1169評估板和MAXQ2000評估板(Rev B)連接原理圖，將由maxqi2c庫使用。

注釋：MAXQ2000評估板上的MAXQ2000高頻晶振(Y1)以20MHz晶振替代。MAX1169評估板的跳接器設置和MAXQ2000評估板的開關設置在表3和表4中：

表3：MAX1169評估板的跳接器設置

跳接器	短路器位置
JU1	引腳1和2之間安裝短路器
JU2	引腳1和2之間安裝短路器
JU3	引腳1和2之間安裝短路器
JU4	沒有短路器
JU5	沒有短路器

表4. MAXQ2000評估板(Rev B)開關設置

開關	位置
SW1-1	斷開
SW1-2	斷開
SW1-3	斷開
SW1-4	打開
SW1-5	斷開
SW1-6	斷開
SW1-7	打開
SW1-8	斷開
SW6-1	斷開
SW6-2	斷開
SW6-3	斷開
SW6-4	斷開
SW6-5	斷開
SW6-6	斷開
SW6-7	斷開
SW6-8	打開

固件

該實例(max1169.c)的固件文件在附錄A中給出。完整的工程資料可以在Maxim MAXQ2000網頁下載，采用MAXQ IAR嵌入式平臺編譯。該實例中，maxqi2c庫的用戶定義代碼(在maxqi2c.h文件的開始)與清單1的源代碼完全相同。

max1169.c文件包括兩個頭文件：iomaxq200x.h和maxqi2c.h。注意，實例中的iomaxq200x.h文件將忽略MAXQ包含路徑IAR嵌入式平臺中的iomaxq200x.h文件。iomaxq200x.h文件為maxqi2c庫所需的每個端口引腳進行定義。包含了maxqi2c.h文件，以支持固件調用maxqi2c庫函數。

固件分成5步，在max1169.c文件中標出(參見附錄A)。

第1步初始化UART0，以19200bps進行異步通信。注意，如果MAXQ2000系統時鐘不是20MHz，必須修改寄存器PR0的分配以獲得所需的波特率。

第2步調用i2cInit()函數，以初始化I2C總線MAXQ2000所使用的引腳。

第3步初始化參數，調用i2cRecv()函數。參數經過初始化，按照下面的格式傳送I2C命令：

[S] [ADDR] [R] [A] [clock stretch] [DATA0] [A] [DATA1] [A (termination)] 

第4步將地址參數設置為0。使i2cRecv()函數按照下面的格式傳送I2C命令：

[clock stretch] [DATA0] [A] [DATA1] [A (termination)] 

第5步是周期不確定的循環。該循環調用i2cRecv() (按照第4步定義的格式)，從MAX1169接收一個16位采樣。由UART0將該16位采樣傳送(MSB在前)至PC。由于匹配參數i2cDataTerm總是等于I2C_TERM_ACK，循環的周期不確定，MAX1169不會看到停止狀態。

附錄A: max1169.c

/*
 * DEMO of maxqi2c Software I2C Driver
 * (uses evkits for the MAX1169 and MAXQ2000)
 *
 * by: Paul Holden - MAXIM INTEGRATED PRODUCTS
 *
 * 
 * DESC: Test program for the maxqi2c.c/maxqi2c.h I2C
 *       driver for the MAXQ2000. The program reads
 *       16-bit samples from the MAX1169 (running in 
 *       continuous conversion mode) and transmits them
 *       using the UART0 port.
 *
 * NOTE - THE FOLLOWING CODE ASSUMES THE MAXQ2000 HAS
 *        A Fsysclk=20MHz.
 */

#include "iomaxq200x.h"
#include "maxqi2c.h"

void main()
{
   unsigned char data[2];

   // 1. Init UART0
   PD7_bit.bit0 = 1;      // Set TX0 pin as output
   SCON0        = 0x42;
   SMD0         = 0x02;
   PR0          = 0x07DD; // 19200bps

   // 2. Init bit-banged I2C port
   i2cInit();

   // 3. Send initial I2C request
   // [S] [ADDR+R] [A] [clock_stretch] [DATA0] [A] [DATA1] [A (termination)] 
   i2cData     = (unsigned char *)(&data); // cast needed!
   i2cDataAddr = 0x7E;
   i2cDataLen  = 0x0002;
   i2cDataTerm = I2C_TERM_ACK;
   i2cRecv();

   // 4. Init continuous conversion
   // [clock_stretch] [DATA0] [A] [DATA1] [A (termination)]
   i2cDataAddr = 0x00;

   // 5. Receive a 16-bit sample and transfer it to the UART0 port
   //    one byte at a time. Repeat forever...
   while (1)
   {
      i2cRecv();
      
      while(!SCON0_bit.TI);   // Wait for UART0 Buffer to be empty
      SCON0_bit.TI = 0;       // Reset TI flag
      SBUF0        = data[0]; // Send data byte 0
      while(!SCON0_bit.TI);   // Wait for UART0 Buffer to be empty
      SCON0_bit.TI = 0;       // reset TI flag
      SBUF0        = data[1]; // Send data byte 1
   }
}