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 ///////////////////////////////hh.p////////////////////////////////////////
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();
98 /** \brief WLAN Management frame packet
100 \par Packet type (typedef):
101 \ref WLANPacket_MgtFrame
104 \ref WLANPacket_MgtFrameParser
105 \image html WLANPacket_MgtFrame.png
107 \ingroup protocolbundle_80211
109 struct WLANPacket_MgtFrameType
110 : public PacketTypeBase,
111 public PacketTypeMixin<WLANPacket_MgtFrameType>
113 typedef PacketTypeMixin<WLANPacket_MgtFrameType> mixin;
114 typedef ConcretePacket<WLANPacket_MgtFrameType> packet;
115 typedef WLANPacket_MgtFrameParser parser;
118 using mixin::initSize;
119 using PacketTypeBase::nextPacketRange;
121 static void dump(packet p, std::ostream &os);
124 /** \brief WLAN Management frame packet typedef
125 \ingroup protocolbundle_80211
127 typedef WLANPacket_MgtFrameType::packet WLANPacket_MgtFrame;
129 ///////////////////////////////////////////////////////////////////////////
131 /** \brief Control frame parser
132 <b>Re-ordering of bits due to LSB byte order</b>
134 currently only CTS, RTS and ACK control frames are supported
136 struct WLANPacket_CtrlFrameParser : public WLANPacketParser
138 # include SENF_PARSER()
140 SENF_PARSER_INHERIT(WLANPacketParser);
142 SENF_PARSER_FIELD ( receiverAddress, MACAddressParser );
144 //only RTS frame contains a source address field
145 //variant is also needed to set correct subtype value
146 SENF_PARSER_VARIANT ( subtype__, subtype,
147 ( ids( na, is_cts, set_cts, key(12, VoidPacketParser)) )
148 ( ids( na, is_ack, set_ack, key(13, VoidPacketParser)) )
149 ( ids( sourceAddress, is_rts, set_rts, key(11, MACAddressParser)) ) );
151 SENF_PARSER_INIT() { type_() = 1; }
153 SENF_PARSER_FINALIZE(WLANPacket_CtrlFrameParser);
156 /** \brief WLAN Control frame packet
158 \par Packet type (typedef):
159 \ref WLANPacket_CtrlFrame
162 \ref WLANPacket_CtrlFrameParser
163 \image html WLANPacket_CtrlFrame.png
165 \ingroup protocolbundle_80211
167 struct WLANPacket_CtrlFrameType
168 : public PacketTypeBase,
169 public PacketTypeMixin<WLANPacket_CtrlFrameType>
171 typedef PacketTypeMixin<WLANPacket_CtrlFrameType> mixin;
172 typedef ConcretePacket<WLANPacket_CtrlFrameType> packet;
173 typedef WLANPacket_CtrlFrameParser parser;
176 using mixin::initSize;
177 using PacketTypeBase::nextPacketRange;
179 static void dump(packet p, std::ostream &os);
182 /** \brief WLAN Control frame packet typedef
183 \ingroup protocolbundle_80211
185 typedef WLANPacket_CtrlFrameType::packet WLANPacket_CtrlFrame;
187 ///////////////////////////////////////////////////////////////////////////
189 /** \brief Data frame parser
190 <b>Re-ordering of bits due to LSB byte order</b>
192 struct WLANPacket_DataFrameParser : public WLANPacketParser
194 # include SENF_PARSER()
196 SENF_PARSER_INHERIT(WLANPacketParser);
198 SENF_PARSER_GOTO(subtype);
199 SENF_PARSER_SKIP_BITS(14); //<pkgdraw: hide
200 SENF_PARSER_PRIVATE_BITFIELD ( dsBits, 2, unsigned ); //<pkgdraw: hide
201 SENF_PARSER_SKIP ( 2, 2 ); //<pkgdraw: hide
203 SENF_PARSER_PRIVATE_FIELD ( addr1, MACAddressParser );
204 SENF_PARSER_PRIVATE_FIELD ( addr2, MACAddressParser );
205 SENF_PARSER_PRIVATE_FIELD ( addr3, MACAddressParser );
207 //sequence Number and fragment number
208 //shift bits manually due to LSB
209 SENF_PARSER_PRIVATE_BITFIELD ( seqNumber_1, 4, unsigned );
210 SENF_PARSER_BITFIELD ( fragmentNumber, 4, unsigned );
211 SENF_PARSER_PRIVATE_FIELD ( seqNumber_2, UInt8Parser );
213 boost::uint16_t sequenceNumber() const {
214 return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
217 // TODO fourth address field in case of WDS
218 // SENF_PARSER_PRIVATE_VARIANT (wds_, dsBits,
219 // ( novalue ( disable_addr4, VoidPacketParser ))
220 // ( id ( addr4, key (3, MACAddressParser ))) );
223 SENF_PARSER_VARIANT ( qosField_, subtype,
224 ( ids( na, na, set_data, key(0, VoidPacketParser)) )
225 ( ids( na, na, set_nullData, key(4, VoidPacketParser)) )
226 ( ids( qosField, has_qosField, set_qosData, key(8, UInt16LSBParser )) )
227 //we cannot parse qos Null (data) frames at the moment
228 ( ids( na, na, set_qosNullData, key(12, UInt16LSBParser)) ) );
230 SENF_PARSER_INIT() { type_() = 2; }
232 SENF_PARSER_FINALIZE(WLANPacket_DataFrameParser);
234 MACAddressParser receiverAddress() const { return addr1(); }; //ra is always addr1
235 MACAddressParser transmitterAddress() const { return addr2(); }; //ta is always addr2
236 MACAddressParser sourceAddress() const;
237 MACAddressParser destinationAddress() const;
238 MACAddressParser bssid() const;
240 friend class WLANPacket_DataFrameType;
243 /** \brief WLAN Data frame packet
245 \par Packet type (typedef):
246 \ref WLANPacket_DataFrame
249 \ref WLANPacket_DataFrameParser
250 \image html WLANPacket_DataFrame.png
252 \ingroup protocolbundle_80211
254 struct WLANPacket_DataFrameType
255 : public PacketTypeBase,
256 public PacketTypeMixin<WLANPacket_DataFrameType>
258 typedef PacketTypeMixin<WLANPacket_DataFrameType> mixin;
259 typedef ConcretePacket<WLANPacket_DataFrameType> packet;
260 typedef WLANPacket_DataFrameParser parser;
263 using mixin::initSize;
264 using mixin::nextPacketRange;
266 static factory_t nextPacketType(packet p) {
267 return p->subtype() == 0 || p->subtype() == 8
268 ? LlcSnapPacket::factory()
272 static void dump(packet p, std::ostream &os);
275 /** \brief WLAN Data frame packet typedef
276 \ingroup protocolbundle_80211
278 typedef WLANPacket_DataFrameType::packet WLANPacket_DataFrame;
281 ///////////////////////////////hh.e////////////////////////////////////////
282 //#include "WLANPacket.cci"
283 //#include "WLANPacket.ct"
284 //#include "WLANPacket.cti"
291 // c-file-style: "senf"
292 // indent-tabs-mode: nil
293 // ispell-local-dictionary: "american"
294 // compile-command: "scons -u test"
295 // comment-column: 40