痞子衡嵌入式：其实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,
    .copyright = "Copyright 2017 NXP",
    .version = MAKE_VERSION(1, 1, 0),
    .habDriver = &hab_rvt,

    .flexSpiNorDriver = &g_flexspiNorDriverInterface,

    .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,
    .copyright = "Copyright 2017 NXP",
    .version = MAKE_VERSION(1, 0, 0),

    .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-MIMXRT1060oardsevkmimxrt1060xipevkmimxrt1060_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主页、微信公众号 平台上。

微信搜索"痞子衡嵌入式"或者扫描下面二维码，就可以在手机上第一时间看了哦。