libosmogsm  1.9.0.19-e4f34.202310252026
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 #define GSM_FN_UNSET 0xFFFFFFFF
37 
38 /* Max length of random identifier which can be requested via osmo_get_rand_id() */
39 #define OSMO_MAX_RAND_ID_LEN 16
40 
41 struct gsm_time {
42  uint32_t fn; /* FN count */
43  uint16_t t1; /* FN div (26*51) */
44  uint8_t t2; /* FN modulo 26 */
45  uint8_t t3; /* FN modulo 51 */
46  uint8_t tc;
47 };
48 
49 enum gsm_band {
54  GSM_BAND_450 = 0x10,
55  GSM_BAND_480 = 0x20,
56  GSM_BAND_750 = 0x40,
57  GSM_BAND_810 = 0x80,
58 };
59 
60 const char *gsm_band_name(enum gsm_band band);
61 enum gsm_band gsm_band_parse(const char *mhz);
62 
63 int osmo_get_rand_id(uint8_t *out, size_t len);
64 
79 int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
80 
86 int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
87 
100 int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written);
101 
107 int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written);
108 
109 /* the four functions below are helper functions and here for the unit test */
110 int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding)
111  OSMO_DEPRECATED("This function is unable to handle more than 255 septets, "
112  "use gsm_septet_pack() instead.");
113 int gsm_septet_pack(uint8_t *result, const uint8_t *rdata, size_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 static inline uint8_t rach_tx_integer_raw2val(uint8_t raw) {
157  const int tbl[6] = { 14, 16, 20, 25, 32, 50 };
158  raw &= 0x0f;
159  if (raw <= 9)
160  return raw + 3;
161  return tbl[raw - 10];
162 }
163 
164 #define ARFCN_PCS 0x8000
165 #define ARFCN_UPLINK 0x4000
166 #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */
167 
168 int gsm_arfcn2band_rc(uint16_t arfcn, enum gsm_band *band);
169 enum gsm_band gsm_arfcn2band(uint16_t arfcn) OSMO_DEPRECATED("Use gsm_arfcn2band_rc() instead");
170 
171 /* Convert an ARFCN to the frequency in MHz * 10 */
172 uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink);
173 
174 /* Convert a Frequency in MHz * 10 to ARFCN */
175 uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink);
176 
177 /* Convert from frame number to GSM time */
178 void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn);
179 
180 /* Parse GSM Frame Number into printable string */
181 char *gsm_fn_as_gsmtime_str(uint32_t fn);
182 
183 /* Convert from GSM time to frame number */
184 uint32_t gsm_gsmtime2fn(const struct gsm_time *time);
185 
186 /* Returns static buffer with string representation of a GSM Time */
187 char *osmo_dump_gsmtime(const struct gsm_time *tm);
188 char *osmo_dump_gsmtime_buf(char *buf, size_t buf_len, const struct gsm_time *tm);
189 char *osmo_dump_gsmtime_c(const void *ctx, const struct gsm_time *tm);
190 
191 /* Reduced Frame Number (3GPP TS 44.018 ยง10.5.2.38) */
192 #define GSM_RFN_MODULUS 42432
193 uint32_t gsm_rfn2fn(uint16_t rfn, uint32_t curr_fn);
194 static inline uint16_t gsm_fn2rfn(uint32_t fn)
195 {
196  return fn % GSM_RFN_MODULUS;
197 }
198 
199 /* GSM TS 03.03 Chapter 2.6 */
208 };
209 
210 /* TS 03.03 Chapter 2.6 */
211 int gprs_tlli_type(uint32_t tlli);
212 
213 uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type);
214 
215 /* Osmocom internal, not part of any gsm spec */
223  GSM_PCHAN_PDCH, /* GPRS PDCH */
224  GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */
230 };
231 /* Backward compatibility with older naming: */
232 #define GSM_PCHAN_TCH_F_TCH_H_PDCH GSM_PCHAN_OSMO_DYN
233 
234 /* Osmocom internal, not part of any gsm spec */
245 };
246 
247 extern const struct value_string gsm_chan_t_names[];
248 static inline const char *gsm_chan_t_name(enum gsm_chan_t val)
249 { return get_value_string(gsm_chan_t_names, val); }
250 
251 /* Deprectated functions */
252 /* Limit encoding and decoding to use no more than this amount of buffer bytes */
253 #define GSM_7BIT_LEGACY_MAX_BUFFER_SIZE 0x10000
254 
255 int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead");
256 int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead");
257 int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
258 int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead");
259 int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
260 
266 
267  /* keep this last */
269 };
270 
271 extern const struct value_string osmo_rat_type_names[];
272 inline static const char *osmo_rat_type_name(enum osmo_rat_type val)
273 { return get_value_string(osmo_rat_type_names, val); }
#define GSM_RFN_MODULUS
Definition: gsm_utils.h:192
Definition: gsm_utils.h:243
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:262
uint32_t fn
Definition: gsm_utils.h:42
Definition: gsm_utils.h:217
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:289
Definition: gsm_utils.h:218
uint32_t tlli
Definition: gsm_04_08.h:806
char * osmo_dump_gsmtime(const struct gsm_time *tm)
Definition: gsm_utils.c:914
uint32_t gsm_rfn2fn(uint16_t rfn, uint32_t curr_fn)
Definition: gsm_utils.c:929
Definition: gsm_utils.h:265
uint8_t type
Definition: gsm_08_08.h:484
char time[12]
Definition: ipaccess.h:219
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:204
gprs_tlli_type
Definition: gsm_utils.h:200
#define OSMO_DEPRECATED(text)
Definition: gsm_utils.h:52
Definition: gsm_utils.h:206
static uint8_t rach_tx_integer_raw2val(uint8_t raw)
Definition: gsm_utils.h:156
enum gsm_band gsm_band_parse(const char *mhz)
Parse string name of a GSM band.
Definition: gsm_utils.c:695
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:272
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:1054
Definition: gsm_utils.h:244
const struct value_string gsm_chan_t_names[]
Definition: gsm48.c:519
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:1067
static int ms_cm2_a5n_support(uint8_t *cm2, unsigned n)
Definition: gsm_utils.h:127
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:772
Definition: gsm_utils.h:238
uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink)
Convert an ARFCN to the frequency in MHz * 10.
Definition: gsm_utils.c:807
uint16_t t1
Definition: gsm_utils.h:43
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:658
Definition: gsm_utils.h:268
Definition: gsm_utils.h:205
Definition: gsm_utils.h:51
Definition: gsm_utils.h:229
uint8_t tc
Definition: gsm_utils.h:46
static uint16_t gsm_fn2rfn(uint32_t fn)
Definition: gsm_utils.h:194
Definition: gsm_utils.h:207
int gsm_arfcn2band_rc(uint16_t arfcn, enum gsm_band *band)
Resolve GSM band from ARFCN.
Definition: gsm_utils.c:730
Definition: gsm_utils.h:219
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:268
uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type)
Determine TLLI from P-TMSI.
Definition: gsm_utils.c:1026
Definition: gsm_utils.h:239
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:1073
Definition: gsm_utils.h:237
Definition: gsm_utils.h:55
int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead")
Definition: gsm_utils.c:1060
const char * gsm_band_name(enum gsm_band band)
Return string name of a given GSM Band.
Definition: gsm_utils.c:671
uint8_t data[0]
Definition: gsm_utils.h:57
Definition: gsm_utils.h:242
gsm_phys_chan_config
Definition: gsm_utils.h:216
int use gsm_septet_pack() instead.")
Definition: gsm_utils.h:223
uint8_t t3
Definition: gsm_utils.h:45
static const char * gsm_chan_t_name(enum gsm_chan_t val)
Definition: gsm_utils.h:248
static int ms_cm3_a5n_support(uint8_t *cm3, unsigned n)
Definition: gsm_utils.h:139
static int rach_max_trans_raw2val(int raw)
Definition: gsm_utils.h:152
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:262
Definition: gsm_utils.h:54
Definition: gsm_utils.h:241
Definition: gsm_utils.h:56
struct gsm48_classmark2 cm2
Definition: gsm_04_08.h:807
Definition: gsm_utils.h:227
osmo_rat_type
Definition: gsm_utils.h:261
Definition: gsm_utils.h:41
Definition: gsm_utils.h:263
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:1045
int rxlev2dbm(uint8_t rxlev)
Convert TS 05.08 RxLev to dBm (TS 05.08 Chapter 8.1.4)
Definition: gsm_utils.c:647
static int rach_max_trans_val2raw(int val)
Definition: gsm_utils.h:151
uint8_t len
Definition: gsm_04_11.h:480
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:509
Definition: gsm_utils.h:226
Definition: gsm_utils.h:222
uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink)
Convert a Frequency in MHz * 10 to ARFCN.
Definition: gsm_utils.c:834
Definition: gsm_utils.h:236
uint8_t t2
Definition: gsm_utils.h:44
Definition: gsm_utils.h:204
Definition: gsm_utils.h:240
Definition: gsm_utils.h:53
char * osmo_dump_gsmtime_c(const void *ctx, const struct gsm_time *tm)
Definition: gsm_utils.c:920
Definition: gsm_utils.h:264
gsm_chan_t
Definition: gsm_utils.h:235
Definition: gsm_utils.h:225
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:554
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:452
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:426
gsm_band
Definition: gsm_utils.h:49
Definition: gsm_utils.h:201
Definition: gsm_utils.h:202
char * gsm_fn_as_gsmtime_str(uint32_t fn)
Parse GSM Frame Number into printable string.
Definition: gsm_utils.c:878
uint8_t gsm_get_octet_len(const uint8_t sept_len)
Compute number of octets from number of septets.
Definition: gsm_utils.c:189
const struct value_string osmo_rat_type_names[]
Definition: gsm_utils.c:1080
Definition: gsm_utils.h:221
Definition: gsm_utils.h:228
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:606
void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn)
Parse GSM Frame Number into struct gsm_time.
Definition: gsm_utils.c:866
Definition: gsm_utils.h:50
Definition: gsm_utils.h:203
uint8_t length
Definition: gsm_08_08.h:485
char * osmo_dump_gsmtime_buf(char *buf, size_t buf_len, const struct gsm_time *tm)
Definition: gsm_utils.c:906
Definition: gsm_utils.h:224
uint32_t gsm_gsmtime2fn(const struct gsm_time *time)
Encode decoded gsm_time to Frame Number.
Definition: gsm_utils.c:889
Definition: gsm_utils.h:220
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:382