]> oss.titaniummirror.com Git - tinyos-2.x.git/blobdiff - tos/interfaces/SplitControl.nc
Update tos-bsl for win32 python
[tinyos-2.x.git] / tos / interfaces / SplitControl.nc
index b60f2066a4f8ef6f4c61731340708bbfc51a1c17..a5c83a83dcb401e4d042f822ea0f3972bbc0b314 100644 (file)
@@ -70,10 +70,14 @@ interface SplitControl
    * values of SUCCESS will always result in a <code>startDone()</code>
    * event being signalled.
    *
-   * @return SUCCESS if issuing the start command was successful<br>
+   * @return SUCCESS if the device is already in the process of 
+   *         starting or the device was off and the device is now ready to turn 
+   *         on.  After receiving this return value, you should expect a 
+   *         <code>startDone</code> event in the near future.<br>
    *         EBUSY if the component is in the middle of powering down
    *               i.e. a <code>stop()</code> command has been called,
    *               and a <code>stopDone()</code> event is pending<br>
+   *         EALREADY if the device is already on <br>
    *         FAIL Otherwise
    */
   command error_t start();
@@ -88,15 +92,18 @@ interface SplitControl
   event void startDone(error_t error);
 
   /**
-   * Stop the component and pertinent subcomponents (not all
-   * subcomponents may be turned off due to wakeup timers, etc.).
-   * Return values of SUCCESS will always result in a
-   * <code>stopDone()</code> event being signalled.
+   * Start this component and all of its subcomponents.  Return
+   * values of SUCCESS will always result in a <code>startDone()</code>
+   * event being signalled.
    *
-   * @return SUCCESS if issuing the stop command was successful<br>
+   * @return SUCCESS if the device is already in the process of 
+   *         stopping or the device was on and the device is now ready to turn 
+   *         off.  After receiving this return value, you should expect a 
+   *         <code>stopDone</code> event in the near future.<br>
    *         EBUSY if the component is in the middle of powering up
    *               i.e. a <code>start()</code> command has been called,
    *               and a <code>startDone()</code> event is pending<br>
+   *         EALREADY if the device is already off <br>
    *         FAIL Otherwise
    */
   command error_t stop();