More work on USCI peripheral support.

[tinyos-2.x.git] / tos / chips / msp430 / usci / HplMsp430UsciInt.nc

diff --git a/tos/chips/msp430/usci/HplMsp430UsciInt.nc b/tos/chips/msp430/usci/HplMsp430UsciInt.nc
new file mode 100644 (file)
index 0000000..19e1e6d
--- /dev/null
+++ b/tos/chips/msp430/usci/HplMsp430UsciInt.nc
@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2008, Titanium Mirror, Inc.
+ * 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 the Technische Universität Berlin 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 THE COPYRIGHT
+ * OWNER OR 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.
+ */
+ 
+/**
+ * Interrupt interface for USCI peripherals.  Although A and B devices have
+ * different interrupt sets since B only support I2C, we use a single set for
+ * both so that upper layers need not deal with the different sets.  This is
+ * critical in the case of SPI communications, which is supported by both A
+ * and B devices.
+ * 
+ * @author R. Steve McKown <rsmckown@gmail.com>
+ */
+ 
+#include "msp430usci.h"
+
+interface HplMsp430UsciInt {
+  /**
+   * Signals a break received in UART modes if UCBRKIE is enabled.  The
+   * provider must reset the UCxIFG.UCxxRXIFG and UCxSTAT.UCBRK bits prior to
+   * signalling the event to the user.
+   */
+  async event void brk();
+
+  /**
+   * Signals a character received for any USCI mode.  The provider must reset
+   * UCxIFG.UCxxRXIFG before signalling the event to the user.
+   *
+   * @params c The character received.
+   */
+  async event void rx(char c);
+
+  /**
+   * Signals that the device's transmit buffer is empty and can accept
+   * another character.  Note that the USCI device may still be in the
+   * process of transmitting the last character when this event is signalled.
+   * The UCxxTXIFG bit will automatically reset when the interface user writes
+   * a value to the related UCxxTXBUF register after receipt of this event.
+   */
+  async event void tx();
+
+  /**
+   * I2C mode only.  Indicates the device has lost arbitration.  Valid only in
+   * multi-master contexts.
+   */
+  async event void i2cCal();
+
+  /**
+   * I2C mode only.  Indicates the device was expecting an ACK and it was not
+   * received.
+   */
+  async event void i2cNak();
+
+  /**
+   * I2C mode only.  Indicates the device has detected a start condition
+   * together with its own address while in slave mode.
+   */
+  async event void i2cStart();
+
+  /**
+   * I2C mode only.  Indicates the device has detected a stop condition while
+   * in slave mode.
+   */
+  async event void i2cStop();
+}