/usr/include/ns3.27/ns3/ul-mac-messages.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007,2008,2009 INRIA, UDcast
*
* 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: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
* Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
* <amine.ismail@UDcast.com>
*/
#ifndef UCD_CHANNEL_ENCODINGS_H
#define UCD_CHANNEL_ENCODINGS_H
#include <stdint.h>
#include "ns3/buffer.h"
#include <list>
namespace ns3 {
/**
* \ingroup wimax
* This class implements the UCD channel encodings as described by "IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
* 11.3.1 UCD channel encodings, page 651
*/
class UcdChannelEncodings
{
public:
UcdChannelEncodings (void);
virtual ~UcdChannelEncodings (void);
/**
* Set BW request opp size
* \param bwReqOppSize the bandwidth request opp size
*/
void SetBwReqOppSize (uint16_t bwReqOppSize);
/**
* Set range request opp size
* \param rangReqOppSize the ranging request opp size
*/
void SetRangReqOppSize (uint16_t rangReqOppSize);
/**
* Set frequency
* \param frequency the frequency
*/
void SetFrequency (uint32_t frequency);
/**
* Get BW request opp size
* \returns the bandwidth request opp size
*/
uint16_t GetBwReqOppSize (void) const;
/**
* Get range request opp size
* \returns the ragning request opp size
*/
uint16_t GetRangReqOppSize (void) const;
/**
* Get frequency
* \returns the frequency
*/
uint32_t GetFrequency (void) const;
/**
* Get size
* \returns the size
*/
uint16_t GetSize (void) const;
/**
* Write item
* \param start the iterator
* \returns the updated iterator
*/
Buffer::Iterator Write (Buffer::Iterator start) const;
/**
* Read item
* \param start the iterator
* \returns the updated iterator
*/
Buffer::Iterator Read (Buffer::Iterator start);
private:
/**
* Write item
* \param start the iterator
* \returns the updated iterator
*/
virtual Buffer::Iterator DoWrite (Buffer::Iterator start) const = 0;
/**
* Read item
* \param start the iterator
* \returns the updated iterator
*/
virtual Buffer::Iterator DoRead (Buffer::Iterator start) = 0;
uint16_t m_bwReqOppSize; ///< BW request opp size
uint16_t m_rangReqOppSize; ///< range request opp size
uint32_t m_frequency; ///< frequency
};
} // namespace ns3
#endif /* UCD_CHANNEL_ENCODINGS_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef OFDM_UCD_CHANNEL_ENCODINGS_H
#define OFDM_UCD_CHANNEL_ENCODINGS_H
#include <stdint.h>
namespace ns3 {
/**
* This class implements the OFDM UCD channel encodings as described by "IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
* 11.3.1 UCD channel encodings, page 651
*/
class OfdmUcdChannelEncodings : public UcdChannelEncodings
{
public:
OfdmUcdChannelEncodings (void);
~OfdmUcdChannelEncodings (void);
/**
* Set SB channel reguest region full parameters
* \param sbchnlReqRegionFullParams the channel request region full parameters
*/
void SetSbchnlReqRegionFullParams (uint8_t sbchnlReqRegionFullParams);
/**
* Set SB channel for control codes
* \param sbchnlFocContCodes the channel control codes
*/
void SetSbchnlFocContCodes (uint8_t sbchnlFocContCodes);
/**
* Get SB channel request region full parameters
* \returns the channel request region full parameters
*/
uint8_t GetSbchnlReqRegionFullParams (void) const;
/**
* Get SB channel for control codes
* \returns the channel for control codes
*/
uint8_t GetSbchnlFocContCodes (void) const;
/**
* Get size
* \returns the size
*/
uint16_t GetSize (void) const;
private:
/**
* Write item
* \param start the iterator
* \returns the updated iterator
*/
virtual Buffer::Iterator DoWrite (Buffer::Iterator start) const;
/**
* Read item
* \param start the iterator
* \returns the updated iterator
*/
virtual Buffer::Iterator DoRead (Buffer::Iterator start);
uint8_t m_sbchnlReqRegionFullParams; ///< SB channel request region full parameters
uint8_t m_sbchnlFocContCodes; ///< SB channel for control codes
};
} // namespace ns3
#endif /* OFDM_UCD_CHANNEL_ENCODINGS_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef OFDM_UL_BURST_PROFILE_H
#define OFDM_UL_BURST_PROFILE_H
#include <stdint.h>
#include "ns3/buffer.h"
namespace ns3 {
/**
* This class implements the UL burst profile as described by "IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
* 11.3.1.1 Uplink burst profile encodings, page 655
*/
class OfdmUlBurstProfile
{
public:
/// UIUC enumeraton
enum Uiuc
{
UIUC_INITIAL_RANGING = 1,
UIUC_REQ_REGION_FULL,
UIUC_REQ_REGION_FOCUSED,
UIUC_FOCUSED_CONTENTION_IE,
UIUC_BURST_PROFILE_5,
UIUC_BURST_PROFILE_6,
UIUC_BURST_PROFILE_7,
UIUC_BURST_PROFILE_8,
UIUC_BURST_PROFILE_9,
UIUC_BURST_PROFILE_10,
UIUC_BURST_PROFILE_11,
UIUC_BURST_PROFILE_12,
UIUC_SUBCH_NETWORK_ENTRY,
UIUC_END_OF_MAP
};
OfdmUlBurstProfile (void);
~OfdmUlBurstProfile (void);
/**
* Set type
* \param type the type
*/
void SetType (uint8_t type);
/**
* Set length
* \param length the length
*/
void SetLength (uint8_t length);
/**
* Set UIUC
* \param uiuc the UIUC
*/
void SetUiuc (uint8_t uiuc);
/**
* Set FEC code type
* \param fecCodeType the FEC code type
*/
void SetFecCodeType (uint8_t fecCodeType);
/**
* Get type
* \returns the type
*/
uint8_t GetType (void) const;
/**
* Get length
* \returns the length
*/
uint8_t GetLength (void) const;
/**
* Get UIUC
* \returns the UIUC
*/
uint8_t GetUiuc (void) const;
/**
* Get FEC code type
* \returns the FEC code type
*/
uint8_t GetFecCodeType (void) const;
/**
* Get size
* \returns the size
*/
uint16_t GetSize (void) const;
/**
* Write item
* \param start the iterator
* \returns the updated iterator
*/
Buffer::Iterator Write (Buffer::Iterator start) const;
/**
* Read item
* \param start the iterator
* \returns the updated iterator
*/
Buffer::Iterator Read (Buffer::Iterator start);
private:
uint8_t m_type; ///< type
uint8_t m_length; ///< length
uint8_t m_uiuc; ///< UIUC
// TLV Encoded information
uint8_t m_fecCodeType; ///< FEC code type
};
} // namespace ns3
#endif /* OFDM_UL_BURST_PROFILE_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef UCD_H
#define UCD_H
#include <stdint.h>
#include "ns3/header.h"
#include <vector>
namespace ns3 {
/**
* This class implements the UCD message as described by "IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
* 6.3.2.3.3 Uplink Channel Descriptor (UCD) message, page 47
*/
class Ucd : public Header
{
public:
Ucd (void);
virtual ~Ucd (void);
/**
* Set configuration change count
* \param ucdCount the UCD count
*/
void SetConfigurationChangeCount (uint8_t ucdCount);
/**
* Set ranging backoff start
* \param rangingBackoffStart ranging backoff start
*/
void SetRangingBackoffStart (uint8_t rangingBackoffStart);
/**
* Set ranging backoff end
* \param rangingBackoffEnd the ranging backoff end
*/
void SetRangingBackoffEnd (uint8_t rangingBackoffEnd);
/**
* Set request backoff start
* \param requestBackoffStart the request backoff start
*/
void SetRequestBackoffStart (uint8_t requestBackoffStart);
/**
* Set request backoff end
* \param requestBackoffEnd the request backoff end
*/
void SetRequestBackoffEnd (uint8_t requestBackoffEnd);
/**
* Set channel encodings
* \param channelEncodings the channel encodings
*/
void SetChannelEncodings (OfdmUcdChannelEncodings channelEncodings);
/**
* Add UL burst profile
* \param ulBurstProfile the UL burst profile
*/
void AddUlBurstProfile (OfdmUlBurstProfile ulBurstProfile);
/**
* Set NR UL burst profiles
* \param nrUlBurstProfiles the NR UL burst profiles
*/
void SetNrUlBurstProfiles (uint8_t nrUlBurstProfiles);
/**
* Get configuration change count
* \returns the configuration change count
*/
uint8_t GetConfigurationChangeCount (void) const;
/**
* Get ranging backoff start
* \returns the ranging backoff start
*/
uint8_t GetRangingBackoffStart (void) const;
/**
* Get ranging backoff end
* \returns the ranging backoff end value
*/
uint8_t GetRangingBackoffEnd (void) const;
/**
* Get request backoff start
* \returns the request backoff start value
*/
uint8_t GetRequestBackoffStart (void) const;
/**
* Get request backoff end
* \returns the request backoff end value
*/
uint8_t GetRequestBackoffEnd (void) const;
/**
* Get channel encodings
* \returns the OFDM UCD channel encodings
*/
OfdmUcdChannelEncodings GetChannelEncodings (void) const;
/**
* Get UL burst profiles
* \returns the UL burst profile
*/
std::vector<OfdmUlBurstProfile> GetUlBurstProfiles (void) const;
/**
* Get number UL burst profiles
* \returns the number of UL burst profiles
*/
uint8_t GetNrUlBurstProfiles (void) const;
/**
* Get name
* \returns the name string
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
private:
uint8_t m_configurationChangeCount; ///< configuration change count
uint8_t m_rangingBackoffStart; ///< ranging backoff start
uint8_t m_rangingBackoffEnd; ///< ranging backoff end
uint8_t m_requestBackoffStart; ///< request backoff start
uint8_t m_requestBackoffEnd; ///< request backoff end
OfdmUcdChannelEncodings m_channelEncodings; ///< TLV Encoded information for the overall channel
std::vector<OfdmUlBurstProfile> m_ulBurstProfiles; ///< UL burst profiles
uint8_t m_nrUlBurstProfiles; ///< number UL burst profiles
};
} // namespace ns3
#endif /* UCD_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef OFDM_UL_MAP_IE_H
#define OFDM_UL_MAP_IE_H
#include <stdint.h>
#include "ns3/header.h"
#include "cid.h"
namespace ns3 {
/**
* This class implements the UL-MAP_IE message as described by "IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
* 6.3.2.3.43.7 UL-MAP_IE, page 115
*/
class OfdmUlMapIe
{
public:
OfdmUlMapIe (void);
~OfdmUlMapIe (void);
/**
* Set CID
* \param cid the CID
*/
void SetCid (const Cid &cid);
/**
* Set start time
* \param startTime the start time
*/
void SetStartTime (uint16_t startTime);
/**
* Set subchannel index
* \param subchannelIndex
*/
void SetSubchannelIndex (uint8_t subchannelIndex);
/**
* Set UIUC
* \param uiuc the UIUC
*/
void SetUiuc (uint8_t uiuc);
/**
* Set duration
* \param duration the duration
*/
void SetDuration (uint16_t duration);
/**
* Set midambe repetition interval
* \param midambleRepetitionInterval the midambe repetition interval
*/
void SetMidambleRepetitionInterval (uint8_t midambleRepetitionInterval);
/**
* Get CID
* \returns the CID
*/
Cid GetCid (void) const;
/**
* Get start time
* \returns the start time
*/
uint16_t GetStartTime (void) const;
/**
* Get subchannel index
* \returns the subchannel index
*/
uint8_t GetSubchannelIndex (void) const;
/**
* Get UIUC
* \returns the UIUC
*/
uint8_t GetUiuc (void) const;
/**
* Get duration
* \returns the duration
*/
uint16_t GetDuration (void) const;
/**
* Get Midamble repetition interval
* \returns the midamble repetition interval
*/
uint8_t GetMidambleRepetitionInterval (void) const;
/**
* Get size
* \returns the size
*/
uint16_t GetSize (void) const;
/**
* Write item
* \param start the iterator
* \returns the updated iterator
*/
Buffer::Iterator Write (Buffer::Iterator start) const;
/**
* Read item
* \param start the iterator
* \returns the udpated iterator
*/
Buffer::Iterator Read (Buffer::Iterator start);
private:
Cid m_cid; ///< CID
uint16_t m_startTime; ///< start time
uint8_t m_subchannelIndex; ///< subchannel index
uint8_t m_uiuc; ///< UIUC
uint16_t m_duration; ///<duration
uint8_t m_midambleRepetitionInterval; ///< midamble repetition interval
// fields to be implemented later on:
// m_focusedContentionIe()
// m_subchannelizedNetworkEntryIe()
// m_ulExtendedIe()
// m_paddingNibble;
};
} // namespace ns3
#endif /* OFDM_UL_MAP_IE_H */
// ----------------------------------------------------------------------------------------------------------
#ifndef UL_MAP_H
#define UL_MAP_H
#include <stdint.h>
#include "ns3/header.h"
#include <vector>
namespace ns3 {
/**
* This class implements the UL-MAP_IE message as described by "IEEE Standard for
* Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
* 8.2.1.8.2 Compressed UL-MAP, page 404
*/
class UlMap : public Header
{
public:
UlMap (void);
virtual ~UlMap (void);
/**
* Set UCD count
* \param ucdCount the UCD count
*/
void SetUcdCount (uint8_t ucdCount);
/**
* Set allocation start time
* \param allocationStartTime the allocation start time
*/
void SetAllocationStartTime (uint32_t allocationStartTime);
/**
* Add UL map element
* \param ulMapElement the UL map element
*/
void AddUlMapElement (OfdmUlMapIe ulMapElement);
/**
* Get UCD count
* \returns the UCD count
*/
uint8_t GetUcdCount (void) const;
/**
* Get allocation start time
* \returns the allocation start time
*/
uint32_t GetAllocationStartTime (void) const;
/**
* Get UL map elements
* \returns the UL map elements
*/
std::list<OfdmUlMapIe> GetUlMapElements (void) const;
/**
* Get name
* \returns the name
*/
std::string GetName (void) const;
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
void Print (std::ostream &os) const;
uint32_t GetSerializedSize (void) const;
void Serialize (Buffer::Iterator start) const;
uint32_t Deserialize (Buffer::Iterator start);
private:
uint8_t m_reserved; ///< changed as per the amendment 802.16e-2005
uint8_t m_ucdCount; ///< UCD count
uint32_t m_allocationStartTime; ///< allocation start time
std::list<OfdmUlMapIe> m_ulMapElements; ///< UL map elements
};
} // namespace ns3
#endif /* UL_MAP_H */
|