diff options
Diffstat (limited to 'share')
107 files changed, 682 insertions, 349 deletions
diff --git a/share/man/man3/tree.3 b/share/man/man3/tree.3 index ea70506..ff701a0 100644 --- a/share/man/man3/tree.3 +++ b/share/man/man3/tree.3 @@ -424,12 +424,14 @@ Individual prototypes can be declared with .Fn RB_PROTOTYPE_PREV , and .Fn RB_PROTOTYPE_MINMAX -in case not all functions are required. The individual prototype macros expect +in case not all functions are required. +The individual prototype macros expect .Fa NAME , .Fa TYPE , and .Fa ATTR -arguments. The +arguments. +The .Fa ATTR argument must be empty for global functions or .Fa static diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index b99b6af..99535c2 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -863,7 +863,7 @@ _dtrace_udp.4= dtrace_udp.4 .if ${MK_ISCSI} != "no" MAN+= iscsi.4 MAN+= iscsi_initiator.4 - +MAN+= iser.4 .endif .if ${MK_TESTS} != "no" diff --git a/share/man/man4/ahci.4 b/share/man/man4/ahci.4 index 67a9606..24a277d 100644 --- a/share/man/man4/ahci.4 +++ b/share/man/man4/ahci.4 @@ -141,7 +141,8 @@ API or emulated .Xr ses 4 device for localization and status reporting purposes. Supporting AHCI controllers may transmit that information to the backplane -controllers via SGPIO interface. Backplane controllers interpret received +controllers via SGPIO interface. +Backplane controllers interpret received statuses in some way (IBPI standard) to report them using present indicators. .Sh HARDWARE The diff --git a/share/man/man4/apic.4 b/share/man/man4/apic.4 index 0856232..2fb5b8c 100644 --- a/share/man/man4/apic.4 +++ b/share/man/man4/apic.4 @@ -43,7 +43,8 @@ The following tunable is settable from the .Xr loader 8 : .Bl -ohang .It Va hint.apic. Ns Ar X Ns Va .clock -controls event timers functionality support. Setting to 0, disables it. +controls event timers functionality support. +Setting to 0, disables it. Default value is 1. .It Va hint.apic. Ns Ar X Ns Va .disabled Set this to 1 to disable APIC support, falling back to the legacy PIC. diff --git a/share/man/man4/atp.4 b/share/man/man4/atp.4 index 6309d09..c326188 100644 --- a/share/man/man4/atp.4 +++ b/share/man/man4/atp.4 @@ -50,7 +50,8 @@ atp_load="YES" The .Nm driver provides support for the Apple Internal Trackpad device found in many -Apple laptops. Older (Fountain/Geyser) and the newer (Wellspring) trackpad +Apple laptops. +Older (Fountain/Geyser) and the newer (Wellspring) trackpad families are all supported through a unified driver. .Pp The driver simulates a three\-button mouse using multi\-finger tap detection. diff --git a/share/man/man4/atrtc.4 b/share/man/man4/atrtc.4 index 0b0dd8f..1ae8e41 100644 --- a/share/man/man4/atrtc.4 +++ b/share/man/man4/atrtc.4 @@ -37,7 +37,8 @@ The following tunable is settable from the .Xr loader 8 : .Bl -ohang .It Va hint.atrtc. Ns Ar X Ns Va .clock -controls event timers functionality support. Setting to 0, disables it. +controls event timers functionality support. +Setting to 0, disables it. Default value is 1. .El .Sh DESCRIPTION diff --git a/share/man/man4/bcma.4 b/share/man/man4/bcma.4 index 3a0313c..b0f13f6 100644 --- a/share/man/man4/bcma.4 +++ b/share/man/man4/bcma.4 @@ -55,7 +55,8 @@ in later Broadcom Home Networking Division's (HND) wireless chipsets and embedded systems. .Pp A common interconnect connects all of the backplane's functional -blocks. These functional blocks, known as cores, use the ARM AMBA AXI or +blocks. +These functional blocks, known as cores, use the ARM AMBA AXI or APB interface to communicate with devices attached to the interconnect. .Pp The IP cores used in @@ -63,7 +64,6 @@ The IP cores used in devices were adapted by Broadcom for compatibility with the new interconnect. .Sh SEE ALSO -.Xr bcma 4 , .Xr bhnd 4 .Sh HISTORY The diff --git a/share/man/man4/bhnd.4 b/share/man/man4/bhnd.4 index e54563f..0c2aba4 100644 --- a/share/man/man4/bhnd.4 +++ b/share/man/man4/bhnd.4 @@ -52,8 +52,8 @@ devices. .Pp The Broadcom HND device family consists of SoCs (System On a Chip) and host-connected chipsets based on a common library of Broadcom IP -cores connected via an internal hardware bus architecture. Drivers -for these cores are implemented against the unified +cores connected via an internal hardware bus architecture. +Drivers for these cores are implemented against the unified .Nm interface. .Pp diff --git a/share/man/man4/bhyve.4 b/share/man/man4/bhyve.4 index f4ff2e1..f654855 100644 --- a/share/man/man4/bhyve.4 +++ b/share/man/man4/bhyve.4 @@ -38,8 +38,8 @@ .Cd "/boot/kernel/vmm.ko" .Sh DESCRIPTION .Nm -is a virtual machine monitor that is hosted by FreeBSD. It is used to host -unmodified guest operating systems on top of FreeBSD. +is a virtual machine monitor that is hosted by FreeBSD. +It is used to host unmodified guest operating systems on top of FreeBSD. .Pp .Nm relies heavily on hardware assist provided by the CPU and chipset to virtualize diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index 01cd0ea..e63b3a6 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -24,7 +24,7 @@ .\" 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. -.\" +.\" .\" Copyright (c) 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -577,7 +577,8 @@ output via the interface is successful. When .Dv BPF_D_INOUT direction is set, injected outgoing packet is not returned by BPF to avoid -duplication. This flag is initialized to zero by default. +duplication. +This flag is initialized to zero by default. .It Dv BIOCLOCK Set the locked flag on the .Nm diff --git a/share/man/man4/cmx.4 b/share/man/man4/cmx.4 index 38ae466..aebcbc0 100644 --- a/share/man/man4/cmx.4 +++ b/share/man/man4/cmx.4 @@ -1,7 +1,7 @@ .\" .\" Copyright (c) 2006-2007 Daniel Roethlisberger <daniel@roe.ch> .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -11,7 +11,7 @@ .\" 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 @@ -42,7 +42,8 @@ driver provides support for the PCCARD based smartcard reader. The driver provides a character device special file based .Em Chip/Smart Card Interface Devices (CCID) -interface. The driver implements what the vendor calls the +interface. +The driver implements what the vendor calls the .Em Synchronous API onto the smartcard reader device. .Pp @@ -51,8 +52,9 @@ Reading and writing is synchronous, meaning that a call to directly corresponds to a complete CCID command sent to the device, while the following .Xr read 2 -will return the complete answer from the reader. There is no -support for partial reads or writes. There is no upper limit on +will return the complete answer from the reader. +There is no support for partial reads or writes. +There is no upper limit on CCID request or response sizes, but the complete CCID request must be sent to the driver in .Xr write 2 @@ -64,7 +66,8 @@ Non-blocking I/O, .Xr select 2 and .Xr poll 2 -are supported and work as expected. An open file descriptor +are supported and work as expected. +An open file descriptor will always be ready for writing, but only ready for reading if the device indicates that it has data available. .Sh FILES @@ -112,9 +115,9 @@ Early testing and bug fixes by .An -nosplit The way the .Nm -driver talks to the CardMan 4040 is a bit rough. Due to the -complete lack of hardware documentation other than vendor drivers +driver talks to the CardMan 4040 is a bit rough. +Due to the complete lack of hardware documentation other than vendor drivers for other operating systems, the gory details of the device's -I/O registers are not understood very well. There may be error -conditions which can only be solved by physically reinserting the -reader. +I/O registers are not understood very well. +There may be error conditions which can only be solved by physically +reinserting the reader. diff --git a/share/man/man4/cxgbe.4 b/share/man/man4/cxgbe.4 index 9821797..72a9483 100644 --- a/share/man/man4/cxgbe.4 +++ b/share/man/man4/cxgbe.4 @@ -270,11 +270,13 @@ The default is -1 which lets the driver decide. 0 or 1 explicitly disable or enable this feature. .It Va hw.cxgbe.allow_mbufs_in_cluster 1 allows the driver to lay down one or more mbufs within the receive buffer -opportunistically. This is the default. +opportunistically. +This is the default. 0 prohibits the driver from doing so. .It Va hw.cxgbe.largest_rx_cluster .It Va hw.cxgbe.safest_rx_cluster -Sizes of rx clusters. Each of these must be set to one of the sizes available +Sizes of rx clusters. +Each of these must be set to one of the sizes available (usually 2048, 4096, 9216, and 16384) and largest_rx_cluster must be greater than or equal to safest_rx_cluster. The defaults are 16384 and 4096 respectively. diff --git a/share/man/man4/dcons.4 b/share/man/man4/dcons.4 index 3f33dd2..d228ad5 100644 --- a/share/man/man4/dcons.4 +++ b/share/man/man4/dcons.4 @@ -100,7 +100,7 @@ See for more details. .Pp If you want to use -.Xr dcons 4 +.Nm as a .Xr gdb 1 port, add the following line into diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index b6ef6ae..3e88aa5 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -60,7 +60,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 18, 2016 +.Dd June 6, 2016 .Dt DDB 4 .Os .Sh NAME @@ -599,6 +599,13 @@ See the header file for more details on the exact meaning of the structure fields. .\" .Pp +.It Ic show Cm callout Ar addr +Show information about the callout structure +.Vt struct callout +present at +.Ar addr . +.\" +.Pp .It Ic show Cm cbstat Show brief information about the TTY subsystem. .\" @@ -681,6 +688,13 @@ The second one is the name of the interrupt/trap handler. Those functions are machine dependent. .\" .Pp +.It Ic show Cm igi_list Ar addr +Show information about the IGMP structure +.Vt struct igmp_ifsoftc +present at +.Ar addr . +.\" +.Pp .It Ic show Cm inodedeps Op Ar addr Show brief information about each inodedep structure. If @@ -834,6 +848,10 @@ option is specified the complete object is printed. .\" .Pp +.It Ic show Cm panic +Print the panic message if set. +.\" +.Pp .It Ic show Cm page Show statistics on VM pages. .\" diff --git a/share/man/man4/devctl.4 b/share/man/man4/devctl.4 index b86cf23..f71d029 100644 --- a/share/man/man4/devctl.4 +++ b/share/man/man4/devctl.4 @@ -75,7 +75,8 @@ Listening programs are expected to cope. .Pp The sysctl .Va hw.bus.devctl_queue -can be used to control queue length. It is set to 0 to disable +can be used to control queue length. +It is set to 0 to disable .Nm when no .Xr devd 8 diff --git a/share/man/man4/fdt.4 b/share/man/man4/fdt.4 index 12542d0..6b371a5 100644 --- a/share/man/man4/fdt.4 +++ b/share/man/man4/fdt.4 @@ -41,19 +41,20 @@ .Sh DESCRIPTION .Em Flattened Device Tree is a mechanism for describing computer hardware resources, which cannot be -probed or self enumerated, in a uniform and portable way. The primary -consumers of this technology are +probed or self enumerated, in a uniform and portable way. +The primary consumers of this technology are .Em embedded systems, where a lot of designs are based on similar chips, but have different assignment of pins, memory layout, addresses bindings, interrupts routing and other resources. .Pp Configuration data, which cannot be self discovered in run-time, has to be -supplied from external source. The concept of a flattened device tree is a +supplied from external source. +The concept of a flattened device tree is a platform and architecture independent approach for resolving such problems. The idea is inherited from Open Firmware IEEE 1275 device-tree notion, and has -been successfully adopted by the embedded industry. The scheme works in the -following way: +been successfully adopted by the embedded industry. +The scheme works in the following way: .Bl -bullet .It Hardware platform resources are @@ -72,7 +73,8 @@ from this [externally supplied] blob, which eliminates the need for embedding any information about the underlying platform hardware resources in the kernel. .It The flattened device tree mechanism in principle does not depend on any -particular first-stage bootloader or firmware features. The only overall +particular first-stage bootloader or firmware features. +The only overall requirement for the environment is to provide a complete device tree description to the kernel. .El @@ -89,8 +91,8 @@ maintenance. .It Va Device tree source (DTS) The device tree source is a text file which describes hardware resources of a computer system in a human-readable form, with certain hierarchical structure -(a tree). The default location for DTS files -in the +(a tree). +The default location for DTS files in the .Fx source repository is .Pa sys/boot/fdt/dts @@ -140,7 +142,8 @@ kernel level. .It Va options FDT The primary option for enabling .Nm -support in the kernel. It covers all low-level and infrastructure parts of +support in the kernel. +It covers all low-level and infrastructure parts of .Nm kernel support, which primarily are the .Xr fdtbus 4 @@ -149,16 +152,18 @@ and drivers, as well as helper routines and libraries. .It Va makeoptions FDT_DTS_FILE=<board name>.dts Specifies a preferred (default) device tree source (DTS) file for a given -kernel. The indicated DTS file will be converted (compiled) into a binary form -along with building the kernel itself. The DTS file name is relative -to the default location of DTS sources i.e. +kernel. +The indicated DTS file will be converted (compiled) into a binary form +along with building the kernel itself. +The DTS file name is relative to the default location of DTS sources i.e. .Pa sys/boot/fdt/dts . This makeoption is not mandatory unless FDT_DTB_STATIC is also defined (see below). .It Va options FDT_DTB_STATIC Typically, the device tree blob (DTB) is a stand-alone file, physically separate from the kernel, but this option lets statically embed a -DTB file into a kernel image. Note that when this is specified the +DTB file into a kernel image. +Note that when this is specified the FDT_DTS_FILE makeoption becomes mandatory (as there needs to be a DTS file specified in order to embed it into the kernel image). .El @@ -182,5 +187,6 @@ support first appeared in The .Nm support was developed by Semihalf under sponsorship from the FreeBSD -Foundation. This manual page was written by +Foundation. +This manual page was written by .An Rafal Jaworowski . diff --git a/share/man/man4/fdtbus.4 b/share/man/man4/fdtbus.4 index 7141655..6755a7d 100644 --- a/share/man/man4/fdtbus.4 +++ b/share/man/man4/fdtbus.4 @@ -43,7 +43,8 @@ abstract bus driver is the primary connection and translation layer between .Xr fdt 4 hardware resources description and .Fx -native newbus device drivers framework. For an embedded system +native newbus device drivers framework. +For an embedded system .Nm represents peripherals typically found on a highly integrated chip (system-on-chip). @@ -84,5 +85,6 @@ support first appeared in The .Nm support was developed by Semihalf under sponsorship from the FreeBSD -Foundation. This manual page was written by +Foundation. +This manual page was written by .An Rafal Jaworowski . diff --git a/share/man/man4/hpet.4 b/share/man/man4/hpet.4 index cd1b766..f006cde 100644 --- a/share/man/man4/hpet.4 +++ b/share/man/man4/hpet.4 @@ -42,16 +42,19 @@ The following tunables are settable from the .Xr loader 8 : .Bl -ohang .It Va hint.hpet. Ns Ar X Ns Va .allowed_irqs -is a 32bit mask. Each set bit allows driver to use respective IRQ, +is a 32bit mask. +Each set bit allows driver to use respective IRQ, if BIOS also set respective capability bit in comparator's configuration register. Default value is 0xffff0000, except some known broken hardware. .It Va hint.hpet. Ns Ar X Ns Va .clock -controls event timers functionality support. Setting to 0, disables it. +controls event timers functionality support. +Setting to 0, disables it. Default value is 1. .It Va hint.hpet. Ns Ar X Ns Va .legacy_route -controls "LegacyReplacement Route" mode. If enabled, HPET will steal IRQ0 of -i8254 timer and IRQ8 of RTC. Before using it, make sure that respective +controls "LegacyReplacement Route" mode. +If enabled, HPET will steal IRQ0 of i8254 timer and IRQ8 of RTC. +Before using it, make sure that respective drivers are not using interrupts, by setting also: .Bd -literal hint.attimer.0.clock=0 @@ -77,8 +80,8 @@ Depending on hardware capabilities and configuration, interrupt can be delivered as regular I/O APIC interrupt (ISA or PCI) in range from 0 to 31, or as Front Side Bus interrupt, alike to PCI MSI interrupts, or in so called "LegacyReplacement Route" HPET can steal IRQ0 of i8254 and IRQ8 of the RTC. -Interrupt can be either edge- or level-triggered. In last case they could be -safely shared with PCI IRQs. +Interrupt can be either edge- or level-triggered. +In last case they could be safely shared with PCI IRQs. Driver prefers to use FSB interrupts, if supported, to avoid sharing. If it is not possible, it uses single sharable IRQ from PCI range. Other modes (LegacyReplacement and ISA IRQs) require special care to setup, @@ -89,9 +92,10 @@ and irrelevant to CPU power states. .Pp Depending on hardware capabilities and configuration, driver can expose each comparator as separate event timer or group them into one or several per-CPU -event timers. In last case interrupt of every of those comparators within -group is bound to specific CPU core. This is possible only when each -of these comparators has own unsharable IRQ. +event timers. +In last case interrupt of every of those comparators within +group is bound to specific CPU core. +This is possible only when each of these comparators has own unsharable IRQ. .Sh SEE ALSO .Xr acpi 4 , .Xr apic 4 , diff --git a/share/man/man4/hptrr.4 b/share/man/man4/hptrr.4 index 0cbd2fd..1f488f8 100644 --- a/share/man/man4/hptrr.4 +++ b/share/man/man4/hptrr.4 @@ -51,7 +51,8 @@ The following tunables are settable from the loader: .Bl -ohang .It Va hw.hptrr.attach_generic set to 1 to permit driver attach to chips with generic Marvell (non-HighPoint) -PCI identification. These chips are also supported by +PCI identification. +These chips are also supported by .Xr ata 4 and .Xr mvs 4 . diff --git a/share/man/man4/iicbus.4 b/share/man/man4/iicbus.4 index c89bfaf..d164bf8 100644 --- a/share/man/man4/iicbus.4 +++ b/share/man/man4/iicbus.4 @@ -122,7 +122,7 @@ Flattened Device Tree (FDT) data, tunables set via or at runtime using .Xr sysctl 8 . When configuration is supplied using more than one method, FDT and -hint data will be overridden by a tunable, which can be overriden by +hint data will be overridden by a tunable, which can be overridden by .Xr sysctl 8 . .Ss Device Hints Set diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index 07e7354..49c050d 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -134,7 +134,7 @@ The following .Xr ioctl 2 commands are provided for a datagram socket in the Internet domain: .Pp -.Bl -tag -width ".Dv SIOCGIFBRDADDR" -offset indent -compact +.Bl -tag -width ".Dv SIOCGIFBRDADDR" -offset indent -compact .It Dv SIOCAIFADDR Add address to an interface. The command requires @@ -149,8 +149,8 @@ as argument. .It Dv SIOCGIFBRDADDR .It Dv SIOCGIFDSTADDR .It Dv SIOCGIFNETMASK -Return address information from interface. The returned value -is in +Return address information from interface. +The returned value is in .Ft struct ifreq . This way of address information retrieval is obsoleted, a preferred way is to use diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index 101993f..27a7d8e 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -122,7 +122,7 @@ may be used to set the Don't Fragment flag on IP packets. Currently this option is respected only on .Xr udp 4 and raw -.Xr ip 4 +.Nm sockets, unless the .Dv IP_HDRINCL option has been set. diff --git a/share/man/man4/ipmi.4 b/share/man/man4/ipmi.4 index 9516d31..ba99464 100644 --- a/share/man/man4/ipmi.4 +++ b/share/man/man4/ipmi.4 @@ -63,8 +63,8 @@ If the .Ar port and .Ar spacing -are not specified the interface type default will be used. Only specify -either the +are not specified the interface type default will be used. +Only specify either the .Ar port for I/O access or .Ar maddr diff --git a/share/man/man4/iscsi.4 b/share/man/man4/iscsi.4 index 1a0731d..65edfe7 100644 --- a/share/man/man4/iscsi.4 +++ b/share/man/man4/iscsi.4 @@ -107,6 +107,7 @@ While the connection is down all input/output operations are suspended, to be retried after the connection is reestablished. .El .Sh SEE ALSO +.Xr iser 4 , .Xr iscsi.conf 5 , .Xr iscsictl 8 , .Xr iscsid 8 diff --git a/share/man/man4/iser.4 b/share/man/man4/iser.4 new file mode 100644 index 0000000..abaaa92 --- /dev/null +++ b/share/man/man4/iser.4 @@ -0,0 +1,94 @@ +.\" Copyright (c) 2015, Mellanox Technologies, Inc. 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 June 6, 2016 +.Dt ISER 4 +.Os +.Sh NAME +.Nm iser +.Nd iSCSI Extensions for RDMA (iSER) driver +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in the +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device iser" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +iser_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +(iSCSI Extensions for RDMA) initiator driver extends the iSCSI protocol to RDMA. +It permits data to be transferred directly into and out of SCSI buffers +without intermediate data copies. +iSER uses the RDMA protocol suite to supply higher bandwidth for +block storage transfers (zero copy behavior). +To that fact, it eliminates the +TCP/IP processing overhead while preserving the compatibility with iSCSI protocol. +The initiator is the iSCSI/iSER client, which connects to an iSCSI/iSER target, +providing local access to a remote block device. +The userland component is provided by +.Xr iscsid 8 +and both the kernel and userland are configured using +.Xr iscsictl 8 . +.Sh SYSCTL VARIABLES +The following variables are available as both +.Xr sysctl 8 +variables and +.Xr loader 8 +tunables: +.Bl -tag -width indent +.It Va kern.iser.debug +Verbosity level for log messages from the +.Nm +driver. +Set to 0 to disable logging or 1 to warn about potential problems. +Larger values enable info and debugging output. +Defaults to 0. +.El +.Sh SEE ALSO +.Xr iscsi 4 , +.Xr iscsi.conf 5 , +.Xr iscsictl 8 , +.Xr iscsid 8 +.Sh HISTORY +The +.Nm +subsystem first appeared in +.Fx 11.0 . +.Sh AUTHORS +The +.Nm +subsystem was developed by +.An Max Gurtovoy Aq Mt maxg@mellanox.com +and +.An Sagi Grimberg Aq Mt sagig@mellanox.com +under sponsorship from Mellanox Technologies. diff --git a/share/man/man4/ixl.4 b/share/man/man4/ixl.4 index ced68f7..60aa5e6 100644 --- a/share/man/man4/ixl.4 +++ b/share/man/man4/ixl.4 @@ -1,29 +1,29 @@ -.\" Copyright (c) 2013-2015, Intel Corporation +.\" Copyright (c) 2013-2015, Intel Corporation .\" 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 are met: -.\" -.\" 1. Redistributions of source code must retain the above copyright notice, +.\" +.\" 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 +.\" +.\" 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. -.\" -.\" 3. Neither the name of the Intel Corporation nor the names of its -.\" contributors may be used to endorse or promote products derived from +.\" +.\" 3. Neither the name of the Intel Corporation nor the names of its +.\" contributors may be used to endorse or promote products derived from .\" this software without specific prior written permission. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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) +.\" 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 COPYRIGHT OWNER 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. .\" diff --git a/share/man/man4/ixlv.4 b/share/man/man4/ixlv.4 index 09aa2cd..1fb0eb9 100644 --- a/share/man/man4/ixlv.4 +++ b/share/man/man4/ixlv.4 @@ -1,29 +1,29 @@ -.\" Copyright (c) 2013-2015, Intel Corporation +.\" Copyright (c) 2013-2015, Intel Corporation .\" 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 are met: -.\" -.\" 1. Redistributions of source code must retain the above copyright notice, +.\" +.\" 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 +.\" +.\" 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. -.\" -.\" 3. Neither the name of the Intel Corporation nor the names of its -.\" contributors may be used to endorse or promote products derived from +.\" +.\" 3. Neither the name of the Intel Corporation nor the names of its +.\" contributors may be used to endorse or promote products derived from .\" this software without specific prior written permission. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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) +.\" 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 COPYRIGHT OWNER 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. .\" diff --git a/share/man/man4/ksyms.4 b/share/man/man4/ksyms.4 index 6ce42ea..fe10d20 100644 --- a/share/man/man4/ksyms.4 +++ b/share/man/man4/ksyms.4 @@ -39,16 +39,18 @@ The .Pa /dev/ksyms character device provides a read-only interface to a snapshot of the kernel -symbol table. The in-kernel symbol manager is designed to be able to handle +symbol table. +The in-kernel symbol manager is designed to be able to handle many types of symbols tables, however, only .Xr elf 5 -symbol tables are supported by this device. The ELF format image contains two +symbol tables are supported by this device. +The ELF format image contains two sections: a symbol table and a corresponding string table. .Bl -tag -width indent -offset indent .It Dv Symbol Table The SYMTAB section contains the symbol table entries present in the current -running kernel, including the symbol table entries of any loaded modules. The -symbols are ordered by the kernel module load time starting with kernel file +running kernel, including the symbol table entries of any loaded modules. +The symbols are ordered by the kernel module load time starting with kernel file symbols first, followed by the first loaded module's symbols and so on. .It Dv String Table The STRTAB section contains the symbol name strings from the kernel and any @@ -97,14 +99,16 @@ of will fail if: .Bl -tag -width Er .It Bq Er EBUSY -The device is already open. A process must close +The device is already open. +A process must close .Pa /dev/ksyms before it can be opened again. .It Bq Er ENOMEM There is a resource shortage in the kernel. .It Bq Er ENXIO The driver was unsuccessful in creating a snapshot of the kernel symbol -table. This may occur if the kernel was in the process of loading or +table. +This may occur if the kernel was in the process of loading or unloading a module. .El .Sh SEE ALSO @@ -133,13 +137,19 @@ driver was written by .An Stacey Son Aq Mt sson@FreeBSD.org . .Sh BUGS Because files can be dynamically linked into the kernel at any time the symbol -information can vary. When you open the +information can vary. +When you open the .Pa /dev/ksyms -file, you have access to an ELF image which represents a snapshot of the state of the kernel symbol information at that instant in time. Keeping the device open does not block the loading or unloading of kernel modules. To get a new snapshot you must close and re-open the device. +file, you have access to an ELF image which represents a snapshot of the state +of the kernel symbol information at that instant in time. +Keeping the device open does not block the loading or unloading of kernel +modules. +To get a new snapshot you must close and re-open the device. .Pp A process is only allowed to open the .Pa /dev/ksyms -file once at a time. The process must close the +file once at a time. +The process must close the .Pa /dev/ksyms before it is allowed to open it again. .Pp diff --git a/share/man/man4/man4.arm/cgem.4 b/share/man/man4/man4.arm/cgem.4 index 01e2921..6de1d79 100644 --- a/share/man/man4/man4.arm/cgem.4 +++ b/share/man/man4/man4.arm/cgem.4 @@ -278,13 +278,15 @@ When receive checksum offloading is enabled, the device will discard packets with bad TCP/UDP/IP checksums. The bad packets will not be counted in any .Xr netstat 1 -statistics. There are +statistics. +There are .Xr sysctl 8 variables that count packets discarded by the hardware (see below). .Pp The GEM used in the Zynq-7000 has a bug such that the receiver can -potentially freeze up under a high load. The issue is described in sec. 16.7 +potentially freeze up under a high load. +The issue is described in sec. 16.7 "Known Issues" of the Zynq-7000 SoC Technical Reference Manual (Xilinx UG585 v1.7). The diff --git a/share/man/man4/man4.arm/mge.4 b/share/man/man4/man4.arm/mge.4 index a0f05bd..ddbacaf 100644 --- a/share/man/man4/man4.arm/mge.4 +++ b/share/man/man4/man4.arm/mge.4 @@ -90,17 +90,19 @@ The .Nm driver supports interrupts coalescing (IC) so that raising a transmit/receive frame interrupt is delayed, if possible, until a threshold-defined period of -time has elapsed. The following sysctls regulate this behaviour (separately -for each path): +time has elapsed. +The following sysctls regulate this behaviour (separately for each path): .Bl -tag -width indent .It Va dev.mge.X.int_coal.rx_time .It Va dev.mge.X.int_coal.tx_time .Pp Value of 0 disables IC on the given path, value greater than zero corresponds to a real time period and is expressed in units equivalent to 64 ticks of the -MGE clock. Maximum allowed value depends on MGE hardware revision. User -provided values larger than supported will be trimmed to the maximum -supported. More details are available in the reference manual of the device. +MGE clock. +Maximum allowed value depends on MGE hardware revision. +User provided values larger than supported will be trimmed to the maximum +supported. +More details are available in the reference manual of the device. .El .Sh HARDWARE Gigabit Ethernet controllers built into the following Marvell systems-on-chip diff --git a/share/man/man4/mdio.4 b/share/man/man4/mdio.4 index 1a8bdd0..8120b07 100644 --- a/share/man/man4/mdio.4 +++ b/share/man/man4/mdio.4 @@ -32,7 +32,8 @@ external PHY devices. .Tn MDIO is one of two signal interfaces that comprise the Media Independent Interface (MII) defined by the IEEE 802.3 -Standard. The +Standard. +The .Xr miibus 4 driver provides support for devices that require full .Tn MII diff --git a/share/man/man4/mfi.4 b/share/man/man4/mfi.4 index c20d9bd..088676a 100644 --- a/share/man/man4/mfi.4 +++ b/share/man/man4/mfi.4 @@ -75,8 +75,9 @@ then the driver will allow mounted volumes to be removed. .Pp A tunable is provided to adjust the .Nm -driver's behaviour when attaching to a card. By default the driver will -attach to all known cards with high probe priority. If the tunable +driver's behaviour when attaching to a card. +By default the driver will attach to all known cards with high probe priority. +If the tunable .Va hw.mfi.mrsas_enable is set to 1, then the driver will reduce its probe priority to allow diff --git a/share/man/man4/mpr.4 b/share/man/man4/mpr.4 index ff500c2..13172f8 100644 --- a/share/man/man4/mpr.4 +++ b/share/man/man4/mpr.4 @@ -29,7 +29,7 @@ .\" 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 DAMAGES. -.\" +.\" .\" mpr driver man page. .\" .\" Author: Ken Merry <ken@FreeBSD.org> @@ -250,7 +250,7 @@ hw.mpr.X.debug_level .Pp tunable, either in .Xr loader.conf 5 -or by using +or by using .Xr sysctl 8 . These bits have the described effects: .Bd -literal -offset indent diff --git a/share/man/man4/mpt.4 b/share/man/man4/mpt.4 index 2e15325..b3a29f6 100644 --- a/share/man/man4/mpt.4 +++ b/share/man/man4/mpt.4 @@ -132,7 +132,8 @@ The controller chips are also present on many new AMD/Opteron based systems, like the Sun 4100. Note that this controller can drive both SAS and SATA -drives or a mix of them at the same time. The Integrated RAID Mirroring +drives or a mix of them at the same time. +The Integrated RAID Mirroring available for these controllers is poorly supported at best. .Pp The diff --git a/share/man/man4/nand.4 b/share/man/man4/nand.4 index 4371e38..2b5adb0 100644 --- a/share/man/man4/nand.4 +++ b/share/man/man4/nand.4 @@ -43,27 +43,29 @@ The framework consists of a set of interfaces that aim to provide an extensible, object oriented environement for NAND controllers and NAND Flash memory chips from various hardware vendors, and to allow for uniform and flexible -management of the NAND devices. It comprises of the following major -components: +management of the NAND devices. +It comprises of the following major components: .Bl -bullet .It NAND Flash controller (NFC) interface. .Pp Defines methods which allow to send commands as well as send/receive data -between the controller and a NAND chip. Back-end drivers for specific NAND +between the controller and a NAND chip. +Back-end drivers for specific NAND controllers plug into this interface and implement low-level routines for a given NAND controller. .Pp -This layer implements basic functionality of a NAND Flash controller. It -allows to send command and address to chip, drive CS (chip select line), as -well as read/write to the selected NAND chip. This layer is independent of +This layer implements basic functionality of a NAND Flash controller. +It allows to send command and address to chip, drive CS (chip select line), +as well as read/write to the selected NAND chip. +This layer is independent of NAND chip devices actually connected to the controller. .It NAND chip interface. .Pp -Provides basic operations like read page, program page, erase block. Currently -three generic classes of drivers are available, which provide support for the -following chips: +Provides basic operations like read page, program page, erase block. +Currently three generic classes of drivers are available, which provide +support for the following chips: .Bl -bullet .It large page @@ -74,7 +76,8 @@ ONFI-compliant .El .Pp This layer implements basic operations to be performed on a NAND chip, like -read, program, erase, get status etc. Since these operations use specific +read, program, erase, get status etc. +Since these operations use specific commands (depending on the vendor), each chip has potentially its own implementation of the commands set. .Pp @@ -87,9 +90,10 @@ This layer is responsible for enumerating NAND chips in the system and establishing the hierarchy between chips and their supervising controllers. .Pp Its main purpose is detecting type of NAND chips connected to a given chip -select (CS line). It also allows manages locking access to the NAND -controller. NANDbus passes requests from an active chip to the chip +select (CS line). +It also allows manages locking access to the NAND controller. +NANDbus passes requests from an active chip to the chip controller. .It NAND character / GEOM device. .Pp diff --git a/share/man/man4/ng_atm.4 b/share/man/man4/ng_atm.4 index 9c07334..2ac1acc 100644 --- a/share/man/man4/ng_atm.4 +++ b/share/man/man4/ng_atm.4 @@ -325,8 +325,8 @@ struct ngm_atm_cpcs_term { }; .Ed .It Dv NGM_ATM_GET_STATS Pq Ic getstats -This command returns a message, containing node statistics. The -structure of the message is: +This command returns a message, containing node statistics. +The structure of the message is: .Bd -literal struct ngm_atm_stats { uint64_t in_packets; diff --git a/share/man/man4/ng_bridge.4 b/share/man/man4/ng_bridge.4 index 9b3e600..fe5d385 100644 --- a/share/man/man4/ng_bridge.4 +++ b/share/man/man4/ng_bridge.4 @@ -186,8 +186,8 @@ This command sets the persistent flag on the node, and takes no arguments. .Sh SHUTDOWN This node shuts down upon receipt of a .Dv NGM_SHUTDOWN -control message, or when all hooks have been disconnected. Setting the -persistent flag via a +control message, or when all hooks have been disconnected. +Setting the persistent flag via a .Dv NGM_BRIDGE_SET_PERSISTENT control message disables automatic node shutdown when the last hook gets disconnected. diff --git a/share/man/man4/ng_car.4 b/share/man/man4/ng_car.4 index 5950b99..cb1459f 100644 --- a/share/man/man4/ng_car.4 +++ b/share/man/man4/ng_car.4 @@ -109,7 +109,8 @@ links with bandwidth * delay product less than 6-8 TCP segments, but it consumes additional system resources for queue processing. .El By default, all information rates are measured in bits per second and bursts -are measured in bytes. But when NG_CAR_COUNT_PACKETS option is enabled, +are measured in bytes. +But when NG_CAR_COUNT_PACKETS option is enabled, rates are measured in packets per second and bursts are in packets. .Sh CONTROL MESSAGES This node type supports the generic control messages and the following diff --git a/share/man/man4/ng_deflate.4 b/share/man/man4/ng_deflate.4 index 92710b4..fef00ff 100644 --- a/share/man/man4/ng_deflate.4 +++ b/share/man/man4/ng_deflate.4 @@ -154,5 +154,6 @@ control message, or when hook have been disconnected. .An Alexander Motin Aq Mt mav@alkar.net .Sh BUGS Due to nature of netgraph PPP implementation there are possible race conditions -between data packet and ResetAck CCP packet in case of packet loss. As result, +between data packet and ResetAck CCP packet in case of packet loss. +As result, packet loss can produce bigger performance degradation than supposed by protocol. diff --git a/share/man/man4/ng_hub.4 b/share/man/man4/ng_hub.4 index bdd3f42..bba9e11 100644 --- a/share/man/man4/ng_hub.4 +++ b/share/man/man4/ng_hub.4 @@ -54,8 +54,8 @@ This command sets the persistent flag on the node, and takes no arguments. .Sh SHUTDOWN This node shuts down upon receipt of a .Dv NGM_SHUTDOWN -control message, or when all hooks have been disconnected. Setting the -persistent flag via a +control message, or when all hooks have been disconnected. +Setting the persistent flag via a .Dv NGM_HUB_SET_PERSISTENT control message disables automatic node shutdown when the last hook gets disconnected. diff --git a/share/man/man4/ng_mppc.4 b/share/man/man4/ng_mppc.4 index 0d4d674..663cec8 100644 --- a/share/man/man4/ng_mppc.4 +++ b/share/man/man4/ng_mppc.4 @@ -35,7 +35,7 @@ .\" $Whistle: ng_mppc.8,v 1.1 1999/12/08 20:20:39 archie Exp $ .\" $FreeBSD$ .\" -.Dd December 8, 1999 +.Dd June 7, 2016 .Dt NG_MPPC 4 .Os .Sh NAME @@ -153,12 +153,6 @@ and are supplied to selectively compile in either or both capabilities. At least one of these must be defined, or else this node type is useless. .Pp -The MPPC protocol requires proprietary compression code available -from Hi/Fn (formerly STAC). -These files must be obtained elsewhere and added to the kernel -sources before this node type will compile with the -.Dv NETGRAPH_MPPC_COMPRESSION -option. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_ppp 4 , diff --git a/share/man/man4/ng_netflow.4 b/share/man/man4/ng_netflow.4 index 889c88a..5372f6c 100644 --- a/share/man/man4/ng_netflow.4 +++ b/share/man/man4/ng_netflow.4 @@ -74,8 +74,9 @@ plus two export hooks: .Va export (for NetFlow version 5) and .Va export9 -(for NetFlow version 9). Export can be done simultaneously for all supported -export hooks. By default (ingress NetFlow enabled) node does NetFlow accounting of data +(for NetFlow version 9). +Export can be done simultaneously for all supported export hooks. +By default (ingress NetFlow enabled) node does NetFlow accounting of data received on .Va iface* hooks. @@ -196,7 +197,8 @@ struct ng_netflow_setconfig { }; .Ed .Pp -Configuration is a bitmask of several options. Option NG_NETFLOW_CONF_INGRESS +Configuration is a bitmask of several options. +Option NG_NETFLOW_CONF_INGRESS enabled by default enables ingress NetFlow generation (for data coming from ifaceX hook). Option diff --git a/share/man/man4/ng_pptpgre.4 b/share/man/man4/ng_pptpgre.4 index fccecf8..867c86c 100644 --- a/share/man/man4/ng_pptpgre.4 +++ b/share/man/man4/ng_pptpgre.4 @@ -84,7 +84,8 @@ Connection to the lower protocol layers This node type supports the generic control messages, plus the following: .Bl -tag -width foo .It Dv NGM_PPTPGRE_SET_CONFIG Pq Ic setconfig -This command resets and configures hook for a session. If corresponding +This command resets and configures hook for a session. +If corresponding session_hhhh hook is not connected, upper hook will be configured. This command takes a .Vt "struct ng_pptpgre_conf" diff --git a/share/man/man4/ng_pred1.4 b/share/man/man4/ng_pred1.4 index 7befbbc..91a7103 100644 --- a/share/man/man4/ng_pred1.4 +++ b/share/man/man4/ng_pred1.4 @@ -141,5 +141,6 @@ control message, or when hook have been disconnected. .An Alexander Motin Aq Mt mav@alkar.net .Sh BUGS Due to nature of netgraph PPP implementation there are possible race conditions -between data packet and ResetAck CCP packet in case of packet loss. As result, +between data packet and ResetAck CCP packet in case of packet loss. +As result, packet loss can produce bigger performance degradation than supposed by protocol. diff --git a/share/man/man4/ng_tag.4 b/share/man/man4/ng_tag.4 index 6aac9fa..25bb7c3 100644 --- a/share/man/man4/ng_tag.4 +++ b/share/man/man4/ng_tag.4 @@ -230,7 +230,7 @@ node which will check for the specified string and return non-matching packets to .Xr ipfw 8 . Matching packets are passed to -.Xr ng_tag 4 +.Nm node, which will set a tag and pass them back to .Xr ng_bpf 4 node on a hook programmed to accept all packets and pass them back to @@ -246,7 +246,7 @@ expressions must be altered accordingly. Thus, there will be expression .Dq Li "ether[40:2]=0x244c && ether[42:4]=0x6f636b20" on incoming hook and empty expression to match all packets from -.Xr ng_tag 4 . +.Nm . .Pp So, this is .Xr ngctl 8 diff --git a/share/man/man4/nvd.4 b/share/man/man4/nvd.4 index f778679..a1e9aac 100644 --- a/share/man/man4/nvd.4 +++ b/share/man/man4/nvd.4 @@ -77,8 +77,9 @@ disks and cannot be partitioned. .Sh CONFIGURATION The .Nm -driver defines a system-wide maximum delete size for NVMe devices. The -default is 1GB. To select a different value, set the following tunable in +driver defines a system-wide maximum delete size for NVMe devices. +The default is 1GB. +To select a different value, set the following tunable in .Xr loader.conf 5 : .Bd -literal -offset indent hw.nvd.delete_max=<delete size in bytes> diff --git a/share/man/man4/nvme.4 b/share/man/man4/nvme.4 index 83ca8ae..6449ec5 100644 --- a/share/man/man4/nvme.4 +++ b/share/man/man4/nvme.4 @@ -89,7 +89,8 @@ not 0, and this driver follows that convention. By default, .Nm will create an I/O queue pair for each CPU, provided enough MSI-X vectors -and NVMe queue pairs can be allocated. If not enough vectors or queue +and NVMe queue pairs can be allocated. +If not enough vectors or queue pairs are available, nvme(4) will use a smaller number of queue pairs and assign multiple CPUs per queue pair. .Pp diff --git a/share/man/man4/nvram2env.4 b/share/man/man4/nvram2env.4 index 3678160..798e04e 100644 --- a/share/man/man4/nvram2env.4 +++ b/share/man/man4/nvram2env.4 @@ -35,11 +35,11 @@ .Sh DESCRIPTION .Nm implements a simple method of reading the NVRAM-like data and information -stored in flash and storing it in the kernel environment. It can then be -used by various device drivers at boot-time. +stored in flash and storing it in the kernel environment. +It can then be used by various device drivers at boot-time. .Pp -The NVRAM-like data is an array of zero terminated strings. Each string contains -the string name, "=" delimiter and the string value. +The NVRAM-like data is an array of zero terminated strings. +Each string contains the string name, "=" delimiter and the string value. .Pp .Nm copies the environment values into kernel environment using the kernel setenv call. @@ -63,13 +63,14 @@ maxsize - maximum size of data block. flags - control flags, used to select nvram type and enable/disable CRC check. .Bl -tag -width indent .It Fa 0x0001 -Avoid CRC checking. Currently CRC checking is not implemented, so to be future +Avoid CRC checking. +Currently CRC checking is not implemented, so to be future compatible, please set it to "1". .It Fa 0x0002 Use format "Generic", skip uint32_t field, then zero terminating array of strings. .It Fa 0x0004 -Use Broadcom CFE format. uint32_t signature "FLSH", uint32_t size, +Use Broadcom CFE format, uint32_t signature "FLSH", uint32_t size, three unused fields uint32_t, then data. .It Fa 0x0008 Use U-Boot format, uint32_t crc, then zero terminating array of strings. diff --git a/share/man/man4/oce.4 b/share/man/man4/oce.4 index 51ac5ec..c502283 100644 --- a/share/man/man4/oce.4 +++ b/share/man/man4/oce.4 @@ -1,6 +1,6 @@ .\" Copyright (C) 2013 Emulex .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions are met: .\" diff --git a/share/man/man4/pass.4 b/share/man/man4/pass.4 index 618b643..3a2e1e7 100644 --- a/share/man/man4/pass.4 +++ b/share/man/man4/pass.4 @@ -98,7 +98,7 @@ It is probably more useful to issue this ioctl through the device. .It CAMIOQUEUE union ccb * Queue a CCB to the -.Xr pass 4 +.Nm driver to be executed asynchronously. The caller may use .Xr select 2 , @@ -167,7 +167,7 @@ ioctl. An error will only be returned from the .Dv CAMIOGET ioctl if the -.Xr pass 4 +.Nm driver fails to copy data to the user process or if there are no completed CCBs available to retrieve. If no CCBs are available to retrieve, diff --git a/share/man/man4/pf.4 b/share/man/man4/pf.4 index b7b504d..6b16943 100644 --- a/share/man/man4/pf.4 +++ b/share/man/man4/pf.4 @@ -1077,7 +1077,7 @@ struct pfi_kif { }; .Ed .It Dv DIOCSETIFFLAG Fa "struct pfioc_iface *io" -Set the user setable flags (described above) of the +Set the user settable flags (described above) of the .Nm internal interface description. The filtering process is the same as for diff --git a/share/man/man4/proto.4 b/share/man/man4/proto.4 index 9638d4f..39f585d 100644 --- a/share/man/man4/proto.4 +++ b/share/man/man4/proto.4 @@ -108,7 +108,8 @@ system call can be used for the .Dv PROTO_IOC_REGION request. This ioctl request returns the extend of the resource covered by this -device special file. The extend is returned in the following structure: +device special file. +The extend is returned in the following structure: .Bd -literal struct proto_ioc_region { unsigned long address; @@ -200,8 +201,8 @@ The field is set on output with the key of the DMA tag. The tag is created with the constraints given by the .Va tag -sub-structure. These constraints correspond roughly to those that can be -given to the +sub-structure. +These constraints correspond roughly to those that can be given to the .Xr bus_dma_tag_create 9 function. .It PROTO_IOC_BUSDMA_TAG_DERIVE @@ -387,7 +388,8 @@ or .Pa mem representing I/O port or memory mapped I/O space (resp.) .Pp -ISA devices do not have a location. Instead, they are identified by the +ISA devices do not have a location. +Instead, they are identified by the first I/O port address or first memory mapped I/O address. Consequently, all device special files corresponding to an ISA device are located under diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index 866e447..df65c2c 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -110,7 +110,8 @@ The movement of the roller is reported as movement along the Z axis. 8 byte data packets are sent to the user program at this level. .Pp At the operation level two, data from the pointing device is passed to the -user program as is. Conversely, command from the user program is passed +user program as is. +Conversely, command from the user program is passed to the pointing device as is and the user program is responsible for status validation and error recovery. Modern PS/2 type pointing devices often use proprietary data format. @@ -352,7 +353,8 @@ to .Em 0 at boot-time. Currently, this is only supported on Synaptics touchpads with Extended -support disabled. The behaviour may be changed after boot by setting +support disabled. +The behaviour may be changed after boot by setting the sysctl with the same name and by restarting .Xr moused 8 using @@ -469,7 +471,7 @@ typedef struct synapticshw { int capPalmDetect; /* can detect a palm */ int capPassthrough; /* can passthrough guest packets */ int capMiddle; /* has a physical middle button */ - int nExtendedButtons; /* has N additionnal buttons */ + int nExtendedButtons; /* has N additional buttons */ int nExtendedQueries; /* supports N extended queries */ } synapticshw_t; .Ed diff --git a/share/man/man4/pts.4 b/share/man/man4/pts.4 index c142c50..2008482 100644 --- a/share/man/man4/pts.4 +++ b/share/man/man4/pts.4 @@ -119,9 +119,11 @@ remote login with proper back-flushing of output; it can be used by other similar programs. .It Dv TIOCGPTN Obtain device unit number, which can be used to generate the filename of -the pseudo-terminal slave device. This +the pseudo-terminal slave device. +This .Xr ioctl 2 -should not be used directly. Instead, the +should not be used directly. +Instead, the .Xr ptsname 3 function should be used. .It Dv TIOCPTMASTER @@ -129,7 +131,8 @@ Determine whether the file descriptor is pointing to a pseudo-terminal master device. This .Xr ioctl 2 -should not be used directly. It is used to implement routines like +should not be used directly. +It is used to implement routines like .Xr grantpt 3 . .El .Sh FILES diff --git a/share/man/man4/puc.4 b/share/man/man4/puc.4 index 34880cd..eb76c36 100644 --- a/share/man/man4/puc.4 +++ b/share/man/man4/puc.4 @@ -53,5 +53,5 @@ Support for new cards should be added there. .Sh HISTORY This driver took the idea from the .Nx -.Xr puc 4 +.Nm driver. diff --git a/share/man/man4/qlxgbe.4 b/share/man/man4/qlxgbe.4 index 32b7d34..fde9ef9 100644 --- a/share/man/man4/qlxgbe.4 +++ b/share/man/man4/qlxgbe.4 @@ -1,5 +1,5 @@ .\"- -.\" Copyright (c) 2013 Qlogic Corportaion +.\" Copyright (c) 2013 Qlogic Corportaion .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without diff --git a/share/man/man4/qlxge.4 b/share/man/man4/qlxge.4 index 21e6ce1..2da3a8d 100644 --- a/share/man/man4/qlxge.4 +++ b/share/man/man4/qlxge.4 @@ -1,5 +1,5 @@ .\"- -.\" Copyright (c) 2013-2014 Qlogic Corporation +.\" Copyright (c) 2013-2014 Qlogic Corporation .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without diff --git a/share/man/man4/random.4 b/share/man/man4/random.4 index 5e5388f..23578d0 100644 --- a/share/man/man4/random.4 +++ b/share/man/man4/random.4 @@ -48,7 +48,7 @@ it is seeded for the first time. This may cause trouble at system boot when keys and the like are generated from -.Xr random 4 +.Nm so steps should be taken to ensure a seeding as soon as possible. .Pp @@ -63,7 +63,7 @@ this could be done by This sysctl will not return random bytes unless the -.Xr random 4 +.Nm device is seeded. .Pp This initial seeding diff --git a/share/man/man4/rum.4 b/share/man/man4/rum.4 index 89af445..dfe2ab8 100644 --- a/share/man/man4/rum.4 +++ b/share/man/man4/rum.4 @@ -16,7 +16,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 13, 2008 +.Dd June 9, 2016 .Dt RUM 4 .Os .Sh NAME @@ -64,10 +64,14 @@ This chipset uses the MIMO (multiple-input multiple-output) technology with multiple antennas to extend the operating range of the adapter and to achieve higher throughput. .Pp +All chips have hardware support for WEP, AES-CCM, TKIP, and Michael +cryptographic operations. +.Pp .Nm supports .Cm station , .Cm adhoc , +.Cm adhoc-demo , .Cm hostap , and .Cm monitor @@ -182,7 +186,3 @@ driver was written by .An Niall O'Higgins Aq Mt niallo@openbsd.org and .An Damien Bergamini Aq Mt damien@openbsd.org . -.Sh BUGS -Host AP mode doesn't support client power save. -Clients using power save mode will experience -packet loss (disabling power saving on the client will fix this). diff --git a/share/man/man4/sdhci.4 b/share/man/man4/sdhci.4 index 8fd16ff..b4b14bc 100644 --- a/share/man/man4/sdhci.4 +++ b/share/man/man4/sdhci.4 @@ -58,8 +58,8 @@ detaches it on card removing. .Sh HARDWARE The .Nm -driver supports different specification compatible chips. The following -chips have been verified to work: +driver supports different specification compatible chips. +The following chips have been verified to work: .Pp .Bl -bullet -compact .It diff --git a/share/man/man4/sfxge.4 b/share/man/man4/sfxge.4 index 0232d23..9be27e0 100644 --- a/share/man/man4/sfxge.4 +++ b/share/man/man4/sfxge.4 @@ -153,8 +153,8 @@ from loss, because reducing the ACK rate can damage performance. .It Va hw.sfxge.mcdi_logging Enable logging of MCDI protocol messages (only available if enabled at compile-time). .It Va hw.sfxge.N.mcdi_logging -Enable or disable logging of MCDI protocol messages on a per-port basis. The default for each -port will be the value of +Enable or disable logging of MCDI protocol messages on a per-port basis. +The default for each port will be the value of .Va hw.sfxge.mcdi_logging. The logging may also be enabled or disabled after the driver is loaded using the sysctl .Va dev.sfxge.%d.mcdi_logging. diff --git a/share/man/man4/siba.4 b/share/man/man4/siba.4 index 12e263b..7fcb5e6 100644 --- a/share/man/man4/siba.4 +++ b/share/man/man4/siba.4 @@ -54,7 +54,8 @@ interblock communications architecture found in earlier Broadcom Home Networking Division wireless chipsets and embedded systems. .Pp A common interconnect connects all of the Silicon Backplane's functional -blocks. These functional blocks, known as cores, use the Open Core Protocol +blocks. +These functional blocks, known as cores, use the Open Core Protocol (OCP) interface to communicate with agents attached to the Silicon Backplane. .Pp @@ -86,7 +87,6 @@ driver was originally written by .An Bruce M. Simpson Aq Mt bms@FreeBSD.org and .An Weongyo Jeong Aq Mt weongyo@FreeBSD.org . - The driver was rewritten for .Fx 11.0 by diff --git a/share/man/man4/siftr.4 b/share/man/man4/siftr.4 index 7afa279..e122b5c 100644 --- a/share/man/man4/siftr.4 +++ b/share/man/man4/siftr.4 @@ -84,8 +84,8 @@ In the IPv4-only (default) mode, standard dotted decimal notation (e.g. "136.186.229.95") is used to format IPv4 addresses for logging. In IPv6 mode, standard dotted decimal notation is used to format IPv4 addresses, and standard colon-separated hex notation (see RFC 4291) is used to format IPv6 -addresses for logging. Note that SIFTR uses uncompressed notation to format IPv6 -addresses. +addresses for logging. +Note that SIFTR uses uncompressed notation to format IPv6 addresses. For example, the address "fe80::20f:feff:fea2:531b" would be logged as "fe80:0:0:0:20f:feff:fea2:531b". .Ss Run-time Configuration @@ -143,8 +143,9 @@ present in the example log messages in this section indicates a line continuation and is not part of the actual log message. .Pp The first type of log message is written to the file when the module is -enabled and starts collecting data from the running kernel. The text below -shows an example module enable log. The fields are tab delimited key-value +enabled and starts collecting data from the running kernel. +The text below shows an example module enable log. +The fields are tab delimited key-value pairs which describe some basic information about the system. .Bd -literal -offset indent enable_time_secs=1238556193 enable_time_usecs=462104 \\ @@ -289,8 +290,8 @@ The maximum segment size for the flow, in bytes. The current smoothed RTT estimate for the flow, in units of TCP_RTT_SCALE * HZ, where TCP_RTT_SCALE is a define found in tcp_var.h, and HZ is the kernel's tick timer. -Divide by TCP_RTT_SCALE * HZ to get the RTT in secs. TCP_RTT_SCALE and HZ are -reported in the enable log message. +Divide by TCP_RTT_SCALE * HZ to get the RTT in secs. +TCP_RTT_SCALE and HZ are reported in the enable log message. .El .Bl -tag -offset indent -width Va .It Va 18 @@ -307,8 +308,8 @@ for information about the various flags. .It Va 20 The current retransmission timeout length for the flow, in units of HZ, where HZ is the kernel's tick timer. -Divide by HZ to get the timeout length in seconds. HZ is reported in the -enable log message. +Divide by HZ to get the timeout length in seconds. +HZ is reported in the enable log message. .El .Bl -tag -offset indent -width Va .It Va 21 @@ -339,7 +340,8 @@ The current number of segments in the reassembly queue. .It Va 27 Flowid for the connection. A caveat: Zero '0' either represents a valid flowid or a default value when it's -not being set. There is no easy way to differentiate without looking at actual +not being set. +There is no easy way to differentiate without looking at actual network interface card and drivers being used. .El .Bl -tag -offset indent -width Va @@ -715,7 +717,8 @@ variable will create the new file and allow log messages to begin being written to disk again. The new log file path must differ from the path to the deleted file. .It -The hash table used within the code is sized to hold 65536 flows. This is not a +The hash table used within the code is sized to hold 65536 flows. +This is not a hard limit, because chaining is used to handle collisions within the hash table structure. However, we suspect (based on analogies with other hash table performance data) diff --git a/share/man/man4/simplebus.4 b/share/man/man4/simplebus.4 index 6834b38..337fc1e 100644 --- a/share/man/man4/simplebus.4 +++ b/share/man/man4/simplebus.4 @@ -51,7 +51,8 @@ controller, connectivity controllers, accelerating engines and so on. .Pp The driver is generic and common for all flattened device tree nodes claiming .Pa simple-bus -compatibility. It iterates over direct descendants of the +compatibility. +It iterates over direct descendants of the .Pa simple-bus node, instantiates newbus children and assigns resources to them, based on the configuration data retrieved from the nodes properties in @@ -78,5 +79,6 @@ support first appeared in The .Nm support was developed by Semihalf under sponsorship from the FreeBSD -Foundation. This manual page was written by +Foundation. +This manual page was written by .An Rafal Jaworowski . diff --git a/share/man/man4/snd_hda.4 b/share/man/man4/snd_hda.4 index 40a8862..6f9017a 100644 --- a/share/man/man4/snd_hda.4 +++ b/share/man/man4/snd_hda.4 @@ -322,8 +322,8 @@ driver. .It Va misc Misc bits. Can be specified as a number from 0 to 15. -Bit 0 has a special meaning. When set it means that jack detection is -not implemented in hardware. +Bit 0 has a special meaning. +When set it means that jack detection is not implemented in hardware. .El .Ss Runtime Configuration The following @@ -411,8 +411,8 @@ Here we can see, that the nodes with ID (nid) 25 and 27 are front panel connectors (Jack, Front), nids 20, 24 and 26 are rear panel connectors (Jack, Rear) and nid 21 is a built-in speaker (Fixed, Onboard). Pins with nids 22, 23, 28, 30 and 31 will be disabled by driver due to "None" -connectivity. So the pin count and description matches to connectors that -we have. +connectivity. +So the pin count and description matches to connectors that we have. .Pp Using association (as) and sequence (seq) fields values pins are grouped into 3 associations: @@ -473,8 +473,8 @@ hint.hdac.0.cad0.nid21.config="as=2" will swap line-out and speaker functions. So the .Li pcm0 -device will play to the line-out and headphones jacks. Line-out will -be muted on the headphones jack connection. +device will play to the line-out and headphones jacks. +Line-out will be muted on the headphones jack connection. Recording on .Li pcm0 will go from two external microphones and line-in jacks. @@ -576,7 +576,8 @@ PC speaker input other random inputs .El .Pp -Controls have different precision. Some could be just an on/off triggers. +Controls have different precision. +Some could be just an on/off triggers. Most of controls use logarithmic scale. .Sh HARDWARE The diff --git a/share/man/man4/stf.4 b/share/man/man4/stf.4 index 5e210df..786acb2 100644 --- a/share/man/man4/stf.4 +++ b/share/man/man4/stf.4 @@ -189,8 +189,9 @@ The default value is shown next to each variable. .Bl -tag -width indent .It Va net.link.stf.permit_rfc1918 : No 0 The RFC3056 requires the use of globally unique 32-bit IPv4 -addresses. This sysctl variable controls the behaviour of this -requirement. When it set to not 0, +addresses. +This sysctl variable controls the behaviour of this requirement. +When it set to not 0, .Nm stf allows the use of private IPv4 addresses described in the RFC1918. This may be useful for an Intranet environment or when some mechanisms diff --git a/share/man/man4/u3g.4 b/share/man/man4/u3g.4 index 0663a9a..ceec14b 100644 --- a/share/man/man4/u3g.4 +++ b/share/man/man4/u3g.4 @@ -91,8 +91,9 @@ In some of these devices a mass storage device supported by the .Xr umass 4 driver is present which contains Windows and Mac OS X drivers. The device starts up in disk mode (TruInstall, ZeroCD, etc.) and requires -additional commands to switch it to modem mode. If your device is not -switching automatically, please try to add quirks. See +additional commands to switch it to modem mode. +If your device is not switching automatically, please try to add quirks. +See .Xr usbconfig 8 and .Xr usb_quirk 4 . diff --git a/share/man/man4/unix.4 b/share/man/man4/unix.4 index 173fd0e..93cd399 100644 --- a/share/man/man4/unix.4 +++ b/share/man/man4/unix.4 @@ -241,7 +241,7 @@ These will arrive in the form of a filled in structure, defined in .In sys/ucred.h as follows: -.Bd -literal +.Bd -literal struct xucred { u_int cr_version; /* structure layout version */ uid_t cr_uid; /* effective user id */ diff --git a/share/man/man4/urtwn.4 b/share/man/man4/urtwn.4 index a4c1b9f..026c981 100644 --- a/share/man/man4/urtwn.4 +++ b/share/man/man4/urtwn.4 @@ -14,13 +14,15 @@ .\" .\" $FreeBSD$ .\" -.Dd October 15, 2015 +.Dd June 9, 2016 .Dt URTWN 4 .Os .Sh NAME .Nm urtwn .Nd Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device .Sh SYNOPSIS +.Cd "options URTWN_WITHOUT_UCODE" +.Pp To compile this driver into the kernel, place the following lines in your kernel configuration file: @@ -39,13 +41,6 @@ module at boot time, place the following line in .Bd -literal -offset indent if_urtwn_load="YES" .Ed -.Pp -In both cases, place the following line in -.Xr loader.conf 5 -to acknowledge the firmware license (see below): -.Bd -literal -offset indent -legal.realtek.license_ack=1 -.Ed .Sh DESCRIPTION The .Nm @@ -64,15 +59,21 @@ The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO) RF in a single chip. It operates in the 2GHz spectrum only. .Pp -This driver requires the firmware built with the -.Nm urtwnfw -module to work. -For the loaded firmware to be enabled for use the license at -.Pa /usr/share/doc/legal/realtek.LICENSE -must be agreed by adding the following line to -.Xr loader.conf 5 : +All chips have hardware support for WEP, AES-CCM and TKIP encryption. +.Pp +The driver supports +.Cm station , +.Cm adhoc , +.Cm hostap , +and +.Cm monitor +mode operation. +Only one virtual interface may be configured at any time. .Pp -.Dl "legal.realtek.license_ack=1" +This driver may use the firmware built with the +.Nm urtwnfw +module for some additional features +(when URTWN_WITHOUT_UCODE kernel option is not set). .Sh FILES .Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact .It Pa /usr/share/doc/legal/realtek.LICENSE @@ -117,6 +118,28 @@ Join a specific BSS network with 64-bit WEP encryption: ifconfig wlan create wlandev urtwn0 ssid my_net \e wepmode on wepkey 0x1234567890 weptxkey 1 up .Ed +.Pp +Create an IBSS network with 128-bit WEP encryption on the channel 4: +.Bd -literal -offset indent +ifconfig wlan0 create wlandev urtwn0 wlanmode adhoc ssid my_net \e + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 \e + channel 4 +.Ed +.Pp +Join/create an 802.11b IBSS network with network name +.Dq Li my_net : +.Bd -literal -offset indent +ifconfig wlan0 create wlandev urtwn0 wlanmode adhoc +ifconfig wlan0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e + mode 11b +.Ed +.Pp +Create an 802.11g host-based access point: +.Bd -literal -offset indent +ifconfig wlan0 create wlandev urtwn0 wlanmode hostap +ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e + mode 11g +.Ed .Sh DIAGNOSTICS .Bl -diag .It "urtwn%d: error %d, could not read firmware %s" @@ -134,6 +157,7 @@ This should not happen. .Xr urtwnfw 4 , .Xr usb 4 , .Xr wlan 4 , +.Xr wlan_amrr 4 , .Xr wlan_ccmp 4 , .Xr wlan_tkip 4 , .Xr wlan_wep 4 , @@ -158,5 +182,9 @@ driver was written by .Sh CAVEATS The .Nm -driver does not support any of the 802.11n capabilities offered by the -adapters. +driver currently does not support A-MPDU 802.11n transmit aggregation. +.Pp +For non-RTL8188EUS chips +.Dq "rate control" +algorithm is absent; this may result in increased packet loss in noisy +networks. diff --git a/share/man/man4/usb_template.4 b/share/man/man4/usb_template.4 index e4dba2c..2cc1ee4 100644 --- a/share/man/man4/usb_template.4 +++ b/share/man/man4/usb_template.4 @@ -23,7 +23,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd March 18, 2014 +.Dd June 8, 2016 .Dt USB_TEMPLATE 4 .Os . @@ -32,7 +32,7 @@ . .Nm usb_template . -.Nd "USB templates" +.Nd "USB device side templates" . . .Sh SYNOPSIS @@ -59,19 +59,33 @@ configuration descriptors, one or more USB interface descriptors, one or more USB endpoint descriptors, USB strings and additional USB descriptors. . -The USB template module currently has templates for USB Mass Storage, -USB CDC Ethernet and Message Transfer Protocol. +USB templates are selected using the +.Va hw.usb.template +sysctl and tunable. . -USB templates are currently selected using the "hw.usb.template" -sysctl. -. -The "hw.usb.template" value can be changed at any time, but will not +The +.Va hw.usb.template +value can be changed at any time, but will not have any effect until the USB device has been re-enumerated. . -. +Available templates are: +.Bl -column -offset 3n "Value" +.It Em Value Ta Em Description +.It Dv 0 Ta USB Mass Storage +.It Dv 1 Ta CDC Ethernet +.It Dv 2 Ta Media Transfer Protocol (MTP) +.It Dv 3 Ta USB serial port +.It Dv 4 Ta USB audio +.It Dv 5 Ta USB keyboard +.It Dv 6 Ta USB mouse +.It Dv 7 Ta USB phone +.It Dv 8 Ta CDC Ethernet and serial port +.It Dv 9 Ta USB MIDI +.El . .Sh SEE ALSO -.Xr usb 4 +.Xr usb 4 , +.Xr usfs 4 .Sh STANDARDS The .Nm diff --git a/share/man/man4/usfs.4 b/share/man/man4/usfs.4 index a72a8d8..ef75785 100644 --- a/share/man/man4/usfs.4 +++ b/share/man/man4/usfs.4 @@ -22,10 +22,10 @@ .\" 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 March 18, 2014 +.Dd June 8, 2016 .Dt USFS 4 .Os .Sh NAME @@ -50,12 +50,17 @@ usfs_load="YES" The .Nm driver provides support for emulating an USB mass storage device when -the USB stack is activated in USB device side mode. +the USB stack is activated in USB device side mode (the +.Xr usb_template 4 +module is loaded and the +.Va hw.usb.template +sysctl is set to 0). .Pp Upon attach the driver creates a RAM disk which can be read and written. .Sh SEE ALSO .Xr umass 4 , -.Xr usb 4 +.Xr usb 4 , +.Xr usb_template 4 .Sh HISTORY The .Nm diff --git a/share/man/man4/vale.4 b/share/man/man4/vale.4 index 4eeab1a..722d8f0 100644 --- a/share/man/man4/vale.4 +++ b/share/man/man4/vale.4 @@ -21,7 +21,7 @@ .\" 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. -.\" +.\" .\" This document is derived in part from the enet man page (enet.4) .\" distributed with 4.3BSD Unix. .\" diff --git a/share/man/man4/virtio_scsi.4 b/share/man/man4/virtio_scsi.4 index f65f8b7..3828eef 100644 --- a/share/man/man4/virtio_scsi.4 +++ b/share/man/man4/virtio_scsi.4 @@ -57,8 +57,9 @@ prompt before booting the kernel or stored in .It Va hw.vtscsi.bus_reset_disable In the initial QEMU release with VirtIO SCSI support, in-flight operations were not aborted when stopping the device, rendering -bus reset ineffective. This tunable disables attempts to issue -reset bus commands. The default value is 1. +bus reset ineffective. +This tunable disables attempts to issue reset bus commands. +The default value is 1. .El .Sh DEBUGGING To enable debugging prints from the diff --git a/share/man/man4/vlan.4 b/share/man/man4/vlan.4 index a47f68c..480d026 100644 --- a/share/man/man4/vlan.4 +++ b/share/man/man4/vlan.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 4, 2012 +.Dd June 8, 2016 .Dt VLAN 4 .Os .Sh NAME diff --git a/share/man/man4/witness.4 b/share/man/man4/witness.4 index 02505aa..fc745d5 100644 --- a/share/man/man4/witness.4 +++ b/share/man/man4/witness.4 @@ -62,7 +62,7 @@ If any of these checks fail, then the kernel will panic. The .Dv WITNESS_COUNT kernel option controls the maximum number of -.Xr witness 4 +.Nm entries that are tracked in the kernel. The maximum number of entries can be queried via the .Va debug.witness.count @@ -76,7 +76,7 @@ environment variable. The .Dv WITNESS_NO_VNODE kernel option tells -.Xr witness 4 +.Nm to ignore locking issues between .Xr vnode 9 objects. @@ -118,7 +118,8 @@ The sysctl specifies the level of witness involvement in the system. A value of 1 specifies that witness is enabled. A value of 0 specifies that witness is disabled, but that can be enabled -again. This will maintain a small amount of overhead in the system. +again. +This will maintain a small amount of overhead in the system. A value of -1 specifies that witness is disabled permanently and cannot be enabled again. The sysctl diff --git a/share/man/man5/ar.5 b/share/man/man5/ar.5 index 1c1d79b..ca9f96d 100644 --- a/share/man/man5/ar.5 +++ b/share/man/man5/ar.5 @@ -70,7 +70,7 @@ file attributes associated with the member. An archive header describes the file attributes for the archive member that follows it. The -.Xr ar 5 +.Nm format only supports a limited number of attributes: the file name, the file creation time stamp, the uid and gid of the creator, the file mode and the file size. diff --git a/share/man/man5/devfs.rules.5 b/share/man/man5/devfs.rules.5 index b8016db..ca62377 100644 --- a/share/man/man5/devfs.rules.5 +++ b/share/man/man5/devfs.rules.5 @@ -90,7 +90,8 @@ configuration file. .It Pa /etc/devfs.rules Local .Nm -configuration file. Rulesets in here override those in +configuration file. +Rulesets in here override those in .Pa /etc/defaults/devfs.rules with the same ruleset number, otherwise the two files are effectively merged. .El diff --git a/share/man/man5/elf.5 b/share/man/man5/elf.5 index a72eed6..42e6b2c 100644 --- a/share/man/man5/elf.5 +++ b/share/man/man5/elf.5 @@ -1308,5 +1308,5 @@ This manual page was written by .An Jeroen Ruigrok van der Werven Aq Mt asmodai@FreeBSD.org with inspiration from BSDi's .Bsx -.Xr elf 5 +.Nm manpage. diff --git a/share/man/man5/nandfs.5 b/share/man/man5/nandfs.5 index 230989e..7e89599 100644 --- a/share/man/man5/nandfs.5 +++ b/share/man/man5/nandfs.5 @@ -109,7 +109,8 @@ partition at the specified mount point during system boot. .Xr umount_nandfs 8 .Sh HISTORY The NAND FS concepts are based on NILFS principles and initial implementation -was derived from early read-only NILFS NetBSD code. Since then the NAND FS +was derived from early read-only NILFS NetBSD code. +Since then the NAND FS code diverged significantly and is by no means compatible with NILFS. .Pp The NAND Flash file system first appeared in diff --git a/share/man/man5/nsswitch.conf.5 b/share/man/man5/nsswitch.conf.5 index b1fbbd4..ec5d94c 100644 --- a/share/man/man5/nsswitch.conf.5 +++ b/share/man/man5/nsswitch.conf.5 @@ -33,7 +33,7 @@ .\" .\" $FreeBSD$ .\" -.Dd December 25, 2013 +.Dd June 6, 2016 .Dt NSSWITCH.CONF 5 .Os .Sh NAME @@ -148,7 +148,9 @@ The following databases are used by the following C library functions: .Xr getprotoent 3 .It netgroup .Xr getnetgrent 3 , +.Xr getnetgrent_r 3 , .Xr setnetgrent 3 , +.Xr endnetgrent 3 , .Xr innetgr 3 .El .Ss Status codes @@ -221,7 +223,7 @@ and continue on anything else (i.e, You can enable caching for the particular database by specifying .Dq cache as the first source in the -.Xr nsswitch.conf 5 +.Nm file. You should also enable caching for this database in .Xr nscd.conf 5 . diff --git a/share/man/man5/quota.user.5 b/share/man/man5/quota.user.5 index c314b65..0bcc591 100644 --- a/share/man/man5/quota.user.5 +++ b/share/man/man5/quota.user.5 @@ -98,7 +98,8 @@ utility will truncate the data files to the minimum size needed to store the highest id with either non-zero file usage or non-zero quota limits. .Pp -The data record for id 0 has special meaning. If the +The data record for id 0 has special meaning. +If the .Dq Dv dqb_btime or .Dq Dv dbq_itime diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index ae4972e..2ce3a0e 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 30, 2016 +.Dd June 8, 2016 .Dt RC.CONF 5 .Os .Sh NAME @@ -189,7 +189,8 @@ to this directory before running the service. Run the service under this user account. .It Ao Ar name Ac Ns Va _group .Pq Vt str -Run the chrooted service under this system group. Unlike the _user +Run the chrooted service under this system group. +Unlike the _user setting, this setting has no effect if the service is not chrooted. .It Ao Ar name Ac Ns Va _fib .Pq Vt int @@ -944,7 +945,8 @@ interface is desired, .Va pflog_instances is set to the list of .Xr pflogd 8 -instances that should be started at system boot time. If +instances that should be started at system boot time. +If .Va pflog_instances is set, for each whitespace-seperated .Ar element @@ -983,11 +985,13 @@ This variable contains additional flags passed to the program. .It Va ftpproxy_instances .Pq Vt str -Empty by default. If multiple instances of +Empty by default. +If multiple instances of .Xr ftp-proxy 8 are desired at boot time, .Va ftpproxy_instances -should contain a whitespace-seperated list of instance names. For each +should contain a whitespace-seperated list of instance names. +For each .Ar element in the list, a variable named .Ao Ar element Ac Ns Va _flags @@ -1203,12 +1207,12 @@ Note that the maximum number of the generated addresses from a range specification is limited to an integer value specified in .Va netif_ipexpand_max in -.Xr rc.conf 5 +.Nm because a small typo can unexpectedly generate a large number of addresses. The default value is .Li 2048 . It can be increased by adding the following line into -.Xr rc.conf 5 : +.Nm : .Bd -literal netif_ipexpand_max="4096" .Ed @@ -2559,6 +2563,22 @@ is set to these are the flags to pass to the .Xr ypbind 8 service. +.It Va nis_ypldap_enable +.Pq Vt bool +If set to +.Dq Li YES , +run the +.Xr ypldap 8 +daemon at system boot time. +.It Va nis_ypldap_flags +.Pq Vt str +If +.Va nis.ypldap_enable +is set to +.Dq Li YES , +these are the flags to pass to the +.Xr ypldap 8 +daemon. .It Va nis_ypset_enable .Pq Vt bool If set to @@ -3880,7 +3900,7 @@ all configured jails in are stopped in reverse order. .It Va jail_* variables Note that older releases supported per-jail configuration via -.Xr rc.conf 5 +.Nm variables. For example, hostname of a jail named diff --git a/share/man/man5/src.conf.5 b/share/man/man5/src.conf.5 index 2e5dfce..c88f9a0 100644 --- a/share/man/man5/src.conf.5 +++ b/share/man/man5/src.conf.5 @@ -1,7 +1,7 @@ .\" DO NOT EDIT-- this file is automatically generated. .\" from FreeBSD: head/tools/build/options/makeman 292283 2015-12-15 18:42:30Z bdrewery .\" $FreeBSD$ -.Dd June 5, 2016 +.Dd June 14, 2016 .Dt SRC.CONF 5 .Os .Sh NAME @@ -190,6 +190,24 @@ as part of the bootstrap process. .Pp It is a default setting on amd64/amd64, arm/arm, arm/armeb, arm/armv6, i386/i386, mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, pc98/i386, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64. +.It Va WITHOUT_BLACKLIST +.\" from FreeBSD: head/tools/build/options/WITHOUT_BLACKLIST 301554 2016-06-07 16:35:55Z lidl +Set this if you do not want to build blacklistd / blacklistctl. +When set, it also enforces the following options: +.Pp +.Bl -item -compact +.It +.Va WITHOUT_BLACKLIST_SUPPORT +.El +.It Va WITHOUT_BLACKLIST_SUPPORT +.\" from FreeBSD: head/tools/build/options/WITHOUT_BLACKLIST_SUPPORT 301554 2016-06-07 16:35:55Z lidl +Set to build some programs without blacklistd support, like +.Xr fingerd 8 , +.Xr ftpd 8 , +.Xr rlogind 8 , +.Xr rshd 8 , +and +.Xr sshd 8 . .It Va WITHOUT_BLUETOOTH .\" from FreeBSD: head/tools/build/options/WITHOUT_BLUETOOTH 156932 2006-03-21 07:50:50Z ru Set to not build Bluetooth related kernel modules, programs and libraries. @@ -1062,7 +1080,7 @@ Set to not build utilities for manual pages, .Xr manctl 8 , and related support files. .It Va WITH_META_MODE -.\" from FreeBSD: head/tools/build/options/WITH_META_MODE 301474 2016-06-05 23:14:06Z bdrewery +.\" from FreeBSD: head/tools/build/options/WITH_META_MODE 301889 2016-06-14 16:20:25Z bdrewery Creates .Xr make 1 meta files when building, which can provide a reliable incremental build when @@ -1071,9 +1089,13 @@ using The meta file is created in the OBJDIR as .Pa target.meta . These meta files track the command ran, its output, and the current directory. -When the +The .Xr filemon 4 -module is loaded, any files used by the commands executed will be tracked as +module is required unless +.Va NO_FILEMON +is defined. +When the module is loaded, any files used by the commands executed will be +tracked as dependencies for the target in its meta file. The target will be considered out-of-date and rebuilt if any of the following are true compared to the last build: @@ -1101,6 +1123,9 @@ The meta files can also be useful for debugging. The build will hide commands ran unless .Va NO_SILENT is defined. +Errors will cause +.Xr make 1 +to show some of its environment for further debugging. .Pp The build operates as it normally would otherwise. This option originally invoked a different build system but that was renamed diff --git a/share/man/man8/nanobsd.8 b/share/man/man8/nanobsd.8 index f12434f..7f4e219 100644 --- a/share/man/man8/nanobsd.8 +++ b/share/man/man8/nanobsd.8 @@ -219,7 +219,8 @@ Path to the source tree used to build the image. .It Va NANO_KERNEL Name of the kernel configuration file used to build the kernel. .It Va NANO_ARCH -Machine processor architecture to build. Defaults to output of +Machine processor architecture to build. +Defaults to output of .Cm uname -p . .It Va NANO_BOOT0CFG Controls the options passed to diff --git a/share/man/man9/BUS_NEW_PASS.9 b/share/man/man9/BUS_NEW_PASS.9 index 1da2f67..e647f8f 100644 --- a/share/man/man9/BUS_NEW_PASS.9 +++ b/share/man/man9/BUS_NEW_PASS.9 @@ -44,7 +44,7 @@ The method is called on each bus device to rescan the device tree when the pass level has been changed. This method is responsible for invoking -.Xr BUS_NEW_PASS 9 +.Nm on child bus devices to propagate the rescan to child devices. It is also responsible for reprobing any unattached child devices and allowing drivers for the current pass to identify new children. diff --git a/share/man/man9/EVENTHANDLER.9 b/share/man/man9/EVENTHANDLER.9 index c8f3002..ebf02e1 100644 --- a/share/man/man9/EVENTHANDLER.9 +++ b/share/man/man9/EVENTHANDLER.9 @@ -197,11 +197,11 @@ Callbacks invoked on error of application core dump. .It Vt bpf_track Callbacks invoked when a BPF listener attaches to/detaches from network interface. .It Vt cpufreq_levels_changed -Callback invoked when cpu frequence levels have changed. +Callback invoked when cpu frequency levels have changed. .It Vt cpufreq_post_change -Callback invoked after cpu frequence has changed. +Callback invoked after cpu frequency has changed. .It Vt cpufreq_pre_change -Callback invoked before cpu frequence has changed +Callback invoked before cpu frequency has changed. .It Vt dcons_poll Callback invoked to poll for dcons changes. .It Vt dev_clone diff --git a/share/man/man9/SYSCALL_MODULE.9 b/share/man/man9/SYSCALL_MODULE.9 index 8fc92aa..aec57a8 100644 --- a/share/man/man9/SYSCALL_MODULE.9 +++ b/share/man/man9/SYSCALL_MODULE.9 @@ -84,7 +84,7 @@ and library functions in libc. The MACRO .Fn SYSCALL_MODULE_HELPER -includes +includes .Fn SYSCALL_MODULE and much of its boilerplate code. .Sh EXAMPLES diff --git a/share/man/man9/bpf.9 b/share/man/man9/bpf.9 index ebf26cb..cddff70 100644 --- a/share/man/man9/bpf.9 +++ b/share/man/man9/bpf.9 @@ -256,8 +256,8 @@ Pointer to .Pq Vt "struct ifnet *" is passed as the first argument, interface .Fa dlt -follows. Last argument indicates listener is attached (1) or -detached (0). +follows. +Last argument indicates listener is attached (1) or detached (0). Note that handler is invoked with .Nm global lock held, which implies restriction on sleeping and calling diff --git a/share/man/man9/counter.9 b/share/man/man9/counter.9 index a89d14d..f717b64 100644 --- a/share/man/man9/counter.9 +++ b/share/man/man9/counter.9 @@ -154,7 +154,7 @@ A read of the oid returns value obtained through Any write to the oid zeroes it. .It Fn SYSCTL_COUNTER_U64_ARRAY parent nbr name access ptr len descr Declare a static -.Xr sysctl +.Xr sysctl oid that would represent an array of .Nm . The @@ -172,7 +172,7 @@ Any write to the oid zeroes all array elements. .It Fn SYSCTL_ADD_COUNTER_U64_ARRAY ctx parent nbr name access ptr len descr Create a .Xr sysctl -oid that would represent an array of +oid that would represent an array of .Nm . The .Fa ptr @@ -181,9 +181,9 @@ argument should be a pointer to allocated array of The .Fa len argument should specify number of elements in the array. -A read of the oid returns len-sized array of -.Vt uint64_t -values obtained through +A read of the oid returns len-sized array of +.Vt uint64_t +values obtained through .Fn counter_u64_fetch . Any write to the oid zeroes all array elements. .El diff --git a/share/man/man9/firmware.9 b/share/man/man9/firmware.9 index f8c8b32..d600652 100644 --- a/share/man/man9/firmware.9 +++ b/share/man/man9/firmware.9 @@ -97,7 +97,8 @@ by calling the function .Fn firmware_get with the .Nm imagename -they want as an argument. If a matching image is not already registered, +they want as an argument. +If a matching image is not already registered, the firmware subsystem will try to load it using the mechanisms specified below (typically, a kernel module with @@ -127,7 +128,8 @@ pointer to the image requested. .Fn firmware_unregister tries to unregister the firmware image .Nm imagename -from the system. The function is successful and returns 0 +from the system. +The function is successful and returns 0 if there are no pending references to the image, otherwise it does not unregister the image and returns EBUSY. .Pp @@ -148,7 +150,8 @@ already mounted. On success, .Fn firmware_get returns a pointer to the image description and increases the reference count -for this image. On failure, the function returns NULL. +for this image. +On failure, the function returns NULL. .Pp .Fn firmware_put drops a reference to a firmware image. diff --git a/share/man/man9/kqueue.9 b/share/man/man9/kqueue.9 index ff379d1..ee56358 100644 --- a/share/man/man9/kqueue.9 +++ b/share/man/man9/kqueue.9 @@ -345,12 +345,12 @@ will have .Dv EV_ONESHOT set so that the .Vt knote -will be returned and removed durning the next scan. +will be returned and removed during the next scan. The .Va f_detach function will be called when the .Vt knote -is deleted durning the next scan. +is deleted during the next scan. This function must not be used when .Va f_isfd is set in diff --git a/share/man/man9/lock.9 b/share/man/man9/lock.9 index 3ac23db..db99cad 100644 --- a/share/man/man9/lock.9 +++ b/share/man/man9/lock.9 @@ -215,7 +215,8 @@ The flag allows exclusive requests to preempt the current shared request even if the current thread owns shared locks. This is safe since shared lock is guaranteed to not recurse, and is used when thread is known to held unrelated shared locks, to not cause -unnecessary starvation. An example is +unnecessary starvation. +An example is .Dv vp locking in VFS .Xr lookup 9 , diff --git a/share/man/man9/locking.9 b/share/man/man9/locking.9 index 30d3b92..06428e2 100644 --- a/share/man/man9/locking.9 +++ b/share/man/man9/locking.9 @@ -335,7 +335,8 @@ running inside an interrupt thread. .El .Ss Interaction table The following table shows what you can and can not do while holding -one of the locking primitives discussed. Note that +one of the locking primitives discussed. +Note that .Dq sleep includes .Fn sema_wait , diff --git a/share/man/man9/pmap.9 b/share/man/man9/pmap.9 index f7edc33..231749c 100644 --- a/share/man/man9/pmap.9 +++ b/share/man/man9/pmap.9 @@ -87,7 +87,6 @@ and it must be updated by the implementation after each relevant .Nm operation. .Sh SEE ALSO -.Xr pmap 9 , .Xr pmap_activate 9 , .Xr pmap_clear_modify 9 , .Xr pmap_copy 9 , diff --git a/share/man/man9/stack.9 b/share/man/man9/stack.9 index 85640df..06065bd 100644 --- a/share/man/man9/stack.9 +++ b/share/man/man9/stack.9 @@ -171,10 +171,10 @@ is returned if the operation is not implemented. .Sh AUTHORS .An -nosplit The -.Xr stack 9 +.Nm function suite was created by .An Antoine Brodin . -.Xr stack 9 +.Nm was extended by .An Robert Watson for general-purpose use outside of diff --git a/share/man/man9/sysctl.9 b/share/man/man9/sysctl.9 index 097cc97d..6b9098d 100644 --- a/share/man/man9/sysctl.9 +++ b/share/man/man9/sysctl.9 @@ -628,7 +628,8 @@ system boot. .It Dv CTLFLAG_NOFETCH In case the node is marked as a tunable using the CTLFLAG_[XX]TUN, this flag will prevent fetching the initial value from the system -environment. Typically this flag should only be used for very early +environment. +Typically this flag should only be used for very early low level system setup code, and not by common drivers and modules. .El .Pp @@ -780,7 +781,8 @@ Use positive logic instead: .Va foobar_enable . .Pp A temporary sysctl node OID that should not be relied upon must be designated -as such by a leading underscore character in its name. For example: +as such by a leading underscore character in its name. +For example: .Va _dirty_hack . .Sh SEE ALSO .Xr sysctl 3 , diff --git a/share/man/man9/timeout.9 b/share/man/man9/timeout.9 index ee30942..df8538e 100644 --- a/share/man/man9/timeout.9 +++ b/share/man/man9/timeout.9 @@ -268,7 +268,8 @@ then that lock must be held when this function is called. Note that when stopping multiple callouts that use the same lock it is possible to get multiple return's of zero and multiple calls to the .Fa drain -function, depending upon which CPU's the callouts are running. The +function, depending upon which CPU's the callouts are running. +The .Fa drain function itself is called from the context of the completing callout i.e. softclock or hardclock, just like a callout itself. @@ -813,7 +814,8 @@ and .Fn callout_drain functions return a value of one if the callout was still pending when it was called, a zero if the callout could not be stopped and a negative one is it -was either not running or haas already completed. The +was either not running or haas already completed. +The .Fn timeout function returns a .Ft struct callout_handle diff --git a/share/man/man9/usbdi.9 b/share/man/man9/usbdi.9 index a42626a..588c79e 100644 --- a/share/man/man9/usbdi.9 +++ b/share/man/man9/usbdi.9 @@ -157,7 +157,8 @@ available. .Fa udev is a pointer to "struct usb_device". .Fa ifaces -is an array of interface index numbers to use. See "if_index". +is an array of interface index numbers to use. +See "if_index". .Fa pxfer is a pointer to an array of USB transfer pointers that are initialized to NULL, and then pointed to allocated USB transfers. @@ -171,9 +172,10 @@ is the private softc pointer, which will be used to initialize "xfer->priv_sc". .Fa priv_mtx is the private mutex protecting the transfer structure and the -softc. This pointer is used to initialize "xfer->priv_mtx". -This function returns -zero upon success. A non-zero return value indicates failure. +softc. +This pointer is used to initialize "xfer->priv_mtx". +This function returns zero upon success. +A non-zero return value indicates failure. . .Pp . @@ -245,8 +247,8 @@ pointer. . The USB callback has three states. . -USB_ST_SETUP, USB_ST_TRANSFERRED and USB_ST_ERROR. USB_ST_SETUP is the -initial state. +USB_ST_SETUP, USB_ST_TRANSFERRED and USB_ST_ERROR. +USB_ST_SETUP is the initial state. . After the callback has been called with this state it will always be called back at a later stage in one of the other two states. @@ -323,7 +325,8 @@ The SETUP packet is always pointed to by frame 0 and the length is set by .Fn usbd_xfer_frame_len also if there should not be -sent any SETUP packet! If an USB control transfer has no DATA stage, +sent any SETUP packet! +If an USB control transfer has no DATA stage, then the number of frames should be set to 1. . Else the default number of frames is 2. @@ -440,10 +443,12 @@ Depending on the endpoint type, this field has different meaning: "0" use the default interrupt interval based on endpoint descriptor. "Else" use the given value for polling rate. .It UE_ISOCHRONOUS -"0" use default. "Else" the value is ignored. +"0" use default. +"Else" the value is ignored. .It UE_BULK .It UE_CONTROL -"0" no transfer pre-delay. "Else" a delay as given by this field in +"0" no transfer pre-delay. +"Else" a delay as given by this field in milliseconds is inserted before the hardware is started when "usbd_transfer_submit()" is called. .Pp @@ -453,14 +458,14 @@ pre-delay has elapsed! . .Pp .Fa timeout -field, if non-zero, will set the transfer timeout in milliseconds. If -the "timeout" field is zero and the transfer type is ISOCHRONOUS a +field, if non-zero, will set the transfer timeout in milliseconds. +If the "timeout" field is zero and the transfer type is ISOCHRONOUS a timeout of 250ms will be used. . .Pp .Fa frames -field sets the maximum number of frames. If zero is specified it will -yield the following results: +field sets the maximum number of frames. +If zero is specified it will yield the following results: .Bl -tag -width "UE_INTERRUPT" .It UE_BULK xfer->nframes = 1; @@ -469,7 +474,8 @@ xfer->nframes = 1; .It UE_CONTROL xfer->nframes = 2; .It UE_ISOCHRONOUS -Not allowed. Will cause an error. +Not allowed. +Will cause an error. .El . .Pp @@ -486,26 +492,29 @@ be used when setting up the given USB transfer. .Pp .Fa flags field has type "struct usb_xfer_flags" and allows one to set initial -flags an USB transfer. Valid flags are: +flags an USB transfer. +Valid flags are: .Bl -tag -width "force_short_xfer" .It force_short_xfer -This flag forces the last transmitted USB packet to be short. A short -packet has a length of less than "xfer->max_packet_size", which -derives from "wMaxPacketSize". This flag can be changed during -operation. +This flag forces the last transmitted USB packet to be short. +A short packet has a length of less than "xfer->max_packet_size", which +derives from "wMaxPacketSize". +This flag can be changed during operation. .It short_xfer_ok This flag allows the received transfer length, "xfer->actlen" to be -less than "xfer->sumlen" upon completion of a transfer. This flag can -be changed during operation. +less than "xfer->sumlen" upon completion of a transfer. +This flag can be changed during operation. .It short_frames_ok -This flag allows the reception of multiple short USB frames. This flag +This flag allows the reception of multiple short USB frames. +This flag only has effect for BULK and INTERRUPT endpoints and if the number of -frames received is greater than 1. This flag can be changed during -operation. +frames received is greater than 1. +This flag can be changed during operation. .It pipe_bof This flag causes a failing USB transfer to remain first in the PIPE queue except in the case of "xfer->error" equal to -"USB_ERR_CANCELLED". No other USB transfers in the affected PIPE queue +"USB_ERR_CANCELLED". +No other USB transfers in the affected PIPE queue will be started until either: .Bl -tag -width "X" .It 1 @@ -569,8 +578,8 @@ This flag can be changed during operation. . . .It no_pipe_ok -Setting this flag causes the USB_ERR_NO_PIPE error to be ignored. This -flag can not be changed during operation. +Setting this flag causes the USB_ERR_NO_PIPE error to be ignored. +This flag can not be changed during operation. . . .It stall_pipe @@ -614,7 +623,8 @@ request structure. . .Pp .Fa callback -pointer sets the USB callback. This field is mandatory. +pointer sets the USB callback. +This field is mandatory. . . .Sh USB LINUX COMPAT LAYER @@ -635,7 +645,8 @@ module complies with the USB 2.0 standard. The .Nm usb module has been inspired by the NetBSD USB stack initially written by -Lennart Augustsson. The +Lennart Augustsson. +The .Nm usb module was written by .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org . diff --git a/share/man/man9/vn_fullpath.9 b/share/man/man9/vn_fullpath.9 index 50c35c9..f961fbb 100644 --- a/share/man/man9/vn_fullpath.9 +++ b/share/man/man9/vn_fullpath.9 @@ -73,7 +73,8 @@ The thread performing the call; this pointer will be dereferenced to find the process and its file descriptor structure, in order to identify the root vnode to use. .It Fa vp -The vnode to search for. No need to be locked by the caller. +The vnode to search for. +No need to be locked by the caller. .It Fa retbuf Pointer to a .Vt "char *" diff --git a/share/man/man9/zone.9 b/share/man/man9/zone.9 index 5047107..69d1f20 100644 --- a/share/man/man9/zone.9 +++ b/share/man/man9/zone.9 @@ -320,8 +320,10 @@ The .Fn uma_zone_set_maxaction function sets a function that will be called when the given zone becomes full and fails to allocate an item. -The function will be called with the zone locked. Also, the function -that called the allocation function may have held additional locks. Therefore, +The function will be called with the zone locked. +Also, the function +that called the allocation function may have held additional locks. +Therefore, this function should do very little work (similar to a signal handler). .Pp The diff --git a/share/misc/committers-ports.dot b/share/misc/committers-ports.dot index fd425b5..df62cd3 100644 --- a/share/misc/committers-ports.dot +++ b/share/misc/committers-ports.dot @@ -226,6 +226,7 @@ tota [label="TAKATSU Tomonari\ntota@FreeBSD.org\n2009/03/30"] trasz [label="Edward Tomasz Napierala\ntrasz@FreeBSD.org\n2007/04/12"] trhodes [label="Tom Rhodes\ntrhodes@FreeBSD.org\n2004/07/06"] trociny [label="Mikolaj Golub\ntrociny@FreeBSD.org\n2013/10/17"] +tz [label="Torsten Zuehlsdorff\ntz@FreeBSD.org\n2016/06/04"] uqs [label="Ulrich Spoerlein\nuqs@FreeBSD.org\n2012/01/19"] vd [label="Vasil Dimov\nvd@FreeBSD.org\n2006/01/19"] vg [label="Veniamin Gvozdikov\nvg@FreeBSD.org\n2013/06/11"] @@ -413,6 +414,8 @@ jadawin -> wen joerg -> netchild +junovitch -> tz + knu -> daichi knu -> maho knu -> nobutaka @@ -530,6 +533,8 @@ pgollucci -> swills philip -> koitsu +pi -> tz + rafan -> chinsan rakuco -> alonso @@ -573,6 +578,7 @@ swills -> milki swills -> pclin swills -> robak swills -> rpaulo +swills -> tz swills -> xmj tabthorpe -> ashish diff --git a/share/misc/committers-src.dot b/share/misc/committers-src.dot index 1656e80..5345bb3 100644 --- a/share/misc/committers-src.dot +++ b/share/misc/committers-src.dot @@ -244,7 +244,7 @@ mp [label="Mark Peek\nmp@FreeBSD.org\n2001/07/27"] mr [label="Michael Reifenberger\nmr@FreeBSD.org\n2001/09/30"] neel [label="Neel Natu\nneel@FreeBSD.org\n2009/09/20"] netchild [label="Alexander Leidinger\nnetchild@FreeBSD.org\n2005/03/31"] -ngie [label="Garrett Cooper\nngie@FreeBSD.org\n2014/07/27"] +ngie [label="Ngie Cooper\nngie@FreeBSD.org\n2014/07/27"] nork [label="Norikatsu Shigemura\nnork@FreeBSD.org\n2009/06/09"] np [label="Navdeep Parhar\nnp@FreeBSD.org\n2009/06/05"] nwhitehorn [label="Nathan Whitehorn\nnwhitehorn@FreeBSD.org\n2008/07/03"] diff --git a/share/mk/bsd.crunchgen.mk b/share/mk/bsd.crunchgen.mk index 435dfeb..2c93526 100644 --- a/share/mk/bsd.crunchgen.mk +++ b/share/mk/bsd.crunchgen.mk @@ -130,7 +130,7 @@ ${PROG}: ${OUTPUTS} objs .META objs: ${OUTMK} .META ${CRUNCHENV} MAKEOBJDIRPREFIX=${CRUNCHOBJS} \ - ${MAKE} -f ${OUTMK} objs + ${MAKE} -f ${OUTMK} BUILD_TOOLS_META=.NOMETA_CMP objs # <sigh> Someone should replace the bin/csh and bin/sh build-tools with # shell scripts so we can remove this nonsense. diff --git a/share/mk/bsd.init.mk b/share/mk/bsd.init.mk index d00b9e5..01d5c47 100644 --- a/share/mk/bsd.init.mk +++ b/share/mk/bsd.init.mk @@ -28,4 +28,14 @@ _SKIP_BUILD = not building at level 0 .warning ${_SKIP_BUILD} .endif +.if ${MK_META_MODE} == "yes" +.if !exists(/dev/filemon) && \ + ${UPDATE_DEPENDFILE:Uyes:tl} != "no" && !defined(NO_FILEMON) && \ + !make(showconfig) +.warning The filemon module (/dev/filemon) is not loaded. +.warning META_MODE is less useful for incremental builds without filemon. +.warning 'kldload filemon' or pass -DNO_FILEMON to suppress this warning. +.endif +.endif # ${MK_META_MODE} == "yes" + .endif # !target(__<bsd.init.mk>__) diff --git a/share/mk/bsd.lib.mk b/share/mk/bsd.lib.mk index 971577c..0b7bb02 100644 --- a/share/mk/bsd.lib.mk +++ b/share/mk/bsd.lib.mk @@ -244,7 +244,7 @@ CLEANFILES+= ${SHLIB_LINK} ${SHLIB_NAME_FULL}: ${SOBJS} @${ECHO} building shared library ${SHLIB_NAME} @rm -f ${SHLIB_NAME} ${SHLIB_LINK} -.if defined(SHLIB_LINK) && !commands(${SHLIB_LINK:R}.ld) +.if defined(SHLIB_LINK) && !commands(${SHLIB_LINK:R}.ld) && ${MK_DEBUG_FILES} == "no" @${INSTALL_SYMLINK} ${TAG_ARGS:D${TAG_ARGS},development} ${SHLIB_NAME} ${SHLIB_LINK} .endif ${_LD:N${CCACHE_BIN}} ${LDFLAGS} ${SSP_CFLAGS} ${SOLINKOPTS} \ @@ -259,6 +259,9 @@ CLEANFILES+= ${SHLIB_NAME_FULL} ${SHLIB_NAME}.debug ${SHLIB_NAME}: ${SHLIB_NAME_FULL} ${SHLIB_NAME}.debug ${OBJCOPY} --strip-debug --add-gnu-debuglink=${SHLIB_NAME}.debug \ ${SHLIB_NAME_FULL} ${.TARGET} +.if defined(SHLIB_LINK) && !commands(${SHLIB_LINK:R}.ld) + @${INSTALL_SYMLINK} ${TAG_ARGS:D${TAG_ARGS},development} ${SHLIB_NAME} ${SHLIB_LINK} +.endif ${SHLIB_NAME}.debug: ${SHLIB_NAME_FULL} ${OBJCOPY} --only-keep-debug ${SHLIB_NAME_FULL} ${.TARGET} diff --git a/share/mk/local.sys.mk b/share/mk/local.sys.mk index e3d212c..73fe5f5 100644 --- a/share/mk/local.sys.mk +++ b/share/mk/local.sys.mk @@ -1,6 +1,18 @@ # $FreeBSD$ -.if ${MK_DIRDEPS_BUILD} == "yes" +.if ${MK_DIRDEPS_BUILD} == "yes" || ${MK_META_MODE} == "yes" + +# Not in the below list as it may make sense for non-meta mode +# eventually. meta.sys.mk (DIRDEPS_BUILD) also already adds these in. +.if ${MK_DIRDEPS_BUILD} == "no" && ${MK_META_MODE} == "yes" +MAKE_PRINT_VAR_ON_ERROR += \ + .ERROR_TARGET \ + .ERROR_META_FILE \ + .MAKE.LEVEL \ + MAKEFILE \ + .MAKE.MODE +.endif + MAKE_PRINT_VAR_ON_ERROR+= \ .CURDIR \ .MAKE \ @@ -12,7 +24,7 @@ MAKE_PRINT_VAR_ON_ERROR+= \ MACHINE_ARCH \ MAKEOBJDIRPREFIX \ MAKESYSPATH \ - MAKE_VERSION\ + MAKE_VERSION \ PATH \ SRCTOP \ OBJTOP \ diff --git a/share/mk/sys.mk b/share/mk/sys.mk index 4a174f8..cccc543 100644 --- a/share/mk/sys.mk +++ b/share/mk/sys.mk @@ -42,9 +42,14 @@ __ENV_ONLY_OPTIONS:= \ .include <bsd.mkopt.mk> +# Disable MK_META_MODE with make -B +.if ${MK_META_MODE} == "yes" && defined(.MAKEFLAGS) && ${.MAKEFLAGS:M-B} +MK_META_MODE= no +.endif + .if ${MK_DIRDEPS_BUILD} == "yes" .sinclude <meta.sys.mk> -.elif ${MK_META_MODE} == "yes" && defined(.MAKEFLAGS) && ${.MAKEFLAGS:M-B} == "" +.elif ${MK_META_MODE} == "yes" # verbose will show .MAKE.META.PREFIX for each target. META_MODE+= meta verbose .if !defined(NO_META_MISSING) @@ -55,9 +60,6 @@ META_MODE+= missing-meta=yes META_MODE+= silent=yes .endif .if !exists(/dev/filemon) -.if ${UPDATE_DEPENDFILE:Uyes:tl} != "no" && !defined(NO_FILEMON) -.error ${.newline}ERROR: The filemon module (/dev/filemon) is not loaded. -.endif META_MODE+= nofilemon .endif # Require filemon data with bmake |
