xref: /freebsd/share/man/man4/man4.aarch64/felix.4 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" -
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2021 Alstom Group.
5.\" Copyright (c) 2021 Semihalf.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd June 21, 2021
29.Dt FELIX 4
30.Os
31.Sh NAME
32.Nm felix
33.Nd "driver for Microchip Ocelot Felix switch"
34.Sh SYNOPSIS
35To compile this driver into the kernel the following lines must be present
36in the kernel configuration file:
37.sp
38.Cd "options SOC_NXP_LS"
39.Cd "device pci"
40.Cd "device fdt"
41.Cd "device mdio"
42.Cd "device enetc"
43.Cd "device etherswitch"
44.Cd "device felix"
45.Sh DESCRIPTION
46The
47.Nm
48driver provides a management interface to Microchip Ocelot Felix switch (VSC9959)
49found in NXP LS1028A SoC. It is a PCI device, part of the larger ENETC
50root complex. The driver is using
51.Xr etherswitch 4
52framework.
53.Pp
54This driver supports only dot1q vlan. dot1q support port base addtag, striptag,
55dropuntagged, dropuntagged.
56.Sh EXAMPLES
57Configure dot1q vlan by etherswitchcfg command.
58.Pp
59.Dl # etherswitchcfg config vlan_mode dot1q
60.Pp
61Configure port 5 is tagging port.
62.Pp
63.Dl # etherswitchcfg port5 addtag
64.Pp
65Disable port 5 is tagging port.
66.Pp
67.Dl # etherswitchcfg port5 -addtag
68.Sh SEE ALSO
69.Xr etherswitch 4 ,
70.Xr etherswitchcfg 8
71.Sh HISTORY
72The
73.Nm
74device driver first appeared in
75.Fx 14.0 .
76.Sh AUTHORS
77The
78.Nm
79driver was written by
80.An Kornel Duleba (mindal@semihalf.com)
81and
82.An Lukasz Hajec (lha@semihalf.com)
83
84