src/shared/libosmocore/src/rsl.c

   1 /* GSM Radio Signalling Link messages on the A-bis interface
   2  * 3GPP TS 08.58 version 8.6.0 Release 1999 / ETSI TS 100 596 V8.6.0 */
   3
   4 /* (C) 2008-2010 by Harald Welte <laforge@gnumonks.org>
   5  *
   6  * All Rights Reserved
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  */
  23
  24 #include <stdint.h>
  25 #include <errno.h>
  26
  27 #include <osmocore/tlv.h>
  28 #include <osmocore/rsl.h>
  29
  30 #define RSL_ALLOC_SIZE          200
  31 #define RSL_ALLOC_HEADROOM      56
  32
  33 void rsl_init_rll_hdr(struct abis_rsl_rll_hdr *dh, uint8_t msg_type)
  34 {
  35         dh->c.msg_discr = ABIS_RSL_MDISC_RLL;
  36         dh->c.msg_type = msg_type;
  37         dh->ie_chan = RSL_IE_CHAN_NR;
  38         dh->ie_link_id = RSL_IE_LINK_IDENT;
  39 }
  40
  41 const struct tlv_definition rsl_att_tlvdef = {
  42         .def = {
  43                 [RSL_IE_CHAN_NR]                = { TLV_TYPE_TV },
  44                 [RSL_IE_LINK_IDENT]             = { TLV_TYPE_TV },
  45                 [RSL_IE_ACT_TYPE]               = { TLV_TYPE_TV },
  46                 [RSL_IE_BS_POWER]               = { TLV_TYPE_TV },
  47                 [RSL_IE_CHAN_IDENT]             = { TLV_TYPE_TLV },
  48                 [RSL_IE_CHAN_MODE]              = { TLV_TYPE_TLV },
  49                 [RSL_IE_ENCR_INFO]              = { TLV_TYPE_TLV },
  50                 [RSL_IE_FRAME_NUMBER]           = { TLV_TYPE_FIXED, 2 },
  51                 [RSL_IE_HANDO_REF]              = { TLV_TYPE_TV },
  52                 [RSL_IE_L1_INFO]                = { TLV_TYPE_FIXED, 2 },
  53                 [RSL_IE_L3_INFO]                = { TLV_TYPE_TL16V },
  54                 [RSL_IE_MS_IDENTITY]            = { TLV_TYPE_TLV },
  55                 [RSL_IE_MS_POWER]               = { TLV_TYPE_TV },
  56                 [RSL_IE_PAGING_GROUP]           = { TLV_TYPE_TV },
  57                 [RSL_IE_PAGING_LOAD]            = { TLV_TYPE_FIXED, 2 },
  58                 [RSL_IE_PYHS_CONTEXT]           = { TLV_TYPE_TLV },
  59                 [RSL_IE_ACCESS_DELAY]           = { TLV_TYPE_TV },
  60                 [RSL_IE_RACH_LOAD]              = { TLV_TYPE_TLV },
  61                 [RSL_IE_REQ_REFERENCE]          = { TLV_TYPE_FIXED, 3 },
  62                 [RSL_IE_RELEASE_MODE]           = { TLV_TYPE_TV },
  63                 [RSL_IE_RESOURCE_INFO]          = { TLV_TYPE_TLV },
  64                 [RSL_IE_RLM_CAUSE]              = { TLV_TYPE_TLV },
  65                 [RSL_IE_STARTNG_TIME]           = { TLV_TYPE_FIXED, 2 },
  66                 [RSL_IE_TIMING_ADVANCE]         = { TLV_TYPE_TV },
  67                 [RSL_IE_UPLINK_MEAS]            = { TLV_TYPE_TLV },
  68                 [RSL_IE_CAUSE]                  = { TLV_TYPE_TLV },
  69                 [RSL_IE_MEAS_RES_NR]            = { TLV_TYPE_TV },
  70                 [RSL_IE_MSG_ID]                 = { TLV_TYPE_TV },
  71                 [RSL_IE_SYSINFO_TYPE]           = { TLV_TYPE_TV },
  72                 [RSL_IE_MS_POWER_PARAM]         = { TLV_TYPE_TLV },
  73                 [RSL_IE_BS_POWER_PARAM]         = { TLV_TYPE_TLV },
  74                 [RSL_IE_PREPROC_PARAM]          = { TLV_TYPE_TLV },
  75                 [RSL_IE_PREPROC_MEAS]           = { TLV_TYPE_TLV },
  76                 [RSL_IE_IMM_ASS_INFO]           = { TLV_TYPE_TLV },
  77                 [RSL_IE_SMSCB_INFO]             = { TLV_TYPE_FIXED, 23 },
  78                 [RSL_IE_MS_TIMING_OFFSET]       = { TLV_TYPE_TV },
  79                 [RSL_IE_ERR_MSG]                = { TLV_TYPE_TLV },
  80                 [RSL_IE_FULL_BCCH_INFO]         = { TLV_TYPE_TLV },
  81                 [RSL_IE_CHAN_NEEDED]            = { TLV_TYPE_TV },
  82                 [RSL_IE_CB_CMD_TYPE]            = { TLV_TYPE_TV },
  83                 [RSL_IE_SMSCB_MSG]              = { TLV_TYPE_TLV },
  84                 [RSL_IE_FULL_IMM_ASS_INFO]      = { TLV_TYPE_TLV },
  85                 [RSL_IE_SACCH_INFO]             = { TLV_TYPE_TLV },
  86                 [RSL_IE_CBCH_LOAD_INFO]         = { TLV_TYPE_TV },
  87                 [RSL_IE_SMSCB_CHAN_INDICATOR]   = { TLV_TYPE_TV },
  88                 [RSL_IE_GROUP_CALL_REF]         = { TLV_TYPE_TLV },
  89                 [RSL_IE_CHAN_DESC]              = { TLV_TYPE_TLV },
  90                 [RSL_IE_NCH_DRX_INFO]           = { TLV_TYPE_TLV },
  91                 [RSL_IE_CMD_INDICATOR]          = { TLV_TYPE_TLV },
  92                 [RSL_IE_EMLPP_PRIO]             = { TLV_TYPE_TV },
  93                 [RSL_IE_UIC]                    = { TLV_TYPE_TLV },
  94                 [RSL_IE_MAIN_CHAN_REF]          = { TLV_TYPE_TV },
  95                 [RSL_IE_MR_CONFIG]              = { TLV_TYPE_TLV },
  96                 [RSL_IE_MR_CONTROL]             = { TLV_TYPE_TV },
  97                 [RSL_IE_SUP_CODEC_TYPES]        = { TLV_TYPE_TLV },
  98                 [RSL_IE_CODEC_CONFIG]           = { TLV_TYPE_TLV },
  99                 [RSL_IE_RTD]                    = { TLV_TYPE_TV },
 100                 [RSL_IE_TFO_STATUS]             = { TLV_TYPE_TV },
 101                 [RSL_IE_LLP_APDU]               = { TLV_TYPE_TLV },
 102                 [RSL_IE_SIEMENS_MRPCI]          = { TLV_TYPE_TV },
 103                 [RSL_IE_IPAC_PROXY_UDP]         = { TLV_TYPE_FIXED, 2 },
 104                 [RSL_IE_IPAC_BSCMPL_TOUT]       = { TLV_TYPE_TV },
 105                 [RSL_IE_IPAC_REMOTE_IP]         = { TLV_TYPE_FIXED, 4 },
 106                 [RSL_IE_IPAC_REMOTE_PORT]       = { TLV_TYPE_FIXED, 2 },
 107                 [RSL_IE_IPAC_RTP_PAYLOAD]       = { TLV_TYPE_TV },
 108                 [RSL_IE_IPAC_LOCAL_PORT]        = { TLV_TYPE_FIXED, 2 },
 109                 [RSL_IE_IPAC_SPEECH_MODE]       = { TLV_TYPE_TV },
 110                 [RSL_IE_IPAC_LOCAL_IP]          = { TLV_TYPE_FIXED, 4 },
 111                 [RSL_IE_IPAC_CONN_ID]           = { TLV_TYPE_FIXED, 2 },
 112                 [RSL_IE_IPAC_RTP_CSD_FMT]       = { TLV_TYPE_TV },
 113                 [RSL_IE_IPAC_RTP_JIT_BUF]       = { TLV_TYPE_FIXED, 2 },
 114                 [RSL_IE_IPAC_RTP_COMPR]         = { TLV_TYPE_TV },
 115                 [RSL_IE_IPAC_RTP_PAYLOAD2]      = { TLV_TYPE_TV },
 116                 [RSL_IE_IPAC_RTP_MPLEX]         = { TLV_TYPE_FIXED, 8 },
 117                 [RSL_IE_IPAC_RTP_MPLEX_ID]      = { TLV_TYPE_TV },
 118         },
 119 };
 120
 121 /* encode channel number as per Section 9.3.1 */
 122 uint8_t rsl_enc_chan_nr(uint8_t type, uint8_t subch, uint8_t timeslot)
 123 {
 124         uint8_t ret;
 125
 126         ret = (timeslot & 0x07) | type;
 127
 128         switch (type) {
 129         case RSL_CHAN_Lm_ACCHs:
 130                 subch &= 0x01;
 131                 break;
 132         case RSL_CHAN_SDCCH4_ACCH:
 133                 subch &= 0x03;
 134                 break;
 135         case RSL_CHAN_SDCCH8_ACCH:
 136                 subch &= 0x07;
 137                 break;
 138         default:
 139                 /* no subchannels allowed */
 140                 subch = 0x00;
 141                 break;
 142         }
 143         ret |= (subch << 3);
 144
 145         return ret;
 146 }
 147
 148 int rsl_dec_chan_nr(uint8_t chan_nr, uint8_t *type, uint8_t *subch, uint8_t *timeslot)
 149 {
 150         *timeslot = chan_nr & 0x7;
 151
 152         if ((chan_nr & 0xf8) == RSL_CHAN_Bm_ACCHs) {
 153                 *type = RSL_CHAN_Bm_ACCHs;
 154                 *subch = 0;
 155         } else if ((chan_nr & 0xf0) == RSL_CHAN_Lm_ACCHs) {
 156                 *type = RSL_CHAN_Lm_ACCHs;
 157                 *subch = (chan_nr >> 3) & 0x1;
 158         } else if ((chan_nr & 0xe0) == RSL_CHAN_SDCCH4_ACCH) {
 159                 *type = RSL_CHAN_SDCCH4_ACCH;
 160                 *subch = (chan_nr >> 3) & 0x3;
 161         } else if ((chan_nr & 0xc0) == RSL_CHAN_SDCCH8_ACCH) {
 162                 *type = RSL_CHAN_SDCCH8_ACCH;
 163                 *subch = (chan_nr >> 3) & 0x7;
 164         } else if ((chan_nr & 0xf8) == RSL_CHAN_BCCH) {
 165                 *type = RSL_CHAN_BCCH;
 166                 *subch = 0;
 167         } else if ((chan_nr & 0xf8) == RSL_CHAN_RACH) {
 168                 *type = RSL_CHAN_RACH;
 169                 *subch = 0;
 170         } else if ((chan_nr & 0xf8) == RSL_CHAN_PCH_AGCH) {
 171                 *type = RSL_CHAN_PCH_AGCH;
 172                 *subch = 0;
 173         } else
 174                 return -EINVAL;
 175
 176         return 0;
 177 }
 178
 179 static const struct value_string rsl_err_vals[] = {
 180         { RSL_ERR_RADIO_IF_FAIL,        "Radio Interface Failure" },
 181         { RSL_ERR_RADIO_LINK_FAIL,      "Radio Link Failure" },
 182         { RSL_ERR_HANDOVER_ACC_FAIL,    "Handover Access Failure" },
 183         { RSL_ERR_TALKER_ACC_FAIL,      "Talker Access Failure" },
 184         { RSL_ERR_OM_INTERVENTION,      "O&M Intervention" },
 185         { RSL_ERR_NORMAL_UNSPEC,        "Normal event, unspecified" },
 186         { RSL_ERR_T_MSRFPCI_EXP,        "Siemens: T_MSRFPCI Expired" },
 187         { RSL_ERR_EQUIPMENT_FAIL,       "Equipment Failure" },
 188         { RSL_ERR_RR_UNAVAIL,           "Radio Resource not available" },
 189         { RSL_ERR_TERR_CH_FAIL,         "Terrestrial Channel Failure" },
 190         { RSL_ERR_CCCH_OVERLOAD,        "CCCH Overload" },
 191         { RSL_ERR_ACCH_OVERLOAD,        "ACCH Overload" },
 192         { RSL_ERR_PROCESSOR_OVERLOAD,   "Processor Overload" },
 193         { RSL_ERR_RES_UNAVAIL,          "Resource not available, unspecified" },
 194         { RSL_ERR_TRANSC_UNAVAIL,       "Transcoding not available" },
 195         { RSL_ERR_SERV_OPT_UNAVAIL,     "Service or Option not available" },
 196         { RSL_ERR_ENCR_UNIMPL,          "Encryption algorithm not implemented" },
 197         { RSL_ERR_SERV_OPT_UNIMPL,      "Service or Option not implemented" },
 198         { RSL_ERR_RCH_ALR_ACTV_ALLOC,   "Radio channel already activated" },
 199         { RSL_ERR_INVALID_MESSAGE,      "Invalid Message, unspecified" },
 200         { RSL_ERR_MSG_DISCR,            "Message Discriminator Error" },
 201         { RSL_ERR_MSG_TYPE,             "Message Type Error" },
 202         { RSL_ERR_MSG_SEQ,              "Message Sequence Error" },
 203         { RSL_ERR_IE_ERROR,             "General IE error" },
 204         { RSL_ERR_MAND_IE_ERROR,        "Mandatory IE error" },
 205         { RSL_ERR_OPT_IE_ERROR,         "Optional IE error" },
 206         { RSL_ERR_IE_NONEXIST,          "IE non-existent" },
 207         { RSL_ERR_IE_LENGTH,            "IE length error" },
 208         { RSL_ERR_IE_CONTENT,           "IE content error" },
 209         { RSL_ERR_PROTO,                "Protocol error, unspecified" },
 210         { RSL_ERR_INTERWORKING,         "Interworking error, unspecified" },
 211         { 0,                            NULL }
 212 };
 213
 214 const char *rsl_err_name(uint8_t err)
 215 {
 216         return get_value_string(rsl_err_vals, err);
 217 }
 218
 219 static const struct value_string rsl_rlm_cause_strs[] = {
 220         { RLL_CAUSE_T200_EXPIRED,       "Timer T200 expired (N200+1) times" },
 221         { RLL_CAUSE_REEST_REQ,          "Re-establishment request" },
 222         { RLL_CAUSE_UNSOL_UA_RESP,      "Unsolicited UA response" },
 223         { RLL_CAUSE_UNSOL_DM_RESP,      "Unsolicited DM response" },
 224         { RLL_CAUSE_UNSOL_DM_RESP_MF,   "Unsolicited DM response, multiple frame" },
 225         { RLL_CAUSE_UNSOL_SPRV_RESP,    "Unsolicited supervisory response" },
 226         { RLL_CAUSE_SEQ_ERR,            "Sequence Error" },
 227         { RLL_CAUSE_UFRM_INC_PARAM,     "U-Frame with incorrect parameters" },
 228         { RLL_CAUSE_SFRM_INC_PARAM,     "S-Frame with incorrect parameters" },
 229         { RLL_CAUSE_IFRM_INC_MBITS,     "I-Frame with incorrect use of M bit" },
 230         { RLL_CAUSE_IFRM_INC_LEN,       "I-Frame with incorrect length" },
 231         { RLL_CAUSE_FRM_UNIMPL,         "Fraeme not implemented" },
 232         { RLL_CAUSE_SABM_MF,            "SABM command, multiple frame established state" },
 233         { RLL_CAUSE_SABM_INFO_NOTALL,   "SABM frame with information not allowed in this state" },
 234         { 0,                            NULL },
 235 };
 236
 237 const char *rsl_rlm_cause_name(uint8_t err)
 238 {
 239         return get_value_string(rsl_rlm_cause_strs, err);
 240 }
 241
 242 /* Section 3.3.2.3 TS 05.02. I think this looks like a table */
 243 int rsl_ccch_conf_to_bs_cc_chans(int ccch_conf)
 244 {
 245         switch (ccch_conf) {
 246         case RSL_BCCH_CCCH_CONF_1_NC:
 247                 return 1;
 248         case RSL_BCCH_CCCH_CONF_1_C:
 249                 return 1;
 250         case RSL_BCCH_CCCH_CONF_2_NC:
 251                 return 2;
 252         case RSL_BCCH_CCCH_CONF_3_NC:
 253                 return 3;
 254         case RSL_BCCH_CCCH_CONF_4_NC:
 255                 return 4;
 256         default:
 257                 return -1;
 258         }
 259 }
 260
 261 /* Section 3.3.2.3 TS 05.02 */
 262 int rsl_ccch_conf_to_bs_ccch_sdcch_comb(int ccch_conf)
 263 {
 264         switch (ccch_conf) {
 265         case RSL_BCCH_CCCH_CONF_1_NC:
 266                 return 0;
 267         case RSL_BCCH_CCCH_CONF_1_C:
 268                 return 1;
 269         case RSL_BCCH_CCCH_CONF_2_NC:
 270                 return 0;
 271         case RSL_BCCH_CCCH_CONF_3_NC:
 272                 return 0;
 273         case RSL_BCCH_CCCH_CONF_4_NC:
 274                 return 0;
 275         default:
 276                 return -1;
 277         }
 278 }
 279
 280 /* Push a RSL RLL header with L3_INFO IE */
 281 void rsl_rll_push_l3(struct msgb *msg, uint8_t msg_type, uint8_t chan_nr,
 282                      uint8_t link_id, int transparent)
 283 {
 284         uint8_t l3_len = msg->tail - (uint8_t *)msgb_l3(msg);
 285         struct abis_rsl_rll_hdr *rh;
 286
 287         /* construct a RSLms RLL message (DATA INDICATION, UNIT DATA
 288          * INDICATION) and send it off via RSLms */
 289
 290         /* Push the L3 IE tag and lengh */
 291         msgb_tv16_push(msg, RSL_IE_L3_INFO, l3_len);
 292
 293         /* Then push the RSL header */
 294         rh = (struct abis_rsl_rll_hdr *) msgb_push(msg, sizeof(*rh));
 295         rsl_init_rll_hdr(rh, msg_type);
 296         if (transparent)
 297                 rh->c.msg_discr |= ABIS_RSL_MDISC_TRANSP;
 298         rh->chan_nr = chan_nr;
 299         rh->link_id = link_id;
 300
 301         /* set the l2 header pointer */
 302         msg->l2h = (uint8_t *)rh;
 303 }
 304
 305 struct msgb *rsl_rll_simple(uint8_t msg_type, uint8_t chan_nr,
 306                             uint8_t link_id, int transparent)
 307 {
 308         struct abis_rsl_rll_hdr *rh;
 309         struct msgb *msg;
 310
 311         msg = msgb_alloc_headroom(RSL_ALLOC_SIZE+RSL_ALLOC_HEADROOM,
 312                                   RSL_ALLOC_HEADROOM, "rsl_rll_simple");
 313
 314         if (!msg)
 315                 return NULL;
 316
 317         /* put the RSL header */
 318         rh = (struct abis_rsl_rll_hdr *) msgb_put(msg, sizeof(*rh));
 319         rsl_init_rll_hdr(rh, msg_type);
 320         if (transparent)
 321                 rh->c.msg_discr |= ABIS_RSL_MDISC_TRANSP;
 322         rh->chan_nr = chan_nr;
 323         rh->link_id = link_id;
 324
 325         /* set the l2 header pointer */
 326         msg->l2h = (uint8_t *)rh;
 327
 328         return msg;
 329 }