caif_socket.h File Reference

#include <linux/types.h>
#include <linux/socket.h>

Go to the source code of this file.

Data Structures
struct	sockaddr_caif

Macros
#define	CAIFPROTO_MAX   _CAIFPROTO_MAX

Enumerations
enum	caif_link_selector { CAIF_LINK_HIGH_BANDW, CAIF_LINK_LOW_LATENCY }
enum	caif_channel_priority {   CAIF_PRIO_MIN = 0x01, CAIF_PRIO_LOW = 0x04, CAIF_PRIO_NORMAL = 0x0f, CAIF_PRIO_HIGH = 0x14,   CAIF_PRIO_MAX = 0x1F }
enum	caif_protocol_type {   CAIFPROTO_AT, CAIFPROTO_DATAGRAM, CAIFPROTO_DATAGRAM_LOOP, CAIFPROTO_UTIL,   CAIFPROTO_RFM, CAIFPROTO_DEBUG, _CAIFPROTO_MAX }
enum	caif_at_type { CAIF_ATTYPE_PLAIN = 2 }
enum	caif_debug_type { CAIF_DEBUG_TRACE_INTERACTIVE = 0, CAIF_DEBUG_TRACE, CAIF_DEBUG_INTERACTIVE }
enum	caif_debug_service { CAIF_RADIO_DEBUG_SERVICE = 1, CAIF_APP_DEBUG_SERVICE }
enum	caif_socket_opts { CAIFSO_LINK_SELECT = 127, CAIFSO_REQ_PARAM = 128, CAIFSO_RSP_PARAM = 129 }

Macro Definition Documentation

#define CAIFPROTO_MAX   _CAIFPROTO_MAX

Definition at line 74 of file caif_socket.h.

Enumeration Type Documentation

enum caif_at_type

enum caif_at_type - AT Service Endpoint : Connects to a plain vanilla AT channel.

Enumerator:

CAIF_ATTYPE_PLAIN

Definition at line 80 of file caif_socket.h.

enum caif_channel_priority

enum caif_channel_priority - CAIF channel priorities.

: Min priority for a channel. : Low-priority channel. : Normal/default priority level. : High priority level : Max priority for channel

Priority can be set on CAIF Channels in order to prioritize between traffic on different CAIF Channels. These priority levels are recommended, but the priority value is not restricted to the values defined in this enum, any value between CAIF_PRIO_MIN and CAIF_PRIO_MAX could be used.

Enumerator:

CAIF_PRIO_MIN
CAIF_PRIO_LOW
CAIF_PRIO_NORMAL
CAIF_PRIO_HIGH
CAIF_PRIO_MAX

Definition at line 45 of file caif_socket.h.

enum caif_debug_service

enum caif_debug_service - Debug Service Endpoint : Debug service on the Radio sub-system : Debug for the applications sub-system

Enumerator:

CAIF_RADIO_DEBUG_SERVICE
CAIF_APP_DEBUG_SERVICE

Definition at line 101 of file caif_socket.h.

enum caif_debug_type

enum caif_debug_type - Content selection for debug connection : Connection will contain both trace and interactive debug. : Connection contains trace only. : Connection to interactive debug.

Enumerator:

CAIF_DEBUG_TRACE_INTERACTIVE
CAIF_DEBUG_TRACE
CAIF_DEBUG_INTERACTIVE

Definition at line 90 of file caif_socket.h.

enum caif_link_selector

enum caif_link_selector - Physical Link Selection. : Physical interface for high-bandwidth traffic. : Physical interface for low-latency traffic.

CAIF Link Layers can register their link properties. This enum is used for choosing between CAIF Link Layers when setting up CAIF Channels when multiple CAIF Link Layers exists.

Enumerator:

CAIF_LINK_HIGH_BANDW
CAIF_LINK_LOW_LATENCY

Definition at line 25 of file caif_socket.h.

enum caif_protocol_type

enum caif_protocol_type - CAIF Channel type. : Classic AT channel. : Datagram channel. : Datagram loopback channel, used for testing. : Utility (Psock) channel. : Remote File Manager : Debug link

This enum defines the CAIF Channel type to be used. This defines the service to connect to on the modem.

Enumerator:

CAIFPROTO_AT
CAIFPROTO_DATAGRAM
CAIFPROTO_DATAGRAM_LOOP
CAIFPROTO_UTIL
CAIFPROTO_RFM
CAIFPROTO_DEBUG
_CAIFPROTO_MAX

Definition at line 65 of file caif_socket.h.

enum caif_socket_opts

enum caif_socket_opts - CAIF option values for getsockopt and setsockopt.

: Selector used if multiple CAIF Link layers are available. Either a high bandwidth link can be selected (CAIF_LINK_HIGH_BANDW) or or a low latency link (CAIF_LINK_LOW_LATENCY). This option is of type __u32. Alternatively SO_BINDTODEVICE can be used.

: Used to set the request parameters for a utility channel. (maximum 256 bytes). This option must be set before connecting.

: Gets the response parameters for a utility channel. (maximum 256 bytes). This option is valid after a successful connect.

This enum defines the CAIF Socket options to be used on a socket of type PF_CAIF.

Enumerator:

CAIFSO_LINK_SELECT
CAIFSO_REQ_PARAM
CAIFSO_RSP_PARAM

Definition at line 188 of file caif_socket.h.