Mailbox Client Intel® FPGA IPs User Guide

Download PDF
ID 683290
Date 7/08/2024
Public

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

Document Table of Contents
Document Table of Contents x
1. Mailbox Client Intel FPGA IP User Guide 2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions
1. Mailbox Client Intel FPGA IP User Guide x
1.1. Release Information 1.2. Device Family Support 1.3. Parameters 1.4. Mailbox Client Intel® FPGA IP Core Interface Signals 1.5. Mailbox Client Intel FPGA 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 Intel® FPGA IP 1.10. Accessing Quad SPI Flash Mailbox Client Intel FPGA IP Core Use Case Examples 1.11. Nios® II and Nios® V Processors HAL Driver 1.12. Mailbox Client Intel FPGA IP User Guide Archives 1.13. Document Revision History for the Mailbox Client Intel® FPGA IP User Guide
1.4. Mailbox Client Intel® FPGA 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 Intel FPGA 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 Intel FPGA IP User Guide
2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions

2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions

The CONFIG_STATUS and RSU_STATUS commands allows you to check the current configuration status or the current remote system upgrade status. The commands return 0 when there is no error. If the operation was unsuccessful, the command returns at least one error code described in the table below.

The Error Code field in the command header provides details of major and minor error codes. For more information about specific bits representing the major and minor error codes in the CONFIG_STATUS and RSU_STATUS command, refer to the Command List and Description table.

Figure 9. Command Header Format

Table 88.  CONFIG_STATUS and RSU_STATUS Major Error Code DescriptionsTable displays the major error codes and their descriptions received through the Error Code field.
Major Error Code Error Type Description
0xF001 ERR_BITSTREAM_ERROR Indicates a bitstream error.
0xF002 ERR_EXT_HW_ACCESS_FAIL Indicates an external hardware access error.
0xF003 ERR_BITSTREAM_CORRUPTION Indicates a bitstream corruption error.
0xF004 ERR_INTERNAL_ERROR Indicates an internal error due to misunderstood bitstream element.
0xF005 ERR_DEVICE_ERROR Indicates a device operation error.
0xF006 ERR_HPS_WDT

Indicates the HPS watchdog timeout failure. Ensure that your design resets the watchdog timer correctly.

0xF007 ERR_INTERNAL_UNKNOWN_ERROR

Indicates an internal device error due to an unknown task.

0xF008 ERR_SYSTEM_INIT_ERROR

Indicates an error due to the system initialization failure.

0xF009 ERR_DECRYPTION_ERROR

Indicates an error due to a bitstream decryption.

Table 89.  CONFIG_STATUS and RSU_STATUS Minor Error Code DescriptionsTable displays the minor error codes and their descriptions received through the Error Code field.
Minor Error Code Description
0x0001 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0002 Indicates a QSPI-related error due to the following conditions:
  • An incorrect connection between the QSPI device and the FPGA device.
  • QSPI device is in reset mode.
0x0003 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0004 Indicates a configuration error due to an incompatible bitstream with the device. Ensure the usage of a correct bitstream.
0x0005 - 0x0007 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0008 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0009 - 0x0014
0x0015 Indicates a bitstream authentication error during configuration. Ensure you signed the bitstream with the correct signing key.
0x0016 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0017 - 0x0024 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0025 Indicates a firmware transitional error during configuration. Ensure the device firmware and the current Quartus® Prime software version are compatible.

To recover, remove the current running firmware from the device.

0x0026 - 0x0031 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0032

Indicates a PMBUS error during configuration due to an incorrect VID setting in the Quartus® Prime project.

The target device failed to communicate with a smart regulator or PMBUS master on a board.

0x0033

Indicates a PMBUS error during configuration due to an incorrect VID setting in the Quartus® Prime project.

The target device failed to communicate with a smart regulator or PMBUS master on a board.

0x0034 - 0x0035 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0036 Reserved
0x0037 - 0x0041 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0042 Indicates an incompatible partial reconfiguration (PR) bitstream. Ensure you use the PR bitstream compatible with the current base design.
0x0043 - 0x0049 Reserved
0x004A- 0x004F Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0050 Indicates an error during configuration due to a device mismatch between the Quartus® Prime project and the target device.
0x0051 - 0x0052 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0053 - 0x0054 Indicates a bitstream decryption error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0055 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0056 - 0x0058 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0059 - 0x0061 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0062 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0063 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0064 - 0x0066 Indicates a configuration error due to a corrupted bitstream. Ensure a valid connection between the device and the configuration source.
0x0067 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0068

Indicates that the detected bitstream is incompatible due to the security enabled settings. You cannot use the bitstream from an advanced security-enabled devices on a non-advanced security-enabled device.

Ensure the Quartus® Prime project device matches the target device.

0x0069

Indicates that the detected bitstream is invalid due to reached maximum number of supported partial reconfiguration (PR) authentication. The bitstream supports up to 32 PR partitions.

0x006A - 0x0075 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0x0088 - 0x0090 Indicates a configuration error due to the UIB ref clock. Ensure the UIB refclk is enabled on the device.
0xC001 Indicates a firmware error during reconfiguration. Check the latest Quartus® Prime software release for possible fixes.
0xC002 - 0xC006 Indicates a bitstream error during reconfiguration. Check the bitstream validity. If corrupted, regenerate and configure bitstream again.
0xC007 Indicates an error due to transitioning to other firmware version or application image. Ensure the bitstream is valid. If corrupted, regenerate and reprogram QSPI flash with RSU image via the JTAG interface.
0xC008 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0xC009 Indicates a bitstream authentication error during reconfiguration. Ensure you use the correct signing key when signing the bitstream.
0xC00A Indicates an error during configuration. To recover, power cycle the device.
0xC00B Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0xC00D Indicates a hardware error during reconfiguration. To recover, power cycle the device.
0xC00E Indicates a bitstream error during reconfiguration. Check the bitstream validity. If corrupted, regenerate and configure bitstream again.
0xC00F Indicates an error when accessing the QSPI flash memory. Reconfigure device by toggling nCONFIG pin signal or power cycle the device.
0xD001 Indicates an authentication failure for the firmware. Ensure you use the correct firmware signing key when enabling firmware co-signing feature.
0xD002 Indicates an authentication failure for the design. Ensure you sign the bitstream with a correct signing key.
0xD003 Indicates an error when loading the application image from QSPI flash. Ensure the application image located at the correct address in QSPI flash.
0xD004 Indicates an error when parsing the RSU CPB block. RSU CPB block is corrupted. To recover, toggle the nCONFIG pin to restart the RSU. If the issue persists, reprogram the RSU CPB block data.
0xD005 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0xD006 Failed to load factory image. Ensure the factory image is valid. If corrupted, regenerate and reprogram the factory image in the flash. When authentication is enabled, ensure you use the correct signing key.
0xD007 Indicates an error when loading the application image. Check the application image validity. If corrupted, regenerate and reprogram again the application image in the flash.
0xD008 Indicates an error during factory image update in flash memory. Check the factory update image validity. If corrupted, regenerate and reprogram again the factory updated image in the flash.
0xD009 Indicates an error during a decision firmware update in flash memory. Check the factory update image validity. If corrupted, regenerate and reprogram again the factory updated image. Ensure you use the correct signing key when authentication is enabled.
0xD00A Indicates an error during a decision firmware update in flash memory. Flash memory may have reset during the update process. To recover, toggle the nCONFIG signal to restart the update process.
0xD00B Indicates an error during a decision firmware update in flash memory. Flash memory may have reset during the update process. To recover, toggle the nCONFIG signal to restart the update process.
0xD00C Indicates an error during RSU CPB table update in flash. RSU CPB block data may be corrupted. To recover, regenerate the RSU image containing the updated factory image and program it to flash.
0xD00D Indicates an error during combined application image update in flash memory. Check the combined application image validity. If corrupted, regenerate and reprogram again the combined application update image in the flash.
0xD00E Indicates an error during a decision firmware update in flash memory. Flash memory may have reset during the update process. To recover, toggle the nCONFIG signal to restart the update process.
0xD00F Indicates an error when parsing the DCIO section. The DCIO section may be corrupted. To recover, regenerate the RSU image containing new decision firmware or DCIO section and program it to flash.
0xD010 Indicates an error in the RSU CPB0 table. The CPB0 table may be corrupted. To recover the CPB0, regenerate the RSU image containing new decision firmware and program it to flash.
0xD011 Indicates an error in the RSU CPB0 and CPB1 tables. Both CPB0 and CPB1 table entries may be corrupted. To recover CPB0 and CPB1, regenerate the RSU image containing new decision firmware and program it to flash.
0xD012 Indicates a successful non-JTAG device provisioning. The successful decision firmware loads the highest priority application image.
0xD013 Indicates an error during the device provisioning.
0xE001 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0xE002 Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0xE003 - 0xE008 Reserved
0xE009 - 0xE00B Indicates an error during configuration.

Refer to the Configuration User Guide for details on the debug guidelines. Check the latest Quartus® Prime software release for possible fixes.

0xE00C Reserved
Related Information
Level Two Title