ATAVRRZ502 Atmel, ATAVRRZ502 Datasheet

Page 1

IEEE 802.15.4 MAC .............................................................................................. User Guide ...

Page 2

Section 1- Introduction 1.1 Subject ......................................................................................................1-1 1.2 Purpose.....................................................................................................1-1 1.3 Scope ........................................................................................................1-1 1.4 Plan of Development.................................................................................1-1 1.5 Background ...............................................................................................1-1 1.6 Supporting Documentation........................................................................1-2 Section 2- Device Overview 2.1 The Application/ Network Layer2-2 2.2 The MAC Layer .........................................................................................2-2 2.3 The Physical Layer....................................................................................2-2 2.4 ...

Page 3

A.4.1 Semantics of the service call ............................................................. A-2 A.4.2 Expected results of the call................................................................ A-2 A.5 MLME GTS Request ............................................................................... A-2 A.5.1 Semantics of the service call ............................................................. A-2 A.5.2 Expected results of the call ............................................................... A-2 A.6 MLME POLL ...

Page 4

B.3.2 Trigger Event ..................................................................................... B-2 B.4 MLME GET Confirm................................................................................. B-2 B.4.1 Semantics of the service call ............................................................. B-2 B.4.2 Trigger Event ..................................................................................... B-2 B.5 MLME GTS Confirm................................................................................. B-2 B.5.1 Semantics of the service call ............................................................. B-2 B.5.2 Trigger Event ..................................................................................... ...

Page 5

... D.2.1 Semantics of the service call ............................................................. D-1 D.2.2 Expected results of the call................................................................ D-1 Appendix E - Parameter Library Appendix F - Release Notes F.1 General Release Notes............................................................................ F-1 F.2 Atmel 802.15.4 MAC Software Release Notes ........................................ F-1 iv 5182A–ZIGB–09/06 .................................................................E-1 IEEE 802.15.4 MAC User Guide PRELIMINARY ...

Page 6

... IEEE 802.15.4 MAC User Guide PRELIMINARY Section 1 INTRODUCTION The following paragraphs introduce this User Guide for the Atmel designed Medium Access Control (MAC) layer utilized in an IEEE 802.15.4 (hereinafter referred to as the IEEE standard). The subject, purpose, scope, and plan of development of this user guide is provided as well as a brief background of the IEEE standard and the ZigBee™ ...

Page 7

... The programmer should consult the following documents when more detailed informa- tion is required. – IEEE 802.15.4 – MAC stack library and header files* – MAC API Reference Document* (*These documents are provided as part of the AT86RF230 documentation. See http://www.atmel.com/products/avr/z-link/default.asp) IEEE 802.15.4 MAC User Guide PRELIMINARY ...

Page 8

... Section 2 DEVICE OVERVIEW IEEE 802.15.4 describes two device types: a Full Function Device (FFD) and a Restricted Function Device (RFD). The Atmel MAC stack was designed for use in both FFDs and RFDs. Differentiation between device types occurs at the user's application and network software layers as well as at the user's hardware implementation layer. ...

Page 9

... The Hardware Abstraction Layer (HAL) is specific to a particular radio and interfaces the common PHY layer to the physical radio. Due to the number of radios that are available in the marketplace, Atmel engineers have designed and added the HAL as a module that is changeable to meet the differing requirements of the various radios. ...

Page 10

Overview IEEE 802.15.4 MAC User Guide PRELIMINARY Section 3 USING MAC SERVICES MAC services and their usage are described in the following paragraphs. The services are overviewed and then a detailed description of the services is presented. Header and ...

Page 11

Figure 3-1. MAC layer reference model ...

Page 12

MAC function calls IEEE 802.15.4 MAC User Guide PRELIMINARY The services provided by the MAC are the capabilities it offers to the Application/Net- work layers. This concept is illustrated in Figure 3-2, showing the relationship of the Application/Network layer ...

Page 13

... This header holds all IEEE 802.15.5 attributes. – ieee_types.h - This file declares IEEE data structures. – wpan.h – Function definitions for API into Atmel’s 802.15.4 implementation. – wpan_defines.h – High level API definitions. The stack library and header files for the MAC are contained in the accompanying CDROM ...

Page 14

... For more details, refer to the "Atmel MAC Reference Manual", available online and sup- plied with Z-Link Application Tool Kits. Typical message flow in support of a specific task is shown in the following paragraphs. Figure 3-3 illustrates the sequence of messages necessary for a successful data trans- fer between two devices ...

Page 15

Figure 3-3. Message sequence chart describing the MAC data service Originator next Higher Layer wpan_mcps_data_request usr_mcps_data_conf 3.7.2 Association message sequence charts Figure 3-4. Message sequence chart for association Device next Higher Layer wpan_mlme_associate_request aResponseWaitTime usr_mlme_associate_conf 3.7.3 Disassociation message sequence charts ...

Page 16

Figure 3-5. Message sequence chart for disassociation Originator next Higher Layer wpan_mlme_disassociate _request usr_mlme_disassociate _conf 3.7.4 GTS management message sequence charts Figure 3-6. Message sequence chart for GTS allocation initiated by a device Originator next Higher Layer wpan_mlme_gts_request usr_mlme_gts_conf IEEE ...

Page 17

Figure 3-7. Message sequence chart for GTS deallocation initiated by a device (a) and the PAN coordinator (b) Device next Higher Layer wpan_mlme_gts_request a) usr_mlme_gts_conf b) usr_mlme_gts_ind 3-8 5182A–ZIGB–09/06 Device MLME GTS request Acknowledgement Beacon (with GTS descriptor) PAN coordinator ...

Page 18

A.1 MLME ASSOCIATE Request A.1.1 Semantics of the service call A.1.2 Expected results of the call A.2 MCPS DATA Request A.2.1 Semantics of the service call A.2.2 Expected results of the call IEEE 802.15.4 MAC User Guide PRELIMINARY Appendix A ...

Page 19

A.3 MLME DISASSOCIATE Request A.3.1 Semantics of the service call A.3.2 Expected results of the call A.4 MLME GET Request A.4.1 Semantics of the service call A.4.2 Expected results of the call A.5 MLME GTS Request A.5.1 Semantics of the ...

Page 20

A.7 MCPS PURGE Request A.7.1 Semantics of the service call A.7.2 Expected results of the call A.8 MLME RESET Request A.8.1 Semantics of the service call A.8.2 Expected results of the call A.9 MLME RX ENABLE Request A.9.1 Semantics of ...

Page 21

A.11 MLME SET Request A.11.1 Semantics of the service call A.11.2 Expected results of the call A.12 MLME START Request A.12.1 Semantics of the service call A.12.2 Expected results of the call A.13 MLME SYNC Request A.13.1 Semantics of the ...

Page 22

B.1 MLME ASSOCIATE Confirm B.1.1 Semantics of the service call B.1.2 Trigger Event B.2 MCPS DATA Confirm B.2.1 Semantics of the service call B.2.2 Trigger Event B.3 MLME DISASSOCIATE Confirm B.3.1 Semantics of the service call IEEE 802.15.4 MAC User ...

Page 23

B.3.2 Trigger Event B.4 MLME GET Confirm B.4.1 Semantics of the service call B.4.2 Trigger Event B.5 MLME GTS Confirm B.5.1 Semantics of the service call B.5.2 Trigger Event B.6 MLME POLL Confirm B.6.1 Semantics of the service call B.6.2 ...

Page 24

B.8 MLME RESET Confirm B.8.1 Semantics of the service call B.8.2 Trigger Event B.9 MLME RX ENABLE Confirm B.9.1 Semantics of the service call B.9.2 Trigger Event B.10 MLME SCAN Confirm B.10.1 Semantics of the service call B.10.2 Trigger Event ...

Page 25

B.12 MLME START Confirm B.12.1 Semantics of the service call B.12.2 Trigger Event B-4 5182A–ZIGB–09/06 The MLME START Confirm message is used to indicate the results of one or more associated previous service requests. SeThe MLME-POLL.request primitive prompts the device ...

Page 26

C.1 MLME ASSOCIATE Indication C.1.1 Semantics of the service call C.1.2 Trigger Event C.2 MLME BEACON- NOTIFY Indication C.2.1 Semantics of the service call C.2.2 Trigger Event C.3 MLME COMM STATUS Indication IEEE 802.15.4 MAC User Guide PRELIMINARY Appendix C ...

Page 27

C.3.1 Semantics of the service call C.3.2 Trigger Event C.4 MCPS DATA Indication C.4.1 Semantics of the service call C.4.2 Trigger Event C.5 MLME DISASSOCIATE Indication C.5.1 Semantics of the service call C.5.2 Trigger Event C.6 MLME GTS Indication C-2 ...

Page 28

C.6.1 Semantics of the service call C.6.2 Trigger Event C.7 MLME ORPHAN Indication C.7.1 Semantics of the service call C.7.2 Trigger Event C.8 MLME SYNC- LOSS Indication C.8.1 Semantics of the service call C.8.2 Trigger Event IEEE 802.15.4 MAC User ...

Page 29

D.1 MLME ASSOCIATE Response D.1.1 Semantics of the service call D.1.2 Expected results of the call D.2 MLME ORPHAN Response D.2.1 Semantics of the service call D.2.2 Expected results of the call IEEE 802.15.4 MAC User Guide PRELIMINARY Appendix D ...

Page 30

Table E--1. Parameter Library Parameter Type ACLEntry Integer addrInfo wpan_commstatus_addr_t; wpan_mcpsdata_addr_t assocShortAddress uint16_t AssociatedMember bool BatteryLifeExtension bool BeaconOrder uint8_t BSN Integer CapabilityInformation Bitmap CoordAddrMode uint8_t CoordAddress uint64_t CoordPANId uint16_t Coord_Realignment bool data Array of bytes data_length size_t IEEE 802.15.4 MAC ...

Page 31

Table E--1. Parameter Library Parameter Type DeferPermit bool DevAddress Device address DeviceAddress uint64_t DisassociateReason Integer DstAddr Device address DstAddrMode Integer GTSCharacteristics GTS characteristics LogicalChannel uint8_t LossReason Enumeration mpduLinkQuality Integer msdu Set of octets msduHandle uint16_t msduLength Integer OrphanAddress uint64_t pAddrInfo ...

Page 32

Table E--1. Parameter Library Parameter Type RxOnDuration uint32_t RxOnTime uint32_t ScanChannels uint32_t ScanDuration uint8_t ScanType Integer SecurityEnable bool SetDefaultPib bool ShortAddress uint16_t SrcAddr uint64_t SrcAddrMode uint8_t status Enumeration SuperframeOrder uint8_t TrackBeacon bool tx_options uint8_t UnscannedChannels Bitmap IEEE 802.15.4 MAC User ...

Page 33

... F.1 General Release Notes F.2 Atmel 802.15.4 MAC Software Release Notes IEEE 802.15.4 MAC User Guide PRELIMINARY Appendix F Release Notes Release 1.0.0 2006-07-05 Supported Compilers: – GCC 3.4.2 ® – IAR 4.10.1.5 Supported Hardware Platforms: – Radio Controller Board 230 GTS Implemented and passing ZQG level 1 tests, currently undergoing stress testing ...

Page 34

F-2 5182A–ZIGB–09/06 Rx Enable not tested Tracking of Beacon frames before Association not implemented IEEE 802.15.4 MAC User Guide PRELIMINARY ...

Page 35

... Disclaimer: The information in this document is provided in connection with Atmel products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Atmel products. EXCEPT AS SET FORTH IN ATMEL’S TERMS AND CONDI- TIONS OF SALE LOCATED ON ATMEL’S WEB SITE, ATMEL ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ...