小凌派RK2206開(kāi)發(fā)板EEPROM存儲(chǔ)案例詳解

一、簡(jiǎn)介
在實(shí)際的應(yīng)用中，保存在RAM中的數(shù)據(jù)掉電后就丟失了，保存在FLASH中的數(shù)據(jù)又不能隨意改變，也就是不能用它來(lái)記錄變化的數(shù)值。但是在某些特定場(chǎng)合，我們又確實(shí)需要記錄下某些數(shù)據(jù)，而它們還時(shí)常需要改變或更新，掉電之后數(shù)據(jù)還不能丟失。比如，我們的家用電表度數(shù)，電視機(jī)里邊的頻道記憶，一般都是使用EEPROM來(lái)保存數(shù)據(jù)，特點(diǎn)就是掉電后存儲(chǔ)的數(shù)據(jù)不丟失。
EEPROM (Electrically Erasable Programmable read only memory)是指帶電可擦可編程只讀存儲(chǔ)器。是一種掉電后數(shù)據(jù)不丟失的存儲(chǔ)芯片。EEPROM可以在電腦上或?qū)Ｓ迷O(shè)備上擦除已有信息，重新編程。一般用在即插即用。一般情況下，EEPROM擁有30萬(wàn)到100萬(wàn)次的壽命，也就是它可以反復(fù)寫(xiě)入30~100萬(wàn)次，而讀取次數(shù)是無(wú)限的。
本文基于瑞芯微RK2206芯片 + 鴻蒙LiteOS操作系統(tǒng)，通過(guò)i2c總線控制EEPROM讀寫(xiě)。
二、硬件電路設(shè)計(jì)
我使用的EEPROM型號(hào)是K24C02，它是一個(gè)常用的基于IIC通信協(xié)議的EEPROM元件，例如ATMEL公司的AT24C02、CATALYST公司的CAT24C02和ST公司的ST24C02等芯片。IIC是一個(gè)通信協(xié)議，它擁有嚴(yán)密的通信時(shí)序邏輯要求，而EEPROM是一個(gè)元件，只是這個(gè)元件采樣了IIC協(xié)議的接口與單片機(jī)相連而已，二者并沒(méi)有必然的聯(lián)系，EEPROM可以用其它接口，I2C也可以用在其它很多器件上。根據(jù)K24C02芯片手冊(cè)，可獲知如下：
（1）K24C02芯片的從設(shè)備地址。因本章節(jié)采用的2Kbit的EEPROM，所以該芯片I2C從設(shè)備地址為0x51。如下圖所示：

（2）K24C02芯片的讀操作
K24C02芯片的讀操作共分為3種，分別為當(dāng)前地址讀（Current Address Read）、隨機(jī)讀（Random Read）和連續(xù)讀（Sequential Read）。
其中，當(dāng)前地址讀（Current Address Read）操作是控制i2c與K24C02通信，通信內(nèi)容為： ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 從設(shè)備地址（1個(gè)字節(jié)，bit0為1，表示讀） + 數(shù)據(jù)（1個(gè)字節(jié)，K24C02發(fā)送給CPU的存儲(chǔ)內(nèi)容）。該讀操作沒(méi)有附帶EEPROM的存儲(chǔ)地址，存儲(chǔ)地址是由上一次存儲(chǔ)地址累加而來(lái)。如下圖所示：

? ?連續(xù)讀操作（Sequential Read）則控制控制i2c往K24C02發(fā)送N個(gè)字節(jié)，通信內(nèi)容為：從設(shè)備地址（bit0為1，表示讀） + N個(gè)數(shù)據(jù)（K24C02發(fā)送給CPU）。具體數(shù)據(jù)傳輸如下圖所示：

（3）K24C02芯片的寫(xiě)操作
K24C02芯片寫(xiě)數(shù)據(jù)操作可分為2種，分別為字節(jié)寫(xiě)操作（Byte Write）和頁(yè)寫(xiě)操作（Page Write）。
其中，字節(jié)寫(xiě)操作（Byte Write）控制i2c與K24C02通信，通信內(nèi)容為：從設(shè)備地址（1個(gè)字節(jié)，bit0為0，表示寫(xiě)） + 存儲(chǔ)地址（1個(gè)字節(jié)） + 數(shù)據(jù)（1個(gè)字節(jié)，CPU發(fā)送給K24C0的存儲(chǔ)內(nèi)容）。具體數(shù)據(jù)傳輸如下圖所示：

頁(yè)寫(xiě)操作（Page Write）則控制i2c與K24C02通信，通信內(nèi)容為：從設(shè)備地址（1個(gè)字節(jié)，bit0為0，表示寫(xiě)） + 存儲(chǔ)地址（1個(gè)字節(jié)） + 數(shù)據(jù)（N個(gè)字節(jié)，CPU發(fā)送給K24C0的存儲(chǔ)內(nèi)容）。其中，存儲(chǔ)數(shù)據(jù)的N個(gè)字節(jié)，N不能超過(guò)Page大?。↘24C02的頁(yè)大小為8個(gè)字節(jié)）。
三、程序設(shè)計(jì)
程序控制RK2206芯片的I2C與K24C02芯片通信，每5秒往某一塊存儲(chǔ)空間（該存儲(chǔ)空間地址依次累加）寫(xiě)入不同數(shù)據(jù)，然后再讀取出來(lái)。
１、主程序設(shè)計(jì)
如圖所示為EEPROM存儲(chǔ)主程序流程圖，開(kāi)機(jī)LiteOS系統(tǒng)初始化后，進(jìn)入主程序后。主程序首先初始化i2c總線。其次，程序進(jìn)入主循環(huán)，每5秒將不同的數(shù)據(jù)寫(xiě)入到一塊存儲(chǔ)空間，然后再讀取回去。其中，存儲(chǔ)空間地址每次循環(huán)都累加32，數(shù)據(jù)也隨著循環(huán)而累加1。

while (1)
   {
       printf("************ Eeprom Process ************\n");
       printf("BlockSize = 0x%x\n", eeprom_get_blocksize());
       
       /* 寫(xiě)EEPROM */
       memset(buffer, 0, sizeof(buffer));
       for (unsigned int i = 0; i < FOR_CHAR; i++)
       {
           buffer[i] = data_offset + i;
           printf("Write Byte: %d = %c\n", addr_offset + i, buffer[i]);
       }
       ret = eeprom_write(addr_offset, buffer, FOR_CHAR);
       if (ret != FOR_CHAR)
       {
           printf("EepromWrite failed(%d)\n", ret);
       }
       
       /* 讀EEPROM */
       memset(buffer, 0, sizeof(buffer));
       ret = eeprom_read(addr_offset, buffer, FOR_CHAR);
       if (ret != FOR_CHAR)
       {
           printf("Read Bytes: failed!\n");
       }
       else
       {
           for (unsigned int i = 0; i < FOR_CHAR; i++)
           {
               printf("Read Byte: %d = %c\n", addr_offset + i, buffer[i]);
           }
       }
       
       data_offset++;
       if (data_offset >= CHAR_END)
       {
           data_offset = CHAR_START;
       }
       
       addr_offset += FOR_ADDRESS;
       if (addr_offset >= 200)
       {
           addr_offset = 0;
       }
       printf("\n");
       
       LOS_Msleep(5000);
   }

２、EEPROM初始化程序設(shè)計(jì)
?主程序通過(guò)控制RK2206芯片的接口對(duì)i2c總線進(jìn)行初始化。

#define EEPROM_I2C_BUS          0
#define EEPROM_I2C_ADDRESS      0x51
static I2cBusIo m_i2cBus = {
   .scl =  {.gpio = GPIO0_PA1, .func = MUX_FUNC3, .type = PULL_NONE, .drv = DRIVE_KEEP, .dir = LZGPIO_DIR_KEEP, .val = LZGPIO_LEVEL_KEEP},
   .sda =  {.gpio = GPIO0_PA0, .func = MUX_FUNC3, .type = PULL_NONE, .drv = DRIVE_KEEP, .dir = LZGPIO_DIR_KEEP, .val = LZGPIO_LEVEL_KEEP},
   .id = FUNC_ID_I2C0,
   .mode = FUNC_MODE_M2,
};
static unsigned int m_i2c_freq = 100000;

unsigned int eeprom_init()
{
   if (I2cIoInit(m_i2cBus) != LZ_HARDWARE_SUCCESS) {
       printf("%s, %d: I2cIoInit failed!\n", __FILE__, __LINE__);
       return __LINE__;
   }
   if (LzI2cInit(EEPROM_I2C_BUS, m_i2c_freq) != LZ_HARDWARE_SUCCESS) {
       printf("%s, %d: I2cInit failed!\n", __FILE__, __LINE__);
       return __LINE__;
   }
   /* GPIO0_A0 => I2C1_SDA_M1 */
   PinctrlSet(GPIO0_PA0, MUX_FUNC3, PULL_NONE, DRIVE_KEEP);
   /* GPIO0_A1 => I2C1_SCL_M1 */
PinctrlSet(GPIO0_PA1, MUX_FUNC3, PULL_NONE, DRIVE_KEEP);
   return 0;
}

３、EEPROM讀操作程序設(shè)計(jì)
?蜂鳴器控制程序當(dāng)開(kāi)啟蜂鳴器時(shí)，打開(kāi)蜂鳴器，并且設(shè)置PWM波的周期為100毫秒，其中占空比50%；當(dāng)關(guān)閉蜂鳴器時(shí)，則停止蜂鳴器。

#define EEPROM_I2C_BUS          0
#define EEPROM_I2C_ADDRESS      0x51
/* EEPROM型號(hào)：K24C02，2Kbit（256Byte），32頁(yè)，每頁(yè)8個(gè)字節(jié)（Byte） */
#define EEPROM_ADDRESS_MAX      256
#define EEPROM_PAGE             8
unsigned int eeprom_readbyte(unsigned int addr, unsigned char *data)
{
   unsigned int ret = 0;
   unsigned char buffer[1];
   LzI2cMsg msgs[2];
   /* K24C02的存儲(chǔ)地址是0~255 */
   if (addr >= EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr(0x%x) >= EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr, EEPROM_ADDRESS_MAX);
       return 0;
}
   buffer[0] = (unsigned char)addr;
   msgs[0].addr = EEPROM_I2C_ADDRESS;
   msgs[0].flags = 0;
   msgs[0].buf = &buffer[0];
   msgs[0].len = 1;
   msgs[1].addr = EEPROM_I2C_ADDRESS;
   msgs[1].flags = I2C_M_RD;
   msgs[1].buf = data;
   msgs[1].len = 1;
 ?ret = LzI2cTransfer(EEPROM_I2C_BUS, msgs, 2);
 ?if (ret != LZ_HARDWARE_SUCCESS) {
     ?printf("%s, %s, %d: LzI2cTransfer failed(%d)!\n", __FILE__, __func__, __LINE__, ret);
     ?return 0;
 ?}
 ?return 1;
}
unsigned int eeprom_read(unsigned int addr, unsigned char *data, unsigned int data_len) 
{
   unsigned int ret = 0;
   if (addr >= EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr(0x%x) >= EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr, EEPROM_ADDRESS_MAX);
       return 0;
}
   if ((addr + data_len) > EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr + len(0x%x) > EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr + data_len, EEPROM_ADDRESS_MAX);
       return 0;
}  
   ret = eeprom_readbyte(addr, data);
   if (ret != 1) {
       printf("%s, %s, %d: EepromReadByte failed(%d)\n", __FILE__, __func__, __LINE__, ret);
       return 0;
}
   if (data_len > 1) {
       ret = LzI2cRead(EEPROM_I2C_BUS, EEPROM_I2C_ADDRESS, &data[1], data_len - 1);
       if (ret < 0) {
           printf("%s, %s, %d: LzI2cRead failed(%d)!\n", __FILE__, __func__, __LINE__, ret);
           return 0;
       }
}
   return data_len;
}

4、EEPROM寫(xiě)操作程序設(shè)計(jì)
?主程序根據(jù)存儲(chǔ)地址、存儲(chǔ)數(shù)據(jù)和數(shù)據(jù)長(zhǎng)度的不同，選用字節(jié)寫(xiě)操作或頁(yè)寫(xiě)操作。具體源代碼如下所示：

#define EEPROM_I2C_BUS          0
#define EEPROM_I2C_ADDRESS      0x51
/* EEPROM型號(hào)：K24C02，2Kbit（256Byte），32頁(yè)，每頁(yè)8個(gè)字節(jié)（Byte） */
#define EEPROM_ADDRESS_MAX      256
#define EEPROM_PAGE             8
unsigned int eeprom_writebyte(unsigned int addr, unsigned char data)
{
   unsigned int ret = 0;
   LzI2cMsg msgs[1];
   unsigned char buffer[2];
   /* K24C02的存儲(chǔ)地址是0~255 */
   if (addr >= EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr(0x%x) >= EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr, EEPROM_ADDRESS_MAX);
       return 0;
}
   buffer[0] = (unsigned char)(addr & 0xFF);
buffer[1] = data;
   msgs[0].addr = EEPROM_I2C_ADDRESS;
   msgs[0].flags = 0;
   msgs[0].buf = &buffer[0];
   msgs[0].len = 2;
   ret = LzI2cTransfer(EEPROM_I2C_BUS, msgs, 1);
   if (ret != LZ_HARDWARE_SUCCESS) {
     ?printf("%s, %s, %d: LzI2cTransfer failed(%d)!\n", __FILE__, __func__, __LINE__, ret);
     ?return 0;
}
   /* K24C02芯片需要時(shí)間完成寫(xiě)操作，在此之前不響應(yīng)其他操作*/
   eeprog_delay_usec(1000);
   return 1;
}
unsigned int eeprom_writepage(unsigned int addr, unsigned char *data, unsigned int data_len)
{
   unsigned int ret = 0;
   LzI2cMsg msgs[1];
   unsigned char buffer[EEPROM_PAGE + 1];
   
   /* K24C02的存儲(chǔ)地址是0~255 */
   if (addr >= EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr(0x%x) >= EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr, EEPROM_ADDRESS_MAX);
       return 0;
   }
   if ((addr % EEPROM_PAGE) != 0) {
       printf("%s, %s, %d: addr(0x%x) is not page addr(0x%x)\n", __FILE__, __func__, __LINE__, addr, EEPROM_PAGE);
       return 0;
}
   if ((addr + data_len) > EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr + data_len(0x%x) > EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr + data_len, EEPROM_ADDRESS_MAX);
       return 0;
}
   if (data_len > EEPROM_PAGE) {
       printf("%s, %s, %d: data_len(%d) > EEPROM_PAGE(%d)\n", __FILE__, __func__, __LINE__, data_len, EEPROM_PAGE);
       return 0;
}
   buffer[0] = addr;
   memcpy(&buffer[1], data, data_len);
   msgs[0].addr = EEPROM_I2C_ADDRESS;
   msgs[0].flags = 0;
   msgs[0].buf = &buffer[0];
   msgs[0].len = 1 + data_len;
   ret = LzI2cTransfer(EEPROM_I2C_BUS, msgs, 1);
   if (ret != LZ_HARDWARE_SUCCESS) {
     ?printf("%s, %s, %d: LzI2cTransfer failed(%d)!\n", __FILE__, __func__, __LINE__, ret);
     ?return 0;
}
   /* K24C02芯片需要時(shí)間完成寫(xiě)操作，在此之前不響應(yīng)其他操作*/
   eeprog_delay_usec(1000);
   return data_len;
}
unsigned int eeprom_write(unsigned int addr, unsigned char *data, unsigned int data_len)
{
   unsigned int ret = 0;
   unsigned int offset_current = 0;
   unsigned int page_start, page_end;
   unsigned char is_data_front = 0;
   unsigned char is_data_back = 0;
   unsigned int len;
   if (addr >= EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr(0x%x) >= EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr, EEPROM_ADDRESS_MAX);
       return 0;
}
   if ((addr + data_len) > EEPROM_ADDRESS_MAX) {
       printf("%s, %s, %d: addr + len(0x%x) > EEPROM_ADDRESS_MAX(0x%x)\n", __FILE__, __func__, __LINE__, addr + data_len, EEPROM_ADDRESS_MAX);
       return 0;
}
   /* 判斷addr是否是頁(yè)地址 */
   page_start = addr / EEPROM_PAGE;
   if ((addr % EEPROM_PAGE) != 0) {
       page_start += 1;
       is_data_front = 1;
}
   /* 判斷addr + data_len是否是頁(yè)地址 */
   page_end = (addr + data_len) / EEPROM_PAGE;
   if ((addr + data_len) % EEPROM_PAGE != 0) {
       page_end += 1;
       is_data_back = 1;
}
   offset_current = 0;
   
   /* 處理前面非頁(yè)地址的數(shù)據(jù)，如果是頁(yè)地址則不執(zhí)行 */
   for (unsigned int i = addr; i < (page_start * EEPROM_PAGE); i++) {
       ret = eeprom_writebyte(i, data[offset_current]);
       if (ret != 1) {
           printf("%s, %s, %d: EepromWriteByte failed(%d)\n", __FILE__, __func__, __LINE__, ret);
           return offset_current;
       }
       offset_current++;
}
   /* 處理后續(xù)的數(shù)據(jù)，如果數(shù)據(jù)長(zhǎng)度不足一個(gè)Page，則不執(zhí)行 */
   for (unsigned int page = page_start; page < page_end; page++) {
       len = EEPROM_PAGE;
       if ((page == (page_end - 1)) && (is_data_back)) {
           len = (addr + data_len) % EEPROM_PAGE;
       }
   
       ret = eeprom_writepage(page * EEPROM_PAGE, &data[offset_current], len);
       if (ret != len) {
           printf("%s, %s, %d: EepromWritePage failed(%d)\n", __FILE__, __func__, __LINE__, ret);
           return offset_current;
       }
       offset_current += EEPROM_PAGE;
}
   return data_len;
}

四、編譯過(guò)程
1、搭建和下載源代碼
我已將OpenHarmony源代碼上傳到Gitee社區(qū)中，大家可以根據(jù)以下網(wǎng)址下載。
https://gitee.com/Lockzhiner-Electronics/lockzhiner-rk2206-openharmony3.0lts
注意：編譯環(huán)境可根據(jù)以下網(wǎng)址來(lái)操作：https://gitee.com/Lockzhiner-Electronics/lockzhiner-rk2206-openharmony3.0lts/blob/master/vendor/lockzhiner/rk2206/README_zh.md
2、打開(kāi)sdk下面路徑的文件
/vendor/lockzhiner/rk2206/samples/b3_eeprom/eeprom_example.c
注意：Gitee上的EEPROM案例為通用案例，請(qǐng)大家根據(jù)上述的需求修改相關(guān)源代碼。
3、修改編譯腳本
修改 vendor/lockzhiner/rk2206/sample 路徑下 BUILD.gn 文件，指定 eeprom_example 參與編譯。
"./b3_eeprom:eeprom_example",
修改 device/lockzhiner/rk2206/sdk_liteos 路徑下 Makefile 文件，添加 -leeprom_example 參與編譯。
hardware_LIBS = -lhal_iothardware -lhardware -leeprom_example?
3、編譯固件
hb set -root .
hb set
hb build -f
4、燒寫(xiě)固件
請(qǐng)參考Gitee網(wǎng)址的說(shuō)明手冊(cè)（“燒錄打印”章節(jié)）：https://gitee.com/Lockzhiner-Electronics/lockzhiner-rk2206-openharmony3.0lts/blob/master/device/rockchip/README_zh.md

五、實(shí)驗(yàn)結(jié)果
?程序編譯燒寫(xiě)到開(kāi)發(fā)板后，按下開(kāi)發(fā)板的RESET按鍵，通過(guò)串口軟件查看日志如下：

************ Eeprom Process ************
BlockSize = 0x8
Write Byte: 3 = !
Write Byte: 4 = "
Write Byte: 5 = #
Write Byte: 6 = $
Write Byte: 7 = %
Write Byte: 8 = &
Write Byte: 9 = '
Write Byte: 10 = (
Write Byte: 11 = )
Write Byte: 12 = *
Write Byte: 13 = +
Write Byte: 14 = ,
Write Byte: 15 = -
Write Byte: 16 = .
Write Byte: 17 = /
Write Byte: 18 = 0
Write Byte: 19 = 1
Write Byte: 20 = 2
Write Byte: 21 = 3
Write Byte: 22 = 4
Write Byte: 23 = 5
Write Byte: 24 = 6
Write Byte: 25 = 7
Write Byte: 26 = 8
Write Byte: 27 = 9
Write Byte: 28 = :
Write Byte: 29 = ;
Write Byte: 30 = <
Write Byte: 31 = =
Write Byte: 32 = >
Read Byte: 3 = !
Read Byte: 4 = "
Read Byte: 5 = #
Read Byte: 6 = $
Read Byte: 7 = %
Read Byte: 8 = &
Read Byte: 9 = '
Read Byte: 10 = (
Read Byte: 11 = )
Read Byte: 12 = *
Read Byte: 13 = +
Read Byte: 14 = ,
Read Byte: 15 = -
Read Byte: 16 = .
Read Byte: 17 = /
Read Byte: 18 = 0
Read Byte: 19 = 1
Read Byte: 20 = 2
Read Byte: 21 = 3
Read Byte: 22 = 4
Read Byte: 23 = 5
Read Byte: 24 = 6
Read Byte: 25 = 7
Read Byte: 26 = 8
Read Byte: 27 = 9
Read Byte: 28 = :
Read Byte: 29 = ;
Read Byte: 30 = <
Read Byte: 31 = =
Read Byte: 32 = >
......

好了，今天的課程就到這里，我們下次再見(jiàn)！