Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / MLME / MLME_START.nc

diff --git a/tos/lib/mac/tkn154/interfaces/MLME/MLME_START.nc b/tos/lib/mac/tkn154/interfaces/MLME/MLME_START.nc
index b5e44b250dc1ee03cfe50173e83ded678741d2a9..1daf81710b2d0803fb4c48264494ac49bac9f376 100644 (file)
--- a/tos/lib/mac/tkn154/interfaces/MLME/MLME_START.nc
+++ b/tos/lib/mac/tkn154/interfaces/MLME/MLME_START.nc
@@ -33,6 +33,14 @@
  * ========================================================================
  */
 
+/** 
+ * MLME-SAP start primitives define how an FFD can request to start
+ * using a new superframe configuration in order to initiate a PAN,
+ * begin transmitting beacons on an already existing PAN, thus
+ * facilitating device discovery, or to stop transmitting beacons.
+ * (IEEE 802.15.4-2006, Sect. 7.1.14)
+ */
+
 #include "TKN154.h"
 interface MLME_START {
 
@@ -70,7 +78,7 @@ interface MLME_START {
    * @param coordRealignSecurity The security options for the coordinator
    *                         realignment command (NULL means security
    *                         is disabled)
-   * @param coordRealignSecurity The security options for beacon frames
+   * @param beaconSecurity The security options for beacon frames
    *                         (NULL means security is disabled)
    *
    * @return       IEEE154_SUCCESS if the request succeeded and a confirm event