mirror of
https://github.com/oliverschmidt/contiki.git
synced 2024-08-14 09:28:59 +00:00
main ideas are: * Separates the Contiki low-layer network stack into four layers: network (e.g. sicslowpan / rime), Medium Access Control MAC (e.g. CSMA), Radio Duty Cycling RDC (e.g. ContikiMAC, X-MAC), and radio (e.g. cc2420). * Introduces a new way to configure the network stack. Four #defines that specify what mechanism/protocol/driver to use at the four layers: NETSTACK_CONF_NETWORK, NETSTACK_CONF_MAC, NETSTACK_CONF_RDC, NETSTACK_CONF_RADIO. * Adds a callback mechanism to inform the MAC and network layers about the fate of a transmitted packet: if the packet was not possible to transmit, the cause of the failure is reported, and if the packets was successfully transmitted, the number of tries before it was finally transmitted is reported. * NULL-protocols at both the MAC and RDC layers: nullmac and nullrdc, which can be used when MAC and RDC functionality is not needed. * Extends the radio API with three new functions that enable more efficient radio duty cycling protocols: channel check, pending packet, and receiving packet. * New initialization mechanism, which takes advantage of the NETSTACK #defines.
112 lines
3.8 KiB
C
112 lines
3.8 KiB
C
/*
|
|
* Copyright (c) 2007, Swedish Institute of Computer Science.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the Institute nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* This file is part of the Contiki operating system.
|
|
*
|
|
* $Id: mac.h,v 1.12 2010/02/18 21:48:39 adamdunkels Exp $
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* MAC driver header file
|
|
* \author
|
|
* Adam Dunkels <adam@sics.se>
|
|
*/
|
|
|
|
#ifndef __MAC_H__
|
|
#define __MAC_H__
|
|
|
|
#include "contiki-conf.h"
|
|
#include "dev/radio.h"
|
|
|
|
|
|
typedef void (* mac_callback_t)(void *ptr, int status, int transmissions);
|
|
|
|
void mac_call_sent_callback(mac_callback_t sent, void *ptr, int status, int num_tx);
|
|
|
|
/**
|
|
* The structure of a MAC protocol driver in Contiki.
|
|
*/
|
|
struct mac_driver {
|
|
char *name;
|
|
|
|
/** Initialize the MAC driver */
|
|
void (* init)(void);
|
|
|
|
/** Send a packet from the Rime buffer */
|
|
void (* send)(mac_callback_t sent_callback, void *ptr);
|
|
|
|
/** Callback for getting notified of incoming packet. */
|
|
void (* input)(void);
|
|
|
|
/** Turn the MAC layer on. */
|
|
int (* on)(void);
|
|
|
|
/** Turn the MAC layer off. */
|
|
int (* off)(int keep_radio_on);
|
|
|
|
/** Returns the channel check interval, expressed in clock_time_t ticks. */
|
|
unsigned short (* channel_check_interval)(void);
|
|
};
|
|
|
|
/* Generic MAC return values. */
|
|
enum {
|
|
/**< The MAC layer transmission was OK. */
|
|
MAC_TX_OK,
|
|
|
|
/**< The MAC layer transmission could not be performed due to a
|
|
collision. */
|
|
MAC_TX_COLLISION,
|
|
|
|
/**< The MAC layer did not get an acknowledgement for the packet. */
|
|
MAC_TX_NOACK,
|
|
|
|
/**< The MAC layer transmission could not be performed because of an
|
|
error. The upper layer may try again later. */
|
|
MAC_TX_ERR,
|
|
|
|
/**< The MAC layer transmission could not be performed because of a
|
|
fatal error. The upper layer does not need to try again, as the
|
|
error will be fatal then as well. */
|
|
MAC_TX_ERR_FATAL,
|
|
};
|
|
#ifndef MAC_CHANNEL_CHECK_RATE
|
|
#ifdef MAC_CONF_CHANNEL_CHECK_RATE
|
|
#define MAC_CHANNEL_CHECK_RATE MAC_CONF_CHANNEL_CHECK_RATE
|
|
#else /* MAC_CONF_CHANNEL_CHECK_RATE */
|
|
#define MAC_CHANNEL_CHECK_RATE 4
|
|
#endif /* MAC_CONF_CHANNEL_CHECK_RATE */
|
|
#endif /* MAC_CHANNEL_CHECK_RATE */
|
|
|
|
#if (MAC_CHANNEL_CHECK_RATE & (MAC_CHANNEL_CHECK_RATE - 1)) != 0
|
|
#error MAC_CONF_CHANNEL_CHECK_RATE must be a power of two (i.e., 1, 2, 4, 8, 16, 32, 64, ...).
|
|
#error Change MAC_CONF_CHANNEL_CHECK_RATE in contiki-conf.h or in your Makefile.
|
|
#endif
|
|
|
|
#endif /* __MAC_H__ */
|