Contiki-NG
csma.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  * \addtogroup link-layer
34  * @{
35  *
36  * \defgroup csma Implementation of the 802.15.4 standard CSMA protocol
37  * @{
38 */
39 
40 /**
41  * \file
42  * The 802.15.4 standard CSMA protocol (nonbeacon-enabled)
43  * \author
44  * Adam Dunkels <adam@sics.se>
45  * Simon Duquennoy <simon.duquennoy@inria.fr>
46  */
47 
48 #ifndef CSMA_H_
49 #define CSMA_H_
50 
51 #include "contiki.h"
52 #include "net/mac/mac.h"
53 #include "net/packetbuf.h"
54 #include "net/netstack.h"
55 #include "dev/radio.h"
56 
57 #ifdef CSMA_CONF_SEND_SOFT_ACK
58 #define CSMA_SEND_SOFT_ACK CSMA_CONF_SEND_SOFT_ACK
59 #else /* CSMA_CONF_SEND_SOFT_ACK */
60 #define CSMA_SEND_SOFT_ACK 0
61 #endif /* CSMA_CONF_SEND_SOFT_ACK */
62 
63 #ifdef CSMA_CONF_ACK_WAIT_TIME
64 #define CSMA_ACK_WAIT_TIME CSMA_CONF_ACK_WAIT_TIME
65 #else /* CSMA_CONF_ACK_WAIT_TIME */
66 #define CSMA_ACK_WAIT_TIME RTIMER_SECOND / 2500
67 #endif /* CSMA_CONF_ACK_WAIT_TIME */
68 
69 #ifdef CSMA_CONF_AFTER_ACK_DETECTED_WAIT_TIME
70 #define CSMA_AFTER_ACK_DETECTED_WAIT_TIME CSMA_CONF_AFTER_ACK_DETECTED_WAIT_TIME
71 #else /* CSMA_CONF_AFTER_ACK_DETECTED_WAIT_TIME */
72 #define CSMA_AFTER_ACK_DETECTED_WAIT_TIME RTIMER_SECOND / 1500
73 #endif /* CSMA_CONF_AFTER_ACK_DETECTED_WAIT_TIME */
74 
75 #define CSMA_ACK_LEN 3
76 
77 /* just a default - with LLSEC, etc */
78 #define CSMA_MAC_MAX_HEADER 21
79 
80 
81 extern const struct mac_driver csma_driver;
82 
83 /* CSMA security framer functions */
84 int csma_security_create_frame(void);
85 int csma_security_parse_frame(void);
86 
87 /* key management for CSMA */
88 int csma_security_set_key(uint8_t index, const uint8_t *key);
89 
90 
91 #endif /* CSMA_H_ */
92 /**
93  * @}
94  * @}
95  */
The structure of a MAC protocol driver in Contiki.
Definition: mac.h:62
Header file for the radio API
Header file for the Packet buffer (packetbuf) management
Include file for the Contiki low-layer network stack (NETSTACK)
MAC driver header file