Fix a bunch of "sentence not on new line" warnings from igor(1).
MFC after: 1 month
This commit is contained in:
parent
51a9a000ee
commit
2597250955
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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 .
|
||||
|
@ -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 .
|
||||
|
@ -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 ,
|
||||
|
@ -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 .
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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;
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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"
|
||||
|
@ -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.
|
||||
|
@ -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>
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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)
|
||||
|
@ -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 .
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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 .
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user