Implement support for the BQ2403x charge controller family. Only tested with

[tinyos-2.x.git] / tos / chips / bq2403x / BQ2403X.nc

diff --git a/tos/chips/bq2403x/BQ2403X.nc b/tos/chips/bq2403x/BQ2403X.nc
new file mode 100644 (file)
index 0000000..2d0a093
--- /dev/null
+++ b/tos/chips/bq2403x/BQ2403X.nc
@@ -0,0 +1,84 @@
+/*
+ * 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 BQ2403X charge controller chip.
+ * 
+ * @author R. Steve McKown <smckown@gmail.com>
+ */
+ 
+#include "BQ2403X.h"
+
+interface BQ2403X {
+  /**
+   * Get the current charge controller state.
+   */
+  async command bq2403x_state_t getState();
+
+  /**
+   * @returns The charge portion of the current state.
+   */
+  async command bq2403x_state_t getCharge();
+
+  /**
+   * @returns The power portion of the current state.
+   */
+  async command bq2403x_state_t getPower();
+
+  /**
+   * @returns TRUE if the battery is charging
+   */
+  async command bool isCharging();
+
+  /**
+   * @returns TRUE if no external power.  Same as getPower() == 0.
+   */
+  async command bool battOnly();
+
+  /**
+   * Enable notifications from the charge controller via <t>change()</t>.
+   */
+  async command void enable();
+
+  /**
+   * Disnable notifications from the charge controller via <t>change()</t>.
+   */
+  async command void disable();
+
+  /**
+   * Signalled any time the state of the BQ2403X charge controller changes when
+   * the controller is <t>enable()</t>'d.  A deglitch mechanism must be
+   * implemented by the provider, as a charge controller on AC or USB and with
+   * no battery attached will tend to "flash" between two states.
+   *
+   * @param current The current state of the charge controller.
+   * @param last The state of the charge controller at last query.
+   */
+  async event void change(bq2403x_state_t current, bq2403x_state_t last);
+}