libosmogsm  0.12.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/gsm/tlv.h>
9 #include <osmocom/gsm/gsm48_ie.h>
10 #include <osmocom/gsm/gsm23003.h>
11 
12 /* reserved according to GSM 03.03 § 2.4 */
13 #define GSM_RESERVED_TMSI 0xFFFFFFFF
14 
15 /* Valid MCC and MNC range from 0 to 999.
16  * To mark an invalid / unset MNC, this value shall be used. */
17 #define GSM_MCC_MNC_INVALID 0xFFFF
18 
19 /* A parsed GPRS routing area */
20 struct gprs_ra_id {
21  uint16_t mcc;
22  uint16_t mnc;
24  uint16_t lac;
25  uint8_t rac;
26 };
27 
28 extern const struct tlv_definition gsm48_att_tlvdef;
29 extern const struct tlv_definition gsm48_rr_att_tlvdef;
30 extern const struct tlv_definition gsm48_mm_att_tlvdef;
31 const char *gsm48_cc_state_name(uint8_t state);
32 const char *gsm48_cc_msg_name(uint8_t msgtype);
33 const char *gsm48_rr_msg_name(uint8_t msgtype);
34 const char *rr_cause_name(uint8_t cause);
35 const char *osmo_rai_name(const struct gprs_ra_id *rai);
36 
37 int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
38  uint16_t *mnc, uint16_t *lac)
39  OSMO_DEPRECATED("Use gsm48_decode_lai2() instead, to not lose leading zeros in the MNC");
40 void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded);
41 void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
42  uint16_t mnc, uint16_t lac)
43  OSMO_DEPRECATED("Use gsm48_generate_lai2() instead, to not lose leading zeros in the MNC");
44 void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai);
45 
46 int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi);
47 int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi);
48 uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type);
49 
50 /* Convert Mobile Identity (10.5.1.4) to string */
51 int gsm48_mi_to_string(char *string, const int str_len,
52  const uint8_t *mi, const int mi_len);
53 const char *gsm48_mi_type_name(uint8_t mi);
54 
55 /* Parse Routeing Area Identifier */
56 void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf);
57 void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid);
58 int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid) OSMO_DEPRECATED("Use gsm48_encode_ra() instead");
59 
61 
62 void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
63  OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead, to not lose leading zeros in the MNC");
64 void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
65  OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead, to not lose leading zeros in the MNC");
void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf)
Parse TS 04.08 Routing Area Identifier.
Definition: gsm48.c:691
uint8_t rac
Definition: gsm48.h:25
void osmo_plmn_to_bcd(uint8_t *bcd_dst, const struct osmo_plmn_id *plmn)
Definition: gsm23003.c:184
int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
Generate TS 04.08 Mobile ID from TMSI.
Definition: gsm48.c:592
const char * gsm48_rr_msg_name(uint8_t msgtype)
return string representation of RR Message Type
Definition: gsm48.c:391
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
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.
Definition: gsm48.c:608
uint8_t cause
Definition: gsm_04_08.h:559
int to not lose leading zeros in the MNC
Definition: gsm48.h:39
const struct tlv_definition gsm48_mm_att_tlvdef
TLV parser definitions for TS 04.08 MM.
Definition: gsm48.c:141
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:739
Definition: gsm48.h:20
Definition: gsm_04_08.h:1718
bool mnc_3_digits
Definition: gsm48.h:23
GSM TS 04.08 definitions.
const char * gsm48_mi_type_name(uint8_t mi)
return string representation of Mobile Identity Type
Definition: gsm48.c:431
uint8_t mi_len
Definition: gsm_04_08.h:560
int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
Generate TS 04.08 Mobile ID from IMSI.
Definition: gsm48.c:635
Definition: gsm_04_08.h:623
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:646
const struct tlv_definition gsm48_rr_att_tlvdef
TLV parser definitions for TS 04.08 RR.
Definition: gsm48.c:96
struct gsm48_chan_desc chan_desc
Definition: gsm_04_08.h:502
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:538
int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
Determine number of paging sub-channels.
Definition: gsm48.c:753
uint8_t mi[0]
Definition: gsm_04_08.h:561
void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn)
Definition: gsm23003.c:211
uint16_t lac
Definition: gsm48.h:24
Definition: gsm23003.h:16
const struct tlv_definition gsm48_att_tlvdef
TLV parser definitions for TS 04.08 CC.
Definition: gsm48.c:54
const char * rr_cause_name(uint8_t cause)
return string representation of RR Cause value
Definition: gsm48.c:180
const char * gsm48_cc_state_name(uint8_t state)
return string representation of CC State
Definition: gsm48.c:235
const char * gsm48_cc_msg_name(uint8_t msgtype)
return string representation of CC Message Type
Definition: gsm48.c:283
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:675
uint16_t mcc
Definition: gsm48.h:21
Definition of All 256 IE / TLV.
Definition: tlv.h:419
struct gsm48_loc_area_id lai
Definition: gsm_04_08.h:559
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:507
uint16_t mnc
Definition: gsm48.h:22
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:189
void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc) OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead
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:718