blob: 002742beed127b58265108858f2b9791cd93ea5c [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
Harald Welte9b455bf2010-03-14 15:45:01 +080025#include <osmocore/msgb.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080026#include <osmocore/linuxlist.h>
27#include <osmocore/timer.h>
Harald Weltea2665542010-05-02 09:28:11 +020028#include <osmocore/talloc.h>
29
30#include <openbsc/gsm_data.h>
31#include <openbsc/debug.h>
Harald Welte807a5d82010-06-01 11:53:01 +020032#include <openbsc/gprs_sgsn.h>
33#include <openbsc/gprs_gmm.h>
Harald Welte9b455bf2010-03-14 15:45:01 +080034#include <openbsc/gprs_bssgp.h>
35#include <openbsc/gprs_llc.h>
36#include <openbsc/crc24.h>
37
Harald Welte1d9d9442010-06-03 07:11:04 +020038/* Section 8.9.9 LLC layer parameter default values */
39static const struct gprs_llc_params llc_default_params[] = {
40 [1] = {
41 .t200_201 = 5,
42 .n200 = 3,
43 .n201_u = 400,
44 },
45 [2] = {
46 .t200_201 = 5,
47 .n200 = 3,
48 .n201_u = 270,
49 },
50 [3] = {
51 .iov_i_exp = 27,
52 .t200_201 = 5,
53 .n200 = 3,
54 .n201_u = 500,
55 .n201_i = 1503,
56 .mD = 1520,
57 .mU = 1520,
58 .kD = 16,
59 .kU = 16,
60 },
61 [5] = {
62 .iov_i_exp = 27,
63 .t200_201 = 10,
64 .n200 = 3,
65 .n201_u = 500,
66 .n201_i = 1503,
67 .mD = 760,
68 .mU = 760,
69 .kD = 8,
70 .kU = 8,
71 },
72 [7] = {
73 .t200_201 = 20,
74 .n200 = 3,
75 .n201_u = 270,
76 },
77 [8] = {
78 .t200_201 = 20,
79 .n200 = 3,
80 .n201_u = 270,
81 },
82 [9] = {
83 .iov_i_exp = 27,
84 .t200_201 = 20,
85 .n200 = 3,
86 .n201_u = 500,
87 .n201_i = 1503,
88 .mD = 380,
89 .mU = 380,
90 .kD = 4,
91 .kU = 4,
92 },
93 [11] = {
94 .iov_i_exp = 27,
95 .t200_201 = 40,
96 .n200 = 3,
97 .n201_u = 500,
98 .n201_i = 1503,
99 .mD = 190,
100 .mU = 190,
101 .kD = 2,
102 .kU = 2,
103 },
104};
105
Harald Welte807a5d82010-06-01 11:53:01 +0200106LLIST_HEAD(gprs_llc_llmes);
Harald Weltea2665542010-05-02 09:28:11 +0200107void *llc_tall_ctx;
108
109/* lookup LLC Entity based on DLCI (TLLI+SAPI tuple) */
Harald Welte1d9d9442010-06-03 07:11:04 +0200110static struct gprs_llc_lle *lle_by_tlli_sapi(uint32_t tlli, uint8_t sapi)
Harald Weltea2665542010-05-02 09:28:11 +0200111{
Harald Welte807a5d82010-06-01 11:53:01 +0200112 struct gprs_llc_llme *llme;
Harald Weltea2665542010-05-02 09:28:11 +0200113
Harald Welte807a5d82010-06-01 11:53:01 +0200114 llist_for_each_entry(llme, &gprs_llc_llmes, list) {
115 if (llme->tlli == tlli || llme->old_tlli == tlli)
116 return &llme->lle[sapi];
Harald Weltea2665542010-05-02 09:28:11 +0200117 }
118 return NULL;
119}
120
Harald Welte1d9d9442010-06-03 07:11:04 +0200121static void lle_init(struct gprs_llc_llme *llme, uint8_t sapi)
Harald Weltea2665542010-05-02 09:28:11 +0200122{
Harald Welte807a5d82010-06-01 11:53:01 +0200123 struct gprs_llc_lle *lle = &llme->lle[sapi];
Harald Weltea2665542010-05-02 09:28:11 +0200124
Harald Welte807a5d82010-06-01 11:53:01 +0200125 lle->llme = llme;
126 lle->sapi = sapi;
127 lle->state = GPRS_LLES_UNASSIGNED;
128
Harald Welte1d9d9442010-06-03 07:11:04 +0200129 /* Initialize according to parameters */
130 memcpy(&lle->params, &llc_default_params[sapi], sizeof(lle->params));
Harald Welte807a5d82010-06-01 11:53:01 +0200131}
132
133static struct gprs_llc_llme *llme_alloc(uint32_t tlli)
134{
135 struct gprs_llc_llme *llme;
136 uint32_t i;
137
138 llme = talloc_zero(llc_tall_ctx, struct gprs_llc_llme);
139 if (!llme)
Harald Weltea2665542010-05-02 09:28:11 +0200140 return NULL;
141
Harald Welte807a5d82010-06-01 11:53:01 +0200142 llme->tlli = tlli;
Harald Welte875840c2010-07-01 11:54:31 +0200143 llme->old_tlli = 0xffffffff;
Harald Welte807a5d82010-06-01 11:53:01 +0200144 llme->state = GPRS_LLMS_UNASSIGNED;
Harald Weltea2665542010-05-02 09:28:11 +0200145
Harald Welte807a5d82010-06-01 11:53:01 +0200146 for (i = 0; i < ARRAY_SIZE(llme->lle); i++)
147 lle_init(llme, i);
148
149 llist_add(&llme->list, &gprs_llc_llmes);
150
151 return llme;
Harald Weltea2665542010-05-02 09:28:11 +0200152}
153
Harald Weltef7fef482010-06-28 22:18:26 +0200154static void llme_free(struct gprs_llc_llme *llme)
155{
156 llist_del(&llme->list);
157 talloc_free(llme);
158}
159
Harald Welte9b455bf2010-03-14 15:45:01 +0800160enum gprs_llc_cmd {
161 GPRS_LLC_NULL,
162 GPRS_LLC_RR,
163 GPRS_LLC_ACK,
164 GPRS_LLC_RNR,
165 GPRS_LLC_SACK,
166 GPRS_LLC_DM,
167 GPRS_LLC_DISC,
168 GPRS_LLC_UA,
169 GPRS_LLC_SABM,
170 GPRS_LLC_FRMR,
171 GPRS_LLC_XID,
Harald Welte1ae09c72010-05-13 19:22:55 +0200172 GPRS_LLC_UI,
Harald Welte9b455bf2010-03-14 15:45:01 +0800173};
174
Harald Welteb61f4032010-05-18 12:31:50 +0200175static const struct value_string llc_cmd_strs[] = {
176 { GPRS_LLC_NULL, "NULL" },
177 { GPRS_LLC_RR, "RR" },
178 { GPRS_LLC_ACK, "ACK" },
179 { GPRS_LLC_RNR, "RNR" },
180 { GPRS_LLC_SACK, "SACK" },
181 { GPRS_LLC_DM, "DM" },
182 { GPRS_LLC_DISC, "DISC" },
183 { GPRS_LLC_UA, "UA" },
184 { GPRS_LLC_SABM, "SABM" },
185 { GPRS_LLC_FRMR, "FRMR" },
186 { GPRS_LLC_XID, "XID" },
187 { GPRS_LLC_UI, "UI" },
188 { 0, NULL }
189};
190
Harald Welte9b455bf2010-03-14 15:45:01 +0800191struct gprs_llc_hdr_parsed {
Harald Welteeaa614c2010-05-02 11:26:34 +0200192 uint8_t sapi;
193 uint8_t is_cmd:1,
Harald Welte9b455bf2010-03-14 15:45:01 +0800194 ack_req:1,
195 is_encrypted:1;
Harald Welteeaa614c2010-05-02 11:26:34 +0200196 uint32_t seq_rx;
197 uint32_t seq_tx;
198 uint32_t fcs;
199 uint32_t fcs_calc;
200 uint8_t *data;
Harald Welte5658a1a2010-05-03 13:25:07 +0200201 uint16_t data_len;
Harald Welte1b8827a2010-06-30 23:15:57 +0200202 uint16_t crc_length;
Harald Welte9b455bf2010-03-14 15:45:01 +0800203 enum gprs_llc_cmd cmd;
204};
205
206#define LLC_ALLOC_SIZE 16384
207#define UI_HDR_LEN 3
208#define N202 4
209#define CRC24_LENGTH 3
210
Harald Welteeaa614c2010-05-02 11:26:34 +0200211static int gprs_llc_fcs(uint8_t *data, unsigned int len)
Harald Welte9b455bf2010-03-14 15:45:01 +0800212{
Harald Welteeaa614c2010-05-02 11:26:34 +0200213 uint32_t fcs_calc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800214
215 fcs_calc = crc24_calc(INIT_CRC24, data, len);
216 fcs_calc = ~fcs_calc;
217 fcs_calc &= 0xffffff;
218
219 return fcs_calc;
220}
221
Harald Welte9b455bf2010-03-14 15:45:01 +0800222static void t200_expired(void *data)
223{
224 struct gprs_llc_lle *lle = data;
225
226 /* 8.5.1.3: Expiry of T200 */
227
Harald Welte1d9d9442010-06-03 07:11:04 +0200228 if (lle->retrans_ctr >= lle->params.n200) {
Harald Welte9b455bf2010-03-14 15:45:01 +0800229 /* FIXME: LLGM-STATUS-IND, LL-RELEASE-IND/CNF */
Harald Welte807a5d82010-06-01 11:53:01 +0200230 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800231 }
232
233 switch (lle->state) {
Harald Welte807a5d82010-06-01 11:53:01 +0200234 case GPRS_LLES_LOCAL_EST:
Harald Welte1ae09c72010-05-13 19:22:55 +0200235 /* FIXME: retransmit SABM */
236 /* FIXME: re-start T200 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800237 lle->retrans_ctr++;
238 break;
Harald Welte807a5d82010-06-01 11:53:01 +0200239 case GPRS_LLES_LOCAL_REL:
Harald Welte1ae09c72010-05-13 19:22:55 +0200240 /* FIXME: retransmit DISC */
241 /* FIXME: re-start T200 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800242 lle->retrans_ctr++;
243 break;
244 }
245
246}
247
248static void t201_expired(void *data)
249{
250 struct gprs_llc_lle *lle = data;
251
Harald Welte1d9d9442010-06-03 07:11:04 +0200252 if (lle->retrans_ctr < lle->params.n200) {
Harald Welte1ae09c72010-05-13 19:22:55 +0200253 /* FIXME: transmit apropriate supervisory frame (8.6.4.1) */
254 /* FIXME: set timer T201 */
Harald Welte9b455bf2010-03-14 15:45:01 +0800255 lle->retrans_ctr++;
256 }
257}
258
Harald Welte10997d02010-05-03 12:28:12 +0200259int gprs_llc_tx_u(struct msgb *msg, uint8_t sapi, int command,
260 enum gprs_llc_u_cmd u_cmd, int pf_bit)
261{
262 uint8_t *fcs, *llch;
263 uint8_t addr, ctrl;
264 uint32_t fcs_calc;
265
266 /* Identifiers from UP: (TLLI, SAPI) + (BVCI, NSEI) */
267
268 /* Address Field */
269 addr = sapi & 0xf;
270 if (command)
271 addr |= 0x40;
272
273 /* 6.3 Figure 8 */
274 ctrl = 0xe0 | u_cmd;
275 if (pf_bit)
276 ctrl |= 0x10;
277
278 /* prepend LLC UI header */
279 llch = msgb_push(msg, 2);
280 llch[0] = addr;
281 llch[1] = ctrl;
282
283 /* append FCS to end of frame */
284 fcs = msgb_put(msg, 3);
285 fcs_calc = gprs_llc_fcs(llch, fcs - llch);
286 fcs[0] = fcs_calc & 0xff;
287 fcs[1] = (fcs_calc >> 8) & 0xff;
288 fcs[2] = (fcs_calc >> 16) & 0xff;
289
290 /* Identifiers passed down: (BVCI, NSEI) */
291
Harald Welte1ae09c72010-05-13 19:22:55 +0200292 /* Send BSSGP-DL-UNITDATA.req */
Harald Welte56a01452010-05-31 22:12:30 +0200293 return gprs_bssgp_tx_dl_ud(msg, NULL);
Harald Welte10997d02010-05-03 12:28:12 +0200294}
295
296/* Send XID response to LLE */
297static int gprs_llc_tx_xid(struct gprs_llc_lle *lle, struct msgb *msg)
298{
299 /* copy identifiers from LLE to ensure lower layers can route */
Harald Welte807a5d82010-06-01 11:53:01 +0200300 msgb_tlli(msg) = lle->llme->tlli;
301 msgb_bvci(msg) = lle->llme->bvci;
302 msgb_nsei(msg) = lle->llme->nsei;
Harald Welte10997d02010-05-03 12:28:12 +0200303
304 return gprs_llc_tx_u(msg, lle->sapi, 0, GPRS_LLC_U_XID, 1);
305}
306
Harald Welte9b455bf2010-03-14 15:45:01 +0800307/* Transmit a UI frame over the given SAPI */
Harald Welte56a01452010-05-31 22:12:30 +0200308int gprs_llc_tx_ui(struct msgb *msg, uint8_t sapi, int command,
309 void *mmctx)
Harald Welte9b455bf2010-03-14 15:45:01 +0800310{
Harald Weltee6afd602010-05-02 11:19:37 +0200311 struct gprs_llc_lle *lle;
Harald Welteeaa614c2010-05-02 11:26:34 +0200312 uint8_t *fcs, *llch;
313 uint8_t addr, ctrl[2];
314 uint32_t fcs_calc;
315 uint16_t nu = 0;
Harald Welted07b4f92010-06-30 23:07:59 +0200316 uint32_t oc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800317
Harald Weltee6afd602010-05-02 11:19:37 +0200318 /* Identifiers from UP: (TLLI, SAPI) + (BVCI, NSEI) */
319
320 /* look-up or create the LL Entity for this (TLLI, SAPI) tuple */
321 lle = lle_by_tlli_sapi(msgb_tlli(msg), sapi);
Harald Welte807a5d82010-06-01 11:53:01 +0200322 if (!lle) {
323 struct gprs_llc_llme *llme;
324 llme = llme_alloc(msgb_tlli(msg));
325 lle = &llme->lle[sapi];
326 }
Harald Welte1d9d9442010-06-03 07:11:04 +0200327
328 if (msg->len > lle->params.n201_u) {
329 LOGP(DLLC, LOGL_ERROR, "Cannot Tx %u bytes (N201-U=%u)\n",
330 msg->len, lle->params.n201_u);
331 return -EFBIG;
332 }
333
Harald Weltee6afd602010-05-02 11:19:37 +0200334 /* Update LLE's (BVCI, NSEI) tuple */
Harald Welte807a5d82010-06-01 11:53:01 +0200335 lle->llme->bvci = msgb_bvci(msg);
336 lle->llme->nsei = msgb_nsei(msg);
Harald Weltee6afd602010-05-02 11:19:37 +0200337
Harald Welted07b4f92010-06-30 23:07:59 +0200338 /* Obtain current values for N(u) and OC */
Harald Welte6bdee6a2010-05-30 21:51:58 +0200339 nu = lle->vu_send;
Harald Welted07b4f92010-06-30 23:07:59 +0200340 oc = lle->oc_ui_send;
341 /* Increment V(U) */
Harald Welte6bdee6a2010-05-30 21:51:58 +0200342 lle->vu_send = (lle->vu_send + 1) % 512;
Harald Welted07b4f92010-06-30 23:07:59 +0200343 /* Increment Overflow Counter, if needed */
344 if ((lle->vu_send + 1) / 512)
345 lle->oc_ui_send += 512;
Harald Welte6bdee6a2010-05-30 21:51:58 +0200346
Harald Welte9b455bf2010-03-14 15:45:01 +0800347 /* Address Field */
348 addr = sapi & 0xf;
349 if (command)
350 addr |= 0x40;
351
352 /* Control Field */
353 ctrl[0] = 0xc0;
354 ctrl[0] |= nu >> 6;
355 ctrl[1] = (nu << 2) & 0xfc;
356 ctrl[1] |= 0x01; /* Protected Mode */
357
358 /* prepend LLC UI header */
359 llch = msgb_push(msg, 3);
360 llch[0] = addr;
361 llch[1] = ctrl[0];
362 llch[2] = ctrl[1];
363
364 /* append FCS to end of frame */
365 fcs = msgb_put(msg, 3);
366 fcs_calc = gprs_llc_fcs(llch, fcs - llch);
367 fcs[0] = fcs_calc & 0xff;
368 fcs[1] = (fcs_calc >> 8) & 0xff;
369 fcs[2] = (fcs_calc >> 16) & 0xff;
370
Harald Welted07b4f92010-06-30 23:07:59 +0200371 /* encrypt information field + FCS, if needed! */
372 if (lle->llme->algo != GPRS_ALGO_GEA0) {
373 uint32_t iov_ui = 0; /* FIXME: randomly select for TLLI */
374 uint16_t crypt_len = (fcs + 3) - (llch + 3);
375 uint8_t cipher_out[GSM0464_CIPH_MAX_BLOCK];
376 uint32_t iv;
377 int rc, i;
378 uint64_t kc = *(uint64_t *)&lle->llme->kc;
379
380 /* Compute the 'Input' Paraemeter */
381 iv = gprs_cipher_gen_input_ui(iov_ui, sapi, nu, oc);
382
383 /* Compute the keystream that we need to XOR with the data */
384 rc = gprs_cipher_run(cipher_out, crypt_len, lle->llme->algo,
385 kc, iv, GPRS_CIPH_SGSN2MS);
386 if (rc < 0) {
387 LOGP(DLLC, LOGL_ERROR, "Error crypting UI frame: %d\n", rc);
388 return rc;
389 }
390
391 /* XOR the cipher output with the information field + FCS */
392 for (i = 0; i < crypt_len; i++)
393 *(llch + 3 + i) ^= cipher_out[i];
394
395 /* Mark frame as encrypted */
396 ctrl[1] |= 0x02;
397 }
398
Harald Weltee6afd602010-05-02 11:19:37 +0200399 /* Identifiers passed down: (BVCI, NSEI) */
400
Harald Welte1ae09c72010-05-13 19:22:55 +0200401 /* Send BSSGP-DL-UNITDATA.req */
Harald Welte56a01452010-05-31 22:12:30 +0200402 return gprs_bssgp_tx_dl_ud(msg, mmctx);
Harald Welte9b455bf2010-03-14 15:45:01 +0800403}
404
Holger Hans Peter Freyther3a6fdcd2010-05-23 21:35:25 +0800405static void gprs_llc_hdr_dump(struct gprs_llc_hdr_parsed *gph)
Harald Welte9b455bf2010-03-14 15:45:01 +0800406{
Sylvain Munaut6f3850f2010-07-03 22:03:02 +0200407 DEBUGP(DLLC, "LLC SAPI=%u %c %c FCS=0x%06x",
Harald Welte9b455bf2010-03-14 15:45:01 +0800408 gph->sapi, gph->is_cmd ? 'C' : 'R', gph->ack_req ? 'A' : ' ',
Sylvain Munaut6f3850f2010-07-03 22:03:02 +0200409 gph->fcs);
Harald Welte9b455bf2010-03-14 15:45:01 +0800410
411 if (gph->cmd)
Harald Welteb61f4032010-05-18 12:31:50 +0200412 DEBUGPC(DLLC, "CMD=%s ", get_value_string(llc_cmd_strs, gph->cmd));
Harald Welte9b455bf2010-03-14 15:45:01 +0800413
414 if (gph->data)
Harald Weltec6ecafe2010-05-13 19:47:50 +0200415 DEBUGPC(DLLC, "DATA ");
Harald Welte9b455bf2010-03-14 15:45:01 +0800416
Harald Weltec6ecafe2010-05-13 19:47:50 +0200417 DEBUGPC(DLLC, "\n");
Harald Welte9b455bf2010-03-14 15:45:01 +0800418}
419static int gprs_llc_hdr_rx(struct gprs_llc_hdr_parsed *gph,
420 struct gprs_llc_lle *lle)
421{
422 switch (gph->cmd) {
423 case GPRS_LLC_SABM: /* Section 6.4.1.1 */
424 lle->v_sent = lle->v_ack = lle->v_recv = 0;
Harald Welte807a5d82010-06-01 11:53:01 +0200425 if (lle->state == GPRS_LLES_ASSIGNED_ADM) {
Harald Welte9b455bf2010-03-14 15:45:01 +0800426 /* start re-establishment (8.7.1) */
427 }
Harald Welte807a5d82010-06-01 11:53:01 +0200428 lle->state = GPRS_LLES_REMOTE_EST;
Harald Welte9b455bf2010-03-14 15:45:01 +0800429 /* FIXME: Send UA */
Harald Welte807a5d82010-06-01 11:53:01 +0200430 lle->state = GPRS_LLES_ABM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800431 /* FIXME: process data */
432 break;
433 case GPRS_LLC_DISC: /* Section 6.4.1.2 */
434 /* FIXME: Send UA */
435 /* terminate ABM */
Harald Welte807a5d82010-06-01 11:53:01 +0200436 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800437 break;
438 case GPRS_LLC_UA: /* Section 6.4.1.3 */
Harald Welte807a5d82010-06-01 11:53:01 +0200439 if (lle->state == GPRS_LLES_LOCAL_EST)
440 lle->state = GPRS_LLES_ABM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800441 break;
442 case GPRS_LLC_DM: /* Section 6.4.1.4: ABM cannot be performed */
Harald Welte807a5d82010-06-01 11:53:01 +0200443 if (lle->state == GPRS_LLES_LOCAL_EST)
444 lle->state = GPRS_LLES_ASSIGNED_ADM;
Harald Welte9b455bf2010-03-14 15:45:01 +0800445 break;
446 case GPRS_LLC_FRMR: /* Section 6.4.1.5 */
447 break;
448 case GPRS_LLC_XID: /* Section 6.4.1.6 */
Harald Welte5658a1a2010-05-03 13:25:07 +0200449 /* FIXME: implement XID negotiation using SNDCP */
450 {
451 struct msgb *resp;
452 uint8_t *xid;
453 resp = msgb_alloc_headroom(4096, 1024, "LLC_XID");
454 xid = msgb_put(resp, gph->data_len);
455 memcpy(xid, gph->data, gph->data_len);
456 gprs_llc_tx_xid(lle, resp);
457 }
Harald Welte9b455bf2010-03-14 15:45:01 +0800458 break;
Harald Welteebabdea2010-06-01 18:28:10 +0200459 case GPRS_LLC_UI:
460 if (gph->seq_tx < lle->vu_recv) {
Holger Hans Peter Freyther2788b962010-06-23 09:48:25 +0800461 LOGP(DLLC, LOGL_NOTICE, "TLLI=%08x dropping UI, vurecv %u <= %u\n",
462 lle->llme ? lle->llme->tlli : -1,
Harald Welteebabdea2010-06-01 18:28:10 +0200463 gph->seq_tx, lle->vu_recv);
464 return -EIO;
465 }
466 /* Increment the sequence number that we expect in the next frame */
467 lle->vu_recv = (gph->seq_tx + 1) % 512;
Harald Welted07b4f92010-06-30 23:07:59 +0200468 /* Increment Overflow Counter */
469 if ((gph->seq_tx + 1) / 512)
470 lle->oc_ui_recv += 512;
Harald Welteebabdea2010-06-01 18:28:10 +0200471 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800472 }
473
474 return 0;
475}
476
477/* parse a GPRS LLC header, also check for invalid frames */
478static int gprs_llc_hdr_parse(struct gprs_llc_hdr_parsed *ghp,
Holger Hans Peter Freytherfa848d42010-05-23 21:43:57 +0800479 uint8_t *llc_hdr, int len)
Harald Welte9b455bf2010-03-14 15:45:01 +0800480{
Harald Welteeaa614c2010-05-02 11:26:34 +0200481 uint8_t *ctrl = llc_hdr+1;
Harald Welte9b455bf2010-03-14 15:45:01 +0800482 int is_sack = 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800483
484 if (len <= CRC24_LENGTH)
485 return -EIO;
486
Harald Welte1b8827a2010-06-30 23:15:57 +0200487 ghp->crc_length = len - CRC24_LENGTH;
Harald Welte9b455bf2010-03-14 15:45:01 +0800488
489 ghp->ack_req = 0;
490
491 /* Section 5.5: FCS */
492 ghp->fcs = *(llc_hdr + len - 3);
493 ghp->fcs |= *(llc_hdr + len - 2) << 8;
494 ghp->fcs |= *(llc_hdr + len - 1) << 16;
495
496 /* Section 6.2.1: invalid PD field */
497 if (llc_hdr[0] & 0x80)
498 return -EIO;
499
500 /* This only works for the MS->SGSN direction */
501 if (llc_hdr[0] & 0x40)
502 ghp->is_cmd = 0;
503 else
504 ghp->is_cmd = 1;
505
506 ghp->sapi = llc_hdr[0] & 0xf;
507
508 /* Section 6.2.3: check for reserved SAPI */
509 switch (ghp->sapi) {
510 case 0:
511 case 4:
512 case 6:
513 case 0xa:
514 case 0xc:
515 case 0xd:
516 case 0xf:
517 return -EINVAL;
518 }
519
520 if ((ctrl[0] & 0x80) == 0) {
521 /* I (Information transfer + Supervisory) format */
Harald Welteeaa614c2010-05-02 11:26:34 +0200522 uint8_t k;
Harald Welte9b455bf2010-03-14 15:45:01 +0800523
524 ghp->data = ctrl + 3;
525
526 if (ctrl[0] & 0x40)
527 ghp->ack_req = 1;
528
529 ghp->seq_tx = (ctrl[0] & 0x1f) << 4;
530 ghp->seq_tx |= (ctrl[1] >> 4);
531
532 ghp->seq_rx = (ctrl[1] & 0x7) << 6;
533 ghp->seq_rx |= (ctrl[2] >> 2);
534
535 switch (ctrl[2] & 0x03) {
536 case 0:
537 ghp->cmd = GPRS_LLC_RR;
538 break;
539 case 1:
540 ghp->cmd = GPRS_LLC_ACK;
541 break;
542 case 2:
543 ghp->cmd = GPRS_LLC_RNR;
544 break;
545 case 3:
546 ghp->cmd = GPRS_LLC_SACK;
547 k = ctrl[3] & 0x1f;
548 ghp->data += 1 + k;
549 break;
550 }
Harald Welte5658a1a2010-05-03 13:25:07 +0200551 ghp->data_len = (llc_hdr + len - 3) - ghp->data;
Harald Welte9b455bf2010-03-14 15:45:01 +0800552 } else if ((ctrl[0] & 0xc0) == 0x80) {
553 /* S (Supervisory) format */
554 ghp->data = NULL;
Harald Welte5658a1a2010-05-03 13:25:07 +0200555 ghp->data_len = 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800556
557 if (ctrl[0] & 0x20)
558 ghp->ack_req = 1;
559 ghp->seq_rx = (ctrl[0] & 0x7) << 6;
560 ghp->seq_rx |= (ctrl[1] >> 2);
561
562 switch (ctrl[1] & 0x03) {
563 case 0:
564 ghp->cmd = GPRS_LLC_RR;
565 break;
566 case 1:
567 ghp->cmd = GPRS_LLC_ACK;
568 break;
569 case 2:
570 ghp->cmd = GPRS_LLC_RNR;
571 break;
572 case 3:
573 ghp->cmd = GPRS_LLC_SACK;
574 break;
575 }
576 } else if ((ctrl[0] & 0xe0) == 0xc0) {
577 /* UI (Unconfirmed Inforamtion) format */
Harald Welte1ae09c72010-05-13 19:22:55 +0200578 ghp->cmd = GPRS_LLC_UI;
Harald Welte9b455bf2010-03-14 15:45:01 +0800579 ghp->data = ctrl + 2;
Harald Welte5658a1a2010-05-03 13:25:07 +0200580 ghp->data_len = (llc_hdr + len - 3) - ghp->data;
Harald Welte9b455bf2010-03-14 15:45:01 +0800581
582 ghp->seq_tx = (ctrl[0] & 0x7) << 6;
583 ghp->seq_tx |= (ctrl[1] >> 2);
584 if (ctrl[1] & 0x02) {
585 ghp->is_encrypted = 1;
586 /* FIXME: encryption */
587 }
588 if (ctrl[1] & 0x01) {
589 /* FCS over hdr + all inf fields */
590 } else {
591 /* FCS over hdr + N202 octets (4) */
Harald Welte1b8827a2010-06-30 23:15:57 +0200592 if (ghp->crc_length > UI_HDR_LEN + N202)
593 ghp->crc_length = UI_HDR_LEN + N202;
Harald Welte9b455bf2010-03-14 15:45:01 +0800594 }
595 } else {
596 /* U (Unnumbered) format: 1 1 1 P/F M4 M3 M2 M1 */
597 ghp->data = NULL;
Harald Welte5658a1a2010-05-03 13:25:07 +0200598 ghp->data_len = 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800599
600 switch (ctrl[0] & 0xf) {
Harald Welte5658a1a2010-05-03 13:25:07 +0200601 case GPRS_LLC_U_NULL_CMD:
Harald Welte9b455bf2010-03-14 15:45:01 +0800602 ghp->cmd = GPRS_LLC_NULL;
603 break;
Harald Welte5658a1a2010-05-03 13:25:07 +0200604 case GPRS_LLC_U_DM_RESP:
Harald Welte9b455bf2010-03-14 15:45:01 +0800605 ghp->cmd = GPRS_LLC_DM;
606 break;
Harald Welte5658a1a2010-05-03 13:25:07 +0200607 case GPRS_LLC_U_DISC_CMD:
Harald Welte9b455bf2010-03-14 15:45:01 +0800608 ghp->cmd = GPRS_LLC_DISC;
609 break;
Harald Welte5658a1a2010-05-03 13:25:07 +0200610 case GPRS_LLC_U_UA_RESP:
Harald Welte9b455bf2010-03-14 15:45:01 +0800611 ghp->cmd = GPRS_LLC_UA;
612 break;
Harald Welte5658a1a2010-05-03 13:25:07 +0200613 case GPRS_LLC_U_SABM_CMD:
Harald Welte9b455bf2010-03-14 15:45:01 +0800614 ghp->cmd = GPRS_LLC_SABM;
615 break;
Harald Welte5658a1a2010-05-03 13:25:07 +0200616 case GPRS_LLC_U_FRMR_RESP:
Harald Welte9b455bf2010-03-14 15:45:01 +0800617 ghp->cmd = GPRS_LLC_FRMR;
618 break;
Harald Welte5658a1a2010-05-03 13:25:07 +0200619 case GPRS_LLC_U_XID:
Harald Welte9b455bf2010-03-14 15:45:01 +0800620 ghp->cmd = GPRS_LLC_XID;
Harald Welte5658a1a2010-05-03 13:25:07 +0200621 ghp->data = ctrl + 1;
622 ghp->data_len = (llc_hdr + len - 3) - ghp->data;
Harald Welte9b455bf2010-03-14 15:45:01 +0800623 break;
624 default:
625 return -EIO;
626 }
627 }
628
Harald Welte9b455bf2010-03-14 15:45:01 +0800629 /* FIXME: parse sack frame */
Harald Welte1ae09c72010-05-13 19:22:55 +0200630 if (ghp->cmd == GPRS_LLC_SACK) {
Harald Welte1b170d12010-05-13 19:49:06 +0200631 LOGP(DLLC, LOGL_NOTICE, "Unsupported SACK frame\n");
Harald Welte1ae09c72010-05-13 19:22:55 +0200632 return -EIO;
633 }
634
635 return 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800636}
637
Harald Weltea2665542010-05-02 09:28:11 +0200638/* receive an incoming LLC PDU (BSSGP-UL-UNITDATA-IND, 7.2.4.2) */
Harald Welte9b455bf2010-03-14 15:45:01 +0800639int gprs_llc_rcvmsg(struct msgb *msg, struct tlv_parsed *tv)
640{
Harald Weltefd3fa1d2010-05-02 09:50:42 +0200641 struct bssgp_ud_hdr *udh = (struct bssgp_ud_hdr *) msgb_bssgph(msg);
Harald Welte943c5bc2010-04-30 16:33:12 +0200642 struct gprs_llc_hdr *lh = msgb_llch(msg);
Harald Welte9b455bf2010-03-14 15:45:01 +0800643 struct gprs_llc_hdr_parsed llhp;
Harald Welte10997d02010-05-03 12:28:12 +0200644 struct gprs_llc_lle *lle;
Harald Weltea2665542010-05-02 09:28:11 +0200645 int rc = 0;
Harald Welte9b455bf2010-03-14 15:45:01 +0800646
Harald Welte11d7c102010-05-02 11:54:55 +0200647 /* Identifiers from DOWN: NSEI, BVCI, TLLI */
648
Holger Hans Peter Freyther4752e0c2010-05-23 21:33:57 +0800649 memset(&llhp, 0, sizeof(llhp));
Holger Hans Peter Freytherfa848d42010-05-23 21:43:57 +0800650 rc = gprs_llc_hdr_parse(&llhp, (uint8_t *) lh, TLVP_LEN(tv, BSSGP_IE_LLC_PDU));
Harald Welte9b455bf2010-03-14 15:45:01 +0800651 gprs_llc_hdr_dump(&llhp);
Harald Welte1ae09c72010-05-13 19:22:55 +0200652 if (rc < 0) {
Harald Welte1b170d12010-05-13 19:49:06 +0200653 LOGP(DLLC, LOGL_NOTICE, "Error during LLC header parsing\n");
Harald Welte1ae09c72010-05-13 19:22:55 +0200654 return rc;
655 }
656
Harald Welte807a5d82010-06-01 11:53:01 +0200657 switch (gprs_tlli_type(msgb_tlli(msg))) {
658 case TLLI_LOCAL:
659 case TLLI_FOREIGN:
660 case TLLI_RANDOM:
661 case TLLI_AUXILIARY:
662 break;
663 default:
664 LOGP(DLLC, LOGL_ERROR,
665 "Discarding frame with strange TLLI type\n");
666 break;
667 }
668
Harald Weltea2665542010-05-02 09:28:11 +0200669 /* find the LLC Entity for this TLLI+SAPI tuple */
670 lle = lle_by_tlli_sapi(msgb_tlli(msg), llhp.sapi);
Harald Welte1ae09c72010-05-13 19:22:55 +0200671
672 /* 7.2.1.1 LLC belonging to unassigned TLLI+SAPI shall be discarded,
673 * except UID and XID frames with SAPI=1 */
Harald Welted764c062010-05-18 12:45:08 +0200674 if (!lle) {
675 if (llhp.sapi == GPRS_SAPI_GMM &&
676 (llhp.cmd == GPRS_LLC_XID || llhp.cmd == GPRS_LLC_UI)) {
Harald Welte807a5d82010-06-01 11:53:01 +0200677 struct gprs_llc_llme *llme;
Harald Welted764c062010-05-18 12:45:08 +0200678 /* FIXME: don't use the TLLI but the 0xFFFF unassigned? */
Harald Welte807a5d82010-06-01 11:53:01 +0200679 llme = llme_alloc(msgb_tlli(msg));
680 lle = &llme->lle[llhp.sapi];
Harald Welted764c062010-05-18 12:45:08 +0200681 } else {
682 LOGP(DLLC, LOGL_NOTICE,
683 "unknown TLLI/SAPI: Silently dropping\n");
684 return 0;
685 }
Harald Welte1ae09c72010-05-13 19:22:55 +0200686 }
Harald Weltea2665542010-05-02 09:28:11 +0200687
Harald Welted07b4f92010-06-30 23:07:59 +0200688 /* decrypt information field + FCS, if needed! */
689 if (llhp.is_encrypted) {
690 uint32_t iov_ui = 0; /* FIXME: randomly select for TLLI */
691 uint16_t crypt_len = llhp.data_len + 3;
692 uint8_t cipher_out[GSM0464_CIPH_MAX_BLOCK];
693 uint32_t iv;
694 uint64_t kc = *(uint64_t *)&lle->llme->kc;
695 int rc, i;
696
697 if (lle->llme->algo == GPRS_ALGO_GEA0) {
698 LOGP(DLLC, LOGL_NOTICE, "encrypted frame for LLC that "
699 "has no KC/Algo! Dropping.\n");
700 return 0;
701 }
702
703 iv = gprs_cipher_gen_input_ui(iov_ui, lle->sapi, llhp.seq_tx,
704 lle->oc_ui_recv);
705 rc = gprs_cipher_run(cipher_out, crypt_len, lle->llme->algo,
706 kc, iv, GPRS_CIPH_MS2SGSN);
707 if (rc < 0) {
708 LOGP(DLLC, LOGL_ERROR, "Error decrypting frame: %d\n",
709 rc);
710 return rc;
711 }
712
713 /* XOR the cipher output with the information field + FCS */
714 for (i = 0; i < crypt_len; i++)
715 *(llhp.data + i) ^= cipher_out[i];
716 } else {
717 if (lle->llme->algo != GPRS_ALGO_GEA0) {
718 LOGP(DLLC, LOGL_NOTICE, "unencrypted frame for LLC "
719 "that is supposed to be encrypted. Dropping.\n");
720 return 0;
721 }
722 }
723
724 /* We have to do the FCS check _after_ decryption */
Harald Welte1b8827a2010-06-30 23:15:57 +0200725 llhp.fcs_calc = gprs_llc_fcs((uint8_t *)lh, llhp.crc_length);
Harald Welted07b4f92010-06-30 23:07:59 +0200726 if (llhp.fcs != llhp.fcs_calc) {
727 LOGP(DLLC, LOGL_INFO, "Dropping frame with invalid FCS\n");
728 return -EIO;
729 }
730
Harald Welte10997d02010-05-03 12:28:12 +0200731 /* Update LLE's (BVCI, NSEI) tuple */
Harald Welte807a5d82010-06-01 11:53:01 +0200732 lle->llme->bvci = msgb_bvci(msg);
733 lle->llme->nsei = msgb_nsei(msg);
Harald Welte10997d02010-05-03 12:28:12 +0200734
Harald Welte1ae09c72010-05-13 19:22:55 +0200735 /* Receive and Process the actual LLC frame */
Harald Welte9b455bf2010-03-14 15:45:01 +0800736 rc = gprs_llc_hdr_rx(&llhp, lle);
Harald Welte1ae09c72010-05-13 19:22:55 +0200737 if (rc < 0)
738 return rc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800739
Harald Welte1ae09c72010-05-13 19:22:55 +0200740 /* llhp.data is only set when we need to send LL_[UNIT]DATA_IND up */
Harald Welte9b455bf2010-03-14 15:45:01 +0800741 if (llhp.data) {
Harald Welte943c5bc2010-04-30 16:33:12 +0200742 msgb_gmmh(msg) = llhp.data;
Harald Welte9b455bf2010-03-14 15:45:01 +0800743 switch (llhp.sapi) {
744 case GPRS_SAPI_GMM:
Harald Welte1ae09c72010-05-13 19:22:55 +0200745 /* send LL_UNITDATA_IND to GMM */
Harald Welte807a5d82010-06-01 11:53:01 +0200746 rc = gsm0408_gprs_rcvmsg(msg, lle->llme);
Harald Weltea2665542010-05-02 09:28:11 +0200747 break;
Harald Weltea2665542010-05-02 09:28:11 +0200748 case GPRS_SAPI_SNDCP3:
749 case GPRS_SAPI_SNDCP5:
750 case GPRS_SAPI_SNDCP9:
751 case GPRS_SAPI_SNDCP11:
Harald Welteebabdea2010-06-01 18:28:10 +0200752 /* send LL_DATA_IND/LL_UNITDATA_IND to SNDCP */
753 rc = sndcp_llunitdata_ind(msg, lle, llhp.data, llhp.data_len);
754 break;
Harald Weltea2665542010-05-02 09:28:11 +0200755 case GPRS_SAPI_SMS:
756 /* FIXME */
Harald Welteebabdea2010-06-01 18:28:10 +0200757 case GPRS_SAPI_TOM2:
758 case GPRS_SAPI_TOM8:
759 /* FIXME: send LL_DATA_IND/LL_UNITDATA_IND to TOM */
Harald Weltea2665542010-05-02 09:28:11 +0200760 default:
Harald Weltec6ecafe2010-05-13 19:47:50 +0200761 LOGP(DLLC, LOGL_NOTICE, "Unsupported SAPI %u\n", llhp.sapi);
Harald Weltea2665542010-05-02 09:28:11 +0200762 rc = -EINVAL;
763 break;
Harald Welte9b455bf2010-03-14 15:45:01 +0800764 }
765 }
766
Harald Weltea2665542010-05-02 09:28:11 +0200767 return rc;
Harald Welte9b455bf2010-03-14 15:45:01 +0800768}
Harald Welte807a5d82010-06-01 11:53:01 +0200769
770/* 04.64 Chapter 7.2.1.1 LLGMM-ASSIGN */
771int gprs_llgmm_assign(struct gprs_llc_llme *llme,
772 uint32_t old_tlli, uint32_t new_tlli,
773 enum gprs_ciph_algo alg, const uint8_t *kc)
774{
775 unsigned int i;
776
Harald Welted07b4f92010-06-30 23:07:59 +0200777 /* Update the crypto parameters */
Harald Welted07b4f92010-06-30 23:07:59 +0200778 llme->algo = alg;
Harald Welte3e2e1592010-06-30 23:19:23 +0200779 if (alg != GPRS_ALGO_GEA0)
780 memcpy(llme->kc, kc, sizeof(llme->kc));
Harald Welted07b4f92010-06-30 23:07:59 +0200781
Harald Welte807a5d82010-06-01 11:53:01 +0200782 if (old_tlli == 0xffffffff && new_tlli != 0xffffffff) {
783 /* TLLI Assignment 8.3.1 */
784 /* New TLLI shall be assigned and used when (re)transmitting LLC frames */
785 /* If old TLLI != 0xffffffff was assigned to LLME, then TLLI
786 * old is unassigned. Only TLLI new shall be accepted when
787 * received from peer. */
Harald Welte875840c2010-07-01 11:54:31 +0200788 if (llme->old_tlli != 0xffffffff) {
789 llme->old_tlli = 0xffffffff;
790 llme->tlli = new_tlli;
791 } else {
792 /* If TLLI old == 0xffffffff was assigned to LLME, then this is
793 * TLLI assignmemt according to 8.3.1 */
794 llme->old_tlli = 0xffffffff;
795 llme->tlli = new_tlli;
796 llme->state = GPRS_LLMS_ASSIGNED;
797 /* 8.5.3.1 For all LLE's */
798 for (i = 0; i < ARRAY_SIZE(llme->lle); i++) {
799 struct gprs_llc_lle *l = &llme->lle[i];
800 l->vu_send = l->vu_recv = 0;
801 l->retrans_ctr = 0;
802 l->state = GPRS_LLES_ASSIGNED_ADM;
803 /* FIXME Set parameters according to table 9 */
804 }
Harald Welte807a5d82010-06-01 11:53:01 +0200805 }
806 } else if (old_tlli != 0xffffffff && new_tlli != 0xffffffff) {
807 /* TLLI Change 8.3.2 */
808 /* Both TLLI Old and TLLI New are assigned; use New when
809 * (re)transmitting. Accept toth Old and New on Rx */
810 llme->old_tlli = llme->tlli;
811 llme->tlli = new_tlli;
812 llme->state = GPRS_LLMS_ASSIGNED;
813 } else if (old_tlli != 0xffffffff && new_tlli == 0xffffffff) {
814 /* TLLI Unassignment 8.3.3) */
815 llme->tlli = llme->old_tlli = 0;
816 llme->state = GPRS_LLMS_UNASSIGNED;
817 for (i = 0; i < ARRAY_SIZE(llme->lle); i++) {
818 struct gprs_llc_lle *l = &llme->lle[i];
819 l->state = GPRS_LLES_UNASSIGNED;
820 }
Harald Weltef7fef482010-06-28 22:18:26 +0200821 llme_free(llme);
Harald Welte807a5d82010-06-01 11:53:01 +0200822 } else
823 return -EINVAL;
824
825 return 0;
826}
Harald Welte496aee42010-06-30 19:59:55 +0200827
828int gprs_llc_init(const char *cipher_plugin_path)
829{
830 return gprs_cipher_load(cipher_plugin_path);
831}