Merge devel code into the trunk.

[tinyos-2.x.git] / tos / lib / power / DeferredPowerManagerP.nc

diff --git a/tos/lib/power/DeferredPowerManagerP.nc b/tos/lib/power/DeferredPowerManagerP.nc
new file mode 100644 (file)
index 0000000..c3184ba
--- /dev/null
+++ b/tos/lib/power/DeferredPowerManagerP.nc
@@ -0,0 +1,146 @@
+/*
+ * "Copyright (c) 2005 Washington University in St. Louis.
+ * 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 following
+ * two paragraphs and the author appear in all copies of this software.
+ *
+ * IN NO EVENT SHALL WASHINGTON UNIVERSITY IN ST. LOUIS BE LIABLE TO ANY PARTY 
+ * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING 
+ * OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF WASHINGTON 
+ * UNIVERSITY IN ST. LOUIS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * WASHINGTON UNIVERSITY IN ST. LOUIS SPECIFICALLY DISCLAIMS ANY WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
+ * ON AN "AS IS" BASIS, AND WASHINGTON UNIVERSITY IN ST. LOUIS HAS NO 
+ * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
+ * MODIFICATIONS."
+ *
+ */
+ 
+/*
+ * - Revision -------------------------------------------------------------
+ * $Revision$
+ * $Date$ 
+ * ======================================================================== 
+ */
+ 
+/**
+ *
+ * This is the internal implementation of the deffered power management
+ * policy for managing the power states of non-virtualized devices.
+ * Non-virtualized devices are shared using a parameterized Resource
+ * interface, and are powered down according to some policy whenever there
+ * are no more pending requests to that Resource.  The policy implemented
+ * by this component is to delay the power down of a device by some contant
+ * factor.  Such a policy is useful whenever a device has a long wake-up
+ * latency.  The cost of waiting for the device to power up can be
+ * avoided if the device is requested again before some predetermined
+ * amount of time.
+ *
+ * @param <b>delay</b> -- The amount of time the power manager should wait
+ *                        before shutting down the device once it is free.
+ * 
+ * @author Kevin Klues (klueska@cs.wustl.edu)
+ * @see  Please refer to TEP 115 for more information about this component and its
+ *          intended use.
+ */
+ 
+generic module DeferredPowerManagerP(uint32_t delay) {
+  provides {
+    interface Init;
+  }
+  uses {
+    interface StdControl;
+    interface SplitControl;
+
+    interface PowerDownCleanup;
+    interface Init as ArbiterInit;
+    interface ResourceController;
+    interface ArbiterInfo;
+    interface Timer<TMilli> as TimerMilli;
+  }
+}
+implementation {
+
+  norace struct {
+   uint8_t stopping :1;
+   uint8_t requested :1;
+  } f; //for flags
+
+  task void startTask() { 
+    call StdControl.start();
+    call SplitControl.start();
+  }
+  task void timerTask() { 
+    call TimerMilli.startOneShot(delay); 
+  }
+
+  command error_t Init.init() {
+    f.stopping = FALSE;
+    f.requested = FALSE;
+    call ArbiterInit.init();
+    call ResourceController.immediateRequest();
+    return SUCCESS;
+  }
+
+  async event void ResourceController.requested() {
+    if(f.stopping == FALSE)
+      post startTask();
+    else atomic f.requested = TRUE;
+  }
+
+  default command error_t StdControl.start() {
+    return SUCCESS;
+  }
+  default command error_t SplitControl.start() {
+    signal SplitControl.startDone(SUCCESS);
+    return SUCCESS;
+  }
+
+  event void SplitControl.startDone(error_t error) {
+    call ResourceController.release();
+  }
+
+  async event void ResourceController.idle() {
+    if(!(call ArbiterInfo.inUse()))
+      post timerTask();
+  }
+
+  event void TimerMilli.fired() {
+    if(call ResourceController.immediateRequest() == SUCCESS) {
+      f.stopping = TRUE;
+      call PowerDownCleanup.cleanup();
+      call StdControl.stop();
+      call SplitControl.stop();
+    }
+  }
+
+  event void SplitControl.stopDone(error_t error) {
+    if(f.requested == TRUE) {
+      call StdControl.start();
+      call SplitControl.start();
+    }
+    atomic {
+      f.requested = FALSE;
+      f.stopping = FALSE;
+    }
+  }
+
+  event void ResourceController.granted() {
+  }
+
+  default command error_t StdControl.stop() {
+    return SUCCESS;
+  }
+  default command error_t SplitControl.stop() {
+    signal SplitControl.stopDone(SUCCESS);
+    return SUCCESS;
+  }
+
+  default async command void PowerDownCleanup.cleanup() {
+  }
+}