Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 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> |
Harald Welte | aebe08c | 2010-03-04 10:39:17 +0100 | [diff] [blame] | 5 | * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 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 | #ifndef GSM_UTILS_H |
| 26 | #define GSM_UTILS_H |
| 27 | |
| 28 | #include <stdint.h> |
| 29 | |
Sylvain Munaut | 221030f | 2010-04-27 21:48:40 +0200 | [diff] [blame] | 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 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 37 | struct gsm_time { |
| 38 | uint32_t fn; /* FN count */ |
| 39 | uint16_t t1; /* FN div (26*51) */ |
| 40 | uint8_t t2; /* FN modulo 26 */ |
| 41 | uint8_t t3; /* FN modulo 51 */ |
| 42 | uint8_t tc; |
| 43 | }; |
| 44 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 45 | enum gsm_band { |
| 46 | GSM_BAND_850 = 1, |
| 47 | GSM_BAND_900 = 2, |
| 48 | GSM_BAND_1800 = 4, |
| 49 | GSM_BAND_1900 = 8, |
| 50 | GSM_BAND_450 = 0x10, |
| 51 | GSM_BAND_480 = 0x20, |
| 52 | GSM_BAND_750 = 0x40, |
| 53 | GSM_BAND_810 = 0x80, |
| 54 | }; |
| 55 | |
Harald Welte | cbc8062 | 2010-03-22 08:28:44 +0800 | [diff] [blame] | 56 | const char *gsm_band_name(enum gsm_band band); |
Harald Welte | aebe08c | 2010-03-04 10:39:17 +0100 | [diff] [blame] | 57 | enum gsm_band gsm_band_parse(const char *mhz); |
| 58 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 59 | int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length); |
Dennis Wehrle | 291e613 | 2011-07-24 20:14:13 +0200 | [diff] [blame] | 60 | int gsm_7bit_decode_hdr(char *decoded, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 61 | int gsm_7bit_encode(uint8_t *result, const char *data); |
Holger Hans Peter Freyther | 6bfa744 | 2013-08-08 12:38:52 +0200 | [diff] [blame^] | 62 | int gsm_7bit_encode_oct(uint8_t *result, const char *data, int *octets_written); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 63 | |
Holger Hans Peter Freyther | 94b2f64 | 2013-08-07 11:09:43 +0200 | [diff] [blame] | 64 | /* the three functions below are helper functions and here for the unit test */ |
Harald Welte | ca69388 | 2013-03-13 15:10:55 +0100 | [diff] [blame] | 65 | 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] | 66 | int gsm_septet_encode(uint8_t *result, const char *data); |
| 67 | uint8_t gsm_get_octet_len(const uint8_t sept_len); |
| 68 | |
Harald Welte | b7b6123 | 2011-07-23 10:49:51 +0200 | [diff] [blame] | 69 | 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] | 70 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 71 | int ms_pwr_ctl_lvl(enum gsm_band band, unsigned int dbm); |
| 72 | int ms_pwr_dbm(enum gsm_band band, uint8_t lvl); |
| 73 | |
Bhaskar | 6b30f92 | 2013-05-16 17:35:49 +0530 | [diff] [blame] | 74 | /* According to TS 05.08 Chapter 8.1.4 */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 75 | int rxlev2dbm(uint8_t rxlev); |
| 76 | uint8_t dbm2rxlev(int dbm); |
| 77 | |
Sylvain Munaut | 4f58549 | 2010-06-09 13:38:56 +0200 | [diff] [blame] | 78 | /* According to GSM 04.08 Chapter 10.5.1.6 */ |
| 79 | static inline int ms_cm2_a5n_support(uint8_t *cm2, int n) { |
| 80 | switch (n) { |
| 81 | case 0: return 1; |
| 82 | case 1: return (cm2[0] & (1<<3)) ? 0 : 1; |
| 83 | case 2: return (cm2[2] & (1<<0)) ? 1 : 0; |
| 84 | case 3: return (cm2[2] & (1<<1)) ? 1 : 0; |
| 85 | default: |
| 86 | return 0; |
| 87 | } |
| 88 | } |
| 89 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 90 | /* According to GSM 04.08 Chapter 10.5.2.29 */ |
| 91 | static inline int rach_max_trans_val2raw(int val) { return (val >> 1) & 3; } |
| 92 | static inline int rach_max_trans_raw2val(int raw) { |
| 93 | const int tbl[4] = { 1, 2, 4, 7 }; |
| 94 | return tbl[raw & 3]; |
| 95 | } |
| 96 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 97 | #define ARFCN_PCS 0x8000 |
| 98 | #define ARFCN_UPLINK 0x4000 |
Sylvain Munaut | 2a471ee | 2010-11-13 17:51:37 +0100 | [diff] [blame] | 99 | #define ARFCN_FLAG_MASK 0xf000 /* Reserve the upper 5 bits for flags */ |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 100 | |
| 101 | enum gsm_band gsm_arfcn2band(uint16_t arfcn); |
| 102 | |
| 103 | /* Convert an ARFCN to the frequency in MHz * 10 */ |
| 104 | uint16_t gsm_arfcn2freq10(uint16_t arfcn, int uplink); |
| 105 | |
Sylvain Munaut | 5572031 | 2012-12-11 23:44:41 +0100 | [diff] [blame] | 106 | /* Convert a Frequency in MHz * 10 to ARFCN */ |
| 107 | uint16_t gsm_freq102arfcn(uint16_t freq10, int uplink); |
| 108 | |
Harald Welte | 622b718 | 2010-03-07 17:50:21 +0100 | [diff] [blame] | 109 | /* Convert from frame number to GSM time */ |
| 110 | void gsm_fn2gsmtime(struct gsm_time *time, uint32_t fn); |
| 111 | |
| 112 | /* Convert from GSM time to frame number */ |
| 113 | uint32_t gsm_gsmtime2fn(struct gsm_time *time); |
| 114 | |
Harald Welte | a1c4f76 | 2010-05-01 11:59:42 +0200 | [diff] [blame] | 115 | /* GSM TS 03.03 Chapter 2.6 */ |
Harald Welte | c226317 | 2010-06-01 10:47:07 +0200 | [diff] [blame] | 116 | enum gprs_tlli_type { |
Harald Welte | a1c4f76 | 2010-05-01 11:59:42 +0200 | [diff] [blame] | 117 | TLLI_LOCAL, |
| 118 | TLLI_FOREIGN, |
| 119 | TLLI_RANDOM, |
| 120 | TLLI_AUXILIARY, |
| 121 | TLLI_RESERVED, |
| 122 | }; |
| 123 | |
| 124 | /* TS 03.03 Chapter 2.6 */ |
| 125 | int gprs_tlli_type(uint32_t tlli); |
| 126 | |
Harald Welte | c226317 | 2010-06-01 10:47:07 +0200 | [diff] [blame] | 127 | uint32_t gprs_tmsi2tlli(uint32_t p_tmsi, enum gprs_tlli_type type); |
| 128 | |
Harald Welte | 11c7193 | 2011-05-24 17:15:12 +0200 | [diff] [blame] | 129 | /* Osmocom internal, not part of any gsm spec */ |
| 130 | enum gsm_phys_chan_config { |
| 131 | GSM_PCHAN_NONE, |
| 132 | GSM_PCHAN_CCCH, |
| 133 | GSM_PCHAN_CCCH_SDCCH4, |
| 134 | GSM_PCHAN_TCH_F, |
| 135 | GSM_PCHAN_TCH_H, |
| 136 | GSM_PCHAN_SDCCH8_SACCH8C, |
| 137 | GSM_PCHAN_PDCH, /* GPRS PDCH */ |
| 138 | GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */ |
| 139 | GSM_PCHAN_UNKNOWN, |
| 140 | _GSM_PCHAN_MAX |
| 141 | }; |
| 142 | |
| 143 | /* Osmocom internal, not part of any gsm spec */ |
| 144 | enum gsm_chan_t { |
| 145 | GSM_LCHAN_NONE, |
| 146 | GSM_LCHAN_SDCCH, |
| 147 | GSM_LCHAN_TCH_F, |
| 148 | GSM_LCHAN_TCH_H, |
| 149 | GSM_LCHAN_UNKNOWN, |
| 150 | GSM_LCHAN_CCCH, |
Harald Welte | 81cd54a | 2012-04-19 23:18:43 +0200 | [diff] [blame] | 151 | GSM_LCHAN_PDTCH, |
Harald Welte | 11c7193 | 2011-05-24 17:15:12 +0200 | [diff] [blame] | 152 | _GSM_LCHAN_MAX |
| 153 | }; |
| 154 | |
| 155 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 156 | #endif |