]> oss.titaniummirror.com Git - tinyos-2.x.git/blobdiff - doc/txt/tep115.txt
Update to TEP115
[tinyos-2.x.git] / doc / txt / tep115.txt
index ae96a51a2801e6e53d2fe0d10ccf9e42492984c8..f224d458afc3eb25655a0ca3bdf7cc4e7b25ed4d 100644 (file)
@@ -32,17 +32,17 @@ This memo documents how TinyOS 2.x manages the power state of physical
 ======================================================================
 
 TinyOS platforms have limited energy. A unified power management
-strategy for all devices and peripherpals is not feasible, as
+strategy for all devices and peripherals is not feasible, as
 they vary significantly in warm-up times, power profiles, and
 operation latencies. While some devices, such as
 microcontrollers, can efficiently calculate their lowest possible
 power state very quickly, others, such as sensors with warm-up
 times, require external knowledge to do so.
 
-In TinyOS 1.x, an application is responsible for all power management.
+In TinyOS 1.x, applications are responsible for all power management.
 Low-level subsystems, such as an SPI bus, are explicitly powered on
 and off by higher level abstractions. This approach of deep calls
-to StdControl.start and StdControl.stop introduces strange behaviors
+to ``StdControl.start()`` and ``StdControl.stop()`` introduces strange behaviors
 and can get in the way of power conservation. Turning off the radio
 on the Telos platform, for example, turns off the SPI bus and therefore
 prevents the flash driver from working. Additionally, the microcontroller
@@ -73,7 +73,8 @@ power management*.
 The explicit model provides a means for a single client to manually
 control the power state of a dedicated physical device (as defined by
 [TEP108]_).  Whenever this client tells the device to power up or down
-it does so without delay (albeit that caused by hardware).  This model
+it does so without delay (except for delays in the hardware of course).  
+This model
 can be particularly useful when the control information driving the
 selection of the proper power state of a device relies on external
 logic contained in higher level components.  The following section
@@ -135,7 +136,7 @@ representing a hardware device that can be powered on and off MUST
 provide one of these three interfaces.
 The selection of the right interface depends on the
 latencies involved in changing between these two states as well as the
-nature of the code (sync or async) executing any of the interfaces
+nature of the code (sync or async) executing any of the interface's
 commands.
 
 3.1 Power Management with ``StdControl``
@@ -172,7 +173,8 @@ interfaces implemented by the device to succeed.
 
 Upon the successful return of a call to ``StdControl.stop()``, a
 device MUST be completely powered down, and any calls to commands 
-of other interfaces implemented by that device MUST return FAIL or EOFF.
+of other interfaces implemented by that device that actually access 
+the device hardware MUST return FAIL or EOFF.
 
 If a device is not able to complete the ``StdControl.start()`` or
 ``StdControl.stop()`` request for any reason, it MUST return FAIL.
@@ -206,7 +208,7 @@ Devices providing this interface would do so as shown below::
 ----------------------------------------------------------------------
 
 When a device's powerup and powerdown times are non-negligible, the
-*``SplitControl``* interface MUST be used in place of the *``StdControl``*
+*``SplitControl``* interface SHOULD be used in place of the *``StdControl``*
 interface.  The definition of this interface can be seen below::
 
    interface SplitControl {
@@ -220,12 +222,12 @@ interface.  The definition of this interface can be seen below::
 An external component MUST call ``SplitControl.start()`` to power a
 device on and ``SplitControl.stop()`` to power a device off.  Calls to
 either command return one of SUCCESS, FAIL, EBUSY, or
-EALREADY. SUCCESS indicates that the device has now started chaning
-its power mode and it will signal a corresponding completion event in
-the future. EBUSY indicates that the device is in the midst of the
-other operation (e.g., it is starting when stop is called or stopping
+EALREADY. SUCCESS indicates that the device has now started changing
+its power state and will signal a corresponding completion event in
+the future. EBUSY indicates that the device is in the midst of either starting
+or stopping (e.g., it is starting when stop is called or stopping
 when start is called) and will not issue an event. EALREADY indicates
-that the device is already in that state; the call is erroneus and a
+that the device is already in that state; the call is erroneous and a
 completion event will not be signaled. FAIL indicates that the
 device's power state could not be changed. More explicitly:
 
@@ -241,7 +243,8 @@ of other interfaces implemented by the device MAY succeed.
 
 Upon signalling a ``SplitControl.stopDone(SUCCESS)``, a device MUST be 
 completely powered down, and any subsequent calls to commands of other 
-interfaces implemented by the device MUST return EOFF or FAIL.
+interfaces implemented by the device that actually access 
+the device hardware MUST return EOFF or FAIL.
 
 If a device is powered on and a successful call to ``SplitControl.stop()``
 signals a ``SplitControl.stopDone(FAIL)``, the device MUST still be fully 
@@ -262,13 +265,13 @@ SUCCESS, with the  anticipation that a corresponding
 ``SplitControl.startDone()`` or ``SplitControl.stopDone()``
 will be signaled in the future.
 
-Calls to `SplitControl.start()`` when the device is started
+Calls to ``SplitControl.start()`` when the device is started
 or ``SplitControl.stop()`` while the device is stopped MUST
 return EALREADY, indicating that the device is already in that
 state. The corresponding completion event (startDone for start
 or stopDone for stop) MUST NOT be signaled.
 
-Calls to `SplitControl.start()`` when the device is stopping or
+Calls to ``SplitControl.start()`` when the device is stopping or
 ``SplitControl.stop()`` while the device is starting MUST return
 EBUSY, indicating that the device is busy performing a differnet
 operation. The correspodning completion event (startDone for start or
@@ -297,7 +300,28 @@ Devices providing this interface would do so as shown below::
        ....
      }
    }
-
+   
+.. Note::
+       
+       Other approaches were considered for the return values of  
+       ``SplitControl.start()`` and ``SplitControl.stop()``.  One such 
+       approach would have replaced EBUSY with SUCCESS when 
+       ``SplitControl.start()`` was called while in the process of stopping
+       and ``SplitControl.stop()`` was called while in the process of starting.
+       However, implementing such an approach adds unwanted complexity to 
+       a device driver.  It is unreasonable to expect the implementor of
+       each driver to implement this functionality.  
+       
+       Returning EBUSY is the most straightforward, unambiguous value
+       that can be returned in such a situation.  By returning 
+       EBUSY when a device is in a transitional state, the components 
+       built on top of a driver unambiguously know exactly why a call to 
+       ``start()`` or ``stop()`` did not succeed, and can take action accordingly.
+       Since only ONE component should ever implement the ``SplitControl`` 
+       interface for a given device, it isn't unreasonable to expect them 
+       to keep track of this return value themselves.  There is, of course, 
+       nothing preventing someone from creating a component 
+       on top of each driver implementation that implements things differently.
 
 3.3 Power Management with ``AsyncStdControl`` 
 ----------------------------------------------------------------------
@@ -380,7 +404,8 @@ For cases when some of these features are known a-priori or are
 restricted in some sense, it is preferable that the system provide 
 architectural support for enforcing a meaningful *default* power-management 
 policy instead of passing that task on to the application programmer to be 
-solved on a case-by-case basis.
+solved on a case-by-case basis.  The following section discusses these power
+management policies and the components that implement them in greater detail.
 
 
 4.1. Power Management Policies
@@ -389,7 +414,7 @@ solved on a case-by-case basis.
 Just as generic arbiters are offered in TinyOS 2.x to provide the
 arbitration functionality required by shared resources, generic power
 management policies are also offered to allow the power management of
-non-virtualised devices to be automatically control.
+non-virtualised devices to be automatically controlled.
 
 Through the use of the arbiter components described in [TEP108]_,
 device drivers implemented as shared resources provide the type of
@@ -437,9 +462,9 @@ by one of its clients.  Whenever a client puts in a request, the
 (or ``immediateRequested()`` event) from the arbiter it is associated with. 
 Upon receiving this event, the *Power Manager* MUST power up the 
 resource through the StdControl-like interface provided by the lower level
-abstraction of the physical device. The *Power Manager* SHOULD release the
+abstraction of the physical device. The *Power Manager* MUST release the
 ownership of the resource (using the ``ResourceDefaultOwner.release()``
-command) but MUST wait until after the resource has been fully powered on 
+command) and MUST wait until after the resource has been fully powered on 
 before doing so.
 
 Modeling devices as shared resources and allowing them to be
@@ -537,7 +562,8 @@ devices are powered on and off immediately after they have been
 requested and released.  The second policy is implemented using
 a *deferred* power control scheme, whereby devices are powered 
 on immediately after being requested, but powered off after
-some small delay from being released.  
+some small delay from being released. This delay is configurable
+to meet the varying needs of different device drivers.  
 
 Each policy has three different implementations for use by each of 
 the ``StdControl``, ``SplitControl``, and ``AsyncStdControl``
@@ -559,12 +585,11 @@ Deferred Power Management:
 5. Author's Address
 ====================================================================
 | Kevin Klues
-| 503 Bryan Hall
-| Washington University
-| St. Louis, MO 63130
+| 444 Gates Hall
+| Stanford University
+| Stanford, CA 94305-9030
 |
-| phone - +1-314-935-6355
-| email - klueska@cs.wustl.edu
+| email - klueska@cs.stanford.edu
 |
 | Vlado Handziski
 | Sekr FT5