Mailbox Client Intel® FPGA IP用户指南

ID 683290
日期 12/04/2023
Public
文档目录

1.12. Mailbox Client Intel® FPGA IP用户指南的文档修订历史

文档版本 英特尔 Quartus Prime版本 IP版本 修订内容
2023.12.04 23.4 21.0.0 附录:CONFIG_STATUS和RSU_STATUS Error Code 描述部分的CONFIG_STATUS和RSU_STATUS Minor Error Code描述表格中添加了其它Minor Error Code。
2023.10.02 23.3 21.0.0 操作命令部分将以下代码添加到命令清单和描述列表中。
  • READ_SEU_ERROR
  • STATUS_VR
2023.08.01 23.2 21.0.0
  • 操作命令小节,更新了命令列表和描述列表中对QSPI_OPENQSPI_SET_CS命令的描述。
  • 错误代码恢复小节,更新了已知错误码的错误码恢复列表中值C的错误代码恢复。
  • 操作命令小节的命令列表和描述表格中,添加了QSPI_READ_SHA512命令行。
  • 更新了 Mailbox Client Intel® FPGA IP核接口信号小节的 Mailbox Client Intel® FPGA IP接口图中以包括avmm_waitrequest部分。
  • Avalon® Memory-Mapped Interface 小节,更新了 Avalon® Memory-Mapped Interface 列表,以包括avmm_waitrequest
  • 更新了Mailbox Client Driver API小节中的mailbox_client_flash _erase_block列表,将Kbytes替换为KB。
文档版本 英特尔 Quartus Prime版本 修订内容
2023.04.10 22.4
  • Mailbox Client with Avalon® Streaming Interface Intel FPGA IP概述小节添加了前往KDB的链接。
  • 更新了LibRSU HAL API小节中的内容以便更好地阐明如何获取ZLIB。
  • 将产品系列名更新为“ 英特尔Agilex® 7”。
  • 将Avalon ST和Avalon MM重命名为Avalon流接口和Avalon存储器映射接口。
2022.12.19 22.4
  • GET_CONFIGURATION_TIMEQSPI_READ_SHA命令行添加到命令清单和描述列表中。
  • 配置参数列表中更新了rsu_protected_slot的默认值和描述。
2022.09.26 22.3
  • 更新了命令清单和描述列表中的GET_VOLTAGE命令行。
  • 修订了使用Mailbox Client Intel FPGA IP。从“限制”(Restrictions)中删除了"Wait 10 ms between back to back commands to the SDM mailbox"。
  • 将注释添加到列表:器件系列支持
  • 在表:命令和响应Header描述中修订了LENGTH header的描述。
  • 修订了中断使能寄存器中关于已使能位的注释。
  • 在Enabling Cryptographic Services中添加了关于 Intel® Agilex™ Device Security User Guide的参考内容。
  • 命令清单和描述列表中,修订了QSPI_SET_CS命令的描述。
  • 将标题Nios II HAL Driver编辑为Nios II and Nios V Processors Hal Driver
    • 添加文字以指定英特尔 Quartus Prime Pro Edition软件21.4之前的版本。
  • 添加了以下主题:
    • Mailbox Client HAL API
    • LibRSU HAL API
    • Configuration Parameter(配置参数)
    • Error Codes(错误代码)
    • Using LibRSU HAL API without Valid SPT or CPB(使用无有效SPT或CPB的LibRSU HAL API)
    • Data Type(数据类型)
    • Functions(函数)
    • RSU Client API
2022.04.04 22.1
  • 将AXI目标的实例更新为AXI管理器实例。
  • 将特定加密服务参数的名称从HAS_OFFLOAD更改为Enable Crypto Service
  • 将位8和位9添加到下表:
    • 中断使能寄存器
    • 中断状态寄存器
  • 更新了命令清单和描述列表。
    • 更新了CONFIG_STATUS 命令的管脚状态描述。
    • 删除了REBOOT_HPS命令。
2021.11.10 21.3 进行以下更改:
  • 更新了对 Intel® Agilex™ 器件的器件系列支持。
  • 添加了新的小节以描述加密服务支持。
  • 修订了中断使能寄存器列表。添加了新寄存器:
    • EN_CRYPTO_MEMORY_TIMEOUT
    • EN_CRYPTO_ERROR_RECOVERY_PROGRESS
  • 修订了中断状态寄存器列表。添加了新的中断:
    • CRYPTO_MEMORY_TIMEOUT
    • CRYPTO_ERROR_RECOVERY_PROGRESS
  • 修订了命令清单和描述列表。更新了针对以下命令的描述:
    • CONFIG_STATUS
    • RSU_STATUS
  • 更新了Driver API小节中的mailbox_client_send_cmd命令
    • 修订了响应缓冲区的长度声明,将指针(alt_u32* resp_buf_len)改为整数(alt_u32 resp_buf_len)。
    • 添加ENOBUFS相关的脚注。
2021.06.21 21.2 修改如下内容:
  • 修订了中断使能寄存器。添加了关于使能位的注释。
  • 修订了命令清单和描述列表。更新了如下命令的描述:
    • RSU_STATUS
    • QSPI_OPEN
    • QSPI_SET_CS
    • QSPI_ERASE
  • 修订了使用Mailbox Client Intel® FPGA IP 中Read Command Description(读命令描述)。添加了关于通过 Avalon® memory-mapped interface访问SDM的注意事项。
  • 修订了 Nios® II HAL Driver。添加了关于对quad SPI的绝对寻址的文本内容。
  • Driver API小节中添加了mailbox_client_flash_get_info操作。
  • 删除了Driver API Application主题。改内容被移动到Driver API小节的一个参考文件中。
  • 更新了附录:CONFIG_STATUS和RSU_STATUS错误代码描述。添加了0xD00D - 0xD013小型错误代码描述。
2021.03.29 21.1 修改了如下内容:
  • 修订了响应包流程图图示和读命令描述小节。
  • 修订了Command List and Description列表中对 RSU_IMAGE_UPDATE的描述
  • 添加了新主题:
    • Nios® II HAL Driver
    • Driver API
    • Driver API Application
  • Operation Commands的内容结构重组。Moved major and minor error code descriptions for the 将对CONFIG_STATUSRSU_STATUS命令的严重或微小错误代码描述移动到附录:CONFIG_STATUSRSU_STATUS错误代码描述
2020.12.14 20.4 修改了如下内容:
  • 修订了Mailbox Client Intel® FPGA IP用户指南主题中结构框图的描述。
  • 更新了Mailbox Client Intel® FPGA IP系统结构框图图示。该图描绘了与Mailbox Client IP进行通信的各种方式。
  • 操作命令主题中添加了关于重新设置QSPI flash的重要说明。
  • 更新了命令清单和描述 列表:
    • 修订了GET_TEMPERATURE命令描述。阐述了 Intel® Stratix® 10器件之间的差异。
    • 修订了RSU_IMAGE_UPDATE命令描述。
      • 添加了关于重新设置QSPI flash的文本内容。
      • 添加了文本内容描述外部主机和FPGA之间的行为。
      • 删除的文本内容:如果器件已经处理了配置命令则返回非零响应。
    • 更新了QSPI_WRITEQSPI_READ描述以指定最大传输4 kilobytes(KB)或1024个字。
    • QSPI_OPENQSPI_CLOSEQSPI_SET_CS命令的响应长度从1更正为0。
    • 修订了QSPI_OPENQSPI_WRITEQSPI_READ_DEVICE_REG QSPI_WRITE_DEVICE_REG描述。
    • 添加了新的命令:REBOOT_HPS
  • 添加了新主题:Error Code Recovery(错误代码恢复)。
  • 修订了Timer Registers(定时器寄存器)主题。添加了脚注并更新了寄存器描述。
  • 更新了读取响应包流程图图示
2020.10.05 20.3 修改了如下内容:
  • 命令清单和描述列表中修订了 Intel® Agilex™ 器件的GET TEMPERATURE命令描述。
  • Mailbox Client FPGA Core Signals小节中添加了关于复位同步器的建议。
  • 更新了错误代码列表。添加了新的错误代码响应:
    • HW_ERROR
    • COMMAND_SPECIFIC_ERROR
2020.06.30 20.2 修改了如下内容:
  • 命令和响应Header描述列表中修订了LENGTHCommand Code/Error Code描述。
  • 命令清单和描述列表中修订了GET_TEMPERATURE命令描述。
  • Error Codes列表删除了UNKNOWN_BR命令。
  • 添加了新的定时器功能以处理对未完成事务超时错误和SDM背压超时致命错误的错误检测。
  • 添加了EOP_TIMEOUT中断支持,从而指示full命令不包含EOP。
  • 添加了 BACKPRESSURE_TIMEOUT中断支持,,以指示SDM内出现的错误。
  • Error Codes列表的CLIENT_ID_NO_MATCH描述中删除了SD/MMC文本内容。
  • 使用Mailbox Client Intel FPGA IP小节中更新了写和读命令描述。
2020.04.13 20.1 修改了如下内容:
  • 将以下限制添加到QSPI_SET_CS的定义中:使用SDM_IO pins管脚访问QSPI flash存储器器件仅适用于AS x4配置方案,JTAG配置和针对ASx4配置编译的设计。对于 Avalon® ST配置方案,您必须将QSPI flash存储器连接到GPIO管脚。
  • RSU_STATUS命令中Failing image字段的定义添加了如下文本内容:
    注: nCONFIG上以便从ASx4进行重新配置的上升沿不会清除该字段。仅当Mailbox Client接收到新的RSU_IMAGE_UPDATE命令并从更新映像成功配置时才会更新下降沿映像的信息。
  • 命令清单和描述列表中添加了RSU_NOTIFY命令。
  • 修订了Flow Chart for Writing Command PacketFlow Chart for Reading Response Packet以包含将命令写入命令FIFO和从响应FIFO读取响应包的正确顺序。更新了相应的写命令描述读命令描述小节。
2020.03.17 19.3 修改了如下内容:
  • 更新了Error Codes列表:
    • INVALID_COMMAND_PARAMETERS重命名为 INVALID_LENGTH
    • COMMAND_INVALID_ON_SOURCE十六进制值从5改为6。
    • CLIENT_ID_NO_MATCH十六进制值从6改为8。
    • INVALID_ADDRESS十六进制值从7改为9。
    • 添加了AUTHENTICATION_FAIL命令。
    • TIMEOUT十六进制值从8改为B。
    • HW_NOT_READY十六进制值从9改为C。
2019.09.30 19.3 进行了以下更改:
  • 添加了对 Intel® Agilex™ 器件的支持。
  • 添加了对COMMAND_INVALID中断的支持,该中断指示header中指定的命令长度与实际发送命令的长度不匹配。
  • 将Mailbox Client Intel® Stratix® 10 FPGA IP名称更改为Mailbox Client Intel FPGA IP。
  • 修订后的介绍包括图1:Mailbox Client Intel FPGA Ip系统块结构框图。修订了写命令包流程图和读响应数据包流程图以包括处理多个字命令和响应的逻辑。更改了对所有mailbox
  • 修订了写命令包流程图读响应数据包流程图以包括处理多个字命令和响应的逻辑。
  • 更改了对所有mailbox client IP名称的引用。mailbox clients IP的名称中不再包含 Intel® Stratix® 10 FPGA。
  • 添加了AN 891: Using the Reset Release Intel FPGA IP的参考内容。
  • 添加了 Intel® Agilex™ Power Management User Guide的参考内容。
  • 更新了GET_TEMPERATURE命令的描述,以表示掩码自变量为可选。忽略该变量,命令返回传感器 0的温度。
  • 更新了RSU_STATUS命令表示最高优先级的失败映像,而非最后一个失败映像。错误信息针对第一个失败的映像,它是最高优先级的失败映像。
  • 添加了CONFIG_STATUSRSU_STATUS主要错误和次要错误代码的描述。
  • HPS_COLDRESETHPS_WARMRESET添加到CONFIG_STATUS命令的软功能列表。
  • 添加了Mailbox Client Intel FPGA IP用户指南归档主题。
  • 将以下Intel FPGA IP添加到需要正确使用CommandCommand last寄存器的IP列表:
    • Advanced SEU Detection Intel IP
    • Partial Reconfiguration Controller Intel IP
    • Partial Reconfiguration External Configuration Controller Intel FPGA IP
    • 编辑整个用户指南的风格使其更加清晰。
文档版本 修订内容
2019.04.19
  • 更新了功能描述主题。
  • 在图命令和响应Header格式中添加了注释。
  • 更新了表: Mailbox Client Intel® Stratix® 10 FPGA IP命令和响应Header描述,以更新命令和响应头的位[11]的描述。
  • 更新了表:命令清单和描述以更新CONFIG_STATUSRSU_STATUS的描述。
  • 将标题 Mailbox Client Intel® Stratix® 10 FPGA IP Core Avalon® -MM Interface重命名为 Mailbox Client Intel® Stratix® 10 FPGA IP Core Signals
  • 将标题 Mailbox Client Intel® Stratix® 10 FPGA IP Core Avalon® -MM Interface重命名为 Mailbox Client Intel® Stratix® 10 FPGA IP Core Signal Description
  • 更新了表: Mailbox Client Intel® Stratix® 10 FPGA IP Core Signal Description以包括关于时钟和复位信号的信息。
  • 更新了表: Mailbox Client Intel® Stratix® 10 FPGA IP Core Avalon® -Memory Map以删除紧急命令和紧急FIFO空闲空间。
  • 更新了Using the Mailbox Client Intel® Stratix® 10 FPGA IP Core主题:
    • 添加了新图:写命令包流程图读响应包流程图
    • 添加了新的小节—限制
    • 更新了写命令包小节中的描述。
  • 更新了 Mailbox Client Intel® Stratix® 10 FPGA IP核用例实例主题。
  • 对整个文档作了编辑更新。
2019.03.14
  • 更新了 Mailbox Client Intel® Stratix® 10 FPGA IP核用户指南主题。
  • 更新图: Mailbox Client Intel® Stratix® 10 FPGA IP核和系统结构框图
  • 更新了表:命令列表及说和说明
    • 将列名称Number of Commands更改为Command Length
    • 将列名称Number of Responses更改为Respond Length
    • 更正了QSPI_READQSPI_WRITEQSPI_ERASE的描述。
2019.02.25
  • 更新了 Mailbox Client Intel® Stratix® 10 FPGA IP核用户指南主题的描述。
  • 更新了图: Mailbox Client Intel® Stratix® 10 FPGA IP Core User Guide
  • 更新了表:Interrupt Status Register以便更新DATA_VALID的描述。
  • 重命名了以下主题的标题:
    • Commands and Error Codes重命名为Commands and Responses
    • Commands重命名为Operation Commands
  • 更新了表:Mailbox Client Intel® Stratix® 10 FPGA IP Command and Response Header Description以更新LengthCommand Code/Error Code的描述。
  • 更新了表:命令列表和说明
    • 更新了响应数量和CONFIG_STATUS的描述。
    • 更新了RSU_STATUS的响应数量。
    • 更新了QSPI_READQSPI_WRITEQSPI_ERASE的描述。
  • 更新了表:Mailbox Client Intel® Stratix® 10 FPGA IP Error Code Responses and Description以更新UNKNOWN_BR的描述。
  • Using the Mailbox Client Intel® Stratix® 10 FPGA IP Core主题中更新了Writing Command PacketReading Command Packet小节。
  • 更新了Mailbox Client Intel Stratix 10 FPGA IP Core Use Case Examples主题。
  • 删除了以下主题:
    • Example 1: Reading Intel® eASIC™ N5X IDCODE and Voltage
    • Example 2: Read and Write EPCQ-L or QSPI Devices
2018.10.15
  • 更新了表:Command List and Description以包括以下命令:
    • 更新了GET_TEMPERATURE的描述。
    • 添加了新命令:
      • RSU_IMAGE_UPDATE
      • CONFIG_STATUS
      • RSU_STATUS
    • 删除了命令GET_DESIGNHASH
  • 更新表:Error Code Responses and Description以更新以下错误代码响应的值:
    • NOT_CONFIGURED
    • ALT_SDM_MBOX_RESP_DEVICE_BUSY
    • ALT_SDM_MBOX_RESP_NO_VALID_RESP_AVAILABLE
    • ALT_SDM_MBOX_RESP_ERROR
  • 在图:Mailbox Client Intel Stratix 10 FPGA IP Core Block Diagram中添加了注释。
  • 少许编辑更新。
2018.02.14 首次发布。