[Tinyos-2-commits] CVS: tinyos-2.x/tos/chips/cc2420/interfaces PacketTimeSyncOffset.nc, 1.2, 1.3

[kusy]

Update of /cvsroot/tinyos/tinyos-2.x/tos/chips/cc2420/interfaces
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv22550

Modified Files:
	PacketTimeSyncOffset.nc 
Log Message:
Added comments.

Index: PacketTimeSyncOffset.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/chips/cc2420/interfaces/PacketTimeSyncOffset.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** PacketTimeSyncOffset.nc	23 Jun 2008 23:40:21 -0000	1.2
--- PacketTimeSyncOffset.nc	11 Jul 2008 08:44:41 -0000	1.3
***************
*** 19,23 ****
   * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
   *
!  * Author: Miklos Maroti
   */
  
--- 19,31 ----
   * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
   *
!  * Author: Miklos Maroti, Brano Kusy
!  *
!  * Interface for one hop time synchronization. Allows to modify timesync
!  * messages in the MAC layer with elapsed time of an event (ETA timesync
!  * primitive). Interface also provides a command to determine offset within
!  * a CC2420 packet, where the timesync ETA value is stored. word 'timestamping'
!  * used in describing commands does not refer to metadata.timestamp value,
!  *  rather it refers to the timesync ETA timestamp which is part of data
!  *  payload and is transmitted over the air.
   */
  
***************
*** 27,31 ****
       * @param 'message_t *ONE msg' message to examine.
       *
!      * Returns TRUE if the value is set for this message.
       */
      async command bool isSet(message_t* msg);
--- 35,39 ----
       * @param 'message_t *ONE msg' message to examine.
       *
!      * Returns TRUE if the current message should be timestamped.
       */
      async command bool isSet(message_t* msg);
***************
*** 34,39 ****
       * @param 'message_t *ONE msg' message to examine.
       *
!      * Returns the stored value of this field in the message. If the
!      * value is not set, then the returned value is undefined.
       */
      async command uint8_t get(message_t* msg);
--- 42,47 ----
       * @param 'message_t *ONE msg' message to examine.
       *
!      * Returns the offset of where the timesync timestamp is sotred in a
!      * CC2420 packet
       */
      async command uint8_t get(message_t* msg);
***************
*** 42,47 ****
       * @param 'message_t *ONE msg' message to modify.
       *
!      * Sets the isSet false to TRUE and the time stamp value to the
!      * specified value.
       */
      async command void set(message_t* msg);
--- 50,54 ----
       * @param 'message_t *ONE msg' message to modify.
       *
!      *  Sets the current message to be timestamped in the MAC layer.
       */
      async command void set(message_t* msg);
***************
*** 50,54 ****
       * @param 'message_t *ONE msg' message to modify.
       *
!      * Cancels any pending requests.
       */
      async command void cancel(message_t* msg);
--- 57,61 ----
       * @param 'message_t *ONE msg' message to modify.
       *
!      * Cancels any pending requests to timestamp the message in MAC.
       */
      async command void cancel(message_t* msg);