Skip to content

Latest commit

 

History

History
328 lines (231 loc) · 22.7 KB

README_jp.md

File metadata and controls

328 lines (231 loc) · 22.7 KB

UPDI4AVR-USB : OSS/OSHW Programmer for UPDI/TPI/PDI

Switching document languages : 日本語, English

  • AVR-DUファミリーを、USB接続プログラム書込器に変身させるオープンソース ソフトウェア/ファームウェア。
  • UPDI、TPI、PDIタイプの AVRシリーズの NVM(不揮発メモリ)を読み出し/消去/書き込みができる。
  • ホストPC側のプログラム書き込みアプリケーションは AVRDUDEを想定。"PICKit4" や "Curiosity Nano" のように見える。
  • VCP-UART トランスファー機能を装備。
  • 全ての成果物は、MITライセンスで頒布。

従来の USB4AVR は USBシリアル変換回路を使用する設計だが、この UPDI4AVR-USB は MCU内蔵USB周辺回路を使用する 1チップ完結設計である。

Quick Start

ビルド済バイナリを "AVR64DU32 Curiosity Nano : EV59F82A" 製品にアップロードして、手早くセットアップできる。

The pre-built binaries can be uploaded to the "AVR64DU32 Curiosity Nano : EV59F82A" product for easy setup. ->Click Here

Introduction

AVR-DUファミリーの存在は 2021年春に公表されたものの、すぐにペンディングした。それが停滞している間にAVR-Exシリーズの発売が先行し、さらに時間を経て 2024年5月にようやく AVR64DU32 第一次生産品(残念なErrata有)が発売され、残る14P/20P製品の発売は10月に確認された。

最大の特徴は AVR-Dxシリーズのファミリーとして唯一、USB 2.0 "Full-Speed" デバイス周辺機能を内蔵していることだ。これは ATxmega AU ファミリー(高価でマイナー)から受け継がれた機能で、ATmega32U4ファミリーのそれよりずっと強力なものだ。AVR-DUファミリーでは SOIC-14P と、3ミリ角の VQFN-20P の外囲器も用意され、コンパクトにも作れることから、高い可能性を秘めている。

一方であまりにも新しい製品であるため、オープンソース対応は進んでいない。公式開発環境は MPLAB-X であるが、HALに基づく大仰なビルド環境のため、とても大きなフラッシュ容量を奪われてしまう。しかもスループットが十分稼げない。戦斧で鮒を調理させたいの?

私が AVR-DUファミリーにまず求めていたことは、USB-CDC/ACM ベースで普通に OSから認識される VCPトランスファーの実現、そして USB-HID ベースで AVRDUDEから扱える UPDI/TPI プログラミング機能だ。自ずから USB複合デバイスでなければならない。一方で MPLAB-Xからの利用はライセンスの問題もあるから考えていない。だから dWire や OCD の存在は忘れることにしよう。

手掛かりになる資料は USB-IF 公開仕様書と、AVR-DUファミリーデータシートと、ATxmega AUファミリー概説だけ。これでは全くのクリーンルーム開発だ。AVR-GCC と AVR-LIBC だけを使用し、他のプロジェクトと何も関わりを持たないまま、USBプロトコルスタックをゼロから構築することから始めた。USB複合デバイスの主要な動作は 3KiB程度に凝縮して、自由に応用できるようになるまで 20日は必要だった。(もちろん DFUブートローダーも作れるが、それはまた別の計画)

次に AVRDUDE のソースコード "jtag3.c"の調査に取り組んだ。私は既に "jtagmkII.c" "serialupdi.c" の改良に貢献してきたので難易度は高くない。UPDI NVM制御の多くは UPDI4AVR シリーズをハンドメイドしたことで熟知していたし、AVR-Dx/Exシリーズ対応にも関わってきた。仮初に "Curiosity Nano"の応答を模倣するエミュレーター応用を作ったところ、USB-VID:PID を自由に変更できない問題が立ちはだかったので、"usb_hidapi.c" の強化が必要だった。加えて、わずかなコード追加だけで済むことから UPDIデバイスだけでなく、TPIデバイスも扱えるようにした。TPI4AVRをハンドメイドした経験がここで活かされた。

シナリオを作り、概ね動くようになるまで10日、手元にある 20種類以上の UPDIデバイスを片っ端から動作確認し、十分満足できる結果が得られるようになるまでさらに20日。だがそれ以上に、概説を整えなければならない退屈な時間!

そんな経緯を経てようやく"AVR64DU32 Curiosity Nano : EV59F82A"で使用できる、最初のオープンソース ブランチを公開する。HV制御のような、予定機能のいくつかはまだ実装されていないが、一般用途で試してみるには困らないはずだ。

What you can and can't do

おおむね、従来の JTAG2UPDImicroUPDI の代替となる。それらをすでに使っているのなら、すぐに使い始められるだろう。

このソフトウェアは、次のことができる:

  • AVR-DUファミリーにのみインストールできる。
  • 発売済の全ての UPDIタイプ AVRシリーズを操作できる:
    • tinyAVR-0/1/2、megaAVR-0、AVR-Dx、AVR-Ex の全ての製品
  • 発売済の全ての TPIタイプ ATtinyシリーズを操作できる:
    • ATtiny4 ATtiny5 ATtiny9 ATtiny10 ATtiny20 ATtiny40 ATtiny102 ATtiny104 (計8種類)
  • 発売済の(おそらく)全ての PDIタイプ ATxmegaシリーズを操作できる:
    • 動作確認は ATxmega128A4U のみ検証されている。
    • PDIサポートは、既定では "Curiosity Nano" 用にビルドされた場合のみ有効。(UPDI/TPI用とは別の配線を使用する)
  • Windows/macos/Linuxの OS標準ドライバーを使用するため、ドライバーの追加導入は不要。VID:PIDは EEPROMでカスタマイズできる。
    • 追加ドライバー/Infファイルが既に入っている場合、VID:PIDに一致するデバイスベンダーが表示がされる。(ライセンス侵害に注意)
  • CDC-ACM仕様に基づく、VCP(Virtual Communication Port)を混載。
  • VCP動作中は、ターゲットデバイスをリセットできる、押し下げスイッチが利用できる。
    • 押し下げている間、リセット状態が維持される。UPDI/TPIプログラム動作中は無効。
    • tinyAVRシリーズのようにハードウェアリセット端子が標準では存在しないターゲットデバイス(UPDIタイプ)でも、電源を切らずにリセットできる。
    • デバイスに書き込まれたブートローダーなどの応用コードを、強制再起動するのに便利。Arduino IDE互換。
  • ターゲットデバイスの、デバイス施錠、解錠ができる。(LOCKビットFUSE操作と、強制チップ消去)

このソフトウェア専用に設計されたハードウェア(MCUボード)を使用した場合は、以下のことができる:

  • UPDIタイプの高電圧書込サポートが 2種類。専用の追加ハードウェア回路が必要。
  • TPIタイプの高電圧書込サポートが 1種類。専用の追加ハードウェア回路が必要。

このソフトウェアは、次のことができない:

  • AVR-DUファミリー以外には、必要かつ互換性のある USB周辺機能が実装されていないため、動作しない。
    • ATxmega AU ファミリーへの移植は USB周辺機能が似ているため、おそらくは可能。(計画はない:Fork必須)
  • USB 2.0 "Full-Speed" のみ対応。AVR-DUファミリーは "High-Speed"に対応していない。(不可能)
  • ISP/PP/HVPPタイプのデバイスはサポート対象外。ハードウェア要件が異なり、GPIOに共通性がないので別のソフトウェアとなる。(Fork必須)
  • JTAG通信機能、SWD/SWO機能、dWire機能、OCD機能はサポートされない。(計画はない)
  • 14P外囲器製品(AVR16-32DU14)には余剰ピンがないため、高電圧書込サポートはできない。20P/28P/32P外囲器製品が必要。
  • 14P/20Pではピン数が不足、16KiB品種では空き容量がないため DEBUGビルド(PRINTF)は使用できない。

AVR-DUファミリーの外囲器種別毎のピン配列/信号割当の詳細については、<configuration.h>を参照。

Note

ATmega328P ファミリーのような前世代のデバイスは、通常は ISP直列プログラミング(SPI技術)で扱うが、ひとたび FUSEを破壊すると HVPP高電圧並列プログラミング(パラレル技術)を使用しなければ、工場出荷時状態に戻せない品種がある。この場合、UPDI4AVR のような「デバイスの工場出荷時状態の復元」を至上命題とするハイレベル書込器は、ISP/PP/HVPP を全て処理できる必要がある。

Practical Usage

以下は、"AVR64DU32 Curiosity Nano" のための簡単な使用例。 この製品シリーズは、付属のピンヘッダを使うとソルダーレスでブレッドボードに装着できる。

UPDI Control

UPDI制御の場合、対象デバイスに必須の配線は "VCC" "GND" "UPDI(TDAT)" の 3本だ。これに任意で "nRST(TRST)" "VCP-TxD" "VCP-RxD" の 3本を加えることができる。デバイス側が GPIOをプッシュプル出力に設定しない限り、どの接続もプルアップ抵抗内蔵オープンドレインだ。GPIO の競合を懸念するなら 330Ωの直列抵抗を挿入しても良い。

電気特性は 5V/225kbpsが基準で、VCCx0.2〜0.8範囲のスリューレートに注意されたい。

AVR-ICSP MIL/6Pコネクタに変換するには、以下の信号配列を推奨。これは TPI制御や、2種類のHV制御方式と互換性がある。(ただし専用回路がなければ HV制御はできない)

仮に、AVR64DU28を対象デバイスとした場合、最低限の接続テストは以下のコマンドラインで可能だ。

avrdude -Pusb:04d8:0b15 -cjtag3updi -pavr64du28 -v -Usib:r:-:r

Tip

AVRDUDE>=8.0では-Pusb:vid:pid構文が使用できるが、それ以前はそうではない。 AVRDUDE<=7.3で使用するには、EEPROMに-c指定が要求する VID:PID を記憶させておく必要がある。

Avrdude version 8.0-20241010 (0b92721a)
Copyright see https://github.com/avrdudes/avrdude/blob/main/AUTHORS

System wide configuration file is /usr/local/etc/avrdude.conf
User configuration file is /Users/user/.avrduderc

Using port            : usb:04d8:0b15
Using programmer      : jtag3updi
AVR part              : AVR64DU28
Programming modes     : SPM, UPDI
Programmer type       : JTAGICE3_UPDI
Description           : Atmel AVR JTAGICE3 in UPDI mode
ICE HW version        : 0
ICE FW version        : 1.33 (rel. 46)
Serial number         : **********
Vtarget               : 5.02 V
PDI/UPDI clk          : 225 kHz

Partial Family_ID returned: "AVR "
Silicon revision: 1.3

AVR device initialized and ready to accept instructions
Device signature = 1E 96 22 (AVR64DU28)
Reading sib memory ...
Writing 32 bytes to output file <stdout>
AVR     P:4D:1-3M2 (A3.KV00S.0)
avrdude done.  Thank you.

TPI Control

TPI制御の場合、対象デバイスに必須の配線は "VCC" "GND" "TDAT" "TCLK" "TRST" の 5本だ。結果的に、6Pデバイスである ATtiny4/5/9/10 の場合、未使用のピンは1本しか残らない。全ての接続は、プルアップ抵抗内蔵オープンドレインだ。(約35kΩ)

なお VCC には 4.5V 以上を供給しなければ NVM書き換えは行うことができない。メモリ内容を読み出すだけなら 3.3V でも構わない。

仮に、ATiny10を対象デバイスとした場合、最低限の接続テストは以下のコマンドラインで可能だ。

avrdude -Pusb:04d8:0b15 -catmelice_tpi -v -pt10 -Uflash:r:-:I
Avrdude version 8.0-20241010 (0b92721a)
Copyright see https://github.com/avrdudes/avrdude/blob/main/AUTHORS

System wide configuration file is /usr/local/etc/avrdude.conf
User configuration file is /Users/user/.avrduderc

Using port            : usb:04d8:0b15
Using programmer      : atmelice_tpi
AVR part              : ATtiny10
Programming modes     : TPI
Programmer type       : JTAGICE3_TPI
Description           : Atmel-ICE in TPI mode
ICE HW version        : 0
ICE FW version        : 1.33 (rel. 46)
Serial number         : **********
Vtarget               : 5.02 V


AVR device initialized and ready to accept instructions
Device signature = 1E 90 03 (ATtiny10)
Reading flash memory ...
Reading | ################################################## | 100% 0.26 s
Writing 86 bytes to output file <stdout>
:200000000AC011C010C00FC00EC00DC00CC00BC00AC009C008C011271FBFCFE5D0E0DEBF02 // 00000> .@.@.@.@.@.@.@.@.@.@.@.'.?OeP`^? flash
:20002000CDBF02D016C0ECCF48ED50E04CBF56BF4FEF47BB7894619A0A9ABA98029A4FEF35 // 00020> M?.P.@lOHmP`L?V?OoG;x.a...:...Oo
:1600400059E668E1415050406040E1F700C00000F5CFF894FFCFAB                     // 00040> YfhaAPP@`@[email protected]
:00000001FF

Avrdude done.  Thank you.

この例では PB2端子用の Lチカ スケッチバイナリが読み出されている。
ATtiny102とATtiny104の UARTを6Pコネクタに引き出して VCPと接続したい場合は工夫が必要。PA0/TCLKとPB3/RXDは短絡し、かつPA0は原則としてGPIO未使用としなければならない。

PDI control

主に ATxmegaシリーズで使われる PDI制御は、UPDIや TPIとは異なる特別な配慮が必要だ。

  • PDI対応デバイスは全て絶対定格が 3.5V以下である。従って VTG/VCC を含むすべての信号線は 3.3V基準 でなければならない。
  • PDI_DATA線は単線通信であるものの、push-pull方式で制御する必要がある。PoR既定では 22kΩ の内蔵プルダウン抵抗が存在するため、PDIアクティベート操作はまずこれに打ち勝つ電流を流す必要がある。これは UPDI/TPIのようなオープンドレイン回路では実現できない。
  • PDI_CLK線はハードリセット信号も兼ねており、かつ高速化のためには push-pull方式で制御する必要がある。

"AVR64DU32 Curiosity Nano"を使用する場合、まず デバッガーファームウェアを MPLAB-X を使用して最新版に更新 しなければならない。少なくとも1.31 (rel. 39)以降であれば、-xvtarg=<dbl>オプションを使用して、PF4端子の隣にある VTG/VCC 端子出力の電圧を 5.03.31.8 から選択して恒久的に変更することができる。

avrdude -cpkobn_updi -pavr64du32 -xvtarg=3.3
Changing target voltage from 5.00 to 3.30V

Avrdude done.  Thank you.

この操作は、ターゲットデバイスと配線する前に行わなければならない。さらに、一度電源を切っても正しく状態が保存されていることを確認しなければならない。古いファームウェアではこの設定を恒久的には記憶されないためだ。

Changing target voltage from 3.30 to 3.30V
                             ^^^^

以上の設定が正しく完了したなら、PDIターゲットデバイスとは次の配線を 安全に 接続することができる。少なくとも "VCC" "GND" "PDAT" "PCLK" の 4本が必要だ。これに任意で "VCP-TxD" "VCP-RxD" の 2本を加えることができる。

avrdude -Pusb:04d8:0b15 -cjtag3pdi -px128a4u -v -Uprodsig:r:-:I
Avrdude version 8.0-20241010 (0b92721a)
Copyright see https://github.com/avrdudes/avrdude/blob/main/AUTHORS

System wide configuration file is /usr/local/etc/avrdude.conf
User configuration file is /Users/user/.avrduderc

Using port            : usb:04d8:0b15
Using programmer      : jtag3pdi
AVR part              : ATxmega128A4U
Programming modes     : SPM, PDI
Programmer type       : JTAGICE3_PDI
Description           : Atmel AVR JTAGICE3 in PDI mode
ICE HW version        : 0
ICE FW version        : 1.33 (rel. 46)
Serial number         : **********
Vtarget               : 3.30 V
PDI/UPDI clk          : 2500 kHz

Silicon revision: 0.0

AVR device initialized and ready to accept instructions
Device signature = 1E 97 46 (ATxmega128A4, ATxmega128A4U)
Reading prodsig/sigrow memory ...
Reading | ################################################## | 100% 0.01 s
Writing 64 bytes to output file <stdout>
:200000000D40740B403FFFFD334132363233FFFF11FF0E0003004933FFFFCF072440FFFF87 // 00000> .@t.@?.}3A2623........I3..O.$@.. prodsig
:20002000440400FF0000FFFFFFFFFFFFFFFF4B09FFFF8301FFFF0409FFFFFFFFFFFFFFFFA8 // 00020> D.............K.................
:00000001FF

Avrdude done.  Thank you.

Tip

TPIデバイスへ NVMを書き込むには、VTG電圧を 5.0V に再設定する必要がある。 UPDIデバイスは 5.0V でも 3.3V でも問題なく動作するが、品種によっては 3.3V だと NVM書換可能寿命が大幅に低下する重大なエラッタが存在するため、注意が必要。

Note

PDIサポートを有効にすると、UPDI4AVR-USB ソフトウェアサイズは 14KiBを超える。従って AVR16DUxx では USBブートローダー(euboot 2.5KiB)との共存はできない。 このため確実にメモリ容量に余裕がある、"AVR64DU32 Curiosity Nano" 向けのビルドでのみ、PDIサポートが有効になっている。 実際問題として PDI制御が必要なユーザーは限定されるため、他に流用の効かない専用ハードウェアを用意するよりは "CNANO" を随時活用した方が有意義だろう。

LED blinking

オレンジLEDは、状況によって幾つかの表情を見せる。

  • ハートビート - あるいは深呼吸。USB接続が ホストOSと確立されている。使用準備完了。
  • 短い閃光 - USB接続待機中。ホストOSから認識されていない。
  • 長い明滅 - SW0が押し下げられている。プログラミング中ではない。対象デバイスは(可能なら)リセット中。
  • 短い明滅 - プログラミング実行中。VCP通信は無効。

追加の LEDを備えることで、VCP通信アクティビティを表示することも可能。

Other pinouts

ピン配列/信号割当の詳細については、<configuration.h>を参照されたい。

High-Voltage control

対応中。専用の制御回路を外付けする必要がある。技術的にはすでに前作の UPDI4AVR (USBシリアル通信版) で実現していることだ。

現在、2種の試作が進行している。

  • FRISK(キャンディ)ケースサイズのオールインワンモデル。UPDI4AVR-USB の標準設計。
  • "AVR64DU32 Curiosity Nano" をドーターボードとして装着する専用拡張ボードモデル。

HV制御を有効にするには、2種の方法がある。

  • -cpickit4_updiを選択し、-xhvupdiオプションを追加する。この-cプログラマー選択でのみ可能な方法。
  • SW1(あるいはSW0)を押しながら、AVRDUDEコマンドを実行する。-c選択は任意。TPIデバイスはこの方法でのみ、HV制御モードを有効にできる。
    • 本ソフトウェア専用に -xhvtpi を有効にするパッチを AVRDUDEに適用する方法もあるが、一般的手段とは言えない。(工業生産現場向け)

Tip

PDIデバイスには、HV制御が必要な製品は存在しない。

Build and installation

Arduino IDEに、次のリンク先の SDK を導入すると、ベアメタルチップを含めた AVR-DUファミリー全てへのビルドとインストールが簡単にできる。

ビルドオプションについては、<UPDI4AVR-USB.ino>を参照されたい。

Related link and documentation

Copyright and Contact

Twitter(X): @askn37
BlueSky Social: @multix.jp
GitHub: https://github.com/askn37/
Product: https://askn37.github.io/

Copyright (c) askn (K.Sato) multix.jp
Released under the MIT license
https://opensource.org/licenses/mit-license.php
https://www.oshwa.org/