FreeRTOS: FreeRTOS Cellular Library v1.4.0
FreeRTOS Cellular Library
 
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Cellular Enumerated types

Enumerated types of the cellular library. More...

Enumerations

enum  CellularError_t {
  CELLULAR_SUCCESS = 0 , CELLULAR_INVALID_HANDLE , CELLULAR_MODEM_NOT_READY , CELLULAR_LIBRARY_NOT_OPEN ,
  CELLULAR_LIBRARY_ALREADY_OPEN , CELLULAR_BAD_PARAMETER , CELLULAR_NO_MEMORY , CELLULAR_TIMEOUT ,
  CELLULAR_SOCKET_CLOSED , CELLULAR_SOCKET_NOT_CONNECTED , CELLULAR_INTERNAL_FAILURE , CELLULAR_RESOURCE_CREATION_FAIL ,
  CELLULAR_UNSUPPORTED , CELLULAR_NOT_ALLOWED , CELLULAR_UNKNOWN
}
 Status code returns from APIs. More...
 
enum  CellularRat_t {
  CELLULAR_RAT_GSM = 0 , CELLULAR_RAT_WCDMA = 2 , CELLULAR_RAT_EDGE = 3 , CELLULAR_RAT_HSDPA = 4 ,
  CELLULAR_RAT_HSUPA = 5 , CELLULAR_RAT_HSDPAHSUPA = 6 , CELLULAR_RAT_LTE = 7 , CELLULAR_RAT_CATM1 = 8 ,
  CELLULAR_RAT_NBIOT = 9 , CELLULAR_RAT_MAX , CELLULAR_RAT_INVALID = 0xFF
}
 Enums representing Radio Access Technologies (RATs). Reference 3GPP TS 27.007 PLMN selection +COPS. More...
 
enum  CellularSimCardState_t { CELLULAR_SIM_CARD_REMOVED = 0 , CELLULAR_SIM_CARD_INSERTED , CELLULAR_SIM_CARD_STATUS_MAX , CELLULAR_SIM_CARD_UNKNOWN }
 SIM card state codes. More...
 
enum  CellularSimCardLockState_t {
  CELLULAR_SIM_CARD_READY = 0 , CELLULAR_SIM_CARD_PIN , CELLULAR_SIM_CARD_PUK , CELLULAR_SIM_CARD_PIN2 ,
  CELLULAR_SIM_CARD_PUK2 , CELLULAR_SIM_CARD_PH_NET_PIN , CELLULAR_SIM_CARD_PH_NET_PUK , CELLULAR_SIM_CARD_PH_NETSUB_PIN ,
  CELLULAR_SIM_CARD_PH_NETSUB_PUK , CELLULAR_SIM_CARD_SP_PIN , CELLULAR_SIM_CARD_SP_PUK , CELLULAR_SIM_CARD_CORP_PIN ,
  CELLULAR_SIM_CARD_CORP_PUK , CELLULAR_SIM_CARD_IMSI_PIN , CELLULAR_SIM_CARD_IMSI_PUK , CELLULAR_SIM_CARD_INVALID ,
  CELLULAR_SIM_CARD_LOCK_UNKNOWN
}
 SIM card lock state codes. Reference 3GPP TS 27.007 Enter PIN +CPIN. More...
 
enum  CellularNetworkRegistrationMode_t {
  REGISTRATION_MODE_AUTO = 0 , REGISTRATION_MODE_MANUAL = 1 , REGISTRATION_MODE_DEREGISTER = 2 , REGISTRATION_MODE_MANUAL_THEN_AUTO = 4 ,
  REGISTRATION_MODE_MAX , REGISTRATION_MODE_UNKNOWN
}
 Represents network registration mode. Reference 3GPP TS 27.007 PLMN selection +COPS. More...
 
enum  CellularNetworkRegistrationStatus_t {
  REGISTRATION_STATUS_NO_REGISTERED_SEARCHING = 0 , REGISTRATION_STATUS_REGISTERED_HOME = 1 , REGISTRATION_STATUS_NOT_REGISTERED_SEARCHING = 2 , REGISTRATION_STATUS_REGISTRATION_DENIED = 3 ,
  REGISTRATION_STATUS_UNKNOWN = 4 , REGISTRATION_STATUS_ROAMING_REGISTERED = 5 , REGISTRATION_STATUS_HOME_SMS_ONLY_REGISTERED = 6 , REGISTRATION_STATUS_SMS_ONLY_ROAMING_REGISTERED = 7 ,
  REGISTRATION_STATUS_ATTACHED_EMERG_SERVICES_ONLY = 8 , REGISTRATION_STATUS_MAX
}
 Represents network registration status. Reference 3GPP TS 27.007 network registration status. More...
 
enum  CellularOperatorNameFormat_t {
  OPERATOR_NAME_FORMAT_LONG = 0 , OPERATOR_NAME_FORMAT_SHORT = 1 , OPERATOR_NAME_FORMAT_NUMERIC = 2 , OPERATOR_NAME_FORMAT_NOT_PRESENT = 9 ,
  OPERATOR_NAME_FORMAT_MAX
}
 Represents operator name format. More...
 
enum  CellularUrcEvent_t {
  CELLULAR_URC_EVENT_NETWORK_CS_REGISTRATION , CELLULAR_URC_EVENT_NETWORK_PS_REGISTRATION , CELLULAR_URC_EVENT_PDN_ACTIVATED , CELLULAR_URC_EVENT_PDN_DEACTIVATED ,
  CELLULAR_URC_EVENT_SIGNAL_CHANGED , CELLULAR_URC_SOCKET_OPENED , CELLULAR_URC_SOCKET_OPEN_FAILED , CELLULAR_URC_EVENT_OTHER
}
 Represents URC events. More...
 
enum  CellularModemEvent_t { CELLULAR_MODEM_EVENT_BOOTUP_OR_REBOOT , CELLULAR_MODEM_EVENT_POWERED_DOWN , CELLULAR_MODEM_EVENT_PSM_ENTER }
 Represents Modem events. More...
 
enum  CellularPdnContextType_t { CELLULAR_PDN_CONTEXT_IPV4 = 1 , CELLULAR_PDN_CONTEXT_IPV6 = 2 , CELLULAR_PDN_CONTEXT_IPV4V6 = 3 , CELLULAR_PDN_CONTEXT_TYPE_MAX }
 Represents PDN context type. More...
 
enum  CellularPdnAuthType_t { CELLULAR_PDN_AUTH_NONE = 0 , CELLULAR_PDN_AUTH_PAP , CELLULAR_PDN_AUTH_CHAP , CELLULAR_PDN_AUTH_PAP_OR_CHAP }
 Represents PDN authentication type. More...
 
enum  CellularSocketDomain_t { CELLULAR_SOCKET_DOMAIN_AF_INET , CELLULAR_SOCKET_DOMAIN_AF_INET6 }
 Represents socket domain. More...
 
enum  CellularSocketType_t { CELLULAR_SOCKET_TYPE_DGRAM , CELLULAR_SOCKET_TYPE_STREAM }
 Represents socket type. More...
 
enum  CellularSocketProtocol_t { CELLULAR_SOCKET_PROTOCOL_UDP , CELLULAR_SOCKET_PROTOCOL_TCP }
 Represents socket protocol.
 
enum  CellularSocketAccessMode_t { CELLULAR_ACCESSMODE_BUFFER = 0 , CELLULAR_ACCESSMODE_DIRECT_PUSH , CELLULAR_ACCESSMODE_TRANSPARENT , CELLULAR_ACCESSMODE_NOT_SET }
 Represents data access modes.
 
enum  CellularIPAddressType_t { CELLULAR_IP_ADDRESS_V4 , CELLULAR_IP_ADDRESS_V6 }
 Represents IP address. More...
 
enum  CellularSocketOptionLevel_t { CELLULAR_SOCKET_OPTION_LEVEL_IP , CELLULAR_SOCKET_OPTION_LEVEL_TRANSPORT }
 Represents socket option level. More...
 
enum  CellularSocketOption_t {
  CELLULAR_SOCKET_OPTION_MAX_IP_PACKET_SIZE , CELLULAR_SOCKET_OPTION_SEND_TIMEOUT , CELLULAR_SOCKET_OPTION_RECV_TIMEOUT , CELLULAR_SOCKET_OPTION_PDN_CONTEXT_ID ,
  CELLULAR_SOCKET_OPTION_SET_LOCAL_PORT
}
 Socket option names. More...
 
enum  CellularPktStatus_t {
  CELLULAR_PKT_STATUS_OK = 0 , CELLULAR_PKT_STATUS_TIMED_OUT , CELLULAR_PKT_STATUS_FAILURE , CELLULAR_PKT_STATUS_BAD_REQUEST ,
  CELLULAR_PKT_STATUS_BAD_RESPONSE , CELLULAR_PKT_STATUS_SIZE_MISMATCH , CELLULAR_PKT_STATUS_BAD_PARAM , CELLULAR_PKT_STATUS_SEND_ERROR ,
  CELLULAR_PKT_STATUS_INVALID_HANDLE , CELLULAR_PKT_STATUS_CREATION_FAIL , CELLULAR_PKT_STATUS_PREFIX_MISMATCH , CELLULAR_PKT_STATUS_INVALID_DATA ,
  CELLULAR_PKT_STATUS_PENDING_DATA , CELLULAR_PKT_STATUS_PENDING_BUFFER
}
 packet Status Names.
 
enum  CellularATCommandType_t {
  CELLULAR_AT_NO_RESULT , CELLULAR_AT_WO_PREFIX , CELLULAR_AT_WITH_PREFIX , CELLULAR_AT_MULTI_WITH_PREFIX ,
  CELLULAR_AT_MULTI_WO_PREFIX , CELLULAR_AT_MULTI_DATA_WO_PREFIX , CELLULAR_AT_WO_PREFIX_NO_RESULT_CODE , CELLULAR_AT_WITH_PREFIX_NO_RESULT_CODE ,
  CELLULAR_AT_NO_COMMAND
}
 Represents AT Command type. More...
 
enum  CellularNetworkRegType_t {
  CELLULAR_REG_TYPE_CREG = 0 , CELLULAR_REG_TYPE_CGREG , CELLULAR_REG_TYPE_CEREG , CELLULAR_REG_TYPE_MAX ,
  CELLULAR_REG_TYPE_UNKNOWN
}
 Cellular network register URC type. More...
 

Detailed Description

Enumerated types of the cellular library.

Enumeration Type Documentation

◆ CellularError_t

Status code returns from APIs.

Enumerator
CELLULAR_SUCCESS 

The operation was successful.

CELLULAR_INVALID_HANDLE 

Invalid handle.

CELLULAR_MODEM_NOT_READY 

The modem is not ready yet.

CELLULAR_LIBRARY_NOT_OPEN 

The cellular library is not open yet.

CELLULAR_LIBRARY_ALREADY_OPEN 

The cellular library is already open.

CELLULAR_BAD_PARAMETER 

One or more of the input parameters is not valid.

CELLULAR_NO_MEMORY 

Memory allocation failure.

CELLULAR_TIMEOUT 

The operation timed out.

CELLULAR_SOCKET_CLOSED 

The supplied socket is already closed.

CELLULAR_SOCKET_NOT_CONNECTED 

The supplied socket is not connected.

CELLULAR_INTERNAL_FAILURE 

The Cellular library internal failure.

CELLULAR_RESOURCE_CREATION_FAIL 

Resource creation for Cellular library failed.

CELLULAR_UNSUPPORTED 

The operation is not supported.

CELLULAR_NOT_ALLOWED 

The operation is not allowed.

CELLULAR_UNKNOWN 

Any other error other than the above mentioned ones.

◆ CellularRat_t

Enums representing Radio Access Technologies (RATs). Reference 3GPP TS 27.007 PLMN selection +COPS.

Enumerator
CELLULAR_RAT_GSM 

The GSM RATs network.

CELLULAR_RAT_WCDMA 

The WCDMA RATs network.

CELLULAR_RAT_EDGE 

The EDGE RATs network.

CELLULAR_RAT_HSDPA 

The HSDPA RATs network.

CELLULAR_RAT_HSUPA 

The HSUPA RATs network.

CELLULAR_RAT_HSDPAHSUPA 

The HSDPAHSUPA RATs network.

CELLULAR_RAT_LTE 

The LTE RATs network.

CELLULAR_RAT_CATM1 

The CAT M1 RATs network.

CELLULAR_RAT_NBIOT 

The NBIOT RATs network.

CELLULAR_RAT_MAX 

The max supported number for RATs network.

CELLULAR_RAT_INVALID 

Any other error other than the above mentioned ones.

◆ CellularSimCardState_t

SIM card state codes.

Enumerator
CELLULAR_SIM_CARD_REMOVED 

The state stands for cellular sim card removed.

CELLULAR_SIM_CARD_INSERTED 

The state stands for cellular sim card inserted.

CELLULAR_SIM_CARD_STATUS_MAX 

The number of supported sim card status.

CELLULAR_SIM_CARD_UNKNOWN 

The state stands for unknown cellular sim card.

◆ CellularSimCardLockState_t

SIM card lock state codes. Reference 3GPP TS 27.007 Enter PIN +CPIN.

Enumerator
CELLULAR_SIM_CARD_READY 

The cellular sim card in a lock state of ready.

CELLULAR_SIM_CARD_PIN 

The cellular sim card in a lock state of pin(personal identification number).

CELLULAR_SIM_CARD_PUK 

The cellular sim card in a lock state of puk(personal unlocking key).

CELLULAR_SIM_CARD_PIN2 

The cellular sim card in a lock state of pin2.

CELLULAR_SIM_CARD_PUK2 

The cellular sim card in a lock state of puk2.

CELLULAR_SIM_CARD_PH_NET_PIN 

The cellular sim card in a lock state of ph-net pin.

CELLULAR_SIM_CARD_PH_NET_PUK 

The cellular sim card in a lock state of ph-net puk.

CELLULAR_SIM_CARD_PH_NETSUB_PIN 

The cellular sim card in a lock state of ph-netsub pin.

CELLULAR_SIM_CARD_PH_NETSUB_PUK 

The cellular sim card in a lock state of ph-netsub puk.

CELLULAR_SIM_CARD_SP_PIN 

The cellular sim card in a lock state of ph-sp pin.

CELLULAR_SIM_CARD_SP_PUK 

The cellular sim card in a lock state of ph-sp puk.

CELLULAR_SIM_CARD_CORP_PIN 

The cellular sim card in a lock state of ph-corp pin.

CELLULAR_SIM_CARD_CORP_PUK 

The cellular sim card in a lock state of ph-sp puk.

CELLULAR_SIM_CARD_IMSI_PIN 

The cellular sim card in a lock state of imsi pin.

CELLULAR_SIM_CARD_IMSI_PUK 

The cellular sim card in a lock state of imsi puk.

CELLULAR_SIM_CARD_INVALID 

The cellular sim card in a lock state of invalid.

CELLULAR_SIM_CARD_LOCK_UNKNOWN 

The cellular sim card in a lock state of unknown.

◆ CellularNetworkRegistrationMode_t

Represents network registration mode. Reference 3GPP TS 27.007 PLMN selection +COPS.

Enumerator
REGISTRATION_MODE_AUTO 

Auto network registration mode.

REGISTRATION_MODE_MANUAL 

Manual network registration mode.

REGISTRATION_MODE_DEREGISTER 

Deregister network registration mode.

REGISTRATION_MODE_MANUAL_THEN_AUTO 

Manual then auto network registration mode.

REGISTRATION_MODE_MAX 

The number of supported registration mode.

REGISTRATION_MODE_UNKNOWN 

Unknown network registration mode.

◆ CellularNetworkRegistrationStatus_t

Represents network registration status. Reference 3GPP TS 27.007 network registration status.

Enumerator
REGISTRATION_STATUS_NO_REGISTERED_SEARCHING 

No registered searching network registration status.

REGISTRATION_STATUS_REGISTERED_HOME 

Registered home network registration status.

REGISTRATION_STATUS_NOT_REGISTERED_SEARCHING 

Not registered searching network registration status.

REGISTRATION_STATUS_REGISTRATION_DENIED 

Registration denied network registration status.

REGISTRATION_STATUS_UNKNOWN 

Unknown network registration status.

REGISTRATION_STATUS_ROAMING_REGISTERED 

Roaming registered network registration status.

REGISTRATION_STATUS_HOME_SMS_ONLY_REGISTERED 

Home SMS only registered network registration status.

REGISTRATION_STATUS_SMS_ONLY_ROAMING_REGISTERED 

SMS only roaming registered network registration status.

REGISTRATION_STATUS_ATTACHED_EMERG_SERVICES_ONLY 

Attached emergency service only network registration status.

REGISTRATION_STATUS_MAX 

The max supported number for registration status.

◆ CellularOperatorNameFormat_t

Represents operator name format.

Enumerator
OPERATOR_NAME_FORMAT_LONG 

Long operator name format.

OPERATOR_NAME_FORMAT_SHORT 

Short operator name format.

OPERATOR_NAME_FORMAT_NUMERIC 

Numeric operator name format.

OPERATOR_NAME_FORMAT_NOT_PRESENT 

Not present operator name format.

OPERATOR_NAME_FORMAT_MAX 

The max supported number for operator name format.

◆ CellularUrcEvent_t

Represents URC events.

Enumerator
CELLULAR_URC_EVENT_NETWORK_CS_REGISTRATION 

Network CS registration URC event.

CELLULAR_URC_EVENT_NETWORK_PS_REGISTRATION 

Network PS registration URC event.

CELLULAR_URC_EVENT_PDN_ACTIVATED 

PDN activated registration URC event.

CELLULAR_URC_EVENT_PDN_DEACTIVATED 

PDN deactivated registration URC event.

CELLULAR_URC_EVENT_SIGNAL_CHANGED 

Signal changed registration URC event.

CELLULAR_URC_SOCKET_OPENED 

Socket opened registration URC event.

CELLULAR_URC_SOCKET_OPEN_FAILED 

Socket open failed registration URC event.

CELLULAR_URC_EVENT_OTHER 

Any URC event other than above.

◆ CellularModemEvent_t

Represents Modem events.

Enumerator
CELLULAR_MODEM_EVENT_BOOTUP_OR_REBOOT 

Bootup or reboot modem event.

CELLULAR_MODEM_EVENT_POWERED_DOWN 

Power down modem event.

CELLULAR_MODEM_EVENT_PSM_ENTER 

PSM enter modem event.

◆ CellularPdnContextType_t

Represents PDN context type.

Enumerator
CELLULAR_PDN_CONTEXT_IPV4 

IPV4 PDN CONTEXT.

CELLULAR_PDN_CONTEXT_IPV6 

IPV6 PDN CONTEXT.

CELLULAR_PDN_CONTEXT_IPV4V6 

IPV4V6 PDN CONTEXT.

CELLULAR_PDN_CONTEXT_TYPE_MAX 

The max number of supported PDN CONTEXT.

◆ CellularPdnAuthType_t

Represents PDN authentication type.

Enumerator
CELLULAR_PDN_AUTH_NONE 

No authentication.

CELLULAR_PDN_AUTH_PAP 

Password Authentication Protocol (PAP).

CELLULAR_PDN_AUTH_CHAP 

Challenge Handshake Authentication Protocol (CHAP).

CELLULAR_PDN_AUTH_PAP_OR_CHAP 

PAP or CHAP.

◆ CellularSocketDomain_t

Represents socket domain.

Enumerator
CELLULAR_SOCKET_DOMAIN_AF_INET 

IPv4 Internet Protocols.

CELLULAR_SOCKET_DOMAIN_AF_INET6 

IPv6 Internet Protocols.

◆ CellularSocketType_t

Represents socket type.

Enumerator
CELLULAR_SOCKET_TYPE_DGRAM 

Datagram.

CELLULAR_SOCKET_TYPE_STREAM 

Byte-stream.

◆ CellularIPAddressType_t

Represents IP address.

Enumerator
CELLULAR_IP_ADDRESS_V4 

IP V4 IP address.

CELLULAR_IP_ADDRESS_V6 

IP V6 IP address.

◆ CellularSocketOptionLevel_t

Represents socket option level.

Enumerator
CELLULAR_SOCKET_OPTION_LEVEL_IP 

IP layer options.

CELLULAR_SOCKET_OPTION_LEVEL_TRANSPORT 

Transport (TCP/UDP) layer options.

◆ CellularSocketOption_t

Socket option names.

Enumerator
CELLULAR_SOCKET_OPTION_MAX_IP_PACKET_SIZE 

Set Max IP packet size.

CELLULAR_SOCKET_OPTION_SEND_TIMEOUT 

Set send timeout (in milliseconds).

CELLULAR_SOCKET_OPTION_RECV_TIMEOUT 

Set receive timeout (in milliseconds).

CELLULAR_SOCKET_OPTION_PDN_CONTEXT_ID 

Set PDN Context ID to use for the socket.

CELLULAR_SOCKET_OPTION_SET_LOCAL_PORT 

Set local port.

◆ CellularATCommandType_t

Represents AT Command type.

Enumerator
CELLULAR_AT_NO_RESULT 

no response expected, only OK, ERROR etc.

CELLULAR_AT_WO_PREFIX 

string response without a prefix.

CELLULAR_AT_WITH_PREFIX 

string response with a prefix.

CELLULAR_AT_MULTI_WITH_PREFIX 

multiple line response all start with a prefix.

CELLULAR_AT_MULTI_WO_PREFIX 

multiple line response with or without a prefix.

CELLULAR_AT_MULTI_DATA_WO_PREFIX 

multiple line data response with or without a prefix.

CELLULAR_AT_WO_PREFIX_NO_RESULT_CODE 

string response without a prefix and no result code is expected.

CELLULAR_AT_WITH_PREFIX_NO_RESULT_CODE 

string response with a prefix and no result code is expected.

CELLULAR_AT_NO_COMMAND 

no command is waiting response.

◆ CellularNetworkRegType_t

Cellular network register URC type.

Enumerator
CELLULAR_REG_TYPE_CREG 

Register type for circuit switched network.

CELLULAR_REG_TYPE_CGREG 

Register type for GPRS packet networks.

CELLULAR_REG_TYPE_CEREG 

Register type for EPS(LTE) packet networks.

CELLULAR_REG_TYPE_MAX 

Maximum value for register type.

CELLULAR_REG_TYPE_UNKNOWN 

Unknown value for register type.