Mailbox Client IPs User Guide

Download PDF
ID 683290
Date 4/07/2025
Public
Document Table of Contents
Document Table of Contents x
1. Mailbox Client IPs User Guide 2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions
1. Mailbox Client IPs User Guide x
1.1. Release Information 1.2. Device Family Support 1.3. Parameters 1.4. Mailbox Client IP Core Interface Signals 1.5. Mailbox Client IP Avalon® Memory-Mapped Interface 1.6. Commands and Responses 1.7. Specifying the Command and Response FIFO Depths 1.8. Enabling Cryptographic Services 1.9. Using the Mailbox Client IP 1.10. Accessing Quad SPI Flash Mailbox Client IP Core Use Case Examples 1.11. Nios® II and Nios® V Processors HAL Driver 1.12. Mailbox Client IP User Guide Archives 1.13. Document Revision History for the Mailbox Client IP User Guide
1.4. Mailbox Client IP Core Interface Signals x
1.4.1. Clock and Reset Interfaces 1.4.2. Avalon® Memory-Mapped Interface 1.4.3. AXI Manager Interface
1.5. Mailbox Client IP Avalon® Memory-Mapped Interface x
1.5.1. Interrupt Enable Register 1.5.2. Interrupt Status Register 1.5.3. Timer Registers
1.6. Commands and Responses x
1.6.1. Operation Commands 1.6.2. Error Code Responses 1.6.3. Error Code Recovery
1.11. Nios® II and Nios® V Processors HAL Driver x
1.11.1. Mailbox Client HAL API 1.11.2. LibRSU HAL API
1.11.1. Mailbox Client HAL API x
1.11.1.1. Mailbox Client Driver API
1.11.2. LibRSU HAL API x
1.11.2.1. Configuration Parameter 1.11.2.2. Error Codes 1.11.2.3. Using LibRSU HAL API without Valid SPT or CPB 1.11.2.4. Data Type 1.11.2.5. Functions 1.11.2.6. RSU Client API
1. Mailbox Client IPs User Guide
2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions

1.1. Release Information

IP versions match the Quartus® Prime Design Suite software versions until v19.1. Starting in Quartus® Prime Design Suite software version 19.2, IP has a new versioning scheme.

The IP version (X.Y.Z) number can change with each Quartus® Prime software version. A change in:

  • X indicates a major revision of the IP. If you update the Quartus® Prime software, you must regenerate the IP.
  • Y indicates the IP includes new features. Regenerate your IP to include these new features.
  • Z indicates the IP includes minor changes. Regenerate your IP to include these changes.
The IPs listed in this section are referred to collectively as Mailbox Client IP throughout this document unless otherwise noted.
Table 1.   Mailbox Client IP Release InformationThis IP is used exclusively with Stratix® 10 and Agilex™ 7 devices.
Item Description
IP Version 22.0.0
Quartus® Prime Pro Edition Version 24.2
Release Date 2024.07.08
Table 2.  Agilex 5/Agilex 3 Mailbox Client IP Release InformationThis IP is used exclusively with Agilex™ 5 and Agilex™ 3 devices.
Item Description
IP Version 1.0.1
Quartus® Prime Pro Edition Version 25.1
Release Date 2025.04.07
Related Information
Level Two Title