ipc_ethernet

Ethernet Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_ethernet_interface
	Dynamic-length array of a_ipc_enum_ethernet_interface. More...
struct	a_ipc_dyn_array_enum_ethernet_result
	Dynamic-length array of a_ipc_enum_ethernet_result. More...
struct	a_ipc_msg_ethernet_request_req
	Request a ethernet interface. More...
struct	a_ipc_msg_ethernet_request_rsp
	Ethernet interface request result. More...
struct	a_ipc_msg_ethernet_release_req
	Release a ethernet interface. More...
struct	a_ipc_msg_ethernet_release_rsp
	Ethernet interface release result. More...
struct	a_ipc_msg_ethernet_set_boot_state_req
	Set ethernet boot state. More...
struct	a_ipc_msg_ethernet_set_boot_state_rsp
	Set ethernet boot state result. More...
struct	a_ipc_msg_ethernet_get_boot_state_req
	Get ethernet boot state. More...
struct	a_ipc_msg_ethernet_get_boot_state_rsp
	Get ethernet boot state result. More...
struct	a_ipc_msg_ethernet_status_req
	Get ethernet status. More...
struct	a_ipc_msg_ethernet_status_rsp
	Get ethernet status response. More...

Enumerations
enum	a_ipc_enum_ethernet_interface { A_IPC_ENUM_ETHERNET_INTERFACE_T1 , A_IPC_ENUM_ETHERNET_INTERFACE_TX , A_IPC_ENUM_ETHERNET_INTERFACE_NUMBER_OF_INTERFACES }
	Ethernet interface. More...
enum	a_ipc_enum_ethernet_result {   A_IPC_ENUM_ETHERNET_RESULT_OK , A_IPC_ENUM_ETHERNET_RESULT_INVALID_INTERFACE , A_IPC_ENUM_ETHERNET_RESULT_UNSUPPORTED_TYPE , A_IPC_ENUM_ETHERNET_RESULT_INTERFACE_NOT_PROCURED ,   A_IPC_ENUM_ETHERNET_RESULT_ERROR_UNKNOWN }
	Result codes. More...

Functions
A_IPC_RESULT	a_ipc_init_ethernet_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_ethernet_request_req. More...
A_IPC_RESULT	a_ipc_init_ethernet_request_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_request_rsp. More...
A_IPC_RESULT	a_ipc_init_ethernet_release_req (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_ethernet_release_req. More...
A_IPC_RESULT	a_ipc_init_ethernet_release_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_release_rsp. More...
A_IPC_RESULT	a_ipc_init_ethernet_set_boot_state_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_set_boot_state_req. More...
A_IPC_RESULT	a_ipc_init_ethernet_set_boot_state_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_set_boot_state_rsp. More...
A_IPC_RESULT	a_ipc_init_ethernet_get_boot_state_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_get_boot_state_req. More...
A_IPC_RESULT	a_ipc_init_ethernet_get_boot_state_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_get_boot_state_rsp. More...
A_IPC_RESULT	a_ipc_init_ethernet_status_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_status_req. More...
A_IPC_RESULT	a_ipc_init_ethernet_status_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_ethernet_status_rsp. More...

Detailed Description

Ethernet Service.

This page contains documentation of the Ethernet Service API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_ethernet_interface

struct a_ipc_dyn_array_enum_ethernet_interface

Dynamic-length array of a_ipc_enum_ethernet_interface.

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

a_ipc_dyn_array_enum_ethernet_result

struct a_ipc_dyn_array_enum_ethernet_result

Dynamic-length array of a_ipc_enum_ethernet_result.

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

a_ipc_msg_ethernet_request_req

struct a_ipc_msg_ethernet_request_req

Request a ethernet interface.

The interface will not be turned on if it's not configured.

Response is delivered in a_ipc_msg_ethernet_request_rsp.

Create using a_ipc_init_ethernet_request_req().

Message type is A_IPC_MSG_ETHERNET_REQUEST_REQ.

Data Fields
a_ipc_enum_ethernet_interface	interface	The requested interface.
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_ethernet_request_rsp

struct a_ipc_msg_ethernet_request_rsp

Ethernet interface request result.

Sent in response to a_ipc_msg_ethernet_request_req.

Create using a_ipc_init_ethernet_request_rsp().

Message type is A_IPC_MSG_ETHERNET_REQUEST_RSP.

Data Fields
a_ipc_enum_ethernet_interface	interface	The requested interface.
a_ipc_enum_ethernet_result	result	Result of the operation.

a_ipc_msg_ethernet_release_req

struct a_ipc_msg_ethernet_release_req

Release a ethernet interface.

Response is delivered in a_ipc_msg_ethernet_release_rsp.

Create using a_ipc_init_ethernet_release_req().

Message type is A_IPC_MSG_ETHERNET_RELEASE_REQ.

Data Fields
a_ipc_enum_ethernet_interface	interface	The released interface.
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_ethernet_release_rsp

struct a_ipc_msg_ethernet_release_rsp

Ethernet interface release result.

Sent in response to a_ipc_msg_ethernet_release_req.

Create using a_ipc_init_ethernet_release_rsp().

Message type is A_IPC_MSG_ETHERNET_RELEASE_RSP.

Data Fields
a_ipc_enum_ethernet_interface	interface	The released interface.
a_ipc_enum_ethernet_result	result	Result of the operation.

a_ipc_msg_ethernet_set_boot_state_req

struct a_ipc_msg_ethernet_set_boot_state_req

Set ethernet boot state.

Response is delivered in a_ipc_msg_ethernet_set_boot_state_rsp.

Create using a_ipc_init_ethernet_set_boot_state_req().

Message type is A_IPC_MSG_ETHERNET_SET_BOOT_STATE_REQ.

Data Fields
bool	enable	Default state.
a_ipc_enum_ethernet_interface	interface	The ethernet interface.

a_ipc_msg_ethernet_set_boot_state_rsp

struct a_ipc_msg_ethernet_set_boot_state_rsp

Set ethernet boot state result.

Sent in response to a_ipc_msg_ethernet_set_boot_state_req.

Create using a_ipc_init_ethernet_set_boot_state_rsp().

Message type is A_IPC_MSG_ETHERNET_SET_BOOT_STATE_RSP.

Data Fields
a_ipc_enum_ethernet_result	result	Result of the operation.

a_ipc_msg_ethernet_get_boot_state_req

struct a_ipc_msg_ethernet_get_boot_state_req

Get ethernet boot state.

Response is delivered in a_ipc_msg_ethernet_get_boot_state_rsp.

Create using a_ipc_init_ethernet_get_boot_state_req().

Message type is A_IPC_MSG_ETHERNET_GET_BOOT_STATE_REQ.

Data Fields
a_ipc_enum_ethernet_interface	interface	The ethernet interface.

a_ipc_msg_ethernet_get_boot_state_rsp

struct a_ipc_msg_ethernet_get_boot_state_rsp

Get ethernet boot state result.

Sent in response to a_ipc_msg_ethernet_get_boot_state_req.

Create using a_ipc_init_ethernet_get_boot_state_rsp().

Message type is A_IPC_MSG_ETHERNET_GET_BOOT_STATE_RSP.

Data Fields
bool	enabled	Default state.
a_ipc_enum_ethernet_result	result	Result of the operation.

a_ipc_msg_ethernet_status_req

struct a_ipc_msg_ethernet_status_req

Get ethernet status.

Response is delivered in a_ipc_msg_ethernet_status_rsp.

Create using a_ipc_init_ethernet_status_req().

Message type is A_IPC_MSG_ETHERNET_STATUS_REQ.

Data Fields
a_ipc_enum_ethernet_interface	interface	The ethernet interface.

a_ipc_msg_ethernet_status_rsp

struct a_ipc_msg_ethernet_status_rsp

Get ethernet status response.

See: https://www.kernel.org/doc/html/latest/networking/statistics.html#c.rtnl_link_stats64 for definition of the different counters

Sent in response to a_ipc_msg_ethernet_status_req.

Create using a_ipc_init_ethernet_status_rsp().

Message type is A_IPC_MSG_ETHERNET_STATUS_RSP.

Data Fields
a_ipc_enum_ethernet_result	result	Result of the operation.
uint64_t	rx_dropped	RX dropped *.
uint64_t	rx_errors	RX errors *.
uint64_t	rx_frame_errors	RX frame errors *.
uint64_t	rx_over_errors	RX ober errors *.
uint64_t	rx_packets	RX packets *.
bool	state	link status, true=up, false=down
uint64_t	tx_carrier_errors	TX carrier errors *.
uint64_t	tx_collisions	TX collisions *.
uint64_t	tx_dropped	TX dropped *.
uint64_t	tx_errors	TX errors *.
uint64_t	tx_over_errors	TX over errors *.
uint64_t	tx_packets	TX packets *.

Enumeration Type Documentation

a_ipc_enum_ethernet_interface

enum a_ipc_enum_ethernet_interface

Ethernet interface.

Enumerator
A_IPC_ENUM_ETHERNET_INTERFACE_T1	T1.
A_IPC_ENUM_ETHERNET_INTERFACE_TX	TX.

a_ipc_enum_ethernet_result

enum a_ipc_enum_ethernet_result

Result codes.

Enumerator
A_IPC_ENUM_ETHERNET_RESULT_OK	No error.
A_IPC_ENUM_ETHERNET_RESULT_INVALID_INTERFACE	The specified interface does not exist.
A_IPC_ENUM_ETHERNET_RESULT_UNSUPPORTED_TYPE	The specified type is not supported.
A_IPC_ENUM_ETHERNET_RESULT_INTERFACE_NOT_PROCURED	The interface was not connected with the supplied user.
A_IPC_ENUM_ETHERNET_RESULT_ERROR_UNKNOWN	Unknown error.

Function Documentation

a_ipc_init_ethernet_get_boot_state_req()

A_IPC_RESULT a_ipc_init_ethernet_get_boot_state_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_get_boot_state_req.

msg->info.type will be A_IPC_MSG_ETHERNET_GET_BOOT_STATE_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_ethernet_get_boot_state_rsp()

A_IPC_RESULT a_ipc_init_ethernet_get_boot_state_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_get_boot_state_rsp.

msg->info.type will be A_IPC_MSG_ETHERNET_GET_BOOT_STATE_RSP.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_ethernet_release_req()

A_IPC_RESULT a_ipc_init_ethernet_release_req	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_ethernet_release_req.

msg->info.type will be A_IPC_MSG_ETHERNET_RELEASE_REQ.

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

Parameters

msg	The message buffer to initialize
user_maxlength	The maximum string length for user in the message.

a_ipc_init_ethernet_release_rsp()

A_IPC_RESULT a_ipc_init_ethernet_release_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_release_rsp.

msg->info.type will be A_IPC_MSG_ETHERNET_RELEASE_RSP.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_ethernet_request_req()

A_IPC_RESULT a_ipc_init_ethernet_request_req	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_ethernet_request_req.

msg->info.type will be A_IPC_MSG_ETHERNET_REQUEST_REQ.

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

Parameters

msg	The message buffer to initialize
user_maxlength	The maximum string length for user in the message.

a_ipc_init_ethernet_request_rsp()

A_IPC_RESULT a_ipc_init_ethernet_request_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_request_rsp.

msg->info.type will be A_IPC_MSG_ETHERNET_REQUEST_RSP.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_ethernet_set_boot_state_req()

A_IPC_RESULT a_ipc_init_ethernet_set_boot_state_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_set_boot_state_req.

msg->info.type will be A_IPC_MSG_ETHERNET_SET_BOOT_STATE_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_ethernet_set_boot_state_rsp()

A_IPC_RESULT a_ipc_init_ethernet_set_boot_state_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_set_boot_state_rsp.

msg->info.type will be A_IPC_MSG_ETHERNET_SET_BOOT_STATE_RSP.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_ethernet_status_req()

A_IPC_RESULT a_ipc_init_ethernet_status_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_status_req.

msg->info.type will be A_IPC_MSG_ETHERNET_STATUS_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_ethernet_status_rsp()

A_IPC_RESULT a_ipc_init_ethernet_status_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_ethernet_status_rsp.

msg->info.type will be A_IPC_MSG_ETHERNET_STATUS_RSP.

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

Parameters

msg	The message buffer to initialize

Variable Documentation

enable

bool a_ipc_msg_ethernet_set_boot_state_req::enable

Default state.

enabled

bool a_ipc_msg_ethernet_get_boot_state_rsp::enabled

Default state.

interface [1/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_request_req::interface

The requested interface.

interface [2/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_request_rsp::interface

The requested interface.

interface [3/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_release_req::interface

The released interface.

interface [4/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_release_rsp::interface

The released interface.

interface [5/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_set_boot_state_req::interface

The ethernet interface.

interface [6/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_get_boot_state_req::interface

The ethernet interface.

interface [7/7]

a_ipc_enum_ethernet_interface a_ipc_msg_ethernet_status_req::interface

The ethernet interface.

result [1/5]

a_ipc_enum_ethernet_result a_ipc_msg_ethernet_request_rsp::result

Result of the operation.

result [2/5]

a_ipc_enum_ethernet_result a_ipc_msg_ethernet_release_rsp::result

Result of the operation.

result [3/5]

a_ipc_enum_ethernet_result a_ipc_msg_ethernet_set_boot_state_rsp::result

Result of the operation.

result [4/5]

a_ipc_enum_ethernet_result a_ipc_msg_ethernet_get_boot_state_rsp::result

Result of the operation.

result [5/5]

a_ipc_enum_ethernet_result a_ipc_msg_ethernet_status_rsp::result

Result of the operation.

rx_dropped

uint64_t a_ipc_msg_ethernet_status_rsp::rx_dropped

RX dropped *.

rx_errors

uint64_t a_ipc_msg_ethernet_status_rsp::rx_errors

RX errors *.

rx_frame_errors

uint64_t a_ipc_msg_ethernet_status_rsp::rx_frame_errors

RX frame errors *.

rx_over_errors

uint64_t a_ipc_msg_ethernet_status_rsp::rx_over_errors

RX ober errors *.

rx_packets

uint64_t a_ipc_msg_ethernet_status_rsp::rx_packets

RX packets *.

state

bool a_ipc_msg_ethernet_status_rsp::state

link status, true=up, false=down

tx_carrier_errors

uint64_t a_ipc_msg_ethernet_status_rsp::tx_carrier_errors

TX carrier errors *.

tx_collisions

uint64_t a_ipc_msg_ethernet_status_rsp::tx_collisions

TX collisions *.

tx_dropped

uint64_t a_ipc_msg_ethernet_status_rsp::tx_dropped

TX dropped *.

tx_errors

uint64_t a_ipc_msg_ethernet_status_rsp::tx_errors

TX errors *.

tx_over_errors

uint64_t a_ipc_msg_ethernet_status_rsp::tx_over_errors

TX over errors *.

tx_packets

uint64_t a_ipc_msg_ethernet_status_rsp::tx_packets

TX packets *.

user [1/2]

a_ipc_dyn_string a_ipc_msg_ethernet_request_req::user

User identifier, max 15 characters long.

user [2/2]

a_ipc_dyn_string a_ipc_msg_ethernet_release_req::user

User identifier, max 15 characters long.