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

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

1.11.2.6. RSUクライアントAPI

表 61.  rsu_client_get_slot_count
プロトタイプ rsu_client_get_slot_count(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 定義済みスロットの数を取得し、スロットの数を表示します。
表 62.  rsu_client_get_slot_by_name
プロトタイプ rsu_client_get_slot_by_name (char *name)
パラメーター
  • name - スロット名
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 23
詳細 名前に基づきスロット番号を取得し、表示します。
表 63.  rsu_client_list_slot_attribute
プロトタイプ rsu_client_list_slot_attribute(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットの属性情報を一覧表示します。属性は、イメージ名、オフセット、サイズ、優先度です。
表 64.  rsu_client_get_slot_size
プロトタイプ rsu_client_get_slot_size(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットのサイズを取得し、スロットサイズをバイト単位で表示します。
表 65.  rsu_client_get_priority
プロトタイプ rsu_client_get_priority(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットの優先度を取得し、選択しているスロットの優先度を表示します。
表 66.  rsu_client_slot_enable
プロトタイプ rsu_client_slot_enable(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットを最も高い優先度に設定します。
表 67.  rsu_client_slot_disable
プロトタイプ rsu_client_slot_disable(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットを無効にします。ただし、消去はされません。
表 68.  rsu_client_request_slot_be_loaded
プロトタイプ rsu_client_request_slot_be_loaded (int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットのロードを要求します。
表 69.  rsu_client_erase_image
プロトタイプ rsu_client_erase_image(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットからアプリケーション・イメージを消去します。
表 70.  rsu_client_request_factory_be_loaded
プロトタイプ rsu_client_request_factory_be_loaded(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 ファクトリー・イメージのロードを要求します。
表 71.  rsu_client_add_image
プロトタイプ rsu_client_add_image (int slot_num, void *buf, int size)
パラメーター
  • slot_num - 選択しているスロット
  • buf - データバッファーへのポインター
  • size - バッファーから読み出すバイト
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットに新しいイメージを追加し、最も高い優先度にします。最初にスロットを消去する必要があります。
表 72.  rsu_client_verify_data
プロトタイプ rsu_client_verify_data(int slot_num, void *buf, int size)
パラメーター
  • slot_num - 選択しているスロット
  • buf - データバッファーへのポインター
  • size - バッファーから読み出すバイト
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットのインテルFPGAビットストリームを検証します。
表 73.  rsu_client_copy_to_buf
プロトタイプ rsu_client_copy_to_buf(int slot_num, alt_u64 address)
パラメーター
  • slot_num - 選択しているスロット
  • address - データを格納するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 スロットからデータを読み出し、アドレスに書き込みます。
表 74.  rsu_client_status_log
プロトタイプ rsu_client_status_log(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 ステータスログをプリントします。
表 75.  rsu_client_clear_error_status
プロトタイプ rsu_client_clear_error_status(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 現在のRSUステータスからエラーをクリアします。
表 76.  rsu_client_display_dcmf_version
プロトタイプ rsu_client_display_dcmf_version(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 4つの決定ファームウェアのバージョンを表示します。
表 77.  rsu_client_display_dcmf_status
プロトタイプ rsu_client_display_dcmf_status(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 4つの決定ファームウェアのステータスを表示します。
表 78.  rsu_client_display_max_retry
プロトタイプ rsu_client_display_max_retry(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 最大再試行パラメーターを表示します。
表 79.  rsu_client_slot_create
プロトタイプ rsu_client_slot_create(char *slot_name, alt_u64 slot_address, unsigned int slot_size)
パラメーター
  • slot_name - 選択しているスロット
  • slot_address - スロットの開始アドレス
  • size - スロットのサイズ
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 未使用のスペースを使用して、SPTに新しいスロットを作成します。
表 80.  rsu_client_slot_rename
プロトタイプ rsu_client_slot_rename (int slot, char *name)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラーコードを返します 23
詳細 選択しているスロットの名前を変更して表示します。
表 81.  rsu_client_slot_delete
プロトタイプ rsu_client_slot_delete(int slot_num)
パラメーター
  • slot_num - 選択しているスロット
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 選択しているスロットを削除し、割り当てられたスペースを解放します。
表 82.  rsu_client_restore_spt
プロトタイプ rsu_client_restore_spt (alt_u64 address)
パラメーター
  • address - SPTを復元するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 アドレスからSPTを復元します。
表 83.  rsu_client_save_spt
プロトタイプ rsu_client_save_spt (alt_u64 address)
パラメーター
  • address - SPTを格納するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 作業中のSPTをアドレスに格納します。
表 84.  rsu_client_create_empty_cpb
プロトタイプ rsu_client_create_empty_cpb(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 CPBヘッダーのみを含む空のCPBを作成します。すべてのエントリーは未使用としてマークされます。
表 85.  rsu_client_restore_cpb
プロトタイプ rsu_client_restore_cpb (alt_u64 address)
パラメーター
  • address - CPBを復元するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 アドレスからCPBを復元します。
表 86.  rsu_client_save_cpb
プロトタイプ rsu_client_save_cpb(alt_u64 address)
パラメーター
  • address - CPBを格納するアドレス
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 作業中のCPBをアドレスに格納します。
表 87.  rsu_client_check_running_factory
プロトタイプ rsu_client_check_running_factory(void)
パラメーター -
戻り値 成功の場合は0を返し、それ以外の場合はエラー時に-1を返します。
詳細 現在実行されているイメージがファクトリー・イメージかを確認します。
23 詳細は、エラーコードを参照してください。