libosmogsm  1.4.0
Osmocom GSM library
gsm_utils.h
Go to the documentation of this file.
1 
3 /*
4  * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de>
5  * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
6  * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
7  *
8  * All Rights Reserved
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  */
25 
26 #pragma once
27 
28 #include <stddef.h>
29 #include <stdint.h>
30 
31 #include <osmocom/core/defs.h>
32 #include <osmocom/core/utils.h>
33 
34 #define ADD_MODULO(sum, delta, modulo) do { \
35  if ((sum += delta) >= modulo) \
36  sum -= modulo; \
37  } while (0)
38 
39 #define GSM_MAX_FN (26*51*2048)
40 
41 /* Max length of random identifier which can be requested via osmo_get_rand_id() */
42 #define OSMO_MAX_RAND_ID_LEN 16
43 
44 struct gsm_time {
45  uint32_t fn; /* FN count */
46  uint16_t t1; /* FN div (26*51) */
47  uint8_t t2; /* FN modulo 26 */
48  uint8_t t3; /* FN modulo 51 */
49  uint8_t tc;
50 };
51 
52 enum gsm_band {
57  GSM_BAND_450 = 0x10,
58  GSM_BAND_480 = 0x20,
59  GSM_BAND_750 = 0x40,
60  GSM_BAND_810 = 0x80,
61 };
62 
63 const char *gsm_band_name(enum gsm_band band);
64 enum gsm_band gsm_band_parse(const char *mhz);
65 
66 int osmo_get_rand_id(uint8_t *out, size_t len);
67 
82 int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
83 
89 int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
90 
103 int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written);
104 
110 int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written);
111 
112 /* the four functions below are helper functions and here for the unit test */
113 int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding);
114 int gsm_septet_encode(uint8_t *result, const char *data);
115 uint8_t gsm_get_octet_len(const uint8_t sept_len);
116 int gsm_7bit_decode_n_hdr(char *decoded, size_t n, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind);
117 
118 int ms_class_gmsk_dbm(enum gsm_band band, int ms_class);
119 int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm);
120 int ms_pwr_dbm(enum gsm_band band, uint8_t lvl);
121 
122 /* According to TS 05.08 Chapter 8.1.4 */
123 int rxlev2dbm(uint8_t rxlev);
124 uint8_t dbm2rxlev(int dbm);
125 
126 /* According to GSM 04.08 Chapter 10.5.1.6 */
127 static inline int ms_cm2_a5n_support(uint8_t *cm2, unsigned n) {
128  switch (n) {
129  case 0: return 1;
130  case 1: return (cm2[0] & (1<<3)) ? 0 : 1;
131  case 2: return (cm2[2] & (1<<0)) ? 1 : 0;
132  case 3: return (cm2[2] & (1<<1)) ? 1 : 0;
133  default:
134  return 0;
135  }
136 }
137 
138 /* According to GSM 04.08 Chapter 10.5.1.7 */
139 static inline int ms_cm3_a5n_support(uint8_t *cm3, unsigned n) {
140  switch (n) {
141  case 4: return (cm3[0] & (1<<0)) ? 1 : 0;
142  case 5: return (cm3[0] & (1<<1)) ? 1 : 0;
143  case 6: return (cm3[0] & (1<<2)) ? 1 : 0;
144  case 7: return (cm3[0] & (1<<3)) ? 1 : 0;
145  default:
146  return 0;
147  }
148 }
149 
150 /* According to GSM 04.08 Chapter 10.5.2.29 */
151 static inline int rach_max_trans_val2raw(int val) { return (val >> 1) & 3; }
152 static inline int rach_max_trans_raw2val(int raw) {
153  const int tbl[4] = { 1, 2, 4, 7 };
154  return tbl[raw & 3];
155 }
156 
157 #define ARFCN_PCS 0x8000
158 #define ARFCN_UPLINK 0x4000
159 #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */
160 
161 int gsm_arfcn2band_rc(uint16_t arfcn, enum gsm_band *band);
162 enum gsm_band gsm_arfcn2band(uint16_t arfcn) OSMO_DEPRECATED("Use gsm_arfcn2band_rc() instead");
163 
164 /* Convert an ARFCN to the frequency in MHz * 10 */
165 uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink);
166 
167 /* Convert a Frequency in MHz * 10 to ARFCN */
168 uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink);
169 
170 /* Convert from frame number to GSM time */
171 void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn);
172 
173 /* Parse GSM Frame Number into printable string */
174 char *gsm_fn_as_gsmtime_str(uint32_t fn);
175 
176 /* Convert from GSM time to frame number */
177 uint32_t gsm_gsmtime2fn(struct gsm_time *time);
178 
179 /* Returns static buffer with string representation of a GSM Time */
180 char *osmo_dump_gsmtime(const struct gsm_time *tm);
181 char *osmo_dump_gsmtime_buf(char *buf, size_t buf_len, const struct gsm_time *tm);
182 char *osmo_dump_gsmtime_c(const void *ctx, const struct gsm_time *tm);
183 
184 /* GSM TS 03.03 Chapter 2.6 */
193 };
194 
195 /* TS 03.03 Chapter 2.6 */
196 int gprs_tlli_type(uint32_t tlli);
197 
198 uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type);
199 
200 /* Osmocom internal, not part of any gsm spec */
208  GSM_PCHAN_PDCH, /* GPRS PDCH */
209  GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */
215 };
216 
217 /* Osmocom internal, not part of any gsm spec */
228 };
229 
230 extern const struct value_string gsm_chan_t_names[];
231 static inline const char *gsm_chan_t_name(enum gsm_chan_t val)
232 { return get_value_string(gsm_chan_t_names, val); }
233 
234 /* Deprectated functions */
235 /* Limit encoding and decoding to use no more than this amount of buffer bytes */
236 #define GSM_7BIT_LEGACY_MAX_BUFFER_SIZE 0x10000
237 
238 int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead");
239 int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead");
240 int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
241 int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead");
242 int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
243 
249 
250  /* keep this last */
252 };
253 
254 extern const struct value_string osmo_rat_type_names[];
255 inline static const char *osmo_rat_type_name(enum osmo_rat_type val)
256 { return get_value_string(osmo_rat_type_names, val); }
len
uint8_t len
Definition: gsm_04_11.h:0
osmo_dump_gsmtime_buf
char * osmo_dump_gsmtime_buf(char *buf, size_t buf_len, const struct gsm_time *tm)
Definition: gsm_utils.c:891
OSMO_RAT_UTRAN_IU
@ OSMO_RAT_UTRAN_IU
Definition: gsm_utils.h:247
GSM_PCHAN_TCH_H
@ GSM_PCHAN_TCH_H
Definition: gsm_utils.h:206
gsm_chan_t
gsm_chan_t
Definition: gsm_utils.h:218
GSM_PCHAN_UNKNOWN
@ GSM_PCHAN_UNKNOWN
Definition: gsm_utils.h:210
dbm2rxlev
uint8_t dbm2rxlev(int dbm)
Convert RF signal level in dBm to TS 05.08 RxLev (TS 05.08 Chapter 8.1.4)
Definition: gsm_utils.c:654
time
char time[12]
Definition: ipaccess.h:7
OSMO_DEPRECATED
#define OSMO_DEPRECATED(text)
get_value_string
const char * get_value_string(const struct value_string *vs, uint32_t val)
gsm_7bit_encode
int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead")
Definition: gsm_utils.c:1006
gsm_7bit_encode_n_ussd
int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written)
Encode a text string into GSM 03.38 encoded 7 bit characters (USSD encoding).
Definition: gsm_utils.c:422
gsm_band_name
const char * gsm_band_name(enum gsm_band band)
Return string name of a given GSM Band.
Definition: gsm_utils.c:667
n
write Write running configuration to or terminal n Write configuration to the copy running config startup Copy configuration n Copy running config to n Copy running config to startup write Write running configuration to or terminal n Write to terminal n
OSMO_RAT_COUNT
@ OSMO_RAT_COUNT
Definition: gsm_utils.h:251
utils.h
gsm_time::tc
uint8_t tc
Definition: gsm_utils.h:49
gsm_time
Definition: gsm_utils.h:44
gsm_band
gsm_band
Definition: gsm_utils.h:52
gsm_septet_encode
int gsm_septet_encode(uint8_t *result, const char *data)
Encode a ASCII characterrs as 7-bit GSM alphabet (TS 03.38)
Definition: gsm_utils.c:292
gsm_arfcn2band_rc
int gsm_arfcn2band_rc(uint16_t arfcn, enum gsm_band *band)
Resolve GSM band from ARFCN.
Definition: gsm_utils.c:726
gsm_fn2gsmtime
void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn)
Parse GSM Frame Number into struct gsm_time.
Definition: gsm_utils.c:862
gsm_7bit_encode_oct
int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead")
Definition: gsm_utils.c:1019
GSM_BAND_810
@ GSM_BAND_810
Definition: gsm_utils.h:60
gsm_gsmtime2fn
uint32_t gsm_gsmtime2fn(struct gsm_time *time)
Encode decoded gsm_time to Frame Number.
Definition: gsm_utils.c:885
TLLI_G_RNTI
@ TLLI_G_RNTI
Definition: gsm_utils.h:191
GSM_LCHAN_TCH_H
@ GSM_LCHAN_TCH_H
Definition: gsm_utils.h:222
GSM_PCHAN_TCH_F
@ GSM_PCHAN_TCH_F
Definition: gsm_utils.h:205
rxlev2dbm
int rxlev2dbm(uint8_t rxlev)
Convert TS 05.08 RxLev to dBm (TS 05.08 Chapter 8.1.4)
Definition: gsm_utils.c:643
ms_cm3_a5n_support
static int ms_cm3_a5n_support(uint8_t *cm3, unsigned n)
Definition: gsm_utils.h:139
GSM_LCHAN_CBCH
@ GSM_LCHAN_CBCH
Definition: gsm_utils.h:226
ms_pwr_ctl_lvl
int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm)
determine power control level for given dBm value, as indicated by the tables in chapter 4....
Definition: gsm_utils.c:550
GSM_BAND_480
@ GSM_BAND_480
Definition: gsm_utils.h:58
gsm_arfcn2freq10
uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink)
Convert an ARFCN to the frequency in MHz * 10.
Definition: gsm_utils.c:803
GSM_PCHAN_CCCH
@ GSM_PCHAN_CCCH
Definition: gsm_utils.h:203
OSMO_RAT_EUTRAN_SGS
@ OSMO_RAT_EUTRAN_SGS
Definition: gsm_utils.h:248
type
uint8_t type
Definition: gsm_08_08.h:0
length
uint8_t length
Definition: gsm_08_08.h:1
GSM_LCHAN_PDTCH
@ GSM_LCHAN_PDTCH
Definition: gsm_utils.h:225
ms_class_gmsk_dbm
int ms_class_gmsk_dbm(enum gsm_band band, int ms_class)
Convert power class to dBm according to GSM TS 05.05.
Definition: gsm_utils.c:505
GSM_BAND_450
@ GSM_BAND_450
Definition: gsm_utils.h:57
gsm_7bit_decode
int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead")
Definition: gsm_utils.c:991
OSMO_RAT_UNKNOWN
@ OSMO_RAT_UNKNOWN
Definition: gsm_utils.h:245
gsm_7bit_decode_n_hdr
int gsm_7bit_decode_n_hdr(char *decoded, size_t n, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind)
TS 03.38 7-bit Character unpacking (6.2.1)
Definition: gsm_utils.c:207
osmo_rat_type
osmo_rat_type
Definition: gsm_utils.h:244
data
uint8_t data[0]
GSM_PCHAN_PDCH
@ GSM_PCHAN_PDCH
Definition: gsm_utils.h:208
gsm_time::t3
uint8_t t3
Definition: gsm_utils.h:48
GSM_LCHAN_TCH_F
@ GSM_LCHAN_TCH_F
Definition: gsm_utils.h:221
gsm_chan_t_name
static const char * gsm_chan_t_name(enum gsm_chan_t val)
Definition: gsm_utils.h:231
gsm_band_parse
enum gsm_band gsm_band_parse(const char *mhz)
Parse string name of a GSM band.
Definition: gsm_utils.c:691
gsm_chan_t_names
const struct value_string gsm_chan_t_names[]
Definition: gsm48.c:435
GSM_LCHAN_CCCH
@ GSM_LCHAN_CCCH
Definition: gsm_utils.h:224
gsm_freq102arfcn
uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink)
Convert a Frequency in MHz * 10 to ARFCN.
Definition: gsm_utils.c:830
GSM_PCHAN_SDCCH8_SACCH8C_CBCH
@ GSM_PCHAN_SDCCH8_SACCH8C_CBCH
Definition: gsm_utils.h:212
GSM_LCHAN_NONE
@ GSM_LCHAN_NONE
Definition: gsm_utils.h:219
TLLI_RESERVED
@ TLLI_RESERVED
Definition: gsm_utils.h:190
osmo_rat_type_names
const struct value_string osmo_rat_type_names[]
Definition: gsm_utils.c:1026
GSM_BAND_900
@ GSM_BAND_900
Definition: gsm_utils.h:54
_GSM_PCHAN_MAX
@ _GSM_PCHAN_MAX
Definition: gsm_utils.h:214
OSMO_RAT_GERAN_A
@ OSMO_RAT_GERAN_A
Definition: gsm_utils.h:246
TLLI_AUXILIARY
@ TLLI_AUXILIARY
Definition: gsm_utils.h:189
gsm_time::t1
uint16_t t1
Definition: gsm_utils.h:46
GSM_BAND_1900
@ GSM_BAND_1900
Definition: gsm_utils.h:56
ms_pwr_dbm
int ms_pwr_dbm(enum gsm_band band, uint8_t lvl)
Convert TS 05.05 power level to absolute dBm value.
Definition: gsm_utils.c:602
GSM_PCHAN_CCCH_SDCCH4_CBCH
@ GSM_PCHAN_CCCH_SDCCH4_CBCH
Definition: gsm_utils.h:211
GSM_PCHAN_CCCH_SDCCH4
@ GSM_PCHAN_CCCH_SDCCH4
Definition: gsm_utils.h:204
TLLI_LOCAL
@ TLLI_LOCAL
Definition: gsm_utils.h:186
osmo_dump_gsmtime_c
char * osmo_dump_gsmtime_c(const void *ctx, const struct gsm_time *tm)
Definition: gsm_utils.c:905
GSM_LCHAN_SDCCH
@ GSM_LCHAN_SDCCH
Definition: gsm_utils.h:220
TLLI_RAND_G_RNTI
@ TLLI_RAND_G_RNTI
Definition: gsm_utils.h:192
GSM_LCHAN_UNKNOWN
@ GSM_LCHAN_UNKNOWN
Definition: gsm_utils.h:223
osmo_rat_type_name
static const char * osmo_rat_type_name(enum osmo_rat_type val)
Definition: gsm_utils.h:255
osmo_get_rand_id
int osmo_get_rand_id(uint8_t *out, size_t len)
Generate random identifier We use /dev/urandom (default when GRND_RANDOM flag is not set).
Definition: gsm_utils.c:448
osmo_dump_gsmtime
char * osmo_dump_gsmtime(const struct gsm_time *tm)
Definition: gsm_utils.c:899
GSM_BAND_850
@ GSM_BAND_850
Definition: gsm_utils.h:53
value_string
gsm_get_octet_len
uint8_t gsm_get_octet_len(const uint8_t sept_len)
Compute number of octets from number of septets.
Definition: gsm_utils.c:192
gprs_tlli_type
gprs_tlli_type
Definition: gsm_utils.h:185
rach_max_trans_raw2val
static int rach_max_trans_raw2val(int raw)
Definition: gsm_utils.h:152
rach_max_trans_val2raw
static int rach_max_trans_val2raw(int val)
Definition: gsm_utils.h:151
gsm_7bit_decode_n
int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length)
Decode a sequence of GSM 03.38 encoded 7 bit characters.
Definition: gsm_utils.c:265
gsm_arfcn2band
enum gsm_band gsm_arfcn2band(uint16_t arfcn) OSMO_DEPRECATED("Use gsm_arfcn2band_rc() instead")
Resolve GSM band from ARFCN, aborts process on invalid ARFCN.
Definition: gsm_utils.c:768
GSM_PCHAN_TCH_F_TCH_H_PDCH
@ GSM_PCHAN_TCH_F_TCH_H_PDCH
Definition: gsm_utils.h:213
gsm_phys_chan_config
gsm_phys_chan_config
Definition: gsm_utils.h:201
gsm_7bit_decode_n_ussd
int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length)
Decode a sequence of 7 bit characters (USSD encoding).
Definition: gsm_utils.c:271
TLLI_RANDOM
@ TLLI_RANDOM
Definition: gsm_utils.h:188
gsm_time::t2
uint8_t t2
Definition: gsm_utils.h:47
gsm_7bit_encode_n
int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written)
Encode a text string into GSM 03.38 encoded 7 bit characters.
Definition: gsm_utils.c:378
GSM_PCHAN_TCH_F_PDCH
@ GSM_PCHAN_TCH_F_PDCH
Definition: gsm_utils.h:209
gsm_time::fn
uint32_t fn
Definition: gsm_utils.h:45
GSM_BAND_750
@ GSM_BAND_750
Definition: gsm_utils.h:59
gsm_septets2octets
int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding)
GSM Default Alphabet 7bit to octet packing.
Definition: gsm_utils.c:327
ms_cm2_a5n_support
static int ms_cm2_a5n_support(uint8_t *cm2, unsigned n)
Definition: gsm_utils.h:127
GSM_PCHAN_SDCCH8_SACCH8C
@ GSM_PCHAN_SDCCH8_SACCH8C
Definition: gsm_utils.h:207
cm2
struct gsm48_classmark2 cm2
Definition: gsm_04_08.h:1
GSM_PCHAN_NONE
@ GSM_PCHAN_NONE
Definition: gsm_utils.h:202
defs.h
gsm_fn_as_gsmtime_str
char * gsm_fn_as_gsmtime_str(uint32_t fn)
Parse GSM Frame Number into printable string.
Definition: gsm_utils.c:874
gprs_tmsi2tlli
uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type)
Determine TLLI from P-TMSI.
Definition: gsm_utils.c:972
GSM_BAND_1800
@ GSM_BAND_1800
Definition: gsm_utils.h:55
gsm_7bit_decode_ussd
int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead")
Definition: gsm_utils.c:1000
tlli
uint32_t tlli
Definition: gsm_04_08.h:0
_GSM_LCHAN_MAX
@ _GSM_LCHAN_MAX
Definition: gsm_utils.h:227
TLLI_FOREIGN
@ TLLI_FOREIGN
Definition: gsm_utils.h:187
gsm_7bit_encode_ussd
int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead")
Definition: gsm_utils.c:1013