Mailbox Client Intel® FPGA IP User Guide

Download PDF
ID 683290
Date 10/02/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
1. Mailbox Client Intel FPGA IP User Guide 2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions
1. Mailbox Client Intel FPGA IP User Guide x
1.1. Device Family Support 1.2. Parameters 1.3. Mailbox Client Intel® FPGA IP Core Interface Signals 1.4. Mailbox Client Intel FPGA IP Avalon® Memory-Mapped Interface 1.5. Commands and Responses 1.6. Specifying the Command and Response FIFO Depths 1.7. Enabling Cryptographic Services 1.8. Using the Mailbox Client Intel FPGA IP 1.9. Mailbox Client Intel FPGA IP Core Use Case Examples 1.10. Nios® II and Nios® V Processors HAL Driver 1.11. Mailbox Client Intel FPGA IP User Guide Archives 1.12. Document Revision History for the Mailbox Client Intel® FPGA IP User Guide
1.3. Mailbox Client Intel® FPGA IP Core Interface Signals x
1.3.1. Clock and Reset Interfaces 1.3.2. Avalon® Memory-Mapped Interface 1.3.3. AXI Manager Interface
1.4. Mailbox Client Intel FPGA IP Avalon® Memory-Mapped Interface x
1.4.1. Interrupt Enable Register 1.4.2. Interrupt Status Register 1.4.3. Timer Registers
1.5. Commands and Responses x
1.5.1. Operation Commands 1.5.2. Error Code Responses 1.5.3. Error Code Recovery
1.10. Nios® II and Nios® V Processors HAL Driver 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. Configuration Parameter 1.10.2.2. Error Codes 1.10.2.3. Using LibRSU HAL API without Valid SPT or CPB 1.10.2.4. Data Type 1.10.2.5. Functions 1.10.2.6. RSU Client API
1. Mailbox Client Intel FPGA IP User Guide
2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions

1. Mailbox Client Intel FPGA IP User Guide

Updated for:
Intel® Quartus® Prime Design Suite 23.3
IP Version 21.0.0

The Mailbox Client Intel® FPGA IP is a bridge between a host and the secure device manager (SDM). Available for Intel® Stratix® 10 and Intel Agilex® 7 devices, you use the Mailbox Client Intel® FPGA IP to send commands and receive status from SDM peripheral clients. The Mailbox Client defines functions that the SDM runs.

The following pre-defined functions are available:
  • Reading the Chip ID
  • Reading temperature sensors
  • Reading voltage sensors
  • Reading and writing external quad serial peripheral interface (SPI) flash memory
  • Performing remote system updates (RSU)
  • Enabling cryptographic services 1

The following block diagram shows how to use the Mailbox Client Intel® FPGA IP in an interactive session. The diagram also emphasizes different ways of communicating with IP through the Host Controller.

Figure 1.  Mailbox Client Intel® FPGA IP System Block Diagram
This block diagram includes the following components:
  • Host Controller: provides possible ways of accessing the Mailbox Client Intel® FPGA IP. Use any of the specified ways to communicate with the host controller:
    • System Console with the JTAG to Avalon® Master Bridge Intel® FPGA IP. The System Console provides a Tcl Console pane that you can use to run the IP functions. The JTAG to Avalon® Master Bridge Intel® FPGA IP translates the commands it receives from the System Console to Avalon® memory-mapped interface format that the Mailbox Client Intel® FPGA IP requires.
    • Nios® II processor: sends commands to the Mailbox Client Intel® FPGA IP.
    • Custom logic: It sends commands to the Mailbox Client Intel® FPGA IP.
    • PCIe* Hard IP
    • Ethernet IP

  • Mailbox Client Intel® FPGA IP: drives commands and receives responses from the SDM. This component includes FIFOs with a maximum depth of 1024 entries to store commands and responses. The Mailbox Client Intel® FPGA IP interrupt indicates when the input FIFO is full and when the output FIFO contains valid data. You can size these FIFOs to accommodate the commands the you intend to send.

Intel provides a reference design that uses the System Console and the JTAG master to drive the Mailbox Client Intel® FPGA IP. In the Intel Design Store, search for Intel Agilex® 7 FPGA - Mailbox Client Design Example with QSPI flash Access and Remote System Update to view the design.


Section Content
Device Family Support
Parameters
Mailbox Client Intel FPGA IP Core Interface Signals
Mailbox Client Intel FPGA IP Avalon Memory-Mapped Interface
Commands and Responses
Specifying the Command and Response FIFO Depths
Enabling Cryptographic Services
Using the Mailbox Client Intel FPGA IP
Mailbox Client Intel FPGA IP Core Use Case Examples
Nios II and Nios V Processors HAL Driver
Mailbox Client Intel FPGA IP User Guide Archives
Document Revision History for the Mailbox Client Intel FPGA IP User Guide

Related Information
1 This feature is available for Intel Agilex® 7 devices in Intel® Quartus® Prime software version 21.3 or later.
Level Two Title