一網(wǎng)打盡串行Flash驅動資源(上)

大家好，我是痞子衡，是正經(jīng)搞技術的痞子。今天痞子衡給大家介紹的是恩智浦i.MXRT官方SDK里關于串行Flash相關的驅動與例程資源。

經(jīng)常有同事以及 i.MXRT 客戶咨詢痞子衡，咱們恩智浦官方 SDK 里有哪些串行 Flash 相關的示例，每一次痞子衡都是按照詢問需求將 SDK 里相應資源路徑發(fā)給對方?？磥砟蔷渌自捳f得也不盡然對，酒香也怕巷子深，今天痞子衡就給大家全面梳理一下 SDK 里和串行 Flash 相關的全部資源。

Note 1: 本文內容主要以 SDK_2_15_100_EVKB-IMXRT1050 軟件包里的資源為例Note 2: 本文共分為上下兩篇，本篇是上篇，主要介紹 drives 和 components

一、Flash相關驅動概覽

首先直接開門見山，痞子衡把 SDK 里和 Flash 有關系的驅動全部羅列如下，分布在 device driver、components、middleware、azure-rtos 里。這四個目錄下的驅動關系簡單概括如下：

1. device driver 就是芯片底層外設的 HAL 級驅動，代碼里直接操作外設寄存器。
2. components 是基于 device driver 而設計的面向某個外圍器件/具體小功能的驅動，代碼里直接調用 devcie driver 里的 API。
3. middleware 則是面向某類具體功能的更大型的軟件庫，代碼里一般調用 components 里的 API，強調與芯片外設底層隔離，主打平臺無關的通用性。
4. azure-rtos 本身是硬件無關的 RTOS，但是其也同時包含了一些類似 middleware 功能實現(xiàn)，這些 middlware 會調用 components 里的 API。

二、Flash驅動解釋及例程

2.1 drivers

2.1.1 flexspi

fsl_flexspi 驅動是芯片外設 FlexSPI 的 HAL 級驅動，其是操作 FlexSPI 寄存器以實現(xiàn) 1-8bit SPI 類主設備方式數(shù)據(jù)收發(fā)，其 API 本身和 Flash 芯片操作并沒有直接的聯(lián)系，這從如下主要 API 原型可以看出來：

void?FLEXSPI_Init(FLEXSPI_Type?*base,?const?flexspi_config_t?*config);
void?FLEXSPI_SetFlashConfig(FLEXSPI_Type?*base,?flexspi_device_config_t?*config,?flexspi_port_t?port);
void?FLEXSPI_UpdateLUT(FLEXSPI_Type?*base,?uint32_t?index,?const?uint32_t?*cmd,?uint32_t?count);
status_t?FLEXSPI_WriteBlocking(FLEXSPI_Type?*base,?uint8_t?*buffer,?size_t?size);
status_t?FLEXSPI_ReadBlocking(FLEXSPI_Type?*base,?uint8_t?*buffer,?size_t?size);
status_t?FLEXSPI_TransferBlocking(FLEXSPI_Type?*base,?flexspi_transfer_t?*xfer);
status_t?FLEXSPI_TransferNonBlocking(FLEXSPI_Type?*base,?flexspi_handle_t?*handle,?flexspi_transfer_t?*xfer);

如下配套例程調用 fsl_flexspi 驅動里 API 實現(xiàn)了官方 RT1050-EVKB 板卡上的 hyperflash （S26KS512S） 和四線 nor flash （IS25WP064A） 的讀寫功能驗證。

例程路徑：SDK_2_15_100_EVKB-IMXRT1050boardsevkbimxrt1050driver_examplesflexspi
  - Hyper Flash 驅動：driver_examplesflexspihyper_flashpolling_transferflexspi_hyper_flash_ops.c
  - Nor Flash 驅動：driver_examplesflexspinorpolling_transferflexspi_nor_flash_ops.c

其中例程里的 flexspi_xxx_flash_ops.c 源文件設計其實有那么一點 components 的味道，從 API 命名來看其實現(xiàn)了面向 Flash 的讀寫擦功能，但是 API 里的代碼實現(xiàn)比較簡潔，沒有過度設計，對于不同廠商/類型的 Flash 支持，主要依賴用戶定義的 LUT 表里的命令序列。

void?flexspi_nor/hyper_flash_init(FLEXSPI_Type?*base);
status_t?flexspi_nor_flash_erase_sector(FLEXSPI_Type?*base,?uint32_t?address);
status_t?flexspi_nor_flash_page_program(FLEXSPI_Type?*base,?uint32_t?dstAddr,?const?uint32_t?*src);
status_t?flexspi_nor_flash_read(FLEXSPI_Type?*base,?uint32_t?dstAddr,?const?uint32_t?*src,?uint32_t?length);

2.1.2 lpspi

fsl_lpspi 驅動是芯片外設 LPSPI 的 HAL 級驅動，其是操作 LPSPI 寄存器以實現(xiàn) 1bit（4bit） SPI 主/從設備方式數(shù)據(jù)收發(fā)，API 本身和 Flash 芯片也沒有直接的聯(lián)系。

void?LPSPI_MasterInit(LPSPI_Type?*base,?const?lpspi_master_config_t?*masterConfig,?uint32_t?srcClock_Hz);
void?LPSPI_SlaveInit(LPSPI_Type?*base,?const?lpspi_slave_config_t?*slaveConfig);
status_t?LPSPI_MasterTransferBlocking(LPSPI_Type?*base,?lpspi_transfer_t?*transfer);
status_t?LPSPI_MasterTransferNonBlocking(LPSPI_Type?*base,?lpspi_master_handle_t?*handle,?lpspi_transfer_t?*transfer);
status_t?LPSPI_SlaveTransferNonBlocking(LPSPI_Type?*base,?lpspi_slave_handle_t?*handle,?lpspi_transfer_t?*transfer);

該驅動的配套例程是單純的 SPI 總線傳輸，并沒有針對 Flash，這里就不展開了，但是它會在 components/flash 里被用到，后文會提及。

2.1.3 romapi

fsl_romapi 驅動是芯片固化 BootROM 所導出的通用 Flash API，在 BootROM 里集成了基于 FlexSPI 外設驅動而寫成的通用 Flash 驅動，這個 Flash 驅動設計差不多是 components 級別，具體源代碼原則上不可見，但其實我們可以在 middleware/mcu_bootloader 里大概知道。

例程路徑：SDK_2_15_100_EVKB-IMXRT1050boardsevkbimxrt1050driver_examplesfsl_romapi

該驅動的 API 比較有意思，既有面向 Flash 的寫擦功能，也有偏 FlexSPI 外設 HAL 級別的接口。前者相比 flexspi 驅動配套的例程里對于 Flash 的支持就強大多了，用戶完全可以僅靠 API 定義的簡化參數(shù)來支持不同廠商/類型的 Flash；而后者存在的意義是為了讓用戶能夠進一步設計面向 Flash 的功能函數(shù)。

status_t?ROM_FLEXSPI_NorFlash_Init(uint32_t?instance,?flexspi_nor_config_t?*config);
status_t?ROM_FLEXSPI_NorFlash_ProgramPage(uint32_t?instance,?flexspi_nor_config_t?*config,?uint32_t?dstAddr,?const?uint32_t?*src);
status_t?ROM_FLEXSPI_NorFlash_EraseSector(uint32_t?instance,?flexspi_nor_config_t?*config,?uint32_t?address);
status_t?ROM_FLEXSPI_NorFlash_CommandXfer(uint32_t?instance,?flexspi_xfer_t?*xfer);
status_t?ROM_FLEXSPI_NorFlash_UpdateLut(uint32_t?instance,?uint32_t?seqIndex,?const?uint32_t?*lutBase,?uint32_t?seqNumber);

總結一下，使用 fsl_romapi 例程相比 fsl_flexspi 例程去操作 Flash，好處是省代碼空間且不需要考慮 Read-While-Write 限制（僅對驅動本身執(zhí)行而言，無需代碼重定向，但是全局中斷問題仍要考慮），壞處是源代碼是個黑盒子，出問題不容易定位。

2.2 components

2.2.1 mx25r_flash

mx25r_flash 組件其實是為 LPC54114 板卡上的旺宏寬電壓四線 NOR Flash MX25R 系列而設計的，其在 SDK_2_xxx_LPCXpresso54114boardslpcxpresso54114driver_examplesspipolling_flash 例程里有被調用，而在 i.MXRT 系列 SDK 里并沒有相關例程使用它（不要疑問為啥會出現(xiàn)在軟件包里，多就是好）。這個組件設計得挺有意思，其代碼實現(xiàn)完全與芯片具體外設隔離，外設接口傳輸函數(shù)是通過 callback 形式傳入的，充滿了代碼抽象（面向對象）的味道，有興趣可以查看源碼。

mx25r_err_t?mx25r_init(struct?mx25r_instance?*instance,?transfer_cb_t?callback,?void?*callback_prv);
mx25r_err_t?mx25r_cmd_read(struct?mx25r_instance?*instance,?uint32_t?address,?uint8_t?*buffer,?uint32_t?size);
mx25r_err_t?mx25r_cmd_write(struct?mx25r_instance?*instance,?uint32_t?address_256_align,?uint8_t?*buffer,?uint32_t?size_256_max);
mx25r_err_t?mx25r_cmd_sector_erase(struct?mx25r_instance?*instance,?uint32_t?address);

2.2.2 internal_flash

internal_flash 組件從名字上看像是為片內 Flash 而設計的，但是 i.MXRT 系列并無片內 Flash（RT1024/1064 只是 SIP 了串行 NOR Flash，本質上還是片外）。大家不要被這個名字騙了，這個組件最早確實是用于恩智浦 Kinetis/LPC 系列片內 Flash 的，但是在 i.MX RT 上因為配套 EVK 上有支持 XIP 的外置 NOR Flash，所以這個組件也沿用給這些外置 NOR Flash 了，因此其是基于 flexspi 驅動的組件。

在 componentsinternal_flashfsl_adapter_flash.h 文件里一共定義了 10 個 API 接口，其中如下 4 個是必須要實現(xiàn)的，其余 6 個可以不用實現(xiàn)（跟 Kinetis/LPC 片內 Flash 特性緊相關）。因為 RT1050-EVKB 默認連接的 hyperflash，所以該組件也僅為其做了相應實現(xiàn) componentsinternal_flashhyper_flash。這個組件代碼實現(xiàn)跟 flexspi 驅動配套例程里對于 Flash 的支持差不多。

hal_flash_status_t?HAL_FlashInit(void);
hal_flash_status_t?HAL_FlashProgram(uint32_t?dest,?uint32_t?size,?uint8_t?*pData);
hal_flash_status_t?HAL_FlashEraseSector(uint32_t?dest,?uint32_t?size);
hal_flash_status_t?HAL_FlashRead(uint32_t?src,?uint32_t?size,?uint8_t?*pData);

internal_flash 組件設計的意義在于 SDK 其它例程中如果有 IAP 操作或者存儲運行參數(shù)需求，均可以調用這個統(tǒng)一接口來實現(xiàn)，當然客戶應用有相應需求，也一樣可以使用。

2.2.3 flash

flash 組件里一共有三個：nor、nand、mflash，咱們一個個來說：

2.2.3.1 nor

先來介紹 nor 組件，從如下 API 命名來看，肯定是面向 NOR Flash 的讀寫擦功能，接口設計上對于底層外設采用了輕度抽象的方法，形參不涉及具體外設，但是函數(shù)實現(xiàn)里不同外設需要不同的實現(xiàn)，這也是為什么我們能看到 norflexspi 和 norlpspi 兩個文件夾里的源代碼。雖然底層外設不同，但是它們要操作的均是相同的串行 NOR Flash。

status_t?Nor_Flash_Init(nor_config_t?*config,?nor_handle_t?*handle);
status_t?Nor_Flash_Read(nor_handle_t?*handle,?uint32_t?address,?uint8_t?*buffer,?uint32_t?length);
status_t?Nor_Flash_Page_Program(nor_handle_t?*handle,?uint32_t?address,?uint8_t?*buffer);
status_t?Nor_Flash_Erase_Sector(nor_handle_t?*handle,?uint32_t?address);
status_t?Nor_Flash_Is_Busy(nor_handle_t?*handle,?bool?*isBusy);

norflexspi 里的代碼實現(xiàn)跟 romapi 驅動實現(xiàn)有點像，其會從 Flash 里讀取 SFDP 表進行解析從而自動獲取所需操作命令，不依賴用戶填充 LUT 命令。

例程路徑：SDK_2_15_000_EVKB-IMXRT1050boardsevkbimxrt1050component_examplesflash_componentflexspi_nor

norlpspi 里的代碼實現(xiàn)則比較簡單，因為 LPSPI 外設本身主要支持 1bit SPI 傳輸，所以其也僅實現(xiàn)了一線方式對 Flash 進行讀寫擦，這部分命令是通用的，也無需用戶填充 LUT。

2.2.3.2 nand

再來介紹 nand 組件，從如下 API 命名來看，肯定是面向 NAND Flash 的讀寫擦功能，接口設計上對于底層外設同樣采用了輕度抽象的方法，形參不涉及具體外設，但是函數(shù)實現(xiàn)里不同外設需要不同的實現(xiàn)，這也是為什么我們能看到 nandflexspi 和 norsemc 兩個文件夾里的源代碼。不過 flexspi 外設和 semc 外設所支持的 NAND 不是一個產品，前者是串行 NAND，后者是并行 NAND，完全是兩類不同的存儲器標準。

nandflexspi 里的代碼實現(xiàn)則比較簡潔，因為串行 NAND 發(fā)展不如串行 NOR 那樣豐富多樣，所以其使用了固定 LUT 里的預設命令序列，基本能夠支持華邦等主流四線串行 NAND 產品。

status_t?Nand_Flash_Init(nand_config_t?*config,?nand_handle_t?*handle);
status_t?Nand_Flash_Read_Page(nand_handle_t?*handle,?uint32_t?pageIndex,?uint8_t?*buffer,?uint32_t?length);
status_t?Nand_Flash_Page_Program(nand_handle_t?*handle,?uint32_t?pageIndex,?const?uint8_t?*src,?uint32_t?length);
status_t?Nand_Flash_Erase_Block(nand_handle_t?*handle,?uint32_t?blockIndex);

2.2.3.3 mflash

最后要重點介紹 mflash 組件，其分為 drv 層和 file 層兩種不同類型的 API，drv 層提供基于芯片外設的底層 Flash 操作（詳見 mflashmimxrt1052 文件夾下代碼），file 層則是基于 drv 層里的 API 而設計的輕量級靜態(tài)文件系統(tǒng)，簡單理解就是將 Flash 虛擬成一個由具有固定最大長度的預定義命名文件集組成的存儲空間，我們可以將小數(shù)據(jù)以文件名索引的方式寫入 Flash，適用于需要存儲運行參數(shù)或者設備配置數(shù)據(jù)的場合。

bool?mflash_is_initialized(void);
status_t?mflash_init(const?mflash_file_t?*dir_template,?bool?init_drv);
status_t?mflash_file_save(char?*path,?uint8_t?*data,?uint32_t?size);
status_t?mflash_file_mmap(char?*path,?uint8_t?**pdata,?uint32_t?*psize);

int32_t?mflash_drv_init(void);
int32_t?mflash_drv_sector_erase(uint32_t?sector_addr);
int32_t?mflash_drv_page_program(uint32_t?page_addr,?uint32_t?*data);
int32_t?mflash_drv_read(uint32_t?addr,?uint32_t?*buffer,?uint32_t?len);
void?*mflash_drv_phys2log(uint32_t?addr,?uint32_t?len);
uint32_t?mflash_drv_log2phys(void?*ptr,?uint32_t?len);

mflash 組件會在 middleware 以及 rtos 里被廣泛使用，這個痞子衡將會在下篇里再具體介紹。

至此，恩智浦i.MXRT官方SDK里關于串行Flash相關的驅動與例程資源痞子衡便介紹完畢了，掌聲在哪里~~~