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.11.2.1. Configuration Parameter

The LibRSU HAL API configuration parameters are stored in Board Support Package (BSP) setting file. You can edit the configuration parameters through the BSP Driver tab. If they are not specified, the LibRSU HAL API uses the default value.

Table 27.  Configuration Parameter
Variable Default Value Description
rsu_protected_slot -1 Allows protection on a certain slot number. Only slots between 0 and 31 can be protected by this feature. By default (rsu_protected_slot = -1), no slot is protected.
rsu_log_level 3 Allows customization on how much logging information is displayed. The valid inputs are 1,2 and 3. By default, the log level is set as 3 and all logging information is displayed.
enable_spt_checksum Disable Enables check and maintenance of the SPT checksum. By default, the SPT checksum feature is disabled.
enable_rsu Disable Enables the RSU functions. By default, it is disabled and the Mailbox Client IP core performs without the RSU functions.

fpga_device

  • Stratix10
Disable Allows configuration targeting the selected Altera FPGA devices. By default, the configuration targets Agilex™ 7, Agilex™ 5 and Agilex™ 3 devices, thus the Stratix® 10 setting is disabled.
Level Two Title