Mailbox Client Intel® FPGA IP User Guide

Download PDF
ID 683290
Date 12/04/2023
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. Device Family Support 1.2. Parameters 1.3. Mailbox Client Intel® FPGA IP Core Interface Signals 1.4. Mailbox Client Intel FPGA IP Avalon® Memory-Mapped Interface 1.5. Commands and Responses 1.6. Specifying the Command and Response FIFO Depths 1.7. Enabling Cryptographic Services 1.8. Using the Mailbox Client Intel FPGA IP 1.9. Mailbox Client Intel FPGA IP Core Use Case Examples 1.10. Nios® II and Nios® V Processors HAL Driver 1.11. Mailbox Client Intel FPGA IP User Guide Archives 1.12. Document Revision History for the Mailbox Client Intel® FPGA IP User Guide
1.3. Mailbox Client Intel® FPGA IP Core Interface Signals x
1.3.1. Clock and Reset Interfaces 1.3.2. Avalon® Memory-Mapped Interface 1.3.3. AXI Manager Interface
1.4. Mailbox Client Intel FPGA IP Avalon® Memory-Mapped Interface x
1.4.1. Interrupt Enable Register 1.4.2. Interrupt Status Register 1.4.3. Timer Registers
1.5. Commands and Responses x
1.5.1. Operation Commands 1.5.2. Error Code Responses 1.5.3. Error Code Recovery
1.10. Nios® II and Nios® V Processors HAL Driver x
1.10.1. Mailbox Client HAL API 1.10.2. LibRSU HAL API
1.10.1. Mailbox Client HAL API x
1.10.1.1. Mailbox Client Driver API
1.10.2. LibRSU HAL API x
1.10.2.1. Configuration Parameter 1.10.2.2. Error Codes 1.10.2.3. Using LibRSU HAL API without Valid SPT or CPB 1.10.2.4. Data Type 1.10.2.5. Functions 1.10.2.6. RSU Client API
1. Mailbox Client Intel FPGA IP User Guide
2. Appendix: CONFIG_STATUS and RSU_STATUS Error Code Descriptions

1.10.2.3. Using LibRSU HAL API without Valid SPT or CPB

You can use the LibRSU HAL APIs when the SPTs or CPBs in flash are corrupted, but with reduced functionality. Intel provides specialized APIs to restore a saved SPT or CPB, and also to create an empty CPB. After the CPBs and SPTs are repaired using these APIs, the full RSU functionality is available.

Table 26.  LibRSU HAL API without valid SPT or CPB
Data Corruption Impact
Single SPT or Single CPB The librsu_init function restores it from the good copy.
Both SPTs The librsu_init is still successful (return code 0) but some of the functions returns the error code ECORRUPTED_SPT when called. Both SPTs being corrupted cause librsu_init to not be able to identify the location of the CPBs, and the CPBs is also considered as corrupted.
Both CPBs The librsu_init is still successful (return code 0) but some of the functions returns the error code ECORRUPTED_CPB when called.
Note: When the processor implements the Functions, the processor needs to call the function librsu_init at the beginning of the whole application, and ends with librsu_exit This is not necessary for RSU Client API.

The table below lists which APIs require valid SPT or CPB.

Table 27.  Functions which require valid SPT or CPB
Functions Requires Valid SPT Requires Valid CPB
librsu_init
librsu_exit
rsu_slot_count Yes
rsu_slot_by_name Yes
rsu_slot_get_info Yes Yes
rsu_slot_size Yes
rsu_slot_priority Yes Yes
rsu_slot_erase Yes Yes
rsu_slot_program_buf Yes Yes
rsu_slot_verify_buf Yes Yes
rsu_slot_program_callback Yes Yes
rsu_slot_verify_callback Yes Yes
rsu_slot_copy_to_buf Yes Yes
rsu_slot_enable Yes Yes
rsu_slot_disable Yes Yes
rsu_slot_load Yes Yes
rsu_slot_load_factory Yes
rsu_slot_rename Yes
rsu_slot_delete Yes Yes
rsu_slot_create Yes
rsu_status_log
rsu_clear_error_status
rsu_dcmf_version
rsu_max_retry
rsu_dcmf_status
rsu_create_empty_cpb
rsu_restore_cpb
rsu_save_cpb Yes
rsu_restore_spt
rsu_save_spt Yes
rsu_running_factory Yes
Level Two Title