IPC Module - Ethernet Service

This page contains documentation of the Ethernet API.

Messages

message ethernet_request_req

Parameters:

• user (string) – User identifier, max 15 characters long.

• interface (enum ethernet_interface) – The requested interface

Return message:

ethernet_request_rsp

Request a ethernet interface.

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

message ethernet_request_rsp

Parameters:

• result (enum ethernet_result) – Result of the operation

• interface (enum ethernet_interface) – The requested interface

Ethernet interface request result.

message ethernet_release_req

Parameters:

• user (string) – User identifier, max 15 characters long.

• interface (enum ethernet_interface) – The released interface

Return message:

ethernet_release_rsp

Release a ethernet interface.

message ethernet_release_rsp

Parameters:

• result (enum ethernet_result) – Result of the operation

• interface (enum ethernet_interface) – The released interface

Ethernet interface release result.

message ethernet_set_boot_state_req

Parameters:

• interface (enum ethernet_interface) – The ethernet interface

• enable (uint8) – Default state

Return message:

ethernet_set_boot_state_rsp

Set ethernet boot state.

message ethernet_set_boot_state_rsp

Parameters:

result (enum ethernet_result) – Result of the operation

Set ethernet boot state result.

message ethernet_get_boot_state_req

Parameters:

interface (enum ethernet_interface) – The ethernet interface

Return message:

ethernet_get_boot_state_rsp

Get ethernet boot state.

message ethernet_get_boot_state_rsp

Parameters:

• result (enum ethernet_result) – Result of the operation

• enabled (uint8) – Default state

Get ethernet boot state result.

message ethernet_status_req

Parameters:

interface (enum ethernet_interface) – The ethernet interface

Return message:

ethernet_status_rsp

Get ethernet status.

message ethernet_status_rsp

Parameters:

• result (enum ethernet_result) – Result of the operation

• rx_packets (uint64) – RX packets

• rx_errors (uint64) – RX errors

• rx_dropped (uint64) – RX dropped

• rx_over_errors (uint64) – RX ober errors

• rx_frame_errors (uint64) – RX frame errors

• tx_packets (uint64) – TX packets

• tx_errors (uint64) – TX errors

• tx_dropped (uint64) – TX dropped

• tx_over_errors (uint64) – TX over errors

• tx_carrier_errors (uint64) – TX carrier errors

• tx_collisions (uint64) – TX collisions

• state (uint8) – link status, true=up, false=down

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

Enums

enum ethernet_interface

Ethernet interface.

Constant	Value	Description
T1	0	T1
TX	1	TX
NUMBER_OF_INTERFACES	2

enum ethernet_result

Result codes.

Constant	Value	Description
OK	0	No error
INVALID_INTERFACE	1	The specified interface does not exist
UNSUPPORTED_TYPE	2	The specified type is not supported
INTERFACE_NOT_PROCURED	3	The interface was not connected with the supplied user
ERROR_UNKNOWN	4	Unknown error