Updated files.

[tinyos-2.x.git] / tos / interfaces / UartStream.nc

diff --git a/tos/interfaces/UartStream.nc b/tos/interfaces/UartStream.nc
new file mode 100644 (file)
index 0000000..6f4e320
--- /dev/null
+++ b/tos/interfaces/UartStream.nc
@@ -0,0 +1,101 @@
+/*
+ * Copyright (c) 2006 Arch Rock Corporation
+ * 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 Arch Rock Corporation 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
+ * ARCHED ROCK 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
+ */
+
+/**
+ * @author Jonathan Hui <jhui@archedrock.com>
+ * @version $Revision$ $Date$
+ */
+
+interface UartStream {
+
+  /**
+   * Begin transmission of a UART stream. If SUCCESS is returned,
+   * <code>sendDone</code> will be signalled when transmission is
+   * complete.
+   *
+   * @param buf Buffer for bytes to send.
+   * @param len Number of bytes to send.
+   * @return SUCCESS if request was accepted, FAIL otherwise.
+   */
+  async command error_t send( uint8_t* buf, uint16_t len );
+
+  /**
+   * Signal completion of sending a stream.
+   *
+   * @param buf Bytes sent.
+   * @param len Number of bytes sent.
+   * @param error SUCCESS if the transmission was successful, FAIL otherwise.
+   */
+  async event void sendDone( uint8_t* buf, uint16_t len, error_t error );
+
+  /**
+   * Enable the receive byte interrupt. The <code>receive</code> event
+   * is signalled each time a byte is received.
+   *
+   * @return SUCCESS if interrupt was enabled, FAIL otherwise.
+   */
+  async command error_t enableReceiveInterrupt();
+
+  /**
+   * Disable the receive byte interrupt.
+   *
+   * @return SUCCESS if interrupt was disabled, FAIL otherwise.
+   */
+  async command error_t disableReceiveInterrupt();
+
+  /**
+   * Signals the receipt of a byte.
+   *
+   * @param byte The byte received.
+   */
+  async event void receivedByte( uint8_t byte );
+
+  /**
+   * Begin reception of a UART stream. If SUCCESS is returned,
+   * <code>receiveDone</code> will be signalled when reception is
+   * complete.
+   *
+   * @param buf Buffer for received bytes.
+   * @param len Number of bytes to receive.
+   * @return SUCCESS if request was accepted, FAIL otherwise.
+   */
+  async command error_t receive( uint8_t* buf, uint16_t len );
+
+  /**
+   * Signal completion of receiving a stream.
+   *
+   * @param buf Buffer for bytes received.
+   * @param len Number of bytes received.
+   * @param error SUCCESS if the reception was successful, FAIL otherwise.
+   */
+  async event void receiveDone( uint8_t* buf, uint16_t len, error_t error );
+
+}