michaelh/zephyr
1
0
Fork 0
Code Releases Activity

net: lldp: Allow generation of documentation

Browse source 
No need to hide the symbols in the header file if CONFIG_NET_LLDP
is not enabled. This also allows the documentation to be generated
properly.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-26 09:56:06 +02:00 • committed by Anas Nashif
commit 52dc50dc6b
6 changed files with 27 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

1
drivers/net/slip.c
View file

@ -30,7 +30,6 @@ LOG_MODULE_REGISTER(LOG_MODULE_NAME);
#include <net/net_pkt.h> #include <net/net_pkt.h>
#include <net/net_if.h> #include <net/net_if.h>
#include <net/net_core.h> #include <net/net_core.h>
#include <net/lldp.h>
#include <console/uart_pipe.h> #include <console/uart_pipe.h>
#include <net/ethernet.h> #include <net/ethernet.h>

4
include/net/ethernet.h
View file

@ -19,7 +19,11 @@
#include <net/net_ip.h> #include <net/net_ip.h>
#include <net/net_pkt.h> #include <net/net_pkt.h>
#if defined(CONFIG_NET_LLDP)
#include <net/lldp.h> #include <net/lldp.h>
#endif
#include <misc/util.h> #include <misc/util.h>
#include <net/net_if.h> #include <net/net_if.h>
#include <net/ethernet_vlan.h> #include <net/ethernet_vlan.h>

4
include/net/lldp.h
View file

@ -24,8 +24,6 @@
extern "C" { extern "C" {
#endif #endif
#if defined(CONFIG_NET_LLDP)
/* LLDP Definitions */ /* LLDP Definitions */
/* According to the spec, End of LLDPDU TLV value is constant. */ /* According to the spec, End of LLDPDU TLV value is constant. */
@ -198,8 +196,6 @@ int net_lldp_register_callback(struct net_if *iface, net_lldp_recv_cb_t cb);
*/ */
enum net_verdict net_lldp_recv(struct net_if *iface, struct net_pkt *pkt); enum net_verdict net_lldp_recv(struct net_if *iface, struct net_pkt *pkt);
#endif /* CONFIG_NET_LLDP */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif

3
subsys/net/ip/net_core.c
View file

@ -27,7 +27,10 @@ LOG_MODULE_REGISTER(net_core, CONFIG_NET_CORE_LOG_LEVEL);
#include <net/net_core.h> #include <net/net_core.h>
#include <net/dns_resolve.h> #include <net/dns_resolve.h>
#include <net/gptp.h> #include <net/gptp.h>
#if defined(CONFIG_NET_LLDP)
#include <net/lldp.h> #include <net/lldp.h>
#endif
#include "net_private.h" #include "net_private.h"
#include "net_shell.h" #include "net_shell.h"

3
subsys/net/l2/ethernet/ethernet.c
View file

@ -14,7 +14,10 @@ LOG_MODULE_REGISTER(net_ethernet, CONFIG_NET_L2_ETHERNET_LOG_LEVEL);
#include <net/ethernet.h> #include <net/ethernet.h>
#include <net/ethernet_mgmt.h> #include <net/ethernet_mgmt.h>
#include <net/gptp.h> #include <net/gptp.h>
#if defined(CONFIG_NET_LLDP)
#include <net/lldp.h> #include <net/lldp.h>
#endif
#include "arp.h" #include "arp.h"
#include "eth_stats.h" #include "eth_stats.h"

21
subsys/net/l2/ethernet/lldp/Kconfig
View file

@ -15,8 +15,6 @@ config NET_LLDP
Enable Link Layer Discovery Protocol (LLDP) Transmit support. Enable Link Layer Discovery Protocol (LLDP) Transmit support.
Please refer to IEEE Std 802.1AB for more information. Please refer to IEEE Std 802.1AB for more information.
if NET_LLDP
module = NET_LLDP module = NET_LLDP
module-dep = NET_LOG module-dep = NET_LOG
module-str = Log level for LLDP module-str = Log level for LLDP
@ -30,6 +28,7 @@ config NET_LLDP_TX_INTERVAL
int "Time between transmissions in seconds (msgTxInterval)" int "Time between transmissions in seconds (msgTxInterval)"
default 30 default 30
range 1 3600 range 1 3600
depends on NET_LLDP
help help
Interval between transmissions of LLDPDUs during normal Interval between transmissions of LLDPDUs during normal
(non-fast mode) transmission periods. For further information (non-fast mode) transmission periods. For further information
@ -39,6 +38,7 @@ config NET_LLDP_TX_HOLD
int "Multiplier of Tx Interval to result on Time to Live value" int "Multiplier of Tx Interval to result on Time to Live value"
default 4 default 4
range 1 100 range 1 100
depends on NET_LLDP
help help
This value (msgTxHold) is used as a multiplier of This value (msgTxHold) is used as a multiplier of
CONFIG_NET_LLDP_TX_INTERVAL, to determine the value to be used CONFIG_NET_LLDP_TX_INTERVAL, to determine the value to be used
@ -51,6 +51,7 @@ config NET_LLDP_TX_HOLD
config NET_LLDP_END_LLDPDU_TLV_ENABLED config NET_LLDP_END_LLDPDU_TLV_ENABLED
bool "Enable End of LLDPDU TLV" bool "Enable End of LLDPDU TLV"
default y default y
depends on NET_LLDP
help help
Tells whether LLDPDU packet will have marker at the end of the packet. Tells whether LLDPDU packet will have marker at the end of the packet.
@ -61,6 +62,7 @@ config NET_LLDP_CHASSIS_ID_SUBTYPE
int "Chassis ID TLV subtype" int "Chassis ID TLV subtype"
default 4 default 4
range 1 7 range 1 7
depends on NET_LLDP
help help
Chassis ID subtype options are defined below. Chassis ID subtype options are defined below.
Please refer to section 8.5.2.2 of the 802.1AB for more info. Please refer to section 8.5.2.2 of the 802.1AB for more info.
@ -80,6 +82,7 @@ config NET_LLDP_CHASSIS_ID_MAC0
hex "Chassis ID MAC Address Byte 0" hex "Chassis ID MAC Address Byte 0"
default 0x00 default 0x00
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 0 of the MAC address. Byte 0 of the MAC address.
@ -87,6 +90,7 @@ config NET_LLDP_CHASSIS_ID_MAC1
hex "Chassis ID MAC Address Byte 1" hex "Chassis ID MAC Address Byte 1"
default 0x00 default 0x00
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 1 of the MAC address. Byte 1 of the MAC address.
@ -94,6 +98,7 @@ config NET_LLDP_CHASSIS_ID_MAC2
hex "Chassis ID MAC Address Byte 2" hex "Chassis ID MAC Address Byte 2"
default 0x5e default 0x5e
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 2 of the MAC address. Byte 2 of the MAC address.
@ -101,6 +106,7 @@ config NET_LLDP_CHASSIS_ID_MAC3
hex "Chassis ID MAC Address Byte 3" hex "Chassis ID MAC Address Byte 3"
default 0x00 default 0x00
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 3 of the MAC address. Byte 3 of the MAC address.
@ -108,6 +114,7 @@ config NET_LLDP_CHASSIS_ID_MAC4
hex "Chassis ID MAC Address Byte 4" hex "Chassis ID MAC Address Byte 4"
default 0x53 default 0x53
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 4 of the MAC address. Byte 4 of the MAC address.
@ -115,6 +122,7 @@ config NET_LLDP_CHASSIS_ID_MAC5
hex "Chassis ID MAC Address Byte 5" hex "Chassis ID MAC Address Byte 5"
default 0x8d default 0x8d
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 5 of the MAC address. Byte 5 of the MAC address.
endif endif
@ -132,6 +140,7 @@ config NET_LLDP_PORT_ID_SUBTYPE
int "Port ID TLV subtype" int "Port ID TLV subtype"
default 5 default 5
range 1 7 range 1 7
depends on NET_LLDP
help help
Port ID subtype options are defined below. Port ID subtype options are defined below.
Please refer to section 8.5.3.2 of the 802.1AB for more info. Please refer to section 8.5.3.2 of the 802.1AB for more info.
@ -151,6 +160,7 @@ config NET_LLDP_PORT_ID_MAC0
hex "Chassis ID MAC Address Byte 0" hex "Chassis ID MAC Address Byte 0"
default 0x00 default 0x00
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 0 of the MAC address. Byte 0 of the MAC address.
@ -158,6 +168,7 @@ config NET_LLDP_PORT_ID_MAC1
hex "Chassis ID MAC Address Byte 1" hex "Chassis ID MAC Address Byte 1"
default 0x00 default 0x00
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 1 of the MAC address. Byte 1 of the MAC address.
@ -165,6 +176,7 @@ config NET_LLDP_PORT_ID_MAC2
hex "Chassis ID MAC Address Byte 2" hex "Chassis ID MAC Address Byte 2"
default 0x5e default 0x5e
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 2 of the MAC address. Byte 2 of the MAC address.
@ -172,6 +184,7 @@ config NET_LLDP_PORT_ID_MAC3
hex "Chassis ID MAC Address Byte 3" hex "Chassis ID MAC Address Byte 3"
default 0x00 default 0x00
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 3 of the MAC address. Byte 3 of the MAC address.
@ -179,6 +192,7 @@ config NET_LLDP_PORT_ID_MAC4
hex "Chassis ID MAC Address Byte 4" hex "Chassis ID MAC Address Byte 4"
default 0x53 default 0x53
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 4 of the MAC address. Byte 4 of the MAC address.
@ -186,6 +200,7 @@ config NET_LLDP_PORT_ID_MAC5
hex "Chassis ID MAC Address Byte 5" hex "Chassis ID MAC Address Byte 5"
default 0x8d default 0x8d
range 0 0xff range 0 0xff
depends on NET_LLDP
help help
Byte 5 of the MAC address. Byte 5 of the MAC address.
endif endif
@ -196,6 +211,4 @@ config NET_LLDP_PORT_ID
default "PORT_ID_PLACEHOLDER" default "PORT_ID_PLACEHOLDER"
endif endif
endif
endmenu endmenu