Skip to main content

Mailbox Client IP Sample

Mailbox Client IP Sample

  • Updated

1 .　Introduction

Stratix® 10 FPGAs and Agilex™ 7 FPGAs have a hardcoded module called the Secure Device Manager (SDM). 
To access the SDM, you will need the Mailbox Client IP. 
For an overview of the Mailbox Client IP, please see the following article: 
Mailbox Client IP Overview and Usage

This article introduces a sample that can operate the Mailbox Client IP from Nios® II. 
We hope this will be helpful for those who are considering Remote System Upgrade (RSU), QSPI access, and information acquisition from voltage/temperature sensors from Nios® II. Table 1.

Table 1] Sample Code and Documentation Attached to This Article

File Name Summary
MailboxClientIP Sample Documentation.pdf Sample Detailed Explanatory Material
mb_hw.qar Hardware archive file
mb_sample.c C source code for Nios® II

__.png NOTES: 
The sample code and detailed documentation in [Table 1] are attached at the end of this article for your convenience.

 

To help you decide if this sample is useful for your design, we provide a " 2. Sample Overview " in the next section.

 

2. sample overview

2-1. Operating Environment

　The operating environment for this sample is as follows

  • Quartus® Prime development software: v21.3 Pro Edition

  • Device: Stratix® 10 FPGA

  • Board: Stratix ® 10 SX SoC Development Kit H-tile 
     

2-2. what the sample can do

There are three main functions that can be tested in this sample. The supported functions are as follows

  • Obtaining values from a sensor
    • Obtaining a value from a voltage sensor
    • Obtaining a value from a temperature sensor
  • Remote System Upgrade (RSU)
    • Check the storage address of the running image
    • Boot image in Flash
  • QSPI (configuration ROM) access
    • Obtain QSPI Flash information
    • Erase
    • Read
    • Write

 

3. reference materials

The following are reference materials for Mailbox Client IP.

User Guide

Please refer to the following link for the Mailbox Client IP User Guide.

__.png Reference: 
Mailbox Client IP User Guide

Manufacturer's Sample

Samples that can be evaluated based on tcl are available from the manufacturer. 
Samples are available for both Stratix® 10 FPGA and Agilex™ FPGA, so please refer to them according to the device you are using.

__.png Reference: Sample for Agilex™ 7 FPGA 
Mailbox Client IP Core Design Example (QSPI flash Access and Remote System Update)

__.png Reference: Sample for Stratix® 10 FPGA 
Stratix 10 Mailbox Client IP Core Design Example (QSPI flash Access and Remote System Update)

 

4. Conclusion

In this article, we introduced the Mailbox Client IP sample. 
We hope you will find this sample code useful when you implement it on your own device using Nios® II. 
 

 

5. sample

Related articles