公開日：2020/12/12

13th Season

#13-10　ATtiny2313とシリアルモニタ

　前回導入したATtiny2313というMCUチップなのですが(下図)、兎に角、メモリ(Flash／RAM)が少なくて、不用意にプログラムを組むと、簡単にメモリを溢れさせてしまいます。治水工事(省メモリでプログラミングするテクニック)が必要です。



　加えて、プログラムやシステムのデバッグ中に利いて来るのがシリアルモニタだと気が付きました。UNO等を使ったシステムのデバッグでは、「考え方間違ってないよね？」「正しく計算できた？」「ここの条件成立してるの？」等々、デバッグに必要な情報をSerial.print()などを使ってシリアルモニタに出力することで、PC画面で情報を確認しながらデバッグを進めることが出来ました。

　ATtiny2313でも、同様なデバッグ環境があると力強いのですが、前回の実験で判ったのは、「Serialライブラリの物量が思いの他大きい」と言う事でした。シリアルモニタを使って"hello, world"と送信する、ただそれだけのことでFlashは半分以上の1,096バイトを使ってしまいましたし、致命的なのはRAMが92バイトも喰っているという事です。
　ATtiny2313のRAMは128バイトしか搭載されていないので、その内の92バイトを使ったら、もう他の用途にRAMを使うことはできません。コンパイル時に表示されるRAM使用量は「グローバル変数」用に確保したサイズであって、それ以外にもauto変数(関数内だけで使う変数)やスタックなどにもRAMが必要となるからです。

　つまるところ、Serialライブラリを使ってしまうと、他のプログラムが全く入らなくなってしまって、デバッグどころではなくなってしまうのです。

tinyシリアル関数群

　Serialライブラリには、Streamクラスが継承されています。どうも、こいつの物量が大きい様です。print()メソッドなどで数値を文字列に変換して送信できるなど、いろいろと便利に使えるのはとても良いのですが、ATtiny2313での使用に限っては、コードサイズが肥大化してしまって否定的です。

　今やりたいのは、デバッグ用にちょっとした情報をPCに送るだけなので、多少使い難くても我慢です。

　　目標仕様：

• デバッグ情報をPC等に送信するため、最小限の機能を持った小さな関数群とする。
• tinyシリアル関数群と呼称する。
• ボーレートは設定可能とするが、フォーマットは8ビットデータ、LSBファースト、パリティなし、1ストップビットに固定する。
• 条件や引数などを見て、設定するレジスタ値を場合分けするコードサイズがもったいない。
• 必要に応じて、ATtiny2313搭載USARTユニットのレジスタ設定部分を手動で変更すれば、他のフォーマットにも対応可能。
• デバッグ用に時々計算結果等の情報を送信できたら良しとする。
• Streamクラスには非対応(コードサイズが大きい)。
• 文字列、F(文字列)、10進数値(int16)、16進数値(int16)の送信に対応。
• PCからのデータ受信は、対応するが、オプションとする。
• 受信しない場合、送信関数のみで使用できて、コードサイズおよびデータサイズを小さくすることが出来る。
• 受信バッファ(FIFO)は8段(定数tser_MAXBFで変更可能)。受信データの有無はtser_rptrとtser_wptrの比較で実施。
• tser_rptr＝tser_wptrなら、受信データなし。
• tser_rptr≠tser_wptrなら、受信データあり。
• リング(FIFO)バッファ制御の解説はこちら。
• ライブラリ化しない。
• デバッグ用なので、#ifdefなどで場合分けして使う用途を想定。必要なコード部分をコピー＆ペーストして使う。
• #ifdef用場合分け：
• USE_TINY_SERIAL：　tinyシリアル送信関数を使う。
• USE_TINY_SERIAL_RX：　tinyシリアル受信関数を使う。
• USE_TINY_SERIAL_RXは、USE_TINY_SERIALに包含される。
• 各関数仕様：
• void　tser_init (int32 baud);
• ATtiny2313のハードウェアシリアル(USARTユニット)を非同期シリアル通信(UART)として初期化する。
• 通信速度をbaudに設定する。フォーマットは8ビットデータ、LSBファースト、パリティなし、1ストップビット。
• 使用例）tser_init (9600);
• void　tser_write (uint8 dat);
• 1バイトのバイナリデータdatを送信する。
• void　tser_write (const char *str);
• C文字列strを送信する。
• 改行を送信したい場合、文字列"\r\n"を送信すれば良い(改行コードがCR＋LFの場合)。
• void　tser_write (const __FlashStringHelper *str);
• F()マクロで修飾された文字列strを送信する。
• 使用例）tser_write (F("hello, world\r\n"));
• void　tser_write_dec (int16 dec, char adh='\0');
• 16ビット符号付10進数値decを文字列に変換して送信する。
• adhに0または'\0'以外の文字が指定されると、数値を送信した後で、adhを送信する。
• 数値を送信したら、次の数値との区切りとして、空白やカンマ(，)などを送信したいケースが多いため。
• 使用例）tser_write_dec (dec_num, '，');
• 数値dec_numの後ろにカンマ(，)が出力される。
• void　tser_write_hex (int16 hex, char adh='\0');
• 16ビット符号付16進数値hexを文字列に変換して送信する。
• 数値の前に16進数を表す"0x"が付加される。必要ない場合はコードから削除のこと。
• adhに0または'\0'以外の文字が指定されると、数値を送信した後で、adhを送信する。
• int　tser_read (void);
• 受信したデータを1バイト(uint8)返す。
• 受信データが無かった場合、−1を返す。
• 要「#define　USE_TINY_SERIAL_RX」。
• void　get_line (void);
• tser_read()関数を使って、次の改行コード(LF)まで受信し、配列lbuf[ ]にセットして戻る。lbuf[ ]にはLFコードを含まない。
• LFまで受信した後で、末尾がCRだった場合には、CRコードを削除する。
• 認識可能な改行コードはLFおよびCR＋LFの2通り。CRのみの改行コードには未対応。
• 結果、lbuf[ ]には改行コード(CR，LF)を含まない。
• 受信バッファ(lbuf[ ])サイズは定数max_lbuf＝8で設定してある。必要に応じて変更。
• 一旦受信してしまう改行コード(CR)分と終端コード('\0')を含んでmax_lbufバイトなので、注意。デフォルトの設定だと、6文字までしか受信できない。
• 要「#define　USE_TINY_SERIAL_RX」。

ATtiny2313のUSARTユニット

　ATtiny2313のハードウェアシリアル(USART)ユニットの使い方を簡単に解説しておきます。足りない部分は各自ATtiny2313データシートで補完して下さい。

初期化

　3個の制御レジスタ(UCSRA，B，C)に必要なビットをセットします(↓)。

　　// USART setting
　　// async, 8 bit, no parity, 1 stop, RXCI enable, RX & TX enable
　　UCSRA=0x00;
　　UCSRB=0x80 + 0x18;
　　UCSRC=0x06;

　パリティやストップビット等の設定ビットが含まれているので、必要に応じて変更してください。UCSRBレジスタに送信機能TXと受信機能RXを有効化するビットが2ビット有って、このビットを有効に設定すると自動的にI/OポートがTXD端子／RXD端子として機能するように乗っ取られるので、pinMode()関数などで別途設定する必要はありません。

　通信速度(ボーレート)は、データシートに記載の通り、以下の様に計算してUBRRH，UBRRLレジスタに書き込めば終了です。

　　baud=((F_CPU/16) + baud/2)/baud - 1;
　　UBRRH=(baud>>8)&0x0f;
　　UBRRL=baud&0xff;

　初期設定はこれで終了。簡単ですね。

※baudが変数だった場合、上コードの「baud＝〜」部分はint32の演算になってしまうので、32ビット演算ルーチンがリンクされて、一気にコードサイズが肥大化します。「tser_init (9600);」の様に、baudを定数にすると、「baud＝〜」部分はCコンパイラ(GCC)が計算してくれるので、32ビット演算ルーチンをリンクしません。……tser_init()関数がインライン展開されることが条件です。

データ送信

　USARTユニットには、送信データバッファが1段あって、UDRレジスタがそれです。1段しかないので、前に書き込んだデータの送信が終わっていない場合には、新しいデータを書き込むことが出来ません。
　これをUCSRAレジスタのUDREビット(第5ビット)で確かめて、送信データバッファが空になってからUDRレジスタへ書き込む必要があります(下コード)。

　　// polling while UDRE=0
　　while (!(UCSRA&0x20))
　　　　;
　　// send data
　　UDR=dat;

　送信もこれだけ。簡単ですね（１＾＾）。

データ受信

　受信データはいつ送られて来るかわからないのと、受信したデータはすぐに読み出してRAM上のバッファ(リングバッファ)に記憶して行かないと、次のデータを受信できずに消失してしまいかねません。そこで、受信した時に割り込みを発生させて、タイムリに受信データを読み出す必要があります。
　USARTユニットの受信データバッファは2段あって、UDRレジスタから1個づつ読み出すことが出来ます。読み出したデータはUSARTユニットの受信データバッファ(2段)からは消えてしまうので、RAMに確保したリングバッファに書き込んでおきます。

　以下、割り込みサービスルーチン(ISR)のコードです。

　　ISR (USART_RX_vect)
　　{
　　　　// RXCI interrupt service routine
　　　　uint8　nxt_wptr;

　　　　// update write pointer
　　　　nxt_wptr=tser_wptr + 1;
　　　　if (nxt_wptr>=tser_MAXBF)
　　　　　　nxt_wptr=0;
　　　　if (nxt_wptr==tser_rptr)
　　　　{
　　　　　　// ERROR: buffer full
　　　　　　// discard new data and ignore error for robustness
　　　　　　UDR;
　　　　　　return;
　　　　}

　　　　// receive data
　　　　tser_rbuf[int (tser_wptr)]=UDR;
　　　　tser_wptr=nxt_wptr;
　　}

　リングバッファが満杯だった場合、新たに受信したデータは消失してしまいますので、バッファフルにならないように制御する必要があります。リングバッファの制御についてはこちらに解説が有ります。

　受信制御は少々複雑でしたね（１＾＾；）。上のコードだと、「ただ受信しただけ」なので、改行コードまで受け取ったり、受け取ったデータを解釈したりと、受信側のコードはどうしてもコードサイズが大きくなります。メモリの限られているATtiny2313では、なるべく使用を控えるべきでしょう。

実験の章

　まず、物量を確認しておきましょう。以下の様なデバッグ情報を送信するコードをsetup()関数内に記述して、Serialライブラリとtinyシリアル関数群でメモリ使用量を比較してみます(↓)。

　　#ifdef　USE_TINY_SERIAL
　　　　tser_init (9600);
　　　　tser_write (prog_name);
　　　　tser_write (F(" ver."));
　　　　tser_write (prog_vers);
　　　　tser_write (F("\r\n"));
　　　　tser_write_dec (dat,' ');
　　　　tser_write_dec (-dat,' ');
　　　　tser_write_hex (dat,' ');
　　　　tser_write_hex (-dat);
　　　　tser_write (F("\r\n"));
　　#else　//　USE_TINY_SERIAL
　　　　Serial.begin (9600);
　　　　while (!Serial)
　　　　　　;
　　　　delay (10);
　　　　Serial.print (prog_name);
　　　　Serial.print (F(" ver."));
　　　　Serial.println (prog_vers);
　　　　Serial.print (dat);
　　　　Serial.print (' ');
　　　　Serial.print (-dat);
　　　　Serial.print (' ');
　　　　Serial.print (dat, HEX);
　　　　Serial.print (' ');
　　　　Serial.println (-dat, HEX);
　　#endif　//　USE_TINY_SERIAL

　結果を以下表に示します。

　ちなみに、tinyシリアルで使用したRAM容量27バイトの内、約17バイトは、以下に示す文字列宣言によるもので、プログラム名やバージョン情報を記憶する必要が無い場合には、削減可能です。

　　const　char　prog_name[ ]="tiny_serial";
　　const　char　prog_vers[ ]="1.00";

　残りはそもそもコアライブラリが消費している分ですので、RAMに関しては、ほぼ手つかずで残っています。これは非常に大きなアドバンテージです。


　続いて、いつもUNO等のプログラムで使っている様に、シリアルモニタから【who】／【help】コマンドだけを受け付けるプログラムを作りました。LED_BUILTINのLチカを追加してあります。ATtiny2313の20DIPピン番号で#16ピンに適切な電流制限抵抗とLEDを接続すると、パイロットランプとしてチカチカ光ります(↓)。

　　tinyシリアル関数群プログラム：tiny_serial.ino

※Arduino as ISPを使ったATtiny2313へのプログラム書き込みについてはこちらを参照してください。

　「#ifdef　USE_TINY_SERIAL」で場合分けした部分(setup()関数／loop()関数内を除く)が今回作成した関数群です。ライブラリ化していないので、他のプログラムのデバッグで使用する場合には、この部分をコピー＆ペーストして使用してください。

　FTDI等のUSB⇔UART変換モジュール(下図)を使って、ATtiny2313との非同期シリアル(UART)接続を確立しましょう(下表)。

※FTDIの電圧ジャンパは5V側で使用。ATtiny2313 #16ピン(D13)に適切な電流制限抵抗＋LEDを接続すると、チカチカ光る。


　以下、実験中の様子です。



　通常のデバッグ中を想定して、UNO as ISPをSPI接続したまま(頻繁にプログラムを書き込みするため)の状態で、FTDIがATtiny2313の非同期シリアル(UART)ポートとつながっています。Arduino IDEは、UNOのUSBポートを選択しておくのが順当ですから、FTDIのシリアルポートはTera Termなど他のソフトウェアで開いた方が使い易いと思います。


　　実験サンプル：【 】内はTera Termからの送信データ
　　tiny_serial ver.1.00
　　100 -100 0x64 0xff9c
　　RDY

　　【help】
　　OK+ who
　　OK: help

　この状態のメモリ使用量は、Flash 1,592バイト、RAM 53バイトでした。さすがに、シリアルモニタからコマンドを受け付けるのは、メモリ容量的に厳しいかもしれませんね(残りFlash空き容量は400バイト程)。受信関数を使わずに、デバッグ情報をPCへ送信するだけなら何とか使用できるのではないでしょうか？
　デバッグ用途としては合格ラインだと思います。

コードサイズ節約のヒント

　C言語のプログラムは、Cコンパイラ(GCC)がコンパイルしてオブジェクトコードに変換すると、リンカと言うソフトウェアが必要なコードだけを集めて、最終的にArduinoへ書き込むデータを生成しています。リンカは賢いので、C言語のソース中に記述してあっても、使わなかった関数のオブジェクトコードは最終的な書き込みデータには含まれません。

• 使わなかった関数は最終書き込みデータに含まれないので、例えば、10進数送信関数と16進数送信関数を両方使うのではなく、どちらか一方に統一して使うとコードサイズを節約できる。
• 10進数送信関数は比較的大きめ。
• 16ビット整数型(int16)の演算を実行しているので、int16の演算ルーチンがリンクされるためであろう。
• そもそも、アプリケーション内でint16演算ルーチンを使っている場合には、10進数送信関数(自身)のコードサイズは、それほど気にならないはず。
• 16進数送信関数の方がやや小さめ。
• 文字列を送信する時は、F()マクロを使って、文字列データをRAMにコピーさせないことが重要。
• 使用例）tser_write (F("hello, world"));
• RAMは消費しなくてもFlashは消費するので、「デバッグ用に意味が通じれば良し」として、なるべく短い文字列に留めることも肝要。
• 16ビットや32ビットの演算はコードサイズが大きくなる。
• 16ビットや32ビットの演算は、AVRのアセンブラ命令1個では実行できないので、いくつかの命令を組み合わせて実現している。
• 特に割り算は、シフト除算ルーチンをリンクしてサブルーチンコールするので、このコードサイズが大きい。
• C言語を使う限り、intが16ビットなので、16ビット演算はある程度止む無しと割り切ったとして、32ビット演算はなるべく使わないのが最善。

　前回ATtiny2313の開発環境(Arduino IDE)を構築したのに引き続き、今回はデバッグを容易にするため、非同期シリアル通信環境を整備してみました。ストレス😣なくデバッグできるかどうか？は、システムを構築する上で非常に重要な要因ですからね。