MAXQ2000微控制器軟件I2C驅(qū)動(dòng)

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

引言

I2C (內(nèi)置集成電路)是一種2線接口，實(shí)現(xiàn)集成電路之間的雙向通信。本應(yīng)用筆記介紹maxqi2c庫(kù)，它是MAXQ2000微控制器(μC)的軟件I2C驅(qū)動(dòng)。

maxqi2c庫(kù)采用擴(kuò)展C語言編寫，由MAXQ的IAR嵌入式平臺(tái)編譯。它由兩個(gè)文件組成：maxqi2c.h和maxqi2c.c。當(dāng)這些文件包含在MAXQ2000固件工程時(shí)，使用μC的任意GPIO引腳，便可實(shí)現(xiàn)100kHz或者400kHz靈活的I2C通信。

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

本應(yīng)用筆記討論的實(shí)例工程文件可以從Maxim Integrated Products網(wǎng)站下載。

配置maxqi2c庫(kù)

用戶應(yīng)將maxqi2c庫(kù)文件(maxqi2c.h和maxqi2c.c)復(fù)制到MAXQ2000工程目錄中，對(duì)文件進(jìn)行配置，建立所需的I2C接口。通過編輯以下代碼(清單1)實(shí)現(xiàn)所有的配置，該代碼位于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   */

注釋：用戶定義代碼編譯時(shí)實(shí)現(xiàn)，因此，運(yùn)行時(shí)間固定。

選擇SCL和SDA引腳

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

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

選擇通信速率

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

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

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

使用時(shí)鐘擴(kuò)展

maxqi2c庫(kù)的時(shí)鐘擴(kuò)展僅在調(diào)用i2cRecv()函數(shù)開始傳送時(shí)(地址傳輸完畢，經(jīng)過地址確認(rèn)后，或者在傳送開始時(shí))使用。因此，I2C傳送可以采用以下格式的時(shí)鐘擴(kuò)展：

[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一節(jié)中的i2cRecv()說明，maxqi2c庫(kù)使用實(shí)例一節(jié)中的代碼解釋了怎樣產(chǎn)生這些格式的I2C命令。

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

上面清單1的源代碼使能時(shí)鐘擴(kuò)展。

使用maxqi2c

由4個(gè)函數(shù)實(shí)現(xiàn)maxqi2c庫(kù)從軟件I2C驅(qū)動(dòng)發(fā)送和接收數(shù)據(jù)：i2cInit()、i2cIsAddrPresent()、i2cSend()和i2cRecv()。這些函數(shù)的文檔也包含在maxqi2c.h文件中。

這些函數(shù)都不需要正式的參數(shù)，而是采用4個(gè)全局變量為這些函數(shù)存儲(chǔ)參數(shù)：i2cData (無符號(hào)字符 *)、i2cDataLen (無符號(hào)整數(shù))、i2cDataAddr (無符號(hào)字符)和i2cDataTerm (無符號(hào)字符)。該方法在函數(shù)調(diào)用時(shí)不進(jìn)行數(shù)據(jù)復(fù)制，從而支持固件以更快的速率運(yùn)行。4個(gè)用作maxqi2c庫(kù)參數(shù)的全局變量是：i2cData (無符號(hào)字符 *)、i2cDataLen (無符號(hào)整數(shù))、i2cDataAddr (無符號(hào)字符)和i2cDataTerm (無符號(hào)字符)。

i2cInit()

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

i2cIsAddrPresent()

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

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

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

i2cSend()

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

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

在I2C總線上向器件傳送數(shù)據(jù)的格式取決于4個(gè)全局變量的取值。表1列出了這些全局變量不同取值時(shí)的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個(gè)格式顯示了i2cSend()怎樣向I2C總線上的同一個(gè)器件連續(xù)發(fā)送數(shù)據(jù)。

如果尋址器件每一字節(jié)作出應(yīng)答，i2cSend()函數(shù)返回一個(gè)等于I2C_XMIT_OK的數(shù)值(無符號(hào)字符類型)，如果尋址器件每字節(jié)沒有應(yīng)答，返回值則等于I2C_XMIT_FAILED。當(dāng)一個(gè)字節(jié)沒有得到應(yīng)答時(shí)，函數(shù)將立即返回。

i2cRecv()

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

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

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

表2. 禁用時(shí)鐘擴(kuò)展，i2cRecv()發(fā)送的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個(gè)格式顯示了i2cRecv()怎樣從I2C總線上的同一個(gè)器件連續(xù)接收數(shù)據(jù)。

如果地址作為I2C命令的一部分進(jìn)行發(fā)送，沒有得到應(yīng)答，i2cRecv()函數(shù)返回一個(gè)等于I2C_XMIT_FAILED的數(shù)值(無符號(hào)字符)，否則，返回I2C_XMIT_OK。

帶有時(shí)鐘擴(kuò)展的maxqi2c庫(kù)使用實(shí)例

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

原理

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


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

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

表3：MAX1169評(píng)估板的跳接器設(shè)置

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

表4. MAXQ2000評(píng)估板(Rev B)開關(guān)設(shè)置

開關(guān)	位置
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	打開

固件

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

max1169.c文件包括兩個(gè)頭文件：iomaxq200x.h和maxqi2c.h。注意，實(shí)例中的iomaxq200x.h文件將忽略MAXQ包含路徑IAR嵌入式平臺(tái)中的iomaxq200x.h文件。iomaxq200x.h文件為maxqi2c庫(kù)所需的每個(gè)端口引腳進(jìn)行定義。包含了maxqi2c.h文件，以支持固件調(diào)用maxqi2c庫(kù)函數(shù)。

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

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

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

第3步初始化參數(shù)，調(diào)用i2cRecv()函數(shù)。參數(shù)經(jīng)過初始化，按照下面的格式傳送I2C命令：

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

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

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

第5步是周期不確定的循環(huán)。該循環(huán)調(diào)用i2cRecv() (按照第4步定義的格式)，從MAX1169接收一個(gè)16位采樣。由UART0將該16位采樣傳送(MSB在前)至PC。由于匹配參數(shù)i2cDataTerm總是等于I2C_TERM_ACK，循環(huán)的周期不確定，MAX1169不會(huì)看到停止?fàn)顟B(tài)。

附錄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
   }
}