src/lte/model/lte-pdcp-header.cc
author Peter D. Barnes, Jr. <barnes26@llnl.gov>
Thu, 14 Nov 2013 16:58:28 -0800
changeset 10410 4d4eb8097fa3
parent 9628 7fb591f54422
child 10652 dc18deba4502
permissions -rw-r--r--
doxygen] Suppress "warning: Member NS_OBJECT_ENSURE_REGISTERED is not documented"
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8368
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     2
/*
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     3
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     4
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     8
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    12
 * GNU General Public License for more details.
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    13
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    17
 *
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    18
 * Author: Manuel Requena <manuel.requena@cttc.es>
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    19
 */
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    20
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    21
#include "ns3/log.h"
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    22
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    23
#include "ns3/lte-pdcp-header.h"
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    24
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    25
NS_LOG_COMPONENT_DEFINE ("LtePdcpHeader");
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    26
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    27
namespace ns3 {
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    28
10410
4d4eb8097fa3 doxygen] Suppress "warning: Member NS_OBJECT_ENSURE_REGISTERED is not documented"
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9628
diff changeset
    29
NS_OBJECT_ENSURE_REGISTERED (LtePdcpHeader)
4d4eb8097fa3 doxygen] Suppress "warning: Member NS_OBJECT_ENSURE_REGISTERED is not documented"
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9628
diff changeset
    30
  ;
8368
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    31
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    32
LtePdcpHeader::LtePdcpHeader ()
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    33
  : m_dcBit (0xff),
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    34
    m_sequenceNumber (0xfffa)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    35
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    36
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    37
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    38
LtePdcpHeader::~LtePdcpHeader ()
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    39
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    40
  m_dcBit = 0xff;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    41
  m_sequenceNumber = 0xfffb;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    42
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    43
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    44
void
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    45
LtePdcpHeader::SetDcBit (uint8_t dcBit)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    46
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    47
  m_dcBit = dcBit & 0x01;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    48
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    49
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    50
void
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    51
LtePdcpHeader::SetSequenceNumber (uint16_t sequenceNumber)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    52
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    53
  m_sequenceNumber = sequenceNumber & 0x0FFF;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    54
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    55
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    56
uint8_t
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    57
LtePdcpHeader::GetDcBit () const
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    58
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    59
  return m_dcBit;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    60
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    61
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    62
uint16_t
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    63
LtePdcpHeader::GetSequenceNumber () const
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    64
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    65
  return m_sequenceNumber;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    66
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    67
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    68
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    69
TypeId
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    70
LtePdcpHeader::GetTypeId (void)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    71
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    72
  static TypeId tid = TypeId ("ns3::LtePdcpHeader")
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    73
    .SetParent<Header> ()
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    74
    .AddConstructor<LtePdcpHeader> ()
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    75
  ;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    76
  return tid;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    77
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    78
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    79
TypeId
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    80
LtePdcpHeader::GetInstanceTypeId (void) const
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    81
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    82
  return GetTypeId ();
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    83
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    84
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    85
void LtePdcpHeader::Print (std::ostream &os)  const
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    86
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    87
  os << "D/C=" << (uint16_t)m_dcBit;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    88
  os << " SN=" << m_sequenceNumber;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    89
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    90
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    91
uint32_t LtePdcpHeader::GetSerializedSize (void) const
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    92
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    93
  return 2;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    94
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    95
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    96
void LtePdcpHeader::Serialize (Buffer::Iterator start) const
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    97
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    98
  Buffer::Iterator i = start;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
    99
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   100
  i.WriteU8 ( (m_dcBit << 7) | (m_sequenceNumber & 0x0F00) >> 8 );
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   101
  i.WriteU8 ( (m_sequenceNumber & 0x00FF) );
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   102
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   103
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   104
uint32_t LtePdcpHeader::Deserialize (Buffer::Iterator start)
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   105
{
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   106
  Buffer::Iterator i = start;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   107
  uint8_t byte_1;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   108
  uint8_t byte_2;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   109
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   110
  byte_1 = i.ReadU8 ();
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   111
  byte_2 = i.ReadU8 ();
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   112
  m_dcBit = (byte_1 & 0x80) > 7;
9628
7fb591f54422 Assert when bad type of PDU type
Manuel Requena <manuel.requena@cttc.es>
parents: 8368
diff changeset
   113
  // For now, we just support DATA PDUs
7fb591f54422 Assert when bad type of PDU type
Manuel Requena <manuel.requena@cttc.es>
parents: 8368
diff changeset
   114
  NS_ASSERT (m_dcBit == DATA_PDU);
8368
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   115
  m_sequenceNumber = ((byte_1 & 0x0F) << 8) | byte_2;
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   116
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   117
  return GetSerializedSize ();
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   118
}
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   119
58ca2e408d26 Add PDCP header: basic fields
Manuel Requena <manuel.requena@cttc.es>
parents:
diff changeset
   120
}; // namespace ns3