X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2F80211Bundle%2FWLANPacket.hh;h=046bed9d1a0f943c3f9e3f0e03bfa2ef5cd904c1;hb=92f8630b75f3ef50e73c48cde58645dcd1534e27;hp=47f4930ace53e05b6d2e0f3f91330b3bcb7590c6;hpb=3449642e5fd7b1c83c866b98f2462c2323edddf0;p=senf.git

diff --git a/Packets/80211Bundle/WLANPacket.hh b/Packets/80211Bundle/WLANPacket.hh
index 47f4930..046bed9 100644
--- a/Packets/80211Bundle/WLANPacket.hh
+++ b/Packets/80211Bundle/WLANPacket.hh
@@ -1,9 +1,9 @@
-// $Id:$
+// $Id$
 //
-// Copyright (C) 2006
+// Copyright (C) 2008
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
 // Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Christian Niephaus <christian.niephaus@fokus.fraunhofer.de>
+//     Christian Niephaus <cni@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -21,17 +21,13 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief 802.11 WLan MAC frame \n
+    \brief 802.11 WLANPacket public header */
 
-
-    */
-
-#ifndef WLANPACKET_HH_
-#define WLANPACKET_HH_
+#ifndef HH_SENF_Packets_80211Bundle_WLANPacket_
+#define HH_SENF_Packets_80211Bundle_WLANPacket_ 1
 
 #include "../../Packets/Packets.hh"
 #include "../DefaultBundle/EthernetPacket.hh"
-#include <boost/cstdint.hpp>
 
 namespace senf
 {
@@ -40,29 +36,32 @@ namespace senf
      * <b>Re-ordering of bits due to LSB byte order</b>
 
      */
-    struct WLANPacketParser_MgtFrameParser : public senf::PacketParserBase
+    struct WLANPacket_MgtFrameParser : public senf::PacketParserBase
     {
     #   include SENF_FIXED_PARSER()
-        SENF_PARSER_PRIVATE_BITFIELD    ( subtype,  4,  unsigned);
-        SENF_PARSER_SKIP_BITS   ( 4                                    ); //skip type and version
+        
+        SENF_PARSER_PRIVATE_BITFIELD ( subtype, 4,  unsigned                ); //<pkgdraw: hide
+	//skip type and version
+        SENF_PARSER_SKIP_BITS        (          4                           ); //<pkgdraw: hide
         //jump to fist address field
-        SENF_PARSER_SKIP                ( 3                                    );
-        SENF_PARSER_FIELD               ( da, MACAddressParser        );
-        SENF_PARSER_FIELD               ( sa, MACAddressParser        );
-        SENF_PARSER_FIELD               ( bssid, MACAddressParser        );
+        SENF_PARSER_SKIP             ( 3                                    ); //<pkgdraw: hide
+        SENF_PARSER_FIELD            ( destinationAddress, MACAddressParser );
+        SENF_PARSER_FIELD            ( sourceAddress,      MACAddressParser );
+        SENF_PARSER_FIELD            ( bssid,              MACAddressParser );
 
         //workaround since bitfield LSB parsers are not available
-        SENF_PARSER_PRIVATE_BITFIELD    (seqNumber_1, 4, unsigned);
-        SENF_PARSER_BITFIELD    (fragmentNumber, 4, unsigned);
-        SENF_PARSER_PRIVATE_FIELD     (seqNumber_2, UInt8Parser);
+        SENF_PARSER_PRIVATE_BITFIELD ( seqNumber_1,    4, unsigned );
+        SENF_PARSER_BITFIELD         ( fragmentNumber, 4, unsigned );
+        SENF_PARSER_PRIVATE_FIELD    ( seqNumber_2,    UInt8Parser );
 
-        SENF_PARSER_FINALIZE(WLANPacketParser_MgtFrameParser);
+        SENF_PARSER_FINALIZE(WLANPacket_MgtFrameParser);
 
         //this is needed due to the goto in the WLANPacketParser. Don't know exactly why yet.
         SENF_PARSER_INIT() {}
 
-        boost::uint16_t sequenceNumber() const;
-
+        boost::uint16_t sequenceNumber() const {
+            return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
+        };
     };
 
     /** \brief Control frame parser
@@ -71,23 +70,25 @@ namespace senf
      * currently only CTS, RTS and ACK control frames are supported
 
      */
-    struct WLANPacketParser_CtrlFrameParser : public senf::PacketParserBase
+    struct WLANPacket_CtrlFrameParser : public senf::PacketParserBase
     {
     #   include SENF_PARSER()
-        SENF_PARSER_PRIVATE_BITFIELD    ( subtype,  4,  unsigned);
-        SENF_PARSER_SKIP_BITS   ( 4                                    ); //skip type and version
+        
+        SENF_PARSER_PRIVATE_BITFIELD ( subtype,  4,  unsigned            ); //<pkgdraw: hide
+	//skip type and version
+        SENF_PARSER_SKIP_BITS        (           4                       ); //<pkgdraw: hide
         //jump to fist address field
-        SENF_PARSER_SKIP                ( 3,3                        );
-        SENF_PARSER_FIELD               ( ra, MACAddressParser         );
+        SENF_PARSER_SKIP             ( 3, 3                              ); //<pkgdraw: hide
+        SENF_PARSER_FIELD            ( receiverAddress, MACAddressParser );
 
         //only RTS frame contains a source address field
-        //variant is also needed so set to correct subtype value
-        SENF_PARSER_VARIANT ( subtype__,             subtype,
-                ( ids (na, na, set_cts, key(12, VoidPacketParser)) )
-                ( ids (na, na, set_ack, key(13, VoidPacketParser)) )
-                ( ids (sa, has_sa, set_rts, key(11, MACAddressParser)) ) );
+        //variant is also needed to set correct subtype value
+        SENF_PARSER_VARIANT ( subtype__, subtype,
+                ( ids( na,            is_cts, set_cts, key(12, VoidPacketParser)) )
+                ( ids( na,            is_ack, set_ack, key(13, VoidPacketParser)) )
+                ( ids( sourceAddress, is_rts, set_rts, key(11, MACAddressParser)) ) );
 
-        SENF_PARSER_FINALIZE(WLANPacketParser_CtrlFrameParser);
+        SENF_PARSER_FINALIZE(WLANPacket_CtrlFrameParser);
 
         //this is needed to due to the goto in the WLANPacketParser. Don't know exactly why yet.
         SENF_PARSER_INIT() {}
@@ -97,29 +98,29 @@ namespace senf
      * <b>Re-ordering of bits due to LSB byte order</b>
 
      */
-    struct WLANPacketParser_DataFrameParser : public senf::PacketParserBase
+    struct WLANPacket_DataFrameParser : public senf::PacketParserBase
     {
     #   include SENF_PARSER()
-        SENF_PARSER_PRIVATE_BITFIELD    ( subtype,  4,  unsigned);
+        SENF_PARSER_PRIVATE_BITFIELD ( subtype,  4,  unsigned  ); //<pkgdraw: hide
         //jump to 'toDS' and 'fromDS' bits
         //skip type and version
-        SENF_PARSER_SKIP_BITS   ( 4                                    );
+        SENF_PARSER_SKIP_BITS        ( 4                       ); //<pkgdraw: hide
         //skip other flags
-        SENF_PARSER_SKIP_BITS   ( 6                                    );
+        SENF_PARSER_SKIP_BITS        ( 6                       ); //<pkgdraw: hide
         //needed in data frames due to the variable address fields
-        SENF_PARSER_PRIVATE_BITFIELD    ( dsBits,    2,  unsigned);
+        SENF_PARSER_PRIVATE_BITFIELD ( dsBits,  2,  unsigned   ); //<pkgdraw: hide
         //skip duration field
-        SENF_PARSER_SKIP        ( 2,0                          );
+        SENF_PARSER_SKIP             ( 2, 2                    ); //<pkgdraw: hide
 
-        SENF_PARSER_PRIVATE_FIELD               ( addr1, MACAddressParser        );
-        SENF_PARSER_PRIVATE_FIELD               ( addr2, MACAddressParser        );
-        SENF_PARSER_PRIVATE_FIELD               ( addr3, MACAddressParser        );
+        SENF_PARSER_PRIVATE_FIELD    ( addr1, MACAddressParser );
+        SENF_PARSER_PRIVATE_FIELD    ( addr2, MACAddressParser );
+        SENF_PARSER_PRIVATE_FIELD    ( addr3, MACAddressParser );
 
         //sequence Number and fragment number
         //shift bits manually due to LSB
-        SENF_PARSER_PRIVATE_BITFIELD    (seqNumber_1, 4, unsigned);
-        SENF_PARSER_BITFIELD    (fragmentNumber, 4, unsigned);
-        SENF_PARSER_PRIVATE_FIELD     (seqNumber_2, UInt8Parser)
+        SENF_PARSER_PRIVATE_BITFIELD ( seqNumber_1,    4, unsigned );
+        SENF_PARSER_BITFIELD         ( fragmentNumber, 4, unsigned );
+        SENF_PARSER_PRIVATE_FIELD    ( seqNumber_2,    UInt8Parser );
 
         //TODO fourth address field in case of WDS
 //        SENF_PARSER_PRIVATE_VARIANT (wds_, dsBits,
@@ -127,26 +128,26 @@ namespace senf
 //                ( id      ( addr4,  key (3,                   MACAddressParser                     ))) );
 
         //QoS Filed
-        SENF_PARSER_VARIANT (qosField_, subtype,
-                ( ids (na, na, set_data, key(0, VoidPacketParser)))
-                ( ids (na, na, set_nullData, key(4, VoidPacketParser)))
-                ( ids (qosField, has_qosField, set_qosData, key(8, UInt16LSBParser)))
+        SENF_PARSER_VARIANT ( qosField_, subtype,
+                ( ids( na,       na,           set_data,        key(0, VoidPacketParser)) )
+                ( ids( na,       na,           set_nullData,    key(4, VoidPacketParser)) )
+                ( ids( qosField, has_qosField, set_qosData,     key(8, UInt16LSBParser )) )
                 //we cannot parse qos Null (data) frames at the moment
-                ( ids (na, na, set_qosNullData, key(12, UInt16LSBParser))) );
-
+                ( ids( na,       na,           set_qosNullData, key(12, UInt16LSBParser)) ) );
 
-
-        SENF_PARSER_FINALIZE(WLANPacketParser_DataFrameParser);
+        SENF_PARSER_FINALIZE(WLANPacket_DataFrameParser);
 
         //this is needed to due to the goto in the WLANPacketParser. Don't know exactly why yet.
         SENF_PARSER_INIT() {}
 
-        boost::uint16_t sequenceNumber() const;
+        boost::uint16_t sequenceNumber() const {
+            return (uint16_t)(seqNumber_2()) << 4 | seqNumber_1();
+        };
 
-        MACAddressParser ra() const { return addr1(); }; //ra is always addr1
-        MACAddressParser ta() const { return addr2(); }; //ta is always addr2
-        MACAddressParser sa() const;
-        MACAddressParser da() const;
+        MACAddressParser receiverAddress() const    { return addr1(); }; //ra is always addr1
+        MACAddressParser transmitterAddress() const { return addr2(); }; //ta is always addr2
+        MACAddressParser sourceAddress() const;
+        MACAddressParser destinationAddress() const;
         MACAddressParser bssid() const;
     };
 
@@ -164,36 +165,34 @@ namespace senf
          * Frame control field
          * re-ordering of fields due to the byte order
          */
-        SENF_PARSER_BITFIELD_RO    ( subtype,  4,  unsigned);
-        SENF_PARSER_BITFIELD_RO    ( type,     2,  unsigned);
-        SENF_PARSER_BITFIELD    ( version,  2,  unsigned);
-        SENF_PARSER_BITFIELD    ( order,     1,  bool);
-        SENF_PARSER_BITFIELD    ( protectedFrame,    1,  bool);
-        SENF_PARSER_BITFIELD    ( moreData,  1,  bool);
-        SENF_PARSER_BITFIELD    ( pwrMgt,   1,  bool);
-        SENF_PARSER_BITFIELD    ( retry,     1,  bool);
-        SENF_PARSER_BITFIELD    ( moreFrag,  1,  bool);
-        SENF_PARSER_BITFIELD    ( fromDS,    1,  bool);
-        SENF_PARSER_BITFIELD    ( toDS,      1,  bool);
-
-        SENF_PARSER_FIELD   (duration,          UInt16LSBParser);
-
-        SENF_PARSER_GOTO( subtype ); //subparsers need to know the subtype
-        SENF_PARSER_VARIANT ( type__,             type,
-                                ( id      ( mgtFrame,   WLANPacketParser_MgtFrameParser     ))
-                                ( id      ( ctrlFrame,  WLANPacketParser_CtrlFrameParser    ))
-                                ( id      ( dataFrame,  WLANPacketParser_DataFrameParser    ))
-                                ( novalue ( reserved,   WLANPacketParser_CtrlFrameParser    )) );
-
-        SENF_PARSER_CUSTOM_FIELD( fcs, senf:: UInt32Parser, fcs_t::fixed_bytes, fcs_t::fixed_bytes) {
+        SENF_PARSER_BITFIELD_RO ( subtype,        4,  unsigned );
+        SENF_PARSER_BITFIELD_RO ( type,           2,  unsigned );
+        SENF_PARSER_BITFIELD    ( version,        2,  unsigned );
+        SENF_PARSER_BITFIELD    ( order,          1,  bool     );
+        SENF_PARSER_BITFIELD    ( protectedFrame, 1,  bool     );
+        SENF_PARSER_BITFIELD    ( moreData,       1,  bool     );
+        SENF_PARSER_BITFIELD    ( pwrMgt,         1,  bool     );
+        SENF_PARSER_BITFIELD    ( retry,          1,  bool     );
+        SENF_PARSER_BITFIELD    ( moreFrag,       1,  bool     );
+        SENF_PARSER_BITFIELD    ( fromDS,         1,  bool     );
+        SENF_PARSER_BITFIELD    ( toDS,           1,  bool     );
+
+        SENF_PARSER_FIELD       ( duration,       UInt16LSBParser );
+
+        SENF_PARSER_GOTO( subtype ); // subparsers need to know the subtype
+        SENF_PARSER_VARIANT ( frameType_,  type,
+                (     ids( mgtFrame,  is_mgtFrame,  init_mgtFrame,  WLANPacket_MgtFrameParser  ))
+                (     ids( ctrlFrame, is_ctrlFrame, init_ctrlFrame, WLANPacket_CtrlFrameParser ))
+                (     ids( dataFrame, is_dataFrame, init_dataFrame, WLANPacket_DataFrameParser ))
+                ( novalue( reserved,                                WLANPacket_CtrlFrameParser )) );
+
+        SENF_PARSER_CUSTOM_FIELD( fcs, senf::UInt32Parser, fcs_t::fixed_bytes, fcs_t::fixed_bytes) {
           return parse<UInt32Parser>( data().size()-4 ); }
 
         SENF_PARSER_FINALIZE(WLANPacketParser);
 
         SENF_PARSER_INIT() {
             version() = 0;
-
-
         }
 
         //Problems can occur with old madwifi and ath5k. Some frames only
@@ -202,11 +201,21 @@ namespace senf
 
     };
 
+    /** \brief WLAN packet
+
+        \par Packet type (typedef):
+            \ref WLANPacket
+
+        \par Fields:
+            \ref WLANPacketParser
+	    \image html WLANPacket.png
+
+        \ingroup protocolbundle_80211
+     */
     struct WLANPacketType
         : public senf::PacketTypeBase,
-        public senf::PacketTypeMixin<WLANPacketType>
+          public senf::PacketTypeMixin<WLANPacketType>
     {
-
         typedef senf::PacketTypeMixin<WLANPacketType> mixin;
         typedef senf::ConcretePacket<WLANPacketType> packet;
         typedef WLANPacketParser parser;
@@ -216,15 +225,12 @@ namespace senf
         using mixin::initSize;
         using senf::PacketTypeBase::nextPacketRange;;
 
-
         static void dump(packet p, std::ostream &os);
 //        static PacketParserBase::size_type initSize();
     };
 
-    typedef WLANPacketType::packet WLANPacket;
-
+    typedef senf::ConcretePacket<WLANPacketType> WLANPacket;
 }
 
 
-
-#endif /* WLANPACKET_HH_ */
+#endif /* HH_SENF_Packets_80211Bundle_WLANPacket_ */