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.5. 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
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 10.  Command and Response Header Description
Header Bit Description
Reserved [31:28] Reserved.
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 IP responds with an error if a wrong number of words of arguments is entered for a given command.
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.