[Tinyos-2-commits] CVS: tinyos-2.x/tos/lib/mac/tkn154/interfaces/public IEEE154BeaconFrame.nc, 1.1, 1.2 IEEE154Frame.nc, 1.2, 1.3 IEEE154TxBeaconPayload.nc, 1.2, 1.3

Wed Mar 4 10:32:22 PST 2009

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

Modified Files:
	IEEE154BeaconFrame.nc IEEE154Frame.nc 
	IEEE154TxBeaconPayload.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: IEEE154BeaconFrame.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/lib/mac/tkn154/interfaces/public/IEEE154BeaconFrame.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** IEEE154BeaconFrame.nc	16 Jun 2008 18:00:34 -0000	1.1
--- IEEE154BeaconFrame.nc	4 Mar 2009 18:31:46 -0000	1.2
***************
*** 34,37 ****
--- 34,41 ----
   */
  
+ /** 
+  * The IEEE154BeaconFrame interface allows to access the content of a beacon
+  * frame.
+  */
  
  #include <TKN154.h>

Index: IEEE154Frame.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** IEEE154Frame.nc	25 Nov 2008 09:35:09 -0000	1.2
--- IEEE154Frame.nc	4 Mar 2009 18:31:46 -0000	1.3
***************
*** 34,37 ****
--- 34,41 ----
   */
  
+ /** 
+  * The IEEE154Frame interface allows to access the content of a IEEE 802.15.4
+  * frame.
+  */
  
  #include <TKN154.h>
***************
*** 158,162 ****
   /**
     * Returns the point in time when the frame was received. If 
!    * <tt>isTimestampValid()<\tt> returns FALSE then the 
     * timestamp is not valid and must be ignored.
     *
--- 162,166 ----
   /**
     * Returns the point in time when the frame was received. If 
!    * <tt>isTimestampValid()</tt> returns FALSE then the 
     * timestamp is not valid and must be ignored.
     *
***************
*** 193,197 ****
      * BEACON=0, DATA=1, ACK=2, COMMAND=3.
      *
!     * Note: For beacon frames one can use the <tt>IEEE154BeaconFrame<\tt>
      * interface to inspect additional fields of the frame.
      *
--- 197,201 ----
      * BEACON=0, DATA=1, ACK=2, COMMAND=3.
      *
!     * Note: For beacon frames one can use the <tt>IEEE154BeaconFrame</tt>
      * interface to inspect additional fields of the frame.
      *

Index: IEEE154TxBeaconPayload.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** IEEE154TxBeaconPayload.nc	25 Nov 2008 09:35:09 -0000	1.2
--- IEEE154TxBeaconPayload.nc	4 Mar 2009 18:31:46 -0000	1.3
***************
*** 34,37 ****
--- 34,43 ----
   */
  
+ /** 
+  * The IEEE154TxBeaconPayload interface allows to access the payload portion of
+  * the beacon frame that is periodically transmitted by a coordinator in a
+  * beacon-enabled PAN. This interface replaces the MLME-SET command for the PIB
+  * attribute values 0x45 (macBeaconPayload) and 0x46 (macBeaconPayloadLength).
+  */
  
  #include <TKN154.h>
***************
*** 43,48 ****
     * This command replaces the MLME-SET command for the PIB attribute values
     * 0x45 (macBeaconPayload) and 0x46 (macBeaconPayloadLength). The
!    * <tt>setBeaconPayloadDone()<\tt> event will be signalled when the 
!    * beacon payload has been set -- until then <tt>beaconPayload<\tt> must 
     * not be modified.
     *
--- 49,54 ----
     * This command replaces the MLME-SET command for the PIB attribute values
     * 0x45 (macBeaconPayload) and 0x46 (macBeaconPayloadLength). The
!    * <tt>setBeaconPayloadDone()</tt> event will be signalled when the 
!    * beacon payload has been set -- until then <tt>beaconPayload</tt> must 
     * not be modified.
     *
***************
*** 51,55 ****
     *
     * @return EBUSY if another transaction is pending, ESIZE if length is too big, 
!    * SUCCESS otherwise (and only then the <tt>setBeaconPayloadDone<\tt> event 
     * will be signalled)
     */
--- 57,61 ----
     *
     * @return EBUSY if another transaction is pending, ESIZE if length is too big, 
!    * SUCCESS otherwise (and only then the <tt>setBeaconPayloadDone</tt> event 
     * will be signalled)
     */
***************
*** 57,73 ****
  
    /**
!    * Signalled in response to a <tt>setBeaconPayload()<\tt> request.
     * Indicates that the beacon payload has been copied and returns the
     * ownership of the buffer to the next higher layer. 
     * 
!    * @param beaconPayload   the <tt>beaconPayload<\tt> passed in the 
!    *                        <tt>setBeaconPayload()<\tt> command
!    * @param length          the <tt>length<\tt> passed in the 
!    *                        <tt>setBeaconPayload()<\tt> command
     */
   event void setBeaconPayloadDone(void *beaconPayload, uint8_t length);
  
    /**
!    * Returns a pointer to the current beacon payload. 
     * 
     * @return the current beacon payload
--- 63,79 ----
  
    /**
!    * Signalled in response to a <tt>setBeaconPayload()</tt> request.
     * Indicates that the beacon payload has been copied and returns the
     * ownership of the buffer to the next higher layer. 
     * 
!    * @param beaconPayload   the <tt>beaconPayload</tt> passed in the 
!    *                        <tt>setBeaconPayload()</tt> command
!    * @param length          the <tt>length</tt> passed in the 
!    *                        <tt>setBeaconPayload()</tt> command
     */
   event void setBeaconPayloadDone(void *beaconPayload, uint8_t length);
  
    /**
!    * Returns a pointer to the current beacon payload.
     * 
     * @return the current beacon payload
***************
*** 85,92 ****
     * Replaces (overwrites) a portion of the current beacon payload. Whenever
     * possible, to minimize overhead, the next higher layer should prefer this
!    * command over the <tt>setBeaconPayload()<\tt> command.  The
!    * <tt>modifyBeaconPayloadDone()<\tt> event will be signalled when the 
!    * beacon payload has been updated -- until then <tt>buffer<\tt> must 
!    * not be modified.
     *
     * @param offset      offset into the current beacon payload
--- 91,98 ----
     * Replaces (overwrites) a portion of the current beacon payload. Whenever
     * possible, to minimize overhead, the next higher layer should prefer this
!    * command over the <tt>setBeaconPayload()</tt> command.  The
!    * <tt>modifyBeaconPayloadDone()</tt> event will be signalled when the beacon
!    * payload has been updated -- until then <tt>buffer</tt> must not be
!    * modified.
     *
     * @param offset      offset into the current beacon payload
***************
*** 94,113 ****
     * @param length      the length of the buffer
     *
!    * @return EBUSY if another transaction is pending, ESIZE if offset+length is too big, 
!    * SUCCESS otherwise (and only then the <tt>modifyBeaconPayloadDone<\tt> event 
!    * will be signalled)
     */
   command error_t modifyBeaconPayload(uint8_t offset, void *buffer, uint8_t bufferLength);
  
    /**
!    * Signalled in response to a <tt>modifyBeaconPayload()<\tt> request.
     * Indicates that the beacon payload has been updated. 
     * 
!    * @param offset        the <tt>offset<\tt> passed in the 
!    *                      <tt>modifyBeaconPayload()<\tt> command
!    * @param buffer        the <tt>buffer<\tt> passed in the 
!    *                      <tt>modifyBeaconPayload()<\tt> command
!    * @param bufferLength  the <tt>bufferLength<\tt> passed in the 
!    *                      <tt>modifyBeaconPayload()<\tt> command
     */
   event void modifyBeaconPayloadDone(uint8_t offset, void *buffer, uint8_t bufferLength);
--- 100,119 ----
     * @param length      the length of the buffer
     *
!    * @return EBUSY if another transaction is pending, ESIZE if offset+length is
!    * too big, SUCCESS otherwise (and only then the
!    * <tt>modifyBeaconPayloadDone</tt> event will be signalled)
     */
   command error_t modifyBeaconPayload(uint8_t offset, void *buffer, uint8_t bufferLength);
  
    /**
!    * Signalled in response to a <tt>modifyBeaconPayload()</tt> request.
     * Indicates that the beacon payload has been updated. 
     * 
!    * @param offset        the <tt>offset</tt> passed in the 
!    *                      <tt>modifyBeaconPayload()</tt> command
!    * @param buffer        the <tt>buffer</tt> passed in the 
!    *                      <tt>modifyBeaconPayload()</tt> command
!    * @param bufferLength  the <tt>bufferLength</tt> passed in the 
!    *                      <tt>modifyBeaconPayload()</tt> command
     */
   event void modifyBeaconPayloadDone(uint8_t offset, void *buffer, uint8_t bufferLength);
***************
*** 118,123 ****
     *
     * The usual policy is that (1) this event is signalled before every beacon
!    * transmission, and (2) that a subsequent call to <tt>setPayload<\tt>
!    * will update the beacon payload portion of this beacon.  However, 
     * because of tight timing constraints in beacon-enabled mode neither can be
     * guaranteed!
--- 124,129 ----
     *
     * The usual policy is that (1) this event is signalled before every beacon
!    * transmission, and (2) that a subsequent call to <tt>setPayload</tt>
!    * will still update the beacon payload portion of this beacon. However, 
     * because of tight timing constraints in beacon-enabled mode neither can be
     * guaranteed!
***************
*** 127,131 ****
    /** 
     * Indicates that a beacon frame has been transmitted (the 
!    * <tt>getBeaconPayload<\tt> command can be used to inspect the
     * beacon payload).
     */
--- 133,137 ----
    /** 
     * Indicates that a beacon frame has been transmitted (the 
!    * <tt>getBeaconPayload</tt> command can be used to inspect the
     * beacon payload).
     */