libosmogb  1.5.1.157-eabc
Osmocom Gb library
gprs_bssgp_rim.h
Go to the documentation of this file.
1 
3 /*
4  * (C) 2020-2021 by sysmocom - s.f.m.c. GmbH
5  * Author: Philipp Maier <pmaier@sysmocom.de>
6  *
7  * All Rights Reserved
8  *
9  * SPDX-License-Identifier: GPL-2.0+
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  *
24  */
25 
26 #pragma once
27 
28 #include <osmocom/gsm/gsm48.h>
31 
36 };
37 
39 
43 
47  union {
48  struct {
49  struct gprs_ra_id raid;
50  uint16_t cid;
51  } geran;
52  struct {
53  struct gprs_ra_id raid;
54  uint16_t rncid;
55  } utran;
56  struct {
58  /* See also 3GPP TS 36.413 9.2.1.37 and 3GPP TS 36.401 */
59  uint8_t global_enb_id[8];
61  } eutran;
62  };
63 };
64 
65 /* The encoded result of the rim routing information is, depending on the
66  * address type (discr) of variable length. */
67 #define BSSGP_RIM_ROUTING_INFO_MAXLEN 14
68 
69 char *bssgp_rim_ri_name_buf(char *buf, size_t buf_len, const struct bssgp_rim_routing_info *ri);
70 const char *bssgp_rim_ri_name(const struct bssgp_rim_routing_info *ri);
71 int bssgp_parse_rim_ri(struct bssgp_rim_routing_info *ri, const uint8_t *buf, unsigned int len);
72 int bssgp_create_rim_ri(uint8_t *buf, const struct bssgp_rim_routing_info *ri);
73 
74 /* 3GPP TS 48.018, table 11.3.63.1.1: RAN-INFORMATION-REQUEST Application Container coding for NACC */
76  struct osmo_cell_global_id_ps reprt_cell;
77 };
78 
79 int bssgp_dec_ran_inf_req_app_cont_nacc(struct bssgp_ran_inf_req_app_cont_nacc *cont, const uint8_t *buf, size_t len);
80 int bssgp_enc_ran_inf_req_app_cont_nacc(uint8_t *buf, size_t len, const struct bssgp_ran_inf_req_app_cont_nacc *cont);
81 
82 /* Length of NACC system information, see also: 3GPP TS 48.018 11.3.63.2.1 */
83 #define BSSGP_RIM_SI_LEN 21
84 #define BSSGP_RIM_PSI_LEN 22
85 
86 /* 3GPP TS 48.018, table 11.3.63.2.1.a: RAN-INFORMATION Application Container coding for NACC */
88  struct osmo_cell_global_id_ps reprt_cell;
89  bool type_psi;
90  uint8_t num_si;
91 
92  /* Pointer to system information messages */
93  const uint8_t *si[127];
94 };
95 
96 int bssgp_dec_ran_inf_app_cont_nacc(struct bssgp_ran_inf_app_cont_nacc *cont, const uint8_t *buf, size_t len);
97 int bssgp_enc_ran_inf_app_cont_nacc(uint8_t *buf, size_t len, const struct bssgp_ran_inf_app_cont_nacc *cont);
98 
99 /* 3GPP TS 48.018, table 11.3.64.1.b, NACC Cause coding */
107 };
108 
109 extern const struct value_string bssgp_nacc_cause_strs[];
110 
112 static inline const char *bssgp_nacc_cause_str(enum bssgp_nacc_cause val)
113 { return get_value_string(bssgp_nacc_cause_strs, val); }
114 
115 /* 3GPP TS 48.018, table 11.3.64.1.a, Application Error Container coding for NACC */
117  enum bssgp_nacc_cause nacc_cause;
118 
119  /* Pointer to errornous application container */
120  const uint8_t *err_app_cont;
122 };
123 
124 int bssgp_dec_app_err_cont_nacc(struct bssgp_app_err_cont_nacc *cont, const uint8_t *buf, size_t len);
125 int bssgp_enc_app_err_cont_nacc(uint8_t *buf, size_t len, const struct bssgp_app_err_cont_nacc *cont);
126 
127 /* 3GPP TS 48.018, table 11.3.61.b: RIM Application Identity coding */
134 };
135 
136 extern const struct value_string bssgp_ran_inf_app_id_strs[];
137 
139 static inline const char *bssgp_ran_inf_app_id_str(enum bssgp_ran_inf_app_id val)
141 
142 /* 3GPP TS 48.018, table 11.3.62a.1.b: RAN-INFORMATION-REQUEST RIM Container Contents */
144  enum bssgp_ran_inf_app_id app_id;
145  uint32_t seq_num;
146  struct bssgp_rim_pdu_ind pdu_ind;
147  uint8_t prot_ver;
148 
149  /* Nested application container */
150  union {
151  struct bssgp_ran_inf_req_app_cont_nacc app_cont_nacc;
152  /* TODO: add containers for Si3, MBMS, SON, UTRA-SI */
153  } u;
154 
155  /* Pointer to SON-transfer application identity, only present if app_id is indicating "son-transfer",
156  * see also 3GPP TS 48.018, section 11.3.108 and 3GPP TS 36.413 annex B.1.1 */
157  const uint8_t *son_trans_app_id;
159 };
160 
161 int bssgp_dec_ran_inf_req_rim_cont(struct bssgp_ran_inf_req_rim_cont *cont, const uint8_t *buf, size_t len);
162 int bssgp_enc_ran_inf_req_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_req_rim_cont *cont);
163 
164 /* 3GPP TS 48.018, table 11.3.62a.2.b: RAN-INFORMATION RIM Container Contents */
166  enum bssgp_ran_inf_app_id app_id;
167  uint32_t seq_num;
168  struct bssgp_rim_pdu_ind pdu_ind;
169  uint8_t prot_ver;
170  bool app_err;
171 
172  /* Nested application container */
173  union {
174  struct bssgp_ran_inf_app_cont_nacc app_cont_nacc;
175  struct bssgp_app_err_cont_nacc app_err_cont_nacc;
176  /* TODO: add containers for Si3, MBMS, SON, UTRA-SI */
177  } u;
178 
179  /* Pointer to SON-transfer application identity, only present if app_id is indicating "son-transfer",
180  * see also 3GPP TS 48.018, section 11.3.108 and 3GPP TS 36.413 annex B.1.1 */
181  const uint8_t *son_trans_app_id;
183 };
184 
185 int bssgp_dec_ran_inf_rim_cont(struct bssgp_ran_inf_rim_cont *cont, const uint8_t *buf, size_t len);
186 int bssgp_enc_ran_inf_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_rim_cont *cont);
187 
188 /* 3GPP TS 48.018, table 11.3.62a.3.b: RAN-INFORMATION-ACK RIM Container Contents */
190  enum bssgp_ran_inf_app_id app_id;
191  uint32_t seq_num;
192  uint8_t prot_ver;
193 
194  /* Pointer to SON-transfer application identity, only present if app_id is indicating "son-transfer",
195  * see also 3GPP TS 48.018, section 11.3.108 and 3GPP TS 36.413 annex B.1.1 */
196  const uint8_t *son_trans_app_id;
198 };
199 
200 int bssgp_dec_ran_inf_ack_rim_cont(struct bssgp_ran_inf_ack_rim_cont *cont, const uint8_t *buf, size_t len);
201 int bssgp_enc_ran_inf_ack_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_ack_rim_cont *cont);
202 
203 /* 3GPP TS 48.018, table 11.3.62a.4.b: RAN-INFORMATION-ERROR RIM Container Contents */
205  enum bssgp_ran_inf_app_id app_id;
206  uint8_t cause;
207  uint8_t prot_ver;
208 
209  /* Pointer to (encoded) errornous PDU,
210  * see also: 3GPP TS 48.018, section 11.3.24 */
211  const uint8_t *err_pdu;
212  size_t err_pdu_len;
213 
214  /* Pointer to SON-transfer application identity, only present if app_id is indicating "son-transfer",
215  * see also 3GPP TS 48.018, section 11.3.108 and 3GPP TS 36.413 annex B.1.1 */
216  const uint8_t *son_trans_app_id;
218 };
219 
220 int bssgp_dec_ran_inf_err_rim_cont(struct bssgp_ran_inf_err_rim_cont *cont, const uint8_t *buf, size_t len);
221 int bssgp_enc_ran_inf_err_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_err_rim_cont *cont);
222 
223 /* 3GPP TS 48.018, table 11.3.62a.5.b: RAN-INFORMATION-APPLICATION-ERROR RIM Container Contents */
225  enum bssgp_ran_inf_app_id app_id;
226  uint32_t seq_num;
227  struct bssgp_rim_pdu_ind pdu_ind;
228  uint8_t prot_ver;
229 
230  /* Nested application container */
231  union {
232  struct bssgp_app_err_cont_nacc app_err_cont_nacc;
233  /* TODO: add containers for Si3, MBMS, SON, UTRA-SI */
234  } u;
235 };
236 
237 int bssgp_dec_ran_inf_app_err_rim_cont(struct bssgp_ran_inf_app_err_rim_cont *cont, const uint8_t *buf, size_t len);
238 int bssgp_enc_ran_inf_app_err_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_app_err_rim_cont *cont);
239 
240 /* Chapter 10.6.1: RAN-INFORMATION-REQUEST */
242  struct bssgp_rim_routing_info routing_info_dest;
243  struct bssgp_rim_routing_info routing_info_src;
244 
245  /* Encoded variant of the RIM container */
246  uint8_t rim_cont_iei;
247  const uint8_t *rim_cont;
248  unsigned int rim_cont_len;
249 
250  /* Decoded variant of the RIM container */
252  union {
253  struct bssgp_ran_inf_req_rim_cont req_rim_cont;
254  struct bssgp_ran_inf_rim_cont rim_cont;
255  struct bssgp_ran_inf_ack_rim_cont ack_rim_cont;
256  struct bssgp_ran_inf_err_rim_cont err_rim_cont;
257  struct bssgp_ran_inf_app_err_rim_cont app_err_rim_cont;
258  } decoded;
259 
260  /* When receiving a PDU from BSSGP the encoded variant of the RIM
261  * container will always be present. The decoded variant will be
262  * present in addition whenever BSSGP was able to decode the container.
263  *
264  * When sending a PDU to BSSGP, then the decoded variant is used when
265  * it is available. The encoded variant (if present) will be ignored
266  * then. */
267 };
268 
269 int bssgp_parse_rim_pdu(struct bssgp_ran_information_pdu *pdu, const struct msgb *msg);
270 struct msgb *bssgp_encode_rim_pdu(const struct bssgp_ran_information_pdu *pdu);
271 
272 int bssgp_tx_rim(const struct bssgp_ran_information_pdu *pdu, uint16_t nsei);
bool decoded_present
Definition: gprs_bssgp_rim.h:251
const uint8_t * son_trans_app_id
Definition: gprs_bssgp_rim.h:196
size_t son_trans_app_id_len
Definition: gprs_bssgp_rim.h:158
int bssgp_dec_ran_inf_req_rim_cont(struct bssgp_ran_inf_req_rim_cont *cont, const uint8_t *buf, size_t len)
Decode a RAN Information Request RIM Container (3GPP TS 48.018, table 11.3.62a.1.b).
Definition: gprs_bssgp_rim.c:472
int bssgp_enc_ran_inf_app_err_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_app_err_rim_cont *cont)
Encode a RAN Information Application Error RIM Container (3GPP TS 48.018, table 11.3.62a.5.b).
Definition: gprs_bssgp_rim.c:918
size_t son_trans_app_id_len
Definition: gprs_bssgp_rim.h:182
uint8_t prot_ver
Definition: gprs_bssgp_rim.h:192
uint8_t prot_ver
Definition: gprs_bssgp_rim.h:169
Definition: gprs_bssgp_rim.h:106
unsigned int rim_cont_len
Definition: gprs_bssgp_rim.h:248
const struct value_string bssgp_rim_routing_info_discr_strs[]
Definition: gprs_bssgp_rim.c:45
Definition: gprs_bssgp_rim.h:241
const char * get_value_string(const struct value_string *vs, uint32_t val)
uint8_t global_enb_id[8]
Definition: gprs_bssgp_rim.h:59
Definition: gprs_bssgp_rim.h:87
Definition: gprs_bssgp_rim.h:104
const uint8_t * rim_cont
Definition: gprs_bssgp_rim.h:247
Definition: gprs_bssgp_rim.h:101
uint16_t rncid
Definition: gprs_bssgp_rim.h:54
size_t err_app_cont_len
Definition: gprs_bssgp_rim.h:121
Definition: gsm_08_18.h:364
bssgp_ran_inf_app_id
Definition: gprs_bssgp_rim.h:128
static const char * bssgp_nacc_cause_str(enum bssgp_nacc_cause val)
Obtain a human-readable string for NACC Cause code.
Definition: gprs_bssgp_rim.h:112
static const char * bssgp_rim_routing_info_discr_str(enum bssgp_rim_routing_info_discr val)
Obtain a human-readable string for NACC Cause code.
Definition: gprs_bssgp_rim.h:41
const uint8_t * son_trans_app_id
Definition: gprs_bssgp_rim.h:181
Definition: gprs_bssgp_rim.h:204
Definition: gprs_bssgp_rim.h:131
bool app_err
Definition: gprs_bssgp_rim.h:170
bssgp_rim_routing_info_discr
Definition: gprs_bssgp_rim.h:32
Tracking area TS 24.301, section 9.9.3.32.
Definition: gsm_24_301.h:6
struct bssgp_rim_routing_info::@5::@9 eutran
struct osmo_eutran_tai tai
Definition: gprs_bssgp_rim.h:57
const struct value_string bssgp_nacc_cause_strs[]
Definition: gprs_bssgp_rim.c:344
int bssgp_enc_ran_inf_err_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_err_rim_cont *cont)
Encode a RAN Information Error RIM Container (3GPP TS 48.018, table 11.3.62a.4.b).
Definition: gprs_bssgp_rim.c:845
int bssgp_enc_ran_inf_req_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_req_rim_cont *cont)
Encode a RAN Information Request RIM Container (3GPP TS 48.018, table 11.3.62a.1.b).
Definition: gprs_bssgp_rim.c:544
uint8_t rim_cont_iei
Definition: gprs_bssgp_rim.h:246
Definition: gprs_bssgp_rim.h:103
int bssgp_dec_ran_inf_app_cont_nacc(struct bssgp_ran_inf_app_cont_nacc *cont, const uint8_t *buf, size_t len)
Decode a RAN Information Application Container (3GPP TS 48.018, section 11.3.63.2.1).
Definition: gprs_bssgp_rim.c:254
size_t son_trans_app_id_len
Definition: gprs_bssgp_rim.h:217
BSSGP RIM Routing information, see also 3GPP TS 48.018, section 11.3.70.
Definition: gprs_bssgp_rim.h:45
size_t son_trans_app_id_len
Definition: gprs_bssgp_rim.h:197
int bssgp_dec_app_err_cont_nacc(struct bssgp_app_err_cont_nacc *cont, const uint8_t *buf, size_t len)
Decode a Application Error Container for NACC (3GPP TS 48.018, section 11.3.64.1).
Definition: gprs_bssgp_rim.c:358
uint16_t nsei
Identifiers of a BTS, equal to &#39;struct bssgp_bts_ctx&#39;.
Definition: gprs_msgb.h:259
uint32_t seq_num
Definition: gprs_bssgp_rim.h:167
const struct value_string bssgp_ran_inf_app_id_strs[]
Definition: gprs_bssgp_rim.c:459
uint8_t num_si
Definition: gprs_bssgp_rim.h:90
Definition: gprs_bssgp_rim.h:165
Definition: gprs_bssgp_rim.h:133
Definition: gprs_bssgp_rim.h:143
Definition: gprs_bssgp_rim.h:130
static const char * bssgp_ran_inf_app_id_str(enum bssgp_ran_inf_app_id val)
Obtain a human-readable string for RIM Application Identity code.
Definition: gprs_bssgp_rim.h:139
int bssgp_enc_ran_inf_ack_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_ack_rim_cont *cont)
Encode a RAN Information ACK RIM Container (3GPP TS 48.018, table 11.3.62a.3.b).
Definition: gprs_bssgp_rim.c:771
int bssgp_enc_app_err_cont_nacc(uint8_t *buf, size_t len, const struct bssgp_app_err_cont_nacc *cont)
Encode Application Error Container for NACC (3GPP TS 48.018, section 11.3.64.1).
Definition: gprs_bssgp_rim.c:382
bssgp_nacc_cause
Definition: gprs_bssgp_rim.h:100
const char * bssgp_rim_ri_name(const struct bssgp_rim_routing_info *ri)
Encode a RIM Routing information into a human readable string.
Definition: gprs_bssgp_rim.c:206
int bssgp_dec_ran_inf_rim_cont(struct bssgp_ran_inf_rim_cont *cont, const uint8_t *buf, size_t len)
Decode a RAN Information RIM Container (3GPP TS 48.018, table 11.3.62a.2.b).
Definition: gprs_bssgp_rim.c:595
Definition: gprs_bssgp_rim.h:33
uint8_t global_enb_id_len
Definition: gprs_bssgp_rim.h:60
size_t err_pdu_len
Definition: gprs_bssgp_rim.h:212
int bssgp_create_rim_ri(uint8_t *buf, const struct bssgp_rim_routing_info *ri)
Encode a RIM Routing information IE (3GPP TS 48.018, chapter 11.3.70).
Definition: gprs_bssgp_rim.c:103
const uint8_t * son_trans_app_id
Definition: gprs_bssgp_rim.h:216
int bssgp_dec_ran_inf_app_err_rim_cont(struct bssgp_ran_inf_app_err_rim_cont *cont, const uint8_t *buf, size_t len)
Decode a RAN Information Application Error RIM Container (3GPP TS 48.018, table 11.3.62a.5.b).
Definition: gprs_bssgp_rim.c:878
uint32_t seq_num
Definition: gprs_bssgp_rim.h:226
uint32_t seq_num
Definition: gprs_bssgp_rim.h:145
int bssgp_dec_ran_inf_err_rim_cont(struct bssgp_ran_inf_err_rim_cont *cont, const uint8_t *buf, size_t len)
Decode a RAN Information Error RIM Container (3GPP TS 48.018, table 11.3.62a.4.b).
Definition: gprs_bssgp_rim.c:800
const uint8_t * err_app_cont
Definition: gprs_bssgp_rim.h:120
int bssgp_enc_ran_inf_app_cont_nacc(uint8_t *buf, size_t len, const struct bssgp_ran_inf_app_cont_nacc *cont)
Encode a RAN Information Application Container (3GPP TS 48.018, section 11.3.63.2.1).
Definition: gprs_bssgp_rim.c:305
enum bssgp_rim_routing_info_discr discr
Definition: gprs_bssgp_rim.h:46
Definition: gprs_bssgp_rim.h:129
Definition: gprs_bssgp_rim.h:105
int bssgp_parse_rim_ri(struct bssgp_rim_routing_info *ri, const uint8_t *buf, unsigned int len)
Parse a RIM Routing information IE (3GPP TS 48.018, chapter 11.3.70).
Definition: gprs_bssgp_rim.c:56
Definition: gprs_bssgp_rim.h:116
int bssgp_parse_rim_pdu(struct bssgp_ran_information_pdu *pdu, const struct msgb *msg)
Parse a given message buffer into a rim-pdu struct.
Definition: gprs_bssgp_rim.c:958
uint8_t prot_ver
Definition: gprs_bssgp_rim.h:147
struct gprs_ra_id raid
Definition: gprs_bssgp_rim.h:49
uint32_t seq_num
Definition: gprs_bssgp_rim.h:191
char * bssgp_rim_ri_name_buf(char *buf, size_t buf_len, const struct bssgp_rim_routing_info *ri)
Encode a RIM Routing information into a human readable string.
Definition: gprs_bssgp_rim.c:155
int bssgp_enc_ran_inf_req_app_cont_nacc(uint8_t *buf, size_t len, const struct bssgp_ran_inf_req_app_cont_nacc *cont)
Encode a RAN Information Request Application Container for NACC (3GPP TS 48.018, section 11...
Definition: gprs_bssgp_rim.c:235
uint16_t cid
Definition: gprs_bssgp_rim.h:50
int bssgp_enc_ran_inf_rim_cont(uint8_t *buf, size_t len, const struct bssgp_ran_inf_rim_cont *cont)
Encode a RAN Information RIM Container (3GPP TS 48.018, table 11.3.62a.2.b).
Definition: gprs_bssgp_rim.c:662
int bssgp_tx_rim(const struct bssgp_ran_information_pdu *pdu, uint16_t nsei)
Send RIM RAN INFORMATION REQUEST via BSSGP (3GPP TS 48.018, section 10.6.1).
Definition: gprs_bssgp_rim.c:1155
int bssgp_dec_ran_inf_ack_rim_cont(struct bssgp_ran_inf_ack_rim_cont *cont, const uint8_t *buf, size_t len)
Decode a RAN Information ACK RIM Container (3GPP TS 48.018, table 11.3.62a.3.b).
Definition: gprs_bssgp_rim.c:733
Definition: gprs_bssgp_rim.h:35
const uint8_t * err_pdu
Definition: gprs_bssgp_rim.h:211
Definition: gprs_bssgp_rim.h:132
static size_t len(const char *str)
Definition: gprs_bssgp_rim.h:102
bool type_psi
Definition: gprs_bssgp_rim.h:89
int bssgp_dec_ran_inf_req_app_cont_nacc(struct bssgp_ran_inf_req_app_cont_nacc *cont, const uint8_t *buf, size_t len)
Decode a RAN Information Request Application Container for NACC (3GPP TS 48.018, section 11...
Definition: gprs_bssgp_rim.c:216
Definition: gprs_bssgp_rim.h:224
Definition: gprs_bssgp_rim.h:75
struct bssgp_rim_routing_info::@5::@7 geran
struct msgb * bssgp_encode_rim_pdu(const struct bssgp_ran_information_pdu *pdu)
Encode a given rim-pdu struct into a message buffer.
Definition: gprs_bssgp_rim.c:1062
Definition: gprs_bssgp_rim.h:34
Definition: gprs_bssgp_rim.h:189
uint8_t prot_ver
Definition: gprs_bssgp_rim.h:228
uint8_t prot_ver
Definition: gprs_bssgp_rim.h:207
const uint8_t * son_trans_app_id
Definition: gprs_bssgp_rim.h:157
uint8_t cause
Definition: gprs_bssgp_rim.h:206
struct bssgp_rim_routing_info::@5::@8 utran