bridgeif_opts.h

00001 /**
00002  * @file
00003  * lwIP netif implementing an IEEE 802.1D MAC Bridge
00004  */
00005 
00006 /*
00007  * Copyright (c) 2017 Simon Goldschmidt.
00008  * All rights reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without modification,
00011  * are permitted provided that the following conditions are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright notice,
00014  *    this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright notice,
00016  *    this list of conditions and the following disclaimer in the documentation
00017  *    and/or other materials provided with the distribution.
00018  * 3. The name of the author may not be used to endorse or promote products
00019  *    derived from this software without specific prior written permission.
00020  *
00021  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00022  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00023  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00024  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00026  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00029  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00030  * OF SUCH DAMAGE.
00031  *
00032  * This file is part of the lwIP TCP/IP stack.
00033  *
00034  * Author: Simon Goldschmidt <goldsimon@gmx.de>
00035  *
00036  */
00037 
00038 #ifndef LWIP_HDR_NETIF_BRIDGEIF_OPTS_H
00039 #define LWIP_HDR_NETIF_BRIDGEIF_OPTS_H
00040 
00041 #include "lwip/opt.h"
00042 
00043 /**
00044  * @defgroup bridgeif_opts Options
00045  * @ingroup bridgeif
00046  * @{
00047  */
00048 
00049 /** BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT==1: set port netif's 'input' function
00050  * to call directly into bridgeif code and on top of that, directly call into
00051  * the selected forwarding port's 'linkoutput' function.
00052  * This means that the bridgeif input/output path is protected from concurrent access
00053  * but as well, *all* bridge port netif's drivers must correctly handle concurrent access!
00054  * == 0: get into tcpip_thread for every input packet (no multithreading)
00055  * ATTENTION: as ==0 relies on tcpip.h, the default depends on NO_SYS setting
00056  */
00057 #ifndef BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT
00058 #define BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT  NO_SYS
00059 #endif
00060 
00061 /** BRIDGEIF_MAX_PORTS: this is used to create a typedef used for forwarding
00062  * bit-fields: the number of bits required is this + 1 (for the internal/cpu port)
00063  * (63 is the maximum, resulting in an u64_t for the bit mask)
00064  * ATTENTION: this controls the maximum number of the implementation only!
00065  * The max. number of ports per bridge must still be passed via netif_add parameter!
00066  */
00067 #ifndef BRIDGEIF_MAX_PORTS
00068 #define BRIDGEIF_MAX_PORTS                  7
00069 #endif
00070 
00071 /** BRIDGEIF_DEBUG: Enable generic debugging in bridgeif.c. */
00072 #ifndef BRIDGEIF_DEBUG
00073 #define BRIDGEIF_DEBUG                      LWIP_DBG_OFF
00074 #endif
00075 
00076 /** BRIDGEIF_DEBUG: Enable FDB debugging in bridgeif.c. */
00077 #ifndef BRIDGEIF_FDB_DEBUG
00078 #define BRIDGEIF_FDB_DEBUG                  LWIP_DBG_OFF
00079 #endif
00080 
00081 /** BRIDGEIF_DEBUG: Enable forwarding debugging in bridgeif.c. */
00082 #ifndef BRIDGEIF_FW_DEBUG
00083 #define BRIDGEIF_FW_DEBUG                   LWIP_DBG_OFF
00084 #endif
00085 
00086 /**
00087  * @}
00088  */
00089 
00090 #endif /* LWIP_HDR_NETIF_BRIDGEIF_OPTS_H */