Initial version of TKN15.4, a platform-independent IEEE 802.15.4-2006 MAC implementat...

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / private / RadioOff.nc

diff --git a/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc b/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
new file mode 100644 (file)
index 0000000..2431784
--- /dev/null
+++ b/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
@@ -0,0 +1,59 @@
+/* 
+ * Copyright (c) 2008, Technische Universitaet Berlin
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * - Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * - Neither the name of the Technische Universitaet Berlin nor the names
+ *   of its contributors may be used to endorse or promote products derived
+ *   from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * - Revision -------------------------------------------------------------
+ * $Revision$
+ * $Date$
+ * @author Jan Hauer <hauer@tkn.tu-berlin.de>
+ * ========================================================================
+ */
+
+interface RadioOff
+{
+
+  /** 
+   * Switches the radio off and changes the radio state to RADIO_OFF. This
+   * command will succeed only if the current state of the radio is either
+   * TX_LOADED, RX_PREPARED or RECEIVING.
+   *
+   * @return EALREADY if radio is already switched off <br> FAIL if radio the
+   * current radio state is neither TX_LOADED, RX_PREPARED nor RECEIVING <br>
+   * SUCCESS if the command was accepted and the <tt>offDone()</tt> event will
+   * be signalled.
+   */
+  async command error_t off();
+
+  /** 
+   * Signalled in response to a successful call to <tt>off()</tt>. The radio is
+   * now in the state RADIO_OFF.
+   **/  
+  async event void offDone();
+
+ /** @return TRUE if the radio is in the state RADIO_OFF, FALSE otherwise */
+  async command bool isOff();
+}