ipc_hwinfo

System Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_hwinfo_result
	Dynamic-length array of a_ipc_enum_hwinfo_result. More...
struct	a_ipc_msg_hwinfo_req
	Read hardware related information. More...
struct	a_ipc_msg_hwinfo_rsp
	Hardware information response. More...

Enumerations
enum	a_ipc_enum_hwinfo_result { A_IPC_ENUM_HWINFO_RESULT_OK , A_IPC_ENUM_HWINFO_RESULT_ERROR }
	Hardware versions result codes. More...

Functions
A_IPC_RESULT	a_ipc_init_hwinfo_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_hwinfo_req. More...
A_IPC_RESULT	a_ipc_init_hwinfo_rsp (a_ipc_msg *msg, uint32_t serial_number_maxlength, uint32_t device_uuid_maxlength, uint32_t assembled_unit_maxlength, uint32_t sales_unit_maxlength, uint32_t manufacturing_timestamp_maxlength)
	Initialize the message buffer to contain a_ipc_msg_hwinfo_rsp. More...

Detailed Description

System Service.

This page contains documentation of the System Service API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_hwinfo_result

struct a_ipc_dyn_array_enum_hwinfo_result

Dynamic-length array of a_ipc_enum_hwinfo_result.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_hwinfo_result *	value	The contents of the array.

a_ipc_msg_hwinfo_req

struct a_ipc_msg_hwinfo_req

Read hardware related information.

If successful the response will include various data.

Response is delivered in a_ipc_msg_hwinfo_rsp.

Create using a_ipc_init_hwinfo_req().

Message type is A_IPC_MSG_HWINFO_REQ.

a_ipc_msg_hwinfo_rsp

struct a_ipc_msg_hwinfo_rsp

Hardware information response.

Sent in response to a_ipc_msg_hwinfo_req.

Create using a_ipc_init_hwinfo_rsp().

Message type is A_IPC_MSG_HWINFO_RSP.

Data Fields
a_ipc_dyn_string	assembled_unit	Assembled Unit.
a_ipc_dyn_string	device_uuid	Device UUID.
a_ipc_dyn_string	manufacturing_timestamp	Manufacturing Timestamp (UTC)
a_ipc_enum_hwinfo_result	result	Result of the operation.
a_ipc_dyn_string	sales_unit	Sales Unit.
a_ipc_dyn_string	serial_number	Device Serial Number.

Enumeration Type Documentation

a_ipc_enum_hwinfo_result

enum a_ipc_enum_hwinfo_result

Hardware versions result codes.

Enumerator
A_IPC_ENUM_HWINFO_RESULT_OK	OK.
A_IPC_ENUM_HWINFO_RESULT_ERROR	Error.

Function Documentation

a_ipc_init_hwinfo_req()

A_IPC_RESULT a_ipc_init_hwinfo_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_hwinfo_req.

msg->info.type will be A_IPC_MSG_HWINFO_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_hwinfo_rsp()

A_IPC_RESULT a_ipc_init_hwinfo_rsp	(	a_ipc_msg *	msg,
		uint32_t	serial_number_maxlength,
		uint32_t	device_uuid_maxlength,
		uint32_t	assembled_unit_maxlength,
		uint32_t	sales_unit_maxlength,
		uint32_t	manufacturing_timestamp_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_hwinfo_rsp.

msg->info.type will be A_IPC_MSG_HWINFO_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
serial_number_maxlength	The maximum string length for serial_number in the message.
device_uuid_maxlength	The maximum string length for device_uuid in the message.
assembled_unit_maxlength	The maximum string length for assembled_unit in the message.
sales_unit_maxlength	The maximum string length for sales_unit in the message.
manufacturing_timestamp_maxlength	The maximum string length for manufacturing_timestamp in the message.

Variable Documentation

assembled_unit

a_ipc_dyn_string a_ipc_msg_hwinfo_rsp::assembled_unit

Assembled Unit.

device_uuid

a_ipc_dyn_string a_ipc_msg_hwinfo_rsp::device_uuid

Device UUID.

manufacturing_timestamp

a_ipc_dyn_string a_ipc_msg_hwinfo_rsp::manufacturing_timestamp

Manufacturing Timestamp (UTC)

result

a_ipc_enum_hwinfo_result a_ipc_msg_hwinfo_rsp::result

Result of the operation.

sales_unit

a_ipc_dyn_string a_ipc_msg_hwinfo_rsp::sales_unit

Sales Unit.

serial_number

a_ipc_dyn_string a_ipc_msg_hwinfo_rsp::serial_number

Device Serial Number.