libosmogsm  1.7.0.8-0578c
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  */
21 
22 #pragma once
23 
24 #include <stddef.h>
25 #include <stdint.h>
26 
27 #include <osmocom/core/defs.h>
28 #include <osmocom/core/utils.h>
29 
30 #define ADD_MODULO(sum, delta, modulo) do { \
31  if ((sum += delta) >= modulo) \
32  sum -= modulo; \
33  } while (0)
34 
35 #define GSM_MAX_FN (26*51*2048)
36 
37 /* Max length of random identifier which can be requested via osmo_get_rand_id() */
38 #define OSMO_MAX_RAND_ID_LEN 16
39 
40 struct gsm_time {
41  uint32_t fn; /* FN count */
42  uint16_t t1; /* FN div (26*51) */
43  uint8_t t2; /* FN modulo 26 */
44  uint8_t t3; /* FN modulo 51 */
45  uint8_t tc;
46 };
47 
48 enum gsm_band {
53  GSM_BAND_450 = 0x10,
54  GSM_BAND_480 = 0x20,
55  GSM_BAND_750 = 0x40,
56  GSM_BAND_810 = 0x80,
57 };
58 
59 const char *gsm_band_name(enum gsm_band band);
60 enum gsm_band gsm_band_parse(const char *mhz);
61 
62 int osmo_get_rand_id(uint8_t *out, size_t len);
63 
78 int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
79 
85 int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
86 
99 int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written);
100 
106 int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written);
107 
108 /* the four functions below are helper functions and here for the unit test */
109 int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding)
110  OSMO_DEPRECATED("This function is unable to handle more than 255 septets, "
111  "use gsm_septet_pack() instead.");
112 int gsm_septet_pack(uint8_t *result, const uint8_t *rdata, size_t septet_len, uint8_t padding);
113 int gsm_septet_encode(uint8_t *result, const char *data);
114 uint8_t gsm_get_octet_len(const uint8_t sept_len);
115 int gsm_7bit_decode_n_hdr(char *decoded, size_t n, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind);
116 
117 int ms_class_gmsk_dbm(enum gsm_band band, int ms_class);
118 int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm);
119 int ms_pwr_dbm(enum gsm_band band, uint8_t lvl);
120 
121 /* According to TS 05.08 Chapter 8.1.4 */
122 int rxlev2dbm(uint8_t rxlev);
123 uint8_t dbm2rxlev(int dbm);
124 
125 /* According to GSM 04.08 Chapter 10.5.1.6 */
126 static inline int ms_cm2_a5n_support(uint8_t *cm2, unsigned n) {
127  switch (n) {
128  case 0: return 1;
129  case 1: return (cm2[0] & (1<<3)) ? 0 : 1;
130  case 2: return (cm2[2] & (1<<0)) ? 1 : 0;
131  case 3: return (cm2[2] & (1<<1)) ? 1 : 0;
132  default:
133  return 0;
134  }
135 }
136 
137 /* According to GSM 04.08 Chapter 10.5.1.7 */
138 static inline int ms_cm3_a5n_support(uint8_t *cm3, unsigned n) {
139  switch (n) {
140  case 4: return (cm3[0] & (1<<0)) ? 1 : 0;
141  case 5: return (cm3[0] & (1<<1)) ? 1 : 0;
142  case 6: return (cm3[0] & (1<<2)) ? 1 : 0;
143  case 7: return (cm3[0] & (1<<3)) ? 1 : 0;
144  default:
145  return 0;
146  }
147 }
148 
149 /* According to GSM 04.08 Chapter 10.5.2.29 */
150 static inline int rach_max_trans_val2raw(int val) { return (val >> 1) & 3; }
151 static inline int rach_max_trans_raw2val(int raw) {
152  const int tbl[4] = { 1, 2, 4, 7 };
153  return tbl[raw & 3];
154 }
155 static inline uint8_t rach_tx_integer_raw2val(uint8_t raw) {
156  const int tbl[6] = { 14, 16, 20, 25, 32, 50 };
157  raw &= 0x0f;
158  if (raw <= 9)
159  return raw + 3;
160  return tbl[raw - 10];
161 }
162 
163 #define ARFCN_PCS 0x8000
164 #define ARFCN_UPLINK 0x4000
165 #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */
166 
167 int gsm_arfcn2band_rc(uint16_t arfcn, enum gsm_band *band);
168 enum gsm_band gsm_arfcn2band(uint16_t arfcn) OSMO_DEPRECATED("Use gsm_arfcn2band_rc() instead");
169 
170 /* Convert an ARFCN to the frequency in MHz * 10 */
171 uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink);
172 
173 /* Convert a Frequency in MHz * 10 to ARFCN */
174 uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink);
175 
176 /* Convert from frame number to GSM time */
177 void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn);
178 
179 /* Parse GSM Frame Number into printable string */
180 char *gsm_fn_as_gsmtime_str(uint32_t fn);
181 
182 /* Convert from GSM time to frame number */
183 uint32_t gsm_gsmtime2fn(struct gsm_time *time);
184 
185 /* Returns static buffer with string representation of a GSM Time */
186 char *osmo_dump_gsmtime(const struct gsm_time *tm);
187 char *osmo_dump_gsmtime_buf(char *buf, size_t buf_len, const struct gsm_time *tm);
188 char *osmo_dump_gsmtime_c(const void *ctx, const struct gsm_time *tm);
189 
190 /* GSM TS 03.03 Chapter 2.6 */
199 };
200 
201 /* TS 03.03 Chapter 2.6 */
202 int gprs_tlli_type(uint32_t tlli);
203 
204 uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type);
205 
206 /* Osmocom internal, not part of any gsm spec */
214  GSM_PCHAN_PDCH, /* GPRS PDCH */
215  GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */
221 };
222 /* Backward compatibility with older naming: */
223 #define GSM_PCHAN_TCH_F_TCH_H_PDCH GSM_PCHAN_OSMO_DYN
224 
225 /* Osmocom internal, not part of any gsm spec */
236 };
237 
238 extern const struct value_string gsm_chan_t_names[];
239 static inline const char *gsm_chan_t_name(enum gsm_chan_t val)
240 { return get_value_string(gsm_chan_t_names, val); }
241 
242 /* Deprectated functions */
243 /* Limit encoding and decoding to use no more than this amount of buffer bytes */
244 #define GSM_7BIT_LEGACY_MAX_BUFFER_SIZE 0x10000
245 
246 int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead");
247 int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead");
248 int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
249 int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead");
250 int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
251 
257 
258  /* keep this last */
260 };
261 
262 extern const struct value_string osmo_rat_type_names[];
263 inline static const char *osmo_rat_type_name(enum osmo_rat_type val)
264 { return get_value_string(osmo_rat_type_names, val); }
Definition: gsm_utils.h:234
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:261
uint32_t fn
Definition: gsm_utils.h:41
Definition: gsm_utils.h:208
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:288
Definition: gsm_utils.h:209
uint32_t tlli
Definition: gsm_04_08.h:766
char * osmo_dump_gsmtime(const struct gsm_time *tm)
Definition: gsm_utils.c:902
Definition: gsm_utils.h:256
uint8_t type
Definition: gsm_08_08.h:471
char time[12]
Definition: ipaccess.h:218
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:203
gprs_tlli_type
Definition: gsm_utils.h:191
#define OSMO_DEPRECATED(text)
Definition: gsm_utils.h:51
Definition: gsm_utils.h:197
static uint8_t rach_tx_integer_raw2val(uint8_t raw)
Definition: gsm_utils.h:155
enum gsm_band gsm_band_parse(const char *mhz)
Parse string name of a GSM band.
Definition: gsm_utils.c:694
const char * get_value_string(const struct value_string *vs, uint32_t val)
static const char * osmo_rat_type_name(enum osmo_rat_type val)
Definition: gsm_utils.h:263
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:1003
Definition: gsm_utils.h:235
const struct value_string gsm_chan_t_names[]
Definition: gsm48.c:478
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:1016
static int ms_cm2_a5n_support(uint8_t *cm2, unsigned n)
Definition: gsm_utils.h:126
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:771
Definition: gsm_utils.h:229
uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink)
Convert an ARFCN to the frequency in MHz * 10.
Definition: gsm_utils.c:806
uint16_t t1
Definition: gsm_utils.h:42
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:657
Definition: gsm_utils.h:259
Definition: gsm_utils.h:196
Definition: gsm_utils.h:50
Definition: gsm_utils.h:220
uint8_t tc
Definition: gsm_utils.h:45
Definition: gsm_utils.h:198
int gsm_arfcn2band_rc(uint16_t arfcn, enum gsm_band *band)
Resolve GSM band from ARFCN.
Definition: gsm_utils.c:729
Definition: gsm_utils.h:210
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:267
uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type)
Determine TLLI from P-TMSI.
Definition: gsm_utils.c:975
Definition: gsm_utils.h:230
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:1022
Definition: gsm_utils.h:228
Definition: gsm_utils.h:54
int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead")
Definition: gsm_utils.c:1009
const char * gsm_band_name(enum gsm_band band)
Return string name of a given GSM Band.
Definition: gsm_utils.c:670
uint8_t data[0]
Definition: gsm_utils.h:56
Definition: gsm_utils.h:233
gsm_phys_chan_config
Definition: gsm_utils.h:207
int use gsm_septet_pack() instead.")
Definition: gsm_utils.h:214
uint8_t t3
Definition: gsm_utils.h:44
static const char * gsm_chan_t_name(enum gsm_chan_t val)
Definition: gsm_utils.h:239
static int ms_cm3_a5n_support(uint8_t *cm3, unsigned n)
Definition: gsm_utils.h:138
static int rach_max_trans_raw2val(int raw)
Definition: gsm_utils.h:151
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
Definition: gsm_utils.h:253
Definition: gsm_utils.h:53
Definition: gsm_utils.h:232
Definition: gsm_utils.h:55
struct gsm48_classmark2 cm2
Definition: gsm_04_08.h:767
Definition: gsm_utils.h:218
osmo_rat_type
Definition: gsm_utils.h:252
Definition: gsm_utils.h:40
Definition: gsm_utils.h:254
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:994
int rxlev2dbm(uint8_t rxlev)
Convert TS 05.08 RxLev to dBm (TS 05.08 Chapter 8.1.4)
Definition: gsm_utils.c:646
static int rach_max_trans_val2raw(int val)
Definition: gsm_utils.h:150
uint8_t len
Definition: gsm_04_11.h:467
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:508
Definition: gsm_utils.h:217
Definition: gsm_utils.h:213
uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink)
Convert a Frequency in MHz * 10 to ARFCN.
Definition: gsm_utils.c:833
Definition: gsm_utils.h:227
uint32_t gsm_gsmtime2fn(struct gsm_time *time)
Encode decoded gsm_time to Frame Number.
Definition: gsm_utils.c:888
uint8_t t2
Definition: gsm_utils.h:43
Definition: gsm_utils.h:195
Definition: gsm_utils.h:231
Definition: gsm_utils.h:52
char * osmo_dump_gsmtime_c(const void *ctx, const struct gsm_time *tm)
Definition: gsm_utils.c:908
Definition: gsm_utils.h:255
gsm_chan_t
Definition: gsm_utils.h:226
Definition: gsm_utils.h:216
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:553
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:451
int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding) OSMO_DEPRECATED("This function is unable to handle more than 255 septets
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:425
gsm_band
Definition: gsm_utils.h:48
Definition: gsm_utils.h:192
Definition: gsm_utils.h:193
char * gsm_fn_as_gsmtime_str(uint32_t fn)
Parse GSM Frame Number into printable string.
Definition: gsm_utils.c:877
uint8_t gsm_get_octet_len(const uint8_t sept_len)
Compute number of octets from number of septets.
Definition: gsm_utils.c:188
const struct value_string osmo_rat_type_names[]
Definition: gsm_utils.c:1029
Definition: gsm_utils.h:212
Definition: gsm_utils.h:219
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:605
void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn)
Parse GSM Frame Number into struct gsm_time.
Definition: gsm_utils.c:865
Definition: gsm_utils.h:49
Definition: gsm_utils.h:194
uint8_t length
Definition: gsm_08_08.h:472
char * osmo_dump_gsmtime_buf(char *buf, size_t buf_len, const struct gsm_time *tm)
Definition: gsm_utils.c:894
Definition: gsm_utils.h:215
Definition: gsm_utils.h:211
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:381