libosmogsm 1.7.0.118-5c7e
Osmocom GSM library
Loading...
Searching...
No Matches
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>
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 */
24struct gprs_ra_id {
25 uint16_t mcc;
26 uint16_t mnc;
28 uint16_t lac;
29 uint8_t rac;
30};
31
32extern const struct tlv_definition gsm48_att_tlvdef;
33extern const struct tlv_definition gsm48_rr_att_tlvdef;
34extern const struct tlv_definition gsm48_mm_att_tlvdef;
35const char *gsm48_cc_state_name(uint8_t state);
36const char *gsm48_cc_msg_name(uint8_t msgtype);
37const char *gsm48_rr_msg_name(uint8_t msgtype);
38const char *gsm48_rr_short_pd_msg_name(uint8_t msgtype);
39const char *rr_cause_name(uint8_t cause);
40const char *osmo_rai_name(const struct gprs_ra_id *rai);
41char *osmo_rai_name_buf(char *buf, size_t buf_len, const struct gprs_ra_id *rai);
42char *osmo_rai_name_c(const void *ctx, const struct gprs_ra_id *rai);
43
44int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
45 uint16_t *mnc, uint16_t *lac)
46 OSMO_DEPRECATED("Use gsm48_decode_lai2() instead, to not lose leading zeros in the MNC");
47void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded);
48void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
49 uint16_t mnc, uint16_t lac)
50 OSMO_DEPRECATED("Use gsm48_generate_lai2() instead, to not lose leading zeros in the MNC");
51void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai);
52
53#define GSM48_MID_MAX_SIZE 11
54int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
55 OSMO_DEPRECATED_OUTSIDE("Instead use: l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);"
56 " *l = osmo_mobile_identity_encode_msgb(...)");
57int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
58 OSMO_DEPRECATED_OUTSIDE("Instead use: l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);"
59 " *l = osmo_mobile_identity_encode_msgb(...)");
60uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
61 OSMO_DEPRECATED_OUTSIDE("Instead use: l = msgb_tl_put(msg, GSM48_IE_MOBILE_ID);"
62 " *l = osmo_mobile_identity_encode_msgb(...)");
63
64const char *gsm48_mi_type_name(uint8_t mi);
65/* Convert encoded Mobile Identity (10.5.1.4) to string */
66int gsm48_mi_to_string(char *string, int str_len, const uint8_t *mi, int mi_len)
67 OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_decode()");
68const char *osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
69 OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_to_str_c()");
70char *osmo_mi_name_buf(char *buf, size_t buf_len, const uint8_t *mi, uint8_t mi_len)
71 OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_to_str_buf()");
72char *osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len)
73 OSMO_DEPRECATED_OUTSIDE("Instead use osmo_mobile_identity_to_str_c()");
74
77struct osmo_mobile_identity {
79 uint8_t type;
82 union {
84 char imsi[GSM23003_IMSI_MAX_DIGITS + 1];
86 char imei[GSM23003_IMEI_NUM_DIGITS + 1];
88 char imeisv[GSM23003_IMEISV_NUM_DIGITS + 1];
90 uint32_t tmsi;
91 };
92};
93
94int osmo_mobile_identity_to_str_buf(char *buf, size_t buflen, const struct osmo_mobile_identity *mi);
95char *osmo_mobile_identity_to_str_c(void *ctx, const struct osmo_mobile_identity *mi);
96int osmo_mobile_identity_cmp(const struct osmo_mobile_identity *a, const struct osmo_mobile_identity *b);
97int osmo_mobile_identity_decode(struct osmo_mobile_identity *mi, const uint8_t *mi_data, uint8_t mi_len,
98 bool allow_hex);
99int osmo_mobile_identity_decode_from_l3(struct osmo_mobile_identity *mi, struct msgb *msg, bool allow_hex);
100int osmo_mobile_identity_encoded_len(const struct osmo_mobile_identity *mi, int *mi_digits);
101int osmo_mobile_identity_encode_buf(uint8_t *buf, size_t buflen, const struct osmo_mobile_identity *mi, bool allow_hex);
102int osmo_mobile_identity_encode_msgb(struct msgb *msg, const struct osmo_mobile_identity *mi, bool allow_hex);
103
104/* Parse Routeing Area Identifier */
105void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf);
106void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid);
107int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid) OSMO_DEPRECATED("Use gsm48_encode_ra() instead");
108bool gsm48_ra_equal(const struct gprs_ra_id *raid1, const struct gprs_ra_id *raid2);
109
111
112void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
113 OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead, to not lose leading zeros in the MNC");
114void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
115 OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead, to not lose leading zeros in the MNC");
116
117struct gsm48_hdr *gsm48_push_l3hdr(struct msgb *msg,
118 uint8_t pdisc, uint8_t msg_type);
119
120#define gsm48_push_l3hdr_tid(msg, pdisc, tid, msg_type) \
121 gsm48_push_l3hdr(msg, (pdisc & 0x0f) | (tid << 4), msg_type)
122
const char * rr_cause_name(uint8_t cause)
return string representation of RR Cause value
Definition: gsm48.c:182
void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
Definition: gsm48.c:1066
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:834
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:972
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:536
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:1002
const char * gsm48_rr_msg_name(uint8_t msgtype)
return string representation of RR Message Type
Definition: gsm48.c:417
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:1012
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
const char * osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:574
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
const char * gsm48_mi_type_name(uint8_t mi)
return string representation of Mobile Identity Type
Definition: gsm48.c:523
int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1246
int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1196
void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
Parse TS 04.08 Routing Area Identifier.
Definition: gsm48.c:1306
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:1365
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:1333
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:772
const struct tlv_definition gsm48_rr_att_tlvdef
TLV parser definitions for TS 04.08 RR.
Definition: gsm48.c:94
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:1110
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:1141
const char * gsm48_rr_short_pd_msg_name(uint8_t msgtype)
return string representation of RR Message Type using the RR short protocol discriminator
Definition: gsm48.c:441
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:853
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:465
const struct tlv_definition gsm48_mm_att_tlvdef
TLV parser definitions for TS 04.08 MM.
Definition: gsm48.c:140
const char * gsm48_cc_msg_name(uint8_t msgtype)
return string representation of CC Message Type
Definition: gsm48.c:309
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:588
uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
Deprecated, see osmo_mobile_identity instead.
Definition: gsm48.c:1214
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:725
const char * gsm48_cc_state_name(uint8_t state)
return string representation of CC State
Definition: gsm48.c:261
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:1752
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:618
int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid)
Encode a TS 04.08 Routing Area Identifier.
Definition: gsm48.c:1354
int gsm48_number_of_paging_subchannels(const struct gsm48_control_channel_descr *chan_desc)
Determine number of paging sub-channels.
Definition: gsm48.c:1387
const struct tlv_definition gsm48_att_tlvdef
TLV parser definitions for TS 04.08 CC.
Definition: gsm48.c:52
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:1264
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:487
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
#define OSMO_DEPRECATED_OUTSIDE(text)
#define OSMO_DEPRECATED(text)
void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc) OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead
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
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 to not lose leading zeros in the MNC
Definition: gsm48.h:46
GSM TS 04.08 definitions.
uint8_t cause
Definition: gsm_04_08.h:2
gsm48_chan_mode
Definition: gsm_04_08.h:749
uint8_t mode
Definition: gsm_04_08.h:1
uint16_t lac
Definition: gsm_04_08.h:1
uint8_t mi_len
Definition: gsm_04_08.h:1
struct gsm48_loc_area_id lai
Definition: gsm_04_08.h:2
struct gsm48_chan_desc chan_desc
Definition: gsm_04_08.h:0
uint8_t mi[0]
Definition: gsm_04_08.h:2
uint8_t msg[0]
Definition: gsm_08_08.h:8
#define GSM23003_IMEI_NUM_DIGITS
Definition: gsm_23_003.h:30
#define GSM23003_IMEISV_NUM_DIGITS
Definition: gsm_23_003.h:32
#define GSM23003_IMSI_MAX_DIGITS
Definition: gsm_23_003.h:6
uint8_t type
Definition: gsm_08_08.h:0
_parse instead
Definition: ipa.h:30
Definition: gsm48.h:24
bool mnc_3_digits
Definition: gsm48.h:27
uint16_t mcc
Definition: gsm48.h:25
uint16_t lac
Definition: gsm48.h:28
uint8_t rac
Definition: gsm48.h:29
uint16_t mnc
Definition: gsm48.h:26
Definition: gsm_04_08.h:938
Definition: gsm_04_08.h:901
uint8_t msg_type
Definition: gsm_04_08.h:903
Definition: gsm_04_08.h:858
Definition: gsm_04_08.h:2129
Definition: gsm23003.h:16
Definition of All 256 IE / TLV.
Definition: tlv.h:517