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.6. RSU Client API

Table 61.  su_cliet_get_slot_cout
Pototype: su_cliet_get_slot_cout(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Get the umbe of pedefied slots ad display the umbe of slots.
Table 62.  su_cliet_get_slot_by_ame
Pototype: su_cliet_get_slot_by_ame (cha *ame)
Paametes:
  • ame - ame of slot
Retu: Retu 0 fo success, o othewise etu eo code 23.
Desciptio: Get slot umbe based o ame ad display it.
Table 63.  su_cliet_list_slot_attibute
Pototype: su_cliet_list_slot_attibute(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: List the attibute ifo fom the selected slot. The attibutes ae image ame, offset, size ad pioity level.
Table 64.  su_cliet_get_slot_size
Pototype: su_cliet_get_slot_size(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Get the size fo a selected slot ad display slot size i bytes.
Table 65.  su_cliet_get_pioity
Pototype: su_cliet_get_pioity(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Get the pioity fo a selected slot ad display the pioity of the selected slot.
Table 66.  su_cliet_slot_eable
Pototype: su_cliet_slot_eable(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Set the selected slot as the highest pioity.
Table 67.  su_cliet_slot_disable
Pototype: su_cliet_slot_disable(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Disable selected slot but ot ease it.
Table 68.  su_cliet_equest_slot_be_loaded
Pototype: su_cliet_equest_slot_be_loaded (it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Request the selected slot be loaded.
Table 69.  su_cliet_ease_image
Pototype: su_cliet_ease_image(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Ease the applicatio image fom a selected slot.
Table 70.  su_cliet_equest_factoy_be_loaded
Pototype: su_cliet_equest_factoy_be_loaded(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Request the factoy image be loaded.
Table 71.  su_cliet_add_image
Pototype: su_cliet_add_image (it slot_um, void *buf, it size)
Paametes:
  • slot_um - the selected slot
  • buf - poite to data buffe
  • size - bytes to ead fom buffe
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Add a ew image to the selected slot ad make it the highest pioity. The slot must be eased fist.
Table 72.  su_cliet_veify_data
Pototype: su_cliet_veify_data(it slot_um, void *buf, it size)
Paametes:
  • slot_um - the selected slot
  • buf - poite to data buffe
  • size - bytes to ead fom buffe
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Veify the Itel FPGA bitsteam i the selected slot.
Table 73.  su_cliet_copy_to_buf
Pototype: su_cliet_copy_to_buf(it slot_um, alt_u64 addess)
Paametes:
  • slot_um - the selected slot
  • addess - the addess which saves data
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Read the data fom a slot the wite to a addess.
Table 74.  su_cliet_status_log
Pototype: su_cliet_status_log(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Pit the status log.
Table 75.  su_cliet_clea_eo_status
Pototype: su_cliet_clea_eo_status(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Clea eos fom the cuet RSU status.
Table 76.  su_cliet_display_dcmf_vesio
Pototype: su_cliet_display_dcmf_vesio(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Display the fou decisio fimwae vesios.
Table 77.  su_cliet_display_dcmf_status
Pototype: su_cliet_display_dcmf_status(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Display the status fo fou decisio fimwae.
Table 78.  su_cliet_display_max_ety
Pototype: su_cliet_display_max_ety(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Display the max ety paamete
Table 79.  su_cliet_slot_ceate
Pototype: su_cliet_slot_ceate(cha *slot_ame, alt_u64 slot_addess, usiged it slot_size)
Paametes:
  • slot_ame - the selected slot
  • slot_addess - stat addess of slot
  • size - size of slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Ceate a ew slot i the SPT, usig uused space.
Table 80.  su_cliet_slot_eame
Pototype: su_cliet_slot_eame (it slot, cha *ame)
Paametes: -
Retu: Retu 0 fo success, o othewise etu eo code23.
Desciptio: Reame the selected slot ad display it.
Table 81.  su_cliet_slot_delete
Pototype: su_cliet_slot_delete(it slot_um)
Paametes:
  • slot_um - the selected slot
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Delete selected slot, feeig up allocated space.
Table 82.  su_cliet_estoe_spt
Pototype: su_cliet_estoe_spt (alt_u64 addess)
Paametes:
  • addess - the addess which estoes SPT
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Restoe the SPT fom a addess.
Table 83.  su_cliet_save_spt
Pototype: su_cliet_save_spt (alt_u64 addess)
Paametes:
  • addess - the addess which saves SPT
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Save the wokig SPT to a addess.
Table 84.  su_cliet_ceate_empty_cpb
Pototype: su_cliet_ceate_empty_cpb(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Ceate a empty CPB, which icludes the CPB heade oly. All eties ae maked as uused.
Table 85.  su_cliet_estoe_cpb
Pototype: su_cliet_estoe_cpb (alt_u64 addess)
Paametes:
  • addess - the addess which estoes CPB
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Restoe the CPB fom a addess.
Table 86.  su_cliet_save_cpb
Pototype: su_cliet_save_cpb(alt_u64 addess)
Paametes:
  • addess - the addess which saves CPB
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Save the wokig CPB to a addess.
Table 87.  su_cliet_check_uig_factoy
Pototype: su_cliet_check_uig_factoy(void)
Paametes: -
Retu: Retu 0 fo success, o othewise etu -1 o eo.
Desciptio: Check if cuetly uig image is the factoy image.
23 Refe to Eo Codes fo moe ifomatio.
Level Two Title