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>
33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
38 /** \brief 802.11 Frame parser
39 (see IEEE 802.11-2007 standard - Chapter 7 Frame formats)
40 <b>Re-ordering of bits due to host byte order</b>
44 struct WLANPacketParser : public PacketParserBase
46 # include SENF_PARSER()
50 * re-ordering of fields due to the byte order
52 SENF_PARSER_BITFIELD_RO ( subtype, 4, unsigned );
53 SENF_PARSER_BITFIELD_RO ( type, 2, unsigned );
54 SENF_PARSER_BITFIELD ( version, 2, unsigned );
55 SENF_PARSER_BITFIELD ( order, 1, bool );
56 SENF_PARSER_BITFIELD ( protectedFrame, 1, bool );
57 SENF_PARSER_BITFIELD ( moreData, 1, bool );
58 SENF_PARSER_BITFIELD ( pwrMgt, 1, bool );
59 SENF_PARSER_BITFIELD ( retry, 1, bool );
60 SENF_PARSER_BITFIELD ( moreFrag, 1, bool );
61 SENF_PARSER_BITFIELD ( fromDS, 1, bool );
62 SENF_PARSER_BITFIELD ( toDS, 1, bool );
64 SENF_PARSER_FIELD ( duration, UInt16LSBParser );
66 SENF_PARSER_FINALIZE(WLANPacketParser);
69 //-////////////////////////////////////////////////////////////////////////
71 /** \brief Management frame parser
72 <b>Re-ordering of bits due to LSB byte order</b>
74 struct WLANPacket_MgtFrameParser : public WLANPacketParser
76 # include SENF_PARSER()
78 SENF_PARSER_INHERIT(WLANPacketParser);
80 SENF_PARSER_FIELD ( destinationAddress, MACAddressParser );
81 SENF_PARSER_FIELD ( sourceAddress, MACAddressParser );
82 SENF_PARSER_FIELD ( bssid, MACAddressParser );
84 //workaround since bitfield LSB parsers are not available
85 SENF_PARSER_PRIVATE_BITFIELD ( seqNumber_1, 4, unsigned );
86 SENF_PARSER_BITFIELD ( fragmentNumber, 4, unsigned );
87 SENF_PARSER_PRIVATE_FIELD ( seqNumber_2, UInt8Parser );
89 SENF_PARSER_INIT() { type_() = 0; }
91 SENF_PARSER_FINALIZE(WLANPacket_MgtFrameParser);
93 boost::uint16_t sequenceNumber() const {
94 return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
97 void sequenceNumber(boost::uint16_t sn);
100 /** \brief WLAN Management frame packet
102 \par Packet type (typedef):
103 \ref WLANPacket_MgtFrame
106 \ref WLANPacket_MgtFrameParser
107 \image html WLANPacket_MgtFrame.png
109 \ingroup protocolbundle_80211
111 struct WLANPacket_MgtFrameType
112 : public PacketTypeBase,
113 public PacketTypeMixin<WLANPacket_MgtFrameType>
115 typedef PacketTypeMixin<WLANPacket_MgtFrameType> mixin;
116 typedef ConcretePacket<WLANPacket_MgtFrameType> packet;
117 typedef WLANPacket_MgtFrameParser parser;
120 using mixin::initSize;
121 using PacketTypeBase::nextPacketRange;
123 static void dump(packet p, std::ostream & os);
126 /** \brief WLAN Management frame packet typedef
127 \ingroup protocolbundle_80211
129 typedef WLANPacket_MgtFrameType::packet WLANPacket_MgtFrame;
131 //-////////////////////////////////////////////////////////////////////////
133 /** \brief Control frame parser
134 <b>Re-ordering of bits due to LSB byte order</b>
136 currently only CTS, RTS and ACK control frames are supported
138 struct WLANPacket_CtrlFrameParser : public WLANPacketParser
140 # include SENF_PARSER()
142 SENF_PARSER_INHERIT(WLANPacketParser);
144 SENF_PARSER_FIELD ( receiverAddress, MACAddressParser );
146 //only RTS frame contains a source address field
147 //variant is also needed to set correct subtype value
148 SENF_PARSER_VARIANT ( subtype__, subtype,
149 ( ids( na, is_cts, set_cts, key(12, VoidPacketParser)) )
150 ( ids( na, is_ack, set_ack, key(13, VoidPacketParser)) )
151 ( ids( sourceAddress, is_rts, set_rts, key(11, MACAddressParser)) ) );
153 SENF_PARSER_INIT() { type_() = 1; }
155 SENF_PARSER_FINALIZE(WLANPacket_CtrlFrameParser);
158 /** \brief WLAN Control frame packet
160 \par Packet type (typedef):
161 \ref WLANPacket_CtrlFrame
164 \ref WLANPacket_CtrlFrameParser
165 \image html WLANPacket_CtrlFrame.png
167 \ingroup protocolbundle_80211
169 struct WLANPacket_CtrlFrameType
170 : public PacketTypeBase,
171 public PacketTypeMixin<WLANPacket_CtrlFrameType>
173 typedef PacketTypeMixin<WLANPacket_CtrlFrameType> mixin;
174 typedef ConcretePacket<WLANPacket_CtrlFrameType> packet;
175 typedef WLANPacket_CtrlFrameParser parser;
178 using mixin::initSize;
179 using PacketTypeBase::nextPacketRange;
181 static void dump(packet p, std::ostream & os);
184 /** \brief WLAN Control frame packet typedef
185 \ingroup protocolbundle_80211
187 typedef WLANPacket_CtrlFrameType::packet WLANPacket_CtrlFrame;
189 //-////////////////////////////////////////////////////////////////////////
191 /** \brief Data frame parser
192 <b>Re-ordering of bits due to LSB byte order</b>
194 struct WLANPacket_DataFrameParser : public WLANPacketParser
196 # include SENF_PARSER()
198 SENF_PARSER_INHERIT(WLANPacketParser);
201 typedef UIntFieldParser<6, 6+2> dsBits_t;
202 dsBits_t::value_type dsBits() const { return parse<dsBits_t>( 1); }
204 MACAddressParser addr1() const { return parse<MACAddressParser>( 4); }
205 MACAddressParser addr2() const { return parse<MACAddressParser>( 10); }
206 MACAddressParser addr3() const { return parse<MACAddressParser>( 16); }
208 //sequence Number and fragment number
209 //shift bits manually due to LSB
211 typedef UIntFieldParser<0, 0+4> seqNumber_1_t;
212 seqNumber_1_t seqNumber_1() const { return parse<seqNumber_1_t>( 22); }
215 typedef UIntFieldParser<4, 4+4> fragmentNumber_t;
216 fragmentNumber_t fragmentNumber() const { return parse<fragmentNumber_t>( 22); }
219 UInt8Parser seqNumber_2() const { return parse<UInt8Parser>( 23); }
222 boost::uint16_t sequenceNumber() const {
223 return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
226 void sequenceNumber(boost::uint16_t sn);
228 SENF_PARSER_GOTO_OFFSET( 24, 24);
230 // TODO fourth address field in case of WDS
231 // SENF_PARSER_PRIVATE_VARIANT (wds_, dsBits,
232 // ( novalue ( disable_addr4, VoidPacketParser ))
233 // ( id ( addr4, key (3, MACAddressParser ))) );
236 SENF_PARSER_VARIANT ( qosField_, subtype,
237 ( ids( na, na, set_data, key(0, VoidPacketParser)) )
238 ( ids( na, na, set_nullData, key(4, VoidPacketParser)) )
239 ( ids( qosField, has_qosField, set_qosData, key(8, UInt16LSBParser )) )
240 //we cannot parse qos Null (data) frames at the moment
241 ( ids( na, na, set_qosNullData, key(12, UInt16LSBParser)) ) );
243 SENF_PARSER_INIT() { type_() = 2; }
245 SENF_PARSER_FINALIZE(WLANPacket_DataFrameParser);
247 MACAddressParser receiverAddress() const { return addr1(); }; //ra is always addr1
248 MACAddressParser transmitterAddress() const { return addr2(); }; //ta is always addr2
249 MACAddressParser sourceAddress() const;
250 MACAddressParser destinationAddress() const;
251 MACAddressParser bssid() const;
253 friend class WLANPacket_DataFrameType;
256 /** \brief WLAN Data frame packet
258 \par Packet type (typedef):
259 \ref WLANPacket_DataFrame
262 \ref WLANPacket_DataFrameParser
263 \image html WLANPacket_DataFrame.png
265 \ingroup protocolbundle_80211
267 struct WLANPacket_DataFrameType
268 : public PacketTypeBase,
269 public PacketTypeMixin<WLANPacket_DataFrameType>
271 typedef PacketTypeMixin<WLANPacket_DataFrameType> mixin;
272 typedef ConcretePacket<WLANPacket_DataFrameType> packet;
273 typedef WLANPacket_DataFrameParser parser;
276 using mixin::initSize;
277 using mixin::nextPacketRange;
279 static factory_t nextPacketType(packet p) {
280 return p->subtype() == 0 || p->subtype() == 8
281 ? LlcSnapPacket::factory()
285 static void dump(packet p, std::ostream & os);
288 /** \brief WLAN Data frame packet typedef
289 \ingroup protocolbundle_80211
291 typedef WLANPacket_DataFrameType::packet WLANPacket_DataFrame;
294 //-/////////////////////////////////////////////////////////////////////////////////////////////////
295 //#include "WLANPacket.cci"
296 //#include "WLANPacket.ct"
297 //#include "WLANPacket.cti"
304 // c-file-style: "senf"
305 // indent-tabs-mode: nil
306 // ispell-local-dictionary: "american"
307 // compile-command: "scons -u test"
308 // comment-column: 40