痞子衡嵌入式：從頭開始認識i.MXRT啟動頭FDCB里的lookupTable

2021 年 4 月 9 日
筆記
D2.單片機i.MXRT-CM7

　　大家好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給大家介紹的是i.MXRT啟動頭FDCB里的lookupTable。

　　一個MCU內部通常有很多外設模組，這些外設模組是各MCU廠商做差異化產品的本質，也是各廠商核心競爭力所在（這裡特指那些生產ARM Cortex-M內核MCU的廠商）。在做MCU開發時有時候並不需要了解全部的外設，因為有些外設在項目里不一定會用到，但是要想把恩智浦i.MXRT系列MCU玩起來，有一個外設是必須要有所了解的，它就是FlexSPI，這個外設負責與外部串列NOR Flash連接，實現外部NOR Flash里的應用程式指令與數據的讀取，而串列NOR Flash正是i.MXRT首選的啟動設備。

　　那麼在FlexSPI外設模組里究竟是什麼機制實現了Flash中應用程式指令與數據的讀取功能呢？痞子衡從i.MXRT啟動頭FDCB里的lookupTable設定開始說起：

一、為何i.MXRT能從外部Flash XIP啟動？

　　關於在串列NOR Flash XIP執行原理，痞子衡其實在之前一篇文章《在串列NOR Flash XIP調試原理》的第二小節 i.MXRT FlexSPI外設特性 介紹過，是FlexSPI這個外設實現了從串列Flash任意地址取指令的功能，這是先決條件。

　　有了從Flash任意地址取指的先決條件基礎，在i.MXRT晶片上電後，BootROM便只需要將FlexSPI外設配置到指定工作狀態（這裡詳見《深入i.MXRT1050系列ROM中串列NOR Flash啟動初始化流程》一文，尤其是文中最後一節提到的第二次FlexSPI初始化，本文討論的內容其實屬於第二次初始化後的狀態），FlexSPI外設配置資訊完全來自於啟動頭FDCB（一共512bytes），FlexSPI配置完成後，BootROM再把CPU控制權交給應用程式，這就完成了啟動任務。

　　下面的 qspiflash_config 便是i.MXRT SDK包里使用的一個典型的適用符合JEDEC SFDP標準且容量為8MB的QSPI NOR Flash的FDCB頭。這個啟動頭將FlexSPI配置成了四線模式，100MHz時鐘頻率，Quad I/O Fast Read時序模式（注意這個頭裡lookupTable設定寫法其實並不標準，沒有顯式地寫出模式序列和停止序列，後面痞子衡會細說）：

　　當PC開始指向FlexSPI映射空間（0x60000000 – 0x607FFFFF）去執行用戶程式時，FlexSPI便在背後一直默默為CPU送上指定的指令數據，如下圖綠色箭頭流向所示。指令數據從外部Flash中通過IO_CTL且按照SEQ_CTL指定的時序送入RX_FIFO，再到AHB_RX_BUF，最後經過AHB_CTL送到系統AHB匯流排上，以被CPU無障礙獲取。整個過程中最重要的自動化環節其實是黃色框內的SEQ_CTL，是這個SEQ_CTL在時刻驅動著FlexSPI發送符合Flash要求的讀訪問時序。

二、FlexSPI外設的SEQ_CTL是如何工作的？

　　經過上一節的分析，我們知道了是FlexSPI中的SEQ_CTL組件實現了核心的Flash訪問時序控制，那麼SEQ_CTL我們該怎麼控制它？別急，這時候該LUT登場，LUT是Look Up Table的簡稱，它其實是FlexSPI內部的一塊存儲區（即FlexSPI->LUTx暫存器），它的組織結構如下，LUT由多個Sequence組成（比如i.MXRT1050上是16個），每個Sequence由最多8個instruction組成，每個instruction大小為16bits，分為opcode（序列編號） + num_pads（管腳模式） + operand（序列參數值）三部分。

　　每個instruction，你可以理解為一個Flash訪問傳輸子序列（比如命令序列、地址序列、模式序列，dummy序列，讀/寫數據序列，停止序列等），在FlexSPI外設模組裡面預先實現了很多個基礎instruction，instruction中的opcode即是那些預實現的序列編號。opcode全部編號如下：

命令序列:
    CMD_SDR   - 0x01， CMD_DDR   - 0x21
地址序列：
    RADDR_SDR - 0x02， RADDR_DDR - 0x22， CADDR_SDR - 0x03， CADDR_DDR - 0x23
模式序列：
    MODE1_SDR - 0x04， MODE1_DDR - 0x24， MODE2_SDR - 0x05， MODE2_DDR - 0x25
    MODE4_SDR - 0x06， MODE4_DDR - 0x26， MODE8_SDR - 0x07， MODE8_DDR - 0x27
寫數據序列:
    WRITE_SDR - 0x08， WRITE_DDR - 0x28
讀數據序列:
    READ_SDR  - 0x09， READ_DDR  - 0x29
LEARN序列:
    LEARN_SDR - 0x0A， LEARN_DDR - 0x2A
數據長度設置序列（適用FPGA）:
    DATSZ_SDR - 0x0B， DATSZ_DDR - 0x2B
空指令序列::
    DUMMY_SDR - 0x0C， DUMMY_DDR - 0x2C， DUMMY_RWDS_SDR - 0x0D， DUMMY_RWDS_DDR - 0x2D
JMP序列:
    JMP_ON_CS - 0x1F
停止序列:
    STOP      - 0x00

　　有了這些基礎instruction，我們便可以自由組合它們（最多8個），得到我們想要的完整傳輸Sequence。比如最常見的Quad I/O Read SDR傳輸時序便由CMD_SDR + RADDR_SDR + MODE8_SDR + DUMMY_SDR + READ_SDR + STOP六個子序列組成，如下表所示：

Note: 關於READ_SDR的參數值設置（即讀取數據長度）需要特別說明一下，這個參數僅對IP CMD方式的訪問時序有效；而對於AHB CMD方式的訪問時序，這個參數值設定是無效的，實際讀取數據長度是由AHB RX Buffer策略靈活決定的。

　　從引腳訊號上來看，完整Quad I/O Read SDR傳輸時序如下圖所示。注意有一處要特別說明，從FlexSPI外設本身而言，MODE8_SDR序列和DUMMY_SDR序列是互相獨立的，但在不少Flash晶片上，MODE8_SDR所佔的2個時鐘周期也被算在了總Dummy時鐘周期數里。

　　LUT中最多可以存儲16個Sequence，對於XIP執行而言，只需要一個讀訪問時序（比如最常用的Quad I/O Read SDR傳輸時序）即可。如果是IAP，那麼還需要添加擦除時序，寫訪問時序，寫使能時序，讀狀態暫存器時序等。這些預先存放在LUT中的Sequence被用戶按需觸發以實現各種不同類型的Flash訪問，這就是SEQ_CTL工作機制。

三、FDCB中的lookupTable是如何配置進FlexSPI->LUT的？

　　從FlexSPI外設模組設計上而言，LUT里16個Sequence地位是相同的，對於XIP執行，必要的讀訪問時序可以放在LUT中的任何一個Sequence位置，只需要在FlexSPI->FLSHxCR2暫存器（x可取A1/A2/B1/B2，具體根據Flash引腳連接來定）中的ARDSEQID位指明讀訪問時序在LUT中的位置(index)即可。

　　但是畢竟應用程式是由BootROM引導的，BootROM有自己的一套配置FlexSPI規則，它定死了CMD_LUT_SEQ_IDX_READ位置，即讀訪問時序必須是FlexSPI->LUT[]中第一個Sequence，因為FlexSPI->FLSHxCR2[ARDSEQID]被BootROM配置成了0。所以我們在準備FDCB時，lookupTable中第一個Sequence必須放置讀訪問時序。

　　再來看BootROM中的FlexSPI初始化函數，在外設模組基本初始化 flexspi_init() 完成後，然後 flexspi_update_lut() 被調用去更新了一次LUT就直接結束了。這次的LUT更新其實僅僅是將FDCB里的lookupTable[0] – lookupTable[3]（第一條Sequence）填到 FlexSPI->LUT[0] – FlexSPI->LUT[3]里。至於為何有時候你會看到FDCB里lookupTable中不止一條Sequence，這個痞子衡後面另有文章再聊。

status_t flexspi_nor_flash_init(uint32_t instance, flexspi_nor_config_t *config)
{
    status_t status = kStatus_InvalidArgument;

    status = flexspi_init(instance, (flexspi_mem_config_t *)config);
    if (status != kStatus_Success)
    {
        break;
    }

    // Configure Lookup table for Read
    // 將config->memConfig.lookupTable里的第一個sequence放到FlexSPI->LUT[0] - FlexSPI->LUT[3]里
    flexspi_update_lut(instance, 0, config->memConfig.lookupTable, 1);

    return status;
}

四、設定FDCB中lookupTable的一個實例

　　我們以i.MXRT官方EVK上配套的典型Flash型號IS25WP064AJBLE來實戰，下圖是該Flash的Fast Read Quad I/O Sequence，這個時序圖中命令序列、地址序列、Dummy序列的參數值是明確的，但模式序列、讀數據序列參數值並不明確，我們給它明確一下，模式序列中mode bits我們設為0x00（其實只要不是0xAx均可），即 non-continuous read mode；讀數據序列中data out byte其實不可設（上面講過AHB訪問下是由RX Buffer策略自動控制的），隨便寫個非0值即可。

　　基於上面的真實Flash讀數據傳輸時序圖，我們在FDCB中lookupTable里的對應設定應如下：

#define CMD_LUT_SEQ_IDX_READ        0

#define FLEXSPI_LUT_SEQ(cmd0, pad0, op0, cmd1, pad1, op1)                                  \
    (FLEXSPI_LUT_OPERAND0(op0) | FLEXSPI_LUT_NUM_PADS0(pad0) | FLEXSPI_LUT_OPCODE0(cmd0) | \
     FLEXSPI_LUT_OPERAND1(op1) | FLEXSPI_LUT_NUM_PADS1(pad1) | FLEXSPI_LUT_OPCODE1(cmd1))

#define FLEXSPI_1PAD 0
#define FLEXSPI_2PAD 1
#define FLEXSPI_4PAD 2
#define FLEXSPI_8PAD 3

const flexspi_nor_config_t qspiflash_config = {
    .memConfig =
        {
            .lookupTable =
                {
                    // Quad I/O Fast Read LUTs
                    // 第1個instruction是CMD_SDR，參數值為0xEB，即Quad I/O Fast Read命令
                    // 第2個instruction是RADDR_SDR，參數值為0x18，即24bits地址（三位元組）
                    [4*CMD_LUT_SEQ_IDX_READ + 0] = FLEXSPI_LUT_SEQ(CMD_SDR,   FLEXSPI_1PAD, 0xEB, RADDR_SDR, FLEXSPI_4PAD, 0x18),

                    // 第3個instruction是MODE8_SDR，參數值為0x00。注意對於IS25WP064AJBLE它同時也算2個Dummy時鐘周期！！！
                    // 第4個instruction是DUMMY_SDR，參數值為0x04，加上上面一共6個時鐘周期
                    [4*CMD_LUT_SEQ_IDX_READ + 1] = FLEXSPI_LUT_SEQ(MODE8_SDR, FLEXSPI_4PAD, 0x00, DUMMY_SDR, FLEXSPI_4PAD, 0x04),

                    // 第5個instruction是READ_SDR，參數值為0x04，設定並不生效，隨便寫個非0值都行
                    // 第6個instruction是STOP
                    [4*CMD_LUT_SEQ_IDX_READ + 2] = FLEXSPI_LUT_SEQ(READ_SDR,  FLEXSPI_4PAD, 0x04, STOP,      FLEXSPI_1PAD, 0x00),
                    [4*CMD_LUT_SEQ_IDX_READ + 3] = 0,
                },
        },
};

五、對FlexSPI映射區域進行AHB讀訪問一定會啟動SEQ_CTL工作嗎？

　　當我們放好了正確的FDCB，BootROM正常配置完FlexSPI，並啟動了應用程式後，CPU便開始按部就班從FlexSPI映射區域直接AHB訪問去獲取應用程式指令，是不是每一次的CPU訪問都會讓SEQ_CTL組件按LUT里的設定發送一次讀訪問時序呢？其實並不是！

　　我們知道i.MXRT系列會有L1 Cache，如果Flash某地址里的指令內容快取在L1 Cache里，那麼當前CPU訪問該Flash地址處的指令並不需要從Flash里重新再獲取一次，CPU直接從cache里便可以得到指令，此時SEQ_CTL不會工作。

　　即便L1 Cache里沒有快取到CPU所要指令，如果FlexSPI本身的Cacheable和Prefetch功能打開的話，AHB RX/TX Buffer里可能也會快取CPU所要指令。如果所需指令確實快取在AHB Buffer里，SEQ_CTL仍然不會工作。

　　僅當CPU所要指令是全新的，完全沒有快取，SEQ_CTL才會真正開始工作，按LUT設定去發送讀數據訪問時序給Flash。

六、AHB讀訪問下SEQ_CTL工作一次到底獲取多長的數據？

　　前面講了，我們在lookupTable里無法有效設置讀數據序列中data out byte，因為AHB訪問下的一次讀取的長度是由RX Buffer策略控制的。在i.MXRT1050中AHB RX Buffer總大小為1KB，分為四個：AHB RX Buffer0 – AHB RX Buffer3，每個Buffer的大小都是可配的。具體配置在如下FlexSPI->AHBRXBUFxCR0暫存器里：

　　BootROM使用了如下 flexspi_config_ahb_buffers() 函數配置了AHB Buffer，即開啟了FlexSPI的Prefetch功能，並且將四個FlexSPI->AHBRXBUFxCR0[BUFSZ]全部設為了0，根據手冊，這種配置意味著僅啟用Buffer3作為唯一的RX Buffer，並且Buffer3大小為1KB。那麼我們現在知道了，在Prefetch開啟的情況下，SEQ_CTL工作一次就會讀取1KB數據。當然Prefetch功能是可以在應用程式里被關掉的，如果Prefetch不使能，SEQ_CTL工作一次僅獲取最小數據單元（8bytes）。

status_t flexspi_config_ahb_buffers(FLEXSPI_Type *base, flexspi_mem_config_t *config)
{
    uint32_t temp;
    uint32_t index;
    status_t status = kStatus_InvalidArgument;

    do
    {
        if ((base == NULL) || (config == NULL))
        {
            break;
        }

        if (config->deviceType == kFlexSpiDeviceType_SerialNOR)
        {
            // Configure AHBCR
            temp = base->AHBCR & (~FLEXSPI_AHBCR_APAREN_MASK);
            // Remove alignment limitation when Flash device works under DDR mode.
            temp |= FLEXSPI_AHBCR_READADDROPT_MASK;
#if FLEXSPI_FEATURE_HAS_PARALLEL_MODE
            if (flexspi_is_parallel_mode(config))
            {
                temp |= FLEXSPI_AHBCR_APAREN_MASK;
            }
#endif // FLEXSPI_FEATURE_HAS_PARALLEL_MODE
            base->AHBCR = temp;
        }

        // Enable prefetch feature
        base->AHBCR |= FLEXSPI_AHBCR_PREFETCHEN_MASK;

        // Skip AHB buffer configuration if corresponding bit is set
        if ((config->controllerMiscOption & (1<<kFlexSpiMiscOffset_SkipAhbBufConfig)))
        {
            status = kStatus_Success;
            break;
        }

        // Configure AHB RX buffer
        for (index = 0; index < FLEXSPI_AHBRXBUFCR0_COUNT - 1; index++)
        {
            base->AHBRXBUFCR0[index] &=
                ~(FLEXSPI_AHBRXBUFCR0_BUFSZ_MASK | FLEXSPI_AHBRXBUFCR0_MSTRID_MASK | FLEXSPI_AHBRXBUFCR0_PRIORITY_MASK);
        }
        status = kStatus_Success;

    } while (0);

    return status;
}

　　至此，i.MXRT啟動頭FDCB里的lookupTable痞子衡便介紹完畢了，掌聲在哪裡~~~

歡迎訂閱

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

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

Tags: D2.單片機i.MXRT-CM7