Mailbox Client Intel® FPGA IPユーザーガイド

ID 683290
日付 4/01/2024
Public
ドキュメント目次

1.11.2.5. 関数

表 30.  librsu_init
プロトタイプ librsu_init(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 LibRSU HAL APIを初期化します。
表 31.  librsu_exit
プロトタイプ librsu_exit (void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 LibRSU HAL APIを停止し、開いている場合はMailbox Client Intel FPGA IPを閉じます。
表 32.  rsu_slot_count
プロトタイプ rsu_slot_count (void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 定義されているスロットの数を取得します。
表 33.  rsu_slot_by_name
プロトタイプ rsu_slot_by_name (char *name)
パラメーター
  • name – スロット名
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 名前に基づきスロット番号を取得します。
表 34.  rsu_slot_get_info
プロトタイプ rsu_slot_get_info (int slot, struct rsu_slot_info *info)
パラメーター
  • slot – スロット番号
  • info – スロット情報構造体へのポインター
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 スロットの属性を取得します。
表 35.  rsu_slot_size
プロトタイプ rsu_slot_size (int slot)
パラメーター
  • slot – スロット番号
戻り値 成功の場合はスロットのサイズをバイト単位で返し、それ以外の場合はエラーコードを返します 22
詳細 スロットのサイズを取得します。
表 36.  rsu_slot_priority
プロトタイプ rsu_slot_priority (int slot)
パラメーター
  • slot – スロット番号
戻り値 成功の場合はスロットの優先度を返し、それ以外の場合はエラーコードを返します 22
詳細 スロットのロード優先度を取得します。優先度が0の場合、スロットには優先度がなく、無効になっていることを意味します。優先度が1のスロットが最も高い優先度をもちます。
表 37.  rsu_slot_erase
プロトタイプ rsu_slot_erase (int slot)
パラメーター slot – スロット番号
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 スロット内のすべてのデータを消去して、プログラミングに備えます。スロットがCPB内にある場合は、それを削除します。
表 38.  rsu_slot_program_buf
プロトタイプ rsu_slot_program_buf (int slot, void *buf, int size)
パラメーター
  • slot – スロット番号
  • buf – データバッファーへのポインター
  • size – バッファーから読み出すバイト
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 バッファーからのインテルFPGAビットストリーム・データを使用してスロットをプログラミングし、最も高い優先度としてCPBにスロットを入力します。スロットは最初に消去する必要があります。
表 39.  rsu_slot_program_callback
プロトタイプ rsu_slot_program_callback(int slot, rsu_data_callback callback)
パラメーター
  • slot – スロット番号
  • callback – 入力データを提供するコールバック関数
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 この関数は、コールバック関数によって提供されるインテルFPGAコンフィグレーション・データを使用してスロットをプログラミングして検証します。スロット (パーティション) をCPBに入力します。
表 40.  rsu_slot_program_verify_buf
プロトタイプ rsu_slot_verify_buf (int slot, void *buf, int size)
パラメーター
  • slot – スロット番号
  • buf – データバッファーへのポインター
  • size – バッファーから読み出すバイト
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 スロット内のFPGAコンフィグレーション・データをバッファーに対して検証します。
表 41.  rsu_slot_verify_callback
プロトタイプ rsu_slot_verify_callback(int slot, rsu_data_callback callback)
パラメーター
  • slot – スロット番号
  • callback – 入力データを提供するコールバック関数
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 コールバック関数で提供されるインテルFPGAビットストリームを使用してスロットを検証します。
表 42.  rsu_slot_copy_to_buf
プロトタイプ rsu_slot_copy_to_buf(int slot, alt_u64 address)
パラメーター
  • slot – スロット番号
  • address - クアッドSPIでデータを格納するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 スロット内のデータを読み出し、バッファーに書き込みます。
表 43.  rsu_slot_enable
プロトタイプ rsu_slot_enable (int slot)
パラメーター
  • slot – スロット番号
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 選択しているスロットを最も高い優先度に設定します。
表 44.  rsu_slot_disable
プロトタイプ rsu_slot_disable (int slot)
パラメーター
  • slot – スロット番号
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 選択しているスロットを優先スキームから除外します。ただし、スロットデータは残ります。
表 45.  rsu_slot_load
プロトタイプ rsu_slot_load (int slot)
パラメーター
  • slot – スロット番号
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 選択しているスロットをすぐにロードするように要求します。
表 46.  rsu_slot_load_factory
プロトタイプ rsu_slot_load_factory (void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 ファクトリー・イメージをすぐにロードするように要求します。
表 47.  rsu_slot_rename
プロトタイプ rsu_slot_rename (int slot, char *name)
パラメーター
  • slot – スロット番号
  • name – スロット名
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 選択しているスロットの名前を変更します。
表 48.  rsu_slot_create
プロトタイプ rsu_slot_create (char *name, alt_u64 address, unsigned int size)
パラメーター
  • name – スロット名
  • address – スロットの開始アドレス
  • size – スロットサイズ
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 未使用のスペースを使用して、SPTに新しいスロットを作成します。
表 49.  rsu_slot_delete
プロトタイプ rsu_slot_delete (int slot)
パラメーター
  • slot – スロット番号
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 選択しているスロットをSPTから削除します。
表 50.  rsu_status_log
プロトタイプ rsu_status_log (struct rsu_status_info *info)
パラメーター
  • info – 入力を行う rsu_status_info 構造体へのポインター
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 ファームウェア・ステータス・ログを rsu_status_info 構造体にコピーします。
表 51.  rsu_clear_error_status
プロトタイプ rsu_clear_error_status (void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 現在のステータスログからエラーフィールドをクリアします。
表 52.  rsu_dcmf_version
プロトタイプ rsu_dcmf_version (alt_u32 *version)
パラメーター
  • versions – 4つのDCMFバージョンが格納されている位置へのポインター
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 フラッシュ内の4つの決定ファームウェアのそれぞれのコピーのバージョンを取得します。
表 53.  rsu_max_retry
プロトタイプ rsu_max_retry (alt_u8 *value)
パラメーター
  • value – max_retry が格納されている位置へのポインター
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 フラッシュから max_retry パラメーターを取得します。
表 54.  rsu_dcmf_status
プロトタイプ rsu_dcmf_status (int *status)
パラメーター
  • status – ステータスが格納されている位置へのポインター
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 決定ファームウェアのコピーがフラッシュ内で破損しているかを判断します。その際は、現在使用されている決定ファームウェアを基準として使用します。ステータスは4つの値の配列で、決定ファームウェアのそれぞれのコピーに1つの値が対応します。値が0の場合はコピーが正常であることを意味し、それ以外の場合はコピーが破損していることを意味します。
表 55.  rsu_create_empty_cpb
プロトタイプ rsu_create_empty_cpb (void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 CPBヘッダーのみを含む空のCPBを作成します。すべてのエントリーは未使用としてマークされます。
表 56.  rsu_restore_cpb
プロトタイプ rsu_restore_cpb (alt_u64 address)
パラメーター
  • address – バッファーのアドレスで、この位置からCPBを復元します
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 メモリー内のバッファーからCPBを復元します。バッファーには4096バイトのCPBデータと、それに続いてデータのCRC32チェックサムを含む4バイトが含まれている必要があります。
表 57.  rsu_save_cpb
プロトタイプ rsu_save_cpb (alt_u64 address)
パラメーター
  • address – CPBを格納するバッファーのアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 CPBをメモリーバッファーに格納します。合計4100バイトが書き込まれます。4096バイトのデータと、データのCRC32チェックサムを含む4バイトです。
表 58.  rsu_restore_spt
プロトタイプ rsu_restore_spt (alt_u64 address)
パラメーター
  • address – バッファーのアドレスで、この位置からSPTを復元します
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 メモリー内のバッファーからSPTを復元します。バッファーには4096バイトのSPTデータと、それに続いてデータのCRC32チェックサムを含む4バイトが含まれている必要があります。
表 59.  rsu_save_spt
プロトタイプ rsu_save_spt (alt_u64 address)
パラメーター
  • address – SPTとCRC32チェックサムを格納するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 SPTをメモリー内のアドレスに格納します。合計4100バイトが書き込まれます。4096バイトのデータと、データのCRC32チェックサムを含む4バイトです。
表 60.  rsu_running_factory
プロトタイプ rsu_running_factory (int *factory)
パラメーター
  • factory – このアドレスの値は、ファクトリー・イメージが現在実行されている場合は1、それ以外の場合は0に設定されます。
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 22
詳細 現在実行されているイメージがファクトリー・イメージかを識別します。
22 詳細は、エラーコードを参照してください。