ie-dot11s-configuration.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2008,2009 IITP RAS
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Kirill Andreev <andreev@iitp.ru>
 *          Aleksey Kovalenko <kovalenko@iitp.ru>
 */
 
#include "ie-dot11s-configuration.h"
 
#include "ns3/packet.h"
 
namespace ns3
{
namespace dot11s
{
 
Dot11sMeshCapability::Dot11sMeshCapability()
    : acceptPeerLinks(true),
      MCCASupported(false),
      MCCAEnabled(false),
      forwarding(true),
      beaconTimingReport(true),
      TBTTAdjustment(true),
      powerSaveLevel(false)
{
}
 
uint8_t
Dot11sMeshCapability::GetSerializedSize() const
{
    return 1;
}
 
uint8_t
Dot11sMeshCapability::GetUint8() const // IEEE 802.11-2012 8.4.2.100.8 Mesh Capability
{
    uint8_t result = 0;
    if (acceptPeerLinks)
    {
        result |= 1 << 0; // The Accepting Additional Mesh Peerings subfield is set to 1 if the mesh
                          // STA is willing to establish additional mesh peerings   with other mesh
                          // STAs and set to 0 otherwise
    }
    if (MCCASupported) // The MCCA Supported subfield is set to 1 if the mesh STA implements MCCA
                       // and set to 0 otherwise
    {
        result |= 1 << 1;
    }
    if (MCCAEnabled)
    {
        result |= 1 << 2;
    }
    if (forwarding)
    {
        result |= 1 << 3;
    }
    if (beaconTimingReport)
    {
        result |= 1 << 4;
    }
    if (TBTTAdjustment)
    {
        result |= 1 << 5;
    }
    if (powerSaveLevel)
    {
        result |= 1 << 6;
    }
    return result;
}
 
Buffer::Iterator
Dot11sMeshCapability::Serialize(Buffer::Iterator i) const
{
    i.WriteU8(GetUint8());
    return i;
}
 
Buffer::Iterator
Dot11sMeshCapability::Deserialize(Buffer::Iterator i)
{
    uint8_t cap = i.ReadU8();
    acceptPeerLinks = Is(cap, 0);
    MCCASupported = Is(cap, 1);
    MCCAEnabled = Is(cap, 2);
    forwarding = Is(cap, 3);
    beaconTimingReport = Is(cap, 4);
    TBTTAdjustment = Is(cap, 5);
    powerSaveLevel = Is(cap, 6);
    return i;
}
 
bool
Dot11sMeshCapability::Is(uint8_t cap, uint8_t n) const
{
    uint16_t mask = 1 << n;
    return (cap & mask);
}
 
WifiInformationElementId
IeConfiguration::ElementId() const
{
    return IE_MESH_CONFIGURATION;
}
 
IeConfiguration::IeConfiguration()
    : m_APSPId(PROTOCOL_HWMP),
      m_APSMId(METRIC_AIRTIME),
      m_CCMId(CONGESTION_NULL),
      m_SPId(SYNC_NEIGHBOUR_OFFSET),
      m_APId(AUTH_NULL),
      m_neighbors(0)
{
}
 
uint16_t
IeConfiguration::GetInformationFieldSize() const
{
    return 0   // Version
           + 1 // APSPId
           + 1 // APSMId
           + 1 // CCMId
           + 1 // SPId
           + 1 // APId
           + 1 // Mesh formation info (see 7.3.2.86.6 of 802.11s draft 3.0)
           + m_meshCap.GetSerializedSize();
}
 
void
IeConfiguration::SerializeInformationField(Buffer::Iterator i) const
{
    // Active Path Selection Protocol ID:
    i.WriteU8(m_APSPId);
    // Active Path Metric ID:
    i.WriteU8(m_APSMId);
    // Congestion Control Mode ID:
    i.WriteU8(m_CCMId);
    // Sync:
    i.WriteU8(m_SPId);
    // Auth:
    i.WriteU8(m_APId);
    i.WriteU8(m_neighbors << 1);
    m_meshCap.Serialize(i);
}
 
uint16_t
IeConfiguration::DeserializeInformationField(Buffer::Iterator i, uint16_t length)
{
    Buffer::Iterator start = i;
    // Active Path Selection Protocol ID:
    m_APSPId = (dot11sPathSelectionProtocol)i.ReadU8();
    // Active Path Metric ID:
    m_APSMId = (dot11sPathSelectionMetric)i.ReadU8();
    // Congestion Control Mode ID:
    m_CCMId = (dot11sCongestionControlMode)i.ReadU8();
    m_SPId = (dot11sSynchronizationProtocolIdentifier)i.ReadU8();
    m_APId = (dot11sAuthenticationProtocol)i.ReadU8();
    m_neighbors = (i.ReadU8() >> 1) & 0xF;
    i = m_meshCap.Deserialize(i);
    return i.GetDistanceFrom(start);
}
 
void
IeConfiguration::Print(std::ostream& os) const
{
    os << "MeshConfiguration=(neighbors=" << (uint16_t)m_neighbors
       << ", Active Path Selection Protocol ID=" << (uint32_t)m_APSPId
       << ", Active Path Selection Metric ID=" << (uint32_t)m_APSMId
       << ", Congestion Control Mode ID=" << (uint32_t)m_CCMId
       << ", Synchronize protocol ID=" << (uint32_t)m_SPId
       << ", Authentication protocol ID=" << (uint32_t)m_APId
       << ", Capabilities=" << m_meshCap.GetUint8();
    os << ")";
}
 
void
IeConfiguration::SetRouting(dot11sPathSelectionProtocol routingId)
{
    m_APSPId = routingId;
}
 
void
IeConfiguration::SetMetric(dot11sPathSelectionMetric metricId)
{
    m_APSMId = metricId;
}
 
bool
IeConfiguration::IsHWMP()
{
    return (m_APSPId == PROTOCOL_HWMP);
}
 
bool
IeConfiguration::IsAirtime()
{
    return (m_APSMId == METRIC_AIRTIME);
}
 
void
IeConfiguration::SetNeighborCount(uint8_t neighbors)
{
    m_neighbors = (neighbors > 31) ? 31 : neighbors;
}
 
uint8_t
IeConfiguration::GetNeighborCount()
{
    return m_neighbors;
}
 
const Dot11sMeshCapability&
IeConfiguration::MeshCapability()
{
    return m_meshCap;
}
 
bool
operator==(const Dot11sMeshCapability& a, const Dot11sMeshCapability& b)
{
    return ((a.acceptPeerLinks == b.acceptPeerLinks) && (a.MCCASupported == b.MCCASupported) &&
            (a.MCCAEnabled == b.MCCAEnabled) && (a.forwarding == b.forwarding) &&
            (a.beaconTimingReport == b.beaconTimingReport) &&
            (a.TBTTAdjustment == b.TBTTAdjustment) && (a.powerSaveLevel == b.powerSaveLevel));
}
 
bool
operator==(const IeConfiguration& a, const IeConfiguration& b)
{
    return ((a.m_APSPId == b.m_APSPId) && (a.m_APSMId == b.m_APSMId) && (a.m_CCMId == b.m_CCMId) &&
            (a.m_SPId == b.m_SPId) && (a.m_APId == b.m_APId) && (a.m_neighbors == b.m_neighbors) &&
            (a.m_meshCap == b.m_meshCap));
}
 
std::ostream&
operator<<(std::ostream& os, const IeConfiguration& a)
{
    a.Print(os);
    return os;
}
} // namespace dot11s
} // namespace ns3