/** * This file is part of license combination gpl version 3 license and eCos. * The corresponding license terms are below. * * gpl version 3 Licence: * * The file were developed during the student thesis "Datensammlung in Wireless * Sensor Networks fuer Autonomic Home NetworkingÒ of Thomas Kothmayr and is * included in the dissertation "Secure Data Transmission in Wireless * Sensor Networks" by Corinna Schmitt during employment at the Technische * UniversitŠt MŸnchen, Department Computer Science, Chair Network * Architectures and Services (Germany). * Copyright (C) 2013 * Authors: Thomas Kothmayr and Corinna Schmitt (schmitt[at]net.in.tum.de) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, version 3 of the License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * * eCos Licence: (http://ecos.sourceware.org) * * This file is part of eCos, the Embedded Configurable Operating System. * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, * 2007, 2008, 2009 Free Software Foundation, Inc. * * eCos is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free * Software Foundation; either version 3 any later version. * * eCos is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with eCos; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * As a special exception, if other files instantiate templates or use * macros or inline functions from this file, or you compile this file and * link it with other works to produce a work based on this file, this file * does not by itself cause the resulting work to be covered by the GNU * General Public License. However the source code for this file must still * be made available in accordance with section (3) of the GNU General * Public License v2. * * This exception does not invalidate any other reasons why a work based on * this file might be covered by the GNU General Public License. * */ Interface: tos.interfaces.SplitControl

Interface: tos.interfaces.SplitControl

interface SplitControl

Please refer to TEP 115 for more information about this interface and its intended use.

This is the split-phase counterpart to the StdContol interface. It should be used for switching between the on and off power states of the component providing it. For each start() or stop() command, if the command returns SUCCESS, then a corresponding startDone() or stopDone() event must be signalled.

Author:
Joe Polastre
Kevin Klues (klueska@cs.wustl.edu)

Commands
command error_t start() Start this component and all of its subcomponents.
command error_t stop() Start this component and all of its subcomponents.

Events
event void startDone(error_t error) Notify caller that the component has been started and is ready to receive other commands.
event void stopDone(error_t error) Notify caller that the component has been stopped.

Commands - Details

start

command error_t start()

Start this component and all of its subcomponents. Return values of SUCCESS will always result in a startDone() event being signalled.

Returns:
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 startDone event in the near future.
EBUSY if the component is in the middle of powering down i.e. a stop() command has been called, and a stopDone() event is pending
EALREADY if the device is already on
FAIL Otherwise

stop

command error_t stop()

Start this component and all of its subcomponents. Return values of SUCCESS will always result in a startDone() event being signalled.

Returns:
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 stopDone event in the near future.
EBUSY if the component is in the middle of powering up i.e. a start() command has been called, and a startDone() event is pending
EALREADY if the device is already off
FAIL Otherwise

Events - Details

startDone

event void startDone(error_t error)

Notify caller that the component has been started and is ready to receive other commands.

Parameters:
error -- SUCCESS if the component was successfully turned on, FAIL otherwise

stopDone

event void stopDone(error_t error)

Notify caller that the component has been stopped.

Parameters:
error -- SUCCESS if the component was successfully turned off, FAIL otherwise