Differential D32476 Diff 96955 share/man/man4/arswitch.4

Changeset View

Standalone View

View Options

share/man/man4/arswitch.4

This file was added.

.\"-

.\"

.\" 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 October 16, 2021

.Dt ARSWITCH 4

debdrupUnsubmitted

Not Done

Remember to bump .Dd when this gets commited.

debdrup: Remember to bump .Dd when this gets commited.

.Os

.Sh NAME

.Nm arswitch

.Nd driver for Atheros Fast Ethernet switch

.Sh SYNOPSIS

.Cd "device mdio"

.Cd "device etherswitch"

.Cd "device arswitch"

.Sh DESCRIPTION

The

.Nm

impUnsubmitted

Done

I'd delete these, or document them.

imp: I'd delete these, or document them.

device driver provides a management interface to multiple Atheros

fast ethernet switch chips:

.Bl -tag -compact -width "AR7240"

.It AR7240

Wireless Network Processor SOC with five Fast Ethernet PHYs

.It AR8216

Fast Ethernet Switch

.It AR8226

.It AR8316

Six-port Gigabit Ethernet Switch

.It AR8327

Seven-port Gigabit Ethernet Switch

.It AR9340

Wireless networking SoC

.El

.Pp

The driver uses an

debdrupUnsubmitted

Not Done

This sentence needs to be reworked a bit, as it's missing an article, has RAS Syndrome, and it's not entirely clear what the meaning of it is (so I'm having trouble coming up with suggestions).

debdrup: This sentence needs to be reworked a bit, as it's missing an article, has RAS Syndrome, and…

.Xr mdio 4

.Xr miibus 4

debdrupUnsubmitted

Not Done

Is this sentence connected to the above? If it is, the above one should probably end with a comma.

debdrup: Is this sentence connected to the above? If it is, the above one should probably end with a…

interface to configure the ethernet interface.

.Pp

This driver supports port based vlan, and

IEEE 802.1Q (QinQ).

debdrupUnsubmitted

Not Done

.Sh EXAMPLES

- Configure dot1q vlan by etherswitchcfg command.

+ Configure dot1q vlan with the

+ .Xr etherswitchcfg 1

+ command.

.Pp

.Dl # etherswitchcfg config vlan_mode dot1q

debdrup:

These options can be configured with the

.Xr etherswitchcfg 8

command.

.Nm

debdrupUnsubmitted

Not Done

.Dl # etherswitchcfg config vlan_mode dot1q

.Pp

- Configure port 5 is tagging port.

+ Configure port 5 as tagging port.

.Pp

.Dl # etherswitchcfg port5 addtag

debdrup:

supports

.Dv addtag ,

.Dv striptag ,

and

.Dv doubletag.

.Dv addtag

and

.Dv striptag

are mutually exclusive.

.Pp

Setting the switch MAC address is not supported.

.Sh SEE ALSO

.Xr etherswitch 4 ,

.Xr etherswitchcfg 8

.Sh HISTORY

The

.Nm

device driver first appeared in

.Fx 12.0 .

impUnsubmitted

Done

I'd leave this whole section out.

imp: I'd leave this whole section out.

.Sh AUTHORS

The

.Nm

manual was written by

.An Felix Johnson.