libosmogsm  0.10.2.279.178b
Osmocom GSM library
gsm0808_utils.h
Go to the documentation of this file.
1 
4 /*
5  * (C) 2016 by sysmocom - s.f.m.c. GmbH, Author: Philipp Maier
6  * All Rights Reserved
7  *
8  * SPDX-License-Identifier: GPL-2.0+
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24 #pragma once
25 
26 struct sockaddr_storage;
27 
29 #include <osmocom/gsm/gsm23003.h>
30 
32 #define GSM0808_CELL_ID_LIST2_MAXLEN 127
33 
40  uint16_t ci;
42  uint16_t lac;
43 };
44 
47  enum CELL_IDENT id_discr;
49 };
50 
53  enum CELL_IDENT id_discr;
55  unsigned int id_list_len;
56 };
57 
58 extern const struct value_string gsm0808_cell_id_discr_names[];
59 static inline const char *gsm0808_cell_id_discr_name(enum CELL_IDENT id_discr)
60 { return get_value_string(gsm0808_cell_id_discr_names, id_discr); }
61 
62 const char *gsm0808_cell_id_name(const struct gsm0808_cell_id *cid);
63 const char *gsm0808_cell_id_name2(const struct gsm0808_cell_id *cid);
64 const char *gsm0808_cell_id_list_name(const struct gsm0808_cell_id_list2 *cil);
65 int gsm0808_cell_id_list_name_buf(char *buf, size_t buflen, const struct gsm0808_cell_id_list2 *cil);
66 int gsm0808_cell_id_u_name(char *buf, size_t buflen,
67  enum CELL_IDENT id_discr, const union gsm0808_cell_id_u *u);
68 
69 uint8_t gsm0808_enc_aoip_trasp_addr(struct msgb *msg,
70  const struct sockaddr_storage *ss);
71 int gsm0808_dec_aoip_trasp_addr(struct sockaddr_storage *ss,
72  const uint8_t *elem, uint8_t len);
73 uint8_t gsm0808_enc_speech_codec(struct msgb *msg,
74  const struct gsm0808_speech_codec *sc);
76  const uint8_t *elem, uint8_t len);
77 uint8_t gsm0808_enc_speech_codec_list(struct msgb *msg,
78  const struct gsm0808_speech_codec_list
79  *scl);
81  const uint8_t *elem, uint8_t len);
82 uint8_t gsm0808_enc_channel_type(struct msgb *msg,
83  const struct gsm0808_channel_type *ct);
85  const uint8_t *elem, uint8_t len);
86 uint8_t gsm0808_enc_encrypt_info(struct msgb *msg,
87  const struct gsm0808_encrypt_info *ei);
89  const uint8_t *elem, uint8_t len);
90 uint8_t gsm0808_enc_cell_id_list2(struct msgb *msg, const struct gsm0808_cell_id_list2 *cil);
91 uint8_t gsm0808_enc_cell_id_list(struct msgb *msg,
92  const struct gsm0808_cell_id_list *cil)
93  OSMO_DEPRECATED("use gsm0808_enc_cell_id_list2 instead");
94 int gsm0808_dec_cell_id_list2(struct gsm0808_cell_id_list2 *cil, const uint8_t *elem, uint8_t len);
96  const uint8_t *elem, uint8_t len)
97  OSMO_DEPRECATED("use gsm0808_dec_cell_id_list2 instead");
98 int gsm0808_cell_id_list_add(struct gsm0808_cell_id_list2 *dst, const struct gsm0808_cell_id_list2 *src);
99 uint8_t gsm0808_enc_cell_id(struct msgb *msg, const struct gsm0808_cell_id *ci);
100 int gsm0808_dec_cell_id(struct gsm0808_cell_id *ci, const uint8_t *elem, uint8_t len);
101 int gsm0808_chan_type_to_speech_codec(uint8_t perm_spch);
103  uint8_t perm_spch);
104 
uint8_t gsm0808_enc_speech_codec_list(struct msgb *msg, const struct gsm0808_speech_codec_list *scl)
Encode TS 08.08 Speech Codec list.
Definition: gsm0808_utils.c:339
uint16_t lac
Definition: gsm0808_utils.h:42
unsigned int id_list_len
Definition: gsm0808_utils.h:55
uint8_t gsm0808_enc_cell_id_list2(struct msgb *msg, const struct gsm0808_cell_id_list2 *cil)
Encode TS 08.08 Cell Identifier List IE.
Definition: gsm0808_utils.c:576
#define OSMO_DEPRECATED(text)
const char * get_value_string(const struct value_string *vs, uint32_t val)
Parsed representation of a Cell Identifier List IE (3GPP TS 48.008 3.2.2.27).
Definition: gsm0808_utils.h:52
uint8_t gsm0808_enc_encrypt_info(struct msgb *msg, const struct gsm0808_encrypt_info *ei)
Encode TS 08.08 Encryption Information IE.
Definition: gsm0808_utils.c:499
struct osmo_location_area_id lai_and_lac
Definition: gsm0808_utils.h:41
static const char * gsm0808_cell_id_discr_name(enum CELL_IDENT id_discr)
Definition: gsm0808_utils.h:59
#define GSM0808_CELL_ID_LIST2_MAXLEN
(225-1)/2 is the maximum number of elements in a cell identifier list.
Definition: gsm0808_utils.h:32
int gsm0808_cell_id_list_add(struct gsm0808_cell_id_list2 *dst, const struct gsm0808_cell_id_list2 *src)
Append entries from one Cell Identifier List to another.
Definition: gsm0808_utils.c:958
int gsm0808_dec_cell_id_list(struct gsm0808_cell_id_list *cil, const uint8_t *elem, uint8_t len) OSMO_DEPRECATED("use gsm0808_dec_cell_id_list2 instead")
DEPRECATED: Use gsm0808_dec_cell_id_list2 instead.
Definition: gsm0808_utils.c:871
Instead of this, use either struct gsm0808_cell_id or gsm0808_cell_id_list2.
Definition: gsm0808_utils.h:37
struct osmo_lac_and_ci_id lac_and_ci
Definition: gsm0808_utils.h:39
const char * gsm0808_cell_id_name(const struct gsm0808_cell_id *cid)
Return a human readable representation of a Cell Identifier, like "LAC:123" or "CGI:001-01-42-23".
Definition: gsm0808_utils.c:1207
int gsm0808_dec_encrypt_info(struct gsm0808_encrypt_info *ei, const uint8_t *elem, uint8_t len)
Decode TS 08.08 Encryption Information IE.
Definition: gsm0808_utils.c:538
int gsm0808_dec_cell_id(struct gsm0808_cell_id *ci, const uint8_t *elem, uint8_t len)
Decode Cell Identifier IE (3GPP TS 48.008 3.2.2.17).
Definition: gsm0808_utils.c:1023
Definition: gsm23003.h:35
Definition: gsm_08_08.h:481
uint8_t gsm0808_enc_aoip_trasp_addr(struct msgb *msg, const struct sockaddr_storage *ss)
const char * gsm0808_cell_id_name2(const struct gsm0808_cell_id *cid)
Like gsm0808_cell_id_name() but uses a different static buffer.
Definition: gsm0808_utils.c:1217
uint8_t gsm0808_enc_cell_id(struct msgb *msg, const struct gsm0808_cell_id *ci)
Encode Cell Identifier IE (3GPP TS 48.008 3.2.2.17).
Definition: gsm0808_utils.c:995
struct osmo_cell_global_id global
Definition: gsm0808_utils.h:38
uint8_t sc
Definition: gsm_04_08.h:502
const struct value_string gsm0808_cell_id_discr_names[]
value_string[] for enum CELL_IDENT.
Definition: gsm0808_utils.c:1165
Definition: gsm23003.h:28
uint8_t gsm0808_enc_cell_id_list(struct msgb *msg, const struct gsm0808_cell_id_list *cil) OSMO_DEPRECATED("use gsm0808_enc_cell_id_list2 instead")
DEPRECATED: Use gsm0808_enc_cell_id_list2 instead.
Definition: gsm0808_utils.c:645
int gsm0808_dec_aoip_trasp_addr(struct sockaddr_storage *ss, const uint8_t *elem, uint8_t len)
int gsm0808_speech_codec_from_chan_type(struct gsm0808_speech_codec *sc, uint8_t perm_spch)
Extrapolate a speech codec field from a given permitted speech parameter (channel type)...
Definition: gsm0808_utils.c:1085
Definition: gsm23003.h:16
uint8_t len
Definition: gsm_04_11.h:434
int gsm0808_cell_id_list_name_buf(char *buf, size_t buflen, const struct gsm0808_cell_id_list2 *cil)
Return a human readable representation of the Cell Identifier List, like "LAC[2]:{123, 456}".
Definition: gsm0808_utils.c:1235
uint8_t gsm0808_enc_channel_type(struct msgb *msg, const struct gsm0808_channel_type *ct)
Encode TS 08.08 Channel Type IE.
Definition: gsm0808_utils.c:419
Definition: gsm_08_08.h:488
CELL_IDENT
Definition: gsm_08_08.h:16
Definition: gsm_08_08.h:498
int gsm0808_dec_speech_codec(struct gsm0808_speech_codec *sc, const uint8_t *elem, uint8_t len)
Decode TS 08.08 Speech Codec IE.
Definition: gsm0808_utils.c:259
Parsed representation of Cell Identifier IE (3GPP TS 48.008 3.2.2.17)
Definition: gsm0808_utils.h:46
const char * gsm0808_cell_id_list_name(const struct gsm0808_cell_id_list2 *cil)
Return a human-readable representation of cil in a static buffer.
Definition: gsm0808_utils.c:1266
int gsm0808_dec_speech_codec_list(struct gsm0808_speech_codec_list *scl, const uint8_t *elem, uint8_t len)
Decode TS 08.08 Speech Codec list IE.
Definition: gsm0808_utils.c:375
int gsm0808_dec_cell_id_list2(struct gsm0808_cell_id_list2 *cil, const uint8_t *elem, uint8_t len)
Decode Cell Identifier List IE.
Definition: gsm0808_utils.c:809
int gsm0808_dec_channel_type(struct gsm0808_channel_type *ct, const uint8_t *elem, uint8_t len)
Decode TS 08.08 Channel Type IE.
Definition: gsm0808_utils.c:462
uint8_t gsm0808_enc_speech_codec(struct msgb *msg, const struct gsm0808_speech_codec *sc)
Encode TS 08.08 Speech Codec IE.
Definition: gsm0808_utils.c:234
uint16_t ci
Definition: gsm0808_utils.h:40
int gsm0808_cell_id_u_name(char *buf, size_t buflen, enum CELL_IDENT id_discr, const union gsm0808_cell_id_u *u)
Print a human readable name of the cell identifier to the char buffer.
Definition: gsm0808_utils.c:1143
int gsm0808_chan_type_to_speech_codec(uint8_t perm_spch)
Convert the representation of the permitted speech codec identifier that is used in struct gsm0808_ch...
Definition: gsm0808_utils.c:1047
DEPRECATED: This definition of the cell identifier list is insufficient.
Definition: gsm_08_08.h:512
Definition: gsm_08_08.h:449