Contiki 2.5
mac.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007, Swedish Institute of Computer Science.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  * $Id: mac.h,v 1.14 2010/10/03 20:37:32 adamdunkels Exp $
32  */
33 
34 /**
35  * \file
36  * MAC driver header file
37  * \author
38  * Adam Dunkels <adam@sics.se>
39  */
40 
41 #ifndef __MAC_H__
42 #define __MAC_H__
43 
44 #include "contiki-conf.h"
45 #include "dev/radio.h"
46 
47 
48 typedef void (* mac_callback_t)(void *ptr, int status, int transmissions);
49 
50 void mac_call_sent_callback(mac_callback_t sent, void *ptr, int status, int num_tx);
51 
52 /**
53  * The structure of a MAC protocol driver in Contiki.
54  */
55 struct mac_driver {
56  char *name;
57 
58  /** Initialize the MAC driver */
59  void (* init)(void);
60 
61  /** Send a packet from the Rime buffer */
62  void (* send)(mac_callback_t sent_callback, void *ptr);
63 
64  /** Callback for getting notified of incoming packet. */
65  void (* input)(void);
66 
67  /** Turn the MAC layer on. */
68  int (* on)(void);
69 
70  /** Turn the MAC layer off. */
71  int (* off)(int keep_radio_on);
72 
73  /** Returns the channel check interval, expressed in clock_time_t ticks. */
74  unsigned short (* channel_check_interval)(void);
75 };
76 
77 /* Generic MAC return values. */
78 enum {
79  /**< The MAC layer transmission was OK. */
80  MAC_TX_OK,
81 
82  /**< The MAC layer transmission could not be performed due to a
83  collision. */
84  MAC_TX_COLLISION,
85 
86  /**< The MAC layer did not get an acknowledgement for the packet. */
87  MAC_TX_NOACK,
88 
89  /**< The MAC layer deferred the transmission for a later time. */
90  MAC_TX_DEFERRED,
91 
92  /**< The MAC layer transmission could not be performed because of an
93  error. The upper layer may try again later. */
94  MAC_TX_ERR,
95 
96  /**< The MAC layer transmission could not be performed because of a
97  fatal error. The upper layer does not need to try again, as the
98  error will be fatal then as well. */
99  MAC_TX_ERR_FATAL,
100 };
101 
102 #endif /* __MAC_H__ */
Generated on Fri Aug 30 2013 12:34:05 for Contiki 2.5 by   doxygen 1.8.3.1