[Tinyos-2-commits] CVS: tinyos-2.x/tos/lib/mac/tkn154/interfaces/MCPS MCPS_DATA.nc, 1.2, 1.3 MCPS_PURGE.nc, 1.1, 1.2

[Jan-Hinrich Hauer]

Update of /cvsroot/tinyos/tinyos-2.x/tos/lib/mac/tkn154/interfaces/MCPS
In directory ddv4jf1.ch3.sourceforge.com:/tmp/cvs-serv17605/tos/lib/mac/tkn154/interfaces/MCPS

Modified Files:
	MCPS_DATA.nc MCPS_PURGE.nc 
Log Message:
- re-designed the radio driver interfaces, restructured/improved the CC2420 radio driver
- split the main MAC configuration (was TKN154P.nc) in two: one for beacon-enabled mode the other for nonbeacon-enabled mode (this decision has to be made at compile time now)
- added (serial) debugging functions (compile with "TKN154_DEBUG=1 make telosb" and use the java PrintfClient, see tinyos-2.x/apps/tests/TestPrintf/README.txt)
- improved readability, added comments 

Index: MCPS_DATA.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_DATA.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** MCPS_DATA.nc	25 Nov 2008 09:35:09 -0000	1.2
--- MCPS_DATA.nc	4 Mar 2009 18:31:40 -0000	1.3
***************
*** 34,37 ****
--- 34,43 ----
   */
  
+ /** 
+  * 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, Sect. 7.1.1)
+  */
+ 
  #include "TKN154.h"
  #include <message.h>
***************
*** 41,55 ****
  
    /**
!    * "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 (<tt>frame</tt>
!    * parameter) and can be accessed through the <tt>IEEE154Frame</tt> 
!    * 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 <tt>frame</tt>, 
!    * i.e. it must have been set (through the <tt>IEEE154Frame</tt> 
!    * interface) before this command is called.
     * 
     * If this command returns IEEE154_SUCCESS, then the confirm event
--- 47,59 ----
  
    /**
!    * "Requests to transfer 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 source/destination addressing mode, destination PAN
!    * identifier, destination address, the payload and (optionally) the
!    * security mode/key are part of the <tt>frame</tt> and must have
!    * been set (through the <tt>IEEE154Frame</tt> interface) before
!    * calling this command.
     * 
     * If this command returns IEEE154_SUCCESS, then the confirm event
***************
*** 59,68 ****
     * @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
     */
--- 63,72 ----
     * @param frame         The frame to send
     * @param payloadLen    The length of the frame payload
!    * @param msduHandle    Handle associated with the frame
     * @param TxOptions     Bitwised OR transmission options
     *
!    * @return       IEEE154_SUCCESS if the request succeeded and only
!    *               then the <tt>confirm()</tt> event will be signalled;
!    *               an appropriate error code otherwise 
     * @see          confirm
     */
***************
*** 76,87 ****
  
    /**
!    * 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    (  
--- 80,91 ----
  
    /**
!    * Reports the result of a request to transfer a frame to a peer
!    * SSCS entity.
     *
!    * @param frame      The frame which was requested to be sent
     * @param msduHandle The handle associated with the frame
     * @param status     The status of the last MSDU transmission
!    * @param timestamp  Time of transmission (invalid if <tt>status</tt> 
!    *                   is not IEEE154_SUCCESS)
     */
    event void confirm    (  
***************
*** 93,98 ****
  
    /**
!    * Indicates the arrival of a frame. Address information can be accessed 
!    * through the <tt>IEEE154Frame</tt> interface.
     * 
     * @return A frame buffer for the stack to use for the next received frame
--- 97,103 ----
  
    /**
!    * Indicates the arrival of a frame. Use the <tt>IEEE154Frame</tt>
!    * interface to get the payload, source/destination addresses, DSN
!    * and other information associated with this frame.
     * 
     * @return A frame buffer for the stack to use for the next received frame

Index: MCPS_PURGE.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_PURGE.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** MCPS_PURGE.nc	16 Jun 2008 18:00:31 -0000	1.1
--- MCPS_PURGE.nc	4 Mar 2009 18:31:40 -0000	1.2
***************
*** 34,37 ****
--- 34,42 ----
   */
  
+ /** 
+  * The MCPS-PURGE.request primitive allows the next higher layer to purge an
+  * MSDU from the transaction queue. (IEEE 802.15.4-2006, Sect. 7.1.1)
+  */
+ 
  #include "TKN154.h"
  
***************
*** 39,48 ****
  
    /**
!    * Request to purge a frame from the transaction queue.
!    * The result will be returned immediately (there
!    * is no confirm event for this command).
     * 
     * @param msduHandle The handle of the frame to be purged from the
     *                   transaction queue
     * @return       IEEE154_SUCCESS if the request succeeded, an 
     *               appropriate error code otherwise 
--- 44,54 ----
  
    /**
!    * Requests to purge a frame from the transaction queue. The result
!    * will be returned immediately (there is no confirm event for this
!    * command).
     * 
     * @param msduHandle The handle of the frame to be purged from the
     *                   transaction queue
+    *
     * @return       IEEE154_SUCCESS if the request succeeded, an 
     *               appropriate error code otherwise