Mailbox Client Intel® FPGA IPs User Guide

ID 683290
Date 4/01/2024
Public

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

Document Table of Contents

1. Mailbox Client Intel FPGA IP User Guide

Updated for:
Intel® Quartus® Prime Design Suite 24.1

The Mailbox Client Intel® FPGA IP 1 is a bridge between a host and the secure device manager (SDM). You use the Mailbox Client Intel® FPGA IP to send commands and receive status from SDM peripheral clients2.

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 4 3

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 Agilex™ 7 FPGA - Mailbox Client Design Example with QSPI flash Access and Remote System Update to view the design.

1 To obtain specific IP names covered by this document, refer to the Release Information section of this document.
2 For the full list of supported SDM-based devices, refer to the Device Family Support section of this document.
3 This feature is available for Agilex™ 7 devices in Quartus® Prime software version 21.3 or later.
4 This feature is available for Agilex™ 5 devices in Quartus® Prime software version 24.1 or later.