Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/adm6996fc.4
- This file was copied from share/man/man4/etherswitch.4.
| .\" Copyright (c) 2015 Christian Brueffer | .\"- | ||||
| .\" Copyright (c) 2017 Hiroki Mori | |||||
| .\" All rights reserved. | .\" All rights reserved. | ||||
| .\" | .\" | ||||
| .\" Redistribution and use in source and binary forms, with or without | .\" Redistribution and use in source and binary forms, with or without | ||||
| .\" modification, are permitted provided that the following conditions | .\" modification, are permitted provided that the following conditions | ||||
| .\" are met: | .\" are met: | ||||
| .\" 1. Redistributions of source code must retain the above copyright | .\" 1. Redistributions of source code must retain the above copyright | ||||
| .\" notice, this list of conditions and the following disclaimer. | .\" notice, this list of conditions and the following disclaimer. | ||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | .\" 2. Redistributions in binary form must reproduce the above copyright | ||||
| Show All 9 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd January 5, 2015 | .Dd April 5, 2017 | ||||
| .Dt ETHERSWITCH 4 | .Dt ADM6996FC 4 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm etherswitch | .Nm adm6996fc | ||||
| .Nd "Ethernet switch framework" | .Nd driver for Infineon ADM6996FC fast ethernet switch chip | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| To compile the framework into the kernel, | .Cd "device mdio" | ||||
| place the following lines in the | |||||
| kernel configuration file: | |||||
| .Bd -ragged -offset indent | |||||
| .Cd "device etherswitch" | .Cd "device etherswitch" | ||||
| .Cd "device miiproxy" | .Cd "device adm6996fc" | ||||
| .Cd "device iicbus" | .Pp | ||||
| .Ed | .Cd hint.adm6996fc.0.at="mdio0" | ||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| driver provides a framework for Ethernet switch devices. | device driver provides a management interface to Infineon ADM6996FC fast ethernet switch chip. This driver use smi interface by ethernet interface. | ||||
bcr: You need to have a hard line break after the sentence stop (after //chip//).
Also, I would… | |||||
| .Sh FILES | .Pp | ||||
Not Done Inline ActionsCan you explain further? Is the case here that adm6996fc is connected by SMI to some (other) Ethernet interface in the system, and configured over SMI? Also, should expand acronym on first use, e.g. the Serial Management Interface (SMI) emaste: Can you explain further? Is the case here that adm6996fc is connected by SMI to some (other)… | |||||
| .Bl -tag -width ".Pa /dev/etherswitch?" -compact | This driver support is port and dot1q vlan. dot1q support port base tag/untag. | ||||
bcrUnsubmitted Not Done Inline ActionsThis driver supports port and dot1q vlan. Also, line break after the sentence stop. bcr: This driver support**s** port and dot1q vlan. Also, line break after the sentence stop. | |||||
| .It Pa /dev/etherswitch? | .Sh EXAMPLES | ||||
| .Nm | Configure dot1q vlan by etherswitchcfg command. | ||||
bcrUnsubmitted Not Done Inline ActionsConfigure dot1q vlan with the etherswitchcfg command. bcr: Configure dot1q vlan with the etherswitchcfg command. | |||||
| device nodes | .Pp | ||||
| .El | .Dl # etherswitchcfg config vlan_mode dot1q | ||||
| .Pp | |||||
| Configure port 5 is tagging port. | |||||
bcrUnsubmitted Not Done Inline ActionsConfigure port 5 as the tagging port. bcr: Configure port 5 **as the** tagging port. | |||||
| .Pp | |||||
| .Dl # etherswitchcfg port5 addtag | |||||
Not Done Inline Actionsto /the/ Infineon emaste: to /the/ Infineon | |||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr arswitch 4 , | .Xr etherswitch 4 , | ||||
| .Xr iicbus 4 , | |||||
| .Xr ip17x 4 , | |||||
| .Xr rtl8366rb 4 , | |||||
| .Xr ukswitch 4 , | |||||
| .Xr etherswitchcfg 8 | .Xr etherswitchcfg 8 | ||||
| .Sh HISTORY | .Sh HISTORY | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| framework first appeared in | device driver first appeared in | ||||
| .Fx 10.0 . | .Fx 12.0 . | ||||
| .Sh AUTHORS | .Sh AUTHORS | ||||
| .An Stefan Bethke | The | ||||
| .Nm | |||||
| driver was written by | |||||
| .An Hiroki Mori | |||||
You need to have a hard line break after the sentence stop (after chip).
Also, I would rephrase the next sentence to this:
This driver uses the smi interface of the ethernet interface. (Not sure what you mean by "by ethernet interface").