AN-1160: Cortex-M3 ベースの ADuCxxx のシリアル・ダウンロード・プロトコル (Rev. A) PDF

日本語参考資料
最新版英語アプリケーション・ノートはこちら
AN-1160
アプリケーション・ノート
Cortex-M3 ベースの ADuCxxx の
シリアル・ダウンロード・プロトコル
はじめに
Cortex-M3 ベースの ADuCxxx の重要な機能は、内蔵のフラッシ
ュ/EE プログラム・メモリへイン・サーキットでコードをダウ
ンロードする機能です。イン・サーキットでのコードのダウン
ロードは、デバイスの UART シリアル・ポートを使用して行わ
れるため、一般にシリアル・ダウンロードと呼ばれています。
シリアル・ダウンロード機能を使うと、ターゲット・システム
に部品を直接ハンダ付けした状態で再書込みできるため、外付
けのデバイス・プログラマが不要になります。また、シリア
ル・ダウンロード機能を使うと、現場でのシステム・アップグ
レードも可能になります。必要なことは、Cortex-M3 ベースの
ADuCxxx へシリアル・ポート・アクセスすることだけです。つ
まり、デバイスを交換しなくても、現場でシステム・ファーム
ウェアをアップグレードできるということです。
Cortex-M3 ベースの ADuCxxx デバイスはすべて、パワーオン時
またはリセット時または特定のリセット時に特定のピン設定を
使って、シリアル・ダウンロード・モードに設定することがで
きます。
シリアル・ダウンロード・モードの開始条件については、デバ
イスごとのユーザー・ガイドを参照してください。例えば、
ADuCM360 は、カーネル実行時に P2.2 入力ピンがチェックされ
ます。パワーアップ後または何らかのリセット後にこのピンが
ロー・レベルである場合、デバイスはシリアル・ダウンロー
ド・モードになります。
このモードでは、内蔵の常駐ローダ・ルーチンが起動されます。
内蔵ローダは、デバイスの UART を設定した後、特定のシリア
ル・ダウンロード・プロトコルを使ってホスト・マシンと通信
して、フラッシュ/EE メモリ・スペースへデータをダウンロー
ドします。ダウンロードするプログラム・データのフォーマッ
トは、リトル・エンディアンである必要があります。
シリアル・ダウンロード・モードは、デバイスの標準電源定格
で動作します。プログラミング用の高電圧は、チップ内で発生
するため不要です。
開発ツールの一部として、アナログ・デバイセズは Windows®
プログラム(CM3WSD.exe)を提供しています。このプログラ
ムを使うと、COM1 ~ COM31 の PC シリアル・ポートから
Cortex-M3 ベースの ADuCxxx デバイスへコードをダウンロード
することができます。ただし、このアプリケーション・ノート
で説明するシリアル・ダウンロード・プロトコルにホスト・マ
シンが準拠する限り、任意のマスター・ホスト・マシン(PC、
マイクロコントローラ、または DSP)から Cortex-M3 ベースの
ADuCxxx デバイスへダウンロードできることに注意してくださ
い。
こ の ア プ リ ケ ー シ ョ ン ・ ノ ー ト で は 、 Cortex-M3 ベ ー ス の
ADuCxxx シリアル・ダウンロード・プロトコルについて説明し、
エンド・ユーザーがこのプロトコル(組込み型ホストと CortexM3 ベースの組込み型 ADuCxxx デバイスとの間のプロトコル)
を理解し、エンド・ターゲット・システムに実装できるように
します。
紛らわしさを避けるため、用語「ホスト」は、データを CortexM3 ベースの ADuCxxx デバイスへダウンロードするホスト・マ
シン(PC、マイクロコントローラ、または DSP)を意味するも
の と 定 義 し ま す 。 用 語 「 ロ ー ダ 」 は 、 Cortex-M3 ベ ー ス の
ADuCxxx デバイス内蔵のシリアル・ダウンロード・ファームウ
ェアを意味するものと定義します。
アナログ・デバイセズ社は、提供する情報が正確で信頼できるものであることを期していますが、その情報の利用に関して、あるいは利用によって
生じる第三者の特許やその他の権利の侵害に関して一切の責任を負いません。また、アナログ・デバイセズ社の特許または特許の権利の使用を明示
的または暗示的に許諾するものでもありません。仕様は、予告なく変更される場合があります。本紙記載の商標および登録商標は、それぞれの所有
者の財産です。※日本語版資料は REVISION が古い場合があります。最新の内容については、英語版をご参照ください。
Rev. A
©2015 Analog Devices, Inc. All rights reserved.
本
社/〒105-6891 東京都港区海岸 1-16-1 ニューピア竹芝サウスタワービル
電話 03(5402)8200
大阪営業所/〒532-0003 大阪府大阪市淀川区宮原 3-5-36 新大阪トラストタワー
電話 06(6350)6868
AN-1160
アプリケーション・ノート
目次
はじめに ............................................................................................. 1
データ・トランスポート・パケット・フォーマットの定義 ......... 3
改訂履歴 ............................................................................................. 2
コマンド ............................................................................................. 4
MicroConverter ローダの実行 ........................................................... 3
コマンド例 ......................................................................................... 5
物理インターフェース ..................................................................... 3
LFSR コード例................................................................................... 6
改訂履歴
1/13—Rev. 0 to Rev. A
Changes to Introduction..................................................................... 1
9/12—Revision 0: Initial Version
Rev. A
- 2/7 -
AN-1160
アプリケーション・ノート
有効なデータ・パケットの開始を検出する際にローダが使いま
す。
MicroConverter ローダの実行
抵抗(代表値 1 kΩ)を介して特定の GPIO ピンをロー・レベルに
プルダウンし、さらにデバイス自体の RESET 入力ピンをトグル
してリセットすると、ADuCxxx デバイス上のローダが起動され
ます。()特定の GPIO がロー・レベルへプルダウンされた状態
では、ウォッチドッグ・リセット、パワーオン・リセット、ソフ
トウェア・リセットなどのリセットを行っても、シリアル・ダウ
ンロード・モードは開始されません。シリアル・ダウンロード・
モードの開始条件については、デバイスのユーザー・ガイドを
参照してください。
バイト数フィールド
次のフィールドは、合計バイト数フィールドです。最小バイト
数は 5 で、これはコマンド・フィールドと値フィールドに該当
します。最大許容バイト数は 255 で、これはコマンド機能、4
バイト値、250 バイトのデータです。
コマンド・フィールド(データ 1)
コマンド・フィールドは、データ・パケットの機能を指定しま
す。4 種類の有効コマンド機能を指定することができます。4 種
類のコマンド機能は、4 文字の ASCII 文字(E、W、V、または
R)の内の 1 文字で指定されます。データ・パケット・コマン
ド機能の一覧を表 2 に示します。
例えば、ADuCM360 では、カーネル実行時に P2.2 入力ピンがチ
ェックされます。このピンがロー・レベルで、かつ
RSTSTA.EXTRST = 0x1 の場合、P2.2 入力ピンがチェックされて、
デバイスはシリアル・ダウンロード・モードになります。
値フィールド(データ 2 ~ データ 5)
物理インターフェース
値フィールドは、ビッグ・エンディアン・フォーマットの 32 ビ
ット値です。
ローダは起動されると、ホストから同期用のバック・スペース
(BS = 0x08)文字が送信されてくるのを待ちます。ローダはこ
の文字のタイミングを計測して、その結果を使って、ADuCxxx
の UART シリアル・ポートを、送信または受信、ホストと同じ
ボー・レート、8 データビット、パリティなしに設定します。
ボー・レートは、600 bps ~ 115,200 bps の範囲である必要があ
ります。
データ・バイト・フィールド(データ 6 ~ データ 255)
データ・バイト・フィールドは、最大 250 バイトのデータです。
チェックサム・フィールド
データ・パケットのチェックサムがこのフィールドに書込まれ
ます。バイト数フィールドの 16 進値と、データ 1 ~ データ 255
(存在する値だけ)のフィールドの 16 進値の和から、2 の補数
チェックサムが計算されます。チェックサムは、この和の 2 の
補数値です。したがって、データ・バイト数からチェックサム
までのすべてのバイトの和の LSB は 0x00 になるはずです。こ
れは、数学的に次のように表されます。
ローダはバック・スペースを受信すると直ちに、次に示す 24 バ
イト ID データ・パケットを送信します。
15 バイト=製品識別マーク
3 バイト=ハードウェアとファームウェアのバージョン番号
4 バイト=予約済み
2 バイト=ライン・フィードとキャリッジ・リターン
255
CS = 0x00 − (バイト数 +
ADuCxxx<space><space><space>128<space>A3Y<space><space><space><space><\n><\r>
128 CORRESPONDS
TO THE MEMORY
SIZE MODEL
A3Y MEAN A SILICON REV. A AND
A VERSION 3 LOADER. Y IS THE
LOADER’S VERSION REVISION
データ・バイト N)
別の表現をすれば、開始 ID を除くすべてのバイトの 8 ビット和
が 0x00 になるということです。
10885-001
ADuCxxx IS THE
PRODUCT ID
∑
N −1
図 1. ID データ・パケットの例
コマンドのアクノリッジ
ローダ・ルーチンは、BEL (0x07)を否定応答として、または
ACK (0x06)を肯定応答として、各データ・パケットに対して
発行します。
データ・トランスポート・パケット・フォーマッ
トの定義
不正なチェックサムまたは無効なアドレスをローダが受信した
とき、ローダは BEL を送信します。古いデータ(まだ消去され
ていないデータ)にダウンロード・データが上書きされる場合
でも、ローダは警告を発しません。()コードがダウンロード
されるすべてのロケーションが消去されることに PC インター
フェース側は注意する必要があります。
UART の設定が終わると、データ転送を開始できます。一般的
な通信データ・トランスポート・パケット・フォーマットを表
1に示します。
パケット開始 ID フィールド
最初のフィールドはパケット開始 ID フィールドで、2 個の開始
文字(0x07 と 0x0E)が含まれます。これらのバイトは固定で、
表 1.データ・トランスポート・パケットのフォーマット
Start ID
No. of Bytes
ID0
ID1
0x07
0x0E
Rev. A
0x05 to 0xFF
Command
Value
Data 1
Data 2
E, W, V, or R
MSB
Data 3
- 3/7 -
Data 4
Data Bytes
Checksum
Data 5
Data [x]
CS
LSB
0x00 to 0xFF
0x00 to 0xFF
AN-1160
アプリケーション・ノート
ページを確認するときは、次の 2 ステップのシーケンスに従う
必要があります。確認対象の各ページに対して次の 2 ステッ
プ・シーケンスを繰り返します。
1. 値 0x80000000 を値フィールドへ、ページの最後の 4 バイト
をデータ・バイト・フィールドへ、それぞれ送信します。
2. 開始ページ・アドレスを値フィールドへ、ページの SIGN
コマンドの結果をデータ・バイト・フィールドへ、それぞ
れ送信します。
コマンド
内蔵ローダの全コマンドのリストを表 2 に示します。
消去コマンド
消去コマンドを使うと、ユーザーは値フィールドで指定される
特定の開始ページのフラッシュ/EE を消去することができます。
このコマンドには消去するページ数も含まれます。
アドレスが 0x00000000 で、かつページ数が 0x00 の場合、ロー
ダはこのコマンドをマス消去コマンドと解釈して、ユーザー・
コード・スペース全体を消去します。
ローダはこれらの 2 つのパケットを受信した後、特定のページ
の LFSR を計算して、入力された値と比較します。比較結果が
正しく、かつそのページのアドレス 0x1FC の値がステップ 1 で
指定された値に一致する場合、ACK (0x06)が返されます。そ
の他の場合には、BEL (0x07)が返されます。
消去コマンドのデータ・パケットを表 3 に示します。
書込みコマンド
リモート・リセット・コマンド
書込みコマンドには、データ・バイト数(5 + x)、コマンド、
書込む先頭データ・バイトのアドレス、書込むデータ・バイト
が含まれます。バイトは、到着したときにフラッシュ/EE に書
込まれます。チェックサムが不正な場合、または受信したアド
レスが範囲外の場合、ローダは BEL を送信します。ホストがロ
ーダから BEL を受信すると、ダウンロード・プロセスが停止さ
れて、ダウンロード・シーケンス全体が再起動されます。
ホストは、すべてのデータ・パケットをローダへ送信した後、
ローダにリセットを実行させる最後のパケットを送信すること
ができます。ソフトウェア・セルフ・リセットが組み込まれて
います。値フィールドは常に 0x1 です。
ホストは、シリアル・プログラミングの開始に使用する特定の
GPIO ピンをこのコマンドの発行前にアサートしないようにす
る必要があります。デバイスがリセットされると、カーネルは
通常の動作を再開します。ローダ開始チェックがもう一度行わ
れるため、このとき特定の GPIO ピンのアサートを解除してお
く必要があります(カーネルは RSTSTA を変更しませんので、
外部リセットをチェックすれば、外部リセットが行われたかど
うかが検出されます)。表 7 に、リモート・リセットの例を示
します。
検証コマンド
ローダはページの内容を確認するために、ページの最後の 4 バ
イトの値と、最後の 4 バイトを除くページの 24 ビット LFSR の
2 つの情報を必要とします(LFSR コード例のセクションを参
照)。
表 2.データ・パケット・コマンドの機能
Command Functions
Command Byte in Data 1 Field
Loader Positive Acknowledge
Loader Negative Acknowledge
Erase Page
E (0x45)
ACK (0x06)
BEL (0x07)
Write
W (0x57)
ACK (0x06)
BEL (0x07)
Verify
V (0x56)
ACK (0x06)
BEL (0x07)
Remote Reset
R (0x52)
ACK (0x06)
BEL (0x07)
表 3.フラッシュ/EE メモリ消去コマンド
Start ID
ID0
ID1
0x07
0x0E
No. of Bytes
0x06
No. of Pages
Checksum
Data 1
Command
Data 2
Data 3
Value
Data 4
Data 5
Data 6
CS
E (0x45)
0x00
ADR[23:16]
ADR[15:8]
ADR[7:0]
0x01 to 0xFF
0x00 to 0xFF
Data Bytes
Checksum
Data 1
Data 2
Data 3
Data 4
Data 5
Data [x]
CS
W (0x57)
0x00
ADR[23:16]
ADR[15:8]
ADR[7:0]
0x00 to 0xFF
0x00 to 0xFF
表 4.フラッシュ/EE メモリ書込みコマンド
Start ID
ID0
ID1
0x07
0x0E
Rev. A
No. of Bytes
5 + x (0x06 to
0xFF)
Command
Value
- 4/7 -
AN-1160
アプリケーション・ノート
表 5.フラッシュ/EE メモリ検証コマンド、ステップ 1
Start ID
ID0
ID1
0x07 0x0E
No. of
Bytes
Command
Data 1
0x09
V (0x56)
Value
Data 2
0x80
Data 3
0x00
Data Bytes
Data 4
0x00
Data 5
0x00
Data 6
Data at
0x1FC
Data 7
Data at
0x1FD
Data 8
Data at
0x1FE
Data 5
ADR[7:0
]
Data 6
LFSR[0:
7]
Data 7
Data 8
LFSR[15:8 LFSR
]
[23:16]
Checksum
Data 9
Data at
0x1FF
CS
0x00 to
0xFF
表 6.フラッシュ/EE メモリ検証コマンド、ステップ 2
Start ID
ID0
0x07
ID1
0x0E
No. of
Bytes
Command
Data 1
0x09
V (0x56)
Value
Data 2
0x00
Data 3
ADR[2
3:16]
Data Bytes
Data 4
ADR[15
:8]
表 7.リモート・リセット・コマンド
Start ID
ID0
ID1
0x07 0x0E
No. of
Bytes
0x05
Command
Data 1
R (0x52)
Data 2
0x00
Data 3
0x00
Value
Data 4
0x00
Data 5
0x01
コマンド例
ポート・アナライザを使って取得したデータの例を次に示します。
消去コマンド
0x00000200 の 1 ページ消去、
IRP_MJ_WRITE Length 10: 07 0E 06 45 00 00 02 00 01 B2
IRP_MJ_READ Length 1 : 06
ユーザー・スペース全体のマス消去、
IRP_MJ_WRITE Length 10: 07 0E 06 45 00 00 00 00 00 B5
IRP_MJ_READ Length 1: 06
書込みコマンド
0x00000200 から開始の 16 データ・バイトの書込み、
IRP_MJ_WRITE Length 25: 07 0E 15 57 00 00 02 00 77 FF 2C B1 00 20 00 F0 5A FC 08 B1 01 20 00 E0 1F
IRP_MJ_READ Length 1 : 06
検証コマンド
次の検証コマンドに対する 0x1FC の値を 0x11223344 に指定、
IRP_MJ_WRITE Length 13: 07 0E 09 56 80 00 00 00 44 33 22 11 77
IRP_MJ_READ Length 1 : 06
0x00000200 のページ検証、LFSR を 0x00841B81 に指定、最終値が 0x11223344 であることをチェック、
IRP_MJ_WRITE Length 13: 07 0E 09 56 00 00 02 00 81 1B 84 00 7F
IRP_MJ_READ Length 1 : 06
リモート・リセット・コマンド
IRP_MJ_WRITE Length 9: 07 0E 05 52 00 00 00 01 A8
IRP_MJ_READ Length 1: 06
Rev. A
- 5/7 -
Checksum
CS
0xA8
Checksum
Data 9
0x00
CS
0x00 to
0xFF
AN-1160
アプリケーション・ノート
LFSR コード例
シグネチャは、多項式 x 24 + x 23 + x 6 + x 5 + x + 1 を使用する 24 ビット CRC。初期値は 0xFFFFFF。
long int GenerateChecksumCRC24_D32(unsigned long ulNumValues,unsigned long *pulData)
{
unsigned long i,ulData,lfsr = 0xFFFFFF;
for (i= 0x0; i < ulNumValues;i++)
{
ulData = pulData[i];
lfsr = CRC24_D32(lfsr,ulData);
}
return lfsr;
}
static unsigned long CRC24_D32(const unsigned long old_CRC, const unsigned long Data)
{
unsigned long D
[32];
unsigned long C
[24];
unsigned long NewCRC [24];
unsigned long ulCRC24_D32;
unsigned long int f, tmp;
unsigned long int bit_mask = 0x000001;
tmp = 0x000000;
// Convert previous CRC value to binary.
bit_mask = 0x000001;
for (f = 0; f <= 23; f++)
{
C[f]
= (old_CRC & bit_mask) >> f;
bit_mask
= bit_mask << 1;
}
// Convert data to binary.
bit_mask = 0x000001;
for (f = 0; f <= 31; f++)
{
D[f]
= (Data & bit_mask) >> f;
bit_mask
= bit_mask << 1;
}
// Calculate new LFSR value.
NewCRC[0] = D[31] ^ D[30] ^ D[29] ^ D[28] ^ D[27] ^ D[26] ^ D[25] ^
D[24] ^ D[23] ^ D[17] ^ D[16] ^ D[15] ^ D[14] ^ D[13] ^
D[12] ^ D[11] ^ D[10] ^ D[9] ^ D[8] ^ D[7] ^ D[6] ^
D[5] ^ D[4] ^ D[3] ^ D[2] ^ D[1] ^ D[0] ^ C[0] ^ C[1] ^
C[2] ^ C[3] ^ C[4] ^ C[5] ^ C[6] ^ C[7] ^ C[8] ^ C[9] ^
C[15] ^ C[16] ^ C[17] ^ C[18] ^ C[19] ^ C[20] ^ C[21] ^
C[22] ^ C[23];
NewCRC[1] = D[23] ^ D[18] ^ D[0] ^ C[10] ^ C[15];
NewCRC[2] = D[24] ^ D[19] ^ D[1] ^ C[11] ^ C[16];
NewCRC[3] = D[25] ^ D[20] ^ D[2] ^ C[12] ^ C[17];
NewCRC[4] = D[26] ^ D[21] ^ D[3] ^ C[13] ^ C[18];
NewCRC[5] = D[31] ^ D[30] ^ D[29] ^ D[28] ^ D[26] ^ D[25] ^ D[24] ^
D[23] ^ D[22] ^ D[17] ^ D[16] ^ D[15] ^ D[14] ^ D[13] ^
D[12] ^ D[11] ^ D[10] ^ D[9] ^ D[8] ^ D[7] ^ D[6] ^
D[5] ^ D[3] ^ D[2] ^ D[1] ^ D[0] ^ C[0] ^ C[1] ^ C[2] ^
C[3] ^ C[4] ^ C[5] ^ C[6] ^ C[7] ^ C[8] ^ C[9] ^ C[14] ^
C[15] ^ C[16] ^ C[17] ^ C[18] ^ C[20] ^ C[21] ^ C[22] ^
C[23];
NewCRC[6] = D[28] ^ D[18] ^ D[5] ^ D[0] ^ C[10] ^ C[20];
NewCRC[7] = D[29] ^ D[19] ^ D[6] ^ D[1] ^ C[11] ^ C[21];
NewCRC[8] = D[30] ^ D[20] ^ D[7] ^ D[2] ^ C[12] ^ C[22];
NewCRC[9] = D[31] ^ D[21] ^ D[8] ^ D[3] ^ C[0] ^ C[13] ^ C[23];
NewCRC[10] = D[22] ^ D[9] ^ D[4] ^ C[1] ^ C[14];
NewCRC[11] = D[23] ^ D[10] ^ D[5] ^ C[2] ^ C[15];
NewCRC[12] = D[24] ^ D[11] ^ D[6] ^ C[3] ^ C[16];
NewCRC[13] = D[25] ^ D[12] ^ D[7] ^ C[4] ^ C[17];
NewCRC[14] = D[26] ^ D[13] ^ D[8] ^ C[0] ^ C[5] ^ C[18];
NewCRC[15] = D[27] ^ D[14] ^ D[9] ^ C[1] ^ C[6] ^ C[19];
NewCRC[16] = D[28] ^ D[15] ^ D[10] ^ C[2] ^ C[7] ^ C[20];
NewCRC[17] = D[29] ^ D[16] ^ D[11] ^ C[3] ^ C[8] ^ C[21];
NewCRC[18] = D[30] ^ D[17] ^ D[12] ^ C[4] ^ C[9] ^ C[22];
Rev. A
- 6/7 -
AN-1160
アプリケーション・ノート
NewCRC[19]
NewCRC[20]
NewCRC[21]
NewCRC[22]
NewCRC[23]
=
=
=
=
=
D[31] ^ D[18] ^ D[13] ^ C[5] ^ C[10] ^ C[23];
D[19] ^ D[14] ^ C[6] ^ C[11];
D[20] ^ D[15] ^ C[7] ^ C[12];
D[21] ^ D[16] ^ C[8] ^ C[13];
D[31] ^ D[30] ^ D[29] ^ D[28] ^ D[27] ^ D[26] ^ D[25] ^
D[24] ^ D[23] ^ D[22] ^ D[16] ^ D[15] ^ D[14] ^ D[13] ^
D[12] ^ D[11] ^ D[10] ^ D[9] ^ D[8] ^ D[7] ^ D[6] ^
D[5] ^ D[4] ^ D[3] ^ D[2] ^ D[1] ^ D[0] ^ C[0] ^ C[1] ^
C[2] ^ C[3] ^ C[4] ^ C[5] ^ C[6] ^ C[7] ^ C[8] ^ C[14] ^
C[15] ^ C[16] ^ C[17] ^ C[18] ^ C[19] ^ C[20] ^ C[21] ^
C[22] ^ C[23];
ulCRC24_D32 = 0;
// LFSR value from binary to hex.
bit_mask = 0x000001;
for (f = 0; f <= 23; f++)
{
ulCRC24_D32 = ulCRC24_D32 + NewCRC[f] * bit_mask;
bit_mask = bit_mask << 1;
}
return(ulCRC24_D32 & 0x00FFFFFF);
}
©2015 Analog Devices, Inc. All rights reserved.
Rev. A
商標および登録商標は、それぞれの所有者の財産です。
- 7/7 -