ipc_device_info Struct Reference

Device information sent over IPC. More...

#include </builds/monado/monado/src/xrt/ipc/shared/ipc_protocol.h>

Collaboration diagram for ipc_device_info:

Public Member Functions
	XRT_ALIGNAS (8) uint32_t tracking_origin_id
	Which tracking system origin is this device attached to.

Data Fields
enum xrt_device_name	name
	Enum identifier of the device.
enum xrt_device_type	device_type
uint64_t	xrt_device_id_val
	The service-side xrt_device_id, synchronized to IPC clients so that xrt_device::id matches across all clients connected to the same service.
char	str [XRT_DEVICE_NAME_LEN]
	A string describing the device.
char	serial [XRT_DEVICE_NAME_LEN]
	A unique identifier. Persistent across configurations, if possible.
uint32_t	binding_profile_count
	Number of binding profiles in varlen data.
uint32_t	total_input_pair_count
	Total number of input pairs in varlen data (across all binding profiles).
uint32_t	total_output_pair_count
	Total number of output pairs in varlen data (across all binding profiles).
uint32_t	input_count
	Number of inputs.
uint32_t	output_count
	Number of outputs.
struct xrt_device_supported	supported
	The supported fields.

Detailed Description

Device information sent over IPC.

Followed by varlen data containing:

• An array of input_count * enum xrt_input_name
• An array of output_count * enum xrt_output_name
• An array of binding_profile_count * struct ipc_binding_profile_info
• An array of total_input_pair_count * struct xrt_binding_input_pair
• An array of total_output_pair_count * struct xrt_binding_output_pair

Member Function Documentation

XRT_ALIGNAS()

ipc_device_info::XRT_ALIGNAS

(

8

)

Which tracking system origin is this device attached to.

Field Documentation

binding_profile_count

uint32_t ipc_device_info::binding_profile_count

Number of binding profiles in varlen data.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

input_count

uint32_t ipc_device_info::input_count

Number of inputs.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

name

enum xrt_device_name ipc_device_info::name

Enum identifier of the device.

Referenced by ipcproto.common.Arg::__init__(), ipcproto.common.Call::__init__(), bindings.Profile::__init__(), ipcproto.common.Arg::dump(), ipcproto.common.Call::dump(), ipcproto.common.Arg::get_func_argument_in(), ipcproto.common.Arg::get_func_argument_out(), ipcproto.common.Arg::get_struct_field(), ipc_client_xdev::ipc_client_xdev_init(), ipcproto.common.Call::write_call_decl(), ipcproto.common.Call::write_handler_decl(), ipcproto.common.Call::write_receive_decl(), and ipcproto.common.Call::write_send_decl().

output_count

uint32_t ipc_device_info::output_count

Number of outputs.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

serial

char ipc_device_info::serial[XRT_DEVICE_NAME_LEN]

A unique identifier. Persistent across configurations, if possible.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

str

char ipc_device_info::str[XRT_DEVICE_NAME_LEN]

A string describing the device.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

supported

struct xrt_device_supported ipc_device_info::supported

The supported fields.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

total_input_pair_count

uint32_t ipc_device_info::total_input_pair_count

Total number of input pairs in varlen data (across all binding profiles).

Referenced by ipc_client_xdev::ipc_client_xdev_init().

total_output_pair_count

uint32_t ipc_device_info::total_output_pair_count

Total number of output pairs in varlen data (across all binding profiles).

Referenced by ipc_client_xdev::ipc_client_xdev_init().

xrt_device_id_val

uint64_t ipc_device_info::xrt_device_id_val

The service-side xrt_device_id, synchronized to IPC clients so that xrt_device::id matches across all clients connected to the same service.

This is distinct from the per-client-connection uint32_t slot index used to look up devices in IPC messages.

Referenced by ipc_client_xdev::ipc_client_xdev_init().

---

The documentation for this struct was generated from the following file:

• ipc/shared/ipc_protocol.h