1.11.1.1. Mailbox ClientドライバーAPI
| プロトタイプ | mailbox_client_open(const char *name) |
| インクルード | <altera_s10_mailbox_client.h> |
| パラメーター |
|
| 戻り値 | 成功の場合はNULL以外の値を返し、それ以外の場合は次の値を返します。
|
| 詳細 | メールボックス・クライアント・ブロック・インスタンスへのポインターを取得します。登録されているメールボックス・クライアント・インスタンスのリストで、指定されている名前を検索します。 |
| プロトタイプ | mailbox_client_send_cmd (intel_mailbox_client* fd, alt_u8 id, alt_u32 cmd, alt_u32* arg, int arg_length, int cmd_length, alt_u32* input_data, alt_u32* resp_buf, alt_u32 resp_buf_len) 17 |
| インクルード | <altera_s10_mailbox_client.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。 |
| 詳細 | コマンドとデータをMailbox Clientに送信します。データ有効割り込みが発生したら、応答を読み戻します。 |
| プロトタイプ | mailbox_client_flash_open(intel_mailbox_client* fd) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | QSPIを開き、QSPIチップを選択するコマンドをMailbox Clientに送信します。クアッドSPIインターフェイスへの排他的アクセスを提供します。QSPIフラッシュサイズを特定します。 |
| プロトタイプ | mailbox_client_flash_close(intel_mailbox_client* fd) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | QSPIを閉じるコマンドをMailbox Clientに送信します。クアッドSPIインターフェイスへの排他的アクセスを停止します。 |
| プロトタイプ | mailbox_client_flash_get_info(intel_mailbox_client* fd, flash_region** info, int* number_of_regions) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | nCSO[0] に対応する情報を提供します。 フラッシュメモリー・オフセット、フラッシュメモリー・サイズ、フラッシュデバイスの数、セクターの数、およびセクターサイズの値を返します。 |
| プロトタイプ | mailbox_client_flash_read (intel_mailbox_client* fd, int offset, void* dest_addr, int length) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | 選択されているアドレスから、バイトサイズで指定されている長さのデータを読み出します。長さは0以外の値です。 |
| プロトタイプ | mailbox_client_flash_erase_block (intel_mailbox_client* fd, int block_offset) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | 単一のフラッシュセクターを消去します。 |
| プロトタイプ | mailbox_client_flash_write_block (intel_mailbox_client* fd, int block_offset, int data_offset, const void* data, int length) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 | 成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | 1つのブロックまたはセクターのデータをフラッシュに書き込みます。書き込みデータの長さを隣接するセクター間で分割することはできません。 この関数は、アドレスが空であることを前提としています。プログラミングの前にアドレスを消去する必要があります。 |
| プロトタイプ | mailbox_client_flash_write (intel_mailbox_client* fd, int offset, const void* src_addr, int length) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 |
成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | 選択されているアドレスでフラッシュにデータをプログラミングします。プログラミングの前に、必要に応じてブロックを自動的に消去します。 |
| プロトタイプ | mailbox_client_flash_erase_block(intel_mailbox_client* fd, int block_offset, int block_size) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 |
成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | 指定されているブロックサイズに応じて単一のフラッシュセクターを消去します。 |
| プロトタイプ | mailbox_client_flash_erase(intel_mailbox_client* fd, int offset, int length) |
| インクルード | <altera_s10_mailbox_client_flash.h> |
| パラメーター |
|
| 戻り値 |
成功の場合は0を返し、それ以外の場合は次の値を返します。
|
| 詳細 | 指定されている長さに応じてフラッシュを消去します。 |
17 Quartus® Primeプロ・エディションの21.3より前のバージョンでは、応答バッファー長 (resp_buf_len) は整数ではなくポインターとして宣言されていました。
18 引数は、メールボックス・クライアントの操作に必要なパラメーターを表します。入力データは含まれません。
19 推奨されるエラーコード回復は、システム全体のリコンフィグレーションです。
20 推奨されるエラーコード回復は、Mailbox Client Intel® FPGA IPのリセットです。
21 応答バッファー長が不十分な場合、HAL APIはMailbox Client Intel® FPGA IPから収集したデータを破棄し、ENOBUFSを返します。