大家好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給大家介紹的是導致串行NOR Flash在i.MXRT下無法正常下載/啟動的常見因素之Write Protection。
i.MXRT系列MCU發布已兩年多了，基於i.MXRT的客戶產品也越來越多，可以說是全面開花了。痞子衡作為i.MXRT產品線的系統應用工程師，早期的時候還可以盡情做參考設計，現在基本大量時間都被客戶支持占據了。
因為i.MXRT系列都沒有內置Flash（RT1064, RT1024等SIP型號除外），因此為其搭配一塊串行NOR Flash去啟動是客戶項目的頭等大事，而串行NOR Flash廠商非常多，客戶選擇余地很大，因此我們不得不與客戶一起同茫茫Flash型號打交道，痞子衡也常常調侃自己已淪為Flash測試工程師。
痞子衡在支持客戶解決串行NOR Flash下載啟動問題過程中主要遇到幾個常見因素，這幾個因素可能會影響Flash在i.MXRT下無法正常使用，上兩篇痞子衡分別講了 《SFDP因素》 和 《QE bit因素》， 今天痞子衡重點跟大家聊聊Write Protection這個因素。
一、引入客戶板子可以啟動、無法再次下載問題
痞子衡最近遇到一個智能電表廠商客戶，他們項目板卡選用的是主控i.MXRT1051 + 華邦W25Q64JVSSIQ，應用程序是MBED bootloader + User App二級加載設計，其中MBED bootloader是由Arm Pelion物聯網小組主導設計的，User App是這個電表廠商自己的功能代碼。
客戶的問題是燒寫了一個特定版本的MBED bootloader運行之后，板卡Flash無法再次做燒寫了，但是板子是能夠正常從Flash啟動的。客戶之后嘗試使用了各種下載工具都不管用（J-Flash/IDE/NXP Tool等），其中下載工具包括痞子衡設計的一站式下載工具 MCUBootUtility ，於是問題就轉到了痞子衡這里（好像有點躺槍的感覺）。工具后台報的錯是擦除或者寫入時會返回 kStatus_FlexSPINOR_CommandFailure，導致無法下載。
既然問題和特定版本的MBED bootloader有關，那看起來就是這個bootloader引入的問題，但是痞子衡拿不到客戶MBED bootloader源碼，無法做白盒分析。鑒於痞子衡這么多年和Flash打交道的經驗，痞子衡盲猜是bootloader使能了Flash的軟件寫保護功能（Software Write Protection）導致的問題，於是痞子衡讓客戶寄來了一塊板卡，實測來證實痞子衡的猜想。
二、修改SDK FlexSPI例程來讀取Status Register
查看W25Q64JVSSIQ數據手冊得知，軟件寫保護功能的配置集成在Flash器件內部非易失性Status Register中，這款Flash一共有3個8bit的Status Register（狀態寄存器均支持易失性寫入（即斷電恢復）和非易失性寫入（即斷電保持），由前導的Write Enable命令類型0x06/0x50決定），並且每個Status Register都有不同的讀寫命令：
現在我們簡單修改了下SDK里的如下flexspi nor例程（選擇ram build），增加上述三個Status Register讀取功能的支持，從而實測讀取Status Register來做驗證。
\SDK_2.9.1_EVKB-IMXRT1050\boards\evkbimxrt1050\driver_examples\flexspi\nor\polling_transfer
首先是在 app.h 和 flexspi_nor_polling_transfer.c 中將Status Register的讀取命令加入到LUT表中。原來工程里已經有Status Register 1的讀取支持，所以我們僅需增加Status Register 2/3的支持即可。因為這新增的兩條命令，需要將CUSTOM_LUT_LENGTH由60改到64（i.MXRT1051上最大64，即支持16條LUT Sequence）。
const uint32_t customLUT[CUSTOM_LUT_LENGTH] = {
// ...
/* 原有 Read status register 1 */
[4 * NOR_CMD_LUT_SEQ_IDX_READSTATUSREG] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x05, kFLEXSPI_Command_READ_SDR, kFLEXSPI_1PAD, 0x04),
/* 新增 Read status register 2 */
[4 * NOR_CMD_LUT_SEQ_IDX_READSTATUSREG2] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x35, kFLEXSPI_Command_READ_SDR, kFLEXSPI_1PAD, 0x04),
/* 新增 Read status register 3 */
[4 * NOR_CMD_LUT_SEQ_IDX_READSTATUSREG3] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x15, kFLEXSPI_Command_READ_SDR, kFLEXSPI_1PAD, 0x04),
// ...
};
然后在 flexspi_nor_flash_ops.c 中新增如下 flexspi_nor_get_status_register() 函數，這個函數直接仿照 flexspi_nor_get_vendor_id() 函數流程寫即可，Flash端時序是一樣的。
status_t flexspi_nor_get_status_register(FLEXSPI_Type *base, uint8_t seqIndex, uint8_t *regValue)
{
uint32_t readValue;
flexspi_transfer_t flashXfer;
flashXfer.deviceAddress = 0;
flashXfer.port = kFLEXSPI_PortA1;
flashXfer.cmdType = kFLEXSPI_Read;
flashXfer.SeqNumber = 1;
flashXfer.seqIndex = seqIndex;
flashXfer.data = &readValue;
flashXfer.dataSize = 1;
status_t status = FLEXSPI_TransferBlocking(base, &flashXfer);
*regValue = (uint8_t)readValue;
/* Do software reset. */
FLEXSPI_SoftwareReset(base);
return status;
}
最后就是在 flexspi_nor_polling_transfer.c 中的 main() 函數里增加 flexspi_nor_get_status_register() 函數調用語句，將Status Register 1/2/3的值全部讀取出來。
static uint8_t s_regValue1 = 0;
static uint8_t s_regValue2 = 0;
static uint8_t s_regValue3 = 0;
int main(void)
{
status_t status;
BOARD_ConfigMPU();
BOARD_InitPins();
BOARD_BootClockRUN();
BOARD_InitDebugConsole();
flexspi_nor_flash_init(EXAMPLE_FLEXSPI);
/* Get status register 1-3. */
status = flexspi_nor_get_status_register(EXAMPLE_FLEXSPI, NOR_CMD_LUT_SEQ_IDX_READSTATUSREG, &s_regValue1);
status = flexspi_nor_get_status_register(EXAMPLE_FLEXSPI, NOR_CMD_LUT_SEQ_IDX_READSTATUSREG2, &s_regValue2);
status = flexspi_nor_get_status_register(EXAMPLE_FLEXSPI, NOR_CMD_LUT_SEQ_IDX_READSTATUSREG3, &s_regValue3);
// ...
}
三、W25Q64JVSSIQ的Write Protection特性
將上一節修改后的 flexspi nor 例程下載進RAM調試運行，可以讀出Status Register 1/2/3的值分別為0x40、0x42、0x60，看起來Status Register確實被MBED bootloader修改過。痞子衡標出了W25Q64JVSSIQ內部狀態寄存器中所有與寫保護相關的bit位如下，我們需要對照Flash數據手冊具體查看讀出來的值對應了什么樣的寫保護設置：
首先Status Register1[SRP]，Status Register2[SRL]以及外部WP#引腳共同決定Status Register設置條件，本例中SRL和SRP均為0，則WP#引腳控制不生效，Status Register可以直接被設置。
Status Register中其他寫保護相關的bit位解釋如下，其中WPS是核心設置，它決定了寫保護是用單獨的Block lock命令來控制（見Flash命令集）還是直接由Status Register1/2中的CMP,TB,SEC,BPx位來決定。
Status Register3[WPS]：決定寫保護策略是獨立的Block鎖定命令控制（WPS=1，默認設置）還是由Status Register1/2控制（WPS=0）
Status Register1[BPx]：指定Flash Memory保護區域塊范圍
Status Register1[SEC]：指定Flash Memory保護區域塊單位是4KB Sector（SEC=1）還是64KB Block（SEC=0）
Status Register1[TB]：指定Flash Memory保護區域是從Top（TB=0）/Bottom（TB=1）開始
Status Register2[CMP]：決定由BPx,SEC,TB決定的Flash Memory保護區域是否生效(否的話，則區域外是受保護的)
綜合上面分析，最后我們發現MBED bootloader將全部的8MB Flash空間都保護起來了，所以各種下載工具都無法正常燒寫這款Flash了。
四、修改SDK FlexSPI例程來寫入Status Register
要想重新使能Flash燒寫，需要一個單獨的嵌入式小工程將Status Register1/2/3值再改回到默認狀態（WPS=0, CMP=0），可按照第2節里讀SR功能修改步驟，代碼如下。代碼工程修改完成后借助調試器下載到RAM運行一次即可，需要注意應在芯片SDP模式下運行，運行結束后，立刻借助其他下載工具將Flash里舊固件更新掉，保證這個過程中不存在軟復位而導致舊固件被再次運行的可能。（此處是將Flash里的MBED bootloader換掉，因為是它在使能Flash的寫保護功能）
// flexspi_nor_flash_ops.c 文件中新增 flexspi_nor_set_status_register() 函數
status_t flexspi_nor_set_status_register(FLEXSPI_Type *base, uint32_t seqIdx, uint8_t regValue)
{
flexspi_transfer_t flashXfer;
status_t status;
uint32_t writeValue = (uint32_t)regValue;
/* Write enable */
status = flexspi_nor_write_enable(base, 0);
if (status != kStatus_Success)
{
return status;
}
flashXfer.deviceAddress = 0;
flashXfer.port = kFLEXSPI_PortA1;
flashXfer.cmdType = kFLEXSPI_Write;
flashXfer.SeqNumber = 1;
flashXfer.seqIndex = seqIdx;
flashXfer.data = &writeValue;
flashXfer.dataSize = 1;
status = FLEXSPI_TransferBlocking(base, &flashXfer);
if (status != kStatus_Success)
{
return status;
}
status = flexspi_nor_wait_bus_busy(base);
/* Do software reset. */
FLEXSPI_SoftwareReset(base);
return status;
}
// app.h 文件中
#define NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG 9
#define NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG2 10
#define NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG3 11
//#define NOR_CMD_LUT_SEQ_IDX_ENTERQPI 10
//#define NOR_CMD_LUT_SEQ_IDX_EXITQPI 11
// flexspi_nor_polling_transfer.c 文件中將Status Register的寫入命令加入到LUT表中
const uint32_t customLUT[CUSTOM_LUT_LENGTH] = {
// ...
/* 原有 Write status register 1 */
[4 * NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x01, kFLEXSPI_Command_WRITE_SDR, kFLEXSPI_1PAD, 0x04),
/* 新增 Write status register 2 */
[4 * NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG2] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x31, kFLEXSPI_Command_WRITE_SDR, kFLEXSPI_1PAD, 0x04),
/* 新增 Write status register 3 */
[4 * NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG3] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x11, kFLEXSPI_Command_WRITE_SDR, kFLEXSPI_1PAD, 0x04),
/*
// Enter QPI mode //
[4 * NOR_CMD_LUT_SEQ_IDX_ENTERQPI] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_1PAD, 0x35, kFLEXSPI_Command_STOP, kFLEXSPI_1PAD, 0),
// Exit QPI mode //
[4 * NOR_CMD_LUT_SEQ_IDX_EXITQPI] =
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_4PAD, 0xF5, kFLEXSPI_Command_STOP, kFLEXSPI_1PAD, 0),
*/
};
int main(void)
{
status_t status;
BOARD_ConfigMPU();
BOARD_InitPins();
BOARD_BootClockRUN();
BOARD_InitDebugConsole();
flexspi_nor_flash_init(EXAMPLE_FLEXSPI);
/* Set status register 1-3. */
status = flexspi_nor_set_status_register(EXAMPLE_FLEXSPI, NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG, 0x00);
status = flexspi_nor_set_status_register(EXAMPLE_FLEXSPI, NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG2, 0x02);
status = flexspi_nor_set_status_register(EXAMPLE_FLEXSPI, NOR_CMD_LUT_SEQ_IDX_WRITESTATUSREG3, 0x60);
// ...
}
五、寫在最后
這里僅以華邦Flash為例介紹Write Protection，其他廠商Flash對於這個Write Protection特性設計也許有所不同，需要查看數據手冊具體分析。此外鑒於Flash這種種因素會導致在i.MXRT無法下載或正常啟動，痞子衡之前計划做的全新上位機工具MCUTestSuite，會考慮將串行NOR Flash狀態信息查詢功能（SFDP/QE bit/Write Protection等）也放進去，敬請關注這個新項目：
- MCUTestSuite工具項目：https://github.com/JayHeng/NXP-MCUTestSuite
至此，導致串行NOR Flash在i.MXRT下無法正常下載/啟動的常見因素之Write Protection痞子衡便介紹完畢了，掌聲在哪里~~~
歡迎訂閱
文章會同時發布到我的 博客園主頁、CSDN主頁、知乎主頁、微信公眾號 平台上。
微信搜索"痞子衡嵌入式"或者掃描下面二維碼，就可以在手機上第一時間看了哦。
