Skip to content

Commit

Permalink
update some man pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
laffer1 committed Sep 20, 2021
1 parent 09fa9a1 commit 7afc6ec
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 37 deletions.
6 changes: 3 additions & 3 deletions share/man/man4/apic.4
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: stable/11/share/man/man4/apic.4 301589 2016-06-08 08:50:35Z trasz $
.\" $FreeBSD$
.\"
.Dd December 20, 2011
.Dd June 19, 2020
.Dt APIC 4
.Os
.Sh NAME
Expand Down Expand Up @@ -64,7 +64,7 @@ they receive from peripheral buses to one or more local APICs.
.Pp
Each local APIC includes one 32-bit programmable timer.
This driver uses them to supply kernel with one event timer named "LAPIC".
Event timer provided by the driver supports both one-shot an periodic modes.
Event timer provided by the driver supports both one-shot and periodic modes.
Because of local APIC nature it is per-CPU.
The timer frequency is not reported by the platform and so automatically
measured by the driver on the first use.
Expand Down
6 changes: 4 additions & 2 deletions share/man/man4/arcmsr.4
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: stable/11/share/man/man4/arcmsr.4 326087 2017-11-22 06:33:51Z delphij $
.\" $FreeBSD$
.\"
.Dd November 8, 2017
.Dd October 15, 2020
.Dt ARCMSR 4
.Os
.Sh NAME
Expand Down Expand Up @@ -153,6 +153,8 @@ ARC-1882
ARC-1883
.It
ARC-1884
.It
ARC-1886
.El
.Sh FILES
.Bl -tag -width ".Pa /dev/arcmsr?" -compact
Expand Down
10 changes: 5 additions & 5 deletions share/man/man4/bnxt.4
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD: stable/11/share/man/man4/bnxt.4 333364 2018-05-08 15:51:40Z shurd $
.\" $FreeBSD$
.\"
.Dd May 9, 2017
.Dd August 18, 2020
.Dt BNXT 4
.Os
.Sh NAME
Expand Down Expand Up @@ -129,15 +129,15 @@ completion ring, and the size of the transmit ring respectively.
The completion ring should be at least twice the size of the transmit ring.
These numbers must be powers of two, and zero means to use the default.
Defaults to 0,0.
.It Va override_qs_enable
.It Va dev.bnxt.X.iflib.override_qs_enable
When set, allows the number of transmit and receive queues to be different.
If not set, the lower of the number of TX or RX queues will be used for both.
.It Va override_nrxqs
.It Va dev.bnxt.X.iflib.override_nrxqs
Set the number of RX queues.
If zero, the number of RX queues is derived from the number of cores on the
socket connected to the controller.
Defaults to 0.
.It Va override_ntxqs
.It Va dev.bnxt.X.iflib.override_ntxqs
Set the number of TX queues.
If zero, the number of TX queues is derived from the number of cores on the
socket connected to the controller.
Expand Down
42 changes: 15 additions & 27 deletions share/man/man4/usb.4
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: stable/11/share/man/man4/usb.4 318624 2017-05-22 06:24:43Z ngie $
.\" $FreeBSD$
.\"
.Dd April 29, 2017
.Dd September 7, 2020
.Dt USB 4
.Os
.Sh NAME
Expand Down Expand Up @@ -52,8 +52,7 @@ for more information.
.Sh DESCRIPTION
.Fx
provides machine-independent bus support and drivers for
.Tn USB
devices in host and device side mode.
USB devices in host and device side mode.
.Pp
The
.Nm
Expand All @@ -67,32 +66,25 @@ driver has three layers:
The controller attaches to a physical bus
like
.Xr pci 4 .
The
.Tn USB
bus attaches to the controller, and the root hub attaches
The USB bus attaches to the controller, and the root hub attaches
to the controller.
Any devices attached to the bus will attach to the root hub
or another hub attached to the
.Tn USB
bus.
or another hub attached to the USB bus.
.Pp
The
.Nm uhub
device will always be present as it is needed for the root hub.
.Sh INTRODUCTION TO USB
The
.Tn USB
is a system where external devices can be connected to a PC.
The USB is a system where external devices can be connected to a PC.
The most common USB speeds are:
.Bl -tag -width 6n -offset indent
.It Low Speed (1.5MBit/sec)
.It Full Speed (12MBit/sec)
.It High Speed (480MBit/sec)
.It Low Speed (1.5 MBit/sec)
.It Full Speed (12 MBit/sec)
.It High Speed (480 MBit/sec)
.It SuperSpeed (5 GBit/sec)
.El
.Pp
Each
.Tn USB
has a USB controller that is the master of the bus.
Each USB has a USB controller that is the master of the bus.
The physical communication is simplex which means the host controller only
communicates with one USB device at a time.
.Pp
Expand Down Expand Up @@ -122,21 +114,17 @@ A device may operate in different configurations.
Depending on the configuration, the device may present different sets of
endpoints and interfaces.
.Pp
The bus enumeration of the
.Tn USB
bus proceeds in several steps:
The bus enumeration of the USB bus proceeds in several steps:
.Bl -enum
.It
Any interface specific driver can attach to the device.
.It
If none is found, generic interface class drivers can attach.
.El
.Sh SEE ALSO
The
.Tn USB
specifications can be found at:
The USB specifications can be found at:
.Pp
.D1 Pa http://www.usb.org/developers/docs/
.D1 Pa https://www.usb.org/documents
.Pp
.Xr libusb 3 ,
.Xr aue 4 ,
Expand Down Expand Up @@ -166,7 +154,7 @@ specifications can be found at:
.Sh STANDARDS
The
.Nm
module complies with the USB 2.0 standard.
module complies with the USB 3.0 standard.
.Sh HISTORY
The
.Nm
Expand Down

0 comments on commit 7afc6ec

Please sign in to comment.