libosmogsm 1.13.1.1-afb4 Osmocom GSM library

rlp.h
Go to the documentation of this file.
1/*
2 * GSM RLP (Radio Link Protocol) as used in CSD (3GPP TS 44.022)
3 *
4 * Copyright (C) 2022-2023 Harald Welte <laforge@osmocom.org>
5 *
6 * All Rights Reserved
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 */
18
19
20
21#pragma once
22#include <stdint.h>
23#include <stdbool.h>
24#include <osmocom/core/utils.h>
25
31 enum osmo_rlp_ftype {
32 OSMO_RLP_FT_U,
33 OSMO_RLP_FT_S,
34 OSMO_RLP_FT_IS,
35};
36 extern const struct value_string osmo_rlp_ftype_vals[];
37
39 enum osmo_rlp_u_ftype {
40 OSMO_RLP_U_FT_SABM = 0x07,
41 OSMO_RLP_U_FT_UA = 0x0c,
42 OSMO_RLP_U_FT_DISC = 0x08,
43 OSMO_RLP_U_FT_DM = 0x03,
44 OSMO_RLP_U_FT_NULL = 0x0f,
45 OSMO_RLP_U_FT_UI = 0x00,
46 OSMO_RLP_U_FT_XID = 0x17,
47 OSMO_RLP_U_FT_TEST = 0x1c,
48 OSMO_RLP_U_FT_REMAP = 0x11,
49};
50 extern const struct value_string osmo_rlp_ftype_u_vals[];
51
53 enum osmo_rlp_s_ftype {
54 OSMO_RLP_S_FT_RR = 0,
55 OSMO_RLP_S_FT_REJ = 2,
56 OSMO_RLP_S_FT_RNR = 1,
57 OSMO_RLP_S_FT_SREJ = 3,
58};
59 extern const struct value_string osmo_rlp_ftype_s_vals[];
60
62 struct osmo_rlp_frame_decoded {
63 uint8_t version;
64 enum osmo_rlp_ftype ftype;
65 enum osmo_rlp_u_ftype u_ftype;
66 enum osmo_rlp_s_ftype s_ftype;
67 bool c_r;
68 bool p_f;
69 uint8_t s_bits;
70 uint16_t n_s;
71 uint16_t n_r;
72 uint32_t fcs;
73 uint8_t info[536/8];
74 uint16_t info_len;
75};
76
77 int osmo_rlp_decode(struct osmo_rlp_frame_decoded *out, uint8_t version, const uint8_t *data, size_t data_len);
78 int osmo_rlp_encode(uint8_t *out, size_t out_size, const struct osmo_rlp_frame_decoded *in);
79uint32_t osmo_rlp_fcs_compute(const uint8_t *in, size_t in_len);
80
data
uint8_t data[0]
osmo_rlp_decode
int osmo_rlp_decode(struct osmo_rlp_frame_decoded *out, uint8_t version, const uint8_t *data, size_t data_len)
decode a RLP frame into its abstract representation.
Definition: rlp.c:69
osmo_rlp_u_ftype
osmo_rlp_u_ftype
RLP U-Frame Type as per 3GPP TS 24.022 Section 5.2.1.
Definition: rlp.h:39
osmo_rlp_encode
int osmo_rlp_encode(uint8_t *out, size_t out_size, const struct osmo_rlp_frame_decoded *in)
encode a RLP frame from its abstract representation.
Definition: rlp.c:122
osmo_rlp_ftype_u_vals
const struct value_string osmo_rlp_ftype_u_vals[]
Definition: rlp.c:39
osmo_rlp_s_ftype
osmo_rlp_s_ftype
RLP S-Frame type as per 3GPP TS 24.022 Section 5.2.1.
Definition: rlp.h:53
osmo_rlp_ftype_s_vals
const struct value_string osmo_rlp_ftype_s_vals[]
Definition: rlp.c:52
osmo_rlp_fcs_compute
uint32_t osmo_rlp_fcs_compute(const uint8_t *in, size_t in_len)
compute RLP FCS according to 3GPP TS 24.022 Section 4.4.
Definition: rlp.c:230
osmo_rlp_ftype_vals
const struct value_string osmo_rlp_ftype_vals[]
Definition: rlp.c:32
osmo_rlp_ftype
osmo_rlp_ftype
RLP frame type as per 3GPP TS 24.022 Section 5.2.1.
Definition: rlp.h:31
OSMO_RLP_U_FT_REMAP
@ OSMO_RLP_U_FT_REMAP
Definition: rlp.h:48
OSMO_RLP_U_FT_TEST
@ OSMO_RLP_U_FT_TEST
Definition: rlp.h:47
OSMO_RLP_U_FT_XID
@ OSMO_RLP_U_FT_XID
Definition: rlp.h:46
OSMO_RLP_U_FT_UI
@ OSMO_RLP_U_FT_UI
Definition: rlp.h:45
OSMO_RLP_U_FT_DISC
@ OSMO_RLP_U_FT_DISC
Definition: rlp.h:42
OSMO_RLP_U_FT_DM
@ OSMO_RLP_U_FT_DM
Definition: rlp.h:43
OSMO_RLP_U_FT_SABM
@ OSMO_RLP_U_FT_SABM
Definition: rlp.h:40
OSMO_RLP_U_FT_NULL
@ OSMO_RLP_U_FT_NULL
Definition: rlp.h:44
OSMO_RLP_U_FT_UA
@ OSMO_RLP_U_FT_UA
Definition: rlp.h:41
OSMO_RLP_S_FT_SREJ
@ OSMO_RLP_S_FT_SREJ
Definition: rlp.h:57
OSMO_RLP_S_FT_RR
@ OSMO_RLP_S_FT_RR
Definition: rlp.h:54
OSMO_RLP_S_FT_RNR
@ OSMO_RLP_S_FT_RNR
Definition: rlp.h:56
OSMO_RLP_S_FT_REJ
@ OSMO_RLP_S_FT_REJ
Definition: rlp.h:55
OSMO_RLP_FT_S
@ OSMO_RLP_FT_S
Definition: rlp.h:33
OSMO_RLP_FT_IS
@ OSMO_RLP_FT_IS
Definition: rlp.h:34
OSMO_RLP_FT_U
@ OSMO_RLP_FT_U
Definition: rlp.h:32
version
char version[20]
Definition: ipaccess.h:10
osmo_rlp_frame_decoded
Data structure representing one decoded RLP frame.
Definition: rlp.h:62
osmo_rlp_frame_decoded::ftype
enum osmo_rlp_ftype ftype
Definition: rlp.h:64
osmo_rlp_frame_decoded::p_f
bool p_f
Definition: rlp.h:68
osmo_rlp_frame_decoded::info_len
uint16_t info_len
Definition: rlp.h:74
osmo_rlp_frame_decoded::fcs
uint32_t fcs
Definition: rlp.h:72
osmo_rlp_frame_decoded::n_s
uint16_t n_s
Definition: rlp.h:70
osmo_rlp_frame_decoded::s_bits
uint8_t s_bits
Definition: rlp.h:69
osmo_rlp_frame_decoded::c_r
bool c_r
Definition: rlp.h:67
osmo_rlp_frame_decoded::n_r
uint16_t n_r
Definition: rlp.h:71
osmo_rlp_frame_decoded::version
uint8_t version
Definition: rlp.h:63
osmo_rlp_frame_decoded::info
uint8_t info[536/8]
Definition: rlp.h:73
osmo_rlp_frame_decoded::u_ftype
enum osmo_rlp_u_ftype u_ftype
Definition: rlp.h:65
osmo_rlp_frame_decoded::s_ftype
enum osmo_rlp_s_ftype s_ftype
Definition: rlp.h:66
value_string
utils.h