Commit bcc1f84e authored by Hangbin Liu's avatar Hangbin Liu Committed by Paolo Abeni
Browse files

docs: bridge: Add kAPI/uAPI fields 



Add kAPI/uAPI field for bridge doc. Update struct net_bridge_vlan
comments to fix doc build warning.

Reviewed-by: default avatarFlorian Fainelli <florian.fainelli@broadcom.com>
Signed-off-by: default avatarHangbin Liu <liuhangbin@gmail.com>
Acked-by: default avatarNikolay Aleksandrov <razor@blackwall.org>
Signed-off-by: default avatarPaolo Abeni <pabeni@redhat.com>
parent 8c4bafdb

Documentation/networking/bridge.rst

+33 −0
Original line number Diff line number Diff line
@@ -14,6 +14,39 @@ at the data link layer (Layer 2) of the OSI (Open Systems Interconnection) 
model. The purpose of a bridge is to filter and forward frames between

different segments based on the destination MAC (Media Access Control) address.



Bridge kAPI

===========



Here are some core structures of bridge code. Note that the kAPI is *unstable*,

and can be changed at any time.



.. kernel-doc:: net/bridge/br_private.h

   :identifiers: net_bridge_vlan



Bridge uAPI

===========



Modern Linux bridge uAPI is accessed via Netlink interface. You can find

below files where the bridge and bridge port netlink attributes are defined.



Bridge netlink attributes

-------------------------



.. kernel-doc:: include/uapi/linux/if_link.h

   :doc: Bridge enum definition



Bridge port netlink attributes

------------------------------



.. kernel-doc:: include/uapi/linux/if_link.h

   :doc: Bridge port enum definition



Bridge sysfs

------------



The sysfs interface is deprecated and should not be extended if new

options are added.



FAQ

===

net/bridge/br_private.h

+2 −0
Original line number Diff line number Diff line
@@ -186,6 +186,7 @@ enum { 
 * struct net_bridge_vlan - per-vlan entry

 *

 * @vnode: rhashtable member

 * @tnode: rhashtable member

 * @vid: VLAN id

 * @flags: bridge vlan flags

 * @priv_flags: private (in-kernel) bridge vlan flags
@@ -196,6 +197,7 @@ enum { 
 * @refcnt: if MASTER flag set, this is bumped for each port referencing it

 * @brvlan: if MASTER flag unset, this points to the global per-VLAN context

 *          for this VLAN entry

 * @tinfo: bridge tunnel info

 * @br_mcast_ctx: if MASTER flag set, this is the global vlan multicast context

 * @port_mcast_ctx: if MASTER flag unset, this is the per-port/vlan multicast

 *                  context