Contiki 2.6

rdc.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2010, Swedish Institute of Computer Science.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the Institute nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  *
00029  * This file is part of the Contiki operating system.
00030  *
00031  * $Id: rdc.h,v 1.1 2010/02/23 20:09:11 nifi Exp $
00032  */
00033 
00034 /**
00035  * \file
00036  *         RDC driver header file
00037  * \author
00038  *         Adam Dunkels <adam@sics.se>
00039  *         Niclas Finne <nfi@sics.se>
00040  */
00041 
00042 #ifndef __RDC_H__
00043 #define __RDC_H__
00044 
00045 #include "contiki-conf.h"
00046 #include "net/mac/mac.h"
00047 
00048 /* List of packets to be sent by RDC layer */
00049 struct rdc_buf_list {
00050   struct rdc_buf_list *next;
00051   struct queuebuf *buf;
00052   void *ptr;
00053 };
00054 
00055 /**
00056  * The structure of a RDC (radio duty cycling) driver in Contiki.
00057  */
00058 struct rdc_driver {
00059   char *name;
00060 
00061   /** Initialize the RDC driver */
00062   void (* init)(void);
00063 
00064   /** Send a packet from the Rime buffer  */
00065   void (* send)(mac_callback_t sent_callback, void *ptr);
00066 
00067   /** Send a packet list */
00068   void (* send_list)(mac_callback_t sent_callback, void *ptr, struct rdc_buf_list *list);
00069 
00070   /** Callback for getting notified of incoming packet. */
00071   void (* input)(void);
00072 
00073   /** Turn the MAC layer on. */
00074   int (* on)(void);
00075 
00076   /** Turn the MAC layer off. */
00077   int (* off)(int keep_radio_on);
00078 
00079   /** Returns the channel check interval, expressed in clock_time_t ticks. */
00080   unsigned short (* channel_check_interval)(void);
00081 };
00082 
00083 #endif /* __RDC_H__ */