diff --git a/share/man/man4/atopcase.4 b/share/man/man4/atopcase.4 index fc93b7094466..33e47ec64ee8 100644 --- a/share/man/man4/atopcase.4 +++ b/share/man/man4/atopcase.4 @@ -1,134 +1,134 @@ .\" Copyright (c) 2023 Vladimir Kondratyev .\" .\" 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 17, 2023 .Dt ATOPCASE 4 .Os .Sh NAME .Nm atopcase .Nd Apple HID-over-SPI transport 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 atopcase" .Cd "device intelspi" .Cd "device spibus" .Cd "device hidbus" .Cd "device hkbd" .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 atopcase_load="YES" hkbd_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for Human Interface Devices (HID) on Serial Peripheral Interface (SPI) buses on Apple Intel Macs. .Sh HARDWARE The .Nm driver supports the following MacBooks produced in 2015-2018 years: .Pp .Bl -bullet -compact .It Macbook8,1 .It Macbook9,1 .It Macbook10,1 .It MacbookPro11,4 .It MacbookPro12,1 .It MacbookPro13,1 .It MacbookPro13,2 .It MacbookPro13,3 .It MacbookPro14,1 .It MacbookPro14,2 .It MacbookPro14,3 .El .Sh SYSCTL VARIABLES The following variables are available as both .Xr sysctl 8 variables and .Xr loader 8 tunables: .Bl -tag -width indent .It Va hw.hid.atopcase.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Sh FILES .Bl -tag -width ".Pa /dev/backlight/atopcase0" -compact .It Pa /dev/backlight/atopcase0 Keyboard .Xr backlight 8 device node. .El .Sh SEE ALSO .Xr acpi 4 , .Xr backlight 8 , .Xr loader 8 , .Xr loader.conf 5 . .Sh HISTORY The .Nm driver first appeared in -.Fx 14.0. +.Fx 14.0 . .Sh AUTHORS .An -nosplit The .Nm driver was originally written by .An Val Packett Aq Mt val@packett.cool and marginally improved upon by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . .Pp This manual page was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . .Sh BUGS Device interrupts are not acknowledged on some hardware that results in interrupt storm. Installation of Darwin OSI in .Xr acpi 4 driver fixes the issue. To install Darwin OSI add following lines to .Xr loader.conf 5 : .Bl -tag -width indent .It Va hw.acpi.install_interface="Darwin" .It Va hw.acpi.remove_interface="Windows 2009, Windows 2012" .El diff --git a/share/man/man4/hconf.4 b/share/man/man4/hconf.4 index b271434698d9..179d95a29832 100644 --- a/share/man/man4/hconf.4 +++ b/share/man/man4/hconf.4 @@ -1,88 +1,88 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 January 18, 2021 .Dt HCONF 4 .Os .Sh NAME .Nm hconf .Nd MS Windows Precision Touchpad configuration 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 hconf" .Cd "device hid" .Cd "device hidbus" .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 hconf_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for generic MS Windows Precision Touchpad configuration collection. It enables the host to configure two different aspects of the device. One allows the host to select input mode, and the other allows the host to be selective in what is reported. .Sh SYSCTL VARIABLES Next parameters are available as .Xr sysctl 8 variables. Debug parameter is available as .Xr loader 8 tunable as well. .Bl -tag -width indent .It Va dev.hconf.*.input_mode HID device input mode: 0 = mouse, 3 = touchpad. .It Va dev.hconf.*.surface_switch Enable / disable switch for surface: 1 = on, 0 = off. .It Va dev.hconf.*.buttons_switch Enable / disable switch for buttons: 1 = on, 0 = off. .It Va hw.hid.hconf.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Sh SEE ALSO .Xr hms 4 , .Xr hmt 4 .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . Switch parameter support was added by .An Andriy Gapon Aq Mt avg@FreeBSD.org . diff --git a/share/man/man4/hcons.4 b/share/man/man4/hcons.4 index 993425e5773e..6cdf0a7dc170 100644 --- a/share/man/man4/hcons.4 +++ b/share/man/man4/hcons.4 @@ -1,96 +1,96 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 January 23, 2021 .Dt HCONS 4 .Os .Sh NAME .Nm hcons .Nd HID consumer page controls 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 hcons" .Cd "device hid" .Cd "device hidbus" .Cd "device hidmap" .Cd "device evdev" .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 hcons_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for HID consumer page controls most often used as "Multimedia keys" found on many keyboards. .Pp The .Pa /dev/input/event* device presents the consumer page controls as a .Ar evdev type device. .Sh SYSCTL VARIABLES The following variable is available as both .Xr sysctl 8 variable and .Xr loader 8 tunable: .Bl -tag -width indent .It Va dev.hcons.X.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Pp It default value is set with .Xr loader 8 tunable: .Bl -tag -width indent .It Va hw.hid.hcons.debug .El .Sh FILES .Bl -tag -width /dev/input/event* -compact .It Pa /dev/input/event* input event device node. .El .Sh SEE ALSO .Xr iichid 4 , .Xr usbhid 4 .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/hgame.4 b/share/man/man4/hgame.4 index 58f09e8f4d50..3309833c1720 100644 --- a/share/man/man4/hgame.4 +++ b/share/man/man4/hgame.4 @@ -1,103 +1,103 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 September 14, 2020 .Dt HGAME 4 .Os .Sh NAME .Nm hgame .Nd Generic HID game controller (joystick/gamepad) 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 hgame" .Cd "device hid" .Cd "device hidbus" .Cd "device hidmap" .Cd "device evdev" .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 hgame_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for generic game controllers (joysticks/gamepads) that attach to the HID transport backend. See .Xr iichid 4 or .Xr usbhid 4 . .Pp The .Pa /dev/input/event* device presents the game controller as a .Ar evdev type device. .Sh SYSCTL VARIABLES The following variable is available as both .Xr sysctl 8 variable and .Xr loader 8 tunable: .Bl -tag -width indent .It Va dev.hgame.X.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Pp It's default value is set with .Xr loader 8 tunable: .Bl -tag -width indent .It Va hw.hid.hgame.debug .El .Sh FILES .Bl -tag -width /dev/input/event* -compact .It Pa /dev/input/event* input event device node. .El .Sh SEE ALSO .Xr iichid 4 , .Xr usbhid 4 .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Val Packett Aq Mt val@packett.cool . .Pp This manual page was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/hidbus.4 b/share/man/man4/hidbus.4 index 8593d1d2c222..f8ebaca8d659 100644 --- a/share/man/man4/hidbus.4 +++ b/share/man/man4/hidbus.4 @@ -1,100 +1,100 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 September 14, 2020 .Dt HIDBUS 4 .Os .Sh NAME .Nm hidbus .Nd generic HID bus 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 hidbus" .Cd "device hid" .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 hidbus_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for multiple HID driver attachments to single HID transport backend. See .Xr iichid 4 or .Xr usbhid 4 . .Pp Each HID device can have several components, e.g., a keyboard and a mouse. These components use different report identifiers (a byte) combined into groups called collections to distinguish which one data is coming from. The .Nm driver has other drivers attached that handle particular kinds of devices and .Nm broadcasts data to all of them. .Sh SYSCTL VARIABLES The following variables are available as both .Xr sysctl 8 variables and .Xr loader 8 tunables: .Bl -tag -width indent .It Va hw.hid.hidbus.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Sh SEE ALSO .Xr hconf 4 , .Xr hcons 4 , .Xr hgame 4 , .Xr hidraw 4 , .Xr hkbd 4 , .Xr hms 4 , .Xr hmt 4 , .Xr hpen 4 , .Xr hsctrl 4 , .Xr hskbd 4 , .Xr iichid 4 , .Xr usbhid 4 .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/hpen.4 b/share/man/man4/hpen.4 index 64f4200b3b21..d3b69ff1b332 100644 --- a/share/man/man4/hpen.4 +++ b/share/man/man4/hpen.4 @@ -1,110 +1,110 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 September 14, 2020 .Dt HPEN 4 .Os .Sh NAME .Nm hpen .Nd MS Windows compatible HID pen tablet 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 hpen" .Cd "device hid" .Cd "device hidbus" .Cd "device hidmap" .Cd "device evdev" .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 hpen_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for generic MS Windows compatible HID pen tablet and digitizer that attach to the HID transport backend. See .Xr iichid 4 or .Xr usbhid 4 . .Pp The .Pa /dev/input/event* device presents the pen as a .Ar evdev type device. .Sh SYSCTL VARIABLES The following variable is available as both .Xr sysctl 8 variable and .Xr loader 8 tunable: .Bl -tag -width indent .It Va dev.hpen.X.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Pp It's default value is set with .Xr loader 8 tunable: .Bl -tag -width indent .It Va hw.hid.hpen.debug .El .Sh FILES .Bl -tag -width /dev/input/event* -compact .It Pa /dev/input/event* input event device node. .El .Sh SEE ALSO .Xr iichid 4 , .Xr usbhid 4 , .Xr xorg.conf 5 Pq Pa ports/x11/xorg .Sh BUGS .Nm cannot act like .Xr sysmouse 4 . .Pp Pen battery charge level reporting is not supported. .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Val Packett Aq Mt val@packett.cool . .Pp This manual page was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/hsctrl.4 b/share/man/man4/hsctrl.4 index 64db32f09d41..fa8ae897e64c 100644 --- a/share/man/man4/hsctrl.4 +++ b/share/man/man4/hsctrl.4 @@ -1,96 +1,96 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 January 26, 2021 .Dt HSCTRL 4 .Os .Sh NAME .Nm hsctrl .Nd HID system controls 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 hsctrl" .Cd "device hid" .Cd "device hidbus" .Cd "device hidmap" .Cd "device evdev" .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 hsctrl_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for HID system controls most often used as "Power off/Sleep keys" found on many keyboards. .Pp The .Pa /dev/input/event* device presents the consumer page controls as a .Ar evdev type device. .Sh SYSCTL VARIABLES The following variable is available as both .Xr sysctl 8 variable and .Xr loader 8 tunable: .Bl -tag -width indent .It Va dev.hsctrl.X.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Pp It default value is set with .Xr loader 8 tunable: .Bl -tag -width indent .It Va hw.hid.hsctrl.debug .El .Sh FILES .Bl -tag -width /dev/input/event* -compact .It Pa /dev/input/event* input event device node. .El .Sh SEE ALSO .Xr iichid 4 , .Xr usbhid 4 .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/iichid.4 b/share/man/man4/iichid.4 index 62af1e57c6cc..02a91d7811a2 100644 --- a/share/man/man4/iichid.4 +++ b/share/man/man4/iichid.4 @@ -1,94 +1,94 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 September 21, 2020 .Dt IICHID 4 .Os .Sh NAME .Nm iichid .Nd I2C HID transport 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 iichid" .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 iichid_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides a interface to I2C Human Interface Devices (HIDs). .Sh SYSCTL VARIABLES Next parameters are available as .Xr sysctl 8 variables. Debug parameter is available as .Xr loader 8 tunable as well. .Bl -tag -width indent .It Va dev.iichid.*.sampling_rate_fast Active sampling rate in num/second (for sampling mode). .It Va dev.iichid.*.sampling_rate_slow Idle sampling rate in num/second (for sampling mode). .It Va dev.iichid.*.sampling_hysteresis Number of missing samples before enabling of slow mode (for sampling mode). .It Va hw.iichid.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Sh SEE ALSO .Xr ig4 4 .Sh BUGS The .Nm does not support GPIO interrupts yet. In that case .Nm enables sampling mode with periodic polling of hardware by driver means. See dev.iichid.*.sampling_* .Xr sysctl 8 variables for tuning of sampling parameters. .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Marc Priggemeyer Aq Mt marc.priggemeyer@gmail.com and .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . .Pp This manual page was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/man4.powerpc/llan.4 b/share/man/man4/man4.powerpc/llan.4 index 45f08e7478d1..c32ddbca6a00 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 .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. +.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/ps4dshock.4 b/share/man/man4/ps4dshock.4 index a6d0df87af76..282a58c49e63 100644 --- a/share/man/man4/ps4dshock.4 +++ b/share/man/man4/ps4dshock.4 @@ -1,107 +1,107 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 September 19, 2020 .Dt PS4DSHOCK 4 .Os .Sh NAME .Nm ps4dshock .Nd Sony PlayStation 4 Dualshock 4 gamepad 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 ps4dshock" .Cd "device hid" .Cd "device hidbus" .Cd "device hidmap" .Cd "device evdev" .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 ps4dshock_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for Sony PlayStation 4 Dualshock 4 gamepad driver. .Pp The .Pa /dev/input/event* device presents the game controller as a .Ar evdev type device. .Sh SYSCTL VARIABLES Next parameters are available as .Xr sysctl 8 variables. Debug parameter is available as .Xr loader 8 tunable as well. .Bl -tag -width indent .It Va dev.p4dshock.*.led_state LED state: 0 - off, 1 - on, 2 - blinking. .It Va dev.p4dshock.*.led_color_r LED color. Red component. .It Va dev.p4dshock.*.led_color_g LED color. Green component. .It Va dev.p4dshock.*.led_color_b LED color. Blue component. .It Va dev.p4dshock.*.led_delay_on LED blink. On delay, msecs. .It Va dev.p4dshock.*.led_delay_off LED blink. Off delay, msecs. .It Va hw.hid.ps4dshock.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Sh FILES .Bl -tag -width /dev/input/event* -compact .It Pa /dev/input/event* input event device node. .El .Sh BUGS The .Nm does not support force-feedback events. .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/usbhid.4 b/share/man/man4/usbhid.4 index 156f53a051ea..c47afaff3534 100644 --- a/share/man/man4/usbhid.4 +++ b/share/man/man4/usbhid.4 @@ -1,84 +1,84 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 January 12, 2021 .Dt USBHID 4 .Os .Sh NAME .Nm usbhid .Nd USB HID transport 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 usbhid" .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 usbhid_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides a interface to USB Human Interface Devices (HIDs). .Sh SYSCTL VARIABLES The following variables are available as both .Xr sysctl 8 variables and .Xr loader 8 tunables: .Bl -tag -width indent .It Va hw.usb.usbhid.enable Enable .Nm and make its priority greater than other USB HID drivers have. Default is 0. .El .Bl -tag -width indent .It Va hw.usb.usbhid.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Sh SEE ALSO .Xr ehci 4 , .Xr ohci 4 , .Xr uhci 4 , .Xr usb 4 , .Xr xhci 4 , .Xr usbconfig 8 .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . diff --git a/share/man/man4/xb360gp.4 b/share/man/man4/xb360gp.4 index a08063bef42d..4e8d4b65fcfd 100644 --- a/share/man/man4/xb360gp.4 +++ b/share/man/man4/xb360gp.4 @@ -1,96 +1,96 @@ .\" Copyright (c) 2020 Vladimir Kondratyev .\" .\" 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 September 16, 2020 .Dt XB360GP 4 .Os .Sh NAME .Nm xb360gp .Nd XBox 360 gamepad 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 xb360gp" .Cd "device hgame" .Cd "device hid" .Cd "device hidbus" .Cd "device hidmap" .Cd "device evdev" .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 xb360gp_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for XBox 360 gamepad driver. .Pp The .Pa /dev/input/event* device presents the game controller as a .Ar evdev type device. .Sh SYSCTL VARIABLES The following variable is available as both .Xr sysctl 8 variable and .Xr loader 8 tunable: .Bl -tag -width indent .It Va dev.xb360gp.X.debug Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0. .El .Pp It's default value is set with .Xr loader 8 tunable: .Bl -tag -width indent .It Va hw.hid.xb360gp.debug .El .Sh FILES .Bl -tag -width /dev/input/event* -compact .It Pa /dev/input/event* input event device node. .El .Sh HISTORY The .Nm driver first appeared in -.Fx 13.0. +.Fx 13.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Val Packett Aq Mt val@packett.cool . .Pp This manual page was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .