A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
lr-wpan-mac-base.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 Tokushima University, Japan.
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Alberto Gallegos Ramonet <alramonet@is.tokushima-u.ac.jp>
7 */
8
9#ifndef LR_WPAN_MAC_BASE_H
10#define LR_WPAN_MAC_BASE_H
11
12#include <ns3/callback.h>
13#include <ns3/mac16-address.h>
14#include <ns3/mac64-address.h>
15#include <ns3/nstime.h>
16#include <ns3/object.h>
17#include <ns3/packet.h>
18#include <ns3/ptr.h>
19
20#include <cstdint>
21
22namespace ns3
23{
24namespace lrwpan
25{
26
27/**
28 * \ingroup lr-wpan
29 *
30 * The status of a confirm or an indication primitive as a result of a previous request.
31 * Represent the value of status in IEEE 802.15.4-2011 primitives.
32 * (Tables 6, 12, 18, 20, 31, 33, 35, 37, 39, 47)
33 *
34 * Status codes values only appear in IEEE 802.15.4-2006, Table 78
35 * See also NXP JN5169 IEEE 802.15.4 Stack User Guide
36 * (Table 6: Status Enumerations and Section 6.1.23)
37 *
38 */
39enum class MacStatus : std::uint8_t
40{
41 SUCCESS = 0, //!< The operation was completed successfully.
42 FULL_CAPACITY = 0x01, //!< PAN at capacity. Association Status field (std. 2006, Table 83)
43 ACCESS_DENIED = 0x02, //!< PAN access denied. Association Status field (std. 2006, Table 83)
44 COUNTER_ERROR = 0xdb, //!< The frame counter of the received frame is invalid.
45 IMPROPER_KEY_TYPE = 0xdc, //!< The key is not allowed to be used with that frame type.
46 IMPROPER_SECURITY_LEVEL = 0xdd, //!< Insufficient security level expected by the recipient.
47 UNSUPPORTED_LEGACY = 0xde, //!< Deprecated security used in IEEE 802.15.4-2003
48 UNSUPPORTED_SECURITY = 0xdf, //!< The security applied is not supported.
49 BEACON_LOSS = 0xe0, //!< The beacon was lost following a synchronization request.
50 CHANNEL_ACCESS_FAILURE = 0xe1, //!< A Tx could not take place due to activity in the CH.
51 DENIED = 0xe2, //!< The GTS request has been denied by the PAN coordinator.
52 DISABLE_TRX_FAILURE = 0xe3, //!< The attempt to disable the transceier has failed.
53 SECURITY_ERROR = 0xe4, // Cryptographic process of the frame failed(FAILED_SECURITY_CHECK).
54 FRAME_TOO_LONG = 0xe5, //!< Frame more than aMaxPHYPacketSize or too large for CAP or GTS.
55 INVALID_GTS = 0xe6, //!< Missing GTS transmit or undefined direction.
56 INVALID_HANDLE = 0xe7, //!< When purging from TX queue handle was not found.
57 INVALID_PARAMETER = 0xe8, //!< Primitive parameter not supported or out of range.
58 NO_ACK = 0xe9, //!< No acknowledgment was received after macMaxFrameRetries.
59 NO_BEACON = 0xea, //!< A scan operation failed to find any network beacons.
60 NO_DATA = 0xeb, //!< No response data were available following a request.
61 NO_SHORT_ADDRESS = 0xec, //!< Failure due to unallocated 16-bit short address.
62 OUT_OF_CAP = 0xed, //!< (Deprecated) See IEEE 802.15.4-2003
63 PAN_ID_CONFLICT = 0xee, //!< PAN id conflict detected and informed to the coordinator.
64 REALIGMENT = 0xef, //!< A coordinator realigment command has been received.
65 TRANSACTION_EXPIRED = 0xf0, //!< The transaction expired and its information discarded.
66 TRANSACTION_OVERFLOW = 0xf1, //!< There is no capacity to store the transaction.
67 TX_ACTIVE = 0xf2, //!< The transceiver was already enabled.
68 UNAVAILABLE_KEY = 0xf3, //!< Unavailable key, unknown or blacklisted.
69 UNSUPPORTED_ATTRIBUTE = 0xf4, //!< SET/GET request issued with a non supported ID.
70 INVALID_ADDRESS = 0xf5, //!< Invalid source or destination address.
71 ON_TIME_TOO_LONG = 0xf6, //!< RX enable request fail due to syms. longer than Bcn. interval
72 PAST_TIME = 0xf7, //!< Rx enable request fail due to lack of time in superframe.
73 TRACKING_OFF = 0xf8, //!< This device is currently not tracking beacons.
74 INVALID_INDEX = 0xf9, //!< A MAC PIB write failed because specified index is out of range.
75 LIMIT_REACHED = 0xfa, //!< PAN descriptors stored reached max capacity.
76 READ_ONLY = 0xfb, //!< SET/GET request issued for a read only attribute.
77 SCAN_IN_PROGRESS = 0xfc, //!< Scan failed because already performing another scan.
78 SUPERFRAME_OVERLAP = 0xfd //!< Coordinator superframe and this device superframe tx overlap.
79};
80
81/**
82 * \ingroup lr-wpan
83 *
84 * table 80 of 802.15.4
85 */
93
94/**
95 * \ingroup lr-wpan
96 *
97 * Table 30 of IEEE 802.15.4-2011
98 */
106
107/**
108 * \ingroup lr-wpan
109 *
110 * MCPS-DATA.request params. See 7.1.1.1
111 */
113{
114 AddressMode m_srcAddrMode{SHORT_ADDR}; //!< Source address mode
115 AddressMode m_dstAddrMode{SHORT_ADDR}; //!< Destination address mode
116 uint16_t m_dstPanId{0}; //!< Destination PAN identifier
117 Mac16Address m_dstAddr; //!< Destination address
118 Mac64Address m_dstExtAddr; //!< Destination extended address
119 uint8_t m_msduHandle{0}; //!< MSDU handle
120 uint8_t m_txOptions{0}; //!< Tx Options (bitfield)
121};
122
123/**
124 * \ingroup lr-wpan
125 *
126 * MLME-START.request params. See 802.15.4-2011 Section 6.2.12.1
127 */
129{
130 uint16_t m_PanId{0}; //!< Pan Identifier used by the device.
131 uint8_t m_logCh{11}; //!< Logical channel on which to start using the
132 //!< new superframe configuration.
133 uint32_t m_logChPage{0}; //!< Logical channel page on which to start using the
134 //!< new superframe configuration.
135 uint32_t m_startTime{0}; //!< Time at which to begin transmitting beacons (Used by Coordinator
136 //!< not PAN Coordinators). The time is specified in symbols.
137 uint8_t m_bcnOrd{15}; //!< Beacon Order, Used to calculate the beacon interval, a value of 15
138 //!< indicates no periodic beacons will be transmitted.
139 uint8_t m_sfrmOrd{15}; //!< Superframe Order, indicates the length of the CAP in time slots.
140 bool m_panCoor{false}; //!< On true this device will become coordinator.
141 bool m_battLifeExt{false}; //!< Flag indicating whether or not the Battery life extension (BLE)
142 //!< features are used.
143 bool m_coorRealgn{false}; //!< True if a realignment request command is to be transmitted prior
144 //!< changing the superframe.
145};
146
147/**
148 * \ingroup lr-wpan
149 *
150 * MLME-SCAN.request params. See IEEE 802.15.4-2011 Section 6.2.10.1 Table 30
151 */
153{
154 MlmeScanType m_scanType{MLMESCAN_PASSIVE}; //!< Indicates the type of scan performed as
155 //!< described in IEEE 802.15.4-2011 (5.1.2.1).
156 uint32_t m_scanChannels{0x7FFF800}; //!< The channel numbers to be scanned.
157 //!< Default: (0x7FFF800 = Ch11-Ch26)
158 //!< 27 LSB (b0,b1,...,b26) = channels
159 uint8_t m_scanDuration{14}; //!< The factor (0-14) used to calculate the length of time
160 //!< to spend scanning.
161 //!< scanDurationSymbols =
162 //!< [aBaseSuperframeDuration * (2^m_scanDuration + 1)].
163 uint32_t m_chPage{0}; //!< The channel page on which to perform scan.
164};
165
166/**
167 * \ingroup lr-wpan
168 *
169 * MLME-ASSOCIATE.request params. See 802.15.4-2011 Section 6.2.2.1
170 */
172{
173 uint8_t m_chNum{11}; //!< The channel number on which to attempt association.
174 uint32_t m_chPage{0}; //!< The channel page on which to attempt association.
175 uint8_t m_coordAddrMode{SHORT_ADDR}; //!< The coordinator addressing mode for this
176 //!< primitive and subsequent MPDU.
177 uint16_t m_coordPanId{0}; //!< The identifier of the PAN with which to associate.
178 Mac16Address m_coordShortAddr; //!< The short address of the coordinator
179 //!< with which to associate.
180 Mac64Address m_coordExtAddr; //!< The extended address of the coordinator
181 //!< with which to associate.
182 uint8_t m_capabilityInfo{0}; //!< Specifies the operational capabilities
183 //!< of the associating device (bitmap).
184};
185
186/**
187 * \ingroup lr-wpan
188 *
189 * MLME-ASSOCIATE.response params. See 802.15.4-2011 6.2.2.3.
190 */
192{
193 Mac64Address m_extDevAddr; //!< The extended address of the device requesting association
194 Mac16Address m_assocShortAddr; //!< The short address allocated by the coordinator on successful
195 //!< assoc. FF:FF = Unsuccessful
197 MacStatus::ACCESS_DENIED}; //!< The status of the association
198 //!< attempt (As defined on Table 83 IEEE 802.15.4-2006)
199};
200
201/**
202 * \ingroup lr-wpan
203 *
204 * MLME-ORPHAN.response params. See 802.15.4-2011 Section 6.2.7.2
205 */
207{
208 Mac64Address m_orphanAddr; //!< The address of the orphaned device.
209 Mac16Address m_shortAddr; //!< The short address allocated.
210 bool m_assocMember{false}; //!< T = allocated with this coord | F = otherwise
211};
212
213/**
214 * \ingroup lr-wpan
215 *
216 * MLME-SYNC.request params. See 802.15.4-2011 Section 6.2.13.1
217 */
219{
220 uint8_t m_logCh{11}; //!< The channel number on which to attempt coordinator synchronization.
221 bool m_trackBcn{false}; //!< True if the mlme sync with the next beacon and attempts to track
222 //!< future beacons. False if mlme sync only the next beacon.
223};
224
225/**
226 * \ingroup lr-wpan
227 *
228 * MLME-POLL.request params. See 802.15.4-2011 Section 6.2.14.1
229 */
231{
232 AddressMode m_coorAddrMode{SHORT_ADDR}; //!< The addressing mode of the coordinator
233 //!< to which the pool is intended.
234 uint16_t m_coorPanId{0}; //!< The PAN id of the coordinator to which the poll is intended.
235 Mac16Address m_coorShortAddr; //!< Coordinator short address.
236 Mac64Address m_coorExtAddr; //!< Coordinator extended address.
237};
238
239/**
240 * \ingroup lr-wpan
241 *
242 * IEEE 802.15.4-2006 PHY and MAC PIB Attribute Identifiers Table 23 and Table 86.
243 * Note: Attribute identifiers use standardized values.
244 */
246{
247 pCurrentChannel = 0x00, //!< RF channel used for transmissions and receptions.
248 pCurrentPage = 0x04, //!< The current channel page.
249 macAckWaitDuration = 0x40, //!< Maximum number of symbols to wait for an acknowledgment.
250 macAssociationPermit = 0x41, //!< Indication of whether a coordinator is allowing association.
251 macAutoRequest = 0x42, //!< Indication of whether a device automatically sends a data request
252 //!< command if its address is listed in a beacon frame.
253 macBattLifeExt = 0x43, //!< Indication of whether BLE, through the reduction of coordinator
254 //!< receiver operation time during the CAP, is enabled.
255 macBattLifeExtPeriods = 0x44, //!< In BLE mode, the number of backoff periods during which the
256 //!< the receiver is enabled after the IFS following a beacon.
257 macBeaconPayload = 0x45, //!< The contents of the beacon payload.
258 macBeaconPayloadLength = 0x46, //!< The length in octets of the beacon payload.
259 macBeaconOrder = 0x47, //!< Specification of how often the coordinator transmits its beacon.
260 macBeaconTxTime = 0x48, //!< The time that the device transmitted its last beacome frame,
261 //!< in symbol periods.
262 macBsn = 0x49, //!< The sequence number added to the transmitted beacon frame.
263 macCoordExtendedAddress = 0x4a, //!< The 64-bit address of the coordinator through which
264 //!< the device is associated.
265 macCoordShortAddress = 0x4b, //!< The 16-bit short address assigned to the coordinator through
266 //!< which the device is associated. 0xFFFE = Ext address mode
267 //!< 0xFFFF = Unknown.
268 macDSN = 0x4c, //!< The sequence number added to the transmitted data or MAC command frame.
269 macGTSPermit = 0x4d, //!< True if the PAN coordinator is to accept GTS requests.
270 macMaxCSMABackoff = 0x4e, //!< The maximum number of backoffs the CSMA-CA algorithm
271 //!< will attempt before declaring a channel access failure.
272 macMinBE = 0x4f, //!< The minimum value of the backoff exponent (BE) in the CSMA-CA algorithm.
273 macExtendedAddress = 0x6f, //!< The extended address of the device (64 bit address). The id
274 //!< is not compliant for 2003 and 2006 versions, but this attribute
275 //!< is later on added to the Pib attributes in 2011 and subsequent
276 //!< editions of the standard.
277 macPanId = 0x50, //!< The 16-bit identifier of the Personal Area Network (PAN).
278 macPromiscuousMode = 0x51, //!< Indication of whether the MAC sublayer is in a promiscuous
279 //!< mode. True indicates that the MAC sublayer accepts all frames.
280 macRxOnWhenIdle = 0x52, //!< Indication of whether the MAC is enabled during idle periods.
281 macShortAddress = 0x53, //!< The short address of the device (16 bit address).
282 macSuperframeOrder = 0x54, //!< The length of the active portion of the outgoing superframe,
283 //!< including the beacon frame.
284 macTransactionPersistenceTime = 0x55, //!< The maximum time (in unit periods) that a
285 //!< transaction is stored by a coordinator and
286 //!< indicated in its beacon.
287 macMaxFrameRetries = 0x59, //!< The maximum number of retries allowed after a transmission
288 //!< failure.
289 macResponseWaitTime = 0x5a, //!< The maximum time in multiples of aBaseSuperframeDuration, a
290 //!< device shall wait for a response command frame to be
291 //!< available following a request command frame.
292 unsupported = 255
293 // TODO: complete other MAC pib attributes
295
296/**
297 * \ingroup lr-wpan
298 *
299 * IEEE802.15.4-2011 PHY PIB Attributes Table 52 in section 6.4.2
300 */
301struct MacPibAttributes : public SimpleRefCount<MacPibAttributes>
302{
303 std::vector<uint8_t> macBeaconPayload; //!< The set with the contents of the beacon payload.
304 uint8_t macBeaconPayloadLength{0}; //!< The length in octets of the beacon payload.
305 Mac16Address macShortAddress; //!< The 16 bit mac short address
306 Mac64Address macExtendedAddress; //!< The EUI-64 bit address
307 uint16_t macPanId{0xffff}; //!< The identifier of the PAN
308 bool macAssociationPermit{true}; //!< Indication of whether the coordinator is allowing
309 //!< association.
310 bool macRxOnWhenIdle{true}; //!< Indication of whether the MAC is enabled during idle periods.
311 bool macPromiscuousMode{false}; //!< Indication of whether the mac is in promiscuous mode
312 //!< (Receive all mode).
313 uint8_t pCurrentChannel{11}; //!< The current logical channel in used in the PHY
314 uint8_t pCurrentPage{0}; //!< The current logical page in use in the PHY
315 // TODO: complete other MAC pib attributes
316};
317
318/**
319 * \ingroup lr-wpan
320 *
321 * MCPS-DATA.confirm params. See 7.1.1.2
322 */
324{
325 uint8_t m_msduHandle{0}; //!< MSDU handle
327 //!< of the last MSDU transmission
328};
329
330/**
331 * \ingroup lr-wpan
332 *
333 * MCPS-DATA.indication params. See 7.1.1.3
334 */
336{
337 uint8_t m_srcAddrMode{SHORT_ADDR}; //!< Source address mode
338 uint16_t m_srcPanId{0}; //!< Source PAN identifier
339 Mac16Address m_srcAddr; //!< Source address
340 Mac64Address m_srcExtAddr; //!< Source extended address
341 uint8_t m_dstAddrMode{SHORT_ADDR}; //!< Destination address mode
342 uint16_t m_dstPanId{0}; //!< Destination PAN identifier
343 Mac16Address m_dstAddr; //!< Destination address
344 Mac64Address m_dstExtAddr; //!< Destination extended address
345 uint8_t m_mpduLinkQuality{0}; //!< LQI value measured during reception of the MPDU
346 uint8_t m_dsn{0}; //!< The DSN of the received data frame
347};
348
349/**
350 * \ingroup lr-wpan
351 *
352 * MLME-ASSOCIATE.indication params. See 802.15.4-2011 6.2.2.2.
353 */
355{
356 Mac64Address m_extDevAddr; //!< The extended address of the device requesting association
357 uint8_t capabilityInfo{0}; //!< The operational capabilities of
358 //!< the device requesting association.
359 uint8_t lqi{0}; //!< The link quality indicator of the received associate request command
360 //!< (Not officially supported in the standard but found in implementations)
361};
362
363/**
364 * \ingroup lr-wpan
365 *
366 * MLME-COMM-STATUS.indication params. See 802.15.4-2011 Section 6.2.4.2 Table 18
367 */
369{
370 uint16_t m_panId{0}; //!< The PAN identifier of the device from which the frame was received or
371 //!< to which the frame was being sent.
372 uint8_t m_srcAddrMode{SHORT_ADDR}; //!< The source addressing mode for this primitive
373 Mac16Address m_srcShortAddr; //!< The short address of the entity from which the frame causing
374 //!< the error originated.
375 Mac64Address m_srcExtAddr; //!< The extended address of the entity from which the frame causing
376 //!< the error originated.
377 uint8_t m_dstAddrMode{SHORT_ADDR}; //!< The destination addressing mode for this primitive.
378 Mac16Address m_dstShortAddr; //!< The short address of the device for
379 //!< which the frame was intended.
380 Mac64Address m_dstExtAddr; //!< The extended address of the device for
381 //!< which the frame was intended.
382 MacStatus m_status{MacStatus::INVALID_PARAMETER}; //!< The communication status
383};
384
385/**
386 * \ingroup lr-wpan
387 *
388 * MLME-ORPHAN.indication params. See 802.15.4-2011 Section 6.2.7.1
389 */
391{
392 Mac64Address m_orphanAddr; //!< The address of the orphaned device.
393};
394
395/**
396 * \ingroup lr-wpan
397 *
398 * MLME-START.confirm params. See 802.15.4-2011 Section 6.2.12.2
399 */
401{
403 //!< a MLME-start.request
404};
405
406/**
407 * \ingroup lr-wpan
408 *
409 * PAN Descriptor, Table 17 IEEE 802.15.4-2011
410 */
412{
413 AddressMode m_coorAddrMode{SHORT_ADDR}; //!< The coordinator addressing mode corresponding
414 //!< to the received beacon frame.
415 uint16_t m_coorPanId{0xffff}; //!< The PAN ID of the coordinator as specified in
416 //!< the received beacon frame.
417 Mac16Address m_coorShortAddr; //!< The coordinator short address as specified in the coordinator
418 //!< address mode.
419 Mac64Address m_coorExtAddr; //!< The coordinator extended address as specified in the
420 //!< coordinator address mode.
421 uint8_t m_logCh{11}; //!< The current channel number occupied by the network.
422 uint8_t m_logChPage{0}; //!< The current channel page occupied by the network.
423 uint16_t m_superframeSpec{0}; //!< The superframe specification as specified in the received
424 //!< beacon frame.
425 bool m_gtsPermit{false}; //!< TRUE if the beacon is from the PAN coordinator
426 //!< that is accepting GTS requests.
427 uint8_t m_linkQuality{0}; //!< The LQI at which the network beacon was received.
428 //!< Lower values represent lower LQI.
429 Time m_timeStamp; //!< Beacon frame reception time. Used as Time data type in ns-3 to avoid
430 //!< precision problems.
431};
432
433/**
434 * \ingroup lr-wpan
435 *
436 * MLME-SCAN.confirm params. See IEEE 802.15.4-2011 Section 6.2.10.2
437 */
439{
440 MacStatus m_status{MacStatus::INVALID_PARAMETER}; //!< The status of the scan request.
441 uint8_t m_scanType{MLMESCAN_PASSIVE}; //!< Indicates the type of scan
442 //!< performed (ED,ACTIVE,PASSIVE,ORPHAN).
443 uint32_t m_chPage{0}; //!< The channel page on which the scan was performed.
444 std::vector<uint8_t> m_unscannedCh; //!< A list of channels given in the request which
445 //!< were not scanned (Not valid for ED scans).
446 uint8_t m_resultListSize{0}; //!< The number of elements returned in the appropriate
447 //!< result list. (Not valid for Orphan scan).
448 std::vector<uint8_t> m_energyDetList; //!< A list of energy measurements, one for each
449 //!< channel searched during ED scan
450 //!< (Not valid for Active, Passive or Orphan Scans)
451 std::vector<PanDescriptor> m_panDescList; //!< A list of PAN descriptor, one for each beacon
452 //!< found (Not valid for ED and Orphan scans).
453};
454
455/**
456 * \ingroup lr-wpan
457 *
458 * MLME-ASSOCIATE.confirm params. See 802.15.4-2011 Section 6.2.2.4
459 */
461{
462 Mac16Address m_assocShortAddr; //!< The short address used in the association request
464 //!< a MLME-associate.request
465};
466
467/**
468 * \ingroup lr-wpan
469 *
470 * MLME-BEACON-NOTIFY.indication params. See 802.15.4-2011 Section 6.2.4.1, Table 16
471 */
473{
474 uint8_t m_bsn{0}; //!< The beacon sequence number.
475 PanDescriptor m_panDescriptor; //!< The PAN descriptor for the received beacon.
476 uint32_t m_sduLength{0}; //!< The number of octets contained in the beacon payload.
477 Ptr<Packet> m_sdu; //!< The set of octets comprising the beacon payload.
478};
479
480/**
481 * \ingroup lr-wpan
482 *
483 * MLME-SYNC-LOSS.indication params. See 802.15.4-2011 Section 6.2.13.2, Table 37
484 */
486{
487 MacStatus m_lossReason{MacStatus::PAN_ID_CONFLICT}; //!< The reason for the lost
488 //!< of synchronization.
489 uint16_t m_panId{0}; //!< The PAN identifier with which the device lost synchronization or to
490 //!< which it was realigned.
491 uint8_t m_logCh{11}; //!< The channel number on which the device lost synchronization or to
492 //!< which it was realigned.
493};
494
495/**
496 * \ingroup lr-wpan
497 *
498 * MLME-SET.confirm params. See 802.15.4-2011 Section 6.2.11.2
499 */
501{
503 //!< the request to write
504 //!< the PIB attribute.
505 MacPibAttributeIdentifier id; //!< The id of the PIB attribute that was written.
506};
507
508/**
509 * \ingroup lr-wpan
510 *
511 * MLME-START.confirm params. See 802.15.4-2011 Section 6.2.14.2
512 */
514{
516 //!< status resulting from a
517 //!< MLME-poll.request.
518};
519
520/**
521 * \ingroup lr-wpan
522 *
523 * This callback is called after a McpsDataRequest has been called from
524 * the higher layer. It returns a status of the outcome of the
525 * transmission request
526 */
528
529/**
530 * \ingroup lr-wpan
531 *
532 * This callback is called after a Mcps has successfully received a
533 * frame and wants to deliver it to the higher layer.
534 *
535 * \todo for now, we do not deliver all of the parameters in section
536 * 802.15.4-2006 7.1.1.3.1 but just send up the packet.
537 */
539
540/**
541 * \ingroup lr-wpan
542 *
543 * This callback is called after a Mlme has successfully received a command
544 * frame and wants to deliver it to the higher layer.
545 *
546 * Security related parameters and not handle.
547 * See 802.15.4-2011 6.2.2.2.
548 */
550
551/**
552 * \ingroup lr-wpan
553 *
554 * This callback is called by the MLME and issued to its next higher layer following
555 * a transmission instigated through a response primitive.
556 *
557 * Security related parameters and not handle.
558 * See 802.15.4-2011 6.2.4.2
559 */
561
562/**
563 * \ingroup lr-wpan
564 *
565 * This callback is called by the MLME and issued to its next higher layer following
566 * the reception of a orphan notification.
567 *
568 * Security related parameters and not handle.
569 * See 802.15.4-2011 6.2.7.1
570 */
572
573/**
574 * \ingroup lr-wpan
575 *
576 * This callback is called after a MlmeStartRequest has been called from
577 * the higher layer. It returns a status of the outcome of the
578 * transmission request
579 */
581
582/**
583 * \ingroup lr-wpan
584 *
585 * This callback is called after a MlmeScanRequest has been called from
586 * the higher layer. It returns a status of the outcome of the scan.
587 */
589
590/**
591 * \ingroup lr-wpan
592 *
593 * This callback is called after a MlmeAssociateRequest has been called from
594 * the higher layer. It returns a status of the outcome of the
595 * association request
596 */
598
599/**
600 * \ingroup lr-wpan
601 *
602 * This callback is called after a Mlme has successfully received a
603 * beacon frame and wants to deliver it to the higher layer.
604 *
605 * \todo for now, we do not deliver all of the parameters in section
606 * 802.15.4-2006 6.2.4.1 but just send up the packet.
607 */
609
610/**
611 * \ingroup lr-wpan
612 *
613 * This callback is called to indicate the loss of synchronization with
614 * a coordinator.
615 *
616 * \todo for now, we do not deliver all of the parameters in section
617 * See IEEE 802.15.4-2011 6.2.13.2.
618 */
620
621/**
622 * \ingroup lr-wpan
623 *
624 * This callback is called after a MlmeSetRequest has been called from
625 * the higher layer to set a PIB. It returns a status of the outcome of the
626 * write attempt.
627 */
629
630/**
631 * \ingroup lr-wpan
632 *
633 * This callback is called after a MlmeGetRequest has been called from
634 * the higher layer to get a PIB. It returns a status of the outcome of the
635 * write attempt.
636 */
639
640/**
641 * \ingroup lr-wpan
642 *
643 * This callback is called after a Mlme-Poll.Request has been called from
644 * the higher layer. It returns a status of the outcome of the
645 * transmission request
646 */
648
649/**
650 * \ingroup netdevice
651 *
652 * \brief Lr-wpan MAC layer abstraction
653 *
654 * This class defines the interface functions (primitives) used by a IEEE 802.15.4-2011 compliant
655 * MAC layer. Any lr-wpan MAC should extend from this class and implement the
656 * behavior of the basic MAC interfaces (primitives).
657 *
658 */
659class LrWpanMacBase : public Object
660{
661 public:
662 /**
663 * \brief Get the type ID.
664 * \return the object TypeId
665 */
666 static TypeId GetTypeId();
667 ~LrWpanMacBase() override;
668
669 /**
670 * IEEE 802.15.4-2006, section 7.1.1.1
671 * MCPS-DATA.request
672 * Request to transfer a MSDU.
673 *
674 * \param params the request parameters
675 * \param p the packet to be transmitted
676 */
678
679 /**
680 * IEEE 802.15.4-2006, section 7.1.14.1
681 * MLME-START.request
682 * Request to allow a PAN coordinator to initiate
683 * a new PAN or beginning a new superframe configuration.
684 *
685 * \param params the request parameters
686 */
687 virtual void MlmeStartRequest(MlmeStartRequestParams params) = 0;
688
689 /**
690 * IEEE 802.15.4-2011, section 6.2.10.1
691 * MLME-SCAN.request
692 * Request primitive used to initiate a channel scan over a given list of channels.
693 *
694 * \param params the scan request parameters
695 */
696 virtual void MlmeScanRequest(MlmeScanRequestParams params) = 0;
697
698 /**
699 * IEEE 802.15.4-2011, section 6.2.2.1
700 * MLME-ASSOCIATE.request
701 * Request primitive used by a device to request an association with
702 * a coordinator.
703 *
704 * \param params the request parameters
705 */
707
708 /**
709 * IEEE 802.15.4-2011, section 6.2.2.3
710 * MLME-ASSOCIATE.response
711 * Primitive used to initiate a response to an MLME-ASSOCIATE.indication
712 * primitive.
713 *
714 * \param params the associate response parameters
715 */
717
718 /**
719 * IEEE 802.15.4-2011, section 6.2.13.1
720 * MLME-SYNC.request
721 * Request to synchronize with the coordinator by acquiring and,
722 * if specified, tracking beacons.
723 *
724 * \param params the request parameters
725 */
726 virtual void MlmeSyncRequest(MlmeSyncRequestParams params) = 0;
727
728 /**
729 * IEEE 802.15.4-2011, section 6.2.14.2
730 * MLME-POLL.request
731 * Prompts the device to request data from the coordinator.
732 *
733 * \param params the request parameters
734 */
735 virtual void MlmePollRequest(MlmePollRequestParams params) = 0;
736
737 /**
738 * IEEE 802.15.4-2011, section 6.2.7.2
739 * MLME-ORPHAN.response
740 * Primitive used to initiatte a response to an MLME-ORPHAN.indication
741 * primitive.
742 *
743 * \param params the orphan response parameters
744 */
746
747 /**
748 * IEEE 802.15.4-2011, section 6.2.11.1
749 * MLME-SET.request
750 * Attempts to write the given value to the indicated PIB attribute.
751 *
752 * \param id the attributed identifier
753 * \param attribute the attribute value
754 */
756
757 /**
758 * IEEE 802.15.4-2006, section 7.1.6.1
759 * MLME-GET.request
760 * Request information about a given PIB attribute.
761 * Note: The PibAttributeIndex parameter is not included because
762 * attributes that represent tables are not supported.
763 *
764 * \param id the attribute identifier
765 */
767
768 /**
769 * Set the callback for the confirmation of a data transmission request.
770 * The callback implements MCPS-DATA.confirm SAP of IEEE 802.15.4-2006,
771 * section 7.1.1.2.
772 *
773 * \param c the callback
774 */
776
777 /**
778 * Set the callback for the indication of an incoming data packet.
779 * The callback implements MCPS-DATA.indication SAP of IEEE 802.15.4-2006,
780 * section 7.1.1.3.
781 *
782 * \param c the callback
783 */
785
786 /**
787 * Set the callback for the indication of an incoming associate request command.
788 * The callback implements MLME-ASSOCIATE.indication SAP of IEEE 802.15.4-2011,
789 * section 6.2.2.2.
790 *
791 * \param c the callback
792 */
794
795 /**
796 * Set the callback for the indication to a response primitive.
797 * The callback implements MLME-COMM-STATUS.indication SAP of IEEE 802.15.4-2011,
798 * section 6.2.4.2.
799 *
800 * \param c the callback
801 */
803
804 /**
805 * Set the callback for the indication to the reception of an orphan notification.
806 * The callback implements MLME-ORPHAN.indication SAP of IEEE 802.15.4-2011,
807 * section 6.2.7.1.
808 *
809 * \param c the callback
810 */
812
813 /**
814 * Set the callback for the confirmation of a data transmission request.
815 * The callback implements MLME-START.confirm SAP of IEEE 802.15.4-2006,
816 * section 7.1.14.2.
817 *
818 * \param c the callback
819 */
821
822 /**
823 * Set the callback for the confirmation of a data transmission request.
824 * The callback implements MLME-SCAN.confirm SAP of IEEE 802.15.4-2011,
825 * section 6.2.10.2.
826 *
827 * \param c the callback
828 */
830
831 /**
832 * Set the callback for the confirmation of a data transmission request.
833 * The callback implements MLME-ASSOCIATE.confirm SAP of IEEE 802.15.4-2011,
834 * section 6.2.2.4.
835 *
836 * \param c the callback
837 */
839
840 /**
841 * Set the callback for the indication of an incoming beacon packet.
842 * The callback implements MLME-BEACON-NOTIFY.indication SAP of IEEE 802.15.4-2011,
843 * section 6.2.4.1.
844 *
845 * \param c the callback
846 */
848
849 /**
850 * Set the callback for the loss of synchronization with a coordinator.
851 * The callback implements MLME-SYNC-LOSS.indication SAP of IEEE 802.15.4-2011,
852 * section 6.2.13.2.
853 *
854 * \param c the callback
855 */
857
858 /**
859 * Set the callback for the confirmation of an attempt to write an attribute.
860 * The callback implements MLME-SET.confirm SAP of IEEE 802.15.4-2011,
861 * section 6.2.11.2
862 *
863 * \param c the callback
864 */
866
867 /**
868 * Set the callback for the confirmation of an attempt to read an attribute.
869 * The callback implements MLME-GET.confirm SAP of IEEE 802.15.4-2011,
870 * section 6.2.5.2
871 *
872 * \param c the callback
873 */
875
876 /**
877 * Set the callback for the confirmation of a data transmission request.
878 * The callback implements MLME-POLL.confirm SAP of IEEE 802.15.4-2011,
879 * section 6.2.14.2
880 *
881 * \param c the callback
882 */
884
885 protected:
886 /**
887 * This callback is used to report data transmission request status to the
888 * upper layers.
889 * See IEEE 802.15.4-2006, section 7.1.1.2.
890 */
892
893 /**
894 * This callback is used to notify incoming packets to the upper layers.
895 * See IEEE 802.15.4-2006, section 7.1.1.3.
896 */
898
899 /**
900 * This callback is used to indicate the reception of an association request command.
901 * See IEEE 802.15.4-2011, section 6.2.2.2
902 */
904
905 /**
906 * This callback is instigated through a response primitive.
907 * See IEEE 802.15.4-2011, section 6.2.4.2
908 */
910
911 /**
912 * This callback is used to indicate the reception of a orphan notification command.
913 * See IEEE 802.15.4-2011, section 6.2.7.1
914 */
916
917 /**
918 * This callback is used to report the start of a new PAN or
919 * the begin of a new superframe configuration.
920 * See IEEE 802.15.4-2006, section 7.1.14.2.
921 */
923
924 /**
925 * This callback is used to report the result of a scan on a group of channels for the
926 * selected channel page.
927 * See IEEE 802.15.4-2011, section 6.2.10.2.
928 */
930
931 /**
932 * This callback is used to report the status after a device request an association with
933 * a coordinator.
934 * See IEEE 802.15.4-2011, section 6.2.2.4.
935 */
937
938 /**
939 * This callback is used to notify incoming beacon packets to the upper layers.
940 * See IEEE 802.15.4-2011, section 6.2.4.1.
941 */
943
944 /**
945 * This callback is used to indicate the loss of synchronization with a coordinator.
946 * See IEEE 802.15.4-2011, section 6.2.13.2.
947 */
949
950 /**
951 * This callback is used to report the result of an attribute writing request
952 * to the upper layers.
953 * See IEEE 802.15.4-2011, section 6.2.11.2.
954 */
956
957 /**
958 * This callback is used to report the result of an attribute read request
959 * to the upper layers.
960 * See IEEE 802.15.4-2011, section 6.2.5.2
961 */
963
964 /**
965 * This callback is used to report the status after a device send data command request to
966 * the coordinator to transmit data.
967 * See IEEE 802.15.4-2011, section 6.2.14.2.
968 */
970};
971
972} // namespace lrwpan
973} // namespace ns3
974
975#endif /* LR_WPAN_MAC_BASE_H*/
This class can contain 16 bit addresses.
an EUI-64 address
A base class which provides memory management and object aggregation.
Definition object.h:78
Smart pointer class similar to boost::intrusive_ptr.
A template-based reference counting class.
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
a unique identifier for an interface.
Definition type-id.h:48
Lr-wpan MAC layer abstraction.
void SetMcpsDataConfirmCallback(McpsDataConfirmCallback c)
Set the callback for the confirmation of a data transmission request.
virtual void MlmePollRequest(MlmePollRequestParams params)=0
IEEE 802.15.4-2011, section 6.2.14.2 MLME-POLL.request Prompts the device to request data from the co...
MlmeOrphanIndicationCallback m_mlmeOrphanIndicationCallback
This callback is used to indicate the reception of a orphan notification command.
MlmeGetConfirmCallback m_mlmeGetConfirmCallback
This callback is used to report the result of an attribute read request to the upper layers.
MlmeAssociateIndicationCallback m_mlmeAssociateIndicationCallback
This callback is used to indicate the reception of an association request command.
virtual void McpsDataRequest(McpsDataRequestParams params, Ptr< Packet > p)=0
IEEE 802.15.4-2006, section 7.1.1.1 MCPS-DATA.request Request to transfer a MSDU.
MlmeSetConfirmCallback m_mlmeSetConfirmCallback
This callback is used to report the result of an attribute writing request to the upper layers.
virtual void MlmeOrphanResponse(MlmeOrphanResponseParams params)=0
IEEE 802.15.4-2011, section 6.2.7.2 MLME-ORPHAN.response Primitive used to initiatte a response to an...
MlmePollConfirmCallback m_mlmePollConfirmCallback
This callback is used to report the status after a device send data command request to the coordinato...
MlmeCommStatusIndicationCallback m_mlmeCommStatusIndicationCallback
This callback is instigated through a response primitive.
virtual void MlmeSyncRequest(MlmeSyncRequestParams params)=0
IEEE 802.15.4-2011, section 6.2.13.1 MLME-SYNC.request Request to synchronize with the coordinator by...
virtual void MlmeGetRequest(MacPibAttributeIdentifier id)=0
IEEE 802.15.4-2006, section 7.1.6.1 MLME-GET.request Request information about a given PIB attribute.
void SetMlmeSyncLossIndicationCallback(MlmeSyncLossIndicationCallback c)
Set the callback for the loss of synchronization with a coordinator.
McpsDataConfirmCallback m_mcpsDataConfirmCallback
This callback is used to report data transmission request status to the upper layers.
virtual void MlmeScanRequest(MlmeScanRequestParams params)=0
IEEE 802.15.4-2011, section 6.2.10.1 MLME-SCAN.request Request primitive used to initiate a channel s...
virtual void MlmeAssociateResponse(MlmeAssociateResponseParams params)=0
IEEE 802.15.4-2011, section 6.2.2.3 MLME-ASSOCIATE.response Primitive used to initiate a response to ...
void SetMlmeOrphanIndicationCallback(MlmeOrphanIndicationCallback c)
Set the callback for the indication to the reception of an orphan notification.
McpsDataIndicationCallback m_mcpsDataIndicationCallback
This callback is used to notify incoming packets to the upper layers.
virtual void MlmeStartRequest(MlmeStartRequestParams params)=0
IEEE 802.15.4-2006, section 7.1.14.1 MLME-START.request Request to allow a PAN coordinator to initiat...
MlmeScanConfirmCallback m_mlmeScanConfirmCallback
This callback is used to report the result of a scan on a group of channels for the selected channel ...
void SetMlmeCommStatusIndicationCallback(MlmeCommStatusIndicationCallback c)
Set the callback for the indication to a response primitive.
void SetMlmeAssociateConfirmCallback(MlmeAssociateConfirmCallback c)
Set the callback for the confirmation of a data transmission request.
virtual void MlmeAssociateRequest(MlmeAssociateRequestParams params)=0
IEEE 802.15.4-2011, section 6.2.2.1 MLME-ASSOCIATE.request Request primitive used by a device to requ...
MlmeAssociateConfirmCallback m_mlmeAssociateConfirmCallback
This callback is used to report the status after a device request an association with a coordinator.
void SetMlmeStartConfirmCallback(MlmeStartConfirmCallback c)
Set the callback for the confirmation of a data transmission request.
void SetMlmePollConfirmCallback(MlmePollConfirmCallback c)
Set the callback for the confirmation of a data transmission request.
static TypeId GetTypeId()
Get the type ID.
MlmeSyncLossIndicationCallback m_mlmeSyncLossIndicationCallback
This callback is used to indicate the loss of synchronization with a coordinator.
void SetMlmeScanConfirmCallback(MlmeScanConfirmCallback c)
Set the callback for the confirmation of a data transmission request.
void SetMlmeGetConfirmCallback(MlmeGetConfirmCallback c)
Set the callback for the confirmation of an attempt to read an attribute.
MlmeBeaconNotifyIndicationCallback m_mlmeBeaconNotifyIndicationCallback
This callback is used to notify incoming beacon packets to the upper layers.
void SetMcpsDataIndicationCallback(McpsDataIndicationCallback c)
Set the callback for the indication of an incoming data packet.
void SetMlmeBeaconNotifyIndicationCallback(MlmeBeaconNotifyIndicationCallback c)
Set the callback for the indication of an incoming beacon packet.
virtual void MlmeSetRequest(MacPibAttributeIdentifier id, Ptr< MacPibAttributes > attribute)=0
IEEE 802.15.4-2011, section 6.2.11.1 MLME-SET.request Attempts to write the given value to the indica...
void SetMlmeSetConfirmCallback(MlmeSetConfirmCallback c)
Set the callback for the confirmation of an attempt to write an attribute.
MlmeStartConfirmCallback m_mlmeStartConfirmCallback
This callback is used to report the start of a new PAN or the begin of a new superframe configuration...
void SetMlmeAssociateIndicationCallback(MlmeAssociateIndicationCallback c)
Set the callback for the indication of an incoming associate request command.
MacPibAttributeIdentifier
IEEE 802.15.4-2006 PHY and MAC PIB Attribute Identifiers Table 23 and Table 86.
AddressMode
table 80 of 802.15.4
MlmeScanType
Table 30 of IEEE 802.15.4-2011.
MacStatus
The status of a confirm or an indication primitive as a result of a previous request.
@ macCoordShortAddress
The 16-bit short address assigned to the coordinator through which the device is associated.
@ macPanId
The 16-bit identifier of the Personal Area Network (PAN).
@ pCurrentChannel
RF channel used for transmissions and receptions.
@ macBsn
The sequence number added to the transmitted beacon frame.
@ macShortAddress
The short address of the device (16 bit address).
@ macSuperframeOrder
The length of the active portion of the outgoing superframe, including the beacon frame.
@ macAutoRequest
Indication of whether a device automatically sends a data request command if its address is listed in...
@ macBeaconOrder
Specification of how often the coordinator transmits its beacon.
@ macAckWaitDuration
Maximum number of symbols to wait for an acknowledgment.
@ macRxOnWhenIdle
Indication of whether the MAC is enabled during idle periods.
@ macBeaconPayloadLength
The length in octets of the beacon payload.
@ macPromiscuousMode
Indication of whether the MAC sublayer is in a promiscuous mode.
@ macBeaconTxTime
The time that the device transmitted its last beacome frame, in symbol periods.
@ macMaxCSMABackoff
The maximum number of backoffs the CSMA-CA algorithm will attempt before declaring a channel access f...
@ pCurrentPage
The current channel page.
@ macMinBE
The minimum value of the backoff exponent (BE) in the CSMA-CA algorithm.
@ macExtendedAddress
The extended address of the device (64 bit address).
@ macBattLifeExtPeriods
In BLE mode, the number of backoff periods during which the the receiver is enabled after the IFS fol...
@ macGTSPermit
True if the PAN coordinator is to accept GTS requests.
@ macBattLifeExt
Indication of whether BLE, through the reduction of coordinator receiver operation time during the CA...
@ macResponseWaitTime
The maximum time in multiples of aBaseSuperframeDuration, a device shall wait for a response command ...
@ macMaxFrameRetries
The maximum number of retries allowed after a transmission failure.
@ macAssociationPermit
Indication of whether a coordinator is allowing association.
@ macDSN
The sequence number added to the transmitted data or MAC command frame.
@ macCoordExtendedAddress
The 64-bit address of the coordinator through which the device is associated.
@ macTransactionPersistenceTime
The maximum time (in unit periods) that a transaction is stored by a coordinator and indicated in its...
@ macBeaconPayload
The contents of the beacon payload.
@ CHANNEL_ACCESS_FAILURE
CHANNEL_ACCESS_FAILURE.
Definition lr-wpan-mac.h:69
@ TRANSACTION_OVERFLOW
There is no capacity to store the transaction.
@ NO_BEACON
A scan operation failed to find any network beacons.
@ TX_ACTIVE
The transceiver was already enabled.
@ INVALID_GTS
Missing GTS transmit or undefined direction.
@ UNSUPPORTED_ATTRIBUTE
SET/GET request issued with a non supported ID.
@ NO_SHORT_ADDRESS
Failure due to unallocated 16-bit short address.
@ PAST_TIME
Rx enable request fail due to lack of time in superframe.
@ ACCESS_DENIED
PAN access denied.
@ BEACON_LOSS
The beacon was lost following a synchronization request.
@ PAN_ID_CONFLICT
PAN id conflict detected and informed to the coordinator.
@ DISABLE_TRX_FAILURE
The attempt to disable the transceier has failed.
@ LIMIT_REACHED
PAN descriptors stored reached max capacity.
@ TRACKING_OFF
This device is currently not tracking beacons.
@ READ_ONLY
SET/GET request issued for a read only attribute.
@ ON_TIME_TOO_LONG
RX enable request fail due to syms.
@ TRANSACTION_EXPIRED
The transaction expired and its information discarded.
@ SCAN_IN_PROGRESS
Scan failed because already performing another scan.
@ FRAME_TOO_LONG
Frame more than aMaxPHYPacketSize or too large for CAP or GTS.
@ OUT_OF_CAP
(Deprecated) See IEEE 802.15.4-2003
@ IMPROPER_KEY_TYPE
The key is not allowed to be used with that frame type.
@ DENIED
The GTS request has been denied by the PAN coordinator.
@ IMPROPER_SECURITY_LEVEL
Insufficient security level expected by the recipient.
@ INVALID_ADDRESS
Invalid source or destination address.
@ INVALID_HANDLE
When purging from TX queue handle was not found.
@ REALIGMENT
A coordinator realigment command has been received.
@ FULL_CAPACITY
PAN at capacity.
@ COUNTER_ERROR
The frame counter of the received frame is invalid.
@ SUCCESS
The operation was completed successfully.
@ UNSUPPORTED_LEGACY
Deprecated security used in IEEE 802.15.4-2003.
@ NO_ACK
No acknowledgment was received after macMaxFrameRetries.
@ SUPERFRAME_OVERLAP
Coordinator superframe and this device superframe tx overlap.
@ UNAVAILABLE_KEY
Unavailable key, unknown or blacklisted.
@ UNSUPPORTED_SECURITY
The security applied is not supported.
@ NO_DATA
No response data were available following a request.
@ INVALID_INDEX
A MAC PIB write failed because specified index is out of range.
@ INVALID_PARAMETER
Primitive parameter not supported or out of range.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
IEEE802.15.4-2011 PHY PIB Attributes Table 52 in section 6.4.2.
Mac16Address macShortAddress
The 16 bit mac short address.
uint16_t macPanId
The identifier of the PAN.
uint8_t macBeaconPayloadLength
The length in octets of the beacon payload.
uint8_t pCurrentChannel
The current logical channel in used in the PHY.
Mac64Address macExtendedAddress
The EUI-64 bit address.
bool macPromiscuousMode
Indication of whether the mac is in promiscuous mode (Receive all mode).
bool macAssociationPermit
Indication of whether the coordinator is allowing association.
bool macRxOnWhenIdle
Indication of whether the MAC is enabled during idle periods.
std::vector< uint8_t > macBeaconPayload
The set with the contents of the beacon payload.
uint8_t pCurrentPage
The current logical page in use in the PHY.
MacStatus m_status
The status of the last MSDU transmission.
uint8_t m_mpduLinkQuality
LQI value measured during reception of the MPDU.
uint16_t m_dstPanId
Destination PAN identifier.
uint8_t m_dsn
The DSN of the received data frame.
Mac16Address m_srcAddr
Source address.
Mac64Address m_dstExtAddr
Destination extended address.
Mac64Address m_srcExtAddr
Source extended address.
Mac16Address m_dstAddr
Destination address.
uint8_t m_dstAddrMode
Destination address mode.
uint16_t m_srcPanId
Source PAN identifier.
uint8_t m_srcAddrMode
Source address mode.
AddressMode m_dstAddrMode
Destination address mode.
Mac16Address m_dstAddr
Destination address.
Mac64Address m_dstExtAddr
Destination extended address.
uint16_t m_dstPanId
Destination PAN identifier.
AddressMode m_srcAddrMode
Source address mode.
uint8_t m_txOptions
Tx Options (bitfield)
MLME-ASSOCIATE.confirm params.
Mac16Address m_assocShortAddr
The short address used in the association request.
MacStatus m_status
The status of a MLME-associate.request.
MLME-ASSOCIATE.indication params.
uint8_t lqi
The link quality indicator of the received associate request command (Not officially supported in the...
Mac64Address m_extDevAddr
The extended address of the device requesting association.
uint8_t capabilityInfo
The operational capabilities of the device requesting association.
MLME-ASSOCIATE.request params.
Mac64Address m_coordExtAddr
The extended address of the coordinator with which to associate.
uint8_t m_coordAddrMode
The coordinator addressing mode for this primitive and subsequent MPDU.
uint8_t m_capabilityInfo
Specifies the operational capabilities of the associating device (bitmap).
Mac16Address m_coordShortAddr
The short address of the coordinator with which to associate.
uint8_t m_chNum
The channel number on which to attempt association.
uint32_t m_chPage
The channel page on which to attempt association.
uint16_t m_coordPanId
The identifier of the PAN with which to associate.
MLME-ASSOCIATE.response params.
Mac16Address m_assocShortAddr
The short address allocated by the coordinator on successful assoc.
MacStatus m_status
The status of the association attempt (As defined on Table 83 IEEE 802.15.4-2006)
Mac64Address m_extDevAddr
The extended address of the device requesting association.
MLME-BEACON-NOTIFY.indication params.
PanDescriptor m_panDescriptor
The PAN descriptor for the received beacon.
uint32_t m_sduLength
The number of octets contained in the beacon payload.
uint8_t m_bsn
The beacon sequence number.
Ptr< Packet > m_sdu
The set of octets comprising the beacon payload.
MLME-COMM-STATUS.indication params.
uint8_t m_dstAddrMode
The destination addressing mode for this primitive.
uint16_t m_panId
The PAN identifier of the device from which the frame was received or to which the frame was being se...
Mac64Address m_srcExtAddr
The extended address of the entity from which the frame causing the error originated.
MacStatus m_status
The communication status.
Mac16Address m_srcShortAddr
The short address of the entity from which the frame causing the error originated.
Mac16Address m_dstShortAddr
The short address of the device for which the frame was intended.
uint8_t m_srcAddrMode
The source addressing mode for this primitive.
Mac64Address m_dstExtAddr
The extended address of the device for which the frame was intended.
MLME-ORPHAN.indication params.
Mac64Address m_orphanAddr
The address of the orphaned device.
bool m_assocMember
T = allocated with this coord | F = otherwise.
Mac64Address m_orphanAddr
The address of the orphaned device.
Mac16Address m_shortAddr
The short address allocated.
MacStatus m_status
The confirmation status resulting from a MLME-poll.request.
uint16_t m_coorPanId
The PAN id of the coordinator to which the poll is intended.
Mac16Address m_coorShortAddr
Coordinator short address.
AddressMode m_coorAddrMode
The addressing mode of the coordinator to which the pool is intended.
Mac64Address m_coorExtAddr
Coordinator extended address.
std::vector< uint8_t > m_unscannedCh
A list of channels given in the request which were not scanned (Not valid for ED scans).
uint32_t m_chPage
The channel page on which the scan was performed.
std::vector< uint8_t > m_energyDetList
A list of energy measurements, one for each channel searched during ED scan (Not valid for Active,...
MacStatus m_status
The status of the scan request.
std::vector< PanDescriptor > m_panDescList
A list of PAN descriptor, one for each beacon found (Not valid for ED and Orphan scans).
uint8_t m_resultListSize
The number of elements returned in the appropriate result list.
uint8_t m_scanType
Indicates the type of scan performed (ED,ACTIVE,PASSIVE,ORPHAN).
MlmeScanType m_scanType
Indicates the type of scan performed as described in IEEE 802.15.4-2011 (5.1.2.1).
uint32_t m_scanChannels
The channel numbers to be scanned.
uint8_t m_scanDuration
The factor (0-14) used to calculate the length of time to spend scanning.
uint32_t m_chPage
The channel page on which to perform scan.
MacStatus m_status
The result of the request to write the PIB attribute.
MacPibAttributeIdentifier id
The id of the PIB attribute that was written.
MacStatus m_status
The status of a MLME-start.request.
bool m_battLifeExt
Flag indicating whether or not the Battery life extension (BLE) features are used.
uint8_t m_logCh
Logical channel on which to start using the new superframe configuration.
uint32_t m_logChPage
Logical channel page on which to start using the new superframe configuration.
bool m_coorRealgn
True if a realignment request command is to be transmitted prior changing the superframe.
uint8_t m_bcnOrd
Beacon Order, Used to calculate the beacon interval, a value of 15 indicates no periodic beacons will...
bool m_panCoor
On true this device will become coordinator.
uint8_t m_sfrmOrd
Superframe Order, indicates the length of the CAP in time slots.
uint16_t m_PanId
Pan Identifier used by the device.
uint32_t m_startTime
Time at which to begin transmitting beacons (Used by Coordinator not PAN Coordinators).
MLME-SYNC-LOSS.indication params.
uint16_t m_panId
The PAN identifier with which the device lost synchronization or to which it was realigned.
uint8_t m_logCh
The channel number on which the device lost synchronization or to which it was realigned.
MacStatus m_lossReason
The reason for the lost of synchronization.
uint8_t m_logCh
The channel number on which to attempt coordinator synchronization.
bool m_trackBcn
True if the mlme sync with the next beacon and attempts to track future beacons.
PAN Descriptor, Table 17 IEEE 802.15.4-2011.
uint16_t m_coorPanId
The PAN ID of the coordinator as specified in the received beacon frame.
uint8_t m_logCh
The current channel number occupied by the network.
Time m_timeStamp
Beacon frame reception time.
bool m_gtsPermit
TRUE if the beacon is from the PAN coordinator that is accepting GTS requests.
Mac16Address m_coorShortAddr
The coordinator short address as specified in the coordinator address mode.
uint16_t m_superframeSpec
The superframe specification as specified in the received beacon frame.
AddressMode m_coorAddrMode
The coordinator addressing mode corresponding to the received beacon frame.
uint8_t m_linkQuality
The LQI at which the network beacon was received.
uint8_t m_logChPage
The current channel page occupied by the network.
Mac64Address m_coorExtAddr
The coordinator extended address as specified in the coordinator address mode.