想定する使いかた

#include <Arduino.h>
#include "Arduino-meta.hpp"

constexpr uint8_t LED_RED = 0;
constexpr uint8_t LED_GREEN = 1;
constexpr uint8_t LED_BLUE = 2;

void setup() {
    pinMode(LED_BUILTIN, OUTPUT);

    // static version of pinMode()
    pinMode(
        LED_RED, OUTPUT,
        LED_GREEN, OUTPUT,
        LED_BLUE, OUTPUT
    );
}

void loop() {
    // this is also static
    digitalWrite(LED_RED, HIGH, LED_GREEN, LOW, LED_BLUE, LOW);
    delay(1000);
    digitalWrite(LED_RED, LOW, LED_GREEN, HIGH, LED_BLUE, LOW);
    delay(1000);
    digitalWrite(LED_RED, LOW, LED_GREEN, LOW, LED_BLUE, HIGH);
    delay(1000);

    // original version of digitalWrite()
    digitalWriteDynamic(LED_BUILTIN, HIGH);
    delay(1000);
    digitalWriteDynamic(LED_BUILTIN, LOW);
    delay(1000);
}

デフォルトの digitalWrite / pinMode / digitalRead をマクロで置き換えるようにして、完全にインターフェイスを互換にしたので、基本的に include したらあとはほぼ気にする必要がない。

ただ、静的に解決できない引数を指定するとコンパイルエラーになるので、この場合は何も考えず Dynamic をサフィックスにして元の Arduino 組込み関数をよぶようにすればいい。

基本 include するだけで最適化されたコードが生成されるようになり、必要に応じて複数ピンの同時操作もできる。

そして引数がおかしい場合コンパイルエラーになってくれるので便利。

何も失うものはない。

実装

前のエントリに書いた通り、C++ の template を使ってコンパイル時にビットマスクとかを計算しているだけ。pinMode も面倒くさいけど実装したり、digitalWrite/digitalRead 前に timer 付きピンなら無効にするような処理を入れたり (互換性のため) した。

Arduino.h を include すると、PROGMEM 指定されている const なテーブルが見えるので、本当はそれを直接コンパイル時にも使いたいのだけれど、どうしても無理っぽいので、独自にマップをコピペして持っている。無駄感

最終的には使う側の見た目をあわせるためプリプロセッサマクロを使って、マクロ関数の引数をテンプレートパラメータとして渡している。

static constexpr void (*digitalWriteDynamic)(uint8_t, uint8_t)  = *digitalWrite;
#define digitalWrite(...) digitalWriteMulti<__VA_ARGS__>()
static constexpr void (*pinModeDynamic)(uint8_t, uint8_t)  = *pinMode;
#define pinMode(...) pinModeMulti<__VA_ARGS__>()
static constexpr int (*digitalReadDynamic)(uint8_t)  = *digitalRead;
#define digitalRead(pin) digitalReadX<pin>()

テスト

一応テストも書いてあって

• https://github.com/cho45/Arduino-meta/blob/master/test/test.rb

test(<<-'EOS')
	void expected() {
		DDRD  = (DDRD  & 0b11111100) | (0b00000000);
		PORTD = (PORTD & 0b11111100) | (0b00000010);
	}

	void result() {
		pinMode(0, INPUT, 1, INPUT_PULLUP);
	}
EOS

こんな感じで、想定する展開コードとテンプレート関数とをコンパイルしたあと obj-dump して突き合せしている。これら2つの関数は全くバイナリ的に同一になることをテストしている。

備考

最初からテンプレートを駆使するつもりで AVR のライブラリを設計すればもっと良いものができそうだが、Arduino が覇権を握っているので、Arduino のインターフェイスにあわせるほうが嬉しい人が多いだろう。Arduino の基板上にはピン番号が書いてあるので、いちいちAVRのポート名とかとのマッピングを見ながら書くよりは、このほうが楽だ。

そしてテンプレート駆使しまくりすぎたライブラリは理解がつらいのが明かなので、このぐらいのショボいラッパぐらいがちょうどいいような気もする。一方でそれはそれで反知性的であるともいえそうだしなんともいえない。

前提

Arduino が使っている 8bit AVR では PORTB, PORTC, PORTD などと最大8bitのレジスタがあり、これら単位では同時に操作が可能になっている。

Arduino ではこれらのポート単位を隠蔽し、ピン番号という一連の番号によって区別するように抽象化されている。具体的には 0〜7 が PD, 8〜14 が PB というような感じ (standard なArduino の場合)

仕様

• digitalWrite() とインターフェイス互換であること (静的であること以外)
• 複数ビットを同時に操作できること
• 指定したピン番号同士のポートが同一でない場合エラーとすること

// オリジナル。0ピンをLOWにする
digitalWrite(0, LOW);

// 作ったもの。0ピンをLOW, 1ピンをHIGH... とする (同時に)
WRITE_MULTI(
  0, LOW,	
  1, HIGH,
  2, LOW,	
  3, HIGH
);

コード

Gist

解説

大きなメリット

同じようなことはテンプレートを使わない場合(素のCとか)だとまずできない。

特に「指定しなかった部分のビットはかえない」を実現しようとすると、どうしてもビットマスクと実際に設定するビット値の2つを扱わないといけないので、かなりコードが煩雑になる。テンプレート化することで表面上の可読性がかなり上がる (テンプレート部分はアレだけど)

そしてコンパイル時にチェックができる点はおおきい。マイコンはどうしてもフィードバックがすくないので、実行時エラーというのは実際気付くのが難しい。

速度的にも当然メリットがある。これの場合はコンパイルしたあとは素で書く場合と完全に同じバイナリになる。

000000ea <setup>:
; PORTD = (PORTD & 0b11110000) | (0b1010);
  ea:	8b b1       	in	r24, 0x0b	; 11
  ec:	80 7f       	andi	r24, 0xF0	; 240
  ee:	8a 60       	ori	r24, 0x0A	; 10
  f0:	8b b9       	out	0x0b, r24	; 11
; asm volatile ("nop");	// marker
  f2:	00 00       	nop
; WRITE_MULTI(...)
  f4:	8b b1       	in	r24, 0x0b	; 11
  f6:	80 7f       	andi	r24, 0xF0	; 240
  f8:	8a 60       	ori	r24, 0x0A	; 10
  fa:	8b b9       	out	0x0b, r24	; 11

素の digitalWrite の場合

; digitalWrite(0, LOW);
 10a:	60 e0       	ldi	r22, 0x00	; 0
 10c:	80 e0       	ldi	r24, 0x00	; 0
 10e:	0c 94 c8 00 	jmp	0x190	; 0x190 <digitalWrite>

で関数コールして

00000190 <digitalWrite>:
 190:	90 e0       	ldi	r25, 0x00	; 0
 192:	fc 01       	movw	r30, r24
 194:	e8 59       	subi	r30, 0x98	; 152
 196:	ff 4f       	sbci	r31, 0xFF	; 255
 198:	24 91       	lpm	r18, Z
 19a:	fc 01       	movw	r30, r24
 19c:	e4 58       	subi	r30, 0x84	; 132
 19e:	ff 4f       	sbci	r31, 0xFF	; 255
 1a0:	34 91       	lpm	r19, Z
 1a2:	fc 01       	movw	r30, r24
 1a4:	e0 57       	subi	r30, 0x70	; 112
 1a6:	ff 4f       	sbci	r31, 0xFF	; 255
 1a8:	84 91       	lpm	r24, Z
 1aa:	88 23       	and	r24, r24
 1ac:	99 f0       	breq	.+38     	; 0x1d4 <digitalWrite+0x44>
 1ae:	21 11       	cpse	r18, r1
 1b0:	16 c0       	rjmp	.+44     	; 0x1de <digitalWrite+0x4e>
 1b2:	e8 2f       	mov	r30, r24
 1b4:	f0 e0       	ldi	r31, 0x00	; 0
 1b6:	ee 0f       	add	r30, r30
 1b8:	ff 1f       	adc	r31, r31
 1ba:	e2 55       	subi	r30, 0x52	; 82
 1bc:	ff 4f       	sbci	r31, 0xFF	; 255
 1be:	a5 91       	lpm	r26, Z+
 1c0:	b4 91       	lpm	r27, Z
 1c2:	8f b7       	in	r24, 0x3f	; 63
 1c4:	f8 94       	cli
 1c6:	9c 91       	ld	r25, X
 1c8:	61 11       	cpse	r22, r1
 1ca:	05 c0       	rjmp	.+10     	; 0x1d6 <digitalWrite+0x46>
 1cc:	30 95       	com	r19
 1ce:	93 23       	and	r25, r19
 1d0:	9c 93       	st	X, r25
 1d2:	8f bf       	out	0x3f, r24	; 63
 1d4:	08 95       	ret
 1d6:	93 2b       	or	r25, r19
 1d8:	9c 93       	st	X, r25
 1da:	8f bf       	out	0x3f, r24	; 63
 1dc:	fb cf       	rjmp	.-10     	; 0x1d4 <digitalWrite+0x44>
 1de:	23 30       	cpi	r18, 0x03	; 3
 1e0:	29 f1       	breq	.+74     	; 0x22c <digitalWrite+0x9c>
 1e2:	60 f0       	brcs	.+24     	; 0x1fc <digitalWrite+0x6c>
 1e4:	27 30       	cpi	r18, 0x07	; 7
 1e6:	e1 f0       	breq	.+56     	; 0x220 <digitalWrite+0x90>
 1e8:	28 30       	cpi	r18, 0x08	; 8
 1ea:	a1 f0       	breq	.+40     	; 0x214 <digitalWrite+0x84>
 1ec:	24 30       	cpi	r18, 0x04	; 4
 1ee:	09 f7       	brne	.-62     	; 0x1b2 <digitalWrite+0x22>
 1f0:	90 91 80 00 	lds	r25, 0x0080
 1f4:	9f 7d       	andi	r25, 0xDF	; 223
 1f6:	90 93 80 00 	sts	0x0080, r25
 1fa:	db cf       	rjmp	.-74     	; 0x1b2 <digitalWrite+0x22>
 1fc:	21 30       	cpi	r18, 0x01	; 1
 1fe:	31 f0       	breq	.+12     	; 0x20c <digitalWrite+0x7c>
 200:	22 30       	cpi	r18, 0x02	; 2
 202:	b9 f6       	brne	.-82     	; 0x1b2 <digitalWrite+0x22>
 204:	94 b5       	in	r25, 0x24	; 36
 206:	9f 7d       	andi	r25, 0xDF	; 223
 208:	94 bd       	out	0x24, r25	; 36
 20a:	d3 cf       	rjmp	.-90     	; 0x1b2 <digitalWrite+0x22>
 20c:	94 b5       	in	r25, 0x24	; 36
 20e:	9f 77       	andi	r25, 0x7F	; 127
 210:	94 bd       	out	0x24, r25	; 36
 212:	cf cf       	rjmp	.-98     	; 0x1b2 <digitalWrite+0x22>
 214:	90 91 b0 00 	lds	r25, 0x00B0
 218:	9f 7d       	andi	r25, 0xDF	; 223
 21a:	90 93 b0 00 	sts	0x00B0, r25
 21e:	c9 cf       	rjmp	.-110    	; 0x1b2 <digitalWrite+0x22>
 220:	90 91 b0 00 	lds	r25, 0x00B0
 224:	9f 77       	andi	r25, 0x7F	; 127
 226:	90 93 b0 00 	sts	0x00B0, r25
 22a:	c3 cf       	rjmp	.-122    	; 0x1b2 <digitalWrite+0x22>
 22c:	90 91 80 00 	lds	r25, 0x0080
 230:	9f 77       	andi	r25, 0x7F	; 127
 232:	90 93 80 00 	sts	0x0080, r25
 236:	bd cf       	rjmp	.-134    	; 0x1b2 <digitalWrite+0x22>

となっていて、1bit 書くだけでかなり大層なことをしていることがわかる。