Mailbox Client Intel® FPGA IP User Guide

ID 683290
Date 4/04/2022
Public

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

1.10. Nios® II HAL Driver

This section describes the HAL driver for the Mailbox Client Intel® FPGA IP core. Intel provides HAL system library drivers that enable you to perform Mailbox Client operations using the HAL API functions. The operations along with their descriptions are listed in Table 11. In addition, the HAL driver also provides exclusive functions on QSPI flash device-related operations to simplify your design flow.

The HAL API is available for this controller in the following software files:
  • altera_s10_mailbox_client.h
  • altera_s10_mailbox_client.c
  • altera_s10_mailbox_client_flash.h
  • altera_s10_mailbox_client_flash.c
These files implement the Mailbox Client core device driver for the HAL system library.

To use the HAL API, enable altera_safeclib in the BSP Software Package from BSP Editor. Enter mailbox_client_open() function to start the HAL API. Note that the interrupt connection to the processor is necessary to use the HAL API.

The absolute addressing to the quad SPI memory specifies all the offset-related variables. You must complete the quad SPI operation by calling mailbox_client_flash_open() before any flash operation, and mailbox_client_flash_close() at the end of any flash operation.