blob: 08a95b336f488c37db77d9ec6acfd2dd94771bbe [file] [log] [blame]
Harald Welte9b455bf2010-03-14 15:45:01 +08001/* GPRS LLC protocol implementation as per 3GPP TS 04.64 */
2
Harald Weltea2665542010-05-02 09:28:11 +02003/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
Harald Welte9b455bf2010-03-14 15:45:01 +08004 *
5 * All Rights Reserved
6 *
7 * This program is free software; you can redistribute it and/or modify
Harald Welte9af6ddf2011-01-01 15:25:50 +01008 * it under the terms of the GNU Affero General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
Harald Welte9b455bf2010-03-14 15:45:01 +080010 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Harald Welte9af6ddf2011-01-01 15:25:50 +010015 * GNU Affero General Public License for more details.
Harald Welte9b455bf2010-03-14 15:45:01 +080016 *
Harald Welte9af6ddf2011-01-01 15:25:50 +010017 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Harald Welte9b455bf2010-03-14 15:45:01 +080019 *
20 */
21
22#include <errno.h>
Harald Welteeaa614c2010-05-02 11:26:34 +020023#include <stdint.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080024
Pablo Neira Ayuso136f4532011-03-22 16:47:59 +010025#include <osmocom/core/msgb.h>
26#include <osmocom/core/linuxlist.h>
27#include <osmocom/core/timer.h>
28#include <osmocom/core/talloc.h>
Harald Welteea34a4e2012-06-16 14:59:56 +080029#include <osmocom/gprs/gprs_bssgp.h>
Harald Weltea2665542010-05-02 09:28:11 +020030
31#include <openbsc/gsm_data.h>
32#include <openbsc/debug.h>
Harald Welte807a5d82010-06-01 11:53:01 +020033#include <openbsc/gprs_sgsn.h>
34#include <openbsc/gprs_gmm.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080035#include <openbsc/gprs_llc.h>
36#include <openbsc/crc24.h>
Holger Hans Peter Freyther3dccda52011-10-14 23:42:13 +020037#include <openbsc/sgsn.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080038
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +020039static struct gprs_llc_llme *llme_alloc(uint32_t tlli);
40
Holger Hans Peter Freyther7e0fec12013-07-29 10:09:12 +020041/* If the TLLI is foreign, return its local version */
42static inline uint32_t tlli_foreign2local(uint32_t tlli)
43{
44 uint32_t new_tlli;
45
46 if (gprs_tlli_type(tlli) == TLLI_FOREIGN) {
47 new_tlli = tlli | 0x40000000;
48 DEBUGP(DLLC, "TLLI 0x%08x is foreign, converting to "
49 "local TLLI 0x%08x\n", tlli, new_tlli);
50 } else
51 new_tlli = tlli;
52
53 return new_tlli;
54}
55
Harald Weltefaa70ff2012-06-17 09:31:16 +080056/* Entry function from upper level (LLC), asking us to transmit a BSSGP PDU
57 * to a remote MS (identified by TLLI) at a BTS identified by its BVCI and NSEI */
58static int _bssgp_tx_dl_ud(struct msgb *msg, struct sgsn_mm_ctx *mmctx)
59{
60 struct bssgp_dl_ud_par dup;
61 const uint8_t qos_profile_default[3] = { 0x00, 0x00, 0x20 };
62
Harald Welte8c004962012-07-04 21:53:12 +020063 memset(&dup, 0, sizeof(dup));
64 /* before we have received some identity from the MS, we might
65 * not yet have a MMC context (e.g. XID negotiation of primarly
66 * LLC connection fro GMM sapi). */
67 if (mmctx) {
68 dup.imsi = mmctx->imsi;
69 dup.drx_parms = mmctx->drx_parms;
70 dup.ms_ra_cap.len = mmctx->ms_radio_access_capa.len;
71 dup.ms_ra_cap.v = mmctx->ms_radio_access_capa.buf;
Holger Hans Peter Freyther7e0fec12013-07-29 10:09:12 +020072
73 /* make sure we only send it to the right llme */
74 OSMO_ASSERT(msgb_tlli(msg) == mmctx->llme->tlli
75 || msgb_tlli(msg) == mmctx->llme->old_tlli
76 || tlli_foreign2local(msgb_tlli(msg)) == mmctx->llme->tlli
77 || tlli_foreign2local(msgb_tlli(msg)) == mmctx->llme->old_tlli);
Harald Welte8c004962012-07-04 21:53:12 +020078 }
Harald Weltefaa70ff2012-06-17 09:31:16 +080079 memcpy(&dup.qos_profile, qos_profile_default,
80 sizeof(qos_profile_default));
81
Harald Weltece95b272012-06-17 13:04:02 +080082 return bssgp_tx_dl_ud(msg, 1000, &dup);
Harald Weltefaa70ff2012-06-17 09:31:16 +080083}
84
85
Harald Welte1d9d9442010-06-03 07:11:04 +020086/* Section 8.9.9 LLC layer parameter default values */
Daniel Willmann46d13262014-06-27 17:05:48 +020087static const struct gprs_llc_params llc_default_params[NUM_SAPIS] = {
Harald Welte1d9d9442010-06-03 07:11:04 +020088 [1] = {
89 .t200_201 = 5,
90 .n200 = 3,
91 .n201_u = 400,
92 },
93 [2] = {
94 .t200_201 = 5,
95 .n200 = 3,
96 .n201_u = 270,
97 },
98 [3] = {
99 .iov_i_exp = 27,
100 .t200_201 = 5,
101 .n200 = 3,
102 .n201_u = 500,
103 .n201_i = 1503,
104 .mD = 1520,
105 .mU = 1520,
106 .kD = 16,
107 .kU = 16,
108 },
109 [5] = {
110 .iov_i_exp = 27,
111 .t200_201 = 10,
112 .n200 = 3,
113 .n201_u = 500,
114 .n201_i = 1503,
115 .mD = 760,
116 .mU = 760,
117 .kD = 8,
118 .kU = 8,
119 },
120 [7] = {
121 .t200_201 = 20,
122 .n200 = 3,
123 .n201_u = 270,
124 },
125 [8] = {
126 .t200_201 = 20,
127 .n200 = 3,
128 .n201_u = 270,
129 },
130 [9] = {
131 .iov_i_exp = 27,
132 .t200_201 = 20,
133 .n200 = 3,
134 .n201_u = 500,
135 .n201_i = 1503,
136 .mD = 380,
137 .mU = 380,
138 .kD = 4,
139 .kU = 4,
140 },
141 [11] = {
142 .iov_i_exp = 27,
143 .t200_201 = 40,
144 .n200 = 3,
145 .n201_u = 500,
146 .n201_i = 1503,
147 .mD = 190,
148 .mU = 190,
149 .kD = 2,
150 .kU = 2,
151 },
152};
153
Harald Welte807a5d82010-06-01 11:53:01 +0200154LLIST_HEAD(gprs_llc_llmes);
Harald Weltea2665542010-05-02 09:28:11 +0200155void *llc_tall_ctx;
156
157/* lookup LLC Entity based on DLCI (TLLI+SAPI tuple) */
Holger Hans Peter Freyther012a7ee2013-07-29 09:06:46 +0200158static struct gprs_llc_lle *lle_by_tlli_sapi(const uint32_t tlli, uint8_t sapi)
Harald Weltea2665542010-05-02 09:28:11 +0200159{
Harald Welte807a5d82010-06-01 11:53:01 +0200160 struct gprs_llc_llme *llme;
Harald Weltea2665542010-05-02 09:28:11 +0200161
Harald Welte807a5d82010-06-01 11:53:01 +0200162 llist_for_each_entry(llme, &gprs_llc_llmes, list) {
163 if (llme->tlli == tlli || llme->old_tlli == tlli)
164 return &llme->lle[sapi];
Harald Weltea2665542010-05-02 09:28:11 +0200165 }
166 return NULL;
167}
168
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200169/* lookup LLC Entity for RX based on DLCI (TLLI+SAPI tuple) */
170static struct gprs_llc_lle *lle_for_rx_by_tlli_sapi(const uint32_t tlli,
171 uint8_t sapi, enum gprs_llc_cmd cmd)
172{
173 struct gprs_llc_lle *lle;
174
175 /* We already know about this TLLI */
176 lle = lle_by_tlli_sapi(tlli, sapi);
177 if (lle)
178 return lle;
179
180 /* Maybe it is a routing area update but we already know this sapi? */
181 if (gprs_tlli_type(tlli) == TLLI_FOREIGN) {
182 lle = lle_by_tlli_sapi(tlli_foreign2local(tlli), sapi);
183 if (lle) {
184 LOGP(DLLC, LOGL_NOTICE,
185 "LLC RX: Found a local entry for TLLI 0x%08x\n",
186 tlli);
187 return lle;
188 }
189 }
190
191 /* 7.2.1.1 LLC belonging to unassigned TLLI+SAPI shall be discarded,
192 * except UID and XID frames with SAPI=1 */
193 if (sapi == GPRS_SAPI_GMM &&
194 (cmd == GPRS_LLC_XID || cmd == GPRS_LLC_UI)) {
195 struct gprs_llc_llme *llme;
196 /* FIXME: don't use the TLLI but the 0xFFFF unassigned? */
197 llme = llme_alloc(tlli);
198 LOGP(DLLC, LOGL_DEBUG, "LLC RX: unknown TLLI 0x%08x, "
199 "creating LLME on the fly\n", tlli);
200 lle = &llme->lle[sapi];
201 return lle;
202 }
203
204 LOGP(DLLC, LOGL_NOTICE,
205 "unknown TLLI(0x%08x)/SAPI(%d): Silently dropping\n",
206 tlli, sapi);
207 return NULL;
208}
209
Harald Welte1d9d9442010-06-03 07:11:04 +0200210static void lle_init(struct gprs_llc_llme *llme, uint8_t sapi)
Harald Weltea2665542010-05-02 09:28:11 +0200211{
Harald Welte807a5d82010-06-01 11:53:01 +0200212 struct gprs_llc_lle *lle = &llme->lle[sapi];
Harald Weltea2665542010-05-02 09:28:11 +0200213
Harald Welte807a5d82010-06-01 11:53:01 +0200214 lle->llme = llme;
215 lle->sapi = sapi;
216 lle->state = GPRS_LLES_UNASSIGNED;
217
Harald Welte1d9d9442010-06-03 07:11:04 +0200218 /* Initialize according to parameters */
219 memcpy(&lle->params, &llc_default_params[sapi], sizeof(lle->params));
Harald Welte807a5d82010-06-01 11:53:01 +0200220}
221
222static struct gprs_llc_llme *llme_alloc(uint32_t tlli)
223{
224 struct gprs_llc_llme *llme;
225 uint32_t i;
226
227 llme = talloc_zero(llc_tall_ctx, struct gprs_llc_llme);
228 if (!llme)
Harald Weltea2665542010-05-02 09:28:11 +0200229 return NULL;
230
Harald Welte807a5d82010-06-01 11:53:01 +0200231 llme->tlli = tlli;
Harald Welte875840c2010-07-01 11:54:31 +0200232 llme->old_tlli = 0xffffffff;
Harald Welte807a5d82010-06-01 11:53:01 +0200233 llme->state = GPRS_LLMS_UNASSIGNED;
Harald Weltea2665542010-05-02 09:28:11 +0200234
Harald Welte807a5d82010-06-01 11:53:01 +0200235 for (i = 0; i < ARRAY_SIZE(llme->lle); i++)
236 lle_init(llme, i);
237
238 llist_add(&llme->list, &gprs_llc_llmes);
239
240 return llme;
Harald Weltea2665542010-05-02 09:28:11 +0200241}
242
Harald Weltef7fef482010-06-28 22:18:26 +0200243static void llme_free(struct gprs_llc_llme *llme)
244{
245 llist_del(&llme->list);
246 talloc_free(llme);
247}
248
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200249#if 0
250/* FIXME: Unused code... */
Harald Welte9b455bf2010-03-14 15:45:01 +0800251static void t200_expired(void *data)
252{
253 struct gprs_llc_lle *lle = data;
254
255 /* 8.5.1.3: Expiry of T200 */
256
Harald Welte1d9d9442010-06-03 07:11:04 +0200257 if (lle->retrans_ctr >= lle->params.n200) {
Harald Welte9b455bf2010-03-14 15:45:01 +0800258 /* FIXME: LLGM-STATUS-IND, LL-RELEASE-IND/CNF */
Harald Welte807a5d82010-06-01 11:53:01 +0200259 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800260 }
261
262 switch (lle->state) {
Harald Welte807a5d82010-06-01 11:53:01 +0200263 case GPRS_LLES_LOCAL_EST:
Harald Welte1ae09c72010-05-13 19:22:55 +0200264 /* FIXME: retransmit SABM */
265 /* FIXME: re-start T200 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800266 lle->retrans_ctr++;
267 break;
Harald Welte807a5d82010-06-01 11:53:01 +0200268 case GPRS_LLES_LOCAL_REL:
Harald Welte1ae09c72010-05-13 19:22:55 +0200269 /* FIXME: retransmit DISC */
270 /* FIXME: re-start T200 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800271 lle->retrans_ctr++;
272 break;
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200273 default:
274 LOGP(DLLC, LOGL_ERROR, "LLC unhandled state: %d\n", lle->state);
275 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800276 }
277
278}
279
280static void t201_expired(void *data)
281{
282 struct gprs_llc_lle *lle = data;
283
Harald Welte1d9d9442010-06-03 07:11:04 +0200284 if (lle->retrans_ctr < lle->params.n200) {
Harald Welte1ae09c72010-05-13 19:22:55 +0200285 /* FIXME: transmit apropriate supervisory frame (8.6.4.1) */
286 /* FIXME: set timer T201 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800287 lle->retrans_ctr++;
288 }
289}
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200290#endif
Harald Welte9b455bf2010-03-14 15:45:01 +0800291
Harald Welte10997d02010-05-03 12:28:12 +0200292int gprs_llc_tx_u(struct msgb *msg, uint8_t sapi, int command,
293 enum gprs_llc_u_cmd u_cmd, int pf_bit)
294{
295 uint8_t *fcs, *llch;
296 uint8_t addr, ctrl;
297 uint32_t fcs_calc;
298
299 /* Identifiers from UP: (TLLI, SAPI) + (BVCI, NSEI) */
300
301 /* Address Field */
302 addr = sapi & 0xf;
303 if (command)
304 addr |= 0x40;
305
306 /* 6.3 Figure 8 */
307 ctrl = 0xe0 | u_cmd;
308 if (pf_bit)
309 ctrl |= 0x10;
310
311 /* prepend LLC UI header */
312 llch = msgb_push(msg, 2);
313 llch[0] = addr;
314 llch[1] = ctrl;
315
316 /* append FCS to end of frame */
317 fcs = msgb_put(msg, 3);
318 fcs_calc = gprs_llc_fcs(llch, fcs - llch);
319 fcs[0] = fcs_calc & 0xff;
320 fcs[1] = (fcs_calc >> 8) & 0xff;
321 fcs[2] = (fcs_calc >> 16) & 0xff;
322
323 /* Identifiers passed down: (BVCI, NSEI) */
324
Harald Welte1ae09c72010-05-13 19:22:55 +0200325 /* Send BSSGP-DL-UNITDATA.req */
Harald Welteb1fd9022012-06-17 12:16:31 +0800326 return _bssgp_tx_dl_ud(msg, NULL);
Harald Welte10997d02010-05-03 12:28:12 +0200327}
328
329/* Send XID response to LLE */
Harald Welte0c1a3032011-10-16 18:49:05 +0200330static int gprs_llc_tx_xid(struct gprs_llc_lle *lle, struct msgb *msg,
331 int command)
Harald Welte10997d02010-05-03 12:28:12 +0200332{
333 /* copy identifiers from LLE to ensure lower layers can route */
Harald Welte807a5d82010-06-01 11:53:01 +0200334 msgb_tlli(msg) = lle->llme->tlli;
335 msgb_bvci(msg) = lle->llme->bvci;
336 msgb_nsei(msg) = lle->llme->nsei;
Harald Welte10997d02010-05-03 12:28:12 +0200337
Harald Welte0c1a3032011-10-16 18:49:05 +0200338 return gprs_llc_tx_u(msg, lle->sapi, command, GPRS_LLC_U_XID, 1);
Harald Welte10997d02010-05-03 12:28:12 +0200339}
340
Harald Welte9b455bf2010-03-14 15:45:01 +0800341/* Transmit a UI frame over the given SAPI */
Harald Welte56a01452010-05-31 22:12:30 +0200342int gprs_llc_tx_ui(struct msgb *msg, uint8_t sapi, int command,
343 void *mmctx)
Harald Welte9b455bf2010-03-14 15:45:01 +0800344{
Harald Weltee6afd602010-05-02 11:19:37 +0200345 struct gprs_llc_lle *lle;
Harald Welteeaa614c2010-05-02 11:26:34 +0200346 uint8_t *fcs, *llch;
347 uint8_t addr, ctrl[2];
348 uint32_t fcs_calc;
349 uint16_t nu = 0;
Harald Welted07b4f92010-06-30 23:07:59 +0200350 uint32_t oc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800351
Harald Weltee6afd602010-05-02 11:19:37 +0200352 /* Identifiers from UP: (TLLI, SAPI) + (BVCI, NSEI) */
353
354 /* look-up or create the LL Entity for this (TLLI, SAPI) tuple */
355 lle = lle_by_tlli_sapi(msgb_tlli(msg), sapi);
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200356 if (!lle)
357 lle = lle_by_tlli_sapi(tlli_foreign2local(msgb_tlli(msg)), sapi);
Harald Welte807a5d82010-06-01 11:53:01 +0200358 if (!lle) {
359 struct gprs_llc_llme *llme;
Harald Weltef0901f02010-12-26 10:39:26 +0100360 LOGP(DLLC, LOGL_ERROR, "LLC TX: unknown TLLI 0x%08x, "
361 "creating LLME on the fly\n", msgb_tlli(msg));
Harald Welte807a5d82010-06-01 11:53:01 +0200362 llme = llme_alloc(msgb_tlli(msg));
363 lle = &llme->lle[sapi];
364 }
Harald Welte1d9d9442010-06-03 07:11:04 +0200365
366 if (msg->len > lle->params.n201_u) {
367 LOGP(DLLC, LOGL_ERROR, "Cannot Tx %u bytes (N201-U=%u)\n",
368 msg->len, lle->params.n201_u);
369 return -EFBIG;
370 }
371
Harald Weltee6afd602010-05-02 11:19:37 +0200372 /* Update LLE's (BVCI, NSEI) tuple */
Harald Welte807a5d82010-06-01 11:53:01 +0200373 lle->llme->bvci = msgb_bvci(msg);
374 lle->llme->nsei = msgb_nsei(msg);
Harald Weltee6afd602010-05-02 11:19:37 +0200375
Harald Welted07b4f92010-06-30 23:07:59 +0200376 /* Obtain current values for N(u) and OC */
Harald Welte6bdee6a2010-05-30 21:51:58 +0200377 nu = lle->vu_send;
Harald Welted07b4f92010-06-30 23:07:59 +0200378 oc = lle->oc_ui_send;
379 /* Increment V(U) */
Harald Welte6bdee6a2010-05-30 21:51:58 +0200380 lle->vu_send = (lle->vu_send + 1) % 512;
Harald Welted07b4f92010-06-30 23:07:59 +0200381 /* Increment Overflow Counter, if needed */
382 if ((lle->vu_send + 1) / 512)
383 lle->oc_ui_send += 512;
Harald Welte6bdee6a2010-05-30 21:51:58 +0200384
Harald Welte9b455bf2010-03-14 15:45:01 +0800385 /* Address Field */
386 addr = sapi & 0xf;
387 if (command)
388 addr |= 0x40;
389
390 /* Control Field */
391 ctrl[0] = 0xc0;
392 ctrl[0] |= nu >> 6;
393 ctrl[1] = (nu << 2) & 0xfc;
394 ctrl[1] |= 0x01; /* Protected Mode */
395
396 /* prepend LLC UI header */
397 llch = msgb_push(msg, 3);
398 llch[0] = addr;
399 llch[1] = ctrl[0];
400 llch[2] = ctrl[1];
401
402 /* append FCS to end of frame */
403 fcs = msgb_put(msg, 3);
404 fcs_calc = gprs_llc_fcs(llch, fcs - llch);
405 fcs[0] = fcs_calc & 0xff;
406 fcs[1] = (fcs_calc >> 8) & 0xff;
407 fcs[2] = (fcs_calc >> 16) & 0xff;
408
Harald Welted07b4f92010-06-30 23:07:59 +0200409 /* encrypt information field + FCS, if needed! */
410 if (lle->llme->algo != GPRS_ALGO_GEA0) {
411 uint32_t iov_ui = 0; /* FIXME: randomly select for TLLI */
412 uint16_t crypt_len = (fcs + 3) - (llch + 3);
413 uint8_t cipher_out[GSM0464_CIPH_MAX_BLOCK];
414 uint32_t iv;
415 int rc, i;
416 uint64_t kc = *(uint64_t *)&lle->llme->kc;
417
418 /* Compute the 'Input' Paraemeter */
419 iv = gprs_cipher_gen_input_ui(iov_ui, sapi, nu, oc);
420
421 /* Compute the keystream that we need to XOR with the data */
422 rc = gprs_cipher_run(cipher_out, crypt_len, lle->llme->algo,
423 kc, iv, GPRS_CIPH_SGSN2MS);
424 if (rc < 0) {
425 LOGP(DLLC, LOGL_ERROR, "Error crypting UI frame: %d\n", rc);
426 return rc;
427 }
428
429 /* XOR the cipher output with the information field + FCS */
430 for (i = 0; i < crypt_len; i++)
431 *(llch + 3 + i) ^= cipher_out[i];
432
433 /* Mark frame as encrypted */
434 ctrl[1] |= 0x02;
435 }
436
Harald Weltee6afd602010-05-02 11:19:37 +0200437 /* Identifiers passed down: (BVCI, NSEI) */
438
Harald Welte1ae09c72010-05-13 19:22:55 +0200439 /* Send BSSGP-DL-UNITDATA.req */
Harald Weltefaa70ff2012-06-17 09:31:16 +0800440 return _bssgp_tx_dl_ud(msg, mmctx);
Harald Welte9b455bf2010-03-14 15:45:01 +0800441}
442
Harald Welte0c1a3032011-10-16 18:49:05 +0200443/* According to 6.4.1.6 / Figure 11 */
444static int msgb_put_xid_par(struct msgb *msg, uint8_t type, uint8_t length, uint8_t *data)
445{
446 uint8_t header_len = 1;
447 uint8_t *cur;
448
449 /* type is a 5-bit field... */
450 if (type > 0x1f)
451 return -EINVAL;
452
453 if (length > 3)
454 header_len = 2;
455
456 cur = msgb_put(msg, length + header_len);
457
458 /* build the header without or with XL bit */
459 if (length <= 3) {
460 *cur++ = (type << 2) | (length & 3);
461 } else {
462 *cur++ = 0x80 | (type << 2) | (length >> 6);
463 *cur++ = (length << 2);
464 }
465
466 /* copy over the payload of the parameter*/
467 memcpy(cur, data, length);
468
469 return length + header_len;
470}
471
472static void rx_llc_xid(struct gprs_llc_lle *lle,
473 struct gprs_llc_hdr_parsed *gph)
474{
475 /* FIXME: 8.5.3.3: check if XID is invalid */
476 if (gph->is_cmd) {
477 /* FIXME: implement XID negotiation using SNDCP */
478 struct msgb *resp;
479 uint8_t *xid;
480 resp = msgb_alloc_headroom(4096, 1024, "LLC_XID");
481 xid = msgb_put(resp, gph->data_len);
482 memcpy(xid, gph->data, gph->data_len);
483 gprs_llc_tx_xid(lle, resp, 0);
484 } else {
485 /* FIXME: if we had sent a XID reset, send
486 * LLGMM-RESET.conf to GMM */
487 /* FIXME: implement XID negotiation using SNDCP */
488 }
489}
490
Harald Welte9b455bf2010-03-14 15:45:01 +0800491static int gprs_llc_hdr_rx(struct gprs_llc_hdr_parsed *gph,
492 struct gprs_llc_lle *lle)
493{
494 switch (gph->cmd) {
495 case GPRS_LLC_SABM: /* Section 6.4.1.1 */
496 lle->v_sent = lle->v_ack = lle->v_recv = 0;
Harald Welte807a5d82010-06-01 11:53:01 +0200497 if (lle->state == GPRS_LLES_ASSIGNED_ADM) {
Harald Welte9b455bf2010-03-14 15:45:01 +0800498 /* start re-establishment (8.7.1) */
499 }
Harald Welte807a5d82010-06-01 11:53:01 +0200500 lle->state = GPRS_LLES_REMOTE_EST;
Harald Welte9b455bf2010-03-14 15:45:01 +0800501 /* FIXME: Send UA */
Harald Welte807a5d82010-06-01 11:53:01 +0200502 lle->state = GPRS_LLES_ABM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800503 /* FIXME: process data */
504 break;
505 case GPRS_LLC_DISC: /* Section 6.4.1.2 */
506 /* FIXME: Send UA */
507 /* terminate ABM */
Harald Welte807a5d82010-06-01 11:53:01 +0200508 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800509 break;
510 case GPRS_LLC_UA: /* Section 6.4.1.3 */
Harald Welte807a5d82010-06-01 11:53:01 +0200511 if (lle->state == GPRS_LLES_LOCAL_EST)
512 lle->state = GPRS_LLES_ABM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800513 break;
514 case GPRS_LLC_DM: /* Section 6.4.1.4: ABM cannot be performed */
Harald Welte807a5d82010-06-01 11:53:01 +0200515 if (lle->state == GPRS_LLES_LOCAL_EST)
516 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800517 break;
518 case GPRS_LLC_FRMR: /* Section 6.4.1.5 */
519 break;
520 case GPRS_LLC_XID: /* Section 6.4.1.6 */
Harald Welte0c1a3032011-10-16 18:49:05 +0200521 rx_llc_xid(lle, gph);
Harald Welte9b455bf2010-03-14 15:45:01 +0800522 break;
Harald Welteebabdea2010-06-01 18:28:10 +0200523 case GPRS_LLC_UI:
Holger Hans Peter Freytherfaf1f642011-06-23 17:53:27 -0400524 if (gprs_llc_is_retransmit(gph->seq_tx, lle->vu_recv)) {
525 LOGP(DLLC, LOGL_NOTICE,
526 "TLLI=%08x dropping UI, N(U=%d) not in window V(URV(UR:%d).\n",
Holger Hans Peter Freyther2788b962010-06-23 09:48:25 +0800527 lle->llme ? lle->llme->tlli : -1,
Harald Welteebabdea2010-06-01 18:28:10 +0200528 gph->seq_tx, lle->vu_recv);
Harald Welteabadd542013-06-21 14:06:18 +0200529
530 /* HACK: non-standard recovery handling. If remote LLE
531 * is re-transmitting the same sequence number for
Harald Welte649e1ff2013-07-21 17:41:46 +0800532 * three times, don't discard the frame but pass it on
Harald Welteabadd542013-06-21 14:06:18 +0200533 * and 'learn' the new sequence number */
534 if (gph->seq_tx != lle->vu_recv_last) {
535 lle->vu_recv_last = gph->seq_tx;
536 lle->vu_recv_duplicates = 0;
537 } else {
538 lle->vu_recv_duplicates++;
539 if (lle->vu_recv_duplicates < 3)
540 return -EIO;
541 LOGP(DLLC, LOGL_NOTICE, "TLLI=%08x recovering "
542 "N(U=%d) after receiving %u duplicates\n",
543 lle->llme ? lle->llme->tlli : -1,
544 gph->seq_tx, lle->vu_recv_duplicates);
545 }
Harald Welteebabdea2010-06-01 18:28:10 +0200546 }
547 /* Increment the sequence number that we expect in the next frame */
548 lle->vu_recv = (gph->seq_tx + 1) % 512;
Harald Welted07b4f92010-06-30 23:07:59 +0200549 /* Increment Overflow Counter */
550 if ((gph->seq_tx + 1) / 512)
551 lle->oc_ui_recv += 512;
Harald Welteebabdea2010-06-01 18:28:10 +0200552 break;
Holger Hans Peter Freyther744568b2014-04-04 12:47:32 +0200553 default:
554 LOGP(DLLC, LOGL_NOTICE, "Unhandled command: %d\n", gph->cmd);
555 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800556 }
557
558 return 0;
559}
560
Harald Weltea2665542010-05-02 09:28:11 +0200561/* receive an incoming LLC PDU (BSSGP-UL-UNITDATA-IND, 7.2.4.2) */
Harald Welte9b455bf2010-03-14 15:45:01 +0800562int gprs_llc_rcvmsg(struct msgb *msg, struct tlv_parsed *tv)
563{
Holger Hans Peter Freyther3dccda52011-10-14 23:42:13 +0200564 struct gprs_llc_hdr *lh = (struct gprs_llc_hdr *) msgb_llch(msg);
Harald Welte9b455bf2010-03-14 15:45:01 +0800565 struct gprs_llc_hdr_parsed llhp;
Harald Welte10997d02010-05-03 12:28:12 +0200566 struct gprs_llc_lle *lle;
Harald Weltea2665542010-05-02 09:28:11 +0200567 int rc = 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800568
Harald Welte11d7c102010-05-02 11:54:55 +0200569 /* Identifiers from DOWN: NSEI, BVCI, TLLI */
570
Holger Hans Peter Freyther4752e0c2010-05-23 21:33:57 +0800571 memset(&llhp, 0, sizeof(llhp));
Holger Hans Peter Freytherfa848d42010-05-23 21:43:57 +0800572 rc = gprs_llc_hdr_parse(&llhp, (uint8_t *) lh, TLVP_LEN(tv, BSSGP_IE_LLC_PDU));
Harald Welte9b455bf2010-03-14 15:45:01 +0800573 gprs_llc_hdr_dump(&llhp);
Harald Welte1ae09c72010-05-13 19:22:55 +0200574 if (rc < 0) {
Harald Welte1b170d12010-05-13 19:49:06 +0200575 LOGP(DLLC, LOGL_NOTICE, "Error during LLC header parsing\n");
Harald Welte1ae09c72010-05-13 19:22:55 +0200576 return rc;
577 }
578
Harald Welte807a5d82010-06-01 11:53:01 +0200579 switch (gprs_tlli_type(msgb_tlli(msg))) {
580 case TLLI_LOCAL:
581 case TLLI_FOREIGN:
582 case TLLI_RANDOM:
583 case TLLI_AUXILIARY:
584 break;
585 default:
586 LOGP(DLLC, LOGL_ERROR,
587 "Discarding frame with strange TLLI type\n");
588 break;
589 }
590
Harald Weltea2665542010-05-02 09:28:11 +0200591 /* find the LLC Entity for this TLLI+SAPI tuple */
Holger Hans Peter Freyther964a9b32013-07-30 09:29:27 +0200592 lle = lle_for_rx_by_tlli_sapi(msgb_tlli(msg), llhp.sapi, llhp.cmd);
593 if (!lle)
594 return 0;
Harald Weltea2665542010-05-02 09:28:11 +0200595
Harald Welted07b4f92010-06-30 23:07:59 +0200596 /* decrypt information field + FCS, if needed! */
597 if (llhp.is_encrypted) {
598 uint32_t iov_ui = 0; /* FIXME: randomly select for TLLI */
599 uint16_t crypt_len = llhp.data_len + 3;
600 uint8_t cipher_out[GSM0464_CIPH_MAX_BLOCK];
601 uint32_t iv;
602 uint64_t kc = *(uint64_t *)&lle->llme->kc;
603 int rc, i;
604
605 if (lle->llme->algo == GPRS_ALGO_GEA0) {
606 LOGP(DLLC, LOGL_NOTICE, "encrypted frame for LLC that "
607 "has no KC/Algo! Dropping.\n");
608 return 0;
609 }
610
611 iv = gprs_cipher_gen_input_ui(iov_ui, lle->sapi, llhp.seq_tx,
612 lle->oc_ui_recv);
613 rc = gprs_cipher_run(cipher_out, crypt_len, lle->llme->algo,
614 kc, iv, GPRS_CIPH_MS2SGSN);
615 if (rc < 0) {
616 LOGP(DLLC, LOGL_ERROR, "Error decrypting frame: %d\n",
617 rc);
618 return rc;
619 }
620
621 /* XOR the cipher output with the information field + FCS */
622 for (i = 0; i < crypt_len; i++)
623 *(llhp.data + i) ^= cipher_out[i];
624 } else {
625 if (lle->llme->algo != GPRS_ALGO_GEA0) {
626 LOGP(DLLC, LOGL_NOTICE, "unencrypted frame for LLC "
627 "that is supposed to be encrypted. Dropping.\n");
628 return 0;
629 }
630 }
631
632 /* We have to do the FCS check _after_ decryption */
Harald Welte1b8827a2010-06-30 23:15:57 +0200633 llhp.fcs_calc = gprs_llc_fcs((uint8_t *)lh, llhp.crc_length);
Harald Welted07b4f92010-06-30 23:07:59 +0200634 if (llhp.fcs != llhp.fcs_calc) {
635 LOGP(DLLC, LOGL_INFO, "Dropping frame with invalid FCS\n");
636 return -EIO;
637 }
638
Harald Welte10997d02010-05-03 12:28:12 +0200639 /* Update LLE's (BVCI, NSEI) tuple */
Harald Welte807a5d82010-06-01 11:53:01 +0200640 lle->llme->bvci = msgb_bvci(msg);
641 lle->llme->nsei = msgb_nsei(msg);
Harald Welte10997d02010-05-03 12:28:12 +0200642
Harald Welte1ae09c72010-05-13 19:22:55 +0200643 /* Receive and Process the actual LLC frame */
Harald Welte9b455bf2010-03-14 15:45:01 +0800644 rc = gprs_llc_hdr_rx(&llhp, lle);
Harald Welte1ae09c72010-05-13 19:22:55 +0200645 if (rc < 0)
646 return rc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800647
Harald Welte1ae09c72010-05-13 19:22:55 +0200648 /* llhp.data is only set when we need to send LL_[UNIT]DATA_IND up */
Harald Welte9b455bf2010-03-14 15:45:01 +0800649 if (llhp.data) {
Harald Welte943c5bc2010-04-30 16:33:12 +0200650 msgb_gmmh(msg) = llhp.data;
Harald Welte9b455bf2010-03-14 15:45:01 +0800651 switch (llhp.sapi) {
652 case GPRS_SAPI_GMM:
Harald Welte1ae09c72010-05-13 19:22:55 +0200653 /* send LL_UNITDATA_IND to GMM */
Harald Welte807a5d82010-06-01 11:53:01 +0200654 rc = gsm0408_gprs_rcvmsg(msg, lle->llme);
Harald Weltea2665542010-05-02 09:28:11 +0200655 break;
Harald Weltea2665542010-05-02 09:28:11 +0200656 case GPRS_SAPI_SNDCP3:
657 case GPRS_SAPI_SNDCP5:
658 case GPRS_SAPI_SNDCP9:
659 case GPRS_SAPI_SNDCP11:
Harald Welteebabdea2010-06-01 18:28:10 +0200660 /* send LL_DATA_IND/LL_UNITDATA_IND to SNDCP */
661 rc = sndcp_llunitdata_ind(msg, lle, llhp.data, llhp.data_len);
662 break;
Harald Weltea2665542010-05-02 09:28:11 +0200663 case GPRS_SAPI_SMS:
664 /* FIXME */
Harald Welteebabdea2010-06-01 18:28:10 +0200665 case GPRS_SAPI_TOM2:
666 case GPRS_SAPI_TOM8:
667 /* FIXME: send LL_DATA_IND/LL_UNITDATA_IND to TOM */
Harald Weltea2665542010-05-02 09:28:11 +0200668 default:
Harald Weltec6ecafe2010-05-13 19:47:50 +0200669 LOGP(DLLC, LOGL_NOTICE, "Unsupported SAPI %u\n", llhp.sapi);
Harald Weltea2665542010-05-02 09:28:11 +0200670 rc = -EINVAL;
671 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800672 }
673 }
674
Harald Weltea2665542010-05-02 09:28:11 +0200675 return rc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800676}
Harald Welte807a5d82010-06-01 11:53:01 +0200677
678/* 04.64 Chapter 7.2.1.1 LLGMM-ASSIGN */
679int gprs_llgmm_assign(struct gprs_llc_llme *llme,
680 uint32_t old_tlli, uint32_t new_tlli,
681 enum gprs_ciph_algo alg, const uint8_t *kc)
682{
683 unsigned int i;
684
Harald Welted07b4f92010-06-30 23:07:59 +0200685 /* Update the crypto parameters */
Harald Welted07b4f92010-06-30 23:07:59 +0200686 llme->algo = alg;
Harald Welte3e2e1592010-06-30 23:19:23 +0200687 if (alg != GPRS_ALGO_GEA0)
688 memcpy(llme->kc, kc, sizeof(llme->kc));
Harald Welted07b4f92010-06-30 23:07:59 +0200689
Harald Welte807a5d82010-06-01 11:53:01 +0200690 if (old_tlli == 0xffffffff && new_tlli != 0xffffffff) {
691 /* TLLI Assignment 8.3.1 */
692 /* New TLLI shall be assigned and used when (re)transmitting LLC frames */
693 /* If old TLLI != 0xffffffff was assigned to LLME, then TLLI
694 * old is unassigned. Only TLLI new shall be accepted when
695 * received from peer. */
Harald Welte875840c2010-07-01 11:54:31 +0200696 if (llme->old_tlli != 0xffffffff) {
697 llme->old_tlli = 0xffffffff;
698 llme->tlli = new_tlli;
699 } else {
700 /* If TLLI old == 0xffffffff was assigned to LLME, then this is
701 * TLLI assignmemt according to 8.3.1 */
702 llme->old_tlli = 0xffffffff;
703 llme->tlli = new_tlli;
704 llme->state = GPRS_LLMS_ASSIGNED;
705 /* 8.5.3.1 For all LLE's */
706 for (i = 0; i < ARRAY_SIZE(llme->lle); i++) {
707 struct gprs_llc_lle *l = &llme->lle[i];
708 l->vu_send = l->vu_recv = 0;
709 l->retrans_ctr = 0;
710 l->state = GPRS_LLES_ASSIGNED_ADM;
711 /* FIXME Set parameters according to table 9 */
712 }
Harald Welte807a5d82010-06-01 11:53:01 +0200713 }
714 } else if (old_tlli != 0xffffffff && new_tlli != 0xffffffff) {
715 /* TLLI Change 8.3.2 */
716 /* Both TLLI Old and TLLI New are assigned; use New when
Holger Hans Peter Freyther92aa6bb2013-07-28 20:13:01 +0200717 * (re)transmitting. Accept both Old and New on Rx */
Holger Hans Peter Freytheraa93bac2013-07-31 11:20:37 +0200718 llme->old_tlli = old_tlli;
Harald Welte807a5d82010-06-01 11:53:01 +0200719 llme->tlli = new_tlli;
720 llme->state = GPRS_LLMS_ASSIGNED;
721 } else if (old_tlli != 0xffffffff && new_tlli == 0xffffffff) {
722 /* TLLI Unassignment 8.3.3) */
723 llme->tlli = llme->old_tlli = 0;
724 llme->state = GPRS_LLMS_UNASSIGNED;
725 for (i = 0; i < ARRAY_SIZE(llme->lle); i++) {
726 struct gprs_llc_lle *l = &llme->lle[i];
727 l->state = GPRS_LLES_UNASSIGNED;
728 }
Harald Weltef7fef482010-06-28 22:18:26 +0200729 llme_free(llme);
Harald Welte807a5d82010-06-01 11:53:01 +0200730 } else
731 return -EINVAL;
732
733 return 0;
734}
Harald Welte496aee42010-06-30 19:59:55 +0200735
Harald Welte0c1a3032011-10-16 18:49:05 +0200736/* Chapter 7.2.1.2 LLGMM-RESET.req */
737int gprs_llgmm_reset(struct gprs_llc_llme *llme)
738{
739 struct msgb *msg = msgb_alloc_headroom(4096, 1024, "LLC_XID");
740 int random = rand();
Jacob Erlbeck25ad52c2014-09-11 14:20:53 +0200741 struct gprs_llc_lle *lle = &llme->lle[1];
Harald Welte0c1a3032011-10-16 18:49:05 +0200742
743 /* First XID component must be RESET */
744 msgb_put_xid_par(msg, GPRS_LLC_XID_T_RESET, 0, NULL);
745 /* randomly select new IOV-UI */
Harald Welte066a0f52011-10-16 18:59:20 +0200746 msgb_put_xid_par(msg, GPRS_LLC_XID_T_IOV_UI, 4, (uint8_t *) &random);
Harald Welte0c1a3032011-10-16 18:49:05 +0200747
Jacob Erlbeck25ad52c2014-09-11 14:20:53 +0200748 /* Reset some of the LLC parameters. See GSM 04.64, 8.5.3.1 */
749 lle->vu_recv = 0;
750 lle->vu_send = 0;
751 lle->oc_ui_send = 0;
752 lle->oc_ui_recv = 0;
753
Harald Welte0c1a3032011-10-16 18:49:05 +0200754 /* FIXME: Start T200, wait for XID response */
Jacob Erlbeck25ad52c2014-09-11 14:20:53 +0200755 return gprs_llc_tx_xid(lle, msg, 1);
Harald Welte0c1a3032011-10-16 18:49:05 +0200756}
757
Harald Welte496aee42010-06-30 19:59:55 +0200758int gprs_llc_init(const char *cipher_plugin_path)
759{
760 return gprs_cipher_load(cipher_plugin_path);
761}