Mailbox Client with Avalon® Streaming Interface Intel® FPGA IP User Guide

Download PDF
ID 683510
Date 4/04/2022
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 with Avalon® Streaming Interface Intel FPGA IP Overview
1. Mailbox Client with Avalon® Streaming Interface Intel FPGA IP Overview x
1.1. Device Family Support 1.2. Commands and Responses 1.3. Mailbox Client with Avalon® Streaming Interface Intel FPGA IP User Guide Document Archives 1.4. Document Revision History for the Mailbox Client with Avalon® Streaming Interface Intel FPGA IP User Guide
1.1. Device Family Support x
1.1.1. Parameters 1.1.2. Interfaces
1.1.2. Interfaces x
1.1.2.1. Clock and Reset Interfaces 1.1.2.2. Command Interface 1.1.2.3. Response Interface 1.1.2.4. Command Status Interface
1.2. Commands and Responses x
1.2.1. Operation Commands 1.2.2. Error Code Responses 1.2.3. Error Code Recovery
1. Mailbox Client with Avalon® Streaming Interface Intel FPGA IP Overview

1.4. Document Revision History for the Mailbox Client with Avalon® Streaming Interface Intel FPGA IP User Guide

Document Version Intel® Quartus® Prime Version IP Version Changes
2022.04.04 22.1 1.0.1 Updated the Command List and Description table.
  • Updated pin status description for the CONFIG_STATUS command.
  • Removed the REBOOT_HPS command.
2021.10.04 21.3 1.0.1 Made the following change:
  • Revised Command List and Description table. Updated description for:
    • CONFIG_STATUS
    • RSU_STATUS
2021.06.21 21.2 1.0.1 Made the following changes:
  • Revised Command List and Description table. Updated description for:
    • RSU_STATUS
    • QSPI_OPEN
    • QSPI_SET_CS
    • QSPI_ERASE
2021.03.29 21.1 1.0.1 Made the following changes:
  • Revised RSU_IMAGE_UPDATE description in the Command List and Description table.
  • Restructured Operation Commands. Removed major and minor error code descriptions for the CONFIG_STATUS and RSU_STATUS commands. The major and minor error codes are now documented as an appendix in the Mailbox Client Intel® FPGA IP User Guide.
2020.12.14 20.4 1.0.1 Made the following changes:
  • Added important note about resetting QSPI flash in the Operation Commands topic.
  • Updated the Command List and Description table:
    • Revised GET_TEMPERATURE command description.
    • Revised RSU_IMAGE_UPDATE command description.
      • Added text about resetting QSPI flash.
      • Added text describing behavior between the external host and FPGA.
      • Removed text: Returns a non-zero response if the device is already processing a configuration command.
    • Updated QSPI_WRITE and QSPI_READ descriptions to specify that the maximum transfer size is 4 kilobytes or 1024 words.
    • Corrected response length from 1 to 0 for the QSPI_OPEN, QSPI_CLOSE and QSPI_SET_CS command.
    • Revised QSPI_OPEN, QSPI_WRITE, QSPI_READ_DEVICE_REG, and QSPI_WRITE_DEVICE_REG descriptions.
    • Added a new command: REBOOT_HPS.
  • Added new topic: Error Code Recovery.
2020.10.05 20.3 1.0.1
  • Changed the title of this user guide from Mailbox Avalon® Streaming Interface Client Intel FPGA IP User Guide to Mailbox Client with Avalon® Streaming Interface Intel FPGA IP User Guide due to the IP name change in the Intel® Quartus® Prime IP Catalog.
  • Globally updated all IP name instances.
  • Revised GET TEMPERATURE command description for Intel® Agilex™ devices in the Command List and Description table.
  • Added recommendation about the reset synchronizer in the Clock and Reset Interfaces table.
  • Updated the Error Codes table. Added new error code responses:
    • HW_ERROR
    • COMMAND_SPECIFIC_ERROR
  • Removed the Temperature Sensor Locations topic. The temperature sensor information is available in the Intel® Agilex™ Power Management User Guide.
2020.06.30 20.2 1.0.0
  • Changed the title of this user guide from Mailbox Avalon ST Client Intel FPGA IP User Guide to Mailbox Avalon® Streaming Interface Client Intel FPGA IP User Guide.
  • Renamed topic title Command and Response Header to Commands and Responses.
  • Revised ID, LENGTH, and Command Code/Error Code descriptions in the Command and Response Header Description table.
  • Renamed topic title Supported Commands to Operation Commands.
  • Revised the following commands description in the Command List and Description table:
    • GET_TEMPERATURE
    • RSU_STATUS
    • QSPI_SET_CS
  • Renamed topic title Error Codes to Error Code Responses.
  • Removed UNKNOWN_BR command from the Error Code table.
2020.04.13 20.1 1.0.0 Made the following changes:
  • Added information about the temperature sensors for the GET_TEMPERATURE command, including figures illustrating TSD locations.
  • Added RSU_NOTIFY command in the Command Code List and Description table.
  • Updated the Error Codes table:
    • Renamed INVALID_COMMAND_PARAMETERS to INVALID_LENGTH.
    • Changed COMMAND_INVALID_ON_SOURCE hex value from 5 to 6.
    • Changed CLIENT_ID_NO_MATCH hex value from 6 to 8.
    • Changed INVALID_ADDRESS hex value from 7 to 9.
    • Added AUTHENTICATION_FAIL command.
    • Changed TIMEOUT hex value from 8 to B.
    • Changed HW_NOT_READY hex value from 9 to C.
2019.09.30 19.3 1.0.0 Initial release.
Level Two Title