Contiki-Inga 3.x
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  */
32 
33 /**
34  * \file
35  * MAC driver header file
36  * \author
37  * Adam Dunkels <adam@sics.se>
38  */
39 
40 #ifndef MAC_H_
41 #define MAC_H_
42 
43 #include "contiki-conf.h"
44 #include "dev/radio.h"
45 
46 
47 typedef void (* mac_callback_t)(void *ptr, int status, int transmissions);
48 
49 void mac_call_sent_callback(mac_callback_t sent, void *ptr, int status, int num_tx);
50 
51 /**
52  * The structure of a MAC protocol driver in Contiki.
53  */
54 struct mac_driver {
55  char *name;
56 
57  /** Initialize the MAC driver */
58  void (* init)(void);
59 
60  /** Send a packet from the Rime buffer */
61  void (* send)(mac_callback_t sent_callback, void *ptr);
62 
63  /** Callback for getting notified of incoming packet. */
64  void (* input)(void);
65 
66  /** Turn the MAC layer on. */
67  int (* on)(void);
68 
69  /** Turn the MAC layer off. */
70  int (* off)(int keep_radio_on);
71 
72  /** Returns the channel check interval, expressed in clock_time_t ticks. */
73  unsigned short (* channel_check_interval)(void);
74 };
75 
76 /* Generic MAC return values. */
77 enum {
78  /**< The MAC layer transmission was OK. */
79  MAC_TX_OK,
80 
81  /**< The MAC layer transmission could not be performed due to a
82  collision. */
83  MAC_TX_COLLISION,
84 
85  /**< The MAC layer did not get an acknowledgement for the packet. */
86  MAC_TX_NOACK,
87 
88  /**< The MAC layer deferred the transmission for a later time. */
89  MAC_TX_DEFERRED,
90 
91  /**< The MAC layer transmission could not be performed because of an
92  error. The upper layer may try again later. */
93  MAC_TX_ERR,
94 
95  /**< The MAC layer transmission could not be performed because of a
96  fatal error. The upper layer does not need to try again, as the
97  error will be fatal then as well. */
98  MAC_TX_ERR_FATAL,
99 };
100 
101 #endif /* MAC_H_ */
Generated on Thu Apr 24 2014 16:26:12 for Contiki-Inga 3.x by   doxygen 1.8.3.1