Mailbox Client Intel® FPGA IP用户指南

下载 PDF
ID 683290
日期 12/04/2023
Public
文档目录
文档目录 x
1. Mailbox Client Intel FPGA IP用户指南 2. 附录：CONFIG_STATUS和RSU_STATUS错误码描述
1. Mailbox Client Intel FPGA IP用户指南 x
1.1. 器件系列支持 1.2. 参数 1.3. Mailbox Client Intel® FPGA IP核接口信号 1.4. Mailbox Client Intel FPGA IP Avalon® 存储器映射接口 1.5. 命令和响应 1.6. 指定命令和响应FIFO深度 1.7. 启用加密服务 1.8. 使用Mailbox Client Intel FPGA IP 1.9. Mailbox Client Intel FPGA IP核用例示范 1.10. Nios® II和 Nios® V处理器HAL驱动程序 1.11. Mailbox Client Intel FPGA IP用户指南存档 1.12. Mailbox Client Intel® FPGA IP用户指南的文档修订历史
1.3. Mailbox Client Intel® FPGA IP核接口信号 x
1.3.1. 时钟和复位接口 1.3.2. Avalon® 存储器映射接口 1.3.3. AXI Manager接口
1.4. Mailbox Client Intel FPGA IP Avalon® 存储器映射接口 x
1.4.1. 中断使能寄存器 1.4.2. 中断状态寄存器 1.4.3. 定时器寄存器
1.5. 命令和响应 x
1.5.1. 操作命令 1.5.2. 错误代码响应 1.5.3. 错误码恢复
1.10. Nios® II和 Nios® V处理器HAL驱动程序 x
1.10.1. Mailbox Client HAL API 1.10.2. LibRSU HAL API
1.10.1. Mailbox Client HAL API x
1.10.1.1. Mailbox Client Driver API
1.10.2. LibRSU HAL API x
1.10.2.1. 配置参数 1.10.2.2. 错误代码 1.10.2.3. 无有效SPT或CPB的情况下使用LibRSU HAL API 1.10.2.4. 数据类型(Data Type) 1.10.2.5. 函数 1.10.2.6. RSU Client API
1. Mailbox Client Intel FPGA IP用户指南
2. 附录：CONFIG_STATUS和RSU_STATUS错误码描述

1.10.2.6. RSU Client API

表 59.  rsu_client_get_slot_count
原型开发： rsu_client_get_slot_count(void，无类型函数)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 获取预定义槽的数量并显示槽的数量。
表 60.  rsu_client_get_slot_by_name
原型开发： rsu_client_get_slot_by_name (char *name)
参数：
  • name - 槽名称
返回： 成功则返回0，否则返回错误码 18
描述： 根据名称获取槽编号并显示该编号。
表 61.  rsu_client_list_slot_attribute
原型开发： rsu_client_list_slot_attribute(int slot_num)
参数：
  • slot_num - the selected slot
返回： 成功则返回0，否则出错返回-1。
描述： 列出所选槽的属性信息。属性包括图像名称、偏移量和优先级。
表 62.  rsu_client_get_slot_size
原型开发： rsu_client_get_slot_size(int slot_num)
参数：
  • slot_num - 选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 获取选定插的大小并以字节为单位显示槽的大小。
表 63.  rsu_client_get_priority
原型开发： rsu_client_get_priority(int slot_num)
参数：
  • slot_num -选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 获取所选槽的优先级并显示所选槽的优先级。
表 64.  rsu_client_slot_enable
原型开发： rsu_client_slot_enable(int slot_num)
参数：
  • slot_num - 选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 将所选槽设置为最高优先级。
表 65.  rsu_client_slot_disable
原型开发： rsu_client_slot_disable(int slot_num)
参数：
  • slot_num - 选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 禁用选择的槽但不将其删除。
表 66.  rsu_client_request_slot_be_loaded
原型开发： rsu_client_request_slot_be_loaded (int slot_num)
参数：
  • slot_num - 选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 请求加载选择的槽。
表 67.  rsu_client_erase_image
原型开发： rsu_client_erase_image(int slot_num)
参数：
  • slot_num - 选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 从选定的槽中删除应用程序映像。
表 68.  rsu_client_request_factory_be_loaded
原型开发： rsu_client_request_factory_be_loaded(void，无类型函数)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 请求加载工厂映像。
表 69.  rsu_client_add_image
原型开发： rsu_client_add_image (int slot_num, void *buf, int size)
参数：
  • slot_num - 选择的槽
  • buf - 指向数据缓冲区的指针
  • size - 从缓冲区读取的字节数
返回： 成功则返回0，否则出错返回-1。
描述： 将新图像添加到所选槽并使其具有最高优先级。但必须先擦除该槽。
表 70.  rsu_client_verify_data
原型开发： rsu_client_verify_data(int slot_num, void *buf, int size)
参数：
  • slot_num - 选择的槽
  • buf - 指向数据缓冲区的指针
  • size - 从缓冲区读取的字节数
返回： 成功则返回0，否则出错返回-1。
描述： 验证选择的槽中的Intel FPGA比特流。
表 71.  rsu_client_copy_to_buf
原型开发： rsu_client_copy_to_buf(int slot_num, alt_u64 address)
参数：
  • slot_num - 选择的槽
  • address - 保存数据的地址
返回： 成功则返回0，否则出错返回-1。
描述： 从一个槽读取数据，然后写入一个地址。
表 72.  rsu_client_status_log
原型开发： rsu_client_status_log(void，无类型函数)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 打印状态日志。
表 73.  rsu_client_clear_error_status
原型开发： rsu_client_clear_error_status(void)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 清除当前RSU状态中的错误。
表 74.  rsu_client_display_dcmf_version
原型开发： rsu_client_display_dcmf_version(void)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 显示四个决策固件版本。
表 75.  rsu_client_display_dcmf_status
原型开发： rsu_client_display_dcmf_status(void)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 显示四个决策固件的状态。
表 76.  rsu_client_display_max_retry
原型开发： rsu_client_display_max_retry(void)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 显示最大重试次数参数
表 77.  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中创建一个新槽。
表 78.  rsu_client_slot_rename
原型开发： rsu_client_slot_rename (int slot, char *name)
参数： -
返回： 如果成功则返回0，否则返回错误代码18
描述： 重命名所选槽并将其显示出来。
表 79.  rsu_client_slot_delete
原型开发： rsu_client_slot_delete(int slot_num)
参数：
  • slot_num - 选择的槽
返回： 成功则返回0，否则出错返回-1。
描述： 删除选择的槽，释放分配的空间。
表 80.  rsu_client_restore_spt
原型开发： rsu_client_restore_spt (alt_u64 address)
参数：
  • address - 恢复SPT的地址
返回： 成功则返回0，否则出错返回-1。
描述： 从地址恢复SPT。
表 81.  rsu_client_save_spt
原型开发： rsu_client_save_spt (alt_u64 address)
参数：
  • address - 保存SPT的地址
返回： 成功则返回0，否则出错返回-1。
描述： 将有效SPT保存到某个地址。
表 82.  rsu_client_create_empty_cpb
原型开发： rsu_client_create_empty_cpb(void)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 创建一个空的CPB，其中仅包含CPB头（header）。所有条目均标记为未使用。
表 83.  rsu_client_restore_cpb
原型开发： rsu_client_restore_cpb (alt_u64 address)
参数：
  • address - 恢复CPB的地址
返回： 成功则返回0，否则出错返回-1。
描述： 从地址恢复CPB。
表 84.  rsu_client_save_cpb
原型开发： rsu_client_save_cpb(alt_u64 address)
参数：
  • address - 保存CPB的地址
返回： 成功则返回0，否则出错返回-1。
描述： 将有效CPB保存到某个地址。
表 85.  rsu_client_check_running_factory
原型开发： rsu_client_check_running_factory(void)
参数： -
返回： 成功则返回0，否则出错返回-1。
描述： 检查当前运行的是否为出厂映像。
18 请参阅Error Codes了解更多信息。
二级标题