Codec for the QMI WDA (Wireless Data Administrative) service.
The WDA service configures the data format used between the modem and the
host driver. On modems whose qmi_wwan driver does not expose
/sys/class/net/<ifname>/qmi/raw_ip, this is the only way to switch the
data path between 802.3 (Ethernet) framing and raw-IP framing.
Summary
Types
Data aggregation protocol.
Result of get_data_format/0 or set_data_format/1.
Link-layer protocol for the data path.
Options for set_data_format/1.
Types
@type aggregation_protocol() :: :disabled | :qmap_v1 | :qmap_v5 | :unknown
Data aggregation protocol.
:disabled– no aggregation:qmap_v1– QMAP version 1:qmap_v5– QMAP version 5
@type data_format() :: %{ optional(:qos_format) => boolean(), optional(:link_layer_protocol) => link_layer_protocol(), optional(:ul_aggregation_protocol) => aggregation_protocol(), optional(:dl_aggregation_protocol) => aggregation_protocol(), optional(:dl_max_datagrams) => non_neg_integer(), optional(:dl_max_size) => non_neg_integer() }
Result of get_data_format/0 or set_data_format/1.
@type link_layer_protocol() :: :raw_ip | :"802.3" | :unknown
Link-layer protocol for the data path.
:raw_ip– raw IP packets (no Ethernet header):"802.3"– Ethernet-framed packets
@type set_data_format_opt() :: {:link_layer_protocol, link_layer_protocol()} | {:ul_aggregation_protocol, aggregation_protocol()} | {:dl_aggregation_protocol, aggregation_protocol()} | {:qos_format, boolean()} | {:endpoint_type, non_neg_integer()} | {:endpoint_iface_number, non_neg_integer()}
Options for set_data_format/1.
:link_layer_protocol–:raw_ipor:"802.3"(required):ul_aggregation_protocol– uplink aggregation (default:disabled):dl_aggregation_protocol– downlink aggregation (default:disabled):qos_format– whether to include QoS headers (defaultfalse):endpoint_type– endpoint device type (default2for HSUSB):endpoint_iface_number– interface number on the endpoint
Functions
@spec get_data_format() :: QMI.request()
Build a request to query the current data format.
@spec set_data_format([set_data_format_opt()]) :: QMI.request()
Build a request to set the data format.
Examples
QMI.Codec.WirelessDataAdmin.set_data_format(link_layer_protocol: :raw_ip)