fahim alavi / ublox-cellular-base_drx

drx

UbloxCellularBase.h@26:7a05f60319bc, 2019-07-26 (annotated)

Committer:
fahimalavi
Date:
Fri Jul 26 15:32:42 2019 +0500
Revision:
26:7a05f60319bc
Parent:
25:e67d3d9d2e7e
Child:
27:bea0391bb075
edrx support for target UBLOX_C030_R41XM added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
fahimalavi 26:7a05f60319bc 1 /* Copyright (c) 2019 ARM Limited
RobMeades 0:5cffef3371f6 2 *
RobMeades 0:5cffef3371f6 3 * Licensed under the Apache License, Version 2.0 (the "License");
RobMeades 0:5cffef3371f6 4 * you may not use this file except in compliance with the License.
RobMeades 0:5cffef3371f6 5 * You may obtain a copy of the License at
RobMeades 0:5cffef3371f6 6 *
RobMeades 0:5cffef3371f6 7 * http://www.apache.org/licenses/LICENSE-2.0
RobMeades 0:5cffef3371f6 8 *
RobMeades 0:5cffef3371f6 9 * Unless required by applicable law or agreed to in writing, software
RobMeades 0:5cffef3371f6 10 * distributed under the License is distributed on an "AS IS" BASIS,
RobMeades 0:5cffef3371f6 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
RobMeades 0:5cffef3371f6 12 * See the License for the specific language governing permissions and
RobMeades 0:5cffef3371f6 13 * limitations under the License.
RobMeades 0:5cffef3371f6 14 */
RobMeades 0:5cffef3371f6 15
rob.meades@u-blox.com 1:5aaecf2572dc 16 #ifndef _UBLOX_CELLULAR_BASE_
rob.meades@u-blox.com 1:5aaecf2572dc 17 #define _UBLOX_CELLULAR_BASE_
RobMeades 0:5cffef3371f6 18
RobMeades 0:5cffef3371f6 19 #include "mbed.h"
RobMeades 14:e420232ee4e7 20 #include "mbed_toolchain.h" // for MBED_DEPRECATED
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 21 #include "ubloxATCmdParser.h"
RobMeades 0:5cffef3371f6 22 #include "FileHandle.h"
RobMeades 0:5cffef3371f6 23
RobMeades 0:5cffef3371f6 24 /**********************************************************************
RobMeades 0:5cffef3371f6 25 * CLASSES
RobMeades 0:5cffef3371f6 26 **********************************************************************/
RobMeades 0:5cffef3371f6 27
RobMeades 0:5cffef3371f6 28 /** UbloxCellularBase class.
RobMeades 0:5cffef3371f6 29 *
RobMeades 0:5cffef3371f6 30 * This class provides all the base support for generic u-blox modems
RobMeades 0:5cffef3371f6 31 * on C030 and C027 boards: module identification, power-up, network
RobMeades 0:5cffef3371f6 32 * registration, etc.
RobMeades 0:5cffef3371f6 33 */
RobMeades 0:5cffef3371f6 34 class UbloxCellularBase {
RobMeades 0:5cffef3371f6 35
RobMeades 0:5cffef3371f6 36 public:
RobMeades 0:5cffef3371f6 37 /** Circuit Switched network registration status (CREG Usage).
RobMeades 0:5cffef3371f6 38 * UBX-13001820 - AT Commands Example Application Note (Section 7.10.3).
RobMeades 0:5cffef3371f6 39 */
RobMeades 0:5cffef3371f6 40 typedef enum {
RobMeades 0:5cffef3371f6 41 CSD_NOT_REGISTERED_NOT_SEARCHING = 0,
RobMeades 0:5cffef3371f6 42 CSD_REGISTERED = 1,
RobMeades 0:5cffef3371f6 43 CSD_NOT_REGISTERED_SEARCHING = 2,
RobMeades 0:5cffef3371f6 44 CSD_REGISTRATION_DENIED = 3,
RobMeades 0:5cffef3371f6 45 CSD_UNKNOWN_COVERAGE = 4,
RobMeades 0:5cffef3371f6 46 CSD_REGISTERED_ROAMING = 5,
RobMeades 0:5cffef3371f6 47 CSD_SMS_ONLY = 6,
RobMeades 0:5cffef3371f6 48 CSD_SMS_ONLY_ROAMING = 7,
RobMeades 0:5cffef3371f6 49 CSD_CSFB_NOT_PREFERRED = 9
RobMeades 0:5cffef3371f6 50 } NetworkRegistrationStatusCsd;
RobMeades 0:5cffef3371f6 51
RobMeades 0:5cffef3371f6 52 /** Packet Switched network registration status (CGREG Usage).
RobMeades 0:5cffef3371f6 53 * UBX-13001820 - AT Commands Example Application Note (Section 18.27.3).
RobMeades 0:5cffef3371f6 54 */
RobMeades 0:5cffef3371f6 55 typedef enum {
RobMeades 0:5cffef3371f6 56 PSD_NOT_REGISTERED_NOT_SEARCHING = 0,
RobMeades 0:5cffef3371f6 57 PSD_REGISTERED = 1,
RobMeades 0:5cffef3371f6 58 PSD_NOT_REGISTERED_SEARCHING = 2,
RobMeades 0:5cffef3371f6 59 PSD_REGISTRATION_DENIED = 3,
RobMeades 0:5cffef3371f6 60 PSD_UNKNOWN_COVERAGE = 4,
RobMeades 0:5cffef3371f6 61 PSD_REGISTERED_ROAMING = 5,
RobMeades 0:5cffef3371f6 62 PSD_EMERGENCY_SERVICES_ONLY = 8
RobMeades 0:5cffef3371f6 63 } NetworkRegistrationStatusPsd;
RobMeades 0:5cffef3371f6 64
RobMeades 0:5cffef3371f6 65 /** EPS network registration status (CEREG Usage).
RobMeades 0:5cffef3371f6 66 * UBX-13001820 - AT Commands Example Application Note (Section 18.36.3).
RobMeades 0:5cffef3371f6 67 */
RobMeades 0:5cffef3371f6 68 typedef enum {
RobMeades 0:5cffef3371f6 69 EPS_NOT_REGISTERED_NOT_SEARCHING = 0,
RobMeades 0:5cffef3371f6 70 EPS_REGISTERED = 1,
RobMeades 0:5cffef3371f6 71 EPS_NOT_REGISTERED_SEARCHING = 2,
RobMeades 0:5cffef3371f6 72 EPS_REGISTRATION_DENIED = 3,
RobMeades 0:5cffef3371f6 73 EPS_UNKNOWN_COVERAGE = 4,
RobMeades 0:5cffef3371f6 74 EPS_REGISTERED_ROAMING = 5,
RobMeades 0:5cffef3371f6 75 EPS_EMERGENCY_SERVICES_ONLY = 8
RobMeades 0:5cffef3371f6 76 } NetworkRegistrationStatusEps;
RobMeades 0:5cffef3371f6 77
wajahat.abbas@u-blox.com 23:eaab8e812a5d 78 /** modem PSM states.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 79 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 80 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 81 typedef enum {
wajahat.abbas@u-blox.com 23:eaab8e812a5d 82 AWAKE = 0,
wajahat.abbas@u-blox.com 23:eaab8e812a5d 83 ASLEEP = 1
wajahat.abbas@u-blox.com 23:eaab8e812a5d 84 } ModemPSMState;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 85
fahimalavi 26:7a05f60319bc 86 /**
fahimalavi 26:7a05f60319bc 87 * edrx access technology
fahimalavi 26:7a05f60319bc 88 */
fahimalavi 26:7a05f60319bc 89 typedef enum {
fahimalavi 26:7a05f60319bc 90 EDRXGSM_EC_GSM_IoT_mode = 1,
fahimalavi 26:7a05f60319bc 91 EDRXGSM_A_Gb_mode,
fahimalavi 26:7a05f60319bc 92 EDRXUTRAN_Iu_mode,
fahimalavi 26:7a05f60319bc 93 EDRXEUTRAN_WB_S1_mode,
fahimalavi 26:7a05f60319bc 94 EDRXEUTRAN_NB_S1_mode
fahimalavi 26:7a05f60319bc 95 }tEDRXAccessTechnology;
fahimalavi 26:7a05f60319bc 96
RobMeades 0:5cffef3371f6 97 /** Initialise the modem, ready for use.
RobMeades 0:5cffef3371f6 98 *
RobMeades 0:5cffef3371f6 99 * @param pin PIN for the SIM card.
RobMeades 0:5cffef3371f6 100 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 101 */
RobMeades 0:5cffef3371f6 102 bool init(const char *pin = 0);
RobMeades 0:5cffef3371f6 103
RobMeades 0:5cffef3371f6 104 /** Perform registration with the network.
RobMeades 0:5cffef3371f6 105 *
RobMeades 0:5cffef3371f6 106 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 107 */
RobMeades 0:5cffef3371f6 108 bool nwk_registration();
RobMeades 0:5cffef3371f6 109
RobMeades 0:5cffef3371f6 110 /** True if the modem is registered for circuit
RobMeades 0:5cffef3371f6 111 * switched data, otherwise false.
RobMeades 0:5cffef3371f6 112 */
RobMeades 0:5cffef3371f6 113 bool is_registered_csd();
RobMeades 0:5cffef3371f6 114
RobMeades 0:5cffef3371f6 115 /** True if the modem is registered for packet
RobMeades 0:5cffef3371f6 116 * switched data, otherwise false.
RobMeades 0:5cffef3371f6 117 */
RobMeades 0:5cffef3371f6 118 bool is_registered_psd();
RobMeades 0:5cffef3371f6 119
RobMeades 0:5cffef3371f6 120 /** True if the modem is registered for enhanced
RobMeades 0:5cffef3371f6 121 * packet switched data (i.e. LTE and beyond),
RobMeades 0:5cffef3371f6 122 * otherwise false.
RobMeades 0:5cffef3371f6 123 */
RobMeades 0:5cffef3371f6 124 bool is_registered_eps();
RobMeades 0:5cffef3371f6 125
RobMeades 0:5cffef3371f6 126 /** Perform deregistration from the network.
RobMeades 0:5cffef3371f6 127 *
RobMeades 0:5cffef3371f6 128 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 129 */
RobMeades 0:5cffef3371f6 130 bool nwk_deregistration();
RobMeades 0:5cffef3371f6 131
RobMeades 0:5cffef3371f6 132 /** Put the modem into its lowest power state.
RobMeades 0:5cffef3371f6 133 */
RobMeades 0:5cffef3371f6 134 void deinit();
RobMeades 0:5cffef3371f6 135
RobMeades 0:5cffef3371f6 136 /** Set the PIN code for the SIM card.
RobMeades 0:5cffef3371f6 137 *
RobMeades 0:5cffef3371f6 138 * @param pin PIN for the SIM card.
RobMeades 0:5cffef3371f6 139 */
RobMeades 0:5cffef3371f6 140 void set_pin(const char *pin);
RobMeades 0:5cffef3371f6 141
RobMeades 0:5cffef3371f6 142 /** Enable or disable SIM pin checking.
RobMeades 0:5cffef3371f6 143 *
RobMeades 0:5cffef3371f6 144 * @param enableNotDisable true if SIM PIN checking is to be enabled,
RobMeades 0:5cffef3371f6 145 * otherwise false.
RobMeades 0:5cffef3371f6 146 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 147 */
RobMeades 0:5cffef3371f6 148 bool sim_pin_check_enable(bool enableNotDisable);
RobMeades 0:5cffef3371f6 149
RobMeades 0:5cffef3371f6 150 /** Change the SIM pin.
RobMeades 0:5cffef3371f6 151 *
RobMeades 0:5cffef3371f6 152 * @param new_pin the new PIN to use.
RobMeades 0:5cffef3371f6 153 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 154 */
RobMeades 0:5cffef3371f6 155 bool change_sim_pin(const char *new_pin);
RobMeades 0:5cffef3371f6 156
fahim alavi 11:57f64bc518c0 157 /** Get the IMEI.
fahim alavi 11:57f64bc518c0 158 *
fahim alavi 11:57f64bc518c0 159 * @return true if successful, otherwise false.
fahim alavi 11:57f64bc518c0 160 */
RobMeades 14:e420232ee4e7 161 MBED_DEPRECATED("This method is now replaced by const char * imei(), please use that instead")
fahim alavi 12:aa3cbc3f88c5 162 bool get_imei(char *imei_to_send, int size);
fahim alavi 11:57f64bc518c0 163
RobMeades 14:e420232ee4e7 164 /** Get the IMEI of the module.
RobMeades 14:e420232ee4e7 165 *
RobMeades 14:e420232ee4e7 166 * @return a pointer to the IMEI as a null-terminated string.
RobMeades 14:e420232ee4e7 167 */
RobMeades 14:e420232ee4e7 168 const char *imei();
RobMeades 14:e420232ee4e7 169
RobMeades 14:e420232ee4e7 170 /** Get the Mobile Equipment ID (which may be the same as the IMEI).
RobMeades 14:e420232ee4e7 171 *
RobMeades 14:e420232ee4e7 172 * @return a pointer to the Mobile Equipment ID as a null-terminated string.
RobMeades 14:e420232ee4e7 173 */
RobMeades 14:e420232ee4e7 174 const char *meid();
RobMeades 14:e420232ee4e7 175
RobMeades 14:e420232ee4e7 176 /** Get the IMSI of the SIM.
RobMeades 14:e420232ee4e7 177 *
RobMeades 14:e420232ee4e7 178 * @return a pointer to the IMSI as a null-terminated string.
RobMeades 14:e420232ee4e7 179 */
RobMeades 14:e420232ee4e7 180 const char *imsi();
RobMeades 14:e420232ee4e7 181
RobMeades 14:e420232ee4e7 182 /** Get the ICCID of the SIM.
RobMeades 14:e420232ee4e7 183 *
RobMeades 14:e420232ee4e7 184 * @return a pointer to the ICCID as a null-terminated string.
RobMeades 14:e420232ee4e7 185 */
RobMeades 14:e420232ee4e7 186 const char *iccid();
RobMeades 14:e420232ee4e7 187
RobMeades 14:e420232ee4e7 188 /** Get the RSSI.
RobMeades 14:e420232ee4e7 189 *
RobMeades 14:e420232ee4e7 190 * @return the RSSI in dBm. If it is not possible to obtain an
RobMeades 14:e420232ee4e7 191 * RSSI reading at the time (e.g. because the modem is in
RobMeades 14:e420232ee4e7 192 * data mode rather than AT command mode) then 0 is returned.
RobMeades 14:e420232ee4e7 193 */
RobMeades 14:e420232ee4e7 194 int rssi();
RobMeades 14:e420232ee4e7 195
wajahat.abbas@u-blox.com 20:31d5e048fbfa 196 /** RAT values for +URAT command
wajahat.abbas@u-blox.com 20:31d5e048fbfa 197 * R412M only supports value 7 (CatM1), 8 (NB1), and 9 (GPRS)
wajahat.abbas@u-blox.com 20:31d5e048fbfa 198 */
wajahat.abbas@u-blox.com 20:31d5e048fbfa 199 typedef enum {
wajahat.abbas@u-blox.com 20:31d5e048fbfa 200 GSM_GPRS_EGPRS = 0,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 201 GSM_UMTS = 1,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 202 UMTS = 2,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 203 URAT_LTE = 3,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 204 GSM_UMTS_LTE = 4,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 205 GSM_LTE = 5,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 206 UMTS_LTE = 6,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 207 LTE_CATM1 = 7,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 208 LTE_CATNB1 = 8,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 209 GPRS_EGPRS = 9,
wajahat.abbas@u-blox.com 22:779971811c46 210 NOT_USED = -1
wajahat.abbas@u-blox.com 20:31d5e048fbfa 211 } RAT;
wajahat.abbas@u-blox.com 20:31d5e048fbfa 212
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 213 /** Module functionality modes. Ref to section 5.3.3 of UBX-13002752 for details.
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 214 */
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 215 typedef enum {
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 216 FUNC_MIN = 0,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 217 FUNC_FULL = 1,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 218 FUNC_AIRPLANE = 4,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 219 FUNC_EN_SIM_TLKT_DEDICATED = 6,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 220 FUNC_DS_SIM_TLKT = 7,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 221 FUNC_EN_SIM_TLKT_RAW = 9,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 222 FUNC_RESET = 15,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 223 FUNC_RESET_WITH_SIM = 16,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 224 FUNC_MIN_WITH_SIM = 19,
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 225 FUNC_HALT = 127
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 226 } FunctionalityMode;
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 227
wajahat.abbas@u-blox.com 20:31d5e048fbfa 228 #ifdef TARGET_UBLOX_C030_R41XM
wajahat.abbas@u-blox.com 20:31d5e048fbfa 229 /** Supported MNO profiles for SARA-R4.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 230 */
wajahat.abbas@u-blox.com 20:31d5e048fbfa 231 typedef enum {
wajahat.abbas@u-blox.com 20:31d5e048fbfa 232 SW_DEFAULT = 0,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 233 SIM_ICCID = 1,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 234 ATT = 2,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 235 VERIZON = 3,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 236 TELSTRA = 4,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 237 TMO = 5,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 238 CT = 6,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 239 VODAFONE = 19,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 240 TELUS = 21,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 241 DT = 31,
wajahat.abbas@u-blox.com 20:31d5e048fbfa 242 STANDARD_EU = 100
wajahat.abbas@u-blox.com 20:31d5e048fbfa 243 } MNOProfile;
wajahat.abbas@u-blox.com 20:31d5e048fbfa 244
wajahat.abbas@u-blox.com 20:31d5e048fbfa 245 #if MBED_CONF_UBLOX_CELL_DEFAULT_MNO_PROFILE
wajahat.abbas@u-blox.com 20:31d5e048fbfa 246 #define DEFAULT_MNO_PROFILE (MNOProfile)MBED_CONF_UBLOX_CELL_DEFAULT_MNO_PROFILE
wajahat.abbas@u-blox.com 20:31d5e048fbfa 247 #else
wajahat.abbas@u-blox.com 20:31d5e048fbfa 248 #define DEFAULT_MNO_PROFILE SW_DEFAULT
wajahat.abbas@u-blox.com 20:31d5e048fbfa 249 #endif
wajahat.abbas@u-blox.com 20:31d5e048fbfa 250
wajahat.abbas@u-blox.com 21:98aea8f49cd8 251 /** Reads the current MNO profile from modem and sets it to user specified profile.
wajahat.abbas@u-blox.com 21:98aea8f49cd8 252 * User can also specify profile in mbed_lib.json file and call set_mno_profile without any arguments.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 253 *
wajahat.abbas@u-blox.com 21:98aea8f49cd8 254 * Note: MNO profile should only be set in detached state and a reboot is required for settings to take effect
wajahat.abbas@u-blox.com 21:98aea8f49cd8 255 *
wajahat.abbas@u-blox.com 21:98aea8f49cd8 256 * @param profile MNO profile to use
wajahat.abbas@u-blox.com 20:31d5e048fbfa 257 * @return true if operation was successful, false if there was an error
wajahat.abbas@u-blox.com 20:31d5e048fbfa 258 */
wajahat.abbas@u-blox.com 20:31d5e048fbfa 259 bool set_mno_profile(MNOProfile profile = DEFAULT_MNO_PROFILE);
wajahat.abbas@u-blox.com 20:31d5e048fbfa 260
wajahat.abbas@u-blox.com 20:31d5e048fbfa 261 /** Get current MNO profile.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 262 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 263 * @param profile pointer to variable that can hold the value for returned profile
wajahat.abbas@u-blox.com 20:31d5e048fbfa 264 * @return true if operation was successful, false if there was an error
wajahat.abbas@u-blox.com 20:31d5e048fbfa 265 */
wajahat.abbas@u-blox.com 22:779971811c46 266 bool get_mno_profile(int *profile);
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 267
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 268 /** Enable or disable the UPSV Power Saving Mode.
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 269 *
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 270 * @param idle_mode_value 1: enable idle mode
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 271 * 0: disable idle mode
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 272 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 273 */
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 274 bool set_idle_mode(bool enable = false);
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 275
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 276 /** Queries the modem for idle mode status.
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 277 *
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 278 * @param status pointer to variable that can hold the value for idle mode status
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 279 * 1: enabled
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 280 * 0: disabled
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 281 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 282 */
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 283 bool get_idle_mode(int *status);
wajahat.abbas@u-blox.com 20:31d5e048fbfa 284 #endif
wajahat.abbas@u-blox.com 20:31d5e048fbfa 285
wajahat.abbas@u-blox.com 20:31d5e048fbfa 286 /** Set Radio Access Technology on modem.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 287 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 288 * Note: RAT should only be set in detached state and a reboot is required for settings to take effect
wajahat.abbas@u-blox.com 20:31d5e048fbfa 289 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 290 * @param selected_rat Radio Access Technology to use
wajahat.abbas@u-blox.com 20:31d5e048fbfa 291 * @param preferred_rat Radio Access Technology to use if selected_rat is not available
wajahat.abbas@u-blox.com 20:31d5e048fbfa 292 * @param second_preferred_rat Radio Access Technology to use if selected_rat and preferred_rat are not available
wajahat.abbas@u-blox.com 20:31d5e048fbfa 293 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 294 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 295 */
wajahat.abbas@u-blox.com 20:31d5e048fbfa 296 bool set_modem_rat(RAT selected_rat, RAT preferred_rat = NOT_USED, RAT second_preferred_rat = NOT_USED);
wajahat.abbas@u-blox.com 20:31d5e048fbfa 297
wajahat.abbas@u-blox.com 20:31d5e048fbfa 298 /** Get last saved values for RAT using +URAT read command. Note: The current selected RAT is indicated by DeviceInfo.rat
wajahat.abbas@u-blox.com 20:31d5e048fbfa 299 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 300 * @param selected_rat pointer to variable that can hold the value for selected_rat
wajahat.abbas@u-blox.com 20:31d5e048fbfa 301 * @param preferred_rat pointer to variable that can hold the value for preferred_rat
wajahat.abbas@u-blox.com 20:31d5e048fbfa 302 * @param second_preferred_rat pointer to variable that can hold the value for second_preferred_rat
wajahat.abbas@u-blox.com 20:31d5e048fbfa 303 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 304 * Note: NOT_USED will be returned in the variables if dual or tri modes are not enabled.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 305 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 306 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 307 */
wajahat.abbas@u-blox.com 22:779971811c46 308 bool get_modem_rat(int *selected_rat, int *preferred_rat, int *second_preferred_rat);
wajahat.abbas@u-blox.com 20:31d5e048fbfa 309
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 310 /** Sets the modem to specified functionality mode.
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 311 *
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 312 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 313 */
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 314 bool set_functionality_mode(FunctionalityMode mode);
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 315
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 316 /** Get the modem functionality mode
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 317 *
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 318 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 319 */
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 320 bool get_functionality_mode(int *mode);
wajahat.abbas@u-blox.com 24:e26a6ab0dd75 321
wajahat.abbas@u-blox.com 23:eaab8e812a5d 322 /** reboot the modem using AT+CFUN=15. Application should call init() or connect() before making any other API calls.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 323 *
wajahat.abbas@u-blox.com 20:31d5e048fbfa 324 * @return true if successful, otherwise false.
wajahat.abbas@u-blox.com 20:31d5e048fbfa 325 */
wajahat.abbas@u-blox.com 20:31d5e048fbfa 326 bool reboot_modem();
wajahat.abbas@u-blox.com 23:eaab8e812a5d 327
wajahat.abbas@u-blox.com 23:eaab8e812a5d 328 #ifdef TARGET_UBLOX_C030_R412M
wajahat.abbas@u-blox.com 23:eaab8e812a5d 329 /** Important: Callback function is executed in context of AT parser so a user should not issue any AT commands from inside the callback.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 330 * It is recommended to set a flag/event/signal in callback and application can use that to wake up the modem and re-initialize it
wajahat.abbas@u-blox.com 23:eaab8e812a5d 331 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 332 * application callback for modem going in to PSM sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 333 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 334 * @param func callback function to be executed when modem is going in to PSM sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 335 * @param param parameter to be passed to callback function.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 336 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 337 void attach_cb_psm_going_in(Callback<void(void*)> func, void *param)
wajahat.abbas@u-blox.com 23:eaab8e812a5d 338 {
wajahat.abbas@u-blox.com 23:eaab8e812a5d 339 _func_psm_going_in = func;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 340 _cb_param_psm_going_in = param;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 341 }
wajahat.abbas@u-blox.com 23:eaab8e812a5d 342
wajahat.abbas@u-blox.com 23:eaab8e812a5d 343 /** Important: Callback function is executed in context of AT parser so a user should not issue any AT commands from inside the callback.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 344 * It is recommended to set a flag/event/signal in callback and application can use that to wake up the modem and re-initialize it
wajahat.abbas@u-blox.com 23:eaab8e812a5d 345 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 346 * application callback for modem coming out of PSM sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 347 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 348 * @param func callback function to be executed when modem is coming out of PSM sleep.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 349 * @param param parameter to be passed to callback function.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 350 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 351 void attach_cb_psm_coming_out(Callback<void(void*)> func, void *param)
wajahat.abbas@u-blox.com 23:eaab8e812a5d 352 {
wajahat.abbas@u-blox.com 23:eaab8e812a5d 353 _func_psm_coming_out = func;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 354 _cb_param_psm_coming_out = param;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 355 }
wajahat.abbas@u-blox.com 23:eaab8e812a5d 356
wajahat.abbas@u-blox.com 23:eaab8e812a5d 357 /** de-register the application callback for modem going in to PSM sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 358 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 359 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 360 void detach_cb_psm_going_in()
wajahat.abbas@u-blox.com 23:eaab8e812a5d 361 {
wajahat.abbas@u-blox.com 23:eaab8e812a5d 362 _func_psm_going_in = NULL;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 363 _cb_param_psm_going_in = NULL;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 364 }
wajahat.abbas@u-blox.com 23:eaab8e812a5d 365
wajahat.abbas@u-blox.com 23:eaab8e812a5d 366 /** de-register application callback for modem coming out of PSM sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 367 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 368 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 369 void detach_cb_psm_coming_out()
wajahat.abbas@u-blox.com 23:eaab8e812a5d 370 {
wajahat.abbas@u-blox.com 23:eaab8e812a5d 371 _func_psm_coming_out = NULL;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 372 _cb_param_psm_coming_out = NULL;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 373 }
wajahat.abbas@u-blox.com 23:eaab8e812a5d 374
wajahat.abbas@u-blox.com 23:eaab8e812a5d 375 /** Enable or disable the 3GPP PSM.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 376 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 377 * Note: Application should reboot the module after enabling PSM in order to enter PSM state. (reboot_modem())
wajahat.abbas@u-blox.com 23:eaab8e812a5d 378 * Note: Modem can be woken up by toggling the power-on signal. (wakeup_modem())
wajahat.abbas@u-blox.com 23:eaab8e812a5d 379 * Note: When device enters PSM, all connections(PPP, sockets) and settings that are not saved in NV memory(ATE0, CREG etc) are lost.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 380 * host application should be prepared to re-initialize the modem and re-establish the connections.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 381 * Note: PSM is disabled if both periodic_time and active_time are 0.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 382 * Note: Not all variants/firmware versions support PSM URCs and in that case function will return false.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 383 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 384 * PSM string encoding code is borrowed from AT_CellularPower.cpp
wajahat.abbas@u-blox.com 23:eaab8e812a5d 385 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 386 * @param periodic_time requested periodic TAU in seconds.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 387 * @param active_time requested active time in seconds.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 388 * @param func callback function to execute when modem goes to sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 389 * @param ptr parameter to callback function
wajahat.abbas@u-blox.com 23:eaab8e812a5d 390 * @return True if successful, otherwise false.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 391 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 392 bool set_power_saving_mode(int periodic_tau, int active_time);
wajahat.abbas@u-blox.com 23:eaab8e812a5d 393
wajahat.abbas@u-blox.com 23:eaab8e812a5d 394 /** Reads the 3GPP PSM status (enabled or disabled) and returns assigned periodic tau and active time values.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 395 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 396 * @param status 0: PSM disabled, 1: PSM enabled
wajahat.abbas@u-blox.com 23:eaab8e812a5d 397 * @param periodic_tau assigned periodic TAU in seconds.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 398 * @param active_time assigned active time in seconds
wajahat.abbas@u-blox.com 23:eaab8e812a5d 399 * @return True if command successful, otherwise false.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 400 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 401 bool get_power_saving_mode(int *status, int *periodic_tau, int *active_time);
wajahat.abbas@u-blox.com 23:eaab8e812a5d 402
wajahat.abbas@u-blox.com 23:eaab8e812a5d 403 /** Wake up the modem from PSM. Ref to comment on set_power_saving_mode, application should call init() or connect()
wajahat.abbas@u-blox.com 23:eaab8e812a5d 404 * before making any other API calls.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 405 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 406 void wakeup_modem();
wajahat.abbas@u-blox.com 23:eaab8e812a5d 407
wajahat.abbas@u-blox.com 23:eaab8e812a5d 408 /** True if the modem is not in PSM sleep
wajahat.abbas@u-blox.com 23:eaab8e812a5d 409 * otherwise false.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 410 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 411 bool is_modem_awake();
wajahat.abbas@u-blox.com 23:eaab8e812a5d 412 #endif
wajahat.abbas@u-blox.com 23:eaab8e812a5d 413
fahimalavi 26:7a05f60319bc 414 #ifdef TARGET_UBLOX_C030_R41XM
fahimalavi 26:7a05f60319bc 415 /** Set discontinuous reception time on cellular device.
fahimalavi 26:7a05f60319bc 416 * SARA-R404M / SARA-R410M-02B / SARA-R410M-52B / SARA-R412M / SARA-N4 : The <Paging_time_window> parameter cannot be set by means of the set command.
fahimalavi 26:7a05f60319bc 417 *
fahimalavi 26:7a05f60319bc 418 *
fahimalavi 26:7a05f60319bc 419 * @remark See 3GPP TS 27.007 eDRX for details.
fahimalavi 26:7a05f60319bc 420 *
fahimalavi 26:7a05f60319bc 421 * @param mode disable or enable the use of eDRX
fahimalavi 26:7a05f60319bc 422 * @param act_type type of access technology
fahimalavi 26:7a05f60319bc 423 * @param edrx_value requested edxr value. Extended DRX parameters information element.
fahimalavi 26:7a05f60319bc 424 *
fahimalavi 26:7a05f60319bc 425 * @return 0 on success
fahimalavi 26:7a05f60319bc 426 * 1 on failure
fahimalavi 26:7a05f60319bc 427 */
fahimalavi 26:7a05f60319bc 428 int set_receive_period(int mode, tEDRXAccessTechnology act_type, uint8_t edrx_value);
fahimalavi 26:7a05f60319bc 429
fahimalavi 26:7a05f60319bc 430 /** Set discontinuous reception time on cellular device.
fahimalavi 26:7a05f60319bc 431 *
fahimalavi 26:7a05f60319bc 432 * @remark See 3GPP TS 27.007 eDRX for details.
fahimalavi 26:7a05f60319bc 433 *
fahimalavi 26:7a05f60319bc 434 * @param mode disable or enable the use of eDRX
fahimalavi 26:7a05f60319bc 435 * @param act_type type of access technology
fahimalavi 26:7a05f60319bc 436 *
fahimalavi 26:7a05f60319bc 437 * @return 0 on success
fahimalavi 26:7a05f60319bc 438 * 1 on failure
fahimalavi 26:7a05f60319bc 439 */
fahimalavi 26:7a05f60319bc 440 int set_receive_period(int mode, tEDRXAccessTechnology act_type);
fahimalavi 26:7a05f60319bc 441
fahimalavi 26:7a05f60319bc 442 /** Set discontinuous reception time on cellular device. (Disable)
fahimalavi 26:7a05f60319bc 443 *
fahimalavi 26:7a05f60319bc 444 * @remark See 3GPP TS 27.007 eDRX for details.
fahimalavi 26:7a05f60319bc 445 *
fahimalavi 26:7a05f60319bc 446 * @param mode disable or enable the use of eDRX
fahimalavi 26:7a05f60319bc 447 *
fahimalavi 26:7a05f60319bc 448 * @return 0 on success
fahimalavi 26:7a05f60319bc 449 * 1 on failure
fahimalavi 26:7a05f60319bc 450 */
fahimalavi 26:7a05f60319bc 451 int set_receive_period(int mode);
fahimalavi 26:7a05f60319bc 452
fahimalavi 26:7a05f60319bc 453 /** get discontinuous reception time on cellular device.
fahimalavi 26:7a05f60319bc 454 *
fahimalavi 26:7a05f60319bc 455 * @remark See 3GPP TS 27.007 eDRX for details.
fahimalavi 26:7a05f60319bc 456 *
fahimalavi 26:7a05f60319bc 457 * @return true on success
fahimalavi 26:7a05f60319bc 458 * false on failure
fahimalavi 26:7a05f60319bc 459 */
fahimalavi 26:7a05f60319bc 460 bool get_receive_period();
fahimalavi 26:7a05f60319bc 461 #endif
fahimalavi 26:7a05f60319bc 462
RobMeades 0:5cffef3371f6 463 protected:
RobMeades 0:5cffef3371f6 464
RobMeades 0:5cffef3371f6 465 #define OUTPUT_ENTER_KEY "\r"
RobMeades 0:5cffef3371f6 466
RobMeades 0:5cffef3371f6 467 #if MBED_CONF_UBLOX_CELL_GEN_DRV_AT_PARSER_BUFFER_SIZE
RobMeades 0:5cffef3371f6 468 #define AT_PARSER_BUFFER_SIZE MBED_CONF_UBLOX_CELL_GEN_DRV_AT_PARSER_BUFFER_SIZE
RobMeades 0:5cffef3371f6 469 #else
RobMeades 0:5cffef3371f6 470 #define AT_PARSER_BUFFER_SIZE 256
RobMeades 0:5cffef3371f6 471 #endif
RobMeades 0:5cffef3371f6 472
RobMeades 0:5cffef3371f6 473 #if MBED_CONF_UBLOX_CELL_GEN_DRV_AT_PARSER_TIMEOUT
RobMeades 0:5cffef3371f6 474 #define AT_PARSER_TIMEOUT MBED_CONF_UBLOX_CELL_GEN_DRV_AT_PARSER_TIMEOUT
RobMeades 0:5cffef3371f6 475 #else
RobMeades 0:5cffef3371f6 476 #define AT_PARSER_TIMEOUT 8*1000 // Milliseconds
RobMeades 0:5cffef3371f6 477 #endif
RobMeades 0:5cffef3371f6 478
RobMeades 0:5cffef3371f6 479 /** A string that would not normally be sent by the modem on the AT interface.
RobMeades 0:5cffef3371f6 480 */
RobMeades 0:5cffef3371f6 481 #define UNNATURAL_STRING "\x01"
RobMeades 0:5cffef3371f6 482
RobMeades 0:5cffef3371f6 483 /** Supported u-blox modem variants.
RobMeades 0:5cffef3371f6 484 */
RobMeades 0:5cffef3371f6 485 typedef enum {
RobMeades 0:5cffef3371f6 486 DEV_TYPE_NONE = 0,
RobMeades 0:5cffef3371f6 487 DEV_SARA_G35,
RobMeades 0:5cffef3371f6 488 DEV_LISA_U2,
RobMeades 0:5cffef3371f6 489 DEV_LISA_U2_03S,
RobMeades 0:5cffef3371f6 490 DEV_SARA_U2,
fahim alavi 11:57f64bc518c0 491 DEV_SARA_R4,
RobMeades 0:5cffef3371f6 492 DEV_LEON_G2,
RobMeades 0:5cffef3371f6 493 DEV_TOBY_L2,
RobMeades 0:5cffef3371f6 494 DEV_MPCI_L2
RobMeades 0:5cffef3371f6 495 } DeviceType;
RobMeades 0:5cffef3371f6 496
RobMeades 0:5cffef3371f6 497 /** Network registration status.
RobMeades 0:5cffef3371f6 498 * UBX-13001820 - AT Commands Example Application Note (Section 4.1.4.5).
RobMeades 0:5cffef3371f6 499 */
RobMeades 0:5cffef3371f6 500 typedef enum {
RobMeades 0:5cffef3371f6 501 GSM = 0,
RobMeades 0:5cffef3371f6 502 COMPACT_GSM = 1,
RobMeades 0:5cffef3371f6 503 UTRAN = 2,
RobMeades 0:5cffef3371f6 504 EDGE = 3,
RobMeades 0:5cffef3371f6 505 HSDPA = 4,
RobMeades 0:5cffef3371f6 506 HSUPA = 5,
RobMeades 0:5cffef3371f6 507 HSDPA_HSUPA = 6,
fahimalavi 10:c4281fa79b8f 508 LTE = 7,
fahim alavi 12:aa3cbc3f88c5 509 EC_GSM_IoT = 8,
fahim alavi 12:aa3cbc3f88c5 510 E_UTRAN_NB_S1 = 9
RobMeades 0:5cffef3371f6 511 } RadioAccessNetworkType;
RobMeades 0:5cffef3371f6 512
RobMeades 0:5cffef3371f6 513 /** Info about the modem.
RobMeades 0:5cffef3371f6 514 */
RobMeades 0:5cffef3371f6 515 typedef struct {
RobMeades 0:5cffef3371f6 516 DeviceType dev;
RobMeades 0:5cffef3371f6 517 char iccid[20 + 1]; //!< Integrated Circuit Card ID.
RobMeades 0:5cffef3371f6 518 char imsi[15 + 1]; //!< International Mobile Station Identity.
RobMeades 0:5cffef3371f6 519 char imei[15 + 1]; //!< International Mobile Equipment Identity.
RobMeades 0:5cffef3371f6 520 char meid[18 + 1]; //!< Mobile Equipment IDentifier.
RobMeades 0:5cffef3371f6 521 volatile RadioAccessNetworkType rat; //!< Type of network (e.g. 2G, 3G, LTE).
RobMeades 0:5cffef3371f6 522 volatile NetworkRegistrationStatusCsd reg_status_csd; //!< Circuit switched attach status.
RobMeades 0:5cffef3371f6 523 volatile NetworkRegistrationStatusPsd reg_status_psd; //!< Packet switched attach status.
RobMeades 0:5cffef3371f6 524 volatile NetworkRegistrationStatusEps reg_status_eps; //!< Evolved Packet Switched (e.g. LTE) attach status.
wajahat.abbas@u-blox.com 23:eaab8e812a5d 525 #ifdef TARGET_UBLOX_C030_R412M
wajahat.abbas@u-blox.com 23:eaab8e812a5d 526 volatile ModemPSMState modem_psm_state; //!< last known modem PSM state
wajahat.abbas@u-blox.com 23:eaab8e812a5d 527 #endif
RobMeades 0:5cffef3371f6 528 } DeviceInfo;
RobMeades 0:5cffef3371f6 529
RobMeades 0:5cffef3371f6 530 /* IMPORTANT: the variables below are available to
RobMeades 0:5cffef3371f6 531 * classes that inherit this in order to keep things
RobMeades 0:5cffef3371f6 532 * simple. However, ONLY this class should free
RobMeades 0:5cffef3371f6 533 * any of the pointers, or there will be havoc.
RobMeades 0:5cffef3371f6 534 */
RobMeades 0:5cffef3371f6 535
RobMeades 0:5cffef3371f6 536 /** Point to the instance of the AT parser in use.
RobMeades 0:5cffef3371f6 537 */
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 538 #ifdef TARGET_UBLOX_C030_R41XM
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 539 UbloxATCmdParser *_at;
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 540 #else
RobMeades 0:5cffef3371f6 541 ATCmdParser *_at;
wajahat.abbas@u-blox.com 25:e67d3d9d2e7e 542 #endif
RobMeades 0:5cffef3371f6 543
RobMeades 0:5cffef3371f6 544 /** The current AT parser timeout value.
RobMeades 0:5cffef3371f6 545 */
RobMeades 0:5cffef3371f6 546 int _at_timeout;
RobMeades 0:5cffef3371f6 547
RobMeades 0:5cffef3371f6 548 /** File handle used by the AT parser.
RobMeades 0:5cffef3371f6 549 */
RobMeades 0:5cffef3371f6 550 FileHandle *_fh;
RobMeades 0:5cffef3371f6 551
RobMeades 0:5cffef3371f6 552 /** The mutex resource.
RobMeades 0:5cffef3371f6 553 */
RobMeades 0:5cffef3371f6 554 Mutex _mtx;
RobMeades 0:5cffef3371f6 555
RobMeades 0:5cffef3371f6 556 /** General info about the modem as a device.
RobMeades 0:5cffef3371f6 557 */
RobMeades 0:5cffef3371f6 558 DeviceInfo _dev_info;
RobMeades 0:5cffef3371f6 559
RobMeades 0:5cffef3371f6 560 /** The SIM PIN to use.
RobMeades 0:5cffef3371f6 561 */
RobMeades 0:5cffef3371f6 562 const char *_pin;
RobMeades 0:5cffef3371f6 563
RobMeades 0:5cffef3371f6 564 /** Set to true to spit out debug traces.
RobMeades 0:5cffef3371f6 565 */
RobMeades 0:5cffef3371f6 566 bool _debug_trace_on;
rob.meades@u-blox.com 4:2e640a101db1 567
rob.meades@u-blox.com 4:2e640a101db1 568 /** The baud rate to the modem.
rob.meades@u-blox.com 4:2e640a101db1 569 */
rob.meades@u-blox.com 4:2e640a101db1 570 int _baud;
RobMeades 0:5cffef3371f6 571
RobMeades 0:5cffef3371f6 572 /** True if the modem is ready register to the network,
RobMeades 0:5cffef3371f6 573 * otherwise false.
RobMeades 0:5cffef3371f6 574 */
RobMeades 0:5cffef3371f6 575 bool _modem_initialised;
RobMeades 0:5cffef3371f6 576
RobMeades 0:5cffef3371f6 577 /** True it the SIM requires a PIN, otherwise false.
RobMeades 0:5cffef3371f6 578 */
RobMeades 0:5cffef3371f6 579 bool _sim_pin_check_enabled;
RobMeades 0:5cffef3371f6 580
RobMeades 0:5cffef3371f6 581 /** Sets the modem up for powering on
RobMeades 0:5cffef3371f6 582 *
RobMeades 0:5cffef3371f6 583 * modem_init() is equivalent to plugging in the device, e.g., attaching power and serial port.
RobMeades 0:5cffef3371f6 584 * Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.
RobMeades 0:5cffef3371f6 585 */
RobMeades 0:5cffef3371f6 586 virtual void modem_init();
RobMeades 0:5cffef3371f6 587
RobMeades 0:5cffef3371f6 588 /** Sets the modem in unplugged state
RobMeades 0:5cffef3371f6 589 *
RobMeades 0:5cffef3371f6 590 * modem_deinit() will be equivalent to pulling the plug off of the device, i.e., detaching power
RobMeades 0:5cffef3371f6 591 * and serial port. This puts the modem in lowest power state.
RobMeades 0:5cffef3371f6 592 * Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.
RobMeades 0:5cffef3371f6 593 */
RobMeades 0:5cffef3371f6 594 virtual void modem_deinit();
RobMeades 0:5cffef3371f6 595
RobMeades 0:5cffef3371f6 596 /** Powers up the modem
RobMeades 0:5cffef3371f6 597 *
RobMeades 0:5cffef3371f6 598 * modem_power_up() is equivalent to pressing the soft power button.
RobMeades 0:5cffef3371f6 599 * The driver may repeat this if the modem is not responsive to AT commands.
RobMeades 0:5cffef3371f6 600 * Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.
RobMeades 0:5cffef3371f6 601 */
RobMeades 0:5cffef3371f6 602 virtual void modem_power_up();
RobMeades 0:5cffef3371f6 603
RobMeades 0:5cffef3371f6 604 /** Powers down the modem
RobMeades 0:5cffef3371f6 605 *
RobMeades 0:5cffef3371f6 606 * modem_power_down() is equivalent to turning off the modem by button press.
RobMeades 0:5cffef3371f6 607 * Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.
RobMeades 0:5cffef3371f6 608 */
RobMeades 0:5cffef3371f6 609 virtual void modem_power_down();
RobMeades 0:5cffef3371f6 610
RobMeades 0:5cffef3371f6 611 /* Note: constructor and destructor protected so that this
RobMeades 0:5cffef3371f6 612 * class can only ever be inherited, never used directly.
RobMeades 0:5cffef3371f6 613 */
RobMeades 0:5cffef3371f6 614 UbloxCellularBase();
RobMeades 0:5cffef3371f6 615 ~UbloxCellularBase();
RobMeades 0:5cffef3371f6 616
RobMeades 0:5cffef3371f6 617 /** Initialise this class.
RobMeades 0:5cffef3371f6 618 *
RobMeades 0:5cffef3371f6 619 * @param tx the UART TX data pin to which the modem is attached.
RobMeades 0:5cffef3371f6 620 * @param rx the UART RX data pin to which the modem is attached.
RobMeades 0:5cffef3371f6 621 * @param baud the UART baud rate.
RobMeades 0:5cffef3371f6 622 * @param debug_on true to switch AT interface debug on, otherwise false.
RobMeades 0:5cffef3371f6 623 *
RobMeades 0:5cffef3371f6 624 * Note: it would be more natural to do this in the constructor
RobMeades 0:5cffef3371f6 625 * however, to avoid the diamond of death, this class is only
RobMeades 0:5cffef3371f6 626 * every inherited virtually. Classes that are inherited virtually
RobMeades 0:5cffef3371f6 627 * do not get passed parameters in their constructor and hence
RobMeades 0:5cffef3371f6 628 * classInit() must be called separately by the first one to wake
RobMeades 0:5cffef3371f6 629 * the beast.
RobMeades 0:5cffef3371f6 630 */
RobMeades 0:5cffef3371f6 631 void baseClassInit(PinName tx = MDMTXD,
RobMeades 0:5cffef3371f6 632 PinName rx = MDMRXD,
RobMeades 0:5cffef3371f6 633 int baud = MBED_CONF_UBLOX_CELL_BAUD_RATE,
RobMeades 0:5cffef3371f6 634 bool debug_on = false);
RobMeades 0:5cffef3371f6 635
RobMeades 0:5cffef3371f6 636 /** Set the AT parser timeout.
RobMeades 0:5cffef3371f6 637 */
RobMeades 0:5cffef3371f6 638 void at_set_timeout(int timeout);
RobMeades 0:5cffef3371f6 639
RobMeades 0:5cffef3371f6 640 /** Read up to size characters from buf
RobMeades 0:5cffef3371f6 641 * or until the character "end" is reached, overwriting
RobMeades 0:5cffef3371f6 642 * the newline with 0 and ensuring a terminator
RobMeades 0:5cffef3371f6 643 * in all cases.
RobMeades 0:5cffef3371f6 644 *
RobMeades 0:5cffef3371f6 645 * @param buf the buffer to write to.
RobMeades 0:5cffef3371f6 646 * @param size the size of the buffer.
RobMeades 0:5cffef3371f6 647 * @param end the character to stop at.
RobMeades 0:5cffef3371f6 648 * @return the number of characters read,
RobMeades 0:5cffef3371f6 649 * not including the terminator.
RobMeades 0:5cffef3371f6 650 */
RobMeades 0:5cffef3371f6 651 int read_at_to_char(char * buf, int size, char end);
RobMeades 0:5cffef3371f6 652
RobMeades 0:5cffef3371f6 653 /** Powers up the modem.
RobMeades 0:5cffef3371f6 654 *
RobMeades 0:5cffef3371f6 655 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 656 */
RobMeades 0:5cffef3371f6 657 bool power_up();
RobMeades 0:5cffef3371f6 658
RobMeades 0:5cffef3371f6 659 /** Power down the modem.
RobMeades 0:5cffef3371f6 660 */
RobMeades 0:5cffef3371f6 661 void power_down();
RobMeades 0:5cffef3371f6 662
RobMeades 0:5cffef3371f6 663 /** Lock a mutex when accessing the modem.
RobMeades 0:5cffef3371f6 664 */
RobMeades 0:5cffef3371f6 665 void lock(void) { _mtx.lock(); }
RobMeades 0:5cffef3371f6 666
RobMeades 0:5cffef3371f6 667 /** Helper to make sure that lock unlock pair is always balanced
RobMeades 0:5cffef3371f6 668 */
RobMeades 0:5cffef3371f6 669 #define LOCK() { lock()
RobMeades 0:5cffef3371f6 670
RobMeades 0:5cffef3371f6 671 /** Unlock the modem when done accessing it.
RobMeades 0:5cffef3371f6 672 */
RobMeades 0:5cffef3371f6 673 void unlock(void) { _mtx.unlock(); }
RobMeades 0:5cffef3371f6 674
RobMeades 0:5cffef3371f6 675 /** Helper to make sure that lock unlock pair is always balanced
RobMeades 0:5cffef3371f6 676 */
RobMeades 0:5cffef3371f6 677 #define UNLOCK() } unlock()
RobMeades 0:5cffef3371f6 678
RobMeades 0:5cffef3371f6 679 /** Set the device identity in _dev_info
RobMeades 0:5cffef3371f6 680 * based on the ATI string returned by
RobMeades 0:5cffef3371f6 681 * the module.
RobMeades 0:5cffef3371f6 682 *
RobMeades 0:5cffef3371f6 683 * @return true if dev is a known value,
RobMeades 0:5cffef3371f6 684 * otherwise false.
RobMeades 0:5cffef3371f6 685 */
RobMeades 0:5cffef3371f6 686 bool set_device_identity(DeviceType *dev);
RobMeades 0:5cffef3371f6 687
RobMeades 0:5cffef3371f6 688 /** Perform any modem initialisation that is
RobMeades 0:5cffef3371f6 689 * specialised by device type.
RobMeades 0:5cffef3371f6 690 *
RobMeades 0:5cffef3371f6 691 * @return true if successful, otherwise false.
RobMeades 0:5cffef3371f6 692 */
RobMeades 0:5cffef3371f6 693 bool device_init(DeviceType dev);
RobMeades 0:5cffef3371f6 694
RobMeades 0:5cffef3371f6 695 /** Set up the SIM.
RobMeades 0:5cffef3371f6 696 *
RobMeades 0:5cffef3371f6 697 * @return true if successful, otherwiss false.
RobMeades 0:5cffef3371f6 698 */
RobMeades 0:5cffef3371f6 699 bool initialise_sim_card();
RobMeades 0:5cffef3371f6 700
wajahat.abbas@u-blox.com 23:eaab8e812a5d 701 #ifdef TARGET_UBLOX_C030_R412M
wajahat.abbas@u-blox.com 23:eaab8e812a5d 702 /** Converts the given uint to binary string. Fills the given str starting from [0] with the number of bits defined by bit_cnt
wajahat.abbas@u-blox.com 23:eaab8e812a5d 703 * For example uint_to_binary_string(9, str, 10) would fill str "0000001001"
wajahat.abbas@u-blox.com 23:eaab8e812a5d 704 * For example uint_to_binary_string(9, str, 3) would fill str "001"
wajahat.abbas@u-blox.com 23:eaab8e812a5d 705 *
wajahat.abbas@u-blox.com 23:eaab8e812a5d 706 * @param num uint to converts to binary string
wajahat.abbas@u-blox.com 23:eaab8e812a5d 707 * @param str buffer for converted binary string
wajahat.abbas@u-blox.com 23:eaab8e812a5d 708 * @param str_size size of the str buffer
wajahat.abbas@u-blox.com 23:eaab8e812a5d 709 * @param bit_cnt defines how many bits are filled to buffer started from lsb
wajahat.abbas@u-blox.com 23:eaab8e812a5d 710 */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 711 void uint_to_binary_str(uint32_t num, char* str, int str_size, int bit_cnt);
wajahat.abbas@u-blox.com 23:eaab8e812a5d 712 #endif
wajahat.abbas@u-blox.com 23:eaab8e812a5d 713
RobMeades 0:5cffef3371f6 714 private:
RobMeades 0:5cffef3371f6 715
RobMeades 0:5cffef3371f6 716 void set_nwk_reg_status_csd(int status);
RobMeades 0:5cffef3371f6 717 void set_nwk_reg_status_psd(int status);
RobMeades 0:5cffef3371f6 718 void set_nwk_reg_status_eps(int status);
RobMeades 0:5cffef3371f6 719 void set_rat(int AcTStatus);
RobMeades 0:5cffef3371f6 720 bool get_iccid();
RobMeades 0:5cffef3371f6 721 bool get_imsi();
RobMeades 0:5cffef3371f6 722 bool get_imei();
RobMeades 0:5cffef3371f6 723 bool get_meid();
RobMeades 0:5cffef3371f6 724 bool set_sms();
RobMeades 0:5cffef3371f6 725 void parser_abort_cb();
RobMeades 0:5cffef3371f6 726 void CMX_ERROR_URC();
RobMeades 0:5cffef3371f6 727 void CREG_URC();
RobMeades 0:5cffef3371f6 728 void CGREG_URC();
RobMeades 0:5cffef3371f6 729 void CEREG_URC();
RobMeades 0:5cffef3371f6 730 void UMWI_URC();
wajahat.abbas@u-blox.com 23:eaab8e812a5d 731 #ifdef TARGET_UBLOX_C030_R412M
wajahat.abbas@u-blox.com 23:eaab8e812a5d 732 void UUPSMR_URC();
wajahat.abbas@u-blox.com 23:eaab8e812a5d 733 bool _psm_status;
fahimalavi 26:7a05f60319bc 734 bool _edrx_configured;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 735 void *_cb_param_psm_going_in;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 736 Callback<void(void*)> _func_psm_going_in; /**< Callback. */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 737 void *_cb_param_psm_coming_out;
wajahat.abbas@u-blox.com 23:eaab8e812a5d 738 Callback<void(void*)> _func_psm_coming_out; /**< Callback. */
wajahat.abbas@u-blox.com 23:eaab8e812a5d 739 void set_modem_psm_state(int state);
wajahat.abbas@u-blox.com 23:eaab8e812a5d 740 #endif
RobMeades 0:5cffef3371f6 741 };
RobMeades 0:5cffef3371f6 742
rob.meades@u-blox.com 1:5aaecf2572dc 743 #endif // _UBLOX_CELLULAR_BASE_
RobMeades 0:5cffef3371f6 744