Loading...
Searching...
No Matches
gsm23003.h
Go to the documentation of this file.
#pragma once
#include <stdint.h>
#include <stdbool.h>
/* 23.003 Chapter 12.1 */
struct osmo_plmn_id {
uint16_t mcc;
uint16_t mnc;
bool mnc_3_digits; /*< ignored and implied true if mnc > 99, otherwise defines leading zeros. */
};
/* 4.1 */
struct osmo_location_area_id {
struct osmo_plmn_id plmn;
uint16_t lac;
};
/* 4.2 */
struct osmo_routing_area_id {
struct osmo_location_area_id lac;
uint8_t rac;
};
/* 4.3.1 */
struct osmo_cell_global_id {
struct osmo_location_area_id lai;
uint16_t cell_identity;
};
/* 3GPP TS 48.018:
* 8c.1.4.1.1 GERAN BSS identification (RIM)
* sec 11.3.9 Cell Identifier */
struct osmo_cell_global_id_ps {
struct osmo_routing_area_id rai;
uint16_t cell_identity;
};
enum osmo_cgi_part {
OSMO_CGI_PART_PLMN = 1,
OSMO_CGI_PART_LAC = 2,
OSMO_CGI_PART_CI = 4,
OSMO_CGI_PART_RAC = 8,
};
/* Actually defined in 3GPP TS 48.008 3.2.2.27 Cell Identifier List,
* but conceptually belongs with the above structures. */
struct osmo_lac_and_ci_id {
uint16_t lac;
uint16_t ci;
};
/* 12.5 */
struct osmo_service_area_id {
struct osmo_location_area_id lai;
uint16_t sac;
};
/* 12.6 */
struct osmo_shared_network_area_id {
struct osmo_plmn_id plmn;
uint32_t snac;
};
/* 5.1 */
enum osmo_gsn_addr_type {
GSN_ADDR_TYPE_IPV4 = 0,
GSN_ADDR_TYPE_IPV6 = 1,
};
/* 5.1 */
struct osmo_gsn_address {
enum osmo_gsn_addr_type type;
uint8_t length;
uint8_t addr[16];
};
/* 19.4.2.3 */
struct osmo_tracking_area_id {
struct osmo_plmn_id plmn;
uint16_t tac;
};
struct osmo_eutran_cell_global_id {
struct osmo_plmn_id plmn;
uint32_t eci; /* FIXME */
};
/* 2.8.1 */
struct osmo_mme_id {
uint16_t group_id;
uint8_t code;
};
/* 2.8.1 */
struct osmo_gummei {
struct osmo_plmn_id plmn;
struct osmo_mme_id mme;
};
/* 2.8.1 */
struct osmo_guti {
struct osmo_gummei gummei;
uint32_t mtmsi;
};
bool osmo_imsi_str_valid(const char *imsi);
bool osmo_msisdn_str_valid(const char *msisdn);
bool osmo_imei_str_valid(const char *imei, bool with_15th_digit);
const char *osmo_mcc_name(uint16_t mcc);
char *osmo_mcc_name_buf(char *buf, size_t buf_len, uint16_t mcc);
const char *osmo_mcc_name_c(const void *ctx, uint16_t mcc);
const char *osmo_mnc_name(uint16_t mnc, bool mnc_3_digits);
char *osmo_mnc_name_buf(char *buf, size_t buf_len, uint16_t mnc, bool mnc_3_digits);
char *osmo_mnc_name_c(const void *ctx, uint16_t mnc, bool mnc_3_digits);
const char *osmo_plmn_name(const struct osmo_plmn_id *plmn);
const char *osmo_plmn_name2(const struct osmo_plmn_id *plmn);
char *osmo_plmn_name_buf(char *buf, size_t buf_len, const struct osmo_plmn_id *plmn);
char *osmo_plmn_name_c(const void *ctx, const struct osmo_plmn_id *plmn);
const char *osmo_lai_name(const struct osmo_location_area_id *lai);
char *osmo_lai_name_buf(char *buf, size_t buf_len, const struct osmo_location_area_id *lai);
char *osmo_lai_name_c(const void *ctx, const struct osmo_location_area_id *lai);
const char *osmo_rai_name2(const struct osmo_routing_area_id *rai);
char *osmo_rai_name2_buf(char *buf, size_t buf_len, const struct osmo_routing_area_id *rai);
char *osmo_rai_name2_c(const void *ctx, const struct osmo_routing_area_id *rai);
const char *osmo_cgi_name(const struct osmo_cell_global_id *cgi);
const char *osmo_cgi_name2(const struct osmo_cell_global_id *cgi);
char *osmo_cgi_name_buf(char *buf, size_t buf_len, const struct osmo_cell_global_id *cgi);
char *osmo_cgi_name_c(const void *ctx, const struct osmo_cell_global_id *cgi);
const char *osmo_cgi_ps_name(const struct osmo_cell_global_id_ps *cgi_ps);
const char *osmo_cgi_ps_name2(const struct osmo_cell_global_id_ps *cgi_ps);
char *osmo_cgi_ps_name_buf(char *buf, size_t buf_len, const struct osmo_cell_global_id_ps *cgi_ps);
char *osmo_cgi_ps_name_c(const void *ctx, const struct osmo_cell_global_id_ps *cgi_ps);
const char *osmo_sai_name(const struct osmo_service_area_id *sai);
const char *osmo_sai_name2(const struct osmo_service_area_id *sai);
char *osmo_sai_name_buf(char *buf, size_t buf_len, const struct osmo_service_area_id *sai);
char *osmo_sai_name_c(const void *ctx, const struct osmo_service_area_id *sai);
const char *osmo_gummei_name(const struct osmo_gummei *gummei);
char *osmo_gummei_name_buf(char *buf, size_t buf_len, const struct osmo_gummei *gummei);
char *osmo_gummei_name_c(const void *ctx, const struct osmo_gummei *gummei);
void osmo_plmn_to_bcd(uint8_t *bcd_dst, const struct osmo_plmn_id *plmn);
void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn);
int osmo_mnc_from_str(const char *mnc_str, uint16_t *mnc, bool *mnc_3_digits);
/* Convert string to MCC.
* \param mcc_str[in] String representation of an MCC, with or without leading zeros.
* \param mcc[out] MCC result buffer, or NULL.
* \returns zero on success, -EINVAL in case of surplus characters, negative errno in case of conversion
* errors. In case of error, do not modify the out-arguments.
*/
static inline int osmo_mcc_from_str(const char *mcc_str, uint16_t *mcc)
{
return osmo_mnc_from_str(mcc_str, mcc, NULL);
}
int osmo_mnc_cmp(uint16_t a_mnc, bool a_mnc_3_digits, uint16_t b_mnc, bool b_mnc_3_digits);
int osmo_plmn_cmp(const struct osmo_plmn_id *a, const struct osmo_plmn_id *b);
int osmo_lai_cmp(const struct osmo_location_area_id *a, const struct osmo_location_area_id *b);
int osmo_rai_cmp(const struct osmo_routing_area_id *a, const struct osmo_routing_area_id *b);
int osmo_cgi_cmp(const struct osmo_cell_global_id *a, const struct osmo_cell_global_id *b);
int osmo_cgi_ps_cmp(const struct osmo_cell_global_id_ps *a, const struct osmo_cell_global_id_ps *b);
int osmo_gen_home_network_domain(char *out, const struct osmo_plmn_id *plmn);
int osmo_parse_home_network_domain(struct osmo_plmn_id *out, const char *in);
int osmo_gen_mme_domain(char *out, const struct osmo_gummei *gummei);
int osmo_gen_mme_group_domain(char *out, uint16_t mmegi, const struct osmo_plmn_id *plmn);
int osmo_parse_mme_domain(struct osmo_gummei *out, const char *in);
osmo_sai_name_buf
char * osmo_sai_name_buf(char *buf, size_t buf_len, const struct osmo_service_area_id *sai)
Return MCC-MNC-LAC-SAC as string, in caller-provided output buffer.
Definition gsm23003.c:377
osmo_cgi_name_c
char * osmo_cgi_name_c(const void *ctx, const struct osmo_cell_global_id *cgi)
Return MCC-MNC-LAC-CI as string, in a talloc-allocated output buffer.
Definition gsm23003.c:321
osmo_cgi_name_buf
char * osmo_cgi_name_buf(char *buf, size_t buf_len, const struct osmo_cell_global_id *cgi)
Return MCC-MNC-LAC-CI as string, in caller-provided output buffer.
Definition gsm23003.c:289
osmo_cgi_name2
const char * osmo_cgi_name2(const struct osmo_cell_global_id *cgi)
Same as osmo_cgi_name(), but uses a different static buffer.
Definition gsm23003.c:310
osmo_gen_home_network_domain
int osmo_gen_home_network_domain(char *out, const struct osmo_plmn_id *plmn)
Generate TS 23.003 Section 19.2 Home Network Realm/Domain (text form)
Definition gsm23003.c:663
osmo_mcc_name
const char * osmo_mcc_name(uint16_t mcc)
Return MCC string as standardized 3-digit with leading zeros.
Definition gsm23003.c:104
osmo_mnc_name
const char * osmo_mnc_name(uint16_t mnc, bool mnc_3_digits)
Return MNC string as standardized 2- or 3-digit with leading zeros.
Definition gsm23003.c:155
osmo_mcc_name_buf
char * osmo_mcc_name_buf(char *buf, size_t buf_len, uint16_t mcc)
Return MCC string as standardized 3-digit with leading zeros.
Definition gsm23003.c:94
osmo_gummei_name
const char * osmo_gummei_name(const struct osmo_gummei *gummei)
Return string representation of GUMMEI in static output buffer.
Definition gsm23003.c:443
osmo_rai_cmp
int osmo_rai_cmp(const struct osmo_routing_area_id *a, const struct osmo_routing_area_id *b)
Definition gsm23003.c:613
osmo_parse_home_network_domain
int osmo_parse_home_network_domain(struct osmo_plmn_id *out, const char *in)
Parse a TS 23.003 Section 19.2 Home Network Realm/Domain (text form) into a osmo_plmn_id.
Definition gsm23003.c:676
osmo_cgi_ps_cmp
int osmo_cgi_ps_cmp(const struct osmo_cell_global_id_ps *a, const struct osmo_cell_global_id_ps *b)
Definition gsm23003.c:647
osmo_mnc_name_c
char * osmo_mnc_name_c(const void *ctx, uint16_t mnc, bool mnc_3_digits)
Return MNC string as standardized 2- or 3-digit with leading zeros, into a talloc-allocated buffer.
Definition gsm23003.c:142
osmo_lai_name
const char * osmo_lai_name(const struct osmo_location_area_id *lai)
Return MCC-MNC-LAC as string, in a static buffer.
Definition gsm23003.c:227
osmo_plmn_to_bcd
void osmo_plmn_to_bcd(uint8_t *bcd_dst, const struct osmo_plmn_id *plmn)
Definition gsm23003.c:475
osmo_parse_mme_domain
int osmo_parse_mme_domain(struct osmo_gummei *out, const char *in)
Parse a TS 23.003 Section 19.4.2.4 MME Domain (text form) into a osmo_gummei.
Definition gsm23003.c:707
osmo_mcc_name_c
const char * osmo_mcc_name_c(const void *ctx, uint16_t mcc)
Return MCC string as standardized 3-digit with leading zeros, into a talloc-allocated buffer.
Definition gsm23003.c:115
osmo_sai_name
const char * osmo_sai_name(const struct osmo_service_area_id *sai)
Return MCC-MNC-LAC-SAC as string, in a static buffer.
Definition gsm23003.c:387
osmo_plmn_cmp
int osmo_plmn_cmp(const struct osmo_plmn_id *a, const struct osmo_plmn_id *b)
Definition gsm23003.c:580
osmo_lai_name_c
char * osmo_lai_name_c(const void *ctx, const struct osmo_location_area_id *lai)
Return MCC-MNC-LAC as string, in a talloc-allocated output buffer.
Definition gsm23003.c:238
osmo_cgi_cmp
int osmo_cgi_cmp(const struct osmo_cell_global_id *a, const struct osmo_cell_global_id *b)
Definition gsm23003.c:630
osmo_rai_name2_buf
char * osmo_rai_name2_buf(char *buf, size_t buf_len, const struct osmo_routing_area_id *rai)
Return MCC-MNC-LAC-RAC as string, in caller-provided output buffer.
Definition gsm23003.c:252
osmo_plmn_name
const char * osmo_plmn_name(const struct osmo_plmn_id *plmn)
Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros.
Definition gsm23003.c:179
osmo_imsi_str_valid
bool osmo_imsi_str_valid(const char *imsi)
Determine whether the given IMSI is valid according to 3GPP TS 23.003.
Definition gsm23003.c:56
osmo_rai_name2
const char * osmo_rai_name2(const struct osmo_routing_area_id *rai)
Return MCC-MNC-LAC-RAC as string, in a static buffer.
Definition gsm23003.c:264
osmo_plmn_name_buf
char * osmo_plmn_name_buf(char *buf, size_t buf_len, const struct osmo_plmn_id *plmn)
Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros.
Definition gsm23003.c:167
osmo_mnc_cmp
int osmo_mnc_cmp(uint16_t a_mnc, bool a_mnc_3_digits, uint16_t b_mnc, bool b_mnc_3_digits)
Definition gsm23003.c:564
osmo_cgi_part
osmo_cgi_part
Bitmask of items contained in a struct osmo_cell_global_id.
Definition gsm23003.h:44
OSMO_CGI_PART_CI
@ OSMO_CGI_PART_CI
Definition gsm23003.h:47
OSMO_CGI_PART_RAC
@ OSMO_CGI_PART_RAC
Definition gsm23003.h:48
OSMO_CGI_PART_LAC
@ OSMO_CGI_PART_LAC
Definition gsm23003.h:46
OSMO_CGI_PART_PLMN
@ OSMO_CGI_PART_PLMN
Definition gsm23003.h:45
osmo_rai_name2_c
char * osmo_rai_name2_c(const void *ctx, const struct osmo_routing_area_id *rai)
Return MCC-MNC-LAC-RAC as string, in a talloc-allocated output buffer.
Definition gsm23003.c:275
osmo_lai_cmp
int osmo_lai_cmp(const struct osmo_location_area_id *a, const struct osmo_location_area_id *b)
Definition gsm23003.c:596
osmo_sai_name2
const char * osmo_sai_name2(const struct osmo_service_area_id *sai)
Same as osmo_cgi_name(), but uses a different static buffer.
Definition gsm23003.c:398
osmo_cgi_ps_name
const char * osmo_cgi_ps_name(const struct osmo_cell_global_id_ps *cgi_ps)
Return MCC-MNC-LAC-RAC-CI as string, in a static buffer.
Definition gsm23003.c:343
osmo_mcc_from_str
static int osmo_mcc_from_str(const char *mcc_str, uint16_t *mcc)
Definition gsm23003.h:159
osmo_gummei_name_c
char * osmo_gummei_name_c(const void *ctx, const struct osmo_gummei *gummei)
Return string representation of GUMMEI in static output buffer.
Definition gsm23003.c:455
osmo_sai_name_c
char * osmo_sai_name_c(const void *ctx, const struct osmo_service_area_id *sai)
Return MCC-MNC-LAC-SAC as string, in a talloc-allocated output buffer.
Definition gsm23003.c:409
osmo_cgi_ps_name_buf
char * osmo_cgi_ps_name_buf(char *buf, size_t buf_len, const struct osmo_cell_global_id_ps *cgi_ps)
Return MCC-MNC-LAC-RAC-CI as string, in caller-provided output buffer.
Definition gsm23003.c:333
osmo_gummei_name_buf
char * osmo_gummei_name_buf(char *buf, size_t buf_len, const struct osmo_gummei *gummei)
Return string representation of GUMMEI in caller-provided output buffer.
Definition gsm23003.c:431
osmo_cgi_ps_name2
const char * osmo_cgi_ps_name2(const struct osmo_cell_global_id_ps *cgi_ps)
Same as osmo_cgi_ps_name(), but uses a different static buffer.
Definition gsm23003.c:354
osmo_plmn_name_c
char * osmo_plmn_name_c(const void *ctx, const struct osmo_plmn_id *plmn)
Return MCC-MNC string as standardized 3-digit-dash-2/3-digit with leading zeros, into a dynamically-a...
Definition gsm23003.c:202
osmo_imei_str_valid
bool osmo_imei_str_valid(const char *imei, bool with_15th_digit)
Determine whether the given IMEI is valid according to 3GPP TS 23.003, Section 6.2....
Definition gsm23003.c:80
osmo_lai_name_buf
char * osmo_lai_name_buf(char *buf, size_t buf_len, const struct osmo_location_area_id *lai)
Return MCC-MNC-LAC as string, in caller-provided output buffer.
Definition gsm23003.c:216
osmo_plmn_name2
const char * osmo_plmn_name2(const struct osmo_plmn_id *plmn)
Same as osmo_plmn_name(), but returning in a different static buffer.
Definition gsm23003.c:190
osmo_msisdn_str_valid
bool osmo_msisdn_str_valid(const char *msisdn)
Determine whether the given MSISDN is valid according to 3GPP TS 23.003.
Definition gsm23003.c:66
osmo_gsn_addr_type
osmo_gsn_addr_type
Definition gsm23003.h:71
GSN_ADDR_TYPE_IPV6
@ GSN_ADDR_TYPE_IPV6
Definition gsm23003.h:73
GSN_ADDR_TYPE_IPV4
@ GSN_ADDR_TYPE_IPV4
Definition gsm23003.h:72
osmo_cgi_ps_name_c
char * osmo_cgi_ps_name_c(const void *ctx, const struct osmo_cell_global_id_ps *cgi_ps)
Return MCC-MNC-LAC-RAC-CI as string, in a talloc-allocated output buffer.
Definition gsm23003.c:365
osmo_plmn_from_bcd
void osmo_plmn_from_bcd(const uint8_t *bcd_src, struct osmo_plmn_id *plmn)
Definition gsm23003.c:500
osmo_gen_mme_domain
int osmo_gen_mme_domain(char *out, const struct osmo_gummei *gummei)
Generate TS 23.003 Section 19.4.2.4 MME Domain (text form)
Definition gsm23003.c:693
osmo_mnc_from_str
int osmo_mnc_from_str(const char *mnc_str, uint16_t *mnc, bool *mnc_3_digits)
Definition gsm23003.c:527
osmo_cgi_name
const char * osmo_cgi_name(const struct osmo_cell_global_id *cgi)
Return MCC-MNC-LAC-CI as string, in a static buffer.
Definition gsm23003.c:299
osmo_gen_mme_group_domain
int osmo_gen_mme_group_domain(char *out, uint16_t mmegi, const struct osmo_plmn_id *plmn)
Generate TS 23.003 Section 19.4.2.4 MME Group Domain (text form)
Definition gsm23003.c:727
osmo_mnc_name_buf
char * osmo_mnc_name_buf(char *buf, size_t buf_len, uint16_t mnc, bool mnc_3_digits)
Return MNC string as standardized 2- or 3-digit with leading zeros.
Definition gsm23003.c:130
lai
struct gsm48_loc_area_id lai
Definition gsm_04_08.h:2
osmo_cell_global_id_ps
Definition gsm23003.h:36
osmo_cell_global_id_ps::cell_identity
uint16_t cell_identity
Definition gsm23003.h:38
osmo_cell_global_id_ps::rai
struct osmo_routing_area_id rai
Definition gsm23003.h:37
osmo_cell_global_id
Definition gsm23003.h:28
osmo_cell_global_id::cell_identity
uint16_t cell_identity
Definition gsm23003.h:30
osmo_cell_global_id::lai
struct osmo_location_area_id lai
Definition gsm23003.h:29
osmo_eutran_cell_global_id
Definition gsm23003.h:89
osmo_eutran_cell_global_id::eci
uint32_t eci
Definition gsm23003.h:91
osmo_eutran_cell_global_id::plmn
struct osmo_plmn_id plmn
Definition gsm23003.h:90
osmo_gsn_address
Definition gsm23003.h:77
osmo_gsn_address::length
uint8_t length
Definition gsm23003.h:79
osmo_gsn_address::addr
uint8_t addr[16]
Definition gsm23003.h:80
osmo_gsn_address::type
enum osmo_gsn_addr_type type
Definition gsm23003.h:78
osmo_gummei
Definition gsm23003.h:101
osmo_gummei::plmn
struct osmo_plmn_id plmn
Definition gsm23003.h:102
osmo_gummei::mme
struct osmo_mme_id mme
Definition gsm23003.h:103
osmo_guti
Definition gsm23003.h:107
osmo_guti::gummei
struct osmo_gummei gummei
Definition gsm23003.h:108
osmo_guti::mtmsi
uint32_t mtmsi
Definition gsm23003.h:109
osmo_lac_and_ci_id
Definition gsm23003.h:53
osmo_lac_and_ci_id::lac
uint16_t lac
Definition gsm23003.h:54
osmo_lac_and_ci_id::ci
uint16_t ci
Definition gsm23003.h:55
osmo_location_area_id
Definition gsm23003.h:16
osmo_location_area_id::lac
uint16_t lac
Definition gsm23003.h:18
osmo_location_area_id::plmn
struct osmo_plmn_id plmn
Definition gsm23003.h:17
osmo_mme_id
Definition gsm23003.h:95
osmo_mme_id::code
uint8_t code
Definition gsm23003.h:97
osmo_mme_id::group_id
uint16_t group_id
Definition gsm23003.h:96
osmo_plmn_id
Definition gsm23003.h:9
osmo_plmn_id::mcc
uint16_t mcc
Definition gsm23003.h:10
osmo_plmn_id::mnc_3_digits
bool mnc_3_digits
Definition gsm23003.h:12
osmo_plmn_id::mnc
uint16_t mnc
Definition gsm23003.h:11
osmo_routing_area_id
Definition gsm23003.h:22
osmo_routing_area_id::lac
struct osmo_location_area_id lac
Definition gsm23003.h:23
osmo_routing_area_id::rac
uint8_t rac
Definition gsm23003.h:24
osmo_service_area_id
Definition gsm23003.h:59
osmo_service_area_id::sac
uint16_t sac
Definition gsm23003.h:61
osmo_service_area_id::lai
struct osmo_location_area_id lai
Definition gsm23003.h:60
osmo_shared_network_area_id
Definition gsm23003.h:65
osmo_shared_network_area_id::snac
uint32_t snac
Definition gsm23003.h:67
osmo_shared_network_area_id::plmn
struct osmo_plmn_id plmn
Definition gsm23003.h:66
osmo_tracking_area_id
Definition gsm23003.h:84
osmo_tracking_area_id::plmn
struct osmo_plmn_id plmn
Definition gsm23003.h:85
osmo_tracking_area_id::tac
uint16_t tac
Definition gsm23003.h:86