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. LibRSU HAL API

The LibRSU HAL API is available for this controller in the following software files:
  • librsu.h
  • librsu.c
  • rsu_client.h
  • rsu_client.c

The HAL driver implements the remote system update feature in SDM-based devices which update the Altera FPGA image and perform device reconfiguration remotely. The Nios® II and Nios® V processors act as the remote system update host controller throughout the whole process.

It is recommended that your system memory has a minimum stack size or heap size of twice the size of the Decision Firmware of the respective SDM-based device.

Note:

You may need to modify the string MAILBOX_NAME based on your system.h in the following source codes.

  • For Stratix® 10 and Agilex™ 7 devices:
    altera_s10_mailbox_client_flash_rsu.c
    altera_s10_mailbox_client_rsu.c
  • For Agilex™ 5 and Agilex™ 3 devices:
    intel_mailbox_client_flash_rsu.c
    intel_mailbox_client_rsu.c
You need the ZLIB binaries to use the LibRSU HAL API. The following code generates the ZLIB libraries according to the specific version, and renames the folder as zlib. It is recommended to use the latest version of ZLIB binaries, provided in the zlib.net Home Page. 
wget http://zlib.net/zlib-<version>.tar.gz 
tar xf zlib-<version>.tar.gz 
mv zlib-<version> zlib

The final directory path of the zlib folder must be one level above the bsp project folder (this folder contains the Nios V processor Board Support Package) as shown in the following figure.

Figure 6. Directory Structure

Section Content
Configuration Parameter
Error Codes
Using LibRSU HAL API without Valid SPT or CPB
Data Type
Functions
RSU Client API

Related Information
Level Two Title