diff --git a/share/man/man4/ioat.4 b/share/man/man4/ioat.4 index deef466c0ae0..1c0e1dd49fd1 100644 --- a/share/man/man4/ioat.4 +++ b/share/man/man4/ioat.4 @@ -1,332 +1,332 @@ .\" Copyright (c) 2015 EMC / Isilon Storage Division .\" 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 AUTHORS 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 AUTHORS 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. .\" .Dd May 3, 2016 -.Dt IOAT 4 +.Dt IOAT 4 amd64 .Os .Sh NAME .Nm I/OAT .Nd Intel I/O Acceleration Technology .Sh SYNOPSIS To compile this driver into your kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device ioat" .Ed .Pp Or, to load the driver as a module at boot, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent ioat_load="YES" .Ed .Pp In .Xr loader.conf 5 : .Pp .Cd hw.ioat.force_legacy_interrupts=0 .Pp In .Xr loader.conf 5 or .Xr sysctl.conf 5 : .Pp .Cd hw.ioat.enable_ioat_test=0 .Cd hw.ioat.debug_level=0 (only critical errors; maximum of 3) .Pp .Ft typedef void .Fn (*bus_dmaengine_callback_t) "void *arg" "int error" .Pp .Ft bus_dmaengine_t .Fn ioat_get_dmaengine "uint32_t channel_index" .Ft void .Fn ioat_put_dmaengine "bus_dmaengine_t dmaengine" .Ft int .Fn ioat_get_hwversion "bus_dmaengine_t dmaengine" .Ft size_t .Fn ioat_get_max_io_size "bus_dmaengine_t dmaengine" .Ft int .Fn ioat_set_interrupt_coalesce "bus_dmaengine_t dmaengine" "uint16_t delay" .Ft uint16_t .Fn ioat_get_max_coalesce_period "bus_dmaengine_t dmaengine" .Ft void .Fn ioat_acquire "bus_dmaengine_t dmaengine" .Ft int .Fn ioat_acquire_reserve "bus_dmaengine_t dmaengine" "uint32_t n" "int mflags" .Ft void .Fn ioat_release "bus_dmaengine_t dmaengine" .Ft struct bus_dmadesc * .Fo ioat_copy .Fa "bus_dmaengine_t dmaengine" .Fa "bus_addr_t dst" .Fa "bus_addr_t src" .Fa "bus_size_t len" .Fa "bus_dmaengine_callback_t callback_fn" .Fa "void *callback_arg" .Fa "uint32_t flags" .Fc .Ft struct bus_dmadesc * .Fo ioat_copy_8k_aligned .Fa "bus_dmaengine_t dmaengine" .Fa "bus_addr_t dst1" .Fa "bus_addr_t dst2" .Fa "bus_addr_t src1" .Fa "bus_addr_t src2" .Fa "bus_dmaengine_callback_t callback_fn" .Fa "void *callback_arg" .Fa "uint32_t flags" .Fc .Ft struct bus_dmadesc * .Fo ioat_copy_crc .Fa "bus_dmaengine_t dmaengine" .Fa "bus_addr_t dst" .Fa "bus_addr_t src" .Fa "bus_size_t len" .Fa "uint32_t *initialseed" .Fa "bus_addr_t crcptr" .Fa "bus_dmaengine_callback_t callback_fn" .Fa "void *callback_arg" .Fa "uint32_t flags" .Fc .Ft struct bus_dmadesc * .Fo ioat_crc .Fa "bus_dmaengine_t dmaengine" .Fa "bus_addr_t src" .Fa "bus_size_t len" .Fa "uint32_t *initialseed" .Fa "bus_addr_t crcptr" .Fa "bus_dmaengine_callback_t callback_fn" .Fa "void *callback_arg" .Fa "uint32_t flags" .Fc .Ft struct bus_dmadesc * .Fo ioat_blockfill .Fa "bus_dmaengine_t dmaengine" .Fa "bus_addr_t dst" .Fa "uint64_t fillpattern" .Fa "bus_size_t len" .Fa "bus_dmaengine_callback_t callback_fn" .Fa "void *callback_arg" .Fa "uint32_t flags" .Fc .Ft struct bus_dmadesc * .Fo ioat_null .Fa "bus_dmaengine_t dmaengine" .Fa "bus_dmaengine_callback_t callback_fn" .Fa "void *callback_arg" .Fa "uint32_t flags" .Fc .Sh DESCRIPTION The .Nm driver provides a kernel API to a variety of DMA engines on some Intel server platforms. .Pp There is a number of DMA channels per CPU package. (Typically 4 or 8.) Each may be used independently. Operations on a single channel proceed sequentially. .Pp Blockfill operations can be used to write a 64-bit pattern to memory. .Pp Copy operations can be used to offload memory copies to the DMA engines. .Pp Null operations do nothing, but may be used to test the interrupt and callback mechanism. .Pp All operations can optionally trigger an interrupt at completion with the .Ar DMA_INT_EN flag. For example, a user might submit multiple operations to the same channel and only enable an interrupt and callback for the last operation. .Pp The hardware can delay and coalesce interrupts on a given channel for a configurable period of time, in microseconds. This may be desired to reduce the processing and interrupt overhead per descriptor, especially for workflows consisting of many small operations. Software can control this on a per-channel basis with the .Fn ioat_set_interrupt_coalesce API. The .Fn ioat_get_max_coalesce_period API can be used to determine the maximum coalescing period supported by the hardware, in microseconds. Current platforms support up to a 16.383 millisecond coalescing period. Optimal configuration will vary by workflow and desired operation latency. .Pp All operations are safe to use in a non-blocking context with the .Ar DMA_NO_WAIT flag. (Of course, allocations may fail and operations requested with .Ar DMA_NO_WAIT may return NULL.) .Pp Operations that depend on the result of prior operations should use .Ar DMA_FENCE . For example, such a scenario can happen when two related DMA operations are queued. First, a DMA copy to one location (A), followed directly by a DMA copy from A to B. In this scenario, some classes of I/OAT hardware may prefetch A for the second operation before it is written by the first operation. To avoid reading a stale value in sequences of dependent operations, use .Ar DMA_FENCE . .Pp All operations, as well as .Fn ioat_get_dmaengine , can return NULL in special circumstances. For example, if the .Nm driver is being unloaded, or the administrator has induced a hardware reset, or a usage error has resulted in a hardware error state that needs to be recovered from. .Pp It is invalid to attempt to submit new DMA operations in a .Fa bus_dmaengine_callback_t context. .Pp The CRC operations have three distinct modes. The default mode is to accumulate. By accumulating over multiple descriptors, a user may gather a CRC over several chunks of memory and only write out the result once. .Pp The .Ar DMA_CRC_STORE flag causes the operation to emit the CRC32C result. If .Ar DMA_CRC_INLINE is set, the result is written inline with the destination data (or source in .Fn ioat_crc mode). If .Ar DMA_CRC_INLINE is not set, the result is written to the provided .Fa crcptr . .Pp Similarly, the .Ar DMA_CRC_TEST flag causes the operation to compare the CRC32C result to an existing checksum. If .Ar DMA_CRC_INLINE is set, the result is compared against the inline four bytes trailing the source data. If it is not set, the result is compared against the value pointed to by .Fa crcptr . .Pp .Fn ioat_copy_crc calculates a CRC32C while copying data. .Fn ioat_crc only computes a CRC32C of some data. If the .Fa initialseed argument to either routine is non-NULL, the CRC32C engine is initialized with the value it points to. .Sh USAGE A typical user will lookup the DMA engine object for a given channel with .Fn ioat_get_dmaengine . When the user wants to offload a copy, they will first .Fn ioat_acquire the .Ar bus_dmaengine_t object for exclusive access to enqueue operations on that channel. Optionally, the user can reserve space by using .Fn ioat_acquire_reserve instead. If .Fn ioat_acquire_reserve succeeds, there is guaranteed to be room for .Fa N new operations in the internal ring buffer. .Pp Then, they will submit one or more operations using .Fn ioat_blockfill , .Fn ioat_copy , .Fn ioat_copy_8k_aligned , .Fn ioat_copy_crc , .Fn ioat_crc , or .Fn ioat_null . After queuing one or more individual DMA operations, they will .Fn ioat_release the .Ar bus_dmaengine_t to drop their exclusive access to the channel. The routine they provided for the .Fa callback_fn argument will be invoked with the provided .Fa callback_arg when the operation is complete. When they are finished with the .Ar bus_dmaengine_t , the user should .Fn ioat_put_dmaengine . .Pp Users MUST NOT block between .Fn ioat_acquire and .Fn ioat_release . Users SHOULD NOT hold .Ar bus_dmaengine_t references for a very long time to enable fault recovery and kernel module unload. .Pp For an example of usage, see .Pa src/sys/dev/ioat/ioat_test.c . .Sh FILES .Bl -tag .It Pa /dev/ioat_test test device for .Xr ioatcontrol 8 .El .Sh SEE ALSO .Xr ioatcontrol 8 .Sh HISTORY The .Nm driver first appeared in .Fx 11.0 . .Sh AUTHORS The .Nm driver was developed by .An \&Jim Harris Aq Mt jimharris@FreeBSD.org , .An \&Carl Delsey Aq Mt carl.r.delsey@intel.com , and .An \&Conrad Meyer Aq Mt cem@FreeBSD.org . This manual page was written by .An \&Conrad Meyer Aq Mt cem@FreeBSD.org . .Sh CAVEATS Copy operation takes bus addresses as parameters, not virtual addresses. .Pp Buffers for individual copy operations must be physically contiguous. .Pp Copies larger than max transfer size (1MB, but may vary by hardware) are not supported. Future versions will likely support this by breaking up the transfer into smaller sizes. .Sh BUGS The .Nm driver only supports blockfill, copy, and null operations at this time. The driver does not yet support advanced DMA modes, such as XOR, that some I/OAT devices support. diff --git a/share/man/man4/iwx.4 b/share/man/man4/iwx.4 index 7cd54d61b920..295a5f318afa 100644 --- a/share/man/man4/iwx.4 +++ b/share/man/man4/iwx.4 @@ -1,157 +1,157 @@ .\" .\" SPDX-License-Identifier: ISC .\" .\" $OpenBSD: iwx.4,v 1.21 2025/03/27 15:12:14 jmc Exp $ .\" .\" Copyright (c) 2020 Stefan Sperling .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .Dd May 2, 2025 -.Dt IWX 4 +.Dt IWX 4 amd64 .Os .Sh NAME .Nm iwx .Nd Intel WiFi 6 IEEE 802.11ax wireless network driver .Sh SYNOPSIS .Cd device iwx .Cd device wlan .Pp In .Xr rc.conf 5 : .Cd devmatch_blocklist="if_iwlwifi" .Cd kld_list="if_iwx" .Pp In .Xr sysctl.conf 5 : .Cd dev.iwx.?.debug=0xffffffff .Sh DESCRIPTION The .Nm driver supports the Intel Wi-Fi 6 series of M.2 wireless network adapters. If the appropriate hardware is detected, and .Xr iwlwifi 4 is blacklisted in .Xr rc.conf 5 , the driver will be automatically loaded with .Xr devmatch 8 . The .Nm driver can be configured at runtime with .Xr ifconfig 8 or at boot with .Xr rc.conf 5 . .Pp These are the modes the .Nm driver can operate in: .Bl -tag -width "monitor mode" .It station mode This is used when associating with an access point, through which all traffic passes. Background scanning is supported in this mode, see .Xr ifconfig 8 . Station mode is the default. .It monitor mode In this mode the driver is able to receive packets without associating with an access point. This disables the internal receive filter and enables the card to capture packets from networks which it wouldn't normally have access to, or to scan for access points. .El .Sh HARDWARE The .Nm driver supports the following M.2 wireless network adapters: .Pp .Bl -bullet -offset indent -compact .It Intel Wi-Fi 6 AX200 .It Intel Wi-Fi 6 AX201 CNVi .It Intel Wi-Fi 6 AX210 .It Intel Wi-Fi 6 AX211 CNVi .El .Sh SYSCTL VARIABLES The .Nm driver supports the following .Xr sysctl 8 variables: .Bl -tag -width "hw.usb.mtw.debug" .It Va dev.iwx.?.debug Specify debug level as a bitmask. Default .Ql 0 . .El .Sh FILES The .Nm driver requires firmware from .Pa ports/net/wifi-firmware-iwlwifi-kmod . This firmware package will be installed automatically with .Xr fwget 8 if the appropriate hardware is detected at installation or runtime. .Sh DIAGNOSTICS .Bl -diag .It "iwx0: device timeout" A frame dispatched to the hardware for transmission did not complete in time. The driver will reset the hardware. This should not happen. .It "iwx0: fatal firmware error" For some reason, the firmware crashed. The driver will reset the hardware. This should not happen. .It "iwx0: radio is disabled by hardware switch" The radio transmitter is off and thus no packet can go out. The driver will reset the hardware. Make sure the laptop radio switch is on. .It "iwx0: could not read firmware ... (error N)" For some reason, the driver was unable to read the firmware image from the filesystem. The file might be missing or corrupted. .It "iwx0: firmware too short: N bytes" The firmware image is corrupted and can't be loaded into the adapter. .It "iwx0: could not load firmware" An attempt to load the firmware into the adapter failed. The driver will reset the hardware. .El .Sh SEE ALSO .Xr intro 4 , .Xr iwlwifi 4 , .Xr iwlwififw 4 , .Xr wlan 4 , .Xr networking 7 , .Xr fwget 8 , .Xr ifconfig 8 , .Xr wpa_supplicant 8 .Sh HISTORY The .Nm driver appeared in .Fx 15.0 . .Sh CAVEATS The .Nm driver does not support hardware encryption offload. .Pp The .Nm driver does not support 802.11ax. Additional work is required in .Xr ieee80211 9 before those features can be supported. diff --git a/share/man/man4/man4.aarch64/armv8crypto.4 b/share/man/man4/man4.aarch64/armv8crypto.4 index 7b8704395daf..0f763adc5766 100644 --- a/share/man/man4/man4.aarch64/armv8crypto.4 +++ b/share/man/man4/man4.aarch64/armv8crypto.4 @@ -1,81 +1,81 @@ .\" Copyright (c) 2016 The FreeBSD Foundation .\" .\" This software was developed by Andrew Turner under .\" sponsorship from the FreeBSD Foundation. .\" .\" 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. .\" .Dd July 29, 2020 -.Dt ARMV8CRYPTO 4 +.Dt ARMV8CRYPTO 4 aarch64 .Os .Sh NAME .Nm armv8crypto .Nd "driver for the AES accelerator on ARM CPUs" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device crypto" .Cd "device armv8crypto" .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 armv8crypto_load="YES" .Ed .Sh DESCRIPTION Starting with the ARMv8 architecture ARM Limited has added optional cryptography instructions to accelerate AES, SHA-1, SHA-2, and finite field arithmetic. .Pp The processor capability is reported as AES in the Instruction Set Attributes 0 line at boot. The .Nm driver does not attach on systems that lack the required CPU capability. .Pp The .Nm driver registers itself to accelerate AES operations for .Xr crypto 4 . .Sh SEE ALSO .Xr crypt 3 , .Xr crypto 4 , .Xr intro 4 , .Xr ipsec 4 , .Xr random 4 , .Xr crypto 7 , .Xr crypto 9 .Sh HISTORY The .Nm driver first appeared in .Fx 11.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Andrew Turner Aq Mt andrew@FreeBSD.org . diff --git a/share/man/man4/man4.aarch64/enetc.4 b/share/man/man4/man4.aarch64/enetc.4 index 33f796347f96..e7cfcb7ebe0e 100644 --- a/share/man/man4/man4.aarch64/enetc.4 +++ b/share/man/man4/man4.aarch64/enetc.4 @@ -1,69 +1,69 @@ .\" - .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2021 Alstom Group. .\" Copyright (c) 2021 Semihalf. .\" .\" 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 ``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 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. .\" .Dd June 11, 2021 -.Dt ENETC 4 +.Dt ENETC 4 aarch64 .Os .Sh NAME .Nm enetc .Nd "Freescale ENETC PCIe Gigabit Ethernet driver" .Sh SYNOPSIS To compile this driver into the kernel the following lines must be present in the kernel configuration file: .sp .Cd "options SOC_NXP_LS" .Cd "device pci" .Cd "device fdt" .Cd "device iflib" .Cd "device enetc" .Sh DESCRIPTION The .Nm driver provides support for ENETC Gigabit Ethernet NIC found in LS1028A SoC. .Xr iflib 9 is used to communicate with the rest of kernel. Both physical ports, as well as virtual interfaces connected to the internal switch are supported. .Pp The following hardware offloads have been implemented in this version of the driver: .Bd -literal - Receive IP checksum validation. - VLAN tag insertion and extraction. - VLAN tag based packet filtering. .Ed .Pp For more information about configuring this device refer to .Xr ifconfig 8 . .Sh SEE ALSO .Xr vlan 4 , .Xr ifconfig 8 , .Xr iflib 9 .Sh HISTORY The .Nm driver first appeared in .Fx 14.0 . diff --git a/share/man/man4/man4.aarch64/felix.4 b/share/man/man4/man4.aarch64/felix.4 index 15caef6d274f..b97f3c2168e8 100644 --- a/share/man/man4/man4.aarch64/felix.4 +++ b/share/man/man4/man4.aarch64/felix.4 @@ -1,83 +1,83 @@ .\" - .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2021 Alstom Group. .\" Copyright (c) 2021 Semihalf. .\" .\" 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. .\" .Dd June 21, 2021 -.Dt FELIX 4 +.Dt FELIX 4 aarch64 .Os .Sh NAME .Nm felix .Nd "driver for Microchip Ocelot Felix switch" .Sh SYNOPSIS To compile this driver into the kernel the following lines must be present in the kernel configuration file: .sp .Cd "options SOC_NXP_LS" .Cd "device pci" .Cd "device fdt" .Cd "device mdio" .Cd "device enetc" .Cd "device etherswitch" .Cd "device felix" .Sh DESCRIPTION The .Nm driver provides a management interface to Microchip Ocelot Felix switch (VSC9959) found in NXP LS1028A SoC. It is a PCI device, part of the larger ENETC root complex. The driver is using .Xr etherswitch 4 framework. .Pp This driver supports only dot1q vlan. dot1q support port base addtag, striptag, dropuntagged, dropuntagged. .Sh EXAMPLES Configure dot1q vlan by etherswitchcfg command. .Pp .Dl # etherswitchcfg config vlan_mode dot1q .Pp Configure port 5 is tagging port. .Pp .Dl # etherswitchcfg port5 addtag .Pp Disable port 5 is tagging port. .Pp .Dl # etherswitchcfg port5 -addtag .Sh SEE ALSO .Xr etherswitch 4 , .Xr etherswitchcfg 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 14.0 . .Sh AUTHORS The .Nm driver was written by .An Kornel Duleba (mindal@semihalf.com) and .An Lukasz Hajec (lha@semihalf.com) diff --git a/share/man/man4/man4.aarch64/rk_gpio.4 b/share/man/man4/man4.aarch64/rk_gpio.4 index b5648662cf5e..b2767dd66dce 100644 --- a/share/man/man4/man4.aarch64/rk_gpio.4 +++ b/share/man/man4/man4.aarch64/rk_gpio.4 @@ -1,60 +1,60 @@ .\"- .\" Copyright (c) 2018 Emmanuel Vadot .\" .\" 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. .\" .Dd Apr 26, 2018 -.Dt RK_GPIO 4 +.Dt RK_GPIO 4 aarch64 .Os .Sh NAME .Nm rk_gpio .Nd driver for the gpio controller on RockChip SoCs .Sh SYNOPSIS .Cd "options SOC_ROCKCHIP_RK3328" .Sh DESCRIPTION The .Nm device driver provides support for the gpio controller device present on RockChip SoC. .Sh HARDWARE The current version of the .Nm driver supports the gpio banks with one of the following compatible strings : .Pp .Bl -bullet -compact .It rockchip,gpio-bank .El .Sh SEE ALSO .Xr gpiobus 4 , .Xr gpioctl 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 12.0 . .Sh AUTHORS The .Nm device driver and manpage was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.aarch64/rk_grf.4 b/share/man/man4/man4.aarch64/rk_grf.4 index 64ed468c1983..b01a93091ecb 100644 --- a/share/man/man4/man4.aarch64/rk_grf.4 +++ b/share/man/man4/man4.aarch64/rk_grf.4 @@ -1,57 +1,57 @@ .\"- .\" Copyright (c) 2018 Emmanuel Vadot .\" .\" 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. .\" .Dd Apr 26, 2018 -.Dt RK_GRF 4 +.Dt RK_GRF 4 aarch64 .Os .Sh NAME .Nm rk_grf .Nd driver for the General Register Files controller on RockChip SoCs .Sh SYNOPSIS .Cd "options SOC_ROCKCHIP_rk3328" .Sh DESCRIPTION The .Nm device driver provides support for the RockChip General Register Files system controller. .Sh HARDWARE The current version of the .Nm driver supports the GRF controller with one of the following compatible strings : .Pp .Bl -bullet -compact .It rockchip,rk3328-grf .El .Sh HISTORY The .Nm device driver first appeared in .Fx 12.0 . .Sh AUTHORS The .Nm device driver and manpage was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.aarch64/rk_grf_gpio.4 b/share/man/man4/man4.aarch64/rk_grf_gpio.4 index 6a5ebbe19e3b..2bfbebce1b76 100644 --- a/share/man/man4/man4.aarch64/rk_grf_gpio.4 +++ b/share/man/man4/man4.aarch64/rk_grf_gpio.4 @@ -1,42 +1,42 @@ .\" .\" Copyright (c) 2025 Stephen Hurd .\" .\" SPDX-License-Identifier: BSD-2-Clause .\" .Dd March 18, 2025 -.Dt RK_GRF_GPIO 4 +.Dt RK_GRF_GPIO 4 aarch64 .Os .Sh NAME .Nm rk_grf_gpio .Nd RockChip GPIO_MUTE pin driver .Sh SYNOPSIS .Cd "options SOC_ROCKCHIP_rk3328" .Sh DESCRIPTION The .Nm driver provides a single-pin, output-only .Xr gpio 3 unit whose single pin is named GPIO_MUTE. This controls the output of the GPIO_MUTE pin on the SoC. .Pp This gpio is usually used to control another device on the board, so is not usually available for user software. .Sh HARDWARE The .Nm driver supports the following GRF GPIO controller: .Pp .Bl -bullet -compact .It rockchip,rk3328-grf-gpio .El .Sh HISTORY The .Nm driver first appeared in .Fx 15.0 . .Sh AUTHORS The .Nm driver and manual were written by .An Stephen Hurd Aq Mt shurd@freebsd.org . diff --git a/share/man/man4/man4.aarch64/rk_i2c.4 b/share/man/man4/man4.aarch64/rk_i2c.4 index be1a0fab943e..363cdeac7f72 100644 --- a/share/man/man4/man4.aarch64/rk_i2c.4 +++ b/share/man/man4/man4.aarch64/rk_i2c.4 @@ -1,62 +1,62 @@ .\"- .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2018 Emmanuel Vadot .\" .\" 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. .\" .Dd June 14, 2018 -.Dt RK_I2C 4 +.Dt RK_I2C 4 aarch64 .Os .Sh NAME .Nm rk_i2c .Nd driver for the i2c controller on RockChip SoCs .Sh SYNOPSIS .Cd "options SOC_ROCKCHIP_RK3328" .Sh DESCRIPTION The .Nm device driver provides support for the i2c controller device present on RockChip SoC. .Sh HARDWARE The current version of the .Nm driver supports the i2c controller with one of the following compatible strings : .Pp .Bl -bullet -compact .It rockchip,rk3328-i2c .El .Sh SEE ALSO .Xr iic 4 , .Xr iicbus 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 12.0 . .Sh AUTHORS The .Nm device driver and manpage was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.aarch64/rk_pinctrl.4 b/share/man/man4/man4.aarch64/rk_pinctrl.4 index 519b3e793cd1..2be5f363498d 100644 --- a/share/man/man4/man4.aarch64/rk_pinctrl.4 +++ b/share/man/man4/man4.aarch64/rk_pinctrl.4 @@ -1,59 +1,59 @@ .\"- .\" Copyright (c) 2018 Emmanuel Vadot .\" .\" 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. .\" .Dd Apr 26, 2018 -.Dt RK_PINCTRL 4 +.Dt RK_PINCTRL 4 aarch64 .Os .Sh NAME .Nm rk_pinctrl .Nd driver for the pin multiplexing on RockChip SoCs .Sh SYNOPSIS .Cd "options SOC_ROCKCHIP_RK3328" .Sh DESCRIPTION The .Nm device driver provides support for the pin multiplexing device present on RockChip SoC. .Sh HARDWARE The current version of the .Nm driver supports the pin controller with one of the following compatible strings : .Pp .Bl -bullet -compact .It rockchip,rk3328-pinctrl .El .Sh SEE ALSO .Xr fdt_pinctrl 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 12.0 . .Sh AUTHORS The .Nm device driver and manpage was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.arm/am335x_dmtpps.4 b/share/man/man4/man4.arm/am335x_dmtpps.4 index d565c65e2cf1..bec5ff7726a0 100644 --- a/share/man/man4/man4.arm/am335x_dmtpps.4 +++ b/share/man/man4/man4.arm/am335x_dmtpps.4 @@ -1,161 +1,161 @@ .\" .\" Copyright (c) 2015 Ian Lepore .\" 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 ``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 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. .\" .Dd August 12, 2015 -.Dt AM335X_DMTPPS 4 +.Dt AM335X_DMTPPS 4 arm .Os .Sh NAME .Nm am335x_dmtpps .Nd RFC 2783 Pulse Per Second API driver for AM335x systems .Sh SYNOPSIS .Cd "device am335x_dmtpps" .Pp Optional in .Pa /boot/loader.conf : .Cd hw.am335x_dmtpps.input="pin name" .\" .Sh DESCRIPTION The .Nm device driver provides a system time counter that includes precise capture of Pulse Per Second (PPS) signals emitted by GPS receivers and other timing devices. The .Nm driver may be compiled into the kernel or loaded as a module. .Pp The AM335x timer hardware captures the value of the system time counter on the leading edge of the PPS pulse. Because the capture is done by the hardware there is no interrupt latency in the measurement. The time counter runs at 24Mhz, providing a measurement resolution of 42 nanoseconds. .Pp To use the PPS timing information provided by this driver with .Xr ntpd 8 , symlink the .Pa /dev/dmtpps device to .Pa /dev/pps0 and configure server .Va 127.127.22.0 in .Xr ntp.conf 5 to configure a type 22 (ATOM) refclock. .\" .Sh DRIVER CONFIGURATION The AM335x hardware provides four timer devices with a capture input pin, DMTimer4 through DMTimer7. Because it also provides the active system time counter, only one instance of the .Nm driver can be active at a time. The driver uses system pin configuration to determine which hardware timer device to use. Configure the timer input pin in the system's FDT data, or by supplying the pin name using a tunable variable in .Xr loader.conf 5 . .Pp To use a standard kernel and FDT data, use .Xr loader.conf 5 to load the .Nm module and set the .Va hw.am335x_dmtpps.input tunable variable to the name of the input pin, one of the following: .Pp .Bl -tag -width "GPMC_ADVn_ALE MMMM" -offset MMMM -compact .It Em Name .Em Hardware .It P8-7 DMTimer4; Beaglebone P8 header pin 7. .It P8-8 DMTimer7; Beaglebone P8 header pin 8. .It P8-9 DMTimer5; Beaglebone P8 header pin 9. .It P8-10 DMTimer6; Beaglebone P8 header pin 10. .It GPMC_ADVn_ALE DMTimer4. .It GPMC_BEn0_CLE DMTimer5. .It GPMC_WEn DMTimer6. .It GPMC_OEn_REn DMTimer7. .El .Pp To configure the .Nm driver using FDT data, create a new pinctrl node by referencing the standard .Va am33xx_pinmux driver node (which is defined in am33xx.dtsi) in your dts file. For example: .Bd -literal &am33xx_pinmux { timer4_pins: timer4_pins { pinctrl-single,pins = <0x90 (PIN_INPUT | MUX_MODE2)>; }; }; .Ed .Pp Add pinctrl properties referencing .Va timer4_pins to the standard .Va timer4 device node (also defined in am33xx.dtsi) by referencing it in your dts file as follows: .Bd -literal &timer4 { pinctrl-names = "default"; pinctrl-0 = <&timer4_pins>; }; .Ed .\" .Sh FILES .Bl -tag -width ".Pa /dev/dmtpps" -compact .It Pa /dev/dmtpps The device providing .Xr ioctl 2 access to the RFC 2783 API. .El .\" .Sh SEE ALSO .Xr timecounters 4 , .Xr loader.conf 5 , .Xr ntp.conf 5 , .Xr ntpd 8 .\" .Sh HISTORY The .Nm device driver first appeared in .Fx 11.0 . .\" .Sh AUTHORS The .Nm device driver and this manual page were written by .An Ian Lepore Aq Mt ian@FreeBSD.org . diff --git a/share/man/man4/man4.arm/aw_gpio.4 b/share/man/man4/man4.arm/aw_gpio.4 index 5cbc7562d9bd..ef9fc1fe2733 100644 --- a/share/man/man4/man4.arm/aw_gpio.4 +++ b/share/man/man4/man4.arm/aw_gpio.4 @@ -1,102 +1,102 @@ .\"- .\" Copyright (c) 2017 Emmanuel Vadot .\" .\" 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. .\" .Dd October 8, 2024 -.Dt AW_GPIO 4 +.Dt AW_GPIO 4 arm .Os .Sh NAME .Nm aw_gpio .Nd driver for the GPIO and pin muxing functionalities on Allwinner SoC .Sh SYNOPSIS .Cd "device gpio" .Cd "options SOC_ALLWINNER_A10" .Cd "options SOC_ALLWINNER_A13" .Cd "options SOC_ALLWINNER_A20" .Cd "options SOC_ALLWINNER_A31" .Cd "options SOC_ALLWINNER_A31S" .Cd "options SOC_ALLWINNER_A33" .Cd "options SOC_ALLWINNER_A83T" .Cd "options SOC_ALLWINNER_H2PLUS" .Cd "options SOC_ALLWINNER_H3" .Cd "options SOC_ALLWINNER_A64" .Cd "options SOC_ALLWINNER_H5" .Cd "options SOC_ALLWINNER_D1" .Sh DESCRIPTION The .Nm device driver provides support for the Allwinner pin muxing and GPIO on Allwinner SoCs. .Sh HARDWARE The current version of the .Nm driver supports the GPIO/pinmuxing controller with one of the following compatible strings : .Pp .Bl -bullet -compact .It allwinner,sun4i-a10-pinctrl .It allwinner,sun5i-a13-pinctrl .It allwinner,sun7i-a20-pinctrl .It allwinner,sun6i-a31-pinctrl .It allwinner,sun6i-a31s-pinctrl .It allwinner,sun6i-a31-r-pinctrl .It allwinner,sun6i-a33-pinctrl .It allwinner,sun8i-a83t-pinctrl .It allwinner,sun8i-a83t-r-pinctrl .It allwinner,sun8i-h3-pinctrl .It allwinner,sun50i-h5-pinctrl .It allwinner,sun8i-h3-r-pinctrl .It allwinner,sun50i-a64-pinctrl .It allwinner,sun50i-a64-r-pinctrl .It allwinner,sun20i-d1-pinctrl .El .Sh SEE ALSO .Xr fdt 4 , .Xr gpio 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 10.0 . .Sh AUTHORS The .Nm device driver was originally written by .An Ganbold Tsagaankhuu Aq Mt ganbold@freebsd.org . This manual page was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.arm/aw_mmc.4 b/share/man/man4/man4.arm/aw_mmc.4 index eb7fc9ce020a..e3f961fa5067 100644 --- a/share/man/man4/man4.arm/aw_mmc.4 +++ b/share/man/man4/man4.arm/aw_mmc.4 @@ -1,73 +1,73 @@ .\"- .\" Copyright (c) 2017 Emmanuel Vadot .\" .\" 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. .\" .Dd Dec 25, 2017 -.Dt AW_MMC 4 +.Dt AW_MMC 4 arm .Os .Sh NAME .Nm aw_mmc .Nd driver for the SD/MMC controller in Allwinner SoC .Sh SYNOPSIS .Cd "device mmc" .Sh DESCRIPTION The .Nm device driver provides support for the Allwinner SD/MMC host controller. .Sh HARDWARE The current version of the .Nm driver supports the SD/MMC controller with one of the following compatible strings : .Pp .Bl -bullet -compact .It allwinner,sun4i-a10-mmc .It allwinner,sun5i-a13-mmc .It allwinner,sun7i-a20-mmc .It allwinner,sun50i-a64-mmc .El .Sh SYSCTL VARIABLES The following read-only variables are available via .Xr sysctl 8 : .Bl -tag -width indent .It Va dev.aw_mmc.req_timeout Request timeout in seconds (default: 10) . .El .Sh SEE ALSO .Xr fdt 4 , .Xr mmc 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 10.0 . .Sh AUTHORS The .Nm device driver was originally written by .An Alexander Fedorov Aq Mt alexander.fedorov@rtlservice.com . Later work and this manual page was done by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.arm/aw_rtc.4 b/share/man/man4/man4.arm/aw_rtc.4 index 1296cd41da68..87212d85116c 100644 --- a/share/man/man4/man4.arm/aw_rtc.4 +++ b/share/man/man4/man4.arm/aw_rtc.4 @@ -1,68 +1,68 @@ .\"- .\" Copyright (c) 2017 Emmanuel Vadot .\" .\" 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. .\" .Dd December 10, 2024 -.Dt AW_RTC 4 +.Dt AW_RTC 4 arm .Os .Sh NAME .Nm aw_rtc .Nd driver for the real-time clock (RTC) controller in Allwinner SoC .Sh DESCRIPTION The .Nm device driver provides support for the Allwinner RTC controller. .Sh HARDWARE The current version of the .Nm driver supports the RTC controller with any of the following compatible strings: .Pp .Bl -bullet -compact .It allwinner,sun4i-a10-rtc .It allwinner,sun7i-a20-rtc .It allwinner,sun6i-a31-rtc .It allwinner,sun8i-h3-rtc .It allwinner,sun20i-d1-rtc .It allwinner,sun50i-h5-rtc .It allwinner,sun50i-h6-rtc .El .Sh HISTORY The .Nm device driver first appeared in .Fx 11.0 . .Sh AUTHORS The .Nm device driver was written by .An Vladimir Belian Aq Mt fate10@gmail.com . This manual page was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.arm/aw_sid.4 b/share/man/man4/man4.arm/aw_sid.4 index 5cd2f3d5e072..8b3691259f22 100644 --- a/share/man/man4/man4.arm/aw_sid.4 +++ b/share/man/man4/man4.arm/aw_sid.4 @@ -1,79 +1,79 @@ .\"- .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2018 Kyle Evans .\" .\" 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. .\" .Dd October 8, 2024 -.Dt AW_SID 4 +.Dt AW_SID 4 arm .Os .Sh NAME .Nm aw_sid .Nd driver for the SID controller in Allwinner SoC .Sh DESCRIPTION The .Nm device driver provides support for the Allwinner SID (Security ID) controller. This controller provides root security keys that may be used as either a device unique ID or to generate a MAC address. .Sh HARDWARE The .Nm driver supports the SID controller with one of the following compatible strings: .Pp .Bl -bullet -compact .It allwinner,sun4i-a10-sid .It allwinner,sun7i-a20-sid .It allwinner,sun50i-a64-sid .It allwinner,sun8i-a83t-sid .It allwinner,sun8i-h3-sid .It allwinner,sun50i-h5-sid .It allwinner,sun20i-d1-sid .El .Sh SYSCTL VARIABLES The following read-only variables are available via .Xr sysctl 8 : .Bl -tag -width indent .It Va dev.aw_sid.rootkey Root security key for this device. .El .Sh HISTORY The .Nm device driver first appeared in .Fx 11.0 . .Sh AUTHORS The .Nm device driver was written by .An Jared McNeill Aq Mt jmcneill@invisible.ca . This manual page was written by .An Kyle Evans Aq Mt kevans@FreeBSD.org . diff --git a/share/man/man4/man4.arm/aw_spi.4 b/share/man/man4/man4.arm/aw_spi.4 index f8985e1c16bb..d0566a45b54b 100644 --- a/share/man/man4/man4.arm/aw_spi.4 +++ b/share/man/man4/man4.arm/aw_spi.4 @@ -1,55 +1,55 @@ .\"- .\" Copyright (c) 2018 Emmanuel Vadot .\" .\" 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. .\" .Dd May 17, 2018 -.Dt AW_SPI 4 +.Dt AW_SPI 4 arm .Os .Sh NAME .Nm aw_spi .Nd driver for the SPI controller in Allwinner SoC .Sh SYNOPSIS .Cd "device aw_spi" .Sh DESCRIPTION The .Nm device driver provides support for the Allwinner SPI host controller. .Sh HARDWARE The current version of the .Nm driver supports the SPI controller with one of the following compatible strings: .Pp .Bl -bullet -compact .It allwinner,sun8i-h3-spi .El .Sh HISTORY The .Nm device driver first appeared in .Fx 12.0 . .Sh AUTHORS The .Nm device driver was written by .An Emmanuel Vadot Aq Mt manu@freebsd.org . diff --git a/share/man/man4/man4.arm/aw_syscon.4 b/share/man/man4/man4.arm/aw_syscon.4 index e32f329e489a..97f01196a8a6 100644 --- a/share/man/man4/man4.arm/aw_syscon.4 +++ b/share/man/man4/man4.arm/aw_syscon.4 @@ -1,67 +1,67 @@ .\"- .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2018 Kyle Evans .\" .\" 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. .\" .Dd November 11, 2024 -.Dt AW_SYSCON 4 +.Dt AW_SYSCON 4 arm .Os .Sh NAME .Nm aw_syscon .Nd driver for the system controller in Allwinner SoC .Sh DESCRIPTION The .Nm device driver provides support for the Allwinner system controller. This controller provides registers for tying together related functionality in a common space. .Nm is required for ethernet functionality on supported devices. .Sh HARDWARE The .Nm driver supports the system controller with one of the following compatible strings: .Pp .Bl -bullet -compact .It allwinner,sun50i-a64-system-controller .It allwinner,sun50i-a64-system-control .It allwinner,sun8i-a83t-system-controller .It allwinner,sun8i-h3-system-controller .It allwinner,sun8i-h3-system-control .It allwinner,sun50i-h5-system-control .It allwinner,sun20i-d1-system-control .El .Sh AUTHORS The .Nm device driver was written by .An Kyle Evans Aq Mt kevans@FreeBSD.org . diff --git a/share/man/man4/man4.arm/bcm283x_pwm.4 b/share/man/man4/man4.arm/bcm283x_pwm.4 index 1fb5a830ace7..71d7f0cc3cca 100644 --- a/share/man/man4/man4.arm/bcm283x_pwm.4 +++ b/share/man/man4/man4.arm/bcm283x_pwm.4 @@ -1,108 +1,108 @@ .\" .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2017 Poul-Henning Kamp .\" 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 ``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 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. .\" .Dd September 10, 2018 -.Dt BCM283X_PWM 4 +.Dt BCM283X_PWM 4 arm .Os .Sh NAME .Nm bcm283x_pwm .Nd bcm283x_pwm - driver for Raspberry Pi 2/3 PWM .Sh SYNOPSIS .Cd "kldload bcm283x_clkman" .Cd "kldload bcm283x_pwm" .Sh DESCRIPTION The .Nm driver provides access to the PWM engine on GPIO12 of Raspberry Pi 2 and 3 hardware. .Pp The PWM hardware is controlled via the .Xr sysctl 8 interface: .Bd -literal dev.pwm.0.mode: 1 dev.pwm.0.mode2: 1 dev.pwm.0.freq: 125000000 dev.pwm.0.ratio: 2500 dev.pwm.0.ratio2: 2500 dev.pwm.0.period: 10000 dev.pwm.0.period2: 10000 dev.pwm.0.pwm_freq: 12500 dev.pwm.0.pwm_freq2: 12500 .Ed .Bl -tag -width ".Va dev.pwm" .It Va dev.pwm.0.mode , dev.pwm.0.mode2 PWM Mode for channels 1 and 2. Three modes exist, 0=off, 1=PWM, 2=N/M. The N/M mode is a first order delta-sigma mode, which makes a quite handy DAC output with a trivial RC lowpass filter. .Pp .It Va dev.pwm.0.freq The input frequency to the PWM hardware in Hz. Applies to both channels 1 and 2. Minimum frequency is 123 kHz, maximum frequency is 125 MHz. .It Va dev.pwm.0.period , dev.pwm.0.period2 The period length in cycles. In PWM mode, the output frequencies will be ( .Va dev.pwm.0.freq / .Va dev.pwm.period ) and ( .Va dev.pwm.0.freq2 / .Va dev.pwm.0.period2 ). In N/M mode this is the 'M'. .It Va dev.pwm.0.ratio , dev.pwm.0.ratio2 The "on" period in cycles for PWM channels 1 and 2. In PWM mode, to get a 25% dutycycle, set this to 25% of .Va dev.pwm.0.period or .Va dev.pwm.0.period2 , as appropriate. In N/M mode this is the 'N'. .It Va dev.pwm.0.pwm_freq , dev.pwm.0.pwm_freq2 The calculated PWM output frequencies in PWM mode, for channels 1 and 2. .El .Pp .Sh NOTES Currently the .Nm driver ignores the 'status="disabled"' flag in the DTB, assuming that if you load the driver, you want it to work. .Sh SEE ALSO .Xr sysctl 8 .Sh HISTORY The .Nm driver first appeared in .Fx 12.0 . .Sh AUTHORS .An -nosplit The .Nm driver and this manual page were written by .An Poul-Henning Kamp Aq Mt phk@FreeBSD.org . diff --git a/share/man/man4/man4.arm/devcfg.4 b/share/man/man4/man4.arm/devcfg.4 index ddf368a85f24..cbc205814c69 100644 --- a/share/man/man4/man4.arm/devcfg.4 +++ b/share/man/man4/man4.arm/devcfg.4 @@ -1,93 +1,93 @@ .\" .\" Copyright (c) 2013 Thomas Skibo .\" 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. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. .\" .\" 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. .\" .Dd February 28, 2013 -.Dt DEVCFG 4 +.Dt DEVCFG 4 arm .Os .Sh NAME .Nm devcfg .Nd Zynq PL device config interface .Sh SYNOPSIS .Cd device devcfg .Sh DESCRIPTION The special file .Pa /dev/devcfg can be used to configure the PL (FPGA) section of the Xilinx Zynq-7000. .Pp On the first write to the character device at file offset 0, the .Nm driver asserts the top-level PL reset signals, disables the PS-PL level shifters, and clears the PL configuration. Write data is sent to the PCAP (processor configuration access port). When the PL asserts the DONE signal, the devcfg driver will enable the level shifters and release the top-level PL reset signals. .Pp The PL (FPGA) can be configured by writing the bitstream to the character device like this: .Bd -literal -offset indent cat design.bit.bin > /dev/devcfg .Ed .Pp The file should not be confused with the .bit file output by the FPGA design tools. It is the binary form of the configuration bitstream. The Xilinx .Ic promgen tool can do the conversion: .Bd -literal -offset indent promgen -b -w -p bin -data_width 32 -u 0 design.bit -o design.bit.bin .Ed .Sh SYSCTL VARIABLES The .Nm driver provides the following .Xr sysctl 8 variables: .Bl -tag -width 4n .It Va hw.fpga.pl_done .Pp This variable always reflects the status of the PL's DONE signal. A 1 means the PL section has been properly programmed. .It Va hw.fpga.en_level_shifters .Pp This variable controls if the PS-PL level shifters are enabled after the PL section has been reconfigured. This variable is 1 by default but setting it to 0 allows the PL section to be programmed with configurations that do not interface to the PS section of the part. Changing this value has no effect on the level shifters until the next device reconfiguration. .El .Sh FILES .Bl -tag -width 12n .It Pa /dev/devcfg Character device for the .Nm driver. .El .Sh SEE ALSO Zynq-7000 SoC Technical Reference Manual (Xilinx doc UG585) .Sh AUTHORS .An Thomas Skibo diff --git a/share/man/man4/man4.arm/imx6_ahci.4 b/share/man/man4/man4.arm/imx6_ahci.4 index 9979cef50d79..50689e323db8 100644 --- a/share/man/man4/man4.arm/imx6_ahci.4 +++ b/share/man/man4/man4.arm/imx6_ahci.4 @@ -1,63 +1,63 @@ .\" .\" Copyright (c) 2018 Ian Lepore .\" 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 ``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 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. .\" .Dd July 7, 2018 -.Dt IMX6_AHCI 4 +.Dt IMX6_AHCI 4 arm .Os .Sh NAME .Nm imx6_ahci .Nd device driver for the NXP i.MX6 on-chip SATA controller .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device ahci" .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 imx6_ahci_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for the on-chip SATA controller found on some models of the NXP i.MX6 chip. The driver is a thin glue layer to interpret the platform's FDT data and marshall resources for the standard .Xr ahci 4 driver. .Sh SEE ALSO .Xr ahci 4 , .Xr fdt 4 .Sh HISTORY The .Nm driver first appeared in .Fx 12.0 . diff --git a/share/man/man4/man4.arm/imx6_snvs.4 b/share/man/man4/man4.arm/imx6_snvs.4 index b36c3ddd91c1..2c1db97b231c 100644 --- a/share/man/man4/man4.arm/imx6_snvs.4 +++ b/share/man/man4/man4.arm/imx6_snvs.4 @@ -1,76 +1,76 @@ .\" .\" Copyright (c) 2018 Ian Lepore .\" 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 ``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 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. .\" .Dd July 8, 2018 -.Dt IMX6_SNVS 4 +.Dt IMX6_SNVS 4 arm .Os .Sh NAME .Nm imx6_snvs .Nd device driver for the NXP i.MX6 on-chip Realtime Clock .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device imx6_snvs" .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 imx6_snvs_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for the i.MX6 on-chip realtime clock. It provides the time of day with a resolution of approximately 30 microseconds. .Pp .Sq SNVS stands for Secure Non-Volatile Storage, and refers to the subsystem within the chip that (optionally) remains powered by a battery when the rest of the system is powered down. The on-chip realtime clock is part of that subsystem. Other features of the SNVS subsystem are related to security, tamper monitoring, and power control; the .Nm driver does not currently support those features. .Pp Many i.MX6 systems do not use a battery to provide power to the SNVS due to its relatively high power draw. In such systems, this driver is able to provide a very accurate time following a reboot, but cannot provide time at all if the power is cycled. If the system provides an i2c or other type of alternate realtime clock with lower resolution, there is value in configuring both clock drivers. Doing so allows SNVS to provide accurate time after a reboot, while the external clock provides approximate time after power cycling. .Sh HISTORY The .Nm driver first appeared in .Fx 12.0 . diff --git a/share/man/man4/man4.arm/imx_spi.4 b/share/man/man4/man4.arm/imx_spi.4 index e7555ed20d94..54a5339e3276 100644 --- a/share/man/man4/man4.arm/imx_spi.4 +++ b/share/man/man4/man4.arm/imx_spi.4 @@ -1,88 +1,88 @@ .\" .\" Copyright (c) 2018 Ian Lepore .\" 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 ``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 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. .\" .Dd July 9, 2018 -.Dt IMX_SPI 4 +.Dt IMX_SPI 4 arm .Os .Sh NAME .Nm imx_spi .Nd device driver for the NXP i.MX family Serial Peripheral Interface (SPI) .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device imx_spi" .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 imx_spi_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for the .Sq ECSPI (Enhanced Configurable SPI) hardware present on the NXP i.MX family of processors. While the ECSPI hardware supports both master and slave mode, this driver currently operates only in master mode. .Pp Due to hardware quirks, the .Nm driver requires that all chip select pins be configured as GPIO pins. Use the FDT property .Sq cs-gpios to specify which pins to use as chip selects. You may use any GPIO pins, including the ones that the hardware would normally use as SPI select pins; just configure them as GPIO in the .Xr fdt_pinctrl 4 data. .Pp .Sh SYSCTL VARIABLES The following variables are available via .Xr sysctl 8 , and as .Xr loader 8 tunables: .Bl -tag -width indent .It Va dev.imx_spi.%d.debug Output debugging info when non-zero. A value of 1 displays information about bus transfers, 2 adds information about bus clock frequency and chip select activity, and 3 adds information about interrupt handling. .El .Sh SEE ALSO .Xr fdt 4 , .Xr fdt_pinctrl 4 , .Xr sysctl 8 .Sh HISTORY The .Nm driver first appeared in .Fx 12.0 . diff --git a/share/man/man4/man4.arm/imx_wdog.4 b/share/man/man4/man4.arm/imx_wdog.4 index 4b993e1d066b..cb4d0e13865b 100644 --- a/share/man/man4/man4.arm/imx_wdog.4 +++ b/share/man/man4/man4.arm/imx_wdog.4 @@ -1,110 +1,110 @@ .\" .\" Copyright (c) 2018 Ian Lepore .\" 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 ``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 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. .\" .Dd July 7, 2018 -.Dt IMX_WDOG 4 +.Dt IMX_WDOG 4 arm .Os .Sh NAME .Nm imx_wdog .Nd device driver for the NXP i.MX5 and i.MX6 watchdog timer .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device imxwdt" .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 imx_wdog_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides .Xr watchdog 4 support for the watchdog timer present on NXP i.MX5 and i.MX6 processors. The i.MX watchdog hardware supports programmable timeouts ranging from 0.5 to 128 seconds, in half-second increments. Once activated, the watchdog hardware cannot be deactivated, but the timeout period can be changed to any valid non-zero value. .Pp At power-on, a special 16-second .Sq power-down timer mode is automatically enabled by the hardware. It will assert the external WDOG_B signal, which may be connected to external hardware that causes the system to reset or power-down. The power-down timer is often reset by the boot loader (typically U-Boot). If the power-down timer is still active at the time when the normal watchdog is first enabled, the .Nm driver automatically disables it. .Pp The .Nm driver supports the FDT .Va fsl,external-reset property by enabling the assertion of the WDOG_B external timeout signal when the property is present. When running this way, the need to reset the system due to watchdog timeout is signaled by driving the WDOG_B line low; some external entity is expected to assert the chip's POR pin in response. The .Nm driver attempts to backstop this external reset by scheduling an interrupt to occur as well. The interrupt handler waits 1 second for the external reset to occur, then it triggers a normal software reset. Note that the WDOG_B signal can be configured to use a variety of pins on the chip. For the .Va fsl,external-reset property to be effective, the signal must be connected to an appropriate pin by the system's FDT pinctrl data. .Pp The .Nm driver supports the FDT .Va timeout-secs property by enabling the watchdog as soon as the driver attaches, using the given timeout value. This extends watchdog protection to much of the system startup process, but it still requires that .Xr watchdogd 4 be configured to service the watchdog. .Sh SEE ALSO .Xr fdt 4 , .Xr watchdog 4 , .Xr watchdog 8 , .Xr watchdogd 8 , .Xr watchdog 9 .Sh HISTORY The .Nm driver first appeared in .Fx 10.0 . diff --git a/share/man/man4/man4.arm/mge.4 b/share/man/man4/man4.arm/mge.4 index e949b36f4307..cba9327eadcf 100644 --- a/share/man/man4/man4.arm/mge.4 +++ b/share/man/man4/man4.arm/mge.4 @@ -1,158 +1,158 @@ .\" .\" Copyright (c) 2008 Semihalf, Rafal Jaworowski .\" .\" 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 DEVELOPERS ``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 DEVELOPERS 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. .\" .Dd November 27, 2008 -.Dt MGE 4 +.Dt MGE 4 arm .Os .Sh NAME .Nm mge .Nd "Marvell Gigabit Ethernet device driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device mge" .Cd "device miibus" .Ed .Sh DESCRIPTION The .Nm driver provides support for gigabit Ethernet controller integrated in Marvell system-on-chip devices. .Pp The .Nm driver supports the following media types: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect Enable autoselection of the media type and options .It 10baseT/UTP Set 10Mbps operation .It 100baseTX Set 100Mbps operation .It 1000baseT Set 1000baseT operation .El .Pp The .Nm driver supports the following media options: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It full-duplex Set full duplex operation .El .Pp The .Nm driver supports polled operation when the system is configured with DEVICE_POLLING kernel option, see .Xr polling 4 for more details. .Pp The .Nm driver supports reception and transmission of extended frames for .Xr vlan 4 . This capability of .Nm can be controlled by means of the .Cm vlanmtu parameter to .Xr ifconfig 8 . .Pp 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): .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. .El .Sh HARDWARE Gigabit Ethernet controllers built into the following Marvell systems-on-chip are known to work with the .Nm driver: .Pp .Bl -bullet -compact .It Orion 88F5182 .It Orion 88F5281 .It Kirkwood 88F6281 (MGE V2) .It Discovery MV78100 (MGE V2) .El .Pp There are also Marvell system controllers for PowerPC processors, which include a variation of this gigabit Ethernet module integrated on chip, and they should also work with the .Nm driver, but this wasn't tested: .Pp .Bl -bullet -compact .It MV64430 .It MV64460, MV64461, MV64462 .El .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr miibus 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr polling 4 , .Xr vlan 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The base version of .Nm device driver was written by .An Grzegorz Bernacki. It has been extended with advanced features (polling, interrupt coalescing, multicast, h/w checksum calculation etc.) by .An Piotr Ziecik . This manual page was written by .An Rafal Jaworowski . diff --git a/share/man/man4/man4.arm/ti_adc.4 b/share/man/man4/man4.arm/ti_adc.4 index d71547231e4c..fb59e1d3e57c 100644 --- a/share/man/man4/man4.arm/ti_adc.4 +++ b/share/man/man4/man4.arm/ti_adc.4 @@ -1,126 +1,126 @@ .\" .\" Copyright (c) 2014 Luiz Otavio O Souza .\" 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 ``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 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. .\" .Dd June 1, 2014 -.Dt TI_ADC 4 +.Dt TI_ADC 4 arm .Os .Sh NAME .Nm ti_adc .Nd TI AM3XXX analog to digital converter driver .Sh SYNOPSIS .Cd "device ti_adc" .Sh DESCRIPTION The .Nm driver provides access to the AIN (analog inputs) on am3xxx SoCs. .Pp It provides raw readings of the converted values for each analog inputs. .Pp The access to .Nm data is made via the .Xr sysctl 8 interface: .Bd -literal dev.ti_adc.0.%desc: TI ADC controller dev.ti_adc.0.%driver: ti_adc dev.ti_adc.0.%pnpinfo: name=adc@44E0D000 compat=ti,adc dev.ti_adc.0.%parent: simplebus0 dev.ti_adc.0.clockdiv: 2400 dev.ti_adc.0.ain.0.enable: 0 dev.ti_adc.0.ain.0.open_delay: 0 dev.ti_adc.0.ain.0.samples_avg: 0 dev.ti_adc.0.ain.0.input: 0 dev.ti_adc.0.ain.1.enable: 0 dev.ti_adc.0.ain.1.open_delay: 0 dev.ti_adc.0.ain.1.samples_avg: 0 dev.ti_adc.0.ain.1.input: 0 dev.ti_adc.0.ain.2.enable: 0 dev.ti_adc.0.ain.2.open_delay: 0 dev.ti_adc.0.ain.2.samples_avg: 0 dev.ti_adc.0.ain.2.input: 0 dev.ti_adc.0.ain.3.enable: 0 dev.ti_adc.0.ain.3.open_delay: 0 dev.ti_adc.0.ain.3.samples_avg: 0 dev.ti_adc.0.ain.3.input: 0 dev.ti_adc.0.ain.4.enable: 0 dev.ti_adc.0.ain.4.open_delay: 0 dev.ti_adc.0.ain.4.samples_avg: 0 dev.ti_adc.0.ain.4.input: 0 dev.ti_adc.0.ain.5.enable: 0 dev.ti_adc.0.ain.5.open_delay: 0 dev.ti_adc.0.ain.5.samples_avg: 0 dev.ti_adc.0.ain.5.input: 0 dev.ti_adc.0.ain.6.enable: 1 dev.ti_adc.0.ain.6.open_delay: 0 dev.ti_adc.0.ain.6.samples_avg: 4 dev.ti_adc.0.ain.6.input: 2308 dev.ti_adc.0.ain.7.enable: 1 dev.ti_adc.0.ain.7.open_delay: 0 dev.ti_adc.0.ain.7.samples_avg: 0 dev.ti_adc.0.ain.7.input: 3812 .Ed .Pp On Beaglebone-black the analog input 7 is connected to the 3V3B rail through a voltage divisor (2:1). The 3V3B voltage rail comes from the TL5209 LDO regulator which is limited to 500mA maximum. .Pp Global settings: .Bl -tag -width ".Va dev.ti_adc.0.clockdiv" .It Va dev.ti_adc.0.clockdiv Sets the ADC clock prescaler. The minimum value is 10 and the maximum is 65535. The ADC clock is based on CLK_M_OSC (24Mhz) / clockdiv. This gives a maximum of ~2.4Mhz for the ADC clock and ~10Khz for the default setting (clockdiv = 2400). .El .Pp Settings per input: .Bl -tag -width ".Va dev.ti_adc.0.ain.%d.samples_avg" .It Va dev.ti_adc.0.ain.%d.enable Enable the conversion for the input. Each input should be individually enabled before it can be used. When all the inputs are disabled, the ADC is turned off. .It Va dev.ti_adc.0.ain.%d.open_delay Sets the number of ADC clock cycles to wait after applying the input configuration and before start the ADC conversion. .It Va dev.ti_adc.0.ain.%d.samples_avg Sets the number of samples average used on each input, it can be set to 0 (no samples average), 2, 4, 8, or 16. .It Va dev.ti_adc.0.ain.%d.input Is the converted raw value of the voltage applied on the analog input. It is made of a 12 bit value (0 ~ 4095). .El .Sh SEE ALSO .Xr sysctl 8 .Sh HISTORY The .Nm driver first appeared in .Fx 10.1 . .Sh AUTHORS .An -nosplit The driver and this manual page was written by .An Luiz Otavio O Souza Aq Mt loos@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/abtn.4 b/share/man/man4/man4.powerpc/abtn.4 index 92d643d5cf32..7421d0a0b5a6 100644 --- a/share/man/man4/man4.powerpc/abtn.4 +++ b/share/man/man4/man4.powerpc/abtn.4 @@ -1,113 +1,113 @@ .\"- .\" Copyright (c) 2011 Justin Hibbits .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd October 16, 2011 -.Dt ABTN 4 +.Dt ABTN 4 powerpc .Os .Sh NAME .Nm abtn .Nd ADB Keyboard Special Keys Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device adb" .Ed .Sh DESCRIPTION The .Nm driver provides support for the extended Fn keys on Apple notebooks with an ADB interface. .Sh HARDWARE The .Nm driver supports extended keyboard keys (special F-keys) on the following devices: .Pp .Bl -bullet -compact .It Apple iBook Keyboard .It Apple PowerBook Keyboard .El .Sh EVENTS The .Nm driver sends events to .Xr devd 8 for the following events under the .Cd PMU system, and .Cd keys subsystem: .Pp .Bl -bullet -compact .It .Cd brightness - Generates .Cd up and .Cd down notify types matching the pressed key. .It .Cd mute .It .Cd volume - Generates .Cd up and .Cd down notify types matching the pressed key. .It .Cd eject .El .Pp Examples are included in /etc/devd/apple.conf. .Sh SEE ALSO .Xr adb 4 , .Xr akbd 4 , .Xr cuda 4 , .Xr pmu 4 , .Xr devd 8 .Sh HISTORY The .Nm device driver first appeared in .Nx 5.0 and was ported to .Fx 10.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Tsubai Masanari for .Nx and ported to .Fx by .An Justin Hibbits . diff --git a/share/man/man4/man4.powerpc/adb.4 b/share/man/man4/man4.powerpc/adb.4 index a781787995ab..6041484b5e33 100644 --- a/share/man/man4/man4.powerpc/adb.4 +++ b/share/man/man4/man4.powerpc/adb.4 @@ -1,67 +1,67 @@ .\"- .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd December 3, 2009 -.Dt ADB 4 +.Dt ADB 4 powerpc .Os .Sh NAME .Nm adb .Nd Apple Desktop Bus .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device adb" .Ed .Sh DESCRIPTION The .Nm driver provides support for the Apple Desktop Bus, which is a simple multi-drop bus used in general for input peripherals in older Apple Macintosh hardware. .Pp The Apple Desktop Bus provides attachment for up to 16 devices, including multiple devices of a single type, but not does support hot-plugging. .Sh SEE ALSO Apple Tech Note HW01: ADB - The Untold Story: Space Aliens Ate My Mouse: .Pa http://developer.apple.com/legacy/mac/library/technotes/hw/hw_01.html .Pp .Xr akbd 4 , .Xr ams 4 , .Xr cuda 4 , .Xr pmu 4 .Sh HISTORY The .Nm device driver appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/akbd.4 b/share/man/man4/man4.powerpc/akbd.4 index 44af08961122..3406f5a1aa76 100644 --- a/share/man/man4/man4.powerpc/akbd.4 +++ b/share/man/man4/man4.powerpc/akbd.4 @@ -1,102 +1,102 @@ .\"- .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd December 3, 2009 -.Dt AKBD 4 +.Dt AKBD 4 powerpc .Os .Sh NAME .Nm akbd .Nd ADB Keyboard Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device adb" .Ed .Sh DESCRIPTION The .Nm driver provides support for all keyboards attached to the Apple Desktop Bus (ADB). .Sh HARDWARE Devices supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple Extended Keyboard .It Apple Keyboard II .It Apple iBook Keyboard .It Apple PowerBook Keyboard .El .Sh EVENTS The .Nm driver sends events to .Xr devd 8 for the following events under the .Cd PMU system: .Pp .Bl -bullet -compact .It Power button - .Cd "Button" subsystem, .Cd "pressed" type. .El .Sh SYSCTL VARIABLES The .Nm driver supports the following sysctl variable for configuring the Fn keys: .Bl -tag -width indent .It Va dev.akbd.%d.fn_keys_function_as_primary Set the Fn keys to be their F-key type as default. A value of 0 causes the F-keys keys to work as special keys by default ( .Xr abtn 4 ) and a value of 1 sets them to behave as F-keys by default. .El .Sh SEE ALSO .Xr abtn 4 , .Xr adb 4 , .Xr cuda 4 , .Xr pmu 4 .Sh HISTORY The .Nm device driver appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/ams.4 b/share/man/man4/man4.powerpc/ams.4 index 21be3c098920..d7fa922e7307 100644 --- a/share/man/man4/man4.powerpc/ams.4 +++ b/share/man/man4/man4.powerpc/ams.4 @@ -1,84 +1,84 @@ .\"- .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd December 3, 2009 -.Dt AMS 4 +.Dt AMS 4 powerpc .Os .Sh NAME .Nm ams .Nd ADB Mouse Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device adb" .Ed .Sh DESCRIPTION The .Nm driver provides support for mice and trackpads attached to the Apple Desktop Bus (ADB) implementing both the base and extended ADB mouse protocols. .Sh HARDWARE Devices supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple Mouse .It ADB Extended Mouse .It MacAlly 2-Button Mouse .It Apple iBook Trackpad .It Apple PowerBook Trackpad .El .Sh SYSCTL VARIABLES .Bl -tag -width indent .It Va dev.ams.%d.tapping On ADB trackpads, setting this sysctl to 1 causes taps on the trackpad to be interpreted as button clicks. .El .Sh SEE ALSO Apple Tech Note HW01: ADB - The Untold Story: Space Aliens Ate My Mouse: .Pa http://developer.apple.com/legacy/mac/library/technotes/hw/hw_01.html .Pp .Xr adb 4 , .Xr cuda 4 , .Xr pmu 4 .Sh HISTORY The .Nm device driver appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/cuda.4 b/share/man/man4/man4.powerpc/cuda.4 index 7171ebb42373..a52b9a447c9d 100644 --- a/share/man/man4/man4.powerpc/cuda.4 +++ b/share/man/man4/man4.powerpc/cuda.4 @@ -1,77 +1,77 @@ .\"- .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd December 3, 2009 -.Dt CUDA 4 +.Dt CUDA 4 powerpc .Os .Sh NAME .Nm cuda .Nd Apple CUDA I/O Controller Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device adb" .Cd "device cuda" .Ed .Sh DESCRIPTION The .Nm driver provides support for the CUDA VIA (Versatile Interface Attachment) chip found in pre-Core99 Apple hardware, such as the Power Macintosh G3. .Pp The Apple CUDA controller is a multi-purpose ASIC that provides power control and an .Xr adb 4 interface. .Sh HARDWARE Chips supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple CUDA I/O Controller .El .Sh SEE ALSO .Xr adb 4 .Sh HISTORY The .Nm device driver appeared in .Nx 4.0 , and then in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Michael Lorenz Aq Mt macallan@NetBSD.org and ported to .Fx by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/dtsec.4 b/share/man/man4/man4.powerpc/dtsec.4 index 4a60dd0b8824..f18de90c4757 100644 --- a/share/man/man4/man4.powerpc/dtsec.4 +++ b/share/man/man4/man4.powerpc/dtsec.4 @@ -1,117 +1,117 @@ .\" .\" Copyright (c) 2016 Justin Hibbits .\" .\" 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 DEVELOPERS ``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 DEVELOPERS 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. .\" .Dd October 31, 2017 -.Dt DTSEC 4 +.Dt DTSEC 4 powerpc .Os .Sh NAME .Nm dtsec .Nd "Freescale Datapath Acceleration Architecture-based Three-Speed Ethernet Controller device driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "include ""dpaa/config.dpaa"" .Cd "device dpaa" .Cd "device miibus" .Ed .Sh DESCRIPTION The .Nm driver provides support for the DPAA-based gigabit Ethernet controller integrated in some of the Freescale system-on-chip devices. .Pp The .Nm driver supports the following media types: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect Enable autoselection of the media type and options .It 10baseT/UTP Set 10Mbps operation .It 100baseTX Set 100Mbps operation .It 1000baseT Set 1000baseT operation .El .Pp The .Nm driver supports the following media options: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It full-duplex Set full duplex operation .El .Pp The .Nm driver supports two operating modes: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It Regular Normal mode, utilizing the full datapath acceleration, Buffer Manager, and Queue Manager. .It Independent Runs disconnected from the Buffer Manager and Queue Manager. .El .Sh HARDWARE Gigabit Ethernet controllers built into the following Freescale system-on-chip devices are known to work with the .Nm driver: .Pp .Bl -bullet -compact .It P2041, P3041 .It P5010, P5020 .El .Pp Additionally, the following devices are expected to work, but are untested: .Bl -bullet -compact .It P4080, P4040 .It P5040 .El .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr miibus 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 11.0 . .Sh AUTHORS .An -nosplit The base version of .Nm device driver was written by .An Semihalf . This manual page was written by .An Justin Hibbits . diff --git a/share/man/man4/man4.powerpc/llan.4 b/share/man/man4/man4.powerpc/llan.4 index c32ddbca6a00..b78109cac626 100644 --- a/share/man/man4/man4.powerpc/llan.4 +++ b/share/man/man4/man4.powerpc/llan.4 @@ -1,59 +1,59 @@ .\"- .\" Copyright (c) 2015 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd February 19, 2015 -.Dt LLAN 4 +.Dt LLAN 4 powerpc .Os .Sh NAME .Nm llan .Nd POWER Logical Lan .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device llan" .Ed .Sh DESCRIPTION The .Nm driver provides support for the inter-partition logical LAN controller provided by PAPR-compliant POWER hypervisors (such as PowerVM and PowerKVM). On some firmwares, advanced offload features are supported by the hypervisor, but these are not currently supported by the driver. .Sh SEE ALSO .Xr vtnet 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver appeared in .Fx 10.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/pmu.4 b/share/man/man4/man4.powerpc/pmu.4 index 6eac20cfa6b7..4dfb31f175bd 100644 --- a/share/man/man4/man4.powerpc/pmu.4 +++ b/share/man/man4/man4.powerpc/pmu.4 @@ -1,114 +1,114 @@ .\"- .\" Copyright (c) 2008 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd December 6, 2008 -.Dt PMU 4 +.Dt PMU 4 powerpc .Os .Sh NAME .Nm pmu .Nd Apple PMU99 Power Management Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device adb" .Cd "device pmu" .Ed .Sh DESCRIPTION The .Nm driver provides support for the Power Management Unit (PMU) found in Apple Core99 hardware. This includes late G3 laptops, all G4 machines, early G5 desktops and all G5 XServes. .Pp The Apple PMU controller is a multi-purpose ASIC that provides power management and thermal control, as well as an ADB bus for the internal keyboard and mouse on laptops. .Sh HARDWARE Chips supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple KeyLargo PMU .It Apple K2-KeyLargo PMU .El .Sh SYSCTL VARIABLES The .Nm driver provides power management services in addition to an .Xr adb 4 interface. The following sysctls can be used to control the power management behavior and to examine current system power and thermal conditions. .Bl -tag -width indent .It Va dev.pmu.%d.server_mode Restart after power failure behavior (1 causes system to reboot after power cut, 0 causes system to remain off). .It Va dev.pmu.%d.batteries.%d.present Indicates whether the relevant battery is inserted. .It Va dev.pmu.%d.batteries.%d.charging Indicates whether the battery is currently charging. .It Va dev.pmu.%d.batteries.%d.charge The current battery charge, in milliamp hours. .It Va dev.pmu.%d.batteries.%d.maxcharge The battery's self-reported maximum charge, in milliamp hours. .It Va dev.pmu.%d.batteries.%d.rate The current into the battery, in milliamps. While the battery is discharging, this will be negative. .It Va dev.pmu.%d.batteries.%d.voltage Battery voltage, in millivolts. .It Va dev.pmu.%d.batteries.%d.time Estimated time until full battery charge (or discharge), in minutes. .It Va dev.pmu.%d.batteries.%d.life Current fraction of the battery's maximum charge, in percent. .El .Sh SEE ALSO .Xr acpi 4 , .Xr adb 4 , .Xr led 4 .Sh HISTORY The .Nm device driver appeared in .Nx 4.0 , and then in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Michael Lorenz Aq Mt macallan@NetBSD.org and ported to .Fx by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/smu.4 b/share/man/man4/man4.powerpc/smu.4 index ef2654746e62..852a08abaa9e 100644 --- a/share/man/man4/man4.powerpc/smu.4 +++ b/share/man/man4/man4.powerpc/smu.4 @@ -1,124 +1,124 @@ .\"- .\" Copyright (c) 2010 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd February 22, 2010 -.Dt SMU 4 +.Dt SMU 4 powerpc .Os .Sh NAME .Nm smu .Nd Apple System Management Unit Driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device smu" .Ed .Sh DESCRIPTION The .Nm driver provides support for the System Management Unit (SMU) found in many Apple G5 systems. This includes most Power Macintosh G5 and all iMac G5 systems. .Pp The Apple SMU controller provides software power management and thermal control functionality, and is responsible for managing system cooling devices. .Sh HARDWARE Chips supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple System Management Unit .El .Sh THERMAL MANAGEMENT The .Nm driver provides basic automatic thermal management. Without a userspace daemon providing more advanced control, the driver will attempt to maintain system temperatures in a conservative range through coarse-grained control of system cooling devices (see below). Automatic kernel-level thermal control will take over if more than 3 seconds elapses between userspace cooling setting adjustments. .Sh SYSCTL VARIABLES The .Nm driver provides power management services and thermal readout through a sysctl interface. The following sysctls can be used to control the power management behavior and to examine current system power and thermal conditions. .Bl -tag -width indent .It Va dev.smu.%d.server_mode Restart after power failure behavior (1 causes system to reboot after power cut, 0 causes system to remain off). .It Va dev.smu.%d.target_temp Target system temperature, in degrees Celsius. The .Nm driver will attempt to adjust fans to maintain the temperature of the warmest component in the system at or below this level. .It Va dev.smu.%d.critical_temp System critical temperature, in degrees Celsius. If any component in the system exceeds this temperature, the machine will be shut down within 500 ms. .It Va dev.smu.%d.fans.%s.minrpm Minimum allowed speed for this fan. .It Va dev.smu.%d.fans.%s.maxrpm Maximum allowed speed for this fan. .It Va dev.smu.%d.fans.%s.rpm Current speed for this fan. The fan speed can be adjusted by changing this sysctl. If more than 3 seconds elapses between fan speed adjustments, the kernel will resume automatic control of the fan. .It Va dev.smu.%d.sensors.%s Current reading from this sensor. Four sensor types are supported. Temperature sensors are in units of degrees Celsius, current sensors in milliamps, voltage sensors in millivolts, and power sensors in milliwatts. .El .Sh LED INTERFACE The .Nm driver provides an .Xr led 4 annunciator interface at .Pa /dev/led/sleepled . .Sh SEE ALSO .Xr acpi 4 , .Xr led 4 , .Xr pmu 4 .Sh HISTORY The .Nm device driver appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/snd_ai2s.4 b/share/man/man4/man4.powerpc/snd_ai2s.4 index 3880751e65c9..7a3cd9cb94af 100644 --- a/share/man/man4/man4.powerpc/snd_ai2s.4 +++ b/share/man/man4/man4.powerpc/snd_ai2s.4 @@ -1,86 +1,86 @@ .\"- .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd January 20, 2009 -.Dt SND_AI2S 4 +.Dt SND_AI2S 4 powerpc .Os .Sh NAME .Nm snd_ai2s .Nd "Apple I2S audio device driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device sound" .Cd "device snd_ai2s" .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 snd_ai2s_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for the Apple I2S audio controllers found predominantly in G4 and G5 machines, along with the snapper and tumbler codecs. Some machines (e.g. the Mac Mini) do not have configurable codecs and so lack hardware volume control. .Sh HARDWARE Chips supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple Tumbler Audio .It Apple Snapper Audio .El .Sh SEE ALSO .Xr snd_davbus 4 , .Xr sound 4 .Sh HISTORY The .Nm device driver appeared in .Nx 2.0 and then in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Tsubai Masanari Aq Mt tsubai@netbsd.org , and ported to .Fx by .An Marco Trillo Aq Mt marcotrillo@gmail.com . .Sh BUGS Recording and operation with non-44.1 Khz audio are not currently supported. diff --git a/share/man/man4/man4.powerpc/snd_davbus.4 b/share/man/man4/man4.powerpc/snd_davbus.4 index 6958ebd4b4b5..028225accf52 100644 --- a/share/man/man4/man4.powerpc/snd_davbus.4 +++ b/share/man/man4/man4.powerpc/snd_davbus.4 @@ -1,78 +1,78 @@ .\"- .\" Copyright (c) 2009 Nathan Whitehorn .\" 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 ``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 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. .\" .Dd January 20, 2009 -.Dt SND_DAVBUS 4 +.Dt SND_DAVBUS 4 powerpc .Os .Sh NAME .Nm snd_davbus .Nd "Apple Davbus audio device driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device sound" .Cd "device snd_davbus" .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 snd_davbus_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for the Apple Davbus audio controllers found in many G3-era Apple machines. .Sh HARDWARE Chips supported by the .Nm driver include: .Pp .Bl -bullet -compact .It Apple Burgundy Audio .It Apple Screamer Audio .El .Sh SEE ALSO .Xr snd_ai2s 4 , .Xr sound 4 .Sh HISTORY The .Nm device driver appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Marco Trillo Aq Mt marcotrillo@gmail.com . .Sh BUGS Recording is not currently supported. diff --git a/share/man/man4/man4.powerpc/tsec.4 b/share/man/man4/man4.powerpc/tsec.4 index b3ccae648ab8..09510e329ff0 100644 --- a/share/man/man4/man4.powerpc/tsec.4 +++ b/share/man/man4/man4.powerpc/tsec.4 @@ -1,157 +1,157 @@ .\" .\" Copyright (c) 2009 Semihalf, Rafal Jaworowski .\" .\" 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 DEVELOPERS ``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 DEVELOPERS 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. .\" .Dd February 20, 2015 -.Dt TSEC 4 +.Dt TSEC 4 powerpc .Os .Sh NAME .Nm tsec .Nd "Freescale Three-Speed Ethernet Controller device driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device tsec" .Cd "device miibus" .Ed .Sh DESCRIPTION The .Nm driver provides support for the gigabit Ethernet controller integrated in some of the Freescale system-on-chip devices. .Pp The .Nm driver supports the following media types: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect Enable autoselection of the media type and options .It 10baseT/UTP Set 10Mbps operation .It 100baseTX Set 100Mbps operation .It 1000baseT Set 1000baseT operation .El .Pp The .Nm driver supports the following media options: .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It full-duplex Set full duplex operation .El .Pp The .Nm driver supports polled operation when the system is configured with DEVICE_POLLING kernel option, see .Xr polling 4 for more details. .Pp The .Nm driver supports reception and transmission of extended frames for .Xr vlan 4 . This capability of .Nm can be controlled by means of the .Cm vlanmtu parameter to .Xr ifconfig 8 . .Pp 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, or a threshold-defined frame counter has been reached (whichever occurs first). The following sysctls regulate this behaviour: .Bl -tag -width indent .It Va dev.tsec.X.int_coal.rx_time .It Va dev.tsec.X.int_coal.rx_count .It Va dev.tsec.X.int_coal.tx_time .It Va dev.tsec.X.int_coal.tx_count .Pp Value of 0 for either time or count disables IC on the given path. Time value 1-65535 corresponds to a real time period and is expressed in units equivalent to 64 ticks of the TSEC clock. Count 1-255 represents the number of frames (note that value of 1 is equivalent to IC disabled). 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 Freescale system-on-chip devices are known to work with the .Nm driver: .Pp .Bl -bullet -compact .It MPC8349 .It MPC8533, MPC8541, MPC8555 .El .Pp The enhanced version of the controller (eTSEC), integrated in the following devices, is also supported by this driver: .Pp .Bl -bullet -compact .It MPC8548, MPC8572 .El .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr miibus 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr polling 4 , .Xr vlan 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The base version of .Nm device driver was written by .An Piotr Kruszynski . It has been extended with polling and interrupt coalescing support by .An Rafal Jaworowski . It has been further enhanced with multicast, h/w checksum calculation and vlan support by .An Piotr Ziecik . This manual page was written by .An Rafal Jaworowski . diff --git a/share/man/man4/nvdimm.4 b/share/man/man4/nvdimm.4 index 5b7dbe435c46..2bec51b42d72 100644 --- a/share/man/man4/nvdimm.4 +++ b/share/man/man4/nvdimm.4 @@ -1,132 +1,132 @@ .\" Copyright (c) 2019 The FreeBSD Foundation .\" .\" This documentation was written by .\" Konstantin Belousov under sponsorship .\" from the FreeBSD Foundation. .\" .\" 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 AUTHORS 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 AUTHORS 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. .\" .Dd September 5, 2019 -.Dt NVDIMM 4 +.Dt NVDIMM 4 amd64 .Os .Sh NAME .Nm nvdimm .Nd ACPI NVDIMM driver .Sh SYNOPSIS To load the driver as a module at boot, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent nvdimm_load="YES" .Ed .Sh DESCRIPTION .Bf -symbolic Note: The .Nm driver is under development and has some important limitations described below. .Ef .Pp The .Nm driver provides access to Non-Volatile DIMM (NVDIMM) persistent memory devices, which are ACPI-enumerated under the root NVDIMM device with a .Va _HID of .Dv ACPI0012 and in the .Dv NFIT table. .Pp For each System Physical Address (SPA) Range described by NFIT, a device node .Pa /dev/nvdimm_spaNNN is created, where .Dv NNN is the SPA position in the table. The node can be used to .Xr read 2 , .Xr write 2 , or .Xr mmap 2 the device. .Pp Also, for each SPA, the geom provider .Pa spaNNN is created, which can be used to create a conventional filesystem (e.g., by .Xr newfs 8 ) and .Xr mount 8 it as any storage volume. Content accessible by .Pa /dev/nvdimm_spaNNN and .Pa /dev/spaNNN is coherent. .Pp The .Nm driver has support for reading NVDIMM namespaces (if supported by your hardware and already configured by some other mechanism, e.g., a BIOS configuration screen). The driver will provide a .Pa /dev/nvdimm_spaNNNnsMMM device node and .Pa spaNNNnsMMM geom provider for each namespace in a SPA, which behave analogously to their full-SPA cousins described above. .Sh SEE ALSO .Xr acpi 4 , .Xr GEOM 4 , .Xr geom 8 , .Xr mount 8 , .Xr newfs 8 , .Xr disk 9 .Sh HISTORY The .Nm driver first appeared in .Fx 12.0 . .Sh AUTHORS .An -nosplit The .Nm driver was originally written by .An Konstantin Belousov Aq Mt kib@FreeBSD.org , and then updated by .An D. Scott Phillips Aq Mt scottph@FreeBSD.org . .Sh BUGS The .Nm driver does not utilize the Block Window interface, so if a write to an NVDIMM is interrupted due to a system crash or power outage, the corresponding page might be left in a partially updated state. .Pp There is no support for Device-Specific Methods (DSM), used to report and control device health and wearing. .Pp The driver depends on the .Xr pmap_largemap 9 pmap interface, which is currently only implemented on amd64. The interface can be only reasonable implemented on 64bit architectures. diff --git a/share/man/man4/qlnxe.4 b/share/man/man4/qlnxe.4 index f545235ec1ff..70bad789add1 100644 --- a/share/man/man4/qlnxe.4 +++ b/share/man/man4/qlnxe.4 @@ -1,90 +1,90 @@ .\"- .\" Copyright (c) 2017 Cavium 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. .\" .Dd May 9, 2017 -.Dt QLNXE 4 +.Dt QLNXE 4 amd64 .Os .Sh NAME .Nm qlnxe .Nd "Cavium 25/40/100 Gigabit Ethernet & CNA Adapter Driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device qlnxe" .Ed .Pp To load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent if_qlnxe_load="YES" .Ed .Sh DESCRIPTION The .Nm driver supports IPv4 checksum offload, TCP and UDP checksum offload for both IPv4 and IPv6, Large Segment Offload for both IPv4 and IPv6, Jumbo frames, VLAN Tag, Receive Side scaling, HW and Soft LRO. For further hardware information, see .Pa http://www.qlogic.com/ . .Sh HARDWARE The .Nm driver supports 25/40/100 Gigabit Ethernet & CNA Adapter based on the following chipsets: .Pp .Bl -bullet -compact .It QLogic 45000 series .It QLogic 41000 series .El .Sh SUPPORT For support questions please contact your Cavium approved reseller or Cavium Technical Support at .Pa http://support.qlogic.com , or by E-mail at .Aq Mt support@qlogic.com . .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 11.1 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An David C Somayajulu at Cavium Inc. diff --git a/share/man/man4/qlxgb.4 b/share/man/man4/qlxgb.4 index 4bf8000d15da..cc97cd060a3f 100644 --- a/share/man/man4/qlxgb.4 +++ b/share/man/man4/qlxgb.4 @@ -1,91 +1,91 @@ .\"- .\" Copyright (c) 2011 "Bjoern A. Zeeb" .\" 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. .\" .Dd November 3, 2011 -.Dt QLXGB 4 +.Dt QLXGB 4 amd64 .Os .Sh NAME .Nm qlxgb .Nd "QLogic 10 Gigabit Ethernet & CNA Adapter Driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device qlxgb" .Ed .Pp To load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent if_qlxgb_load="YES" .Ed .Sh DESCRIPTION The .Nm driver supports IPv4 checksum offload, TCP and UDP checksum offload for both IPv4 and IPv6, Large Segment Offload for both IPv4 and IPv6, Jumbo frames, VLAN Tag, and Receive Side scaling. For further hardware information, see .Pa http://www.qlogic.com/ . .Sh HARDWARE The .Nm driver supports 10 Gigabit Ethernet & CNA Adapter based on the following chipsets: .Pp .Bl -bullet -compact .It QLogic 3200 series .It QLogic 8200 series .El .Sh SUPPORT For support questions please contact your QLogic approved reseller or QLogic Technical Support at .Pa http://support.qlogic.com , or by E-mail at .Aq Mt support@qlogic.com . .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 10.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An David C Somayajulu at QLogic Corporation. diff --git a/share/man/man4/qlxgbe.4 b/share/man/man4/qlxgbe.4 index 486a5ec0f682..465e4fc018ad 100644 --- a/share/man/man4/qlxgbe.4 +++ b/share/man/man4/qlxgbe.4 @@ -1,90 +1,90 @@ .\"- .\" Copyright (c) 2013 Qlogic Corportaion .\" 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. .\" .Dd April 1, 2013 -.Dt QLXGBE 4 +.Dt QLXGBE 4 amd64 .Os .Sh NAME .Nm qlxgbe .Nd "QLogic 10 Gigabit Ethernet & CNA Adapter Driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device qlxgbe" .Ed .Pp To load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent if_qlxgbe_load="YES" .Ed .Sh DESCRIPTION The .Nm driver supports IPv4 checksum offload, TCP and UDP checksum offload for both IPv4 and IPv6, Large Segment Offload for both IPv4 and IPv6, Jumbo frames, VLAN Tag, and Receive Side scaling, ability to select either HW or Software LRO, when LRO is enabled (default HW LRO). For further hardware information, see .Pa http://www.qlogic.com/ . .Sh HARDWARE The .Nm driver supports 10 Gigabit Ethernet & CNA Adapter based on the following chipsets: .Pp .Bl -bullet -compact .It QLogic 8300 series .El .Sh SUPPORT For support questions please contact your QLogic approved reseller or QLogic Technical Support at .Pa http://support.qlogic.com , or by E-mail at .Aq Mt support@qlogic.com . .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 10.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An David C Somayajulu at QLogic Corporation. diff --git a/share/man/man4/qlxge.4 b/share/man/man4/qlxge.4 index 4723c56ff68b..14a1e1284fab 100644 --- a/share/man/man4/qlxge.4 +++ b/share/man/man4/qlxge.4 @@ -1,89 +1,89 @@ .\"- .\" Copyright (c) 2013-2014 Qlogic Corporation .\" 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. .\" .Dd June 21, 2013 -.Dt QLXGE 4 +.Dt QLXGE 4 amd64 .Os .Sh NAME .Nm qlxge .Nd "QLogic 8100 Series 10 Gigabit Ethernet Adapter Driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device qlxge" .Ed .Pp To load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent if_qlxge_load="YES" .Ed .Sh DESCRIPTION The .Nm driver supports IPv4 checksum offload, TCP and UDP checksum offload for both IPv4 and IPv6, Large Segment Offload for both IPv4 and IPv6, Jumbo frames, VLAN Tag, and Receive Side scaling. For further hardware information, see .Pa http://www.qlogic.com/ . .Sh HARDWARE The .Nm driver supports 10 Gigabit Ethernet & CNA Adapter based on the following chipsets: .Pp .Bl -bullet -compact .It QLogic 8100 series .El .Sh SUPPORT For support questions please contact your QLogic approved reseller or QLogic Technical Support at .Pa http://support.qlogic.com , or by E-mail at .Aq Mt support@qlogic.com . .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 10.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An David C Somayajulu at QLogic Corporation. diff --git a/share/man/man4/sfxge.4 b/share/man/man4/sfxge.4 index a9724074581e..ea35cf3e573c 100644 --- a/share/man/man4/sfxge.4 +++ b/share/man/man4/sfxge.4 @@ -1,187 +1,187 @@ .\" Copyright (c) 2011-2016 Solarflare Communications 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 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) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" The views and conclusions contained in the software and documentation are .\" those of the authors and should not be interpreted as representing official .\" policies, either expressed or implied, of the FreeBSD Project. .\" .Dd February 22, 2015 -.Dt SFXGE 4 +.Dt SFXGE 4 amd64 .Os .Sh NAME .Nm sfxge .Nd "Solarflare 10Gb Ethernet adapter driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device sfxge" .Ed .Pp To load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent sfxge_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for 10Gb Ethernet adapters based on Solarflare SFC9000 and XtremeScale X2 family controllers. The driver supports jumbo frames, transmit/receive checksum offload, TCP Segmentation Offload (TSO), Large Receive Offload (LRO), VLAN checksum offload, VLAN TSO, and Receive Side Scaling (RSS) using MSI-X interrupts. .Pp The driver allocates 1 receive queue, transmit queue, event queue and IRQ per CPU up to a maximum of 64. IRQ affinities should be spread out using .Xr cpuset 1 . Interrupt moderation may be controlled through the sysctl .Va dev.sfxge.%d.int_mod (units are microseconds). .Pp For more information on configuring this device, see .Xr ifconfig 8 . .Pp A large number of MAC, PHY and data path statistics are available under the sysctl .Va dev.sfxge.%d.stats . The adapter's VPD fields including its serial number are available under the sysctl .Va dev.sfxge.%d.vpd . .Sh HARDWARE The .Nm driver supports all 10Gb Ethernet adapters based on Solarflare SFC9000 family controllers. .Sh LOADER TUNABLES Tunables can be set at the .Xr loader 8 prompt before booting the kernel or stored in .Xr loader.conf 5 . Actual values can be obtained using .Xr sysctl 8 . .Bl -tag -width indent .It Va hw.sfxge.rx_ring The maximum number of descriptors in a receive queue ring. Supported values are: 512, 1024, 2048 and 4096. .It Va hw.sfxge.tx_ring The maximum number of descriptors in a transmit queue ring. Supported values are: 512, 1024, 2048 and 4096. .It Va hw.sfxge.tx_dpl_get_max The maximum length of the deferred packet .Dq get-list for queued transmit packets (TCP and non-TCP), used only if the transmit queue lock can be acquired. If a packet is dropped, the .Va tx_get_overflow counter is incremented and the local sender receives ENOBUFS. The value must be greater than 0. .It Va hw.sfxge.tx_dpl_get_non_tcp_max The maximum number of non-TCP packets in the deferred packet .Dq get-list , used only if the transmit queue lock can be acquired. If a packet is dropped, the .Va tx_get_non_tcp_overflow counter is incremented and the local sender receives ENOBUFS. The value must be greater than 0. .It Va hw.sfxge.tx_dpl_put_max The maximum length of the deferred packet .Dq put-list for queued transmit packets, used if the transmit queue lock cannot be acquired. If a packet is dropped, the .Va tx_put_overflow counter is incremented and the local sender receives ENOBUFS. The value must be greater than or equal to 0. .It Va hw.sfxge.tso_fw_assisted Bitmask to enable/disable usage of FW-assisted TSO version if supported by NIC firmware. FATSOv1 (bit 0) and FATSOv2 (bit 1) are supported. All enabled by default. .It Va hw.sfxge.N.max_rss_channels The maximum number of allocated RSS channels for the Nth adapter. If set to 0 or unset, the number of channels is determined by the number of CPU cores. .It Va hw.sfxge.lro.table_size Size of the LRO hash table. Must be a power of 2. A larger table means we can accelerate a larger number of streams. .It Va hw.sfxge.lro.chain_max The maximum length of a hash chain. If chains get too long then the lookup time increases and may exceed the benefit of LRO. .It Va hw.sfxge.lro.idle_ticks The maximum time (in ticks) that a connection can be idle before it's LRO state is discarded. .It Va hw.sfxge.lro.slow_start_packets Number of packets with payload that must arrive in-order before a connection is eligible for LRO. The idea is we should avoid coalescing segments when the sender is in slow-start because reducing the ACK rate can damage performance. .It Va hw.sfxge.lro.loss_packets Number of packets with payload that must arrive in-order following loss before a connection is eligible for LRO. The idea is we should avoid coalescing segments when the sender is recovering 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 .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. .It Va hw.sfxge.stats_update_period_ms Period in milliseconds to refresh interface statistics from hardware. The accepted range is 0 to 65535, the default is 1000 (1 second). Use zero value to disable periodic statistics update. Supported on SFN8xxx series adapters with firmware v6.2.1.1033 and later and SFN5xxx, SFN6xxx and XtremeScale X2xxx series adapters. SFN7xxx series adapters and sfN8xxx series with earlier firmware use a fixed 1000 milliseconds statistics update period. The period may also be changed after the driver is loaded using the sysctl .Va dev.sfxge.%d.stats_update_period_ms . .El .Sh SUPPORT For general information and support, go to the Solarflare support website at: .Pa https://support.solarflare.com . .Sh SEE ALSO .Xr cpuset 1 , .Xr arp 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 .Sh AUTHORS The .Nm driver was written by .An Philip Paeps and .An Solarflare Communications, Inc. diff --git a/share/man/man4/smartpqi.4 b/share/man/man4/smartpqi.4 index 5b7ea923e13e..f5fab85d13bd 100644 --- a/share/man/man4/smartpqi.4 +++ b/share/man/man4/smartpqi.4 @@ -1,95 +1,95 @@ .\" Copyright (C) 2019-2023, Microchip Technology Inc. and its subsidiaries .\" Copyright (C) 2016-2018, Microsemi Corporation .\" Copyright (C) 2016, PMC-Sierra, Inc. .\" Written by John Hall .\" .\" 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. .\" .Dd August 24, 2023 -.Dt SMARTPQI 4 +.Dt SMARTPQI 4 amd64 .Os .Sh NAME .Nm smartpqi .Nd "Microchip Smart Storage SCSI driver" .Sh SYNOPSIS To compile this driver into the kernel, place these lines in the kernel configuration file: .Bd -ragged -offset indent .Cd device pci .Cd device scbus .Cd device smartpqi .Ed .Pp The driver can be loaded as a module at boot time by placing this line in .Xr loader.conf 5 : .Bd -literal -offset indent smartpqi_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for Microchip Technology Inc. / Adaptec SmartRaid and SmartHBA SATA/SAS/NVME PCIe controllers .Sh HARDWARE Controllers supported by the .Nm driver include, but not limited to: .Pp .Bl -bullet -compact .It HPE Gen10 Smart Array Controller Family .It Adaptec SmartRaid and SmartHBA Controllers .It OEM Controllers based on the Microchip Technology Inc. SmartROC and SmartIOC Chipsets .El .Sh FILES .Bl -tag -width /boot/kernel/smartpqi.ko -compact .It Pa /dev/smartpqi? smartpqi management interface .El .Sh NOTES .Ss Configuration To configure a Microchip Smart Storage controller, refer to the User Guide for the controller, which can be found by searching for the specific controller at https://www.microchip.com/design-centers/storage .Sh SEE ALSO .Xr kld 4 , .Xr linux 4 , .Xr pass 4 , .Xr scsi 4 , .Xr xpt 4 , .Xr loader.conf 5 , .Xr camcontrol 8 , .Xr kldload 8 .Sh HISTORY The .Nm driver first appeared in .Fx 11.1 . .Sh AUTHORS .An John Hall .Aq john.hall@microchip.com .Sh BUGS The controller is not actually paused on suspend/resume. diff --git a/share/man/man4/sume.4 b/share/man/man4/sume.4 index 219328a4f4c4..b36f924875e6 100644 --- a/share/man/man4/sume.4 +++ b/share/man/man4/sume.4 @@ -1,96 +1,96 @@ .\"- .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2020 Denis Salopek .\" .\" 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 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) .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" .Dd August 30, 2020 -.Dt SUME 4 +.Dt SUME 4 amd64 .Os .Sh NAME .Nm sume .Nd "NetFPGA SUME 4x10Gb Ethernet driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device sume" .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 if_sume_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for NetFPGA SUME Virtex-7 FPGA Development Board with the reference NIC bitstream loaded onto it. The HDL design for the reference NIC project uses the RIFFA based DMA engine to communicate with the host machine over PCIe. Every packet is transmitted to / from the board via a single DMA transaction, taking up to two or three interrupts per one transaction which yields low performance. .Pp There is no support for Jumbo frames as the hardware is capable of dealing only with frames with maximum size of 1514 bytes. The hardware does not support multicast filtering, provides no checksums, and offers no other offloading. .Sh SEE ALSO .Xr arp 4 , .Xr netgraph 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 .Sh AUTHORS The Linux .Nm driver was originally written by .An -nosplit .An Bjoern A. Zeeb . The .Fx version and this manual page were written by .An Denis Salopek as a GSoC project. More information about the project can be found here: .Pa https://wiki.freebsd.org/SummerOfCode2020Projects/NetFPGA_SUME_Driver .Sh BUGS The reference NIC hardware design provides no mechanism for quiescing inbound traffic from interfaces configured as DOWN. All packets from administratively disabled interfaces are transferred to main memory, leaving the driver with the task of dropping such packets, thus consuming PCI bandwidth, interrupts and CPU cycles in vain. .Pp Pre-built FPGA bitstream from the NetFPGA project may not work correctly. At higher RX packet rates, the newly incoming packets can overwrite the ones in an internal FIFO so the packets would arrive in main memory corrupted, until a physical reset of the board. .Pp Occasionally, the driver can get stuck in a non-IDLE TX state due to a missed interrupt. The driver includes a watchdog function which monitors for such a condition and resets the board automatically. For more details, visit the NetFPGA SUME project site.