Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file gsm_utils.h |
| 2 | * GSM utility functions, e.g. coding and decoding. */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 3 | /* |
| 4 | * (C) 2008 by Daniel Willmann <daniel@totalueberwachung.de> |
| 5 | * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> |
Harald Welte | aebe08c | 2010-03-04 10:39:17 +0100 | [diff] [blame] | 6 | * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 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 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 26 | #pragma once |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 27 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 28 | #include <stddef.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 29 | #include <stdint.h> |
| 30 | |
Jacob Erlbeck | 6b26218 | 2013-08-14 12:26:27 +0200 | [diff] [blame] | 31 | #include <osmocom/core/defs.h> |
Max | fb348ee | 2016-03-30 21:14:53 +0200 | [diff] [blame] | 32 | #include <osmocom/core/utils.h> |
Jacob Erlbeck | 3f69ceb | 2013-08-12 18:31:59 +0200 | [diff] [blame] | 33 | |
Sylvain Munaut | 221030f | 2010-04-27 21:48:40 +0200 | [diff] [blame] | 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 | |
Max | 4b2b0cc | 2017-07-10 14:32:48 +0200 | [diff] [blame] | 41 | /* Max length of random identifier which can be requested via osmo_get_rand_id() */ |
| 42 | #define OSMO_MAX_RAND_ID_LEN 16 |
| 43 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 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 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 52 | enum gsm_band { |
| 53 | GSM_BAND_850 = 1, |
| 54 | GSM_BAND_900 = 2, |
| 55 | GSM_BAND_1800 = 4, |
| 56 | GSM_BAND_1900 = 8, |
| 57 | GSM_BAND_450 = 0x10, |
| 58 | GSM_BAND_480 = 0x20, |
| 59 | GSM_BAND_750 = 0x40, |
| 60 | GSM_BAND_810 = 0x80, |
| 61 | }; |
| 62 | |
Harald Welte | cbc8062 | 2010-03-22 08:28:44 +0800 | [diff] [blame] | 63 | const char *gsm_band_name(enum gsm_band band); |
Harald Welte | aebe08c | 2010-03-04 10:39:17 +0100 | [diff] [blame] | 64 | enum gsm_band gsm_band_parse(const char *mhz); |
| 65 | |
Max | 4b2b0cc | 2017-07-10 14:32:48 +0200 | [diff] [blame] | 66 | int osmo_get_rand_id(uint8_t *out, size_t len); |
| 67 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 68 | /*! |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 69 | * Decode a sequence of GSM 03.38 encoded 7 bit characters. |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 70 | * |
| 71 | * \param decoded The destination buffer for the decoded characters. |
| 72 | * \param n A maximum of n chars is written (incl. terminating \0). |
| 73 | * Requires n >= 1. |
| 74 | * \param user_data A pointer to the start of the packed 7bit character |
| 75 | * sequence. |
Neels Hofmeyr | cda9885 | 2016-02-29 09:56:26 +0100 | [diff] [blame] | 76 | * \param length The length of the input sequence in septets, for |
| 77 | * example pass octet_length*8/7. |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 78 | * |
| 79 | * \returns the number of (8 bit) chars written excluding the terminating \0. |
| 80 | * This is the same like strlen(decoded). |
| 81 | */ |
| 82 | int gsm_7bit_decode_n(char *decoded, size_t n, const uint8_t *user_data, uint8_t length); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 83 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 84 | /*! |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 85 | * Decode a sequence of 7 bit characters (USSD encoding). |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 86 | * |
| 87 | * \see gsm_7bit_encode_n() |
| 88 | */ |
| 89 | int gsm_7bit_decode_n_ussd(char *decoded, size_t n, const uint8_t *user_data, uint8_t length); |
| 90 | |
Jacob Erlbeck | 3f69ceb | 2013-08-12 18:31:59 +0200 | [diff] [blame] | 91 | /*! |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 92 | * Encode a text string into GSM 03.38 encoded 7 bit characters. |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 93 | * |
| 94 | * \param result The destination buffer for the packed 7 bit sequence. |
| 95 | * \param n A maximum of n octets is written. |
| 96 | * \param data A pointer to the start of the \0 terminated 8 bit character |
| 97 | * string. |
| 98 | * \param octets_written Iff not NULL, *octets_written will be set to the |
| 99 | * number of octets written to the result buffer. |
| 100 | * |
| 101 | * \returns the number of septets that have been created. |
| 102 | */ |
| 103 | int gsm_7bit_encode_n(uint8_t *result, size_t n, const char *data, int *octets_written); |
| 104 | |
| 105 | /*! |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 106 | * Encode a text string into GSM 03.38 encoded 7 bit characters (USSD encoding). |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 107 | * |
| 108 | * \see gsm_7bit_decode_n() |
| 109 | */ |
| 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 */ |
Harald Welte | ca69388 | 2013-03-13 15:10:55 +0100 | [diff] [blame] | 113 | int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding); |
Dennis Wehrle | 291e613 | 2011-07-24 20:14:13 +0200 | [diff] [blame] | 114 | int gsm_septet_encode(uint8_t *result, const char *data); |
| 115 | uint8_t gsm_get_octet_len(const uint8_t sept_len); |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 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); |
Dennis Wehrle | 291e613 | 2011-07-24 20:14:13 +0200 | [diff] [blame] | 117 | |
Harald Welte | b7b6123 | 2011-07-23 10:49:51 +0200 | [diff] [blame] | 118 | unsigned int ms_class_gmsk_dbm(enum gsm_band band, int ms_class); |
Andreas Eversberg | 2a68c7c | 2011-06-26 11:41:48 +0200 | [diff] [blame] | 119 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 120 | int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm); |
| 121 | int ms_pwr_dbm(enum gsm_band band, uint8_t lvl); |
| 122 | |
Bhaskar | 6b30f92 | 2013-05-16 17:35:49 +0530 | [diff] [blame] | 123 | /* According to TS 05.08 Chapter 8.1.4 */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 124 | int rxlev2dbm(uint8_t rxlev); |
| 125 | uint8_t dbm2rxlev(int dbm); |
| 126 | |
Sylvain Munaut | 4f58549 | 2010-06-09 13:38:56 +0200 | [diff] [blame] | 127 | /* According to GSM 04.08 Chapter 10.5.1.6 */ |
Max | 402b9b0 | 2016-04-21 14:58:30 +0200 | [diff] [blame] | 128 | static inline int ms_cm2_a5n_support(uint8_t *cm2, unsigned n) { |
Sylvain Munaut | 4f58549 | 2010-06-09 13:38:56 +0200 | [diff] [blame] | 129 | switch (n) { |
| 130 | case 0: return 1; |
| 131 | case 1: return (cm2[0] & (1<<3)) ? 0 : 1; |
| 132 | case 2: return (cm2[2] & (1<<0)) ? 1 : 0; |
| 133 | case 3: return (cm2[2] & (1<<1)) ? 1 : 0; |
| 134 | default: |
| 135 | return 0; |
| 136 | } |
| 137 | } |
| 138 | |
Max | 402b9b0 | 2016-04-21 14:58:30 +0200 | [diff] [blame] | 139 | /* According to GSM 04.08 Chapter 10.5.1.7 */ |
| 140 | static inline int ms_cm3_a5n_support(uint8_t *cm3, unsigned n) { |
| 141 | switch (n) { |
| 142 | case 4: return (cm3[0] & (1<<0)) ? 1 : 0; |
| 143 | case 5: return (cm3[0] & (1<<1)) ? 1 : 0; |
| 144 | case 6: return (cm3[0] & (1<<2)) ? 1 : 0; |
| 145 | case 7: return (cm3[0] & (1<<3)) ? 1 : 0; |
| 146 | default: |
| 147 | return 0; |
| 148 | } |
| 149 | } |
| 150 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 151 | /* According to GSM 04.08 Chapter 10.5.2.29 */ |
| 152 | static inline int rach_max_trans_val2raw(int val) { return (val >> 1) & 3; } |
| 153 | static inline int rach_max_trans_raw2val(int raw) { |
| 154 | const int tbl[4] = { 1, 2, 4, 7 }; |
| 155 | return tbl[raw & 3]; |
| 156 | } |
| 157 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 158 | #define ARFCN_PCS 0x8000 |
| 159 | #define ARFCN_UPLINK 0x4000 |
Sylvain Munaut | 2a471ee | 2010-11-13 17:51:37 +0100 | [diff] [blame] | 160 | #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */ |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 161 | |
| 162 | enum gsm_band gsm_arfcn2band(uint16_t arfcn); |
| 163 | |
| 164 | /* Convert an ARFCN to the frequency in MHz * 10 */ |
| 165 | uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink); |
| 166 | |
Sylvain Munaut | 5572031 | 2012-12-11 23:44:41 +0100 | [diff] [blame] | 167 | /* Convert a Frequency in MHz * 10 to ARFCN */ |
| 168 | uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink); |
| 169 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 170 | /* Convert from frame number to GSM time */ |
| 171 | void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn); |
| 172 | |
Philipp Maier | b808da4 | 2017-06-26 10:50:28 +0200 | [diff] [blame] | 173 | /* Parse GSM Frame Number into printable string */ |
| 174 | char *gsm_fn_as_gsmtime_str(uint32_t fn); |
| 175 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 176 | /* Convert from GSM time to frame number */ |
| 177 | uint32_t gsm_gsmtime2fn(struct gsm_time *time); |
| 178 | |
Pau Espin Pedrol | 363130f | 2017-07-03 10:42:42 +0200 | [diff] [blame] | 179 | /* Returns static buffer with string representation of a GSM Time */ |
| 180 | char *osmo_dump_gsmtime(const struct gsm_time *tm); |
| 181 | |
Harald Welte | a1c4f76 | 2010-05-01 11:59:42 +0200 | [diff] [blame] | 182 | /* GSM TS 03.03 Chapter 2.6 */ |
Harald Welte | c226317 | 2010-06-01 10:47:07 +0200 | [diff] [blame] | 183 | enum gprs_tlli_type { |
Harald Welte | a1c4f76 | 2010-05-01 11:59:42 +0200 | [diff] [blame] | 184 | TLLI_LOCAL, |
| 185 | TLLI_FOREIGN, |
| 186 | TLLI_RANDOM, |
| 187 | TLLI_AUXILIARY, |
| 188 | TLLI_RESERVED, |
Harald Welte | 1f6aad1 | 2015-08-15 19:51:45 +0200 | [diff] [blame] | 189 | TLLI_G_RNTI, |
| 190 | TLLI_RAND_G_RNTI, |
Harald Welte | a1c4f76 | 2010-05-01 11:59:42 +0200 | [diff] [blame] | 191 | }; |
| 192 | |
| 193 | /* TS 03.03 Chapter 2.6 */ |
| 194 | int gprs_tlli_type(uint32_t tlli); |
| 195 | |
Harald Welte | c226317 | 2010-06-01 10:47:07 +0200 | [diff] [blame] | 196 | uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type); |
| 197 | |
Harald Welte | 11c7193 | 2011-05-24 17:15:12 +0200 | [diff] [blame] | 198 | /* Osmocom internal, not part of any gsm spec */ |
| 199 | enum gsm_phys_chan_config { |
| 200 | GSM_PCHAN_NONE, |
| 201 | GSM_PCHAN_CCCH, |
| 202 | GSM_PCHAN_CCCH_SDCCH4, |
| 203 | GSM_PCHAN_TCH_F, |
| 204 | GSM_PCHAN_TCH_H, |
| 205 | GSM_PCHAN_SDCCH8_SACCH8C, |
| 206 | GSM_PCHAN_PDCH, /* GPRS PDCH */ |
| 207 | GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */ |
| 208 | GSM_PCHAN_UNKNOWN, |
Harald Welte | 1b12d16 | 2014-12-28 13:37:01 +0100 | [diff] [blame] | 209 | GSM_PCHAN_CCCH_SDCCH4_CBCH, |
| 210 | GSM_PCHAN_SDCCH8_SACCH8C_CBCH, |
Neels Hofmeyr | fd80f5a | 2016-07-14 03:21:05 +0200 | [diff] [blame] | 211 | GSM_PCHAN_TCH_F_TCH_H_PDCH, |
Harald Welte | 11c7193 | 2011-05-24 17:15:12 +0200 | [diff] [blame] | 212 | _GSM_PCHAN_MAX |
| 213 | }; |
| 214 | |
| 215 | /* Osmocom internal, not part of any gsm spec */ |
| 216 | enum gsm_chan_t { |
| 217 | GSM_LCHAN_NONE, |
| 218 | GSM_LCHAN_SDCCH, |
| 219 | GSM_LCHAN_TCH_F, |
| 220 | GSM_LCHAN_TCH_H, |
| 221 | GSM_LCHAN_UNKNOWN, |
| 222 | GSM_LCHAN_CCCH, |
Harald Welte | 81cd54a | 2012-04-19 23:18:43 +0200 | [diff] [blame] | 223 | GSM_LCHAN_PDTCH, |
Harald Welte | 1b12d16 | 2014-12-28 13:37:01 +0100 | [diff] [blame] | 224 | GSM_LCHAN_CBCH, |
Harald Welte | 11c7193 | 2011-05-24 17:15:12 +0200 | [diff] [blame] | 225 | _GSM_LCHAN_MAX |
| 226 | }; |
| 227 | |
Max | fb348ee | 2016-03-30 21:14:53 +0200 | [diff] [blame] | 228 | extern const struct value_string gsm_chan_t_names[]; |
| 229 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 230 | /* Deprectated functions */ |
Jacob Erlbeck | 26cbd45 | 2014-01-07 13:39:24 +0100 | [diff] [blame] | 231 | /* Limit encoding and decoding to use no more than this amount of buffer bytes */ |
| 232 | #define GSM_7BIT_LEGACY_MAX_BUFFER_SIZE 0x10000 |
| 233 | |
Jacob Erlbeck | 3f69ceb | 2013-08-12 18:31:59 +0200 | [diff] [blame] | 234 | int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n() instead"); |
| 235 | int gsm_7bit_decode_ussd(char *decoded, const uint8_t *user_data, uint8_t length) OSMO_DEPRECATED("Use gsm_7bit_decode_n_ussd() instead"); |
| 236 | int gsm_7bit_encode(uint8_t *result, const char *data) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead"); |
| 237 | int gsm_7bit_encode_ussd(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n_ussd() instead"); |
| 238 | int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written) OSMO_DEPRECATED("Use gsm_7bit_encode_n() instead"); |