Commit 8470f18e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller
Browse files

docs: networking: device drivers: convert ti/cpsw_switchdev.txt to ReST 



- add SPDX header;
- adjust titles and chapters, adding proper markups;
- use :field: markup;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent d6a99873

Documentation/networking/device_drivers/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -47,6 +47,7 @@ Contents: 
   qualcomm/rmnet

   sb1000

   smsc/smc9

   ti/cpsw_switchdev



.. only::  subproject and html

Documentation/networking/device_drivers/ti/cpsw_switchdev.txt→Documentation/networking/device_drivers/ti/cpsw_switchdev.rst

+138 −105
Original line number Diff line number Diff line 
* Texas Instruments CPSW switchdev based ethernet driver 2.0

.. SPDX-License-Identifier: GPL-2.0



======================================================

Texas Instruments CPSW switchdev based ethernet driver

======================================================



:Version: 2.0



Port renaming

=============



- Port renaming

On older udev versions renaming of ethX to swXpY will not be automatically

supported

In order to rename via udev:



In order to rename via udev::



    ip -d link show dev sw0p1 | grep switchid



    SUBSYSTEM=="net", ACTION=="add", ATTR{phys_switch_id}==<switchid>, \

	    ATTR{phys_port_name}!="", NAME="sw0$attr{phys_port_name}"





====================

# Dual mac mode

====================

Dual mac mode

=============



- The new (cpsw_new.c) driver is operating in dual-emac mode by default, thus

  working as 2 individual network interfaces. Main differences from legacy CPSW

  driver are:



 - optimized promiscuous mode: The P0_UNI_FLOOD (both ports) is enabled in

   addition to ALLMULTI (current port) instead of ALE_BYPASS.

So, Ports in promiscuous mode will keep possibility of mcast and vlan filtering,

which is provides significant benefits when ports are joined to the same bridge,

but without enabling "switch" mode, or to different bridges.

   So, Ports in promiscuous mode will keep possibility of mcast and vlan

   filtering, which is provides significant benefits when ports are joined

   to the same bridge, but without enabling "switch" mode, or to different

   bridges.

 - learning disabled on ports as it make not too much sense for

   segregated ports - no forwarding in HW.

 - enabled basic support for devlink.



   ::



	devlink dev show

		platform/48484000.switch
@@ -38,22 +52,25 @@ but without enabling "switch" mode, or to different bridges. 
		cmode runtime value false



Devlink configuration parameters

====================

================================



See Documentation/networking/devlink/ti-cpsw-switch.rst



====================

# Bridging in dual mac mode

====================

Bridging in dual mac mode

=========================



The dual_mac mode requires two vids to be reserved for internal purposes,

which, by default, equal CPSW Port numbers. As result, bridge has to be

configured in vlan unaware mode or default_pvid has to be adjusted.

configured in vlan unaware mode or default_pvid has to be adjusted::



	ip link add name br0 type bridge

	ip link set dev br0 type bridge vlan_filtering 0

	echo 0 > /sys/class/net/br0/bridge/default_pvid

	ip link set dev sw0p1 master br0

	ip link set dev sw0p2 master br0

 - or -



or::



	ip link add name br0 type bridge

	ip link set dev br0 type bridge vlan_filtering 0

	echo 100 > /sys/class/net/br0/bridge/default_pvid
@@ -61,11 +78,12 @@ configured in vlan unaware mode or default_pvid has to be adjusted. 
	ip link set dev sw0p1 master br0

	ip link set dev sw0p2 master br0



====================

# Enabling "switch"

====================

Enabling "switch"

=================



The Switch mode can be enabled by configuring devlink driver parameter

"switch_mode" to 1/true:

"switch_mode" to 1/true::



	devlink dev param set platform/48484000.switch \

	name switch_mode value 1 cmode runtime
@@ -79,9 +97,11 @@ marking packets with offload_fwd_mark flag unless "ale_bypass=0" 


All configuration is implemented via switchdev API.



====================

# Bridge setup

====================

Bridge setup

============



::



	devlink dev param set platform/48484000.switch \

	name switch_mode value 1 cmode runtime
@@ -91,56 +111,65 @@ All configuration is implemented via switchdev API. 
	ip link set dev sw0p2 up

	ip link set dev sw0p1 master br0

	ip link set dev sw0p2 master br0



	[*] bridge vlan add dev br0 vid 1 pvid untagged self



	[*] if vlan_filtering=1. where default_pvid=1



=================

# On/off STP

=================

	Note. Steps [*] are mandatory.





On/off STP

==========



::



	ip link set dev BRDEV type bridge stp_state 1/0



Note. Steps [*] are mandatory.

VLAN configuration

==================



::



====================

# VLAN configuration

====================

  bridge vlan add dev br0 vid 1 pvid untagged self <---- add cpu port to VLAN 1



Note. This step is mandatory for bridge/default_pvid.



=================

# Add extra VLANs

=================

 1. untagged:

Add extra VLANs

===============



 1. untagged::



	bridge vlan add dev sw0p1 vid 100 pvid untagged master

	bridge vlan add dev sw0p2 vid 100 pvid untagged master

	bridge vlan add dev br0 vid 100 pvid untagged self <---- Add cpu port to VLAN100



 2. tagged:

 2. tagged::



	bridge vlan add dev sw0p1 vid 100 master

	bridge vlan add dev sw0p2 vid 100 master

	bridge vlan add dev br0 vid 100 pvid tagged self <---- Add cpu port to VLAN100



====

FDBs

====

----



FDBs are automatically added on the appropriate switch port upon detection



Manually adding FDBs:

Manually adding FDBs::



    bridge fdb add aa:bb:cc:dd:ee:ff dev sw0p1 master vlan 100

    bridge fdb add aa:bb:cc:dd:ee:fe dev sw0p2 master <---- Add on all VLANs



====

MDBs

====

----



MDBs are automatically added on the appropriate switch port upon detection



Manually adding MDBs:

Manually adding MDBs::



  bridge mdb add dev br0 port sw0p1 grp 239.1.1.1 permanent vid 100

  bridge mdb add dev br0 port sw0p1 grp 239.1.1.1 permanent <---- Add on all VLANs



==================

Multicast flooding

==================

CPU port mcast_flooding is always on
@@ -148,9 +177,11 @@ CPU port mcast_flooding is always on 
Turning flooding on/off on swithch ports:

bridge link set dev sw0p1 mcast_flood on/off



==================

Access and Trunk port

==================

=====================



::



 bridge vlan add dev sw0p1 vid 100 pvid untagged master

 bridge vlan add dev sw0p2 vid 100 master
@@ -161,15 +192,16 @@ Access and Trunk port 
Note. Setting PVID on Bridge device itself working only for

default VLAN (default_pvid).



=====================

NFS

=====================

===



The only way for NFS to work is by chrooting to a minimal environment when

switch configuration that will affect connectivity is needed.

Assuming you are booting NFS with eth1 interface(the script is hacky and

it's just there to prove NFS is doable).



setup.sh:

setup.sh::



	#!/bin/sh

	mkdir proc

	mount -t proc none /proc
@@ -192,7 +224,8 @@ if [ $? -ne 0 ]; then 
	fi

	umount /proc



run_nfs.sh:

run_nfs.sh:::



	#!/bin/sh

	mkdir /tmp/root/bin -p

	mkdir /tmp/root/lib -p

CRA Git | Maintained and supported by SUSTech CRA and CCSE