src/gsm/gsm48.c

   1 /* GSM Mobile Radio Interface Layer 3 messages
   2  * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */
   3
   4 /* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
   5  * (C) 2008, 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
   6  *
   7  * All Rights Reserved
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  *
  23  */
  24
  25 #include <stdint.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28
  29 #include <arpa/inet.h>
  30
  31 #include <osmocore/utils.h>
  32 #include <osmocore/tlv.h>
  33 #include <osmocore/gsm48.h>
  34
  35 #include <osmocore/protocol/gsm_04_08.h>
  36
  37 const struct tlv_definition gsm48_att_tlvdef = {
  38         .def = {
  39                 [GSM48_IE_MOBILE_ID]    = { TLV_TYPE_TLV },
  40                 [GSM48_IE_NAME_LONG]    = { TLV_TYPE_TLV },
  41                 [GSM48_IE_NAME_SHORT]   = { TLV_TYPE_TLV },
  42                 [GSM48_IE_UTC]          = { TLV_TYPE_TV },
  43                 [GSM48_IE_NET_TIME_TZ]  = { TLV_TYPE_FIXED, 7 },
  44                 [GSM48_IE_LSA_IDENT]    = { TLV_TYPE_TLV },
  45
  46                 [GSM48_IE_BEARER_CAP]   = { TLV_TYPE_TLV },
  47                 [GSM48_IE_CAUSE]        = { TLV_TYPE_TLV },
  48                 [GSM48_IE_CC_CAP]       = { TLV_TYPE_TLV },
  49                 [GSM48_IE_ALERT]        = { TLV_TYPE_TLV },
  50                 [GSM48_IE_FACILITY]     = { TLV_TYPE_TLV },
  51                 [GSM48_IE_PROGR_IND]    = { TLV_TYPE_TLV },
  52                 [GSM48_IE_AUX_STATUS]   = { TLV_TYPE_TLV },
  53                 [GSM48_IE_NOTIFY]       = { TLV_TYPE_TV },
  54                 [GSM48_IE_KPD_FACILITY] = { TLV_TYPE_TV },
  55                 [GSM48_IE_SIGNAL]       = { TLV_TYPE_TV },
  56                 [GSM48_IE_CONN_BCD]     = { TLV_TYPE_TLV },
  57                 [GSM48_IE_CONN_SUB]     = { TLV_TYPE_TLV },
  58                 [GSM48_IE_CALLING_BCD]  = { TLV_TYPE_TLV },
  59                 [GSM48_IE_CALLING_SUB]  = { TLV_TYPE_TLV },
  60                 [GSM48_IE_CALLED_BCD]   = { TLV_TYPE_TLV },
  61                 [GSM48_IE_CALLED_SUB]   = { TLV_TYPE_TLV },
  62                 [GSM48_IE_REDIR_BCD]    = { TLV_TYPE_TLV },
  63                 [GSM48_IE_REDIR_SUB]    = { TLV_TYPE_TLV },
  64                 [GSM48_IE_LOWL_COMPAT]  = { TLV_TYPE_TLV },
  65                 [GSM48_IE_HIGHL_COMPAT] = { TLV_TYPE_TLV },
  66                 [GSM48_IE_USER_USER]    = { TLV_TYPE_TLV },
  67                 [GSM48_IE_SS_VERS]      = { TLV_TYPE_TLV },
  68                 [GSM48_IE_MORE_DATA]    = { TLV_TYPE_T },
  69                 [GSM48_IE_CLIR_SUPP]    = { TLV_TYPE_T },
  70                 [GSM48_IE_CLIR_INVOC]   = { TLV_TYPE_T },
  71                 [GSM48_IE_REV_C_SETUP]  = { TLV_TYPE_T },
  72                 [GSM48_IE_REPEAT_CIR]   = { TLV_TYPE_T },
  73                 [GSM48_IE_REPEAT_SEQ]   = { TLV_TYPE_T },
  74                 /* FIXME: more elements */
  75         },
  76 };
  77
  78 /* RR elements */
  79 const struct tlv_definition gsm48_rr_att_tlvdef = {
  80         .def = {
  81                 /* NOTE: Don't add IE 17 = MOBILE_ID here, it already used. */
  82                 [GSM48_IE_VGCS_TARGET]          = { TLV_TYPE_TLV },
  83                 [GSM48_IE_FRQSHORT_AFTER]       = { TLV_TYPE_FIXED, 9 },
  84                 [GSM48_IE_MUL_RATE_CFG]         = { TLV_TYPE_TLV },
  85                 [GSM48_IE_FREQ_L_AFTER]         = { TLV_TYPE_TLV },
  86                 [GSM48_IE_MSLOT_DESC]           = { TLV_TYPE_TLV },
  87                 [GSM48_IE_CHANMODE_2]           = { TLV_TYPE_TV },
  88                 [GSM48_IE_FRQSHORT_BEFORE]      = { TLV_TYPE_FIXED, 9 },
  89                 [GSM48_IE_CHANMODE_3]           = { TLV_TYPE_TV },
  90                 [GSM48_IE_CHANMODE_4]           = { TLV_TYPE_TV },
  91                 [GSM48_IE_CHANMODE_5]           = { TLV_TYPE_TV },
  92                 [GSM48_IE_CHANMODE_6]           = { TLV_TYPE_TV },
  93                 [GSM48_IE_CHANMODE_7]           = { TLV_TYPE_TV },
  94                 [GSM48_IE_CHANMODE_8]           = { TLV_TYPE_TV },
  95                 [GSM48_IE_FREQ_L_BEFORE]        = { TLV_TYPE_TLV },
  96                 [GSM48_IE_CH_DESC_1_BEFORE]     = { TLV_TYPE_FIXED, 3 },
  97                 [GSM48_IE_CH_DESC_2_BEFORE]     = { TLV_TYPE_FIXED, 3 },
  98                 [GSM48_IE_F_CH_SEQ_BEFORE]      = { TLV_TYPE_FIXED, 9 },
  99                 [GSM48_IE_CLASSMARK3]           = { TLV_TYPE_TLV },
 100                 [GSM48_IE_MA_BEFORE]            = { TLV_TYPE_TLV },
 101                 [GSM48_IE_RR_PACKET_UL]         = { TLV_TYPE_TLV },
 102                 [GSM48_IE_RR_PACKET_DL]         = { TLV_TYPE_TLV },
 103                 [GSM48_IE_CELL_CH_DESC]         = { TLV_TYPE_FIXED, 16 },
 104                 [GSM48_IE_CHANMODE_1]           = { TLV_TYPE_TV },
 105                 [GSM48_IE_CHDES_2_AFTER]        = { TLV_TYPE_FIXED, 3 },
 106                 [GSM48_IE_MODE_SEC_CH]          = { TLV_TYPE_TV },
 107                 [GSM48_IE_F_CH_SEQ_AFTER]               = { TLV_TYPE_FIXED, 9 },
 108                 [GSM48_IE_MA_AFTER]             = { TLV_TYPE_TLV },
 109                 [GSM48_IE_BA_RANGE]             = { TLV_TYPE_TLV },
 110                 [GSM48_IE_GROUP_CHDES]          = { TLV_TYPE_TLV },
 111                 [GSM48_IE_BA_LIST_PREF]         = { TLV_TYPE_TLV },
 112                 [GSM48_IE_MOB_OVSERV_DIF]       = { TLV_TYPE_TLV },
 113                 [GSM48_IE_REALTIME_DIFF]        = { TLV_TYPE_TLV },
 114                 [GSM48_IE_START_TIME]           = { TLV_TYPE_FIXED, 2 },
 115                 [GSM48_IE_TIMING_ADVANCE]       = { TLV_TYPE_TV },
 116                 [GSM48_IE_GROUP_CIP_SEQ]        = { TLV_TYPE_SINGLE_TV },
 117                 [GSM48_IE_CIP_MODE_SET]         = { TLV_TYPE_SINGLE_TV },
 118                 [GSM48_IE_GPRS_RESUMPT]         = { TLV_TYPE_SINGLE_TV },
 119                 [GSM48_IE_SYNC_IND]             = { TLV_TYPE_SINGLE_TV },
 120         },
 121 };
 122
 123 /* MM elements */
 124 const struct tlv_definition gsm48_mm_att_tlvdef = {
 125         .def = {
 126                 [GSM48_IE_MOBILE_ID]            = { TLV_TYPE_TLV },
 127                 [GSM48_IE_NAME_LONG]            = { TLV_TYPE_TLV },
 128                 [GSM48_IE_NAME_SHORT]           = { TLV_TYPE_TLV },
 129                 [GSM48_IE_UTC]                  = { TLV_TYPE_TV },
 130                 [GSM48_IE_NET_TIME_TZ]          = { TLV_TYPE_FIXED, 7 },
 131                 [GSM48_IE_LSA_IDENT]            = { TLV_TYPE_TLV },
 132
 133                 [GSM48_IE_LOCATION_AREA]        = { TLV_TYPE_FIXED, 5 },
 134                 [GSM48_IE_PRIORITY_LEV]         = { TLV_TYPE_SINGLE_TV },
 135                 [GSM48_IE_FOLLOW_ON_PROC]       = { TLV_TYPE_T },
 136                 [GSM48_IE_CTS_PERMISSION]       = { TLV_TYPE_T },
 137         },
 138 };
 139
 140 static const struct value_string rr_cause_names[] = {
 141         { GSM48_RR_CAUSE_NORMAL,                "Normal event" },
 142         { GSM48_RR_CAUSE_ABNORMAL_UNSPEC,       "Abnormal release, unspecified" },
 143         { GSM48_RR_CAUSE_ABNORMAL_UNACCT,       "Abnormal release, channel unacceptable" },
 144         { GSM48_RR_CAUSE_ABNORMAL_TIMER,        "Abnormal release, timer expired" },
 145         { GSM48_RR_CAUSE_ABNORMAL_NOACT,        "Abnormal release, no activity on radio path" },
 146         { GSM48_RR_CAUSE_PREMPTIVE_REL,         "Preemptive release" },
 147         { GSM48_RR_CAUSE_HNDOVER_IMP,           "Handover impossible, timing advance out of range" },
 148         { GSM48_RR_CAUSE_CHAN_MODE_UNACCT,      "Channel mode unacceptable" },
 149         { GSM48_RR_CAUSE_FREQ_NOT_IMPL,         "Frequency not implemented" },
 150         { GSM48_RR_CAUSE_CALL_CLEARED,          "Call already cleared" },
 151         { GSM48_RR_CAUSE_SEMANT_INCORR,         "Semantically incorrect message" },
 152         { GSM48_RR_CAUSE_INVALID_MAND_INF,      "Invalid mandatory information" },
 153         { GSM48_RR_CAUSE_MSG_TYPE_N,            "Message type non-existant or not implemented" },
 154         { GSM48_RR_CAUSE_MSG_TYPE_N_COMPAT,     "Message type not compatible with protocol state" },
 155         { GSM48_RR_CAUSE_COND_IE_ERROR,         "Conditional IE error" },
 156         { GSM48_RR_CAUSE_NO_CELL_ALLOC_A,       "No cell allocation available" },
 157         { GSM48_RR_CAUSE_PROT_ERROR_UNSPC,      "Protocol error unspecified" },
 158         { 0,                                    NULL },
 159 };
 160
 161 /* FIXME: convert to value_string */
 162 static const char *cc_state_names[32] = {
 163         "NULL",
 164         "INITIATED",
 165         "MM_CONNECTION_PEND",
 166         "MO_CALL_PROC",
 167         "CALL_DELIVERED",
 168         "illegal state 5",
 169         "CALL_PRESENT",
 170         "CALL_RECEIVED",
 171         "CONNECT_REQUEST",
 172         "MO_TERM_CALL_CONF",
 173         "ACTIVE",
 174         "DISCONNECT_REQ",
 175         "DISCONNECT_IND",
 176         "illegal state 13",
 177         "illegal state 14",
 178         "illegal state 15",
 179         "illegal state 16",
 180         "illegal state 17",
 181         "illegal state 18",
 182         "RELEASE_REQ",
 183         "illegal state 20",
 184         "illegal state 21",
 185         "illegal state 22",
 186         "illegal state 23",
 187         "illegal state 24",
 188         "illegal state 25",
 189         "MO_ORIG_MODIFY",
 190         "MO_TERM_MODIFY",
 191         "CONNECT_IND",
 192         "illegal state 29",
 193         "illegal state 30",
 194         "illegal state 31",
 195 };
 196
 197 const char *gsm48_cc_state_name(uint8_t state)
 198 {
 199         if (state < ARRAY_SIZE(cc_state_names))
 200                 return cc_state_names[state];
 201
 202         return "invalid";
 203 }
 204
 205 static const struct value_string cc_msg_names[] = {
 206         { GSM48_MT_CC_ALERTING,         "ALERTING" },
 207         { GSM48_MT_CC_CALL_PROC,        "CALL_PROC" },
 208         { GSM48_MT_CC_PROGRESS,         "PROGRESS" },
 209         { GSM48_MT_CC_ESTAB,            "ESTAB" },
 210         { GSM48_MT_CC_SETUP,            "SETUP" },
 211         { GSM48_MT_CC_ESTAB_CONF,       "ESTAB_CONF" },
 212         { GSM48_MT_CC_CONNECT,          "CONNECT" },
 213         { GSM48_MT_CC_CALL_CONF,        "CALL_CONF" },
 214         { GSM48_MT_CC_START_CC,         "START_CC" },
 215         { GSM48_MT_CC_RECALL,           "RECALL" },
 216         { GSM48_MT_CC_EMERG_SETUP,      "EMERG_SETUP" },
 217         { GSM48_MT_CC_CONNECT_ACK,      "CONNECT_ACK" },
 218         { GSM48_MT_CC_USER_INFO,        "USER_INFO" },
 219         { GSM48_MT_CC_MODIFY_REJECT,    "MODIFY_REJECT" },
 220         { GSM48_MT_CC_MODIFY,           "MODIFY" },
 221         { GSM48_MT_CC_HOLD,             "HOLD" },
 222         { GSM48_MT_CC_HOLD_ACK,         "HOLD_ACK" },
 223         { GSM48_MT_CC_HOLD_REJ,         "HOLD_REJ" },
 224         { GSM48_MT_CC_RETR,             "RETR" },
 225         { GSM48_MT_CC_RETR_ACK,         "RETR_ACK" },
 226         { GSM48_MT_CC_RETR_REJ,         "RETR_REJ" },
 227         { GSM48_MT_CC_MODIFY_COMPL,     "MODIFY_COMPL" },
 228         { GSM48_MT_CC_DISCONNECT,       "DISCONNECT" },
 229         { GSM48_MT_CC_RELEASE_COMPL,    "RELEASE_COMPL" },
 230         { GSM48_MT_CC_RELEASE,          "RELEASE" },
 231         { GSM48_MT_CC_STOP_DTMF,        "STOP_DTMF" },
 232         { GSM48_MT_CC_STOP_DTMF_ACK,    "STOP_DTMF_ACK" },
 233         { GSM48_MT_CC_STATUS_ENQ,       "STATUS_ENQ" },
 234         { GSM48_MT_CC_START_DTMF,       "START_DTMF" },
 235         { GSM48_MT_CC_START_DTMF_ACK,   "START_DTMF_ACK" },
 236         { GSM48_MT_CC_START_DTMF_REJ,   "START_DTMF_REJ" },
 237         { GSM48_MT_CC_CONG_CTRL,        "CONG_CTRL" },
 238         { GSM48_MT_CC_FACILITY,         "FACILITY" },
 239         { GSM48_MT_CC_STATUS,           "STATUS" },
 240         { GSM48_MT_CC_NOTIFY,           "NOTFIY" },
 241         { 0,                            NULL }
 242 };
 243
 244 const char *gsm48_cc_msg_name(uint8_t msgtype)
 245 {
 246         return get_value_string(cc_msg_names, msgtype);
 247 }
 248
 249 const char *rr_cause_name(uint8_t cause)
 250 {
 251         return get_value_string(rr_cause_names, cause);
 252 }
 253
 254 static void to_bcd(uint8_t *bcd, uint16_t val)
 255 {
 256         bcd[2] = val % 10;
 257         val = val / 10;
 258         bcd[1] = val % 10;
 259         val = val / 10;
 260         bcd[0] = val % 10;
 261         val = val / 10;
 262 }
 263
 264 void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
 265                         uint16_t mnc, uint16_t lac)
 266 {
 267         uint8_t bcd[3];
 268
 269         to_bcd(bcd, mcc);
 270         lai48->digits[0] = bcd[0] | (bcd[1] << 4);
 271         lai48->digits[1] = bcd[2];
 272
 273         to_bcd(bcd, mnc);
 274         /* FIXME: do we need three-digit MNC? See Table 10.5.3 */
 275         if (mnc > 99) {
 276                 lai48->digits[1] |= bcd[2] << 4;
 277                 lai48->digits[2] = bcd[0] | (bcd[1] << 4);
 278         } else {
 279                 lai48->digits[1] |= 0xf << 4;
 280                 lai48->digits[2] = bcd[1] | (bcd[2] << 4);
 281         }
 282
 283         lai48->lac = htons(lac);
 284 }
 285
 286 int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
 287 {
 288         uint32_t *tptr = (uint32_t *) &buf[3];
 289
 290         buf[0] = GSM48_IE_MOBILE_ID;
 291         buf[1] = GSM48_TMSI_LEN;
 292         buf[2] = 0xf0 | GSM_MI_TYPE_TMSI;
 293         *tptr = htonl(tmsi);
 294
 295         return 7;
 296 }
 297
 298 int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
 299 {
 300         unsigned int length = strlen(imsi), i, off = 0;
 301         uint8_t odd = (length & 0x1) == 1;
 302
 303         buf[0] = GSM48_IE_MOBILE_ID;
 304         buf[2] = char2bcd(imsi[0]) << 4 | GSM_MI_TYPE_IMSI | (odd << 3);
 305
 306         /* if the length is even we will fill half of the last octet */
 307         if (odd)
 308                 buf[1] = (length + 1) >> 1;
 309         else
 310                 buf[1] = (length + 2) >> 1;
 311
 312         for (i = 1; i < buf[1]; ++i) {
 313                 uint8_t lower, upper;
 314
 315                 lower = char2bcd(imsi[++off]);
 316                 if (!odd && off + 1 == length)
 317                         upper = 0x0f;
 318                 else
 319                         upper = char2bcd(imsi[++off]) & 0x0f;
 320
 321                 buf[2 + i] = (upper << 4) | lower;
 322         }
 323
 324         return 2 + buf[1];
 325 }
 326
 327 /* Convert Mobile Identity (10.5.1.4) to string */
 328 int gsm48_mi_to_string(char *string, const int str_len, const uint8_t *mi,
 329                        const int mi_len)
 330 {
 331         int i;
 332         uint8_t mi_type;
 333         char *str_cur = string;
 334         uint32_t tmsi;
 335
 336         mi_type = mi[0] & GSM_MI_TYPE_MASK;
 337
 338         switch (mi_type) {
 339         case GSM_MI_TYPE_NONE:
 340                 break;
 341         case GSM_MI_TYPE_TMSI:
 342                 /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
 343                 if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
 344                         memcpy(&tmsi, &mi[1], 4);
 345                         tmsi = ntohl(tmsi);
 346                         return snprintf(string, str_len, "%u", tmsi);
 347                 }
 348                 break;
 349         case GSM_MI_TYPE_IMSI:
 350         case GSM_MI_TYPE_IMEI:
 351         case GSM_MI_TYPE_IMEISV:
 352                 *str_cur++ = bcd2char(mi[0] >> 4);
 353
 354                 for (i = 1; i < mi_len; i++) {
 355                         if (str_cur + 2 >= string + str_len)
 356                                 return str_cur - string;
 357                         *str_cur++ = bcd2char(mi[i] & 0xf);
 358                         /* skip last nibble in last input byte when GSM_EVEN */
 359                         if( (i != mi_len-1) || (mi[0] & GSM_MI_ODD))
 360                                 *str_cur++ = bcd2char(mi[i] >> 4);
 361                 }
 362                 break;
 363         default:
 364                 break;
 365         }
 366         *str_cur++ = '\0';
 367
 368         return str_cur - string;
 369 }
 370
 371 void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
 372 {
 373         raid->mcc = (buf[0] & 0xf) * 100;
 374         raid->mcc += (buf[0] >> 4) * 10;
 375         raid->mcc += (buf[1] & 0xf) * 1;
 376
 377         /* I wonder who came up with the stupidity of encoding the MNC
 378          * differently depending on how many digits its decimal number has! */
 379         if ((buf[1] >> 4) == 0xf) {
 380                 raid->mnc = (buf[2] & 0xf) * 10;
 381                 raid->mnc += (buf[2] >> 4) * 1;
 382         } else {
 383                 raid->mnc = (buf[2] & 0xf) * 100;
 384                 raid->mnc += (buf[2] >> 4) * 10;
 385                 raid->mnc += (buf[1] >> 4) * 1;
 386         }
 387
 388         raid->lac = ntohs(*(uint16_t *)(buf + 3));
 389         raid->rac = buf[5];
 390 }
 391
 392 int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
 393 {
 394         uint16_t mcc = raid->mcc;
 395         uint16_t mnc = raid->mnc;
 396
 397         buf[0] = ((mcc / 100) % 10) | (((mcc / 10) % 10) << 4);
 398         buf[1] = (mcc % 10);
 399
 400         /* I wonder who came up with the stupidity of encoding the MNC
 401          * differently depending on how many digits its decimal number has! */
 402         if (mnc < 100) {
 403                 buf[1] |= 0xf0;
 404                 buf[2] = ((mnc / 10) % 10) | ((mnc % 10) << 4);
 405         } else {
 406                 buf[1] |= (mnc % 10) << 4;
 407                 buf[2] = ((mnc / 100) % 10) | (((mcc / 10) % 10) << 4);
 408         }
 409
 410         *(uint16_t *)(buf+3) = htons(raid->lac);
 411
 412         buf[5] = raid->rac;
 413
 414         return 6;
 415 }