Curt Black / ublox-cellular-base

Fork of ublox-cellular-base to add LARA-R2 support

Fork of ublox-cellular-base by u-blox

UbloxCellularBase.cpp@12:aa3cbc3f88c5, 2018-01-09 (annotated)

Committer:
fahim alavi
Date:
Tue Jan 09 12:34:53 2018 +0500
Revision:
12:aa3cbc3f88c5
Parent:
11:57f64bc518c0
Child:
13:158a035b1b50
Code convention applied

Who changed what in which revision?

UserRevisionLine numberNew contents of line
RobMeades 0:5cffef3371f6 1 /* Copyright (c) 2017 ublox 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
RobMeades 0:5cffef3371f6 16 #include "UARTSerial.h"
RobMeades 0:5cffef3371f6 17 #include "APN_db.h"
RobMeades 0:5cffef3371f6 18 #include "UbloxCellularBase.h"
RobMeades 0:5cffef3371f6 19 #include "onboard_modem_api.h"
RobMeades 0:5cffef3371f6 20 #ifdef FEATURE_COMMON_PAL
RobMeades 0:5cffef3371f6 21 #include "mbed_trace.h"
RobMeades 0:5cffef3371f6 22 #define TRACE_GROUP "UCB"
RobMeades 0:5cffef3371f6 23 #else
rob.meades@u-blox.com 2:73fcc33c9400 24 #define tr_debug(format, ...) debug_if(_debug_trace_on, format "\n", ## __VA_ARGS__)
rob.meades@u-blox.com 2:73fcc33c9400 25 #define tr_info(format, ...) debug_if(_debug_trace_on, format "\n", ## __VA_ARGS__)
rob.meades@u-blox.com 2:73fcc33c9400 26 #define tr_warn(format, ...) debug_if(_debug_trace_on, format "\n", ## __VA_ARGS__)
rob.meades@u-blox.com 2:73fcc33c9400 27 #define tr_error(format, ...) debug_if(_debug_trace_on, format "\n", ## __VA_ARGS__)
RobMeades 0:5cffef3371f6 28 #endif
RobMeades 0:5cffef3371f6 29
RobMeades 0:5cffef3371f6 30 /**********************************************************************
RobMeades 0:5cffef3371f6 31 * PRIVATE METHODS
RobMeades 0:5cffef3371f6 32 **********************************************************************/
RobMeades 0:5cffef3371f6 33
RobMeades 0:5cffef3371f6 34 void UbloxCellularBase::set_nwk_reg_status_csd(int status)
RobMeades 0:5cffef3371f6 35 {
RobMeades 0:5cffef3371f6 36 switch (status) {
RobMeades 0:5cffef3371f6 37 case CSD_NOT_REGISTERED_NOT_SEARCHING:
RobMeades 0:5cffef3371f6 38 case CSD_NOT_REGISTERED_SEARCHING:
RobMeades 0:5cffef3371f6 39 tr_info("Not (yet) registered for circuit switched service");
RobMeades 0:5cffef3371f6 40 break;
RobMeades 0:5cffef3371f6 41 case CSD_REGISTERED:
RobMeades 0:5cffef3371f6 42 case CSD_REGISTERED_ROAMING:
RobMeades 0:5cffef3371f6 43 tr_info("Registered for circuit switched service");
RobMeades 0:5cffef3371f6 44 break;
RobMeades 0:5cffef3371f6 45 case CSD_REGISTRATION_DENIED:
RobMeades 0:5cffef3371f6 46 tr_info("Circuit switched service denied");
RobMeades 0:5cffef3371f6 47 break;
RobMeades 0:5cffef3371f6 48 case CSD_UNKNOWN_COVERAGE:
RobMeades 0:5cffef3371f6 49 tr_info("Out of circuit switched service coverage");
RobMeades 0:5cffef3371f6 50 break;
RobMeades 0:5cffef3371f6 51 case CSD_SMS_ONLY:
RobMeades 0:5cffef3371f6 52 tr_info("SMS service only");
RobMeades 0:5cffef3371f6 53 break;
RobMeades 0:5cffef3371f6 54 case CSD_SMS_ONLY_ROAMING:
RobMeades 0:5cffef3371f6 55 tr_info("SMS service only");
RobMeades 0:5cffef3371f6 56 break;
RobMeades 0:5cffef3371f6 57 case CSD_CSFB_NOT_PREFERRED:
RobMeades 0:5cffef3371f6 58 tr_info("Registered for circuit switched service with CSFB not preferred");
RobMeades 0:5cffef3371f6 59 break;
RobMeades 0:5cffef3371f6 60 default:
RobMeades 0:5cffef3371f6 61 tr_info("Unknown circuit switched service registration status. %d", status);
RobMeades 0:5cffef3371f6 62 break;
RobMeades 0:5cffef3371f6 63 }
RobMeades 0:5cffef3371f6 64
RobMeades 0:5cffef3371f6 65 _dev_info.reg_status_csd = static_cast<NetworkRegistrationStatusCsd>(status);
RobMeades 0:5cffef3371f6 66 }
RobMeades 0:5cffef3371f6 67
RobMeades 0:5cffef3371f6 68 void UbloxCellularBase::set_nwk_reg_status_psd(int status)
RobMeades 0:5cffef3371f6 69 {
RobMeades 0:5cffef3371f6 70 switch (status) {
RobMeades 0:5cffef3371f6 71 case PSD_NOT_REGISTERED_NOT_SEARCHING:
RobMeades 0:5cffef3371f6 72 case PSD_NOT_REGISTERED_SEARCHING:
RobMeades 0:5cffef3371f6 73 tr_info("Not (yet) registered for packet switched service");
RobMeades 0:5cffef3371f6 74 break;
RobMeades 0:5cffef3371f6 75 case PSD_REGISTERED:
RobMeades 0:5cffef3371f6 76 case PSD_REGISTERED_ROAMING:
RobMeades 0:5cffef3371f6 77 tr_info("Registered for packet switched service");
RobMeades 0:5cffef3371f6 78 break;
RobMeades 0:5cffef3371f6 79 case PSD_REGISTRATION_DENIED:
RobMeades 0:5cffef3371f6 80 tr_info("Packet switched service denied");
RobMeades 0:5cffef3371f6 81 break;
RobMeades 0:5cffef3371f6 82 case PSD_UNKNOWN_COVERAGE:
RobMeades 0:5cffef3371f6 83 tr_info("Out of packet switched service coverage");
RobMeades 0:5cffef3371f6 84 break;
RobMeades 0:5cffef3371f6 85 case PSD_EMERGENCY_SERVICES_ONLY:
RobMeades 0:5cffef3371f6 86 tr_info("Limited access for packet switched service. Emergency use only.");
RobMeades 0:5cffef3371f6 87 break;
RobMeades 0:5cffef3371f6 88 default:
RobMeades 0:5cffef3371f6 89 tr_info("Unknown packet switched service registration status. %d", status);
RobMeades 0:5cffef3371f6 90 break;
RobMeades 0:5cffef3371f6 91 }
RobMeades 0:5cffef3371f6 92
RobMeades 0:5cffef3371f6 93 _dev_info.reg_status_psd = static_cast<NetworkRegistrationStatusPsd>(status);
RobMeades 0:5cffef3371f6 94 }
RobMeades 0:5cffef3371f6 95
RobMeades 0:5cffef3371f6 96 void UbloxCellularBase::set_nwk_reg_status_eps(int status)
RobMeades 0:5cffef3371f6 97 {
RobMeades 0:5cffef3371f6 98 switch (status) {
RobMeades 0:5cffef3371f6 99 case EPS_NOT_REGISTERED_NOT_SEARCHING:
RobMeades 0:5cffef3371f6 100 case EPS_NOT_REGISTERED_SEARCHING:
RobMeades 0:5cffef3371f6 101 tr_info("Not (yet) registered for EPS service");
RobMeades 0:5cffef3371f6 102 break;
RobMeades 0:5cffef3371f6 103 case EPS_REGISTERED:
RobMeades 0:5cffef3371f6 104 case EPS_REGISTERED_ROAMING:
RobMeades 0:5cffef3371f6 105 tr_info("Registered for EPS service");
RobMeades 0:5cffef3371f6 106 break;
RobMeades 0:5cffef3371f6 107 case EPS_REGISTRATION_DENIED:
RobMeades 0:5cffef3371f6 108 tr_info("EPS service denied");
RobMeades 0:5cffef3371f6 109 break;
RobMeades 0:5cffef3371f6 110 case EPS_UNKNOWN_COVERAGE:
RobMeades 0:5cffef3371f6 111 tr_info("Out of EPS service coverage");
RobMeades 0:5cffef3371f6 112 break;
RobMeades 0:5cffef3371f6 113 case EPS_EMERGENCY_SERVICES_ONLY:
RobMeades 0:5cffef3371f6 114 tr_info("Limited access for EPS service. Emergency use only.");
RobMeades 0:5cffef3371f6 115 break;
RobMeades 0:5cffef3371f6 116 default:
RobMeades 0:5cffef3371f6 117 tr_info("Unknown EPS service registration status. %d", status);
RobMeades 0:5cffef3371f6 118 break;
RobMeades 0:5cffef3371f6 119 }
RobMeades 0:5cffef3371f6 120
RobMeades 0:5cffef3371f6 121 _dev_info.reg_status_eps = static_cast<NetworkRegistrationStatusEps>(status);
RobMeades 0:5cffef3371f6 122 }
RobMeades 0:5cffef3371f6 123
RobMeades 0:5cffef3371f6 124 void UbloxCellularBase::set_rat(int AcTStatus)
RobMeades 0:5cffef3371f6 125 {
RobMeades 0:5cffef3371f6 126 switch (AcTStatus) {
RobMeades 0:5cffef3371f6 127 case GSM:
RobMeades 0:5cffef3371f6 128 case COMPACT_GSM:
RobMeades 0:5cffef3371f6 129 tr_info("Connected in GSM");
RobMeades 0:5cffef3371f6 130 break;
RobMeades 0:5cffef3371f6 131 case UTRAN:
RobMeades 0:5cffef3371f6 132 tr_info("Connected to UTRAN");
RobMeades 0:5cffef3371f6 133 break;
RobMeades 0:5cffef3371f6 134 case EDGE:
RobMeades 0:5cffef3371f6 135 tr_info("Connected to EDGE");
RobMeades 0:5cffef3371f6 136 break;
RobMeades 0:5cffef3371f6 137 case HSDPA:
RobMeades 0:5cffef3371f6 138 tr_info("Connected to HSDPA");
RobMeades 0:5cffef3371f6 139 break;
RobMeades 0:5cffef3371f6 140 case HSUPA:
RobMeades 0:5cffef3371f6 141 tr_info("Connected to HSPA");
RobMeades 0:5cffef3371f6 142 break;
RobMeades 0:5cffef3371f6 143 case HSDPA_HSUPA:
RobMeades 0:5cffef3371f6 144 tr_info("Connected to HDPA/HSPA");
RobMeades 0:5cffef3371f6 145 break;
RobMeades 0:5cffef3371f6 146 case LTE:
RobMeades 0:5cffef3371f6 147 tr_info("Connected to LTE");
RobMeades 0:5cffef3371f6 148 break;
fahimalavi 10:c4281fa79b8f 149 case EC_GSM_IoT:
fahimalavi 10:c4281fa79b8f 150 tr_info("Connected to EC_GSM_IoT");
fahimalavi 10:c4281fa79b8f 151 break;
fahimalavi 10:c4281fa79b8f 152 case E_UTRAN_NB_S1:
fahimalavi 10:c4281fa79b8f 153 tr_info("Connected to E_UTRAN NB1");
fahimalavi 10:c4281fa79b8f 154 break;
RobMeades 0:5cffef3371f6 155 default:
RobMeades 0:5cffef3371f6 156 tr_info("Unknown RAT %d", AcTStatus);
RobMeades 0:5cffef3371f6 157 break;
RobMeades 0:5cffef3371f6 158 }
RobMeades 0:5cffef3371f6 159
RobMeades 0:5cffef3371f6 160 _dev_info.rat = static_cast<RadioAccessNetworkType>(AcTStatus);
RobMeades 0:5cffef3371f6 161 }
RobMeades 0:5cffef3371f6 162
RobMeades 0:5cffef3371f6 163 bool UbloxCellularBase::get_iccid()
RobMeades 0:5cffef3371f6 164 {
RobMeades 0:5cffef3371f6 165 bool success;
RobMeades 0:5cffef3371f6 166 LOCK();
RobMeades 0:5cffef3371f6 167
RobMeades 0:5cffef3371f6 168 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 169
RobMeades 0:5cffef3371f6 170 // Returns the ICCID (Integrated Circuit Card ID) of the SIM-card.
RobMeades 0:5cffef3371f6 171 // ICCID is a serial number identifying the SIM.
RobMeades 0:5cffef3371f6 172 // AT Command Manual UBX-13002752, section 4.12
RobMeades 0:5cffef3371f6 173 success = _at->send("AT+CCID") && _at->recv("+CCID: %20[^\n]\nOK\n", _dev_info.iccid);
RobMeades 0:5cffef3371f6 174 tr_info("DevInfo: ICCID=%s", _dev_info.iccid);
RobMeades 0:5cffef3371f6 175
RobMeades 0:5cffef3371f6 176 UNLOCK();
RobMeades 0:5cffef3371f6 177 return success;
RobMeades 0:5cffef3371f6 178 }
RobMeades 0:5cffef3371f6 179
RobMeades 0:5cffef3371f6 180 bool UbloxCellularBase::get_imsi()
RobMeades 0:5cffef3371f6 181 {
RobMeades 0:5cffef3371f6 182 bool success;
RobMeades 0:5cffef3371f6 183 LOCK();
RobMeades 0:5cffef3371f6 184
RobMeades 0:5cffef3371f6 185 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 186
RobMeades 0:5cffef3371f6 187 // International mobile subscriber identification
RobMeades 0:5cffef3371f6 188 // AT Command Manual UBX-13002752, section 4.11
RobMeades 0:5cffef3371f6 189 success = _at->send("AT+CIMI") && _at->recv("%15[^\n]\nOK\n", _dev_info.imsi);
RobMeades 0:5cffef3371f6 190 tr_info("DevInfo: IMSI=%s", _dev_info.imsi);
RobMeades 0:5cffef3371f6 191
RobMeades 0:5cffef3371f6 192 UNLOCK();
RobMeades 0:5cffef3371f6 193 return success;
RobMeades 0:5cffef3371f6 194 }
RobMeades 0:5cffef3371f6 195
RobMeades 0:5cffef3371f6 196 bool UbloxCellularBase::get_imei()
RobMeades 0:5cffef3371f6 197 {
RobMeades 0:5cffef3371f6 198 bool success;
RobMeades 0:5cffef3371f6 199 LOCK();
RobMeades 0:5cffef3371f6 200
RobMeades 0:5cffef3371f6 201 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 202
RobMeades 0:5cffef3371f6 203 // International mobile equipment identifier
RobMeades 0:5cffef3371f6 204 // AT Command Manual UBX-13002752, section 4.7
RobMeades 0:5cffef3371f6 205 success = _at->send("AT+CGSN") && _at->recv("%15[^\n]\nOK\n", _dev_info.imei);
RobMeades 0:5cffef3371f6 206 tr_info("DevInfo: IMEI=%s", _dev_info.imei);
RobMeades 0:5cffef3371f6 207
RobMeades 0:5cffef3371f6 208 UNLOCK();
RobMeades 0:5cffef3371f6 209 return success;
RobMeades 0:5cffef3371f6 210 }
RobMeades 0:5cffef3371f6 211
fahim alavi 11:57f64bc518c0 212 /** Get the IMEI.
fahim alavi 11:57f64bc518c0 213 *
fahim alavi 11:57f64bc518c0 214 * @return true if successful, otherwise false.
fahim alavi 11:57f64bc518c0 215 */
fahim alavi 12:aa3cbc3f88c5 216 bool UbloxCellularBase::get_imei(char *imei_to_send, int size)
fahim alavi 11:57f64bc518c0 217 {
fahim alavi 11:57f64bc518c0 218 bool success;
fahim alavi 11:57f64bc518c0 219 LOCK();
fahim alavi 11:57f64bc518c0 220
fahim alavi 11:57f64bc518c0 221 MBED_ASSERT(_at != NULL);
fahim alavi 11:57f64bc518c0 222
fahim alavi 11:57f64bc518c0 223 // International mobile equipment identifier
fahim alavi 11:57f64bc518c0 224 // AT Command Manual UBX-13002752, section 4.7
fahim alavi 11:57f64bc518c0 225 success = _at->send("AT+CGSN") && _at->recv("%15[^\n]\nOK\n", _dev_info.imei);
fahim alavi 11:57f64bc518c0 226 tr_info("DevInfo: IMEI=%s", _dev_info.imei);
fahim alavi 11:57f64bc518c0 227
fahim alavi 12:aa3cbc3f88c5 228 if (success) {
fahim alavi 11:57f64bc518c0 229 memcpy(imei_to_send,_dev_info.imei,size);
fahim alavi 11:57f64bc518c0 230 imei_to_send[size-1] = '\0';
fahim alavi 11:57f64bc518c0 231 }
fahim alavi 11:57f64bc518c0 232
fahim alavi 11:57f64bc518c0 233 UNLOCK();
fahim alavi 11:57f64bc518c0 234 return success;
fahim alavi 11:57f64bc518c0 235 }
fahim alavi 11:57f64bc518c0 236
RobMeades 0:5cffef3371f6 237 bool UbloxCellularBase::get_meid()
RobMeades 0:5cffef3371f6 238 {
RobMeades 0:5cffef3371f6 239 bool success;
RobMeades 0:5cffef3371f6 240 LOCK();
RobMeades 0:5cffef3371f6 241
RobMeades 0:5cffef3371f6 242 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 243
RobMeades 0:5cffef3371f6 244 // Mobile equipment identifier
RobMeades 0:5cffef3371f6 245 // AT Command Manual UBX-13002752, section 4.8
RobMeades 0:5cffef3371f6 246 success = _at->send("AT+GSN") && _at->recv("%18[^\n]\nOK\n", _dev_info.meid);
RobMeades 0:5cffef3371f6 247 tr_info("DevInfo: MEID=%s", _dev_info.meid);
RobMeades 0:5cffef3371f6 248
RobMeades 0:5cffef3371f6 249 UNLOCK();
RobMeades 0:5cffef3371f6 250 return success;
RobMeades 0:5cffef3371f6 251 }
RobMeades 0:5cffef3371f6 252
RobMeades 0:5cffef3371f6 253 bool UbloxCellularBase::set_sms()
RobMeades 0:5cffef3371f6 254 {
RobMeades 0:5cffef3371f6 255 bool success = false;
RobMeades 0:5cffef3371f6 256 char buf[32];
RobMeades 0:5cffef3371f6 257 LOCK();
RobMeades 0:5cffef3371f6 258
RobMeades 0:5cffef3371f6 259 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 260
RobMeades 0:5cffef3371f6 261 // Set up SMS format and enable URC
RobMeades 0:5cffef3371f6 262 // AT Command Manual UBX-13002752, section 11
RobMeades 0:5cffef3371f6 263 if (_at->send("AT+CMGF=1") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 264 tr_debug("SMS in text mode");
RobMeades 0:5cffef3371f6 265 if (_at->send("AT+CNMI=2,1") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 266 tr_debug("SMS URC enabled");
RobMeades 0:5cffef3371f6 267 // Set to CS preferred since PS preferred doesn't work
RobMeades 0:5cffef3371f6 268 // on some networks
RobMeades 0:5cffef3371f6 269 if (_at->send("AT+CGSMS=1") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 270 tr_debug("SMS set to CS preferred");
RobMeades 0:5cffef3371f6 271 success = true;
RobMeades 0:5cffef3371f6 272 memset (buf, 0, sizeof (buf));
RobMeades 0:5cffef3371f6 273 if (_at->send("AT+CSCA?") &&
RobMeades 0:5cffef3371f6 274 _at->recv("+CSCA: \"%31[^\"]\"", buf) &&
RobMeades 0:5cffef3371f6 275 _at->recv("OK")) {
RobMeades 0:5cffef3371f6 276 tr_info("SMS Service Centre address is \"%s\"", buf);
RobMeades 0:5cffef3371f6 277 }
RobMeades 0:5cffef3371f6 278 }
RobMeades 0:5cffef3371f6 279 }
RobMeades 0:5cffef3371f6 280 }
RobMeades 0:5cffef3371f6 281
RobMeades 0:5cffef3371f6 282 UNLOCK();
RobMeades 0:5cffef3371f6 283 return success;
RobMeades 0:5cffef3371f6 284 }
RobMeades 0:5cffef3371f6 285
RobMeades 0:5cffef3371f6 286 void UbloxCellularBase::parser_abort_cb()
RobMeades 0:5cffef3371f6 287 {
RobMeades 0:5cffef3371f6 288 _at->abort();
RobMeades 0:5cffef3371f6 289 }
RobMeades 0:5cffef3371f6 290
RobMeades 0:5cffef3371f6 291 // Callback for CME ERROR and CMS ERROR.
RobMeades 0:5cffef3371f6 292 void UbloxCellularBase::CMX_ERROR_URC()
RobMeades 0:5cffef3371f6 293 {
RobMeades 0:5cffef3371f6 294 char buf[48];
RobMeades 0:5cffef3371f6 295
RobMeades 0:5cffef3371f6 296 if (read_at_to_char(buf, sizeof (buf), '\n') > 0) {
RobMeades 0:5cffef3371f6 297 tr_debug("AT error %s", buf);
RobMeades 0:5cffef3371f6 298 }
RobMeades 0:5cffef3371f6 299 parser_abort_cb();
RobMeades 0:5cffef3371f6 300 }
RobMeades 0:5cffef3371f6 301
RobMeades 0:5cffef3371f6 302 // Callback for circuit switched registration URC.
RobMeades 0:5cffef3371f6 303 void UbloxCellularBase::CREG_URC()
RobMeades 0:5cffef3371f6 304 {
RobMeades 0:5cffef3371f6 305 char buf[10];
RobMeades 0:5cffef3371f6 306 int status;
RobMeades 0:5cffef3371f6 307
RobMeades 0:5cffef3371f6 308 // If this is the URC it will be a single
RobMeades 0:5cffef3371f6 309 // digit followed by \n. If it is the
RobMeades 0:5cffef3371f6 310 // answer to a CREG query, it will be
RobMeades 0:5cffef3371f6 311 // a ": %d,%d\n" where the second digit
RobMeades 0:5cffef3371f6 312 // indicates the status
RobMeades 0:5cffef3371f6 313 // Note: not calling _at->recv() from here as we're
RobMeades 0:5cffef3371f6 314 // already in an _at->recv()
RobMeades 0:5cffef3371f6 315 if (read_at_to_char(buf, sizeof (buf), '\n') > 0) {
RobMeades 0:5cffef3371f6 316 if (sscanf(buf, ": %*d,%d", &status) == 1) {
RobMeades 0:5cffef3371f6 317 set_nwk_reg_status_csd(status);
RobMeades 0:5cffef3371f6 318 } else if (sscanf(buf, ": %d", &status) == 1) {
RobMeades 0:5cffef3371f6 319 set_nwk_reg_status_csd(status);
RobMeades 0:5cffef3371f6 320 }
RobMeades 0:5cffef3371f6 321 }
RobMeades 0:5cffef3371f6 322 }
RobMeades 0:5cffef3371f6 323
RobMeades 0:5cffef3371f6 324 // Callback for packet switched registration URC.
RobMeades 0:5cffef3371f6 325 void UbloxCellularBase::CGREG_URC()
RobMeades 0:5cffef3371f6 326 {
RobMeades 0:5cffef3371f6 327 char buf[10];
RobMeades 0:5cffef3371f6 328 int status;
RobMeades 0:5cffef3371f6 329
RobMeades 0:5cffef3371f6 330 // If this is the URC it will be a single
RobMeades 0:5cffef3371f6 331 // digit followed by \n. If it is the
RobMeades 0:5cffef3371f6 332 // answer to a CGREG query, it will be
RobMeades 0:5cffef3371f6 333 // a ": %d,%d\n" where the second digit
RobMeades 0:5cffef3371f6 334 // indicates the status
RobMeades 0:5cffef3371f6 335 // Note: not calling _at->recv() from here as we're
RobMeades 0:5cffef3371f6 336 // already in an _at->recv()
RobMeades 0:5cffef3371f6 337 if (read_at_to_char(buf, sizeof (buf), '\n') > 0) {
RobMeades 0:5cffef3371f6 338 if (sscanf(buf, ": %*d,%d", &status) == 1) {
RobMeades 0:5cffef3371f6 339 set_nwk_reg_status_psd(status);
RobMeades 0:5cffef3371f6 340 } else if (sscanf(buf, ": %d", &status) == 1) {
RobMeades 0:5cffef3371f6 341 set_nwk_reg_status_psd(status);
RobMeades 0:5cffef3371f6 342 }
RobMeades 0:5cffef3371f6 343 }
RobMeades 0:5cffef3371f6 344 }
RobMeades 0:5cffef3371f6 345
RobMeades 0:5cffef3371f6 346 // Callback for EPS registration URC.
RobMeades 0:5cffef3371f6 347 void UbloxCellularBase::CEREG_URC()
RobMeades 0:5cffef3371f6 348 {
RobMeades 0:5cffef3371f6 349 char buf[10];
RobMeades 0:5cffef3371f6 350 int status;
RobMeades 0:5cffef3371f6 351
RobMeades 0:5cffef3371f6 352 // If this is the URC it will be a single
RobMeades 0:5cffef3371f6 353 // digit followed by \n. If it is the
RobMeades 0:5cffef3371f6 354 // answer to a CEREG query, it will be
RobMeades 0:5cffef3371f6 355 // a ": %d,%d\n" where the second digit
RobMeades 0:5cffef3371f6 356 // indicates the status
RobMeades 0:5cffef3371f6 357 // Note: not calling _at->recv() from here as we're
RobMeades 0:5cffef3371f6 358 // already in an _at->recv()
RobMeades 0:5cffef3371f6 359 if (read_at_to_char(buf, sizeof (buf), '\n') > 0) {
RobMeades 0:5cffef3371f6 360 if (sscanf(buf, ": %*d,%d", &status) == 1) {
RobMeades 0:5cffef3371f6 361 set_nwk_reg_status_eps(status);
RobMeades 0:5cffef3371f6 362 } else if (sscanf(buf, ": %d", &status) == 1) {
RobMeades 0:5cffef3371f6 363 set_nwk_reg_status_eps(status);
RobMeades 0:5cffef3371f6 364 }
RobMeades 0:5cffef3371f6 365 }
RobMeades 0:5cffef3371f6 366 }
RobMeades 0:5cffef3371f6 367
RobMeades 0:5cffef3371f6 368 // Callback UMWI, just filtering it out.
RobMeades 0:5cffef3371f6 369 void UbloxCellularBase::UMWI_URC()
RobMeades 0:5cffef3371f6 370 {
RobMeades 0:5cffef3371f6 371 char buf[10];
RobMeades 0:5cffef3371f6 372
RobMeades 0:5cffef3371f6 373 // Note: not calling _at->recv() from here as we're
RobMeades 0:5cffef3371f6 374 // already in an _at->recv()
RobMeades 0:5cffef3371f6 375 read_at_to_char(buf, sizeof (buf), '\n');
RobMeades 0:5cffef3371f6 376 }
RobMeades 0:5cffef3371f6 377
RobMeades 0:5cffef3371f6 378 /**********************************************************************
RobMeades 0:5cffef3371f6 379 * PROTECTED METHODS
RobMeades 0:5cffef3371f6 380 **********************************************************************/
RobMeades 0:5cffef3371f6 381
RobMeades 0:5cffef3371f6 382 #if MODEM_ON_BOARD
RobMeades 0:5cffef3371f6 383 void UbloxCellularBase::modem_init()
RobMeades 0:5cffef3371f6 384 {
RobMeades 0:5cffef3371f6 385 ::onboard_modem_init();
RobMeades 0:5cffef3371f6 386 }
RobMeades 0:5cffef3371f6 387
RobMeades 0:5cffef3371f6 388 void UbloxCellularBase::modem_deinit()
RobMeades 0:5cffef3371f6 389 {
RobMeades 0:5cffef3371f6 390 ::onboard_modem_deinit();
RobMeades 0:5cffef3371f6 391 }
RobMeades 0:5cffef3371f6 392
RobMeades 0:5cffef3371f6 393 void UbloxCellularBase::modem_power_up()
RobMeades 0:5cffef3371f6 394 {
RobMeades 0:5cffef3371f6 395 ::onboard_modem_power_up();
RobMeades 0:5cffef3371f6 396 }
RobMeades 0:5cffef3371f6 397
RobMeades 0:5cffef3371f6 398 void UbloxCellularBase::modem_power_down()
RobMeades 0:5cffef3371f6 399 {
RobMeades 0:5cffef3371f6 400 ::onboard_modem_power_down();
RobMeades 0:5cffef3371f6 401 }
RobMeades 0:5cffef3371f6 402 #else
RobMeades 0:5cffef3371f6 403 void UbloxCellularBase::modem_init()
RobMeades 0:5cffef3371f6 404 {
RobMeades 0:5cffef3371f6 405 // Meant to be overridden
RobMeades 0:5cffef3371f6 406 }
RobMeades 0:5cffef3371f6 407
RobMeades 0:5cffef3371f6 408 void UbloxCellularBase::modem_deinit()
RobMeades 0:5cffef3371f6 409 {
RobMeades 0:5cffef3371f6 410 // Meant to be overridden
RobMeades 0:5cffef3371f6 411 }
RobMeades 0:5cffef3371f6 412
RobMeades 0:5cffef3371f6 413 void UbloxCellularBase::modem_power_up()
RobMeades 0:5cffef3371f6 414 {
RobMeades 0:5cffef3371f6 415 // Meant to be overridden
RobMeades 0:5cffef3371f6 416 }
RobMeades 0:5cffef3371f6 417
RobMeades 0:5cffef3371f6 418 void UbloxCellularBase::modem_power_down()
RobMeades 0:5cffef3371f6 419 {
RobMeades 0:5cffef3371f6 420 // Mmeant to be overridden
RobMeades 0:5cffef3371f6 421 }
RobMeades 0:5cffef3371f6 422 #endif
RobMeades 0:5cffef3371f6 423
RobMeades 0:5cffef3371f6 424 // Constructor.
RobMeades 0:5cffef3371f6 425 // Note: to allow this base class to be inherited as a virtual base class
RobMeades 0:5cffef3371f6 426 // by everyone, it takes no parameters. See also comment above classInit()
RobMeades 0:5cffef3371f6 427 // in the header file.
RobMeades 0:5cffef3371f6 428 UbloxCellularBase::UbloxCellularBase()
RobMeades 0:5cffef3371f6 429 {
RobMeades 0:5cffef3371f6 430 _pin = NULL;
RobMeades 0:5cffef3371f6 431 _at = NULL;
RobMeades 0:5cffef3371f6 432 _at_timeout = AT_PARSER_TIMEOUT;
RobMeades 0:5cffef3371f6 433 _fh = NULL;
RobMeades 0:5cffef3371f6 434 _modem_initialised = false;
RobMeades 0:5cffef3371f6 435 _sim_pin_check_enabled = false;
RobMeades 0:5cffef3371f6 436 _debug_trace_on = false;
RobMeades 0:5cffef3371f6 437
RobMeades 0:5cffef3371f6 438 _dev_info.dev = DEV_TYPE_NONE;
RobMeades 0:5cffef3371f6 439 _dev_info.reg_status_csd = CSD_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 440 _dev_info.reg_status_psd = PSD_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 441 _dev_info.reg_status_eps = EPS_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 442 }
RobMeades 0:5cffef3371f6 443
RobMeades 0:5cffef3371f6 444 // Destructor.
RobMeades 0:5cffef3371f6 445 UbloxCellularBase::~UbloxCellularBase()
RobMeades 0:5cffef3371f6 446 {
RobMeades 0:5cffef3371f6 447 deinit();
RobMeades 0:5cffef3371f6 448 delete _at;
RobMeades 0:5cffef3371f6 449 delete _fh;
RobMeades 0:5cffef3371f6 450 }
RobMeades 0:5cffef3371f6 451
RobMeades 0:5cffef3371f6 452 // Initialise the portions of this class that are parameterised.
RobMeades 0:5cffef3371f6 453 void UbloxCellularBase::baseClassInit(PinName tx, PinName rx,
RobMeades 0:5cffef3371f6 454 int baud, bool debug_on)
RobMeades 0:5cffef3371f6 455 {
RobMeades 0:5cffef3371f6 456 // Only initialise ourselves if it's not already been done
RobMeades 0:5cffef3371f6 457 if (_at == NULL) {
RobMeades 0:5cffef3371f6 458 if (_debug_trace_on == false) {
RobMeades 0:5cffef3371f6 459 _debug_trace_on = debug_on;
RobMeades 0:5cffef3371f6 460 }
rob.meades@u-blox.com 4:2e640a101db1 461 _baud = baud;
RobMeades 0:5cffef3371f6 462
RobMeades 0:5cffef3371f6 463 // Set up File Handle for buffered serial comms with cellular module
RobMeades 0:5cffef3371f6 464 // (which will be used by the AT parser)
rob.meades@u-blox.com 4:2e640a101db1 465 // Note: the UART is initialised to run no faster than 115200 because
rob.meades@u-blox.com 4:2e640a101db1 466 // the modems cannot reliably auto-baud at faster rates. The faster
rob.meades@u-blox.com 4:2e640a101db1 467 // rate is adopted later with a specific AT command and the
rob.meades@u-blox.com 4:2e640a101db1 468 // UARTSerial rate is adjusted at that time
rob.meades@u-blox.com 4:2e640a101db1 469 if (baud > 115200) {
rob.meades@u-blox.com 4:2e640a101db1 470 baud = 115200;
rob.meades@u-blox.com 4:2e640a101db1 471 }
RobMeades 0:5cffef3371f6 472 _fh = new UARTSerial(tx, rx, baud);
RobMeades 0:5cffef3371f6 473
RobMeades 0:5cffef3371f6 474 // Set up the AT parser
RobMeades 0:5cffef3371f6 475 _at = new ATCmdParser(_fh, OUTPUT_ENTER_KEY, AT_PARSER_BUFFER_SIZE,
rob.meades@u-blox.com 3:f9b2cd6f72b1 476 _at_timeout, _debug_trace_on);
RobMeades 0:5cffef3371f6 477
RobMeades 0:5cffef3371f6 478 // Error cases, out of band handling
RobMeades 0:5cffef3371f6 479 _at->oob("ERROR", callback(this, &UbloxCellularBase::parser_abort_cb));
RobMeades 0:5cffef3371f6 480 _at->oob("+CME ERROR", callback(this, &UbloxCellularBase::CMX_ERROR_URC));
RobMeades 0:5cffef3371f6 481 _at->oob("+CMS ERROR", callback(this, &UbloxCellularBase::CMX_ERROR_URC));
RobMeades 0:5cffef3371f6 482
RobMeades 0:5cffef3371f6 483 // Registration status, out of band handling
RobMeades 0:5cffef3371f6 484 _at->oob("+CREG", callback(this, &UbloxCellularBase::CREG_URC));
RobMeades 0:5cffef3371f6 485 _at->oob("+CGREG", callback(this, &UbloxCellularBase::CGREG_URC));
RobMeades 0:5cffef3371f6 486 _at->oob("+CEREG", callback(this, &UbloxCellularBase::CEREG_URC));
RobMeades 0:5cffef3371f6 487
RobMeades 0:5cffef3371f6 488 // Capture the UMWI, just to stop it getting in the way
RobMeades 0:5cffef3371f6 489 _at->oob("+UMWI", callback(this, &UbloxCellularBase::UMWI_URC));
RobMeades 0:5cffef3371f6 490 }
RobMeades 0:5cffef3371f6 491 }
RobMeades 0:5cffef3371f6 492
RobMeades 0:5cffef3371f6 493 // Set the AT parser timeout.
RobMeades 0:5cffef3371f6 494 // Note: the AT interface should be locked before this is called.
RobMeades 0:5cffef3371f6 495 void UbloxCellularBase::at_set_timeout(int timeout) {
RobMeades 0:5cffef3371f6 496
RobMeades 0:5cffef3371f6 497 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 498
RobMeades 0:5cffef3371f6 499 _at_timeout = timeout;
RobMeades 0:5cffef3371f6 500 _at->set_timeout(timeout);
RobMeades 0:5cffef3371f6 501 }
RobMeades 0:5cffef3371f6 502
RobMeades 0:5cffef3371f6 503 // Read up to size bytes from the AT interface up to a "end".
RobMeades 0:5cffef3371f6 504 // Note: the AT interface should be locked before this is called.
RobMeades 0:5cffef3371f6 505 int UbloxCellularBase::read_at_to_char(char * buf, int size, char end)
RobMeades 0:5cffef3371f6 506 {
RobMeades 0:5cffef3371f6 507 int count = 0;
RobMeades 0:5cffef3371f6 508 int x = 0;
RobMeades 0:5cffef3371f6 509
RobMeades 0:5cffef3371f6 510 if (size > 0) {
RobMeades 0:5cffef3371f6 511 for (count = 0; (count < size) && (x >= 0) && (x != end); count++) {
RobMeades 0:5cffef3371f6 512 x = _at->getc();
RobMeades 0:5cffef3371f6 513 *(buf + count) = (char) x;
RobMeades 0:5cffef3371f6 514 }
RobMeades 0:5cffef3371f6 515
RobMeades 0:5cffef3371f6 516 count--;
RobMeades 0:5cffef3371f6 517 *(buf + count) = 0;
RobMeades 0:5cffef3371f6 518
RobMeades 0:5cffef3371f6 519 // Convert line endings:
RobMeades 0:5cffef3371f6 520 // If end was '\n' (0x0a) and the preceding character was 0x0d, then
RobMeades 0:5cffef3371f6 521 // overwrite that with null as well.
RobMeades 0:5cffef3371f6 522 if ((count > 0) && (end == '\n') && (*(buf + count - 1) == '\x0d')) {
RobMeades 0:5cffef3371f6 523 count--;
RobMeades 0:5cffef3371f6 524 *(buf + count) = 0;
RobMeades 0:5cffef3371f6 525 }
RobMeades 0:5cffef3371f6 526 }
RobMeades 0:5cffef3371f6 527
RobMeades 0:5cffef3371f6 528 return count;
RobMeades 0:5cffef3371f6 529 }
RobMeades 0:5cffef3371f6 530
RobMeades 0:5cffef3371f6 531 // Power up the modem.
RobMeades 0:5cffef3371f6 532 // Enables the GPIO lines to the modem and then wriggles the power line in short pulses.
RobMeades 0:5cffef3371f6 533 bool UbloxCellularBase::power_up()
RobMeades 0:5cffef3371f6 534 {
RobMeades 0:5cffef3371f6 535 bool success = false;
RobMeades 0:5cffef3371f6 536 int at_timeout;
RobMeades 0:5cffef3371f6 537 LOCK();
RobMeades 0:5cffef3371f6 538
RobMeades 0:5cffef3371f6 539 at_timeout = _at_timeout; // Has to be inside LOCK()s
RobMeades 0:5cffef3371f6 540
RobMeades 0:5cffef3371f6 541 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 542
RobMeades 0:5cffef3371f6 543 /* Initialize GPIO lines */
RobMeades 0:5cffef3371f6 544 tr_info("Powering up modem...");
pilotak 7:c2cf27a981b3 545 modem_init();
RobMeades 0:5cffef3371f6 546 /* Give modem a little time to settle down */
RobMeades 0:5cffef3371f6 547 wait_ms(250);
RobMeades 0:5cffef3371f6 548
RobMeades 0:5cffef3371f6 549 for (int retry_count = 0; !success && (retry_count < 20); retry_count++) {
pilotak 7:c2cf27a981b3 550 modem_power_up();
RobMeades 0:5cffef3371f6 551 wait_ms(500);
RobMeades 0:5cffef3371f6 552 // Modem tends to spit out noise during power up - don't confuse the parser
RobMeades 0:5cffef3371f6 553 _at->flush();
RobMeades 0:5cffef3371f6 554 at_set_timeout(1000);
RobMeades 0:5cffef3371f6 555 if (_at->send("AT")) {
RobMeades 0:5cffef3371f6 556 // C027 needs a delay here
RobMeades 0:5cffef3371f6 557 wait_ms(100);
RobMeades 0:5cffef3371f6 558 if (_at->recv("OK")) {
RobMeades 0:5cffef3371f6 559 success = true;
RobMeades 0:5cffef3371f6 560 }
RobMeades 0:5cffef3371f6 561 }
RobMeades 0:5cffef3371f6 562 at_set_timeout(at_timeout);
RobMeades 0:5cffef3371f6 563 }
RobMeades 0:5cffef3371f6 564
rob.meades@u-blox.com 4:2e640a101db1 565 if (success) {
rob.meades@u-blox.com 4:2e640a101db1 566 // Set the final baud rate
rob.meades@u-blox.com 4:2e640a101db1 567 if (_at->send("AT+IPR=%d", _baud) && _at->recv("OK")) {
rob.meades@u-blox.com 4:2e640a101db1 568 // Need to wait for things to be sorted out on the modem side
rob.meades@u-blox.com 4:2e640a101db1 569 wait_ms(100);
rob.meades@u-blox.com 4:2e640a101db1 570 ((UARTSerial *)_fh)->set_baud(_baud);
rob.meades@u-blox.com 4:2e640a101db1 571 }
rob.meades@u-blox.com 4:2e640a101db1 572
rob.meades@u-blox.com 4:2e640a101db1 573 // Turn off modem echoing and turn on verbose responses
rob.meades@u-blox.com 4:2e640a101db1 574 success = _at->send("ATE0;+CMEE=2") && _at->recv("OK") &&
rob.meades@u-blox.com 4:2e640a101db1 575 // The following commands are best sent separately
rob.meades@u-blox.com 4:2e640a101db1 576 _at->send("AT&K0") && _at->recv("OK") && // Turn off RTC/CTS handshaking
rob.meades@u-blox.com 4:2e640a101db1 577 _at->send("AT&C1") && _at->recv("OK") && // Set DCD circuit(109), changes in accordance with the carrier detect status
rob.meades@u-blox.com 4:2e640a101db1 578 _at->send("AT&D0") && _at->recv("OK"); // Set DTR circuit, we ignore the state change of DTR
rob.meades@u-blox.com 4:2e640a101db1 579 }
RobMeades 0:5cffef3371f6 580
RobMeades 0:5cffef3371f6 581 if (!success) {
RobMeades 0:5cffef3371f6 582 tr_error("Preliminary modem setup failed.");
RobMeades 0:5cffef3371f6 583 }
RobMeades 0:5cffef3371f6 584
RobMeades 0:5cffef3371f6 585 UNLOCK();
RobMeades 0:5cffef3371f6 586 return success;
RobMeades 0:5cffef3371f6 587 }
RobMeades 0:5cffef3371f6 588
RobMeades 0:5cffef3371f6 589 // Power down modem via AT interface.
RobMeades 0:5cffef3371f6 590 void UbloxCellularBase::power_down()
RobMeades 0:5cffef3371f6 591 {
RobMeades 0:5cffef3371f6 592 LOCK();
RobMeades 0:5cffef3371f6 593
RobMeades 0:5cffef3371f6 594 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 595
RobMeades 0:5cffef3371f6 596 // If we have been running, do a soft power-off first
RobMeades 0:5cffef3371f6 597 if (_modem_initialised && (_at != NULL)) {
RobMeades 0:5cffef3371f6 598 _at->send("AT+CPWROFF") && _at->recv("OK");
RobMeades 0:5cffef3371f6 599 }
RobMeades 0:5cffef3371f6 600
RobMeades 0:5cffef3371f6 601 // Now do a hard power-off
pilotak 7:c2cf27a981b3 602 modem_power_down();
pilotak 7:c2cf27a981b3 603 modem_deinit();
RobMeades 0:5cffef3371f6 604
RobMeades 0:5cffef3371f6 605 _dev_info.reg_status_csd = CSD_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 606 _dev_info.reg_status_psd = PSD_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 607 _dev_info.reg_status_eps = EPS_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 608
RobMeades 0:5cffef3371f6 609 UNLOCK();
RobMeades 0:5cffef3371f6 610 }
RobMeades 0:5cffef3371f6 611
RobMeades 0:5cffef3371f6 612 // Get the device ID.
RobMeades 0:5cffef3371f6 613 bool UbloxCellularBase::set_device_identity(DeviceType *dev)
RobMeades 0:5cffef3371f6 614 {
RobMeades 0:5cffef3371f6 615 char buf[20];
RobMeades 0:5cffef3371f6 616 bool success;
RobMeades 0:5cffef3371f6 617 LOCK();
RobMeades 0:5cffef3371f6 618
RobMeades 0:5cffef3371f6 619 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 620
RobMeades 0:5cffef3371f6 621 success = _at->send("ATI") && _at->recv("%19[^\n]\nOK\n", buf);
RobMeades 0:5cffef3371f6 622
RobMeades 0:5cffef3371f6 623 if (success) {
RobMeades 0:5cffef3371f6 624 if (strstr(buf, "SARA-G35"))
RobMeades 0:5cffef3371f6 625 *dev = DEV_SARA_G35;
RobMeades 0:5cffef3371f6 626 else if (strstr(buf, "LISA-U200-03S"))
RobMeades 0:5cffef3371f6 627 *dev = DEV_LISA_U2_03S;
RobMeades 0:5cffef3371f6 628 else if (strstr(buf, "LISA-U2"))
RobMeades 0:5cffef3371f6 629 *dev = DEV_LISA_U2;
RobMeades 0:5cffef3371f6 630 else if (strstr(buf, "SARA-U2"))
RobMeades 0:5cffef3371f6 631 *dev = DEV_SARA_U2;
fahimalavi 10:c4281fa79b8f 632 else if (strstr(buf, "SARA-R4"))
fahimalavi 10:c4281fa79b8f 633 *dev = DEV_SARA_R4;
RobMeades 0:5cffef3371f6 634 else if (strstr(buf, "LEON-G2"))
RobMeades 0:5cffef3371f6 635 *dev = DEV_LEON_G2;
RobMeades 0:5cffef3371f6 636 else if (strstr(buf, "TOBY-L2"))
RobMeades 0:5cffef3371f6 637 *dev = DEV_TOBY_L2;
RobMeades 0:5cffef3371f6 638 else if (strstr(buf, "MPCI-L2"))
RobMeades 0:5cffef3371f6 639 *dev = DEV_MPCI_L2;
RobMeades 0:5cffef3371f6 640 }
RobMeades 0:5cffef3371f6 641
RobMeades 0:5cffef3371f6 642 UNLOCK();
RobMeades 0:5cffef3371f6 643 return success;
RobMeades 0:5cffef3371f6 644 }
RobMeades 0:5cffef3371f6 645
RobMeades 0:5cffef3371f6 646 // Send initialisation AT commands that are specific to the device.
RobMeades 0:5cffef3371f6 647 bool UbloxCellularBase::device_init(DeviceType dev)
RobMeades 0:5cffef3371f6 648 {
RobMeades 0:5cffef3371f6 649 bool success = false;
RobMeades 0:5cffef3371f6 650 LOCK();
RobMeades 0:5cffef3371f6 651
RobMeades 0:5cffef3371f6 652 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 653
RobMeades 0:5cffef3371f6 654 if ((dev == DEV_LISA_U2) || (dev == DEV_LEON_G2) || (dev == DEV_TOBY_L2)) {
RobMeades 0:5cffef3371f6 655 success = _at->send("AT+UGPIOC=20,2") && _at->recv("OK");
RobMeades 0:5cffef3371f6 656 } else if ((dev == DEV_SARA_U2) || (dev == DEV_SARA_G35)) {
RobMeades 0:5cffef3371f6 657 success = _at->send("AT+UGPIOC=16,2") && _at->recv("OK");
RobMeades 0:5cffef3371f6 658 } else {
RobMeades 0:5cffef3371f6 659 success = true;
RobMeades 0:5cffef3371f6 660 }
RobMeades 0:5cffef3371f6 661
RobMeades 0:5cffef3371f6 662 UNLOCK();
RobMeades 0:5cffef3371f6 663 return success;
RobMeades 0:5cffef3371f6 664 }
RobMeades 0:5cffef3371f6 665
RobMeades 0:5cffef3371f6 666 // Get the SIM card going.
RobMeades 0:5cffef3371f6 667 bool UbloxCellularBase::initialise_sim_card()
RobMeades 0:5cffef3371f6 668 {
RobMeades 0:5cffef3371f6 669 bool success = false;
RobMeades 0:5cffef3371f6 670 int retry_count = 0;
RobMeades 0:5cffef3371f6 671 bool done = false;
RobMeades 0:5cffef3371f6 672 LOCK();
RobMeades 0:5cffef3371f6 673
RobMeades 0:5cffef3371f6 674 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 675
RobMeades 0:5cffef3371f6 676 /* SIM initialisation may take a significant amount, so an error is
RobMeades 0:5cffef3371f6 677 * kind of expected. We should retry 10 times until we succeed or timeout. */
RobMeades 0:5cffef3371f6 678 for (retry_count = 0; !done && (retry_count < 10); retry_count++) {
RobMeades 0:5cffef3371f6 679 char pinstr[16];
RobMeades 0:5cffef3371f6 680
RobMeades 0:5cffef3371f6 681 if (_at->send("AT+CPIN?") && _at->recv("+CPIN: %15[^\n]\n", pinstr) &&
RobMeades 0:5cffef3371f6 682 _at->recv("OK")) {
RobMeades 0:5cffef3371f6 683 done = true;
RobMeades 0:5cffef3371f6 684 if (strcmp(pinstr, "SIM PIN") == 0) {
RobMeades 0:5cffef3371f6 685 _sim_pin_check_enabled = true;
RobMeades 0:5cffef3371f6 686 if (_at->send("AT+CPIN=\"%s\"", _pin)) {
RobMeades 0:5cffef3371f6 687 if (_at->recv("OK")) {
RobMeades 0:5cffef3371f6 688 tr_info("PIN correct");
RobMeades 0:5cffef3371f6 689 success = true;
RobMeades 0:5cffef3371f6 690 } else {
RobMeades 0:5cffef3371f6 691 tr_error("Incorrect PIN");
RobMeades 0:5cffef3371f6 692 }
RobMeades 0:5cffef3371f6 693 }
RobMeades 0:5cffef3371f6 694 } else if (strcmp(pinstr, "READY") == 0) {
RobMeades 0:5cffef3371f6 695 _sim_pin_check_enabled = false;
RobMeades 0:5cffef3371f6 696 tr_info("No PIN required");
RobMeades 0:5cffef3371f6 697 success = true;
RobMeades 0:5cffef3371f6 698 } else {
RobMeades 0:5cffef3371f6 699 tr_debug("Unexpected response from SIM: \"%s\"", pinstr);
RobMeades 0:5cffef3371f6 700 }
RobMeades 0:5cffef3371f6 701 }
RobMeades 0:5cffef3371f6 702
RobMeades 0:5cffef3371f6 703 /* wait for a second before retry */
RobMeades 0:5cffef3371f6 704 wait_ms(1000);
RobMeades 0:5cffef3371f6 705 }
RobMeades 0:5cffef3371f6 706
RobMeades 0:5cffef3371f6 707 if (done) {
RobMeades 0:5cffef3371f6 708 tr_info("SIM Ready.");
RobMeades 0:5cffef3371f6 709 } else {
RobMeades 0:5cffef3371f6 710 tr_error("SIM not ready.");
RobMeades 0:5cffef3371f6 711 }
RobMeades 0:5cffef3371f6 712
RobMeades 0:5cffef3371f6 713 UNLOCK();
RobMeades 0:5cffef3371f6 714 return success;
RobMeades 0:5cffef3371f6 715 }
RobMeades 0:5cffef3371f6 716
RobMeades 0:5cffef3371f6 717 /**********************************************************************
RobMeades 0:5cffef3371f6 718 * PUBLIC METHODS
RobMeades 0:5cffef3371f6 719 **********************************************************************/
RobMeades 0:5cffef3371f6 720
RobMeades 0:5cffef3371f6 721 // Initialise the modem.
RobMeades 0:5cffef3371f6 722 bool UbloxCellularBase::init(const char *pin)
RobMeades 0:5cffef3371f6 723 {
RobMeades 8:a15349fcab25 724 int x;
RobMeades 0:5cffef3371f6 725 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 726
RobMeades 0:5cffef3371f6 727 if (!_modem_initialised) {
RobMeades 0:5cffef3371f6 728 if (power_up()) {
RobMeades 0:5cffef3371f6 729 tr_info("Modem Ready.");
RobMeades 0:5cffef3371f6 730 if (pin != NULL) {
RobMeades 0:5cffef3371f6 731 _pin = pin;
RobMeades 0:5cffef3371f6 732 }
RobMeades 0:5cffef3371f6 733 if (initialise_sim_card()) {
RobMeades 0:5cffef3371f6 734 if (set_device_identity(&_dev_info.dev) && // Set up device identity
rob.meades@u-blox.com 6:8fadf1e49487 735 device_init(_dev_info.dev)) {// Initialise this device
rob.meades@u-blox.com 6:8fadf1e49487 736 // Get the integrated circuit ID of the SIM
rob.meades@u-blox.com 6:8fadf1e49487 737 if (get_iccid()) {
rob.meades@u-blox.com 6:8fadf1e49487 738 // Try a few times to get the IMSI (since on some modems this can
rob.meades@u-blox.com 6:8fadf1e49487 739 // take a while to be retrieved, especially if a SIM PIN
rob.meades@u-blox.com 6:8fadf1e49487 740 // was set)
RobMeades 8:a15349fcab25 741 for (x = 0; (x < 3) && !get_imsi(); x++) {
rob.meades@u-blox.com 6:8fadf1e49487 742 wait_ms(1000);
rob.meades@u-blox.com 6:8fadf1e49487 743 }
rob.meades@u-blox.com 6:8fadf1e49487 744
RobMeades 8:a15349fcab25 745 if (x < 3) { // If we got the IMSI, can get the others
rob.meades@u-blox.com 6:8fadf1e49487 746 if (get_imei() && // Get international mobile equipment identifier
rob.meades@u-blox.com 6:8fadf1e49487 747 get_meid() && // Probably the same as the IMEI
rob.meades@u-blox.com 6:8fadf1e49487 748 set_sms()) { // And set up SMS
rob.meades@u-blox.com 6:8fadf1e49487 749 // The modem is initialised.
rob.meades@u-blox.com 6:8fadf1e49487 750 _modem_initialised = true;
rob.meades@u-blox.com 6:8fadf1e49487 751 }
rob.meades@u-blox.com 6:8fadf1e49487 752 }
rob.meades@u-blox.com 6:8fadf1e49487 753 }
RobMeades 0:5cffef3371f6 754 }
RobMeades 0:5cffef3371f6 755 }
RobMeades 0:5cffef3371f6 756 }
RobMeades 0:5cffef3371f6 757 }
RobMeades 0:5cffef3371f6 758
RobMeades 0:5cffef3371f6 759 return _modem_initialised;
RobMeades 0:5cffef3371f6 760 }
RobMeades 0:5cffef3371f6 761
RobMeades 0:5cffef3371f6 762 // Perform registration.
RobMeades 0:5cffef3371f6 763 bool UbloxCellularBase::nwk_registration()
RobMeades 0:5cffef3371f6 764 {
RobMeades 0:5cffef3371f6 765 bool atSuccess = false;
RobMeades 0:5cffef3371f6 766 bool registered = false;
RobMeades 0:5cffef3371f6 767 int status;
RobMeades 0:5cffef3371f6 768 int at_timeout;
RobMeades 0:5cffef3371f6 769 LOCK();
RobMeades 0:5cffef3371f6 770
RobMeades 0:5cffef3371f6 771 at_timeout = _at_timeout; // Has to be inside LOCK()s
RobMeades 0:5cffef3371f6 772
RobMeades 0:5cffef3371f6 773 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 774
RobMeades 0:5cffef3371f6 775 if (!is_registered_psd() && !is_registered_csd() && !is_registered_eps()) {
RobMeades 0:5cffef3371f6 776 tr_info("Searching Network...");
RobMeades 0:5cffef3371f6 777 // Enable the packet switched and network registration unsolicited result codes
RobMeades 0:5cffef3371f6 778 if (_at->send("AT+CREG=1") && _at->recv("OK") &&
RobMeades 0:5cffef3371f6 779 _at->send("AT+CGREG=1") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 780 atSuccess = true;
RobMeades 0:5cffef3371f6 781 if (_at->send("AT+CEREG=1")) {
RobMeades 0:5cffef3371f6 782 _at->recv("OK");
RobMeades 0:5cffef3371f6 783 // Don't check return value as this works for LTE only
RobMeades 0:5cffef3371f6 784 }
RobMeades 0:5cffef3371f6 785
RobMeades 0:5cffef3371f6 786 if (atSuccess) {
RobMeades 0:5cffef3371f6 787 // See if we are already in automatic mode
RobMeades 0:5cffef3371f6 788 if (_at->send("AT+COPS?") && _at->recv("+COPS: %d", &status) &&
RobMeades 0:5cffef3371f6 789 _at->recv("OK")) {
RobMeades 0:5cffef3371f6 790 // If not, set it
RobMeades 0:5cffef3371f6 791 if (status != 0) {
RobMeades 0:5cffef3371f6 792 // Don't check return code here as there's not much
RobMeades 0:5cffef3371f6 793 // we can do if this fails.
RobMeades 0:5cffef3371f6 794 _at->send("AT+COPS=0") && _at->recv("OK");
RobMeades 0:5cffef3371f6 795 }
RobMeades 0:5cffef3371f6 796 }
RobMeades 0:5cffef3371f6 797
RobMeades 0:5cffef3371f6 798 // Query the registration status directly as well,
RobMeades 0:5cffef3371f6 799 // just in case
RobMeades 0:5cffef3371f6 800 if (_at->send("AT+CREG?") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 801 // Answer will be processed by URC
RobMeades 0:5cffef3371f6 802 }
RobMeades 0:5cffef3371f6 803 if (_at->send("AT+CGREG?") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 804 // Answer will be processed by URC
RobMeades 0:5cffef3371f6 805 }
RobMeades 0:5cffef3371f6 806 if (_at->send("AT+CEREG?")) {
RobMeades 0:5cffef3371f6 807 _at->recv("OK");
RobMeades 0:5cffef3371f6 808 // Don't check return value as this works for LTE only
RobMeades 0:5cffef3371f6 809 }
RobMeades 0:5cffef3371f6 810 }
RobMeades 0:5cffef3371f6 811 }
RobMeades 0:5cffef3371f6 812 // Wait for registration to succeed
RobMeades 0:5cffef3371f6 813 at_set_timeout(1000);
RobMeades 0:5cffef3371f6 814 for (int waitSeconds = 0; !registered && (waitSeconds < 180); waitSeconds++) {
RobMeades 0:5cffef3371f6 815 registered = is_registered_psd() || is_registered_csd() || is_registered_eps();
RobMeades 0:5cffef3371f6 816 _at->recv(UNNATURAL_STRING);
RobMeades 0:5cffef3371f6 817 }
RobMeades 0:5cffef3371f6 818 at_set_timeout(at_timeout);
RobMeades 0:5cffef3371f6 819
RobMeades 0:5cffef3371f6 820 if (registered) {
RobMeades 0:5cffef3371f6 821 // This should return quickly but sometimes the status field is not returned
RobMeades 0:5cffef3371f6 822 // so make the timeout short
RobMeades 0:5cffef3371f6 823 at_set_timeout(1000);
RobMeades 0:5cffef3371f6 824 if (_at->send("AT+COPS?") && _at->recv("+COPS: %*d,%*d,\"%*[^\"]\",%d\n", &status)) {
RobMeades 0:5cffef3371f6 825 set_rat(status);
RobMeades 0:5cffef3371f6 826 }
RobMeades 0:5cffef3371f6 827 at_set_timeout(at_timeout);
RobMeades 0:5cffef3371f6 828 }
RobMeades 0:5cffef3371f6 829 } else {
RobMeades 0:5cffef3371f6 830 registered = true;
RobMeades 0:5cffef3371f6 831 }
RobMeades 0:5cffef3371f6 832
RobMeades 0:5cffef3371f6 833 UNLOCK();
RobMeades 0:5cffef3371f6 834 return registered;
RobMeades 0:5cffef3371f6 835 }
RobMeades 0:5cffef3371f6 836
RobMeades 0:5cffef3371f6 837 bool UbloxCellularBase::is_registered_csd()
RobMeades 0:5cffef3371f6 838 {
RobMeades 0:5cffef3371f6 839 return (_dev_info.reg_status_csd == CSD_REGISTERED) ||
RobMeades 0:5cffef3371f6 840 (_dev_info.reg_status_csd == CSD_REGISTERED_ROAMING) ||
RobMeades 0:5cffef3371f6 841 (_dev_info.reg_status_csd == CSD_CSFB_NOT_PREFERRED);
RobMeades 0:5cffef3371f6 842 }
RobMeades 0:5cffef3371f6 843
RobMeades 0:5cffef3371f6 844 bool UbloxCellularBase::is_registered_psd()
RobMeades 0:5cffef3371f6 845 {
RobMeades 0:5cffef3371f6 846 return (_dev_info.reg_status_psd == PSD_REGISTERED) ||
RobMeades 0:5cffef3371f6 847 (_dev_info.reg_status_psd == PSD_REGISTERED_ROAMING);
RobMeades 0:5cffef3371f6 848 }
RobMeades 0:5cffef3371f6 849
RobMeades 0:5cffef3371f6 850 bool UbloxCellularBase::is_registered_eps()
RobMeades 0:5cffef3371f6 851 {
RobMeades 0:5cffef3371f6 852 return (_dev_info.reg_status_eps == EPS_REGISTERED) ||
RobMeades 0:5cffef3371f6 853 (_dev_info.reg_status_eps == EPS_REGISTERED_ROAMING);
RobMeades 0:5cffef3371f6 854 }
RobMeades 0:5cffef3371f6 855
RobMeades 0:5cffef3371f6 856 // Perform deregistration.
RobMeades 0:5cffef3371f6 857 bool UbloxCellularBase::nwk_deregistration()
RobMeades 0:5cffef3371f6 858 {
RobMeades 0:5cffef3371f6 859 bool success = false;
RobMeades 0:5cffef3371f6 860 LOCK();
RobMeades 0:5cffef3371f6 861
RobMeades 0:5cffef3371f6 862 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 863
RobMeades 0:5cffef3371f6 864 if (_at->send("AT+COPS=2") && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 865 _dev_info.reg_status_csd = CSD_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 866 _dev_info.reg_status_psd = PSD_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 867 _dev_info.reg_status_eps = EPS_NOT_REGISTERED_NOT_SEARCHING;
RobMeades 0:5cffef3371f6 868 success = true;
RobMeades 0:5cffef3371f6 869 }
RobMeades 0:5cffef3371f6 870
RobMeades 0:5cffef3371f6 871 UNLOCK();
RobMeades 0:5cffef3371f6 872 return success;
RobMeades 0:5cffef3371f6 873 }
RobMeades 0:5cffef3371f6 874
RobMeades 0:5cffef3371f6 875 // Put the modem into its lowest power state.
RobMeades 0:5cffef3371f6 876 void UbloxCellularBase::deinit()
RobMeades 0:5cffef3371f6 877 {
RobMeades 0:5cffef3371f6 878 power_down();
RobMeades 0:5cffef3371f6 879 _modem_initialised = false;
RobMeades 0:5cffef3371f6 880 }
RobMeades 0:5cffef3371f6 881
RobMeades 0:5cffef3371f6 882 // Set the PIN.
RobMeades 0:5cffef3371f6 883 void UbloxCellularBase::set_pin(const char *pin) {
RobMeades 0:5cffef3371f6 884 _pin = pin;
RobMeades 0:5cffef3371f6 885 }
RobMeades 0:5cffef3371f6 886
RobMeades 0:5cffef3371f6 887 // Enable or disable SIM pin checking.
rob.meades@u-blox.com 4:2e640a101db1 888 bool UbloxCellularBase::sim_pin_check_enable(bool enableNotDisable)
RobMeades 0:5cffef3371f6 889 {
RobMeades 0:5cffef3371f6 890 bool success = false;;
RobMeades 0:5cffef3371f6 891 LOCK();
RobMeades 0:5cffef3371f6 892
RobMeades 0:5cffef3371f6 893 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 894
RobMeades 0:5cffef3371f6 895 if (_pin != NULL) {
RobMeades 0:5cffef3371f6 896 if (_sim_pin_check_enabled && !enableNotDisable) {
RobMeades 0:5cffef3371f6 897 // Disable the SIM lock
RobMeades 0:5cffef3371f6 898 if (_at->send("AT+CLCK=\"SC\",0,\"%s\"", _pin) && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 899 _sim_pin_check_enabled = false;
RobMeades 0:5cffef3371f6 900 success = true;
RobMeades 0:5cffef3371f6 901 }
RobMeades 0:5cffef3371f6 902 } else if (!_sim_pin_check_enabled && enableNotDisable) {
RobMeades 0:5cffef3371f6 903 // Enable the SIM lock
RobMeades 0:5cffef3371f6 904 if (_at->send("AT+CLCK=\"SC\",1,\"%s\"", _pin) && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 905 _sim_pin_check_enabled = true;
RobMeades 0:5cffef3371f6 906 success = true;
RobMeades 0:5cffef3371f6 907 }
RobMeades 0:5cffef3371f6 908 } else {
RobMeades 0:5cffef3371f6 909 success = true;
RobMeades 0:5cffef3371f6 910 }
RobMeades 0:5cffef3371f6 911 }
RobMeades 0:5cffef3371f6 912
RobMeades 0:5cffef3371f6 913 UNLOCK();
RobMeades 0:5cffef3371f6 914 return success;
RobMeades 0:5cffef3371f6 915 }
RobMeades 0:5cffef3371f6 916
RobMeades 0:5cffef3371f6 917 // Change the pin code for the SIM card.
RobMeades 0:5cffef3371f6 918 bool UbloxCellularBase::change_sim_pin(const char *pin)
RobMeades 0:5cffef3371f6 919 {
RobMeades 0:5cffef3371f6 920 bool success = false;;
RobMeades 0:5cffef3371f6 921 LOCK();
RobMeades 0:5cffef3371f6 922
RobMeades 0:5cffef3371f6 923 MBED_ASSERT(_at != NULL);
RobMeades 0:5cffef3371f6 924
RobMeades 0:5cffef3371f6 925 // Change the SIM pin
RobMeades 0:5cffef3371f6 926 if ((pin != NULL) && (_pin != NULL)) {
RobMeades 0:5cffef3371f6 927 if (_at->send("AT+CPWD=\"SC\",\"%s\",\"%s\"", _pin, pin) && _at->recv("OK")) {
RobMeades 0:5cffef3371f6 928 _pin = pin;
RobMeades 0:5cffef3371f6 929 success = true;
RobMeades 0:5cffef3371f6 930 }
RobMeades 0:5cffef3371f6 931 }
RobMeades 0:5cffef3371f6 932
RobMeades 0:5cffef3371f6 933 UNLOCK();
RobMeades 0:5cffef3371f6 934 return success;
RobMeades 0:5cffef3371f6 935 }
RobMeades 0:5cffef3371f6 936
RobMeades 0:5cffef3371f6 937 // End of File
RobMeades 0:5cffef3371f6 938