/usr/include/ns3.27/ns3/lr-wpan-mac.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 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 The Boeing Company
*
* 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:
* Gary Pei <guangyu.pei@boeing.com>
* kwong yin <kwong-sang.yin@boeing.com>
* Tom Henderson <thomas.r.henderson@boeing.com>
* Sascha Alexander Jopen <jopen@cs.uni-bonn.de>
*/
#ifndef LR_WPAN_MAC_H
#define LR_WPAN_MAC_H
#include <ns3/object.h>
#include <ns3/traced-callback.h>
#include <ns3/traced-value.h>
#include <ns3/mac16-address.h>
#include <ns3/mac64-address.h>
#include <ns3/sequence-number.h>
#include <ns3/lr-wpan-phy.h>
#include <ns3/event-id.h>
#include <deque>
namespace ns3 {
class Packet;
class LrWpanCsmaCa;
/**
* \defgroup lr-wpan LR-WPAN models
*
* This section documents the API of the IEEE 802.15.4-related models. For a generic functional description, please refer to the ns-3 manual.
*/
/**
* \ingroup lr-wpan
*
* Tx options
*/
typedef enum
{
TX_OPTION_NONE = 0, //!< TX_OPTION_NONE
TX_OPTION_ACK = 1, //!< TX_OPTION_ACK
TX_OPTION_GTS = 2, //!< TX_OPTION_GTS
TX_OPTION_INDIRECT = 4 //!< TX_OPTION_INDIRECT
} LrWpanTxOption;
/**
* \ingroup lr-wpan
*
* MAC states
*/
typedef enum
{
MAC_IDLE, //!< MAC_IDLE
MAC_CSMA, //!< MAC_CSMA
MAC_SENDING, //!< MAC_SENDING
MAC_ACK_PENDING, //!< MAC_ACK_PENDING
CHANNEL_ACCESS_FAILURE,//!< CHANNEL_ACCESS_FAILURE
CHANNEL_IDLE, //!< CHANNEL_IDLE
SET_PHY_TX_ON //!< SET_PHY_TX_ON
} LrWpanMacState;
namespace TracedValueCallback {
/**
* \ingroup lr-wpan
* TracedValue callback signature for LrWpanMacState.
*
* \param [in] oldValue original value of the traced variable
* \param [in] newValue new value of the traced variable
*/
typedef void (* LrWpanMacState)(LrWpanMacState oldValue,
LrWpanMacState newValue);
} // namespace TracedValueCallback
/**
* \ingroup lr-wpan
*
* table 80 of 802.15.4
*/
typedef enum
{
NO_PANID_ADDR = 0,
ADDR_MODE_RESERVED = 1,
SHORT_ADDR = 2,
EXT_ADDR = 3
} LrWpanAddressMode;
/**
* \ingroup lr-wpan
*
* table 83 of 802.15.4
*/
typedef enum
{
ASSOCIATED = 0,
PAN_AT_CAPACITY = 1,
PAN_ACCESS_DENIED = 2,
ASSOCIATED_WITHOUT_ADDRESS = 0xfe,
DISASSOCIATED = 0xff
} LrWpanAssociationStatus;
/**
* \ingroup lr-wpan
*
* Table 42 of 802.15.4-2006
*/
typedef enum
{
IEEE_802_15_4_SUCCESS = 0,
IEEE_802_15_4_TRANSACTION_OVERFLOW = 1,
IEEE_802_15_4_TRANSACTION_EXPIRED = 2,
IEEE_802_15_4_CHANNEL_ACCESS_FAILURE = 3,
IEEE_802_15_4_INVALID_ADDRESS = 4,
IEEE_802_15_4_INVALID_GTS = 5,
IEEE_802_15_4_NO_ACK = 6,
IEEE_802_15_4_COUNTER_ERROR = 7,
IEEE_802_15_4_FRAME_TOO_LONG = 8,
IEEE_802_15_4_UNAVAILABLE_KEY = 9,
IEEE_802_15_4_UNSUPPORTED_SECURITY = 10,
IEEE_802_15_4_INVALID_PARAMETER = 11
} LrWpanMcpsDataConfirmStatus;
/**
* \ingroup lr-wpan
*
* MCPS-DATA.request params. See 7.1.1.1
*/
struct McpsDataRequestParams
{
McpsDataRequestParams ()
: m_srcAddrMode (SHORT_ADDR),
m_dstAddrMode (SHORT_ADDR),
m_dstPanId (0),
m_dstAddr (),
m_msduHandle (0),
m_txOptions (0)
{
}
LrWpanAddressMode m_srcAddrMode; //!< Source address mode
LrWpanAddressMode m_dstAddrMode; //!< Destination address mode
uint16_t m_dstPanId; //!< Destination PAN identifier
Mac16Address m_dstAddr; //!< Destination address
uint8_t m_msduHandle; //!< MSDU handle
uint8_t m_txOptions; //!< Tx Options (bitfield)
};
/**
* \ingroup lr-wpan
*
* MCPS-DATA.confirm params. See 7.1.1.2
*/
struct McpsDataConfirmParams
{
uint8_t m_msduHandle; //!< MSDU handle
LrWpanMcpsDataConfirmStatus m_status; //!< The status of the last MSDU transmission
};
/**
* \ingroup lr-wpan
*
* MCPS-DATA.indication params. See 7.1.1.3
*/
struct McpsDataIndicationParams
{
uint8_t m_srcAddrMode; //!< Source address mode
uint16_t m_srcPanId; //!< Source PAN identifier
Mac16Address m_srcAddr; //!< Source address
uint8_t m_dstAddrMode; //!< Destination address mode
uint16_t m_dstPanId; //!< Destination PAN identifier
Mac16Address m_dstAddr; //!< Destination address
uint8_t m_mpduLinkQuality; //!< LQI value measured during reception of the MPDU
uint8_t m_dsn; //!< The DSN of the received data frame
};
/**
* \ingroup lr-wpan
*
* This callback is called after a McpsDataRequest has been called from
* the higher layer. It returns a status of the outcome of the
* transmission request
*/
typedef Callback<void, McpsDataConfirmParams> McpsDataConfirmCallback;
/**
* \ingroup lr-wpan
*
* This callback is called after a Mcps has successfully received a
* frame and wants to deliver it to the higher layer.
*
* \todo for now, we do not deliver all of the parameters in section
* 7.1.1.3.1 but just send up the packet.
*/
typedef Callback<void, McpsDataIndicationParams, Ptr<Packet> > McpsDataIndicationCallback;
/**
* \ingroup lr-wpan
*
* Class that implements the LR-WPAN Mac state machine
*/
class LrWpanMac : public Object
{
public:
/**
* Get the type ID.
*
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* The minimum number of octets added by the MAC sublayer to the PSDU.
* See IEEE 802.15.4-2006, section 7.4.1, Table 85
*/
static const uint32_t aMinMPDUOverhead;
/**
* Default constructor.
*/
LrWpanMac (void);
virtual ~LrWpanMac (void);
/**
* Check if the receiver will be enabled when the MAC is idle.
*
* \return true, if the receiver is enabled during idle periods, false otherwise
*/
bool GetRxOnWhenIdle (void);
/**
* Set if the receiver should be enabled when the MAC is idle.
*
* \param rxOnWhenIdle set to true to enable the receiver during idle periods
*/
void SetRxOnWhenIdle (bool rxOnWhenIdle);
// XXX these setters will become obsolete if we use the attribute system
/**
* Set the short address of this MAC.
*
* \param address the new address
*/
void SetShortAddress (Mac16Address address);
/**
* Get the short address of this MAC.
*
* \return the short address
*/
Mac16Address GetShortAddress (void) const;
/**
* Set the extended address of this MAC.
*
* \param address the new address
*/
void SetExtendedAddress (Mac64Address address);
/**
* Get the extended address of this MAC.
*
* \return the extended address
*/
Mac64Address GetExtendedAddress (void) const;
/**
* Set the PAN id used by this MAC.
*
* \param panId the new PAN id.
*/
void SetPanId (uint16_t panId);
/**
* Get the PAN id used by this MAC.
*
* \return the PAN id.
*/
uint16_t GetPanId (void) const;
/**
* IEEE 802.15.4-2006, section 7.1.1.1
* MCPS-DATA.request
* Request to transfer a MSDU.
*
* \param params the request parameters
* \param p the packet to be transmitted
*/
void McpsDataRequest (McpsDataRequestParams params, Ptr<Packet> p);
/**
* Set the CSMA/CA implementation to be used by the MAC.
*
* \param csmaCa the CSMA/CA implementation
*/
void SetCsmaCa (Ptr<LrWpanCsmaCa> csmaCa);
/**
* Set the underlying PHY for the MAC.
*
* \param phy the PHY
*/
void SetPhy (Ptr<LrWpanPhy> phy);
/**
* Get the underlying PHY of the MAC.
*
* \return the PHY
*/
Ptr<LrWpanPhy> GetPhy (void);
/**
* Set the callback for the indication of an incoming data packet.
* The callback implements MCPS-DATA.indication SAP of IEEE 802.15.4-2006,
* section 7.1.1.3.
*
* \param c the callback
*/
void SetMcpsDataIndicationCallback (McpsDataIndicationCallback c);
/**
* Set the callback for the confirmation of a data transmission request.
* The callback implements MCPS-DATA.confirm SAP of IEEE 802.15.4-2006,
* section 7.1.1.2.
*
* \param c the callback
*/
void SetMcpsDataConfirmCallback (McpsDataConfirmCallback c);
// interfaces between MAC and PHY
/**
* IEEE 802.15.4-2006 section 6.2.1.3
* PD-DATA.indication
* Indicates the transfer of an MPDU from PHY to MAC (receiving)
* @param psduLength number of bytes in the PSDU
* @param p the packet to be transmitted
* @param lqi Link quality (LQI) value measured during reception of the PPDU
*/
void PdDataIndication (uint32_t psduLength, Ptr<Packet> p, uint8_t lqi);
/**
* IEEE 802.15.4-2006 section 6.2.1.2
* Confirm the end of transmission of an MPDU to MAC
* @param status to report to MAC
* PHY PD-DATA.confirm status
*/
void PdDataConfirm (LrWpanPhyEnumeration status);
/**
* IEEE 802.15.4-2006 section 6.2.2.2
* PLME-CCA.confirm status
* @param status TRX_OFF, BUSY or IDLE
*/
void PlmeCcaConfirm (LrWpanPhyEnumeration status);
/**
* IEEE 802.15.4-2006 section 6.2.2.4
* PLME-ED.confirm status and energy level
* @param status SUCCESS, TRX_OFF or TX_ON
* @param energyLevel 0x00-0xff ED level for the channel
*/
void PlmeEdConfirm (LrWpanPhyEnumeration status, uint8_t energyLevel);
/**
* IEEE 802.15.4-2006 section 6.2.2.6
* PLME-GET.confirm
* Get attributes per definition from Table 23 in section 6.4.2
* @param status SUCCESS or UNSUPPORTED_ATTRIBUTE
* @param id the attributed identifier
* @param attribute the attribute value
*/
void PlmeGetAttributeConfirm (LrWpanPhyEnumeration status,
LrWpanPibAttributeIdentifier id,
LrWpanPhyPibAttributes* attribute);
/**
* IEEE 802.15.4-2006 section 6.2.2.8
* PLME-SET-TRX-STATE.confirm
* Set PHY state
* @param status in RX_ON,TRX_OFF,FORCE_TRX_OFF,TX_ON
*/
void PlmeSetTRXStateConfirm (LrWpanPhyEnumeration status);
/**
* IEEE 802.15.4-2006 section 6.2.2.10
* PLME-SET.confirm
* Set attributes per definition from Table 23 in section 6.4.2
* @param status SUCCESS, UNSUPPORTED_ATTRIBUTE, INVALID_PARAMETER, or READ_ONLY
* @param id the attributed identifier
*/
void PlmeSetAttributeConfirm (LrWpanPhyEnumeration status,
LrWpanPibAttributeIdentifier id);
/**
* CSMA-CA algorithm calls back the MAC after executing channel assessment.
*
* \param macState indicate BUSY oder IDLE channel condition
*/
void SetLrWpanMacState (LrWpanMacState macState);
/**
* Get the current association status.
*
* \return current association status
*/
LrWpanAssociationStatus GetAssociationStatus (void) const;
/**
* Set the current association status.
*
* \param status new association status
*/
void SetAssociationStatus (LrWpanAssociationStatus status);
//MAC sublayer constants
/**
* Length of a superframe slot in symbols. Defaults to 60 symbols in each
* superframe slot.
* See IEEE 802.15.4-2006, section 7.4.1, Table 85.
*/
uint64_t m_aBaseSlotDuration;
/**
* Number of a superframe slots per superframe. Defaults to 16.
* See IEEE 802.15.4-2006, section 7.4.1, Table 85.
*/
uint64_t m_aNumSuperframeSlots;
/**
* Length of a superframe in symbols. Defaults to
* aBaseSlotDuration * aNumSuperframeSlots in symbols.
* See IEEE 802.15.4-2006, section 7.4.1, Table 85.
*/
uint64_t m_aBaseSuperframeDuration;
//MAC PIB attributes
/**
* The time that the device transmitted its last beacon frame, in symbol
* periods. Only 24 bits used.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
uint64_t m_macBeaconTxTime;
/**
* Symbol boundary is same as m_macBeaconTxTime.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
uint64_t m_macSyncSymbolOffset;
/**
* Specification of how often the coordinator transmits its beacon.
* 0 - 15 with 15 means no beacons are being sent.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
uint64_t m_macBeaconOrder;
/**
* The length of the active portion of the outgoing superframe, including the
* beacon frame.
* 0 - 15 with 15 means the superframe will not be active after the beacon.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
uint64_t m_macSuperframeOrder;
/**
* Indicates if MAC sublayer is in receive all mode. True mean accept all
* frames from PHY.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
bool m_macPromiscuousMode;
/**
* 16 bits id of PAN on which this device is operating. 0xffff means not
* asscoiated.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
uint16_t m_macPanId;
/**
* Sequence number added to transmitted data or MAC command frame, 00-ff.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
SequenceNumber8 m_macDsn;
/**
* The maximum number of retries allowed after a transmission failure.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
uint8_t m_macMaxFrameRetries;
/**
* Indication of whether the MAC sublayer is to enable its receiver during
* idle periods.
* See IEEE 802.15.4-2006, section 7.4.2, Table 86.
*/
bool m_macRxOnWhenIdle;
/**
* Get the macAckWaitDuration attribute value.
*
* \return the maximum number symbols to wait for an acknowledgment frame
*/
uint64_t GetMacAckWaitDuration (void) const;
/**
* Get the macMaxFrameRetries attribute value.
*
* \return the maximum number of retries
*/
uint8_t GetMacMaxFrameRetries (void) const;
/**
* Set the macMaxFrameRetries attribute value.
*
* \param retries the maximum number of retries
*/
void SetMacMaxFrameRetries (uint8_t retries);
/**
* TracedCallback signature for sent packets.
*
* \param [in] packet The packet.
* \param [in] retries The number of retries.
* \param [in] backoffs The number of CSMA backoffs.
*/
typedef void (* SentTracedCallback)
(Ptr<const Packet> packet, uint8_t retries, uint8_t backoffs);
/**
* TracedCallback signature for LrWpanMacState change events.
*
* \param [in] oldValue The original state value.
* \param [in] newValue The new state value.
* \deprecated The LrWpanMacState is now accessible as the
* TracedValue \c MacStateValue. The \c MacState TracedCallback will
* be removed in a future release.
*/
typedef void (* StateTracedCallback)
(LrWpanMacState oldState, LrWpanMacState newState);
protected:
// Inherited from Object.
virtual void DoInitialize (void);
virtual void DoDispose (void);
private:
/**
* Helper structure for managing transmission queue elements.
*/
struct TxQueueElement
{
uint8_t txQMsduHandle; //!< MSDU Handle
Ptr<Packet> txQPkt; //!< Queued packet
};
/**
* Send an acknowledgment packet for the given sequence number.
*
* \param seqno the sequence number for the ACK
*/
void SendAck (uint8_t seqno);
/**
* Remove the tip of the transmission queue, including clean up related to the
* last packet transmission.
*/
void RemoveFirstTxQElement ();
/**
* Change the current MAC state to the given new state.
*
* \param newState the new state
*/
void ChangeMacState (LrWpanMacState newState);
/**
* Handle an ACK timeout with a packet retransmission, if there are
* retransmission left, or a packet drop.
*/
void AckWaitTimeout (void);
/**
* Check for remaining retransmissions for the packet currently being sent.
* Drop the packet, if there are no retransmissions left.
*
* \return true, if the packet should be retransmitted, false otherwise.
*/
bool PrepareRetransmission (void);
/**
* Check the transmission queue. If there are packets in the transmission
* queue and the MAC is idle, pick the first one and initiate a packet
* transmission.
*/
void CheckQueue (void);
/**
* The trace source fired when packets are considered as successfully sent
* or the transmission has been given up.
* Only non-broadcast packets are traced.
*
* The data should represent:
* packet, number of retries, total number of csma backoffs
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet>, uint8_t, uint8_t > m_sentPktTrace;
/**
* The trace source fired when packets come into the "top" of the device
* at the L3/L2 transition, when being queued for transmission.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macTxEnqueueTrace;
/**
* The trace source fired when packets are dequeued from the
* L3/l2 transmission queue.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macTxDequeueTrace;
/**
* The trace source fired when packets are being sent down to L1.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macTxTrace;
/**
* The trace source fired when packets where successfully transmitted, that is
* an acknowledgment was received, if requested, or the packet was
* successfully sent by L1, if no ACK was requested.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macTxOkTrace;
/**
* The trace source fired when packets are dropped due to missing ACKs or
* because of transmission failures in L1.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macTxDropTrace;
/**
* The trace source fired for packets successfully received by the device
* immediately before being forwarded up to higher layers (at the L2/L3
* transition). This is a promiscuous trace.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macPromiscRxTrace;
/**
* The trace source fired for packets successfully received by the device
* immediately before being forwarded up to higher layers (at the L2/L3
* transition). This is a non-promiscuous trace.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macRxTrace;
/**
* The trace source fired for packets successfully received by the device
* but dropped before being forwarded up to higher layers (at the L2/L3
* transition).
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_macRxDropTrace;
/**
* A trace source that emulates a non-promiscuous protocol sniffer connected
* to the device. Unlike your average everyday sniffer, this trace source
* will not fire on PACKET_OTHERHOST events.
*
* On the transmit size, this trace hook will fire after a packet is dequeued
* from the device queue for transmission. In Linux, for example, this would
* correspond to the point just before a device hard_start_xmit where
* dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET
* ETH_P_ALL handlers.
*
* On the receive side, this trace hook will fire when a packet is received,
* just before the receive callback is executed. In Linux, for example,
* this would correspond to the point at which the packet is dispatched to
* packet sniffers in netif_receive_skb.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_snifferTrace;
/**
* A trace source that emulates a promiscuous mode protocol sniffer connected
* to the device. This trace source fire on packets destined for any host
* just like your average everyday packet sniffer.
*
* On the transmit size, this trace hook will fire after a packet is dequeued
* from the device queue for transmission. In Linux, for example, this would
* correspond to the point just before a device hard_start_xmit where
* dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET
* ETH_P_ALL handlers.
*
* On the receive side, this trace hook will fire when a packet is received,
* just before the receive callback is executed. In Linux, for example,
* this would correspond to the point at which the packet is dispatched to
* packet sniffers in netif_receive_skb.
*
* \see class CallBackTraceSource
*/
TracedCallback<Ptr<const Packet> > m_promiscSnifferTrace;
/**
* A trace source that fires when the LrWpanMac changes states.
* Parameters are the old mac state and the new mac state.
*
* \deprecated This TracedCallback is deprecated and will be
* removed in a future release, Instead, use the \c MacStateValue
* TracedValue.
*/
TracedCallback<LrWpanMacState, LrWpanMacState> m_macStateLogger;
/**
* The PHY associated with this MAC.
*/
Ptr<LrWpanPhy> m_phy;
/**
* The CSMA/CA implementation used by this MAC.
*/
Ptr<LrWpanCsmaCa> m_csmaCa;
/**
* This callback is used to notify incoming packets to the upper layers.
* See IEEE 802.15.4-2006, section 7.1.1.3.
*/
McpsDataIndicationCallback m_mcpsDataIndicationCallback;
/**
* This callback is used to report data transmission request status to the
* upper layers.
* See IEEE 802.15.4-2006, section 7.1.1.2.
*/
McpsDataConfirmCallback m_mcpsDataConfirmCallback;
/**
* The current state of the MAC layer.
*/
TracedValue<LrWpanMacState> m_lrWpanMacState;
/**
* The current association status of the MAC layer.
*/
LrWpanAssociationStatus m_associationStatus;
/**
* The packet which is currently being sent by the MAC layer.
*/
Ptr<Packet> m_txPkt; // XXX need packet buffer instead of single packet
/**
* The short address used by this MAC. Currently we do not have complete
* extended address support in the MAC, nor do we have the association
* primitives, so this address has to be configured manually.
*/
Mac16Address m_shortAddress;
/**
* The extended address used by this MAC. Extended addresses are currently not
* really supported.
*/
Mac64Address m_selfExt;
/**
* The transmit queue used by the MAC.
*/
std::deque<TxQueueElement*> m_txQueue;
/**
* The number of already used retransmission for the currently transmitted
* packet.
*/
uint8_t m_retransmission;
/**
* The number of CSMA/CA retries used for sending the current packet.
*/
uint8_t m_numCsmacaRetry;
/**
* Scheduler event for the ACK timeout of the currently transmitted data
* packet.
*/
EventId m_ackWaitTimeout;
/**
* Scheduler event for a deferred MAC state change.
*/
EventId m_setMacState;
};
} // namespace ns3
#endif /* LR_WPAN_MAC_H */
|