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 | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 13 | /* TS 44.006 Figure 4 */ |
| 14 | type record LapdmAddressField { |
| 15 | BIT1 spare, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 16 | uint2_t lpd, |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 17 | LapdmSapi sapi, |
| 18 | boolean c_r, |
| 19 | boolean ea |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 20 | } with { variant "FIELDORDER(msb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 21 | |
Harald Welte | 9e4725d | 2017-07-16 23:18:09 +0200 | [diff] [blame] | 22 | template LapdmAddressField tr_LapdmAddr(template LapdmSapi sapi, template boolean c_r) := { |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 23 | spare := '0'B, |
| 24 | lpd := 0, |
| 25 | sapi := sapi, |
| 26 | c_r := c_r, |
| 27 | ea := true |
| 28 | }; |
| 29 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 30 | template (value) LapdmAddressField ts_LapdmAddr(LapdmSapi sapi, boolean c_r) := { |
| 31 | spare := '0'B, |
| 32 | lpd := 0, |
| 33 | sapi := sapi, |
| 34 | c_r := c_r, |
| 35 | ea := true |
| 36 | }; |
| 37 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 38 | type record LapdmCtrlI { |
Harald Welte | ffcad68 | 2017-07-30 22:51:04 +0200 | [diff] [blame] | 39 | BIT1 spare ('0'B), |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 40 | uint3_t n_s, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 41 | boolean p, |
| 42 | uint3_t n_r |
| 43 | } with { variant "FIELDORDER(lsb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 44 | |
| 45 | type record LapdmCtrlS { |
Harald Welte | ffcad68 | 2017-07-30 22:51:04 +0200 | [diff] [blame] | 46 | BIT2 spare ('01'B), |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 47 | LapdmSBits s, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 48 | boolean p_f, |
| 49 | uint3_t n_r |
| 50 | } with { variant "FIELDORDER(lsb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 51 | |
| 52 | type record LapdmCtrlU { |
Harald Welte | ffcad68 | 2017-07-30 22:51:04 +0200 | [diff] [blame] | 53 | BIT2 spare ('11'B), |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 54 | LapdmU2Bits u2, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 55 | boolean p_f, |
| 56 | LapdmUBits u |
| 57 | } with { variant "FIELDORDER(lsb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 58 | |
| 59 | /* TS 44.006 Table 3 */ |
| 60 | type union LapdmCtrl { |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 61 | LapdmCtrlS s, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 62 | LapdmCtrlU u, |
| 63 | LapdmCtrlI i, |
| 64 | uint8_t other |
| 65 | } with { variant "TAG(u, spare = '11'B; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 66 | s, spare = '01'B; |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 67 | i, spare = '0'B; |
| 68 | other, OTHERWISE)" }; |
| 69 | /* )" }; */ |
| 70 | |
| 71 | /* TS 44.006 Table 4 */ |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 72 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 73 | template LapdmCtrl tr_LapdmCtrlS := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 74 | s := { spare := '01'B, s := ?, p_f := ?, n_r := ? } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 75 | }; |
| 76 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 77 | template LapdmCtrl tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 78 | u := { spare := '11'B, u2 := ?, p_f := ?, u := ? } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 79 | }; |
| 80 | |
| 81 | /* TS 44.006 Table 4 */ |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 82 | 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] | 83 | i := { spare := '0'B, n_s := ns, p := p, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 84 | }; |
| 85 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 86 | 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] | 87 | s := { s:= '00'B, p_f := pf, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 88 | }; |
| 89 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 90 | 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] | 91 | s := { s:= '01'B, p_f := pf, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 92 | }; |
| 93 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 94 | 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] | 95 | s := { s:= '10'B, p_f := pf, n_r := nr } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 96 | }; |
| 97 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 98 | template LapdmCtrl tr_LapdmCtrlSABM(template boolean p) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 99 | u := { u2 := '11'B, p_f := p, u := '001'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 100 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 101 | template (value) LapdmCtrl ts_LapdmCtrlSABM(boolean p) := { |
| 102 | u := { spare := '11'B, u2 := '11'B, p_f := p, u := '001'B } |
| 103 | }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 104 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 105 | template LapdmCtrl tr_LapdmCtrlDM(template boolean f) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 106 | u := { u2 := '11'B, p_f := f, u := '000'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 107 | }; |
| 108 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 109 | template LapdmCtrl tr_LapdmCtrlUI(template boolean p) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 110 | u := { u2 := '00'B, p_f := p, u := '000'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 111 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 112 | template (value) LapdmCtrl ts_LapdmCtrlUI(boolean p) := { |
| 113 | u := { spare := '11'B, u2 := '00'B, p_f := p, u := '000'B } |
| 114 | }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 115 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 116 | template LapdmCtrl tr_LapdmCtrlDISC(template boolean p) modifies tr_LapdmCtrlU := { |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 117 | u := { u2 := '00'B, p_f := p, u := '010'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 118 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 119 | template LapdmCtrl ts_LapdmCtrlDISC(boolean p) := { |
| 120 | u := { spare := '11'B, u2 := '00'B, p_f := p, u := '010'B } |
| 121 | }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 122 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 123 | template LapdmCtrl tr_LapdmCtrlUA(template boolean f) modifies tr_LapdmCtrlU := { |
Harald Welte | d4ba7ff | 2017-07-17 21:00:48 +0200 | [diff] [blame] | 124 | u := { u2 := '00'B, p_f := f, u := '011'B } |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 125 | }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 126 | template (value) LapdmCtrl ts_LapdmCtrlUA(boolean f) := { |
| 127 | u := { spare := '11'B, u2 := '00'B, p_f := f, u := '011'B } |
| 128 | }; |
| 129 | |
| 130 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 131 | |
Harald Welte | 1bd7c32 | 2017-07-17 20:59:46 +0200 | [diff] [blame] | 132 | external function dec_LapdmAddressField(in octetstring stream) return LapdmAddressField |
| 133 | with { extension "prototype(convert) decode(RAW)" }; |
| 134 | |
| 135 | external function dec_LapdmCtrl(in octetstring stream) return LapdmCtrl |
| 136 | with { extension "prototype(convert) decode(RAW)" }; |
| 137 | |
| 138 | external function dec_LapdmCtrlU(in octetstring stream) return LapdmCtrlU |
| 139 | with { extension "prototype(convert) decode(RAW)" }; |
| 140 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 141 | /* Formats B, Bter and B4 are used on DCCHs for frames containing an information field: |
| 142 | /* - format Bter is used on request of higher layers if and only if short L2 header type 1 is |
| 143 | * supported and a UI command is to be transmitted on SAPI 0 */ |
| 144 | /* - format B4 is used for UI frames transmitted by the network on SACCH; */ |
| 145 | /* - format B is applied in all other cases. */ |
| 146 | /* Format Bbis is used only on BCCH, PCH, NCH, and AGCH. |
| 147 | |
| 148 | /* Format B */ |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 149 | type record LapdmFrameAB { |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 150 | LapdmAddressField addr, |
| 151 | LapdmCtrl ctrl, |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 152 | uint6_t len, |
Harald Welte | d4ba7ff | 2017-07-17 21:00:48 +0200 | [diff] [blame] | 153 | boolean m, |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 154 | uint1_t el, |
| 155 | octetstring payload /* zero-length in Frame A */ |
Harald Welte | d4ba7ff | 2017-07-17 21:00:48 +0200 | [diff] [blame] | 156 | } with { variant (len) "LENGTHTO(payload)" |
| 157 | variant "FIELDORDER(msb)" }; |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 158 | |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 159 | external function enc_LapdmFrameAB(in LapdmFrameAB si) return octetstring |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 160 | with { extension "prototype(convert) encode(RAW)" }; |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 161 | external function dec_LapdmFrameAB(in octetstring stream) return LapdmFrameAB |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 162 | with { extension "prototype(convert) decode(RAW)" }; |
| 163 | |
Harald Welte | f654332 | 2017-07-16 07:35:10 +0200 | [diff] [blame] | 164 | /* Format B4 */ |
| 165 | type record LapdmFrameB4 { |
| 166 | LapdmAddressField addr, |
| 167 | LapdmCtrl ctrl, |
| 168 | octetstring payload |
| 169 | } with { variant "" }; |
| 170 | |
| 171 | external function enc_LapdmFrameB4(in LapdmFrameB4 si) return octetstring |
| 172 | with { extension "prototype(convert) encode(RAW)" }; |
| 173 | external function dec_LapdmFrameB4(in octetstring stream) return LapdmFrameB4 |
| 174 | with { extension "prototype(convert) decode(RAW)" }; |
| 175 | |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 176 | type record LapdmFrameBbis { |
| 177 | octetstring payload |
| 178 | } with { variant "" }; |
| 179 | |
| 180 | external function enc_LapdmFrameBbis(in LapdmFrameBbis si) return octetstring |
| 181 | with { extension "prototype(convert) encode(RAW)" }; |
| 182 | external function dec_LapdmFrameBbis(in octetstring stream) return LapdmFrameBbis |
| 183 | with { extension "prototype(convert) decode(RAW)" }; |
| 184 | |
| 185 | type union LapdmFrame { |
Harald Welte | d879bd9 | 2018-03-12 15:01:23 +0100 | [diff] [blame] | 186 | LapdmFrameAB ab, |
Harald Welte | c2a5c07 | 2017-07-17 20:58:32 +0200 | [diff] [blame] | 187 | LapdmFrameBbis bbis, |
| 188 | LapdmFrameB4 b4 |
| 189 | } with { variant "" }; |
| 190 | |
| 191 | external function enc_LapdmFrame(in LapdmFrame si) return octetstring |
| 192 | with { extension "prototype(convert) encode(RAW)" }; |
| 193 | /* automatic decoding to the generic LapdmFrame will not work, you have to call one of the |
| 194 | * type-specific decoder routines above */ |
| 195 | |
| 196 | } with { encode "RAW"; /*variant "FIELDORDER(msb)" */} |