gpiocountercapture.nc

Develop Zigbee network real-time Os

// $Id: GpioCapture.nc,v 1.4 2006/12/12 18:23:14 vlahan 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 author 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."
 */

/**
 * Interface for microcontroller-independent 32kHz timer capture events.
 * 
 * @author Jonathan Hui
 * @author Philip Levis
 * @author Joe Polastre
 * @author Martin Leopold
 * @date   August 6 2007
 *
 */

#include "Timer.h"

interface GpioCounterCapture<precision_tag, size_type>
{

  /** 
   * Enable an edge based timer capture event.
   *
   * @return Whether the timer capture has been enabled.
   */
  async command error_t captureRisingEdge();
  async command error_t captureFallingEdge();

  /**
   * Fired when an edge interrupt occurs.
   *
   * @param val The value of the respective timer/counter
   */
  async event void captured(size_type time);

  /**
   * Disable further captures.
   */ 
  async command void disable();

}