痞子衡嵌入式：恩智浦i.MX RTxxx系列MCU啟動那些事（4）- OTP及其燒寫方法

OTP是i.MXRTxxx里一塊特殊的存儲區域，用於存放全部晶元配置信息，其中有一部分配置信息和Boot相關。這塊特殊存儲區域並不在ARM的4G system address空間里，需要用特殊的方式去訪問（讀/寫），如何訪問OTP是本篇文章的重點。 ...

　　大家好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給大家介紹的是恩智浦i.MX RTxxx系列MCU的OTP。

　　在i.MXRTxxx啟動系列第二篇文章 Boot配置(ISP Pin, OTP) 里痞子衡提到了OTP，部分Boot配置都存儲在OTP memory里，但是對OTP的介紹僅僅淺嘗輒止，沒有深入，今天痞子衡就為大家再進一步介紹OTP。

　　OTP是i.MXRTxxx里一塊特殊的存儲區域，用於存放全部晶元配置信息，其中有一部分配置信息和Boot相關。這塊特殊存儲區域並不在ARM的4G system address空間里，需要用特殊的方式去訪問（讀/寫），如何訪問OTP是本篇文章的重點。

一、OTP基本原理

1.1 OTP屬性（OTP, Shadow Lock）

　　OTP本質上就是i.MXRTxxx內嵌的一塊One Time Programmable memory，僅可被燒寫一次，但可以被多次讀取。OTP memory的燒寫大部分是按Word進行的（也有極少部分是按Bit進行的），初始狀態下所有OTP bit均為0，通過特殊的燒寫時序可以將bit從0改成1，一旦某bit被燒寫成1後便再也無法被修改（可理解為硬體熔絲燒斷了無法恢復）。
　　i.MXRT600的OTP memory總地址空間有2KB（word index範圍為0x000 - 0x1FF），分為64個BANK，每個BANK含8個word（1word = 4bytes）。
　　OTP memory空間除了OTP特性外，還有Shadow Lock控制特性，Shadow Lock控制是OTP memory的標配，Lock控制有二種：第一種是WP，即防寫，用於保護OTP區域對應的shadow register不能被改寫；第二種是RP，即讀保護，被保護的OTP區域對應的shadow register不能被讀取。看到這裡，你會發現i.MXRTyyyy的efuse里的LOCK控制是同時針對efuse本身和shadow register的；而i.MXRTxxx的OTP里的LOCK控制僅針對shadow register，那麼對OTP本身的保護在哪裡呢？先別急，後面會給你答案。
　　Shadow Lock控制在OTP的BANK0_word4、BANK1_word8/9，如下是RT600具體Lock bit定義：

關於OTP空間所有bit定義詳見Reference Manual里的otpmap Descriptions。

1.2 OCOTP控制器與Shadow Register

　　i.MXRTxxx內部有一個硬體IP模塊叫OCOTP_CTRL，即OCOTP控制器，對OTP memory的讀寫控制操作其實都是通過這個OCOTP控制器實現的，下圖是OCOTP_CTRL模塊圖：

　　OCOTP_CTRL模塊寄存器一共分兩類：一類是IP控制寄存器，用於實現對OTP memory的讀寫操作時序控制；一類是Shadow register，用於上電時自動從OTP memory獲取數據並緩存，這樣我們可以直接訪問Shadow register而不用訪問OTP memory也能獲取OTP內容（註意：當晶元運行中燒寫OTP，Shadow register的值並不會立刻更新，需要執行IP控制器的reload命令或者將晶元reset才能同步）。
　　下圖是RT600里的OCOTP_CTRL模塊寄存器map，其中Shadow register寄存器偏移地址範圍是0x000 - 0x7FF（註意並不是所有OTP Word都會被載入到Shadow register里，雖然Shadow register預留了全部的OTP位置。這點與i.MXRTyyyy efuse會全部載入到Shadow register不同，原因是i.MXRTxxx的OTP里會有很多Peripheral寄存器載入初值，如果這些OTP值目的是載入Peripheral，那就沒有必要再載入到Shadow register里，而i.MXRTyyyy的efuse值沒有載入Peripheral寄存器的用途）。IP控制寄存器偏移地址範圍是0x800 - 0x82C:

　　痞子衡寫過關於i.MXRTyyyy的eFUSE燒寫的文章飛思卡爾i.MX RTyyyy系列MCU啟動那些事（5）- 再聊eFUSE及其燒寫方法，其實i.MXRTxxx的OCOTP控制器與i.MXRTyyyy里的OCOTP控制器非常相似，雖然兩者在寄存器組織上有差異，但其共同點更多。不過提及差異，有一個地方痞子衡不得不提，那就是CTRL寄存器的bit15，在i.MXRTyyyy上這個bit是保留的，但是i.MXRTxxx上這個bit為WORDLOCK，顧名思義即提供對操作的OTP word區域進行保護（主要是防寫），下一節介紹的efuse-program-once命令第三個可選參數[nolock/lock]其實就是利用了這個bit。

二、使用blhost燒寫OTP

　　OTP memory的燒寫是通過OCOTP_CTRL模塊來實現的，我們當然可以在Application中集成OCOTP_CTRL的驅動程式，然後在Application調用OCOTP_CTRL的驅動程式完成OTP的燒寫，但這種方式並不是痞子衡要介紹的重點，痞子衡要介紹的是通過Serial ISP模式配套的blhost.exe上位機工具實現OTP的燒寫。
　　痞子衡在前面的文章里介紹過如何進入Serial ISP模式與BootROM通信，此處假設你已經使用blhost與BootROM建立了通信。讓我們再來回顧一下blhost的命令help，可以得知efuse-program-once這個命令就是我們想要的命令。

PS D:\NXP-MCUBootUtility\tools\blhost2_3\win> .\blhost.exe
usage: D:\NXP-MCUBootUtility\tools\blhost2_3\win\blhost.exe
                       [-p|--port <name>[,<speed>]]
                       [-u|--usb [[[<vid>,]<pid>]]]
                       -- command <args...>

Command:
  efuse-program-once <addr> <data> [nolock/lock]
                               Program one word of OCOTP Field
                               <addr> is ADDR of OTP word, not the shadowed memory address.
                               <data> is hex digits without prefix '0x'
  efuse-read-once <addr>
                               Read one word of OCOTP Field
                               <addr> is ADDR of OTP word, not the shadowed memory address.

　　讓我們試一下efuse-program-once這個命令，開始試之前要解決2個問題：
　　addr參數到底是什麼地址？幫助里說是OTP word address，其實這個地址就是1.1節里介紹的word index，index範圍為0x000 - 0x1FF，對應512個可讀寫操作的OTP Word。
　　data參數到底是什麼格式？幫助里說是hex digits without prefix '0x'，但是似乎沒有指明長度，我們知道每一個index對應的是4byte，那就應該是8位16進位數據（實測下來必須要填8位，如果是非8位會返回Error: invalid command or arguments）。
　　弄清了問題，那我們做一個小測試：要求將OTP里的REVOKE_IMG_KEY word的最低byte燒寫成0x5A。翻看OTP Memory Footprint表，找到REVOKE_IMG_KEY的index地址是0x66（對應Shadow register地址是0x40130198），命令搞起來：

PS D:\NXP-MCUBootUtility\tools\blhost2_3\win> .\blhost.exe -u -- efuse-program-once 0x66 0000005A
Inject command 'efuse-program-once'
Successful generic response to command 'efuse-program-once'
Response status = 0 (0x0) Success.
PS D:\NXP-MCUBootUtility\tools\blhost2_3\win> .\blhost.exe -u -- efuse-read-once 0x66
Inject command 'efuse-read-once'
Response status = 0 (0x0) Success.
Response word 1 = 4 (0x4)
Response word 2 = 90 (0x5a)

　　看起來命令執行正常，如果此時你用J-Link去讀取對應Shadow register的值，你會發現剛纔燒寫的OTP數據並沒有自動同步更新到Shadow register里。與i.MXRTyyyy系列下Flashloader里efuse program操作有所不同的是，i.MXRTxxx Serial ISP模式下blhost里的efuse-program-once命令僅包含program命令，沒有集成reload命令。因此想要刷新Shadow register，必須複位晶元。

　　至此，恩智浦i.MX RTxxx系列MCU的OTP痞子衡便介紹完畢了，掌聲在哪裡~~~