tos/interfaces/RadioTimeStamping.nc

   1 /*
   2  * "Copyright (c) 2000-2005 The Regents of the University  of California.
   3  * All rights reserved.
   4  *
   5  * Permission to use, copy, modify, and distribute this software and its
   6  * documentation for any purpose, without fee, and without written agreement is
   7  * hereby granted, provided that the above copyright notice, the following
   8  * two paragraphs and the author appear in all copies of this software.
   9  *
  10  * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
  11  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  12  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13  * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18  * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
  20  *
  21  */
  22 /**
  23  * Interface for receiving time stamp information from the radio.
  24  * This information is also embedded in packet metadata.
  25  *
  26  * @author Jonathan Hui
  27  * @author Philip Levis
  28  * @author Joe Polastre
  29  * @date   October 10 2005
  30  *
  31  */
  32
  33 interface RadioTimeStamping
  34 {
  35   /**
  36    * Provides the time at which start of frame delimiter has been
  37    * transmitted: units are in terms of a 32kHz clock.
  38    * @param 'message_t* ONE p_msg'
  39    */
  40   async event void transmittedSFD( uint16_t time, message_t* p_msg );
  41
  42   /**
  43    * Provides the time at which start of frame delimiter was received:
  44    * units are in terms of a 32kHz clock.  <b>NOTE</b> that receiving
  45    * a receivedSFD() event does NOT mean that a packet will be
  46    * received; the transmission may stop, become corrupted, or be
  47    * filtered by the physical or link layers.  The number of rxSFD
  48    * events will always be great than or equal to the number of
  49    * Receive message events.
  50    */
  51   async event void receivedSFD( uint16_t time );
  52 }