blob: 4292bb11bf8d5beba2ff84a206a3ff50883f0c75 [file] [log] [blame]
Harald Welte52b1f982008-12-23 20:25:15 +00001#ifndef _GSM_DATA_H
2#define _GSM_DATA_H
3
4#include <sys/types.h>
5
Harald Welte4bfdfe72009-06-10 23:11:52 +08006enum gsm_phys_chan_config {
7 GSM_PCHAN_NONE,
8 GSM_PCHAN_CCCH,
9 GSM_PCHAN_CCCH_SDCCH4,
10 GSM_PCHAN_TCH_F,
11 GSM_PCHAN_TCH_H,
12 GSM_PCHAN_SDCCH8_SACCH8C,
Harald Weltea1499d02009-10-24 10:25:50 +020013 GSM_PCHAN_PDCH, /* GPRS PDCH */
14 GSM_PCHAN_TCH_F_PDCH, /* TCH/F if used, PDCH otherwise */
Harald Welte4bfdfe72009-06-10 23:11:52 +080015 GSM_PCHAN_UNKNOWN,
16};
17
18enum gsm_chan_t {
19 GSM_LCHAN_NONE,
20 GSM_LCHAN_SDCCH,
21 GSM_LCHAN_TCH_F,
22 GSM_LCHAN_TCH_H,
23 GSM_LCHAN_UNKNOWN,
24};
25
Harald Welteeab84a12009-12-13 10:53:12 +010026/* RRLP mode of operation */
27enum rrlp_mode {
28 RRLP_MODE_NONE,
29 RRLP_MODE_MS_BASED,
30 RRLP_MODE_MS_PREF,
31 RRLP_MODE_ASS_PREF,
32};
Harald Welte4bfdfe72009-06-10 23:11:52 +080033
34/* Channel Request reason */
35enum gsm_chreq_reason_t {
36 GSM_CHREQ_REASON_EMERG,
37 GSM_CHREQ_REASON_PAG,
38 GSM_CHREQ_REASON_CALL,
39 GSM_CHREQ_REASON_LOCATION_UPD,
40 GSM_CHREQ_REASON_OTHER,
41};
42
Harald Weltedfe6c7d2010-02-20 16:24:02 +010043#include <osmocore/timer.h>
Holger Freyther1adb4ff2009-02-04 00:04:52 +000044#include <openbsc/gsm_04_08.h>
Harald Welte9943c5b2009-07-29 15:41:29 +020045#include <openbsc/abis_rsl.h>
Harald Welte4bfdfe72009-06-10 23:11:52 +080046#include <openbsc/mncc.h>
Harald Weltedfe6c7d2010-02-20 16:24:02 +010047#include <osmocore/tlv.h>
48#include <osmocore/bitvec.h>
49#include <osmocore/statistics.h>
50#include <osmocore/gsm_utils.h>
51#include <osmocore/utils.h>
Harald Welte8470bf22008-12-25 23:28:35 +000052
Harald Welte85770c72009-01-18 17:47:32 +000053#define TRX_NR_TS 8
Harald Welte8470bf22008-12-25 23:28:35 +000054#define TS_MAX_LCHAN 8
Harald Welte52b1f982008-12-23 20:25:15 +000055
56#define HARDCODED_ARFCN 123
Harald Welte02b0e092009-02-28 13:11:07 +000057#define HARDCODED_TSC 7
Harald Welte78f2f502009-05-23 16:56:52 +000058#define HARDCODED_BSIC 0x3f /* NCC = 7 / BCC = 7 */
Harald Welte52b1f982008-12-23 20:25:15 +000059
Harald Welte63589be2009-08-06 17:38:10 +020060/* for multi-drop config */
61#define HARDCODED_BTS0_TS 1
62#define HARDCODED_BTS1_TS 6
63#define HARDCODED_BTS2_TS 11
64
Harald Welte8e1e3ee2009-02-01 13:32:45 +000065enum gsm_hooks {
66 GSM_HOOK_NM_SWLOAD,
Harald Welte0932d1e2009-02-16 22:53:52 +000067 GSM_HOOK_RR_PAGING,
Sylvain Munaut30a15382009-12-24 00:27:26 +010068 GSM_HOOK_RR_SECURITY,
Harald Welte0932d1e2009-02-16 22:53:52 +000069};
70
71enum gsm_paging_event {
72 GSM_PAGING_SUCCEEDED,
73 GSM_PAGING_EXPIRED,
Holger Freyther85a7b362009-04-18 13:48:55 +020074 GSM_PAGING_OOM,
Harald Welte8e1e3ee2009-02-01 13:32:45 +000075};
76
Harald Welte4511d892010-04-18 15:51:20 +020077enum bts_gprs_mode {
78 BTS_GPRS_NONE = 0,
79 BTS_GPRS_GPRS = 1,
80 BTS_GPRS_EGPRS = 2,
81};
82
Harald Welte0809d792010-04-30 14:36:25 +020083/* the data structure stored in msgb->cb for openbsc apps */
84struct openbsc_msgb_cb {
Harald Weltefd3fa1d2010-05-02 09:50:42 +020085 unsigned char *bssgph;
86 unsigned char *llch;
Harald Welte44f1c272010-04-30 19:54:29 +020087
Harald Welte11d7c102010-05-02 11:54:55 +020088 /* Cell Identifier */
89 unsigned char *bssgp_cell_id;
90
Harald Weltee6afd602010-05-02 11:19:37 +020091 /* Identifiers of a BTS, equal to 'struct bssgp_bts_ctx' */
Harald Welte44f1c272010-04-30 19:54:29 +020092 u_int16_t nsei;
93 u_int16_t bvci;
94
Harald Weltee6afd602010-05-02 11:19:37 +020095 /* Identifier of a MS (inside BTS), equal to 'struct sgsn_mm_ctx' */
Harald Welte0809d792010-04-30 14:36:25 +020096 u_int32_t tlli;
Harald Welte44f1c272010-04-30 19:54:29 +020097} __attribute__((packed));
Harald Welte0809d792010-04-30 14:36:25 +020098#define OBSC_MSGB_CB(__msgb) ((struct openbsc_msgb_cb *)&((__msgb)->cb[0]))
Harald Welte943c5bc2010-04-30 16:33:12 +020099#define msgb_tlli(__x) OBSC_MSGB_CB(__x)->tlli
Harald Welte44f1c272010-04-30 19:54:29 +0200100#define msgb_nsei(__x) OBSC_MSGB_CB(__x)->nsei
101#define msgb_bvci(__x) OBSC_MSGB_CB(__x)->bvci
Harald Weltefd3fa1d2010-05-02 09:50:42 +0200102#define msgb_gmmh(__x) (__x)->l3h
103#define msgb_bssgph(__x) OBSC_MSGB_CB(__x)->bssgph
Harald Welte721961c2010-05-02 21:29:36 +0200104#define msgb_bssgp_len(__x) ((__x)->tail - (uint8_t *)msgb_bssgph(__x))
Harald Welte11d7c102010-05-02 11:54:55 +0200105#define msgb_bcid(__x) OBSC_MSGB_CB(__x)->bssgp_cell_id
Harald Weltefd3fa1d2010-05-02 09:50:42 +0200106#define msgb_llch(__x) OBSC_MSGB_CB(__x)->llch
Harald Welte0809d792010-04-30 14:36:25 +0200107
Holger Hans Peter Freyther9c595b72010-06-15 11:20:52 +0800108#define OBSC_LINKID_CB(__msgb) (__msgb)->cb[3]
109
Sylvain Munaut30a15382009-12-24 00:27:26 +0100110enum gsm_security_event {
111 GSM_SECURITY_NOAVAIL,
112 GSM_SECURITY_AUTH_FAILED,
113 GSM_SECURITY_SUCCEEDED,
114};
115
Harald Welte8e1e3ee2009-02-01 13:32:45 +0000116struct msgb;
117typedef int gsm_cbfn(unsigned int hooknum,
118 unsigned int event,
119 struct msgb *msg,
120 void *data, void *param);
121
Holger Freytherc6ea9db2008-12-30 19:18:21 +0000122/*
123 * Use the channel. As side effect the lchannel recycle timer
124 * will be started.
125 */
Harald Welteb9c758b2009-07-05 14:02:46 +0200126#define LCHAN_RELEASE_TIMEOUT 20, 0
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100127#define use_subscr_con(con) \
128 do { (con)->use_count++; \
Harald Welted0c19142009-12-24 11:46:44 +0100129 DEBUGP(DREF, "lchan (bts=%d,trx=%d,ts=%d,ch=%d) increases usage to: %d\n", \
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100130 (con)->lchan->ts->trx->bts->nr, (con)->lchan->ts->trx->nr, (con)->lchan->ts->nr, \
131 (con)->lchan->nr, (con)->use_count); \
132 bsc_schedule_timer(&(con)->release_timer, LCHAN_RELEASE_TIMEOUT); } while(0);
Holger Freytherc6ea9db2008-12-30 19:18:21 +0000133
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100134#define put_subscr_con(con) \
135 do { (con)->use_count--; \
Harald Welted0c19142009-12-24 11:46:44 +0100136 DEBUGP(DREF, "lchan (bts=%d,trx=%d,ts=%d,ch=%d) decreases usage to: %d\n", \
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100137 (con)->lchan->ts->trx->bts->nr, (con)->lchan->ts->trx->nr, (con)->lchan->ts->nr, \
138 (con)->lchan->nr, (con)->use_count); \
Holger Freyther4f584c32009-06-02 02:55:07 +0000139 } while(0);
140
Holger Freytherc6ea9db2008-12-30 19:18:21 +0000141
Sylvain Munaut47193072009-12-27 21:56:14 +0100142/* Real authentication information containing Ki */
143enum gsm_auth_algo {
144 AUTH_ALGO_NONE,
145 AUTH_ALGO_XOR,
146 AUTH_ALGO_COMP128v1,
147};
148
149struct gsm_auth_info {
150 enum gsm_auth_algo auth_algo;
151 unsigned int a3a8_ki_len;
152 u_int8_t a3a8_ki[16];
153};
154
155struct gsm_auth_tuple {
156 int use_count;
157 int key_seq;
158 u_int8_t rand[16];
159 u_int8_t sres[4];
160 u_int8_t kc[8];
161};
Sylvain Munautb48216f2010-06-09 12:45:37 +0200162#define GSM_KEY_SEQ_INVAL 7 /* GSM 04.08 - 10.5.1.2 */
Sylvain Munaut47193072009-12-27 21:56:14 +0100163
164
Harald Welte49f48b82009-02-17 15:29:33 +0000165struct gsm_lchan;
166struct gsm_subscriber;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800167struct gsm_mncc;
Harald Welte805f6442009-07-28 18:25:29 +0200168struct rtp_socket;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800169struct bsc_api;
Harald Welte49f48b82009-02-17 15:29:33 +0000170
Harald Weltebbcc7a52009-02-14 19:45:44 +0000171/* Network Management State */
172struct gsm_nm_state {
173 u_int8_t operational;
174 u_int8_t administrative;
Harald Welte8c1d0e42009-02-15 03:38:12 +0000175 u_int8_t availability;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000176};
Harald Weltebbcc7a52009-02-14 19:45:44 +0000177
Holger Freyther73487a22008-12-31 18:53:57 +0000178/*
179 * LOCATION UPDATING REQUEST state
180 *
181 * Our current operation is:
182 * - Get imei/tmsi
183 * - Accept/Reject according to global policy
184 */
185struct gsm_loc_updating_operation {
186 struct timer_list updating_timer;
Holger Hans Peter Freyther251aa912009-10-27 10:42:28 +0100187 unsigned int waiting_for_imsi : 1;
188 unsigned int waiting_for_imei : 1;
Sylvain Munaut2030a2a2010-06-10 13:36:59 +0200189 unsigned int key_seq : 4;
Holger Freyther73487a22008-12-31 18:53:57 +0000190};
191
Sylvain Munaut30a15382009-12-24 00:27:26 +0100192/*
193 * AUTHENTICATION/CIPHERING state
194 */
195struct gsm_security_operation {
196 struct gsm_auth_tuple atuple;
197 gsm_cbfn *cb;
198 void *cb_data;
199};
200
Harald Weltef7c28b02009-12-21 13:30:17 +0100201/* Maximum number of neighbor cells whose average we track */
202#define MAX_NEIGH_MEAS 10
203/* Maximum size of the averaging window for neighbor cells */
204#define MAX_WIN_NEIGH_AVG 10
205
206/* processed neighbor measurements for one cell */
207struct neigh_meas_proc {
208 u_int16_t arfcn;
209 u_int8_t bsic;
210 u_int8_t rxlev[MAX_WIN_NEIGH_AVG];
211 unsigned int rxlev_cnt;
212 u_int8_t last_seen_nr;
213};
214
Harald Welte08d91a52009-08-30 15:37:11 +0900215#define MAX_A5_KEY_LEN (128/8)
Sylvain Munaute824d9c2010-06-11 00:19:42 +0200216#define A38_XOR_MIN_KEY_LEN 12
217#define A38_XOR_MAX_KEY_LEN 16
Sylvain Munaut30a15382009-12-24 00:27:26 +0100218#define A38_COMP128_KEY_LEN 16
Harald Welte08d91a52009-08-30 15:37:11 +0900219#define RSL_ENC_ALG_A5(x) (x+1)
220
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100221/* is the data link established? who established it? */
222#define LCHAN_SAPI_UNUSED 0
223#define LCHAN_SAPI_MS 1
224#define LCHAN_SAPI_NET 2
225
Harald Welteb8bfc562009-12-21 13:27:11 +0100226/* state of a logical channel */
227enum gsm_lchan_state {
228 LCHAN_S_NONE, /* channel is not active */
Harald Welte (local)3e460312009-12-27 18:12:29 +0100229 LCHAN_S_ACT_REQ, /* channel activatin requested */
Harald Welteb8bfc562009-12-21 13:27:11 +0100230 LCHAN_S_ACTIVE, /* channel is active and operational */
Harald Welte8e93b792009-12-29 10:44:17 +0100231 LCHAN_S_REL_REQ, /* channel release has been requested */
Holger Hans Peter Freyther4b4dd102010-05-31 21:38:24 +0800232 LCHAN_S_REL_ERR, /* channel is in an error state */
Harald Welteb8bfc562009-12-21 13:27:11 +0100233 LCHAN_S_INACTIVE, /* channel is set inactive */
234};
235
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100236/* the per subscriber data for lchan */
237struct gsm_subscriber_connection {
238 /* To whom we are allocated at the moment */
239 struct gsm_subscriber *subscr;
240
241 /* Timer started to release the channel */
242 struct timer_list release_timer;
243
244 /*
245 * Operations that have a state and might be pending
246 */
247 struct gsm_loc_updating_operation *loc_operation;
Sylvain Munaut30a15382009-12-24 00:27:26 +0100248 struct gsm_security_operation *sec_operation;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100249
250 /* use count. how many users use this channel */
251 unsigned int use_count;
252
253 /* Are we part of a special "silent" call */
254 int silent_call;
255
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100256 /* back pointers */
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100257 struct gsm_lchan *lchan;
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100258 struct gsm_bts *bts;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100259};
260
Harald Welte8470bf22008-12-25 23:28:35 +0000261struct gsm_lchan {
262 /* The TS that we're part of */
263 struct gsm_bts_trx_ts *ts;
264 /* The logical subslot number in the TS */
265 u_int8_t nr;
Harald Welte45b407a2009-05-23 15:51:12 +0000266 /* The logical channel type */
Harald Welte8470bf22008-12-25 23:28:35 +0000267 enum gsm_chan_t type;
Harald Welte9943c5b2009-07-29 15:41:29 +0200268 /* RSL channel mode */
269 enum rsl_cmod_spd rsl_cmode;
Harald Welte45b407a2009-05-23 15:51:12 +0000270 /* If TCH, traffic channel mode */
Harald Welte9943c5b2009-07-29 15:41:29 +0200271 enum gsm48_chan_mode tch_mode;
Harald Welteb8bfc562009-12-21 13:27:11 +0100272 /* State */
273 enum gsm_lchan_state state;
Harald Welted4c9bf32009-02-15 16:56:18 +0000274 /* Power levels for MS and BTS */
275 u_int8_t bs_power;
276 u_int8_t ms_power;
Harald Welte08d91a52009-08-30 15:37:11 +0900277 /* Encryption information */
278 struct {
279 u_int8_t alg_id;
280 u_int8_t key_len;
281 u_int8_t key[MAX_A5_KEY_LEN];
282 } encr;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100283
284 struct timer_list T3101;
Holger Hans Peter Freytherf30c0dc2010-05-31 21:33:15 +0800285 struct timer_list T3111;
Holger Hans Peter Freyther4b4dd102010-05-31 21:38:24 +0800286 struct timer_list error_timer;
Holger Hans Peter Freytherea528022009-11-18 22:57:02 +0100287
288 /* AMR bits */
289 struct gsm48_multi_rate_conf mr_conf;
Harald Welted4c9bf32009-02-15 16:56:18 +0000290
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100291 /* Established data link layer services */
292 u_int8_t sapis[8];
293
Harald Welted12b0fd2009-12-15 21:36:05 +0100294 /* cache of last measurement reports on this lchan */
295 struct gsm_meas_rep meas_rep[6];
296 int meas_rep_idx;
297
Harald Weltef7c28b02009-12-21 13:30:17 +0100298 /* table of neighbor cell measurements */
299 struct neigh_meas_proc neigh_meas[MAX_NEIGH_MEAS];
300
Harald Welte2c828992009-12-02 01:56:49 +0530301 struct {
302 u_int32_t bound_ip;
Harald Welte5e3d91b2009-12-19 16:42:06 +0100303 u_int32_t connect_ip;
Harald Welte2c828992009-12-02 01:56:49 +0530304 u_int16_t bound_port;
Harald Welte5e3d91b2009-12-19 16:42:06 +0100305 u_int16_t connect_port;
Harald Welte2c828992009-12-02 01:56:49 +0530306 u_int16_t conn_id;
Sylvain Munautb54dda42009-12-20 22:06:40 +0100307 u_int8_t rtp_payload;
Harald Welte5e3d91b2009-12-19 16:42:06 +0100308 u_int8_t rtp_payload2;
309 u_int8_t speech_mode;
Harald Welte2c828992009-12-02 01:56:49 +0530310 struct rtp_socket *rtp_socket;
311 } abis_ip;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100312
313 struct gsm_subscriber_connection conn;
Harald Welte8470bf22008-12-25 23:28:35 +0000314};
315
Harald Welte85770c72009-01-18 17:47:32 +0000316struct gsm_e1_subslot {
317 /* Number of E1 link */
318 u_int8_t e1_nr;
319 /* Number of E1 TS inside E1 link */
320 u_int8_t e1_ts;
321 /* Sub-slot within the E1 TS, 0xff if full TS */
322 u_int8_t e1_ts_ss;
323};
324
Harald Welte4563eab2010-03-28 14:42:09 +0800325#define TS_F_PDCH_MODE 0x1000
Harald Welte52b1f982008-12-23 20:25:15 +0000326/* One Timeslot in a TRX */
327struct gsm_bts_trx_ts {
328 struct gsm_bts_trx *trx;
329 /* number of this timeslot at the TRX */
330 u_int8_t nr;
331
Harald Welte8470bf22008-12-25 23:28:35 +0000332 enum gsm_phys_chan_config pchan;
333
Harald Welte52b1f982008-12-23 20:25:15 +0000334 unsigned int flags;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000335 struct gsm_nm_state nm_state;
Harald Welte93e9d172009-06-20 19:04:31 +0200336 struct tlv_parsed nm_attr;
Harald Welte39c7deb2009-08-09 21:49:48 +0200337 u_int8_t nm_chan_comb;
Harald Welte8470bf22008-12-25 23:28:35 +0000338
Harald Welte85770c72009-01-18 17:47:32 +0000339 /* To which E1 subslot are we connected */
340 struct gsm_e1_subslot e1_link;
341
Harald Welte8470bf22008-12-25 23:28:35 +0000342 struct gsm_lchan lchan[TS_MAX_LCHAN];
Harald Welte52b1f982008-12-23 20:25:15 +0000343};
344
345/* One TRX in a BTS */
346struct gsm_bts_trx {
Harald Weltee441d9c2009-06-21 16:17:15 +0200347 /* list header in bts->trx_list */
348 struct llist_head list;
349
Harald Welte52b1f982008-12-23 20:25:15 +0000350 struct gsm_bts *bts;
351 /* number of this TRX in the BTS */
352 u_int8_t nr;
Harald Welte197dea92010-05-14 17:59:53 +0200353 /* human readable name / description */
354 char *description;
Harald Welte1fa60c82009-02-09 18:13:26 +0000355 /* how do we talk RSL with this TRX? */
Harald Welte42581822009-08-08 16:12:58 +0200356 struct gsm_e1_subslot rsl_e1_link;
357 u_int8_t rsl_tei;
Harald Welte1fa60c82009-02-09 18:13:26 +0000358 struct e1inp_sign_link *rsl_link;
Harald Welte42581822009-08-08 16:12:58 +0200359
Harald Weltebbcc7a52009-02-14 19:45:44 +0000360 struct gsm_nm_state nm_state;
Harald Welte93e9d172009-06-20 19:04:31 +0200361 struct tlv_parsed nm_attr;
Harald Welte8c1d0e42009-02-15 03:38:12 +0000362 struct {
363 struct gsm_nm_state nm_state;
364 } bb_transc;
Harald Welte52b1f982008-12-23 20:25:15 +0000365
366 u_int16_t arfcn;
Harald Weltefcd24452009-06-20 18:15:19 +0200367 int nominal_power; /* in dBm */
368 unsigned int max_power_red; /* in actual dB */
Harald Welte8b697c72009-06-05 19:18:45 +0000369
370 union {
371 struct {
372 struct {
373 struct gsm_nm_state nm_state;
374 } bbsig;
375 struct {
376 struct gsm_nm_state nm_state;
377 } pa;
378 } bs11;
379 };
Harald Welte85770c72009-01-18 17:47:32 +0000380 struct gsm_bts_trx_ts ts[TRX_NR_TS];
Harald Welte52b1f982008-12-23 20:25:15 +0000381};
382
Harald Welte978cb422009-01-18 17:57:27 +0000383enum gsm_bts_type {
384 GSM_BTS_TYPE_UNKNOWN,
385 GSM_BTS_TYPE_BS11,
Mike Habene2d82272009-10-02 12:19:34 +0100386 GSM_BTS_TYPE_NANOBTS,
Harald Welte978cb422009-01-18 17:57:27 +0000387};
388
Harald Welte39315c42010-01-10 18:01:52 +0100389struct gsm_bts_model {
390 struct llist_head list;
391
392 enum gsm_bts_type type;
393 const char *name;
394
395 struct tlv_definition nm_att_tlvdef;
396};
397
Holger Freytherceb59b72009-02-06 18:54:00 +0000398/**
399 * A pending paging request
400 */
401struct gsm_paging_request {
Harald Welte0932d1e2009-02-16 22:53:52 +0000402 /* list_head for list of all paging requests */
Holger Freytherceb59b72009-02-06 18:54:00 +0000403 struct llist_head entry;
Harald Welte0932d1e2009-02-16 22:53:52 +0000404 /* the subscriber which we're paging. Later gsm_paging_request
405 * should probably become a part of the gsm_subscriber struct? */
Holger Freytherceb59b72009-02-06 18:54:00 +0000406 struct gsm_subscriber *subscr;
Harald Welte0932d1e2009-02-16 22:53:52 +0000407 /* back-pointer to the BTS on which we are paging */
Holger Freytherceb59b72009-02-06 18:54:00 +0000408 struct gsm_bts *bts;
Harald Welte0932d1e2009-02-16 22:53:52 +0000409 /* what kind of channel type do we ask the MS to establish */
Holger Freytherceb59b72009-02-06 18:54:00 +0000410 int chan_type;
Harald Weltecd06bfb2009-02-10 17:33:56 +0000411
412 /* Timer 3113: how long do we try to page? */
413 struct timer_list T3113;
Harald Welte0932d1e2009-02-16 22:53:52 +0000414
415 /* callback to be called in case paging completes */
416 gsm_cbfn *cbfn;
417 void *cbfn_param;
Holger Freytherceb59b72009-02-06 18:54:00 +0000418};
419
420/*
421 * This keeps track of the paging status of one BTS. It
422 * includes a number of pending requests, a back pointer
423 * to the gsm_bts, a timer and some more state.
424 */
425struct gsm_bts_paging_state {
Holger Freytherceb59b72009-02-06 18:54:00 +0000426 /* pending requests */
427 struct llist_head pending_requests;
Holger Freytherceb59b72009-02-06 18:54:00 +0000428 struct gsm_bts *bts;
429
Harald Welte75a1fa82009-02-17 01:39:41 +0000430 struct timer_list work_timer;
431
Holger Freyther392209c2009-02-10 00:06:19 +0000432 /* load */
433 u_int16_t available_slots;
Holger Freytherceb59b72009-02-06 18:54:00 +0000434};
435
Harald Welte8b697c72009-06-05 19:18:45 +0000436struct gsm_envabtse {
437 struct gsm_nm_state nm_state;
438};
439
Harald Welte55dd4432009-10-24 10:19:14 +0200440struct gsm_bts_gprs_nsvc {
441 struct gsm_bts *bts;
Harald Welteab88a622010-03-18 00:01:23 +0800442 /* data read via VTY config file, to configure the BTS
443 * via OML from BSC */
Harald Welte55dd4432009-10-24 10:19:14 +0200444 int id;
Harald Welte97a282b2010-03-14 15:37:43 +0800445 u_int16_t nsvci;
Harald Welteab88a622010-03-18 00:01:23 +0800446 u_int16_t local_port; /* on the BTS */
447 u_int16_t remote_port; /* on the SGSN */
448 u_int32_t remote_ip; /* on the SGSN */
449
Harald Welte55dd4432009-10-24 10:19:14 +0200450 struct gsm_nm_state nm_state;
451};
452
Harald Welte52b1f982008-12-23 20:25:15 +0000453/* One BTS */
454struct gsm_bts {
Harald Weltee441d9c2009-06-21 16:17:15 +0200455 /* list header in net->bts_list */
456 struct llist_head list;
457
Harald Welte52b1f982008-12-23 20:25:15 +0000458 struct gsm_network *network;
459 /* number of ths BTS in network */
460 u_int8_t nr;
Harald Welte197dea92010-05-14 17:59:53 +0200461 /* human readable name / description */
462 char *description;
Holger Hans Peter Freytherc4a49e32009-08-21 14:44:12 +0200463 /* Cell Identity */
464 u_int16_t cell_identity;
Harald Welte52b1f982008-12-23 20:25:15 +0000465 /* location area code of this BTS */
Holger Hans Peter Freyther0b7f4b32009-09-29 14:02:33 +0200466 u_int16_t location_area_code;
Harald Welte02b0e092009-02-28 13:11:07 +0000467 /* Training Sequence Code */
468 u_int8_t tsc;
Harald Welte78f2f502009-05-23 16:56:52 +0000469 /* Base Station Identification Code (BSIC) */
470 u_int8_t bsic;
Harald Welte978cb422009-01-18 17:57:27 +0000471 /* type of BTS */
472 enum gsm_bts_type type;
Harald Welte39315c42010-01-10 18:01:52 +0100473 struct gsm_bts_model *model;
Harald Weltefcd24452009-06-20 18:15:19 +0200474 enum gsm_band band;
Harald Weltefc0d9522009-08-10 13:46:55 +0200475 /* should the channel allocator allocate channels from high TRX to TRX0,
476 * rather than starting from TRX0 and go upwards? */
477 int chan_alloc_reverse;
Harald Welte (local)0e451d02009-08-13 10:14:26 +0200478 /* maximum Tx power that the MS is permitted to use in this cell */
479 int ms_max_power;
Harald Weltefc0d9522009-08-10 13:46:55 +0200480
Harald Welte1fa60c82009-02-09 18:13:26 +0000481 /* how do we talk OML with this TRX? */
Harald Welte42581822009-08-08 16:12:58 +0200482 struct gsm_e1_subslot oml_e1_link;
483 u_int8_t oml_tei;
Harald Welte1fa60c82009-02-09 18:13:26 +0000484 struct e1inp_sign_link *oml_link;
Harald Welte52b1f982008-12-23 20:25:15 +0000485
486 /* Abis network management O&M handle */
487 struct abis_nm_h *nmh;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000488 struct gsm_nm_state nm_state;
Harald Welte93e9d172009-06-20 19:04:31 +0200489 struct tlv_parsed nm_attr;
Harald Welte978cb422009-01-18 17:57:27 +0000490
Harald Welte52b1f982008-12-23 20:25:15 +0000491 /* number of this BTS on given E1 link */
492 u_int8_t bts_nr;
493
Holger Freytherceb59b72009-02-06 18:54:00 +0000494 /* paging state and control */
495 struct gsm_bts_paging_state paging;
496
Harald Welte52b1f982008-12-23 20:25:15 +0000497 /* CCCH is on C0 */
498 struct gsm_bts_trx *c0;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000499
500 struct {
501 struct gsm_nm_state nm_state;
502 } site_mgr;
Harald Welteedb37782009-05-01 14:59:07 +0000503
Harald Weltea43f7892009-12-01 18:04:30 +0530504 /* parameters from which we build SYSTEM INFORMATION */
505 struct {
506 struct gsm48_rach_control rach_control;
507 u_int8_t ncc_permitted;
508 struct gsm48_cell_sel_par cell_sel_par;
509 struct gsm48_cell_options cell_options;
510 struct gsm48_control_channel_descr chan_desc;
Harald Welte6c40def2009-12-14 22:07:14 +0100511 struct bitvec neigh_list;
512 struct bitvec cell_alloc;
513 struct {
514 /* bitmask large enough for all possible ARFCN's */
515 u_int8_t neigh_list[1024/8];
516 u_int8_t cell_alloc[1024/8];
517 } data;
Harald Weltea43f7892009-12-01 18:04:30 +0530518 } si_common;
519
Harald Welteedb37782009-05-01 14:59:07 +0000520 /* ip.accesss Unit ID's have Site/BTS/TRX layout */
Harald Welte7b26bcb2009-05-28 11:39:21 +0000521 union {
522 struct {
523 u_int16_t site_id;
524 u_int16_t bts_id;
Harald Welte88a412a2009-12-16 17:32:37 +0100525 u_int32_t flags;
Harald Welte7b26bcb2009-05-28 11:39:21 +0000526 } ip_access;
527 struct {
528 struct {
529 struct gsm_nm_state nm_state;
530 } cclk;
531 struct {
532 struct gsm_nm_state nm_state;
533 } rack;
Harald Welte8b697c72009-06-05 19:18:45 +0000534 struct gsm_envabtse envabtse[4];
Harald Welte7b26bcb2009-05-28 11:39:21 +0000535 } bs11;
536 };
Harald Welte55dd4432009-10-24 10:19:14 +0200537
538 /* Not entirely sure how ip.access specific this is */
539 struct {
Harald Welte4511d892010-04-18 15:51:20 +0200540 enum bts_gprs_mode mode;
Harald Welte55dd4432009-10-24 10:19:14 +0200541 struct {
542 struct gsm_nm_state nm_state;
Harald Weltea5731cf2010-03-22 11:48:36 +0800543 u_int16_t nsei;
Harald Welte615e9562010-05-11 23:50:21 +0200544 uint8_t timer[7];
Harald Welte55dd4432009-10-24 10:19:14 +0200545 } nse;
546 struct {
547 struct gsm_nm_state nm_state;
Harald Welte97a282b2010-03-14 15:37:43 +0800548 u_int16_t bvci;
Harald Welte615e9562010-05-11 23:50:21 +0200549 uint8_t timer[11];
Harald Welte55dd4432009-10-24 10:19:14 +0200550 } cell;
551 struct gsm_bts_gprs_nsvc nsvc[2];
Harald Welte97a282b2010-03-14 15:37:43 +0800552 u_int8_t rac;
Harald Welte55dd4432009-10-24 10:19:14 +0200553 } gprs;
Holger Hans Peter Freyther95c22902010-04-25 23:08:39 +0800554
555 /* RACH NM values */
556 int rach_b_thresh;
557 int rach_ldavg_slots;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000558
Harald Welte52b1f982008-12-23 20:25:15 +0000559 /* transceivers */
560 int num_trx;
Harald Weltee441d9c2009-06-21 16:17:15 +0200561 struct llist_head trx_list;
Harald Welte52b1f982008-12-23 20:25:15 +0000562};
563
Harald Welte24ff6ee2009-12-22 00:41:05 +0100564/* Some statistics of our network */
565struct gsmnet_stats {
566 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100567 struct counter *total;
568 struct counter *no_channel;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100569 } chreq;
570 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100571 struct counter *attempted;
572 struct counter *no_channel; /* no channel available */
573 struct counter *timeout; /* T3103 timeout */
574 struct counter *completed; /* HO COMPL received */
575 struct counter *failed; /* HO FAIL received */
Harald Welte24ff6ee2009-12-22 00:41:05 +0100576 } handover;
577 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100578 struct counter *attach;
579 struct counter *normal;
580 struct counter *periodic;
581 struct counter *detach;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100582 } loc_upd_type;
583 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100584 struct counter *reject;
585 struct counter *accept;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100586 } loc_upd_resp;
587 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100588 struct counter *attempted;
589 struct counter *detached;
590 struct counter *completed;
591 struct counter *expired;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100592 } paging;
593 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100594 struct counter *submitted; /* MO SMS submissions */
595 struct counter *no_receiver;
596 struct counter *delivered; /* MT SMS deliveries */
597 struct counter *rp_err_mem;
598 struct counter *rp_err_other;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100599 } sms;
600 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100601 struct counter *dialled; /* total number of dialled calls */
602 struct counter *alerted; /* we alerted the other end */
603 struct counter *connected;/* how many calls were accepted */
Harald Welte24ff6ee2009-12-22 00:41:05 +0100604 } call;
Holger Hans Peter Freyther3ba36d52010-04-17 06:48:29 +0200605 struct {
606 struct counter *rf_fail;
607 struct counter *rll_err;
608 } chan;
Holger Hans Peter Freytherbb110f92010-04-12 10:45:52 +0200609 struct {
610 struct counter *oml_fail;
611 struct counter *rsl_fail;
612 } bts;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100613};
614
Harald Welte (local)69de3972009-08-12 14:42:23 +0200615enum gsm_auth_policy {
616 GSM_AUTH_POLICY_CLOSED, /* only subscribers authorized in DB */
617 GSM_AUTH_POLICY_ACCEPT_ALL, /* accept everyone, even if not authorized in DB */
618 GSM_AUTH_POLICY_TOKEN, /* accept first, send token per sms, then revoke authorization */
619};
620
Harald Welteb84ddfc2009-12-01 17:36:54 +0530621#define GSM_T3101_DEFAULT 10
622#define GSM_T3113_DEFAULT 60
623
Harald Welte52b1f982008-12-23 20:25:15 +0000624struct gsm_network {
625 /* global parameters */
Harald Welteb84e2f42008-12-28 23:42:04 +0000626 u_int16_t country_code;
627 u_int16_t network_code;
Harald Weltec6ba9c22008-12-30 18:01:02 +0000628 char *name_long;
629 char *name_short;
Harald Welte (local)69de3972009-08-12 14:42:23 +0200630 enum gsm_auth_policy auth_policy;
Harald Welte1085c092009-11-18 20:33:19 +0100631 enum gsm48_reject_value reject_cause;
Harald Welte4381cfe2009-08-30 15:47:06 +0900632 int a5_encryption;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +0100633 int neci;
Harald Welte648b6ce2009-12-14 09:00:24 +0100634 int send_mm_info;
Harald Weltebc814502009-12-19 21:41:52 +0100635 struct {
636 int active;
Harald Weltef7c28b02009-12-21 13:30:17 +0100637 /* Window RXLEV averaging */
638 unsigned int win_rxlev_avg; /* number of SACCH frames */
639 /* Window RXQUAL averaging */
640 unsigned int win_rxqual_avg; /* number of SACCH frames */
641 /* Window RXLEV neighbouring cells averaging */
642 unsigned int win_rxlev_avg_neigh; /* number of SACCH frames */
643
644 /* how often should we check for power budget HO */
645 unsigned int pwr_interval; /* SACCH frames */
646 /* how much better does a neighbor cell have to be ? */
647 unsigned int pwr_hysteresis; /* dBm */
648 /* maximum distacne before we try a handover */
649 unsigned int max_distance; /* TA values */
Harald Weltebc814502009-12-19 21:41:52 +0100650 } handover;
Harald Welte52b1f982008-12-23 20:25:15 +0000651
Harald Welte24ff6ee2009-12-22 00:41:05 +0100652 struct gsmnet_stats stats;
653
Harald Welte4bfdfe72009-06-10 23:11:52 +0800654 /* layer 4 */
655 int (*mncc_recv) (struct gsm_network *net, int msg_type, void *arg);
656 struct llist_head upqueue;
657 struct llist_head trans_list;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800658 struct bsc_api *bsc_api;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800659
Harald Welte52b1f982008-12-23 20:25:15 +0000660 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +0200661 struct llist_head bts_list;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +0100662
663 /* timer values */
664 int T3101;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100665 int T3103;
666 int T3105;
667 int T3107;
668 int T3109;
669 int T3111;
670 int T3113;
671 int T3115;
672 int T3117;
673 int T3119;
674 int T3141;
Harald Welteeab84a12009-12-13 10:53:12 +0100675
676 /* Radio Resource Location Protocol (TS 04.31) */
677 struct {
678 enum rrlp_mode mode;
679 } rrlp;
Harald Welte52b1f982008-12-23 20:25:15 +0000680};
681
Harald Welte7e310b12009-03-30 20:56:32 +0000682#define SMS_HDR_SIZE 128
683#define SMS_TEXT_SIZE 256
684struct gsm_sms {
Harald Welted409be72009-11-07 00:06:19 +0900685 unsigned long long id;
Harald Welte7e310b12009-03-30 20:56:32 +0000686 struct gsm_subscriber *sender;
687 struct gsm_subscriber *receiver;
688
Harald Welteb9c758b2009-07-05 14:02:46 +0200689 unsigned long validity_minutes;
Harald Welte76042182009-08-08 16:03:15 +0200690 u_int8_t reply_path_req;
691 u_int8_t status_rep_req;
692 u_int8_t ud_hdr_ind;
693 u_int8_t protocol_id;
694 u_int8_t data_coding_scheme;
695 u_int8_t msg_ref;
696 char dest_addr[20+1]; /* DA LV is 12 bytes max, i.e. 10 bytes
697 * BCD == 20 bytes string */
698 u_int8_t user_data_len;
699 u_int8_t user_data[SMS_TEXT_SIZE];
Harald Weltef3efc592009-07-27 20:11:35 +0200700
Harald Welte7e310b12009-03-30 20:56:32 +0000701 char text[SMS_TEXT_SIZE];
702};
703
Harald Welte3606cc52009-12-05 15:13:22 +0530704
Harald Weltee441d9c2009-06-21 16:17:15 +0200705struct gsm_network *gsm_network_init(u_int16_t country_code, u_int16_t network_code,
Harald Welte4bfdfe72009-06-10 23:11:52 +0800706 int (*mncc_recv)(struct gsm_network *, int, void *));
Harald Weltee441d9c2009-06-21 16:17:15 +0200707struct gsm_bts *gsm_bts_alloc(struct gsm_network *net, enum gsm_bts_type type,
708 u_int8_t tsc, u_int8_t bsic);
709struct gsm_bts_trx *gsm_bts_trx_alloc(struct gsm_bts *bts);
Harald Welte39315c42010-01-10 18:01:52 +0100710int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type);
Harald Weltee441d9c2009-06-21 16:17:15 +0200711
712struct gsm_bts *gsm_bts_num(struct gsm_network *net, int num);
Harald Welte84874c92009-12-14 22:33:02 +0100713
714/* Get reference to a neighbor cell on a given BCCH ARFCN */
Harald Welte0b121032009-12-15 00:21:31 +0100715struct gsm_bts *gsm_bts_neighbor(const struct gsm_bts *bts,
716 u_int16_t arfcn, u_int8_t bsic);
Harald Welte84874c92009-12-14 22:33:02 +0100717
Harald Weltee441d9c2009-06-21 16:17:15 +0200718struct gsm_bts_trx *gsm_bts_trx_num(struct gsm_bts *bts, int num);
Harald Welte8470bf22008-12-25 23:28:35 +0000719
Harald Weltea72c98e2009-01-04 16:10:38 +0000720const char *gsm_pchan_name(enum gsm_phys_chan_config c);
Harald Welte65da9122009-08-07 00:32:22 +0200721enum gsm_phys_chan_config gsm_pchan_parse(const char *name);
Harald Welte (local)ccd88452009-12-27 18:05:25 +0100722const char *gsm_lchant_name(enum gsm_chan_t c);
Harald Weltea72c98e2009-01-04 16:10:38 +0000723const char *gsm_chreq_name(enum gsm_chreq_reason_t c);
Harald Welte (local)d48f4eb2009-12-28 23:14:22 +0100724char *gsm_trx_name(struct gsm_bts_trx *trx);
Harald Welte23a68632009-02-19 17:06:42 +0000725char *gsm_ts_name(struct gsm_bts_trx_ts *ts);
Harald Welte (local)19ef62a2009-12-27 18:16:36 +0100726char *gsm_lchan_name(struct gsm_lchan *lchan);
Harald Welte1887f9d2009-12-29 10:52:38 +0100727const char *gsm_lchans_name(enum gsm_lchan_state s);
Harald Weltea72c98e2009-01-04 16:10:38 +0000728
Harald Weltead384642008-12-26 10:20:07 +0000729enum gsm_e1_event {
730 EVT_E1_NONE,
Harald Welte1fa60c82009-02-09 18:13:26 +0000731 EVT_E1_TEI_UP,
732 EVT_E1_TEI_DN,
Harald Weltead384642008-12-26 10:20:07 +0000733};
734
Harald Weltecd06bfb2009-02-10 17:33:56 +0000735void set_ts_e1link(struct gsm_bts_trx_ts *ts, u_int8_t e1_nr,
736 u_int8_t e1_ts, u_int8_t e1_ts_ss);
Harald Welte1d014a52009-08-08 15:38:29 +0200737enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +0200738const char *btstype2str(enum gsm_bts_type type);
Harald Welte6e670aa2010-01-07 20:44:32 +0100739struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr);
Harald Weltebe991492009-05-23 13:56:40 +0000740struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
741 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +0000742
Andreas Eversberg8226fa72009-06-29 15:19:38 +0200743extern void *tall_bsc_ctx;
Harald Weltef88c8a02009-12-20 13:48:15 +0100744extern int ipacc_rtp_direct;
Harald Welte2cf161b2009-06-20 22:36:41 +0200745
Harald Welte32201c12009-03-10 12:15:10 +0000746static inline int is_ipaccess_bts(struct gsm_bts *bts)
747{
748 switch (bts->type) {
Mike Habene2d82272009-10-02 12:19:34 +0100749 case GSM_BTS_TYPE_NANOBTS:
Harald Welte32201c12009-03-10 12:15:10 +0000750 return 1;
751 default:
752 break;
753 }
754 return 0;
755}
756
Harald Welte5b570672009-08-10 10:08:01 +0200757static inline int is_siemens_bts(struct gsm_bts *bts)
758{
759 switch (bts->type) {
760 case GSM_BTS_TYPE_BS11:
761 return 1;
762 default:
763 break;
764 }
765
766 return 0;
767}
768
Harald Welte (local)69de3972009-08-12 14:42:23 +0200769
770enum gsm_auth_policy gsm_auth_policy_parse(const char *arg);
771const char *gsm_auth_policy_name(enum gsm_auth_policy policy);
772
Harald Welteeab84a12009-12-13 10:53:12 +0100773enum rrlp_mode rrlp_mode_parse(const char *arg);
774const char *rrlp_mode_name(enum rrlp_mode mode);
775
Harald Welte4511d892010-04-18 15:51:20 +0200776enum bts_gprs_mode bts_gprs_mode_parse(const char *arg);
777const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
778
Holger Hans Peter Freyther2d501ea2009-11-11 11:54:24 +0100779void gsm_trx_lock_rf(struct gsm_bts_trx *trx, int locked);
780
Harald Welte97a282b2010-03-14 15:37:43 +0800781int gsm48_ra_id_by_bts(u_int8_t *buf, struct gsm_bts *bts);
782void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +0100783struct gsm_meas_rep *lchan_next_meas_rep(struct gsm_lchan *lchan);
784
Harald Weltefbda4e12010-03-04 11:04:52 +0100785int gsm_bts_model_register(struct gsm_bts_model *model);
786
Harald Welte52b1f982008-12-23 20:25:15 +0000787#endif