hplatm128i2cbus.nc

来自「tinyos-2.x.rar」· NC 代码 · 共 87 行

/// $Id: HplAtm128I2CBus.nc,v 1.4 2006/12/12 18:23:03 vlahan Exp $

/*
 *  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 (updated) modification history and the author appear in
 *  all copies of this source code.
 *
 *  Permission is also granted to distribute this software under the
 *  standard BSD license as contained in the TinyOS distribution.
 *
 *  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 THE COPYRIGHT HOLDERS OR CONTRIBUTORS 
 *  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOSS OF USE, DATA, 
 *  OR PROFITS) 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.
 */

#include "Atm128I2C.h"

/**
 * This driver implements direct I2C register access and a blocking master
 * controller for the ATmega128 via a Hardware Platform Layer (HPL) to its  
 * two-wire-interface (TWI) hardware subsystem.
 *
 * @author Martin Turon <[e-mail]>
 * @author Philip Levis
 *
 * @version  $Id: HplAtm128I2CBus.nc,v 1.4 2006/12/12 18:23:03 vlahan Exp $
 */
interface HplAtm128I2CBus {

  async command void init(bool hasExternalPulldown);
  async command void off();
  
  async command uint8_t status();

  async command void readCurrent();
  async command void sendCommand();
  async event void commandComplete();

  
  // Transaction interface
  async command void setStart(bool on);
  async command bool hasStart();
  async command void setStop(bool on);   
  async command bool hasStop();
  async command void enableAck(bool enable);
  async command bool hasAcks();
  
  async command void enableInterrupt(bool enable);
  async command bool isInterruptEnabled();

  // Examines actual register. Included so that code which needs
  // to spin in TWINT does not have to read out cached copies.
  async command bool isRealInterruptPending();

  // Operates on cached copy (from readCurrent)
  async command bool isInterruptPending(); 
  
  // NOTE: writing a 1 in the interrupt pending bit (TWINT) of the
  // atm128 I2C control register (TWCR) will *clear* the bit if it
  // is set. This is how you tell the I2C to take the next action,
  // as when the bit is cleared it starts the next operation.
  async command void setInterruptPending(bool on);

  async command void enable(bool on);
  async command bool isEnabled();
  async command bool hasWriteCollided();
  
  // Data interface to TWDR
  async command void write(uint8_t data);
  async command uint8_t read();
  
  

}