Mailbox Client Intel® FPGA IP User Guide

ID 683290
Date 12/04/2023
Document Table of Contents
Give Feedback

1.10.1. Mailbox Client HAL API

The Mailbox Client 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. The HAL driver provides exclusive functions on QSPI flash device-related operations to simplify your design flow.

To use the HAL API, enable altera_safeclib in the BSP Software Package from BSP Editor for Intel® Quartus® Prime Pro Edition software version prior to 21.4. 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.