wlan_common/mac/
fields.rs

1// Copyright 2019 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use std::marker::PhantomData;
6use wlan_bitfield::bitfield;
7use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout};
8
9// IEEE Std 802.11-2016, 9.2.4.1.3
10#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
11pub struct FrameType(pub u8);
12
13impl FrameType {
14    pub const MGMT: Self = Self(0);
15    pub const CTRL: Self = Self(1);
16    pub const DATA: Self = Self(2);
17    pub const EXT: Self = Self(3);
18
19    pub fn is_supported(&self) -> bool {
20        let FrameType(inner) = *self;
21        let FrameType(max) = FrameType::EXT;
22        !(inner > max)
23    }
24}
25
26// IEEE Std 802.11-2016, 9.2.4.1.3
27#[bitfield(
28    0 cf_ack,
29    1 cf_poll,
30    2 null,
31    3 qos,
32    4..=7 _ // subtype is a 4-bit number
33)]
34#[derive(Clone, Copy, Hash, PartialEq, Eq)]
35pub struct DataSubtype(pub u8);
36
37// IEEE Std 802.11-2016, 9.2.4.1.3
38#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
39pub struct MgmtSubtype(u8);
40
41impl MgmtSubtype {
42    pub const ASSOC_REQ: Self = Self(0b0000);
43    pub const ASSOC_RESP: Self = Self(0b0001);
44    pub const REASSOC_REQ: Self = Self(0b0010);
45    pub const REASSOC_RESP: Self = Self(0b0011);
46    pub const PROBE_REQ: Self = Self(0b0100);
47    pub const PROBE_RESP: Self = Self(0b0101);
48    pub const TIMING_AD: Self = Self(0b0110);
49    // 0111 reserved
50    pub const BEACON: Self = Self(0b1000);
51    pub const ATIM: Self = Self(0b1001);
52    pub const DISASSOC: Self = Self(0b1010);
53    pub const AUTH: Self = Self(0b1011);
54    pub const DEAUTH: Self = Self(0b1100);
55    pub const ACTION: Self = Self(0b1101);
56    pub const ACTION_NO_ACK: Self = Self(0b1110);
57    // 1111 reserved
58
59    pub fn is_supported(&self) -> bool {
60        let MgmtSubtype(inner) = *self;
61        let MgmtSubtype(max) = MgmtSubtype::ACTION_NO_ACK;
62        !(inner == 0b0111 || inner == 0b1111 || inner > max)
63    }
64}
65
66// IEEE Std 802.11-2016, 9.2.4.1.3
67#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
68pub struct CtrlSubtype(u8);
69
70impl CtrlSubtype {
71    // 0000 - 0011 reserved
72    pub const BEAM_FORMING: Self = Self(0b0100);
73    pub const VHT_NDP_ANNOUNCE: Self = Self(0b0101);
74    pub const CTRL_EXT: Self = Self(0b0110);
75    pub const CTRL_WRAP: Self = Self(0b0111);
76    pub const BLOCK_ACK: Self = Self(0b1000);
77    pub const BLOCK_ACK_REQ: Self = Self(0b1001);
78    pub const PS_POLL: Self = Self(0b1010);
79    pub const RTS: Self = Self(0b1011);
80    pub const CTS: Self = Self(0b1100);
81    pub const ACK: Self = Self(0b1101);
82    pub const CF_END: Self = Self(0b1110);
83    pub const CF_END_ACK: Self = Self(0b1111);
84}
85
86/// The power management state of a station.
87///
88/// Represents the possible power states from IEEE-802.11-2016, 11.2.7.
89#[derive(Clone, Copy, Debug, Eq, PartialEq)]
90#[repr(C)]
91pub struct PowerState(bool);
92
93impl PowerState {
94    /// The awake power management state. When in this state, stations are expected to be reliable
95    /// and handle transmitted frames.
96    pub const AWAKE: Self = Self(false);
97    /// The doze power management state. When in this state, stations may be less reliable and APs
98    /// should typically buffer frames.
99    pub const DOZE: Self = Self(true);
100}
101
102// IEEE Std 802.11-2016, 9.2.4.1.1
103#[bitfield(
104    0..=1   protocol_version,
105    2..=3   frame_type as FrameType(u8),
106    4..=7   union {
107                frame_subtype,
108                mgmt_subtype as MgmtSubtype(u8),
109                data_subtype as DataSubtype(u8),
110                ctrl_subtype as CtrlSubtype(u8),
111            },
112    8       to_ds,
113    9       from_ds,
114    10      more_fragments,
115    11      retry,
116    12      power_mgmt as PowerState(bool),
117    13      more_data,
118    14      protected,
119    15      htc_order
120)]
121#[derive(IntoBytes, KnownLayout, FromBytes, Immutable, PartialEq, Eq, Clone, Copy)]
122#[repr(C)]
123pub struct FrameControl(pub u16);
124
125impl FrameControl {
126    pub fn is_mgmt(&self) -> bool {
127        self.frame_type() == FrameType::MGMT
128    }
129    pub fn is_ctrl(&self) -> bool {
130        self.frame_type() == FrameType::CTRL
131    }
132    pub fn is_data(&self) -> bool {
133        self.frame_type() == FrameType::DATA
134    }
135}
136
137// IEEE Std 802.11-2016, 9.2.4.4
138#[bitfield(
139    0..=3   frag_num,
140    4..=15  seq_num,
141)]
142#[derive(IntoBytes, KnownLayout, FromBytes, Immutable, PartialEq, Eq, Clone, Copy)]
143#[repr(C)]
144pub struct SequenceControl(pub u16);
145
146// IEEE Std 802.11-2016, 9.2.4.6
147#[bitfield(
148    0       vht,
149    1..=29  middle, // see 9.2.4.6.2 for HT and 9.2.4.6.3 for VHT
150    30      ac_constraint,
151    31      rdg_more_ppdu,
152)]
153#[repr(C)]
154#[derive(IntoBytes, KnownLayout, FromBytes, Immutable, Copy, Clone, PartialEq, Eq)]
155pub struct HtControl(pub u32);
156
157#[derive(PartialEq, Eq)]
158pub struct Presence<T: ?Sized>(bool, PhantomData<T>);
159
160impl<T: ?Sized> Presence<T> {
161    pub fn from_bool(present: bool) -> Self {
162        Self(present, PhantomData)
163    }
164}
165
166pub trait OptionalField {
167    const PRESENT: Presence<Self> = Presence::<Self>(true, PhantomData);
168    const ABSENT: Presence<Self> = Presence::<Self>(false, PhantomData);
169}
170impl<T: ?Sized> OptionalField for T {}
171
172#[derive(Copy, Clone, Debug, PartialEq, Eq)]
173pub struct WlanGi(pub u8);
174
175// Guart intervals
176impl WlanGi {
177    pub const G_800NS: Self = Self(0x1); // all 802.11 phy
178    pub const G_400NS: Self = Self(0x2); // 802.11n/ac
179    pub const G_200NS: Self = Self(0x4); // 802.11n/ac
180    pub const G_3200NS: Self = Self(0x10); // 802.11ax
181    pub const G_1600NS: Self = Self(0x20); // 802.11ax
182}
183
184impl std::ops::BitAnd for WlanGi {
185    type Output = Self;
186    fn bitand(self, rhs: Self) -> Self {
187        Self(self.0 & rhs.0)
188    }
189}
190
191impl std::ops::BitAndAssign for WlanGi {
192    fn bitand_assign(&mut self, rhs: Self) {
193        *self = Self(self.0 & rhs.0)
194    }
195}
196
197impl std::ops::BitOr for WlanGi {
198    type Output = Self;
199    fn bitor(self, rhs: Self) -> Self {
200        Self(self.0 | rhs.0)
201    }
202}
203
204impl std::ops::BitOrAssign for WlanGi {
205    fn bitor_assign(&mut self, rhs: Self) {
206        *self = Self(self.0 | rhs.0)
207    }
208}
209
210impl std::ops::BitXor for WlanGi {
211    type Output = Self;
212    fn bitxor(self, rhs: Self) -> Self {
213        Self(self.0 ^ rhs.0)
214    }
215}
216
217impl std::ops::BitXorAssign for WlanGi {
218    fn bitxor_assign(&mut self, rhs: Self) {
219        *self = Self(self.0 ^ rhs.0)
220    }
221}
wlan_common/mac/fields.rs

wlan_common/mac/
fields.rs
