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

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / MCPS / MCPS_DATA.nc

diff --git a/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_DATA.nc b/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_DATA.nc
new file mode 100644 (file)
index 0000000..5870943
--- /dev/null
+++ b/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_DATA.nc
@@ -0,0 +1,102 @@
+/*
+ * 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>
+ * ========================================================================
+ */
+
+#include "TKN154.h"
+#include <message.h>
+
+interface MCPS_DATA 
+{
+
+  /**
+   * "The MCPS-DATA.request primitive requests the transfer of a data 
+   * SPDU (i.e., MSDU) from a local SSCS entity to a single peer SSCS 
+   * entity." (IEEE 802.15.4-2006, Sec. 7.1.1.1) 
+   *
+   * The MSDU is the payload portion of a message_t (<code>frame<\code>
+   * parameter) and can be accessed through the <code>IEEE154Frame<\code> 
+   * interface. In contrast to the standard interface definition address 
+   * information is not passed as separate parameters; instead, the 
+   * address information is already part of the <code>frame<\code>, 
+   * i.e. it must have been set (through the <code>IEEE154Frame<\code> 
+   * interface) before this command is called.
+   * 
+   * If this command returns IEEE154_SUCCESS, then the confirm event
+   * will be signalled in the future; otherwise, the confirm event
+   * will not be signalled.
+   * 
+   * @param frame         The frame to send
+   * @param payloadLen    The length of the frame payload
+   * @param msduHandle    Handle associated with the frame to be transmitted
+   * @param TxOptions     Bitwised OR transmission options
+   *
+   * @return       IEEE154_SUCCESS if the request succeeded and a confirm event
+   *               will be signalled, an appropriate error code otherwise 
+   *               (no confirm event will be signalled in this case)
+   * @see          confirm
+   */
+
+  command ieee154_status_t request  (
+                          message_t *frame,
+                          uint8_t payloadLen,
+                          uint8_t msduHandle,
+                          uint8_t TxOptions
+                        );
+
+  /**
+   * Confirm reports the results of a request to transfer a frame to a 
+   * peer SSCS entity.
+   *
+   * @param frame      The frame which was requested to send
+   * @param msduHandle The handle associated with the frame
+   * @param status     The status of the last MSDU transmission
+   * @param timestamp  Time of transmission (invalid if status is 
+   *                   not IEEE154_SUCCESS)
+   */
+  event void confirm    (  
+                          message_t *frame,
+                          uint8_t msduHandle,
+                          ieee154_status_t status,
+                          uint32_t Timestamp
+                        );
+
+  /**
+   * Indicates the arrival of a frame. Address information can be accessed 
+   * through the <code>IEEE154Frame<\code> interface.
+   * 
+   * @return A frame buffer for the stack to use for the next received frame
+   */
+  event message_t* indication ( message_t* frame );
+
+}