Skip to content

Responses

Dorian Stoll edited this page Jan 7, 2020 · 2 revisions

Responses are events, that are sent from the ME to the host, as a reaction to a command that was sent before. They will consist of the 4 byte response code, a 4 byte status code, and 80 bytes payload.

struct ipts_response {
	u32 code;
	u32 status;
	u8 data[80];
};

The status code can be one of the following:

SUCCESS

  • code: 0
  • Requested operation was successful.

INVALID_PARAMS

  • code: 1
  • Invalid parameter(s) sent.

ACCESS_DENIED

  • code: 2
  • Unable to validate address range.

CMD_SIZE_ERROR

  • code: 3
  • Message has incorrect size for specified command.

NOT_READY

  • code: 4
  • Memory window not set or device is not armed for operation.

REQUEST_OUTSTANDING

  • code: 5
  • There is already an outstanding message of the same type, must wait for response before sending another request of that type.

NO_SENSOR_FOUND

  • code: 6
  • Sensor could not be found. Either no sensor is connected, the sensor has not yet initialized, or the system is improperly configured.

OUT_OF_MEMORY

  • code: 7
  • Not enough memory/storage for requested operation.

INTERNAL_ERROR

  • code: 8
  • Unexpected error occurred.

SENSOR_DISABLED

  • code: 9
  • Sensor has been disabled or reset and must be reinitialized.

COMPAT_CHECK_FAIL

  • code: 10
  • Compatibility revision check between sensor and ME failed.

SENSOR_EXPECTED_RESET

  • code: 11
  • Indicates sensor went through a reset initiated by the ME.

SENSOR_UNEXPECTED_RESET

  • code: 12
  • Sensor went through an unexpected reset.

RESET_FAILED

  • code: 13
  • Requested sensor reset failed to complete.

TIMEOUT

  • code: 14
  • Operation timed out.

TEST_MODE_FAIL

  • code: 15
  • Test mode pattern did not match expected values.

SENSOR_FAIL_FATAL

  • code: 16
  • Sensor reported fatal error during reset sequence. Further progress is not possible.

SENSOR_FAIL_NONFATAL

  • code: 17
  • Sensor reported non-fatal error during reset sequence, logged the error and will attempt to continue.

INVALID_DEVICE_CAPS

  • code: 18
  • Sensor reported invalid capabilities, such as not supporting required minimum frequency or I/O mode.

QUIESCE_IO_IN_PROGRESS

  • code: 19
  • Command cannot be complete until ongoing Quiesce I/O flow has completed.