flash - 2021.1 Japanese

Vitis 統合ソフトウェア プラットフォームの資料: アプリケーション アクセラレーション開発 (UG1393)

Document ID
UG1393
Release Date
2022-03-29
Version
2021.1 Japanese
重要: このオプションはエンベデッド プロセッサ プラットフォームでは使用できません。

flash コマンドには、次の表に示す 3 つのサブコマンドがあります。

xbmgmt flash --scan コマンドは、プラットフォーム ベースがロードされたかどうかをレポートします。シェルがロードされたかどうかを確認するには、xbmgmt partition --scan を使用する必要があります。プラットフォームのベースおよびシェルの詳細は、Alveo プラットフォーム ロードの概要を参照してください。

表 1. xbmgmt flash のサブコマンド
サブコマンド 説明
--scan FPGA で実行されているフラッシュ メモリに書き込まれているパーティションと、ホスト システムにインストールされているフラッシュ メモリに書き込み可能なパーティションを取得します。
--update ターゲット プラットフォーム (フラッシュ メモリに書き込み可能なパーティション) をカードのフラッシュ メモリに書き込みます。
--factory_reset カードを工場出荷時の状態にリセットします。

各サブコマンドの詳細は、次のとおりです。

--scan

--scan サブコマンドは、各カードのフラッシュ メモリにインストールされているパーティションと、ホスト システムにインストールされているフラッシュ メモリに書き込み可能なパーティションの詳細を返します。SC バージョン、BDF、シリアル番号、MAC アドレスなどの追加情報も返します。

コマンド ライン構文は次のとおりです。

xbmgmt flash --scan [--verbose | --json]
表 2. xbmgmt flash --scan サブコマンドのオプション
オプション 説明 必須
--verbose 追加のフィールドを含む詳細出力を返します。

--verbose--json オプションを同時に使用することはできません。

×
--json --verbose オプションで表示されるすべてのフィールドを JSON フォーマットで返します。

--verbose--json オプションを同時に使用することはできません。

×

flash --scan サブコマンドを次に示すようにオプションなしで使用すると、下の表に示すフィールドが返されます。

xbmgmt flash --scan
表 3. xbmgmt flash --scan で返されるフィールド
フィールド 説明
Card カードのバス デバイス ファンクション (BDF) を次のフォーマットで示します。

[Bus : Device : Function]

ヒント: xbmgmt コマンドは、カード管理機能を含む BDF を返します。xbutil scan コマンドは、カードのユーザー機能を含む BDF を返します。
Card type ザイリンクス カードのタイプ
Flash type カードに物理的に搭載されているフラッシュのタイプを返します。フラッシュのタイプは、次のとおりです。
  • Dual QSPI: 2 つの x4 SPI
  • SPI: 1 つの x4 SPI
  • OSPI: 1 つの x8 SPI
Flashable partition running on FPGA カードのフラッシュ メモリにインストールされているパーティションの詳細:
  • FPGA 上のターゲット プラットフォームの名前
  • プラットフォーム ビットストリームの ID
  • サテライト コントローラー (SC) のバージョン番号
重要: フラッシュ メモリに書き込まれ、FPGA で実行中のパーティションの ID は、システムにインストールされているフラッシュ メモリに書き込み可能なパーティションの ID と一致している必要があります。そうでないと、スタックが正しく機能しません。
Flashable partitions installed in system ホスト システムにインストールされているフラッシュ メモリに書き込み可能なパーティションの詳細:
  • ホスト システムにインストールされている実行中のターゲット プラットフォームの名前
  • ターゲット プラットフォームのタイムスタンプを表す ID
  • SC のバージョン番号
次に、2 つのカードが設置されたシステムの xbmgmt flash --scan 出力例を示します。
Card [0000:a6:00.0]
    Card type:          u280
    Flash type:         SPI
    Flashable partition running on FPGA:
        xilinx_u280_xdma_201920_1,[ID=0x5da8da6e],[SC=4.3.4]
    Flashable partitions installed in system:
        xilinx_u280_xdma_201920_1,[ID=0x5da8da6e],[SC=4.3.4]
 
Card [0000:73:00.0]
    Card type:          u250
    Flash type:         SPI
    Flashable partition running on FPGA:
        xilinx_u250_xdma_201830_2,[ID=0x5d14fbe6],[SC=4.3.7]
    Flashable partitions installed in system:
        xilinx_u250_xdma_201830_2,[ID=0x5d14fbe6],[SC=4.3.7]

カードを初めて設置し、フラッシュ メモリへの書き込みを実行していない場合、またはカードが工場出荷時の状態にリセットされた場合は、--factory_reset に示すように、名前に GOLDEN が含まれます。

--verbose オプションを使用すると、次の表に示すフィールドが追加で返されます。

注記: カードの情報すべてを取得するには、プラットフォームがシステムにインストールされている必要があります。
xbmgmt flash --scan --verbose
表 4. xbmgmt flash --scan --verbose で返されるフィールド
フィールド 説明
Card Name ザイリンクスのカード名
Card serial number (S/N) カードのシリアル番号
Configuration mode FPGA がコールド リセットから起動するときのコンフィギュレーション モード。次のコンフィギュレーション モードがあります。
  • Dual QSPI: 2 つの x4 SPI
  • QSPI: 1 つの x4 SPI
  • OSPI: 1 つの x8 SPI
Fan presence カードにファンがあるかどうかを示します。

A: アクティブ冷却。カード上にファンがあります。

P: パッシブ冷却。カード上にファンはなく、ホスト サーバーにより冷却する必要があります。

Max power level PCIe および接続された AUX 電源ポートから供給される使用可能なカードの最大消費電力 (ワット)。すべてのカードに AUX 電源ポートがあるわけではありません。
MAC address ザイリンクスがカードに割り当てた MAC アドレス。

ザイリンクスが割り当てた MAC アドレスを使用するか、独自のアドレスを指定できます。

アドレス FF:FF:FF:FF:FF:FF は、この MAC スロットにアドレスが割り当てられていないことを示します。

次に、1 つのカードを含むシステムの xbmgmt flash --scan --verbose 出力例を示します。

Card [0000:a6:00.0]
    Card type:          u280
    Flash type:         SPI
    Flashable partition running on FPGA:
        xilinx_u280_xdma_201920_1,[ID=0x5da8da6e],[SC=4.3.4]
    Flashable partitions installed in system:
        xilinx_u280_xdma_201920_1,[ID=0x5da8da6e],[SC=4.3.4]
    Card name                   ALVEO U280 PQ
    Card S/N:                   21760394R01L
    Config mode:                7
    Fan presence:               A
    Max power level:            225W
    MAC address0:               00:0A:35:06:00:0A
    MAC address1:               00:0A:35:06:00:0B
    MAC address2:               FF:FF:FF:FF:FF:FF
    MAC address3:               FF:FF:FF:FF:FF:FF

--json サブオプションを使用すると、xbmgmt flash --scan と同じ情報が JSON フォーマットで返されます。次に、1 つのカードを含むシステムに生成された JSON 出力の例を示します。

{
    "card0": {
        "shellpackage": "xilinx_u280_xdma_201920_1,[ID=0x5da8da6e],[SC=4.3.4]; ",
        "name": "ALVEO U280 PQ",
        "serial": "21760394R01L",
        "config_mode": "7",
        "fan_presence": "A",
        "max_power": "225W",
        "mac0": "00:0A:35:06:00:0A",
        "mac1": "00:0A:35:06:00:0B",
        "mac2": "FF:FF:FF:FF:FF:FF",
        "mac3": "FF:FF:FF:FF:FF:FF"
    }
}

--update

flash --update サブコマンドは、カードのフラッシュ メモリにインストールされているパーティション (ターゲット プラットフォーム) を変更するために使用します。指定したターゲット プラットフォームと関連のサテライト コントローラーが、カード上のコンフィギュレーション可能な ROM に書き込まれます。コマンド ライン構文は次のとおりです。

xbmgmt flash --update [--shell <target_platform_name> 
[--id <target_platform_id>]] [--card <bdf] [–force]

次の表に、使用可能なオプションを示します。

表 5. xbmgmt --update サブコマンド オプション
オプション 説明 必須
--shell <target_platform_name>

[--id]

カードのラッシュ メモリに書き込むターゲット プラットフォーム (フラッシュ メモリに書き込み可能なパーティション) の名前。ターゲット プラットフォームのインストール パッケージで指定する前に、ターゲット プラットフォームをホスト システム上にインストールしておく必要があります。ターゲット プラットフォームのダウンロード、インストール、および運用については、 Alveo™ を参照してください。ホスト システムにインストールされている使用可能なターゲット プラットフォームをリストするには、xbmgmt flash --scan を使用します。

--shell オプションと --card オプションのどちらも指定しない場合は、すべてのカードのフラッシュ メモリに互換性のあるターゲット プラットフォーム (ホスト システムに存在する場合) が書き込まれます。

たとえば、システムに U200 および U250 カードが設置されており、U200 および U250 ターゲット プラットフォームがどちらもホスト システムに存在する場合は、両方のカードのフラッシュ メモリにそれぞれのターゲット プラットフォームが書き込まれます。カードのターゲット プラットフォームがシステムに存在しない場合は、カードのフラッシュ メモリへの書き込みは実行されません。

--shell オプションを指定し、--card オプションを指定しない場合は、指定した target_platform_name と互換性のあるカードすべてのフラッシュ メモリに書き込まれます。たとえば、システムに 2 つの U200 カードが設置されている場合は、両方のカードのフラッシュ メモリに指定した target_platform_name が書き込まれます。カードのターゲット プラットフォームがシステムに存在しない場合は、カードのフラッシュ メモリへの書き込みは実行されません。

--shell オプションを指定せず、--card オプションを指定した場合は、ホスト システムに互換性のあるターゲット プラットフォームが存在していれば、指定したカードのフラッシュ メモリにそのターゲット プラットフォームが書き込まれます。

--shell および --card オプションを両方指定した場合は、指定したカードのフラッシュ メモリに指定したターゲット プラットフォーム (ホスト システムに存在する場合) が書き込まれます。

カードのフラッシュ メモリに書き込まれているパーティションとシステム上のパーティションが一致する場合は、次のようなメッセージが表示され、カードはアップデートされません。--force オプションを使用すると、カードのフラッシュ メモリに強制的に書き込むことができます。

Card [0000:65:00.0]: 
Status: shell is up-to-date 
Card(s) up-to-date and do not need to be flashed.

指定した target_platform_name がホスト システムにインストールされていない場合は、カードはアップデートされず、次のようなメッセージが表示されます。
Specified shell not found.

--id サブオプションは、ターゲット プラットフォームの ID を指定します。

フラッシュ メモリに書き込み可能なパーティションの ID を取得するには、xbmgmt flash --scan を使用します。

--id オプションを指定しない場合は、ホスト システムにある最後にリリースされたターゲット プラットフォームでカードがアップデートされます。

×
--card <bdf> アップデートするアクセラレータ カードを Bus:Device:Function (BDF) タグで指定します。カードの BDF を取得するには、xbmgmt flash --scan を使用します。

--card オプションを指定しない場合は、システムにあるすべてのアクセラレータ カードが指定した target_platform でアップデートされます。

--shell オプションと --card オプションのどちらも指定しない場合は、すべてのカードのフラッシュ メモリに互換性のあるターゲット プラットフォーム (ホスト システムに存在する場合) が書き込まれます。たとえば、システムに U200 および U250 カードが設置されており、U200 および U250 ターゲット プラットフォームがどちらもホスト システムに存在する場合は、両方のカードのフラッシュ メモリにそれぞれのターゲット プラットフォームが書き込まれます。カードのターゲット プラットフォームがシステムに存在しない場合は、カードのフラッシュ メモリへの書き込みは実行されません。

--shell オプションを指定し、--card オプションを指定しない場合は、指定した target_platform_name と互換性のあるカードすべてのフラッシュ メモリに書き込まれます。

たとえば、システムに 2 つの U200 カードが設置されている場合は、両方のカードのフラッシュ メモリに指定した target_platform_name が書き込まれます。カードのターゲット プラットフォームがシステムに存在しない場合は、カードのフラッシュ メモリへの書き込みは実行されません。

--shell オプションを指定せず、--card オプションを指定した場合は、ホスト システムに互換性のあるターゲット プラットフォームが存在していれば、指定したカードのフラッシュ メモリにそのターゲット プラットフォームが書き込まれます。

--shell および --card オプションを両方指定した場合は、指定したカードのフラッシュ メモリに指定したターゲット プラットフォーム (ホスト システムに存在する場合) が書き込まれます。

BDF がみつからない場合は、次のメッセージが表示されます (<bdf> は入力した BDF)。カードにインストールされている BDF 値のリストを取得するには、xbmgmt flash --scan を使用します。

ERROR: No mgmt PF found for <bdf>
×
--force

--force オプションは、xbmgmt flash --update コマンドからのすべてのプロンプトに y (yes) と入力するのと同じです。

たとえば、xbmgmt flash --update を使用してカードのフラッシュ メモリに書き込む際、アップデートの実行を確認する次のようなプロンプトが表示されます。

Are you sure you wish to proceed? [y/n]:

--force オプションを使用すると、これらのプロンプトにすべてに y が自動的に入力され、続行します。

×

--factory_reset

flash --factory_reset サブコマンドは、カードのフラッシュ メモリに書き込まれている FPGA で実行中のパーティションを元のゴールデン イメージに戻します。サテライト コントローラーのバージョンは変更しません。コマンド ライン構文は次のとおりです。

xbmgmt flash --factory_reset [--card <bdf>]

オプションは 1 つで、次の表に示します。

表 6. xbmgmt --factory_reset サブコマンド オプション
オプション 説明 必須
--card <bdf> 工場出荷時の状態にリセットするアクセラレータ カードを Bus:Device:Function (BDF) タグで指定します。

カードの BDF を取得するには、xbmgmt flash --scan を使用します。

--card を指定しない場合、カード ID 0 がリセットされます。カード ID は確定的なものではなく、コールド リブートまたはウォーム リブートすると変わる可能性があります。

×

xbmgmt flash --factory_reset コマンドを実行したら、カードを元のゴールデン イメージに戻すため、システムをコールド リブートする必要があります。

このコマンドを実行してコールド リブートしたら、xbmgmt flash --scan を使用して、[Flashable partition running on FPGA] が元に戻っていることを確認します。次に示すように、パーティション名に GOLDEN が含まれているはずます。

Card [0000:a6:00.0]
    Card type:          u280
    Flash type:         SPI
    Flashable partition running on FPGA:
        xilinx_u280_GOLDEN_8,[SC=4.3]
    Flashable partitions installed in system:
        xilinx_u280_xdma_201920_1,[ID=0x5da8da6e],[SC=4.3.4]