Mailbox Client Intel® FPGA IPs User Guide

Download PDF
ID 683290
Date 11/04/2024
Public
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

1.11.2.3. Using LibRSU HAL API without Valid SPT or CPB

You ca use the LibRSU HAL APIs whe the SPTs o CPBs i flash ae coupted, but with educed fuctioality. Itel povides specialized APIs to estoe a saved SPT o CPB, ad also to ceate a empty CPB. Afte the CPBs ad SPTs ae epaied usig these APIs, the full RSU fuctioality is available.

Table 28.  LibRSU HAL API without valid SPT o CPB
Data Couptio Impact
Sigle SPT o Sigle CPB The libsu_iit fuctio estoes it fom the good copy.
Both SPTs The libsu_iit is still successful (etu code 0) but some of the fuctios etus the eo code ECORRUPTED_SPT whe called. Both SPTs beig coupted cause libsu_iit to ot be able to idetify the locatio of the CPBs, ad the CPBs is also cosideed as coupted.
Both CPBs The libsu_iit is still successful (etu code 0) but some of the fuctios etus the eo code ECORRUPTED_CPB whe called.
Note: Whe the pocesso implemets the Fuctios, the pocesso eeds to call the fuctio libsu_iit at the begiig of the whole applicatio, ad eds with libsu_exit This is ot ecessay fo RSU Cliet API.

The table below lists which APIs equie valid SPT o CPB.

Table 29.  Fuctios which equie valid SPT o CPB
Fuctios Requies Valid SPT Requies Valid CPB
libsu_iit
libsu_exit
su_slot_cout Yes
su_slot_by_ame Yes
su_slot_get_ifo Yes Yes
su_slot_size Yes
su_slot_pioity Yes Yes
su_slot_ease Yes Yes
su_slot_pogam_buf Yes Yes
su_slot_veify_buf Yes Yes
su_slot_pogam_callback Yes Yes
su_slot_veify_callback Yes Yes
su_slot_copy_to_buf Yes Yes
su_slot_eable Yes Yes
su_slot_disable Yes Yes
su_slot_load Yes Yes
su_slot_load_factoy Yes
su_slot_eame Yes
su_slot_delete Yes Yes
su_slot_ceate Yes
su_status_log
su_clea_eo_status
su_dcmf_vesio
su_max_ety
su_dcmf_status
su_ceate_empty_cpb
su_estoe_cpb
su_save_cpb Yes
su_estoe_spt
su_save_spt Yes
su_uig_factoy Yes
Level Two Title