Raspberry Pi Pico(ラズピコ)：Arduino-PicoでのIOの高速化

# この記事は.. 
きのう投稿した『Raspberry Pi Pico(ラズピコ)：各種SDKによるIO速度の比較』の補足

https://qiita.com/teddokano/items/a9e96a6b5c5142640f98 

この記事ではArduino-Picoを使ってIO周波数:600kHzが得られたことを書いた．記事内ではMicroPythonではIOレジスタへの直接アクセスは試してみたのに，Arduinoではやってなかった．これってフェアぢゃない． 
ArduinoのコードはC/C++でコンパイルされるので，`digitalWrite()`ってAPIを使わずに直接レジスタへ書き込めばかなり速くなるはず．で，それをやってみた．

:::note info
追記：この記事を投稿した直後，Twitter(ていうが「X」)で，別の方法があることを教えていただいた． 
https://twitter.com/FremenHlide/status/1691233928554672129
Raspberry Pi Pico C/C++ SDKの`gpio_put()`がそのまま使えるらしい． 
この方法も試してみたので，記事の構成をちょっと変えた
:::

:::note info
追記2：さらに[同じ方から教えていただいた](https://twitter.com/FremenHlide/status/1691373205628284930)のだけど，Raspberry Pi Pico C/C++ SDKのAPIとしてインラインで直接アクセスする関数が充実しているので，こちらを使う方が便利ですね．
これらの関数については，こちらのドキュメントを参照↓↓
https://www.raspberrypi.com/documentation/pico-sdk/gpio_8h.html 
:::

結果は次のとおり👍


|SDK|周波数|
|----|----|
|[Raspberry Pi Pico SDK](https://github.com/raspberrypi/pico-sdk)|50MHz(推定値)|
|[Arduino-Pico](https://github.com/earlephilhower/arduino-pico) (`digitalWrite()`使用)|600kHz|
|[Arduino-Pico](https://github.com/earlephilhower/arduino-pico) (IOレジスタ直接アクセス)|60MHz(推定値)|
|[Arduino-Pico](https://github.com/earlephilhower/arduino-pico) (`gpio_put()`使用)|60MHz(推定値)|
|[MicroPython](https://micropython.org)|88k~120Hz|

# ふたつの方法 
最初に思いついたのが「直接レジスタにアクセス」による高速化だった．単純にハードにアクセスするので速くなる．  
その後，この記事を投稿したあとで，Raspberry Pi Pico C/C++ SDKのAPIがそのまま使えることを教えていただいたので，最後の節にそれを追加した．



## 直接レジスタにアクセス 
『Raspberry Pi Pico(ラズピコ)：各種SDKによるIO速度の比較』の記事の「あとは..」の節に書いたとおり，ラズピコに搭載されているマイコン・チップ:RP2040の[データシート](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf)には，IOがマップされている場所が「2.3.1.7. List of Registers」に書かれている．これによるとIOのベース・アドレスが0xD0000000，出力のオフセットが0x010になってるのでここに値を書き込めば，ピン出力の状態を変更できる． 
ラズピコのpin1（GPIOの0番）はこのレジスタのビット0にマップされているので，アドレス「0xD0000000 + 0x010」に「0x1」と「0x0」を交互に書き込めばピンがパタパタ（HIGHとLOWをトグル）する． 

この「レジスタ直接書き込み」はこんな感じで書ける． 

```c 
volatile uint32_t *GPIO_OUTPORT = (uint32_t *)(0xD0000010);

void setup() {
  pinMode(0, OUTPUT);
}

void loop() {
  *GPIO_OUTPORT = 0x1;
  *GPIO_OUTPORT = 0x0;
  }
```

出力は下のような感じに
![スクリーンショット 2023-08-15 10.44.49.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3288603/d76ae07c-2e55-aca7-0233-ed439a6ca6a8.png)

### 自前でループさせてみる
細いパルスが400nsちょっとの間隔で出ている．この400nsは`loop()`がコールされるオーバーヘッド分と思われる． 
これを確認するために自前のループを作って実行してみる．そうすると..

```c 
volatile uint32_t *GPIO_OUTPORT = (uint32_t *)(0xD0000010);

void setup() {
  pinMode(0, OUTPUT);
}

void loop() {
  for (;;) {  // 自前のループ
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x0;
  }
}
```
![スクリーンショット 2023-08-15 10.57.02.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3288603/a912a428-6851-996b-eaaa-259105263c92.png)

### コードで周波数を下げてみる
パルスが間欠ではなくて連続して出ているっぽいのだけど，残念ながらこのオシロスコープでの測定限界(30MHzまで)を超えていて，うねった波が見えるだけ．
なので同じレジスタアクセスを複数書いて周波数を下げてみる． 

```c 
volatile uint32_t *GPIO_OUTPORT = ( uint32_t *)(0xD0000010);

void setup() {
  pinMode(0, OUTPUT);
}

void loop() {
  for (;;) {
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    *GPIO_OUTPORT = 0x1;
    
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
    *GPIO_OUTPORT = 0x0;
  }
}
```

![スクリーンショット 2023-08-15 11.06.10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3288603/80bf6e5a-1305-9102-0f11-9a0f4e4efddc.png)

# `gpio_put()`を使ってみる
Raspberry Pi Pico C/C++ SDKのAPI，[`gpio_put()`がそのまま使える](https://twitter.com/FremenHlide/status/1691233928554672129)というのを教えていただいたので，それも試してみた． 
この実験も上記と同じく周波数を下げて試してみた． 


```c 
void setup() {
  pinMode(0, OUTPUT);
}

void loop() {
  for (;;) {
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);
    gpio_put(0, 1);

    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
    gpio_put(0, 0);
  }
}
```
![スクリーンショット 2023-08-15 12.03.33.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3288603/4415e007-2f91-d633-07a6-c27ee940d78c.png)

直接レジスタ・アクセスと同じ結果が得られた！

# まとめ

周波数を下げたいずれの実験結果でも，約6MHzは出ている．これらのコードでは同じ代入を10回書いて周波数を落としたので，この10倍の60MHzは出るものと想像できる． 

今回の結果は「Raspberry Pi Pico SDK」を使った時の50MHz(推定値)よりも速い．これはチップ内部のクロック設定などの違いが現れているのかもしれない．

では，直接レジスタ・アクセスと`gpio_put()`ではどちらを使う方がいいかというと，どちらでもいいと思う．ハードを直接触るよりもAPI経由の方がコードが読みやすくなるかもしれない． 
~~一方，直接レジスタ・アクセスは複数のビットを同時に操作できるし，別に用意されているレジスタでは細かいビット操作なども可能そうなので，そのような用途には有効かも．~~ 

**追記** 
上記の最後の一文を消した．というのも[『複数ビット操作なら`void gpio_put_masked (uint32_t mask, uint32_t value)`が使える』と，さらに『インラインで同じ直接アクセスを行う便利な関数がたくさんあります』と，またしても教えてもらった](https://twitter.com/FremenHlide/status/1691373205628284930)から．　
Arduino-PicoでRaspberry Pi Pico C/C++ SDKのGPIO関連のAPIドキュメントへのリンクも教えていただいた．ありがたい． 
これだけあればレジスタに直接アクセスする必要は無さそうに思う． 
@FremenHlideさん，ありがとうございました！

https://www.raspberrypi.com/documentation/pico-sdk/gpio_8h.html