libosmogsm  1.0.1
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 
39 int gsm48_decode_lai(struct gsm48_loc_area_id *lai, uint16_t *mcc,
40  uint16_t *mnc, uint16_t *lac)
41  OSMO_DEPRECATED("Use gsm48_decode_lai2() instead, to not lose leading zeros in the MNC");
42 void gsm48_decode_lai2(const struct gsm48_loc_area_id *lai, struct osmo_location_area_id *decoded);
43 void gsm48_generate_lai(struct gsm48_loc_area_id *lai48, uint16_t mcc,
44  uint16_t mnc, uint16_t lac)
45  OSMO_DEPRECATED("Use gsm48_generate_lai2() instead, to not lose leading zeros in the MNC");
46 void gsm48_generate_lai2(struct gsm48_loc_area_id *lai48, const struct osmo_location_area_id *lai);
47 
48 int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi);
49 int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi);
50 uint8_t gsm48_generate_mid(uint8_t *buf, const char *id, uint8_t mi_type);
51 
52 /* Convert Mobile Identity (10.5.1.4) to string */
53 int gsm48_mi_to_string(char *string, const int str_len,
54  const uint8_t *mi, const int mi_len);
55 const char *gsm48_mi_type_name(uint8_t mi);
56 const char *osmo_mi_name(const uint8_t *mi, uint8_t mi_len);
57 
58 /* Parse Routeing Area Identifier */
59 void gsm48_parse_ra(struct gprs_ra_id *raid, const uint8_t *buf);
60 void gsm48_encode_ra(struct gsm48_ra_id *out, const struct gprs_ra_id *raid);
61 int gsm48_construct_ra(uint8_t *buf, const struct gprs_ra_id *raid) OSMO_DEPRECATED("Use gsm48_encode_ra() instead");
62 
64 
65 void gsm48_mcc_mnc_to_bcd(uint8_t *bcd_dst, uint16_t mcc, uint16_t mnc)
66  OSMO_DEPRECATED("Use osmo_plmn_to_bcd() instead, to not lose leading zeros in the MNC");
67 void gsm48_mcc_mnc_from_bcd(uint8_t *bcd_src, uint16_t *mcc, uint16_t *mnc)
68  OSMO_DEPRECATED("Use osmo_plmn_from_bcd() instead, to not lose leading zeros in the MNC");
69 
70 struct gsm48_hdr *gsm48_push_l3hdr(struct msgb *msg,
71  uint8_t pdisc, uint8_t msg_type);
72 
73 #define gsm48_push_l3hdr_tid(msg, pdisc, tid, msg_type) \
74  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:730
uint8_t msg_type
Definition: gsm_04_08.h:807
uint8_t mi[0]
Definition: gsm_04_08.h:807
Definition: gsm_04_08.h:928
uint8_t rac
Definition: gsm48.h:27
void osmo_plmn_to_bcd(uint8_t *bcd_dst, const struct osmo_plmn_id *plmn)
Definition: gsm23003.c:210
int gsm48_generate_mid_from_tmsi(uint8_t *buf, uint32_t tmsi)
Generate TS 04.08 Mobile ID from TMSI.
Definition: gsm48.c:628
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:645
uint8_t cause
Definition: gsm_04_08.h:807
int to not lose leading zeros in the MNC
Definition: gsm48.h:41
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:778
Definition: gsm48.h:22
Definition: gsm_04_08.h:2122
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:431
uint8_t mi_len
Definition: gsm_04_08.h:806
int gsm48_generate_mid_from_imsi(uint8_t *buf, const char *imsi)
Generate TS 04.08 Mobile ID from IMSI.
Definition: gsm48.c:672
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:441
Definition: gsm_04_08.h:885
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:687
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:732
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:574
int gsm48_number_of_paging_subchannels(struct gsm48_control_channel_descr *chan_desc)
Determine number of paging sub-channels.
Definition: gsm48.c:792
void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn)
Definition: gsm23003.c:237
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: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:965
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:807
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:543
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:1128
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:757