开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > 通讯编程 > 查看源码
p802_15_4mac.h
资源名称：ns-allinone-2.33.tar.gz　[点击查看]
上传用户：rrhhcc
上传日期：2015-12-11
资源大小：54129k
文件大小：26k
源码类别：

通讯编程

开发平台：

Visual C++

p802_15_4mac.h：源码内容
  1. /********************************************/
  2. /*     NS2 Simulator for IEEE 802.15.4      */
  3. /*           (per P802.15.4/D18)            */
  4. /*------------------------------------------*/
  5. /* by:        Jianliang Zheng               */
  6. /*        (zheng@ee.ccny.cuny.edu)          */
  7. /*              Myung J. Lee                */
  8. /*          (lee@ccny.cuny.edu)             */
  9. /*        ~~~~~~~~~~~~~~~~~~~~~~~~~         */
  10. /*           SAIT-CUNY Joint Lab            */
  11. /********************************************/
  13. // File:  p802_15_4mac.h
  14. // Mode:  C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t
  16. // $Header: /cvsroot/nsnam/ns-2/wpan/p802_15_4mac.h,v 1.3 2007/01/30 05:00:52 tom_henderson Exp $
  18. /*
  19.  * Copyright (c) 2003-2004 Samsung Advanced Institute of Technology and
  20.  * The City University of New York. All rights reserved.
  21.  *
  22.  * Redistribution and use in source and binary forms, with or without
  23.  * modification, are permitted provided that the following conditions
  24.  * are met:
  25.  * 1. Redistributions of source code must retain the above copyright
  26.  *    notice, this list of conditions and the following disclaimer.
  27.  * 2. Redistributions in binary form must reproduce the above copyright
  28.  *    notice, this list of conditions and the following disclaimer in the
  29.  *    documentation and/or other materials provided with the distribution.
  30.  * 3. All advertising materials mentioning features or use of this software
  31.  *    must display the following acknowledgement:
  32.  * This product includes software developed by the Joint Lab of Samsung 
  33.  *      Advanced Institute of Technology and The City University of New York.
  34.  * 4. Neither the name of Samsung Advanced Institute of Technology nor of 
  35.  *    The City University of New York may be used to endorse or promote 
  36.  *    products derived from this software without specific prior written 
  37.  *    permission.
  38.  *
  39.  * THIS SOFTWARE IS PROVIDED BY THE JOINT LAB OF SAMSUNG ADVANCED INSTITUTE
  40.  * OF TECHNOLOGY AND THE CITY UNIVERSITY OF NEW YORK ``AS IS'' AND ANY EXPRESS 
  41.  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
  42.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 
  43.  * NO EVENT SHALL SAMSUNG ADVANCED INSTITUTE OR THE CITY UNIVERSITY OF NEW YORK 
  44.  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
  45.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
  46.  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
  47.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
  48.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
  49.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50.  */
  53. #ifndef p802_15_4mac_h
  54. #define p802_15_4mac_h
  56. #include "p802_15_4pkt.h"
  57. #include "p802_15_4phy.h"
  58. #include "p802_15_4timer.h"
  59. #include "p802_15_4hlist.h"
  60. #include "p802_15_4transac.h"
  62. //Elements of PAN descriptor (Table 41)
  63. struct PAN_ELE
  64. {
  65. UINT_8 CoordAddrMode;
  66. UINT_16 CoordPANId;
  67. union
  68. {
  69. UINT_16 CoordAddress_16;
  70. IE3ADDR CoordAddress_64;
  71. };
  72. UINT_8 LogicalChannel;
  73. UINT_16 SuperframeSpec;
  74. bool GTSPermit;
  75. UINT_8 LinkQuality;
  76. UINT_32 TimeStamp:24;
  77. bool SecurityUse;
  78. UINT_8 ACLEntry;
  79. bool SecurityFailure;
  80. //add one field for cluster tree
  81. UINT_16 clusTreeDepth;
  82. };
  84. //task pending (callback)
  85. #define TP_mcps_data_request 1
  86. #define TP_mlme_associate_request 2
  87. #define TP_mlme_associate_response 3
  88. #define TP_mlme_disassociate_request 4
  89. #define TP_mlme_orphan_response 5
  90. #define TP_mlme_reset_request 6
  91. #define TP_mlme_rx_enable_request 7
  92. #define TP_mlme_scan_request 8
  93. #define TP_mlme_start_request 9
  94. #define TP_mlme_sync_request 10
  95. #define TP_mlme_poll_request 11
  96. #define TP_CCA_csmaca 12
  97. #define TP_RX_ON_csmaca 13
  98. struct taskPending
  99. {
  100. taskPending()
  101. {
  102. init();
  103. }
  104. inline void init()
  105. {
  106. mcps_data_request = false;
  107. mcps_data_request_STEP = 0;
  108. mlme_associate_request = false;
  109. mlme_associate_request_STEP = 0;
  110. mlme_associate_response = false;
  111. mlme_associate_response_STEP = 0;
  112. mlme_disassociate_request = false;
  113. mlme_disassociate_request_STEP = 0;
  114. mlme_orphan_response = false;
  115. mlme_orphan_response_STEP = 0;
  116. mlme_reset_request = false;
  117. mlme_reset_request_STEP = 0;
  118. mlme_rx_enable_request = false;
  119. mlme_rx_enable_request_STEP = 0;
  120. mlme_scan_request = false;
  121. mlme_scan_request_STEP = 0;
  122. mlme_start_request = false;
  123. mlme_start_request_STEP = 0;
  124. mlme_sync_request = false;
  125. mlme_sync_request_STEP = 0;
  126. mlme_sync_request_tracking = false;
  127. mlme_poll_request = false;
  128. mlme_poll_request_STEP = 0;
  129. CCA_csmaca = false;
  130. CCA_csmaca_STEP = 0;
  131. RX_ON_csmaca = false;
  132. RX_ON_csmaca_STEP = 0;
  133. }
  135. bool &taskStatus(UINT_8 task)
  136. {
  137. switch (task)
  138. {
  139. case TP_mcps_data_request:
  140. return mcps_data_request;
  141. case TP_mlme_associate_request:
  142. return mlme_associate_request;
  143. case TP_mlme_associate_response:
  144. return mlme_associate_response;
  145. case TP_mlme_disassociate_request:
  146. return mlme_disassociate_request;
  147. case TP_mlme_orphan_response:
  148. return mlme_orphan_response;
  149. case TP_mlme_reset_request:
  150. return mlme_reset_request;
  151. case TP_mlme_rx_enable_request:
  152. return mlme_rx_enable_request;
  153. case TP_mlme_scan_request:
  154. return mlme_scan_request;
  155. case TP_mlme_start_request:
  156. return mlme_start_request;
  157. case TP_mlme_sync_request:
  158. return mlme_sync_request;
  159. case TP_mlme_poll_request:
  160. return mlme_poll_request;
  161. case TP_CCA_csmaca:
  162. return CCA_csmaca;
  163. case TP_RX_ON_csmaca:
  164. return RX_ON_csmaca;
  165. default:
  166. assert(0);
  167. // shutup the compiler.
  168. return RX_ON_csmaca;
  169. }
  170. }
  172. UINT_8 &taskStep(UINT_8 task)
  173. {
  174. switch (task)
  175. {
  176. case TP_mcps_data_request:
  177. return mcps_data_request_STEP;
  178. case TP_mlme_associate_request:
  179. return mlme_associate_request_STEP;
  180. case TP_mlme_associate_response:
  181. return mlme_associate_response_STEP;
  182. case TP_mlme_disassociate_request:
  183. return mlme_disassociate_request_STEP;
  184. case TP_mlme_orphan_response:
  185. return mlme_orphan_response_STEP;
  186. case TP_mlme_reset_request:
  187. return mlme_reset_request_STEP;
  188. case TP_mlme_rx_enable_request:
  189. return mlme_rx_enable_request_STEP;
  190. case TP_mlme_scan_request:
  191. return mlme_scan_request_STEP;
  192. case TP_mlme_start_request:
  193. return mlme_start_request_STEP;
  194. case TP_mlme_sync_request:
  195. return mlme_sync_request_STEP;
  196. case TP_mlme_poll_request:
  197. return mlme_poll_request_STEP;
  198. case TP_CCA_csmaca:
  199. return CCA_csmaca_STEP;
  200. case TP_RX_ON_csmaca:
  201. return RX_ON_csmaca_STEP;
  202. default:
  203. assert(0);
  204. // shutup compiler.
  205. return RX_ON_csmaca_STEP;
  206. }
  207. }
  209. char *taskFrFunc(UINT_8 task)
  210. {
  211. switch (task)
  212. {
  213. case TP_mcps_data_request:
  214. return mcps_data_request_frFunc;
  215. case TP_mlme_associate_request:
  216. return mlme_associate_request_frFunc;
  217. case TP_mlme_associate_response:
  218. return mlme_associate_response_frFunc;
  219. case TP_mlme_disassociate_request:
  220. return mlme_disassociate_request_frFunc;
  221. case TP_mlme_orphan_response:
  222. return mlme_orphan_response_frFunc;
  223. case TP_mlme_reset_request:
  224. return mlme_reset_request_frFunc;
  225. case TP_mlme_rx_enable_request:
  226. return mlme_rx_enable_request_frFunc;
  227. case TP_mlme_scan_request:
  228. return mlme_scan_request_frFunc;
  229. case TP_mlme_start_request:
  230. return mlme_start_request_frFunc;
  231. case TP_mlme_sync_request:
  232. return mlme_sync_request_frFunc;
  233. case TP_mlme_poll_request:
  234. return mlme_poll_request_frFunc;
  235. default:
  236. assert(0);
  237. // shutup compiler.
  238. return mlme_poll_request_frFunc;
  239. }
  240. }
  242. //----------------
  243. bool mcps_data_request;
  244. UINT_8 mcps_data_request_STEP;
  245. char mcps_data_request_frFunc[81];
  246. UINT_8 mcps_data_request_TxOptions;
  247. Packet *mcps_data_request_pendPkt;
  248. //----------------
  249. bool mlme_associate_request;
  250. UINT_8 mlme_associate_request_STEP;
  251. char mlme_associate_request_frFunc[81];
  252. bool mlme_associate_request_SecurityEnable;
  253. UINT_8 mlme_associate_request_CoordAddrMode;
  254. Packet *mlme_associate_request_pendPkt;
  255. //----------------
  256. bool mlme_associate_response;
  257. UINT_8 mlme_associate_response_STEP;
  258. char mlme_associate_response_frFunc[81];
  259. IE3ADDR mlme_associate_response_DeviceAddress;
  260. Packet *mlme_associate_response_pendPkt;
  261. //----------------
  262. bool mlme_disassociate_request;
  263. UINT_8 mlme_disassociate_request_STEP;
  264. char mlme_disassociate_request_frFunc[81];
  265. bool mlme_disassociate_request_toCoor;
  266. Packet *mlme_disassociate_request_pendPkt;
  267. //----------------
  268. bool mlme_orphan_response;
  269. UINT_8 mlme_orphan_response_STEP;
  270. char mlme_orphan_response_frFunc[81];
  271. IE3ADDR mlme_orphan_response_OrphanAddress;
  272. //----------------
  273. bool mlme_reset_request;
  274. UINT_8 mlme_reset_request_STEP;
  275. char mlme_reset_request_frFunc[81];
  276. bool mlme_reset_request_SetDefaultPIB;
  277. //----------------
  278. bool mlme_rx_enable_request;
  279. UINT_8 mlme_rx_enable_request_STEP;
  280. char mlme_rx_enable_request_frFunc[81];
  281. UINT_32 mlme_rx_enable_request_RxOnTime;
  282. UINT_32 mlme_rx_enable_request_RxOnDuration;
  283. double mlme_rx_enable_request_currentTime;
  284. //----------------
  285. bool mlme_scan_request;
  286. UINT_8 mlme_scan_request_STEP;
  287. char mlme_scan_request_frFunc[81];
  288. UINT_8 mlme_scan_request_ScanType;
  289. UINT_8 mlme_scan_request_orig_macBeaconOrder;
  290. UINT_8 mlme_scan_request_orig_macBeaconOrder2;
  291. UINT_8 mlme_scan_request_orig_macBeaconOrder3;
  292. UINT_16 mlme_scan_request_orig_macPANId;
  293. UINT_32 mlme_scan_request_ScanChannels;
  294. UINT_8 mlme_scan_request_ScanDuration;
  295. UINT_8 mlme_scan_request_CurrentChannel;
  296. UINT_8 mlme_scan_request_ListNum;
  297. UINT_8 mlme_scan_request_EnergyDetectList[27];
  298. PAN_ELE mlme_scan_request_PANDescriptorList[27];
  299. //----------------
  300. bool mlme_start_request;
  301. UINT_8 mlme_start_request_STEP;
  302. char mlme_start_request_frFunc[81];
  303. UINT_8 mlme_start_request_BeaconOrder;
  304. UINT_8 mlme_start_request_SuperframeOrder;
  305. bool mlme_start_request_BatteryLifeExtension;
  306. bool mlme_start_request_SecurityEnable;
  307. bool mlme_start_request_PANCoordinator;
  308. UINT_16 mlme_start_request_PANId;
  309. UINT_8 mlme_start_request_LogicalChannel;
  310. //----------------
  311. bool mlme_sync_request;
  312. UINT_8 mlme_sync_request_STEP;
  313. char mlme_sync_request_frFunc[81];
  314. UINT_8 mlme_sync_request_numSearchRetry;
  315. bool mlme_sync_request_tracking;
  316. //----------------
  317. bool mlme_poll_request;
  318. UINT_8 mlme_poll_request_STEP;
  319. char mlme_poll_request_frFunc[81];
  320. UINT_8 mlme_poll_request_CoordAddrMode;
  321. UINT_16 mlme_poll_request_CoordPANId;
  322. IE3ADDR mlme_poll_request_CoordAddress;
  323. bool mlme_poll_request_SecurityEnable;
  324. bool mlme_poll_request_autoRequest;
  325. bool mlme_poll_request_pending;
  326. //----------------
  327. bool CCA_csmaca;
  328. UINT_8 CCA_csmaca_STEP;
  329. //----------------
  330. bool RX_ON_csmaca;
  331. UINT_8 RX_ON_csmaca_STEP;
  332. //----------------
  333. };
  335. //Elements of ACL entry descriptor (Table 73)
  336. struct MAC_ACL
  337. {
  338. IE3ADDR ACLExtendedAddress;
  339. UINT_16 ACLShortAddress;
  340. UINT_16 ACLPANId;
  341. UINT_8 ACLSecurityMaterialLength;
  342. UINT_8 *ACLSecurityMaterial;
  343. UINT_8 ACLSecuritySuite;
  344. };
  346. //MAC enumerations description (Table 64)
  347. typedef enum
  348. {
  349. m_SUCCESS = 0,
  350. //--- following from Table 68) ---
  351. m_PAN_at_capacity,
  352. m_PAN_access_denied,
  353. //--------------------------------
  354. m_BEACON_LOSS = 0xe0,
  355. m_CHANNEL_ACCESS_FAILURE,
  356. m_DENIED,
  357. m_DISABLE_TRX_FAILURE,
  358. m_FAILED_SECURITY_CHECK,
  359. m_FRAME_TOO_LONG,
  360. m_INVALID_GTS,
  361. m_INVALID_HANDLE,
  362. m_INVALID_PARAMETER,
  363. m_NO_ACK,
  364. m_NO_BEACON,
  365. m_NO_DATA,
  366. m_NO_SHORT_ADDRESS,
  367. m_OUT_OF_CAP,
  368. m_PAN_ID_CONFLICT,
  369. m_REALIGNMENT,
  370. m_TRANSACTION_EXPIRED,
  371. m_TRANSACTION_OVERFLOW,
  372. m_TX_ACTIVE,
  373. m_UNAVAILABLE_KEY,
  374. m_UNSUPPORTED_ATTRIBUTE,
  375. m_UNDEFINED //we added this for handling any case not specified in the draft
  376. }MACenum;
  378. //MAC PIB attributes (Tables 71,72)
  379. typedef enum {
  380. //attributes from Table 71
  381. macAckWaitDuration,
  382. macAssociationPermit,
  383. macAutoRequest,
  384. macBattLifeExt,
  385. macBattLifeExtPeriods,
  386. macBeaconPayload,
  387. macBeaconPayloadLength,
  388. macBeaconOrder,
  389. macBeaconTxTime,
  390. macBSN,
  391. macCoordExtendedAddress,
  392. macCoordShortAddress,
  393. macDSN,
  394. macGTSPermit,
  395. macMaxCSMABackoffs,
  396. macMinBE,
  397. macPANId,
  398. macPromiscuousMode,
  399. macRxOnWhenIdle,
  400. macShortAddress,
  401. macSuperframeOrder,
  402. macTransactionPersistenceTime,
  403. //attributes from Table 72 (security attributes)
  404. macACLEntryDescriptorSet,
  405. macACLEntryDescriptorSetSize,
  406. macDefaultSecurity,
  407. macACLDefaultSecurityMaterialLength,
  408. macDefaultSecurityMaterial,
  409. macDefaultSecuritySuite,
  410. macSecurityMode
  411. }MPIBAenum;
  413. struct MAC_PIB
  414. {
  415. //attributes from Table 71
  416. UINT_8 macAckWaitDuration;
  417. bool macAssociationPermit;
  418. bool macAutoRequest;
  419. bool macBattLifeExt;
  420. UINT_8 macBattLifeExtPeriods;
  421. /*
  422. UINT_8 macBeaconPayload[aMaxPHYPacketSize-(6+9+2+1)+1]; //beacon length in octets (w/o payload):
  423. // max: 6(phy) + 15(mac) + 23 (GTSs) + 57 (pending addresses)
  424. // min: 6(phy) + 9(mac) + 2 (GTSs) + 1 (pending addresses)
  425. */
  426. UINT_8 macBeaconPayload[aMaxBeaconPayloadLength+1];
  427. UINT_8 macBeaconPayloadLength;
  428. UINT_8 macBeaconOrder;
  429. UINT_32 macBeaconTxTime:24;
  430. UINT_8 macBSN;
  431. IE3ADDR macCoordExtendedAddress;
  432. UINT_16 macCoordShortAddress;
  433. UINT_8 macDSN;
  434. bool macGTSPermit;
  435. UINT_8 macMaxCSMABackoffs;
  436. UINT_8 macMinBE;
  437. UINT_16 macPANId;
  438. bool macPromiscuousMode;
  439. bool macRxOnWhenIdle;
  440. UINT_16 macShortAddress;
  441. UINT_8 macSuperframeOrder;
  442. UINT_16 macTransactionPersistenceTime;
  443. //attributes from Table 72 (security attributes)
  444. MAC_ACL *macACLEntryDescriptorSet;
  445. UINT_8 macACLEntryDescriptorSetSize;
  446. bool macDefaultSecurity;
  447. UINT_8 macACLDefaultSecurityMaterialLength;
  448. UINT_8 *macDefaultSecurityMaterial;
  449. UINT_8 macDefaultSecuritySuite;
  450. UINT_8 macSecurityMode;
  451. };
  453. #define macTxBcnCmdDataHType 1
  454. #define macIFSHType 2
  455. #define macBackoffBoundType 3
  456. class Mac802_15_4;
  457. class Mac802_15_4Handler : public Handler
  458. {
  459. friend class Mac802_15_4;
  460. public:
  461. Mac802_15_4Handler(Mac802_15_4 *m, int tp) : Handler()
  462. {
  463. mac = m;
  464. type = tp;
  465. nullEvent.uid_ = 0;
  466. }
  467. virtual void handle(Event* e);
  469. protected:
  470. Mac802_15_4 *mac;
  471. int type;
  472. Event nullEvent;
  473. };
  475. #define TxOp_Acked 0x01
  476. #define TxOp_GTS 0x02
  477. #define TxOp_Indirect 0x04
  478. #define TxOp_SecEnabled 0x08
  479. class Phy802_15_4;
  480. class CsmaCA802_15_4;
  481. class SSCS802_15_4;
  482. class Nam802_15_4;
  483. class Mac802_15_4 : public Mac
  484. {
  485. friend class Phy802_15_4;
  486. friend class Mac802_15_4Handler;
  487. friend class macTxOverTimer;
  488. friend class macTxTimer;
  489. friend class macExtractTimer;
  490. friend class macAssoRspWaitTimer;
  491. friend class macDataWaitTimer;
  492. friend class macRxEnableTimer;
  493. friend class macScanTimer;
  494. friend class macBeaconTxTimer;
  495. friend class macBeaconRxTimer;
  496. friend class macBeaconSearchTimer;
  497. friend class macWakeupTimer; // 2.31 change: 
  498. friend class CsmaCA802_15_4;
  499. friend class SSCS802_15_4;
  500. friend class Nam802_15_4;
  501. public:
  502. Mac802_15_4(MAC_PIB *mp);
  503. ~Mac802_15_4();
  504. void init(bool reset = false);
  506. //interfaces between MAC and PHY
  507. void PD_DATA_confirm(PHYenum status);
  508. void PLME_CCA_confirm(PHYenum status);
  509. void PLME_ED_confirm(PHYenum status,UINT_8 EnergyLevel);
  510. void PLME_GET_confirm(PHYenum status,PPIBAenum PIBAttribute,PHY_PIB *PIBAttributeValue);
  511. void PLME_SET_TRX_STATE_confirm(PHYenum status);
  512. void PLME_SET_confirm(PHYenum status,PPIBAenum PIBAttribute);
  514. //interfaces between MAC and SSCS (or some other upper layer)
  515. void MCPS_DATA_request(UINT_8 SrcAddrMode,UINT_16 SrcPANId,IE3ADDR SrcAddr,
  516.        UINT_8 DstAddrMode,UINT_16 DstPANId,IE3ADDR DstAddr,
  517.        UINT_8 msduLength,Packet *msdu,UINT_8 msduHandle,UINT_8 TxOptions);
  518. void MCPS_DATA_indication(UINT_8 SrcAddrMode,UINT_16 SrcPANId,IE3ADDR SrcAddr,
  519.   UINT_8 DstAddrMode,UINT_16 DstPANId,IE3ADDR DstAddr,
  520.   UINT_8 msduLength,Packet *msdu,UINT_8 mpduLinkQuality,
  521.   bool SecurityUse,UINT_8 ACLEntry);
  522. void MCPS_PURGE_request(UINT_8 msduHandle);
  523. void MLME_ASSOCIATE_request(UINT_8 LogicalChannel,UINT_8 CoordAddrMode,UINT_16 CoordPANId,IE3ADDR CoordAddress,
  524.     UINT_8 CapabilityInformation,bool SecurityEnable);
  525. void MLME_ASSOCIATE_response(IE3ADDR DeviceAddress,UINT_16 AssocShortAddress,MACenum status,bool SecurityEnable);
  526. void MLME_DISASSOCIATE_request(IE3ADDR DeviceAddress,UINT_8 DisassociateReason,bool SecurityEnable);
  527. void MLME_DISASSOCIATE_indication(IE3ADDR DeviceAddress,UINT_8 DisassociateReason,bool SecurityUse,UINT_8 ACLEntry);
  528. void MLME_GET_request(MPIBAenum PIBAttribute);
  529. /*TBD*/ void MLME_GTS_request(UINT_8 GTSCharacteristics,bool SecurityEnable);
  530. /*TBD*/ void MLME_GTS_confirm(UINT_8 GTSCharacteristics,MACenum status);
  531. /*TBD*/ void MLME_GTS_indication(UINT_16 DevAddress,UINT_8 GTSCharacteristics,
  532.  bool SecurityUse, UINT_8 ACLEntry);
  533. void MLME_ORPHAN_response(IE3ADDR OrphanAddress,UINT_16 ShortAddress,bool AssociatedMember,bool SecurityEnable);
  534. void MLME_RESET_request(bool SetDefaultPIB);
  535. void MLME_RX_ENABLE_request(bool DeferPermit,UINT_32 RxOnTime,UINT_32 RxOnDuration);
  536. void MLME_SCAN_request(UINT_8 ScanType,UINT_32 ScanChannels,UINT_8 ScanDuration);
  537. void MLME_SET_request(MPIBAenum PIBAttribute,MAC_PIB *PIBAttributeValue);
  538. void MLME_START_request(UINT_16 PANId,UINT_8 LogicalChannel,UINT_8 BeaconOrder,
  539. UINT_8 SuperframeOrder,bool PANCoordinator,bool BatteryLifeExtension,
  540. bool CoordRealignment,bool SecurityEnable);
  541. void MLME_SYNC_request(UINT_8 LogicalChannel, bool TrackBeacon);
  542. void MLME_POLL_request(UINT_8 CoordAddrMode,UINT_16 CoordPANId,IE3ADDR CoordAddress,bool SecurityEnable);
  544. inline int hdr_dst(char* hdr,int dst = -2);
  545. inline int hdr_src(char* hdr,int src = -2);
  546. inline int hdr_type(char* hdr, UINT_16 type = 0);
  548. inline Tap *tap(){return tap_;}
  549. void recv(Packet *p, Handler *h);
  550. void recvBeacon(Packet *p);
  551. void recvAck(Packet *p);
  552. void recvCommand(Packet *p);
  553. void recvData(Packet *p);
  554. bool toParent(Packet *p);
  556. protected:
  557. void set_trx_state_request(PHYenum state,const char *frFile,const char *frFunc,int line);
  558. double locateBoundary(bool parent,double wtime);
  559. void txOverHandler(void); //transmission over timer handler
  560. void txHandler(void); //ack expiration timer handler
  561. void extractHandler(void); //data extraction timer handler
  562. void assoRspWaitHandler(void); //association response wait timer handler
  563. void dataWaitHandler(void); //data wait timer handler (for indirect transmission)
  564. void rxEnableHandler(void); //receiver enable timer handler
  565. void scanHandler(void); //scan done for current channel
  566. void beaconTxHandler(bool forTX); //periodic beacon transmission
  567. void beaconRxHandler(void); //periodic beacon reception
  568. void beaconSearchHandler(void); //beacon searching times out during synchronization
  569. void isPanCoor(bool isPC);
  571. private:
  572. void checkTaskOverflow(UINT_8 task);
  573. void dispatch(PHYenum status,const char *frFunc,PHYenum req_state = p_SUCCESS,MACenum mStatus = m_SUCCESS);
  574. void sendDown(Packet *p,Handler* h);
  575. void mcps_data_request(UINT_8 SrcAddrMode,UINT_16 SrcPANId,IE3ADDR SrcAddr,
  576.        UINT_8 DstAddrMode,UINT_16 DstPANId,IE3ADDR DstAddr,
  577.        UINT_8 msduLength,Packet *msdu,UINT_8 msduHandle,UINT_8 TxOptions,
  578.        bool frUpper = false,PHYenum status = p_SUCCESS,MACenum mStatus = m_SUCCESS);
  579. void mlme_associate_request(UINT_8 LogicalChannel,UINT_8 CoordAddrMode,UINT_16 CoordPANId,IE3ADDR CoordAddress,
  580.     UINT_8 CapabilityInformation,bool SecurityEnable,
  581.     bool frUpper = false,PHYenum status = p_SUCCESS,MACenum mStatus = m_SUCCESS);
  582. void mlme_associate_response(IE3ADDR DeviceAddress,UINT_16 AssocShortAddress,MACenum Status,bool SecurityEnable,
  583.      bool frUpper = false,PHYenum status = p_SUCCESS);
  584. void mlme_disassociate_request(IE3ADDR DeviceAddress,UINT_8 DisassociateReason,bool SecurityEnable,bool frUpper = false,PHYenum status = p_SUCCESS);
  585. void mlme_orphan_response(IE3ADDR OrphanAddress,UINT_16 ShortAddress,bool AssociatedMember,bool SecurityEnable,bool frUpper = false,PHYenum status = p_SUCCESS);
  586. void mlme_reset_request(bool SetDefaultPIB,bool frUpper = false,PHYenum status = p_SUCCESS);
  587. void mlme_rx_enable_request(bool DeferPermit,UINT_32 RxOnTime,UINT_32 RxOnDuration,bool frUpper = false,PHYenum status = p_SUCCESS);
  588. void mlme_scan_request(UINT_8 ScanType,UINT_32 ScanChannels,UINT_8 ScanDuration,bool frUpper = false,PHYenum status = p_SUCCESS);
  589. void mlme_start_request(UINT_16 PANId,UINT_8 LogicalChannel,UINT_8 BeaconOrder,
  590. UINT_8 SuperframeOrder,bool PANCoordinator,bool BatteryLifeExtension,
  591. bool CoordRealignment,bool SecurityEnable,
  592. bool frUpper = false,PHYenum status = p_SUCCESS);
  593. void mlme_sync_request(UINT_8 LogicalChannel, bool TrackBeacon,bool frUpper = false,PHYenum status = p_SUCCESS);
  594. void mlme_poll_request(UINT_8 CoordAddrMode,UINT_16 CoordPANId,IE3ADDR CoordAddress,bool SecurityEnable,
  595.        bool autoRequest = false,bool firstTime = false,PHYenum status = p_SUCCESS);
  597. void csmacaBegin(char pktType);
  598. void csmacaResume(void);
  599. void csmacaCallBack(PHYenum status);
  600. int getBattLifeExtSlotNum(void);
  601. double getCAP(bool small);
  602. double getCAPbyType(int type);
  603. bool canProceedWOcsmaca(Packet *p); //can we proceed w/o CSMA-CA?
  604. void transmitCmdData(void);
  605. void reset_TRX(const char *frFile,const char *frFunc,int line);
  606. void taskSuccess(char task,bool csmacaRes = true);
  607. void taskFailed(char task,MACenum status,bool csmacaRes = true);
  608. void freePkt(Packet *pkt);
  609. UINT_8 macHeaderLen(UINT_16 FrmCtrl);
  610. void constructACK(Packet *p);
  611. void constructMPDU(UINT_8 msduLength,Packet *msdu, UINT_16 FrmCtrl,UINT_8 BDSN,panAddrInfo DstAddrInfo,
  612.     panAddrInfo SrcAddrInfo,UINT_16 SuperSpec,UINT_8 CmdType,UINT_16 FCS);
  613. void constructCommandHeader(Packet *p,FrameCtrl *frmCtrl,UINT_8 CmdType,
  614.    UINT_8 dstAddrMode,UINT_16 dstPANId,IE3ADDR dstAddr,
  615.    UINT_8 srcAddrMode,UINT_16 srcPANId,IE3ADDR srcAddr,
  616.    bool secuEnable,bool pending,bool ackreq);
  617. void log(Packet *p);
  618. void resetCounter(int dst);
  619. int command(int argc, const char*const* argv);
  620. void changeNodeColor(double atTime,const char *newColor,bool save = true);
  621. void txBcnCmdDataHandler(void);
  622. void IFSHandler(void);
  623. void backoffBoundHandler(void);
  625. public:
  626. static bool verbose;
  627. static UINT_8 txOption; //0x02=GTS; 0x04=Indirect; 0x00=Direct (only for 802.15.4-unaware upper layer app. packet)
  628. static bool ack4data;
  629. static UINT_8 callBack; //0=no call back; 1=call back for failures; 2=call back for failures and successes
  630. static UINT_32 DBG_UID;
  632. protected:
  634. taskPending taskP;
  635. MAC_PIB mpib;
  636. PHY_PIB tmp_ppib;
  637. DevCapability capability; //device capability (refer to Figure 49)
  639. //--- for beacon ---
  640. //(most are temp. variables which should be populated before being used)
  641. bool secuBeacon;
  642. SuperframeSpec sfSpec,sfSpec2,sfSpec3; //superframe specification
  643. GTSSpec gtsSpec,gtsSpec2; //GTS specification
  644. PendAddrSpec pendAddrSpec; //pending address specification
  645. UINT_8 beaconPeriods,beaconPeriods2; //# of backoff periods it takes to transmit the beacon
  646. PAN_ELE panDes,panDes2; //PAN descriptor
  647. Packet *rxBeacon; //the beacon packet just received
  648. double macBcnTxTime; //the time last beacon sent (in symbol) (we use this double variable instead of integer mpib.macBeaconTxTime for accuracy reason)
  649. double macBcnRxTime; //the time last beacon received from within PAN (in symbol)
  650. double macBcnOtherRxTime; //the time last beacon received from outside PAN (in symbol)
  651. //To support beacon enabled mode in multi-hop envirionment, we use {<mpib.macBeaconOrder>,<mpib.macSuperframeOrder>}
  652. //for coordinators (transmitting beacons) and the following two parameters for devices (receiving beacons). Note that,
  653. //in such an environment, a node can act as a coordinator and a device at the same time. More complicated algorithm 
  654. //is required for slotted CSMA-CA in this case.
  655. //(does 802.15.4 have this in mind?) 
  656. UINT_8 macBeaconOrder2;
  657. UINT_8 macSuperframeOrder2;
  658. UINT_8 macBeaconOrder3;
  659. UINT_8 macSuperframeOrder3;
  660. bool oneMoreBeacon;
  661. UINT_8 numLostBeacons; //# of beacons lost in a row
  662. //------------------
  663. UINT_16 rt_myNodeID;
  665. UINT_8 energyLevel;
  667. //for association and transaction
  668. DEVICELINK *deviceLink1;
  669. DEVICELINK *deviceLink2;
  670. TRANSACLINK *transacLink1;
  671. TRANSACLINK *transacLink2;
  673. private:
  674. IE3ADDR aExtendedAddress;
  676. //timers
  677. macTxOverTimer *txOverT;
  678. macTxTimer *txT;
  679. macExtractTimer *extractT;
  680. macAssoRspWaitTimer *assoRspWaitT;
  681. macDataWaitTimer *dataWaitT;
  682. macRxEnableTimer *rxEnableT;
  683. macScanTimer *scanT;
  684. macBeaconTxTimer *bcnTxT; //beacon transmission timer
  685. macBeaconRxTimer *bcnRxT; //beacon reception timer
  686. macBeaconSearchTimer *bcnSearchT; //beacon search timer
  687. macWakeupTimer *wakeupT;  // 2.31 change:
  689. //handlers
  690. Mac802_15_4Handler txCmdDataH;
  691. Mac802_15_4Handler IFSH;
  692. Mac802_15_4Handler backoffBoundH;
  694. bool isPANCoor; //is a PAN coordinator?
  695. Phy802_15_4 *phy;
  696. CsmaCA802_15_4 *csmaca;
  697. SSCS802_15_4 *sscs;
  698. Nam802_15_4 *nam;
  699. PHYenum trx_state_req; //tranceiver state required: TRX_OFF/TX_ON/RX_ON
  700. bool inTransmission; //in the middle of transmission
  701. bool beaconWaiting; //it's about time to transmit beacon (suppress all other transmissions)
  702. Packet *txBeacon; //beacon packet to be transmitted (w/o using CSMA-CA)
  703. Packet *txAck; //ack. packet to be transmitted (no waiting)
  704. Packet *txBcnCmd; //beacon or command packet waiting for transmission (using CSMA-CA) -- triggered by receiving a packet
  705. Packet *txBcnCmd2; //beacon or command packet waiting for transmission (using CSMA-CA) -- triggered by upper layer
  706. Packet *txData; //data packet waiting for transmission (using CSMA-CA)
  707. Packet *txCsmaca; //for which packet (txBcnCmd/txBcnCmd2/txData) is CSMA-CA performed
  708. Packet *txPkt; //packet (any type) currently being transmitted
  709. Packet *rxData; //data packet received (waiting for passing up)
  710. Packet *rxCmd; //command packet received (will be handled after the transmission of ack.)
  711. UINT_32 txPkt_uid; //for debug purpose
  712. double rxDataTime; //the time when data packet received by MAC
  713. bool waitBcnCmdAck; //only used if (txBcnCmd): waiting for an ack. or not
  714. bool waitBcnCmdAck2; //only used if (txBcnCmd2): waiting for an ack. or not
  715. bool waitDataAck; //only used if (txData): waiting for an ack. or not
  716. UINT_8 backoffStatus; //0=no backoff yet;1=backoff successful;2=backoff failed;99=in the middle of backoff
  717. UINT_8 numDataRetry; //# of retries (retransmissions) for data packet
  718. UINT_8 numBcnCmdRetry; //# of retries (retransmissions) for beacon or command packet
  719. UINT_8 numBcnCmdRetry2; //# of retries (retransmissions) for beacon or command packet
  721. NsObject *logtarget_;
  723. //packet duplication detection
  724. HLISTLINK *hlistBLink1;
  725. HLISTLINK *hlistBLink2;
  726. HLISTLINK *hlistDLink1;
  727. HLISTLINK *hlistDLink2;
  728. };
  730. #define plme_set_trx_state_request(state) 
  731. set_trx_state_request(state,__FILE__,__FUNCTION__,__LINE__)
  732. #define resetTRX() 
  733. reset_TRX(__FILE__,__FUNCTION__,__LINE__)
  735. #endif
  737. // End of file: p802_15_4mac.h