libosmogsm  1.1.0
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 
30 #include <osmocom/gsm/gsm29205.h>
31 #include <osmocom/gsm/gsm23003.h>
32 #include <osmocom/gsm/gsm_utils.h>
33 #include <osmocom/gsm/tlv.h>
34 
36 #define GSM0808_CELL_ID_LIST2_MAXLEN 127
37 
44  uint16_t ci;
46  uint16_t lac;
47 };
48 
51  enum CELL_IDENT id_discr;
53 };
54 
57  enum CELL_IDENT id_discr;
59  unsigned int id_list_len;
60 };
61 
63 struct osmo_lcls {
65  enum gsm0808_lcls_control control;
66  struct osmo_gcr_parsed gcr;
68  bool corr_needed;
69 };
70 
71 char *osmo_lcls_dump(const struct osmo_lcls *lcls);
72 char *osmo_lcls_dump_buf(char *buf, size_t buf_len, const struct osmo_lcls *lcls);
73 char *osmo_lcls_dump_c(void *ctx, const struct osmo_lcls *lcls);
74 char *osmo_gcr_dump(const struct osmo_lcls *lcls);
75 char *osmo_gcr_dump_buf(char *buf, size_t buf_len, const struct osmo_lcls *lcls);
76 
77 extern const struct value_string gsm0808_cell_id_discr_names[];
78 static inline const char *gsm0808_cell_id_discr_name(enum CELL_IDENT id_discr)
79 { return get_value_string(gsm0808_cell_id_discr_names, id_discr); }
80 
81 const char *gsm0808_cell_id_name(const struct gsm0808_cell_id *cid);
82 const char *gsm0808_cell_id_name2(const struct gsm0808_cell_id *cid);
83 char *gsm0808_cell_id_name_buf(char *buf, size_t buflen, const struct gsm0808_cell_id *cid);
84 char *gsm0808_cell_id_name_c(const void *ctx, const struct gsm0808_cell_id *cid);
85 const char *gsm0808_cell_id_list_name(const struct gsm0808_cell_id_list2 *cil);
86 int gsm0808_cell_id_list_name_buf(char *buf, size_t buflen, const struct gsm0808_cell_id_list2 *cil);
87 char *gsm0808_cell_id_list_name_c(const void *ctx, const struct gsm0808_cell_id_list2 *cil);
88 int gsm0808_cell_id_u_name(char *buf, size_t buflen,
89  enum CELL_IDENT id_discr, const union gsm0808_cell_id_u *u);
90 bool gsm0808_cell_ids_match(const struct gsm0808_cell_id *id1, const struct gsm0808_cell_id *id2, bool exact_match);
91 int gsm0808_cell_id_matches_list(const struct gsm0808_cell_id *id, const struct gsm0808_cell_id_list2 *list,
92  unsigned int match_nr, bool exact_match);
93 void gsm0808_cell_id_from_cgi(struct gsm0808_cell_id *cid, enum CELL_IDENT id_discr,
94  const struct osmo_cell_global_id *cgi);
95 int gsm0808_cell_id_to_cgi(struct osmo_cell_global_id *cgi, const struct gsm0808_cell_id *cid);
96 
97 uint8_t gsm0808_enc_cause(struct msgb *msg, uint16_t cause);
98 uint8_t gsm0808_enc_aoip_trasp_addr(struct msgb *msg,
99  const struct sockaddr_storage *ss);
100 int gsm0808_dec_aoip_trasp_addr(struct sockaddr_storage *ss,
101  const uint8_t *elem, uint8_t len);
102 
103 uint8_t gsm0808_enc_lcls(struct msgb *msg, const struct osmo_lcls *lcls);
104 int gsm0808_dec_lcls(struct osmo_lcls *lcls, const struct tlv_parsed *tp);
105 
106 uint8_t gsm0808_enc_speech_codec(struct msgb *msg,
107  const struct gsm0808_speech_codec *sc);
109  const uint8_t *elem, uint8_t len);
110 uint8_t gsm0808_enc_speech_codec_list(struct msgb *msg,
111  const struct gsm0808_speech_codec_list
112  *scl);
114  const uint8_t *elem, uint8_t len);
115 uint8_t gsm0808_enc_channel_type(struct msgb *msg,
116  const struct gsm0808_channel_type *ct);
118  const uint8_t *elem, uint8_t len);
119 uint8_t gsm0808_enc_encrypt_info(struct msgb *msg,
120  const struct gsm0808_encrypt_info *ei);
122  const uint8_t *elem, uint8_t len);
123 uint8_t gsm0808_enc_cell_id_list2(struct msgb *msg, const struct gsm0808_cell_id_list2 *cil);
124 uint8_t gsm0808_enc_cell_id_list(struct msgb *msg,
125  const struct gsm0808_cell_id_list *cil)
126  OSMO_DEPRECATED("use gsm0808_enc_cell_id_list2 instead");
127 int gsm0808_dec_cell_id_list2(struct gsm0808_cell_id_list2 *cil, const uint8_t *elem, uint8_t len);
129  const uint8_t *elem, uint8_t len)
130  OSMO_DEPRECATED("use gsm0808_dec_cell_id_list2 instead");
131 int gsm0808_cell_id_list_add(struct gsm0808_cell_id_list2 *dst, const struct gsm0808_cell_id_list2 *src);
132 void gsm0808_cell_id_to_list(struct gsm0808_cell_id_list2 *dst, const struct gsm0808_cell_id *src);
133 uint8_t gsm0808_enc_cell_id(struct msgb *msg, const struct gsm0808_cell_id *ci);
134 int gsm0808_dec_cell_id(struct gsm0808_cell_id *ci, const uint8_t *elem, uint8_t len);
135 int gsm0808_chan_type_to_speech_codec(uint8_t perm_spch);
137  uint8_t perm_spch);
138 uint16_t gsm0808_sc_cfg_from_gsm48_mr_cfg(const struct gsm48_multi_rate_conf *cfg, bool fr);
139 int gsm48_mr_cfg_from_gsm0808_sc_cfg(struct gsm48_multi_rate_conf *cfg, uint16_t s15_s0);
140 
143 {
144  return (cause << 1) >> 4;
145 }
146 
148 static inline bool gsm0808_cause_ext(enum gsm0808_cause cause)
149 {
150  /* check that cause looks like 1XXX0000 where XXX represent class */
151  return (cause & 0x80) && !(cause & 0x0F);
152 }
153 
154 int gsm0808_get_cipher_reject_cause(const struct tlv_parsed *tp);
155 
157 static inline uint8_t gsm0808_current_channel_type_1(enum gsm_chan_t type)
158 {
159  switch (type) {
160  default:
161  return 0;
162  case GSM_LCHAN_SDCCH:
163  return 0x01;
164  case GSM_LCHAN_TCH_F:
165  return 0x18;
166  case GSM_LCHAN_TCH_H:
167  return 0x19;
168  }
169 }
170 
174  enum gsm48_chan_mode mode)
175 {
176  switch (mode) {
178  switch (type) {
179  case GSM_LCHAN_TCH_F:
180  return GSM0808_PERM_FR1;
181  case GSM_LCHAN_TCH_H:
182  return GSM0808_PERM_HR1;
183  default:
184  return 0;
185  }
187  switch (type) {
188  case GSM_LCHAN_TCH_F:
189  return GSM0808_PERM_FR2;
190  case GSM_LCHAN_TCH_H:
191  return GSM0808_PERM_HR2;
192  default:
193  return 0;
194  }
196  switch (type) {
197  case GSM_LCHAN_TCH_F:
198  return GSM0808_PERM_FR3;
199  case GSM_LCHAN_TCH_H:
200  return GSM0808_PERM_HR3;
201  default:
202  return 0;
203  }
204  default:
205  return 0;
206  }
207 }
208 
210 static inline uint8_t gsm0808_chosen_channel(enum gsm_chan_t type, enum gsm48_chan_mode mode)
211 {
212  uint8_t channel_mode = 0, channel = 0;
213 
214  switch (mode) {
218  channel_mode = 0x9;
219  break;
220  case GSM48_CMODE_SIGN:
221  channel_mode = 0x8;
222  break;
224  channel_mode = 0xe;
225  break;
227  channel_mode = 0xb;
228  break;
230  channel_mode = 0xc;
231  break;
233  channel_mode = 0xd;
234  break;
235  default:
236  return 0;
237  }
238 
239  switch (type) {
240  case GSM_LCHAN_NONE:
241  channel = 0x0;
242  break;
243  case GSM_LCHAN_SDCCH:
244  channel = 0x1;
245  break;
246  case GSM_LCHAN_TCH_F:
247  channel = 0x8;
248  break;
249  case GSM_LCHAN_TCH_H:
250  channel = 0x9;
251  break;
252  default:
253  return 0;
254  }
255 
256  return channel_mode << 4 | channel;
257 }
258 
259 const char *gsm0808_channel_type_name(const struct gsm0808_channel_type *ct);
260 char *gsm0808_channel_type_name_buf(char *buf, size_t buf_len, const struct gsm0808_channel_type *ct);
261 char *gsm0808_channel_type_name_c(const void *ctx, const struct gsm0808_channel_type *ct);
262 
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:366
Definition: gsm_04_08.h:812
uint16_t lac
Definition: gsm0808_utils.h:46
char * gsm0808_channel_type_name_c(const void *ctx, const struct gsm0808_channel_type *ct)
Definition: gsm0808_utils.c:1900
char * osmo_gcr_dump_buf(char *buf, size_t buf_len, const struct osmo_lcls *lcls)
Dump GCR struct into string for printing.
Definition: gsm0808_utils.c:638
uint8_t type
Definition: gsm_08_08.h:469
unsigned int id_list_len
Definition: gsm0808_utils.h:59
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:744
#define OSMO_DEPRECATED(text)
static enum gsm0808_permitted_speech gsm0808_permitted_speech(enum gsm_chan_t type, enum gsm48_chan_mode mode)
Return 3GPP TS 48.008 3.2.2.51 Speech Version aka permitted speech version indication in 3...
Definition: gsm0808_utils.h:173
gsm48_chan_mode
Definition: gsm_04_08.h:810
Definition: gsm_04_08.h:818
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:56
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:667
Definition: gsm_04_08.h:811
char * osmo_lcls_dump(const struct osmo_lcls *lcls)
Dump LCLS parameters (GCR excluded) into static string buffer for printing.
Definition: gsm0808_utils.c:620
GSM FR.
Definition: gsm_08_08.h:457
gsm0808_cause_class
Definition: gsm_08_08.h:398
Definition: gsm_04_08.h:816
(deprecated)
Definition: gsm_08_08.h:463
write Write running configuration to or terminal n Write configuration to the copy running config startup config
LCLS-related parameters from 3GPP TS 48.008.
Definition: gsm0808_utils.h:63
HR AMR.
Definition: gsm_08_08.h:464
GSM EFR.
Definition: gsm_08_08.h:458
struct osmo_location_area_id lai_and_lac
Definition: gsm0808_utils.h:45
static const char * gsm0808_cell_id_discr_name(enum CELL_IDENT id_discr)
Definition: gsm0808_utils.h:78
gsm0808_lcls_control
Definition: gsm_08_08.h:621
#define GSM0808_CELL_ID_LIST2_MAXLEN
(225-1)/2 is the maximum number of elements in a cell identifier list.
Definition: gsm0808_utils.h:36
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:1126
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:1039
Definition: gsm_utils.h:223
char * osmo_lcls_dump_c(void *ctx, const struct osmo_lcls *lcls)
Definition: gsm0808_utils.c:625
int gsm0808_get_cipher_reject_cause(const struct tlv_parsed *tp)
Definition: gsm0808_utils.c:1478
Instead of this, use either struct gsm0808_cell_id or gsm0808_cell_id_list2.
Definition: gsm0808_utils.h:41
int gsm0808_dec_lcls(struct osmo_lcls *lcls, const struct tlv_parsed *tp)
Decode LCLS parameters to a given msgb, 3GPP TS 48.008 §3.2.2.115 - 3.2.2.120.
Definition: gsm0808_utils.c:583
uint8_t cause
Definition: gsm_04_08.h:825
struct osmo_lac_and_ci_id lac_and_ci
Definition: gsm0808_utils.h:43
uint16_t gsm0808_sc_cfg_from_gsm48_mr_cfg(const struct gsm48_multi_rate_conf *cfg, bool fr)
Determine a set of AMR speech codec configuration bits (S0-S15) from a given GSM 04.08 AMR configuration struct.
Definition: gsm0808_utils.c:1337
uint8_t gsm0808_enc_lcls(struct msgb *msg, const struct osmo_lcls *lcls)
Add LCLS parameters to a given msgb, 3GPP TS 48.008 §3.2.2.115 - 3.2.2.120.
Definition: gsm0808_utils.c:550
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:1800
char * osmo_gcr_dump(const struct osmo_lcls *lcls)
Dump GCR struct into static string buffer for printing.
Definition: gsm0808_utils.c:657
int gsm0808_cell_id_to_cgi(struct osmo_cell_global_id *cgi, const struct gsm0808_cell_id *cid)
Overwrite parts of cgi with values from a Cell Identifier.
Definition: gsm0808_utils.c:1724
char * gsm0808_cell_id_name_c(const void *ctx, const struct gsm0808_cell_id *cid)
Definition: gsm0808_utils.c:1816
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:706
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:1222
Definition: gsm23003.h:44
static enum gsm0808_cause_class gsm0808_cause_class(enum gsm0808_cause cause)
Definition: gsm0808_utils.h:142
void gsm0808_cell_id_to_list(struct gsm0808_cell_id_list2 *dst, const struct gsm0808_cell_id *src)
Convert a single Cell Identifier to a Cell Identifier List with one entry.
Definition: gsm0808_utils.c:1163
char * gsm0808_cell_id_name_buf(char *buf, size_t buflen, const struct gsm0808_cell_id *cid)
Definition: gsm0808_utils.c:1786
Definition: gsm_04_08.h:817
uint8_t gsm0808_enc_cause(struct msgb *msg, uint16_t cause)
Definition: gsm_utils.h:224
GSM TS 04.08 definitions.
GSM HR.
Definition: gsm_08_08.h:462
Definition: gsm_08_08.h:572
gsm0808_permitted_speech
GSM 08.08 3.2.2.11 Channel Type (see also 3GPP TS 48.008, section 3.2.2.11)
Definition: gsm_08_08.h:456
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:1810
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:1194
Definition: gsm_utils.h:222
void gsm0808_cell_id_from_cgi(struct gsm0808_cell_id *cid, enum CELL_IDENT id_discr, const struct osmo_cell_global_id *cgi)
Copy information from a CGI to form a Cell Identifier of the specified kind.
Definition: gsm0808_utils.c:1676
static bool gsm0808_cause_ext(enum gsm0808_cause cause)
Definition: gsm0808_utils.h:148
struct osmo_cell_global_id global
Definition: gsm0808_utils.h:42
static uint8_t gsm0808_current_channel_type_1(enum gsm_chan_t type)
Definition: gsm0808_utils.h:157
gsm0808_cause
Definition: gsm_08_08.h:331
const struct value_string gsm0808_cell_id_discr_names[]
value_string[] for enum CELL_IDENT.
Definition: gsm0808_utils.c:1759
Definition: gsm23003.h:28
FR AMR.
Definition: gsm_08_08.h:459
int gsm48_mr_cfg_from_gsm0808_sc_cfg(struct gsm48_multi_rate_conf *cfg, uint16_t s15_s0)
Determine a GSM 04.08 AMR configuration struct from a set of speech codec configuration bits (S0-S15)...
Definition: gsm0808_utils.c:1390
Parsed representation of Global Call Reference, 3GPP TS 29.205 Table B 2.1.9.1.
Definition: gsm29205.h:33
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:813
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:1284
Definition: gsm23003.h:16
uint8_t len
Definition: gsm_04_11.h:465
bool gcr_available
Definition: gsm0808_utils.h:67
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:1836
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:436
char * osmo_lcls_dump_buf(char *buf, size_t buf_len, const struct osmo_lcls *lcls)
Dump LCLS parameters (GCR excluded) into string for printing.
Definition: gsm0808_utils.c:602
static uint8_t gsm0808_chosen_channel(enum gsm_chan_t type, enum gsm48_chan_mode mode)
Return 3GPP TS 48.008 3.2.2.33 Chosen Channel.
Definition: gsm0808_utils.h:210
uint8_t mode
Definition: gsm_04_08.h:751
Definition: gsm_04_08.h:815
Definition: gsm_08_08.h:579
Definition: gsm_04_08.h:814
Definition: gsm_utils.h:221
result of the TLV parser
Definition: tlv.h:442
CELL_IDENT
Definition: gsm_08_08.h:16
char * gsm0808_cell_id_list_name_c(const void *ctx, const struct gsm0808_cell_id_list2 *cil)
Definition: gsm0808_utils.c:1874
char * gsm0808_channel_type_name_buf(char *buf, size_t buf_len, const struct gsm0808_channel_type *ct)
Definition: gsm0808_utils.c:1886
gsm_chan_t
Definition: gsm_utils.h:220
Definition: gsm_08_08.h:589
Definition: gsm_04_08.h:664
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:286
Parsed representation of Cell Identifier IE (3GPP TS 48.008 3.2.2.17)
Definition: gsm0808_utils.h:50
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:1867
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:399
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:977
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:479
exact_match
bool gsm0808_cell_ids_match(const struct gsm0808_cell_id *id1, const struct gsm0808_cell_id *id2, bool exact_match)
Return true if the common information between the two Cell Identifiers match.
Definition: gsm0808_utils.c:1639
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:261
gsm0808_lcls_config
Definition: gsm_08_08.h:610
int gsm0808_cell_id_matches_list(const struct gsm0808_cell_id *id, const struct gsm0808_cell_id_list2 *list, unsigned int match_nr, bool exact_match)
Find an index in a Cell Identifier list that matches a given single Cell Identifer.
Definition: gsm0808_utils.c:1656
const char * gsm0808_channel_type_name(const struct gsm0808_channel_type *ct)
Definition: gsm0808_utils.c:1894
Definition: gsm_04_08.h:813
uint16_t ci
Definition: gsm0808_utils.h:44
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:1504
GSM utility functions, e.g.
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:1246
bool corr_needed
§3.2.2.118 Correlation-Not-Needed.
Definition: gsm0808_utils.h:68
DEPRECATED: This definition of the cell identifier list is insufficient.
Definition: gsm_08_08.h:603
Definition: gsm_08_08.h:512