interfaces/modemServices/c/le_mdm_defs.h File Reference

#include "legato.h"

Go to the source code of this file.

Defines
#define	LE_MRC_MCC_LEN   3
#define	LE_MRC_MCC_BYTES   (LE_MRC_MCC_LEN+1)
#define	LE_MRC_MNC_LEN   3
#define	LE_MRC_MNC_BYTES   (LE_MRC_MNC_LEN+1)
#define	LE_TEL_NMBR_MAX_LEN   (15+2+1)
#define	LE_SMS_TEL_NMBR_MAX_LEN   LE_TEL_NMBR_MAX_LEN
#define	LE_SMS_TIMESTAMP_MAX_LEN   (20+1)
#define	LE_SMS_TEXT_MAX_LEN   (160+1)
#define	LE_SMS_BINARY_MAX_LEN   (140)
#define	LE_SMS_PDU_MAX_LEN   (36+140)
Enumerations
enum	le_sim_States_t {   LE_SIM_INSERTED = 0, LE_SIM_ABSENT = 1, LE_SIM_READY = 2, LE_SIM_BLOCKED = 3,   LE_SIM_BUSY = 4, LE_SIM_STATE_UNKNOWN = 5 }
enum	le_mrc_NetRegState_t {   LE_MRC_REG_NONE = 0, LE_MRC_REG_HOME = 1, LE_MRC_REG_SEARCHING = 2, LE_MRC_REG_DENIED = 3,   LE_MRC_REG_ROAMING = 5, LE_MRC_REG_UNKNOWN = 4 }
enum	le_mrc_Rat_t {   LE_MRC_RAT_UNKNOWN = 0, LE_MRC_RAT_GSM = 1<<0, LE_MRC_RAT_UTMS = 1<<1, LE_MRC_RAT_LTE = 1<<2,   LE_MRC_RAT_TC_SCDMA = 1<<3, LE_MRC_RAT_ALL }
enum	le_mcc_call_Event_t {   LE_MCC_EVENT_INCOMING, LE_MCC_EVENT_ALERTING, LE_MCC_EVENT_EARLY_MEDIA, LE_MCC_EVENT_CONNECTED,   LE_MCC_EVENT_TERMINATED, LE_MCC_EVENT_ON_HOLD, LE_MCC_EVENT_TRANSFERED }
enum	le_mcc_call_TerminationReason_t {   LE_MCC_TERM_NETWORK_FAIL, LE_MCC_TERM_BAD_ADDRESS, LE_MCC_TERM_BUSY, LE_MCC_TERM_LOCAL_ENDED,   LE_MCC_TERM_REMOTE_ENDED, LE_MCC_TERM_NOT_DEFINED }
enum	le_mdc_dataBearerTechnology_t {   LE_MDC_DATA_BEARER_TECHNOLOGY_UNKNOWN = 0, LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_1X, LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_HRPD, LE_MDC_DATA_BEARER_TECHNOLOGY_GSM,   LE_MDC_DATA_BEARER_TECHNOLOGY_UMTS, LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA200_HRPD, LE_MDC_DATA_BEARER_TECHNOLOGY_EDGE, LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPA_WCDMA,   LE_MDC_DATA_BEARER_TECHNOLOGY_WCDMA_HSUPA, LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPA_HSUPA, LE_MDC_DATA_BEARER_TECHNOLOGY_LTE, LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_EHRPD,   LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_WCDMA, LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_HSUPA, LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSDPAPLUS_WCDMA, LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSDPAPLUS_HSUPA,   LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_64QAM, LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_64QAM_HSUPA, LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA, LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA_HSDPA,   LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA_HSUPA }
enum	le_sms_msg_Format_t { LE_SMS_FORMAT_PDU = 0, LE_SMS_FORMAT_TEXT = 1, LE_SMS_FORMAT_BINARY = 2, LE_SMS_FORMAT_UNKNOWN = 3 }
enum	le_sms_msg_Status_t {   LE_SMS_RX_READ = 0, LE_SMS_RX_UNREAD = 1, LE_SMS_STORED_SENT = 2, LE_SMS_STORED_UNSENT = 3,   LE_SMS_SENT = 4, LE_SMS_UNSENT = 5, LE_SMS_STATUS_UNKNOWN = 6 }

---

Detailed Description

Copyright (C) Sierra Wireless, Inc. 2013. All rights reserved. Use of this work is subject to license.

---

Define Documentation

#define LE_SMS_BINARY_MAX_LEN   (140)

The raw binary message can be up to 140 bytes long.

#define LE_SMS_PDU_MAX_LEN   (36+140)

The PDU message can be up to 36 (header) + 140 (payload) bytes long.

#define LE_SMS_TEL_NMBR_MAX_LEN   LE_TEL_NMBR_MAX_LEN

Cf. ITU-T recommendations E.164/E.163. E.164 numbers can have a maximum of 15 digits and are usually written with a ‘+’ prefix. One extra byte is added for the null character.

#define LE_SMS_TEXT_MAX_LEN   (160+1)

The text message can be up to 160 characters long. One extra byte is added for the null character.

#define LE_SMS_TIMESTAMP_MAX_LEN   (20+1)

Time stamp string length. The string format is "yy/MM/dd,hh:mm:ss+/-zz" (Year/Month/Day,Hour:Min:Seconds+/-TimeZone). One extra byte is added for the null character.

#define LE_TEL_NMBR_MAX_LEN   (15+2+1)

Cf. ITU-T recommendations E.164/E.163. E.164 numbers can have a maximum of 15 digits except the international prefix (‘+’ or '00'). One extra byte is added for the null character.

---

Enumeration Type Documentation

enum le_mcc_call_Event_t

Enumeration of the possible events that may be reported to a call event handler.

Enumerator:

LE_MCC_EVENT_INCOMING	Incoming call attempt (new call).
LE_MCC_EVENT_ALERTING	Far end is now alerting its user (outgoing call).
LE_MCC_EVENT_EARLY_MEDIA	Callee has not accepted the call, but a media stream is available.
LE_MCC_EVENT_CONNECTED	Call has been established, and is media is active.
LE_MCC_EVENT_TERMINATED	Call has terminated.
LE_MCC_EVENT_ON_HOLD	Remote party has put the call on hold.
LE_MCC_EVENT_TRANSFERED	Remote party transferred or forwarded the call.

enum le_mcc_call_TerminationReason_t

Enumeration of the possible reasons for call termination.

Enumerator:

LE_MCC_TERM_NETWORK_FAIL	Network could not complete the call.
LE_MCC_TERM_BAD_ADDRESS	Remote address could not be resolved.
LE_MCC_TERM_BUSY	Callee is currently busy and cannot take the call.
LE_MCC_TERM_LOCAL_ENDED	Local party ended the call.
LE_MCC_TERM_REMOTE_ENDED	Remote party ended the call.
LE_MCC_TERM_NOT_DEFINED	Undefined reason.

enum le_mdc_dataBearerTechnology_t

Enumeration to convey Data Bearer Technology.

Enumerator:

LE_MDC_DATA_BEARER_TECHNOLOGY_UNKNOWN	Unknown.
LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_1X	cdma2000 1X
LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_HRPD	cdma2000 HRPD (1xEV-DO)
LE_MDC_DATA_BEARER_TECHNOLOGY_GSM	GSM.
LE_MDC_DATA_BEARER_TECHNOLOGY_UMTS	UMTS.
LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA200_HRPD	cdma200 HRPD (1xEV-DO RevA)
LE_MDC_DATA_BEARER_TECHNOLOGY_EDGE	EDGE.
LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPA_WCDMA	HSDPA and WCDMA.
LE_MDC_DATA_BEARER_TECHNOLOGY_WCDMA_HSUPA	WCDMA and HSUPA.
LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPA_HSUPA	HSDPA and HSUPA.
LE_MDC_DATA_BEARER_TECHNOLOGY_LTE	LTE.
LE_MDC_DATA_BEARER_TECHNOLOGY_CDMA2000_EHRPD	cdma2000 EHRPD
LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_WCDMA	HSDPA+ and WCDMA.
LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_HSUPA	HSDPA+ and HSUPA.
LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSDPAPLUS_WCDMA	DC_HSDPA+ and WCDMA.
LE_MDC_DATA_BEARER_TECHNOLOGY_DC_HSDPAPLUS_HSUPA	DC_HSDPA+ and HSUPA.
LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_64QAM	HSDPA+ and 64QAM.
LE_MDC_DATA_BEARER_TECHNOLOGY_HSDPAPLUS_64QAM_HSUPA	HSDPA+, 64QAM and HSUPA.
LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA	TDSCDMA.
LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA_HSDPA	TDSCDMA and HSDPA.
LE_MDC_DATA_BEARER_TECHNOLOGY_TDSCDMA_HSUPA	TDSCDMA and HSUPA.

enum le_mrc_NetRegState_t

Network Registration states.

Enumerator:

LE_MRC_REG_NONE	Not registered and not currently searching for new operator.
LE_MRC_REG_HOME	Registered, home network.
LE_MRC_REG_SEARCHING	Not registered but currently searching for a new operator.
LE_MRC_REG_DENIED	Registration was denied, usually because of invalid access credentials.
LE_MRC_REG_ROAMING	Registered to a roaming network.
LE_MRC_REG_UNKNOWN	Unknown state.

enum le_mrc_Rat_t

Radio Access Technology

Enumerator:

LE_MRC_RAT_UNKNOWN	Unknown.
LE_MRC_RAT_GSM	GSM network.
LE_MRC_RAT_UTMS	UTMS network.
LE_MRC_RAT_LTE	LTE network.
LE_MRC_RAT_TC_SCDMA	TC SCDMA network.
LE_MRC_RAT_ALL	All technology.

enum le_sim_States_t

SIM states.

Enumerator:

LE_SIM_INSERTED	SIM card is inserted and locked.
LE_SIM_ABSENT	SIM card is absent.
LE_SIM_READY	SIM card is inserted and unlocked.
LE_SIM_BLOCKED	SIM card is blocked.
LE_SIM_BUSY	SIM card is busy.
LE_SIM_STATE_UNKNOWN	Unknown SIM state.

enum le_sms_msg_Format_t

Message Format.

Enumerator:

LE_SMS_FORMAT_PDU	PDU message format.
LE_SMS_FORMAT_TEXT	Text message format.
LE_SMS_FORMAT_BINARY	Binary message format.
LE_SMS_FORMAT_UNKNOWN	Unknown message format.

enum le_sms_msg_Status_t

Message Status.

Enumerator:

LE_SMS_RX_READ	Message present in the message storage has been read.
LE_SMS_RX_UNREAD	Message present in the message storage has not been read.
LE_SMS_STORED_SENT	Message saved in the message storage has been sent.
LE_SMS_STORED_UNSENT	Message saved in the message storage has not been sent.
LE_SMS_SENT	Message has been sent.
LE_SMS_UNSENT	Message has not been sent.
LE_SMS_STATUS_UNKNOWN	Unknown message status.