OpenOCD
jaylink_device Struct Reference

Opaque structure representing a device. More...

Collaboration diagram for jaylink_device:

Data Fields

struct jaylink_contextctx
 libjaylink context. More...
 
bool has_hw_version
 Indicates whether the hardware version is available. More...
 
bool has_mac_address
 Indicates whether the MAC address is available. More...
 
bool has_nickname
 Indicates whether the nickname is available. More...
 
bool has_product_name
 Indicates whether the product name is available. More...
 
bool has_serial_number
 Indicates whether the serial number is available. More...
 
struct jaylink_hardware_version hw_version
 Hardware version. More...
 
enum jaylink_host_interface iface
 Host interface. More...
 
char ipv4_address [INET_ADDRSTRLEN]
 IPv4 address. More...
 
uint8_t mac_address [JAYLINK_MAC_ADDRESS_LENGTH]
 Media Access Control (MAC) address. More...
 
char nickname [JAYLINK_NICKNAME_MAX_LENGTH]
 Nickname. More...
 
char product_name [JAYLINK_PRODUCT_NAME_MAX_LENGTH]
 Product name. More...
 
size_t ref_count
 Number of references held on this device instance. More...
 
uint32_t serial_number
 Serial number of the device. More...
 

Detailed Description

Opaque structure representing a device.

Definition at line 84 of file libjaylink-internal.h.

Field Documentation

◆ ctx

struct jaylink_context* jaylink_device::ctx

libjaylink context.

Definition at line 86 of file libjaylink-internal.h.

Referenced by _recv(), _send(), adjust_buffer(), device_allocate(), handle_server_hello(), initialize_handle(), jaylink_clear_reset(), jaylink_device_get_usb_bus_ports(), jaylink_emucom_read(), jaylink_emucom_write(), jaylink_file_delete(), jaylink_file_get_size(), jaylink_file_read(), jaylink_file_write(), jaylink_get_available_interfaces(), jaylink_get_caps(), jaylink_get_counters(), jaylink_get_extended_caps(), jaylink_get_firmware_version(), jaylink_get_free_memory(), jaylink_get_hardware_info(), jaylink_get_hardware_status(), jaylink_get_hardware_version(), jaylink_get_selected_interface(), jaylink_get_speeds(), jaylink_jtag_clear_trst(), jaylink_jtag_io(), jaylink_jtag_set_trst(), jaylink_open(), jaylink_read_raw_config(), jaylink_register(), jaylink_select_interface(), jaylink_set_reset(), jaylink_set_speed(), jaylink_set_target_power(), jaylink_swd_io(), jaylink_swo_get_speeds(), jaylink_swo_read(), jaylink_swo_start(), jaylink_swo_stop(), jaylink_unref_device(), jaylink_unregister(), jaylink_write_raw_config(), set_socket_timeouts(), transport_close(), transport_open(), transport_read(), transport_start_read(), transport_start_write(), transport_start_write_read(), transport_tcp_close(), transport_tcp_open(), transport_tcp_read(), transport_tcp_start_read(), transport_tcp_start_write(), transport_tcp_start_write_read(), transport_tcp_write(), transport_usb_close(), transport_usb_open(), transport_usb_read(), transport_usb_start_read(), transport_usb_start_write(), transport_usb_start_write_read(), transport_usb_write(), transport_write(), usb_recv(), and usb_send().

◆ has_hw_version

bool jaylink_device::has_hw_version

Indicates whether the hardware version is available.

Definition at line 150 of file libjaylink-internal.h.

Referenced by jaylink_device_get_hardware_version(), parse_adv_message(), and probe_device().

◆ has_mac_address

bool jaylink_device::has_mac_address

Indicates whether the MAC address is available.

Definition at line 123 of file libjaylink-internal.h.

Referenced by jaylink_device_get_mac_address(), parse_adv_message(), and probe_device().

◆ has_nickname

bool jaylink_device::has_nickname

Indicates whether the nickname is available.

Definition at line 141 of file libjaylink-internal.h.

Referenced by jaylink_device_get_nickname(), parse_adv_message(), and probe_device().

◆ has_product_name

bool jaylink_device::has_product_name

Indicates whether the product name is available.

Definition at line 132 of file libjaylink-internal.h.

Referenced by jaylink_device_get_product_name(), parse_adv_message(), and probe_device().

◆ has_serial_number

bool jaylink_device::has_serial_number

Indicates whether the serial number is available.

Definition at line 99 of file libjaylink-internal.h.

Referenced by jaylink_device_get_serial_number(), parse_adv_message(), and probe_device().

◆ hw_version

struct jaylink_hardware_version jaylink_device::hw_version

Hardware version.

This field is used for devices with host interface JAYLINK_HIF_TCP only.

Definition at line 148 of file libjaylink-internal.h.

Referenced by compare_devices(), jaylink_device_get_hardware_version(), parse_adv_message(), and probe_device().

◆ iface

◆ ipv4_address

char jaylink_device::ipv4_address[INET_ADDRSTRLEN]

IPv4 address.

The address is encoded as string in quad-dotted decimal format.

This field is used for devices with host interface JAYLINK_HIF_TCP only.

Definition at line 114 of file libjaylink-internal.h.

Referenced by compare_devices(), jaylink_device_get_ipv4_address(), jaylink_unref_device(), parse_adv_message(), probe_device(), transport_tcp_close(), and transport_tcp_open().

◆ mac_address

uint8_t jaylink_device::mac_address[JAYLINK_MAC_ADDRESS_LENGTH]

Media Access Control (MAC) address.

This field is used for devices with host interface JAYLINK_HIF_TCP only.

Definition at line 121 of file libjaylink-internal.h.

Referenced by compare_devices(), jaylink_device_get_mac_address(), parse_adv_message(), and probe_device().

◆ nickname

char jaylink_device::nickname[JAYLINK_NICKNAME_MAX_LENGTH]

Nickname.

This field is used for devices with host interface JAYLINK_HIF_TCP only.

Definition at line 139 of file libjaylink-internal.h.

Referenced by compare_devices(), jaylink_device_get_nickname(), parse_adv_message(), and probe_device().

◆ product_name

char jaylink_device::product_name[JAYLINK_PRODUCT_NAME_MAX_LENGTH]

Product name.

This field is used for devices with host interface JAYLINK_HIF_TCP only.

Definition at line 130 of file libjaylink-internal.h.

Referenced by compare_devices(), jaylink_device_get_product_name(), parse_adv_message(), and probe_device().

◆ ref_count

size_t jaylink_device::ref_count

Number of references held on this device instance.

Definition at line 88 of file libjaylink-internal.h.

Referenced by device_allocate(), jaylink_ref_device(), and jaylink_unref_device().

◆ serial_number

uint32_t jaylink_device::serial_number

Serial number of the device.

This number is for enumeration purpose only and can differ from the real serial number of the device.

Definition at line 97 of file libjaylink-internal.h.

Referenced by compare_devices(), jaylink_device_get_serial_number(), parse_adv_message(), and probe_device().


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