Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 1 | /* LAPDm definitiona according to 3GPP TS 44.006 */ |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 2 | /* (C) 2017-2018 bh Harald Welte <laforge@gnumonks.org> */ |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 3 | module LAPDm_Types { |
| 4 | |
| 5 | import from General_Types all; |
| 6 | import from Osmocom_Types all; |
| 7 | |
| 8 | type uint3_t LapdmSapi; |
| 9 | type BIT2 LapdmSBits; |
| 10 | type BIT3 LapdmUBits; |
| 11 | type BIT2 LapdmU2Bits; |
| 12 | |
Harald Welte | 0472ab4 | 2018-03-12 15:02:26 +0100 | [diff] [blame^] | 13 | /* 44.006 6.3.2 */ |
| 14 | const boolean cr_MO_CMD := false; |
| 15 | const boolean cr_MO_RSP := true; |
| 16 | const boolean cr_MT_CMD := true; |
| 17 | const boolean cr_MT_RSP := false; |
| 18 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 19 | /* TS 44.006 Figure 4 */ |
| 20 | type record LapdmAddressField { |
| 21 | BIT1 spare, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 22 | uint2_t lpd, |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 23 | LapdmSapi sapi, |
| 24 | boolean c_r, |
| 25 | boolean ea |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 26 | } with { variant "FIELDORDER(msb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 27 | |
Harald Welte | 9e4725d | 2017-07-16 23:18:09 +0200 | [diff] [blame] | 28 | template LapdmAddressField tr_LapdmAddr(template LapdmSapi sapi, template boolean c_r) := { |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 29 | spare := '0'B, |
| 30 | lpd := 0, |
| 31 | sapi := sapi, |
| 32 | c_r := c_r, |
| 33 | ea := true |
| 34 | }; |
| 35 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 36 | template (value) LapdmAddressField ts_LapdmAddr(LapdmSapi sapi, boolean c_r) := { |
| 37 | spare := '0'B, |
| 38 | lpd := 0, |
| 39 | sapi := sapi, |
| 40 | c_r := c_r, |
| 41 | ea := true |
| 42 | }; |
| 43 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 44 | type record LapdmCtrlI { |
Harald Welte | ffcad68 | 2017-07-30 22:51:04 +0200 | [diff] [blame] | 45 | BIT1 spare ('0'B), |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 46 | uint3_t n_s, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 47 | boolean p, |
| 48 | uint3_t n_r |
| 49 | } with { variant "FIELDORDER(lsb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 50 | |
| 51 | type record LapdmCtrlS { |
Harald Welte | ffcad68 | 2017-07-30 22:51:04 +0200 | [diff] [blame] | 52 | BIT2 spare ('01'B), |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 53 | LapdmSBits s, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 54 | boolean p_f, |
| 55 | uint3_t n_r |
| 56 | } with { variant "FIELDORDER(lsb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 57 | |
| 58 | type record LapdmCtrlU { |
Harald Welte | ffcad68 | 2017-07-30 22:51:04 +0200 | [diff] [blame] | 59 | BIT2 spare ('11'B), |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 60 | LapdmU2Bits u2, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 61 | boolean p_f, |
| 62 | LapdmUBits u |
| 63 | } with { variant "FIELDORDER(lsb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 64 | |
| 65 | /* TS 44.006 Table 3 */ |
| 66 | type union LapdmCtrl { |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 67 | LapdmCtrlS s, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 68 | LapdmCtrlU u, |
| 69 | LapdmCtrlI i, |
| 70 | uint8_t other |
| 71 | } with { variant "TAG(u, spare = '11'B; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 72 | s, spare = '01'B; |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 73 | i, spare = '0'B; |
| 74 | other, OTHERWISE)" }; |
| 75 | /* )" }; */ |
| 76 | |
| 77 | /* TS 44.006 Table 4 */ |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 78 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 79 | template LapdmCtrl tr_LapdmCtrlS := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 80 | s := { spare := '01'B, s := ?, p_f := ?, n_r := ? } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 81 | }; |
| 82 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 83 | template LapdmCtrl tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 84 | u := { spare := '11'B, u2 := ?, p_f := ?, u := ? } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 85 | }; |
| 86 | |
| 87 | /* TS 44.006 Table 4 */ |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 88 | template LapdmCtrl tr_LapdmCtrlI(template uint3_t nr, template uint3_t ns, template boolean p) := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 89 | i := { spare := '0'B, n_s := ns, p := p, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 90 | }; |
| 91 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 92 | template LapdmCtrl tr_LapdmCtrlRR(template uint3_t nr, template boolean pf) modifies tr_LapdmCtrlS := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 93 | s := { s:= '00'B, p_f := pf, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 94 | }; |
| 95 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 96 | template LapdmCtrl tr_LapdmCtrlRNR(template uint3_t nr, template boolean pf) modifies tr_LapdmCtrlS := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 97 | s := { s:= '01'B, p_f := pf, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 98 | }; |
| 99 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 100 | template LapdmCtrl tr_LapdmCtrlREJ(template uint3_t nr, template boolean pf) modifies tr_LapdmCtrlS := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 101 | s := { s:= '10'B, p_f := pf, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 102 | }; |
| 103 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 104 | template LapdmCtrl tr_LapdmCtrlSABM(template boolean p) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 105 | u := { u2 := '11'B, p_f := p, u := '001'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 106 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 107 | template (value) LapdmCtrl ts_LapdmCtrlSABM(boolean p) := { |
| 108 | u := { spare := '11'B, u2 := '11'B, p_f := p, u := '001'B } |
| 109 | }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 110 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 111 | template LapdmCtrl tr_LapdmCtrlDM(template boolean f) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 112 | u := { u2 := '11'B, p_f := f, u := '000'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 113 | }; |
| 114 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 115 | template LapdmCtrl tr_LapdmCtrlUI(template boolean p) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 116 | u := { u2 := '00'B, p_f := p, u := '000'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 117 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 118 | template (value) LapdmCtrl ts_LapdmCtrlUI(boolean p) := { |
| 119 | u := { spare := '11'B, u2 := '00'B, p_f := p, u := '000'B } |
| 120 | }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 121 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 122 | template LapdmCtrl tr_LapdmCtrlDISC(template boolean p) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 123 | u := { u2 := '00'B, p_f := p, u := '010'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 124 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 125 | template LapdmCtrl ts_LapdmCtrlDISC(boolean p) := { |
| 126 | u := { spare := '11'B, u2 := '00'B, p_f := p, u := '010'B } |
| 127 | }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 128 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 129 | template LapdmCtrl tr_LapdmCtrlUA(template boolean f) modifies tr_LapdmCtrlU := { |
Harald Welte | d4ba7ff | 2017-07-17 21:00:48 +0200 | [diff] [blame] | 130 | u := { u2 := '00'B, p_f := f, u := '011'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 131 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 132 | template (value) LapdmCtrl ts_LapdmCtrlUA(boolean f) := { |
| 133 | u := { spare := '11'B, u2 := '00'B, p_f := f, u := '011'B } |
| 134 | }; |
| 135 | |
| 136 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 137 | |
Harald Welte | 1bd7c32 | 2017-07-17 20:59:46 +0200 | [diff] [blame] | 138 | external function dec_LapdmAddressField(in octetstring stream) return LapdmAddressField |
| 139 | with { extension "prototype(convert) decode(RAW)" }; |
| 140 | |
| 141 | external function dec_LapdmCtrl(in octetstring stream) return LapdmCtrl |
| 142 | with { extension "prototype(convert) decode(RAW)" }; |
| 143 | |
| 144 | external function dec_LapdmCtrlU(in octetstring stream) return LapdmCtrlU |
| 145 | with { extension "prototype(convert) decode(RAW)" }; |
| 146 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 147 | /* Formats B, Bter and B4 are used on DCCHs for frames containing an information field: |
| 148 | /* - format Bter is used on request of higher layers if and only if short L2 header type 1 is |
| 149 | * supported and a UI command is to be transmitted on SAPI 0 */ |
| 150 | /* - format B4 is used for UI frames transmitted by the network on SACCH; */ |
| 151 | /* - format B is applied in all other cases. */ |
| 152 | /* Format Bbis is used only on BCCH, PCH, NCH, and AGCH. |
| 153 | |
| 154 | /* Format B */ |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 155 | type record LapdmFrameAB { |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 156 | LapdmAddressField addr, |
| 157 | LapdmCtrl ctrl, |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 158 | uint6_t len, |
Harald Welte | d4ba7ff | 2017-07-17 21:00:48 +0200 | [diff] [blame] | 159 | boolean m, |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 160 | uint1_t el, |
| 161 | octetstring payload /* zero-length in Frame A */ |
Harald Welte | d4ba7ff | 2017-07-17 21:00:48 +0200 | [diff] [blame] | 162 | } with { variant (len) "LENGTHTO(payload)" |
| 163 | variant "FIELDORDER(msb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 164 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 165 | external function enc_LapdmFrameAB(in LapdmFrameAB si) return octetstring |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 166 | with { extension "prototype(convert) encode(RAW)" }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 167 | external function dec_LapdmFrameAB(in octetstring stream) return LapdmFrameAB |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 168 | with { extension "prototype(convert) decode(RAW)" }; |
| 169 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 170 | /* Format B4 */ |
| 171 | type record LapdmFrameB4 { |
| 172 | LapdmAddressField addr, |
| 173 | LapdmCtrl ctrl, |
| 174 | octetstring payload |
| 175 | } with { variant "" }; |
| 176 | |
| 177 | external function enc_LapdmFrameB4(in LapdmFrameB4 si) return octetstring |
| 178 | with { extension "prototype(convert) encode(RAW)" }; |
| 179 | external function dec_LapdmFrameB4(in octetstring stream) return LapdmFrameB4 |
| 180 | with { extension "prototype(convert) decode(RAW)" }; |
| 181 | |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 182 | type record LapdmFrameBbis { |
| 183 | octetstring payload |
| 184 | } with { variant "" }; |
| 185 | |
| 186 | external function enc_LapdmFrameBbis(in LapdmFrameBbis si) return octetstring |
| 187 | with { extension "prototype(convert) encode(RAW)" }; |
| 188 | external function dec_LapdmFrameBbis(in octetstring stream) return LapdmFrameBbis |
| 189 | with { extension "prototype(convert) decode(RAW)" }; |
| 190 | |
| 191 | type union LapdmFrame { |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 192 | LapdmFrameAB ab, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 193 | LapdmFrameBbis bbis, |
| 194 | LapdmFrameB4 b4 |
| 195 | } with { variant "" }; |
| 196 | |
| 197 | external function enc_LapdmFrame(in LapdmFrame si) return octetstring |
| 198 | with { extension "prototype(convert) encode(RAW)" }; |
| 199 | /* automatic decoding to the generic LapdmFrame will not work, you have to call one of the |
| 200 | * type-specific decoder routines above */ |
| 201 | |
Harald Welte | 0472ab4 | 2018-03-12 15:02:26 +0100 | [diff] [blame^] | 202 | /* SABM frame with L3 payload */ |
| 203 | template (value) LapdmFrame ts_LAPDm_SABM(LapdmSapi sapi, boolean c_r, boolean p, |
| 204 | octetstring l3) := { |
| 205 | ab := { |
| 206 | addr := ts_LapdmAddr(sapi, c_r), |
| 207 | ctrl := ts_LapdmCtrlSABM(p), |
| 208 | len := 0, /* overwritten in encoder */ |
| 209 | m := false, |
| 210 | el := 1, |
| 211 | payload := l3 |
| 212 | } |
| 213 | } |
| 214 | template LapdmFrame tr_LAPDm_SABM(template LapdmSapi sapi, template boolean c_r, |
| 215 | template boolean p, template octetstring l3) := { |
| 216 | ab := { |
| 217 | addr := tr_LapdmAddr(sapi, c_r), |
| 218 | ctrl := tr_LapdmCtrlSABM(p), |
| 219 | len := ?, |
| 220 | m := false, |
| 221 | el := 1, |
| 222 | payload := l3 |
| 223 | } |
| 224 | } |
| 225 | |
| 226 | template (value) LapdmFrame ts_LAPDm_UA(LapdmSapi sapi, boolean c_r, boolean f, |
| 227 | octetstring l3) := { |
| 228 | ab := { |
| 229 | addr := ts_LapdmAddr(sapi, c_r), |
| 230 | ctrl := ts_LapdmCtrlUA(f), |
| 231 | len := 0, /* overwritten in encoder */ |
| 232 | m := false, |
| 233 | el := 1, |
| 234 | payload := l3 |
| 235 | } |
| 236 | } |
| 237 | template LapdmFrame tr_LAPDm_UA(template LapdmSapi sapi, template boolean c_r, |
| 238 | template boolean f, template octetstring l3) := { |
| 239 | ab := { |
| 240 | addr := tr_LapdmAddr(sapi, c_r), |
| 241 | ctrl := tr_LapdmCtrlUA(f), |
| 242 | len := ?, |
| 243 | m := false, |
| 244 | el := 1, |
| 245 | payload := l3 |
| 246 | } |
| 247 | } |
| 248 | |
| 249 | template LapdmFrame ts_LAPDm_DISC(LapdmSapi sapi, boolean c_r, boolean p) := { |
| 250 | ab := { |
| 251 | addr := ts_LapdmAddr(sapi, c_r), |
| 252 | ctrl := ts_LapdmCtrlDISC(p), |
| 253 | len := 0, |
| 254 | m := false, |
| 255 | el := 1, |
| 256 | payload := ''O |
| 257 | } |
| 258 | } |
| 259 | template LapdmFrame tr_LAPDm_DISC(template LapdmSapi sapi, template boolean c_r, |
| 260 | template boolean p) := { |
| 261 | ab := { |
| 262 | addr := tr_LapdmAddr(sapi, c_r), |
| 263 | ctrl := tr_LapdmCtrlDISC(p), |
| 264 | len := ?, |
| 265 | m := false, |
| 266 | el := 1, |
| 267 | payload := ''O |
| 268 | } |
| 269 | } |
| 270 | |
| 271 | template LapdmFrame ts_LAPDm_UI(LapdmSapi sapi, boolean c_r, boolean p, octetstring l3) := { |
| 272 | ab := { |
| 273 | addr := ts_LapdmAddr(sapi, c_r), |
| 274 | ctrl := ts_LapdmCtrlUI(p), |
| 275 | len := 0, |
| 276 | m := false, |
| 277 | el := 1, |
| 278 | payload := l3 |
| 279 | } |
| 280 | } |
| 281 | template LapdmFrame tr_LAPDm_UI(template LapdmSapi sapi, template boolean c_r, |
| 282 | template boolean p, template octetstring l3) := { |
| 283 | ab := { |
| 284 | addr := tr_LapdmAddr(sapi, c_r), |
| 285 | ctrl := tr_LapdmCtrlUI(p), |
| 286 | len := ?, |
| 287 | m := false, |
| 288 | el := 1, |
| 289 | payload := l3 |
| 290 | } |
| 291 | } |
| 292 | |
| 293 | template LapdmFrame ts_LAPDm_B4_UI(LapdmSapi sapi, boolean c_r, boolean p, octetstring l3) := { |
| 294 | b4 := { |
| 295 | addr := ts_LapdmAddr(sapi, c_r), |
| 296 | ctrl := ts_LapdmCtrlUI(p), |
| 297 | payload := l3 |
| 298 | } |
| 299 | } |
| 300 | template LapdmFrame tr_LAPDm_B4_UI(template LapdmSapi sapi, template boolean c_r, |
| 301 | template boolean p, template octetstring l3) := { |
| 302 | b4 := { |
| 303 | addr := tr_LapdmAddr(sapi, c_r), |
| 304 | ctrl := tr_LapdmCtrlUI(p), |
| 305 | payload := l3 |
| 306 | } |
| 307 | } |
| 308 | |
| 309 | |
| 310 | |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 311 | } with { encode "RAW"; /*variant "FIELDORDER(msb)" */} |