libosmogsm  1.1.0
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/msgb.h>
8 
9 #include <osmocom/gsm/tlv.h>
11 #include <osmocom/gsm/gsm48_ie.h>
12 #include <osmocom/gsm/gsm23003.h>
13 
14 /* reserved according to GSM 03.03 § 2.4 */
15 #define GSM_RESERVED_TMSI 0xFFFFFFFF
16 
17 /* Valid MCC and MNC range from 0 to 999.
18  * To mark an invalid / unset MNC, this value shall be used. */
19 #define GSM_MCC_MNC_INVALID 0xFFFF
20 
21 /* A parsed GPRS routing area */
22 struct gprs_ra_id {
23  uint16_t mcc;
24  uint16_t mnc;
26  uint16_t lac;
27  uint8_t rac;
28 };
29 
30 extern const struct tlv_definition gsm48_att_tlvdef;
31 extern const struct tlv_definition gsm48_rr_att_tlvdef;
32 extern const struct tlv_definition gsm48_mm_att_tlvdef;
33 const char *gsm48_cc_state_name(uint8_t state);
34 const char *gsm48_cc_msg_name(uint8_t msgtype);
35 const char *gsm48_rr_msg_name(uint8_t msgtype);
36 const char *rr_cause_name(uint8_t cause);
37 const char *osmo_rai_name(const struct gprs_ra_id *rai);
38 char *osmo_rai_name_buf(char *buf, size_t buf_len, const struct gprs_ra_id *rai);
39 char *osmo_rai_name_c(const void *ctx, const struct gprs_ra_id *rai);
40 
41 int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
42  uint16_t *mnc, uint16_t *lac)
43  OSMO_DEPRECATED("Use gsm48_decode_lai2() instead, to not lose leading zeros in the MNC");
44 void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded);
45 void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
46  uint16_t mnc, uint16_t lac)
47  OSMO_DEPRECATED("Use gsm48_generate_lai2() instead, to not lose leading zeros in the MNC");
48 void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai);
49 
50 #define GSM48_MID_MAX_SIZE 11
51 int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi);
52 int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi);
53 uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type);
54 
55 /* Convert Mobile Identity (10.5.1.4) to string */
56 int gsm48_mi_to_string(char *string, const int str_len,
57  const uint8_t *mi, const int mi_len);
58 const char *gsm48_mi_type_name(uint8_t mi);
59 const char *osmo_mi_name(const uint8_t *mi, uint8_t mi_len);
60 char *osmo_mi_name_buf(char *buf, size_t buf_len, const uint8_t *mi, uint8_t mi_len);
61 char *osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len);
62 
63 /* Parse Routeing Area Identifier */
64 void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf);
65 void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid);
66 int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid) OSMO_DEPRECATED("Use gsm48_encode_ra() instead");
67 
69 
70 void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
71  OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead, to not lose leading zeros in the MNC");
72 void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
73  OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead, to not lose leading zeros in the MNC");
74 
75 struct gsm48_hdr *gsm48_push_l3hdr(struct msgb *msg,
76  uint8_t pdisc, uint8_t msg_type);
77 
78 #define gsm48_push_l3hdr_tid(msg, pdisc, tid, msg_type) \
79  gsm48_push_l3hdr(msg, (pdisc & 0x0f) | (tid << 4), msg_type)
void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
Parse TS 04.08 Routing Area Identifier.
Definition: gsm48.c:787
uint8_t msg_type
Definition: gsm_04_08.h:825
uint8_t mi[0]
Definition: gsm_04_08.h:825
Definition: gsm_04_08.h:946
uint8_t rac
Definition: gsm48.h:27
#define OSMO_DEPRECATED(text)
int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
Generate TS 04.08 Mobile ID from TMSI.
Definition: gsm48.c:681
const char * gsm48_rr_msg_name(uint8_t msgtype)
return string representation of RR Message Type
Definition: gsm48.c:416
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
char * osmo_mi_name_c(const void *ctx, const uint8_t *mi, uint8_t mi_len)
Return a human readable representation of a Mobile Identity in dynamically-allocated buffer...
Definition: gsm48.c:516
uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type)
Generate TS 24.008 §10.5.1.4 Mobile ID of BCD type from ASCII string.
Definition: gsm48.c:698
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:192
uint8_t cause
Definition: gsm_04_08.h:825
int to not lose leading zeros in the MNC
Definition: gsm48.h:43
const struct tlv_definition gsm48_mm_att_tlvdef
TLV parser definitions for TS 04.08 MM.
Definition: gsm48.c:142
int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid) OSMO_DEPRECATED("Use gsm48_encode_ra() instead")
Encode a TS 04.08 Routing Area Identifier.
Definition: gsm48.c:835
Definition: gsm48.h:22
Definition: gsm_04_08.h:2144
bool mnc_3_digits
Definition: gsm48.h:25
GSM TS 04.08 definitions.
const char * gsm48_mi_type_name(uint8_t mi)
return string representation of Mobile Identity Type
Definition: gsm48.c:456
uint8_t mi_len
Definition: gsm_04_08.h:824
int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
Generate TS 04.08 Mobile ID from IMSI.
Definition: gsm48.c:729
const char * osmo_mi_name(const uint8_t *mi, uint8_t mi_len)
Return a human readable representation of a Mobile Identity in static buffer.
Definition: gsm48.c:503
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:215
Definition: gsm_04_08.h:903
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_mi_to_string(char *string, const int str_len, const uint8_t *mi, const int mi_len)
Convert TS 04.08 Mobile Identity (10.5.1.4) to string.
Definition: gsm48.c:744
const struct tlv_definition gsm48_rr_att_tlvdef
TLV parser definitions for TS 04.08 RR.
Definition: gsm48.c:97
struct gsm48_chan_desc chan_desc
Definition: gsm_04_08.h:750
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:627
int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
Determine number of paging sub-channels.
Definition: gsm48.c:849
uint16_t lac
Definition: gsm48.h:26
Definition: gsm23003.h:16
const struct tlv_definition gsm48_att_tlvdef
TLV parser definitions for TS 04.08 CC.
Definition: gsm48.c:55
const char * rr_cause_name(uint8_t cause)
return string representation of RR Cause value
Definition: gsm48.c:181
const char * gsm48_cc_state_name(uint8_t state)
return string representation of CC State
Definition: gsm48.c:260
const char * gsm48_cc_msg_name(uint8_t msgtype)
return string representation of CC Message Type
Definition: gsm48.c:308
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:983
uint16_t mcc
Definition: gsm48.h:23
Definition of All 256 IE / TLV.
Definition: tlv.h:437
struct gsm48_loc_area_id lai
Definition: gsm_04_08.h:825
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:596
uint16_t mnc
Definition: gsm48.h:24
_parse instead
Definition: ipa.h:30
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:1214
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:204
void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc) OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead
char * osmo_mi_name_buf(char *buf, size_t buf_len, const uint8_t *mi, uint8_t mi_len)
Return a human readable representation of a Mobile Identity in caller-provided buffer.
Definition: gsm48.c:468
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:814