xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/netif/lowpan6_opts.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * 6LowPAN options list
4*10465441SEvalZero  */
5*10465441SEvalZero 
6*10465441SEvalZero /*
7*10465441SEvalZero  * Copyright (c) 2015 Inico Technologies Ltd.
8*10465441SEvalZero  * All rights reserved.
9*10465441SEvalZero  *
10*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
11*10465441SEvalZero  * are permitted provided that the following conditions are met:
12*10465441SEvalZero  *
13*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
14*10465441SEvalZero  *    this list of conditions and the following disclaimer.
15*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
17*10465441SEvalZero  *    and/or other materials provided with the distribution.
18*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
19*10465441SEvalZero  *    derived from this software without specific prior written permission.
20*10465441SEvalZero  *
21*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30*10465441SEvalZero  * OF SUCH DAMAGE.
31*10465441SEvalZero  *
32*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
33*10465441SEvalZero  *
34*10465441SEvalZero  * Author: Ivan Delamer <[email protected]>
35*10465441SEvalZero  *
36*10465441SEvalZero  *
37*10465441SEvalZero  * Please coordinate changes and requests with Ivan Delamer
38*10465441SEvalZero  * <[email protected]>
39*10465441SEvalZero  */
40*10465441SEvalZero 
41*10465441SEvalZero #ifndef LWIP_HDR_LOWPAN6_OPTS_H
42*10465441SEvalZero #define LWIP_HDR_LOWPAN6_OPTS_H
43*10465441SEvalZero 
44*10465441SEvalZero #include "lwip/opt.h"
45*10465441SEvalZero 
46*10465441SEvalZero /** LWIP_6LOWPAN_NUM_CONTEXTS: define the number of compression
47*10465441SEvalZero  * contexts per netif type
48*10465441SEvalZero  */
49*10465441SEvalZero #ifndef LWIP_6LOWPAN_NUM_CONTEXTS
50*10465441SEvalZero #define LWIP_6LOWPAN_NUM_CONTEXTS        10
51*10465441SEvalZero #endif
52*10465441SEvalZero 
53*10465441SEvalZero /** LWIP_6LOWPAN_INFER_SHORT_ADDRESS: set this to 0 to disable creating
54*10465441SEvalZero  * short addresses for matching addresses (debug only)
55*10465441SEvalZero  */
56*10465441SEvalZero #ifndef LWIP_6LOWPAN_INFER_SHORT_ADDRESS
57*10465441SEvalZero #define LWIP_6LOWPAN_INFER_SHORT_ADDRESS 1
58*10465441SEvalZero #endif
59*10465441SEvalZero 
60*10465441SEvalZero /** LWIP_6LOWPAN_IPHC: set this to 0 to disable IP header compression as per
61*10465441SEvalZero  * RFC 6282 (which is mandatory for BLE)
62*10465441SEvalZero  */
63*10465441SEvalZero #ifndef LWIP_6LOWPAN_IPHC
64*10465441SEvalZero #define LWIP_6LOWPAN_IPHC                1
65*10465441SEvalZero #endif
66*10465441SEvalZero 
67*10465441SEvalZero /** Set this to 1 if your IEEE 802.15.4 interface can calculate and check the
68*10465441SEvalZero  * CRC in hardware. This means TX packets get 2 zero bytes added on transmission
69*10465441SEvalZero  * which are to be filled with the CRC.
70*10465441SEvalZero  */
71*10465441SEvalZero #ifndef LWIP_6LOWPAN_802154_HW_CRC
72*10465441SEvalZero #define LWIP_6LOWPAN_802154_HW_CRC       0
73*10465441SEvalZero #endif
74*10465441SEvalZero 
75*10465441SEvalZero /** If LWIP_6LOWPAN_802154_HW_CRC==0, this can override the default slow
76*10465441SEvalZero  * implementation of the CRC used for 6LoWPAN over IEEE 802.15.4 (which uses
77*10465441SEvalZero  * a shift register).
78*10465441SEvalZero  */
79*10465441SEvalZero #ifndef LWIP_6LOWPAN_CALC_CRC
80*10465441SEvalZero #define LWIP_6LOWPAN_CALC_CRC(buf, len)  lowpan6_calc_crc(buf, len)
81*10465441SEvalZero #endif
82*10465441SEvalZero 
83*10465441SEvalZero /** Debug level for 6LoWPAN in general */
84*10465441SEvalZero #ifndef LWIP_LOWPAN6_DEBUG
85*10465441SEvalZero #define LWIP_LOWPAN6_DEBUG               LWIP_DBG_OFF
86*10465441SEvalZero #endif
87*10465441SEvalZero 
88*10465441SEvalZero /** Debug level for 6LoWPAN over IEEE 802.15.4 */
89*10465441SEvalZero #ifndef LWIP_LOWPAN6_802154_DEBUG
90*10465441SEvalZero #define LWIP_LOWPAN6_802154_DEBUG        LWIP_DBG_OFF
91*10465441SEvalZero #endif
92*10465441SEvalZero 
93*10465441SEvalZero /** LWIP_LOWPAN6_IP_COMPRESSED_DEBUG: enable compressed IP frame
94*10465441SEvalZero  * output debugging
95*10465441SEvalZero  */
96*10465441SEvalZero #ifndef LWIP_LOWPAN6_IP_COMPRESSED_DEBUG
97*10465441SEvalZero #define LWIP_LOWPAN6_IP_COMPRESSED_DEBUG      LWIP_DBG_OFF
98*10465441SEvalZero #endif
99*10465441SEvalZero 
100*10465441SEvalZero /** LWIP_LOWPAN6_DECOMPRESSION_DEBUG: enable decompression debug output
101*10465441SEvalZero  */
102*10465441SEvalZero #ifndef LWIP_LOWPAN6_DECOMPRESSION_DEBUG
103*10465441SEvalZero #define LWIP_LOWPAN6_DECOMPRESSION_DEBUG      LWIP_DBG_OFF
104*10465441SEvalZero #endif
105*10465441SEvalZero 
106*10465441SEvalZero /** LWIP_RFC7668_IP_UNCOMPRESSED_DEBUG: enable decompressed IP frame
107*10465441SEvalZero  * output debugging */
108*10465441SEvalZero #ifndef LWIP_RFC7668_IP_UNCOMPRESSED_DEBUG
109*10465441SEvalZero #define LWIP_RFC7668_IP_UNCOMPRESSED_DEBUG    LWIP_DBG_OFF
110*10465441SEvalZero #endif
111*10465441SEvalZero 
112*10465441SEvalZero /** LWIP_RFC7668_LINUX_WORKAROUND_PUBLIC_ADDRESS:
113*10465441SEvalZero  * Currently, the linux kernel driver for 6lowpan sets/clears a bit in
114*10465441SEvalZero  * the address, depending on the BD address (either public or not).
115*10465441SEvalZero  * Might not be RFC7668 conform, so you may select to do that (=1) or
116*10465441SEvalZero  * not (=0) */
117*10465441SEvalZero #ifndef LWIP_RFC7668_LINUX_WORKAROUND_PUBLIC_ADDRESS
118*10465441SEvalZero #define LWIP_RFC7668_LINUX_WORKAROUND_PUBLIC_ADDRESS 1
119*10465441SEvalZero #endif
120*10465441SEvalZero 
121*10465441SEvalZero 
122*10465441SEvalZero #endif /* LWIP_HDR_LOWPAN6_OPTS_H */
123