2008年10月31日 USB接続方式のドライバインストール不要なAVRライタ（HIDaspx） ￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣ 【0】 はじめに HIDaspxとは、ドライバのインストールが不要のUSB接続方式のAVRライタです。 hidmonを利用すれば、汎用のUSB-IOとしても利用できます。 瓶詰堂さんの作成された HIDasp を元に、iruka さんと senshu が共同で改良を行 ないました。一定の成果が得られましたので、2008年 9月 22日より公開を開始しま す。HIDaspx は、瓶詰堂さんの公開しているものとは内容が異なり、firmware, hidspx コマンド共に互換性はありませんので区別して扱ってください。 ※ HIDaspxは、エイチ・アイ・ディー アスペックスとお読みください。 【0】 アーカイブの構成 .\ ├─bin │ libusb0.dll │ hidspx-gcc.exe … MinGW-GCCでコンパイルしたもの │ hidspx.exe … Borland C++ ver 5.5.1でコンパイルしたもの │ hidspx.ini … hidspxの初期化ファイル │ fuse.txt … FUSE情報を詳細に表示する為のテキストファイル │ fuse_en.txt │ fuse_j.txt ├─bin │ └─firmware … main.hex（HIDaspx用）, main_libusb.hex（MacOS, Linux用） │ … main-small.hex(USB-IO専用のファームウェア) ｜　　　　　　　　　　　… genserial.awk（シリアル情報生成ツール） ｜ ├─firmware … HIDaspのファームウェアソース ├─hidspx-src … hidspxのソース(MinGW, Borland C++兼用) │ └─libusb │ ├─bin │ ├─examples │ ├─include │ └─lib │ ├─bcc │ ├─dynamic │ ├─gcc │ ├─msvc │ └─msvc_x64 └─pict … 回路図 【1】 hidspxコマンドのインストール方法 　hidspxのインストールには、特別なインストーラは不要です。 bin ディレクトリにあるファイルを実行可能なディレクトリにコピーすることで利 用可能になります。 **************************** 重要 **************************** 2007/03/20 11:33 43,520 libusb0.dll 2008/10/30 12:29 115,712 hidspx.exe 2008/10/30 12:29 67,584 hidspx-gcc.exe 2008/09/09 12:54 17,408 usbtool.exe 2008/09/05 10:39 289 hidspx.ini 2007/10/31 23:01 19,207 fuse.txt 2007/10/31 23:00 21,160 fuse_en.txt 2007/10/31 23:01 19,207 fuse_j.txt **************************** 重要 **************************** これらのファイルは、相互に関係していますので、hidspx.exe だけでなく一括して コピーしてください。 環境変数の操作ができる方は、hidspx\bin というディレクトリを PATH 環境変数に 登録して利用するとよいでしょう。 なお、2 つの実行ファイル（hidspx-gcc.exe, hidspx.exe）の機能は同じです。1 ヶ月以上のテスト期間中に問題が無かったことから、Borland C++ でコンパイルし た hidspx.exe を標準の実行ファイルとして公開します。動作に異常がある時には、 従来の標準にしていた hidspx-gcc.exe を使ってみてください。 ===========================「補足」=========================== 現在のところ、hidspx のコマンド名を使っていますが、これは avrspx の別名です。 （名前は任意に変更できますが、混乱しない名前をつけてください。設定ファイル は、コマンド名.ini になります。） この名称にしているのは 既存の avrspx の利用者に混乱を与えなず、HIDaspx に対 応を明示するためです。hidspx は avrspx の機能の全て利用可能です。そして多く の改良を行っています。しかし、意図しない副作用（不具合）が生じる可能性もあ ります。そのため、十分な動作検証を終えるまでは、avrspx の名称をつけずに公開 ますので、ご了承ください。 ============================================================== 【2】 準備 bin/main.hex を Tiny2313 に書き込んでください．ヒューズ設定は，外付けの 12MHz クリスタルに合わせ、以下のように設定します。 Low: 11111111 (0xFF) ||||++++-- CKSEL[3:0] システムクロック選択 ||++-- SUT[1:0] 起動時間 |+-- CKOUT (0:PD2にシステムクロックを出力) +-- CKDIV8 クロック分周初期値 (1:1/1, 0:1/8) High:11-11011 (0xDB) |||||||+-- RSTDISBL (RESETピン 1:有効, 0:無効(PA2)) ||||+++-- BODLEVEL[2:0] (111:Off, 110:1.8, 101:2.7, 100:4.3) |||+-- WDTON (WDT 0:常時ON, 1:通常) ||+-- SPIEN (1:ISP禁止, 0:ISP許可) ※Parallel時のみ |+-- EESAVE (消去でEEPROMを 1:消去, 0:保持) +-- DWEN (On-Chipデバッグ 1:無効, 0:有効) Ext: -------1 (0xFF) +-- SPMEN (SPM命令 1:無効, 0:有効) ※ 今までは、PD2からのクロック出力を有効にしていました。この機能を利用したい 場合には、Low=0xBF と設定します。 現在の版では、PD2 は開放で通常のライタモード、GND と接続すると USB-IO モー ドとして機能します。また、AVR ライタモードでは PB2 の LED 端子は 1MHz の クロック信号を出力します。この信号は、PD2よりも使い勝手は良いと考えます。 【3】 使い方 　以下に簡単な使用例を紹介します。詳細な使い方は、avrx-tool.txtをご覧ください。 ※ 1030版以降は、FUSE Lowを0xFFに設定することをお薦めします。 ■ USB-IOとして利用する USB-IO として利用する場合には、PD2 を GND に繋いでください。USB-IO として使 っている装置を誤ってプログラマ（ライタ）として操作するのを避ける為、この状 態で、hidspx を利用すると、以下のようにエラーを表示します。 >hidspx -rp Error: HIDaspx is USB-IO mode. HIDaspx(0000) not found. ■ AVRライタ（Programmer）として利用する USB-IO 機能を利用しない場合には、ハードウェアの変更は不要です。なお、ライタ モードでは、PB2(PWR LED) の LED がやや薄く点灯します。これは、PD2(12MHz) の 替わりに、PB2 を ターゲットマイコンの 救済用クロック (1MHz) として利用でき ます。 hidspx に「-ph」を指定すれば HIDaspx が利用できます。hidspx.ini に -ph を書 いておけば、この指定は省略できます。 > hidspx -ph -d4 test.hex hidspx.ini に -d4 を設定しています。-d でディレイを指定でき、数値は時間に比 例します。1MHz の RC 発振モードでは -d4 以上を指定してください。なお、この 値は、高速に動作する AVR マイコンでは小さな値を指定でき、16MHz 以上の周波数 で動作する AVR マイコンには -d0 が指定できます。指定値が小さいほど、R/W の 速度が向上します。 -dNの指定の目安は、以下のとおりです。 No FUSE Low -dの値 発振周波数 備考 0 ---- -d0 16MHz以上 外部クリスタル/セラミック発振子 1 -fL11100100 -d1 8MHz 14CK+65ms 2 -fL11100010 -d2 4MHz 14CK+65ms 3 -fL01100100 -d4 1MHz 工場出荷値 4 -fL01100010 -d5 500kHz 14CK+65ms 5 -fL11100110 -d17 128kHz 14CK+65ms 6 -fL01100110 -d120 16kHz 118, 119では不安定 iruka さんによる計測結果を示します。（最新の版では、これよりも性能が向上し ていることがあります） コマンド 評価内容 改良前 高速化後 ------------------------------------------------------------------------- hidspx -d0 -rp >XX.hex 8kB Read 8.39秒 2.22秒(3,690B/秒) hidspx -d0 test.hex 8kB Write/Verify 10.94秒 4.86秒(1.64kB/秒) hidspx -d1 -rp >XX.hex 8kB Read 8.40秒 3.12秒(2,625B/秒) hidspx -d1 test.hex 8kB Write/Verify 10.96秒 7.06秒(1.13kB/秒) hidspx -d4 -rp >XX.hex 8kB Read 8.39秒 4.63秒(1,770B/秒) hidspx -d4 test.hex 8kB Write/Verify 13.26秒 9.98秒(821B/秒) ------------------------------------------------------------------------- 【4】 HIDaspxの高速化（USB-HUB利用の薦め） 　AT90S2313 のように、ページ書込みをサポートしない AVR マイコンでは書込みに 時間がかかります。USB 2.0 HUB を介せずに接続して、同様の書込みを行った結果 です。 ○ hidmonによるベンチマーク結果 AVR> bench hid write start hid write end, 38000 bytes/11172 ms, 3401 bytes/s ○ Write&Verify結果 >timeit hidspx -d2 2kb.hex Elapsed Time: 0:00:25.703 次に、1,000 円以内で買える HUB を介して、同様の計測を行ってみます。 ○ hidmonによるベンチマーク結果 >hidmon AVR> bench hid write start hid write end, 38000 bytes/2468 ms, 15397 bytes/s ○ Write&Verify結果 >timeit hidspx -d2 2kb.hex Elapsed Time: 0:00:09.546 ATtiny2313 に比べて遅いのですが、HUB 無しに比べて、1/2 以下に短縮され、10秒 未満で書込み＆照合が完了します。 USB HUB が非常によい仕事をしていることがわかります。旧タイプの AVR マイコン に限らず、ほとんどの場合、処理速度は格段に向上します。この例では、10秒程度 の時間ですが、ATtiny2313 なら 1秒程度で完了します。hidmon で 15kB/s を超え る環境を用意するのが速度向上につながります。USB-HUB をお持ちであれば、それ を介して利用してみてはいかがでしょうか。 =============================================================================== 【5】 ライセンス（瓶詰堂さんに同じ） AVR USBに準じ、GPL2とします． 【6】 謝辞 　HIDaspx の開発には、多くの方から協力をいただきました。ここに、心より感謝 の意を表します。 1. 瓶詰堂さん …… HIDaspの開発者です。HIDaspなくしてはHIDaspxはありません。 2. irukaさん …… 高速化はirukaさんの成果です。 3. kugaさん …… 旧AVRのサポートとコンパクト化、PD5による再接続機能。 4. RAINさん …… 新アイコンの作成と各種の動作テスト。 5. 岩永さん …… 複数のHIDaspxを区別して利用可能なことを確認。 6. kumanさん …… 早期から注目していただき、多くの助言をいただきました。 7. TADさん、宮前さん、mituさん、akakusaさん、すんさん、kawanaさん …… 動作報告や各種のコメントをいただきました。 ----- * ----- * ----- * ----- * ----- * ----- * ----- * ----- * ----- 【付録】 開発者向けのメモ [0] 2008-10-17〜10-22の作業内容 　複数台の HIDaspx を一台の PC に混乱無く利用できる機構を実現する為、シリア ル番号の生成ツールや hidspx,hidmon の機能拡張を行いました。この機能を実現す るため、以下の作業を行っています。 1. シリアル情報生成ツールの作成（gawkで記述） 2. hidspxコマンドの-ph[:XXXX]にシリアル情報指定機能を追加 3. 〃 に -ph? でリストできる機能を追加 4. hidmon にも同様の機能を追加 5. 〃 に -p? でリストできる機能を追加 6. hidmon.dllに シリアル情報を指定できる機能を追加 7. ドキュメントの見直し 8. 実際の環境での動作確認 [2] firmware, hidspx-src の利用法 1. CMD prompt 上で make を使ってbuildする 2. ヘッダファイルなどを変更した場合には、make clean 後にmakeすること。 ミスを避ける為、rebuild.bat を用意している。rebuild を実行すると、これ を必ず実行できる。なお、作業が済んだら、cleanup を実行すると、作業ファ イルを一括して削除できる。 3. エラー無く生成されたファームウェアや実行ファイルは、binの下にコピーされる [3] シリアル情報の生成ツールの使い方 Gawk を使って、HIDaspx 用のシリアルデータ（HEX ファイル）を生成するツールを 作成しました。（WinAVR に付属する gawk_exe を同梱しています） 1028 版以降、「-v adr= 」を指定することで、任意のアドレスに対するシリアル情 報を生成できます。これにより、複数のファームウェアでの適用が可能になりました。 usage: gawk -f genserial.awk [-v adr=XX] start-number [end-number] ￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣ 使用例1： > gawk -f genserial.awk 0001 のように使います。これを実行すると、0001 のシリアルデータの HEX ファイル （_0001.hex）を生成できます。 使用例2：0001〜0100のシリアル情報のファイルを一括して生成します。 指定できる値は1〜9999まで、これを超えるとエラーになります。 > gawk -f genserial.awk 1 100 使用例3：16進数や英大文字の指定も可能です。 小文字で指定しても大文字に変換します。 > gawk -f genserial.awk ABCD このファイルを main.hex のファームとともに以下のように書き込めば、HIDaspx はそのシリアル番号を持ったものになります。 > hidspx main.hex _0001.hex ※ 先頭文字に'_'を追加しました。 > del _*.hex で一括してシリアル情報用のファイルを削除できます。 [3.1] hidspxでのシリアル情報指定方法 複数台の異なるシリアル情報を持った HIDaspx を使って動作の確認を行いました。 この機能により、複数の HIDaspx を区別して利用できます。（一台だけで利用する 場合には、シリアル情報設定は不要です。） > hidspx -ph:0001 ↑のように指定すると複数の HIDaspx を区別して使うことができます。なお、-ph とだけ指定すると、初期値の 0000 が選ばれるので、HIDaspx を一台だけ利用して いる場合には、シリアル情報を意識する必要はありません。 >hidspx -ph -r HIDaspx(0000) not found. ---- -ph では「0000」を探します >hidspx -ph? ---- 接続されている HIDaspxを表示させます Manufacturer: [YCIT], Product: [HIDaspx], serial number: [0123] >hidspx -ph:1234 -r ---- 番号を指定してHIDaspxを使います HIDaspx(1234) not found. ---- 1234のHIDaspxは存在しません >hidspx -ph:0123 -r ---- 正しく指定すれば、動作します Detected device is ATtiny2313. Device Signature = 1E-91-0A Flash Memory Size = 2048 bytes Flash Memory Page = 32 bytes x 64 pages EEPROM Size = 128 bytes [4] 機能の変更点 　複数の開発者による開発は発散しがちですが、HIDaspx に関しては、奇跡的？に 上手く機能しています。 4454 Oct 16 20:19 Makefile 4540 Oct 16 20:22 Makefile.unix 52 Oct 16 20:31 cleanup.bat 144 Oct 17 08:41 rebuild.bat 1137 Oct 18 18:03 hidconfig.h 15153 Oct 18 18:04 usbconfig.h 今まで main.c に書いていた「機能選択用の定義」を「hidconfig.h」に分離し、 他のソースからも参照可能にしました。これによって、hidconfig.h のみを修 正するだけで、最適なコードの作成が可能になります。 私の追加したbatファイルの簡単な使い方を説明しておきます。 0. 設定フラグは、hidconfig.h, usbconfig.h に設定する （main.c には設定フラグはありません） 1. 通常は、make を実行する。 2. エラーが無くなり、正しく機能することがわかれば、rebuildを実行すると、 clean後に再コンパイルし、2種類のHEXファイルは ../bin/firmwareにコピーされる 3. 作業が終われば、cleanupにて作業ファイルを削除する 2 と 3 は一つにできますが、ファイルを削除するようなコマンドは、分離する のが無難と考えています。この変更で不都合がある場合には、ご指摘ください。 また、iruka さんも書いていますが、現在、全ての機能を有効にしても 2044 バイトであり、2048 以内に収まっています。 * senshu 2008-10-18 (土) 20:23:54 New hidspx と firmware の整合性を再確認してみましたが、LED の制御コマンド の有無の判定と LED 制御のファームウェアの部分に若干の疑問点があります。 サイズが足りなかったので、コメントアウトした部分があるのですが、これ は整理し、LED 制御は MONITOR コマンドに統一し、ISP_CMD は必ず使えるよ うにするのがよいと考えています。 色々検討した結果、以下の仕様にしたいと考えています。（1017版も同様） (1) ISP_CMD は必ず組み込む (2) ISP_CMDではLEDの制御は無効（ファームに任せる） 　　⇒ ライタ制御プログラム(hidspx)で指定しても無視する (3) 2個のLEDをPCから制御する場合、ISP_CMDではなくMONITOR機能を利用する この仕様にすれば、ファームもコンパクトに維持でき、混乱を避けられます。 問題は 9月に公開したファームを使っている場合ですが、これは新しいもの に更新をお願いすることになります。 [5] 変更履歴 2008-09-22 ... senshuとirukaさんが改造を実施 高速化対応実施 2008-09-24 ... senshu firmware -d0オプションの最適化 hidpsxのエラー検出時、のメッセージ出力の修正（改行して表示） 2008-09-28 ... hidspxのコンパイルオプションに-Wallを追加し、警告メッセージに 対する修正を実施(senshu) firmware -d0オプションをUSBasp互換性を高めた(iruka) MOSI, SCK の競合を回避（Hi-Z化する） 2008-10-03 ... - hidspxのメッセージをHIDaspxに統一 - Borland C++ での警告メッセージを抑止(avrspx.hを修正) - usbtool を追加 - kugaさんのアドバイスにより、Firmwareサイズを40バイト縮小(1968バイト) avr-size --mcu=attiny2313 main.elf text data bss dec hex filename 1966 4 85 2055 807 main.elf - USBのProductID 0x5dc (libusb device) との競合を避ける為、 0x5df(HID devide)に変更 - firmwareの変更 （今のところサポートしているAVRデバイスでは） page_addr は 256 以下なので、uint16 から uint8 に降格。 2008-10-06 ... - irukaさんの10-05までの修正分を反映（ほぼ同じ内容です） - -d2以上の値を指定した時の不具合は、senshuの修正ミスでした。 （irukaさん、大変お手数をお掛けしました） - ATtiny2313の認識が不十分だった件に関しては、このミスに起因して シーケンスが見直され？、より適切なものになっています - firmwareの変更 page_addr を uint16 に戻す。 2008-10-10 ... - irukaさんの10-09までの修正分を反映（ほぼ同じ内容です） - 2008.10.9a delay_10us関数がコンパイル環境によっては最適化されて 消えていたのを修正. （アセンブﾘ言語でリライト） - 2008.10.9a '-d2'以上の遅延クロック数を適正化 - 2008.10.9 高速化: flow-controlを導入 - 2008.10.9 12MHzターゲットに '-d0'が使えるように変更(SCLK=2MHz) - 2008.10.9 ispConnect/ispDisconnectを導入 2008-10-12 ... - kugaさんのAT90Sシリーズ用のISP移行処理を追加（90Sシリーズをサポート） - ATtiny2313 のFUSEビットSTUビットの値によって、認識に失敗するのを修正 （hidspx内のhwctrl.c spi_reset関数にdelay_ms(10)を追加しました） - FUSE verifyエラー時の表示を適正化 - FUSE 書き換え関数の適正化（重要！） 2008-10-14 ... - firmware main.c「USICR=0; /* SCKをポートに戻しておく */」を有効化 -- USIの初期化をmain関数から、usi_trans関数に移動(SCK発生時の互換性向上) - usbHidReportDescriptorの大きさを9バイト縮小(現在 2038バイト) - hidmonとの整合性を考慮し、元に戻しました(現在 2048バイト) - ソース中のコメントを修正（不整合部分を修正） 2008-10-17 ... - firmware (HID版に加え、libusb版を追加） - rebuild.bat , cleanup.batを追加 - avrx-tool.txt（詳しい使い方の解説）を追加 2008-10-20 ... - firmware (HID版に加え、libusb版を追加） - -ph:XXXX のシリアル情報をサポート - firmwareソースのクリーンアップを実施 - bin フォルダにシリアル情報生成ツール(genserial.awk)を追加 - 新アイコンに変更(RAINさん作成) 2008-10-21 ... - シリアル情報生成ツールの強化 - 回路図ファイルを更新 2008-10-22 ... - シリアル情報生成ツールの強化(WinAVR付属のgawkでも正常に動作) - 説明書の見直し 2008-10-23 ... - シリアル情報生成ツールの強化(数字、英大文字の利用も可能) - AVR-USBのドライバを2008-10-22版に更新 2008-10-28 ... - 安定性向上のため、HIDaspxファームの起動時に300m秒の時間待ちを挿入した - 説明書の加筆（メモリロック部分） - USB-IOモードの処理を追加した(PORTBを入力モードにする) - hidmonにて提供していたファームウエアのsmall版をこの版に含めた - 十分な安定性が確認できたので、Borland C++ でコンパイルしたものを hidspx.exeとし、MinGW-gcc でコンパイルしたものを hidspx-gcc.exe とした。 - 重複して出力されるメッセージを1度のみ、出力するようにした。 2008-10-30 ... - USB-IO と Programmerモードを区別して扱うように変更しました。 - firmware と hidspx.exe の両方を更新する必要があります。 - 回路図を修正しました(PD2とPB2の扱いを変更した為） - HIDaspxのページをPDF化し、付属資料に追加しました。 2008-10-31 ... - 付属の説明書に不整合部分を修正しました。 - firmware 中の uint8_t => ucharに統一（AVR-USBに合わせました） # TAB size = 8で編集しています。