Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

+71 -45
+1 -1
Documentation/ABI/removed/sysfs-class-rfkill
··· 1 1 rfkill - radio frequency (RF) connector kill switch support 2 2 3 - For details to this subsystem look at Documentation/rfkill.txt. 3 + For details to this subsystem look at Documentation/driver-api/rfkill.rst. 4 4 5 5 What: /sys/class/rfkill/rfkill[0-9]+/claim 6 6 Date: 09-Jul-2007
+1 -1
Documentation/ABI/stable/sysfs-class-rfkill
··· 1 1 rfkill - radio frequency (RF) connector kill switch support 2 2 3 - For details to this subsystem look at Documentation/rfkill.txt. 3 + For details to this subsystem look at Documentation/driver-api/rfkill.rst. 4 4 5 5 For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in 6 6 Documentation/ABI/removed/sysfs-class-rfkill.
+1 -1
Documentation/ABI/testing/sysfs-class-switchtec
··· 1 1 switchtec - Microsemi Switchtec PCI Switch Management Endpoint 2 2 3 - For details on this subsystem look at Documentation/switchtec.txt. 3 + For details on this subsystem look at Documentation/driver-api/switchtec.rst. 4 4 5 5 What: /sys/class/switchtec 6 6 Date: 05-Jan-2017
+1 -1
Documentation/EDID/howto.rst Documentation/driver-api/edid.rst
··· 1 - :orphan: 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 3 ==== 4 4 EDID
Documentation/SM501.txt Documentation/driver-api/sm501.rst
+1 -1
Documentation/admin-guide/kernel-parameters.txt
··· 930 930 edid/1680x1050.bin, or edid/1920x1080.bin is given 931 931 and no file with the same name exists. Details and 932 932 instructions how to build your own EDID data are 933 - available in Documentation/EDID/howto.rst. An EDID 933 + available in Documentation/driver-api/edid.rst. An EDID 934 934 data set will only be used for a particular connector, 935 935 if its name and a colon are prepended to the EDID 936 936 name. Each connector may use a unique EDID data
+3 -3
Documentation/admin-guide/laptops/thinkpad-acpi.rst
··· 643 643 2010. 644 644 645 645 rfkill controller switch "tpacpi_bluetooth_sw": refer to 646 - Documentation/rfkill.txt for details. 646 + Documentation/driver-api/rfkill.rst for details. 647 647 648 648 649 649 Video output control -- /proc/acpi/ibm/video ··· 1406 1406 2010. 1407 1407 1408 1408 rfkill controller switch "tpacpi_wwan_sw": refer to 1409 - Documentation/rfkill.txt for details. 1409 + Documentation/driver-api/rfkill.rst for details. 1410 1410 1411 1411 1412 1412 EXPERIMENTAL: UWB ··· 1426 1426 ^^^^^^^^^^^ 1427 1427 1428 1428 rfkill controller switch "tpacpi_uwb_sw": refer to 1429 - Documentation/rfkill.txt for details. 1429 + Documentation/driver-api/rfkill.rst for details. 1430 1430 1431 1431 Adaptive keyboard 1432 1432 -----------------
Documentation/bt8xxgpio.txt Documentation/driver-api/bt8xxgpio.rst
+1 -1
Documentation/connector/connector.rst Documentation/driver-api/connector.rst
··· 1 - :orphan: 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 3 ================ 4 4 Kernel Connector
+1 -1
Documentation/console/console.rst Documentation/driver-api/console.rst
··· 1 - :orphan: 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 3 =============== 4 4 Console Drivers
Documentation/dcdbas.txt Documentation/driver-api/dcdbas.rst
Documentation/dell_rbu.txt Documentation/driver-api/dell_rbu.rst
+26
Documentation/driver-api/index.rst
··· 68 68 fpga/index 69 69 acpi/index 70 70 backlight/lp855x-driver.rst 71 + bt8xxgpio 72 + connector 73 + console 74 + dcdbas 75 + dell_rbu 76 + edid 77 + eisa 78 + isa 79 + isapnp 71 80 generic-counter 81 + lightnvm-pblk 82 + men-chameleon-bus 83 + ntb 84 + nvmem 85 + parport-lowlevel 86 + pti_intel_mid 87 + pwm 88 + rfkill 89 + sgi-ioc4 90 + sm501 91 + smsc_ece1099 92 + switchtec 93 + sync_file 94 + vfio-mediated-device 95 + vfio 96 + xillybus 97 + zorro 72 98 73 99 .. only:: subproject and html 74 100
Documentation/eisa.txt Documentation/driver-api/eisa.rst
+2 -2
Documentation/fb/fbcon.rst
··· 187 187 Assuming the VGA driver can be unloaded, one must first unbind the VGA driver 188 188 from the console layer before unloading the driver. The VGA driver cannot be 189 189 unloaded if it is still bound to the console layer. (See 190 - Documentation/console/console.rst for more information). 190 + Documentation/driver-api/console.rst for more information). 191 191 192 192 This is more complicated in the case of the framebuffer console (fbcon), 193 193 because fbcon is an intermediate layer between the console and the drivers:: ··· 204 204 fbcon. 205 205 206 206 So, how do we unbind fbcon from the console? Part of the answer is in 207 - Documentation/console/console.rst. To summarize: 207 + Documentation/driver-api/console.rst. To summarize: 208 208 209 209 Echo a value to the bind file that represents the framebuffer console 210 210 driver. So assuming vtcon1 represents fbcon, then::
Documentation/isa.txt Documentation/driver-api/isa.rst
Documentation/isapnp.txt Documentation/driver-api/isapnp.rst
Documentation/lightnvm/pblk.txt Documentation/driver-api/lightnvm-pblk.rst
Documentation/men-chameleon-bus.txt Documentation/driver-api/men-chameleon-bus.rst
Documentation/ntb.txt Documentation/driver-api/ntb.rst
+1 -1
Documentation/nvmem/nvmem.rst Documentation/driver-api/nvmem.rst
··· 1 - :orphan: 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 3 =============== 4 4 NVMEM Subsystem
Documentation/parport-lowlevel.txt Documentation/driver-api/parport-lowlevel.rst
+1 -1
Documentation/pti/pti_intel_mid.rst Documentation/driver-api/pti_intel_mid.rst
··· 1 - :orphan: 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 3 ============= 4 4 Intel MID PTI
Documentation/pwm.txt Documentation/driver-api/pwm.rst
Documentation/rfkill.txt Documentation/driver-api/rfkill.rst
+3 -3
Documentation/s390/vfio-ccw.rst
··· 38 38 qemu/hw/s390x/css.c 39 39 40 40 For vfio mediated device framework: 41 - - Documentation/vfio-mediated-device.txt 41 + - Documentation/driver-api/vfio-mediated-device.rst 42 42 43 43 Motivation of vfio-ccw 44 44 ---------------------- ··· 322 322 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204) 323 323 3. https://en.wikipedia.org/wiki/Channel_I/O 324 324 4. Documentation/s390/cds.rst 325 - 5. Documentation/vfio.txt 326 - 6. Documentation/vfio-mediated-device.txt 325 + 5. Documentation/driver-api/vfio.rst 326 + 6. Documentation/driver-api/vfio-mediated-device.rst
Documentation/sgi-ioc4.txt Documentation/driver-api/sgi-ioc4.rst
Documentation/smsc_ece1099.txt Documentation/driver-api/smsc_ece1099.rst
+1 -1
Documentation/switchtec.txt Documentation/driver-api/switchtec.rst
··· 97 97 NT EP BAR 2 will be dynamically configured as a Direct Window, and 98 98 the configuration file does not need to configure it explicitly. 99 99 100 - Please refer to Documentation/ntb.txt in Linux source tree for an overall 100 + Please refer to Documentation/driver-api/ntb.rst in Linux source tree for an overall 101 101 understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB 102 102 Hardware Driver in this stack.
Documentation/sync_file.txt Documentation/driver-api/sync_file.rst
+1 -1
Documentation/vfio-mediated-device.txt Documentation/driver-api/vfio-mediated-device.rst
··· 408 408 References 409 409 ========== 410 410 411 - 1. See Documentation/vfio.txt for more information on VFIO. 411 + 1. See Documentation/driver-api/vfio.rst for more information on VFIO. 412 412 2. struct mdev_driver in include/linux/mdev.h 413 413 3. struct mdev_parent_ops in include/linux/mdev.h 414 414 4. struct vfio_iommu_driver_ops in include/linux/vfio.h
Documentation/vfio.txt Documentation/driver-api/vfio.rst
Documentation/xillybus.txt Documentation/driver-api/xillybus.rst
Documentation/zorro.txt Documentation/driver-api/zorro.rst
+11 -11
MAINTAINERS
··· 4642 4642 M: Stuart Hayes <stuart.w.hayes@gmail.com> 4643 4643 L: platform-driver-x86@vger.kernel.org 4644 4644 S: Maintained 4645 - F: Documentation/dcdbas.txt 4645 + F: Documentation/driver-api/dcdbas.rst 4646 4646 F: drivers/platform/x86/dcdbas.* 4647 4647 4648 4648 DELL WMI NOTIFICATIONS DRIVER ··· 8462 8462 ISA 8463 8463 M: William Breathitt Gray <vilhelm.gray@gmail.com> 8464 8464 S: Maintained 8465 - F: Documentation/isa.txt 8465 + F: Documentation/driver-api/isa.rst 8466 8466 F: drivers/base/isa.c 8467 8467 F: include/linux/isa.h 8468 8468 ··· 8477 8477 ISAPNP 8478 8478 M: Jaroslav Kysela <perex@perex.cz> 8479 8479 S: Maintained 8480 - F: Documentation/isapnp.txt 8480 + F: Documentation/driver-api/isapnp.rst 8481 8481 F: drivers/pnp/isapnp/ 8482 8482 F: include/linux/isapnp.h 8483 8483 ··· 10353 10353 S: Maintained 10354 10354 F: drivers/mcb/ 10355 10355 F: include/linux/mcb.h 10356 - F: Documentation/men-chameleon-bus.txt 10356 + F: Documentation/driver-api/men-chameleon-bus.rst 10357 10357 10358 10358 MEN F21BMC (Board Management Controller) 10359 10359 M: Andreas Werner <andreas.werner@men.de> ··· 12070 12070 F: include/linux/parport*.h 12071 12071 F: drivers/char/ppdev.c 12072 12072 F: include/uapi/linux/ppdev.h 12073 - F: Documentation/parport*.txt 12073 + F: Documentation/driver-api/parport*.rst 12074 12074 12075 12075 PARAVIRT_OPS INTERFACE 12076 12076 M: Juergen Gross <jgross@suse.com> ··· 12245 12245 M: Logan Gunthorpe <logang@deltatee.com> 12246 12246 L: linux-pci@vger.kernel.org 12247 12247 S: Maintained 12248 - F: Documentation/switchtec.txt 12248 + F: Documentation/driver-api/switchtec.rst 12249 12249 F: Documentation/ABI/testing/sysfs-class-switchtec 12250 12250 F: drivers/pci/switch/switchtec* 12251 12251 F: include/uapi/linux/switchtec_ioctl.h ··· 13006 13006 L: linux-pwm@vger.kernel.org 13007 13007 S: Maintained 13008 13008 T: git git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm.git 13009 - F: Documentation/pwm.txt 13009 + F: Documentation/driver-api/pwm.rst 13010 13010 F: Documentation/devicetree/bindings/pwm/ 13011 13011 F: include/linux/pwm.h 13012 13012 F: drivers/pwm/ ··· 13620 13620 T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git 13621 13621 T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git 13622 13622 S: Maintained 13623 - F: Documentation/rfkill.txt 13623 + F: Documentation/driver-api/rfkill.rst 13624 13624 F: Documentation/ABI/stable/sysfs-class-rfkill 13625 13625 F: net/rfkill/ 13626 13626 F: include/linux/rfkill.h ··· 15343 15343 F: drivers/dma-buf/sw_sync.c 15344 15344 F: include/linux/sync_file.h 15345 15345 F: include/uapi/linux/sync_file.h 15346 - F: Documentation/sync_file.txt 15346 + F: Documentation/driver-api/sync_file.rst 15347 15347 T: git git://anongit.freedesktop.org/drm/drm-misc 15348 15348 15349 15349 SYNOPSYS ARC ARCHITECTURE ··· 16839 16839 L: kvm@vger.kernel.org 16840 16840 T: git git://github.com/awilliam/linux-vfio.git 16841 16841 S: Maintained 16842 - F: Documentation/vfio.txt 16842 + F: Documentation/driver-api/vfio.rst 16843 16843 F: drivers/vfio/ 16844 16844 F: include/linux/vfio.h 16845 16845 F: include/uapi/linux/vfio.h ··· 16848 16848 M: Kirti Wankhede <kwankhede@nvidia.com> 16849 16849 L: kvm@vger.kernel.org 16850 16850 S: Maintained 16851 - F: Documentation/vfio-mediated-device.txt 16851 + F: Documentation/driver-api/vfio-mediated-device.rst 16852 16852 F: drivers/vfio/mdev/ 16853 16853 F: include/linux/mdev.h 16854 16854 F: samples/vfio-mdev/
+1 -1
drivers/dma-buf/Kconfig
··· 15 15 associated with a buffer. When a job is submitted to the GPU a fence 16 16 is attached to the buffer and is transferred via userspace, using Sync 17 17 Files fds, to the DRM driver for example. More details at 18 - Documentation/sync_file.txt. 18 + Documentation/driver-api/sync_file.rst. 19 19 20 20 config SW_SYNC 21 21 bool "Sync File Validation Framework"
+1 -1
drivers/gpio/Kconfig
··· 1301 1301 The card needs to be physically altered for using it as a 1302 1302 GPIO card. For more information on how to build a GPIO card 1303 1303 from a BT8xx TV card, see the documentation file at 1304 - Documentation/bt8xxgpio.txt 1304 + Documentation/driver-api/bt8xxgpio.rst 1305 1305 1306 1306 If unsure, say N. 1307 1307
+1 -1
drivers/gpu/drm/Kconfig
··· 141 141 monitor are unable to provide appropriate EDID data. Since this 142 142 feature is provided as a workaround for broken hardware, the 143 143 default case is N. Details and instructions how to build your own 144 - EDID data are given in Documentation/EDID/howto.rst. 144 + EDID data are given in Documentation/driver-api/edid.rst. 145 145 146 146 config DRM_DP_CEC 147 147 bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"
+1 -1
drivers/pci/switch/Kconfig
··· 9 9 Enables support for the management interface for the MicroSemi 10 10 Switchtec series of PCIe switches. Supports userspace access 11 11 to submit MRPC commands to the switch via /dev/switchtecX 12 - devices. See <file:Documentation/switchtec.txt> for more 12 + devices. See <file:Documentation/driver-api/switchtec.rst> for more 13 13 information. 14 14 15 15 endmenu
+2 -2
drivers/platform/x86/Kconfig
··· 118 118 Interrupts (SMIs) and Host Control Actions (system power cycle or 119 119 power off after OS shutdown) on certain Dell systems. 120 120 121 - See <file:Documentation/dcdbas.txt> for more details on the driver 121 + See <file:Documentation/driver-api/dcdbas.rst> for more details on the driver 122 122 and the Dell systems on which Dell systems management software makes 123 123 use of this driver. 124 124 ··· 259 259 DELL system. Note you need a Dell OpenManage or Dell Update package (DUP) 260 260 supporting application to communicate with the BIOS regarding the new 261 261 image for the image update to take effect. 262 - See <file:Documentation/dell_rbu.txt> for more details on the driver. 262 + See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver. 263 263 264 264 265 265 config FUJITSU_LAPTOP
+1 -1
drivers/platform/x86/dcdbas.c
··· 7 7 * and Host Control Actions (power cycle or power off after OS shutdown) on 8 8 * Dell systems. 9 9 * 10 - * See Documentation/dcdbas.txt for more information. 10 + * See Documentation/driver-api/dcdbas.rst for more information. 11 11 * 12 12 * Copyright (C) 1995-2006 Dell Inc. 13 13 */
+1 -1
drivers/platform/x86/dell_rbu.c
··· 24 24 * on every time the packet data is written. This driver requires an 25 25 * application to break the BIOS image in to fixed sized packet chunks. 26 26 * 27 - * See Documentation/dell_rbu.txt for more info. 27 + * See Documentation/driver-api/dell_rbu.rst for more info. 28 28 */ 29 29 #include <linux/init.h> 30 30 #include <linux/module.h>
+1 -1
drivers/pnp/isapnp/Kconfig
··· 7 7 depends on ISA || COMPILE_TEST 8 8 help 9 9 Say Y here if you would like support for ISA Plug and Play devices. 10 - Some information is in <file:Documentation/isapnp.txt>. 10 + Some information is in <file:Documentation/driver-api/isapnp.rst>. 11 11 12 12 If unsure, say Y.
+1 -1
drivers/tty/Kconfig
··· 93 93 select the console driver that will serve as the backend for the 94 94 virtual terminals. 95 95 96 - See <file:Documentation/console/console.rst> for more 96 + See <file:Documentation/driver-api/console.rst> for more 97 97 information. For framebuffer console users, please refer to 98 98 <file:Documentation/fb/fbcon.rst>. 99 99
+1 -1
drivers/vfio/Kconfig
··· 25 25 select VFIO_IOMMU_TYPE1 if (X86 || S390 || ARM || ARM64) 26 26 help 27 27 VFIO provides a framework for secure userspace device drivers. 28 - See Documentation/vfio.txt for more details. 28 + See Documentation/driver-api/vfio.rst for more details. 29 29 30 30 If you don't know what to do here, say N. 31 31
+1 -1
drivers/vfio/mdev/Kconfig
··· 6 6 default n 7 7 help 8 8 Provides a framework to virtualize devices. 9 - See Documentation/vfio-mediated-device.txt for more details. 9 + See Documentation/driver-api/vfio-mediated-device.rst for more details. 10 10 11 11 If you don't know what do here, say N. 12 12
+1 -1
drivers/w1/Kconfig
··· 19 19 default y 20 20 ---help--- 21 21 This allows to communicate with userspace using connector. For more 22 - information see <file:Documentation/connector/connector.rst>. 22 + information see <file:Documentation/driver-api/connector.rst>. 23 23 There are three types of messages between w1 core and userspace: 24 24 1. Events. They are generated each time new master or slave device found 25 25 either due to automatic or requested search.
+1 -1
samples/Kconfig
··· 99 99 When enabled, this builds both a sample kernel module for 100 100 the connector interface and a user space tool to communicate 101 101 with it. 102 - See also Documentation/connector/connector.rst 102 + See also Documentation/driver-api/connector.rst 103 103 104 104 config SAMPLE_HIDRAW 105 105 bool "hidraw sample"