net: bridge: add document for IFLA_BR enum (8ebe0661) · Commits · git / linux-net

include/uapi/linux/if_link.h

+280 −0

Original line number	Diff line number	Diff line
		@@ -461,6 +461,286 @@ enum in6_addr_gen_mode {

		/* Bridge section */

		/**
		* DOC: Bridge enum definition
		*
		* Please note that the timer values in the following section are expected
		* in clock_t format, which is seconds multiplied by USER_HZ (generally
		* defined as 100).
		*
		* @IFLA_BR_FORWARD_DELAY
		* The bridge forwarding delay is the time spent in LISTENING state
		* (before moving to LEARNING) and in LEARNING state (before moving
		* to FORWARDING). Only relevant if STP is enabled.
		*
		* The valid values are between (2 * USER_HZ) and (30 * USER_HZ).
		* The default value is (15 * USER_HZ).
		*
		* @IFLA_BR_HELLO_TIME
		* The time between hello packets sent by the bridge, when it is a root
		* bridge or a designated bridge. Only relevant if STP is enabled.
		*
		* The valid values are between (1 * USER_HZ) and (10 * USER_HZ).
		* The default value is (2 * USER_HZ).
		*
		* @IFLA_BR_MAX_AGE
		* The hello packet timeout is the time until another bridge in the
		* spanning tree is assumed to be dead, after reception of its last hello
		* message. Only relevant if STP is enabled.
		*
		* The valid values are between (6 * USER_HZ) and (40 * USER_HZ).
		* The default value is (20 * USER_HZ).
		*
		* @IFLA_BR_AGEING_TIME
		* Configure the bridge's FDB entries aging time. It is the time a MAC
		* address will be kept in the FDB after a packet has been received from
		* that address. After this time has passed, entries are cleaned up.
		* Allow values outside the 802.1 standard specification for special cases:
		*
		* * 0 - entry never ages (all permanent)
		* * 1 - entry disappears (no persistence)
		*
		* The default value is (300 * USER_HZ).
		*
		* @IFLA_BR_STP_STATE
		* Turn spanning tree protocol on (IFLA_BR_STP_STATE > 0) or off
		* (IFLA_BR_STP_STATE == 0) for this bridge.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_PRIORITY
		* Set this bridge's spanning tree priority, used during STP root bridge
		* election.
		*
		* The valid values are between 0 and 65535.
		*
		* @IFLA_BR_VLAN_FILTERING
		* Turn VLAN filtering on (IFLA_BR_VLAN_FILTERING > 0) or off
		* (IFLA_BR_VLAN_FILTERING == 0). When disabled, the bridge will not
		* consider the VLAN tag when handling packets.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_VLAN_PROTOCOL
		* Set the protocol used for VLAN filtering.
		*
		* The valid values are 0x8100(802.1Q) or 0x88A8(802.1AD). The default value
		* is 0x8100(802.1Q).
		*
		* @IFLA_BR_GROUP_FWD_MASK
		* The group forwarding mask. This is the bitmask that is applied to
		* decide whether to forward incoming frames destined to link-local
		* addresses (of the form 01:80:C2:00:00:0X).
		*
		* The default value is 0, which means the bridge does not forward any
		* link-local frames coming on this port.
		*
		* @IFLA_BR_ROOT_ID
		* The bridge root id, read only.
		*
		* @IFLA_BR_BRIDGE_ID
		* The bridge id, read only.
		*
		* @IFLA_BR_ROOT_PORT
		* The bridge root port, read only.
		*
		* @IFLA_BR_ROOT_PATH_COST
		* The bridge root path cost, read only.
		*
		* @IFLA_BR_TOPOLOGY_CHANGE
		* The bridge topology change, read only.
		*
		* @IFLA_BR_TOPOLOGY_CHANGE_DETECTED
		* The bridge topology change detected, read only.
		*
		* @IFLA_BR_HELLO_TIMER
		* The bridge hello timer, read only.
		*
		* @IFLA_BR_TCN_TIMER
		* The bridge tcn timer, read only.
		*
		* @IFLA_BR_TOPOLOGY_CHANGE_TIMER
		* The bridge topology change timer, read only.
		*
		* @IFLA_BR_GC_TIMER
		* The bridge gc timer, read only.
		*
		* @IFLA_BR_GROUP_ADDR
		* Set the MAC address of the multicast group this bridge uses for STP.
		* The address must be a link-local address in standard Ethernet MAC address
		* format. It is an address of the form 01:80:C2:00:00:0X, with X in [0, 4..f].
		*
		* The default value is 0.
		*
		* @IFLA_BR_FDB_FLUSH
		* Flush bridge's fdb dynamic entries.
		*
		* @IFLA_BR_MCAST_ROUTER
		* Set bridge's multicast router if IGMP snooping is enabled.
		* The valid values are:
		*
		* * 0 - disabled.
		* * 1 - automatic (queried).
		* * 2 - permanently enabled.
		*
		* The default value is 1.
		*
		* @IFLA_BR_MCAST_SNOOPING
		* Turn multicast snooping on (IFLA_BR_MCAST_SNOOPING > 0) or off
		* (IFLA_BR_MCAST_SNOOPING == 0).
		*
		* The default value is 1.
		*
		* @IFLA_BR_MCAST_QUERY_USE_IFADDR
		* If enabled use the bridge's own IP address as source address for IGMP
		* queries (IFLA_BR_MCAST_QUERY_USE_IFADDR > 0) or the default of 0.0.0.0
		* (IFLA_BR_MCAST_QUERY_USE_IFADDR == 0).
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_MCAST_QUERIER
		* Enable (IFLA_BR_MULTICAST_QUERIER > 0) or disable
		* (IFLA_BR_MULTICAST_QUERIER == 0) IGMP querier, ie sending of multicast
		* queries by the bridge.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_MCAST_HASH_ELASTICITY
		* Set multicast database hash elasticity, It is the maximum chain length in
		* the multicast hash table. This attribute is deprecated and the value
		* is always 16.
		*
		* @IFLA_BR_MCAST_HASH_MAX
		* Set maximum size of the multicast hash table
		*
		* The default value is 4096, the value must be a power of 2.
		*
		* @IFLA_BR_MCAST_LAST_MEMBER_CNT
		* The Last Member Query Count is the number of Group-Specific Queries
		* sent before the router assumes there are no local members. The Last
		* Member Query Count is also the number of Group-and-Source-Specific
		* Queries sent before the router assumes there are no listeners for a
		* particular source.
		*
		* The default value is 2.
		*
		* @IFLA_BR_MCAST_STARTUP_QUERY_CNT
		* The Startup Query Count is the number of Queries sent out on startup,
		* separated by the Startup Query Interval.
		*
		* The default value is 2.
		*
		* @IFLA_BR_MCAST_LAST_MEMBER_INTVL
		* The Last Member Query Interval is the Max Response Time inserted into
		* Group-Specific Queries sent in response to Leave Group messages, and
		* is also the amount of time between Group-Specific Query messages.
		*
		* The default value is (1 * USER_HZ).
		*
		* @IFLA_BR_MCAST_MEMBERSHIP_INTVL
		* The interval after which the bridge will leave a group, if no membership
		* reports for this group are received.
		*
		* The default value is (260 * USER_HZ).
		*
		* @IFLA_BR_MCAST_QUERIER_INTVL
		* The interval between queries sent by other routers. if no queries are
		* seen after this delay has passed, the bridge will start to send its own
		* queries (as if IFLA_BR_MCAST_QUERIER_INTVL was enabled).
		*
		* The default value is (255 * USER_HZ).
		*
		* @IFLA_BR_MCAST_QUERY_INTVL
		* The Query Interval is the interval between General Queries sent by
		* the Querier.
		*
		* The default value is (125 * USER_HZ). The minimum value is (1 * USER_HZ).
		*
		* @IFLA_BR_MCAST_QUERY_RESPONSE_INTVL
		* The Max Response Time used to calculate the Max Resp Code inserted
		* into the periodic General Queries.
		*
		* The default value is (10 * USER_HZ).
		*
		* @IFLA_BR_MCAST_STARTUP_QUERY_INTVL
		* The interval between queries in the startup phase.
		*
		* The default value is (125 * USER_HZ) / 4. The minimum value is (1 * USER_HZ).
		*
		* @IFLA_BR_NF_CALL_IPTABLES
		* Enable (NF_CALL_IPTABLES > 0) or disable (NF_CALL_IPTABLES == 0)
		* iptables hooks on the bridge.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_NF_CALL_IP6TABLES
		* Enable (NF_CALL_IP6TABLES > 0) or disable (NF_CALL_IP6TABLES == 0)
		* ip6tables hooks on the bridge.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_NF_CALL_ARPTABLES
		* Enable (NF_CALL_ARPTABLES > 0) or disable (NF_CALL_ARPTABLES == 0)
		* arptables hooks on the bridge.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_VLAN_DEFAULT_PVID
		* VLAN ID applied to untagged and priority-tagged incoming packets.
		*
		* The default value is 1. Setting to the special value 0 makes all ports of
		* this bridge not have a PVID by default, which means that they will
		* not accept VLAN-untagged traffic.
		*
		* @IFLA_BR_PAD
		* Bridge attribute padding type for netlink message.
		*
		* @IFLA_BR_VLAN_STATS_ENABLED
		* Enable (IFLA_BR_VLAN_STATS_ENABLED == 1) or disable
		* (IFLA_BR_VLAN_STATS_ENABLED == 0) per-VLAN stats accounting.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_MCAST_STATS_ENABLED
		* Enable (IFLA_BR_MCAST_STATS_ENABLED > 0) or disable
		* (IFLA_BR_MCAST_STATS_ENABLED == 0) multicast (IGMP/MLD) stats
		* accounting.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_MCAST_IGMP_VERSION
		* Set the IGMP version.
		*
		* The valid values are 2 and 3. The default value is 2.
		*
		* @IFLA_BR_MCAST_MLD_VERSION
		* Set the MLD version.
		*
		* The valid values are 1 and 2. The default value is 1.
		*
		* @IFLA_BR_VLAN_STATS_PER_PORT
		* Enable (IFLA_BR_VLAN_STATS_PER_PORT == 1) or disable
		* (IFLA_BR_VLAN_STATS_PER_PORT == 0) per-VLAN per-port stats accounting.
		* Can be changed only when there are no port VLANs configured.
		*
		* The default value is 0 (disabled).
		*
		* @IFLA_BR_MULTI_BOOLOPT
		* The multi_boolopt is used to control new boolean options to avoid adding
		* new netlink attributes. You can look at ``enum br_boolopt_id`` for those
		* options.
		*
		* @IFLA_BR_MCAST_QUERIER_STATE
		* Bridge mcast querier states, read only.
		*
		* @IFLA_BR_FDB_N_LEARNED
		* The number of dynamically learned FDB entries for the current bridge,
		* read only.
		*
		* @IFLA_BR_FDB_MAX_LEARNED
		* Set the number of max dynamically learned FDB entries for the current
		* bridge.
		*/
		enum {
		IFLA_BR_UNSPEC,
		IFLA_BR_FORWARD_DELAY,