[etherswitch] add manpages for etherswitch supported devices.
Submitted by: Hiroki Mori <yamori813@yahoo.co.jp> Reviewed by: mizhka Differential Revision: https://reviews.freebsd.org/D10278
This commit is contained in:
Adrian Chadd
parent
a99badc23e
commit
52d3eee999
@ -22,6 +22,7 @@ MAN= aac.4 \
|
||||
acpi_video.4 \
|
||||
${_acpi_wmi.4} \
|
||||
ada.4 \
|
||||
adm6996fc.4 \
|
||||
adv.4 \
|
||||
adw.4 \
|
||||
ae.4 \
|
||||
@ -152,6 +153,7 @@ MAN= aac.4 \
|
||||
etherswitch.4 \
|
||||
eventtimers.4 \
|
||||
exca.4 \
|
||||
e6060sw.4 \
|
||||
fd.4 \
|
||||
fdc.4 \
|
||||
fdt.4 \
|
||||
@ -245,6 +247,7 @@ MAN= aac.4 \
|
||||
keyboard.4 \
|
||||
kld.4 \
|
||||
ksyms.4 \
|
||||
ksz8995ma.4 \
|
||||
ktr.4 \
|
||||
kue.4 \
|
||||
lagg.4 \
|
||||
|
||||
68
share/man/man4/adm6996fc.4
Normal file
68
share/man/man4/adm6996fc.4
Normal file
@ -0,0 +1,68 @@
|
||||
.\"-
|
||||
.\" Copyright (c) 2017 Hiroki Mori
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd April 5, 2017
|
||||
.Dt ADM6996FC 4
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm adm6996fc
|
||||
.Nd driver for Infineon ADM6996FC fast ethernet switch chip
|
||||
.Sh SYNOPSIS
|
||||
.Cd "device mdio"
|
||||
.Cd "device etherswitch"
|
||||
.Cd "device adm6996fc"
|
||||
.Pp
|
||||
.Cd hint.adm6996fc.0.at="mdio0"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
device driver provides a management interface to Infineon ADM6996FC fast ethernet switch chip.
|
||||
This driver use smi interface by ethernet interface.
|
||||
.Pp
|
||||
This driver support is port and dot1q vlan.
|
||||
dot1q support port base tag/untag.
|
||||
.Sh EXAMPLES
|
||||
Configure dot1q vlan by etherswitchcfg command.
|
||||
.Pp
|
||||
.Dl # etherswitchcfg config vlan_mode dot1q
|
||||
.Pp
|
||||
Configure port 5 is tagging port.
|
||||
.Pp
|
||||
.Dl # etherswitchcfg port5 addtag
|
||||
.Sh SEE ALSO
|
||||
.Xr etherswitch 4 ,
|
||||
.Xr etherswitchcfg 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
device driver first appeared in
|
||||
.Fx 12.0 .
|
||||
.Sh AUTHORS
|
||||
The
|
||||
.Nm
|
||||
driver was written by
|
||||
.An Hiroki Mori
|
||||
70
share/man/man4/e6060sw.4
Normal file
70
share/man/man4/e6060sw.4
Normal file
@ -0,0 +1,70 @@
|
||||
.\"-
|
||||
.\" Copyright (c) 2017 Hiroki Mori
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd April 5, 2017
|
||||
.Dt E6060SW 4
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm e6060sw
|
||||
.Nd driver for Marvell 88E6060 and 88E6065 fast ethernet switch chip
|
||||
.Sh SYNOPSIS
|
||||
.Cd "device mdio"
|
||||
.Cd "device etherswitch"
|
||||
.Cd "device e6060sw"
|
||||
.Pp
|
||||
.Cd hint.e6060sw.0.at="mdio0"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
device driver provides a management interface to Marvell 88E6060 and 88E6065 fast ethernet switch chip.
|
||||
This driver use smi interface by ethernet interface.
|
||||
.Pp
|
||||
88E6060 support is only port vlan.
|
||||
88E6065 support is port and dot1q vlan.
|
||||
dot1q support group base tag/untag.
|
||||
.Sh EXAMPLES
|
||||
Configure dot1q vlan on 88E6065 by etherswitchcfg command.
|
||||
.Pp
|
||||
.Dl # etherswitchcfg config vlan_mode dot1q
|
||||
.Pp
|
||||
Configure vlangroup with dot1q tag on 88E6065.
|
||||
This example is port0 as vlan 2.
|
||||
.Pp
|
||||
.Dl # etherswitchcfg vlangroup2 vlan 2 members 0,5t port0 pvid 2
|
||||
.Sh SEE ALSO
|
||||
.Xr etherswitch 4 ,
|
||||
.Xr etherswitchcfg 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
device driver first appeared in
|
||||
.Fx 12.0 .
|
||||
.Sh AUTHORS
|
||||
The
|
||||
.Nm
|
||||
driver was written by
|
||||
.An Hiroki Mori
|
||||
@ -24,7 +24,7 @@
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd January 5, 2015
|
||||
.Dd April 5, 2017
|
||||
.Dt ETHERSWITCH 4
|
||||
.Os
|
||||
.Sh NAME
|
||||
@ -54,6 +54,9 @@ device nodes
|
||||
.Xr iicbus 4 ,
|
||||
.Xr ip17x 4 ,
|
||||
.Xr rtl8366rb 4 ,
|
||||
.Xr e6060sw 4 ,
|
||||
.Xr adm6996fc 4 ,
|
||||
.Xr ksz8995ma 4 ,
|
||||
.Xr ukswitch 4 ,
|
||||
.Xr etherswitchcfg 8
|
||||
.Sh HISTORY
|
||||
|
||||
69
share/man/man4/ksz8995ma.4
Normal file
69
share/man/man4/ksz8995ma.4
Normal file
@ -0,0 +1,69 @@
|
||||
.\"-
|
||||
.\" Copyright (c) 2017 Hiroki Mori
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd April 6, 2017
|
||||
.Dt KSZ8995MA 4
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ksz8995ma
|
||||
.Nd driver for Micrel KSZ8995MA fast ethernet switch chip
|
||||
.Sh SYNOPSIS
|
||||
.Cd "device spibus"
|
||||
.Cd "device etherswitch"
|
||||
.Cd "device ksz8995ma"
|
||||
.Pp
|
||||
.Cd hint.ksz8995ma.0.at="spibus0"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
device driver provides a management interface to Micrel KSZ8995MA fast ethernet switch chip.
|
||||
This driver use spi interface.
|
||||
KSZ8995 series have many vertion but only support MA/FQ version.
|
||||
.Pp
|
||||
This driver support is port and dot1q vlan.
|
||||
dot1q support port base tag/untag.
|
||||
.Sh EXAMPLES
|
||||
Configure dot1q vlan by etherswitchcfg command.
|
||||
.Pp
|
||||
.Dl # etherswitchcfg config vlan_mode dot1q
|
||||
.Pp
|
||||
Configure port 5 is tagging port.
|
||||
.Pp
|
||||
.Dl # etherswitchcfg port5 addtag
|
||||
.Sh SEE ALSO
|
||||
.Xr etherswitch 4 ,
|
||||
.Xr etherswitchcfg 8
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
device driver first appeared in
|
||||
.Fx 12.0 .
|
||||
.Sh AUTHORS
|
||||
The
|
||||
.Nm
|
||||
driver was written by
|
||||
.An Hiroki Mori
|
||||
Loading…
Reference in New Issue
Block a user