Add support for the cp210x chipset, which is simply a debounced version status

[tinyos-2.x.git] / tos / chips / cp210x / CP210X.nc

diff --git a/tos/chips/cp210x/CP210X.nc b/tos/chips/cp210x/CP210X.nc
new file mode 100644 (file)
index 0000000..07f82b5
--- /dev/null
+++ b/tos/chips/cp210x/CP210X.nc
@@ -0,0 +1,70 @@
+/*
+ * 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.
+ */
+ 
+/**
+ * HIL interface for the CP210X USB/serial controller chip.
+ * 
+ * @author R. Steve McKown <smckown@gmail.com>
+ */
+ 
+interface CP210X {
+  /**
+   * @returns the current attach state of the USB connector.
+   */
+  async command bool isEnabled();
+
+  /**
+   * Enable notifications from the cp210x.  This does not enable the USB bus.
+   */
+  async command void enable();
+
+  /**
+   * Disable notifications from the cp210x.  This does not disable the USB bus.
+   */
+  async command void disable();
+
+  /**
+   * Signalled any time the USB connection moves from any other state to the
+   * enabled state.  In the enabled state, USB is supplying power and data
+   * connections can be established.  Signals are only send if notifications
+   * have been enabled.
+   */
+  async event void enabled();
+
+  /**
+   * Signalled any time the USB connection moves out of enabled state.  This
+   * may be because the USB host or hub has placed the local USB device into
+   * suspend, the upstream hub has powered down, or the interconnecting cable
+   * has been disconnected.  In all cases, only very minimal power is available
+   * from USB, all existing data connections are aborted and no new connections
+   * can be established.  Signals are only sent if notifications have been
+   * enabled.
+   */
+  async event void suspended();
+}