layer23: Move subscriber.{c,h} under common/

 Some of those can be reused by other apps (like modem).

Change-Id: I3727e40bcc9a4ee93aaf2c4ced070cc789653e80

3 files changed, 121 insertions, 1 deletions

diff --git a/src/host/layer23/include/osmocom/bb/common/Makefile.am b/src/host/layer23/include/osmocom/bb/common/Makefile.am
index 54799bea..f09353bb 100644
--- a/src/host/layer23/include/osmocom/bb/common/Makefile.am
+++ b/src/host/layer23/include/osmocom/bb/common/Makefile.am
@@ -13,6 +13,7 @@ noinst_HEADERS = \
 	sap_fsm.h \
 	sap_interface.h \
 	sim.h \
+	subscriber.h \
 	support.h \
 	vty.h \
 	$(NULL)
diff --git a/src/host/layer23/include/osmocom/bb/common/ms.h b/src/host/layer23/include/osmocom/bb/common/ms.h
index 3a162937..db6b276a 100644
--- a/src/host/layer23/include/osmocom/bb/common/ms.h
+++ b/src/host/layer23/include/osmocom/bb/common/ms.h
@@ -7,8 +7,8 @@
 
 /* FIXME no 'mobile' specific stuff should be here */
 #include <osmocom/bb/mobile/settings.h>
-#include <osmocom/bb/mobile/subscriber.h>
 #include <osmocom/gsm/lapdm.h>
+#include <osmocom/bb/common/subscriber.h>
 #include <osmocom/bb/common/support.h>
 #include <osmocom/bb/common/sap_interface.h>
 #include <osmocom/bb/common/sap_proto.h>
diff --git a/src/host/layer23/include/osmocom/bb/common/subscriber.h b/src/host/layer23/include/osmocom/bb/common/subscriber.h
new file mode 100644
index 00000000..698b0fdc
--- /dev/null
+++ b/src/host/layer23/include/osmocom/bb/common/subscriber.h
@@ -0,0 +1,119 @@
+#ifndef _SUBSCRIBER_H
+#define _SUBSCRIBER_H
+
+/* GSM 04.08 4.1.2.2 SIM update status */
+#define GSM_SIM_U0_NULL		0
+#define GSM_SIM_U1_UPDATED	1
+#define GSM_SIM_U2_NOT_UPDATED	2
+#define GSM_SIM_U3_ROAMING_NA	3
+
+struct gsm_sub_plmn_list {
+	struct llist_head	entry;
+	uint16_t		mcc, mnc;
+};
+
+struct gsm_sub_plmn_na {
+	struct llist_head	entry;
+	uint16_t		mcc, mnc;
+	uint8_t			cause;
+};
+
+#define GSM_IMSI_LENGTH		16
+
+#define GSM_SIM_IS_READER(type) \
+	(type == GSM_SIM_TYPE_L1PHY || type == GSM_SIM_TYPE_SAP)
+
+enum {
+	GSM_SIM_TYPE_NONE = 0,
+	GSM_SIM_TYPE_L1PHY,
+	GSM_SIM_TYPE_TEST,
+	GSM_SIM_TYPE_SAP
+};
+
+struct gsm_subscriber {
+	struct osmocom_ms	*ms;
+
+	/* status */
+	uint8_t			sim_type; /* type of sim */
+	uint8_t			sim_valid; /* sim inserted and valid */
+	uint8_t			ustate; /* update status */
+	uint8_t			imsi_attached; /* attached state */
+
+	/* IMSI & co */
+	char 			imsi[GSM_IMSI_LENGTH];
+	char 			msisdn[31]; /* may include access codes */
+	char 			iccid[21]; /* 20 + termination */
+
+	/* TMSI / LAI */
+	uint32_t		tmsi; /* invalid tmsi: 0xffffffff */
+	uint16_t		mcc, mnc, lac; /* invalid lac: 0x0000 */
+
+
+	/* key */
+	uint8_t			key_seq; /* ciphering key sequence number */
+	uint8_t			key[8]; /* 64 bit */
+
+	/* other */
+	struct llist_head	plmn_list; /* PLMN Selector field */
+	struct llist_head	plmn_na; /* not allowed PLMNs */
+	uint8_t			t6m_hplmn; /* timer for hplmn search */
+
+	/* special things */
+	uint8_t			always_search_hplmn;
+		/* search hplmn in other countries also (for test cards) */
+	uint8_t			any_timeout;
+		/* timer to restart 'any cell selection' */
+	char			sim_name[31]; /* name to load/save sim */
+	char			sim_spn[17]; /* name of service privider */
+
+	/* PLMN last registered */
+	uint8_t			plmn_valid;
+	uint16_t		plmn_mcc, plmn_mnc;
+
+	/* our access */
+	uint8_t			acc_barr; /* if we may access, if cell barred */
+	uint16_t		acc_class; /* bitmask of what we may access */
+
+	/* talk to SIM */
+	uint8_t			sim_state;
+	uint8_t			sim_pin_required; /* state: wait for PIN */
+	uint8_t			sim_file_index;
+	uint32_t		sim_handle_query;
+	uint32_t		sim_handle_update;
+	uint32_t		sim_handle_key;
+
+	/* SMS */
+	char			sms_sca[22];
+};
+
+int gsm_subscr_init(struct osmocom_ms *ms);
+int gsm_subscr_exit(struct osmocom_ms *ms);
+int gsm_subscr_testcard(struct osmocom_ms *ms, uint16_t mcc, uint16_t mnc,
+	uint16_t lac, uint32_t tmsi, uint8_t imsi_attached);
+int gsm_subscr_sap_rsp_cb(struct osmocom_ms *ms, int res_code,
+	uint8_t res_type, uint16_t param_len, const uint8_t *param_val);
+int gsm_subscr_sapcard(struct osmocom_ms *ms);
+int gsm_subscr_remove_sapcard(struct osmocom_ms *ms);
+int gsm_subscr_simcard(struct osmocom_ms *ms);
+void gsm_subscr_sim_pin(struct osmocom_ms *ms, char *pin1, char *pin2,
+	int8_t mode);
+int gsm_subscr_write_loci(struct osmocom_ms *ms);
+int gsm_subscr_generate_kc(struct osmocom_ms *ms, uint8_t key_seq,
+	uint8_t *rand, uint8_t no_sim);
+int gsm_subscr_remove(struct osmocom_ms *ms);
+void new_sim_ustate(struct gsm_subscriber *subscr, int state);
+int gsm_subscr_del_forbidden_plmn(struct gsm_subscriber *subscr, uint16_t mcc,
+	uint16_t mnc);
+int gsm_subscr_add_forbidden_plmn(struct gsm_subscriber *subscr, uint16_t mcc,
+					uint16_t mnc, uint8_t cause);
+int gsm_subscr_is_forbidden_plmn(struct gsm_subscriber *subscr, uint16_t mcc,
+					uint16_t mnc);
+int gsm_subscr_dump_forbidden_plmn(struct osmocom_ms *ms,
+			void (*print)(void *, const char *, ...), void *priv);
+void gsm_subscr_dump(struct gsm_subscriber *subscr,
+			void (*print)(void *, const char *, ...), void *priv);
+char *gsm_check_imsi(const char *imsi);
+int gsm_subscr_get_key_seq(struct osmocom_ms *ms, struct gsm_subscriber *subscr);
+
+#endif /* _SUBSCRIBER_H */
+