xref: /freebsd/share/man/man4/etherswitch.4 (revision 924226fba12cc9a228c73b956e1b7fa24c60b055)
1.\" Copyright (c) 2015 Christian Brueffer
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd April 5, 2017
28.Dt ETHERSWITCH 4
29.Os
30.Sh NAME
31.Nm etherswitch
32.Nd "Ethernet switch framework"
33.Sh SYNOPSIS
34To compile the framework into the kernel,
35place the following lines in the
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device etherswitch"
39.Cd "device miiproxy"
40.Cd "device iicbus"
41.Ed
42.Sh DESCRIPTION
43The
44.Nm
45driver provides a framework for Ethernet switch devices.
46.Sh FILES
47.Bl -tag -width ".Pa /dev/etherswitch?" -compact
48.It Pa /dev/etherswitch?
49.Nm
50device nodes
51.El
52.Sh SEE ALSO
53.Xr arswitch 4 ,
54.Xr iicbus 4 ,
55.Xr ip17x 4 ,
56.Xr rtl8366rb 4 ,
57.Xr e6060sw 4 ,
58.Xr adm6996fc 4 ,
59.Xr ksz8995ma 4 ,
60.Xr ukswitch 4 ,
61.Xr etherswitchcfg 8
62.Sh HISTORY
63The
64.Nm
65framework first appeared in
66.Fx 10.0 .
67.Sh AUTHORS
68.An Stefan Bethke
69