rp2040_1.html (33279B)
1 <h1>RP2040 SDKなしでLチカ</h1> 2 <time>2023-04-19</time> 3 4 <h2>はじめに</h2> 5 <p> 6 パタヘネのRISC-V<sup>[1]</sup>版を買って一通り読んだらアセンブリ言語\ 7 で組込のプログラミングがしたくなった。\ 8 RISC-Vのマイコンボードが欲しかったのだが、安くていい感じ\ 9 のものが見付からなかった。\ 10 代わりに秋月電子通商でArmのものがあった。\ 11 RP2040マイコンボードキット<sup>[2]</sup>というものである。\ 12 ウェブ上の情報も多く、データシート<sup>[3]</sup>もしっかりしていそうなので、\ 13 とりあえずこれを買ってみた。\ 14 </p> 15 <p> 16 一般的にはSDK<sup>[4]</sup>をダウンロードしてあらかじめ用意された\ 17 ライブラリを使って開発するようだが、これはビルドシステムとしてcmake\ 18 というのを使っている。これがOpenBSDでは何かエラーがでて動かなかった。\ 19 僕はこういう便利ツールが嫌いだ。どうせ使わんからいいんやけど。\ 20 関係ないけど途中から開発環境がLinuxに替わった。\ 21 SDKには便利な関数がたくさん用意されているので楽である。\ 22 ハードウェアの面倒な部分がプログラマから見えないようにしているからである。\ 23 しかし今回はその面倒な部分に触れてみたくて買ったので、SDKを使うと意味がない。\ 24 </p> 25 <p> 26 ということでSDKなしで開発してみる。\ 27 とりあえず定番のLチカをば。\ 28 </p> 29 <p> 30 ソースコード: <a href="https://git.mtkn.jp/rp2040">git</a> 31 </p> 32 33 <h2>動作環境</h2> 34 <ul> 35 <li>Arch Linux 6.2.12-arch1-1 36 <ul> 37 <li>arm-none-eabi-binutils 2.40-1</li> 38 <li>GNU Make 4.4.1</li> 39 </ul> 40 </li> 41 <li>OpenBSD 7.3 42 <ul> 43 <li>arm-none-eabi-binutils 2.31.1</li> 44 <li>make (バージョン?)</li> 45 </ul> 46 ※<code>make flash</code>は動かん。<code>dmesg</code>でデバイス確認して手動で\ 47 マウントする必要がある。 48 </li> 49 </ul> 50 51 <h2>Boot Process</h2> 52 <p> 53 RP2040は電源を入れるといくつかの段階(ここでは関係ないので省略。\ 54 データシート「2.8.1 Processor Controlled Boot Sequence」に詳しく書いてある)\ 55 を踏んだあと、外部のフラッシュROMの先頭から\ 56 256バイトを内部のSRAMにコピーして、フラッシュにプログラムが書き込まれているか\ 57 どうか確認する。RP2040はフラッシュの先頭252バイトから計算したCRC32チェックサム\ 58 を、直後の253バイト目から256バイトに記録することになっている。\ 59 起動時にこのチェックサムを確認することで、フラッシュにプログラムが\ 60 書き込まれているかどうか確かめている。コピーした最後の4バイトと\ 61 起動時に最初の252バイトから計算したチェックサムが一致していれば、\ 62 そのままコピーしてきた256バイトの先頭にPCをセットして実行を開始する。\ 63 一致しなければUSBデバイスモードに切り替わり、パソコンに接続すると\ 64 ストレージとして認識される。このストレージにUF2という形式に変換した\ 65 プログラムをコピーするとプログラムがフラッシュROMやSRAMに書き込まれる。 66 </p> 67 <p> 68 以上のことから、プログラムを実行するためにはCRC32を計算し、UF2という形式\ 69 に変換することが必要である。ソースコードからの流れは以下の通り: 70 </p> 71 <pre>\ 72 source bin bin with 73 code ---------> object ------> elf --------> bin -------> with --------> crc32 in 74 crc32 uf2 format 75 compile link objcopy bincrc bin2uf2 76 </pre> 77 78 <h2>CRC(巡回冗長検査)</h2> 79 <h3>基本</h3> 80 <p> 81 入力のデータをごにょごにょしてある値を出力する。\ 82 <blockquote cite="https://ja.wikipedia.org/wiki/%E5%B7%A1%E5%9B%9E%E5%86%97%E9%95%B7%E6%A4%9C%E6%9F%BB"> 83 <p> 84 データ転送等に伴う偶発的な誤りの検査によく使われている<sup>[5]</sup>。 85 </p> 86 </blockquote> 87 らしい。 88 </p> 89 <p> 90 入力のビットを一列に並べて、除数で「割り算」していく。\ 91 この「割り算」が多項式の除算に似ているので、この除数をCRC多項式というらしい。\ 92 ただし多項式の除算と違い、引き算するところをXORする。\ 93 CRC32の場合、除数は33ビットである。\ 94 33ビットで割ると32ビットの余りが残る。この余りがCRC32のチェックサムである。\ 95 除数は色々あるようだが、標準的なものがWikipedia<sup>[5]</sup>に列挙されている。\ 96 除数<code>1011</code>を使ったCRC3の計算の手順は以下の通り: 97 </p> 98 <pre><code>\ 99 1110101011011100110101101101111 入力(適当) 100 1011 除数(4ビット) 101 ------------------------------- 102 101101011011100110101101101111 結果(入力と除数のXOR) 103 1011 104 ------------------------------ 105 00001011011100110101101101111 106 1011 107 ------------------------- 108 000011100110101101101111 109 1011 110 -------------------- 111 1010110101101101111 112 1011 113 ------------------- 114 001110101101101111 115 1011 116 ---------------- 117 101101101101111 118 1011 119 --------------- 120 00001101101111 121 1011 122 ---------- 123 110101111 124 1011 125 --------- 126 11001111 127 1011 128 -------- 129 1111111 130 1011 131 ------- 132 100111 133 1011 134 ------ 135 01011 136 1011 137 ---- 138 000 CRC3チェックサム 139 </code></pre> 140 <p> 141 普通の割り算と基本は同じであるが、引き算の部分だけXORになっている。\ 142 </p> 143 144 <h3>細かいこと</h3> 145 <p> 146 以上の計算をプログラムの先頭252バイトに対して、33ビットの除数を用いて行う。\ 147 データの並べ方は、上の例において左側を先頭に、フラッシュROM上の0番地から順に、\ 148 各バイトは最上位ビットから順に並べる。\ 149 入力のデータは253バイト目から256バイト目に<code>0</code>をひっつけて計算する。\ 150 これは多分予め長さが分からないデータでも計算できるようにしたかったからかな。\ 151 除数は<code>0x104c11db7</code>である(最上位ビットは常に1なのでデータシート\ 152 では省略されている)。\ 153 </p> 154 <p> 155 入力データは1バイトづつ処理したいみたいである。多分通信等で使う都合である。\ 156 この時XORは結合則が成り立つので1バイト処理した結果と\ 157 次のバイトとをXORして次の処理の入力として利用することができる: 158 </p> 159 <pre><code>\ 160 111000111000000110000110111000111000001010010011111000111000000110010011 入力(適当) 161 |......| 162 111000110000000000000000000000000 先頭1バイト 163 100000100110000010001110110110111 除数 164 ------------------------------------------------------------------------ 165 011000010110000010001110110110111 166 100000100110000010001110110110111 167 ----------------------------------------------------------------------- 168 010000001010000110010011011011001 169 100000100110000010001110110110111 170 ---------------------------------------------------------------------- 171 000000110010001110101000000000101 172 |......| 173 110010001110101000000000101000000 1バイト目の結果 174 |......| 175 10000001 入力の2バイト目 176 ---------------------------------------------------------------- 177 010010011110101000000000101000000 1バイト目の結果と2バイト目のXOR 178 100000100110000010001110110110111 除数 179 ---------------------------------------------------------------- 180 000100011011010010001111100110111 181 . 182 . 183 . 184 </code></pre> 185 <p> 186 以上の操作は以下のようなアルゴリズムのループで実装できる。\ 187 </p> 188 <ul> 189 <li>前回の結果と、入力データの次のバイトをXOR</li> 190 <li> 191 <ul> 192 <li>先頭の1ビットが1の場合、除数とXORを取り左シフト</li> 193 <li>先頭の1ビットが0の場合、そのまま左シフト</li> 194 </ul> 195 </li> 196 </ul> 197 <p> 198 これを<code>for</code>ループで回す都合上、最初のバイトもXORを取る。\ 199 上の例では最初は<code>0x0</code>とXORを取っているが、この値を<code>0x0</code>\ 200 以外にすることもできる。そうした方がいろいろいいこともあるらしい。\ 201 RP2040では<code>0xffffffff</code>を使う。\ 202 更にこの工程を32ビットの<code>int</code>だけで行うことを考える: 203 </p> 204 <pre><code>\ 205 111000111000000110000110111000111000001010010011111000111000000110010011 入力(適当) 206 207 11111111111111111111111111111111 0xffffffff 208 11100011000000000000000000000000 先頭1バイトを24ビットシフト 209 -------------------------------- XOR 210 00011100111111111111111111111111 211 先頭1ビットが0なので1ビットシフト 212 -------------------------------- シフト 213 00111001111111111111111111111110 214 先頭1ビットが0なので1ビットシフト 215 -------------------------------- シフト 216 01110011111111111111111111111100 217 先頭1ビットが0なので1ビットシフト 218 -------------------------------- シフト 219 11100111111111111111111111111000 220 先頭1ビットが1なので1ビットシフトした後、除数の下位32ビットとXOR: 221 11001111111111111111111111110000 シフト 222 00000100110000010001110110110111 除数の下位32ビット 223 -------------------------------- XOR 224 11001011001111101110001001000111 225 先頭1ビットが1なので1ビットシフトした後、除数の下位32ビットとXOR: 226 10010110011111011100010010001110 227 00000100110000010001110110110111 除数の下位32ビット 228 -------------------------------- XOR 229 10010010101111001101100100111001 230 先頭1ビットが1なので1ビットシフトした後、除数の下位32ビットとXOR: 231 00100101011110011011001001110010 232 00000100110000010001110110110111 除数の下位32ビット 233 -------------------------------- XOR 234 00100001101110001010111111000101 235 先頭1ビットが0なので1ビットシフト 236 -------------------------------- シフト 237 01000011011100010101111110001010 238 先頭1ビットが0なので1ビットシフト 239 -------------------------------- シフト 240 10000110111000101011111100010100 1バイト目の結果 241 242 10000001 入力の2バイト目 243 -------------------------------- XOR 244 00000111111000101011111100010100 245 先頭1ビットが0なので1ビットシフト 246 -------------------------------- シフト 247 00001111110001010111111000101000 248 . 249 . 250 . 251 </code></pre> 252 <p> 253 これを実装したのが以下のコード:\ 254 </p> 255 <pre><code>\ 256 uint32_t 257 crc32(uint8_t *idata, size_t len) 258 { 259 uint32_t pol = 0x04C11DB7; 260 uint32_t c = 0xFFFFFFFF; 261 uint32_t b; 262 263 for (int i = 0; i < len; i++) { 264 b = idata[i] << 24; 265 c ^= b; 266 for (int j = 0; j < 8; j++) { 267 c = c >> 31 & 1 ? c << 1 ^ pol : c << 1; 268 } 269 } 270 271 return c; 272 } 273 </code></pre> 274 <p> 275 <code>main()</code>関数では上の<code>crc32()</code>に、<code>idata</code>として入力\ 276 となるバイナリデータの先頭を、<code>len</code>として<code>252</code>を渡してCRC32\ 277 を計算させる。その後、出力先のファイルに入力元のデータをコピーしていき、253バイト\ 278 目から256バイト目だけ、計算したCRC32に置き換える。入力元のこの場所にデータが\ 279 書き込まれていないかどうかは確かめていない。 280 </p> 281 282 <h2>UF2(USB Flashing Format)</h2> 283 <p> 284 Microsoftが開発したフラッシュ書き込み用のファイル形式らしい: 285 <blockquote cite="https://github.com/microsoft/uf2"> 286 <p> 287 UF2 is a file format, developed by Microsoft for PXT (also known as 288 Microsoft MakeCode), that is particularly suitable for flashing microcontrollers 289 over MSC (Mass Storage Class; aka removable flash drive)<sup>[6]</sup>. 290 </p> 291 </blockquote> 292 <p> 293 このファイルに変換する上で必要な情報はGitHubのmicrosoft/uf2<sup>[6]</sup>に\ 294 表として纏められている: 295 <blockquote cite"https://github.com/microsoft/uf2"> 296 <table> 297 <thead><tr> 298 <th>Offset</th><th>Size</th><th>Value</th> 299 </tr></thead> 300 <tbody> 301 <tr> 302 <td>0</td> 303 <td>4</td> 304 <td>First magic number, <code>0x0A324655</code> (<code>"UF2\n"</code>)</td> 305 </tr> 306 <tr> 307 <td>4</td> 308 <td>4</td> 309 <td>Second magic number, <code>0x9E5D5157</code></td> 310 </tr> 311 <tr> 312 <td>8</td> 313 <td>4</td> 314 <td>Flags</td> 315 </tr> 316 <tr> 317 <td>12</td> 318 <td>4</td> 319 <td>Address in flash where the data should be written</td> 320 </tr> 321 <tr> 322 <td>16</td> 323 <td>4</td> 324 <td>Number of bytes used in data (often 256)</td> 325 </tr> 326 <tr> 327 <td>20</td> 328 <td>4</td> 329 <td>Sequential block number; starts at 0</td> 330 </tr> 331 <tr> 332 <td>24</td> 333 <td>4</td> 334 <td>Total number of blocks in file</td> 335 </tr> 336 <tr> 337 <td>28</td> 338 <td>4</td> 339 <td>File size or board family ID or zero</td> 340 </tr> 341 <tr> 342 <td>32</td> 343 <td>476</td> 344 <td>Data, padded with zeros</td> 345 </tr> 346 <tr> 347 <td>508</td> 348 <td>4</td> 349 <td>Final magic number, <code>0x0AB16F30</code></td> 350 </tr> 351 </tbody> 352 </table> 353 </blockquote> 354 355 <p> 356 RP2040のデータシート<sup>[3]</sup>「2.8.4.2 UF2 Format Details」\ 357 を見ると、\ 358 8バイト目のFlagsは、28バイト目に\ 359 ファミリーIDが書き込まれていることを示す<code>0x00002000</code>、\ 360 12バイト目は、書き込みを行うフラッシュROMの先頭アドレスである\ 361 <code>0x10000000</code>に、各ブロックの先頭からの位置を足したもの、\ 362 16バイト目の、各ブロックのデータサイズは256バイト、\ 363 28バイト目のファミリーIDは<code>0xe48bff56</code>である。\ 364 あとは表の通り3つのマジックナンバーをセットし、32バイト目以降にデータを書き込み、\ 365 20バイト目と24バイト目にブロックの通し番号と総数をそれぞれ書き込めばいい。\ 366 ブロックの通し番号はデータのついでに書き込めるが、総数はデータを全部\ 367 さばいた後でないと分からないので、最後全てのブロックにまとめて書き込むようにした。\ 368 できたのが以下のコード: 369 </p> 370 <pre><code>\ 371 #include <stdio.h> 372 #include <stdint.h> 373 #include <stdlib.h> 374 #include <string.h> 375 376 377 size_t 378 fwrite32l(uint32_t d, FILE *f) 379 { 380 int i; 381 uint8_t b; 382 for (i = 0; i < 32; i += 8) { 383 b = (uint8_t) (d >> i & 0xff); 384 fwrite(&b, 1, 1, f); 385 if (ferror(f)) { 386 fprintf(stderr, "Fwrite32l: write error.\n"); 387 return 0; 388 } 389 } 390 return 4; 391 } 392 393 int 394 main(int argc, char *argv[]) 395 { 396 FILE *src = NULL, *dst = NULL; 397 size_t sdata = 476; 398 int retnum = 0; 399 400 uint32_t mag1 = 0x0A324655; 401 uint32_t mag2 = 0x9E5D5157; 402 uint32_t flags = 0x00002000; // familyID present 403 uint32_t addr = 0x10000000; 404 uint32_t nbyte = 256; 405 uint32_t blk = 0; 406 uint32_t nblk = 0; 407 uint32_t famid = 0xe48bff56; 408 uint8_t data[sdata]; 409 uint32_t mag3 = 0x0AB16F30; 410 411 memset(data, 0, sdata); 412 413 if (argc != 3) { 414 fprintf(stderr, "Usage: %s src dst\n", argv[0]); 415 exit(1); 416 } 417 418 if ((src = fopen(argv[1], "rb")) == NULL) { 419 fprintf(stderr, "Could not open %s.\n", argv[1]); 420 retnum = 1; 421 goto defer; 422 } 423 if ((dst = fopen(argv[2], "wb")) == NULL) { 424 fprintf(stderr, "Could not open %s.\n", argv[2]); 425 retnum = 1; 426 goto defer; 427 } 428 429 while (!feof(src)) { 430 fwrite32l(mag1, dst); 431 fwrite32l(mag2, dst); 432 fwrite32l(flags, dst); 433 fwrite32l(addr, dst); 434 fwrite32l(nbyte, dst); 435 fwrite32l(blk, dst); 436 fwrite32l(nblk, dst); // dummy 437 fwrite32l(famid, dst); 438 439 fread(data, 1, nbyte, src); 440 if (ferror(src)) { 441 fprintf(stderr, "Read error: %s.\n", argv[1]); 442 retnum = 1; 443 goto defer; 444 } 445 fwrite(data, 1, sdata, dst); 446 if (ferror(src)) { 447 fprintf(stderr, "Write error: %s.\n", argv[2]); 448 retnum = 1; 449 goto defer; 450 } 451 452 fwrite32l(mag3, dst); 453 454 addr += nbyte; 455 blk++; 456 nblk++; 457 } 458 459 for (int i = 0; i < nblk; i++) { 460 if (i == 0) 461 if (fseek(dst, 24, SEEK_SET) < 0) { 462 fprintf(stderr, "Seek error: %s.\n argv[2]"); 463 retnum = 1; 464 goto defer; 465 } 466 fwrite32l(nblk, dst); 467 if (i < nblk - 1) 468 if(fseek(dst, 512 - 4, SEEK_CUR) < 0){ 469 fprintf(stderr, "Seek error: %s.\n argv[2]"); 470 retnum = 1; 471 goto defer; 472 } 473 } 474 475 defer: 476 if (src) 477 fclose(src); 478 if (dst) 479 fclose(dst); 480 return retnum; 481 } 482 </code></pre> 483 <p>\ 484 <code>fwrite32l()</code>関数は指定されたファイルに32ビットの整数を\ 485 下位バイトから順に書き込む関数である。バイトオーダーとかややこしそうなので\ 486 作っておいたけど必要なのかな？あと名前が気に入らない。\ 487 </p> 488 <p> 489 CRC32のチェックサムが書き込まれたバイナリファイルを、このプログラムでUF2に\ 490 変換し、生成されたファイルをUSBストレージとして接続したRP2040にコピーすれば\ 491 フラッシュROMに書き込まれる。 492 </p> 493 494 <h2>Flash Second Stage</h2> 495 <p> 496 RP2040に電源を投入し、CRC32のチェックが通った後、フラッシュROMからコピー\ 497 されたプログラムの先頭から実行が開始される。このコピーされた部分で、\ 498 その後の動作に必要な各種の設定を行うことになる。\ 499 RP2040のデータシートには、フラッシュROMとSSIコントローラのXIP\ 500 を設定するようにと書かれている。\ 501 XIPはExecute in Placeの略で、フラッシュROMの内容をCPUから\ 502 直接実行するものである。SSIはSynchronous Serial Interfaceの略で、\ 503 周辺機器と情報のやりとりをする通信方式である。\ 504 RP2040はチップに内蔵されたこのSSIコントローラを通して、\ 505 外部のフラッシュROMと通信しているのだが、このコントローラを適切に設定すれば\ 506 フラッシュROMの内容がCPUから直接アクセスできる<code>0x10000000</code>番地以降\ 507 にマップされる。これによりフラッシュROMから内部のSRAMにデータをコピーする\ 508 ことなく命令を実行できるので、速くて便利だという。 509 </p> 510 <p> 511 しかしこのSSIコントローラはSynopsysという会社のDW_apb_ssiというIPを\ 512 使っているようで、データシートのSSIコントローラの章は多分Synopsysの\ 513 人が書いている。その他の章はRaspberry Pi財団の書いたブリティッシュイングリッシュ\ 514 だが、この部分だけ多分ネイティブじゃない人の書いたいい加減な英語である。誤植も多い。\ 515 何日かかけて理解しようとしたがよく分からん。不毛なので一旦諦めた。\ 516 </p> 517 <p> 518 RP2040には内部にもROMがあり、はバージョン情報や電源を投入した時の動作、\ 519 その他便利な関数が書き込まれている。この関数の中に外部のフラッシュROMと\ 520 SSIコントローラを設定するものも含まれているので、今回はこれを利用した。\ 521 ただしこの方法だとフラッシュROMとの通信方式がStandard SPIのままなので少し\ 522 遅いらしい。詳しくはデータシートの「2.3.8. Bootrom Contents」を参照。 523 </p> 524 <p> 525 RP2040の内蔵ROMの<code>0x00000018</code>番地に関数を検索するための関数がある。\ 526 この関数に<code>0x00000014</code>番地の<code>rom_func_table</code>と、\ 527 各関数に割り当てられた二文字の文字列を渡せば、欲しい関数へのポインタが\ 528 返ってくる。なお、二文字の文字列はそれぞれASCIIコードで現し、二文字目を\ 529 8ビットシフトしたものと1文字目のORを取ったものを渡すことになっている。\ 530 今回欲しい関数はフラッシュROMをXIPに設定するもの\ 531 (<code>_flash_enter_cmd_xip()</code>)なので、<code>'C', 'X'</code>を渡す。\ 532 関数のポインタが返ってきて、それを呼び出せばフラッシュROMとSSIはXIPモード\ 533 になる: 534 </p> 535 <pre><code>\ 536 setup_xip: 537 ldr r3, rom_base 538 539 ldrh r0, [r3, #0x14] // rom_func_table 540 ldr r1, =('C' | 'X' << 8) // _flash_enter_cmd_xip() 541 ldrh r2, [r3, #0x18] // rom_table_lookup 542 blx r2 543 blx r0 544 /* ... */ 545 rom_base: 546 .word 0x00000000 547 </code></pre> 548 549 <p> 550 XIPの設定が完了すれば、次はメインのプログラムを実行するための準備である。\ 551 エントリーポイントの指定、スタックポインタの初期値の設定、ベクターテーブル\ 552 の設定である。初期スタックポインタとエントリーポイントはベクターテーブルの\ 553 <code>0x0</code>バイト目と<code>0x4</code>バイト目に書くことになっている\ 554 <sup>[要出展]</sup>。\ 555 また、ベクターテーブルはメインのプログラムの先頭に置くことにする。\ 556 メインのプログラムはFlash Second Stageが占有する256バイトの直後、\ 557 フラッシュROMの257バイト目から配置することにする。\ 558 RP2040のベクターテーブルは<code>M0PLUS: VTOR(0xe0000000 + 0xed08)</code>という\ 559 レジスタに書き込むことで設定する。以上をまとめると以下のコードになる:\ 560 </p> 561 <pre><code>\ 562 ldr r0, flash_main 563 ldr r1, m0plus_vtor 564 str r0, [r1, #0] // vector table 565 ldr r1, [r0, #4] // entry point 566 ldr r0, [r0, #0] // stack pointer 567 mov sp, r0 568 bx r1 569 /* ... */ 570 flash_main: 571 .word 0x10000000 + 0x100 572 m0plus_vtor: 573 .word 0xe0000000 + 0xed08 574 </code></pre> 575 <p>\ 576 なお以上のコードは<code>.boot2</code>という名前のセクションにしてある。 577 </p> 578 579 <h2>メインのコード(<code>main.s</code>)<h2> 580 <h3>ベクターテーブル</h3> 581 <p> 582 メインのコードの最初には上で説明したベクターテーブルを配置する。\ 583 ここでは割り込みの処理は考えないので、初期スタックポインタと\ 584 エントリーポイントだけである。初期スタックポインタはSRAMの最後?\ 585 (<code>0x20040000</code>)、エントリーポイントはエントリーポイントの\ 586 ラベルを用いて設定した。ただしこのCPUはThumbモードなので、\ 587 ラベルに<code>0x1</code>を足している[要説明?]: 588 </p> 589 <pre><code>\ 590 vectors: 591 .word 0x20040000 // initial SP 592 .word (reset+1) 593 </code></pre> 594 <p> 595 この部分のセクション名は<code>.vectors</code>である。 596 </p> 597 598 <h3>GPIOの設定</h3> 599 <p> 600 電源投入直後、RP2040の周辺機器はリセット状態になっている。\ 601 まずは今回利用するGPIOのリセット状態を解除する必要がある。\ 602 日本語だと意味が分かりにくいが英語でも分かりにくい。\ 603 データシートの「2.14. Subsystem Resets」には以下のように書かれている: 604 </p> 605 <blockquote cite="https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf"> 606 <p> 607 Every peripheral reset by the reset controller is held in reset at power-up. 608 It is up to software to deassert the reset of peripherals it intends to use. 609 </p> 610 </blockquote> 611 <p> 612 リセット状態を解除するには、RESETS_BASE(<code>0x4000c000</code>)から\ 613 <code>0x0</code>バイト目のRESETS: RESEレジスタのうち利用したい周辺機器の\ 614 ビットを<code>0x0</code>にすればいい。 615 GPIOはIO Bank 0なので(これ明記されてなくない？)、RESETS: RESETレジスタの\ 616 IO_BANK0(5番ビット)を<code>0x0</code>にする。 617 </p> 618 <h4>レジスタのアトミックなクリア</h4> 619 <p> 620 RESETS: RESETレジスタのうち5番ビットだけを<code>0x0</code>に\ 621 したい。この時、まずこのレジスタを読み込んでから<code>~(1 << 5)</code>と\ 622 論理積を取って同レジスタに書き戻してもいいのだが、RP2040にはこれを\ 623 一回の<code>str</code>でしかもアトミックにできる便利な機能が用意されている。\ 624 今回の場合アトミックかどうかは関係ないと思うが。\ 625 </p> 626 <p> 627 各レジスタには4個のアドレスが割り当てられている。\ 628 データシートの各章のList of Registersに記載されているアドレスは\ 629 通常の読み書きができる。そのアドレスに<code>0x1000</code>を足したもの\ 630 にアクセスするとアトミックなXORが、<code>0x2000</code>を足したものは\ 631 アトミックなセットが、<code>0x3000</code>を足したものはアトミックな\ 632 クリアができる。つまりレジスタのアドレスに<code>0x3000</code>を足した\ 633 ものに、<code>0x1 << 5</code>を<code>str</code>すれば5番目のビットだけ\ 634 <code>0x0</code>にして、他のビットは変更されない。\ 635 逆に指定したビットだけ立てて他を触らない場合は<code>0x2000</code>を、\ 636 あるいは指定したビットだけトグルしたい場合は<code>0x1000</code>を足したアドレス\ 637 にアクセスすればいい。\ 638 </p> 639 <h4>リセット状態の確認</h4> 640 <p>\ 641 リセットの解除はすぐに完了するわけではないようである。\ 642 リセットの解除が完了したかどうか確認するにはRESETS: RESET_DONE\ 643 レジスタ(RESETS_BASEから<code>0x8</code>バイト目)の該当するビット\ 644 (ここでは5番目のビット)を読む。この値が<code>0x1</code>であれば\ 645 リセットの解除が完了している。<code>0x0</code>であれば処理が進行中\ 646 なので<code>0x1</code>が返ってくるまで繰り返し読み込んで<code>0x0</code>\ 647 になるまで待機する。\ 648 ところでこのレジスタはリセットの解除が完了したかどうか確かめるもの\ 649 なので、RESET_DONEという名前はどうなん？ 650 <p> 651 以上から、GPIOのリセットを解除するのは以下のコード: 652 </p> 653 <pre><code>\ 654 reset: 655 // unreset gpio 656 mov r0, #1 657 lsl r0, r0, #5 // io_bank0 658 ldr r3, resets_base 659 ldr r1, atomic_clr 660 str r0, [r3, r1] // RESETS: RESET 661 reset_chk: 662 ldr r1, [r3, #0x8] // RESETS: RESET_DONE 663 tst r0, r1 664 beq reset_chk 665 666 /* ... */ 667 668 atomic_clr: 669 .word 0x00003000 670 resets_base: 671 .word 0x4000c000 672 </code></pre> 673 674 <h3>GPIOの機能の選択</h3> 675 <p>\ 676 RP2040のGPIOにはそれぞれ複数の機能が用意されていて、どれを使うかは\ 677 ソフトウェアから選択できる。利用できる機能の一覧と各機能の説明は\ 678 データシートの「2.19.2 Function Select」に詳しく書いてある。\ 679 ここではGPIO25番のピンをSIO(Single-cycle IO)として利用する。\ 680 同じCPUが載っているRaspberry Pi PicoはGPIO25番にLEDが半田付けされている。\ 681 25番にしたのはこれに合わせるためである。他のピンでもいい。\ 682 GPIOに1(3.3V)か0を印加するだけならこのSIOを使うみたいである。\ 683 Single-cycleはCPUから操作したときに1クロックでその操作が完了する\ 684 という意味らしい。SIOの詳しい説明はデータシートの「2.3.1 SIO」にある。\ 685 </p> 686 <p> 687 GPIO25番の機能を選択するにはIO_BANK0_BASE(<code>0x40014000</code>)から\ 688 <code>0xcc</code>番目のGPIO25_CTRLレジスタの下位5ビットに、該当する機能\ 689 の番号を書き込めばいい。データシートの「2.19.2 Function Select」にある\ 690 表を見ると、GPIO25番のSIOは5である:\ 691 </p> 692 <pre><code>\ 693 // set gpio functions 694 ldr r3, io_bank0_base 695 mov r0, #5 // sio 696 mov r1, #0xcc 697 str r0, [r3, r1] // IO_BANK0: GPIO25_CTRL 698 699 /* ... */ 700 701 io_bank0_base: 702 .word 0x40014000 703 </pre></code> 704 705 <h3>GPIOの出力を有効化</h3> 706 <p> 707 GPIO25番がSIOになったので、次にこのピンからの出力を有効化する。\ 708 既定値では出力は無効になっている。ハイインピーダンスってことなのかな？\ 709 出力を有効にするには、SIO_BASE(<code>0xd0000000</code>)から\ 710 <code>0x24</code>バイト目のSIO: GPIO_OEレジスタの該当するビット\ 711 (25番のピンなので25番ビット)を<code>0x1</code>にする: 712 </p> 713 <pre><code> 714 // enable gpio output 715 ldr r3, sio_base 716 mov r0, #1 717 lsl r0, r0, #25 // gpio25 718 str r0, [r3, #0x24] // SIO: GPIO_OE 719 720 /* ... */ 721 722 sio_base: 723 .word 0xd0000000 724 </code></pre> 725 726 <h3>LEDの点滅</h3> 727 <p>\ 728 以上でGPIOの設定は完了したので、あとは実際にLEDに電圧を掛けるだけである。\ 729 レジスタのアドレスに<code>0x1000</code>を足したものに書き込むと\ 730 アトミックなレジスタのXORができると書いたが、SIOだけこの機能がサポート\ 731 されていないようである。データシートの「2.1.2 Atomic Register Access」に、 732 </p> 733 <blockquote cite="https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf"> 734 <p> 735 The SIO (Section 2.3.1), a single-cycle IO block attached directly to the cores' 736 IO ports, does <strong>not</strong> support atomic accesses at the bus level, 737 although some individual registers (e.g. GPIO) have set/clear/xor aliases. 738 </p> 739 </blockquote> 740 <p> 741 と書かれている。ここにも書かれている通り、SIOの一部のレジスタには\ 742 アトミックなセット/クリア/XORをするためのレジスタが用意されている。\ 743 ここではLEDを点滅させるためにGPIOの出力をトグルしたいのでXOR用のレジスタを使う。\ 744 SIO_BASE(<code>0xd0000000</code>)から<code>0x1c</code>バイト目の\ 745 SIO: GPIO_OUT_XORレジスタがそれである。\ 746 このレジスタの25番ビットに<code>0x1</code>を書き込めばいい。\ 747 出力をトグルした後は少し間をおいて同じことを繰り返す。\ 748 間をおくためにここでは適当な数値を1づつ減らしていって0になったら\ 749 返る関数<code>delay</code>を作った。\ 750 タイマーと割り込みを使ったほうが消費電力等で優位なようだが、\ 751 面倒なのでとりあえずこれで:\ 752 </p> 753 754 <pre><code>\ 755 // blink led on gpio25 756 ldr r4, sio_base 757 mov r5, r0 // r0 = 1 << 25 758 loop: 759 str r5, [r4, #0x1c] // SIO: GPIO_OUT_XOR 760 bl delay 761 b loop 762 763 delay: 764 mov r0, #1 765 lsl r0, r0, #20 766 delay_loop: 767 sub r0, r0, #1 768 bne delay_loop 769 bx lr 770 771 /* ... */ 772 773 sio_base: 774 .word 0xd0000000 775 </code></pre> 776 <p>\ 777 なお以上のコードは<code>.text</code>セクションである。\ 778 </p> 779 780 <h2>リンカスクリプト</h2> 781 <p> 782 以上のコードには<code>.boot2</code>、<code>.vectors</code>、<code>.text</code>\ 783 の3つのセクションが含まれる。<code>.boot2</code>はフラッシュの先頭から\ 784 256(<code>0x100</code>)バイト目まで、<code>.vectors</code>と<code>.text</code>\ 785 はその後ろに続くように配置する: 786 <pre><code>\ 787 MEMORY 788 { 789 FLASH(rx) : ORIGIN = 0x10000000, LENGTH = 2048k 790 } 791 792 SECTIONS 793 { 794 .boot2 : { 795 *(.boot2) 796 . = 0x100; 797 } > FLASH 798 799 .text : { 800 *(.vectors) 801 *(.text) 802 } > FLASH 803 } 804 </code></pre> 805 806 <h2>Makefile</h2> 807 <p> 808 以上のソースコードは以下のように配置している: 809 </p> 810 <pre><code>\ 811 rp2040 812 ├── ex1 813 │ ├── Makefile 814 │ ├── boot2.s 815 │ ├── main.s 816 │ └── memmap.ld 817 └── tools 818 ├── Makefile 819 ├── bin2uf2.c 820 └── bincrc.c 821 </code></pre> 822 <p> 823 toolsディレクトリのMakefileは同じディレクトリのソースファイルを<code>$(CC)</code>\ 824 でコンパイルするだけのものである(個人的な趣味で<code>tcc</code>を使っている)。\ 825 ex1ディレクトリのMakefileは以下の通り: 826 </p> 827 <pre><code>\ 828 AS = arm-none-eabi-as 829 LD = arm-none-eabi-ld 830 OBJCOPY = arm-none-eabi-objcopy 831 BINCRC = ../tools/bincrc 832 BIN2UF2 = ../tools/bin2uf2 833 834 MCPU = -mcpu=cortex-m0plus 835 ASFLAGS = $(MCPU) 836 CFLAGS = $(MCPU) -ffreestanding -nostartfiles -O0 -fpic -mthumb -c 837 LDFLAGS = --no-relax -nostdlib 838 839 all: tools led.uf2 840 841 clean: 842 rm -f *.o *.elf *.uf2 *.bin 843 cd ../tools && make clean 844 845 .s.o: 846 $(AS) $(ASFLAGS) -o $@ $< 847 848 led.elf: boot2.o main.o memmap.ld 849 $(LD) $(LDFLAGS) -o $@ -T memmap.ld boot2.o main.o 850 851 led.bin: led.elf 852 $(OBJCOPY) -O binary led.elf $@ 853 854 led.uf2: led.bin 855 $(BINCRC) led.bin led_crc.bin 856 $(BIN2UF2) led_crc.bin $@ 857 858 flash: all 859 mount /dev/disk/by-label/RPI-RP2 /mnt 860 cp led.uf2 /mnt 861 862 tools: 863 cd ../tools && make 864 </code></pre> 865 866 <p> 867 RP2040のボードをUSBデバイスモードでLinuxのパソコンに接続し、ex1ディレクトリで\ 868 </p> 869 <pre><code>\ 870 $ make 871 # make flash 872 </code></pre> 873 <p> 874 とすればプログラムがRP2040のボードに書き込まれて実行が開始される。\ 875 </p> 876 877 <h2>最後に</h2> 878 <p> 879 光あれ。 880 </p> 881 882 <h2>参考</h2> 883 <ul> 884 <li> 885 [1] Hennesy, J. L. and Patterson, D. A. 2017. Computer Organization And Design RISC-V Edition. 886 </li> 887 <li> 888 [2] <a href="https://akizukidenshi.com/catalog/g/gK-17542/">RP2040マイコンボードキット.秋月電子通商</a> 889 </li> 890 <li> 891 [3] <a href="https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf">RP2040 Datasheet.Raspberry Pi Foundation</a> 892 </li> 893 <li> 894 [4] <a href="https://github.com/raspberrypi/pico-sdk">pico-sdk.github</a> 895 </li> 896 <li> 897 [5] <a href="https://ja.wikipedia.org/wiki/%E5%B7%A1%E5%9B%9E%E5%86%97%E9%95%B7%E6%A4%9C%E6%9F%BB">巡回冗長検査.Wikipedia</a> 898 </li> 899 <li> 900 [6] <a href="https://github.com/microsoft/uf2">USB Flashing Format (UF2).GitHub</a> 901 </li> 902 </ul>