[Tinyos-2-commits] CVS: tinyos-2.x/tos/lib/serial SerialFlush.nc, NONE, 1.1

[Ben Greenstein]

Update of /cvsroot/tinyos/tinyos-2.x/tos/lib/serial
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv11231/tos/lib/serial

Added Files:
	SerialFlush.nc 
Log Message:
cleaned up document


--- NEW FILE: SerialFlush.nc ---
//$Id: SerialFlush.nc,v 1.1 2007/02/06 02:39:43 bengreenstein Exp $

/* "Copyright (c) 2000-2005 The Regents of the University of California.  
 * All rights reserved.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement
 * is hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the autor appear in all copies of this software.
 * 
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY
 * OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 */

/**
 * A basic interface to flush the serial port.
 *
 * @author Ben Greenstein
 * @author Philip Levis
 * @date January 23 2006
 *
 */

interface SerialFlush {

  /** 
   * Request that the serial device signal when no more transmissions
   * are pending (i.e., when the device is idle)
   */
  command void flush();

  /** 
   * Split phase event to indicate that the serial hardware is now idle.
   */
  event void flushDone();

}