hplm16c62ptimer.nc

tinyos-2.x.rar

/*
 * Copyright (c) 2009 Communication Group and Eislab at
 * Lulea University of Technology
 *
 * Contact: Laurynas Riliskis, LTU
 * Mail: [e-mail]
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the
 *   distribution.
 * - Neither the name of Communication Group at Lulea University of Technology
 *   nor the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL STANFORD
 * UNIVERSITY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Copyright (c) 2004-2005 Crossbow Technology, Inc.  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 CROSSBOW TECHNOLOGY OR ANY OF ITS LICENSORS 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 CROSSBOW OR ITS LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 
 * DAMAGE. 
 *
 * CROSSBOW TECHNOLOGY AND ITS LICENSORS SPECIFICALLY DISCLAIM ALL 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 NEITHER CROSSBOW NOR ANY LICENSOR HAS ANY 
 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR 
 * MODIFICATIONS.
 *
 */

/**
 * Basic interface to the hardware timers on the M16C/62p.
 * This interface provides four major groups of functionality:<ol>
 *      <li>Timer Value: get/set current time
 *      <li>Interrupt event, occurs when the timer under- or overflows.
 *      <li>Control of Interrupt: enableInterrupt/disableInterrupt/clearInterrupt...
 *      <li>Timer Initialization: turn on/off clock source
 * </ol>
 *
 * @author Henrik Makitaavola <[e-mail]>
 * @author Martin Turon <[e-mail]>
 */
 
#include "M16c62pTimer.h"

interface HplM16c62pTimer
{
  /**
   * Turn on the clock.
   */
  async command void on();
  
  /**
   * Turn off the clock.
   */
  async command void off();

  /**
   * Check if the clock is on.
   */
  async command bool isOn();

  /** 
   * Get the current time.
   * @return  the current time.
   */
  async command uint16_t get();

  /** 
   * Set the current time.
   * @param t the time to set.
   */
  async command void set( uint16_t t );

  /**
   * Signalled on timer interrupt.
   */
  async event void fired();

  /**
   * Clear the interrupt flag.
   */
  async command void clearInterrupt();

  /**
   * Enable the interrupts.
   */
  async command void enableInterrupt();

  /**
   * Turns off interrupts.
   */
  async command void disableInterrupt();

  /** 
   * Checks if an interrupt has occured.
   * @return TRUE if interrupt has triggered.
   */
  async command bool testInterrupt();

  /** 
   * Checks if interrupts are on.
   * @return TRUE if interrups are enabled.
   */
  async command bool isInterruptOn();
  
  /**
   * Turn stop mode on/off while the timer is on.
   * @param allow If true the mcu can go into stop mode while
   *              timer is on if false the mcu can only use
   *              wait mode while timer is on.
   */
  async command void allowStopMode(bool allow);
}