blob: 3960bbe25c1e03c57b23e9b81f7a2a7725016ece [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
Sylvain Munaut30a15382009-12-24 00:27:26 +0100108enum gsm_security_event {
109 GSM_SECURITY_NOAVAIL,
110 GSM_SECURITY_AUTH_FAILED,
111 GSM_SECURITY_SUCCEEDED,
112};
113
Harald Welte8e1e3ee2009-02-01 13:32:45 +0000114struct msgb;
115typedef int gsm_cbfn(unsigned int hooknum,
116 unsigned int event,
117 struct msgb *msg,
118 void *data, void *param);
119
Holger Freytherc6ea9db2008-12-30 19:18:21 +0000120/*
121 * Use the channel. As side effect the lchannel recycle timer
122 * will be started.
123 */
Harald Welteb9c758b2009-07-05 14:02:46 +0200124#define LCHAN_RELEASE_TIMEOUT 20, 0
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100125#define use_subscr_con(con) \
126 do { (con)->use_count++; \
Harald Welted0c19142009-12-24 11:46:44 +0100127 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 +0100128 (con)->lchan->ts->trx->bts->nr, (con)->lchan->ts->trx->nr, (con)->lchan->ts->nr, \
129 (con)->lchan->nr, (con)->use_count); \
130 bsc_schedule_timer(&(con)->release_timer, LCHAN_RELEASE_TIMEOUT); } while(0);
Holger Freytherc6ea9db2008-12-30 19:18:21 +0000131
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100132#define put_subscr_con(con) \
133 do { (con)->use_count--; \
Harald Welted0c19142009-12-24 11:46:44 +0100134 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 +0100135 (con)->lchan->ts->trx->bts->nr, (con)->lchan->ts->trx->nr, (con)->lchan->ts->nr, \
136 (con)->lchan->nr, (con)->use_count); \
Holger Freyther4f584c32009-06-02 02:55:07 +0000137 } while(0);
138
Holger Freytherc6ea9db2008-12-30 19:18:21 +0000139
Sylvain Munaut47193072009-12-27 21:56:14 +0100140/* Real authentication information containing Ki */
141enum gsm_auth_algo {
142 AUTH_ALGO_NONE,
143 AUTH_ALGO_XOR,
144 AUTH_ALGO_COMP128v1,
145};
146
147struct gsm_auth_info {
148 enum gsm_auth_algo auth_algo;
149 unsigned int a3a8_ki_len;
150 u_int8_t a3a8_ki[16];
151};
152
153struct gsm_auth_tuple {
154 int use_count;
155 int key_seq;
156 u_int8_t rand[16];
157 u_int8_t sres[4];
158 u_int8_t kc[8];
159};
Sylvain Munautb48216f2010-06-09 12:45:37 +0200160#define GSM_KEY_SEQ_INVAL 7 /* GSM 04.08 - 10.5.1.2 */
Sylvain Munaut47193072009-12-27 21:56:14 +0100161
162
Harald Welte49f48b82009-02-17 15:29:33 +0000163struct gsm_lchan;
164struct gsm_subscriber;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800165struct gsm_mncc;
Harald Welte805f6442009-07-28 18:25:29 +0200166struct rtp_socket;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800167struct bsc_api;
Harald Welte49f48b82009-02-17 15:29:33 +0000168
Harald Weltebbcc7a52009-02-14 19:45:44 +0000169/* Network Management State */
170struct gsm_nm_state {
171 u_int8_t operational;
172 u_int8_t administrative;
Harald Welte8c1d0e42009-02-15 03:38:12 +0000173 u_int8_t availability;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000174};
Harald Weltebbcc7a52009-02-14 19:45:44 +0000175
Holger Freyther73487a22008-12-31 18:53:57 +0000176/*
177 * LOCATION UPDATING REQUEST state
178 *
179 * Our current operation is:
180 * - Get imei/tmsi
181 * - Accept/Reject according to global policy
182 */
183struct gsm_loc_updating_operation {
184 struct timer_list updating_timer;
Holger Hans Peter Freyther251aa912009-10-27 10:42:28 +0100185 unsigned int waiting_for_imsi : 1;
186 unsigned int waiting_for_imei : 1;
Holger Freyther73487a22008-12-31 18:53:57 +0000187};
188
Sylvain Munaut30a15382009-12-24 00:27:26 +0100189/*
190 * AUTHENTICATION/CIPHERING state
191 */
192struct gsm_security_operation {
193 struct gsm_auth_tuple atuple;
194 gsm_cbfn *cb;
195 void *cb_data;
196};
197
Harald Weltef7c28b02009-12-21 13:30:17 +0100198/* Maximum number of neighbor cells whose average we track */
199#define MAX_NEIGH_MEAS 10
200/* Maximum size of the averaging window for neighbor cells */
201#define MAX_WIN_NEIGH_AVG 10
202
203/* processed neighbor measurements for one cell */
204struct neigh_meas_proc {
205 u_int16_t arfcn;
206 u_int8_t bsic;
207 u_int8_t rxlev[MAX_WIN_NEIGH_AVG];
208 unsigned int rxlev_cnt;
209 u_int8_t last_seen_nr;
210};
211
Harald Welte08d91a52009-08-30 15:37:11 +0900212#define MAX_A5_KEY_LEN (128/8)
Sylvain Munaut30a15382009-12-24 00:27:26 +0100213#define A38_COMP128_KEY_LEN 16
Harald Welte08d91a52009-08-30 15:37:11 +0900214#define RSL_ENC_ALG_A5(x) (x+1)
215
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100216/* is the data link established? who established it? */
217#define LCHAN_SAPI_UNUSED 0
218#define LCHAN_SAPI_MS 1
219#define LCHAN_SAPI_NET 2
220
Harald Welteb8bfc562009-12-21 13:27:11 +0100221/* state of a logical channel */
222enum gsm_lchan_state {
223 LCHAN_S_NONE, /* channel is not active */
Harald Welte (local)3e460312009-12-27 18:12:29 +0100224 LCHAN_S_ACT_REQ, /* channel activatin requested */
Harald Welteb8bfc562009-12-21 13:27:11 +0100225 LCHAN_S_ACTIVE, /* channel is active and operational */
Harald Welte8e93b792009-12-29 10:44:17 +0100226 LCHAN_S_REL_REQ, /* channel release has been requested */
Holger Hans Peter Freyther4b4dd102010-05-31 21:38:24 +0800227 LCHAN_S_REL_ERR, /* channel is in an error state */
Harald Welteb8bfc562009-12-21 13:27:11 +0100228 LCHAN_S_INACTIVE, /* channel is set inactive */
229};
230
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100231/* the per subscriber data for lchan */
232struct gsm_subscriber_connection {
233 /* To whom we are allocated at the moment */
234 struct gsm_subscriber *subscr;
235
236 /* Timer started to release the channel */
237 struct timer_list release_timer;
238
239 /*
240 * Operations that have a state and might be pending
241 */
242 struct gsm_loc_updating_operation *loc_operation;
Sylvain Munaut30a15382009-12-24 00:27:26 +0100243 struct gsm_security_operation *sec_operation;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100244
245 /* use count. how many users use this channel */
246 unsigned int use_count;
247
248 /* Are we part of a special "silent" call */
249 int silent_call;
250
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100251 /* back pointers */
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100252 struct gsm_lchan *lchan;
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100253 struct gsm_bts *bts;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100254};
255
Harald Welte8470bf22008-12-25 23:28:35 +0000256struct gsm_lchan {
257 /* The TS that we're part of */
258 struct gsm_bts_trx_ts *ts;
259 /* The logical subslot number in the TS */
260 u_int8_t nr;
Harald Welte45b407a2009-05-23 15:51:12 +0000261 /* The logical channel type */
Harald Welte8470bf22008-12-25 23:28:35 +0000262 enum gsm_chan_t type;
Harald Welte9943c5b2009-07-29 15:41:29 +0200263 /* RSL channel mode */
264 enum rsl_cmod_spd rsl_cmode;
Harald Welte45b407a2009-05-23 15:51:12 +0000265 /* If TCH, traffic channel mode */
Harald Welte9943c5b2009-07-29 15:41:29 +0200266 enum gsm48_chan_mode tch_mode;
Harald Welteb8bfc562009-12-21 13:27:11 +0100267 /* State */
268 enum gsm_lchan_state state;
Harald Welted4c9bf32009-02-15 16:56:18 +0000269 /* Power levels for MS and BTS */
270 u_int8_t bs_power;
271 u_int8_t ms_power;
Harald Welte08d91a52009-08-30 15:37:11 +0900272 /* Encryption information */
273 struct {
274 u_int8_t alg_id;
275 u_int8_t key_len;
276 u_int8_t key[MAX_A5_KEY_LEN];
277 } encr;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100278
279 struct timer_list T3101;
Holger Hans Peter Freytherf30c0dc2010-05-31 21:33:15 +0800280 struct timer_list T3111;
Holger Hans Peter Freyther4b4dd102010-05-31 21:38:24 +0800281 struct timer_list error_timer;
Holger Hans Peter Freytherea528022009-11-18 22:57:02 +0100282
283 /* AMR bits */
284 struct gsm48_multi_rate_conf mr_conf;
Harald Welted4c9bf32009-02-15 16:56:18 +0000285
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100286 /* Established data link layer services */
287 u_int8_t sapis[8];
288
Harald Welted12b0fd2009-12-15 21:36:05 +0100289 /* cache of last measurement reports on this lchan */
290 struct gsm_meas_rep meas_rep[6];
291 int meas_rep_idx;
292
Harald Weltef7c28b02009-12-21 13:30:17 +0100293 /* table of neighbor cell measurements */
294 struct neigh_meas_proc neigh_meas[MAX_NEIGH_MEAS];
295
Harald Welte2c828992009-12-02 01:56:49 +0530296 struct {
297 u_int32_t bound_ip;
Harald Welte5e3d91b2009-12-19 16:42:06 +0100298 u_int32_t connect_ip;
Harald Welte2c828992009-12-02 01:56:49 +0530299 u_int16_t bound_port;
Harald Welte5e3d91b2009-12-19 16:42:06 +0100300 u_int16_t connect_port;
Harald Welte2c828992009-12-02 01:56:49 +0530301 u_int16_t conn_id;
Sylvain Munautb54dda42009-12-20 22:06:40 +0100302 u_int8_t rtp_payload;
Harald Welte5e3d91b2009-12-19 16:42:06 +0100303 u_int8_t rtp_payload2;
304 u_int8_t speech_mode;
Harald Welte2c828992009-12-02 01:56:49 +0530305 struct rtp_socket *rtp_socket;
306 } abis_ip;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100307
308 struct gsm_subscriber_connection conn;
Harald Welte8470bf22008-12-25 23:28:35 +0000309};
310
Harald Welte85770c72009-01-18 17:47:32 +0000311struct gsm_e1_subslot {
312 /* Number of E1 link */
313 u_int8_t e1_nr;
314 /* Number of E1 TS inside E1 link */
315 u_int8_t e1_ts;
316 /* Sub-slot within the E1 TS, 0xff if full TS */
317 u_int8_t e1_ts_ss;
318};
319
Harald Welte4563eab2010-03-28 14:42:09 +0800320#define TS_F_PDCH_MODE 0x1000
Harald Welte52b1f982008-12-23 20:25:15 +0000321/* One Timeslot in a TRX */
322struct gsm_bts_trx_ts {
323 struct gsm_bts_trx *trx;
324 /* number of this timeslot at the TRX */
325 u_int8_t nr;
326
Harald Welte8470bf22008-12-25 23:28:35 +0000327 enum gsm_phys_chan_config pchan;
328
Harald Welte52b1f982008-12-23 20:25:15 +0000329 unsigned int flags;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000330 struct gsm_nm_state nm_state;
Harald Welte93e9d172009-06-20 19:04:31 +0200331 struct tlv_parsed nm_attr;
Harald Welte39c7deb2009-08-09 21:49:48 +0200332 u_int8_t nm_chan_comb;
Harald Welte8470bf22008-12-25 23:28:35 +0000333
Harald Welte85770c72009-01-18 17:47:32 +0000334 /* To which E1 subslot are we connected */
335 struct gsm_e1_subslot e1_link;
336
Harald Welte8470bf22008-12-25 23:28:35 +0000337 struct gsm_lchan lchan[TS_MAX_LCHAN];
Harald Welte52b1f982008-12-23 20:25:15 +0000338};
339
340/* One TRX in a BTS */
341struct gsm_bts_trx {
Harald Weltee441d9c2009-06-21 16:17:15 +0200342 /* list header in bts->trx_list */
343 struct llist_head list;
344
Harald Welte52b1f982008-12-23 20:25:15 +0000345 struct gsm_bts *bts;
346 /* number of this TRX in the BTS */
347 u_int8_t nr;
Harald Welte197dea92010-05-14 17:59:53 +0200348 /* human readable name / description */
349 char *description;
Harald Welte1fa60c82009-02-09 18:13:26 +0000350 /* how do we talk RSL with this TRX? */
Harald Welte42581822009-08-08 16:12:58 +0200351 struct gsm_e1_subslot rsl_e1_link;
352 u_int8_t rsl_tei;
Harald Welte1fa60c82009-02-09 18:13:26 +0000353 struct e1inp_sign_link *rsl_link;
Harald Welte42581822009-08-08 16:12:58 +0200354
Harald Weltebbcc7a52009-02-14 19:45:44 +0000355 struct gsm_nm_state nm_state;
Harald Welte93e9d172009-06-20 19:04:31 +0200356 struct tlv_parsed nm_attr;
Harald Welte8c1d0e42009-02-15 03:38:12 +0000357 struct {
358 struct gsm_nm_state nm_state;
359 } bb_transc;
Harald Welte52b1f982008-12-23 20:25:15 +0000360
361 u_int16_t arfcn;
Harald Weltefcd24452009-06-20 18:15:19 +0200362 int nominal_power; /* in dBm */
363 unsigned int max_power_red; /* in actual dB */
Harald Welte8b697c72009-06-05 19:18:45 +0000364
365 union {
366 struct {
367 struct {
368 struct gsm_nm_state nm_state;
369 } bbsig;
370 struct {
371 struct gsm_nm_state nm_state;
372 } pa;
373 } bs11;
374 };
Harald Welte85770c72009-01-18 17:47:32 +0000375 struct gsm_bts_trx_ts ts[TRX_NR_TS];
Harald Welte52b1f982008-12-23 20:25:15 +0000376};
377
Harald Welte978cb422009-01-18 17:57:27 +0000378enum gsm_bts_type {
379 GSM_BTS_TYPE_UNKNOWN,
380 GSM_BTS_TYPE_BS11,
Mike Habene2d82272009-10-02 12:19:34 +0100381 GSM_BTS_TYPE_NANOBTS,
Harald Welte978cb422009-01-18 17:57:27 +0000382};
383
Harald Welte39315c42010-01-10 18:01:52 +0100384struct gsm_bts_model {
385 struct llist_head list;
386
387 enum gsm_bts_type type;
388 const char *name;
389
390 struct tlv_definition nm_att_tlvdef;
391};
392
Holger Freytherceb59b72009-02-06 18:54:00 +0000393/**
394 * A pending paging request
395 */
396struct gsm_paging_request {
Harald Welte0932d1e2009-02-16 22:53:52 +0000397 /* list_head for list of all paging requests */
Holger Freytherceb59b72009-02-06 18:54:00 +0000398 struct llist_head entry;
Harald Welte0932d1e2009-02-16 22:53:52 +0000399 /* the subscriber which we're paging. Later gsm_paging_request
400 * should probably become a part of the gsm_subscriber struct? */
Holger Freytherceb59b72009-02-06 18:54:00 +0000401 struct gsm_subscriber *subscr;
Harald Welte0932d1e2009-02-16 22:53:52 +0000402 /* back-pointer to the BTS on which we are paging */
Holger Freytherceb59b72009-02-06 18:54:00 +0000403 struct gsm_bts *bts;
Harald Welte0932d1e2009-02-16 22:53:52 +0000404 /* what kind of channel type do we ask the MS to establish */
Holger Freytherceb59b72009-02-06 18:54:00 +0000405 int chan_type;
Harald Weltecd06bfb2009-02-10 17:33:56 +0000406
407 /* Timer 3113: how long do we try to page? */
408 struct timer_list T3113;
Harald Welte0932d1e2009-02-16 22:53:52 +0000409
410 /* callback to be called in case paging completes */
411 gsm_cbfn *cbfn;
412 void *cbfn_param;
Holger Freytherceb59b72009-02-06 18:54:00 +0000413};
414
415/*
416 * This keeps track of the paging status of one BTS. It
417 * includes a number of pending requests, a back pointer
418 * to the gsm_bts, a timer and some more state.
419 */
420struct gsm_bts_paging_state {
Holger Freytherceb59b72009-02-06 18:54:00 +0000421 /* pending requests */
422 struct llist_head pending_requests;
Holger Freytherceb59b72009-02-06 18:54:00 +0000423 struct gsm_bts *bts;
424
Harald Welte75a1fa82009-02-17 01:39:41 +0000425 struct timer_list work_timer;
426
Holger Freyther392209c2009-02-10 00:06:19 +0000427 /* load */
428 u_int16_t available_slots;
Holger Freytherceb59b72009-02-06 18:54:00 +0000429};
430
Harald Welte8b697c72009-06-05 19:18:45 +0000431struct gsm_envabtse {
432 struct gsm_nm_state nm_state;
433};
434
Harald Welte55dd4432009-10-24 10:19:14 +0200435struct gsm_bts_gprs_nsvc {
436 struct gsm_bts *bts;
Harald Welteab88a622010-03-18 00:01:23 +0800437 /* data read via VTY config file, to configure the BTS
438 * via OML from BSC */
Harald Welte55dd4432009-10-24 10:19:14 +0200439 int id;
Harald Welte97a282b2010-03-14 15:37:43 +0800440 u_int16_t nsvci;
Harald Welteab88a622010-03-18 00:01:23 +0800441 u_int16_t local_port; /* on the BTS */
442 u_int16_t remote_port; /* on the SGSN */
443 u_int32_t remote_ip; /* on the SGSN */
444
Harald Welte55dd4432009-10-24 10:19:14 +0200445 struct gsm_nm_state nm_state;
446};
447
Harald Welte52b1f982008-12-23 20:25:15 +0000448/* One BTS */
449struct gsm_bts {
Harald Weltee441d9c2009-06-21 16:17:15 +0200450 /* list header in net->bts_list */
451 struct llist_head list;
452
Harald Welte52b1f982008-12-23 20:25:15 +0000453 struct gsm_network *network;
454 /* number of ths BTS in network */
455 u_int8_t nr;
Harald Welte197dea92010-05-14 17:59:53 +0200456 /* human readable name / description */
457 char *description;
Holger Hans Peter Freytherc4a49e32009-08-21 14:44:12 +0200458 /* Cell Identity */
459 u_int16_t cell_identity;
Harald Welte52b1f982008-12-23 20:25:15 +0000460 /* location area code of this BTS */
Holger Hans Peter Freyther0b7f4b32009-09-29 14:02:33 +0200461 u_int16_t location_area_code;
Harald Welte02b0e092009-02-28 13:11:07 +0000462 /* Training Sequence Code */
463 u_int8_t tsc;
Harald Welte78f2f502009-05-23 16:56:52 +0000464 /* Base Station Identification Code (BSIC) */
465 u_int8_t bsic;
Harald Welte978cb422009-01-18 17:57:27 +0000466 /* type of BTS */
467 enum gsm_bts_type type;
Harald Welte39315c42010-01-10 18:01:52 +0100468 struct gsm_bts_model *model;
Harald Weltefcd24452009-06-20 18:15:19 +0200469 enum gsm_band band;
Harald Weltefc0d9522009-08-10 13:46:55 +0200470 /* should the channel allocator allocate channels from high TRX to TRX0,
471 * rather than starting from TRX0 and go upwards? */
472 int chan_alloc_reverse;
Harald Welte (local)0e451d02009-08-13 10:14:26 +0200473 /* maximum Tx power that the MS is permitted to use in this cell */
474 int ms_max_power;
Harald Weltefc0d9522009-08-10 13:46:55 +0200475
Harald Welte1fa60c82009-02-09 18:13:26 +0000476 /* how do we talk OML with this TRX? */
Harald Welte42581822009-08-08 16:12:58 +0200477 struct gsm_e1_subslot oml_e1_link;
478 u_int8_t oml_tei;
Harald Welte1fa60c82009-02-09 18:13:26 +0000479 struct e1inp_sign_link *oml_link;
Harald Welte52b1f982008-12-23 20:25:15 +0000480
481 /* Abis network management O&M handle */
482 struct abis_nm_h *nmh;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000483 struct gsm_nm_state nm_state;
Harald Welte93e9d172009-06-20 19:04:31 +0200484 struct tlv_parsed nm_attr;
Harald Welte978cb422009-01-18 17:57:27 +0000485
Harald Welte52b1f982008-12-23 20:25:15 +0000486 /* number of this BTS on given E1 link */
487 u_int8_t bts_nr;
488
Holger Freytherceb59b72009-02-06 18:54:00 +0000489 /* paging state and control */
490 struct gsm_bts_paging_state paging;
491
Harald Welte52b1f982008-12-23 20:25:15 +0000492 /* CCCH is on C0 */
493 struct gsm_bts_trx *c0;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000494
495 struct {
496 struct gsm_nm_state nm_state;
497 } site_mgr;
Harald Welteedb37782009-05-01 14:59:07 +0000498
Harald Weltea43f7892009-12-01 18:04:30 +0530499 /* parameters from which we build SYSTEM INFORMATION */
500 struct {
501 struct gsm48_rach_control rach_control;
502 u_int8_t ncc_permitted;
503 struct gsm48_cell_sel_par cell_sel_par;
504 struct gsm48_cell_options cell_options;
505 struct gsm48_control_channel_descr chan_desc;
Harald Welte6c40def2009-12-14 22:07:14 +0100506 struct bitvec neigh_list;
507 struct bitvec cell_alloc;
508 struct {
509 /* bitmask large enough for all possible ARFCN's */
510 u_int8_t neigh_list[1024/8];
511 u_int8_t cell_alloc[1024/8];
512 } data;
Harald Weltea43f7892009-12-01 18:04:30 +0530513 } si_common;
514
Harald Welteedb37782009-05-01 14:59:07 +0000515 /* ip.accesss Unit ID's have Site/BTS/TRX layout */
Harald Welte7b26bcb2009-05-28 11:39:21 +0000516 union {
517 struct {
518 u_int16_t site_id;
519 u_int16_t bts_id;
Harald Welte88a412a2009-12-16 17:32:37 +0100520 u_int32_t flags;
Harald Welte7b26bcb2009-05-28 11:39:21 +0000521 } ip_access;
522 struct {
523 struct {
524 struct gsm_nm_state nm_state;
525 } cclk;
526 struct {
527 struct gsm_nm_state nm_state;
528 } rack;
Harald Welte8b697c72009-06-05 19:18:45 +0000529 struct gsm_envabtse envabtse[4];
Harald Welte7b26bcb2009-05-28 11:39:21 +0000530 } bs11;
531 };
Harald Welte55dd4432009-10-24 10:19:14 +0200532
533 /* Not entirely sure how ip.access specific this is */
534 struct {
Harald Welte4511d892010-04-18 15:51:20 +0200535 enum bts_gprs_mode mode;
Harald Welte55dd4432009-10-24 10:19:14 +0200536 struct {
537 struct gsm_nm_state nm_state;
Harald Weltea5731cf2010-03-22 11:48:36 +0800538 u_int16_t nsei;
Harald Welte615e9562010-05-11 23:50:21 +0200539 uint8_t timer[7];
Harald Welte55dd4432009-10-24 10:19:14 +0200540 } nse;
541 struct {
542 struct gsm_nm_state nm_state;
Harald Welte97a282b2010-03-14 15:37:43 +0800543 u_int16_t bvci;
Harald Welte615e9562010-05-11 23:50:21 +0200544 uint8_t timer[11];
Harald Welte55dd4432009-10-24 10:19:14 +0200545 } cell;
546 struct gsm_bts_gprs_nsvc nsvc[2];
Harald Welte97a282b2010-03-14 15:37:43 +0800547 u_int8_t rac;
Harald Welte55dd4432009-10-24 10:19:14 +0200548 } gprs;
Holger Hans Peter Freyther95c22902010-04-25 23:08:39 +0800549
550 /* RACH NM values */
551 int rach_b_thresh;
552 int rach_ldavg_slots;
Harald Weltebbcc7a52009-02-14 19:45:44 +0000553
Harald Welte52b1f982008-12-23 20:25:15 +0000554 /* transceivers */
555 int num_trx;
Harald Weltee441d9c2009-06-21 16:17:15 +0200556 struct llist_head trx_list;
Harald Welte52b1f982008-12-23 20:25:15 +0000557};
558
Harald Welte24ff6ee2009-12-22 00:41:05 +0100559/* Some statistics of our network */
560struct gsmnet_stats {
561 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100562 struct counter *total;
563 struct counter *no_channel;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100564 } chreq;
565 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100566 struct counter *attempted;
567 struct counter *no_channel; /* no channel available */
568 struct counter *timeout; /* T3103 timeout */
569 struct counter *completed; /* HO COMPL received */
570 struct counter *failed; /* HO FAIL received */
Harald Welte24ff6ee2009-12-22 00:41:05 +0100571 } handover;
572 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100573 struct counter *attach;
574 struct counter *normal;
575 struct counter *periodic;
576 struct counter *detach;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100577 } loc_upd_type;
578 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100579 struct counter *reject;
580 struct counter *accept;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100581 } loc_upd_resp;
582 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100583 struct counter *attempted;
584 struct counter *detached;
585 struct counter *completed;
586 struct counter *expired;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100587 } paging;
588 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100589 struct counter *submitted; /* MO SMS submissions */
590 struct counter *no_receiver;
591 struct counter *delivered; /* MT SMS deliveries */
592 struct counter *rp_err_mem;
593 struct counter *rp_err_other;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100594 } sms;
595 struct {
Harald Welteffa55a42009-12-22 19:07:32 +0100596 struct counter *dialled; /* total number of dialled calls */
597 struct counter *alerted; /* we alerted the other end */
598 struct counter *connected;/* how many calls were accepted */
Harald Welte24ff6ee2009-12-22 00:41:05 +0100599 } call;
Holger Hans Peter Freyther3ba36d52010-04-17 06:48:29 +0200600 struct {
601 struct counter *rf_fail;
602 struct counter *rll_err;
603 } chan;
Holger Hans Peter Freytherbb110f92010-04-12 10:45:52 +0200604 struct {
605 struct counter *oml_fail;
606 struct counter *rsl_fail;
607 } bts;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100608};
609
Harald Welte (local)69de3972009-08-12 14:42:23 +0200610enum gsm_auth_policy {
611 GSM_AUTH_POLICY_CLOSED, /* only subscribers authorized in DB */
612 GSM_AUTH_POLICY_ACCEPT_ALL, /* accept everyone, even if not authorized in DB */
613 GSM_AUTH_POLICY_TOKEN, /* accept first, send token per sms, then revoke authorization */
614};
615
Harald Welteb84ddfc2009-12-01 17:36:54 +0530616#define GSM_T3101_DEFAULT 10
617#define GSM_T3113_DEFAULT 60
618
Harald Welte52b1f982008-12-23 20:25:15 +0000619struct gsm_network {
620 /* global parameters */
Harald Welteb84e2f42008-12-28 23:42:04 +0000621 u_int16_t country_code;
622 u_int16_t network_code;
Harald Weltec6ba9c22008-12-30 18:01:02 +0000623 char *name_long;
624 char *name_short;
Harald Welte (local)69de3972009-08-12 14:42:23 +0200625 enum gsm_auth_policy auth_policy;
Harald Welte1085c092009-11-18 20:33:19 +0100626 enum gsm48_reject_value reject_cause;
Harald Welte4381cfe2009-08-30 15:47:06 +0900627 int a5_encryption;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +0100628 int neci;
Harald Welte648b6ce2009-12-14 09:00:24 +0100629 int send_mm_info;
Harald Weltebc814502009-12-19 21:41:52 +0100630 struct {
631 int active;
Harald Weltef7c28b02009-12-21 13:30:17 +0100632 /* Window RXLEV averaging */
633 unsigned int win_rxlev_avg; /* number of SACCH frames */
634 /* Window RXQUAL averaging */
635 unsigned int win_rxqual_avg; /* number of SACCH frames */
636 /* Window RXLEV neighbouring cells averaging */
637 unsigned int win_rxlev_avg_neigh; /* number of SACCH frames */
638
639 /* how often should we check for power budget HO */
640 unsigned int pwr_interval; /* SACCH frames */
641 /* how much better does a neighbor cell have to be ? */
642 unsigned int pwr_hysteresis; /* dBm */
643 /* maximum distacne before we try a handover */
644 unsigned int max_distance; /* TA values */
Harald Weltebc814502009-12-19 21:41:52 +0100645 } handover;
Harald Welte52b1f982008-12-23 20:25:15 +0000646
Harald Welte24ff6ee2009-12-22 00:41:05 +0100647 struct gsmnet_stats stats;
648
Harald Welte4bfdfe72009-06-10 23:11:52 +0800649 /* layer 4 */
650 int (*mncc_recv) (struct gsm_network *net, int msg_type, void *arg);
651 struct llist_head upqueue;
652 struct llist_head trans_list;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800653 struct bsc_api *bsc_api;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800654
Harald Welte52b1f982008-12-23 20:25:15 +0000655 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +0200656 struct llist_head bts_list;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +0100657
658 /* timer values */
659 int T3101;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100660 int T3103;
661 int T3105;
662 int T3107;
663 int T3109;
664 int T3111;
665 int T3113;
666 int T3115;
667 int T3117;
668 int T3119;
669 int T3141;
Harald Welteeab84a12009-12-13 10:53:12 +0100670
671 /* Radio Resource Location Protocol (TS 04.31) */
672 struct {
673 enum rrlp_mode mode;
674 } rrlp;
Harald Welte52b1f982008-12-23 20:25:15 +0000675};
676
Harald Welte7e310b12009-03-30 20:56:32 +0000677#define SMS_HDR_SIZE 128
678#define SMS_TEXT_SIZE 256
679struct gsm_sms {
Harald Welted409be72009-11-07 00:06:19 +0900680 unsigned long long id;
Harald Welte7e310b12009-03-30 20:56:32 +0000681 struct gsm_subscriber *sender;
682 struct gsm_subscriber *receiver;
683
Harald Welteb9c758b2009-07-05 14:02:46 +0200684 unsigned long validity_minutes;
Harald Welte76042182009-08-08 16:03:15 +0200685 u_int8_t reply_path_req;
686 u_int8_t status_rep_req;
687 u_int8_t ud_hdr_ind;
688 u_int8_t protocol_id;
689 u_int8_t data_coding_scheme;
690 u_int8_t msg_ref;
691 char dest_addr[20+1]; /* DA LV is 12 bytes max, i.e. 10 bytes
692 * BCD == 20 bytes string */
693 u_int8_t user_data_len;
694 u_int8_t user_data[SMS_TEXT_SIZE];
Harald Weltef3efc592009-07-27 20:11:35 +0200695
Harald Welte7e310b12009-03-30 20:56:32 +0000696 char text[SMS_TEXT_SIZE];
697};
698
Harald Welte3606cc52009-12-05 15:13:22 +0530699
Harald Weltee441d9c2009-06-21 16:17:15 +0200700struct gsm_network *gsm_network_init(u_int16_t country_code, u_int16_t network_code,
Harald Welte4bfdfe72009-06-10 23:11:52 +0800701 int (*mncc_recv)(struct gsm_network *, int, void *));
Harald Weltee441d9c2009-06-21 16:17:15 +0200702struct gsm_bts *gsm_bts_alloc(struct gsm_network *net, enum gsm_bts_type type,
703 u_int8_t tsc, u_int8_t bsic);
704struct gsm_bts_trx *gsm_bts_trx_alloc(struct gsm_bts *bts);
Harald Welte39315c42010-01-10 18:01:52 +0100705int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type);
Harald Weltee441d9c2009-06-21 16:17:15 +0200706
707struct gsm_bts *gsm_bts_num(struct gsm_network *net, int num);
Harald Welte84874c92009-12-14 22:33:02 +0100708
709/* Get reference to a neighbor cell on a given BCCH ARFCN */
Harald Welte0b121032009-12-15 00:21:31 +0100710struct gsm_bts *gsm_bts_neighbor(const struct gsm_bts *bts,
711 u_int16_t arfcn, u_int8_t bsic);
Harald Welte84874c92009-12-14 22:33:02 +0100712
Harald Weltee441d9c2009-06-21 16:17:15 +0200713struct gsm_bts_trx *gsm_bts_trx_num(struct gsm_bts *bts, int num);
Harald Welte8470bf22008-12-25 23:28:35 +0000714
Harald Weltea72c98e2009-01-04 16:10:38 +0000715const char *gsm_pchan_name(enum gsm_phys_chan_config c);
Harald Welte65da9122009-08-07 00:32:22 +0200716enum gsm_phys_chan_config gsm_pchan_parse(const char *name);
Harald Welte (local)ccd88452009-12-27 18:05:25 +0100717const char *gsm_lchant_name(enum gsm_chan_t c);
Harald Weltea72c98e2009-01-04 16:10:38 +0000718const char *gsm_chreq_name(enum gsm_chreq_reason_t c);
Harald Welte (local)d48f4eb2009-12-28 23:14:22 +0100719char *gsm_trx_name(struct gsm_bts_trx *trx);
Harald Welte23a68632009-02-19 17:06:42 +0000720char *gsm_ts_name(struct gsm_bts_trx_ts *ts);
Harald Welte (local)19ef62a2009-12-27 18:16:36 +0100721char *gsm_lchan_name(struct gsm_lchan *lchan);
Harald Welte1887f9d2009-12-29 10:52:38 +0100722const char *gsm_lchans_name(enum gsm_lchan_state s);
Harald Weltea72c98e2009-01-04 16:10:38 +0000723
Harald Weltead384642008-12-26 10:20:07 +0000724enum gsm_e1_event {
725 EVT_E1_NONE,
Harald Welte1fa60c82009-02-09 18:13:26 +0000726 EVT_E1_TEI_UP,
727 EVT_E1_TEI_DN,
Harald Weltead384642008-12-26 10:20:07 +0000728};
729
Harald Weltecd06bfb2009-02-10 17:33:56 +0000730void set_ts_e1link(struct gsm_bts_trx_ts *ts, u_int8_t e1_nr,
731 u_int8_t e1_ts, u_int8_t e1_ts_ss);
Harald Welte1d014a52009-08-08 15:38:29 +0200732enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +0200733const char *btstype2str(enum gsm_bts_type type);
Harald Welte6e670aa2010-01-07 20:44:32 +0100734struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr);
Harald Weltebe991492009-05-23 13:56:40 +0000735struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
736 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +0000737
Andreas Eversberg8226fa72009-06-29 15:19:38 +0200738extern void *tall_bsc_ctx;
Harald Weltef88c8a02009-12-20 13:48:15 +0100739extern int ipacc_rtp_direct;
Harald Welte2cf161b2009-06-20 22:36:41 +0200740
Harald Welte32201c12009-03-10 12:15:10 +0000741static inline int is_ipaccess_bts(struct gsm_bts *bts)
742{
743 switch (bts->type) {
Mike Habene2d82272009-10-02 12:19:34 +0100744 case GSM_BTS_TYPE_NANOBTS:
Harald Welte32201c12009-03-10 12:15:10 +0000745 return 1;
746 default:
747 break;
748 }
749 return 0;
750}
751
Harald Welte5b570672009-08-10 10:08:01 +0200752static inline int is_siemens_bts(struct gsm_bts *bts)
753{
754 switch (bts->type) {
755 case GSM_BTS_TYPE_BS11:
756 return 1;
757 default:
758 break;
759 }
760
761 return 0;
762}
763
Harald Welte (local)69de3972009-08-12 14:42:23 +0200764
765enum gsm_auth_policy gsm_auth_policy_parse(const char *arg);
766const char *gsm_auth_policy_name(enum gsm_auth_policy policy);
767
Harald Welteeab84a12009-12-13 10:53:12 +0100768enum rrlp_mode rrlp_mode_parse(const char *arg);
769const char *rrlp_mode_name(enum rrlp_mode mode);
770
Harald Welte4511d892010-04-18 15:51:20 +0200771enum bts_gprs_mode bts_gprs_mode_parse(const char *arg);
772const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
773
Holger Hans Peter Freyther2d501ea2009-11-11 11:54:24 +0100774void gsm_trx_lock_rf(struct gsm_bts_trx *trx, int locked);
775
Harald Welte97a282b2010-03-14 15:37:43 +0800776int gsm48_ra_id_by_bts(u_int8_t *buf, struct gsm_bts *bts);
777void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +0100778struct gsm_meas_rep *lchan_next_meas_rep(struct gsm_lchan *lchan);
779
Harald Weltefbda4e12010-03-04 11:04:52 +0100780int gsm_bts_model_register(struct gsm_bts_model *model);
781
Harald Welte52b1f982008-12-23 20:25:15 +0000782#endif