Mailbox Client Intel® FPGA IPs User Guide

ID 683290
Date 7/08/2024
Public
Document Table of Contents

1.6. Commands and Responses

The host controller communicates with the SDM using command and response packets via the Mailbox Client Intel® FPGA IP.

The first word of the command and response packets is a header that provides basic information about the command or response.

Figure 3. Command and Response Header Format in Stratix® 10
Figure 4. Command and Response Header Format in Agilex™ 7
Figure 5. Command and Response Header Format in Agilex™ 5
Note: The LENGTH field in the command header must match the command length of corresponding command.

The following table describes the fields of the header command.

Table 12.  Command and Response Header Description
Header Bit Description
Reserved [31:28] Reserved.
CLIENT [31:28] The client ID. The response header returns the client ID specified in the command header.
ID [27:24] The command ID. The response header returns the ID specified in the command header. Refer to Operation Commands for command descriptions.
0 [23] Reserved.
LENGTH [22:12] Number of words of arguments following the header. The Mailbox Client Intel® FPGA IP responds with an error if a wrong number of words of arguments is entered for a given command.

If there is a mismatch between the command length specified in the command header and the number of words sent, the Mailbox Client Intel® FPGA IP raises bit 3 of the Interrupt Status Register (COMMAND_INVALID) and the Mailbox Client Intel® FPGA IP must be reset.

Reserved [11] Reserved. Must be set to 0.
Command Code/Error Code [10:0] Command Code specifies the command. The Error Code indicates whether the command succeeded or failed.

In the command header, these bits represent command code. In the response header, these bits represent error code. If the command succeeds, the Error Code is 0. If the command fails, refer to the error codes defined in the Error Code Responses.