doc: Add top-level description about U-Boot documentation
[platform/kernel/u-boot.git] / doc / README.t1040-l2switch
1 This file contains information for VSC9953, a Vitesse L2 Switch IP
2 which is integrated in the T1040/T1020 Freescale SoCs.
3
4 About Device:
5 =============
6 VSC9953 is an 8-port Gigabit Ethernet switch supports the following features:
7         -       8192 MAC addresses
8         -       Static Address provisioning
9         -       Dynamic learning of MAC addresses and aging
10         -       4096 VLANs
11         -       Independent and shared VLAN learning (IVL, SVL)
12         -       Policing with storm control and MC/BC protection
13         -       IPv4 and IPv6 multicast
14         -       Jumbo frames (9.6 KB)
15         -       Access Control List
16         -       VLAN editing, translation and remarking
17         -       RMON counters per port
18
19 Switch interfaces:
20         -       8 Gigabit switch ports (ports 0 to 7) are external and are connected to external PHYs
21         -       2 switch ports (ports 8 and 9) of 2.5 G are connected (fixed links)
22                 to FMan ports (FM1@DTSEC1 and FM1@DTSEC2)
23
24 Commands Overview:
25 =============
26 Commands supported
27         - enable/disable a port or show its configuration (speed, duplexity, status, etc.)
28         - port statistics
29         - MAC learning
30         - add/remove FDB entries
31         - Port-based VLAN
32         - Private/Shared VLAN learning
33         - VLAN ingress filtering
34         - Port LAG
35
36 Commands syntax
37 ethsw [port <port_no>] { enable | disable | show } - enable/disable a port; show a port's configuration
38 ethsw [port <port_no>] statistics { [help] | [clear] } - show an l2 switch port's statistics
39 ethsw [port <port_no>] learning { [help] | show | auto | disable } - enable/disable/show learning configuration on a port
40 ethsw [port <port_no>] [vlan <vid>] fdb { [help] | show | flush | { add | del } <mac> } - add/delete a mac entry in FDB; use show to see FDB entries;
41                                                                                           if [vlan <vid>] is missing, VID 1 will be used
42 ethsw [port <port_no>] pvid { [help] | show | <pvid> } - set/show PVID (ingress and egress VLAN tagging) for a port
43 ethsw [port <port_no>] vlan { [help] | show | add <vid> | del <vid> } - add a VLAN to a port (VLAN members)
44 ethsw [port <port_no>] untagged { [help] | show | all | none | pvid } - set egress tagging mode for a port
45 ethsw [port <port_no>] egress tag { [help] | show | pvid | classified } - configure VID source for egress tag.
46                                                                           Tag's VID could be the frame's classified VID or the PVID of the port
47 ethsw vlan fdb { [help] | show | shared | private } - make VLAN learning shared or private
48 ethsw [port <port_no>] ingress filtering { [help] | show | enable | disable } - enable/disable VLAN ingress filtering on port
49 ethsw [port <port_no>] aggr { [help] | show | <lag_group_no> } - get/set LAG group for a port
50
51 => ethsw show
52     Port   Status     Link    Speed   Duplex
53        0  enabled     down       10     half
54        1  enabled     down       10     half
55        2  enabled     down       10     half
56        3  enabled       up     1000     full
57        4 disabled     down        -     half
58        5 disabled     down        -     half
59        6 disabled     down        -     half
60        7 disabled     down        -     half
61        8  enabled       up     2500     full
62        9  enabled       up     2500     full
63 =>