libosmogsm  0.9.6.311-c977
Osmocom GSM library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 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 
77 int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
78 
84 int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
85 
98 int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written);
99 
105 int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written);
106 
107 /* the four functions below are helper functions and here for the unit test */
108 int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding);
109 int gsm_septet_encode(uint8_t *result, const char *data);
110 uint8_t gsm_get_octet_len(const uint8_t sept_len);
111 int gsm_7bit_decode_n_hdr(char *decoded, size_t n, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind);
112 
113 unsigned int ms_class_gmsk_dbm(enum gsm_band band, int ms_class);
114 
115 int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm);
116 int ms_pwr_dbm(enum gsm_band band, uint8_t lvl);
117 
118 /* According to TS 05.08 Chapter 8.1.4 */
119 int rxlev2dbm(uint8_t rxlev);
120 uint8_t dbm2rxlev(int dbm);
121 
122 /* According to GSM 04.08 Chapter 10.5.1.6 */
123 static inline int ms_cm2_a5n_support(uint8_t *cm2, unsigned n) {
124  switch (n) {
125  case 0: return 1;
126  case 1: return (cm2[0] & (1<<3)) ? 0 : 1;
127  case 2: return (cm2[2] & (1<<0)) ? 1 : 0;
128  case 3: return (cm2[2] & (1<<1)) ? 1 : 0;
129  default:
130  return 0;
131  }
132 }
133 
134 /* According to GSM 04.08 Chapter 10.5.1.7 */
135 static inline int ms_cm3_a5n_support(uint8_t *cm3, unsigned n) {
136  switch (n) {
137  case 4: return (cm3[0] & (1<<0)) ? 1 : 0;
138  case 5: return (cm3[0] & (1<<1)) ? 1 : 0;
139  case 6: return (cm3[0] & (1<<2)) ? 1 : 0;
140  case 7: return (cm3[0] & (1<<3)) ? 1 : 0;
141  default:
142  return 0;
143  }
144 }
145 
146 /* According to GSM 04.08 Chapter 10.5.2.29 */
147 static inline int rach_max_trans_val2raw(int val) { return (val >> 1) & 3; }
148 static inline int rach_max_trans_raw2val(int raw) {
149  const int tbl[4] = { 1, 2, 4, 7 };
150  return tbl[raw & 3];
151 }
152 
153 #define ARFCN_PCS 0x8000
154 #define ARFCN_UPLINK 0x4000
155 #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */
156 
157 enum gsm_band gsm_arfcn2band(uint16_t arfcn);
158 
159 /* Convert an ARFCN to the frequency in MHz * 10 */
160 uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink);
161 
162 /* Convert a Frequency in MHz * 10 to ARFCN */
163 uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink);
164 
165 /* Convert from frame number to GSM time */
166 void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn);
167 
168 /* Convert from GSM time to frame number */
169 uint32_t gsm_gsmtime2fn(struct gsm_time *time);
170 
171 /* GSM TS 03.03 Chapter 2.6 */
180 };
181 
182 /* TS 03.03 Chapter 2.6 */
183 int gprs_tlli_type(uint32_t tlli);
184 
185 uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type);
186 
187 /* Osmocom internal, not part of any gsm spec */
195  GSM_PCHAN_PDCH, /* GPRS PDCH */
196  GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */
202 };
203 
204 /* Osmocom internal, not part of any gsm spec */
215 };
216 
217 extern const struct value_string gsm_chan_t_names[];
218 
219 /* Deprectated functions */
220 /* Limit encoding and decoding to use no more than this amount of buffer bytes */
221 #define GSM_7BIT_LEGACY_MAX_BUFFER_SIZE 0x10000
222 
223 int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead");
224 int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead");
225 int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
226 int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead");
227 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.h:213
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:215
uint32_t fn
Definition: gsm_utils.h:42
Definition: gsm_utils.h:189
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:242
Definition: gsm_utils.h:190
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:157
gprs_tlli_type
Definition: gsm_utils.h:172
Definition: gsm_utils.h:52
Definition: gsm_utils.h:178
enum gsm_band gsm_band_parse(const char *mhz)
Parse string name of a GSM band.
Definition: gsm_utils.c:597
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:848
Definition: gsm_utils.h:214
const struct value_string gsm_chan_t_names[]
Definition: gsm48.c:391
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:861
static int ms_cm2_a5n_support(uint8_t *cm2, unsigned n)
Definition: gsm_utils.h:123
Definition: gsm_utils.h:208
uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink)
Convert an ARFCN to the frequency in MHz * 10.
Definition: gsm_utils.c:684
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:560
Definition: gsm_utils.h:177
Definition: gsm_utils.h:51
Definition: gsm_utils.h:201
uint8_t tc
Definition: gsm_utils.h:46
Definition: gsm_utils.h:179
Definition: gsm_utils.h:191
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:221
uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type)
Determine TLLI from P-TMSI.
Definition: gsm_utils.c:820
Definition: gsm_utils.h:209
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:867
Definition: gsm_utils.h:207
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:854
const char * gsm_band_name(enum gsm_band band)
Return string name of a given GSM Band.
Definition: gsm_utils.c:573
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:276
Definition: gsm_utils.h:57
Definition: gsm_utils.h:212
gsm_phys_chan_config
Definition: gsm_utils.h:188
Definition: gsm_utils.h:195
uint8_t t3
Definition: gsm_utils.h:45
static int ms_cm3_a5n_support(uint8_t *cm3, unsigned n)
Definition: gsm_utils.h:135
static int rach_max_trans_raw2val(int raw)
Definition: gsm_utils.h:148
unsigned 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:411
Definition: gsm_utils.h:200
Definition: gsm_utils.h:54
Definition: gsm_utils.h:211
Definition: gsm_utils.h:56
Definition: gsm_utils.h:199
Definition: gsm_utils.h:41
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:839
int rxlev2dbm(uint8_t rxlev)
Convert TS 05.08 RxLev to dBm (TS 05.08 Chapter 8.1.4)
Definition: gsm_utils.c:549
static int rach_max_trans_val2raw(int val)
Definition: gsm_utils.h:147
Definition: gsm_utils.h:198
Definition: gsm_utils.h:194
uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink)
Convert a Frequency in MHz * 10 to ARFCN.
Definition: gsm_utils.c:711
Definition: gsm_utils.h:206
uint32_t gsm_gsmtime2fn(struct gsm_time *time)
Encode decoded gsm_time to Frame Number.
Definition: gsm_utils.c:755
uint8_t t2
Definition: gsm_utils.h:44
Definition: gsm_utils.h:176
enum gsm_band gsm_arfcn2band(uint16_t arfcn)
Resolve GSM band from ARFCN In Osmocom, we use the highest bit of the arfcn to indicate PCS...
Definition: gsm_utils.c:631
Definition: gsm_utils.h:210
Definition: gsm_utils.h:53
gsm_chan_t
Definition: gsm_utils.h:205
Definition: gsm_utils.h:197
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:456
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:371
gsm_band
Definition: gsm_utils.h:49
Definition: gsm_utils.h:173
Definition: gsm_utils.h:174
uint8_t gsm_get_octet_len(const uint8_t sept_len)
Compute number of octets from number of septets, for instance: 47 septets needs 41,125 = 42 octets
Definition: gsm_utils.c:142
Definition: gsm_utils.h:193
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:508
void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn)
Parse GSM Frame Number into struct gsm_time.
Definition: gsm_utils.c:743
Definition: gsm_utils.h:50
Definition: gsm_utils.h:175
Definition: gsm_utils.h:196
Definition: gsm_utils.h:192
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:327