痞子衡嵌入式：其實i.MXRT1050,1020,1015系列ROM也提供了FlexSPI driver API

---

　　大家好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給大家介紹的是i.MXRT1050/1020/1015系列ROM中的FlexSPI驅動API使用。

　　今天痞子衡去4S店給愛車做保養了，保養一次要等兩小時，閑來無聊就寫了這篇文章打發時間，正好痞子衡技術交流群里有朋友也在問這個主題，急人所急是痞子衡的一大特質（此處請允許我裝一下）。

　　本篇是 《利用i.MXRT1xxx系列ROM提供的FlexSPI driver API可輕松IAP》 的續集，上篇文章基本上把ROM API原理及使用講得很透徹了，但文中賣了一個關子，即i.MXRT1xxx系列一共出了7款型號，但並不是每個型號都開放了ROM API，最早誕生的三款型號（105x、1021、1015）就並沒有開放API（不是沒有API，而是沒有嚴格測試），隨着ROM API的優點逐漸被大家意識到，客戶要求API開放的呼聲也越來越高，因此恩智浦研發團隊對未開放的API做了測試，明確功能一切正常后，終於官宣了。所以今天痞子衡着重講這三款未開放API的RT型號在API使用上跟主流RT型號（如i.MXRT1060）有什么區別。

RT芯片型號	是否支持ROM API	是否全功能API
i.MXRT117x	支持	是
i.MXRT1064	支持	是
i.MXRT106x	支持	是
i.MXRT105x	未開放 -> 官宣開放	N/A -> 僅少get_config()
i.MXRT1021	未開放 -> 官宣開放	N/A -> 少get_config()和erase_all()
i.MXRT1015	未開放 -> 官宣開放	N/A -> 少get_config()和erase_all()
i.MXRT1011	支持	否（沒有program()和erase()）

一、ROM API簡介

1.1、API設計實現

　　關於i.MXRT1050/1020/1015 API設計原理，這里就不予贅述了，因為跟i.MXRT1060中是一樣的。咱們直接看它們的API原型 bootloader_api_entry_t，細心的朋友會發現在原型定義上跟i.MXRT1060是有區別的，結構體中前3個成員順序上不一樣，其實這是早期的原型定義，存在不合理的地方，顯然version放第一個才符合API標准定義，因此這在i.MXRT1060中得到了改進。此外在后面API分組功能上也差異較大，不過我們最在意的FlexSPI NOR驅動API在就行。

typedef struct
{
    void (*runBootloader)(void *arg);
    const uint32_t version;
    const char * copyright;
    const hab_rvt_t* habDriver;

    //!< FlexSPI NOR Flash API
    const flexspi_nor_driver_interface_t* flexSpiNorDriver;

    const flexspi_nand_driver_interface_t* flexSpiNandDriver;
    const nand_ecc_driver_interface_t *nandEccDriver;
    const dcp_aes_driver_interface_t *dcpAesDriver;
}bootloader_api_entry_t;

　　下面是i.MXRT1050中的g_bootloaderTree實例，其實只真正提供了HAB、FlexSPI NOR、NAND ECC三類API：

// Bootloader API Tree
const bootloader_api_entry_t g_bootloaderTree =
{
    .runBootloader = run_bootloader,
    .version = MAKE_VERSION(1, 1, 0),
    .copyright = "Copyright 2017 NXP",
    .habDriver = &hab_rvt,
    .flexSpiNorDriver = &g_flexspiNorDriverInterface,
    .flexSpiNandDriver = NULL,
    .nandEccDriver = &g_nandEccDriverInterface,
};

　　下面是i.MXRT1020/1015中的g_bootloaderTree實例，這里甚至只提供了FlexSPI NOR API，沒辦法，BootROM空間有限：

// Bootloader API Tree
const bootloader_api_entry_t g_bootloaderTree =
{
    .runBootloader = run_bootloader,
    .version = MAKE_VERSION(1, 0, 0),
    .copyright = "Copyright 2017 NXP",
    .habDriver = NULL,
    .flexSpiNorDriver = &g_flexspiNorDriverInterface,
};

二、API之FlexSPI驅動

2.1 FlexSPI驅動原型

　　flexspi_nor_driver_interface_t是FlexSPI NOR驅動的原型，原型中定義了全部的API函數，但具體在每個RT型號里並不是都有實例。

　　下面是i.MXRT1050中的g_flexspiNorDriverInterface實例，缺少了get_config()函數實現：

const flexspi_nor_driver_interface_t g_flexspiNorDriverInterface =
{
    .version = MAKE_VERSION(1, 4, 0),
    .init = flexspi_nor_flash_init,
    .program = flexspi_nor_flash_page_program,
    .erase_all = flexspi_nor_flash_erase_all,
    .erase = flexspi_nor_flash_erase,
    .read = flexspi_nor_flash_read,
    .clear_cache = flexspi_clear_cache,
    .xfer = flexspi_command_xfer,
    .update_lut = flexspi_update_lut,
};

　　下面是i.MXRT1020/1015中的g_flexspiNorDriverInterface實例，除了缺少get_config()函數，還缺少erase_all()函數實現：

const flexspi_nor_driver_interface_t g_flexspiNorDriverInterface =
{
    .version = MAKE_VERSION(1, 4, 0),
    .init = flexspi_nor_flash_init,
    .program = flexspi_nor_flash_page_program,
    .erase = flexspi_nor_flash_erase,
    .clear_cache = flexspi_clear_cache,
    .xfer = flexspi_command_xfer,
    .update_lut = flexspi_update_lut,
};

2.2 FlexSPI驅動使用示例

　　根據前面介紹，我們知道未開放的API主要缺少get_config()函數，其他都是一樣的，但是別小看這個get_config()函數，它可是API簡便易用的核心所在，現在沒有了這個函數，我們只能根據板子上的Flash型號去手工提供512bytes的flexspi_nor_config_t變量。

// 找到API根結構體
#define g_bootloaderTree (*(bootloader_api_entry_t **)0x0020001c)

// 定義FlexSPI配置變量
flexspi_nor_config_t config;
uint32_t instance = 0;

// 需要初始化完整512bytes FlexSPI配置變量
config.memConfig.tag     = FLEXSPI_CFG_BLK_TAG
config.memConfig.version = FLEXSPI_CFG_BLK_VERSION
// ...

// 調用API中init()函數
g_bootloaderTree->flexSpiNorDriver->init(instance, &config);
// 調用API中erase()函數
g_bootloaderTree->flexSpiNorDriver->erase(instance, &config, 0x40000, 0x1000);

2.3 FlexSPI配置變量初始化

　　那么如何初始化這512bytes的flexspi_nor_config_t變量呢，這就說來話長了，痞子衡講一個最常見的四線QSPI Flash的配置吧。

　　我們知道i.MXRT1060-EVK上默認連的是ISSI的8MB QSPI Flash，SDK XIP工程里默認使用了它的配置，在 \SDK_2.x.x_EVK-MIMXRT1060\boards\evkmimxrt1060\xip\evkmimxrt1060_flexspi_nor_config.c中定義了常量 qspiflash_config，我們可以參考這個常量定義。

　　qspiflash_config適用於四線、100MHz、8MB的Flash，如果你的QSPI Flash在大小和速度上與它不同，可以做相應調整。不過這個qspiflash_config主要是給ROM啟動用的，而ROM啟動僅需要讀Flash，因此這個配置中LUT僅有Read，而我們需要的API一般都要實現擦除和編程，因此要修改其lookupTable如下：

config.memConfig.lookupTable = 
{
        // Sequence 0 - Quad Read
        // 0x6B - Fast read Quad Output command, 0x18 - 24 bit address
        [0]  = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x6B,
                               kFLEXSPI_Command_RADDR_SDR, kFLEXSPI_1PAD, 0x18),
        // 0x08 - 8 dummy clocks, 0x80 - read 128 bytes
        [1]  = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_DUMMY_SDR, kFLEXSPI_4PAD, 0x08,
                               kFLEXSPI_Command_READ_SDR,  kFLEXSPI_4PAD, 0x80),

        // Sequence 1 - Read Status Register
        // 0x05 - Read status register command, 0x4 - read 4 bytes
        [4]  = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x05,
                               kFLEXSPI_Command_READ_SDR,  kFLEXSPI_1PAD, 0x04),

        // Sequence 2 - Write Status Register 2
        // 0x31 - Write status register 2 command, 0x1 - write 1 byte
        [8]  = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x31,
                               kFLEXSPI_Command_WRITE_SDR, kFLEXSPI_1PAD, 0x01),

        // Sequence 3 - Write enable
        // 0x06 - Write enable command
        [12] = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x06,
                               kFLEXSPI_Command_STOP,      0x00,          0x00),
        //[16] - Seq 4 empty

        // Sequence 5 - 4K Sector erase
        // 0x20 - Sector erase command, 0x18 - 24 bit address
        [20] = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x20,
                               kFLEXSPI_Command_RADDR_SDR, kFLEXSPI_1PAD, 0x18),
        //[24] - Seq 6 empty
        //[28] - Seq 7 empty
        //[32] - Seq 8 empty

        // Sequence 9 - Page Program, 256 bytes
        // 0x02 - page program command, 0x18 - 24 bit address
        [36] = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x02,
                               kFLEXSPI_Command_RADDR_SDR, kFLEXSPI_1PAD, 0x18),
        // 0x04 - write 4 bytes
        [37] = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_WRITE_SDR, kFLEXSPI_1PAD, 0x04,
                               kFLEXSPI_Command_STOP,      0x00,          0x00),
        //[40] - Seq 10 empty
        //[44] - Seq 11 empty

        // Sequence 12 - Read JEDEC
        // 0x9F - read JEDEC command, 0x04 - read 4 bytes
        [48] = FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR,       kFLEXSPI_1PAD, 0x9F,
                               kFLEXSPI_Command_READ_SDR,  kFLEXSPI_1PAD, 0x04),
        //[52-60] - Seqs 13 - 15 empty
};

　　至此，i.MXRT1050/1020/1015系列ROM中的FlexSPI驅動API使用痞子衡便介紹完畢了，掌聲在哪里~~~

歡迎訂閱

文章會同時發布到我的 博客園主頁、CSDN主頁、知乎主頁、微信公眾號 平台上。

微信搜索"痞子衡嵌入式"或者掃描下面二維碼，就可以在手機上第一時間看了哦。