4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Christian Niephaus <cni@berlios.de>
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.
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.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief 802.11 WLANPacket public header */
26 #ifndef HH_SENF_Packets_80211Bundle_WLANPacket_
27 #define HH_SENF_Packets_80211Bundle_WLANPacket_ 1
29 #include <senf/Packets/Packets.hh>
30 #include <senf/Packets/DefaultBundle/EthernetPacket.hh>
31 #include <senf/Packets/DefaultBundle/LlcSnapPacket.hh>
36 /** \brief 802.11 Frame parser
37 (see IEEE 802.11-2007 standard - Chapter 7 Frame formats)
38 <b>Re-ordering of bits due to host byte order</b>
42 struct WLANPacketParser : public senf::PacketParserBase
44 # include SENF_PARSER()
48 * re-ordering of fields due to the byte order
50 SENF_PARSER_BITFIELD_RO ( subtype, 4, unsigned );
51 SENF_PARSER_BITFIELD_RO ( type, 2, unsigned );
52 SENF_PARSER_BITFIELD ( version, 2, unsigned );
53 SENF_PARSER_BITFIELD ( order, 1, bool );
54 SENF_PARSER_BITFIELD ( protectedFrame, 1, bool );
55 SENF_PARSER_BITFIELD ( moreData, 1, bool );
56 SENF_PARSER_BITFIELD ( pwrMgt, 1, bool );
57 SENF_PARSER_BITFIELD ( retry, 1, bool );
58 SENF_PARSER_BITFIELD ( moreFrag, 1, bool );
59 SENF_PARSER_BITFIELD ( fromDS, 1, bool );
60 SENF_PARSER_BITFIELD ( toDS, 1, bool );
62 SENF_PARSER_FIELD ( duration, UInt16LSBParser );
64 SENF_PARSER_FINALIZE(WLANPacketParser);
67 ///////////////////////////////////////////////////////////////////////////
69 /** \brief Management frame parser
70 <b>Re-ordering of bits due to LSB byte order</b>
72 struct WLANPacket_MgtFrameParser : public WLANPacketParser
74 # include SENF_PARSER()
76 SENF_PARSER_INHERIT(WLANPacketParser);
78 SENF_PARSER_FIELD ( destinationAddress, MACAddressParser );
79 SENF_PARSER_FIELD ( sourceAddress, MACAddressParser );
80 SENF_PARSER_FIELD ( bssid, MACAddressParser );
82 //workaround since bitfield LSB parsers are not available
83 SENF_PARSER_PRIVATE_BITFIELD ( seqNumber_1, 4, unsigned );
84 SENF_PARSER_BITFIELD ( fragmentNumber, 4, unsigned );
85 SENF_PARSER_PRIVATE_FIELD ( seqNumber_2, UInt8Parser );
87 SENF_PARSER_INIT() { type_() = 0; }
89 SENF_PARSER_FINALIZE(WLANPacket_MgtFrameParser);
91 boost::uint16_t sequenceNumber() const {
92 return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
96 /** \brief WLAN Management frame packet
98 \par Packet type (typedef):
99 \refWLANPacket_MgtFrame
102 \ref WLANPacket_MgtFrameParser
103 \image html WLANPacket_MgtFrame.png
105 \ingroup protocolbundle_80211
107 struct WLANPacket_MgtFrameType
108 : public senf::PacketTypeBase,
109 public senf::PacketTypeMixin<WLANPacket_MgtFrameType>
111 typedef senf::PacketTypeMixin<WLANPacket_MgtFrameType> mixin;
112 typedef senf::ConcretePacket<WLANPacket_MgtFrameType> packet;
113 typedef WLANPacket_MgtFrameParser parser;
116 using mixin::initSize;
117 using senf::PacketTypeBase::nextPacketRange;
119 static void dump(packet p, std::ostream &os);
122 typedef WLANPacket_MgtFrameType::packet WLANPacket_MgtFrame;
124 ///////////////////////////////////////////////////////////////////////////
126 /** \brief Control frame parser
127 <b>Re-ordering of bits due to LSB byte order</b>
129 currently only CTS, RTS and ACK control frames are supported
131 struct WLANPacket_CtrlFrameParser : public WLANPacketParser
133 # include SENF_PARSER()
135 SENF_PARSER_INHERIT(WLANPacketParser);
137 SENF_PARSER_FIELD ( receiverAddress, MACAddressParser );
139 //only RTS frame contains a source address field
140 //variant is also needed to set correct subtype value
141 SENF_PARSER_VARIANT ( subtype__, subtype,
142 ( ids( na, is_cts, set_cts, key(12, VoidPacketParser)) )
143 ( ids( na, is_ack, set_ack, key(13, VoidPacketParser)) )
144 ( ids( sourceAddress, is_rts, set_rts, key(11, MACAddressParser)) ) );
146 SENF_PARSER_INIT() { type_() = 1; }
148 SENF_PARSER_FINALIZE(WLANPacket_CtrlFrameParser);
151 /** \brief WLAN Control frame packet
153 \par Packet type (typedef):
154 \ref WLANPacket_CtrlFrame
157 \ref WLANPacket_CtrlFrameParser
158 \image html WLANPacket_CtrlFrame.png
160 \ingroup protocolbundle_80211
162 struct WLANPacket_CtrlFrameType
163 : public senf::PacketTypeBase,
164 public senf::PacketTypeMixin<WLANPacket_CtrlFrameType>
166 typedef senf::PacketTypeMixin<WLANPacket_CtrlFrameType> mixin;
167 typedef senf::ConcretePacket<WLANPacket_CtrlFrameType> packet;
168 typedef WLANPacket_CtrlFrameParser parser;
171 using mixin::initSize;
172 using senf::PacketTypeBase::nextPacketRange;
174 static void dump(packet p, std::ostream &os);
177 typedef WLANPacket_CtrlFrameType::packet WLANPacket_CtrlFrame;
179 ///////////////////////////////////////////////////////////////////////////
181 /** \brief Data frame parser
182 <b>Re-ordering of bits due to LSB byte order</b>
184 struct WLANPacket_DataFrameParser : public WLANPacketParser
186 # include SENF_PARSER()
188 SENF_PARSER_INHERIT(WLANPacketParser);
190 SENF_PARSER_GOTO(subtype);
191 SENF_PARSER_SKIP_BITS(14); //<pkgdraw: hide
192 SENF_PARSER_PRIVATE_BITFIELD ( dsBits, 2, unsigned ); //<pkgdraw: hide
193 SENF_PARSER_SKIP ( 2, 2 ); //<pkgdraw: hide
195 SENF_PARSER_PRIVATE_FIELD ( addr1, MACAddressParser );
196 SENF_PARSER_PRIVATE_FIELD ( addr2, MACAddressParser );
197 SENF_PARSER_PRIVATE_FIELD ( addr3, MACAddressParser );
199 //sequence Number and fragment number
200 //shift bits manually due to LSB
201 SENF_PARSER_PRIVATE_BITFIELD ( seqNumber_1, 4, unsigned );
202 SENF_PARSER_BITFIELD ( fragmentNumber, 4, unsigned );
203 SENF_PARSER_PRIVATE_FIELD ( seqNumber_2, UInt8Parser );
205 boost::uint16_t sequenceNumber() const {
206 return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
209 // TODO fourth address field in case of WDS
210 // SENF_PARSER_PRIVATE_VARIANT (wds_, dsBits,
211 // ( novalue ( disable_addr4, VoidPacketParser ))
212 // ( id ( addr4, key (3, MACAddressParser ))) );
215 SENF_PARSER_VARIANT ( qosField_, subtype,
216 ( ids( na, na, set_data, key(0, VoidPacketParser)) )
217 ( ids( na, na, set_nullData, key(4, VoidPacketParser)) )
218 ( ids( qosField, has_qosField, set_qosData, key(8, UInt16LSBParser )) )
219 //we cannot parse qos Null (data) frames at the moment
220 ( ids( na, na, set_qosNullData, key(12, UInt16LSBParser)) ) );
222 SENF_PARSER_INIT() { type_() = 2; }
224 SENF_PARSER_FINALIZE(WLANPacket_DataFrameParser);
226 MACAddressParser receiverAddress() const { return addr1(); }; //ra is always addr1
227 MACAddressParser transmitterAddress() const { return addr2(); }; //ta is always addr2
228 MACAddressParser sourceAddress() const;
229 MACAddressParser destinationAddress() const;
230 MACAddressParser bssid() const;
232 friend class WLANPacket_DataFrameType;
235 /** \brief WLAN Data frame packet
237 \par Packet type (typedef):
238 \ref WLANPacket_DataFrame
241 \ref WLANPacket_DataFrameParser
242 \image html WLANPacket_DataFrame.png
244 \ingroup protocolbundle_80211
246 struct WLANPacket_DataFrameType
247 : public senf::PacketTypeBase,
248 public senf::PacketTypeMixin<WLANPacket_DataFrameType>
250 typedef senf::PacketTypeMixin<WLANPacket_DataFrameType> mixin;
251 typedef senf::ConcretePacket<WLANPacket_DataFrameType> packet;
252 typedef WLANPacket_DataFrameParser parser;
255 using mixin::initSize;
256 using mixin::nextPacketRange;
258 static factory_t nextPacketType(packet p) {
259 return p->subtype() == 0 || p->subtype() == 8
260 ? LlcSnapPacket::factory()
264 static void dump(packet p, std::ostream &os);
267 typedef WLANPacket_DataFrameType::packet WLANPacket_DataFrame;
270 #endif /* HH_SENF_Packets_80211Bundle_WLANPacket_ */
276 // c-file-style: "senf"
277 // indent-tabs-mode: nil
278 // ispell-local-dictionary: "american"
279 // compile-command: "scons -u test"
280 // comment-column: 40