mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-12-29 01:05:29 +00:00
docs: driver-api: add a series of orphaned documents
There are lots of documents under Documentation/*.txt and a few other orphan documents elsehwere that belong to the driver-API book. Move them to their right place. Reviewed-by: Cornelia Huck <cohuck@redhat.com> # vfio-related parts Acked-by: Logan Gunthorpe <logang@deltatee.com> # switchtec Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
parent
4f4cfa6c56
commit
baa293e954
@ -1,6 +1,6 @@
|
||||
rfkill - radio frequency (RF) connector kill switch support
|
||||
|
||||
For details to this subsystem look at Documentation/rfkill.txt.
|
||||
For details to this subsystem look at Documentation/driver-api/rfkill.rst.
|
||||
|
||||
What: /sys/class/rfkill/rfkill[0-9]+/claim
|
||||
Date: 09-Jul-2007
|
||||
|
@ -1,6 +1,6 @@
|
||||
rfkill - radio frequency (RF) connector kill switch support
|
||||
|
||||
For details to this subsystem look at Documentation/rfkill.txt.
|
||||
For details to this subsystem look at Documentation/driver-api/rfkill.rst.
|
||||
|
||||
For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in
|
||||
Documentation/ABI/removed/sysfs-class-rfkill.
|
||||
|
@ -1,6 +1,6 @@
|
||||
switchtec - Microsemi Switchtec PCI Switch Management Endpoint
|
||||
|
||||
For details on this subsystem look at Documentation/switchtec.txt.
|
||||
For details on this subsystem look at Documentation/driver-api/switchtec.rst.
|
||||
|
||||
What: /sys/class/switchtec
|
||||
Date: 05-Jan-2017
|
||||
|
@ -930,7 +930,7 @@
|
||||
edid/1680x1050.bin, or edid/1920x1080.bin is given
|
||||
and no file with the same name exists. Details and
|
||||
instructions how to build your own EDID data are
|
||||
available in Documentation/EDID/howto.rst. An EDID
|
||||
available in Documentation/driver-api/edid.rst. An EDID
|
||||
data set will only be used for a particular connector,
|
||||
if its name and a colon are prepended to the EDID
|
||||
name. Each connector may use a unique EDID data
|
||||
|
@ -643,7 +643,7 @@ Sysfs notes
|
||||
2010.
|
||||
|
||||
rfkill controller switch "tpacpi_bluetooth_sw": refer to
|
||||
Documentation/rfkill.txt for details.
|
||||
Documentation/driver-api/rfkill.rst for details.
|
||||
|
||||
|
||||
Video output control -- /proc/acpi/ibm/video
|
||||
@ -1406,7 +1406,7 @@ Sysfs notes
|
||||
2010.
|
||||
|
||||
rfkill controller switch "tpacpi_wwan_sw": refer to
|
||||
Documentation/rfkill.txt for details.
|
||||
Documentation/driver-api/rfkill.rst for details.
|
||||
|
||||
|
||||
EXPERIMENTAL: UWB
|
||||
@ -1426,7 +1426,7 @@ Sysfs notes
|
||||
^^^^^^^^^^^
|
||||
|
||||
rfkill controller switch "tpacpi_uwb_sw": refer to
|
||||
Documentation/rfkill.txt for details.
|
||||
Documentation/driver-api/rfkill.rst for details.
|
||||
|
||||
Adaptive keyboard
|
||||
-----------------
|
||||
|
@ -1,4 +1,4 @@
|
||||
:orphan:
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
================
|
||||
Kernel Connector
|
@ -1,4 +1,4 @@
|
||||
:orphan:
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===============
|
||||
Console Drivers
|
@ -1,4 +1,4 @@
|
||||
:orphan:
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
====
|
||||
EDID
|
@ -68,7 +68,33 @@ available subsections can be seen below.
|
||||
fpga/index
|
||||
acpi/index
|
||||
backlight/lp855x-driver.rst
|
||||
bt8xxgpio
|
||||
connector
|
||||
console
|
||||
dcdbas
|
||||
dell_rbu
|
||||
edid
|
||||
eisa
|
||||
isa
|
||||
isapnp
|
||||
generic-counter
|
||||
lightnvm-pblk
|
||||
men-chameleon-bus
|
||||
ntb
|
||||
nvmem
|
||||
parport-lowlevel
|
||||
pti_intel_mid
|
||||
pwm
|
||||
rfkill
|
||||
sgi-ioc4
|
||||
sm501
|
||||
smsc_ece1099
|
||||
switchtec
|
||||
sync_file
|
||||
vfio-mediated-device
|
||||
vfio
|
||||
xillybus
|
||||
zorro
|
||||
|
||||
.. only:: subproject and html
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
:orphan:
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===============
|
||||
NVMEM Subsystem
|
@ -1,4 +1,4 @@
|
||||
:orphan:
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
=============
|
||||
Intel MID PTI
|
@ -97,6 +97,6 @@ the following configuration settings:
|
||||
NT EP BAR 2 will be dynamically configured as a Direct Window, and
|
||||
the configuration file does not need to configure it explicitly.
|
||||
|
||||
Please refer to Documentation/ntb.txt in Linux source tree for an overall
|
||||
Please refer to Documentation/driver-api/ntb.rst in Linux source tree for an overall
|
||||
understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB
|
||||
Hardware Driver in this stack.
|
@ -408,7 +408,7 @@ card.
|
||||
References
|
||||
==========
|
||||
|
||||
1. See Documentation/vfio.txt for more information on VFIO.
|
||||
1. See Documentation/driver-api/vfio.rst for more information on VFIO.
|
||||
2. struct mdev_driver in include/linux/mdev.h
|
||||
3. struct mdev_parent_ops in include/linux/mdev.h
|
||||
4. struct vfio_iommu_driver_ops in include/linux/vfio.h
|
@ -187,7 +187,7 @@ the hardware. Thus, in a VGA console::
|
||||
Assuming the VGA driver can be unloaded, one must first unbind the VGA driver
|
||||
from the console layer before unloading the driver. The VGA driver cannot be
|
||||
unloaded if it is still bound to the console layer. (See
|
||||
Documentation/console/console.rst for more information).
|
||||
Documentation/driver-api/console.rst for more information).
|
||||
|
||||
This is more complicated in the case of the framebuffer console (fbcon),
|
||||
because fbcon is an intermediate layer between the console and the drivers::
|
||||
@ -204,7 +204,7 @@ fbcon. Thus, there is no need to explicitly unbind the fbdev drivers from
|
||||
fbcon.
|
||||
|
||||
So, how do we unbind fbcon from the console? Part of the answer is in
|
||||
Documentation/console/console.rst. To summarize:
|
||||
Documentation/driver-api/console.rst. To summarize:
|
||||
|
||||
Echo a value to the bind file that represents the framebuffer console
|
||||
driver. So assuming vtcon1 represents fbcon, then::
|
||||
|
@ -38,7 +38,7 @@ every detail. More information/reference could be found here:
|
||||
qemu/hw/s390x/css.c
|
||||
|
||||
For vfio mediated device framework:
|
||||
- Documentation/vfio-mediated-device.txt
|
||||
- Documentation/driver-api/vfio-mediated-device.rst
|
||||
|
||||
Motivation of vfio-ccw
|
||||
----------------------
|
||||
@ -322,5 +322,5 @@ Reference
|
||||
2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204)
|
||||
3. https://en.wikipedia.org/wiki/Channel_I/O
|
||||
4. Documentation/s390/cds.rst
|
||||
5. Documentation/vfio.txt
|
||||
6. Documentation/vfio-mediated-device.txt
|
||||
5. Documentation/driver-api/vfio.rst
|
||||
6. Documentation/driver-api/vfio-mediated-device.rst
|
||||
|
@ -183,7 +183,7 @@ acknowledge number is set to seq+1.
|
||||
Additional documantion, source code examples.
|
||||
============================================
|
||||
|
||||
1. Documentation/connector
|
||||
1. Documentation/driver-api/connector.rst
|
||||
2. http://www.ioremap.net/archive/w1
|
||||
This archive includes userspace application w1d.c which uses
|
||||
read/write/search commands for all master/slave devices found on the bus.
|
||||
|
22
MAINTAINERS
22
MAINTAINERS
@ -4642,7 +4642,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas)
|
||||
M: Stuart Hayes <stuart.w.hayes@gmail.com>
|
||||
L: platform-driver-x86@vger.kernel.org
|
||||
S: Maintained
|
||||
F: Documentation/dcdbas.txt
|
||||
F: Documentation/driver-api/dcdbas.rst
|
||||
F: drivers/platform/x86/dcdbas.*
|
||||
|
||||
DELL WMI NOTIFICATIONS DRIVER
|
||||
@ -8462,7 +8462,7 @@ F: drivers/irqchip/
|
||||
ISA
|
||||
M: William Breathitt Gray <vilhelm.gray@gmail.com>
|
||||
S: Maintained
|
||||
F: Documentation/isa.txt
|
||||
F: Documentation/driver-api/isa.rst
|
||||
F: drivers/base/isa.c
|
||||
F: include/linux/isa.h
|
||||
|
||||
@ -8477,7 +8477,7 @@ F: drivers/media/radio/radio-isa*
|
||||
ISAPNP
|
||||
M: Jaroslav Kysela <perex@perex.cz>
|
||||
S: Maintained
|
||||
F: Documentation/isapnp.txt
|
||||
F: Documentation/driver-api/isapnp.rst
|
||||
F: drivers/pnp/isapnp/
|
||||
F: include/linux/isapnp.h
|
||||
|
||||
@ -10353,7 +10353,7 @@ M: Johannes Thumshirn <morbidrsa@gmail.com>
|
||||
S: Maintained
|
||||
F: drivers/mcb/
|
||||
F: include/linux/mcb.h
|
||||
F: Documentation/men-chameleon-bus.txt
|
||||
F: Documentation/driver-api/men-chameleon-bus.rst
|
||||
|
||||
MEN F21BMC (Board Management Controller)
|
||||
M: Andreas Werner <andreas.werner@men.de>
|
||||
@ -12070,7 +12070,7 @@ F: drivers/parport/
|
||||
F: include/linux/parport*.h
|
||||
F: drivers/char/ppdev.c
|
||||
F: include/uapi/linux/ppdev.h
|
||||
F: Documentation/parport*.txt
|
||||
F: Documentation/driver-api/parport*.rst
|
||||
|
||||
PARAVIRT_OPS INTERFACE
|
||||
M: Juergen Gross <jgross@suse.com>
|
||||
@ -12245,7 +12245,7 @@ M: Kurt Schwemmer <kurt.schwemmer@microsemi.com>
|
||||
M: Logan Gunthorpe <logang@deltatee.com>
|
||||
L: linux-pci@vger.kernel.org
|
||||
S: Maintained
|
||||
F: Documentation/switchtec.txt
|
||||
F: Documentation/driver-api/switchtec.rst
|
||||
F: Documentation/ABI/testing/sysfs-class-switchtec
|
||||
F: drivers/pci/switch/switchtec*
|
||||
F: include/uapi/linux/switchtec_ioctl.h
|
||||
@ -13006,7 +13006,7 @@ M: Thierry Reding <thierry.reding@gmail.com>
|
||||
L: linux-pwm@vger.kernel.org
|
||||
S: Maintained
|
||||
T: git git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm.git
|
||||
F: Documentation/pwm.txt
|
||||
F: Documentation/driver-api/pwm.rst
|
||||
F: Documentation/devicetree/bindings/pwm/
|
||||
F: include/linux/pwm.h
|
||||
F: drivers/pwm/
|
||||
@ -13620,7 +13620,7 @@ W: http://wireless.kernel.org/
|
||||
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git
|
||||
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git
|
||||
S: Maintained
|
||||
F: Documentation/rfkill.txt
|
||||
F: Documentation/driver-api/rfkill.rst
|
||||
F: Documentation/ABI/stable/sysfs-class-rfkill
|
||||
F: net/rfkill/
|
||||
F: include/linux/rfkill.h
|
||||
@ -15343,7 +15343,7 @@ F: drivers/dma-buf/dma-fence*
|
||||
F: drivers/dma-buf/sw_sync.c
|
||||
F: include/linux/sync_file.h
|
||||
F: include/uapi/linux/sync_file.h
|
||||
F: Documentation/sync_file.txt
|
||||
F: Documentation/driver-api/sync_file.rst
|
||||
T: git git://anongit.freedesktop.org/drm/drm-misc
|
||||
|
||||
SYNOPSYS ARC ARCHITECTURE
|
||||
@ -16839,7 +16839,7 @@ R: Cornelia Huck <cohuck@redhat.com>
|
||||
L: kvm@vger.kernel.org
|
||||
T: git git://github.com/awilliam/linux-vfio.git
|
||||
S: Maintained
|
||||
F: Documentation/vfio.txt
|
||||
F: Documentation/driver-api/vfio.rst
|
||||
F: drivers/vfio/
|
||||
F: include/linux/vfio.h
|
||||
F: include/uapi/linux/vfio.h
|
||||
@ -16848,7 +16848,7 @@ VFIO MEDIATED DEVICE DRIVERS
|
||||
M: Kirti Wankhede <kwankhede@nvidia.com>
|
||||
L: kvm@vger.kernel.org
|
||||
S: Maintained
|
||||
F: Documentation/vfio-mediated-device.txt
|
||||
F: Documentation/driver-api/vfio-mediated-device.rst
|
||||
F: drivers/vfio/mdev/
|
||||
F: include/linux/mdev.h
|
||||
F: samples/vfio-mdev/
|
||||
|
@ -15,7 +15,7 @@ config SYNC_FILE
|
||||
associated with a buffer. When a job is submitted to the GPU a fence
|
||||
is attached to the buffer and is transferred via userspace, using Sync
|
||||
Files fds, to the DRM driver for example. More details at
|
||||
Documentation/sync_file.txt.
|
||||
Documentation/driver-api/sync_file.rst.
|
||||
|
||||
config SW_SYNC
|
||||
bool "Sync File Validation Framework"
|
||||
|
@ -1301,7 +1301,7 @@ config GPIO_BT8XX
|
||||
The card needs to be physically altered for using it as a
|
||||
GPIO card. For more information on how to build a GPIO card
|
||||
from a BT8xx TV card, see the documentation file at
|
||||
Documentation/bt8xxgpio.txt
|
||||
Documentation/driver-api/bt8xxgpio.rst
|
||||
|
||||
If unsure, say N.
|
||||
|
||||
|
@ -141,7 +141,7 @@ config DRM_LOAD_EDID_FIRMWARE
|
||||
monitor are unable to provide appropriate EDID data. Since this
|
||||
feature is provided as a workaround for broken hardware, the
|
||||
default case is N. Details and instructions how to build your own
|
||||
EDID data are given in Documentation/EDID/howto.rst.
|
||||
EDID data are given in Documentation/driver-api/edid.rst.
|
||||
|
||||
config DRM_DP_CEC
|
||||
bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"
|
||||
|
@ -9,7 +9,7 @@ config PCI_SW_SWITCHTEC
|
||||
Enables support for the management interface for the MicroSemi
|
||||
Switchtec series of PCIe switches. Supports userspace access
|
||||
to submit MRPC commands to the switch via /dev/switchtecX
|
||||
devices. See <file:Documentation/switchtec.txt> for more
|
||||
devices. See <file:Documentation/driver-api/switchtec.rst> for more
|
||||
information.
|
||||
|
||||
endmenu
|
||||
|
@ -118,7 +118,7 @@ config DCDBAS
|
||||
Interrupts (SMIs) and Host Control Actions (system power cycle or
|
||||
power off after OS shutdown) on certain Dell systems.
|
||||
|
||||
See <file:Documentation/dcdbas.txt> for more details on the driver
|
||||
See <file:Documentation/driver-api/dcdbas.rst> for more details on the driver
|
||||
and the Dell systems on which Dell systems management software makes
|
||||
use of this driver.
|
||||
|
||||
@ -259,7 +259,7 @@ config DELL_RBU
|
||||
DELL system. Note you need a Dell OpenManage or Dell Update package (DUP)
|
||||
supporting application to communicate with the BIOS regarding the new
|
||||
image for the image update to take effect.
|
||||
See <file:Documentation/dell_rbu.txt> for more details on the driver.
|
||||
See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver.
|
||||
|
||||
|
||||
config FUJITSU_LAPTOP
|
||||
|
@ -7,7 +7,7 @@
|
||||
* and Host Control Actions (power cycle or power off after OS shutdown) on
|
||||
* Dell systems.
|
||||
*
|
||||
* See Documentation/dcdbas.txt for more information.
|
||||
* See Documentation/driver-api/dcdbas.rst for more information.
|
||||
*
|
||||
* Copyright (C) 1995-2006 Dell Inc.
|
||||
*/
|
||||
|
@ -24,7 +24,7 @@
|
||||
* on every time the packet data is written. This driver requires an
|
||||
* application to break the BIOS image in to fixed sized packet chunks.
|
||||
*
|
||||
* See Documentation/dell_rbu.txt for more info.
|
||||
* See Documentation/driver-api/dell_rbu.rst for more info.
|
||||
*/
|
||||
#include <linux/init.h>
|
||||
#include <linux/module.h>
|
||||
|
@ -7,6 +7,6 @@ config ISAPNP
|
||||
depends on ISA || COMPILE_TEST
|
||||
help
|
||||
Say Y here if you would like support for ISA Plug and Play devices.
|
||||
Some information is in <file:Documentation/isapnp.txt>.
|
||||
Some information is in <file:Documentation/driver-api/isapnp.rst>.
|
||||
|
||||
If unsure, say Y.
|
||||
|
@ -93,7 +93,7 @@ config VT_HW_CONSOLE_BINDING
|
||||
select the console driver that will serve as the backend for the
|
||||
virtual terminals.
|
||||
|
||||
See <file:Documentation/console/console.rst> for more
|
||||
See <file:Documentation/driver-api/console.rst> for more
|
||||
information. For framebuffer console users, please refer to
|
||||
<file:Documentation/fb/fbcon.rst>.
|
||||
|
||||
|
@ -25,7 +25,7 @@ menuconfig VFIO
|
||||
select VFIO_IOMMU_TYPE1 if (X86 || S390 || ARM || ARM64)
|
||||
help
|
||||
VFIO provides a framework for secure userspace device drivers.
|
||||
See Documentation/vfio.txt for more details.
|
||||
See Documentation/driver-api/vfio.rst for more details.
|
||||
|
||||
If you don't know what to do here, say N.
|
||||
|
||||
|
@ -6,7 +6,7 @@ config VFIO_MDEV
|
||||
default n
|
||||
help
|
||||
Provides a framework to virtualize devices.
|
||||
See Documentation/vfio-mediated-device.txt for more details.
|
||||
See Documentation/driver-api/vfio-mediated-device.rst for more details.
|
||||
|
||||
If you don't know what do here, say N.
|
||||
|
||||
|
@ -19,7 +19,7 @@ config W1_CON
|
||||
default y
|
||||
---help---
|
||||
This allows to communicate with userspace using connector. For more
|
||||
information see <file:Documentation/connector/connector.rst>.
|
||||
information see <file:Documentation/driver-api/connector.rst>.
|
||||
There are three types of messages between w1 core and userspace:
|
||||
1. Events. They are generated each time new master or slave device found
|
||||
either due to automatic or requested search.
|
||||
|
@ -99,7 +99,7 @@ config SAMPLE_CONNECTOR
|
||||
When enabled, this builds both a sample kernel module for
|
||||
the connector interface and a user space tool to communicate
|
||||
with it.
|
||||
See also Documentation/connector/connector.rst
|
||||
See also Documentation/driver-api/connector.rst
|
||||
|
||||
config SAMPLE_HIDRAW
|
||||
bool "hidraw sample"
|
||||
|
Loading…
Reference in New Issue
Block a user