Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Examples

radio.h

Go to the documentation of this file.
00001 /**
00002  * \addtogroup dev
00003  * @{
00004  */
00005 
00006 /**
00007  * \defgroup radio Radio API
00008  *
00009  * The radio API module defines a set of functions that a radio device
00010  * driver must implement.
00011  *
00012  * @{
00013  */
00014 
00015 /*
00016  * Copyright (c) 2005, Swedish Institute of Computer Science.
00017  * All rights reserved.
00018  *
00019  * Redistribution and use in source and binary forms, with or without
00020  * modification, are permitted provided that the following conditions
00021  * are met:
00022  * 1. Redistributions of source code must retain the above copyright
00023  *    notice, this list of conditions and the following disclaimer.
00024  * 2. Redistributions in binary form must reproduce the above copyright
00025  *    notice, this list of conditions and the following disclaimer in the
00026  *    documentation and/or other materials provided with the distribution.
00027  * 3. Neither the name of the Institute nor the names of its contributors
00028  *    may be used to endorse or promote products derived from this software
00029  *    without specific prior written permission.
00030  *
00031  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
00032  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00033  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00034  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
00035  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00036  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00037  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00038  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00039  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00040  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00041  * SUCH DAMAGE.
00042  *
00043  * This file is part of the Contiki operating system.
00044  *
00045  * $Id: radio.h,v 1.1 2006/06/17 22:41:17 adamdunkels Exp $
00046  */
00047 
00048 /**
00049  * \file
00050  *         Header file for the radio API
00051  * \author
00052  *         Adam Dunkels <adam@sics.se>
00053  */
00054 
00055 #ifndef __RADIO_H__
00056 #define __RADIO_H__
00057 
00058 
00059 /**
00060  * \brief      Turn radio on.
00061  *
00062  *             This function turns the radio hardware on.
00063  */
00064 void radio_on(void);
00065 
00066 /**
00067  * \brief      Turn radio off.
00068  *
00069  *             This function turns the radio hardware off.
00070  */
00071 void radio_off(void);
00072 
00073 #endif /* __RADIO_H__ */
00074 
00075 /** @} */
00076 /** @} */

Generated on Thu Jun 22 17:45:42 2006 for Contiki 2.x by  doxygen 1.4.4