ubit2pbit flushes at the wrong moment, added one note to bits.h
[osmocom-bb.git] / src / gsm48.c
index 9efc2bb..daec4f3 100644 (file)
@@ -1,7 +1,7 @@
 /* GSM Mobile Radio Interface Layer 3 messages
  * 3GPP TS 04.08 version 7.21.0 Release 1998 / ETSI TS 100 940 V7.21.0 */
 
-/* (C) 2008-2009 by Harald Welte <laforge@gnumonks.org>
+/* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
  * (C) 2008, 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
  *
  * All Rights Reserved
@@ -75,6 +75,68 @@ const struct tlv_definition gsm48_att_tlvdef = {
        },
 };
 
+/* RR elements */
+const struct tlv_definition gsm48_rr_att_tlvdef = {
+       .def = {
+               /* NOTE: Don't add IE 17 = MOBILE_ID here, it already used. */
+               [GSM48_IE_VGCS_TARGET]          = { TLV_TYPE_TLV },
+               [GSM48_IE_FRQSHORT_AFTER]       = { TLV_TYPE_FIXED, 9 },
+               [GSM48_IE_MUL_RATE_CFG]         = { TLV_TYPE_TLV },
+               [GSM48_IE_FREQ_L_AFTER]         = { TLV_TYPE_TLV },
+               [GSM48_IE_MSLOT_DESC]           = { TLV_TYPE_TLV },
+               [GSM48_IE_CHANMODE_2]           = { TLV_TYPE_TV },
+               [GSM48_IE_FRQSHORT_BEFORE]      = { TLV_TYPE_FIXED, 9 },
+               [GSM48_IE_CHANMODE_3]           = { TLV_TYPE_TV },
+               [GSM48_IE_CHANMODE_4]           = { TLV_TYPE_TV },
+               [GSM48_IE_CHANMODE_5]           = { TLV_TYPE_TV },
+               [GSM48_IE_CHANMODE_6]           = { TLV_TYPE_TV },
+               [GSM48_IE_CHANMODE_7]           = { TLV_TYPE_TV },
+               [GSM48_IE_CHANMODE_8]           = { TLV_TYPE_TV },
+               [GSM48_IE_FREQ_L_BEFORE]        = { TLV_TYPE_TLV },
+               [GSM48_IE_CH_DESC_1_BEFORE]     = { TLV_TYPE_FIXED, 3 },
+               [GSM48_IE_CH_DESC_2_BEFORE]     = { TLV_TYPE_FIXED, 3 },
+               [GSM48_IE_F_CH_SEQ_BEFORE]      = { TLV_TYPE_FIXED, 9 },
+               [GSM48_IE_CLASSMARK3]           = { TLV_TYPE_TLV },
+               [GSM48_IE_MA_BEFORE]            = { TLV_TYPE_TLV },
+               [GSM48_IE_RR_PACKET_UL]         = { TLV_TYPE_TLV },
+               [GSM48_IE_RR_PACKET_DL]         = { TLV_TYPE_TLV },
+               [GSM48_IE_CELL_CH_DESC]         = { TLV_TYPE_FIXED, 16 },
+               [GSM48_IE_CHANMODE_1]           = { TLV_TYPE_TV },
+               [GSM48_IE_CHDES_2_AFTER]        = { TLV_TYPE_FIXED, 3 },
+               [GSM48_IE_MODE_SEC_CH]          = { TLV_TYPE_TV },
+               [GSM48_IE_F_CH_SEQ_AFTER]               = { TLV_TYPE_FIXED, 9 },
+               [GSM48_IE_MA_AFTER]             = { TLV_TYPE_TLV },
+               [GSM48_IE_BA_RANGE]             = { TLV_TYPE_TLV },
+               [GSM48_IE_GROUP_CHDES]          = { TLV_TYPE_TLV },
+               [GSM48_IE_BA_LIST_PREF]         = { TLV_TYPE_TLV },
+               [GSM48_IE_MOB_OVSERV_DIF]       = { TLV_TYPE_TLV },
+               [GSM48_IE_REALTIME_DIFF]        = { TLV_TYPE_TLV },
+               [GSM48_IE_START_TIME]           = { TLV_TYPE_FIXED, 2 },
+               [GSM48_IE_TIMING_ADVANCE]       = { TLV_TYPE_TV },
+               [GSM48_IE_GROUP_CIP_SEQ]        = { TLV_TYPE_SINGLE_TV },
+               [GSM48_IE_CIP_MODE_SET]         = { TLV_TYPE_SINGLE_TV },
+               [GSM48_IE_GPRS_RESUMPT]         = { TLV_TYPE_SINGLE_TV },
+               [GSM48_IE_SYNC_IND]             = { TLV_TYPE_SINGLE_TV },
+       },
+};
+
+/* MM elements */
+const struct tlv_definition gsm48_mm_att_tlvdef = {
+       .def = {
+               [GSM48_IE_MOBILE_ID]            = { TLV_TYPE_TLV },
+               [GSM48_IE_NAME_LONG]            = { TLV_TYPE_TLV },
+               [GSM48_IE_NAME_SHORT]           = { TLV_TYPE_TLV },
+               [GSM48_IE_UTC]                  = { TLV_TYPE_TV },
+               [GSM48_IE_NET_TIME_TZ]          = { TLV_TYPE_FIXED, 7 },
+               [GSM48_IE_LSA_IDENT]            = { TLV_TYPE_TLV },
+
+               [GSM48_IE_LOCATION_AREA]        = { TLV_TYPE_FIXED, 5 },
+               [GSM48_IE_PRIORITY_LEV]         = { TLV_TYPE_SINGLE_TV },
+               [GSM48_IE_FOLLOW_ON_PROC]       = { TLV_TYPE_T },
+               [GSM48_IE_CTS_PERMISSION]       = { TLV_TYPE_T },
+       },
+};
+
 static const struct value_string rr_cause_names[] = {
        { GSM48_RR_CAUSE_NORMAL,                "Normal event" },
        { GSM48_RR_CAUSE_ABNORMAL_UNSPEC,       "Abnormal release, unspecified" },
@@ -96,10 +158,11 @@ static const struct value_string rr_cause_names[] = {
        { 0,                                    NULL },
 };
 
-const char *cc_state_names[32] = {
+/* FIXME: convert to value_string */
+static const char *cc_state_names[32] = {
        "NULL",
        "INITIATED",
-       "illegal state 2",
+       "MM_CONNECTION_PEND",
        "MO_CALL_PROC",
        "CALL_DELIVERED",
        "illegal state 5",
@@ -131,74 +194,57 @@ const char *cc_state_names[32] = {
        "illegal state 31",
 };
 
-const char *gsm48_cc_msg_names[0x40] = {
-       "unknown 0x00",
-       "ALERTING",
-       "CALL_PROC",
-       "PROGRESS",
-       "ESTAB",
-       "SETUP",
-       "ESTAB_CONF",
-       "CONNECT",
-       "CALL_CONF",
-       "START_CC",
-       "unknown 0x0a",
-       "RECALL",
-       "unknown 0x0c",
-       "unknown 0x0d",
-       "EMERG_SETUP",
-       "CONNECT_ACK",
-       "USER_INFO",
-       "unknown 0x11",
-       "unknown 0x12",
-       "MODIFY_REJECT",
-       "unknown 0x14",
-       "unknown 0x15",
-       "unknown 0x16",
-       "MODIFY",
-       "HOLD",
-       "HOLD_ACK",
-       "HOLD_REJ",
-       "unknown 0x1b",
-       "RETR",
-       "RETR_ACK",
-       "RETR_REJ",
-       "MODIFY_COMPL",
-       "unknown 0x20",
-       "unknown 0x21",
-       "unknown 0x22",
-       "unknown 0x23",
-       "unknown 0x24",
-       "DISCONNECT",
-       "unknown 0x26",
-       "unknown 0x27",
-       "unknown 0x28",
-       "unknown 0x29",
-       "RELEASE_COMPL",
-       "unknown 0x2b",
-       "unknown 0x2c",
-       "RELEASE",
-       "unknown 0x2e",
-       "unknown 0x2f",
-       "unknown 0x30",
-       "STOP_DTMF",
-       "STOP_DTMF_ACK",
-       "unknown 0x33",
-       "STATUS_ENQ",
-       "START_DTMF",
-       "START_DTMF_ACK",
-       "START_DTMF_REJ",
-       "unknown 0x38",
-       "CONG_CTRL",
-       "FACILITY",
-       "unknown 0x3b",
-       "STATUS",
-       "unknown 0x3d",
-       "NOTIFY",
-       "unknown 0x3f",
+const char *gsm48_cc_state_name(uint8_t state)
+{
+       if (state < ARRAY_SIZE(cc_state_names))
+               return cc_state_names[state];
+
+       return "invalid";
+}
+
+static const struct value_string cc_msg_names[] = {
+       { GSM48_MT_CC_ALERTING,         "ALERTING" },
+       { GSM48_MT_CC_CALL_PROC,        "CALL_PROC" },
+       { GSM48_MT_CC_PROGRESS,         "PROGRESS" },
+       { GSM48_MT_CC_ESTAB,            "ESTAB" },
+       { GSM48_MT_CC_SETUP,            "SETUP" },
+       { GSM48_MT_CC_ESTAB_CONF,       "ESTAB_CONF" },
+       { GSM48_MT_CC_CONNECT,          "CONNECT" },
+       { GSM48_MT_CC_CALL_CONF,        "CALL_CONF" },
+       { GSM48_MT_CC_START_CC,         "START_CC" },
+       { GSM48_MT_CC_RECALL,           "RECALL" },
+       { GSM48_MT_CC_EMERG_SETUP,      "EMERG_SETUP" },
+       { GSM48_MT_CC_CONNECT_ACK,      "CONNECT_ACK" },
+       { GSM48_MT_CC_USER_INFO,        "USER_INFO" },
+       { GSM48_MT_CC_MODIFY_REJECT,    "MODIFY_REJECT" },
+       { GSM48_MT_CC_MODIFY,           "MODIFY" },
+       { GSM48_MT_CC_HOLD,             "HOLD" },
+       { GSM48_MT_CC_HOLD_ACK,         "HOLD_ACK" },
+       { GSM48_MT_CC_HOLD_REJ,         "HOLD_REJ" },
+       { GSM48_MT_CC_RETR,             "RETR" },
+       { GSM48_MT_CC_RETR_ACK,         "RETR_ACK" },
+       { GSM48_MT_CC_RETR_REJ,         "RETR_REJ" },
+       { GSM48_MT_CC_MODIFY_COMPL,     "MODIFY_COMPL" },
+       { GSM48_MT_CC_DISCONNECT,       "DISCONNECT" },
+       { GSM48_MT_CC_RELEASE_COMPL,    "RELEASE_COMPL" },
+       { GSM48_MT_CC_RELEASE,          "RELEASE" },
+       { GSM48_MT_CC_STOP_DTMF,        "STOP_DTMF" },
+       { GSM48_MT_CC_STOP_DTMF_ACK,    "STOP_DTMF_ACK" },
+       { GSM48_MT_CC_STATUS_ENQ,       "STATUS_ENQ" },
+       { GSM48_MT_CC_START_DTMF,       "START_DTMF" },
+       { GSM48_MT_CC_START_DTMF_ACK,   "START_DTMF_ACK" },
+       { GSM48_MT_CC_START_DTMF_REJ,   "START_DTMF_REJ" },
+       { GSM48_MT_CC_CONG_CTRL,        "CONG_CTRL" },
+       { GSM48_MT_CC_FACILITY,         "FACILITY" },
+       { GSM48_MT_CC_STATUS,           "STATUS" },
+       { GSM48_MT_CC_NOTIFY,           "NOTFIY" },
+       { 0,                            NULL }
 };
 
-static char strbuf[64];
+const char *gsm48_cc_msg_name(uint8_t msgtype)
+{
+       return get_value_string(cc_msg_names, msgtype);
+}
 
 const char *rr_cause_name(uint8_t cause)
 {
@@ -226,13 +272,13 @@ void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
 
        to_bcd(bcd, mnc);
        /* FIXME: do we need three-digit MNC? See Table 10.5.3 */
-#if 0
-       lai48->digits[1] |= bcd[2] << 4;
-       lai48->digits[2] = bcd[0] | (bcd[1] << 4);
-#else
-       lai48->digits[1] |= 0xf << 4;
-       lai48->digits[2] = bcd[1] | (bcd[2] << 4);
-#endif
+       if (mnc > 99) {
+               lai48->digits[1] |= bcd[2] << 4;
+               lai48->digits[2] = bcd[0] | (bcd[1] << 4);
+       } else {
+               lai48->digits[1] |= 0xf << 4;
+               lai48->digits[2] = bcd[1] | (bcd[2] << 4);
+       }
 
        lai48->lac = htons(lac);
 }
@@ -277,3 +323,93 @@ int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
 
        return 2 + buf[1];
 }
+
+/* Convert Mobile Identity (10.5.1.4) to string */
+int gsm48_mi_to_string(char *string, const int str_len, const uint8_t *mi,
+                      const int mi_len)
+{
+       int i;
+       uint8_t mi_type;
+       char *str_cur = string;
+       uint32_t tmsi;
+
+       mi_type = mi[0] & GSM_MI_TYPE_MASK;
+
+       switch (mi_type) {
+       case GSM_MI_TYPE_NONE:
+               break;
+       case GSM_MI_TYPE_TMSI:
+               /* Table 10.5.4.3, reverse generate_mid_from_tmsi */
+               if (mi_len == GSM48_TMSI_LEN && mi[0] == (0xf0 | GSM_MI_TYPE_TMSI)) {
+                       memcpy(&tmsi, &mi[1], 4);
+                       tmsi = ntohl(tmsi);
+                       return snprintf(string, str_len, "%u", tmsi);
+               }
+               break;
+       case GSM_MI_TYPE_IMSI:
+       case GSM_MI_TYPE_IMEI:
+       case GSM_MI_TYPE_IMEISV:
+               *str_cur++ = bcd2char(mi[0] >> 4);
+
+                for (i = 1; i < mi_len; i++) {
+                       if (str_cur + 2 >= string + str_len)
+                               return str_cur - string;
+                       *str_cur++ = bcd2char(mi[i] & 0xf);
+                       /* skip last nibble in last input byte when GSM_EVEN */
+                       if( (i != mi_len-1) || (mi[0] & GSM_MI_ODD))
+                               *str_cur++ = bcd2char(mi[i] >> 4);
+               }
+               break;
+       default:
+               break;
+       }
+       *str_cur++ = '\0';
+
+       return str_cur - string;
+}
+
+void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
+{
+       raid->mcc = (buf[0] & 0xf) * 100;
+       raid->mcc += (buf[0] >> 4) * 10;
+       raid->mcc += (buf[1] & 0xf) * 1;
+
+       /* I wonder who came up with the stupidity of encoding the MNC
+        * differently depending on how many digits its decimal number has! */
+       if ((buf[1] >> 4) == 0xf) {
+               raid->mnc = (buf[2] & 0xf) * 10;
+               raid->mnc += (buf[2] >> 4) * 1;
+       } else {
+               raid->mnc = (buf[2] & 0xf) * 100;
+               raid->mnc += (buf[2] >> 4) * 10;
+               raid->mnc += (buf[1] >> 4) * 1;
+       }
+
+       raid->lac = ntohs(*(uint16_t *)(buf + 3));
+       raid->rac = buf[5];
+}
+
+int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
+{
+       uint16_t mcc = raid->mcc;
+       uint16_t mnc = raid->mnc;
+
+       buf[0] = ((mcc / 100) % 10) | (((mcc / 10) % 10) << 4);
+       buf[1] = (mcc % 10);
+
+       /* I wonder who came up with the stupidity of encoding the MNC
+        * differently depending on how many digits its decimal number has! */
+       if (mnc < 100) {
+               buf[1] |= 0xf0;
+               buf[2] = ((mnc / 10) % 10) | ((mnc % 10) << 4);
+       } else {
+               buf[1] |= (mnc % 10) << 4;
+               buf[2] = ((mnc / 100) % 10) | (((mcc / 10) % 10) << 4);
+       }
+
+       *(uint16_t *)(buf+3) = htons(raid->lac);
+
+       buf[5] = raid->rac;
+
+       return 6;
+}