libosmogsm  0.9.0
Osmocom GSM library
gsm_utils.h
1 /* GSM utility functions, e.g. coding and decoding */
2 /*
3  * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de>
4  * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
5  * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
6  *
7  * All Rights Reserved
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  *
23  */
24 
25 #pragma once
26 
27 #include <stddef.h>
28 #include <stdint.h>
29 
30 #include <osmocom/core/defs.h>
31 
32 #define ADD_MODULO(sum, delta, modulo) do { \
33  if ((sum += delta) >= modulo) \
34  sum -= modulo; \
35  } while (0)
36 
37 #define GSM_MAX_FN (26*51*2048)
38 
39 struct gsm_time {
40  uint32_t fn; /* FN count */
41  uint16_t t1; /* FN div (26*51) */
42  uint8_t t2; /* FN modulo 26 */
43  uint8_t t3; /* FN modulo 51 */
44  uint8_t tc;
45 };
46 
47 enum gsm_band {
48  GSM_BAND_850 = 1,
49  GSM_BAND_900 = 2,
50  GSM_BAND_1800 = 4,
51  GSM_BAND_1900 = 8,
52  GSM_BAND_450 = 0x10,
53  GSM_BAND_480 = 0x20,
54  GSM_BAND_750 = 0x40,
55  GSM_BAND_810 = 0x80,
56 };
57 
58 const char *gsm_band_name(enum gsm_band band);
59 enum gsm_band gsm_band_parse(const char *mhz);
60 
74 int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
75 
81 int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length);
82 
95 int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written);
96 
102 int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written);
103 
104 /* the four functions below are helper functions and here for the unit test */
105 int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding);
106 int gsm_septet_encode(uint8_t *result, const char *data);
107 uint8_t gsm_get_octet_len(const uint8_t sept_len);
108 int gsm_7bit_decode_n_hdr(char *decoded, size_t n, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind);
109 
110 unsigned int ms_class_gmsk_dbm(enum gsm_band band, int ms_class);
111 
112 int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm);
113 int ms_pwr_dbm(enum gsm_band band, uint8_t lvl);
114 
115 /* According to TS 05.08 Chapter 8.1.4 */
116 int rxlev2dbm(uint8_t rxlev);
117 uint8_t dbm2rxlev(int dbm);
118 
119 /* According to GSM 04.08 Chapter 10.5.1.6 */
120 static inline int ms_cm2_a5n_support(uint8_t *cm2, int n) {
121  switch (n) {
122  case 0: return 1;
123  case 1: return (cm2[0] & (1<<3)) ? 0 : 1;
124  case 2: return (cm2[2] & (1<<0)) ? 1 : 0;
125  case 3: return (cm2[2] & (1<<1)) ? 1 : 0;
126  default:
127  return 0;
128  }
129 }
130 
131 /* According to GSM 04.08 Chapter 10.5.2.29 */
132 static inline int rach_max_trans_val2raw(int val) { return (val >> 1) & 3; }
133 static inline int rach_max_trans_raw2val(int raw) {
134  const int tbl[4] = { 1, 2, 4, 7 };
135  return tbl[raw & 3];
136 }
137 
138 #define ARFCN_PCS 0x8000
139 #define ARFCN_UPLINK 0x4000
140 #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */
141 
142 enum gsm_band gsm_arfcn2band(uint16_t arfcn);
143 
144 /* Convert an ARFCN to the frequency in MHz * 10 */
145 uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink);
146 
147 /* Convert a Frequency in MHz * 10 to ARFCN */
148 uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink);
149 
150 /* Convert from frame number to GSM time */
151 void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn);
152 
153 /* Convert from GSM time to frame number */
154 uint32_t gsm_gsmtime2fn(struct gsm_time *time);
155 
156 /* GSM TS 03.03 Chapter 2.6 */
157 enum gprs_tlli_type {
158  TLLI_LOCAL,
159  TLLI_FOREIGN,
160  TLLI_RANDOM,
161  TLLI_AUXILIARY,
162  TLLI_RESERVED,
163  TLLI_G_RNTI,
164  TLLI_RAND_G_RNTI,
165 };
166 
167 /* TS 03.03 Chapter 2.6 */
168 int gprs_tlli_type(uint32_t tlli);
169 
170 uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type);
171 
172 /* Osmocom internal, not part of any gsm spec */
173 enum gsm_phys_chan_config {
174  GSM_PCHAN_NONE,
175  GSM_PCHAN_CCCH,
176  GSM_PCHAN_CCCH_SDCCH4,
177  GSM_PCHAN_TCH_F,
178  GSM_PCHAN_TCH_H,
179  GSM_PCHAN_SDCCH8_SACCH8C,
180  GSM_PCHAN_PDCH, /* GPRS PDCH */
181  GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */
182  GSM_PCHAN_UNKNOWN,
183  GSM_PCHAN_CCCH_SDCCH4_CBCH,
184  GSM_PCHAN_SDCCH8_SACCH8C_CBCH,
185  _GSM_PCHAN_MAX
186 };
187 
188 /* Osmocom internal, not part of any gsm spec */
189 enum gsm_chan_t {
190  GSM_LCHAN_NONE,
191  GSM_LCHAN_SDCCH,
192  GSM_LCHAN_TCH_F,
193  GSM_LCHAN_TCH_H,
194  GSM_LCHAN_UNKNOWN,
195  GSM_LCHAN_CCCH,
196  GSM_LCHAN_PDTCH,
197  GSM_LCHAN_CBCH,
198  _GSM_LCHAN_MAX
199 };
200 
201 /* Deprectated functions */
202 /* Limit encoding and decoding to use no more than this amount of buffer bytes */
203 #define GSM_7BIT_LEGACY_MAX_BUFFER_SIZE 0x10000
204 
205 int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead");
206 int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead");
207 int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
208 int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead");
209 int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead");
uint8_t data[0]
actual payload data
Definition: gsm_08_58.h:106
Definition: gsm_utils.h:39
uint8_t length
Length in octets.
Definition: gsm_12_21.h:115