summaryrefslogtreecommitdiffstats
path: root/src/host/layer23/src/modem/gmm.c
blob: c0e6936886e278b8f366d404fdc02e88368d1a09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/* GPRS GMM interfaces as per 3GPP TS 24.008, TS 24.007 */
/* (C) 2023 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
 * All Rights Reserved
 * Author: Pau Espin Pedrol <pespin@sysmocom.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/lienses/>.
 *
 */

#include <stdbool.h>
#include <string.h>
#include <stdint.h>
#include <errno.h>
#include <stdio.h>

#include <osmocom/core/msgb.h>
#include <osmocom/core/prim.h>
#include <osmocom/core/utils.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/talloc.h>
#include <osmocom/core/tun.h>
#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>

#include <osmocom/gprs/llc/llc.h>
#include <osmocom/gprs/llc/llc_prim.h>
#include <osmocom/gprs/gmm/gmm_prim.h>
#include <osmocom/gprs/gmm/gmm.h>
#include <osmocom/gprs/rlcmac/rlcmac_prim.h>
#include <osmocom/gprs/sm/sm_prim.h>

#include <osmocom/bb/common/settings.h>
#include <osmocom/bb/common/logging.h>
#include <osmocom/bb/common/apn.h>
#include <osmocom/bb/common/ms.h>
#include <osmocom/bb/common/vty.h>
#include <osmocom/bb/modem/gmm.h>
#include <osmocom/bb/modem/sm.h>
#include <osmocom/bb/modem/modem.h>

static int modem_gmm_prim_up_cb(struct osmo_gprs_gmm_prim *gmm_prim, void *user_data)
{
	const char *pdu_name = osmo_gprs_gmm_prim_name(gmm_prim);
	struct osmocom_ms *ms = user_data;
	struct osmobb_apn *apn;
	int rc = 0;

	switch (gmm_prim->oph.sap) {
	case OSMO_GPRS_GMM_SAP_GMMREG:
		switch (OSMO_PRIM_HDR(&gmm_prim->oph)) {
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMREG_ATTACH, PRIM_OP_CONFIRM):
			if (gmm_prim->gmmreg.attach_cnf.accepted) {
				LOGP(DGMM, LOGL_NOTICE, "%s(): Rx %s: Attach success P-TMSI=0x%08x TLLI=0x%08x\n",
				     __func__, pdu_name, gmm_prim->gmmreg.attach_cnf.acc.allocated_ptmsi,
				     gmm_prim->gmmreg.attach_cnf.acc.allocated_tlli);
				ms->subscr.gprs.ptmsi = gmm_prim->gmmreg.attach_cnf.acc.allocated_ptmsi;
				ms->gmmlayer.tlli = gmm_prim->gmmreg.attach_cnf.acc.allocated_tlli;
				app_data.modem_state = MODEM_ST_ATTACHED;
				/* Activate APN if not yet already: */
				llist_for_each_entry(apn, &ms->gprs.apn_list, list) {
					if (apn->fsm.fi->state != APN_ST_INACTIVE)
						continue;
					osmo_fsm_inst_dispatch(apn->fsm.fi, APN_EV_GMM_ATTACHED, NULL);
					modem_sm_smreg_pdp_act_req(ms, apn);
				}
			} else {
				uint8_t cause = gmm_prim->gmmreg.attach_cnf.rej.cause;
				LOGP(DGMM, LOGL_ERROR, "%s(): Rx %s: Attach rejected, cause=%u (%s)\n",
				     __func__, pdu_name, cause, get_value_string(gsm48_gmm_cause_names, cause));
				app_data.modem_state = MODEM_ST_IDLE;
				modem_gprs_attach_if_needed(ms);
			}
			break;
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMREG_SIM_AUTH, PRIM_OP_INDICATION):
			LOGP(DGMM, LOGL_NOTICE, "%s(): Rx %s ac_ref_nr=%u key_seq=%u rand=%s\n",
			     __func__, pdu_name,
			     gmm_prim->gmmreg.sim_auth_ind.ac_ref_nr,
			     gmm_prim->gmmreg.sim_auth_ind.key_seq,
			     osmo_hexdump(gmm_prim->gmmreg.sim_auth_ind.rand,
					  sizeof(gmm_prim->gmmreg.sim_auth_ind.rand)));
			/* Cache request information, it'll be needed during response time: */
			ms->gmmlayer.ac_ref_nr = gmm_prim->gmmreg.sim_auth_ind.ac_ref_nr;
			ms->gmmlayer.key_seq = gmm_prim->gmmreg.sim_auth_ind.key_seq;
			memcpy(ms->gmmlayer.rand, gmm_prim->gmmreg.sim_auth_ind.rand,
			       sizeof(ms->gmmlayer.rand));
			/* Request SIM to authenticate. Wait for signal S_L23_SUBSCR_SIM_AUTH_RESP. */
			rc = gsm_subscr_generate_kc(ms, gmm_prim->gmmreg.sim_auth_ind.key_seq,
						    gmm_prim->gmmreg.sim_auth_ind.rand, false);
			break;
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMREG_DETACH, PRIM_OP_CONFIRM):
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMREG_DETACH, PRIM_OP_INDICATION):
			LOGP(DGMM, LOGL_NOTICE, "%s(): Rx %s\n", __func__, pdu_name);
			ms_dispatch_all_apn(ms, APN_EV_GMM_DETACHED, NULL);
			break;
		default:
			LOGP(DGMM, LOGL_ERROR, "%s(): Rx %s UNIMPLEMENTED\n", __func__, pdu_name);
			break;
		};
		break;
	case OSMO_GPRS_GMM_SAP_GMMSM:
		switch (OSMO_PRIM_HDR(&gmm_prim->oph)) {
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMSM_ESTABLISH, PRIM_OP_CONFIRM):
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMSM_RELEASE,   PRIM_OP_INDICATION):
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMSM_UNITDATA,  PRIM_OP_INDICATION):
		case OSMO_PRIM(OSMO_GPRS_GMM_GMMSM_MODIFY,    PRIM_OP_INDICATION):
			osmo_gprs_sm_prim_gmm_lower_up(gmm_prim);
			rc = 1; /* Tell RLCMAC that we take ownership of the prim. */
			break;
		default:
			LOGP(DGMM, LOGL_ERROR, "%s(): Rx %s UNIMPLEMENTED\n", __func__, pdu_name);
			break;
		};
		break;
	default:
		LOGP(DGMM, LOGL_ERROR, "%s(): Unexpected Rx %s\n", __func__, pdu_name);
		OSMO_ASSERT(0);
	}

	return rc;
}

static int modem_gmm_prim_down_cb(struct osmo_gprs_gmm_prim *gmm_prim, void *user_data)
{
	const char *pdu_name = osmo_gprs_gmm_prim_name(gmm_prim);
	int rc = 0;
	uint32_t old_tlli, new_tlli;
	struct osmocom_ms *ms, *ms_found = NULL;

	osmo_static_assert(sizeof(struct osmo_gprs_gmm_gmmrr_prim) == sizeof(struct osmo_gprs_rlcmac_gmmrr_prim),
			   _gmmrr_prim_size);

	switch (gmm_prim->oph.sap) {
	case OSMO_GPRS_GMM_SAP_GMMRR:
		OSMO_ASSERT(gmm_prim->oph.primitive == OSMO_GPRS_GMM_GMMRR_ASSIGN);
		/* Update app TLLI reference. This usually happens as a result of a RAU ACCEPT */
		old_tlli = gmm_prim->gmmrr.tlli;
		new_tlli = gmm_prim->gmmrr.assign_req.new_tlli;
		llist_for_each_entry(ms, &ms_list, entity) {
			if (old_tlli != ms->gmmlayer.tlli)
				continue;
			ms_found = ms;
			break;
		}
		if (ms_found) {
			if (new_tlli != OSMO_GPRS_GMM_TLLI_UNASSIGNED) {
				LOGP(DGMM, LOGL_INFO, "%s(): Rx %s Update TLLI 0x%08x -> 0x%08x\n",
				     __func__, pdu_name, old_tlli, new_tlli);
				ms_found->gmmlayer.tlli = new_tlli;
			} else {
				LOGP(DGMM, LOGL_ERROR, "%s(): Rx %s with TLLI=0x%08x is being released, GMM should be restarted?\n",
				     __func__, pdu_name, old_tlli);
			}
		} else {
			if (old_tlli != OSMO_GPRS_GMM_TLLI_UNASSIGNED)
				LOGP(DGMM, LOGL_NOTICE, "%s(): Rx %s with unknown TLLI=0x%08x, probably the MS is still attaching\n",
				     __func__, pdu_name, old_tlli);
		}

		/* Forward it to lower layers, pass ownership over to RLCMAC: */
		/* Optimization: GMM-GMMRR-ASSIGN-REQ is 1-to-1 ABI compatible with
				 RLCMAC-GMMRR-ASSIGN-REQ, we just need to adapt the header.
				 See osmo_static_assert(_gmmrr_prim_size) above.
		*/
		gmm_prim->oph.sap = OSMO_GPRS_RLCMAC_SAP_GMMRR;
		gmm_prim->oph.primitive = OSMO_GPRS_RLCMAC_GMMRR_ASSIGN;
		osmo_gprs_rlcmac_prim_upper_down((struct osmo_gprs_rlcmac_prim *)gmm_prim);
		rc = 1; /* Tell GMM that we take ownership of the prim. */
		break;
	case OSMO_GPRS_GMM_SAP_GMMREG:
	default:
		LOGP(DGMM, LOGL_ERROR, "%s(): Unexpected Rx %s\n", __func__, pdu_name);
		OSMO_ASSERT(0);
	}

	return rc;
}

static int modem_gmm_prim_llc_down_cb(struct osmo_gprs_llc_prim *llc_prim, void *user_data)
{
	int rc;

	rc = osmo_gprs_llc_prim_upper_down(llc_prim);

	/* LLC took ownership of the message, tell GMM layer to not free it: */
	rc = 1;
	return rc;
}

int modem_gmm_init(struct osmocom_ms *ms)
{
	int rc;
	rc = osmo_gprs_gmm_init(OSMO_GPRS_GMM_LOCATION_MS);
	if (rc != 0)
		return rc;

	osmo_gprs_gmm_set_log_cat(OSMO_GPRS_GMM_LOGC_GMM, DGMM);

	osmo_gprs_gmm_prim_set_up_cb(modem_gmm_prim_up_cb, ms);
	osmo_gprs_gmm_prim_set_down_cb(modem_gmm_prim_down_cb, ms);
	osmo_gprs_gmm_prim_set_llc_down_cb(modem_gmm_prim_llc_down_cb, ms);

	osmo_gprs_gmm_enable_gprs(true);
	return rc;
}

int modem_gmm_gmmreg_attach_req(const struct osmocom_ms *ms)
{
	struct osmo_gprs_gmm_prim *gmm_prim;
	const struct gsm_subscriber *subscr = &ms->subscr;
	int rc;

	gmm_prim = osmo_gprs_gmm_prim_alloc_gmmreg_attach_req();
	gmm_prim->gmmreg.attach_req.attach_type = OSMO_GPRS_GMM_ATTACH_TYPE_GPRS;
	gmm_prim->gmmreg.attach_req.ptmsi = subscr->gprs.ptmsi;
	gmm_prim->gmmreg.attach_req.ptmsi_sig = subscr->gprs.ptmsi_sig;
	gmm_prim->gmmreg.attach_req.attach_with_imsi = (subscr->gprs.ptmsi == GSM_RESERVED_TMSI);
	memcpy(gmm_prim->gmmreg.attach_req.imsi, subscr->imsi, ARRAY_SIZE(subscr->imsi));
	memcpy(gmm_prim->gmmreg.attach_req.imei, ms->settings.imei, ARRAY_SIZE(ms->settings.imei));
	memcpy(gmm_prim->gmmreg.attach_req.imeisv, ms->settings.imeisv, ARRAY_SIZE(ms->settings.imeisv));
	memcpy(&gmm_prim->gmmreg.attach_req.old_rai, &subscr->gprs.rai, sizeof(subscr->gprs.rai));
	rc = osmo_gprs_gmm_prim_upper_down(gmm_prim);
	if (rc < 0)
		LOGP(DMM, LOGL_ERROR, "Failed submitting GMMREG-ATTACH.req\n");
	return rc;
}

int modem_gmm_gmmreg_detach_req(const struct osmocom_ms *ms)
{
	struct osmo_gprs_gmm_prim *gmm_prim;
	const struct gsm_subscriber *subscr = &ms->subscr;
	int rc;

	gmm_prim = osmo_gprs_gmm_prim_alloc_gmmreg_detach_req();
	gmm_prim->gmmreg.detach_req.ptmsi = subscr->gprs.ptmsi;
	gmm_prim->gmmreg.detach_req.detach_type = OSMO_GPRS_GMM_DETACH_MS_TYPE_GPRS;
	gmm_prim->gmmreg.detach_req.poweroff_type = OSMO_GPRS_GMM_DETACH_POWEROFF_TYPE_NORMAL;
	rc = osmo_gprs_gmm_prim_upper_down(gmm_prim);
	if (rc < 0)
		LOGP(DMM, LOGL_ERROR, "Failed submitting GMMREG-DETACH.req\n");
	return rc;
}

int modem_gmm_gmmreg_sim_auth_rsp(const struct osmocom_ms *ms, uint8_t *sres, uint8_t *kc, uint8_t kc_len)
{
	struct osmo_gprs_gmm_prim *gmm_prim;
	int rc;

	gmm_prim = osmo_gprs_gmm_prim_alloc_gmmreg_sim_auth_rsp();
	gmm_prim->gmmreg.sim_auth_rsp.ac_ref_nr = ms->gmmlayer.ac_ref_nr;
	gmm_prim->gmmreg.sim_auth_rsp.key_seq = ms->gmmlayer.key_seq;
	memcpy(gmm_prim->gmmreg.sim_auth_rsp.rand, ms->gmmlayer.rand,
	       sizeof(gmm_prim->gmmreg.sim_auth_rsp.rand));
	memcpy(gmm_prim->gmmreg.sim_auth_rsp.sres, sres,
	       sizeof(gmm_prim->gmmreg.sim_auth_rsp.sres));
	memcpy(gmm_prim->gmmreg.sim_auth_rsp.kc, kc,
	       kc_len);
	rc = osmo_gprs_gmm_prim_upper_down(gmm_prim);
	if (rc < 0)
		LOGP(DMM, LOGL_ERROR, "Failed submitting GMMREG-SIM_AUTH.rsp\n");
	return rc;
}