libosmogsm  1.6.0.113-b17c
Osmocom GSM library
gsm48.h
Go to the documentation of this file.
1 
3 #pragma once
4 
5 #include <stdbool.h>
6 
7 #include <osmocom/core/defs.h>
8 #include <osmocom/core/msgb.h>
9 
10 #include <osmocom/gsm/tlv.h>
13 #include <osmocom/gsm/gsm48_ie.h>
14 #include <osmocom/gsm/gsm23003.h>
15 
16 /* reserved according to GSM 03.03 § 2.4 */
17 #define GSM_RESERVED_TMSI 0xFFFFFFFF
18 
19 /* Valid MCC and MNC range from 0 to 999.
20  * To mark an invalid / unset MNC, this value shall be used. */
21 #define GSM_MCC_MNC_INVALID 0xFFFF
22 
23 /* A parsed GPRS routing area */
24 struct gprs_ra_id {
25  uint16_t mcc;
26  uint16_t mnc;
28  uint16_t lac;
29  uint8_t rac;
30 };
31 
32 extern const struct tlv_definition gsm48_att_tlvdef;
33 extern const struct tlv_definition gsm48_rr_att_tlvdef;
34 extern const struct tlv_definition gsm48_mm_att_tlvdef;
35 const char *gsm48_cc_state_name(uint8_t state);
36 const char *gsm48_cc_msg_name(uint8_t msgtype);
37 const char *gsm48_rr_msg_name(uint8_t msgtype);
38 const char *rr_cause_name(uint8_t cause);
39 const char *osmo_rai_name(const struct gprs_ra_id *rai);
40 char *osmo_rai_name_buf(char *buf, size_t buf_len, const struct gprs_ra_id *rai);
41 char *osmo_rai_name_c(const void *ctx, const struct gprs_ra_id *rai);
42 
43 int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
44  uint16_t *mnc, uint16_t *lac)
45  OSMO_DEPRECATED("Use gsm48_decode_lai2() instead, to not lose leading zeros in the MNC");
46 void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded);
47 void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
48  uint16_t mnc, uint16_t lac)
49  OSMO_DEPRECATED("Use gsm48_generate_lai2() instead, to not lose leading zeros in the MNC");
50 void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai);
51 
52 #define GSM48_MID_MAX_SIZE 11
53 int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
54  OSMO_DEPRECATED_OUTSIDE("Instead use: l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);"
55  " *l = osmo_mobile_identity_encode_msgb(...)");
56 int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
57  OSMO_DEPRECATED_OUTSIDE("Instead use: l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);"
58  " *l = osmo_mobile_identity_encode_msgb(...)");
59 uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
60  OSMO_DEPRECATED_OUTSIDE("Instead use: l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);"
61  " *l = osmo_mobile_identity_encode_msgb(...)");
62 
63 const char *gsm48_mi_type_name(uint8_t mi);
64 /* Convert encoded Mobile Identity (10.5.1.4) to string */
65 int gsm48_mi_to_string(char *string, int str_len, const uint8_t *mi, int mi_len)
66  OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_decode()");
67 const char *osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
68  OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_to_str_c()");
69 char *osmo_mi_name_buf(char *buf, size_t buf_len, const uint8_t *mi, uint8_t mi_len)
70  OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_to_str_buf()");
71 char *osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len)
72  OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_to_str_c()");
73 
76 struct osmo_mobile_identity {
78  uint8_t type;
81  union {
83  char imsi[GSM23003_IMSI_MAX_DIGITS + 1];
85  char imei[GSM23003_IMEI_NUM_DIGITS + 1];
87  char imeisv[GSM23003_IMEISV_NUM_DIGITS + 1];
89  uint32_t tmsi;
90  };
91 };
92 
93 int osmo_mobile_identity_to_str_buf(char *buf, size_t buflen, const struct osmo_mobile_identity *mi);
94 char *osmo_mobile_identity_to_str_c(void *ctx, const struct osmo_mobile_identity *mi);
95 int osmo_mobile_identity_cmp(const struct osmo_mobile_identity *a, const struct osmo_mobile_identity *b);
96 int osmo_mobile_identity_decode(struct osmo_mobile_identity *mi, const uint8_t *mi_data, uint8_t mi_len,
97  bool allow_hex);
98 int osmo_mobile_identity_decode_from_l3(struct osmo_mobile_identity *mi, struct msgb *msg, bool allow_hex);
99 int osmo_mobile_identity_encoded_len(const struct osmo_mobile_identity *mi, int *mi_digits);
100 int osmo_mobile_identity_encode_buf(uint8_t *buf, size_t buflen, const struct osmo_mobile_identity *mi, bool allow_hex);
101 int osmo_mobile_identity_encode_msgb(struct msgb *msg, const struct osmo_mobile_identity *mi, bool allow_hex);
102 
103 /* Parse Routeing Area Identifier */
104 void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf);
105 void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid);
106 int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid) OSMO_DEPRECATED("Use gsm48_encode_ra() instead");
107 bool gsm48_ra_equal(const struct gprs_ra_id *raid1, const struct gprs_ra_id *raid2);
108 
110 
111 void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
112  OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead, to not lose leading zeros in the MNC");
113 void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
114  OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead, to not lose leading zeros in the MNC");
115 
116 struct gsm48_hdr *gsm48_push_l3hdr(struct msgb *msg,
117  uint8_t pdisc, uint8_t msg_type);
118 
119 #define gsm48_push_l3hdr_tid(msg, pdisc, tid, msg_type) \
120  gsm48_push_l3hdr(msg, (pdisc & 0x0f) | (tid << 4), msg_type)
121 
void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
Parse TS 04.08 Routing Area Identifier.
Definition: gsm48.c:1283
uint8_t msg_type
Definition: gsm_04_08.h:768
uint8_t mi[0]
Definition: gsm_04_08.h:768
Definition: gsm_04_08.h:901
uint8_t rac
Definition: gsm48.h:29
char * osmo_mobile_identity_to_str_c(void *ctx, const struct osmo_mobile_identity *mi)
Like osmo_mobile_identity_to_str_buf(), but return the string in a talloc buffer. ...
Definition: gsm48.c:979
uint8_t type
Definition: gsm_08_08.h:471
#define OSMO_DEPRECATED(text)
int osmo_mobile_identity_to_str_buf(char *buf, size_t buflen, const struct osmo_mobile_identity *mi)
Return a human readable representation of a struct osmo_mobile_identity.
Definition: gsm48.c:949
gsm48_chan_mode
Definition: gsm_04_08.h:749
int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1173
bool gsm48_ra_equal(const struct gprs_ra_id *raid1, const struct gprs_ra_id *raid2)
Compare a TS 04.08 Routing Area Identifier.
Definition: gsm48.c:1342
#define GSM23003_IMSI_MAX_DIGITS
Definition: gsm_23_003.h:6
const char * gsm48_rr_msg_name(uint8_t msgtype)
return string representation of RR Message Type
Definition: gsm48.c:417
int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc, uint16_t *mnc, uint16_t *lac) OSMO_DEPRECATED("Use gsm48_decode_lai2() instead
int osmo_mobile_identity_encode_msgb(struct msgb *msg, const struct osmo_mobile_identity *mi, bool allow_hex)
Encode Mobile Identity type and BCD digits, appended to a msgb.
Definition: gsm48.c:811
char * osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:565
uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1191
int osmo_mobile_identity_encode_buf(uint8_t *buf, size_t buflen, const struct osmo_mobile_identity *mi, bool allow_hex)
Encode Mobile Identity from uint32_t (TMSI) or digits string (all others) (3GPP TS 24...
Definition: gsm48.c:749
char * osmo_rai_name_buf(char *buf, size_t buf_len, const struct gprs_ra_id *rai)
Return MCC-MNC-LAC-RAC as string, in a caller-provided output buffer.
Definition: gsm48.c:193
uint8_t cause
Definition: gsm_04_08.h:768
int to not lose leading zeros in the MNC
Definition: gsm48.h:45
const struct tlv_definition gsm48_mm_att_tlvdef
TLV parser definitions for TS 04.08 MM.
Definition: gsm48.c:140
int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
Encode a TS 04.08 Routing Area Identifier.
Definition: gsm48.c:1331
Definition: gsm48.h:24
enum gsm48_chan_mode gsm48_chan_mode_to_vamos(enum gsm48_chan_mode mode)
Translate GSM48_CMODE_SPEECH_* to its corresponding GSM48_CMODE_SPEECH_*_VAMOS mode.
Definition: gsm48.c:442
Definition: gsm_04_08.h:2114
bool mnc_3_digits
Definition: gsm48.h:27
int osmo_mobile_identity_encoded_len(const struct osmo_mobile_identity *mi, int *mi_digits)
Return the number of encoded Mobile Identity octets, without actually encoding.
Definition: gsm48.c:702
int gsm48_mi_to_string(char *string, int str_len, const uint8_t *mi, int mi_len)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1241
GSM TS 04.08 definitions.
const char * gsm48_mi_type_name(uint8_t mi)
return string representation of Mobile Identity Type
Definition: gsm48.c:500
uint8_t mi_len
Definition: gsm_04_08.h:767
int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1223
const char * osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:551
char * osmo_rai_name_c(const void *ctx, const struct gprs_ra_id *rai)
Return MCC-MNC-LAC-RAC as string, in dynamically-allocated output buffer.
Definition: gsm48.c:216
int osmo_mobile_identity_cmp(const struct osmo_mobile_identity *a, const struct osmo_mobile_identity *b)
Compare two osmo_mobile_identity structs, returning typical cmp() result.
Definition: gsm48.c:989
Definition: gsm_04_08.h:858
void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc, uint16_t mnc, uint16_t lac) OSMO_DEPRECATED("Use gsm48_generate_lai2() instead
const struct tlv_definition gsm48_rr_att_tlvdef
TLV parser definitions for TS 04.08 RR.
Definition: gsm48.c:94
enum gsm48_chan_mode gsm48_chan_mode_to_non_vamos(enum gsm48_chan_mode mode)
Translate GSM48_CMODE_SPEECH_*_VAMOS to its corresponding GSM48_CMODE_SPEECH_* non-vamos mode...
Definition: gsm48.c:464
struct gsm48_chan_desc chan_desc
Definition: gsm_04_08.h:689
void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded)
Decode TS 04.08 Location Area Identifier.
Definition: gsm48.c:1118
int osmo_mobile_identity_decode_from_l3(struct osmo_mobile_identity *mi, struct msgb *msg, bool allow_hex)
Extract Mobile Identity from a Complete Layer 3 message.
Definition: gsm48.c:830
int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
Determine number of paging sub-channels.
Definition: gsm48.c:1364
uint16_t lac
Definition: gsm48.h:28
Definition: gsm23003.h:16
#define OSMO_DEPRECATED_OUTSIDE(text)
const struct tlv_definition gsm48_att_tlvdef
TLV parser definitions for TS 04.08 CC.
Definition: gsm48.c:52
uint8_t mode
Definition: gsm_04_08.h:690
const char * rr_cause_name(uint8_t cause)
return string representation of RR Cause value
Definition: gsm48.c:182
const char * gsm48_cc_state_name(uint8_t state)
return string representation of CC State
Definition: gsm48.c:261
uint8_t msg[0]
Definition: gsm_08_08.h:529
const char * gsm48_cc_msg_name(uint8_t msgtype)
return string representation of CC Message Type
Definition: gsm48.c:309
void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc) OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead
Definition: gsm_04_08.h:938
uint16_t mcc
Definition: gsm48.h:25
int osmo_mobile_identity_decode(struct osmo_mobile_identity *mi, const uint8_t *mi_data, uint8_t mi_len, bool allow_hex)
Extract Mobile Identity from encoded bytes (3GPP TS 24.008 10.5.1.4).
Definition: gsm48.c:595
Definition of All 256 IE / TLV.
Definition: tlv.h:517
struct gsm48_loc_area_id lai
Definition: gsm_04_08.h:768
void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai)
Encode TS 04.08 Location Area Identifier.
Definition: gsm48.c:1087
uint16_t mnc
Definition: gsm48.h:26
#define GSM23003_IMEI_NUM_DIGITS
Definition: gsm_23_003.h:30
void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
Definition: gsm48.c:1043
_parse instead
Definition: ipa.h:30
#define GSM23003_IMEISV_NUM_DIGITS
Definition: gsm_23_003.h:32
struct gsm48_hdr * gsm48_push_l3hdr(struct msgb *msg, uint8_t pdisc, uint8_t msg_type)
Wrap a given msg with gsm48_hdr structure.
Definition: gsm48.c:1729
const char * osmo_rai_name(const struct gprs_ra_id *rai)
Return MCC-MNC-LAC-RAC as string, in a static buffer.
Definition: gsm48.c:205
char * osmo_mi_name_buf(char *buf, size_t buf_len, const uint8_t *mi, uint8_t mi_len)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:513
void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid)
Encode a 3GPP TS 24.008 § 10.5.5.15 Routing area identification.
Definition: gsm48.c:1310