Contiki 2.6
|
00001 /* 00002 * Copyright (c) 2007, 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: mac.h,v 1.14 2010/10/03 20:37:32 adamdunkels Exp $ 00032 */ 00033 00034 /** 00035 * \file 00036 * MAC driver header file 00037 * \author 00038 * Adam Dunkels <adam@sics.se> 00039 */ 00040 00041 #ifndef __MAC_H__ 00042 #define __MAC_H__ 00043 00044 #include "contiki-conf.h" 00045 #include "dev/radio.h" 00046 00047 00048 typedef void (* mac_callback_t)(void *ptr, int status, int transmissions); 00049 00050 void mac_call_sent_callback(mac_callback_t sent, void *ptr, int status, int num_tx); 00051 00052 /** 00053 * The structure of a MAC protocol driver in Contiki. 00054 */ 00055 struct mac_driver { 00056 char *name; 00057 00058 /** Initialize the MAC driver */ 00059 void (* init)(void); 00060 00061 /** Send a packet from the Rime buffer */ 00062 void (* send)(mac_callback_t sent_callback, void *ptr); 00063 00064 /** Callback for getting notified of incoming packet. */ 00065 void (* input)(void); 00066 00067 /** Turn the MAC layer on. */ 00068 int (* on)(void); 00069 00070 /** Turn the MAC layer off. */ 00071 int (* off)(int keep_radio_on); 00072 00073 /** Returns the channel check interval, expressed in clock_time_t ticks. */ 00074 unsigned short (* channel_check_interval)(void); 00075 }; 00076 00077 /* Generic MAC return values. */ 00078 enum { 00079 /**< The MAC layer transmission was OK. */ 00080 MAC_TX_OK, 00081 00082 /**< The MAC layer transmission could not be performed due to a 00083 collision. */ 00084 MAC_TX_COLLISION, 00085 00086 /**< The MAC layer did not get an acknowledgement for the packet. */ 00087 MAC_TX_NOACK, 00088 00089 /**< The MAC layer deferred the transmission for a later time. */ 00090 MAC_TX_DEFERRED, 00091 00092 /**< The MAC layer transmission could not be performed because of an 00093 error. The upper layer may try again later. */ 00094 MAC_TX_ERR, 00095 00096 /**< The MAC layer transmission could not be performed because of a 00097 fatal error. The upper layer does not need to try again, as the 00098 error will be fatal then as well. */ 00099 MAC_TX_ERR_FATAL, 00100 }; 00101 00102 #endif /* __MAC_H__ */