docs: driver-api: add .rst files from the main dir
Subsystems (79)
PATCH 12/22 docs: driver-api: add .rst files from the main dir
In reply to a message not in the archiveThose files belong to the driver-api guide. Add them to the driver-api book.
---
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
Documentation/PCI/pci.rst | 2 +-
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../admin-guide/kernel-parameters.txt | 4 +-
.../admin-guide/kernel-per-cpu-kthreads.rst | 2 +-
.../{ => driver-api}/atomic_bitops.rst | 2 -
Documentation/{ => driver-api}/bt8xxgpio.rst | 2 -
.../bus-virt-phys-mapping.rst | 2 -
.../{connector => driver-api}/connector.rst | 2 -
.../{console => driver-api}/console.rst | 2 -
Documentation/{ => driver-api}/crc32.rst | 2 -
Documentation/{ => driver-api}/dcdbas.rst | 2 -
.../{ => driver-api}/debugging-modules.rst | 2 -
.../debugging-via-ohci1394.rst | 2 -
Documentation/{ => driver-api}/dell_rbu.rst | 2 -
Documentation/{ => driver-api}/digsig.rst | 2 -
.../{EDID/howto.rst => driver-api/edid.rst} | 2 -
Documentation/{ => driver-api}/eisa.rst | 2 -
.../{ => driver-api}/futex-requeue-pi.rst | 2 -
.../{ => driver-api}/gcc-plugins.rst | 2 -
Documentation/{ => driver-api}/hwspinlock.rst | 2 -
Documentation/driver-api/index.rst | 66 +++++++++++++++++++
Documentation/{ => driver-api}/io-mapping.rst | 2 -
.../{ => driver-api}/io_ordering.rst | 2 -
.../{IPMI.rst => driver-api/ipmi.rst} | 2 -
.../irq-affinity.rst} | 2 -
.../irq-domain.rst} | 2 -
Documentation/{IRQ.rst => driver-api/irq.rst} | 2 -
.../{ => driver-api}/irqflags-tracing.rst | 2 -
Documentation/{ => driver-api}/isa.rst | 2 -
Documentation/{ => driver-api}/isapnp.rst | 2 -
Documentation/{ => driver-api}/kobject.rst | 4 +-
Documentation/{ => driver-api}/kprobes.rst | 2 -
Documentation/{ => driver-api}/kref.rst | 2 -
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
Documentation/{ => driver-api}/lzo.rst | 2 -
Documentation/{ => driver-api}/mailbox.rst | 2 -
.../{ => driver-api}/men-chameleon-bus.rst | 2 -
Documentation/{ => driver-api}/nommu-mmap.rst | 2 -
Documentation/{ => driver-api}/ntb.rst | 2 -
Documentation/{nvmem => driver-api}/nvmem.rst | 2 -
Documentation/{ => driver-api}/padata.rst | 2 -
.../{ => driver-api}/parport-lowlevel.rst | 2 -
.../{ => driver-api}/percpu-rw-semaphore.rst | 2 -
Documentation/{ => driver-api}/pi-futex.rst | 2 -
Documentation/driver-api/pps.rst | 2 -
.../{ => driver-api}/preempt-locking.rst | 2 -
.../{pti => driver-api}/pti_intel_mid.rst | 2 -
Documentation/driver-api/ptp.rst | 2 -
Documentation/{ => driver-api}/pwm.rst | 2 -
Documentation/{ => driver-api}/rbtree.rst | 2 -
Documentation/{ => driver-api}/remoteproc.rst | 4 +-
Documentation/{ => driver-api}/rfkill.rst | 2 -
.../{ => driver-api}/robust-futex-ABI.rst | 2 -
.../{ => driver-api}/robust-futexes.rst | 2 -
Documentation/{ => driver-api}/rpmsg.rst | 2 -
Documentation/{ => driver-api}/sgi-ioc4.rst | 2 -
.../{SM501.rst => driver-api/sm501.rst} | 2 -
.../{ => driver-api}/smsc_ece1099.rst | 2 -
.../{ => driver-api}/speculation.rst | 8 +--
.../{ => driver-api}/static-keys.rst | 2 -
Documentation/{ => driver-api}/switchtec.rst | 4 +-
Documentation/{ => driver-api}/sync_file.rst | 2 -
Documentation/{ => driver-api}/tee.rst | 2 -
.../{ => driver-api}/this_cpu_ops.rst | 2 -
.../unaligned-memory-access.rst | 2 -
.../{ => driver-api}/vfio-mediated-device.rst | 4 +-
Documentation/{ => driver-api}/vfio.rst | 2 -
Documentation/{ => driver-api}/xillybus.rst | 2 -
Documentation/{ => driver-api}/xz.rst | 2 -
Documentation/{ => driver-api}/zorro.rst | 2 -
Documentation/driver-model/device.rst | 2 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/ia64/irq-redir.rst | 2 +-
Documentation/laptops/thinkpad-acpi.rst | 6 +-
Documentation/locking/rt-mutex.rst | 2 +-
Documentation/networking/scaling.rst | 4 +-
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/sysctl/kernel.rst | 2 +-
Documentation/sysctl/vm.rst | 2 +-
Documentation/trace/kprobetrace.rst | 2 +-
Documentation/translations/zh_CN/IRQ.txt | 4 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
.../translations/zh_CN/io_ordering.txt | 4 +-
Documentation/w1/w1.netlink | 2 +-
Documentation/watchdog/hpwdt.rst | 2 +-
MAINTAINERS | 46 ++++++-------
arch/Kconfig | 4 +-
arch/unicore32/include/asm/io.h | 2 +-
drivers/base/core.c | 2 +-
drivers/char/ipmi/Kconfig | 2 +-
drivers/char/ipmi/ipmi_si_hotmod.c | 2 +-
drivers/char/ipmi/ipmi_si_intf.c | 2 +-
drivers/dma-buf/Kconfig | 2 +-
drivers/gpio/Kconfig | 2 +-
drivers/gpu/drm/Kconfig | 2 +-
drivers/pci/switch/Kconfig | 2 +-
drivers/platform/x86/Kconfig | 4 +-
drivers/platform/x86/dcdbas.c | 2 +-
drivers/platform/x86/dell_rbu.c | 2 +-
drivers/pnp/isapnp/Kconfig | 2 +-
drivers/tty/Kconfig | 2 +-
drivers/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
include/asm-generic/bitops/atomic.h | 2 +-
include/linux/io-mapping.h | 2 +-
include/linux/jump_label.h | 2 +-
include/linux/kobject.h | 2 +-
include/linux/kobject_ns.h | 2 +-
include/linux/rbtree.h | 2 +-
include/linux/rbtree_augmented.h | 2 +-
init/Kconfig | 2 +-
kernel/padata.c | 2 +-
lib/Kconfig | 2 +-
lib/Kconfig.debug | 2 +-
lib/crc32.c | 2 +-
lib/kobject.c | 4 +-
lib/lzo/lzo1x_decompress_safe.c | 2 +-
lib/xz/Kconfig | 2 +-
mm/Kconfig | 2 +-
mm/nommu.c | 2 +-
samples/Kconfig | 2 +-
samples/kprobes/kprobe_example.c | 2 +-
samples/kprobes/kretprobe_example.c | 2 +-
scripts/gcc-plugins/Kconfig | 2 +-
tools/include/linux/rbtree.h | 2 +-
tools/include/linux/rbtree_augmented.h | 2 +-
132 files changed, 173 insertions(+), 235 deletions(-)
rename Documentation/{ => driver-api}/atomic_bitops.rst (99%)
rename Documentation/{ => driver-api}/bt8xxgpio.rst (99%)
rename Documentation/{ => driver-api}/bus-virt-phys-mapping.rst (99%)
rename Documentation/{connector => driver-api}/connector.rst (99%)
rename Documentation/{console => driver-api}/console.rst (99%)
rename Documentation/{ => driver-api}/crc32.rst (99%)
rename Documentation/{ => driver-api}/dcdbas.rst (99%)
rename Documentation/{ => driver-api}/debugging-modules.rst (98%)
rename Documentation/{ => driver-api}/debugging-via-ohci1394.rst (99%)
rename Documentation/{ => driver-api}/dell_rbu.rst (99%)
rename Documentation/{ => driver-api}/digsig.rst (99%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (99%)
rename Documentation/{ => driver-api}/eisa.rst (99%)
rename Documentation/{ => driver-api}/futex-requeue-pi.rst (99%)
rename Documentation/{ => driver-api}/gcc-plugins.rst (99%)
rename Documentation/{ => driver-api}/hwspinlock.rst (99%)
rename Documentation/{ => driver-api}/io-mapping.rst (99%)
rename Documentation/{ => driver-api}/io_ordering.rst (99%)
rename Documentation/{IPMI.rst => driver-api/ipmi.rst} (99%)
rename Documentation/{IRQ-affinity.rst => driver-api/irq-affinity.rst} (99%)
rename Documentation/{IRQ-domain.rst => driver-api/irq-domain.rst} (99%)
rename Documentation/{IRQ.rst => driver-api/irq.rst} (99%)
rename Documentation/{ => driver-api}/irqflags-tracing.rst (99%)
rename Documentation/{ => driver-api}/isa.rst (99%)
rename Documentation/{ => driver-api}/isapnp.rst (98%)
rename Documentation/{ => driver-api}/kobject.rst (99%)
rename Documentation/{ => driver-api}/kprobes.rst (99%)
rename Documentation/{ => driver-api}/kref.rst (99%)
rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%)
rename Documentation/{ => driver-api}/lzo.rst (99%)
rename Documentation/{ => driver-api}/mailbox.rst (99%)
rename Documentation/{ => driver-api}/men-chameleon-bus.rst (99%)
rename Documentation/{ => driver-api}/nommu-mmap.rst (99%)
rename Documentation/{ => driver-api}/ntb.rst (99%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{ => driver-api}/padata.rst (99%)
rename Documentation/{ => driver-api}/parport-lowlevel.rst (99%)
rename Documentation/{ => driver-api}/percpu-rw-semaphore.rst (99%)
rename Documentation/{ => driver-api}/pi-futex.rst (99%)
rename Documentation/{ => driver-api}/preempt-locking.rst (99%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{ => driver-api}/pwm.rst (99%)
rename Documentation/{ => driver-api}/rbtree.rst (99%)
rename Documentation/{ => driver-api}/remoteproc.rst (99%)
rename Documentation/{ => driver-api}/rfkill.rst (99%)
rename Documentation/{ => driver-api}/robust-futex-ABI.rst (99%)
rename Documentation/{ => driver-api}/robust-futexes.rst (99%)
rename Documentation/{ => driver-api}/rpmsg.rst (99%)
rename Documentation/{ => driver-api}/sgi-ioc4.rst (99%)
rename Documentation/{SM501.rst => driver-api/sm501.rst} (99%)
rename Documentation/{ => driver-api}/smsc_ece1099.rst (99%)
rename Documentation/{ => driver-api}/speculation.rst (99%)
rename Documentation/{ => driver-api}/static-keys.rst (99%)
rename Documentation/{ => driver-api}/switchtec.rst (97%)
rename Documentation/{ => driver-api}/sync_file.rst (99%)
rename Documentation/{ => driver-api}/tee.rst (99%)
rename Documentation/{ => driver-api}/this_cpu_ops.rst (99%)
rename Documentation/{ => driver-api}/unaligned-memory-access.rst (99%)
rename Documentation/{ => driver-api}/vfio-mediated-device.rst (99%)
rename Documentation/{ => driver-api}/vfio.rst (99%)
rename Documentation/{ => driver-api}/xillybus.rst (99%)
rename Documentation/{ => driver-api}/xz.rst (99%)
rename Documentation/{ => driver-api}/zorro.rst (99%)Documentation/ABI/removed/sysfs-class-rfkill +1 -1
@@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.rst. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. What: /sys/class/rfkill/rfkill[0-9]+/claim Date: 09-Jul-2007
Documentation/ABI/stable/sysfs-class-rfkill +1 -1
@@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.rst. +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.
Documentation/ABI/testing/sysfs-class-switchtec +1 -1
@@ -1,6 +1,6 @@ switchtec - Microsemi Switchtec PCI Switch Management Endpoint -For details on this subsystem look at Documentation/switchtec.rst. +For details on this subsystem look at Documentation/driver-api/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017
Documentation/PCI/pci.rst +1 -1
@@ -239,7 +239,7 @@ from the PCI device config space. Use the values in the pci_dev structure as the PCI "bus address" might have been remapped to a "host physical" address by the arch/chip-set specific kernel support. -See Documentation/io-mapping.rst for how to access device registers +See Documentation/driver-api/io-mapping.rst for how to access device registers or device memory. The device driver needs to call pci_request_region() to verify
Documentation/admin-guide/hw-vuln/l1tf.rst +1 -1
@@ -268,7 +268,7 @@ Guest mitigation mechanisms /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is available at: - https://www.kernel.org/doc/Documentation/IRQ-affinity.rst + https://www.kernel.org/doc/Documentation/driver-api/irq-affinity.rst .. _smt_control:
Documentation/admin-guide/kernel-parameters.txt +2 -2
@@ -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
@@ -3162,7 +3162,7 @@ See Documentation/sysctl/vm.rst for details. ohci1394_dma=early [HW] enable debugging via the ohci1394 driver. - See Documentation/debugging-via-ohci1394.rst for more + See Documentation/driver-api/debugging-via-ohci1394.rst for more info. olpc_ec_timeout= [OLPC] ms delay when issuing EC commands
Documentation/admin-guide/kernel-per-cpu-kthreads.rst +1 -1
@@ -10,7 +10,7 @@ them to a "housekeeping" CPU dedicated to such work. References ========== -- Documentation/IRQ-affinity.rst: Binding interrupts to sets of CPUs. +- Documentation/driver-api/irq-affinity.rst: Binding interrupts to sets of CPUs. - Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
Documentation/driver-api/atomic_bitops.rst renamed from Documentation/atomic_bitops.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= Atomic bitops =============
Documentation/driver-api/bt8xxgpio.rst renamed from Documentation/bt8xxgpio.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================================================== A driver for a selfmade cheap BT8xx based PCI GPIO-card (bt8xxgpio) ===================================================================
Documentation/driver-api/bus-virt-phys-mapping.rst renamed from Documentation/bus-virt-phys-mapping.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================================== How to access I/O mapped memory from within device drivers ==========================================================
Documentation/driver-api/connector.rst renamed from Documentation/connector/connector.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ Kernel Connector ================
Documentation/driver-api/console.rst renamed from Documentation/console/console.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== Console Drivers ===============
Documentation/driver-api/crc32.rst renamed from Documentation/crc32.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================= brief tutorial on CRC computation =================================
Documentation/driver-api/dcdbas.rst renamed from Documentation/dcdbas.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================== Dell Systems Management Base Driver ===================================
Documentation/driver-api/debugging-modules.rst renamed from Documentation/debugging-modules.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - Debugging Modules after 2.6.3 -----------------------------
Documentation/driver-api/debugging-via-ohci1394.rst renamed from Documentation/debugging-via-ohci1394.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================================================== Using physical DMA provided by OHCI-1394 FireWire controllers for debugging ===========================================================================
Documentation/driver-api/dell_rbu.rst renamed from Documentation/dell_rbu.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================================= Usage of the new open sourced rbu (Remote BIOS Update) driver =============================================================
Documentation/driver-api/digsig.rst renamed from Documentation/digsig.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================== Digital Signature Verification API ==================================
Documentation/driver-api/edid.rst renamed from Documentation/EDID/howto.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==== EDID ====
Documentation/driver-api/eisa.rst renamed from Documentation/eisa.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ EISA bus support ================
Documentation/driver-api/futex-requeue-pi.rst renamed from Documentation/futex-requeue-pi.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ Futex Requeue PI ================
Documentation/driver-api/gcc-plugins.rst renamed from Documentation/gcc-plugins.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================= GCC plugin infrastructure =========================
Documentation/driver-api/hwspinlock.rst renamed from Documentation/hwspinlock.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== Hardware Spinlock Framework ===========================
Documentation/driver-api/index.rst +66 -0
72 lines not on this page · raw message
Documentation/driver-api/io-mapping.rst renamed from Documentation/io-mapping.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================== The io_mapping functions ========================
Documentation/driver-api/io_ordering.rst renamed from Documentation/io_ordering.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================== Ordering I/O writes to memory-mapped addresses ==============================================
Documentation/driver-api/ipmi.rst renamed from Documentation/IPMI.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ===================== The Linux IPMI Driver =====================
Documentation/driver-api/irq-affinity.rst renamed from Documentation/IRQ-affinity.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ SMP IRQ affinity ================
Documentation/driver-api/irq-domain.rst renamed from Documentation/IRQ-domain.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================================== The irq_domain interrupt number mapping library ===============================================
Documentation/driver-api/irq.rst renamed from Documentation/IRQ.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== What is an IRQ? ===============
Documentation/driver-api/irqflags-tracing.rst renamed from Documentation/irqflags-tracing.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================= IRQ-flags state tracing =======================
Documentation/driver-api/isa.rst renamed from Documentation/isa.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========== ISA Drivers ===========
Documentation/driver-api/isapnp.rst renamed from Documentation/isapnp.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================================== ISA Plug & Play support by Jaroslav Kysela <[email protected]> ==========================================================
Documentation/driver-api/kobject.rst renamed from Documentation/kobject.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ===================================================================== Everything you never wanted to know about kobjects, ksets, and ktypes =====================================================================
@@ -212,7 +210,7 @@ statically and will warn the developer of this improper usage. If all that you want to use a kobject for is to provide a reference counter for your structure, please use the struct kref instead; a kobject would be overkill. For more information on how to use struct kref, please see the -file Documentation/kref.rst in the Linux kernel source tree. +file Documentation/driver-api/kref.rst in the Linux kernel source tree. Creating "simple" kobjects
Documentation/driver-api/kprobes.rst renamed from Documentation/kprobes.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================= Kernel Probes (Kprobes) =======================
Documentation/driver-api/kref.rst renamed from Documentation/kref.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================================== Adding reference counters (krefs) to kernel objects ===================================================
Documentation/driver-api/lightnvm-pblk.rst renamed from Documentation/lightnvm/pblk.txt +0 -0
Documentation/driver-api/lzo.rst renamed from Documentation/lzo.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================================== LZO stream format as understood by Linux's LZO decompressor ===========================================================
Documentation/driver-api/mailbox.rst renamed from Documentation/mailbox.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================ The Common Mailbox Framework ============================
Documentation/driver-api/men-chameleon-bus.rst renamed from Documentation/men-chameleon-bus.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================= MEN Chameleon Bus =================
Documentation/driver-api/nommu-mmap.rst renamed from Documentation/nommu-mmap.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================= No-MMU memory mapping support =============================
Documentation/driver-api/ntb.rst renamed from Documentation/ntb.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========== NTB Drivers ===========
Documentation/driver-api/nvmem.rst renamed from Documentation/nvmem/nvmem.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== NVMEM Subsystem ===============
Documentation/driver-api/padata.rst renamed from Documentation/padata.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================= The padata parallel execution mechanism =======================================
Documentation/driver-api/parport-lowlevel.rst renamed from Documentation/parport-lowlevel.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================== PARPORT interface documentation ===============================
Documentation/driver-api/percpu-rw-semaphore.rst renamed from Documentation/percpu-rw-semaphore.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================== Percpu rw semaphores ====================
Documentation/driver-api/pi-futex.rst renamed from Documentation/pi-futex.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================== Lightweight PI-futexes ======================
Documentation/driver-api/pps.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================== PPS - Pulse Per Second ======================
Documentation/driver-api/preempt-locking.rst renamed from Documentation/preempt-locking.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================================================== Proper Locking Under a Preemptible Kernel: Keeping Kernel Code Preempt-Safe ===========================================================================
Documentation/driver-api/pti_intel_mid.rst renamed from Documentation/pti/pti_intel_mid.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= Intel MID PTI =============
Documentation/driver-api/ptp.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================== PTP hardware clock infrastructure for Linux ===========================================
Documentation/driver-api/pwm.rst renamed from Documentation/pwm.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================================== Pulse Width Modulation (PWM) interface ======================================
Documentation/driver-api/rbtree.rst renamed from Documentation/rbtree.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================= Red-black Trees (rbtree) in Linux =================================
Documentation/driver-api/remoteproc.rst renamed from Documentation/remoteproc.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ========================== Remote Processor Framework ==========================
@@ -24,7 +22,7 @@ for remote processors that supports this kind of communication. This way, platform-specific remoteproc drivers only need to provide a few low-level handlers, and then all rpmsg drivers will then just work (for more information about the virtio-based rpmsg bus and its drivers, -please read Documentation/rpmsg.rst). +please read Documentation/driver-api/rpmsg.rst). Registration of other types of virtio devices is now also possible. Firmwares just need to publish what kind of virtio devices do they support, and then remoteproc will add those devices. This makes it possible to reuse the
Documentation/driver-api/rfkill.rst renamed from Documentation/rfkill.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================== rfkill - RF kill switch support ===============================
Documentation/driver-api/robust-futex-ABI.rst renamed from Documentation/robust-futex-ABI.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================== The robust futex ABI ====================
Documentation/driver-api/robust-futexes.rst renamed from Documentation/robust-futexes.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================== A description of what robust futexes are ========================================
Documentation/driver-api/rpmsg.rst renamed from Documentation/rpmsg.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================ Remote Processor Messaging (rpmsg) Framework ============================================
Documentation/driver-api/sgi-ioc4.rst renamed from Documentation/sgi-ioc4.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================================== SGI IOC4 PCI (multi function) device ====================================
Documentation/driver-api/sm501.rst renamed from Documentation/SM501.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - .. include:: <isonum.txt> ============
Documentation/driver-api/smsc_ece1099.rst renamed from Documentation/smsc_ece1099.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================================= Msc Keyboard Scan Expansion/GPIO Expansion device =================================================
Documentation/driver-api/speculation.rst renamed from Documentation/speculation.rst +3 -5
@@ -1,12 +1,10 @@ -:orphan: +=========== +Speculation +=========== This document explains potential effects of speculation, and how undesirable effects can be mitigated portably using common APIs. -=========== -Speculation -=========== - To improve performance and minimize average latencies, many contemporary CPUs employ speculative execution techniques such as branch prediction, performing work which may be discarded at a later stage.
Documentation/driver-api/static-keys.rst renamed from Documentation/static-keys.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========== Static Keys ===========
Documentation/driver-api/switchtec.rst renamed from Documentation/switchtec.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ======================== Linux Switchtec Support ========================
@@ -99,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.rst 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.
Documentation/driver-api/sync_file.rst renamed from Documentation/sync_file.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================== Sync File API Guide ===================
Documentation/driver-api/tee.rst renamed from Documentation/tee.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= TEE subsystem =============
Documentation/driver-api/this_cpu_ops.rst renamed from Documentation/this_cpu_ops.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================== this_cpu operations ===================
Documentation/driver-api/unaligned-memory-access.rst renamed from Documentation/unaligned-memory-access.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================= Unaligned Memory Accesses =========================
Documentation/driver-api/vfio-mediated-device.rst renamed from Documentation/vfio-mediated-device.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - .. include:: <isonum.txt> =====================
@@ -410,7 +408,7 @@ card. References ========== -1. See Documentation/vfio.rst 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
Documentation/driver-api/vfio.rst renamed from Documentation/vfio.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================== VFIO - "Virtual Function I/O" [1]_ ==================================
Documentation/driver-api/xillybus.rst renamed from Documentation/xillybus.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================== Xillybus driver for generic FPGA interface ==========================================
Documentation/driver-api/xz.rst renamed from Documentation/xz.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================ XZ data compression in Linux ============================
Documentation/driver-api/zorro.rst renamed from Documentation/zorro.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================== Writing Device Drivers for Zorro Devices ========================================
Documentation/driver-model/device.rst +1 -1
@@ -53,7 +53,7 @@ Attributes of devices can be exported by a device driver through sysfs. Please see Documentation/filesystems/sysfs.txt for more information on how sysfs works. -As explained in Documentation/kobject.rst, device attributes must be +As explained in Documentation/driver-api/kobject.rst, device attributes must be created before the KOBJ_ADD uevent is generated. The only way to realize that is by defining an attribute group.
Documentation/fb/fbcon.rst +2 -2
@@ -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::
Documentation/filesystems/sysfs.txt +1 -1
@@ -16,7 +16,7 @@ a means to export kernel data structures, their attributes, and the linkages between them to userspace. sysfs is tied inherently to the kobject infrastructure. Please read -Documentation/kobject.rst for more information concerning the kobject +Documentation/driver-api/kobject.rst for more information concerning the kobject interface.
Documentation/gpu/drm-mm.rst +1 -1
@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rst Memory Coherency ----------------
Documentation/ia64/irq-redir.rst +1 -1
@@ -7,7 +7,7 @@ IRQ affinity on IA64 platforms By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be controlled. The behavior on IA64 platforms is slightly different from -that described in Documentation/IRQ-affinity.rst for i386 systems. +that described in Documentation/driver-api/irq-affinity.rst for i386 systems. Because of the usage of SAPIC mode and physical destination mode the IRQ target is one particular CPU and cannot be a mask of several
Documentation/laptops/thinkpad-acpi.rst +3 -3
@@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.rst 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.rst 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.rst for details. + Documentation/driver-api/rfkill.rst for details. Adaptive keyboard -----------------
Documentation/locking/rt-mutex.rst +1 -1
@@ -4,7 +4,7 @@ RT-mutex subsystem with PI support RT-mutexes with priority inheritance are used to support PI-futexes, which enable pthread_mutex_t priority inheritance attributes -(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.rst for more details +(PTHREAD_PRIO_INHERIT). [See Documentation/driver-api/pi-futex.rst for more details about PI-futexes.] This technology was developed in the -rt tree and streamlined for
Documentation/networking/scaling.rst +2 -2
@@ -81,7 +81,7 @@ of queues to IRQs can be determined from /proc/interrupts. By default, an IRQ may be handled on any CPU. Because a non-negligible part of packet processing takes place in receive interrupt handling, it is advantageous to spread receive interrupts between CPUs. To manually adjust the IRQ -affinity of each interrupt see Documentation/IRQ-affinity.rst. Some systems +affinity of each interrupt see Documentation/driver-api/irq-affinity.rst. Some systems will be running irqbalance, a daemon that dynamically optimizes IRQ assignments and as a result may override any manual settings.
@@ -160,7 +160,7 @@ can be configured for each receive queue using a sysfs file entry:: This file implements a bitmap of CPUs. RPS is disabled when it is zero (the default), in which case packets are processed on the interrupting -CPU. Documentation/IRQ-affinity.rst explains how CPUs are assigned to +CPU. Documentation/driver-api/irq-affinity.rst explains how CPUs are assigned to the bitmap.
Documentation/s390/vfio-ccw.rst +3 -3
@@ -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.rst +- 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.rst -6. Documentation/vfio-mediated-device.rst +5. Documentation/driver-api/vfio.rst +6. Documentation/driver-api/vfio-mediated-device.rst
Documentation/sysctl/kernel.rst +1 -1
@@ -50,7 +50,7 @@ show up in /proc/sys/kernel: - kexec_load_disabled - kptr_restrict - l2cr [ PPC only ] -- modprobe ==> Documentation/debugging-modules.rst +- modprobe ==> Documentation/driver-api/debugging-modules.rst - modules_disabled - msg_next_id [ sysv ipc ] - msgmax
Documentation/sysctl/vm.rst +1 -1
@@ -580,7 +580,7 @@ trimming of allocations is initiated. The default value is 1. -See Documentation/nommu-mmap.rst for more information. +See Documentation/driver-api/nommu-mmap.rst for more information. numa_zonelist_order
Documentation/trace/kprobetrace.rst +1 -1
@@ -40,7 +40,7 @@ Synopsis of kprobe_events MEMADDR : Address where the probe is inserted. MAXACTIVE : Maximum number of instances of the specified function that can be probed simultaneously, or 0 for the default value - as defined in Documentation/kprobes.rst section 1.3.1. + as defined in Documentation/driver-api/kprobes.rst section 1.3.1. FETCHARGS : Arguments. Each probe can have up to 128 args. %REG : Fetch register REG
Documentation/translations/zh_CN/IRQ.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/IRQ.rst +Chinese translated version of Documentation/driver-api/irq.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem
@@ -9,7 +9,7 @@ or if there is a problem with the translation. Maintainer: Eric W. Biederman <[email protected]> Chinese maintainer: Fu Wei <[email protected]> --------------------------------------------------------------------- -Documentation/IRQ.rst 的中文翻译 +Documentation/driver-api/irq.rst 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
Documentation/translations/zh_CN/filesystems/sysfs.txt +1 -1
@@ -40,7 +40,7 @@ sysfs 是一个最初基于 ramfs 且位于内存的文件系统。它提供导 数据结构及其属性,以及它们之间的关联到用户空间的方法。 sysfs 始终与 kobject 的底层结构紧密相关。请阅读 -Documentation/kobject.rst 文档以获得更多关于 kobject 接口的 +Documentation/driver-api/kobject.rst 文档以获得更多关于 kobject 接口的 信息。
Documentation/translations/zh_CN/io_ordering.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/io_ordering.rst +Chinese translated version of Documentation/driver-api/io_ordering.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem
@@ -8,7 +8,7 @@ or if there is a problem with the translation. Chinese maintainer: Lin Yongting <[email protected]> --------------------------------------------------------------------- -Documentation/io_ordering.rst 的中文翻译 +Documentation/driver-api/io_ordering.rst 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
Documentation/w1/w1.netlink +1 -1
@@ -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.
Documentation/watchdog/hpwdt.rst +1 -1
@@ -44,7 +44,7 @@ Last reviewed: 08/20/2018 NOTE: More information about watchdog drivers in general, including the ioctl interface to /dev/watchdog can be found in - Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.rst. + Documentation/watchdog/watchdog-api.rst and Documentation/driver-api/ipmi.rst. Due to limitations in the iLO hardware, the NMI pretimeout if enabled, can only be set to 9 seconds. Attempts to set pretimeout to other
MAINTAINERS +23 -23
184 lines not on this page · raw message
arch/Kconfig +2 -2
@@ -141,7 +141,7 @@ config HAVE_64BIT_ALIGNED_ACCESS accesses are required to be 64 bit aligned in this way even though it is not a 64 bit architecture. - See Documentation/unaligned-memory-access.rst for more + See Documentation/driver-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config HAVE_EFFICIENT_UNALIGNED_ACCESS
@@ -160,7 +160,7 @@ config HAVE_EFFICIENT_UNALIGNED_ACCESS problems with received packets if doing so would not help much. - See Documentation/unaligned-memory-access.rst for more + See Documentation/driver-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config ARCH_USE_BUILTIN_BSWAP
arch/unicore32/include/asm/io.h +1 -1
@@ -31,7 +31,7 @@ extern void __uc32_iounmap(volatile void __iomem *addr);* ioremap and friends. * * ioremap takes a PCI memory address, as specified in -* Documentation/io-mapping.rst. +* Documentation/driver-api/io-mapping.rst. * */ #define ioremap (cookie, size) __uc32_ioremap(cookie, size)
drivers/base/core.c +1 -1
@@ -1063,7 +1063,7 @@ static void device_release(struct kobject *kobj)else if (dev->class && dev->class->dev_release) dev->class->dev_release (dev);else -WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/kobject.rst.\n" , +WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/driver-api/kobject.rst.\n" ,dev_name (dev));kfree (p); }
drivers/char/ipmi/Kconfig +1 -1
@@ -14,7 +14,7 @@ menuconfig IPMI_HANDLER IPMI is a standard for managing sensors (temperature, voltage, etc.) in a system. - See <file:Documentation/IPMI.rst> for more details on the driver. + See <file:Documentation/driver-api/ipmi.rst> for more details on the driver. If unsure, say N.
drivers/char/ipmi/ipmi_si_hotmod.c +1 -1
@@ -18,7 +18,7 @@ static int hotmod_handler(const char *val, const struct kernel_param *kp);module_param_call (hotmod, hotmod_handler,NULL ,NULL ,0200 );MODULE_PARM_DESC (hotmod,"Add and remove interfaces. See" -" Documentation/IPMI.rst in the kernel sources for the" +" Documentation/driver-api/ipmi.rst in the kernel sources for the" " gory details." );/*
drivers/char/ipmi/ipmi_si_intf.c +1 -1
@@ -977,7 +977,7 @@ static inline int ipmi_thread_busy_wait(enum si_sm_result smi_result,* that are not BT and do not have interrupts. It starts spinning * when an operation is complete or until max_busy tells it to stop * (if that is enabled). See the paragraph on kimid_max_busy_us in -* Documentation/IPMI.rst for details. +* Documentation/driver-api/ipmi.rst for details. */ static int ipmi_thread (void *data) {
drivers/dma-buf/Kconfig +1 -1
@@ -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.rst. + Documentation/driver-api/sync_file.rst. config SW_SYNC bool "Sync File Validation Framework"
drivers/gpio/Kconfig +1 -1
@@ -1300,7 +1300,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.rst + Documentation/driver-api/bt8xxgpio.rst If unsure, say N.
drivers/gpu/drm/Kconfig +1 -1
@@ -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"
drivers/pci/switch/Kconfig +1 -1
@@ -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.rst> for more + devices. See <file:Documentation/driver-api/switchtec.rst> for more information. endmenu
drivers/platform/x86/Kconfig +2 -2
@@ -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.rst> 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.rst> for more details on the driver. + See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver. config FUJITSU_LAPTOP
drivers/platform/x86/dcdbas.c +1 -1
@@ -7,7 +7,7 @@* and Host Control Actions (power cycle or power off after OS shutdown) on * Dell systems. * -* See Documentation/dcdbas.rst for more information. +* See Documentation/driver-api/dcdbas.rst for more information. * * Copyright (C) 1995-2006 Dell Inc. */
drivers/platform/x86/dell_rbu.c +1 -1
@@ -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.rst for more info. +* See Documentation/driver-api/dell_rbu.rst for more info. */ #include <linux/init.h> #include <linux/module.h>
drivers/pnp/isapnp/Kconfig +1 -1
@@ -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.rst>. + Some information is in <file:Documentation/driver-api/isapnp.rst>. If unsure, say Y.
drivers/tty/Kconfig +1 -1
@@ -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>.
drivers/vfio/Kconfig +1 -1
@@ -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.rst for more details. + See Documentation/driver-api/vfio.rst for more details. If you don't know what to do here, say N.
drivers/vfio/mdev/Kconfig +1 -1
@@ -6,7 +6,7 @@ config VFIO_MDEV default n help Provides a framework to virtualize devices. - See Documentation/vfio-mediated-device.rst for more details. + See Documentation/driver-api/vfio-mediated-device.rst for more details. If you don't know what do here, say N.
drivers/w1/Kconfig +1 -1
@@ -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.
include/asm-generic/bitops/atomic.h +1 -1
@@ -8,7 +8,7 @@/* * Implementation of atomic bitops using atomic-fetch ops. -* See Documentation/atomic_bitops.rst for details. +* See Documentation/driver-api/atomic_bitops.rst for details. */ static inline void set_bit (unsigned int nr,volatile unsigned long *p)
include/linux/io-mapping.h +1 -1
@@ -28,7 +28,7 @@* The io_mapping mechanism provides an abstraction for mapping * individual pages from an io device to the CPU in an efficient fashion. * -* See Documentation/io-mapping.rst +* See Documentation/driver-api/io-mapping.rst */ struct io_mapping {
include/linux/jump_label.h +1 -1
@@ -68,7 +68,7 @@* Lacking toolchain and or architecture support, static keys fall back to a * simple conditional branch. * -* Additional babbling in: Documentation/static-keys.rst +* Additional babbling in: Documentation/driver-api/static-keys.rst */ #ifndef __ASSEMBLY__
include/linux/kobject.h +1 -1
@@ -7,7 +7,7 @@* Copyright (c) 2006-2008 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2006-2008 Novell Inc. * -* Please read Documentation/kobject.rst before using the kobject +* Please read Documentation/driver-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */
include/linux/kobject_ns.h +1 -1
@@ -8,7 +8,7 @@* * Split from kobject.h by David Howells ([email protected]) * -* Please read Documentation/kobject.rst before using the kobject +* Please read Documentation/driver-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */
include/linux/rbtree.h +1 -1
@@ -11,7 +11,7 @@I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... -See Documentation/rbtree.rst for documentation and samples. +See Documentation/driver-api/rbtree.rst for documentation and samples. */ #ifndef _LINUX_RBTREE_H
include/linux/rbtree_augmented.h +1 -1
@@ -21,7 +21,7 @@* rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * -* See Documentation/rbtree.rst for documentation and samples. +* See Documentation/driver-api/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {
init/Kconfig +1 -1
@@ -1807,7 +1807,7 @@ config MMAP_ALLOW_UNINITIALIZED userspace. Since that isn't generally a problem on no-MMU systems, it is normally safe to say Y here. - See Documentation/nommu-mmap.rst for more information. + See Documentation/driver-api/nommu-mmap.rst for more information. config SYSTEM_DATA_VERIFICATION def_bool n
kernel/padata.c +1 -1
@@ -2,7 +2,7 @@/* * padata.c - generic interface to process data streams in parallel * -* See Documentation/padata.rst for an api documentation. +* See Documentation/driver-api/padata.rst for an api documentation. * * Copyright (C) 2008, 2009 secunet Security Networks AG * Copyright (C) 2008, 2009 Steffen Klassert <[email protected]>
lib/Kconfig +1 -1
@@ -420,7 +420,7 @@ config INTERVAL_TREE See: - Documentation/rbtree.rst + Documentation/driver-api/rbtree.rst for more information.
lib/Kconfig.debug +1 -1
@@ -1682,7 +1682,7 @@ config PROVIDE_OHCI1394_DMA_INIT This code (~1k) is freed after boot. By then, the firewire stack in charge of the OHCI-1394 controllers should be used instead. - See Documentation/debugging-via-ohci1394.rst for more information. + See Documentation/driver-api/debugging-via-ohci1394.rst for more information. menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing"
lib/crc32.c +1 -1
@@ -24,7 +24,7 @@* Version 2. See the file COPYING for more details. */ -/* see: Documentation/crc32.rst for a description of algorithms */ +/* see: Documentation/driver-api/crc32.rst for a description of algorithms */ #include <linux/crc32.h> #include <linux/crc32poly.h>
lib/kobject.c +2 -2
@@ -6,7 +6,7 @@* Copyright (c) 2006-2007 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2006-2007 Novell Inc. * -* Please see the file Documentation/kobject.rst for critical information +* Please see the file Documentation/driver-api/kobject.rst for critical information * about using the kobject interface. */
@@ -668,7 +668,7 @@ static void kobject_cleanup(struct kobject *kobj) kobject_name(kobj), kobj, __func__, kobj->parent);if (t && !t->release) -pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/kobject.rst.\n" , +pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/driver-api/kobject.rst.\n" ,kobject_name (kobj), kobj);/* send "remove" if the caller did not do it but sent "add" */
lib/lzo/lzo1x_decompress_safe.c +1 -1
@@ -32,7 +32,7 @@* depending on the base count. Since the base count is taken from a u8 * and a few bits, it is safe to assume that it will always be lower than * or equal to 2*255, thus we can always prevent any overflow by accepting -* two less 255 steps. See Documentation/lzo.rst for more information. +* two less 255 steps. See Documentation/driver-api/lzo.rst for more information. */ #define MAX_255_COUNT ((((size_t)~0) / 255) - 2)
lib/xz/Kconfig +1 -1
@@ -5,7 +5,7 @@ config XZ_DEC help LZMA2 compression algorithm and BCJ filters are supported using the .xz file format as the container. For integrity checking, - CRC32 is supported. See Documentation/xz.rst for more information. + CRC32 is supported. See Documentation/driver-api/xz.rst for more information. if XZ_DEC
mm/Kconfig +1 -1
@@ -369,7 +369,7 @@ config NOMMU_INITIAL_TRIM_EXCESS This option specifies the initial value of this option. The default of 1 says that all excess pages should be trimmed. - See Documentation/nommu-mmap.rst for more information. + See Documentation/driver-api/nommu-mmap.rst for more information. config TRANSPARENT_HUGEPAGE bool "Transparent Hugepage Support"
mm/nommu.c +1 -1
@@ -5,7 +5,7 @@* Replacement code for mm functions to support CPU's that don't * have any form of memory management unit (thus no virtual memory). * -* See Documentation/nommu-mmap.rst +* See Documentation/driver-api/nommu-mmap.rst * * Copyright (c) 2004-2008 David Howells <[email protected]> * Copyright (c) 2000-2003 David McCullough <[email protected]>
samples/Kconfig +1 -1
@@ -100,7 +100,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_SECCOMP bool "Build seccomp sample code"
samples/kprobes/kprobe_example.c +1 -1
@@ -5,7 +5,7 @@* stack trace and selected registers when _do_fork() is called. * * For more information on theory of operation of kprobes, see -* Documentation/kprobes.rst +* Documentation/driver-api/kprobes.rst * * You will see the trace data in /var/log/messages and on the console * whenever _do_fork() is invoked to create a new process.
samples/kprobes/kretprobe_example.c +1 -1
@@ -11,7 +11,7 @@* If no func_name is specified, _do_fork is instrumented * * For more information on theory of operation of kretprobes, see -* Documentation/kprobes.rst +* Documentation/driver-api/kprobes.rst * * Build and insert the kernel module as done in the kprobe example. * You will see the trace data in /var/log/messages and on the console
scripts/gcc-plugins/Kconfig +1 -1
@@ -23,7 +23,7 @@ config GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. - See Documentation/gcc-plugins.rst for details. + See Documentation/driver-api/gcc-plugins.rst for details. menu "GCC plugins" depends on GCC_PLUGINS
tools/include/linux/rbtree.h +1 -1
@@ -11,7 +11,7 @@I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... -See Documentation/rbtree.rst for documentation and samples. +See Documentation/driver-api/rbtree.rst for documentation and samples. */ #ifndef __TOOLS_LINUX_PERF_RBTREE_H
tools/include/linux/rbtree_augmented.h +1 -1
@@ -23,7 +23,7 @@* rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * -* See Documentation/rbtree.rst for documentation and samples. +* See Documentation/driver-api/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {
Signature · 1 line
2.21.0
PATCH v2 6/29 docs: console.txt: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabConvert this small file to ReST in preparation for adding it to the driver-api book.
While this is not part of the driver-api book, mark it as :orphan:, in order to avoid build warnings.
---
.../console/{console.txt => console.rst} | 63 ++++++++++---------
Documentation/fb/fbcon.rst | 4 +-
drivers/tty/Kconfig | 2 +-
3 files changed, 38 insertions(+), 31 deletions(-)
rename Documentation/console/{console.txt => console.rst} (80%)Documentation/console/console.rst renamed from Documentation/console/console.txt +34 -28
@@ -1,3 +1,6 @@ +:orphan: + +======= Console Drivers =======
@@ -17,25 +20,26 @@ of driver occupying the consoles.) They can only take over the console that is occupied by the system driver. In the same token, if the modular driver is released by the console, the system driver will take over. -Modular drivers, from the programmer's point of view, have to call: +Modular drivers, from the programmer's point of view, have to call:: do_take_over_console() - load and bind driver to console layer give_up_console() - unload driver; it will only work if driver is fully unbound -In newer kernels, the following are also available: +In newer kernels, the following are also available:: do_register_con_driver() do_unregister_con_driver() If sysfs is enabled, the contents of /sys/class/vtconsole can be examined. This shows the console backends currently registered by the -system which are named vtcon<n> where <n> is an integer from 0 to 15. Thus: +system which are named vtcon<n> where <n> is an integer from 0 to 15. +Thus:: ls /sys/class/vtconsole . .. vtcon0 vtcon1 -Each directory in /sys/class/vtconsole has 3 files: +Each directory in /sys/class/vtconsole has 3 files:: ls /sys/class/vtconsole/vtcon0 . .. bind name uevent
@@ -46,27 +50,29 @@ What do these files signify? read, or acts to bind or unbind the driver to the virtual consoles when written to. The possible values are: - 0 - means the driver is not bound and if echo'ed, commands the driver + 0 + - means the driver is not bound and if echo'ed, commands the driver to unbind - 1 - means the driver is bound and if echo'ed, commands the driver to + 1 + - means the driver is bound and if echo'ed, commands the driver to bind - 2. name - read-only file. Shows the name of the driver in this format: + 2. name - read-only file. Shows the name of the driver in this format:: - cat /sys/class/vtconsole/vtcon0/name - (S) VGA+ + cat /sys/class/vtconsole/vtcon0/name + (S) VGA+ - '(S)' stands for a (S)ystem driver, i.e., it cannot be directly - commanded to bind or unbind + '(S)' stands for a (S)ystem driver, i.e., it cannot be directly + commanded to bind or unbind - 'VGA+' is the name of the driver + 'VGA+' is the name of the driver - cat /sys/class/vtconsole/vtcon1/name - (M) frame buffer device + cat /sys/class/vtconsole/vtcon1/name + (M) frame buffer device - In this case, '(M)' stands for a (M)odular driver, one that can be - directly commanded to bind or unbind. + In this case, '(M)' stands for a (M)odular driver, one that can be + directly commanded to bind or unbind. 3. uevent - ignore this file
@@ -75,14 +81,17 @@ driver takes over the consoles vacated by the driver. Binding, on the other hand, will bind the driver to the consoles that are currently occupied by a system driver. -NOTE1: Binding and unbinding must be selected in Kconfig. It's under: +NOTE1: + Binding and unbinding must be selected in Kconfig. It's under:: -Device Drivers -> Character devices -> Support for binding and unbinding -console drivers + Device Drivers -> + Character devices -> + Support for binding and unbinding console drivers -NOTE2: If any of the virtual consoles are in KD_GRAPHICS mode, then binding or -unbinding will not succeed. An example of an application that sets the console -to KD_GRAPHICS is X. +NOTE2: + If any of the virtual consoles are in KD_GRAPHICS mode, then binding or + unbinding will not succeed. An example of an application that sets the + console to KD_GRAPHICS is X. How useful is this feature? This is very useful for console driver developers. By unbinding the driver from the console layer, one can unload the
@@ -92,10 +101,10 @@ framebuffer console to VGA console and vice versa, this feature also makes this possible. (NOTE NOTE NOTE: Please read fbcon.txt under Documentation/fb for more details.) -Notes for developers: -==========+Notes for developers +========== -do_take_over_console() is now broken up into: +do_take_over_console() is now broken up into:: do_register_con_driver() do_bind_con_driver() - private function
@@ -104,7 +113,7 @@ give_up_console() is a wrapper to do_unregister_con_driver(), and a driver must be fully unbound for this call to succeed. con_is_bound() will check if the driver is bound or not. -Guidelines for console driver writers: +Guidelines for console driver writers ================== In order for binding to and unbinding from the console to properly work,
@@ -140,6 +149,4 @@ The current crop of console drivers should still work correctly, but binding and unbinding them may cause problems. With minimal fixes, these drivers can be made to work correctly. -============= Antonino Daplas <[email protected]> -
Documentation/fb/fbcon.rst +2 -2
@@ -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.txt for more information). +Documentation/console/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.txt. To summarize: +Documentation/console/console.rst. To summarize: Echo a value to the bind file that represents the framebuffer console driver. So assuming vtcon1 represents fbcon, then::
drivers/tty/Kconfig +1 -1
@@ -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.txt> for more + See <file:Documentation/console/console.rst> for more information. For framebuffer console users, please refer to <file:Documentation/fb/fbcon.rst>.
Signature · 1 line
2.21.0
PATCH v2 9/29 docs: driver-model: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabConvert the various documents at the driver-model, preparing them to be part of the driver-api book.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/driver-api/gpio/driver.rst | 2 +-
.../driver-model/{binding.txt => binding.rst} | 20 +-
.../driver-model/{bus.txt => bus.rst} | 69 ++--
.../driver-model/{class.txt => class.rst} | 74 ++--
...esign-patterns.txt => design-patterns.rst} | 106 +++---
.../driver-model/{device.txt => device.rst} | 57 +--
.../driver-model/{devres.txt => devres.rst} | 50 +--
.../driver-model/{driver.txt => driver.rst} | 112 +++---
Documentation/driver-model/index.rst | 26 ++
.../{overview.txt => overview.rst} | 37 +-
.../{platform.txt => platform.rst} | 30 +-
.../driver-model/{porting.txt => porting.rst} | 333 +++++++++---------
Documentation/eisa.txt | 4 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
drivers/base/platform.c | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
18 files changed, 489 insertions(+), 441 deletions(-)
rename Documentation/driver-model/{binding.txt => binding.rst} (92%)
rename Documentation/driver-model/{bus.txt => bus.rst} (76%)
rename Documentation/driver-model/{class.txt => class.rst} (75%)
rename Documentation/driver-model/{design-patterns.txt => design-patterns.rst} (59%)
rename Documentation/driver-model/{device.txt => device.rst} (71%)
rename Documentation/driver-model/{devres.txt => devres.rst} (93%)
rename Documentation/driver-model/{driver.txt => driver.rst} (75%)
create mode 100644 Documentation/driver-model/index.rst
rename Documentation/driver-model/{overview.txt => overview.rst} (90%)
rename Documentation/driver-model/{platform.txt => platform.rst} (95%)
rename Documentation/driver-model/{porting.txt => porting.rst} (62%)Documentation/driver-api/gpio/driver.rst +1 -1
@@ -399,7 +399,7 @@ symbol: will pass the struct gpio_chip* for the chip to all IRQ callbacks, so the callbacks need to embed the gpio_chip in its state container and obtain a pointer to the container using container_of(). - (See Documentation/driver-model/design-patterns.txt) + (See Documentation/driver-model/design-patterns.rst) - gpiochip_irqchip_add_nested(): adds a nested cascaded irqchip to a gpiochip, as discussed above regarding different types of cascaded irqchips. The
Documentation/driver-model/binding.rst renamed from Documentation/driver-model/binding.txt +10 -10
@@ -1,5 +1,6 @@ - +============== Driver Binding +============== Driver binding is the process of associating a device with a device driver that can control it. Bus drivers have typically handled this
@@ -25,7 +26,7 @@ device_register When a new device is added, the bus's list of drivers is iterated over to find one that supports it. In order to determine that, the device ID of the device must match one of the device IDs that the driver -supports. The format and semantics for comparing IDs is bus-specific. +supports. The format and semantics for comparing IDs is bus-specific. Instead of trying to derive a complex state machine and matching algorithm, it is up to the bus driver to provide a callback to compare a device against the IDs of a driver. The bus returns 1 if a match was
@@ -36,14 +37,14 @@ int match(struct device * dev, struct device_driver * drv); If a match is found, the device's driver field is set to the driver and the driver's probe callback is called. This gives the driver a chance to verify that it really does support the hardware, and that -it's in a working state. +it's in a working state. Device Class ~~~~~~~~~~~~ Upon the successful completion of probe, the device is registered with the class to which it belongs. Device drivers belong to one and only one -class, and that is set in the driver's devclass field. +class, and that is set in the driver's devclass field. devclass_add_device is called to enumerate the device within the class and actually register it with the class, which happens with the class's register_dev callback.
@@ -53,7 +54,7 @@ Driver ~~~~~~ When a driver is attached to a device, the device is inserted into the -driver's list of devices. +driver's list of devices. sysfs
@@ -67,18 +68,18 @@ to the device's directory in the physical hierarchy. A directory for the device is created in the class's directory. A symlink is created in that directory that points to the device's -physical location in the sysfs tree. +physical location in the sysfs tree. A symlink can be created (though this isn't done yet) in the device's physical directory to either its class directory, or the class's top-level directory. One can also be created to point to its driver's -directory also. +directory also. driver_register ~~~~~~~~~~~~~~~ -The process is almost identical for when a new driver is added. +The process is almost identical for when a new driver is added. The bus's list of devices is iterated over to find a match. Devices that already have a driver are skipped. All the devices are iterated over, to bind as many devices as possible to the driver.
@@ -94,5 +95,4 @@ of the driver is decremented. All symlinks between the two are removed. When a driver is removed, the list of devices that it supports is iterated over, and the driver's remove callback is called for each -one. The device is removed from that list and the symlinks removed. - +one. The device is removed from that list and the symlinks removed.
Documentation/driver-model/bus.rst renamed from Documentation/driver-model/bus.txt +36 -33
147 lines not on this page · raw message
Documentation/driver-model/class.rst renamed from Documentation/driver-model/class.txt +38 -36
165 lines not on this page · raw message
Documentation/driver-model/design-patterns.rst renamed from Documentation/driver-model/design-patterns.txt +53 -53
141 lines not on this page · raw message
Documentation/driver-model/device.rst renamed from Documentation/driver-model/device.txt +30 -27
114 lines not on this page · raw message
Documentation/driver-model/devres.rst renamed from Documentation/driver-model/devres.txt +26 -24
126 lines not on this page · raw message
Documentation/driver-model/driver.rst renamed from Documentation/driver-model/driver.txt +60 -52
209 lines not on this page · raw message
Documentation/driver-model/index.rst new file +26 -0
@@ -0,0 +1,26 @@ +:orphan: + +============ +Driver Model +============ + +.. toctree:: + :maxdepth: 1 + + binding + bus + class + design-patterns + device + devres + driver + overview + platform + porting + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex`
Documentation/driver-model/overview.rst renamed from Documentation/driver-model/overview.txt +19 -18
@@ -1,4 +1,6 @@ +============================= The Linux Kernel Device Model +============================= Patrick Mochel <[email protected]>
@@ -41,14 +43,14 @@ data structure. These fields must still be accessed by the bus layers, and sometimes by the device-specific drivers. Other bus layers are encouraged to do what has been done for the PCI layer. -struct pci_dev now looks like this: +struct pci_dev now looks like this:: -struct pci_dev { + struct pci_dev { ... struct device dev; /* Generic device interface */ ... -}; + }; Note first that the struct device dev within the struct pci_dev is statically allocated. This means only one allocation on device discovery.
@@ -80,26 +82,26 @@ easy. This has been accomplished by implementing a special purpose virtual file system named sysfs. Almost all mainstream Linux distros mount this filesystem automatically; you -can see some variation of the following in the output of the "mount" command: +can see some variation of the following in the output of the "mount" command:: -$ mount -... -none on /sys type sysfs (rw,noexec,nosuid,nodev) -... -$ + $ mount + ... + none on /sys type sysfs (rw,noexec,nosuid,nodev) + ... + $ The auto-mounting of sysfs is typically accomplished by an entry similar to -the following in the /etc/fstab file: +the following in the /etc/fstab file:: -none /sys sysfs defaults 0 0 + none /sys sysfs defaults 0 0 -or something similar in the /lib/init/fstab file on Debian-based systems: +or something similar in the /lib/init/fstab file on Debian-based systems:: -none /sys sysfs nodev,noexec,nosuid 0 0 + none /sys sysfs nodev,noexec,nosuid 0 0 -If sysfs is not automatically mounted, you can always do it manually with: +If sysfs is not automatically mounted, you can always do it manually with:: -# mount -t sysfs sysfs /sys + # mount -t sysfs sysfs /sys Whenever a device is inserted into the tree, a directory is created for it. This directory may be populated at each layer of discovery - the global layer,
@@ -108,7 +110,7 @@ the bus layer, or the device layer. The global layer currently creates two files - 'name' and 'power'. The former only reports the name of the device. The latter reports the current power state of the device. It will also be used to set the current -power state. +power state. The bus layer may also create files for the devices it finds while probing the bus. For example, the PCI layer currently creates 'irq' and 'resource' files
@@ -118,6 +120,5 @@ A device-specific driver may also export files in its directory to expose device-specific data or tunable interfaces. More information about the sysfs directory layout can be found in -the other documents in this directory and in the file +the other documents in this directory and in the file Documentation/filesystems/sysfs.txt. -
Documentation/driver-model/platform.rst renamed from Documentation/driver-model/platform.txt +16 -14
@@ -1,5 +1,7 @@ +============================ Platform Devices and Drivers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +============================ + See <linux/platform_device.h> for the driver model interface to the platform bus: platform_device, and platform_driver. This pseudo-bus is used to connect devices on busses with minimal infrastructure,
@@ -19,15 +21,15 @@ be connected through a segment of some other kind of bus; but its registers will still be directly addressable. Platform devices are given a name, used in driver binding, and a -list of resources such as addresses and IRQs. +list of resources such as addresses and IRQs:: -struct platform_device { + struct platform_device { const char *name; u32 id; struct device dev; u32 num_resources; struct resource *resource; -}; + }; Platform drivers
@@ -35,9 +37,9 @@ Platform drivers Platform drivers follow the standard driver model convention, where discovery/enumeration is handled outside the drivers, and drivers provide probe() and remove() methods. They support power management -and shutdown notifications using the standard conventions. +and shutdown notifications using the standard conventions:: -struct platform_driver { + struct platform_driver { int (*probe)(struct platform_device *); int (*remove)(struct platform_device *); void (*shutdown)(struct platform_device *);
@@ -46,25 +48,25 @@ struct platform_driver { int (*resume_early)(struct platform_device *); int (*resume)(struct platform_device *); struct device_driver driver; -}; + }; Note that probe() should in general verify that the specified device hardware actually exists; sometimes platform setup code can't be sure. The probing can use device resources, including clocks, and device platform_data. -Platform drivers register themselves the normal way: +Platform drivers register themselves the normal way:: int platform_driver_register(struct platform_driver *drv); Or, in common situations where the device is known not to be hot-pluggable, the probe() routine can live in an init section to reduce the driver's -runtime memory footprint: +runtime memory footprint:: int platform_driver_probe(struct platform_driver *drv, int (*probe)(struct platform_device *)) Kernel modules can be composed of several platform drivers. The platform core -provides helpers to register and unregister an array of drivers: +provides helpers to register and unregister an array of drivers:: int __platform_register_drivers(struct platform_driver * const *drivers, unsigned int count, struct module *owner);
@@ -73,7 +75,7 @@ provides helpers to register and unregister an array of drivers: If one of the drivers fails to register, all drivers registered up to that point will be unregistered in reverse order. Note that there is a convenience -macro that passes THIS_MODULE as owner parameter: +macro that passes THIS_MODULE as owner parameter:: #define platform_register_drivers(drivers, count)
@@ -81,7 +83,7 @@ macro that passes THIS_MODULE as owner parameter: Device Enumeration ~~~~~~~~~~~~~~~~~~ As a rule, platform specific (and often board-specific) setup code will -register platform devices: +register platform devices:: int platform_device_register(struct platform_device *pdev);
@@ -133,14 +135,14 @@ tend to already have "normal" modes, such as ones using device nodes that were created by PNP or by platform device setup. None the less, there are some APIs to support such legacy drivers. Avoid -using these calls except with such hotplug-deficient drivers. +using these calls except with such hotplug-deficient drivers:: struct platform_device *platform_device_alloc( const char *name, int id); You can use platform_device_alloc() to dynamically allocate a device, which you will then initialize with resources and platform_device_register(). -A better solution is usually: +A better solution is usually:: struct platform_device *platform_device_register_simple( const char *name, int id,
Documentation/driver-model/porting.rst renamed from Documentation/driver-model/porting.txt +167 -166
586 lines not on this page · raw message
Documentation/eisa.txt +2 -2
@@ -103,7 +103,7 @@ id_table an array of NULL terminated EISA id strings, (driver_data). driver a generic driver, such as described in - Documentation/driver-model/driver.txt. Only .name, + Documentation/driver-model/driver.rst. Only .name, .probe and .remove members are mandatory. =============== ====================================================
@@ -152,7 +152,7 @@ state set of flags indicating the state of the device. Current flags are EISA_CONFIG_ENABLED and EISA_CONFIG_FORCED. res set of four 256 bytes I/O regions allocated to this device dma_mask DMA mask set from the parent device. -dev generic device (see Documentation/driver-model/device.txt) +dev generic device (see Documentation/driver-model/device.rst) ======== ============================================================ You can get the 'struct eisa_device' from 'struct device' using the
Documentation/hwmon/submitting-patches.rst +1 -1
@@ -89,7 +89,7 @@ increase the chances of your change being accepted. console. Excessive logging can seriously affect system performance. * Use devres functions whenever possible to allocate resources. For rationale - and supported functions, please see Documentation/driver-model/devres.txt. + and supported functions, please see Documentation/driver-model/devres.rst. If a function is not supported by devres, consider using devm_add_action(). * If the driver has a detect function, make sure it is silent. Debug messages
drivers/base/platform.c +1 -1
@@ -5,7 +5,7 @@* Copyright (c) 2002-3 Patrick Mochel * Copyright (c) 2002-3 Open Source Development Labs * -* Please see Documentation/driver-model/platform.txt for more +* Please see Documentation/driver-model/platform.rst for more * information. */
drivers/gpio/gpio-cs5535.c +1 -1
@@ -41,7 +41,7 @@ MODULE_PARM_DESC(mask, "GPIO channel mask.");/* * FIXME: convert this singleton driver to use the state container -* design pattern, see Documentation/driver-model/design-patterns.txt +* design pattern, see Documentation/driver-model/design-patterns.rst */ static struct cs5535_gpio_chip { struct gpio_chip chip;
drivers/net/ethernet/intel/ice/ice_main.c +1 -1
@@ -2286,7 +2286,7 @@ ice_probe(struct pci_dev *pdev, const struct pci_device_id __always_unused *ent)struct ice_hw *hw;int err; -/* this driver uses devres, see Documentation/driver-model/devres.txt */ +/* this driver uses devres, see Documentation/driver-model/devres.rst */ err =pcim_enable_device (pdev);if (err)return err;
scripts/coccinelle/free/devm_free.cocci +1 -1
@@ -2,7 +2,7 @@ /// functions. Values allocated using the devm_functions are freed when /// the device is detached, and thus the use of the standard freeing /// function would cause a double free. -/// See Documentation/driver-model/devres.txt for more information. +/// See Documentation/driver-model/devres.rst for more information. /// /// A difficulty of detecting this problem is that the standard freeing /// function might be called from a different function than the one
Signature · 1 line
2.21.0
PATCH v2 10/29 docs: arm: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabConverts ARM the text files to ReST, preparing them to be an architecture book.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/arm/Marvell/README | 395 --------------
Documentation/arm/Netwinder | 78 ---
Documentation/arm/SA1100/FreeBird | 21 -
Documentation/arm/SA1100/empeg | 2 -
Documentation/arm/SA1100/serial_UART | 47 --
Documentation/arm/{README => arm.rst} | 50 +-
Documentation/arm/{Booting => booting.rst} | 71 ++-
...ance.txt => cluster-pm-race-avoidance.rst} | 177 ++++---
.../arm/{firmware.txt => firmware.rst} | 14 +-
Documentation/arm/index.rst | 80 +++
.../arm/{Interrupts => interrupts.rst} | 86 +--
Documentation/arm/{IXP4xx => ixp4xx.rst} | 61 +--
...nel_mode_neon.txt => kernel_mode_neon.rst} | 3 +
...er_helpers.txt => kernel_user_helpers.rst} | 79 +--
.../keystone/{knav-qmss.txt => knav-qmss.rst} | 6 +-
.../keystone/{Overview.txt => overview.rst} | 47 +-
Documentation/arm/marvel.rst | 488 ++++++++++++++++++
.../arm/{mem_alignment => mem_alignment.rst} | 11 +-
Documentation/arm/{memory.txt => memory.rst} | 9 +-
.../arm/{Microchip/README => microchip.rst} | 63 ++-
Documentation/arm/netwinder.rst | 85 +++
Documentation/arm/nwfpe/index.rst | 11 +
.../nwfpe/{README.FPE => netwinder-fpe.rst} | 24 +-
Documentation/arm/nwfpe/{NOTES => notes.rst} | 3 +
Documentation/arm/nwfpe/{README => nwfpe.rst} | 10 +-
Documentation/arm/nwfpe/{TODO => todo.rst} | 47 +-
Documentation/arm/{OMAP/DSS => omap/dss.rst} | 112 ++--
Documentation/arm/omap/index.rst | 10 +
.../arm/{OMAP/README => omap/omap.rst} | 7 +
.../arm/{OMAP/omap_pm => omap/omap_pm.rst} | 55 +-
Documentation/arm/{Porting => porting.rst} | 14 +-
Documentation/arm/pxa/{mfp.txt => mfp.rst} | 106 ++--
.../{SA1100/ADSBitsy => sa1100/adsbitsy.rst} | 14 +-
.../{SA1100/Assabet => sa1100/assabet.rst} | 185 +++----
.../arm/{SA1100/Brutus => sa1100/brutus.rst} | 45 +-
.../arm/{SA1100/CERF => sa1100/cerf.rst} | 10 +-
Documentation/arm/sa1100/freebird.rst | 25 +
.../graphicsclient.rst} | 46 +-
.../graphicsmaster.rst} | 13 +-
.../HUW_WEBPANEL => sa1100/huw_webpanel.rst} | 8 +-
Documentation/arm/sa1100/index.rst | 23 +
.../arm/{SA1100/Itsy => sa1100/itsy.rst} | 14 +-
.../arm/{SA1100/LART => sa1100/lart.rst} | 3 +-
.../nanoEngine => sa1100/nanoengine.rst} | 6 +-
.../{SA1100/Pangolin => sa1100/pangolin.rst} | 10 +-
.../arm/{SA1100/PLEB => sa1100/pleb.rst} | 6 +-
Documentation/arm/sa1100/serial_uart.rst | 51 ++
.../arm/{SA1100/Tifon => sa1100/tifon.rst} | 4 +-
.../arm/{SA1100/Yopy => sa1100/yopy.rst} | 5 +-
.../cpufreq.rst} | 5 +-
.../eb2410itx.rst} | 5 +-
.../GPIO.txt => samsung-s3c24xx/gpio.rst} | 23 +-
.../H1940.txt => samsung-s3c24xx/h1940.rst} | 5 +-
Documentation/arm/samsung-s3c24xx/index.rst | 18 +
.../NAND.txt => samsung-s3c24xx/nand.rst} | 6 +-
.../overview.rst} | 21 +-
.../s3c2412.rst} | 5 +-
.../s3c2413.rst} | 7 +-
.../smdk2440.rst} | 5 +-
.../suspend.rst} | 20 +-
.../usb-host.rst} | 16 +-
.../bootloader-interface.rst} | 27 +-
.../clksrc-change-registers.awk | 0
.../{Samsung/GPIO.txt => samsung/gpio.rst} | 7 +-
Documentation/arm/samsung/index.rst | 10 +
.../Overview.txt => samsung/overview.rst} | 15 +-
Documentation/arm/{Setup => setup.rst} | 49 +-
.../arm/{SH-Mobile => sh-mobile}/.gitignore | 0
.../overview.txt => spear/overview.rst} | 20 +-
.../arm/sti/{overview.txt => overview.rst} | 21 +-
...h407-overview.txt => stih407-overview.rst} | 9 +-
...h415-overview.txt => stih415-overview.rst} | 8 +-
...h416-overview.txt => stih416-overview.rst} | 5 +-
...h418-overview.txt => stih418-overview.rst} | 9 +-
Documentation/arm/stm32/overview.rst | 2 -
.../arm/stm32/stm32f429-overview.rst | 7 +-
.../arm/stm32/stm32f746-overview.rst | 7 +-
.../arm/stm32/stm32f769-overview.rst | 7 +-
.../arm/stm32/stm32h743-overview.rst | 7 +-
.../arm/stm32/stm32mp157-overview.rst | 3 +-
Documentation/arm/{sunxi/README => sunxi.rst} | 98 +++-
.../arm/sunxi/{clocks.txt => clocks.rst} | 7 +-
.../arm/{swp_emulation => swp_emulation.rst} | 24 +-
Documentation/arm/{tcm.txt => tcm.rst} | 54 +-
Documentation/arm/{uefi.txt => uefi.rst} | 39 +-
.../release-notes.rst} | 4 +-
Documentation/arm/{vlocks.txt => vlocks.rst} | 9 +-
Documentation/devicetree/bindings/arm/xen.txt | 2 +-
.../devicetree/booting-without-of.txt | 4 +-
Documentation/index.rst | 1 +
Documentation/translations/zh_CN/arm/Booting | 4 +-
.../zh_CN/arm/kernel_user_helpers.txt | 4 +-
MAINTAINERS | 4 +-
arch/arm/Kconfig | 2 +-
arch/arm/common/mcpm_entry.c | 2 +-
arch/arm/common/mcpm_head.S | 2 +-
arch/arm/common/vlock.S | 2 +-
arch/arm/include/asm/setup.h | 2 +-
arch/arm/include/uapi/asm/setup.h | 2 +-
arch/arm/kernel/entry-armv.S | 2 +-
arch/arm/mach-exynos/common.h | 2 +-
arch/arm/mach-ixp4xx/Kconfig | 14 +-
arch/arm/mach-s3c24xx/pm.c | 2 +-
arch/arm/mm/Kconfig | 4 +-
arch/arm/plat-samsung/Kconfig | 6 +-
arch/arm/tools/mach-types | 2 +-
arch/arm64/Kconfig | 2 +-
arch/arm64/kernel/kuser32.S | 2 +-
arch/mips/bmips/setup.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss-cipher.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss-core.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss-hash.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss.h | 2 +-
drivers/input/touchscreen/sun4i-ts.c | 2 +-
drivers/tty/serial/Kconfig | 2 +-
115 files changed, 1985 insertions(+), 1420 deletions(-)
delete mode 100644 Documentation/arm/Marvell/README
delete mode 100644 Documentation/arm/Netwinder
delete mode 100644 Documentation/arm/SA1100/FreeBird
delete mode 100644 Documentation/arm/SA1100/empeg
delete mode 100644 Documentation/arm/SA1100/serial_UART
rename Documentation/arm/{README => arm.rst} (88%)
rename Documentation/arm/{Booting => booting.rst} (89%)
rename Documentation/arm/{cluster-pm-race-avoidance.txt => cluster-pm-race-avoidance.rst} (84%)
rename Documentation/arm/{firmware.txt => firmware.rst} (86%)
create mode 100644 Documentation/arm/index.rst
rename Documentation/arm/{Interrupts => interrupts.rst} (81%)
rename Documentation/arm/{IXP4xx => ixp4xx.rst} (84%)
rename Documentation/arm/{kernel_mode_neon.txt => kernel_mode_neon.rst} (99%)
rename Documentation/arm/{kernel_user_helpers.txt => kernel_user_helpers.rst} (78%)
rename Documentation/arm/keystone/{knav-qmss.txt => knav-qmss.rst} (92%)
rename Documentation/arm/keystone/{Overview.txt => overview.rst} (59%)
create mode 100644 Documentation/arm/marvel.rst
rename Documentation/arm/{mem_alignment => mem_alignment.rst} (89%)
rename Documentation/arm/{memory.txt => memory.rst} (90%)
rename Documentation/arm/{Microchip/README => microchip.rst} (92%)
create mode 100644 Documentation/arm/netwinder.rst
create mode 100644 Documentation/arm/nwfpe/index.rst
rename Documentation/arm/nwfpe/{README.FPE => netwinder-fpe.rst} (94%)
rename Documentation/arm/nwfpe/{NOTES => notes.rst} (99%)
rename Documentation/arm/nwfpe/{README => nwfpe.rst} (98%)
rename Documentation/arm/nwfpe/{TODO => todo.rst} (75%)
rename Documentation/arm/{OMAP/DSS => omap/dss.rst} (86%)
create mode 100644 Documentation/arm/omap/index.rst
rename Documentation/arm/{OMAP/README => omap/omap.rst} (62%)
rename Documentation/arm/{OMAP/omap_pm => omap/omap_pm.rst} (83%)
rename Documentation/arm/{Porting => porting.rst} (94%)
rename Documentation/arm/pxa/{mfp.txt => mfp.rst} (83%)
rename Documentation/arm/{SA1100/ADSBitsy => sa1100/adsbitsy.rst} (90%)
rename Documentation/arm/{SA1100/Assabet => sa1100/assabet.rst} (62%)
rename Documentation/arm/{SA1100/Brutus => sa1100/brutus.rst} (75%)
rename Documentation/arm/{SA1100/CERF => sa1100/cerf.rst} (91%)
create mode 100644 Documentation/arm/sa1100/freebird.rst
rename Documentation/arm/{SA1100/GraphicsClient => sa1100/graphicsclient.rst} (87%)
rename Documentation/arm/{SA1100/GraphicsMaster => sa1100/graphicsmaster.rst} (92%)
rename Documentation/arm/{SA1100/HUW_WEBPANEL => sa1100/huw_webpanel.rst} (78%)
create mode 100644 Documentation/arm/sa1100/index.rst
rename Documentation/arm/{SA1100/Itsy => sa1100/itsy.rst} (88%)
rename Documentation/arm/{SA1100/LART => sa1100/lart.rst} (90%)
rename Documentation/arm/{SA1100/nanoEngine => sa1100/nanoengine.rst} (74%)
rename Documentation/arm/{SA1100/Pangolin => sa1100/pangolin.rst} (81%)
rename Documentation/arm/{SA1100/PLEB => sa1100/pleb.rst} (95%)
create mode 100644 Documentation/arm/sa1100/serial_uart.rst
rename Documentation/arm/{SA1100/Tifon => sa1100/tifon.rst} (88%)
rename Documentation/arm/{SA1100/Yopy => sa1100/yopy.rst} (74%)
rename Documentation/arm/{Samsung-S3C24XX/CPUfreq.txt => samsung-s3c24xx/cpufreq.rst} (96%)
rename Documentation/arm/{Samsung-S3C24XX/EB2410ITX.txt => samsung-s3c24xx/eb2410itx.rst} (92%)
rename Documentation/arm/{Samsung-S3C24XX/GPIO.txt => samsung-s3c24xx/gpio.rst} (89%)
rename Documentation/arm/{Samsung-S3C24XX/H1940.txt => samsung-s3c24xx/h1940.rst} (94%)
create mode 100644 Documentation/arm/samsung-s3c24xx/index.rst
rename Documentation/arm/{Samsung-S3C24XX/NAND.txt => samsung-s3c24xx/nand.rst} (92%)
rename Documentation/arm/{Samsung-S3C24XX/Overview.txt => samsung-s3c24xx/overview.rst} (94%)
rename Documentation/arm/{Samsung-S3C24XX/S3C2412.txt => samsung-s3c24xx/s3c2412.rst} (96%)
rename Documentation/arm/{Samsung-S3C24XX/S3C2413.txt => samsung-s3c24xx/s3c2413.rst} (77%)
rename Documentation/arm/{Samsung-S3C24XX/SMDK2440.txt => samsung-s3c24xx/smdk2440.rst} (94%)
rename Documentation/arm/{Samsung-S3C24XX/Suspend.txt => samsung-s3c24xx/suspend.rst} (94%)
rename Documentation/arm/{Samsung-S3C24XX/USB-Host.txt => samsung-s3c24xx/usb-host.rst} (94%)
rename Documentation/arm/{Samsung/Bootloader-interface.txt => samsung/bootloader-interface.rst} (72%)
rename Documentation/arm/{Samsung => samsung}/clksrc-change-registers.awk (100%)
rename Documentation/arm/{Samsung/GPIO.txt => samsung/gpio.rst} (87%)
create mode 100644 Documentation/arm/samsung/index.rst
rename Documentation/arm/{Samsung/Overview.txt => samsung/overview.rst} (86%)
rename Documentation/arm/{Setup => setup.rst} (87%)
rename Documentation/arm/{SH-Mobile => sh-mobile}/.gitignore (100%)
rename Documentation/arm/{SPEAr/overview.txt => spear/overview.rst} (91%)
rename Documentation/arm/sti/{overview.txt => overview.rst} (82%)
rename Documentation/arm/sti/{stih407-overview.txt => stih407-overview.rst} (82%)
rename Documentation/arm/sti/{stih415-overview.txt => stih415-overview.rst} (79%)
rename Documentation/arm/sti/{stih416-overview.txt => stih416-overview.rst} (83%)
rename Documentation/arm/sti/{stih418-overview.txt => stih418-overview.rst} (83%)
rename Documentation/arm/{sunxi/README => sunxi.rst} (83%)
rename Documentation/arm/sunxi/{clocks.txt => clocks.rst} (92%)
rename Documentation/arm/{swp_emulation => swp_emulation.rst} (63%)
rename Documentation/arm/{tcm.txt => tcm.rst} (86%)
rename Documentation/arm/{uefi.txt => uefi.rst} (63%)
rename Documentation/arm/{VFP/release-notes.txt => vfp/release-notes.rst} (92%)
rename Documentation/arm/{vlocks.txt => vlocks.rst} (98%)Documentation/arm/Marvell/README deleted +0 -395
@@ -1,395 +0,0 @@ -ARM Marvell SoCs -================ - -This document lists all the ARM Marvell SoCs that are currently -supported in mainline by the Linux kernel. As the Marvell families of -SoCs are large and complex, it is hard to understand where the support -for a particular SoC is available in the Linux kernel. This document -tries to help in understanding where those SoCs are supported, and to -match them with their corresponding public datasheet, when available. - -Orion family ------------- - - Flavors: - 88F5082 - 88F5181 - 88F5181L - 88F5182 - Datasheet : http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf - Programmer's User Guide : http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf - User Manual : http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf - 88F5281 - Datasheet : http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf - 88F6183 - Core: Feroceon 88fr331 (88f51xx) or 88fr531-vd (88f52xx) ARMv5 compatible - Linux kernel mach directory: arch/arm/mach-orion5x - Linux kernel plat directory: arch/arm/plat-orion - -Kirkwood family ---------------- - - Flavors: - 88F6282 a.k.a Armada 300 - Product Brief : http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf - 88F6283 a.k.a Armada 310 - Product Brief : http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf - 88F6190 - Product Brief : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6190-003_WEB.pdf - Hardware Spec : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf - 88F6192 - Product Brief : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6192-003_ver1.pdf - Hardware Spec : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf - 88F6182 - 88F6180 - Product Brief : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6180-003_ver1.pdf - Hardware Spec : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6180_OpenSource.pdf - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf - 88F6281 - Product Brief : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6281-004_ver1.pdf - Hardware Spec : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6281_OpenSource.pdf - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf - Homepage: http://www.marvell.com/embedded-processors/kirkwood/ - Core: Feroceon 88fr131 ARMv5 compatible - Linux kernel mach directory: arch/arm/mach-mvebu - Linux kernel plat directory: none - -Discovery family ----------------- - - Flavors: - MV78100 - Product Brief : http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78100-003_WEB.pdf - Hardware Spec : http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78100_OpenSource.pdf - Functional Spec: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf - MV78200 - Product Brief : http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78200-002_WEB.pdf - Hardware Spec : http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78200_OpenSource.pdf - Functional Spec: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf - MV76100 - Not supported by the Linux kernel. - - Core: Feroceon 88fr571-vd ARMv5 compatible - - Linux kernel mach directory: arch/arm/mach-mv78xx0 - Linux kernel plat directory: arch/arm/plat-orion - -EBU Armada family ------------------ - - Armada 370 Flavors: - 88F6710 - 88F6707 - 88F6W11 - Product Brief: http://www.marvell.com/embedded-processors/armada-300/assets/Marvell_ARMADA_370_SoC.pdf - Hardware Spec: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-datasheet.pdf - Functional Spec: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-FunctionalSpec-datasheet.pdf - Core: Sheeva ARMv7 compatible PJ4B - - Armada 375 Flavors: - 88F6720 - Product Brief: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf - Core: ARM Cortex-A9 - - Armada 38x Flavors: - 88F6810 Armada 380 - 88F6820 Armada 385 - 88F6828 Armada 388 - Product infos: http://www.marvell.com/embedded-processors/armada-38x/ - Functional Spec: https://marvellcorp.wufoo.com/forms/marvell-armada-38x-functional-specifications/ - Core: ARM Cortex-A9 - - Armada 39x Flavors: - 88F6920 Armada 390 - 88F6928 Armada 398 - Product infos: http://www.marvell.com/embedded-processors/armada-39x/ - Core: ARM Cortex-A9 - - Armada XP Flavors: - MV78230 - MV78260 - MV78460 - NOTE: not to be confused with the non-SMP 78xx0 SoCs - Product Brief: http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf - Functional Spec: http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf - Hardware Specs: - http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF - http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78260_OS.PDF - http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF - Core: Sheeva ARMv7 compatible Dual-core or Quad-core PJ4B-MP - - Linux kernel mach directory: arch/arm/mach-mvebu - Linux kernel plat directory: none - -EBU Armada family ARMv8 ------------------------ - - Armada 3710/3720 Flavors: - 88F3710 - 88F3720 - Core: ARM Cortex A53 (ARMv8) - - Homepage: http://www.marvell.com/embedded-processors/armada-3700/ - Product Brief: http://www.marvell.com/embedded-processors/assets/PB-88F3700-FNL.pdf - Device tree files: arch/arm64/boot/dts/marvell/armada-37* - - Armada 7K Flavors: - 88F7020 (AP806 Dual + one CP110) - 88F7040 (AP806 Quad + one CP110) - Core: ARM Cortex A72 - - Homepage: http://www.marvell.com/embedded-processors/armada-70xx/ - Product Brief: http://www.marvell.com/embedded-processors/assets/Armada7020PB-Jan2016.pdf - http://www.marvell.com/embedded-processors/assets/Armada7040PB-Jan2016.pdf - Device tree files: arch/arm64/boot/dts/marvell/armada-70* - - Armada 8K Flavors: - 88F8020 (AP806 Dual + two CP110) - 88F8040 (AP806 Quad + two CP110) - Core: ARM Cortex A72 - - Homepage: http://www.marvell.com/embedded-processors/armada-80xx/ - Product Brief: http://www.marvell.com/embedded-processors/assets/Armada8020PB-Jan2016.pdf - http://www.marvell.com/embedded-processors/assets/Armada8040PB-Jan2016.pdf - Device tree files: arch/arm64/boot/dts/marvell/armada-80* - -Avanta family -------------- - - Flavors: - 88F6510 - 88F6530P - 88F6550 - 88F6560 - Homepage : http://www.marvell.com/broadband/ - Product Brief: http://www.marvell.com/broadband/assets/Marvell_Avanta_88F6510_305_060-001_product_brief.pdf - No public datasheet available. - - Core: ARMv5 compatible - - Linux kernel mach directory: no code in mainline yet, planned for the future - Linux kernel plat directory: no code in mainline yet, planned for the future - -Storage family --------------- - - Armada SP: - 88RC1580 - Product infos: http://www.marvell.com/storage/armada-sp/ - Core: Sheeva ARMv7 comatible Quad-core PJ4C - (not supported in upstream Linux kernel) - -Dove family (application processor) ------------------------------------ - - Flavors: - 88AP510 a.k.a Armada 510 - Product Brief : http://www.marvell.com/application-processors/armada-500/assets/Marvell_Armada510_SoC.pdf - Hardware Spec : http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Hardware-Spec.pdf - Functional Spec : http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Functional-Spec.pdf - Homepage: http://www.marvell.com/application-processors/armada-500/ - Core: ARMv7 compatible - - Directory: arch/arm/mach-mvebu (DT enabled platforms) - arch/arm/mach-dove (non-DT enabled platforms) - -PXA 2xx/3xx/93x/95x family --------------------------- - - Flavors: - PXA21x, PXA25x, PXA26x - Application processor only - Core: ARMv5 XScale1 core - PXA270, PXA271, PXA272 - Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_pb.pdf - Design guide : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_design_guide.pdf - Developers manual : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_dev_man.pdf - Specification : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_emts.pdf - Specification update : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_spec_update.pdf - Application processor only - Core: ARMv5 XScale2 core - PXA300, PXA310, PXA320 - PXA 300 Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/PXA300_PB_R4.pdf - PXA 310 Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/PXA310_PB_R4.pdf - PXA 320 Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/PXA320_PB_R4.pdf - Design guide : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Design_Guide.pdf - Developers manual : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Developers_Manual.zip - Specifications : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_EMTS.pdf - Specification Update : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Spec_Update.zip - Reference Manual : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_TavorP_BootROM_Ref_Manual.pdf - Application processor only - Core: ARMv5 XScale3 core - PXA930, PXA935 - Application processor with Communication processor - Core: ARMv5 XScale3 core - PXA955 - Application processor with Communication processor - Core: ARMv7 compatible Sheeva PJ4 core - - Comments: - - * This line of SoCs originates from the XScale family developed by - Intel and acquired by Marvell in ~2006. The PXA21x, PXA25x, - PXA26x, PXA27x, PXA3xx and PXA93x were developed by Intel, while - the later PXA95x were developed by Marvell. - - * Due to their XScale origin, these SoCs have virtually nothing in - common with the other (Kirkwood, Dove, etc.) families of Marvell - SoCs, except with the MMP/MMP2 family of SoCs. - - Linux kernel mach directory: arch/arm/mach-pxa - Linux kernel plat directory: arch/arm/plat-pxa - -MMP/MMP2/MMP3 family (communication processor) ------------------------------------------ - - Flavors: - PXA168, a.k.a Armada 168 - Homepage : http://www.marvell.com/application-processors/armada-100/armada-168.jsp - Product brief : http://www.marvell.com/application-processors/armada-100/assets/pxa_168_pb.pdf - Hardware manual : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_datasheet.pdf - Software manual : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_software_manual.pdf - Specification update : http://www.marvell.com/application-processors/armada-100/assets/ARMADA16x_Spec_update.pdf - Boot ROM manual : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_ref_manual.pdf - App node package : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_app_note_package.pdf - Application processor only - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk) - PXA910/PXA920 - Homepage : http://www.marvell.com/communication-processors/pxa910/ - Product Brief : http://www.marvell.com/communication-processors/pxa910/assets/Marvell_PXA910_Platform-001_PB_final.pdf - Application processor with Communication processor - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk) - PXA688, a.k.a. MMP2, a.k.a Armada 610 - Product Brief : http://www.marvell.com/application-processors/armada-600/assets/armada610_pb.pdf - Application processor only - Core: ARMv7 compatible Sheeva PJ4 88sv581x core - PXA2128, a.k.a. MMP3 (OLPC XO4, Linux support not upstream) - Product Brief : http://www.marvell.com/application-processors/armada/pxa2128/assets/Marvell-ARMADA-PXA2128-SoC-PB.pdf - Application processor only - Core: Dual-core ARMv7 compatible Sheeva PJ4C core - PXA960/PXA968/PXA978 (Linux support not upstream) - Application processor with Communication Processor - Core: ARMv7 compatible Sheeva PJ4 core - PXA986/PXA988 (Linux support not upstream) - Application processor with Communication Processor - Core: Dual-core ARMv7 compatible Sheeva PJ4B-MP core - PXA1088/PXA1920 (Linux support not upstream) - Application processor with Communication Processor - Core: quad-core ARMv7 Cortex-A7 - PXA1908/PXA1928/PXA1936 - Application processor with Communication Processor - Core: multi-core ARMv8 Cortex-A53 - - Comments: - - * This line of SoCs originates from the XScale family developed by - Intel and acquired by Marvell in ~2006. All the processors of - this MMP/MMP2 family were developed by Marvell. - - * Due to their XScale origin, these SoCs have virtually nothing in - common with the other (Kirkwood, Dove, etc.) families of Marvell - SoCs, except with the PXA family of SoCs listed above. - - Linux kernel mach directory: arch/arm/mach-mmp - Linux kernel plat directory: arch/arm/plat-pxa - -Berlin family (Multimedia Solutions) -------------------------------------- - - Flavors: - 88DE3010, Armada 1000 (no Linux support) - Core: Marvell PJ1 (ARMv5TE), Dual-core - Product Brief: http://www.marvell.com.cn/digital-entertainment/assets/armada_1000_pb.pdf - 88DE3005, Armada 1500 Mini - Design name: BG2CD - Core: ARM Cortex-A9, PL310 L2CC - 88DE3006, Armada 1500 Mini Plus - Design name: BG2CDP - Core: Dual Core ARM Cortex-A7 - 88DE3100, Armada 1500 - Design name: BG2 - Core: Marvell PJ4B-MP (ARMv7), Tauros3 L2CC - 88DE3114, Armada 1500 Pro - Design name: BG2Q - Core: Quad Core ARM Cortex-A9, PL310 L2CC - 88DE3214, Armada 1500 Pro 4K - Design name: BG3 - Core: ARM Cortex-A15, CA15 integrated L2CC - 88DE3218, ARMADA 1500 Ultra - Core: ARM Cortex-A53 - - Homepage: https://www.synaptics.com/products/multimedia-solutions - Directory: arch/arm/mach-berlin - - Comments: - - * This line of SoCs is based on Marvell Sheeva or ARM Cortex CPUs - with Synopsys DesignWare (IRQ, GPIO, Timers, ...) and PXA IP (SDHCI, USB, ETH, ...). - - * The Berlin family was acquired by Synaptics from Marvell in 2017. - -CPU Cores ---------- - -The XScale cores were designed by Intel, and shipped by Marvell in the older -PXA processors. Feroceon is a Marvell designed core that developed in-house, -and that evolved into Sheeva. The XScale and Feroceon cores were phased out -over time and replaced with Sheeva cores in later products, which subsequently -got replaced with licensed ARM Cortex-A cores. - - XScale 1 - CPUID 0x69052xxx - ARMv5, iWMMXt - XScale 2 - CPUID 0x69054xxx - ARMv5, iWMMXt - XScale 3 - CPUID 0x69056xxx or 0x69056xxx - ARMv5, iWMMXt - Feroceon-1850 88fr331 "Mohawk" - CPUID 0x5615331x or 0x41xx926x - ARMv5TE, single issue - Feroceon-2850 88fr531-vd "Jolteon" - CPUID 0x5605531x or 0x41xx926x - ARMv5TE, VFP, dual-issue - Feroceon 88fr571-vd "Jolteon" - CPUID 0x5615571x - ARMv5TE, VFP, dual-issue - Feroceon 88fr131 "Mohawk-D" - CPUID 0x5625131x - ARMv5TE, single-issue in-order - Sheeva PJ1 88sv331 "Mohawk" - CPUID 0x561584xx - ARMv5, single-issue iWMMXt v2 - Sheeva PJ4 88sv581x "Flareon" - CPUID 0x560f581x - ARMv7, idivt, optional iWMMXt v2 - Sheeva PJ4B 88sv581x - CPUID 0x561f581x - ARMv7, idivt, optional iWMMXt v2 - Sheeva PJ4B-MP / PJ4C - CPUID 0x562f584x - ARMv7, idivt/idiva, LPAE, optional iWMMXt v2 and/or NEON - -Long-term plans ---------------- - - * Unify the mach-dove/, mach-mv78xx0/, mach-orion5x/ into the - mach-mvebu/ to support all SoCs from the Marvell EBU (Engineering - Business Unit) in a single mach-<foo> directory. The plat-orion/ - would therefore disappear. - - * Unify the mach-mmp/ and mach-pxa/ into the same mach-pxa - directory. The plat-pxa/ would therefore disappear. - -Credits -------- - - Maen Suleiman <[email protected]> - Lior Amsalem <[email protected]> - Thomas Petazzoni <[email protected]> - Andrew Lunn <[email protected]> - Nicolas Pitre <[email protected]> - Eric Miao <[email protected]>
Documentation/arm/Netwinder deleted +0 -78
78 lines not on this page · raw message
Documentation/arm/SA1100/FreeBird deleted +0 -21
@@ -1,21 +0,0 @@ -Freebird-1.1 is produced by Legend(C), Inc. -http://web.archive.org/web/*/http://www.legend.com.cn -and software/linux maintained by Coventive(C), Inc. -(http://www.coventive.com) - -Based on the Nicolas's strongarm kernel tree. - -=============================================================== -Maintainer: - -Chester Kuo <[email protected]> - <[email protected]> - -Author : -Tim wu <[email protected]> -CIH <[email protected]> -Eric Peng <[email protected]> -Jeff Lee <[email protected]> -Allen Cheng -Tony Liu <[email protected]> -
Documentation/arm/SA1100/empeg deleted +0 -2
@@ -1,2 +0,0 @@ -See ../empeg/README -
Documentation/arm/SA1100/serial_UART deleted +0 -47
47 lines not on this page · raw message
Documentation/arm/arm.rst renamed from Documentation/arm/README +30 -20
106 lines not on this page · raw message
Documentation/arm/booting.rst renamed from Documentation/arm/Booting +45 -26
135 lines not on this page · raw message
Documentation/arm/cluster-pm-race-avoidance.rst renamed from Documentation/arm/cluster-pm-race-avoidance.txt +106 -71
321 lines not on this page · raw message
Documentation/arm/firmware.rst renamed from Documentation/arm/firmware.txt +8 -6
@@ -1,5 +1,7 @@ -Interface for registering and calling firmware-specific operations for ARM. ----- +========================================================================== +Interface for registering and calling firmware-specific operations for ARM +========================================================================== + Written by Tomasz Figa <[email protected]> Some boards are running with secure firmware running in TrustZone secure
@@ -9,7 +11,7 @@ operations and call them when needed. Firmware operations can be specified by filling in a struct firmware_ops with appropriate callbacks and then registering it with register_firmware_ops() -function. +function:: void register_firmware_ops(const struct firmware_ops *ops)
@@ -19,7 +21,7 @@ and its members can be found in arch/arm/include/asm/firmware.h header. There is a default, empty set of operations provided, so there is no need to set anything if platform does not require firmware operations. -To call a firmware operation, a helper macro is provided +To call a firmware operation, a helper macro is provided:: #define call_firmware_op(op, ...) \ ((firmware_ops->op) ? firmware_ops->op(__VA_ARGS__) : (-ENOSYS))
@@ -28,7 +30,7 @@ the macro checks if the operation is provided and calls it or otherwise returns -ENOSYS to signal that given operation is not available (for example, to allow fallback to legacy operation). -Example of registering firmware operations: +Example of registering firmware operations:: /* board file */
@@ -56,7 +58,7 @@ Example of registering firmware operations: register_firmware_ops(&platformX_firmware_ops); } -Example of using a firmware operation: +Example of using a firmware operation:: /* some platform code, e.g. SMP initialization */
Documentation/arm/index.rst new file +80 -0
80 lines not on this page · raw message
Documentation/arm/interrupts.rst renamed from Documentation/arm/Interrupts +44 -42
141 lines not on this page · raw message
Documentation/arm/ixp4xx.rst renamed from Documentation/arm/IXP4xx +31 -30
135 lines not on this page · raw message
Documentation/arm/kernel_mode_neon.rst renamed from Documentation/arm/kernel_mode_neon.txt +3 -0
@@ -1,3 +1,4 @@ +================ Kernel mode NEON ================
@@ -86,6 +87,7 @@ instructions appearing in unexpected places if no special care is taken. Therefore, the recommended and only supported way of using NEON/VFP in the kernel is by adhering to the following rules: + * isolate the NEON code in a separate compilation unit and compile it with '-march=armv7-a -mfpu=neon -mfloat-abi=softfp'; * issue the calls to kernel_neon_begin(), kernel_neon_end() as well as the calls
@@ -115,6 +117,7 @@ NEON intrinsics NEON intrinsics are also supported. However, as code using NEON intrinsics relies on the GCC header <arm_neon.h>, (which #includes <stdint.h>), you should observe the following in addition to the rules above: + * Compile the unit containing the NEON intrinsics with '-ffreestanding' so GCC uses its builtin version of <stdint.h> (this is a C99 header which the kernel does not supply);
Documentation/arm/kernel_user_helpers.rst renamed from Documentation/arm/kernel_user_helpers.txt +40 -39
175 lines not on this page · raw message
Documentation/arm/keystone/knav-qmss.rst renamed from Documentation/arm/keystone/knav-qmss.txt +5 -1
@@ -1,4 +1,6 @@ -* Texas Instruments Keystone Navigator Queue Management SubSystem driver +====================================================================== +Texas Instruments Keystone Navigator Queue Management SubSystem driver +====================================================================== Driver source code path drivers/soc/ti/knav_qmss.c
@@ -34,11 +36,13 @@ driver that interface with the accumulator PDSP. This configures accumulator channels defined in DTS (example in DT documentation) to monitor 1 or 32 queues per channel. More description on the firmware is available in CPPI/QMSS Low Level Driver document (docs/CPPI_QMSS_LLD_SDS.pdf) at + git://git.ti.com/keystone-rtos/qmss-lld.git k2_qmss_pdsp_acc48_k2_le_1_0_0_9.bin firmware supports upto 48 accumulator channels. This firmware is available under ti-keystone folder of firmware.git at + git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git To use copy the firmware image to lib/firmware folder of the initramfs or
Documentation/arm/keystone/overview.rst renamed from Documentation/arm/keystone/Overview.txt +33 -14
85 lines not on this page · raw message
Documentation/arm/marvel.rst new file +488 -0
488 lines not on this page · raw message
Documentation/arm/mem_alignment.rst renamed from Documentation/arm/mem_alignment +8 -3
@@ -1,3 +1,7 @@ +================ +Memory alignment +================ + Too many problems popped up because of unnoticed misaligned memory access in kernel code lately. Therefore the alignment fixup is now unconditionally configured in for SA11x0 based targets. According to Alan Cox, this is a
@@ -26,9 +30,9 @@ space, and might cause programs to fail unexpectedly. To change the alignment trap behavior, simply echo a number into /proc/cpu/alignment. The number is made up from various bits: +=== ======================================================== bit behavior when set ---- ----------------- - +=== ======================================================== 0 A user process performing an unaligned memory access will cause the kernel to print a message indicating process name, pid, pc, instruction, address, and the
@@ -41,12 +45,13 @@ bit behavior when set 2 The kernel will send a SIGBUS signal to the user process performing the unaligned access. +=== ======================================================== Note that not all combinations are supported - only values 0 through 5. (6 and 7 don't make sense). For example, the following will turn on the warnings, but without -fixing up or sending SIGBUS signals: +fixing up or sending SIGBUS signals:: echo 1 > /proc/cpu/alignment
Documentation/arm/memory.rst renamed from Documentation/arm/memory.txt +7 -2
@@ -1,6 +1,9 @@ - Kernel Memory Layout on ARM Linux +================================= +Kernel Memory Layout on ARM Linux +================================= Russell King <[email protected]> + November 17, 2005 (2.6.15) This document describes the virtual memory layout which the Linux
@@ -15,8 +18,9 @@ As the ARM architecture matures, it becomes necessary to reserve certain regions of VM space for use for new facilities; therefore this document may reserve more VM space over time. +=============== =============== =============================================== Start End Use --------------------------------------------------------------------------- +=============== =============== =============================================== ffff8000 ffffffff copy_user_page / clear_user_page use. For SA11xx and Xscale, this is used to setup a minicache mapping.
@@ -77,6 +81,7 @@ MODULES_VADDR MODULES_END-1 Kernel module space place their vector page here. NULL pointer dereferences by both the kernel and user space are also caught via this mapping. +=============== =============== =============================================== Please note that mappings which collide with the above areas may result in a non-bootable kernel, or may cause the kernel to (eventually) panic
Documentation/arm/microchip.rst renamed from Documentation/arm/Microchip/README +49 -14
160 lines not on this page · raw message
Documentation/arm/netwinder.rst new file +85 -0
85 lines not on this page · raw message
Documentation/arm/nwfpe/index.rst new file +11 -0
@@ -0,0 +1,11 @@ +=================================== +NetWinder's floating point emulator +=================================== + +.. toctree:: + :maxdepth: 1 + + nwfpe + netwinder-fpe + notes + todo
Documentation/arm/nwfpe/netwinder-fpe.rst renamed from Documentation/arm/nwfpe/README.FPE +15 -9
@@ -1,12 +1,18 @@ +============= +Current State +============= + The following describes the current state of the NetWinder's floating point emulator. In the following nomenclature is used to describe the floating point instructions. It follows the conventions in the ARM manual. -<S|D|E> = <single|double|extended>, no default -{P|M|Z} = {round to +infinity,round to -infinity,round to zero}, - default = round to nearest +:: + + <S|D|E> = <single|double|extended>, no default + {P|M|Z} = {round to +infinity,round to -infinity,round to zero}, + default = round to nearest Note: items enclosed in {} are optional.
@@ -32,10 +38,10 @@ Form 2 syntax: <LFM|SFM>{cond}<FD,EA> Fd, <count>, [Rn]{!} These instructions are fully implemented. They store/load three words -for each floating point register into the memory location given in the +for each floating point register into the memory location given in the instruction. The format in memory is unlikely to be compatible with other implementations, in particular the actual hardware. Specific -mention of this is made in the ARM manuals. +mention of this is made in the ARM manuals. Floating Point Coprocessor Register Transfer Instructions (CPRT) ----------------------------------------------------------------
@@ -123,7 +129,7 @@ RPW{cond}<S|D|E>{P,M,Z} Fd, Fn, <Fm,#value> - reverse power POL{cond}<S|D|E>{P,M,Z} Fd, Fn, <Fm,#value> - polar angle (arctan2) LOG{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - logarithm to base 10 -LGN{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - logarithm to base e +LGN{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - logarithm to base e EXP{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - exponent SIN{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - sine COS{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - cosine
@@ -134,7 +140,7 @@ ATN{cond}<S|D|E>{P,M,Z} Fd, <Fm,#value> - arctangent These are not implemented. They are not currently issued by the compiler, and are handled by routines in libc. These are not implemented by the FPA11 -hardware, but are handled by the floating point support code. They should +hardware, but are handled by the floating point support code. They should be implemented in future versions. Signalling:
@@ -147,10 +153,10 @@ current_set[0] correctly. The kernel provided with this distribution (vmlinux-nwfpe-0.93) contains a fix for this problem and also incorporates the current version of the emulator directly. It is possible to run with no floating point module -loaded with this kernel. It is provided as a demonstration of the +loaded with this kernel. It is provided as a demonstration of the technology and for those who want to do floating point work that depends on signals. It is not strictly necessary to use the module. -A module (either the one provided by Russell King, or the one in this +A module (either the one provided by Russell King, or the one in this distribution) can be loaded to replace the functionality of the emulator built into the kernel.
Documentation/arm/nwfpe/notes.rst renamed from Documentation/arm/nwfpe/NOTES +3 -0
@@ -1,3 +1,6 @@ +Notes +===== + There seems to be a problem with exp(double) and our emulator. I haven't been able to track it down yet. This does not occur with the emulator supplied by Russell King.
Documentation/arm/nwfpe/nwfpe.rst renamed from Documentation/arm/nwfpe/README +7 -3
@@ -1,4 +1,7 @@ -This directory contains the version 0.92 test release of the NetWinder +Introduction +============ + +This directory contains the version 0.92 test release of the NetWinder Floating Point Emulator. The majority of the code was written by me, Scott Bambrough It is
@@ -31,7 +34,7 @@ SoftFloat to the ARM was done by Phil Blundell, based on an earlier port of SoftFloat version 1 by Neil Carson for NetBSD/arm32. The file README.FPE contains a description of what has been implemented -so far in the emulator. The file TODO contains a information on what +so far in the emulator. The file TODO contains a information on what remains to be done, and other ideas for the emulator. Bug reports, comments, suggestions should be directed to me at
@@ -48,10 +51,11 @@ Legal Notices The NetWinder Floating Point Emulator is free software. Everything Rebel.com has written is provided under the GNU GPL. See the file COPYING for copying -conditions. Excluded from the above is the SoftFloat code. John Hauser's +conditions. Excluded from the above is the SoftFloat code. John Hauser's legal notice for SoftFloat is included below. ------------------------------------------------------------------------------- + SoftFloat Legal Notice SoftFloat was written by John R. Hauser. This work was made possible in
Documentation/arm/nwfpe/todo.rst renamed from Documentation/arm/nwfpe/TODO +26 -21
84 lines not on this page · raw message
Documentation/arm/omap/dss.rst renamed from Documentation/arm/OMAP/DSS +61 -51
167 lines not on this page · raw message
Documentation/arm/omap/index.rst new file +10 -0
@@ -0,0 +1,10 @@ +======= +TI OMAP +======= + +.. toctree:: + :maxdepth: 1 + + omap.rst + omap_pm.rst + dss.rst
Documentation/arm/omap/omap.rst renamed from Documentation/arm/OMAP/README +7 -0
@@ -1,7 +1,13 @@ +============ +OMAP history +============ + This file contains documentation for running mainline kernel on omaps. +====== ====================================================== KERNEL NEW DEPENDENCIES +====== ====================================================== v4.3+ Update is needed for custom .config files to make sure CONFIG_REGULATOR_PBIAS is enabled for MMC1 to work properly.
@@ -9,3 +15,4 @@ v4.3+ Update is needed for custom .config files to make sure v4.18+ Update is needed for custom .config files to make sure CONFIG_MMC_SDHCI_OMAP is enabled for all MMC instances to work in DRA7 and K2G based boards. +====== ======================================================
Documentation/arm/omap/omap_pm.rst renamed from Documentation/arm/OMAP/omap_pm +33 -22
24 lines not on this page · raw message
Documentation/arm/porting.rst renamed from Documentation/arm/Porting +8 -6
Lines of this file are not shown. View the raw message.
Documentation/arm/pxa/mfp.rst renamed from Documentation/arm/pxa/mfp.txt +54 -52
106 lines not on this page · raw message
Documentation/arm/sa1100/adsbitsy.rst renamed from Documentation/arm/SA1100/ADSBitsy +11 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/assabet.rst renamed from Documentation/arm/SA1100/Assabet +93 -92
185 lines not on this page · raw message
Documentation/arm/sa1100/brutus.rst renamed from Documentation/arm/SA1100/Brutus +24 -21
45 lines not on this page · raw message
Documentation/arm/sa1100/cerf.rst renamed from Documentation/arm/SA1100/CERF +8 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/freebird.rst new file +25 -0
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/graphicsclient.rst renamed from Documentation/arm/SA1100/GraphicsClient +25 -21
46 lines not on this page · raw message
Documentation/arm/sa1100/graphicsmaster.rst renamed from Documentation/arm/SA1100/GraphicsMaster +10 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/huw_webpanel.rst renamed from Documentation/arm/SA1100/HUW_WEBPANEL +6 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/index.rst new file +23 -0
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/itsy.rst renamed from Documentation/arm/SA1100/Itsy +11 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/lart.rst renamed from Documentation/arm/SA1100/LART +2 -1
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/nanoengine.rst renamed from Documentation/arm/SA1100/nanoEngine +3 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/pangolin.rst renamed from Documentation/arm/SA1100/Pangolin +8 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/pleb.rst renamed from Documentation/arm/SA1100/PLEB +4 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/serial_uart.rst new file +51 -0
51 lines not on this page · raw message
Documentation/arm/sa1100/tifon.rst renamed from Documentation/arm/SA1100/Tifon +2 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sa1100/yopy.rst renamed from Documentation/arm/SA1100/Yopy +4 -1
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/cpufreq.rst renamed from Documentation/arm/Samsung-S3C24XX/CPUfreq.txt +3 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/eb2410itx.rst renamed from Documentation/arm/Samsung-S3C24XX/EB2410ITX.txt +3 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/gpio.rst renamed from Documentation/arm/Samsung-S3C24XX/GPIO.txt +12 -11
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/h1940.rst renamed from Documentation/arm/Samsung-S3C24XX/H1940.txt +3 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/index.rst new file +18 -0
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/nand.rst renamed from Documentation/arm/Samsung-S3C24XX/NAND.txt +3 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/overview.rst renamed from Documentation/arm/Samsung-S3C24XX/Overview.txt +11 -10
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/s3c2412.rst renamed from Documentation/arm/Samsung-S3C24XX/S3C2412.txt +3 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/s3c2413.rst renamed from Documentation/arm/Samsung-S3C24XX/S3C2413.txt +4 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/smdk2440.rst renamed from Documentation/arm/Samsung-S3C24XX/SMDK2440.txt +3 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/suspend.rst renamed from Documentation/arm/Samsung-S3C24XX/Suspend.txt +10 -10
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung-s3c24xx/usb-host.rst renamed from Documentation/arm/Samsung-S3C24XX/USB-Host.txt +7 -9
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung/bootloader-interface.rst renamed from Documentation/arm/Samsung/Bootloader-interface.txt +20 -7
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung/clksrc-change-registers.awk renamed from Documentation/arm/Samsung/clksrc-change-registers.awk +0 -0
Documentation/arm/samsung/gpio.rst renamed from Documentation/arm/Samsung/GPIO.txt +4 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung/index.rst new file +10 -0
Lines of this file are not shown. View the raw message.
Documentation/arm/samsung/overview.rst renamed from Documentation/arm/Samsung/Overview.txt +9 -6
Lines of this file are not shown. View the raw message.
Documentation/arm/setup.rst renamed from Documentation/arm/Setup +14 -35
49 lines not on this page · raw message
Documentation/arm/sh-mobile/.gitignore renamed from Documentation/arm/SH-Mobile/.gitignore +0 -0
Documentation/arm/spear/overview.rst renamed from Documentation/arm/SPEAr/overview.txt +11 -9
Lines of this file are not shown. View the raw message.
Documentation/arm/sti/overview.rst renamed from Documentation/arm/sti/overview.txt +12 -9
Lines of this file are not shown. View the raw message.
Documentation/arm/sti/stih407-overview.rst renamed from Documentation/arm/sti/stih407-overview.txt +5 -4
Lines of this file are not shown. View the raw message.
Documentation/arm/sti/stih415-overview.rst renamed from Documentation/arm/sti/stih415-overview.txt +5 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/sti/stih416-overview.rst renamed from Documentation/arm/sti/stih416-overview.txt +3 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sti/stih418-overview.rst renamed from Documentation/arm/sti/stih418-overview.txt +5 -4
Lines of this file are not shown. View the raw message.
Documentation/arm/stm32/stm32f429-overview.rst +2 -5
Lines of this file are not shown. View the raw message.
Documentation/arm/stm32/stm32f746-overview.rst +2 -5
Lines of this file are not shown. View the raw message.
Documentation/arm/stm32/stm32f769-overview.rst +2 -5
Lines of this file are not shown. View the raw message.
Documentation/arm/stm32/stm32h743-overview.rst +2 -5
Lines of this file are not shown. View the raw message.
Documentation/arm/stm32/stm32mp157-overview.rst +1 -2
Lines of this file are not shown. View the raw message.
Documentation/arm/sunxi.rst renamed from Documentation/arm/sunxi/README +73 -25
98 lines not on this page · raw message
Documentation/arm/sunxi/clocks.rst renamed from Documentation/arm/sunxi/clocks.txt +4 -3
Lines of this file are not shown. View the raw message.
Documentation/arm/swp_emulation.rst renamed from Documentation/arm/swp_emulation +12 -12
Lines of this file are not shown. View the raw message.
Documentation/arm/tcm.rst renamed from Documentation/arm/tcm.txt +30 -24
54 lines not on this page · raw message
Documentation/arm/uefi.rst renamed from Documentation/arm/uefi.txt +23 -16
Lines of this file are not shown. View the raw message.
Documentation/arm/vfp/release-notes.rst renamed from Documentation/arm/VFP/release-notes.txt +3 -1
Lines of this file are not shown. View the raw message.
Documentation/arm/vlocks.rst renamed from Documentation/arm/vlocks.txt +5 -4
Lines of this file are not shown. View the raw message.
Documentation/devicetree/bindings/arm/xen.txt +1 -1
Lines of this file are not shown. View the raw message.
Documentation/devicetree/booting-without-of.txt +2 -2
Lines of this file are not shown. View the raw message.
Documentation/translations/zh_CN/arm/Booting +2 -2
Lines of this file are not shown. View the raw message.
Documentation/translations/zh_CN/arm/kernel_user_helpers.txt +2 -2
Lines of this file are not shown. View the raw message.
drivers/crypto/sunxi-ss/sun4i-ss-cipher.c +1 -1
Lines of this file are not shown. View the raw message.
drivers/crypto/sunxi-ss/sun4i-ss-core.c +1 -1
Lines of this file are not shown. View the raw message.
drivers/crypto/sunxi-ss/sun4i-ss-hash.c +1 -1
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.21.0
Part of the diff is not shown here. View the raw message.
PATCH v2 18/29 docs: accounting: convert to ReST
In reply to Mauro Carvalho ChehabRename the accounting documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../{cgroupstats.txt => cgroupstats.rst} | 14 ++--
...ay-accounting.txt => delay-accounting.rst} | 61 ++++++++------
Documentation/accounting/index.rst | 14 ++++
Documentation/accounting/{psi.txt => psi.rst} | 40 +++++-----
...kstats-struct.txt => taskstats-struct.rst} | 79 ++++++++++++-------
.../{taskstats.txt => taskstats.rst} | 15 ++--
Documentation/admin-guide/cgroup-v2.rst | 6 +-
init/Kconfig | 2 +-
8 files changed, 139 insertions(+), 92 deletions(-)
rename Documentation/accounting/{cgroupstats.txt => cgroupstats.rst} (77%)
rename Documentation/accounting/{delay-accounting.txt => delay-accounting.rst} (77%)
create mode 100644 Documentation/accounting/index.rst
rename Documentation/accounting/{psi.txt => psi.rst} (91%)
rename Documentation/accounting/{taskstats-struct.txt => taskstats-struct.rst} (78%)
rename Documentation/accounting/{taskstats.txt => taskstats.rst} (95%)Documentation/accounting/cgroupstats.rst renamed from Documentation/accounting/cgroupstats.txt +9 -5
@@ -1,3 +1,7 @@ +================== +Control Groupstats +================== + Control Groupstats is inspired by the discussion at http://lkml.org/lkml/2007/4/11/187 and implements per cgroup statistics as suggested by Andrew Morton in http://lkml.org/lkml/2007/4/11/263.
@@ -19,9 +23,9 @@ about tasks blocked on I/O. If CONFIG_TASK_DELAY_ACCT is disabled, this information will not be available. To extract cgroup statistics a utility very similar to getdelays.c -has been developed, the sample output of the utility is shown below +has been developed, the sample output of the utility is shown below:: -~/balbir/cgroupstats # ./getdelays -C "/sys/fs/cgroup/a" -sleeping 1, blocked 0, running 1, stopped 0, uninterruptible 0 -~/balbir/cgroupstats # ./getdelays -C "/sys/fs/cgroup" -sleeping 155, blocked 0, running 1, stopped 0, uninterruptible 2 + ~/balbir/cgroupstats # ./getdelays -C "/sys/fs/cgroup/a" + sleeping 1, blocked 0, running 1, stopped 0, uninterruptible 0 + ~/balbir/cgroupstats # ./getdelays -C "/sys/fs/cgroup" + sleeping 155, blocked 0, running 1, stopped 0, uninterruptible 2
Documentation/accounting/delay-accounting.rst renamed from Documentation/accounting/delay-accounting.txt +35 -26
100 lines not on this page · raw message
Documentation/accounting/index.rst new file +14 -0
@@ -0,0 +1,14 @@ +:orphan: + +========== +Accounting +========== + +.. toctree:: + :maxdepth: 1 + + cgroupstats + delay-accounting + psi + taskstats + taskstats-struct
Documentation/accounting/psi.rst renamed from Documentation/accounting/psi.txt +21 -19
@@ -35,14 +35,14 @@ Pressure interface Pressure information for each resource is exported through the respective file in /proc/pressure/ -- cpu, memory, and io. -The format for CPU is as such: +The format for CPU is as such:: -some avg10=0.00 avg60=0.00 avg300=0.00 total=0 + some avg10=0.00 avg60=0.00 avg300=0.00 total=0 -and for memory and IO: +and for memory and IO:: -some avg10=0.00 avg60=0.00 avg300=0.00 total=0 -full avg10=0.00 avg60=0.00 avg300=0.00 total=0 + some avg10=0.00 avg60=0.00 avg300=0.00 total=0 + full avg10=0.00 avg60=0.00 avg300=0.00 total=0 The "some" line indicates the share of time in which at least some tasks are stalled on a given resource.
@@ -77,9 +77,9 @@ To register a trigger user has to open psi interface file under /proc/pressure/ representing the resource to be monitored and write the desired threshold and time window. The open file descriptor should be used to wait for trigger events using select(), poll() or epoll(). -The following format is used: +The following format is used:: -<some|full> <stall amount in us> <time window in us> + <some|full> <stall amount in us> <time window in us> For example writing "some 150000 1000000" into /proc/pressure/memory would add 150ms threshold for partial memory stall measured within
@@ -115,18 +115,20 @@ trigger is closed. Userspace monitor usage example =============================== -#include <errno.h> -#include <fcntl.h> -#include <stdio.h> -#include <poll.h> -#include <string.h> -#include <unistd.h> +:: -/* - * Monitor memory partial stall with 1s tracking window size - * and 150ms threshold. - */ -int main() { + #include <errno.h> + #include <fcntl.h> + #include <stdio.h> + #include <poll.h> + #include <string.h> + #include <unistd.h> + + /* + * Monitor memory partial stall with 1s tracking window size + * and 150ms threshold. + */ + int main() { const char trig[] = "some 150000 1000000"; struct pollfd fds; int n;
@@ -165,7 +167,7 @@ int main() { } return 0; -} + } Cgroup2 interface =================
Documentation/accounting/taskstats-struct.rst renamed from Documentation/accounting/taskstats-struct.txt +49 -30
166 lines not on this page · raw message
Documentation/accounting/taskstats.rst renamed from Documentation/accounting/taskstats.txt +7 -8
@@ -1,5 +1,6 @@ +============================= Per-task statistics interface ------------------------------ +============================= Taskstats is a netlink-based interface for sending per-task and
@@ -65,7 +66,7 @@ taskstats.h file. The data exchanged between user and kernel space is a netlink message belonging to the NETLINK_GENERIC family and using the netlink attributes interface. -The messages are in the format +The messages are in the format:: +----------+- - -+-------------+-------------------+ | nlmsghdr | Pad | genlmsghdr | taskstats payload |
@@ -167,15 +168,13 @@ extended and the number of cpus grows large. To avoid losing statistics, userspace should do one or more of the following: - increase the receive buffer sizes for the netlink sockets opened by -listeners to receive exit data. + listeners to receive exit data. - create more listeners and reduce the number of cpus being listened to by -each listener. In the extreme case, there could be one listener for each cpu. -Users may also consider setting the cpu affinity of the listener to the subset -of cpus to which it listens, especially if they are listening to just one cpu. + each listener. In the extreme case, there could be one listener for each cpu. + Users may also consider setting the cpu affinity of the listener to the subset + of cpus to which it listens, especially if they are listening to just one cpu. Despite these measures, if the userspace receives ENOBUFS error messages indicated overflow of receive buffers, it should take measures to handle the loss of data. - -----
Documentation/admin-guide/cgroup-v2.rst +3 -3
@@ -1014,7 +1014,7 @@ All time durations are in microseconds. A read-only nested-key file which exists on non-root cgroups. Shows pressure stall information for CPU. See - Documentation/accounting/psi.txt for details. + Documentation/accounting/psi.rst for details. Memory
@@ -1361,7 +1361,7 @@ PAGE_SIZE multiple when read back. A read-only nested-key file which exists on non-root cgroups. Shows pressure stall information for memory. See - Documentation/accounting/psi.txt for details. + Documentation/accounting/psi.rst for details. Usage Guidelines
@@ -1504,7 +1504,7 @@ IO Interface Files A read-only nested-key file which exists on non-root cgroups. Shows pressure stall information for IO. See - Documentation/accounting/psi.txt for details. + Documentation/accounting/psi.rst for details. Writeback
init/Kconfig +1 -1
@@ -517,7 +517,7 @@ config PSI have cpu.pressure, memory.pressure, and io.pressure files, which aggregate pressure stalls for the grouped tasks only. - For more details see Documentation/accounting/psi.txt. + For more details see Documentation/accounting/psi.rst. Say N if unsure.
Signature · 1 line
2.21.0
PATCH v2 19/29 docs: ia64: convert to ReST
In reply to Mauro Carvalho ChehabRename the ia64 documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
There are two upper case file names. Rename them to lower case, as we're working to avoid upper case file names at Documentation.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../ia64/{aliasing.txt => aliasing.rst} | 73 ++--
Documentation/ia64/{efirtc.txt => efirtc.rst} | 118 +++---
.../ia64/{err_inject.txt => err_inject.rst} | 349 +++++++++---------
Documentation/ia64/{fsys.txt => fsys.rst} | 127 ++++---
Documentation/ia64/{README => ia64.rst} | 26 +-
Documentation/ia64/index.rst | 18 +
.../ia64/{IRQ-redir.txt => irq-redir.rst} | 31 +-
Documentation/ia64/{mca.txt => mca.rst} | 10 +-
Documentation/ia64/{serial.txt => serial.rst} | 36 +-
Documentation/ia64/xen.rst | 206 +++++++++++
Documentation/ia64/xen.txt | 183 ---------
MAINTAINERS | 2 +-
arch/ia64/kernel/efi.c | 2 +-
arch/ia64/kernel/fsys.S | 2 +-
arch/ia64/mm/ioremap.c | 2 +-
arch/ia64/pci/pci.c | 2 +-
16 files changed, 660 insertions(+), 527 deletions(-)
rename Documentation/ia64/{aliasing.txt => aliasing.rst} (83%)
rename Documentation/ia64/{efirtc.txt => efirtc.rst} (70%)
rename Documentation/ia64/{err_inject.txt => err_inject.rst} (82%)
rename Documentation/ia64/{fsys.txt => fsys.rst} (76%)
rename Documentation/ia64/{README => ia64.rst} (61%)
create mode 100644 Documentation/ia64/index.rst
rename Documentation/ia64/{IRQ-redir.txt => irq-redir.rst} (86%)
rename Documentation/ia64/{mca.txt => mca.rst} (96%)
rename Documentation/ia64/{serial.txt => serial.rst} (87%)
create mode 100644 Documentation/ia64/xen.rst
delete mode 100644 Documentation/ia64/xen.txtDocumentation/ia64/aliasing.rst renamed from Documentation/ia64/aliasing.txt +49 -24
@@ -1,20 +1,25 @@ - MEMORY ATTRIBUTE ALIASING ON IA-64 +================= +Memory Attribute Aliasing on IA-64 +================= - Bjorn Helgaas - <[email protected]> - May 4, 2006 +Bjorn Helgaas <[email protected]> +May 4, 2006 -MEMORY ATTRIBUTES + +Memory Attributes +======== Itanium supports several attributes for virtual memory references. The attribute is part of the virtual translation, i.e., it is contained in the TLB entry. The ones of most interest to the Linux kernel are: - WB Write-back (cacheable) + = =========== + WB Write-back (cacheable) UC Uncacheable WC Write-coalescing + = =========== System memory typically uses the WB attribute. The UC attribute is used for memory-mapped I/O devices. The WC attribute is uncacheable
@@ -29,7 +34,8 @@ MEMORY ATTRIBUTES support either WB or UC access to main memory, while others support only WB access. -MEMORY MAP +Memory Map +===== Platform firmware describes the physical memory map and the supported attributes for each region. At boot-time, the kernel uses
@@ -55,7 +61,8 @@ MEMORY MAP The efi_memmap table is preserved unmodified because the original boot-time information is required for kexec. -KERNEL IDENTITY MAPPINGS +Kernel Identify Mappings +============ Linux/ia64 identity mappings are done with large pages, currently either 16MB or 64MB, referred to as "granules." Cacheable mappings
@@ -74,17 +81,20 @@ KERNEL IDENTITY MAPPINGS are only partially populated, or populated with a combination of UC and WB regions. -USER MAPPINGS +User Mappings +====== User mappings are typically done with 16K or 64K pages. The smaller page size allows more flexibility because only 16K or 64K has to be homogeneous with respect to memory attributes. -POTENTIAL ATTRIBUTE ALIASING CASES +Potential Attribute Aliasing Cases +================= There are several ways the kernel creates new mappings: - mmap of /dev/mem +mmap of /dev/mem +---------------- This uses remap_pfn_range(), which creates user mappings. These mappings may be either WB or UC. If the region being mapped
@@ -98,7 +108,8 @@ POTENTIAL ATTRIBUTE ALIASING CASES Since the EFI memory map does not describe MMIO on some machines, this should use an uncacheable mapping as a fallback. - mmap of /sys/class/pci_bus/.../legacy_mem +mmap of /sys/class/pci_bus/.../legacy_mem +----------------------------------------- This is very similar to mmap of /dev/mem, except that legacy_mem only allows mmap of the one megabyte "legacy MMIO" area for a
@@ -112,9 +123,10 @@ POTENTIAL ATTRIBUTE ALIASING CASES The /dev/mem mmap constraints apply. - mmap of /proc/bus/pci/.../??.? +mmap of /proc/bus/pci/.../??.? +------------------------------ - This is an MMIO mmap of PCI functions, which additionally may or + This is an MMIO mmap of PCI functions, which additionally may or may not be requested as using the WC attribute. If WC is requested, and the region in kern_memmap is either WC
@@ -124,7 +136,8 @@ POTENTIAL ATTRIBUTE ALIASING CASES Otherwise, the user mapping must use the same attribute as the kernel mapping. - read/write of /dev/mem +read/write of /dev/mem +---------------------- This uses copy_from_user(), which implicitly uses a kernel identity mapping. This is obviously safe for things in
@@ -138,7 +151,8 @@ POTENTIAL ATTRIBUTE ALIASING CASES eight-byte accesses, and the copy_from_user() path doesn't allow any control over the access size, so this would be dangerous. - ioremap() +ioremap() +--------- This returns a mapping for use inside the kernel.
@@ -155,9 +169,11 @@ POTENTIAL ATTRIBUTE ALIASING CASES Failing all of the above, we have to fall back to a UC mapping. -PAST PROBLEM CASES +Past Problem Cases +========= - mmap of various MMIO regions from /dev/mem by "X" on Intel platforms +mmap of various MMIO regions from /dev/mem by "X" on Intel platforms +-------------------------------------------------------------------- The EFI memory map may not report these MMIO regions.
@@ -166,12 +182,16 @@ PAST PROBLEM CASES succeed. It may create either WB or UC user mappings, depending on whether the region is in kern_memmap or the EFI memory map. - mmap of 0x0-0x9FFFF /dev/mem by "hwinfo" on HP sx1000 with VGA enabled +mmap of 0x0-0x9FFFF /dev/mem by "hwinfo" on HP sx1000 with VGA enabled +---------------------------------------------------------------------- The EFI memory map reports the following attributes: + + ======== ==== ========= 0x00000-0x9FFFF WB only 0xA0000-0xBFFFF UC only (VGA frame buffer) 0xC0000-0xFFFFF WB only + ======== ==== ========= This mmap is done with user pages, not kernel identity mappings, so it is safe to use WB mappings.
@@ -182,7 +202,8 @@ PAST PROBLEM CASES never generate an uncacheable reference to the WB-only areas unless the driver explicitly touches them. - mmap of 0x0-0xFFFFF legacy_mem by "X" +mmap of 0x0-0xFFFFF legacy_mem by "X" +------------------------------------- If the EFI memory map reports that the entire range supports the same attributes, we can allow the mmap (and we will prefer WB if
@@ -197,15 +218,18 @@ PAST PROBLEM CASES that doesn't report the VGA frame buffer at all), we should fail the mmap and force the user to map just the specific region of interest. - mmap of 0xA0000-0xBFFFF legacy_mem by "X" on HP sx1000 with VGA disabled +mmap of 0xA0000-0xBFFFF legacy_mem by "X" on HP sx1000 with VGA disabled +------------------------------------------------------------------------ + + The EFI memory map reports the following attributes:: - The EFI memory map reports the following attributes: 0x00000-0xFFFFF WB only (no VGA MMIO hole) This is a special case of the previous case, and the mmap should fail for the same reason as above. - read of /sys/devices/.../rom +read of /sys/devices/.../rom +---------------------------- For VGA devices, this may cause an ioremap() of 0xC0000. This used to be done with a UC mapping, because the VGA frame buffer
@@ -215,7 +239,8 @@ PAST PROBLEM CASES We should use WB page table mappings to avoid covering the VGA frame buffer. -NOTES +Notes +== [1] SDM rev 2.2, vol 2, sec 4.4.1. [2] SDM rev 2.2, vol 2, sec 4.4.6.
Documentation/ia64/efirtc.rst renamed from Documentation/ia64/efirtc.txt +67 -51
187 lines not on this page · raw message
Documentation/ia64/err_inject.rst renamed from Documentation/ia64/err_inject.txt +174 -175
570 lines not on this page · raw message
Documentation/ia64/fsys.rst renamed from Documentation/ia64/fsys.txt +69 -55
233 lines not on this page · raw message
Documentation/ia64/ia64.rst renamed from Documentation/ia64/README +15 -10
@@ -1,43 +1,49 @@ - Linux kernel release 2.4.xx for the IA-64 Platform +=====================+Linux kernel release for the IA-64 Platform +===================== - These are the release notes for Linux version 2.4 for IA-64 + These are the release notes for Linux since version 2.4 for IA-64 platform. This document provides information specific to IA-64 ONLY, to get additional information about the Linux kernel also read the original Linux README provided with the kernel. -INSTALLING the kernel: +Installing the Kernel +========== - IA-64 kernel installation is the same as the other platforms, see original README for details. -SOFTWARE REQUIREMENTS +Software Requirements +========== Compiling and running this kernel requires an IA-64 compliant GCC compiler. And various software packages also compiled with an IA-64 compliant GCC compiler. -CONFIGURING the kernel: +Configuring the Kernel +=========== Configuration is the same, see original README for details. -COMPILING the kernel: +Compiling the Kernel: - Compiling this kernel doesn't differ from other platform so read the original README for details BUT make sure you have an IA-64 compliant GCC compiler. -IA-64 SPECIFICS +IA-64 Specifics +======= - General issues: - o Hardly any performance tuning has been done. Obvious targets + * Hardly any performance tuning has been done. Obvious targets include the library routines (IP checksum, etc.). Less obvious targets include making sure we don't flush the TLB needlessly, etc. - o SMP locks cleanup/optimization + * SMP locks cleanup/optimization - o IA32 support. Currently experimental. It mostly works. + * IA32 support. Currently experimental. It mostly works.
Documentation/ia64/index.rst new file +18 -0
@@ -0,0 +1,18 @@ +:orphan: + +========= +IA-64 Architecture +========= + +.. toctree:: + :maxdepth: 1 + + ia64 + aliasing + efirtc + err_inject + fsys + irq-redir + mca + serial + xen
Documentation/ia64/irq-redir.rst renamed from Documentation/ia64/IRQ-redir.txt +21 -10
@@ -1,6 +1,8 @@ +=============== IRQ affinity on IA64 platforms ------------------------------- - 07.01.2002, Erich Focht <[email protected]> +=============== + +07.01.2002, Erich Focht <[email protected]> By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be
@@ -12,22 +14,27 @@ IRQ target is one particular CPU and cannot be a mask of several CPUs. Only the first non-zero bit is taken into account. -Usage examples: +Usage examples +======= The target CPU has to be specified as a hexadecimal CPU mask. The first non-zero bit is the selected CPU. This format has been kept for compatibility reasons with i386. Set the delivery mode of interrupt 41 to fixed and route the -interrupts to CPU #3 (logical CPU number) (2^3=0x08): +interrupts to CPU #3 (logical CPU number) (2^3=0x08):: + echo "8" >/proc/irq/41/smp_affinity Set the default route for IRQ number 41 to CPU 6 in lowest priority -delivery mode (redirectable): +delivery mode (redirectable):: + echo "r 40" >/proc/irq/41/smp_affinity -The output of the command +The output of the command:: + cat /proc/irq/IRQ#/smp_affinity + gives the target CPU mask for the specified interrupt vector. If the CPU mask is preceded by the character "r", the interrupt is redirectable (i.e. lowest priority mode routing is used), otherwise its route is
@@ -35,7 +42,8 @@ fixed. -Initialization and default behavior: +Initialization and default behavior +================= If the platform features IRQ redirection (info provided by SAL) all IO-SAPIC interrupts are initialized with CPU#0 as their default target
@@ -43,9 +51,11 @@ and the routing is the so called "lowest priority mode" (actually fixed SAPIC mode with hint). The XTP chipset registers are used as hints for the IRQ routing. Currently in Linux XTP registers can have three values: + - minimal for an idle task, - normal if any other task runs, - maximal if the CPU is going to be switched off. + The IRQ is routed to the CPU with lowest XTP register value, the search begins at the default CPU. Therefore most of the interrupts will be handled by CPU #0.
@@ -53,12 +63,14 @@ will be handled by CPU #0. If the platform doesn't feature interrupt redirection IOSAPIC fixed routing is used. The target CPUs are distributed in a round robin manner. IRQs will be routed only to the selected target CPUs. Check -with +with:: + cat /proc/interrupts -Comments: +Comments +==== On large (multi-node) systems it is recommended to route the IRQs to the node to which the corresponding device is connected.
@@ -66,4 +78,3 @@ For systems like the NEC AzusA we get IRQ node-affinity for free. This is because usually the chipsets on each node redirect the interrupts only to their own CPUs (as they cannot see the XTP registers on the other nodes). -
Documentation/ia64/mca.rst renamed from Documentation/ia64/mca.txt +5 -3
@@ -1,5 +1,8 @@ -An ad-hoc collection of notes on IA64 MCA and INIT processing. Feel -free to update it with notes about any area that is not clear. +==============================+An ad-hoc collection of notes on IA64 MCA and INIT processing +==============================+ +Feel free to update it with notes about any area that is not clear. ---
@@ -82,7 +85,8 @@ if we have a choice here. own stack as running on that cpu. Then a recursive error gets a trace of the failing handler's "task". -[1] My (Keith Owens) original design called for ia64 to separate its +[1] + My (Keith Owens) original design called for ia64 to separate its struct task and the kernel stacks. Then the MCA/INIT data would be chained stacks like i386 interrupt stacks. But that required radical surgery on the rest of ia64, plus extra hard wired TLB
Documentation/ia64/serial.rst renamed from Documentation/ia64/serial.txt +24 -11
@@ -1,4 +1,9 @@ -SERIAL DEVICE NAMING +======= +Serial Devices +======= + +Serial Device Naming +========== As of 2.6.10, serial devices on ia64 are named based on the order of ACPI and PCI enumeration. The first device in the
@@ -30,17 +35,21 @@ SERIAL DEVICE NAMING (described in the ACPI namespace) plus an MP[2] (a PCI device) has these ports: - pre-2.6.10 pre-2.6.10 - MMIO (EFI console (EFI console - address on builtin) on MP port) 2.6.10 - ===== ===== ===== === + ===== ===== ====== ====== ===+ Type MMIO pre-2.6.10 pre-2.6.10 2.6.10+ + address + (EFI console (EFI console + on builtin) on MP port) + ===== ===== ====== ====== === builtin 0xff5e0000 ttyS0 ttyS1 ttyS0 MP UPS 0xf8031000 ttyS1 ttyS2 ttyS1 MP Console 0xf8030000 ttyS2 ttyS0 ttyS2 MP 2 0xf8030010 ttyS3 ttyS3 ttyS3 MP 3 0xf8030038 ttyS4 ttyS4 ttyS4 + ===== ===== ====== ====== === -CONSOLE SELECTION +Console Selection +======== EFI knows what your console devices are, but it doesn't tell the kernel quite enough to actually locate them. The DIG64 HCDP
@@ -67,7 +76,8 @@ CONSOLE SELECTION entries in /etc/inittab (for getty) and /etc/securetty (to allow root login). -EARLY SERIAL CONSOLE +Early Serial Console +========== The kernel can't start using a serial console until it knows where the device lives. Normally this happens when the driver enumerates
@@ -80,7 +90,8 @@ EARLY SERIAL CONSOLE or if the EFI console path contains only a UART device and the firmware supplies an HCDP. -TROUBLESHOOTING SERIAL CONSOLE PROBLEMS +Troubleshooting Serial Console Problems +=================== No kernel output after elilo prints "Uncompressing Linux... done":
@@ -133,19 +144,22 @@ TROUBLESHOOTING SERIAL CONSOLE PROBLEMS -[1] http://www.dig64.org/specifications/agreement +[1] + http://www.dig64.org/specifications/agreement The table was originally defined as the "HCDP" for "Headless Console/Debug Port." The current version is the "PCDP" for "Primary Console and Debug Port Devices." -[2] The HP MP (management processor) is a PCI device that provides +[2] + The HP MP (management processor) is a PCI device that provides several UARTs. One of the UARTs is often used as a console; the EFI Boot Manager identifies it as "Acpi(HWP0002,700)/Pci(...)/Uart". The external connection is usually a 25-pin connector, and a special dongle converts that to three 9-pin connectors, one of which is labelled "Console." -[3] EFI console devices are configured using the EFI Boot Manager +[3] + EFI console devices are configured using the EFI Boot Manager "Boot option maintenance" menu. You may have to interrupt the boot sequence to use this menu, and you will have to reset the box after changing console configuration.
Documentation/ia64/xen.rst new file +203 -0
203 lines not on this page · raw message
Documentation/ia64/xen.txt deleted +0 -177
177 lines not on this page · raw message
MAINTAINERS +1 -1
@@ -14266,7 +14266,7 @@ SGI SN-IA64 (Altix) SERIAL CONSOLE DRIVER M: Pat Gefre <[email protected]> L: [email protected] S: Supported -F: Documentation/ia64/serial.txt +F: Documentation/ia64/serial.rst F: drivers/tty/serial/ioc?_serial.c F: include/linux/ioc?.h
arch/ia64/kernel/efi.c +1 -1
@@ -852,7 +852,7 @@ valid_phys_addr_range (phys_addr_t phys_addr, unsigned long size)* /dev/mem reads and writes use copy_to_user(), which implicitly * uses a granule-sized kernel identity mapping. It's really * only safe to do this for regions in kern_memmap. For more -* details, see Documentation/ia64/aliasing.txt. +* details, see Documentation/ia64/aliasing.rst. */ attr =kern_mem_attribute (phys_addr, size);if (attr &EFI_MEMORY_WB || attr &EFI_MEMORY_UC )
arch/ia64/kernel/fsys.S +1 -1
@@ -28,7 +28,7 @@ #include <asm/native/inst.h> /* - * See Documentation/ia64/fsys.txt for details on fsyscalls. + * See Documentation/ia64/fsys.rst for details on fsyscalls. * * On entry to an fsyscall handler: * r10 = 0 (i.e., defaults to "successful syscall return")
arch/ia64/mm/ioremap.c +1 -1
@@ -45,7 +45,7 @@ ioremap (unsigned long phys_addr, unsigned long size)/* * For things in kern_memmap, we must use the same attribute * as the rest of the kernel. For more details, see -* Documentation/ia64/aliasing.txt. +* Documentation/ia64/aliasing.rst. */ attr =kern_mem_attribute (phys_addr, size);if (attr &EFI_MEMORY_WB )
arch/ia64/pci/pci.c +1 -1
@@ -450,7 +450,7 @@ pci_mmap_legacy_page_range(struct pci_bus *bus, struct vm_area_struct *vma,return -ENOSYS ;/* -* Avoid attribute aliasing. See Documentation/ia64/aliasing.txt +* Avoid attribute aliasing. See Documentation/ia64/aliasing.rst * for more details. */ if (!valid_mmap_phys_addr_range (vma->vm_pgoff, size))
Signature · 1 line
2.21.0
PATCH v2 20/29 docs: leds: convert to ReST
In reply to Mauro Carvalho ChehabRename the leds documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/laptops/thinkpad-acpi.txt | 4 +-
Documentation/leds/index.rst | 25 ++
.../leds/{leds-blinkm.txt => leds-blinkm.rst} | 64 ++---
...s-class-flash.txt => leds-class-flash.rst} | 49 ++--
.../leds/{leds-class.txt => leds-class.rst} | 15 +-
.../leds/{leds-lm3556.txt => leds-lm3556.rst} | 100 ++++++--
.../leds/{leds-lp3944.txt => leds-lp3944.rst} | 23 +-
Documentation/leds/leds-lp5521.rst | 115 +++++++++
Documentation/leds/leds-lp5521.txt | 101 --------
Documentation/leds/leds-lp5523.rst | 147 ++++++++++++
Documentation/leds/leds-lp5523.txt | 130 ----------
Documentation/leds/leds-lp5562.rst | 137 +++++++++++
Documentation/leds/leds-lp5562.txt | 120 ----------
Documentation/leds/leds-lp55xx.rst | 224 ++++++++++++++++++
Documentation/leds/leds-lp55xx.txt | 194 ---------------
Documentation/leds/leds-mlxcpld.rst | 118 +++++++++
Documentation/leds/leds-mlxcpld.txt | 110 ---------
...edtrig-oneshot.txt => ledtrig-oneshot.rst} | 11 +-
...ig-transient.txt => ledtrig-transient.rst} | 63 +++--
...edtrig-usbport.txt => ledtrig-usbport.rst} | 11 +-
Documentation/leds/{uleds.txt => uleds.rst} | 5 +-
MAINTAINERS | 2 +-
drivers/leds/trigger/Kconfig | 2 +-
drivers/leds/trigger/ledtrig-transient.c | 2 +-
net/netfilter/Kconfig | 2 +-
25 files changed, 996 insertions(+), 778 deletions(-)
create mode 100644 Documentation/leds/index.rst
rename Documentation/leds/{leds-blinkm.txt => leds-blinkm.rst} (57%)
rename Documentation/leds/{leds-class-flash.txt => leds-class-flash.rst} (74%)
rename Documentation/leds/{leds-class.txt => leds-class.rst} (92%)
rename Documentation/leds/{leds-lm3556.txt => leds-lm3556.rst} (70%)
rename Documentation/leds/{leds-lp3944.txt => leds-lp3944.rst} (78%)
create mode 100644 Documentation/leds/leds-lp5521.rst
delete mode 100644 Documentation/leds/leds-lp5521.txt
create mode 100644 Documentation/leds/leds-lp5523.rst
delete mode 100644 Documentation/leds/leds-lp5523.txt
create mode 100644 Documentation/leds/leds-lp5562.rst
delete mode 100644 Documentation/leds/leds-lp5562.txt
create mode 100644 Documentation/leds/leds-lp55xx.rst
delete mode 100644 Documentation/leds/leds-lp55xx.txt
create mode 100644 Documentation/leds/leds-mlxcpld.rst
delete mode 100644 Documentation/leds/leds-mlxcpld.txt
rename Documentation/leds/{ledtrig-oneshot.txt => ledtrig-oneshot.rst} (90%)
rename Documentation/leds/{ledtrig-transient.txt => ledtrig-transient.rst} (81%)
rename Documentation/leds/{ledtrig-usbport.txt => ledtrig-usbport.rst} (86%)
rename Documentation/leds/{uleds.txt => uleds.rst} (95%)Documentation/laptops/thinkpad-acpi.txt +2 -2
@@ -679,7 +679,7 @@ status as "unknown". The available commands are: sysfs notes: The ThinkLight sysfs interface is documented by the LED class -documentation, in Documentation/leds/leds-class.txt. The ThinkLight LED name +documentation, in Documentation/leds/leds-class.rst. The ThinkLight LED name is "tpacpi::thinklight". Due to limitations in the sysfs LED class, if the status of the ThinkLight
@@ -779,7 +779,7 @@ All of the above can be turned on and off and can be made to blink. sysfs notes: The ThinkPad LED sysfs interface is described in detail by the LED class -documentation, in Documentation/leds/leds-class.txt. +documentation, in Documentation/leds/leds-class.rst. The LEDs are named (in LED ID order, from 0 to 12): "tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
Documentation/leds/index.rst new file +25 -0
@@ -0,0 +1,25 @@ +:orphan: + +==== +LEDs +==== + +.. toctree:: + :maxdepth: 1 + + leds-class + leds-class-flash + ledtrig-oneshot + ledtrig-transient + ledtrig-usbport + + uleds + + leds-blinkm + leds-lm3556 + leds-lp3944 + leds-lp5521 + leds-lp5523 + leds-lp5562 + leds-lp55xx + leds-mlxcpld
Documentation/leds/leds-blinkm.rst renamed from Documentation/leds/leds-blinkm.txt +34 -30
101 lines not on this page · raw message
Documentation/leds/leds-class-flash.rst renamed from Documentation/leds/leds-class-flash.txt +33 -16
78 lines not on this page · raw message
Documentation/leds/leds-class.rst renamed from Documentation/leds/leds-class.txt +9 -6
@@ -1,4 +1,4 @@ - +======================== LED handling under Linux ========================
@@ -43,7 +43,7 @@ LED Device Naming Is currently of the form: -"devicename:colour:function" + "devicename:colour:function" There have been calls for LED properties such as colour to be exported as individual led class attributes. As a solution which doesn't incur as much
@@ -57,9 +57,12 @@ Brightness setting API LED subsystem core exposes following API for setting brightness: - - led_set_brightness : it is guaranteed not to sleep, passing LED_OFF stops + - led_set_brightness: + it is guaranteed not to sleep, passing LED_OFF stops blinking, - - led_set_brightness_sync : for use cases when immediate effect is desired - + + - led_set_brightness_sync: + for use cases when immediate effect is desired - it can block the caller for the time required for accessing device registers and can sleep, passing LED_OFF stops hardware blinking, returns -EBUSY if software blink fallback is enabled.
@@ -70,7 +73,7 @@ LED registration API A driver wanting to register a LED classdev for use by other drivers / userspace needs to allocate and fill a led_classdev struct and then call -[devm_]led_classdev_register. If the non devm version is used the driver +`[devm_]led_classdev_register`. If the non devm version is used the driver must call led_classdev_unregister from its remove function before free-ing the led_classdev struct.
@@ -94,7 +97,7 @@ with brightness value LED_OFF, which should stop any software timers that may have been required for blinking. The blink_set() function should choose a user friendly blinking value -if it is called with *delay_on==0 && *delay_off==0 parameters. In this +if it is called with `*delay_on==0` && `*delay_off==0` parameters. In this case the driver should give back the chosen value through delay_on and delay_off parameters to the leds subsystem.
Documentation/leds/leds-lm3556.rst renamed from Documentation/leds/leds-lm3556.txt +76 -24
157 lines not on this page · raw message
Documentation/leds/leds-lp3944.rst renamed from Documentation/leds/leds-lp3944.txt +16 -7
@@ -1,14 +1,20 @@ +==================== Kernel driver lp3944 ==================== * National Semiconductor LP3944 Fun-light Chip + Prefix: 'lp3944' + Addresses scanned: None (see the Notes section below) - Datasheet: Publicly available at the National Semiconductor website - http://www.national.com/pf/LP/LP3944.html + + Datasheet: + + Publicly available at the National Semiconductor website + http://www.national.com/pf/LP/LP3944.html Authors: - Antonio Ospite <[email protected]> + Antonio Ospite <[email protected]> Description
@@ -19,8 +25,11 @@ is used as a led controller. The DIM modes are used to set _blink_ patterns for leds, the pattern is specified supplying two parameters: - - period: from 0s to 1.6s - - duty cycle: percentage of the period the led is on, from 0 to 100 + + - period: + from 0s to 1.6s + - duty cycle: + percentage of the period the led is on, from 0 to 100 Setting a led in DIM0 or DIM1 mode makes it blink according to the pattern. See the datasheet for details.
@@ -35,7 +44,7 @@ The chip is used mainly in embedded contexts, so this driver expects it is registered using the i2c_board_info mechanism. To register the chip at address 0x60 on adapter 0, set the platform data -according to include/linux/leds-lp3944.h, set the i2c board info: +according to include/linux/leds-lp3944.h, set the i2c board info:: static struct i2c_board_info a910_i2c_board_info[] __initdata = { {
@@ -44,7 +53,7 @@ according to include/linux/leds-lp3944.h, set the i2c board info: }, }; -and register it in the platform init function +and register it in the platform init function:: i2c_register_board_info(0, a910_i2c_board_info, ARRAY_SIZE(a910_i2c_board_info));
Documentation/leds/leds-lp5521.rst new file +115 -0
115 lines not on this page · raw message
Documentation/leds/leds-lp5521.txt deleted +0 -101
101 lines not on this page · raw message
Documentation/leds/leds-lp5523.rst new file +147 -0
147 lines not on this page · raw message
Documentation/leds/leds-lp5523.txt deleted +0 -130
130 lines not on this page · raw message
Documentation/leds/leds-lp5562.rst new file +137 -0
137 lines not on this page · raw message
Documentation/leds/leds-lp5562.txt deleted +0 -120
120 lines not on this page · raw message
Documentation/leds/leds-lp55xx.rst new file +224 -0
224 lines not on this page · raw message
Documentation/leds/leds-lp55xx.txt deleted +0 -194
194 lines not on this page · raw message
Documentation/leds/leds-mlxcpld.rst new file +118 -0
118 lines not on this page · raw message
Documentation/leds/leds-mlxcpld.txt deleted +0 -110
110 lines not on this page · raw message
Documentation/leds/ledtrig-oneshot.rst renamed from Documentation/leds/ledtrig-oneshot.txt +6 -5
@@ -1,3 +1,4 @@ +==================== One-shot LED Trigger ====================
@@ -17,27 +18,27 @@ additional "invert" property specifies if the LED has to stay off (normal) or on (inverted) when not rearmed. The trigger can be activated from user space on led class devices as shown -below: +below:: echo oneshot > trigger This adds sysfs attributes to the LED that are documented in: Documentation/ABI/testing/sysfs-class-led-trigger-oneshot -Example use-case: network devices, initialization: +Example use-case: network devices, initialization:: echo oneshot > trigger # set trigger for this led echo 33 > delay_on # blink at 1 / (33 + 33) Hz on continuous traffic echo 33 > delay_off -interface goes up: +interface goes up:: echo 1 > invert # set led as normally-on, turn the led on -packet received/transmitted: +packet received/transmitted:: echo 1 > shot # led starts blinking, ignored if already blinking -interface goes down +interface goes down:: echo 0 > invert # set led as normally-off, turn the led off
Documentation/leds/ledtrig-transient.rst renamed from Documentation/leds/ledtrig-transient.txt +39 -24
112 lines not on this page · raw message
Documentation/leds/ledtrig-usbport.rst renamed from Documentation/leds/ledtrig-usbport.txt +8 -3
@@ -1,3 +1,4 @@ +==================== USB port LED trigger ====================
@@ -10,14 +11,18 @@ listed as separated entries in a "ports" subdirectory. Selecting is handled by echoing "1" to a chosen port. Please note that this trigger allows selecting multiple USB ports for a single -LED. This can be useful in two cases: +LED. + +This can be useful in two cases: 1) Device with single USB LED and few physical ports +==================================================== In such a case LED will be turned on as long as there is at least one connected USB device. 2) Device with a physical port handled by few controllers +========================================================= Some devices may have one controller per PHY standard. E.g. USB 3.0 physical port may be handled by ohci-platform, ehci-platform and xhci-hcd. If there is
@@ -25,14 +30,14 @@ only one LED user will most likely want to assign ports from all 3 hubs. This trigger can be activated from user space on led class devices as shown -below: +below:: echo usbport > trigger This adds sysfs attributes to the LED that are documented in: Documentation/ABI/testing/sysfs-class-led-trigger-usbport -Example use-case: +Example use-case:: echo usbport > trigger echo 1 > ports/usb1-port1
Documentation/leds/uleds.rst renamed from Documentation/leds/uleds.txt +3 -2
@@ -1,3 +1,4 @@ +============== Userspace LEDs ==============
@@ -10,12 +11,12 @@ Usage When the driver is loaded, a character device is created at /dev/uleds. To create a new LED class device, open /dev/uleds and write a uleds_user_dev -structure to it (found in kernel public header file linux/uleds.h). +structure to it (found in kernel public header file linux/uleds.h):: #define LED_MAX_NAME_SIZE 64 struct uleds_user_dev { - char name[LED_MAX_NAME_SIZE]; + char name[LED_MAX_NAME_SIZE]; }; A new LED class device will be created with the name given. The name can be
MAINTAINERS +1 -1
@@ -10175,7 +10175,7 @@ L: [email protected] S: Supported F: drivers/leds/leds-mlxcpld.c F: drivers/leds/leds-mlxreg.c -F: Documentation/leds/leds-mlxcpld.txt +F: Documentation/leds/leds-mlxcpld.rst MELLANOX PLATFORM DRIVER M: Vadim Pasternak <[email protected]>
drivers/leds/trigger/Kconfig +1 -1
@@ -15,7 +15,7 @@ config LEDS_TRIGGER_TIMER This allows LEDs to be controlled by a programmable timer via sysfs. Some LED hardware can be programmed to start blinking the LED without any further software interaction. - For more details read Documentation/leds/leds-class.txt. + For more details read Documentation/leds/leds-class.rst. If unsure, say Y.
drivers/leds/trigger/ledtrig-transient.c +1 -1
@@ -3,7 +3,7 @@// LED Kernel Transient Trigger // // Transient trigger allows one shot timer activation. Please refer to -// Documentation/leds/ledtrig-transient.txt for details +// Documentation/leds/ledtrig-transient.rst for details // Copyright (C) 2012 Shuah Khan <[email protected]> // // Based on Richard Purdie's ledtrig-timer.c and Atsushi Nemoto's
net/netfilter/Kconfig +1 -1
@@ -906,7 +906,7 @@ config NETFILTER_XT_TARGET_LED echo netfilter-ssh > /sys/class/leds/<ledname>/trigger For more information on the LEDs available on your system, see - Documentation/leds/leds-class.txt + Documentation/leds/leds-class.rst config NETFILTER_XT_TARGET_LOG tristate "LOG target support"
Signature · 1 line
2.21.0
PATCH v2 21/29 docs: laptops: convert to ReST
In reply to Mauro Carvalho ChehabRename the laptops documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/ABI/testing/sysfs-block-device | 2 +-
.../ABI/testing/sysfs-platform-asus-laptop | 2 +-
.../admin-guide/kernel-parameters.txt | 2 +-
.../{asus-laptop.txt => asus-laptop.rst} | 92 ++--
...otection.txt => disk-shock-protection.rst} | 32 +-
Documentation/laptops/index.rst | 17 +
.../{laptop-mode.txt => laptop-mode.rst} | 509 +++++++++---------
.../{sony-laptop.txt => sony-laptop.rst} | 58 +-
.../laptops/{sonypi.txt => sonypi.rst} | 28 +-
.../{thinkpad-acpi.txt => thinkpad-acpi.rst} | 363 ++++++++-----
.../{toshiba_haps.txt => toshiba_haps.rst} | 47 +-
Documentation/sysctl/vm.txt | 4 +-
MAINTAINERS | 2 +-
drivers/char/Kconfig | 2 +-
drivers/platform/x86/Kconfig | 4 +-
15 files changed, 660 insertions(+), 504 deletions(-)
rename Documentation/laptops/{asus-laptop.txt => asus-laptop.rst} (84%)
rename Documentation/laptops/{disk-shock-protection.txt => disk-shock-protection.rst} (91%)
create mode 100644 Documentation/laptops/index.rst
rename Documentation/laptops/{laptop-mode.txt => laptop-mode.rst} (62%)
rename Documentation/laptops/{sony-laptop.txt => sony-laptop.rst} (85%)
rename Documentation/laptops/{sonypi.txt => sonypi.rst} (87%)
rename Documentation/laptops/{thinkpad-acpi.txt => thinkpad-acpi.rst} (89%)
rename Documentation/laptops/{toshiba_haps.txt => toshiba_haps.rst} (60%)Documentation/ABI/testing/sysfs-block-device +1 -1
@@ -45,7 +45,7 @@ Description: - Values below -2 are rejected with -EINVAL For more information, see - Documentation/laptops/disk-shock-protection.txt + Documentation/laptops/disk-shock-protection.rst What: /sys/block/*/device/ncq_prio_enable
Documentation/ABI/testing/sysfs-platform-asus-laptop +1 -1
@@ -31,7 +31,7 @@ Description: To control the LED display, use the following : echo 0x0T000DDD > /sys/devices/platform/asus_laptop/ where T control the 3 letters display, and DDD the 3 digits display. - The DDD table can be found in Documentation/laptops/asus-laptop.txt + The DDD table can be found in Documentation/laptops/asus-laptop.rst What: /sys/devices/platform/asus_laptop/bluetooth Date: January 2007
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -4356,7 +4356,7 @@ Format: <integer> sonypi.*= [HW] Sony Programmable I/O Control Device driver - See Documentation/laptops/sonypi.txt + See Documentation/laptops/sonypi.rst spectre_v2= [X86] Control mitigation of Spectre variant 2 (indirect branch speculation) vulnerability.
Documentation/laptops/asus-laptop.rst renamed from Documentation/laptops/asus-laptop.txt +53 -39
207 lines not on this page · raw message
Documentation/laptops/disk-shock-protection.rst renamed from Documentation/laptops/disk-shock-protection.txt +17 -15
@@ -1,17 +1,18 @@ +========================== Hard disk shock protection ========================== Author: Elias Oltmanns <[email protected]> + Last modified: 2008-10-03 -0. Contents ------------ +.. 0. Contents -1. Intro -2. The interface -3. References -4. CREDITS + 1. Intro + 2. The interface + 3. References + 4. CREDITS 1. Intro
@@ -36,8 +37,8 @@ that). ---------------- For each ATA device, the kernel exports the file -block/*/device/unload_heads in sysfs (here assumed to be mounted under -/sys). Access to /sys/block/*/device/unload_heads is denied with +`block/*/device/unload_heads` in sysfs (here assumed to be mounted under +/sys). Access to `/sys/block/*/device/unload_heads` is denied with -EOPNOTSUPP if the device does not support the unload feature. Otherwise, writing an integer value to this file will take the heads of the respective drive off the platter and block all I/O operations
@@ -54,18 +55,18 @@ cancel a previously set timeout and resume normal operation immediately by specifying a timeout of 0. Values below -2 are rejected with -EINVAL (see below for the special meaning of -1 and -2). If the timeout specified for a recent head park request has not yet expired, -reading from /sys/block/*/device/unload_heads will report the number +reading from `/sys/block/*/device/unload_heads` will report the number of milliseconds remaining until normal operation will be resumed; otherwise, reading the unload_heads attribute will return 0. For example, do the following in order to park the heads of drive -/dev/sda and stop all I/O operations for five seconds: +/dev/sda and stop all I/O operations for five seconds:: -# echo 5000 > /sys/block/sda/device/unload_heads + # echo 5000 > /sys/block/sda/device/unload_heads -A simple +A simple:: -# cat /sys/block/sda/device/unload_heads + # cat /sys/block/sda/device/unload_heads will show you how many milliseconds are left before normal operation will be resumed.
@@ -112,9 +113,9 @@ unload_heads attribute. If you know that your device really does support the unload feature (for instance, because the vendor of your laptop or the hard drive itself told you so), then you can tell the kernel to enable the usage of this feature for that drive by writing -the special value -1 to the unload_heads attribute: +the special value -1 to the unload_heads attribute:: -# echo -1 > /sys/block/sda/device/unload_heads + # echo -1 > /sys/block/sda/device/unload_heads will enable the feature for /dev/sda, and giving -2 instead of -1 will disable it again.
@@ -135,6 +136,7 @@ for use. Please feel free to add projects that have been the victims of my ignorance. - http://www.thinkwiki.org/wiki/HDAPS + See this page for information about Linux support of the hard disk active protection system as implemented in IBM/Lenovo Thinkpads.
Documentation/laptops/index.rst new file +17 -0
@@ -0,0 +1,17 @@ +:orphan: + +============== +Laptop Drivers +============== + +.. toctree:: + :maxdepth: 1 + + asus-laptop + disk-shock-protection + laptop-mode + lg-laptop + sony-laptop + sonypi + thinkpad-acpi + toshiba_haps
Documentation/laptops/laptop-mode.rst renamed from Documentation/laptops/laptop-mode.txt +254 -255
663 lines not on this page · raw message
Documentation/laptops/sony-laptop.rst renamed from Documentation/laptops/sony-laptop.txt +44 -14
128 lines not on this page · raw message
Documentation/laptops/sonypi.rst renamed from Documentation/laptops/sonypi.txt +18 -10
@@ -1,11 +1,13 @@ +================================================== Sony Programmable I/O Control Device Driver Readme --------------------------------------------------- - Copyright (C) 2001-2004 Stelian Pop <[email protected]> - Copyright (C) 2001-2002 Alcôve <www.alcove.com> - Copyright (C) 2001 Michael Ashley <[email protected]> - Copyright (C) 2001 Junichi Morita <[email protected]> - Copyright (C) 2000 Takaya Kinjo <[email protected]> - Copyright (C) 2000 Andrew Tridgell <[email protected]> +================================================== + + - Copyright (C) 2001-2004 Stelian Pop <[email protected]> + - Copyright (C) 2001-2002 Alcôve <www.alcove.com> + - Copyright (C) 2001 Michael Ashley <[email protected]> + - Copyright (C) 2001 Junichi Morita <[email protected]> + - Copyright (C) 2000 Takaya Kinjo <[email protected]> + - Copyright (C) 2000 Andrew Tridgell <[email protected]> This driver enables access to the Sony Programmable I/O Control Device which can be found in many Sony Vaio laptops. Some newer Sony laptops (seems to be
@@ -14,6 +16,7 @@ sonypi device and are not supported at all by this driver. It will give access (through a user space utility) to some events those laptops generate, like: + - jogdial events (the small wheel on the side of Vaios) - capture button events (only on Vaio Picturebook series) - Fn keys
@@ -49,6 +52,7 @@ module argument syntax (<param>=<value> when passing the option to the module or sonypi.<param>=<value> on the kernel boot line when sonypi is statically linked into the kernel). Those options are: + =============== ======================================================= minor: minor number of the misc device /dev/sonypi, default is -1 (automatic allocation, see /proc/misc or kernel logs)
@@ -86,6 +90,8 @@ statically linked into the kernel). Those options are: will be tried. You can use the following bits to construct your own event mask (from drivers/char/sonypi.h): + + ======================== ====== SONYPI_JOGGER_MASK 0x0001 SONYPI_CAPTURE_MASK 0x0002 SONYPI_FNKEY_MASK 0x0004
@@ -100,22 +106,24 @@ statically linked into the kernel). Those options are: SONYPI_MEMORYSTICK_MASK 0x0800 SONYPI_BATTERY_MASK 0x1000 SONYPI_WIRELESS_MASK 0x2000 + ======================== ====== useinput: if set (which is the default) two input devices are created, one which interprets the jogdial events as mouse events, the other one which acts like a keyboard reporting the pressing of the special keys. + =============== ======================================================= Module use: ----------- In order to automatically load the sonypi module on use, you can put those -lines a configuration file in /etc/modprobe.d/: +lines a configuration file in /etc/modprobe.d/:: alias char-major-10-250 sonypi options sonypi minor=250 -This supposes the use of minor 250 for the sonypi device: +This supposes the use of minor 250 for the sonypi device:: # mknod /dev/sonypi c 10 250
@@ -148,5 +156,5 @@ Bugs: http://www.acc.umu.se/~erikw/program/smartdimmer-0.1.tar.bz2 - since all development was done by reverse engineering, there is - _absolutely no guarantee_ that this driver will not crash your + *absolutely no guarantee* that this driver will not crash your laptop. Permanently.
Documentation/laptops/thinkpad-acpi.rst renamed from Documentation/laptops/thinkpad-acpi.txt +219 -144
783 lines not on this page · raw message
Documentation/laptops/toshiba_haps.rst renamed from Documentation/laptops/toshiba_haps.txt +29 -18
75 lines not on this page · raw message
Documentation/sysctl/vm.txt +2 -2
@@ -102,7 +102,7 @@ Changing this takes effect whenever an application requests memory. block_dump block_dump enables block I/O debugging when set to a nonzero value. More -information on block I/O debugging is in Documentation/laptops/laptop-mode.txt. +information on block I/O debugging is in Documentation/laptops/laptop-mode.rst. ==============================================================
@@ -286,7 +286,7 @@ shared memory segment using hugetlb page. laptop_mode laptop_mode is a knob that controls "laptop mode". All the things that are -controlled by this knob are discussed in Documentation/laptops/laptop-mode.txt. +controlled by this knob are discussed in Documentation/laptops/laptop-mode.rst. ==============================================================
MAINTAINERS +1 -1
@@ -14756,7 +14756,7 @@ M: Mattia Dongili <[email protected]> L: [email protected] W: http://www.linux.it/~malattia/wiki/index.php/Sony_drivers S: Maintained -F: Documentation/laptops/sony-laptop.txt +F: Documentation/laptops/sony-laptop.rst F: drivers/char/sonypi.c F: drivers/platform/x86/sony-laptop.c F: include/linux/sony-laptop.h
drivers/char/Kconfig +1 -1
@@ -382,7 +382,7 @@ config SONYPI Device which can be found in many (all ?) Sony Vaio laptops. If you have one of those laptops, read - <file:Documentation/laptops/sonypi.txt>, and say Y or M here. + <file:Documentation/laptops/sonypi.rst>, and say Y or M here. To compile this driver as a module, choose M here: the module will be called sonypi.
drivers/platform/x86/Kconfig +2 -2
@@ -451,7 +451,7 @@ config SONY_LAPTOP screen brightness control, Fn keys and allows powering on/off some devices. - Read <file:Documentation/laptops/sony-laptop.txt> for more information. + Read <file:Documentation/laptops/sony-laptop.rst> for more information. config SONYPI_COMPAT bool "Sonypi compatibility"
@@ -503,7 +503,7 @@ config THINKPAD_ACPI support for Fn-Fx key combinations, Bluetooth control, video output switching, ThinkLight control, UltraBay eject and more. For more information about this driver see - <file:Documentation/laptops/thinkpad-acpi.txt> and + <file:Documentation/laptops/thinkpad-acpi.rst> and <http://ibm-acpi.sf.net/> . This driver was formerly known as ibm-acpi.
Signature · 1 line
2.21.0
PATCH v2 12/29 docs: xen-tpmfront.txt: convert it to .rst
In reply to Mauro Carvalho ChehabIn order to be able to add this file to the security book, we need first to convert it to reST.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
---
.../{xen-tpmfront.txt => xen-tpmfront.rst} | 103 ++++++++++--------
1 file changed, 58 insertions(+), 45 deletions(-)
rename Documentation/security/tpm/{xen-tpmfront.txt => xen-tpmfront.rst} (66%)Documentation/security/tpm/xen-tpmfront.rst renamed from Documentation/security/tpm/xen-tpmfront.txt +58 -45
@@ -1,4 +1,8 @@ +:orphan: + +============================= Virtual TPM interface for Xen +============================= Authors: Matthew Fioravante (JHUAPL), Daniel De Graaf (NSA)
@@ -6,7 +10,8 @@ This document describes the virtual Trusted Platform Module (vTPM) subsystem for Xen. The reader is assumed to have familiarity with building and installing Xen, Linux, and a basic understanding of the TPM and vTPM concepts. -INTRODUCTION +Introduction +------------ The goal of this work is to provide a TPM functionality to a virtual guest operating system (in Xen terms, a DomU). This allows programs to interact with
@@ -24,81 +29,89 @@ This mini-os vTPM subsystem was built on top of the previous vTPM work done by IBM and Intel corporation. -DESIGN OVERVIEW +Design Overview --------------- -The architecture of vTPM is described below: +The architecture of vTPM is described below:: -+------------------+ -| Linux DomU | ... -| | ^ | -| v | | -| xen-tpmfront | -+------------------+ - | ^ - v | -+------------------+ -| mini-os/tpmback | -| | ^ | -| v | | -| vtpm-stubdom | ... -| | ^ | -| v | | -| mini-os/tpmfront | -+------------------+ - | ^ - v | -+------------------+ -| mini-os/tpmback | -| | ^ | -| v | | -| vtpmmgr-stubdom | -| | ^ | -| v | | -| mini-os/tpm_tis | -+------------------+ - | ^ - v | -+------------------+ -| Hardware TPM | -+------------------+ + +------------------+ + | Linux DomU | ... + | | ^ | + | v | | + | xen-tpmfront | + +------------------+ + | ^ + v | + +------------------+ + | mini-os/tpmback | + | | ^ | + | v | | + | vtpm-stubdom | ... + | | ^ | + | v | | + | mini-os/tpmfront | + +------------------+ + | ^ + v | + +------------------+ + | mini-os/tpmback | + | | ^ | + | v | | + | vtpmmgr-stubdom | + | | ^ | + | v | | + | mini-os/tpm_tis | + +------------------+ + | ^ + v | + +------------------+ + | Hardware TPM | + +------------------+ - * Linux DomU: The Linux based guest that wants to use a vTPM. There may be +* Linux DomU: + The Linux based guest that wants to use a vTPM. There may be more than one of these. - * xen-tpmfront.ko: Linux kernel virtual TPM frontend driver. This driver +* xen-tpmfront.ko: + Linux kernel virtual TPM frontend driver. This driver provides vTPM access to a Linux-based DomU. - * mini-os/tpmback: Mini-os TPM backend driver. The Linux frontend driver +* mini-os/tpmback: + Mini-os TPM backend driver. The Linux frontend driver connects to this backend driver to facilitate communications between the Linux DomU and its vTPM. This driver is also used by vtpmmgr-stubdom to communicate with vtpm-stubdom. - * vtpm-stubdom: A mini-os stub domain that implements a vTPM. There is a +* vtpm-stubdom: + A mini-os stub domain that implements a vTPM. There is a one to one mapping between running vtpm-stubdom instances and logical vtpms on the system. The vTPM Platform Configuration Registers (PCRs) are normally all initialized to zero. - * mini-os/tpmfront: Mini-os TPM frontend driver. The vTPM mini-os domain +* mini-os/tpmfront: + Mini-os TPM frontend driver. The vTPM mini-os domain vtpm-stubdom uses this driver to communicate with vtpmmgr-stubdom. This driver is also used in mini-os domains such as pv-grub that talk to the vTPM domain. - * vtpmmgr-stubdom: A mini-os domain that implements the vTPM manager. There is +* vtpmmgr-stubdom: + A mini-os domain that implements the vTPM manager. There is only one vTPM manager and it should be running during the entire lifetime of the machine. This domain regulates access to the physical TPM on the system and secures the persistent state of each vTPM. - * mini-os/tpm_tis: Mini-os TPM version 1.2 TPM Interface Specification (TIS) +* mini-os/tpm_tis: + Mini-os TPM version 1.2 TPM Interface Specification (TIS) driver. This driver used by vtpmmgr-stubdom to talk directly to the hardware TPM. Communication is facilitated by mapping hardware memory pages into vtpmmgr-stubdom. - * Hardware TPM: The physical TPM that is soldered onto the motherboard. +* Hardware TPM: + The physical TPM that is soldered onto the motherboard. -INTEGRATION WITH XEN +Integration With Xen -------------------- Support for the vTPM driver was added in Xen using the libxl toolstack in Xen
Signature · 1 line
2.21.0
PATCH v2 25/29 docs: md: convert to ReST
In reply to Mauro Carvalho ChehabRename the md documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/md/index.rst | 12 ++
.../md/{md-cluster.txt => md-cluster.rst} | 188 ++++++++++++------
.../md/{raid5-cache.txt => raid5-cache.rst} | 28 +--
.../md/{raid5-ppl.txt => raid5-ppl.rst} | 2 +
4 files changed, 153 insertions(+), 77 deletions(-)
create mode 100644 Documentation/md/index.rst
rename Documentation/md/{md-cluster.txt => md-cluster.rst} (68%)
rename Documentation/md/{raid5-cache.txt => raid5-cache.rst} (92%)
rename Documentation/md/{raid5-ppl.txt => raid5-ppl.rst} (98%)Documentation/md/index.rst new file +12 -0
@@ -0,0 +1,12 @@ +:orphan: + +==== +RAID +==== + +.. toctree:: + :maxdepth: 1 + + md-cluster + raid5-cache + raid5-ppl
Documentation/md/md-cluster.rst renamed from Documentation/md/md-cluster.txt +124 -64
390 lines not on this page · raw message
Documentation/md/raid5-cache.rst renamed from Documentation/md/raid5-cache.txt +15 -13
@@ -1,4 +1,6 @@ -RAID5 cache +================ +RAID 4/5/6 cache +================ Raid 4/5/6 could include an extra disk for data cache besides normal RAID disks. The role of RAID disks isn't changed with the cache disk. The cache disk
@@ -6,19 +8,19 @@ caches data to the RAID disks. The cache can be in write-through (supported since 4.4) or write-back mode (supported since 4.10). mdadm (supported since 3.4) has a new option '--write-journal' to create array with cache. Please refer to mdadm manual for details. By default (RAID array starts), the cache is -in write-through mode. A user can switch it to write-back mode by: +in write-through mode. A user can switch it to write-back mode by:: -echo "write-back" > /sys/block/md0/md/journal_mode + echo "write-back" > /sys/block/md0/md/journal_mode -And switch it back to write-through mode by: +And switch it back to write-through mode by:: -echo "write-through" > /sys/block/md0/md/journal_mode + echo "write-through" > /sys/block/md0/md/journal_mode In both modes, all writes to the array will hit cache disk first. This means the cache disk must be fast and sustainable. -------------------------------------- -write-through mode: +write-through mode +================== This mode mainly fixes the 'write hole' issue. For RAID 4/5/6 array, an unclean shutdown can cause data in some stripes to not be in consistent state, eg, data
@@ -42,8 +44,8 @@ exposed to 'write hole' again. In write-through mode, the cache disk isn't required to be big. Several hundreds megabytes are enough. --------------------------------------- -write-back mode: +write-back mode +=============== write-back mode fixes the 'write hole' issue too, since all write data is cached on cache disk. But the main goal of 'write-back' cache is to speed up
@@ -64,16 +66,16 @@ data loss. In write-back mode, MD also caches data in memory. The memory cache includes the same data stored on cache disk, so a power loss doesn't cause data loss. The memory cache size has performance impact for the array. It's recommended -the size is big. A user can configure the size by: +the size is big. A user can configure the size by:: -echo "2048" > /sys/block/md0/md/stripe_cache_size + echo "2048" > /sys/block/md0/md/stripe_cache_size Too small cache disk will make the write aggregation less efficient in this mode depending on the workloads. It's recommended to use a cache disk with at least several gigabytes size in write-back mode. --------------------------------------- -The implementation: +The implementation +================== The write-through and write-back cache use the same disk format. The cache disk is organized as a simple write log. The log consists of 'meta data' and 'data'
Documentation/md/raid5-ppl.rst renamed from Documentation/md/raid5-ppl.txt +2 -0
@@ -1,4 +1,6 @@ +================== Partial Parity Log +================== Partial Parity Log (PPL) is a feature available for RAID5 arrays. The issue addressed by PPL is that after a dirty shutdown, parity of a particular stripe
Signature · 1 line
2.21.0
PATCH v2 27/29 docs: nvdimm: convert to ReST
In reply to Mauro Carvalho ChehabRename the nvdimm documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/nvdimm/{btt.txt => btt.rst} | 140 ++---
Documentation/nvdimm/index.rst | 12 +
.../nvdimm/{nvdimm.txt => nvdimm.rst} | 518 ++++++++++--------
.../nvdimm/{security.txt => security.rst} | 4 +-
drivers/nvdimm/Kconfig | 2 +-
5 files changed, 387 insertions(+), 289 deletions(-)
rename Documentation/nvdimm/{btt.txt => btt.rst} (71%)
create mode 100644 Documentation/nvdimm/index.rst
rename Documentation/nvdimm/{nvdimm.txt => nvdimm.rst} (60%)
rename Documentation/nvdimm/{security.txt => security.rst} (99%)Documentation/nvdimm/btt.rst renamed from Documentation/nvdimm/btt.txt +76 -64
@@ -1,9 +1,10 @@ +============================= BTT - Block Translation Table ============================= 1. Introduction ---------------- +=============== Persistent memory based storage is able to perform IO at byte (or more accurately, cache line) granularity. However, we often want to expose such
@@ -25,7 +26,7 @@ provides atomic sector updates. 2. Static Layout ----------------- +================ The underlying storage on which a BTT can be laid out is not limited in any way. The BTT, however, splits the available space into chunks of up to 512 GiB,
@@ -33,43 +34,43 @@ called "Arenas". Each arena follows the same layout for its metadata, and all references in an arena are internal to it (with the exception of one field that points to the -next arena). The following depicts the "On-disk" metadata layout: +next arena). The following depicts the "On-disk" metadata layout:: - Backing Store +-------> Arena -+---------------+ | +------------------+ -| | | | Arena info block | -| Arena 0 +---+ | 4K | -| 512G | +------------------+ -| | | | -+---------------+ | | -| | | | -| Arena 1 | | Data Blocks | -| 512G | | | -| | | | -+---------------+ | | -| . | | | -| . | | | -| . | | | -| | | | -| | | | -+---------------+ +------------------+ - | | - | BTT Map | - | | - | | - +------------------+ - | | - | BTT Flog | - | | - +------------------+ - | Info block copy | - | 4K | - +------------------+ + Backing Store +-------> Arena + +---------------+ | +------------------+ + | | | | Arena info block | + | Arena 0 +---+ | 4K | + | 512G | +------------------+ + | | | | + +---------------+ | | + | | | | + | Arena 1 | | Data Blocks | + | 512G | | | + | | | | + +---------------+ | | + | . | | | + | . | | | + | . | | | + | | | | + | | | | + +---------------+ +------------------+ + | | + | BTT Map | + | | + | | + +------------------+ + | | + | BTT Flog | + | | + +------------------+ + | Info block copy | + | 4K | + +------------------+ 3. Theory of Operation ----------------------- +====================== a. The BTT Map
@@ -79,31 +80,37 @@ The map is a simple lookup/indirection table that maps an LBA to an internal block. Each map entry is 32 bits. The two most significant bits are special flags, and the remaining form the internal block number. +======== ============================================================= Bit Description -31 - 30 : Error and Zero flags - Used in the following way: - Bit Description - 31 30 - ----------------------------------------------------------------------- - 00 Initial state. Reads return zeroes; Premap = Postmap - 01 Zero state: Reads return zeroes - 10 Error state: Reads fail; Writes clear 'E' bit - 11 Normal Block – has valid postmap +======== ============================================================= +31 - 30 Error and Zero flags - Used in the following way: + == == ==================================================== + 31 30 Description + == == ==================================================== + 0 0 Initial state. Reads return zeroes; Premap = Postmap + 0 1 Zero state: Reads return zeroes + 1 0 Error state: Reads fail; Writes clear 'E' bit + 1 1 Normal Block – has valid postmap + == == ==================================================== -29 - 0 : Mappings to internal 'postmap' blocks +29 - 0 Mappings to internal 'postmap' blocks +======== ============================================================= Some of the terminology that will be subsequently used: -External LBA : LBA as made visible to upper layers. -ABA : Arena Block Address - Block offset/number within an arena -Premap ABA : The block offset into an arena, which was decided upon by range +============ ================================================================ +External LBA LBA as made visible to upper layers. +ABA Arena Block Address - Block offset/number within an arena +Premap ABA The block offset into an arena, which was decided upon by range checking the External LBA -Postmap ABA : The block number in the "Data Blocks" area obtained after +Postmap ABA The block number in the "Data Blocks" area obtained after indirection from the map -nfree : The number of free blocks that are maintained at any given time. +nfree The number of free blocks that are maintained at any given time. This is the number of concurrent writes that can happen to the arena. +============ ================================================================ For example, after adding a BTT, we surface a disk of 1024G. We get a read for
@@ -121,19 +128,21 @@ i.e. Every write goes to a "free" block. A running list of free blocks is maintained in the form of the BTT flog. 'Flog' is a combination of the words "free list" and "log". The flog contains 'nfree' entries, and an entry contains: -lba : The premap ABA that is being written to -old_map : The old postmap ABA - after 'this' write completes, this will be a +======== ===================================================================== +lba The premap ABA that is being written to +old_map The old postmap ABA - after 'this' write completes, this will be a free block. -new_map : The new postmap ABA. The map will up updated to reflect this +new_map The new postmap ABA. The map will up updated to reflect this lba->postmap_aba mapping, but we log it here in case we have to recover. -seq : Sequence number to mark which of the 2 sections of this flog entry is +seq Sequence number to mark which of the 2 sections of this flog entry is valid/newest. It cycles between 01->10->11->01 (binary) under normal operation, with 00 indicating an uninitialized state. -lba' : alternate lba entry -old_map': alternate old postmap entry -new_map': alternate new postmap entry -seq' : alternate sequence number. +lba' alternate lba entry +old_map' alternate old postmap entry +new_map' alternate new postmap entry +seq' alternate sequence number. +======== ===================================================================== Each of the above fields is 32-bit, making one entry 32 bytes. Entries are also padded to 64 bytes to avoid cache line sharing or aliasing. Flog updates are
@@ -147,8 +156,10 @@ c. The concept of lanes While 'nfree' describes the number of concurrent IOs an arena can process concurrently, 'nlanes' is the number of IOs the BTT device as a whole can -process. - nlanes = min(nfree, num_cpus) +process:: + + nlanes = min(nfree, num_cpus) + A lane number is obtained at the start of any IO, and is used for indexing into all the on-disk and in-memory data structures for the duration of the IO. If there are more CPUs than the max number of available lanes, than lanes are
@@ -180,10 +191,10 @@ e. In-memory data structure: map locks -------------------------------------- Consider a case where two writer threads are writing to the same LBA. There can -be a race in the following sequence of steps: +be a race in the following sequence of steps:: -free[lane] = map[premap_aba] -map[premap_aba] = postmap_aba + free[lane] = map[premap_aba] + map[premap_aba] = postmap_aba Both threads can update their respective free[lane] with the same old, freed postmap_aba. This has made the layout inconsistent by losing a free entry, and
@@ -202,6 +213,7 @@ On startup, we analyze the BTT flog to create our list of free blocks. We walk through all the entries, and for each lane, of the set of two possible 'sections', we always look at the most recent one only (based on the sequence number). The reconstruction rules/steps are simple: + - Read map[log_entry.lba]. - If log_entry.new matches the map entry, then log_entry.old is free. - If log_entry.new does not match the map entry, then log_entry.new is free.
@@ -228,7 +240,7 @@ Write: 1. Convert external LBA to Arena number + pre-map ABA 2. Get a lane (and take lane_lock) 3. Use lane to index into in-memory free list and obtain a new block, next flog - index, next sequence number + index, next sequence number 4. Scan the RTT to check if free block is present, and spin/wait if it is. 5. Write data to this free block 6. Read map to get the existing post-map ABA entry for this pre-map ABA
@@ -245,6 +257,7 @@ Write: An arena would be in an error state if any of the metadata is corrupted irrecoverably, either due to a bug or a media error. The following conditions indicate an error: + - Info block checksum does not match (and recovering from the copy also fails) - All internal available blocks are not uniquely and entirely addressed by the sum of mapped blocks and free blocks (from the BTT flog).
@@ -263,11 +276,10 @@ The BTT can be set up on any disk (namespace) exposed by the libnvdimm subsystem (pmem, or blk mode). The easiest way to set up such a namespace is using the 'ndctl' utility [1]: -For example, the ndctl command line to setup a btt with a 4k sector size is: +For example, the ndctl command line to setup a btt with a 4k sector size is:: ndctl create-namespace -f -e namespace0.0 -m sector -l 4k See ndctl create-namespace --help for more options. [1]: https://github.com/pmem/ndctl -
Documentation/nvdimm/index.rst new file +12 -0
@@ -0,0 +1,12 @@ +:orphan: + +=================================== +Non-Volatile Memory Device (NVDIMM) +=================================== + +.. toctree:: + :maxdepth: 1 + + nvdimm + btt + security
Documentation/nvdimm/nvdimm.rst renamed from Documentation/nvdimm/nvdimm.txt +295 -223
803 lines not on this page · raw message
Documentation/nvdimm/security.rst renamed from Documentation/nvdimm/security.txt +3 -1
@@ -1,4 +1,5 @@ -NVDIMM SECURITY +=============== +NVDIMM Security =============== 1. Introduction
@@ -138,4 +139,5 @@ This command is only available when the master security is enabled, indicated by the extended security status. [1]: http://pmem.io/documents/NVDIMM_DSM_Interface-V1.8.pdf + [2]: http://www.t13.org/documents/UploadedDocuments/docs2006/e05179r4-ACS-SecurityClarifications.pdf
drivers/nvdimm/Kconfig +1 -1
@@ -33,7 +33,7 @@ config BLK_DEV_PMEM Documentation/admin-guide/kernel-parameters.rst). This driver converts these persistent memory ranges into block devices that are capable of DAX (direct-access) file system mappings. See - Documentation/nvdimm/nvdimm.txt for more details. + Documentation/nvdimm/nvdimm.rst for more details. Say Y if you want to use an NVDIMM
Signature · 6 lines
2.21.0 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
PATCH v2 3/29 docs: lp855x-driver.txt: convert to ReST and move to kernel-api
In reply to Mauro Carvalho ChehabThis small file seems to be an attempt to start documenting backlight drivers.
It contains descriptions of the controls for the driver with could sound as an somewhat user-faced description, but it's main focus is to describe, instead, the data that should be passed via platform data and some driver-specific stuff.
While this is not part of the driver-api book, mark it as :orphan:, in order to avoid build warnings.
--- Documentation/backlight/lp855x-driver.rst | 83 +++++++++++++++++++++++ Documentation/backlight/lp855x-driver.txt | 66 ------------------ MAINTAINERS | 2 +- 3 files changed, 84 insertions(+), 67 deletions(-) create mode 100644 Documentation/backlight/lp855x-driver.rst delete mode 100644 Documentation/backlight/lp855x-driver.txt
Documentation/backlight/lp855x-driver.rst new file +83 -0
@@ -0,0 +1,83 @@ +:orphan: + +==================== +Kernel driver lp855x +==================== + +Backlight driver for LP855x ICs + +Supported chips: + + Texas Instruments LP8550, LP8551, LP8552, LP8553, LP8555, LP8556 and + LP8557 + +Author: Milo(Woogyom) Kim <[email protected]> + +Description +----------- + +* Brightness control + + Brightness can be controlled by the pwm input or the i2c command. + The lp855x driver supports both cases. + +* Device attributes + + 1) bl_ctl_mode + + Backlight control mode. + + Value: pwm based or register based + + 2) chip_id + + The lp855x chip id. + + Value: lp8550/lp8551/lp8552/lp8553/lp8555/lp8556/lp8557 + +Platform data for lp855x +------------------------ + +For supporting platform specific data, the lp855x platform data can be used. + +* name: + Backlight driver name. If it is not defined, default name is set. +* device_control: + Value of DEVICE CONTROL register. +* initial_brightness: + Initial value of backlight brightness. +* period_ns: + Platform specific PWM period value. unit is nano. + Only valid when brightness is pwm input mode. +* size_program: + Total size of lp855x_rom_data. +* rom_data: + List of new eeprom/eprom registers. + +Examples +======== + +1) lp8552 platform data: i2c register mode with new eeprom data:: + + #define EEPROM_A5_ADDR 0xA5 + #define EEPROM_A5_VAL 0x4f /* EN_VSYNC=0 */ + + static struct lp855x_rom_data lp8552_eeprom_arr[] = { + {EEPROM_A5_ADDR, EEPROM_A5_VAL}, + }; + + static struct lp855x_platform_data lp8552_pdata = { + .name = "lcd-bl", + .device_control = I2C_CONFIG(LP8552), + .initial_brightness = INITIAL_BRT, + .size_program = ARRAY_SIZE(lp8552_eeprom_arr), + .rom_data = lp8552_eeprom_arr, + }; + +2) lp8556 platform data: pwm input mode with default rom data:: + + static struct lp855x_platform_data lp8556_pdata = { + .device_control = PWM_CONFIG(LP8556), + .initial_brightness = INITIAL_BRT, + .period_ns = 1000000, + };
Documentation/backlight/lp855x-driver.txt deleted +0 -66
66 lines not on this page · raw message
MAINTAINERS +1 -1
@@ -15831,7 +15831,7 @@ F: sound/soc/codecs/isabelle* TI LP855x BACKLIGHT DRIVER M: Milo Kim <[email protected]> S: Maintained -F: Documentation/backlight/lp855x-driver.txt +F: Documentation/backlight/lp855x-driver.rst F: drivers/video/backlight/lp855x_bl.c F: include/linux/platform_data/lp855x.h
Signature · 1 line
2.21.0
PATCH v2 26/29 docs: mtd: convert to ReST
In reply to Mauro Carvalho ChehabRename the mtd documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
It should be noticed that Sphinx doesn't handle very well URLs with dots in the middle. Thankfully, internally, the '.' char is translated to %2E, so we can jus use %2E instead of dots, and this will work fine on both text and processed files.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/mtd/index.rst | 12 +
.../mtd/{intel-spi.txt => intel-spi.rst} | 46 +-
.../mtd/{nand_ecc.txt => nand_ecc.rst} | 481 ++++++++++--------
.../mtd/{spi-nor.txt => spi-nor.rst} | 7 +-
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
5 files changed, 306 insertions(+), 242 deletions(-)
create mode 100644 Documentation/mtd/index.rst
rename Documentation/mtd/{intel-spi.txt => intel-spi.rst} (71%)
rename Documentation/mtd/{nand_ecc.txt => nand_ecc.rst} (67%)
rename Documentation/mtd/{spi-nor.txt => spi-nor.rst} (94%)Documentation/mtd/index.rst new file +12 -0
@@ -0,0 +1,12 @@ +:orphan: + +============================== +Memory Technology Device (MTD) +============================== + +.. toctree:: + :maxdepth: 1 + + intel-spi + nand_ecc + spi-nor
Documentation/mtd/intel-spi.rst renamed from Documentation/mtd/intel-spi.txt +24 -22
79 lines not on this page · raw message
Documentation/mtd/nand_ecc.rst renamed from Documentation/mtd/nand_ecc.txt +265 -216
640 lines not on this page · raw message
Documentation/mtd/spi-nor.rst renamed from Documentation/mtd/spi-nor.txt +4 -3
@@ -1,5 +1,6 @@ - SPI NOR framework - ============================================ +================= +SPI NOR framework +================= Part I - Why do we need this framework? ---------------------------------------
@@ -23,7 +24,7 @@ This framework just adds a new layer between the MTD and the SPI bus driver. With this new layer, the SPI NOR controller driver does not depend on the m25p80 code anymore. - Before this framework, the layer is like: +Before this framework, the layer is like:: MTD ------------------------
drivers/mtd/nand/raw/nand_ecc.c +1 -1
@@ -11,7 +11,7 @@* Thomas Gleixner ([email protected]) * * Information on how this algorithm works and how it was developed -* can be found in Documentation/mtd/nand_ecc.txt +* can be found in Documentation/mtd/nand_ecc.rst */ #include <linux/types.h>
Signature · 6 lines
2.21.0 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
PATCH v2 8/29 docs: early-userspace: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabThe two files there describes a Kernel API feature, used to support early userspace stuff. Prepare for moving them to the kernel API book by converting to ReST format.
The conversion itself was quite trivial: just add/mark a few titles as such, add a literal block markup, add a table markup and a few blank lines, in order to make Sphinx to properly parse it.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../{buffer-format.txt => buffer-format.rst} | 19 +++++++++++++------
.../{README => early_userspace_support.rst} | 3 +++
Documentation/early-userspace/index.rst | 18 ++++++++++++++++++
Documentation/filesystems/nfs/nfsroot.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.txt | 4 ++--
usr/Kconfig | 2 +-
6 files changed, 38 insertions(+), 10 deletions(-)
rename Documentation/early-userspace/{buffer-format.txt => buffer-format.rst} (91%)
rename Documentation/early-userspace/{README => early_userspace_support.rst} (99%)
create mode 100644 Documentation/early-userspace/index.rstDocumentation/early-userspace/buffer-format.rst renamed from Documentation/early-userspace/buffer-format.txt +13 -6
@@ -1,8 +1,10 @@ - initramfs buffer format - ----------------------- +======================= +initramfs buffer format +======================= - Al Viro, H. Peter Anvin - Last revision: 2002-01-13 +Al Viro, H. Peter Anvin + +Last revision: 2002-01-13 Starting with kernel 2.5.x, the old "initial ramdisk" protocol is getting {replaced/complemented} with the new "initial ramfs"
@@ -18,7 +20,8 @@ archive can be compressed using gzip(1). One valid version of an initramfs buffer is thus a single .cpio.gz file. The full format of the initramfs buffer is defined by the following -grammar, where: +grammar, where:: + * is used to indicate "0 or more occurrences of" (|) indicates alternatives + indicates concatenation
@@ -49,7 +52,9 @@ hexadecimal ASCII numbers fully padded with '0' on the left to the full width of the field, for example, the integer 4780 is represented by the ASCII string "000012ac"): +============= ================== ============================================== Field name Field size Meaning +============= ================== ============================================== c_magic 6 bytes The string "070701" or "070702" c_ino 8 bytes File inode number c_mode 8 bytes File mode and permissions
@@ -65,6 +70,7 @@ c_rmin 8 bytes Minor part of device node reference c_namesize 8 bytes Length of filename, including final \0 c_chksum 8 bytes Checksum of data field if c_magic is 070702; otherwise zero +============= ================== ============================================== The c_mode field matches the contents of st_mode returned by stat(2) on Linux, and encodes the file type and file permissions.
@@ -82,7 +88,8 @@ If the filename is "TRAILER!!!" this is actually an end-of-archive marker; the c_filesize for an end-of-archive marker must be zero. -*** Handling of hard links +Handling of hard links +====================== When a nondirectory with c_nlink > 1 is seen, the (c_maj,c_min,c_ino) tuple is looked up in a tuple buffer. If not found, it is entered in
Documentation/early-userspace/early_userspace_support.rst renamed from Documentation/early-userspace/README +3 -0
@@ -1,3 +1,4 @@ +======================= Early userspace support =======================
@@ -26,6 +27,7 @@ archive to be used as the image or have the kernel build process build the image from specifications. CPIO ARCHIVE method +------------------- You can create a cpio archive that contains the early userspace image. Your cpio archive should be specified in CONFIG_INITRAMFS_SOURCE and it
@@ -34,6 +36,7 @@ CONFIG_INITRAMFS_SOURCE and directory and file names are not allowed in combination with a cpio archive. IMAGE BUILDING method +--------------------- The kernel build process can also build an early userspace image from source parts rather than supplying a cpio archive. This method provides
Documentation/early-userspace/index.rst new file +18 -0
@@ -0,0 +1,18 @@ +:orphan: + +=============== +Early Userspace +=============== + +.. toctree:: + :maxdepth: 1 + + early_userspace_support + buffer-format + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex`
Documentation/filesystems/nfs/nfsroot.txt +1 -1
@@ -239,7 +239,7 @@ rdinit=<executable file> A description of the process of mounting the root file system can be found in: - Documentation/early-userspace/README + Documentation/early-userspace/early_userspace_support.rst
Documentation/filesystems/ramfs-rootfs-initramfs.txt +2 -2
@@ -105,7 +105,7 @@ All this differs from the old initrd in several ways: - The old initrd file was a gzipped filesystem image (in some file format, such as ext2, that needed a driver built into the kernel), while the new initramfs archive is a gzipped cpio archive (like tar only simpler, - see cpio(1) and Documentation/early-userspace/buffer-format.txt). The + see cpio(1) and Documentation/early-userspace/buffer-format.rst). The kernel's cpio extraction code is not only extremely small, it's also __init text and data that can be discarded during the boot process.
@@ -159,7 +159,7 @@ One advantage of the configuration file is that root access is not required to set permissions or create device nodes in the new archive. (Note that those two example "file" entries expect to find files named "init.sh" and "busybox" in a directory called "initramfs", under the linux-2.6.* directory. See -Documentation/early-userspace/README for more details.) +Documentation/early-userspace/early_userspace_support.rst for more details.) The kernel does not depend on external cpio tools. If you specify a directory instead of a configuration file, the kernel's build infrastructure
usr/Kconfig +1 -1
@@ -18,7 +18,7 @@ config INITRAMFS_SOURCE When multiple directories and files are specified then the initramfs image will be the aggregate of all of them. - See <file:Documentation/early-userspace/README> for more details. + See <file:Documentation/early-userspace/early_userspace_support.rst> for more details. If you are not sure, leave it blank.
Signature · 1 line
2.21.0
PATCH v2 7/29 docs: pti_intel_mid.txt: convert it to pti_intel_mid.rst
In reply to Mauro Carvalho ChehabConvert this small file to ReST format and rename it.
Most of the conversion were related to adjusting whitespaces in order for each section to be properly parsed.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
--- Documentation/pti/pti_intel_mid.rst | 106 ++++++++++++++++++++++++++++ Documentation/pti/pti_intel_mid.txt | 99 -------------------------- 2 files changed, 106 insertions(+), 99 deletions(-) create mode 100644 Documentation/pti/pti_intel_mid.rst delete mode 100644 Documentation/pti/pti_intel_mid.txt
Documentation/pti/pti_intel_mid.rst new file +106 -0
@@ -0,0 +1,106 @@ +:orphan: + +============= +Intel MID PTI +============= + +The Intel MID PTI project is HW implemented in Intel Atom +system-on-a-chip designs based on the Parallel Trace +Interface for MIPI P1149.7 cJTAG standard. The kernel solution +for this platform involves the following files:: + + ./include/linux/pti.h + ./drivers/.../n_tracesink.h + ./drivers/.../n_tracerouter.c + ./drivers/.../n_tracesink.c + ./drivers/.../pti.c + +pti.c is the driver that enables various debugging features +popular on platforms from certain mobile manufacturers. +n_tracerouter.c and n_tracesink.c allow extra system information to +be collected and routed to the pti driver, such as trace +debugging data from a modem. Although n_tracerouter +and n_tracesink are a part of the complete PTI solution, +these two line disciplines can work separately from +pti.c and route any data stream from one /dev/tty node +to another /dev/tty node via kernel-space. This provides +a stable, reliable connection that will not break unless +the user-space application shuts down (plus avoids +kernel->user->kernel context switch overheads of routing +data). + +An example debugging usage for this driver system: + + * Hook /dev/ttyPTI0 to syslogd. Opening this port will also start + a console device to further capture debugging messages to PTI. + * Hook /dev/ttyPTI1 to modem debugging data to write to PTI HW. + This is where n_tracerouter and n_tracesink are used. + * Hook /dev/pti to a user-level debugging application for writing + to PTI HW. + * `Use mipi_` Kernel Driver API in other device drivers for + debugging to PTI by first requesting a PTI write address via + mipi_request_masterchannel(1). + +Below is example pseudo-code on how a 'privileged' application +can hook up n_tracerouter and n_tracesink to any tty on +a system. 'Privileged' means the application has enough +privileges to successfully manipulate the ldisc drivers +but is not just blindly executing as 'root'. Keep in mind +the use of ioctl(,TIOCSETD,) is not specific to the n_tracerouter +and n_tracesink line discpline drivers but is a generic +operation for a program to use a line discpline driver +on a tty port other than the default n_tty:: + + /////////// To hook up n_tracerouter and n_tracesink ///////// + + // Note that n_tracerouter depends on n_tracesink. + #include <errno.h> + #define ONE_TTY "/dev/ttyOne" + #define TWO_TTY "/dev/ttyTwo" + + // needed global to hand onto ldisc connection + static int g_fd_source = -1; + static int g_fd_sink = -1; + + // these two vars used to grab LDISC values from loaded ldisc drivers + // in OS. Look at /proc/tty/ldiscs to get the right numbers from + // the ldiscs loaded in the system. + int source_ldisc_num, sink_ldisc_num = -1; + int retval; + + g_fd_source = open(ONE_TTY, O_RDWR); // must be R/W + g_fd_sink = open(TWO_TTY, O_RDWR); // must be R/W + + if (g_fd_source <= 0) || (g_fd_sink <= 0) { + // doubt you'll want to use these exact error lines of code + printf("Error on open(). errno: %d\n",errno); + return errno; + } + + retval = ioctl(g_fd_sink, TIOCSETD, &sink_ldisc_num); + if (retval < 0) { + printf("Error on ioctl(). errno: %d\n", errno); + return errno; + } + + retval = ioctl(g_fd_source, TIOCSETD, &source_ldisc_num); + if (retval < 0) { + printf("Error on ioctl(). errno: %d\n", errno); + return errno; + } + + /////////// To disconnect n_tracerouter and n_tracesink //////// + + // First make sure data through the ldiscs has stopped. + + // Second, disconnect ldiscs. This provides a + // little cleaner shutdown on tty stack. + sink_ldisc_num = 0; + source_ldisc_num = 0; + ioctl(g_fd_uart, TIOCSETD, &sink_ldisc_num); + ioctl(g_fd_gadget, TIOCSETD, &source_ldisc_num); + + // Three, program closes connection, and cleanup: + close(g_fd_uart); + close(g_fd_gadget); + g_fd_uart = g_fd_gadget = NULL;
Documentation/pti/pti_intel_mid.txt deleted +0 -99
99 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v2 24/29 docs: nfc: convert to ReST
In reply to Mauro Carvalho ChehabRename the nfc documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/nfc/index.rst | 11 ++
.../nfc/{nfc-hci.txt => nfc-hci.rst} | 163 ++++++++++--------
.../nfc/{nfc-pn544.txt => nfc-pn544.rst} | 6 +-
3 files changed, 107 insertions(+), 73 deletions(-)
create mode 100644 Documentation/nfc/index.rst
rename Documentation/nfc/{nfc-hci.txt => nfc-hci.rst} (71%)
rename Documentation/nfc/{nfc-pn544.txt => nfc-pn544.rst} (82%)Documentation/nfc/index.rst new file +11 -0
@@ -0,0 +1,11 @@ +:orphan: + +======================== +Near Field Communication +======================== + +.. toctree:: + :maxdepth: 1 + + nfc-hci + nfc-pn544
Documentation/nfc/nfc-hci.rst renamed from Documentation/nfc/nfc-hci.txt +92 -71
264 lines not on this page · raw message
Documentation/nfc/nfc-pn544.rst renamed from Documentation/nfc/nfc-pn544.txt +4 -2
@@ -1,5 +1,7 @@ -Kernel driver for the NXP Semiconductors PN544 Near Field -Communication chip +============================================================================ +Kernel driver for the NXP Semiconductors PN544 Near Field Communication chip +============================================================================ + General -------
Signature · 1 line
2.21.0
PATCH v2 5/29 docs: cma/debugfs.txt: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabThe debugfs interface for CMA should be there together with other mm-related documents.
Convert this small file to ReST and move it to its rightful place.
The conversion is actually quite simple: just add a title for the document. In order to make it to look better for the audience, also mark the "echo" command as a literal block.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
---
Documentation/cma/{debugfs.txt => debugfs.rst} | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
rename Documentation/cma/{debugfs.txt => debugfs.rst} (91%)Documentation/cma/debugfs.rst renamed from Documentation/cma/debugfs.txt +7 -1
@@ -1,3 +1,9 @@ +:orphan: + +===================== +CMA Debugfs Interface +===================== + The CMA debugfs interface is useful to retrieve basic information out of the different CMA areas and to test allocation/release in each of the areas.
@@ -12,7 +18,7 @@ The structure of the files created under that directory is as follows: - [RO] count: Amount of memory in the CMA area. - [RO] order_per_bit: Order of pages represented by one bit. - [RO] bitmap: The bitmap of page states in the zone. - - [WO] alloc: Allocate N pages from that CMA area. For example: + - [WO] alloc: Allocate N pages from that CMA area. For example:: echo 5 > <debugfs>/cma/cma-2/alloc
Signature · 1 line
2.21.0
PATCH v2 2/29 docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabThis small text file describes the usage of parallel port LCD displays from userspace PoV. So, a good candidate for the admin guide.
While this is not part of the admin-guide book, mark it as :orphan:, in order to avoid build warnings.
---
.../{lcd-panel-cgram.txt => lcd-panel-cgram.rst} | 9 +++++++--
MAINTAINERS | 2 +-
2 files changed, 8 insertions(+), 3 deletions(-)
rename Documentation/auxdisplay/{lcd-panel-cgram.txt => lcd-panel-cgram.rst} (88%)Documentation/auxdisplay/lcd-panel-cgram.rst renamed from Documentation/auxdisplay/lcd-panel-cgram.txt +7 -2
@@ -1,3 +1,9 @@ +:orphan: + +====================================== +Parallel port LCD/Keypad Panel support +====================================== + Some LCDs allow you to define up to 8 characters, mapped to ASCII characters 0 to 7. The escape code to define a new character is '\e[LG' followed by one digit from 0 to 7, representing the character
@@ -7,7 +13,7 @@ illuminated pixel with LSB on the right. Lines are numbered from the top of the character to the bottom. On a 5x7 matrix, only the 5 lower bits of the 7 first bytes are used for each character. If the string is incomplete, only complete lines will be redefined. Here are some -examples : +examples:: printf "\e[LG0010101050D1F0C04;" => 0 = [enter] printf "\e[LG1040E1F0000000000;" => 1 = [up]
@@ -21,4 +27,3 @@ examples : printf "\e[LG00002061E1E060200;" => small speaker Willy -
MAINTAINERS +1 -1
@@ -11935,7 +11935,7 @@ PARALLEL LCD/KEYPAD PANEL DRIVER M: Willy Tarreau <[email protected]> M: Ksenija Stanojevic <[email protected]> S: Odd Fixes -F: Documentation/auxdisplay/lcd-panel-cgram.txt +F: Documentation/auxdisplay/lcd-panel-cgram.rst F: drivers/auxdisplay/panel.c PARALLEL PORT SUBSYSTEM
Signature · 1 line
2.21.0
PATCH v2 28/29 docs: xtensa: convert to ReST
In reply to Mauro Carvalho ChehabRename the xtensa documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../xtensa/{atomctl.txt => atomctl.rst} | 13 +-
.../xtensa/{booting.txt => booting.rst} | 5 +-
Documentation/xtensa/index.rst | 12 ++
Documentation/xtensa/mmu.rst | 195 ++++++++++++++++++
Documentation/xtensa/mmu.txt | 189 -----------------
arch/xtensa/include/asm/initialize_mmu.h | 2 +-
6 files changed, 222 insertions(+), 194 deletions(-)
rename Documentation/xtensa/{atomctl.txt => atomctl.rst} (81%)
rename Documentation/xtensa/{booting.txt => booting.rst} (91%)
create mode 100644 Documentation/xtensa/index.rst
create mode 100644 Documentation/xtensa/mmu.rst
delete mode 100644 Documentation/xtensa/mmu.txtDocumentation/xtensa/atomctl.rst renamed from Documentation/xtensa/atomctl.txt +10 -3
@@ -1,3 +1,7 @@ +=========================================== +Atomic Operation Control (ATOMCTL) Register +=========================================== + We Have Atomic Operation Control (ATOMCTL) Register. This register determines the effect of using a S32C1I instruction with various combinations of:
@@ -8,7 +12,7 @@ with various combinations of: 2. With and without An Intelligent Memory Controller which can do Atomic Transactions itself. -The Core comes up with a default value of for the three types of cache ops: +The Core comes up with a default value of for the three types of cache ops:: 0x28: (WB: Internal, WT: Internal, BY:Exception)
@@ -30,15 +34,18 @@ CUSTOMER-WARNING: Developers might find using RCW in Bypass mode convenient when testing with the cache being bypassed; for example studying cache alias problems. -See Section 4.3.12.4 of ISA; Bits: +See Section 4.3.12.4 of ISA; Bits:: WB WT BY 5 4 | 3 2 | 1 0 + +========= ================== ================== =============== 2 Bit Field Values WB - Write Back WT - Write Thru BY - Bypass ---------- --------------- ----------------- ---------------- +========= ================== ================== =============== 0 Exception Exception Exception 1 RCW Transaction RCW Transaction RCW Transaction 2 Internal Operation Internal Operation Reserved 3 Reserved Reserved Reserved +========= ================== ================== ===============
Documentation/xtensa/booting.rst renamed from Documentation/xtensa/booting.txt +4 -1
@@ -1,10 +1,13 @@ -Passing boot parameters to the kernel. +===================================== +Passing boot parameters to the kernel +===================================== Boot parameters are represented as a TLV list in the memory. Please see arch/xtensa/include/asm/bootparam.h for definition of the bp_tag structure and tag value constants. First entry in the list must have type BP_TAG_FIRST, last entry must have type BP_TAG_LAST. The address of the first list entry is passed to the kernel in the register a2. The address type depends on MMU type: + - For configurations without MMU, with region protection or with MPU the address must be the physical address. - For configurations with region translarion MMU or with MMUv3 and CONFIG_MMU=n
Documentation/xtensa/index.rst new file +12 -0
@@ -0,0 +1,12 @@ +:orphan: + +=================== +Xtensa Architecture +=================== + +.. toctree:: + :maxdepth: 1 + + atomctl + booting + mmu
Documentation/xtensa/mmu.rst new file +195 -0
195 lines not on this page · raw message
Documentation/xtensa/mmu.txt deleted +0 -189
189 lines not on this page · raw message
arch/xtensa/include/asm/initialize_mmu.h +1 -1
@@ -42,7 +42,7 @@#if XCHAL_HAVE_S32C1I && (XCHAL_HW_MIN_VERSION >=XTENSA_HWVERSION_RC_2009_0 )/* * We Have Atomic Operation Control (ATOMCTL) Register; Initialize it. -* For details see Documentation/xtensa/atomctl.txt +* For details see Documentation/xtensa/atomctl.rst */ #if XCHAL_DCACHE_IS_COHERENT movi a3, 0x25 /* For SMP/MX -- internal for writeback,
Signature · 1 line
2.21.0
PATCH v2 4/29 docs: m68k: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabConvert the m68k kernel-options.txt file to ReST.
The conversion is trivial, as the document is already on a format close enough to ReST. Just some small adjustments were needed in order to make it both good for being parsed while keeping it on a good txt shape.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../admin-guide/kernel-parameters.rst | 2 +-
Documentation/m68k/index.rst | 17 +
...{kernel-options.txt => kernel-options.rst} | 319 ++++++++++--------
3 files changed, 191 insertions(+), 147 deletions(-)
create mode 100644 Documentation/m68k/index.rst
rename Documentation/m68k/{kernel-options.txt => kernel-options.rst} (78%)Documentation/admin-guide/kernel-parameters.rst +1 -1
@@ -118,7 +118,7 @@ parameter is applicable:: LOOP Loopback device support is enabled. M68k M68k architecture is enabled. These options have more detailed description inside of - Documentation/m68k/kernel-options.txt. + Documentation/m68k/kernel-options.rst. MDA MDA console support is enabled. MIPS MIPS architecture is enabled. MOUSE Appropriate mouse support is enabled.
Documentation/m68k/index.rst new file +17 -0
@@ -0,0 +1,17 @@ +:orphan: + +================= +m68k Architecture +================= + +.. toctree:: + :maxdepth: 2 + + kernel-options + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex`
Documentation/m68k/kernel-options.rst renamed from Documentation/m68k/kernel-options.txt +173 -146
802 lines not on this page · raw message
Signature · 1 line
2.21.0
PATCH v2 1/29 docs: connector: convert to ReST and rename to connector.rst
In reply to Mauro Carvalho ChehabAs it has some function definitions, move them to connector.h.
The remaining conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../{connector.txt => connector.rst} | 130 ++++++------------
drivers/w1/Kconfig | 2 +-
include/linux/connector.h | 63 ++++++++-
samples/Kconfig | 2 +-
4 files changed, 109 insertions(+), 88 deletions(-)
rename Documentation/connector/{connector.txt => connector.rst} (57%)Documentation/connector/connector.rst renamed from Documentation/connector/connector.txt +45 -85
@@ -1,6 +1,8 @@ -/*****************************************/ -Kernel Connector. -/*****************************************/ +:orphan: + +================ +Kernel Connector +================ Kernel connector - new netlink based userspace <-> kernel space easy to use communication module.
@@ -12,94 +14,55 @@ identifier, the appropriate callback will be called. From the userspace point of view it's quite straightforward: - socket(); - bind(); - send(); - recv(); + - socket(); + - bind(); + - send(); + - recv(); But if kernelspace wants to use the full power of such connections, the driver writer must create special sockets, must know about struct sk_buff handling, etc... The Connector driver allows any kernelspace agents to use netlink based networking for inter-process communication in a significantly -easier way: +easier way:: -int cn_add_callback(struct cb_id *id, char *name, void (*callback) (struct cn_msg *, struct netlink_skb_parms *)); -void cn_netlink_send_multi(struct cn_msg *msg, u16 len, u32 portid, u32 __group, int gfp_mask); -void cn_netlink_send(struct cn_msg *msg, u32 portid, u32 __group, int gfp_mask); + int cn_add_callback(struct cb_id *id, char *name, void (*callback) (struct cn_msg *, struct netlink_skb_parms *)); + void cn_netlink_send_multi(struct cn_msg *msg, u16 len, u32 portid, u32 __group, int gfp_mask); + void cn_netlink_send(struct cn_msg *msg, u32 portid, u32 __group, int gfp_mask); -struct cb_id -{ + struct cb_id + { __u32 idx; __u32 val; -}; + }; idx and val are unique identifiers which must be registered in the -connector.h header for in-kernel usage. void (*callback) (void *) is a +connector.h header for in-kernel usage. `void (*callback) (void *)` is a callback function which will be called when a message with above idx.val is received by the connector core. The argument for that function must -be dereferenced to struct cn_msg *. +be dereferenced to `struct cn_msg *`:: -struct cn_msg -{ + struct cn_msg + { struct cb_id id; __u32 seq; __u32 ack; - __u32 len; /* Length of the following data */ + __u32 len; /* Length of the following data */ __u8 data[0]; -}; + }; -/*****************************************/ -Connector interfaces. -/*****************************************/ +Connector interfaces +==================== -int cn_add_callback(struct cb_id *id, char *name, void (*callback) (struct cn_msg *, struct netlink_skb_parms *)); + .. kernel-doc:: include/linux/connector.h - Registers new callback with connector core. + Note: + When registering new callback user, connector core assigns + netlink group to the user which is equal to its id.idx. - struct cb_id *id - unique connector's user identifier. - It must be registered in connector.h for legal in-kernel users. - char *name - connector's callback symbolic name. - void (*callback) (struct cn..) - connector's callback. - cn_msg and the sender's credentials - - -void cn_del_callback(struct cb_id *id); - - Unregisters new callback with connector core. - - struct cb_id *id - unique connector's user identifier. - - -int cn_netlink_send_multi(struct cn_msg *msg, u16 len, u32 portid, u32 __groups, int gfp_mask); -int cn_netlink_send(struct cn_msg *msg, u32 portid, u32 __groups, int gfp_mask); - - Sends message to the specified groups. It can be safely called from - softirq context, but may silently fail under strong memory pressure. - If there are no listeners for given group -ESRCH can be returned. - - struct cn_msg * - message header(with attached data). - u16 len - for *_multi multiple cn_msg messages can be sent - u32 port - destination port. - If non-zero the message will be sent to the - given port, which should be set to the - original sender. - u32 __group - destination group. - If port and __group is zero, then appropriate group will - be searched through all registered connector users, - and message will be delivered to the group which was - created for user with the same ID as in msg. - If __group is not zero, then message will be delivered - to the specified group. - int gfp_mask - GFP mask. - - Note: When registering new callback user, connector core assigns - netlink group to the user which is equal to its id.idx. - -/*****************************************/ -Protocol description. -/*****************************************/ +Protocol description +==================== The current framework offers a transport layer with fixed headers. The recommended protocol which uses such a header is as following:
@@ -132,9 +95,8 @@ driver (it also registers itself with id={-1, -1}). As example of this usage can be found in the cn_test.c module which uses the connector to request notification and to send messages. -/*****************************************/ -Reliability. -/*****************************************/ +Reliability +=========== Netlink itself is not a reliable protocol. That means that messages can be lost due to memory pressure or process' receiving queue overflowed,
@@ -142,32 +104,31 @@ so caller is warned that it must be prepared. That is why the struct cn_msg [main connector's message header] contains u32 seq and u32 ack fields. -/*****************************************/ -Userspace usage. -/*****************************************/ +Userspace usage +=============== 2.6.14 has a new netlink socket implementation, which by default does not allow people to send data to netlink groups other than 1. So, if you wish to use a netlink socket (for example using connector) with a different group number, the userspace application must subscribe to -that group first. It can be achieved by the following pseudocode: +that group first. It can be achieved by the following pseudocode:: -s = socket(PF_NETLINK, SOCK_DGRAM, NETLINK_CONNECTOR); + s = socket(PF_NETLINK, SOCK_DGRAM, NETLINK_CONNECTOR); -l_local.nl_family = AF_NETLINK; -l_local.nl_groups = 12345; -l_local.nl_pid = 0; + l_local.nl_family = AF_NETLINK; + l_local.nl_groups = 12345; + l_local.nl_pid = 0; -if (bind(s, (struct sockaddr *)&l_local, sizeof(struct sockaddr_nl)) == -1) { + if (bind(s, (struct sockaddr *)&l_local, sizeof(struct sockaddr_nl)) == -1) { perror("bind"); close(s); return -1; -} + } -{ + { int on = l_local.nl_groups; setsockopt(s, 270, 1, &on, sizeof(on)); -} + } Where 270 above is SOL_NETLINK, and 1 is a NETLINK_ADD_MEMBERSHIP socket option. To drop a multicast subscription, one should call the above socket
@@ -180,16 +141,15 @@ group number 12345, you must increment CN_NETLINK_USERS to that number. Additional 0xf numbers are allocated to be used by non-in-kernel users. Due to this limitation, group 0xffffffff does not work now, so one can -not use add/remove connector's group notifications, but as far as I know, +not use add/remove connector's group notifications, but as far as I know, only cn_test.c test module used it. Some work in netlink area is still being done, so things can be changed in 2.6.15 timeframe, if it will happen, documentation will be updated for that kernel. -/*****************************************/ Code samples -/*****************************************/ +============ Sample code for a connector test module and user space can be found in samples/connector/. To build this code, enable CONFIG_CONNECTOR
drivers/w1/Kconfig +1 -1
@@ -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.txt>. + information see <file:Documentation/connector/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.
include/linux/connector.h +62 -1
72 lines not on this page · raw message
samples/Kconfig +1 -1
@@ -100,7 +100,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.txt + See also Documentation/connector/connector.rst config SAMPLE_SECCOMP bool "Build seccomp sample code"
Signature · 1 line
2.21.0
PATCH v2 16/29 docs: rbtree.txt: fix Sphinx build warnings
In reply to Mauro Carvalho ChehabThs file is already at ReST format. Yet, some recent changes made it to produce a few warnings when building it with Sphinx.
Those are trivially fixed by marking some literal blocks.
Fix them before adding it to the docs building system.
--- Documentation/rbtree.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/rbtree.txt +3 -3
@@ -204,21 +204,21 @@ potentially expensive tree iterations. This is done at negligible runtime overhead for maintanence; albeit larger memory footprint. Similar to the rb_root structure, cached rbtrees are initialized to be -empty via: +empty via:: struct rb_root_cached mytree = RB_ROOT_CACHED; Cached rbtree is simply a regular rb_root with an extra pointer to cache the leftmost node. This allows rb_root_cached to exist wherever rb_root does, which permits augmented trees to be supported as well as only a few extra -interfaces: +interfaces:: struct rb_node *rb_first_cached(struct rb_root_cached *tree); void rb_insert_color_cached(struct rb_node *, struct rb_root_cached *, bool); void rb_erase_cached(struct rb_node *node, struct rb_root_cached *); Both insert and erase calls have their respective counterpart of augmented -trees: +trees:: void rb_insert_augmented_cached(struct rb_node *node, struct rb_root_cached *, bool, struct rb_augment_callbacks *);
Signature · 1 line
2.21.0
v2 cover Convert files to ReST - part 2
In reply to Mauro Carvalho ChehabThis is the second part of a series I wrote sometime ago where I manually convert lots of files to be properly parsed by Sphinx as ReST files.
As it touches on lot of stuff, this series is based on today's linux-next, at tag next-20190617.
The first version of this series had 57 patches. The first part with 28 patches were already merged. Right now, there are still ~76 patches pending applying (including this series), and that's because I opted to do ~1 patch per converted
directory.
That sounds too much to be send on a single round. So, I'm opting to split it on 3 parts for the conversion, plus a final patch adding orphaned books to existing ones.
Those patches should probably be good to be merged either by subsystem maintainers or via the docs tree.
I opted to mark new files not included yet to the main index.rst (directly or indirectly) with the :orphan: tag, in order to avoid adding warnings to the build system. This should be removed after we find a "home" for all the converted files within the new document tree arrangement, after I submit the third part.
Both this series and the other parts of this work are on my devel git tree, at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=convert_rst_renames_v5.1
The final output in html (after all patches I currently have, including the upcoming series) can be seen at:
https://www.infradead.org/~mchehab/rst_conversion/
It contains all pending work from my side related to the conversion, plus the patches I finished a first version today with contains the renaming patches and de-orphan changes.
---
Version 2:
- Removed patches merged via other trees;
- rebased on the top of today's linux-next (next-20190617);
- Fix a typo on one patch's description;
- Added received acks.
Mauro Carvalho Chehab (29):
docs: connector: convert to ReST and rename to connector.rst
docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst
docs: lp855x-driver.txt: convert to ReST and move to kernel-api
docs: m68k: convert docs to ReST and rename to *.rst
docs: cma/debugfs.txt: convert docs to ReST and rename to *.rst
docs: console.txt: convert docs to ReST and rename to *.rst
docs: pti_intel_mid.txt: convert it to pti_intel_mid.rst
docs: early-userspace: convert docs to ReST and rename to *.rst
docs: driver-model: convert docs to ReST and rename to *.rst
docs: arm: convert docs to ReST and rename to *.rst
docs: memory-devices: convert ti-emif.txt to ReST
docs: xen-tpmfront.txt: convert it to .rst
docs: bus-devices: ti-gpmc.rst: convert it to ReST
docs: nvmem: convert docs to ReST and rename to *.rst
docs: phy: convert samsung-usb2.txt to ReST format
docs: rbtree.txt: fix Sphinx build warnings
docs: DMA-API-HOWTO.txt: fix an unmarked code block
docs: accounting: convert to ReST
docs: ia64: convert to ReST
docs: leds: convert to ReST
docs: laptops: convert to ReST
docs: iio: convert to ReST
docs: namespaces: convert to ReST
docs: nfc: convert to ReST
docs: md: convert to ReST
docs: mtd: convert to ReST
docs: nvdimm: convert to ReST
docs: xtensa: convert to ReST
docs: mmc: convert to ReST
Documentation/ABI/testing/sysfs-block-device | 2 +-
.../ABI/testing/sysfs-platform-asus-laptop | 2 +-
Documentation/DMA-API-HOWTO.txt | 2 +-
.../{cgroupstats.txt => cgroupstats.rst} | 14 +-
...ay-accounting.txt => delay-accounting.rst} | 61 ++-
Documentation/accounting/index.rst | 14 +
Documentation/accounting/{psi.txt => psi.rst} | 40 +-
...kstats-struct.txt => taskstats-struct.rst} | 79 ++-
.../{taskstats.txt => taskstats.rst} | 15 +-
Documentation/admin-guide/cgroup-v2.rst | 6 +-
.../admin-guide/kernel-parameters.rst | 2 +-
.../admin-guide/kernel-parameters.txt | 2 +-
Documentation/arm/Marvell/README | 395 -------------
Documentation/arm/Netwinder | 78 ---
Documentation/arm/SA1100/FreeBird | 21 -
Documentation/arm/SA1100/empeg | 2 -
Documentation/arm/SA1100/serial_UART | 47 --
Documentation/arm/{README => arm.rst} | 50 +-
Documentation/arm/{Booting => booting.rst} | 71 ++-
...ance.txt => cluster-pm-race-avoidance.rst} | 177 +++---
.../arm/{firmware.txt => firmware.rst} | 14 +-
Documentation/arm/index.rst | 80 +++
.../arm/{Interrupts => interrupts.rst} | 86 +--
Documentation/arm/{IXP4xx => ixp4xx.rst} | 61 ++-
...nel_mode_neon.txt => kernel_mode_neon.rst} | 3 +
...er_helpers.txt => kernel_user_helpers.rst} | 79 +--
.../keystone/{knav-qmss.txt => knav-qmss.rst} | 6 +-
.../keystone/{Overview.txt => overview.rst} | 47 +-
Documentation/arm/marvel.rst | 488 +++++++++++++++++
.../arm/{mem_alignment => mem_alignment.rst} | 11 +-
Documentation/arm/{memory.txt => memory.rst} | 9 +-
.../arm/{Microchip/README => microchip.rst} | 63 ++-
Documentation/arm/netwinder.rst | 85 +++
Documentation/arm/nwfpe/index.rst | 11 +
.../nwfpe/{README.FPE => netwinder-fpe.rst} | 24 +-
Documentation/arm/nwfpe/{NOTES => notes.rst} | 3 +
Documentation/arm/nwfpe/{README => nwfpe.rst} | 10 +-
Documentation/arm/nwfpe/{TODO => todo.rst} | 47 +-
Documentation/arm/{OMAP/DSS => omap/dss.rst} | 112 ++--
Documentation/arm/omap/index.rst | 10 +
.../arm/{OMAP/README => omap/omap.rst} | 7 +
.../arm/{OMAP/omap_pm => omap/omap_pm.rst} | 55 +-
Documentation/arm/{Porting => porting.rst} | 14 +-
Documentation/arm/pxa/{mfp.txt => mfp.rst} | 106 ++--
.../{SA1100/ADSBitsy => sa1100/adsbitsy.rst} | 14 +-
.../{SA1100/Assabet => sa1100/assabet.rst} | 185 +++----
.../arm/{SA1100/Brutus => sa1100/brutus.rst} | 45 +-
.../arm/{SA1100/CERF => sa1100/cerf.rst} | 10 +-
Documentation/arm/sa1100/freebird.rst | 25 +
.../graphicsclient.rst} | 46 +-
.../graphicsmaster.rst} | 13 +-
.../HUW_WEBPANEL => sa1100/huw_webpanel.rst} | 8 +-
Documentation/arm/sa1100/index.rst | 23 +
.../arm/{SA1100/Itsy => sa1100/itsy.rst} | 14 +-
.../arm/{SA1100/LART => sa1100/lart.rst} | 3 +-
.../nanoEngine => sa1100/nanoengine.rst} | 6 +-
.../{SA1100/Pangolin => sa1100/pangolin.rst} | 10 +-
.../arm/{SA1100/PLEB => sa1100/pleb.rst} | 6 +-
Documentation/arm/sa1100/serial_uart.rst | 51 ++
.../arm/{SA1100/Tifon => sa1100/tifon.rst} | 4 +-
.../arm/{SA1100/Yopy => sa1100/yopy.rst} | 5 +-
.../cpufreq.rst} | 5 +-
.../eb2410itx.rst} | 5 +-
.../GPIO.txt => samsung-s3c24xx/gpio.rst} | 23 +-
.../H1940.txt => samsung-s3c24xx/h1940.rst} | 5 +-
Documentation/arm/samsung-s3c24xx/index.rst | 18 +
.../NAND.txt => samsung-s3c24xx/nand.rst} | 6 +-
.../overview.rst} | 21 +-
.../s3c2412.rst} | 5 +-
.../s3c2413.rst} | 7 +-
.../smdk2440.rst} | 5 +-
.../suspend.rst} | 20 +-
.../usb-host.rst} | 16 +-
.../bootloader-interface.rst} | 27 +-
.../clksrc-change-registers.awk | 0
.../{Samsung/GPIO.txt => samsung/gpio.rst} | 7 +-
Documentation/arm/samsung/index.rst | 10 +
.../Overview.txt => samsung/overview.rst} | 15 +-
Documentation/arm/{Setup => setup.rst} | 49 +-
.../arm/{SH-Mobile => sh-mobile}/.gitignore | 0
.../overview.txt => spear/overview.rst} | 20 +-
.../arm/sti/{overview.txt => overview.rst} | 21 +-
...h407-overview.txt => stih407-overview.rst} | 9 +-
...h415-overview.txt => stih415-overview.rst} | 8 +-
...h416-overview.txt => stih416-overview.rst} | 5 +-
...h418-overview.txt => stih418-overview.rst} | 9 +-
Documentation/arm/stm32/overview.rst | 2 -
.../arm/stm32/stm32f429-overview.rst | 7 +-
.../arm/stm32/stm32f746-overview.rst | 7 +-
.../arm/stm32/stm32f769-overview.rst | 7 +-
.../arm/stm32/stm32h743-overview.rst | 7 +-
.../arm/stm32/stm32mp157-overview.rst | 3 +-
Documentation/arm/{sunxi/README => sunxi.rst} | 98 +++-
.../arm/sunxi/{clocks.txt => clocks.rst} | 7 +-
.../arm/{swp_emulation => swp_emulation.rst} | 24 +-
Documentation/arm/{tcm.txt => tcm.rst} | 54 +-
Documentation/arm/{uefi.txt => uefi.rst} | 39 +-
.../release-notes.rst} | 4 +-
Documentation/arm/{vlocks.txt => vlocks.rst} | 9 +-
...cd-panel-cgram.txt => lcd-panel-cgram.rst} | 9 +-
Documentation/backlight/lp855x-driver.rst | 83 +++
Documentation/backlight/lp855x-driver.txt | 66 ---
.../bus-devices/{ti-gpmc.txt => ti-gpmc.rst} | 159 ++++--
.../cma/{debugfs.txt => debugfs.rst} | 8 +-
.../{connector.txt => connector.rst} | 130 ++---
.../console/{console.txt => console.rst} | 63 ++-
Documentation/devicetree/bindings/arm/xen.txt | 2 +-
.../devicetree/booting-without-of.txt | 4 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
.../driver-model/{binding.txt => binding.rst} | 20 +-
.../driver-model/{bus.txt => bus.rst} | 69 +--
.../driver-model/{class.txt => class.rst} | 74 +--
...esign-patterns.txt => design-patterns.rst} | 106 ++--
.../driver-model/{device.txt => device.rst} | 57 +-
.../driver-model/{devres.txt => devres.rst} | 50 +-
.../driver-model/{driver.txt => driver.rst} | 112 ++--
Documentation/driver-model/index.rst | 26 +
.../{overview.txt => overview.rst} | 37 +-
.../{platform.txt => platform.rst} | 30 +-
.../driver-model/{porting.txt => porting.rst} | 333 +++++------
.../{buffer-format.txt => buffer-format.rst} | 19 +-
.../{README => early_userspace_support.rst} | 3 +
Documentation/early-userspace/index.rst | 18 +
Documentation/eisa.txt | 4 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/filesystems/nfs/nfsroot.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.txt | 4 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
.../ia64/{aliasing.txt => aliasing.rst} | 73 ++-
Documentation/ia64/{efirtc.txt => efirtc.rst} | 118 ++--
.../ia64/{err_inject.txt => err_inject.rst} | 349 ++++++------
Documentation/ia64/{fsys.txt => fsys.rst} | 127 +++--
Documentation/ia64/{README => ia64.rst} | 26 +-
Documentation/ia64/index.rst | 18 +
.../ia64/{IRQ-redir.txt => irq-redir.rst} | 31 +-
Documentation/ia64/{mca.txt => mca.rst} | 10 +-
Documentation/ia64/{serial.txt => serial.rst} | 36 +-
Documentation/ia64/xen.rst | 206 +++++++
Documentation/ia64/xen.txt | 183 -------
.../iio/{ep93xx_adc.txt => ep93xx_adc.rst} | 15 +-
.../{iio_configfs.txt => iio_configfs.rst} | 52 +-
Documentation/iio/index.rst | 12 +
Documentation/index.rst | 1 +
.../{asus-laptop.txt => asus-laptop.rst} | 92 ++--
...otection.txt => disk-shock-protection.rst} | 32 +-
Documentation/laptops/index.rst | 17 +
.../{laptop-mode.txt => laptop-mode.rst} | 509 +++++++++--------
.../{sony-laptop.txt => sony-laptop.rst} | 58 +-
.../laptops/{sonypi.txt => sonypi.rst} | 28 +-
.../{thinkpad-acpi.txt => thinkpad-acpi.rst} | 367 ++++++++-----
.../{toshiba_haps.txt => toshiba_haps.rst} | 47 +-
Documentation/leds/index.rst | 25 +
.../leds/{leds-blinkm.txt => leds-blinkm.rst} | 64 ++-
...s-class-flash.txt => leds-class-flash.rst} | 49 +-
.../leds/{leds-class.txt => leds-class.rst} | 15 +-
.../leds/{leds-lm3556.txt => leds-lm3556.rst} | 100 +++-
.../leds/{leds-lp3944.txt => leds-lp3944.rst} | 23 +-
Documentation/leds/leds-lp5521.rst | 115 ++++
Documentation/leds/leds-lp5521.txt | 101 ----
Documentation/leds/leds-lp5523.rst | 147 +++++
Documentation/leds/leds-lp5523.txt | 130 -----
Documentation/leds/leds-lp5562.rst | 137 +++++
Documentation/leds/leds-lp5562.txt | 120 ----
Documentation/leds/leds-lp55xx.rst | 224 ++++++++
Documentation/leds/leds-lp55xx.txt | 194 -------
Documentation/leds/leds-mlxcpld.rst | 118 ++++
Documentation/leds/leds-mlxcpld.txt | 110 ----
...edtrig-oneshot.txt => ledtrig-oneshot.rst} | 11 +-
...ig-transient.txt => ledtrig-transient.rst} | 63 ++-
...edtrig-usbport.txt => ledtrig-usbport.rst} | 11 +-
Documentation/leds/{uleds.txt => uleds.rst} | 5 +-
Documentation/m68k/index.rst | 17 +
...{kernel-options.txt => kernel-options.rst} | 319 ++++++-----
Documentation/md/index.rst | 12 +
.../md/{md-cluster.txt => md-cluster.rst} | 188 ++++---
.../md/{raid5-cache.txt => raid5-cache.rst} | 28 +-
.../md/{raid5-ppl.txt => raid5-ppl.rst} | 2 +
.../{ti-emif.txt => ti-emif.rst} | 27 +-
Documentation/mmc/index.rst | 13 +
.../{mmc-async-req.txt => mmc-async-req.rst} | 53 +-
.../{mmc-dev-attrs.txt => mmc-dev-attrs.rst} | 32 +-
.../{mmc-dev-parts.txt => mmc-dev-parts.rst} | 13 +-
.../mmc/{mmc-tools.txt => mmc-tools.rst} | 5 +-
Documentation/mtd/index.rst | 12 +
.../mtd/{intel-spi.txt => intel-spi.rst} | 46 +-
.../mtd/{nand_ecc.txt => nand_ecc.rst} | 481 ++++++++--------
.../mtd/{spi-nor.txt => spi-nor.rst} | 7 +-
...bility-list.txt => compatibility-list.rst} | 10 +-
Documentation/namespaces/index.rst | 11 +
...ource-control.txt => resource-control.rst} | 4 +
Documentation/nfc/index.rst | 11 +
.../nfc/{nfc-hci.txt => nfc-hci.rst} | 163 +++---
.../nfc/{nfc-pn544.txt => nfc-pn544.rst} | 6 +-
Documentation/nvdimm/{btt.txt => btt.rst} | 140 ++---
Documentation/nvdimm/index.rst | 12 +
.../nvdimm/{nvdimm.txt => nvdimm.rst} | 518 ++++++++++--------
.../nvdimm/{security.txt => security.rst} | 4 +-
Documentation/nvmem/{nvmem.txt => nvmem.rst} | 112 ++--
.../{samsung-usb2.txt => samsung-usb2.rst} | 62 ++-
Documentation/pti/pti_intel_mid.rst | 106 ++++
Documentation/pti/pti_intel_mid.txt | 99 ----
Documentation/rbtree.txt | 6 +-
.../{xen-tpmfront.txt => xen-tpmfront.rst} | 103 ++--
Documentation/sysctl/vm.txt | 4 +-
Documentation/translations/zh_CN/arm/Booting | 4 +-
.../zh_CN/arm/kernel_user_helpers.txt | 4 +-
.../xtensa/{atomctl.txt => atomctl.rst} | 13 +-
.../xtensa/{booting.txt => booting.rst} | 5 +-
Documentation/xtensa/index.rst | 12 +
Documentation/xtensa/mmu.rst | 195 +++++++
Documentation/xtensa/mmu.txt | 189 -------
MAINTAINERS | 16 +-
arch/arm/Kconfig | 2 +-
arch/arm/common/mcpm_entry.c | 2 +-
arch/arm/common/mcpm_head.S | 2 +-
arch/arm/common/vlock.S | 2 +-
arch/arm/include/asm/setup.h | 2 +-
arch/arm/include/uapi/asm/setup.h | 2 +-
arch/arm/kernel/entry-armv.S | 2 +-
arch/arm/mach-exynos/common.h | 2 +-
arch/arm/mach-ixp4xx/Kconfig | 14 +-
arch/arm/mach-s3c24xx/pm.c | 2 +-
arch/arm/mm/Kconfig | 4 +-
arch/arm/plat-samsung/Kconfig | 6 +-
arch/arm/tools/mach-types | 2 +-
arch/arm64/Kconfig | 2 +-
arch/arm64/kernel/kuser32.S | 2 +-
arch/ia64/kernel/efi.c | 2 +-
arch/ia64/kernel/fsys.S | 2 +-
arch/ia64/mm/ioremap.c | 2 +-
arch/ia64/pci/pci.c | 2 +-
arch/mips/bmips/setup.c | 2 +-
arch/xtensa/include/asm/initialize_mmu.h | 2 +-
drivers/base/platform.c | 2 +-
drivers/char/Kconfig | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss-cipher.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss-core.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss-hash.c | 2 +-
drivers/crypto/sunxi-ss/sun4i-ss.h | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/iio/Kconfig | 2 +-
drivers/input/touchscreen/sun4i-ts.c | 2 +-
drivers/leds/trigger/Kconfig | 2 +-
drivers/leds/trigger/ledtrig-transient.c | 2 +-
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/nvdimm/Kconfig | 2 +-
drivers/platform/x86/Kconfig | 4 +-
drivers/tty/Kconfig | 2 +-
drivers/tty/serial/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
include/linux/connector.h | 63 ++-
init/Kconfig | 2 +-
net/netfilter/Kconfig | 2 +-
samples/Kconfig | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
usr/Kconfig | 2 +-
257 files changed, 7122 insertions(+), 5341 deletions(-)
rename Documentation/accounting/{cgroupstats.txt => cgroupstats.rst} (77%)
rename Documentation/accounting/{delay-accounting.txt => delay-accounting.rst} (77%)
create mode 100644 Documentation/accounting/index.rst
rename Documentation/accounting/{psi.txt => psi.rst} (91%)
rename Documentation/accounting/{taskstats-struct.txt => taskstats-struct.rst} (78%)
rename Documentation/accounting/{taskstats.txt => taskstats.rst} (95%)
delete mode 100644 Documentation/arm/Marvell/README
delete mode 100644 Documentation/arm/Netwinder
delete mode 100644 Documentation/arm/SA1100/FreeBird
delete mode 100644 Documentation/arm/SA1100/empeg
delete mode 100644 Documentation/arm/SA1100/serial_UART
rename Documentation/arm/{README => arm.rst} (88%)
rename Documentation/arm/{Booting => booting.rst} (89%)
rename Documentation/arm/{cluster-pm-race-avoidance.txt => cluster-pm-race-avoidance.rst} (84%)
rename Documentation/arm/{firmware.txt => firmware.rst} (86%)
create mode 100644 Documentation/arm/index.rst
rename Documentation/arm/{Interrupts => interrupts.rst} (81%)
rename Documentation/arm/{IXP4xx => ixp4xx.rst} (84%)
rename Documentation/arm/{kernel_mode_neon.txt => kernel_mode_neon.rst} (99%)
rename Documentation/arm/{kernel_user_helpers.txt => kernel_user_helpers.rst} (78%)
rename Documentation/arm/keystone/{knav-qmss.txt => knav-qmss.rst} (92%)
rename Documentation/arm/keystone/{Overview.txt => overview.rst} (59%)
create mode 100644 Documentation/arm/marvel.rst
rename Documentation/arm/{mem_alignment => mem_alignment.rst} (89%)
rename Documentation/arm/{memory.txt => memory.rst} (90%)
rename Documentation/arm/{Microchip/README => microchip.rst} (92%)
create mode 100644 Documentation/arm/netwinder.rst
create mode 100644 Documentation/arm/nwfpe/index.rst
rename Documentation/arm/nwfpe/{README.FPE => netwinder-fpe.rst} (94%)
rename Documentation/arm/nwfpe/{NOTES => notes.rst} (99%)
rename Documentation/arm/nwfpe/{README => nwfpe.rst} (98%)
rename Documentation/arm/nwfpe/{TODO => todo.rst} (75%)
rename Documentation/arm/{OMAP/DSS => omap/dss.rst} (86%)
create mode 100644 Documentation/arm/omap/index.rst
rename Documentation/arm/{OMAP/README => omap/omap.rst} (62%)
rename Documentation/arm/{OMAP/omap_pm => omap/omap_pm.rst} (83%)
rename Documentation/arm/{Porting => porting.rst} (94%)
rename Documentation/arm/pxa/{mfp.txt => mfp.rst} (83%)
rename Documentation/arm/{SA1100/ADSBitsy => sa1100/adsbitsy.rst} (90%)
rename Documentation/arm/{SA1100/Assabet => sa1100/assabet.rst} (62%)
rename Documentation/arm/{SA1100/Brutus => sa1100/brutus.rst} (75%)
rename Documentation/arm/{SA1100/CERF => sa1100/cerf.rst} (91%)
create mode 100644 Documentation/arm/sa1100/freebird.rst
rename Documentation/arm/{SA1100/GraphicsClient => sa1100/graphicsclient.rst} (87%)
rename Documentation/arm/{SA1100/GraphicsMaster => sa1100/graphicsmaster.rst} (92%)
rename Documentation/arm/{SA1100/HUW_WEBPANEL => sa1100/huw_webpanel.rst} (78%)
create mode 100644 Documentation/arm/sa1100/index.rst
rename Documentation/arm/{SA1100/Itsy => sa1100/itsy.rst} (88%)
rename Documentation/arm/{SA1100/LART => sa1100/lart.rst} (90%)
rename Documentation/arm/{SA1100/nanoEngine => sa1100/nanoengine.rst} (74%)
rename Documentation/arm/{SA1100/Pangolin => sa1100/pangolin.rst} (81%)
rename Documentation/arm/{SA1100/PLEB => sa1100/pleb.rst} (95%)
create mode 100644 Documentation/arm/sa1100/serial_uart.rst
rename Documentation/arm/{SA1100/Tifon => sa1100/tifon.rst} (88%)
rename Documentation/arm/{SA1100/Yopy => sa1100/yopy.rst} (74%)
rename Documentation/arm/{Samsung-S3C24XX/CPUfreq.txt => samsung-s3c24xx/cpufreq.rst} (96%)
rename Documentation/arm/{Samsung-S3C24XX/EB2410ITX.txt => samsung-s3c24xx/eb2410itx.rst} (92%)
rename Documentation/arm/{Samsung-S3C24XX/GPIO.txt => samsung-s3c24xx/gpio.rst} (89%)
rename Documentation/arm/{Samsung-S3C24XX/H1940.txt => samsung-s3c24xx/h1940.rst} (94%)
create mode 100644 Documentation/arm/samsung-s3c24xx/index.rst
rename Documentation/arm/{Samsung-S3C24XX/NAND.txt => samsung-s3c24xx/nand.rst} (92%)
rename Documentation/arm/{Samsung-S3C24XX/Overview.txt => samsung-s3c24xx/overview.rst} (94%)
rename Documentation/arm/{Samsung-S3C24XX/S3C2412.txt => samsung-s3c24xx/s3c2412.rst} (96%)
rename Documentation/arm/{Samsung-S3C24XX/S3C2413.txt => samsung-s3c24xx/s3c2413.rst} (77%)
rename Documentation/arm/{Samsung-S3C24XX/SMDK2440.txt => samsung-s3c24xx/smdk2440.rst} (94%)
rename Documentation/arm/{Samsung-S3C24XX/Suspend.txt => samsung-s3c24xx/suspend.rst} (94%)
rename Documentation/arm/{Samsung-S3C24XX/USB-Host.txt => samsung-s3c24xx/usb-host.rst} (94%)
rename Documentation/arm/{Samsung/Bootloader-interface.txt => samsung/bootloader-interface.rst} (72%)
rename Documentation/arm/{Samsung => samsung}/clksrc-change-registers.awk (100%)
rename Documentation/arm/{Samsung/GPIO.txt => samsung/gpio.rst} (87%)
create mode 100644 Documentation/arm/samsung/index.rst
rename Documentation/arm/{Samsung/Overview.txt => samsung/overview.rst} (86%)
rename Documentation/arm/{Setup => setup.rst} (87%)
rename Documentation/arm/{SH-Mobile => sh-mobile}/.gitignore (100%)
rename Documentation/arm/{SPEAr/overview.txt => spear/overview.rst} (91%)
rename Documentation/arm/sti/{overview.txt => overview.rst} (82%)
rename Documentation/arm/sti/{stih407-overview.txt => stih407-overview.rst} (82%)
rename Documentation/arm/sti/{stih415-overview.txt => stih415-overview.rst} (79%)
rename Documentation/arm/sti/{stih416-overview.txt => stih416-overview.rst} (83%)
rename Documentation/arm/sti/{stih418-overview.txt => stih418-overview.rst} (83%)
rename Documentation/arm/{sunxi/README => sunxi.rst} (83%)
rename Documentation/arm/sunxi/{clocks.txt => clocks.rst} (92%)
rename Documentation/arm/{swp_emulation => swp_emulation.rst} (63%)
rename Documentation/arm/{tcm.txt => tcm.rst} (86%)
rename Documentation/arm/{uefi.txt => uefi.rst} (63%)
rename Documentation/arm/{VFP/release-notes.txt => vfp/release-notes.rst} (92%)
rename Documentation/arm/{vlocks.txt => vlocks.rst} (98%)
rename Documentation/auxdisplay/{lcd-panel-cgram.txt => lcd-panel-cgram.rst} (88%)
create mode 100644 Documentation/backlight/lp855x-driver.rst
delete mode 100644 Documentation/backlight/lp855x-driver.txt
rename Documentation/bus-devices/{ti-gpmc.txt => ti-gpmc.rst} (58%)
rename Documentation/cma/{debugfs.txt => debugfs.rst} (91%)
rename Documentation/connector/{connector.txt => connector.rst} (57%)
rename Documentation/console/{console.txt => console.rst} (80%)
rename Documentation/driver-model/{binding.txt => binding.rst} (92%)
rename Documentation/driver-model/{bus.txt => bus.rst} (76%)
rename Documentation/driver-model/{class.txt => class.rst} (75%)
rename Documentation/driver-model/{design-patterns.txt => design-patterns.rst} (59%)
rename Documentation/driver-model/{device.txt => device.rst} (71%)
rename Documentation/driver-model/{devres.txt => devres.rst} (93%)
rename Documentation/driver-model/{driver.txt => driver.rst} (75%)
create mode 100644 Documentation/driver-model/index.rst
rename Documentation/driver-model/{overview.txt => overview.rst} (90%)
rename Documentation/driver-model/{platform.txt => platform.rst} (95%)
rename Documentation/driver-model/{porting.txt => porting.rst} (62%)
rename Documentation/early-userspace/{buffer-format.txt => buffer-format.rst} (91%)
rename Documentation/early-userspace/{README => early_userspace_support.rst} (99%)
create mode 100644 Documentation/early-userspace/index.rst
rename Documentation/ia64/{aliasing.txt => aliasing.rst} (83%)
rename Documentation/ia64/{efirtc.txt => efirtc.rst} (70%)
rename Documentation/ia64/{err_inject.txt => err_inject.rst} (82%)
rename Documentation/ia64/{fsys.txt => fsys.rst} (76%)
rename Documentation/ia64/{README => ia64.rst} (61%)
create mode 100644 Documentation/ia64/index.rst
rename Documentation/ia64/{IRQ-redir.txt => irq-redir.rst} (86%)
rename Documentation/ia64/{mca.txt => mca.rst} (96%)
rename Documentation/ia64/{serial.txt => serial.rst} (87%)
create mode 100644 Documentation/ia64/xen.rst
delete mode 100644 Documentation/ia64/xen.txt
rename Documentation/iio/{ep93xx_adc.txt => ep93xx_adc.rst} (71%)
rename Documentation/iio/{iio_configfs.txt => iio_configfs.rst} (73%)
create mode 100644 Documentation/iio/index.rst
rename Documentation/laptops/{asus-laptop.txt => asus-laptop.rst} (84%)
rename Documentation/laptops/{disk-shock-protection.txt => disk-shock-protection.rst} (91%)
create mode 100644 Documentation/laptops/index.rst
rename Documentation/laptops/{laptop-mode.txt => laptop-mode.rst} (62%)
rename Documentation/laptops/{sony-laptop.txt => sony-laptop.rst} (85%)
rename Documentation/laptops/{sonypi.txt => sonypi.rst} (87%)
rename Documentation/laptops/{thinkpad-acpi.txt => thinkpad-acpi.rst} (89%)
rename Documentation/laptops/{toshiba_haps.txt => toshiba_haps.rst} (60%)
create mode 100644 Documentation/leds/index.rst
rename Documentation/leds/{leds-blinkm.txt => leds-blinkm.rst} (57%)
rename Documentation/leds/{leds-class-flash.txt => leds-class-flash.rst} (74%)
rename Documentation/leds/{leds-class.txt => leds-class.rst} (92%)
rename Documentation/leds/{leds-lm3556.txt => leds-lm3556.rst} (70%)
rename Documentation/leds/{leds-lp3944.txt => leds-lp3944.rst} (78%)
create mode 100644 Documentation/leds/leds-lp5521.rst
delete mode 100644 Documentation/leds/leds-lp5521.txt
create mode 100644 Documentation/leds/leds-lp5523.rst
delete mode 100644 Documentation/leds/leds-lp5523.txt
create mode 100644 Documentation/leds/leds-lp5562.rst
delete mode 100644 Documentation/leds/leds-lp5562.txt
create mode 100644 Documentation/leds/leds-lp55xx.rst
delete mode 100644 Documentation/leds/leds-lp55xx.txt
create mode 100644 Documentation/leds/leds-mlxcpld.rst
delete mode 100644 Documentation/leds/leds-mlxcpld.txt
rename Documentation/leds/{ledtrig-oneshot.txt => ledtrig-oneshot.rst} (90%)
rename Documentation/leds/{ledtrig-transient.txt => ledtrig-transient.rst} (81%)
rename Documentation/leds/{ledtrig-usbport.txt => ledtrig-usbport.rst} (86%)
rename Documentation/leds/{uleds.txt => uleds.rst} (95%)
create mode 100644 Documentation/m68k/index.rst
rename Documentation/m68k/{kernel-options.txt => kernel-options.rst} (78%)
create mode 100644 Documentation/md/index.rst
rename Documentation/md/{md-cluster.txt => md-cluster.rst} (68%)
rename Documentation/md/{raid5-cache.txt => raid5-cache.rst} (92%)
rename Documentation/md/{raid5-ppl.txt => raid5-ppl.rst} (98%)
rename Documentation/memory-devices/{ti-emif.txt => ti-emif.rst} (81%)
create mode 100644 Documentation/mmc/index.rst
rename Documentation/mmc/{mmc-async-req.txt => mmc-async-req.rst} (75%)
rename Documentation/mmc/{mmc-dev-attrs.txt => mmc-dev-attrs.rst} (73%)
rename Documentation/mmc/{mmc-dev-parts.txt => mmc-dev-parts.rst} (83%)
rename Documentation/mmc/{mmc-tools.txt => mmc-tools.rst} (92%)
create mode 100644 Documentation/mtd/index.rst
rename Documentation/mtd/{intel-spi.txt => intel-spi.rst} (71%)
rename Documentation/mtd/{nand_ecc.txt => nand_ecc.rst} (67%)
rename Documentation/mtd/{spi-nor.txt => spi-nor.rst} (94%)
rename Documentation/namespaces/{compatibility-list.txt => compatibility-list.rst} (86%)
create mode 100644 Documentation/namespaces/index.rst
rename Documentation/namespaces/{resource-control.txt => resource-control.rst} (89%)
create mode 100644 Documentation/nfc/index.rst
rename Documentation/nfc/{nfc-hci.txt => nfc-hci.rst} (71%)
rename Documentation/nfc/{nfc-pn544.txt => nfc-pn544.rst} (82%)
rename Documentation/nvdimm/{btt.txt => btt.rst} (71%)
create mode 100644 Documentation/nvdimm/index.rst
rename Documentation/nvdimm/{nvdimm.txt => nvdimm.rst} (60%)
rename Documentation/nvdimm/{security.txt => security.rst} (99%)
rename Documentation/nvmem/{nvmem.txt => nvmem.rst} (62%)
rename Documentation/phy/{samsung-usb2.txt => samsung-usb2.rst} (77%)
create mode 100644 Documentation/pti/pti_intel_mid.rst
delete mode 100644 Documentation/pti/pti_intel_mid.txt
rename Documentation/security/tpm/{xen-tpmfront.txt => xen-tpmfront.rst} (66%)
rename Documentation/xtensa/{atomctl.txt => atomctl.rst} (81%)
rename Documentation/xtensa/{booting.txt => booting.rst} (91%)
create mode 100644 Documentation/xtensa/index.rst
create mode 100644 Documentation/xtensa/mmu.rst
delete mode 100644 Documentation/xtensa/mmu.txtSignature · 1 line
2.21.0
PATCH v2 13/29 docs: bus-devices: ti-gpmc.rst: convert it to ReST
In order to be able to add this file to a book, it needs first to be converted to ReST and renamed.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
---
.../bus-devices/{ti-gpmc.txt => ti-gpmc.rst} | 159 ++++++++++++------
1 file changed, 108 insertions(+), 51 deletions(-)
rename Documentation/bus-devices/{ti-gpmc.txt => ti-gpmc.rst} (58%)Documentation/bus-devices/ti-gpmc.rst renamed from Documentation/bus-devices/ti-gpmc.txt +108 -51
@@ -1,8 +1,12 @@ -GPMC (General Purpose Memory Controller): -========================================= +:orphan: + +======================================== +GPMC (General Purpose Memory Controller) +======================================== GPMC is an unified memory controller dedicated to interfacing external memory devices like + * Asynchronous SRAM like memories and application specific integrated circuit devices. * Asynchronous, synchronous, and page mode burst NOR flash devices
@@ -48,75 +52,128 @@ most of the datasheets & hardware (to be exact none of those supported in mainline having custom timing routine) and by simulation. gpmc timing dependency on peripheral timings: + [<gpmc_timing>: <peripheral timing1>, <peripheral timing2> ...] 1. common -cs_on: t_ceasu -adv_on: t_avdasu, t_ceavd + +cs_on: + t_ceasu +adv_on: + t_avdasu, t_ceavd 2. sync common -sync_clk: clk -page_burst_access: t_bacc -clk_activation: t_ces, t_avds + +sync_clk: + clk +page_burst_access: + t_bacc +clk_activation: + t_ces, t_avds 3. read async muxed -adv_rd_off: t_avdp_r -oe_on: t_oeasu, t_aavdh -access: t_iaa, t_oe, t_ce, t_aa -rd_cycle: t_rd_cycle, t_cez_r, t_oez + +adv_rd_off: + t_avdp_r +oe_on: + t_oeasu, t_aavdh +access: + t_iaa, t_oe, t_ce, t_aa +rd_cycle: + t_rd_cycle, t_cez_r, t_oez 4. read async non-muxed -adv_rd_off: t_avdp_r -oe_on: t_oeasu -access: t_iaa, t_oe, t_ce, t_aa -rd_cycle: t_rd_cycle, t_cez_r, t_oez + +adv_rd_off: + t_avdp_r +oe_on: + t_oeasu +access: + t_iaa, t_oe, t_ce, t_aa +rd_cycle: + t_rd_cycle, t_cez_r, t_oez 5. read sync muxed -adv_rd_off: t_avdp_r, t_avdh -oe_on: t_oeasu, t_ach, cyc_aavdh_oe -access: t_iaa, cyc_iaa, cyc_oe -rd_cycle: t_cez_r, t_oez, t_ce_rdyz + +adv_rd_off: + t_avdp_r, t_avdh +oe_on: + t_oeasu, t_ach, cyc_aavdh_oe +access: + t_iaa, cyc_iaa, cyc_oe +rd_cycle: + t_cez_r, t_oez, t_ce_rdyz 6. read sync non-muxed -adv_rd_off: t_avdp_r -oe_on: t_oeasu -access: t_iaa, cyc_iaa, cyc_oe -rd_cycle: t_cez_r, t_oez, t_ce_rdyz + +adv_rd_off: + t_avdp_r +oe_on: + t_oeasu +access: + t_iaa, cyc_iaa, cyc_oe +rd_cycle: + t_cez_r, t_oez, t_ce_rdyz 7. write async muxed -adv_wr_off: t_avdp_w -we_on, wr_data_mux_bus: t_weasu, t_aavdh, cyc_aavhd_we -we_off: t_wpl -cs_wr_off: t_wph -wr_cycle: t_cez_w, t_wr_cycle + +adv_wr_off: + t_avdp_w +we_on, wr_data_mux_bus: + t_weasu, t_aavdh, cyc_aavhd_we +we_off: + t_wpl +cs_wr_off: + t_wph +wr_cycle: + t_cez_w, t_wr_cycle 8. write async non-muxed -adv_wr_off: t_avdp_w -we_on, wr_data_mux_bus: t_weasu -we_off: t_wpl -cs_wr_off: t_wph -wr_cycle: t_cez_w, t_wr_cycle + +adv_wr_off: + t_avdp_w +we_on, wr_data_mux_bus: + t_weasu +we_off: + t_wpl +cs_wr_off: + t_wph +wr_cycle: + t_cez_w, t_wr_cycle 9. write sync muxed -adv_wr_off: t_avdp_w, t_avdh -we_on, wr_data_mux_bus: t_weasu, t_rdyo, t_aavdh, cyc_aavhd_we -we_off: t_wpl, cyc_wpl -cs_wr_off: t_wph -wr_cycle: t_cez_w, t_ce_rdyz + +adv_wr_off: + t_avdp_w, t_avdh +we_on, wr_data_mux_bus: + t_weasu, t_rdyo, t_aavdh, cyc_aavhd_we +we_off: + t_wpl, cyc_wpl +cs_wr_off: + t_wph +wr_cycle: + t_cez_w, t_ce_rdyz 10. write sync non-muxed -adv_wr_off: t_avdp_w -we_on, wr_data_mux_bus: t_weasu, t_rdyo -we_off: t_wpl, cyc_wpl -cs_wr_off: t_wph -wr_cycle: t_cez_w, t_ce_rdyz +adv_wr_off: + t_avdp_w +we_on, wr_data_mux_bus: + t_weasu, t_rdyo +we_off: + t_wpl, cyc_wpl +cs_wr_off: + t_wph +wr_cycle: + t_cez_w, t_ce_rdyz -Note: Many of gpmc timings are dependent on other gpmc timings (a few -gpmc timings purely dependent on other gpmc timings, a reason that -some of the gpmc timings are missing above), and it will result in -indirect dependency of peripheral timings to gpmc timings other than -mentioned above, refer timing routine for more details. To know what -these peripheral timings correspond to, please see explanations in -struct gpmc_device_timings definition. And for gpmc timings refer -IP details (link above). + +Note: + Many of gpmc timings are dependent on other gpmc timings (a few + gpmc timings purely dependent on other gpmc timings, a reason that + some of the gpmc timings are missing above), and it will result in + indirect dependency of peripheral timings to gpmc timings other than + mentioned above, refer timing routine for more details. To know what + these peripheral timings correspond to, please see explanations in + struct gpmc_device_timings definition. And for gpmc timings refer + IP details (link above).
Signature · 1 line
2.21.0
PATCH v2 15/29 docs: phy: convert samsung-usb2.txt to ReST format
In reply to Mauro Carvalho ChehabIn order to merge it into a Sphinx book, we need first to convert to ReST.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
---
.../{samsung-usb2.txt => samsung-usb2.rst} | 62 ++++++++++---------
MAINTAINERS | 2 +-
2 files changed, 34 insertions(+), 30 deletions(-)
rename Documentation/phy/{samsung-usb2.txt => samsung-usb2.rst} (77%)Documentation/phy/samsung-usb2.rst renamed from Documentation/phy/samsung-usb2.txt +33 -29
@@ -1,9 +1,11 @@ -.------------------------------------------------------------------------------+ -| Samsung USB 2.0 PHY adaptation layer | -+-----------------------------------------------------------------------------+' +:orphan: -| 1. Description -+---------------- +==================================== +Samsung USB 2.0 PHY adaptation layer +==================================== + +1. Description +-------------- The architecture of the USB 2.0 PHY module in Samsung SoCs is similar among many SoCs. In spite of the similarities it proved difficult to
@@ -14,8 +16,8 @@ the PHY powering up process had to be altered. This adaptation layer is a compromise between having separate drivers and having a single driver with added support for many special cases. -| 2. Files description -+---------------------- +2. Files description +-------------------- - phy-samsung-usb2.c This is the main file of the adaptation layer. This file contains
@@ -32,44 +34,45 @@ with added support for many special cases. driver. In addition it should contain extern declarations for structures that describe particular SoCs. -| 3. Supporting SoCs -+-------------------- +3. Supporting SoCs +------------------ To support a new SoC a new file should be added to the drivers/phy directory. Each SoC's configuration is stored in an instance of the -struct samsung_usb2_phy_config. +struct samsung_usb2_phy_config:: -struct samsung_usb2_phy_config { + struct samsung_usb2_phy_config { const struct samsung_usb2_common_phy *phys; int (*rate_to_clk)(unsigned long, u32 *); unsigned int num_phys; bool has_mode_switch; -}; + }; -The num_phys is the number of phys handled by the driver. *phys is an +The num_phys is the number of phys handled by the driver. `*phys` is an array that contains the configuration for each phy. The has_mode_switch property is a boolean flag that determines whether the SoC has USB host and device on a single pair of pins. If so, a special register has to be modified to change the internal routing of these pins between a USB device or host module. -For example the configuration for Exynos 4210 is following: +For example the configuration for Exynos 4210 is following:: -const struct samsung_usb2_phy_config exynos4210_usb2_phy_config = { + const struct samsung_usb2_phy_config exynos4210_usb2_phy_config = { .has_mode_switch = 0, .num_phys = EXYNOS4210_NUM_PHYS, .phys = exynos4210_phys, .rate_to_clk = exynos4210_rate_to_clk, -} + } + +- `int (*rate_to_clk)(unsigned long, u32 *)` -- int (*rate_to_clk)(unsigned long, u32 *) The rate_to_clk callback is to convert the rate of the clock used as the reference clock for the PHY module to the value that should be written in the hardware register. -The exynos4210_phys configuration array is as follows: +The exynos4210_phys configuration array is as follows:: -static const struct samsung_usb2_common_phy exynos4210_phys[] = { + static const struct samsung_usb2_common_phy exynos4210_phys[] = { { .label = "device", .id = EXYNOS4210_DEVICE,
@@ -95,29 +98,30 @@ static const struct samsung_usb2_common_phy exynos4210_phys[] = { .power_off = exynos4210_power_off, }, {}, -}; + }; + +- `int (*power_on)(struct samsung_usb2_phy_instance *);` + `int (*power_off)(struct samsung_usb2_phy_instance *);` -- int (*power_on)(struct samsung_usb2_phy_instance *); -- int (*power_off)(struct samsung_usb2_phy_instance *); These two callbacks are used to power on and power off the phy by modifying appropriate registers. Final change to the driver is adding appropriate compatible value to the phy-samsung-usb2.c file. In case of Exynos 4210 the following lines were -added to the struct of_device_id samsung_usb2_phy_of_match[] array: +added to the struct of_device_id samsung_usb2_phy_of_match[] array:: -#ifdef CONFIG_PHY_EXYNOS4210_USB2 + #ifdef CONFIG_PHY_EXYNOS4210_USB2 { .compatible = "samsung,exynos4210-usb2-phy", .data = &exynos4210_usb2_phy_config, }, -#endif + #endif To add further flexibility to the driver the Kconfig file enables to include support for selected SoCs in the compiled driver. The Kconfig -entry for Exynos 4210 is following: +entry for Exynos 4210 is following:: -config PHY_EXYNOS4210_USB2 + config PHY_EXYNOS4210_USB2 bool "Support for Exynos 4210" depends on PHY_SAMSUNG_USB2 depends on CPU_EXYNOS4210
@@ -128,8 +132,8 @@ config PHY_EXYNOS4210_USB2 phys are available - device, host, HSCI0 and HSCI1. The newly created file that supports the new SoC has to be also added to the -Makefile. In case of Exynos 4210 the added line is following: +Makefile. In case of Exynos 4210 the added line is following:: -obj-$(CONFIG_PHY_EXYNOS4210_USB2) += phy-exynos4210-usb2.o + obj-$(CONFIG_PHY_EXYNOS4210_USB2) += phy-exynos4210-usb2.o After completing these steps the support for the new SoC should be ready.
MAINTAINERS +1 -1
@@ -13966,7 +13966,7 @@ M: Sylwester Nawrocki <[email protected]> L: [email protected] S: Supported F: Documentation/devicetree/bindings/phy/samsung-phy.txt -F: Documentation/phy/samsung-usb2.txt +F: Documentation/phy/samsung-usb2.rst F: drivers/phy/samsung/phy-exynos4210-usb2.c F: drivers/phy/samsung/phy-exynos4x12-usb2.c F: drivers/phy/samsung/phy-exynos5250-usb2.c
Signature · 1 line
2.21.0
PATCH v2 17/29 docs: DMA-API-HOWTO.txt: fix an unmarked code block
In reply to Mauro Carvalho ChehabWhen building with Sphinx, it would produce this warning:
docs/Documentation/DMA-API-HOWTO.rst:222: WARNING: Definition list ends without a blank line; unexpected unindent.
--- Documentation/DMA-API-HOWTO.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/DMA-API-HOWTO.txt +1 -1
@@ -212,7 +212,7 @@ The standard 64-bit addressing device would do something like this:: If the device only supports 32-bit addressing for descriptors in the coherent allocations, but supports full 64-bits for streaming mappings -it would look like this: +it would look like this:: if (dma_set_mask(dev, DMA_BIT_MASK(64))) { dev_warn(dev, "mydev: No suitable DMA available\n");
Signature · 1 line
2.21.0
PATCH v2 22/29 docs: iio: convert to ReST
In reply to Mauro Carvalho ChehabRename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
.../iio/{ep93xx_adc.txt => ep93xx_adc.rst} | 15 +++++-
.../{iio_configfs.txt => iio_configfs.rst} | 52 +++++++++++--------
Documentation/iio/index.rst | 12 +++++
drivers/iio/Kconfig | 2 +-
4 files changed, 56 insertions(+), 25 deletions(-)
rename Documentation/iio/{ep93xx_adc.txt => ep93xx_adc.rst} (71%)
rename Documentation/iio/{iio_configfs.txt => iio_configfs.rst} (73%)
create mode 100644 Documentation/iio/index.rstDocumentation/iio/ep93xx_adc.rst renamed from Documentation/iio/ep93xx_adc.txt +13 -2
@@ -1,12 +1,16 @@ -Cirrus Logic EP93xx ADC driver. +============================== +Cirrus Logic EP93xx ADC driver +============================== 1. Overview +=========== The driver is intended to work on both low-end (EP9301, EP9302) devices with 5-channel ADC and high-end (EP9307, EP9312, EP9315) devices with 10-channel touchscreen/ADC module. 2. Channel numbering +==================== Numbering scheme for channels 0..4 is defined in EP9301 and EP9302 datasheets. EP9307, EP9312 and EP9312 have 3 channels more (total 8), but the numbering is
@@ -17,13 +21,20 @@ Assuming ep93xx_adc is IIO device0, you'd find the following entries under +-----------------+---------------+ | sysfs entry | ball/pin name | - +-----------------+---------------+ + +=================+===============+ | in_voltage0_raw | YM | + +-----------------+---------------+ | in_voltage1_raw | SXP | + +-----------------+---------------+ | in_voltage2_raw | SXM | + +-----------------+---------------+ | in_voltage3_raw | SYP | + +-----------------+---------------+ | in_voltage4_raw | SYM | + +-----------------+---------------+ | in_voltage5_raw | XP | + +-----------------+---------------+ | in_voltage6_raw | XM | + +-----------------+---------------+ | in_voltage7_raw | YP | +-----------------+---------------+
Documentation/iio/iio_configfs.rst renamed from Documentation/iio/iio_configfs.txt +30 -22
117 lines not on this page · raw message
Documentation/iio/index.rst new file +12 -0
@@ -0,0 +1,12 @@ +:orphan: + +============== +Industrial I/O +============== + +.. toctree:: + :maxdepth: 1 + + iio_configfs + + ep93xx_adc
drivers/iio/Kconfig +1 -1
@@ -28,7 +28,7 @@ config IIO_CONFIGFS help This allows configuring various IIO bits through configfs (e.g. software triggers). For more info see - Documentation/iio/iio_configfs.txt. + Documentation/iio/iio_configfs.rst. config IIO_TRIGGER bool "Enable triggered sampling support"
Signature · 1 line
2.21.0
PATCH v2 29/29 docs: mmc: convert to ReST
In reply to Mauro Carvalho ChehabRename the mmc documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
Documentation/mmc/index.rst | 13 +++++
.../{mmc-async-req.txt => mmc-async-req.rst} | 53 +++++++++++--------
.../{mmc-dev-attrs.txt => mmc-dev-attrs.rst} | 32 +++++++----
.../{mmc-dev-parts.txt => mmc-dev-parts.rst} | 13 ++---
.../mmc/{mmc-tools.txt => mmc-tools.rst} | 5 +-
5 files changed, 79 insertions(+), 37 deletions(-)
create mode 100644 Documentation/mmc/index.rst
rename Documentation/mmc/{mmc-async-req.txt => mmc-async-req.rst} (75%)
rename Documentation/mmc/{mmc-dev-attrs.txt => mmc-dev-attrs.rst} (73%)
rename Documentation/mmc/{mmc-dev-parts.txt => mmc-dev-parts.rst} (83%)
rename Documentation/mmc/{mmc-tools.txt => mmc-tools.rst} (92%)Documentation/mmc/index.rst new file +13 -0
@@ -0,0 +1,13 @@ +:orphan: + +======================== +MMC/SD/SDIO card support +======================== + +.. toctree:: + :maxdepth: 1 + + mmc-dev-attrs + mmc-dev-parts + mmc-async-req + mmc-tools
Documentation/mmc/mmc-async-req.rst renamed from Documentation/mmc/mmc-async-req.txt +32 -21
96 lines not on this page · raw message
Documentation/mmc/mmc-dev-attrs.rst renamed from Documentation/mmc/mmc-dev-attrs.txt +23 -9
@@ -1,3 +1,4 @@ +================================== SD and MMC Block Device Attributes ==================================
@@ -6,23 +7,29 @@ SD or MMC device. The following attributes are read/write. - force_ro Enforce read-only access even if write protect switch is off. + ======== =============================================== + force_ro Enforce read-only access even if write protect switch is off. + ======== =============================================== SD and MMC Device Attributes ============================ All attributes are read-only. + ====================== =============================================== cid Card Identification Register csd Card Specific Data Register scr SD Card Configuration Register (SD only) date Manufacturing Date (from CID Register) - fwrev Firmware/Product Revision (from CID Register) (SD and MMCv1 only) - hwrev Hardware/Product Revision (from CID Register) (SD and MMCv1 only) + fwrev Firmware/Product Revision (from CID Register) + (SD and MMCv1 only) + hwrev Hardware/Product Revision (from CID Register) + (SD and MMCv1 only) manfid Manufacturer ID (from CID Register) name Product Name (from CID Register) oemid OEM/Application ID (from CID Register) - prv Product Revision (from CID Register) (SD and MMCv4 only) + prv Product Revision (from CID Register) + (SD and MMCv4 only) serial Product Serial Number (from CID Register) erase_size Erase group size preferred_erase_size Preferred erase size
@@ -30,7 +37,10 @@ All attributes are read-only. rel_sectors Reliable write sector count ocr Operation Conditions Register dsr Driver Stage Register - cmdq_en Command Queue enabled: 1 => enabled, 0 => not enabled + cmdq_en Command Queue enabled: + + 1 => enabled, 0 => not enabled + ====================== =============================================== Note on Erase Size and Preferred Erase Size:
@@ -44,14 +54,15 @@ Note on Erase Size and Preferred Erase Size: SD/MMC cards can erase an arbitrarily large area up to and including the whole card. When erasing a large area it may be desirable to do it in smaller chunks for three reasons: - 1. A single erase command will make all other I/O on + + 1. A single erase command will make all other I/O on the card wait. This is not a problem if the whole card is being erased, but erasing one partition will make I/O for another partition on the same card wait for the duration of the erase - which could be a several minutes. - 2. To be able to inform the user of erase progress. - 3. The erase timeout becomes too large to be very + 2. To be able to inform the user of erase progress. + 3. The erase timeout becomes too large to be very useful. Because the erase timeout contains a margin which is multiplied by the size of the erase area, the value can end up being several minutes for large
@@ -72,6 +83,9 @@ Note on Erase Size and Preferred Erase Size: "preferred_erase_size" is in bytes. Note on raw_rpmb_size_mult: + "raw_rpmb_size_mult" is a multiple of 128kB block. + RPMB size in byte is calculated by using the following equation: - RPMB partition size = 128kB x raw_rpmb_size_mult + + RPMB partition size = 128kB x raw_rpmb_size_mult
Documentation/mmc/mmc-dev-parts.rst renamed from Documentation/mmc/mmc-dev-parts.txt +7 -6
@@ -1,3 +1,4 @@ +============================ SD and MMC Device Partitions ============================
@@ -18,18 +19,18 @@ platform, write access is disabled by default to reduce the chance of accidental bricking. To enable write access to /dev/mmcblkXbootY, disable the forced read-only -access with: +access with:: -echo 0 > /sys/block/mmcblkXbootY/force_ro + echo 0 > /sys/block/mmcblkXbootY/force_ro -To re-enable read-only access: +To re-enable read-only access:: -echo 1 > /sys/block/mmcblkXbootY/force_ro + echo 1 > /sys/block/mmcblkXbootY/force_ro The boot partitions can also be locked read only until the next power on, -with: +with:: -echo 1 > /sys/block/mmcblkXbootY/ro_lock_until_next_power_on + echo 1 > /sys/block/mmcblkXbootY/ro_lock_until_next_power_on This is a feature of the card and not of the kernel. If the card does not support boot partition locking, the file will not exist. If the
Documentation/mmc/mmc-tools.rst renamed from Documentation/mmc/mmc-tools.txt +4 -1
@@ -1,14 +1,17 @@ +====================== MMC tools introduction ====================== There is one MMC test tools called mmc-utils, which is maintained by Chris Ball, you can find it at the below public git repository: -http://git.kernel.org/cgit/linux/kernel/git/cjb/mmc-utils.git/ + + http://git.kernel.org/cgit/linux/kernel/git/cjb/mmc-utils.git/ Functions ========= The mmc-utils tools can do the following: + - Print and parse extcsd data. - Determine the eMMC writeprotect status. - Set the eMMC writeprotect status.
Signature · 1 line
2.21.0
PATCH v2 23/29 docs: namespaces: convert to ReST
In reply to Mauro Carvalho ChehabRename the namespaces documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
There are two upper case file names. Rename them to lower case, as we're working to avoid upper case file names at Documentation.
At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings.
---
...{compatibility-list.txt => compatibility-list.rst} | 10 +++++++---
Documentation/namespaces/index.rst | 11 +++++++++++
.../{resource-control.txt => resource-control.rst} | 4 ++++
3 files changed, 22 insertions(+), 3 deletions(-)
rename Documentation/namespaces/{compatibility-list.txt => compatibility-list.rst} (86%)
create mode 100644 Documentation/namespaces/index.rst
rename Documentation/namespaces/{resource-control.txt => resource-control.rst} (89%)Documentation/namespaces/compatibility-list.rst renamed from Documentation/namespaces/compatibility-list.txt +7 -3
@@ -1,4 +1,6 @@ - Namespaces compatibility list +============================= +Namespaces compatibility list +============================= This document contains the information about the problems user may have when creating tasks living in different namespaces.
@@ -7,13 +9,16 @@ Here's the summary. This matrix shows the known problems, that occur when tasks share some namespace (the columns) while living in different other namespaces (the rows): - UTS IPC VFS PID User Net +==== === === === === ==== === +- UTS IPC VFS PID User Net +==== === === === === ==== === UTS X IPC X 1 VFS X PID 1 1 X User 2 2 X Net X +==== === === === === ==== === 1. Both the IPC and the PID namespaces provide IDs to address object inside the kernel. E.g. semaphore with IPCID or
@@ -36,4 +41,3 @@ Net X even having equal UIDs. But currently this is not so. -
Documentation/namespaces/index.rst new file +11 -0
@@ -0,0 +1,11 @@ +:orphan: + +========== +Namespaces +========== + +.. toctree:: + :maxdepth: 1 + + compatibility-list + resource-control
Documentation/namespaces/resource-control.rst renamed from Documentation/namespaces/resource-control.txt +4 -0
@@ -1,3 +1,7 @@ +=========================== +Namespaces research control +=========================== + There are a lot of kinds of objects in the kernel that don't have individual limits or that have limits that are ineffective when a set of processes is allowed to switch user ids. With user namespaces
Signature · 1 line
2.21.0
PATCH v2 11/29 docs: memory-devices: convert ti-emif.txt to ReST
In reply to Mauro Carvalho ChehabPrepare this file to be moved to a kernel book by converting it to ReST format and renaming it to ti-emif.rst.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
---
.../{ti-emif.txt => ti-emif.rst} | 27 ++++++++++++-------
1 file changed, 17 insertions(+), 10 deletions(-)
rename Documentation/memory-devices/{ti-emif.txt => ti-emif.rst} (81%)Documentation/memory-devices/ti-emif.rst renamed from Documentation/memory-devices/ti-emif.txt +17 -10
@@ -1,20 +1,24 @@ -TI EMIF SDRAM Controller Driver: +:orphan: + +=============================== +TI EMIF SDRAM Controller Driver +=============================== Author -======== +====== Aneesh V <[email protected]> Location -============ +======== driver/memory/emif.c Supported SoCs: -=================== +=============== TI OMAP44xx TI OMAP54xx Menuconfig option: -========================== +================== Device Drivers Memory devices Texas Instruments EMIF driver
@@ -29,10 +33,11 @@ functions of the driver includes re-configuring AC timing parameters and other settings during frequency, voltage and temperature changes -Platform Data (see include/linux/platform_data/emif_plat.h): -===================================================================== +Platform Data (see include/linux/platform_data/emif_plat.h) +=========================================================== DDR device details and other board dependent and SoC dependent information can be passed through platform data (struct emif_platform_data) + - DDR device details: 'struct ddr_device_info' - Device AC timings: 'struct lpddr2_timings' and 'struct lpddr2_min_tck' - Custom configurations: customizable policy options through
@@ -40,17 +45,19 @@ information can be passed through platform data (struct emif_platform_data) - IP revision - PHY type -Interface to the external world: -================================ +Interface to the external world +=============================== EMIF driver registers notifiers for voltage and frequency changes affecting EMIF and takes appropriate actions when these are invoked. + - freq_pre_notify_handling() - freq_post_notify_handling() - volt_notify_handling() Debugfs -======== +======= The driver creates two debugfs entries per device. + - regcache_dump : dump of register values calculated and saved for all frequencies used so far. - mr4 : last polled value of MR4 register in the LPDDR2 device. MR4
Signature · 1 line
2.21.0
PATCH v2 14/29 docs: nvmem: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabIn order to be able to add it into a doc book, we need first convert it to ReST.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- mark literal blocks;
- adjust title markups.
While this is not part of any book, mark it as :orphan:, in order to avoid build warnings.
---
Documentation/nvmem/{nvmem.txt => nvmem.rst} | 112 ++++++++++---------
1 file changed, 59 insertions(+), 53 deletions(-)
rename Documentation/nvmem/{nvmem.txt => nvmem.rst} (62%)Documentation/nvmem/nvmem.rst renamed from Documentation/nvmem/nvmem.txt +59 -53
@@ -1,5 +1,10 @@ - NVMEM SUBSYSTEM - Srinivas Kandagatla <[email protected]> +:orphan: + +=============== +NVMEM Subsystem +=============== + + Srinivas Kandagatla <[email protected]> This document explains the NVMEM Framework along with the APIs provided, and how to use it.
@@ -40,54 +45,54 @@ nvmem_device pointer. nvmem_unregister(nvmem) is used to unregister a previously registered provider. -For example, a simple qfprom case: +For example, a simple qfprom case:: -static struct nvmem_config econfig = { + static struct nvmem_config econfig = { .name = "qfprom", .owner = THIS_MODULE, -}; + }; -static int qfprom_probe(struct platform_device *pdev) -{ + static int qfprom_probe(struct platform_device *pdev) + { ... econfig.dev = &pdev->dev; nvmem = nvmem_register(&econfig); ... -} + } It is mandatory that the NVMEM provider has a regmap associated with its struct device. Failure to do would return error code from nvmem_register(). Users of board files can define and register nvmem cells using the -nvmem_cell_table struct: +nvmem_cell_table struct:: -static struct nvmem_cell_info foo_nvmem_cells[] = { + static struct nvmem_cell_info foo_nvmem_cells[] = { { .name = "macaddr", .offset = 0x7f00, .bytes = ETH_ALEN, } -}; + }; -static struct nvmem_cell_table foo_nvmem_cell_table = { + static struct nvmem_cell_table foo_nvmem_cell_table = { .nvmem_name = "i2c-eeprom", .cells = foo_nvmem_cells, .ncells = ARRAY_SIZE(foo_nvmem_cells), -}; + }; -nvmem_add_cell_table(&foo_nvmem_cell_table); + nvmem_add_cell_table(&foo_nvmem_cell_table); Additionally it is possible to create nvmem cell lookup entries and register -them with the nvmem framework from machine code as shown in the example below: +them with the nvmem framework from machine code as shown in the example below:: -static struct nvmem_cell_lookup foo_nvmem_lookup = { + static struct nvmem_cell_lookup foo_nvmem_lookup = { .nvmem_name = "i2c-eeprom", .cell_name = "macaddr", .dev_id = "foo_mac.0", .con_id = "mac-address", -}; + }; -nvmem_add_cell_lookups(&foo_nvmem_lookup, 1); + nvmem_add_cell_lookups(&foo_nvmem_lookup, 1); NVMEM Consumers +++++++++++++++
@@ -99,43 +104,43 @@ read from and to NVMEM. ================================= NVMEM cells are the data entries/fields in the NVMEM. -The NVMEM framework provides 3 APIs to read/write NVMEM cells. +The NVMEM framework provides 3 APIs to read/write NVMEM cells:: -struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *name); -struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *name); + struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *name); + struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *name); -void nvmem_cell_put(struct nvmem_cell *cell); -void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell); + void nvmem_cell_put(struct nvmem_cell *cell); + void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell); -void *nvmem_cell_read(struct nvmem_cell *cell, ssize_t *len); -int nvmem_cell_write(struct nvmem_cell *cell, void *buf, ssize_t len); + void *nvmem_cell_read(struct nvmem_cell *cell, ssize_t *len); + int nvmem_cell_write(struct nvmem_cell *cell, void *buf, ssize_t len); -*nvmem_cell_get() apis will get a reference to nvmem cell for a given id, +`*nvmem_cell_get()` apis will get a reference to nvmem cell for a given id, and nvmem_cell_read/write() can then read or write to the cell. -Once the usage of the cell is finished the consumer should call *nvmem_cell_put() -to free all the allocation memory for the cell. +Once the usage of the cell is finished the consumer should call +`*nvmem_cell_put()` to free all the allocation memory for the cell. 4. Direct NVMEM device based consumer APIs ========================================== In some instances it is necessary to directly read/write the NVMEM. -To facilitate such consumers NVMEM framework provides below apis. +To facilitate such consumers NVMEM framework provides below apis:: -struct nvmem_device *nvmem_device_get(struct device *dev, const char *name); -struct nvmem_device *devm_nvmem_device_get(struct device *dev, + struct nvmem_device *nvmem_device_get(struct device *dev, const char *name); + struct nvmem_device *devm_nvmem_device_get(struct device *dev, const char *name); -void nvmem_device_put(struct nvmem_device *nvmem); -int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset, + void nvmem_device_put(struct nvmem_device *nvmem); + int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset, size_t bytes, void *buf); -int nvmem_device_write(struct nvmem_device *nvmem, unsigned int offset, + int nvmem_device_write(struct nvmem_device *nvmem, unsigned int offset, size_t bytes, void *buf); -int nvmem_device_cell_read(struct nvmem_device *nvmem, + int nvmem_device_cell_read(struct nvmem_device *nvmem, struct nvmem_cell_info *info, void *buf); -int nvmem_device_cell_write(struct nvmem_device *nvmem, + int nvmem_device_cell_write(struct nvmem_device *nvmem, struct nvmem_cell_info *info, void *buf); Before the consumers can read/write NVMEM directly, it should get hold -of nvmem_controller from one of the *nvmem_device_get() api. +of nvmem_controller from one of the `*nvmem_device_get()` api. The difference between these apis and cell based apis is that these apis always take nvmem_device as parameter.
@@ -145,12 +150,12 @@ take nvmem_device as parameter. When a consumer no longer needs the NVMEM, it has to release the reference to the NVMEM it has obtained using the APIs mentioned in the above section. -The NVMEM framework provides 2 APIs to release a reference to the NVMEM. +The NVMEM framework provides 2 APIs to release a reference to the NVMEM:: -void nvmem_cell_put(struct nvmem_cell *cell); -void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell); -void nvmem_device_put(struct nvmem_device *nvmem); -void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem); + void nvmem_cell_put(struct nvmem_cell *cell); + void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell); + void nvmem_device_put(struct nvmem_device *nvmem); + void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem); Both these APIs are used to release a reference to the NVMEM and devm_nvmem_cell_put and devm_nvmem_device_put destroys the devres associated
@@ -162,20 +167,21 @@ Userspace 6. Userspace binary interface ============================== -Userspace can read/write the raw NVMEM file located at -/sys/bus/nvmem/devices/*/nvmem +Userspace can read/write the raw NVMEM file located at:: -ex: + /sys/bus/nvmem/devices/*/nvmem -hexdump /sys/bus/nvmem/devices/qfprom0/nvmem +ex:: -0000000 0000 0000 0000 0000 0000 0000 0000 0000 -* -00000a0 db10 2240 0000 e000 0c00 0c00 0000 0c00 -0000000 0000 0000 0000 0000 0000 0000 0000 0000 -... -* -0001000 + hexdump /sys/bus/nvmem/devices/qfprom0/nvmem + + 0000000 0000 0000 0000 0000 0000 0000 0000 0000 + * + 00000a0 db10 2240 0000 e000 0c00 0c00 0000 0c00 + 0000000 0000 0000 0000 0000 0000 0000 0000 0000 + ... + * + 0001000 7. DeviceTree Binding =====================
Signature · 1 line
2.21.0
Re: [PATCH v2 02/29] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabQuoted 7 lines · Mauro Carvalho Chehab
This small text file describes the usage of parallel port LCD displays from userspace PoV. So, a good candidate for the admin guide.
While this is not part of the admin-guide book, mark it as :orphan:, in order to avoid build warnings.
If we are going to move everything else to .rst too, even things outside the guide, then ack.
Cheers,
Miguel
Re: [PATCH v2 02/29] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst
Em Tue, 18 Jun 2019 23:14:01 +0200
Miguel Ojeda <[email protected]> escreveu:
Quoted 7 lines
Quoted 5 lines · Mauro Carvalho Chehab
This small text file describes the usage of parallel port LCD displays from userspace PoV. So, a good candidate for the admin guide.
Quoted 5 lines
Quoted 2 lines
While this is not part of the admin-guide book, mark it as :orphan:, in order to avoid build warnings.
If we are going to move everything else to
.rsttoo, even things outside the guide, then ack.
Yeah, the plan is to move all text files inside Documentation/ to .rst[1].
[1] There are some exceptions: for ABI and features, the current plan is to have a script that parses their strict formats and produce a ReST output.
Btw, Still pending to be sent, I have already a patch removing the :orphan: from this file and adding it to the admin guide:
https://git.linuxtv.org/mchehab/experimental.git/commit/?h=convert_rst_renames_v5.1&id=eae5b48cab115c83be8dd59ee99b9e45f8142134
And the corresponding output, after the patches I currently have:
https://www.infradead.org/~mchehab/rst_conversion/admin-guide/lcd-panel-cgram.html
Thanks,
Mauro
Quoted 193 lines · Mauro Carvalho Chehab
Those files belong to the driver-api guide. Add them to the driver-api book.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/ABI/removed/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-class-rfkill | 2 +- .../ABI/testing/sysfs-class-switchtec | 2 +- Documentation/PCI/pci.rst | 2 +- Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- .../admin-guide/kernel-parameters.txt | 4 +- .../admin-guide/kernel-per-cpu-kthreads.rst | 2 +- .../{ => driver-api}/atomic_bitops.rst | 2 - Documentation/{ => driver-api}/bt8xxgpio.rst | 2 - .../bus-virt-phys-mapping.rst | 2 - .../{connector => driver-api}/connector.rst | 2 - .../{console => driver-api}/console.rst | 2 - Documentation/{ => driver-api}/crc32.rst | 2 - Documentation/{ => driver-api}/dcdbas.rst | 2 - .../{ => driver-api}/debugging-modules.rst | 2 - .../debugging-via-ohci1394.rst | 2 - Documentation/{ => driver-api}/dell_rbu.rst | 2 - Documentation/{ => driver-api}/digsig.rst | 2 - .../{EDID/howto.rst => driver-api/edid.rst} | 2 - Documentation/{ => driver-api}/eisa.rst | 2 - .../{ => driver-api}/futex-requeue-pi.rst | 2 - .../{ => driver-api}/gcc-plugins.rst | 2 - Documentation/{ => driver-api}/hwspinlock.rst | 2 - Documentation/driver-api/index.rst | 66 +++++++++++++++++++ Documentation/{ => driver-api}/io-mapping.rst | 2 - .../{ => driver-api}/io_ordering.rst | 2 - .../{IPMI.rst => driver-api/ipmi.rst} | 2 - .../irq-affinity.rst} | 2 - .../irq-domain.rst} | 2 - Documentation/{IRQ.rst => driver-api/irq.rst} | 2 - .../{ => driver-api}/irqflags-tracing.rst | 2 - Documentation/{ => driver-api}/isa.rst | 2 - Documentation/{ => driver-api}/isapnp.rst | 2 - Documentation/{ => driver-api}/kobject.rst | 4 +- Documentation/{ => driver-api}/kprobes.rst | 2 - Documentation/{ => driver-api}/kref.rst | 2 - .../pblk.txt => driver-api/lightnvm-pblk.rst} | 0 Documentation/{ => driver-api}/lzo.rst | 2 - Documentation/{ => driver-api}/mailbox.rst | 2 - .../{ => driver-api}/men-chameleon-bus.rst | 2 - Documentation/{ => driver-api}/nommu-mmap.rst | 2 - Documentation/{ => driver-api}/ntb.rst | 2 - Documentation/{nvmem => driver-api}/nvmem.rst | 2 - Documentation/{ => driver-api}/padata.rst | 2 - .../{ => driver-api}/parport-lowlevel.rst | 2 - .../{ => driver-api}/percpu-rw-semaphore.rst | 2 - Documentation/{ => driver-api}/pi-futex.rst | 2 - Documentation/driver-api/pps.rst | 2 - .../{ => driver-api}/preempt-locking.rst | 2 - .../{pti => driver-api}/pti_intel_mid.rst | 2 - Documentation/driver-api/ptp.rst | 2 - Documentation/{ => driver-api}/pwm.rst | 2 - Documentation/{ => driver-api}/rbtree.rst | 2 - Documentation/{ => driver-api}/remoteproc.rst | 4 +- Documentation/{ => driver-api}/rfkill.rst | 2 - .../{ => driver-api}/robust-futex-ABI.rst | 2 - .../{ => driver-api}/robust-futexes.rst | 2 - Documentation/{ => driver-api}/rpmsg.rst | 2 - Documentation/{ => driver-api}/sgi-ioc4.rst | 2 - .../{SM501.rst => driver-api/sm501.rst} | 2 - .../{ => driver-api}/smsc_ece1099.rst | 2 - .../{ => driver-api}/speculation.rst | 8 +-- .../{ => driver-api}/static-keys.rst | 2 - Documentation/{ => driver-api}/switchtec.rst | 4 +- Documentation/{ => driver-api}/sync_file.rst | 2 - Documentation/{ => driver-api}/tee.rst | 2 - .../{ => driver-api}/this_cpu_ops.rst | 2 - .../unaligned-memory-access.rst | 2 - .../{ => driver-api}/vfio-mediated-device.rst | 4 +- Documentation/{ => driver-api}/vfio.rst | 2 - Documentation/{ => driver-api}/xillybus.rst | 2 - Documentation/{ => driver-api}/xz.rst | 2 - Documentation/{ => driver-api}/zorro.rst | 2 - Documentation/driver-model/device.rst | 2 +- Documentation/fb/fbcon.rst | 4 +- Documentation/filesystems/sysfs.txt | 2 +- Documentation/gpu/drm-mm.rst | 2 +- Documentation/ia64/irq-redir.rst | 2 +- Documentation/laptops/thinkpad-acpi.rst | 6 +- Documentation/locking/rt-mutex.rst | 2 +- Documentation/networking/scaling.rst | 4 +- Documentation/s390/vfio-ccw.rst | 6 +- Documentation/sysctl/kernel.rst | 2 +- Documentation/sysctl/vm.rst | 2 +- Documentation/trace/kprobetrace.rst | 2 +- Documentation/translations/zh_CN/IRQ.txt | 4 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/io_ordering.txt | 4 +- Documentation/w1/w1.netlink | 2 +- Documentation/watchdog/hpwdt.rst | 2 +- MAINTAINERS | 46 ++++++------- arch/Kconfig | 4 +- arch/unicore32/include/asm/io.h | 2 +- drivers/base/core.c | 2 +- drivers/char/ipmi/Kconfig | 2 +- drivers/char/ipmi/ipmi_si_hotmod.c | 2 +- drivers/char/ipmi/ipmi_si_intf.c | 2 +- drivers/dma-buf/Kconfig | 2 +- drivers/gpio/Kconfig | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/pci/switch/Kconfig | 2 +- drivers/platform/x86/Kconfig | 4 +- drivers/platform/x86/dcdbas.c | 2 +- drivers/platform/x86/dell_rbu.c | 2 +- drivers/pnp/isapnp/Kconfig | 2 +- drivers/tty/Kconfig | 2 +- drivers/vfio/Kconfig | 2 +- drivers/vfio/mdev/Kconfig | 2 +- drivers/w1/Kconfig | 2 +- include/asm-generic/bitops/atomic.h | 2 +- include/linux/io-mapping.h | 2 +- include/linux/jump_label.h | 2 +- include/linux/kobject.h | 2 +- include/linux/kobject_ns.h | 2 +- include/linux/rbtree.h | 2 +- include/linux/rbtree_augmented.h | 2 +- init/Kconfig | 2 +- kernel/padata.c | 2 +- lib/Kconfig | 2 +- lib/Kconfig.debug | 2 +- lib/crc32.c | 2 +- lib/kobject.c | 4 +- lib/lzo/lzo1x_decompress_safe.c | 2 +- lib/xz/Kconfig | 2 +- mm/Kconfig | 2 +- mm/nommu.c | 2 +- samples/Kconfig | 2 +- samples/kprobes/kprobe_example.c | 2 +- samples/kprobes/kretprobe_example.c | 2 +- scripts/gcc-plugins/Kconfig | 2 +- tools/include/linux/rbtree.h | 2 +- tools/include/linux/rbtree_augmented.h | 2 +- 132 files changed, 173 insertions(+), 235 deletions(-) rename Documentation/{ => driver-api}/atomic_bitops.rst (99%) rename Documentation/{ => driver-api}/bt8xxgpio.rst (99%) rename Documentation/{ => driver-api}/bus-virt-phys-mapping.rst (99%) rename Documentation/{connector => driver-api}/connector.rst (99%) rename Documentation/{console => driver-api}/console.rst (99%) rename Documentation/{ => driver-api}/crc32.rst (99%) rename Documentation/{ => driver-api}/dcdbas.rst (99%) rename Documentation/{ => driver-api}/debugging-modules.rst (98%) rename Documentation/{ => driver-api}/debugging-via-ohci1394.rst (99%) rename Documentation/{ => driver-api}/dell_rbu.rst (99%) rename Documentation/{ => driver-api}/digsig.rst (99%) rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (99%) rename Documentation/{ => driver-api}/eisa.rst (99%) rename Documentation/{ => driver-api}/futex-requeue-pi.rst (99%) rename Documentation/{ => driver-api}/gcc-plugins.rst (99%) rename Documentation/{ => driver-api}/hwspinlock.rst (99%) rename Documentation/{ => driver-api}/io-mapping.rst (99%) rename Documentation/{ => driver-api}/io_ordering.rst (99%) rename Documentation/{IPMI.rst => driver-api/ipmi.rst} (99%) rename Documentation/{IRQ-affinity.rst => driver-api/irq-affinity.rst} (99%) rename Documentation/{IRQ-domain.rst => driver-api/irq-domain.rst} (99%) rename Documentation/{IRQ.rst => driver-api/irq.rst} (99%) rename Documentation/{ => driver-api}/irqflags-tracing.rst (99%) rename Documentation/{ => driver-api}/isa.rst (99%) rename Documentation/{ => driver-api}/isapnp.rst (98%) rename Documentation/{ => driver-api}/kobject.rst (99%) rename Documentation/{ => driver-api}/kprobes.rst (99%) rename Documentation/{ => driver-api}/kref.rst (99%) rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%) rename Documentation/{ => driver-api}/lzo.rst (99%) rename Documentation/{ => driver-api}/mailbox.rst (99%) rename Documentation/{ => driver-api}/men-chameleon-bus.rst (99%) rename Documentation/{ => driver-api}/nommu-mmap.rst (99%) rename Documentation/{ => driver-api}/ntb.rst (99%) rename Documentation/{nvmem => driver-api}/nvmem.rst (99%) rename Documentation/{ => driver-api}/padata.rst (99%) rename Documentation/{ => driver-api}/parport-lowlevel.rst (99%) rename Documentation/{ => driver-api}/percpu-rw-semaphore.rst (99%) rename Documentation/{ => driver-api}/pi-futex.rst (99%) rename Documentation/{ => driver-api}/preempt-locking.rst (99%) rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%) rename Documentation/{ => driver-api}/pwm.rst (99%) rename Documentation/{ => driver-api}/rbtree.rst (99%) rename Documentation/{ => driver-api}/remoteproc.rst (99%) rename Documentation/{ => driver-api}/rfkill.rst (99%) rename Documentation/{ => driver-api}/robust-futex-ABI.rst (99%) rename Documentation/{ => driver-api}/robust-futexes.rst (99%) rename Documentation/{ => driver-api}/rpmsg.rst (99%) rename Documentation/{ => driver-api}/sgi-ioc4.rst (99%) rename Documentation/{SM501.rst => driver-api/sm501.rst} (99%) rename Documentation/{ => driver-api}/smsc_ece1099.rst (99%) rename Documentation/{ => driver-api}/speculation.rst (99%) rename Documentation/{ => driver-api}/static-keys.rst (99%) rename Documentation/{ => driver-api}/switchtec.rst (97%) rename Documentation/{ => driver-api}/sync_file.rst (99%)
Quoted 8 lines
rename Documentation/{ => driver-api}/tee.rst (99%)
rename Documentation/{ => driver-api}/this_cpu_ops.rst (99%)
rename Documentation/{ => driver-api}/unaligned-memory-access.rst (99%)
rename Documentation/{ => driver-api}/vfio-mediated-device.rst (99%)
rename Documentation/{ => driver-api}/vfio.rst (99%)
rename Documentation/{ => driver-api}/xillybus.rst (99%)
rename Documentation/{ => driver-api}/xz.rst (99%)
rename Documentation/{ => driver-api}/zorro.rst (99%)Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 10 lines · Mauro Carvalho Chehab
Documentation/gpu/drm-mm.rst +1
-1@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rst
Random drive-by comment: Could we convert these into hyperlinks within sphinx somehow, without making them less useful as raw file references (with vim I can just type 'gf' and it works, emacs probably the same). -Daniel
Signature · 3 lines
Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch
Hi Daniel,
Em Wed, 19 Jun 2019 11:05:57 +0200
Daniel Vetter <[email protected]> escreveu:
Quoted 9 lines
Quoted 7 lines · Mauro Carvalho Chehab
Documentation/gpu/drm-mm.rst +0
-0@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`.
Quoted 8 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 3 lines
Documentation/gpu/drm-mm.rst +1
-1More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstRandom drive-by comment: Could we convert these into hyperlinks within sphinx somehow, without making them less useful as raw file references (with vim I can just type 'gf' and it works, emacs probably the same). -Daniel
Short answer: I don't know how vim/emacs would recognize Sphinx tags.
There are two ways of doing hyperlinks to local files. The first one is to add a label at the other file and use a reference to such label, e. g. at nommu-mmap.rst, you would add a label like:
.. _drm_nommu-mmap:
at the beginning of the file.
Then, at drm-mm.rst, you would use :ref:drm_nommu-mmap (there are a few other alternative tags that would work the same way).
The advantage is that you could move/rename documents anytime, without needing to take care of it.
Perhaps it could be possible a tool like cscope to parse those in order to provide such automation for Sphinx. I dunno.
-
The other way is to use:
:doc:nommu-mmap.rst (if both files are at the same dir)
The :doc: path is the current directory. So, if a file at, let's say, Documentation/gpu wants to refer another file at driver-api, it would need to write it as:
:doc:`../driver-api/nommu-mmap.rst`
I'm not sure if vim/emacs recognizes this syntax, though.
Perhaps this tag could be used as:
:doc:Documentation/driver-api/nommu-mmap.rst <../driver-api/nommu-map.rst
But that looks too ugly to my taste.
-
On this conversion, I opted to not touch this. We may consider trying to replace those
Thanks,
Mauro
Peter Zijlstra
maintainerQuoted 23 lines · Mauro Carvalho Chehab
Hi Daniel,
Em Wed, 19 Jun 2019 11:05:57 +0200
Daniel Vetter <[email protected]> escreveu:Quoted 9 lines
Quoted 7 lines · Mauro Carvalho Chehab
Documentation/gpu/drm-mm.rst +0
-0@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`.Quoted 8 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 3 lines
Documentation/gpu/drm-mm.rst +1
-1More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstRandom drive-by comment: Could we convert these into hyperlinks within sphinx somehow, without making them less useful as raw file references (with vim I can just type 'gf' and it works, emacs probably the same). -Daniel
Quoted 1 line
Short answer: I don't know how vim/emacs would recognize Sphinx tags.
No, the other way around, Sphinx can recognize local files and treat them special. That way we keep the text readable.
Same with that :c:func:'foo' crap, that needs to die, and Sphinx needs to be taught about foo().
Peter Zijlstra
maintainerQuoted 1 line · Mauro Carvalho Chehab
.../{ => driver-api}/atomic_bitops.rst | 2 -That's a .txt file, big fat NAK for making it an rst.
Quoted 6 lines
.../{ => driver-api}/futex-requeue-pi.rst | 2 -.../{ => driver-api}/gcc-plugins.rst | 2 -Documentation/{ => driver-api}/kprobes.rst | 2 - .../{ => driver-api}/percpu-rw-semaphore.rst | 2 -
More NAK for rst conversion
Quoted 8 lines
Documentation/{ => driver-api}/pi-futex.rst | 2 - .../{ => driver-api}/preempt-locking.rst | 2 -Documentation/{ => driver-api}/rbtree.rst | 2 -.../{ => driver-api}/robust-futex-ABI.rst | 2 - .../{ => driver-api}/robust-futexes.rst | 2 -
Quoted 6 lines
.../{ => driver-api}/speculation.rst | 8 +-- .../{ => driver-api}/static-keys.rst | 2 -.../{ => driver-api}/this_cpu_ops.rst | 2 -Documentation/locking/rt-mutex.rst | 2 +-
NAK. None of the above have anything to do with driver-api.
Peter Zijlstra
maintainerQuoted 5 lines · Peter Zijlstra
Quoted 1 line · Mauro Carvalho Chehab
.../{ => driver-api}/atomic_bitops.rst | 2 -That's a .txt file, big fat NAK for making it an rst.
Also, how many bloody times do I have to keep telling this? It is starting to get _REALLY_ annoying.
Peter Zijlstra
maintainerQuoted 9 lines · Peter Zijlstra
Quoted 5 lines · Peter Zijlstra
Quoted 1 line · Mauro Carvalho Chehab
.../{ => driver-api}/atomic_bitops.rst | 2 -That's a .txt file, big fat NAK for making it an rst.
Also, how many bloody times do I have to keep telling this? It is starting to get _REALLY_ annoying.
Also, cross-posting to moderated lists is rude.
Quoted 1 line · Peter Zijlstra
Also, cross-posting to moderated lists is rude.
It's even worse with partially-pre-moderated lists, because then list moderators are forced to either accept all the mostly off-topic messages (as some follow-ups from other lists would get through anyway, and would be out of context if a message in a thread were rejected) or switch the list to fully pre-moderated with no exceptions for anyone (and then it's more work and greater delays on desirable messages).
I already brought this up with Mauro off-list, and I hope we'll see no more of these threads on kernel-hardening, but we'll have to let the rest of already started threads through.
I think this has significant negative effect on the kernel-hardening project, shifting it further towards and beyond security circus (to non-security circus now) and thereby discouraging desirable contributions, whereas the (one relevant) file rename is unimportant (and buried in lots of other renames).
Alexander
Quoted 1 line
rename Documentation/{ => driver-api}/atomic_bitops.rst (99%)Same here: NAK, this document does not belong to driver-api.
I also realize that, despite previous notices, you keep touching documentation without even CC-ing the people who care...
Andrea
Em Wed, 19 Jun 2019 12:42:39 +0200
Peter Zijlstra <[email protected]> escreveu:
(reduced the C/C to just the relevant ML/people)
Quoted 24 lines · Mauro Carvalho Chehab
Quoted 23 lines
Hi Daniel,
Em Wed, 19 Jun 2019 11:05:57 +0200
Daniel Vetter <[email protected]> escreveu:Quoted 17 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 10 lines · Mauro Carvalho Chehab
Documentation/gpu/drm-mm.rst +1
-1@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstRandom drive-by comment: Could we convert these into hyperlinks within sphinx somehow, without making them less useful as raw file references (with vim I can just type 'gf' and it works, emacs probably the same). -Daniel
Quoted 7 lines
Quoted 1 line
Short answer: I don't know how vim/emacs would recognize Sphinx tags.
No, the other way around, Sphinx can recognize local files and treat them special. That way we keep the text readable.
Same with that :c:func:'foo' crap, that needs to die, and Sphinx needs to be taught about
foo().
Just did a test today with Jon's extension with is meant to replace :c:func:'foo' (with is currently on a separate 'automarkup' branch). At least the version therestill needs some work, as it currently mangles with titles and tables. like on those warnings/errors:
6.4 :c:func:resync_start(), :c:func:resync_finish()
-----------------------------------
/devel/v4l/docs/Documentation/driver-api/md/md-cluster.rst:323: WARNING: Title underline too short.
/devel/v4l/docs/Documentation/driver-api/serial/tty.rst:74: WARNING: Malformed table. Text in column margin in table line 34.
======================= =======================================================
:c:func:open() Called when the line discipline is attached to
-
That's said, once it gets fixed to address those complex cases, a regex like:
\bDocumentation/([\w\d\-\_\/]+)\.rst\b
could be used to convert to :doc: tag. It should be smart enough to convert the relative paths, as we refer to the files from the git root directory (with makes a lot sense to me), while Sphinx :doc: use relative patches from the location where the parsed file is.
Something like the enclosed patch.
Thanks,
Mauro
[PATCH] automarkup.py: convert Documentation/* to hyperlinks
Auto-create hyperlinks when it finds a Documentation/.. occurrence.
Documentation/sphinx/automarkup.py +28 -1
@@ -9,6 +9,7 @@ from __future__ import print_function import re import sphinx +#import sys # Just for debug # # Regex nastiness. Of course.
@@ -31,10 +32,26 @@ RE_literal = re.compile(r'^(\s*)(.*::\s*|\.\.\s+code-block::.*)$') # RE_whitesp = re.compile(r'^(\s*)') +# +# Get a documentation reference +# +RE_doc_links = re.compile(r'\bDocumentation/([\w\d\-\_\/]+)\.rst\b') + +# +# Doc link false-positives +# +RE_false_doc_links = re.compile(r':ref:`\s*Documentation/[\w\d\-\_\/]+\.rst') + def MangleFile(app, docname, text): ret = [ ] previous = '' literal = False + + rel_dir = '' + + for depth in range(0, docname.count('/')): + rel_dir += "../" + for line in text[0].split('\n'): # # See if we might be ending a literal block, as denoted by
@@ -63,7 +80,17 @@ def MangleFile(app, docname, text): # Normal line - perform substitutions. # else: - ret.append(RE_function.sub(r'\1:c:func:`\2`\3', line)) + new_line = RE_function.sub(r'\1:c:func:`\2`\3', line) + + if not RE_false_doc_links.search(new_line): + new_line = RE_doc_links.sub(r':doc:`' + rel_dir + r'\1`', new_line) + + # # Just for debug - should be removed on production + # if new_line != line: + # print ("===>" + new_line, file=sys.stderr) + + ret.append(new_line) + # # Might we be starting a literal block? If so make note of # the fact.
Em Wed, 19 Jun 2019 12:42:39 +0200
Peter Zijlstra <[email protected]> escreveu:
Quoted 24 lines · Mauro Carvalho Chehab
Quoted 23 lines
Hi Daniel,
Em Wed, 19 Jun 2019 11:05:57 +0200
Daniel Vetter <[email protected]> escreveu:Quoted 17 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 10 lines · Mauro Carvalho Chehab
Documentation/gpu/drm-mm.rst +1
-1@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstRandom drive-by comment: Could we convert these into hyperlinks within sphinx somehow, without making them less useful as raw file references (with vim I can just type 'gf' and it works, emacs probably the same). -Daniel
Quoted 7 lines
Quoted 1 line
Short answer: I don't know how vim/emacs would recognize Sphinx tags.
No, the other way around, Sphinx can recognize local files and treat them special. That way we keep the text readable.
Same with that :c:func:'foo' crap, that needs to die, and Sphinx needs to be taught about
foo().
Just did a test today at Jon's extension (with is currently on a separate branch). At least the version that it is there at his automarkup branch still needs some work, as it currently breaks titles and tables:
6.4 :c:func:resync_start(), :c:func:resync_finish()
-----------------------------------
/devel/v4l/docs/Documentation/driver-api/md/md-cluster.rst:323: WARNING: Title underline too short.
/devel/v4l/docs/Documentation/driver-api/serial/tty.rst:74: WARNING: Malformed table. Text in column margin in table line 34.
======================= =======================================================
:c:func:open() Called when the line discipline is attached to
-
That's said, once it gets fixed to address those complex cases, a regex like:
\bDocumentation/([\w\d\-\_\/]+)\.rst\b
could be converted to :doc: tag. It should be smart enough to convert the relative paths, as we refer to the files from the git root directory (with makes a lot sense to me), while Sphinx :doc: use relative patches from the location where the parsed file is.
Something like the enclosed patch.
Thanks,
Mauro
[PATCH] automarkup.py: convert Documentation/* to hyperlinks
Auto-create hyperlinks when it finds a Documentation/.. occurrence.
Documentation/sphinx/automarkup.py +28 -1
@@ -9,6 +9,7 @@ from __future__ import print_function import re import sphinx +#import sys # Just for debug # # Regex nastiness. Of course.
@@ -31,10 +32,26 @@ RE_literal = re.compile(r'^(\s*)(.*::\s*|\.\.\s+code-block::.*)$') # RE_whitesp = re.compile(r'^(\s*)') +# +# Get a documentation reference +# +RE_doc_links = re.compile(r'\bDocumentation/([\w\d\-\_\/]+)\.rst\b') + +# +# Doc link false-positives +# +RE_false_doc_links = re.compile(r':ref:`\s*Documentation/[\w\d\-\_\/]+\.rst') + def MangleFile(app, docname, text): ret = [ ] previous = '' literal = False + + rel_dir = '' + + for depth in range(0, docname.count('/')): + rel_dir += "../" + for line in text[0].split('\n'): # # See if we might be ending a literal block, as denoted by
@@ -63,7 +80,17 @@ def MangleFile(app, docname, text): # Normal line - perform substitutions. # else: - ret.append(RE_function.sub(r'\1:c:func:`\2`\3', line)) + new_line = RE_function.sub(r'\1:c:func:`\2`\3', line) + + if not RE_false_doc_links.search(new_line): + new_line = RE_doc_links.sub(r':doc:`' + rel_dir + r'\1`', new_line) + + # # Just for debug - should be removed on production + # if new_line != line: + # print ("===>" + new_line, file=sys.stderr) + + ret.append(new_line) + # # Might we be starting a literal block? If so make note of # the fact.
(c/c list cleaned)
Em Wed, 19 Jun 2019 13:43:56 +0200
Peter Zijlstra <[email protected]> escreveu:
Quoted 5 lines · Mauro Carvalho Chehab
Quoted 2 lines
.../{ => driver-api}/atomic_bitops.rst | 2 -That's a .txt file, big fat NAK for making it an rst.
Rst is a text file. This one is parsed properly by Sphinx without any changes.
Quoted 9 lines
Quoted 7 lines
.../{ => driver-api}/futex-requeue-pi.rst | 2 -.../{ => driver-api}/gcc-plugins.rst | 2 -Documentation/{ => driver-api}/kprobes.rst | 2 - .../{ => driver-api}/percpu-rw-semaphore.rst | 2 -More NAK for rst conversion
Again, those don't need any conversion. Those files already parse as-is by Sphinx, with no need for any change.
The only change here is that, on patch 1/22, the files that aren't listed on an index file got a :orphan: added in order to make this explicit. This patch removes it.
Quoted 9 lines
Quoted 8 lines
Documentation/{ => driver-api}/pi-futex.rst | 2 - .../{ => driver-api}/preempt-locking.rst | 2 -Documentation/{ => driver-api}/rbtree.rst | 2 -.../{ => driver-api}/robust-futex-ABI.rst | 2 - .../{ => driver-api}/robust-futexes.rst | 2 -
Quoted 8 lines
Quoted 6 lines
.../{ => driver-api}/speculation.rst | 8 +-- .../{ => driver-api}/static-keys.rst | 2 -.../{ => driver-api}/this_cpu_ops.rst | 2 -Documentation/locking/rt-mutex.rst | 2 +-NAK. None of the above have anything to do with driver-api.
Ok. Where do you think they should sit instead? core-api?
Thanks,
Mauro
Em Wed, 19 Jun 2019 14:13:08 +0200
Solar Designer <[email protected]> escreveu:
Quoted 10 lines · Peter Zijlstra
Quoted 1 line
Also, cross-posting to moderated lists is rude.
It's even worse with partially-pre-moderated lists, because then list moderators are forced to either accept all the mostly off-topic messages (as some follow-ups from other lists would get through anyway, and would be out of context if a message in a thread were rejected) or switch the list to fully pre-moderated with no exceptions for anyone (and then it's more work and greater delays on desirable messages).
Quoted 3 lines
I already brought this up with Mauro off-list, and I hope we'll see no more of these threads on kernel-hardening, but we'll have to let the rest of already started threads through.
I'll take care on a next review to explicitly remove kernel-hardening.
As I pointed in priv, as gcc-plugins file is listed at MAINTAINERS, except if someone actively remove kernel-hardening ML from get_maintainers.pl results, you'll likely keep receiving e-mails with patches that will be touching it.
Quoted 5 lines
I think this has significant negative effect on the kernel-hardening project, shifting it further towards and beyond security circus (to non-security circus now) and thereby discouraging desirable contributions, whereas the (one relevant) file rename is unimportant (and buried in lots of other renames).
Sorry for that.
Thanks,
Mauro
Quoted 2 lines · Mauro Carvalho Chehab
Quoted 2 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 2 lines
Documentation/gpu/drm-mm.rst +1
-1-Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rst
Why is this moving to Documentation/driver-api? It's less to do with drivers than with the userspace mapping interface. Documentation/vm/ would seem a better home.
Or should we institute a Documentation/uapi/? Though that might be seen to overlap with man2. Actually, should this be in man7?
David
Jonathan Corbet
maintainerQuoted 5 lines · On Wed, 19 Jun 2019 12:42:39 +0200 Peter Zijlstra <[email protected]> wrote:
No, the other way around, Sphinx can recognize local files and treat them special. That way we keep the text readable.
Same with that :c:func:'foo' crap, that needs to die, and Sphinx needs to be taught about
foo().
I did a patch to make that latter part happen, but haven't been able to find the time to address the comments and get it out there. It definitely cleaned up the source files a lot and is worth doing. Will try to get back to it soon.
The local file links should be easy to do; we shouldn't need to add any markup for those.
jon
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Hi David,
Em Wed, 19 Jun 2019 14:39:10 +0100
David Howells <[email protected]> escreveu:
Quoted 6 lines
Quoted 2 lines · Mauro Carvalho Chehab
Quoted 2 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 2 lines
Documentation/gpu/drm-mm.rst +1
-1-Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstWhy is this moving to
Documentation/driver-api?
Good point. I tried to do my best with those document renames, but I'm pretty sure some of them ended by going to the wrong place - or at least there are arguments in favor of moving it to different places :-)
The driver-api ended to be where most of the stuff has been moved, as this is the main kAPI dir (there is also a core-api dir for kAPI too).
I tend to place there stuff that has a mix of kAPI and uAPI at driver-api, as usually such documents are written assuming that the one that would be reading it is a Kernel developer.
Quoted 6 lines
It's less to do with drivers
than with the userspace mapping interface.Documentation/vm/would seem a better home.Or should we institute a
Documentation/uapi/? Though that might be seen to overlap with man2. Actually, should this be in man7?
Actually, there is an userspace-api dir too. While the logs show that this was created back on 2017, I only noticed it very recently.
Re-checking the file, I see your point: there are lots of userspace-relevant contents there. Yet, it also mentions kAPI internals, like a reference for file and vm ops (at "Providing shareable character device support" session):
file->f_op->get_unmapped_area() file->f_op->mmap() vm_ops->close()
It is up to MM people and Jon to decide where to place it.
In any case, the best (long term) seems to split it on separate files, one with kAPI and another one with uAPI (just like may other subsystem specific docs).
Thanks,
Mauro
Jonathan Corbet
maintainer[Trimming the CC list from hell made sense, but it might have been better to leave me on it...]
Quoted 10 lines · On Wed, 19 Jun 2019 11:15:28 -0300 Mauro Carvalho Chehab…
Em Wed, 19 Jun 2019 14:39:10 +0100
David Howells <[email protected]> escreveu:Quoted 6 lines
Quoted 2 lines · Mauro Carvalho Chehab
Quoted 2 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 2 lines
Documentation/gpu/drm-mm.rst +1
-1-Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstWhy is this moving to
Documentation/driver-api?
Quoted 4 lines
Good point. I tried to do my best with those document renames, but I'm pretty sure some of them ended by going to the wrong place - or at least there are arguments in favor of moving it to different places :-)
I think that a lot of this might also be an argument for slowing down just a little bit. I really don't think that blasting through and reformatting all of our text documents is the most urgent problem right now and, in cases like this, it might create others.
Organization of the documentation tree is important; it has never really gotten any attention so far, and we're trying to make it better. But moving documents will, by its nature, annoy people. We can generally get past that, but I'd really like to avoid moving things twice. In general, I would rather see a single document converted, read critically and updated, and carefully integrated with the rest than a hundred of them swept into different piles...
See what I'm getting at?
Thanks,
jon
Hi Jon,
Em Wed, 19 Jun 2019 08:13:53 -0600
Jonathan Corbet <[email protected]> escreveu:
Quoted 6 lines
Quoted 3 lines · On Wed, 19 Jun 2019 12:42:39 +0200 Peter Zijlstra <[email protected]> wrote:
No, the other way around, Sphinx can recognize local files and treat them special. That way we keep the text readable.
Quoted 7 lines
Quoted 2 lines
Same with that :c:func:'foo' crap, that needs to die, and Sphinx needs to be taught about
foo().I did a patch to make that latter part happen, but haven't been able to find the time to address the comments and get it out there. It definitely cleaned up the source files a lot and is worth doing. Will try to get back to it soon.
See my comment. Yeah, the :c:func:'foo' (the version you merged at the automarkup branch) has currently a bug, when there's something like:
func() ======
or when func() is inside a table.
Solving the table case would be a lot better if the plugin could run the existing table parser and only then handle the cross-reference replacements, but I've no idea how flexible the Sphinx plugins can be.
Quoted 3 lines
The local file links should be easy to do; we shouldn't need to add any markup for those.
Yeah, those are easy - except if someone adds a Documentation/* link inside a table or inside a topic header.
Running a modified version of your tool shows just two new warnings:
Documentation/translations/ja_JP/howto.rst:176: WARNING: undefined label: :doc: (if the link has no caption the label must precede a section header) Documentation/translations/zh_CN/process/submitting-drivers.rst:25: WARNING: unknown document: ../../../Documentation/translations/zh_CN/process/submitting-patches
The first one is because of this:
:Ref:Documentation/process/kernel-docs.rst <kernel_docs>
(my parser didn't consider upper-case tags - a simple fix at a regex should fix this)
The second one is because the URL is wrong. It is pointing to:
Documentation/Documentation/translations/zh_CN/process/submitting-patches
at Chinese translation.
So, at least the way our documentation is, the plugin seems to be working as expected.
As a reference, I'm enclosing the diff against your patch:
commit 6231d7456e87bd3e11f892709945887bd55a8a20 (docs/automarkup)
Author: Jonathan Corbet <[email protected]>
Date: Thu Apr 25 07:55:07 2019 -0600
Docs: An initial automarkup extension for sphinx
Rather than fill our text files with :c:func:function() syntax, just do the markup via a hook into the sphinx build process. As is always the case, the real problem is detecting the situations where this markup should *not* be done.
Thanks,
Mauro
-
Documentation/sphinx/automarkup.py +29 -1
@@ -9,6 +9,7 @@ from __future__ import print_function import re import sphinx +#import sys # Just for debug # # Regex nastiness. Of course.
@@ -31,10 +32,26 @@ RE_literal = re.compile(r'^(\s*)(.*::\s*|\.\.\s+code-block::.*)$') # RE_whitesp = re.compile(r'^(\s*)') +# +# Get a documentation reference +# +RE_doc_links = re.compile(r'\bDocumentation/([\w\d\-\_\/]+)\.rst\b') + +# +# Doc link false-positives +# +RE_false_doc_links = re.compile(r':ref:`\s*Documentation/[\w\d\-\_\/]+\.rst') + def MangleFile(app, docname, text): ret = [ ] previous = '' literal = False + + rel_dir = '' + + for depth in range(0, docname.count('/')): + rel_dir += "../" + for line in text[0].split('\n'): # # See if we might be ending a literal block, as denoted by
@@ -63,7 +80,18 @@ def MangleFile(app, docname, text): # Normal line - perform substitutions. # else: - ret.append(RE_function.sub(r'\1:c:func:`\2`\3', line)) +# new_line = RE_function.sub(r'\1:c:func:`\2`\3', line) + new_line = line + + if not RE_false_doc_links.search(new_line): + new_line = RE_doc_links.sub(r':doc:`' + rel_dir + r'\1`', new_line) + + # # Just for debug - should be removed on production + # if new_line != line: + # print ("===>" + new_line, file=sys.stderr) + + ret.append(new_line) + # # Might we be starting a literal block? If so make note of # the fact.
Quoted 7 lines · Jonathan Corbet
Organization of the documentation tree is important; it has never really gotten any attention so far, and we're trying to make it better. But moving documents will, by its nature, annoy people. We can generally get past that, but I'd really like to avoid moving things twice. In general, I would rather see a single document converted, read critically and updated, and carefully integrated with the rest than a hundred of them swept into different piles...
FWIW, as a first step, my preference would actually be cleaning up the top level Documentation/ directory. Move every file to an existing or a new subdirectory, even if just as .txt, or just delete. I understand this would lead to an extra rst conversion and extension change later, which you'd like to avoid, but IMO would be helpful.
We could even add an attic directory, which would be a suitable place for things like zorro.txt. Attic is where I'd look for my old Amiga hardware, so feels natural.
BR,
Jani.
Signature · 1 line
Jani Nikula, Intel Open Source Graphics Center
Em Wed, 19 Jun 2019 08:54:58 -0600
Jonathan Corbet <[email protected]> escreveu:
Quoted 34 lines
[Trimming the CC list from hell made sense, but it might have been better to leave me on it...]
Quoted 10 lines · On Wed, 19 Jun 2019 11:15:28 -0300 Mauro Carvalho Chehab…
Em Wed, 19 Jun 2019 14:39:10 +0100
David Howells <[email protected]> escreveu:Quoted 6 lines
Quoted 2 lines · Mauro Carvalho Chehab
Quoted 2 lines
Documentation/gpu/drm-mm.rst struct :c:type:`struct file_operations <file_operations>` get_unmapped_area · line 323
Quoted 2 lines
Documentation/gpu/drm-mm.rst +1
-1-Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rstWhy is this moving to
Documentation/driver-api?Quoted 4 lines
Good point. I tried to do my best with those document renames, but I'm pretty sure some of them ended by going to the wrong place - or at least there are arguments in favor of moving it to different places :-)
I think that a lot of this might also be an argument for slowing down just a little bit. I really don't think that blasting through and reformatting all of our text documents is the most urgent problem right now and, in cases like this, it might create others.
Organization of the documentation tree is important; it has never really gotten any attention so far, and we're trying to make it better. But moving documents will, by its nature, annoy people. We can generally get past that, but I'd really like to avoid moving things twice. In general, I would rather see a single document converted, read critically and updated, and carefully integrated with the rest than a hundred of them swept into different piles...
Quoted 1 line
See what I'm getting at?
I see what you mean, and I agree with this principle. That's basically why I split the patches into two groups.
The first group (with comes first) does just the conversion and renames from txt to rst, adding a :orphan: to the stuff that was just converted.
On this series, those are patches 1 to 11. I was already expecting some heat on patch 1.
The next group of patches do the renaming part. Those are the ones that actually took me a lot more time, as I needed to quickly read several docs in order to understand what's happening, before proposing a change.
That's also the group of patches were I expect more active comments, as there are several cases where this is not obvious.
Yet, from what I saw, there are some documents that sounds easy to move, like Documentation/laptops, with (except if I missed something) clearly belongs to admin-guide.
Applying the second patch series and patches 2 to 11 from this third series is, IMHO, a good thing to do.
-
IMO, patches 1 and 12 are important, as, after those patches, the /Documentation dir becomes a lot cleaner:
$ ls -F Documentation/ ABI/ fb/ locking/ s390/ accounting/ features/ logo.gif scheduler/ acpi/ filesystems/ logo.txt scsi/ admin-guide/ firmware_class/ m68k/ security/ arm/ firmware-guide/ maintainer/ sh/ arm64/ fpga/ Makefile sound/ auxdisplay/ gpio/ media/ sparc/ block/ gpu/ mic/ sphinx/ bpf/ hid/ mips/ sphinx-static/ cdrom/ hwmon/ misc-devices/ spi/ Changes@ i2c/ Module.symvers SubmittingPatches CodingStyle ia64/ netlabel/ target/ conf.py ide/ networking/ timers/ core-api/ iio/ nios2/ trace/ cpu-freq/ index.rst openrisc/ translations/ crypto/ infiniband/ output/ usb/ devicetree/ input/ packing.txt userspace-api/ dev-tools/ ioctl/ parisc/ virtual/ DocBook/ IPMB.txt PCI/ vm/ doc-guide/ isdn/ pcmcia/ w1/ docutils.conf kbuild/ power/ watchdog/ dontdiff Kconfig powerpc/ wimax/ driver-api/ kernel-hacking/ process/ x86/ EDID/ leds/ RCU/ xtensa/ fault-injection/ livepatch/ riscv/
Being easy to identify when someone tries to add a new text file there without thinking on where it would fit[1], and to reorganize the directory tree in a way that it will fit our needs.
[1] Btw, there are some two files at linux-next, incrementally increasing the Documentation/ mess:
IPMB.txt and packing.txt.
Added on those commits:
commit 51bd6f291583684f495ea498984dfc22049d7fd2 Author: Asmaa Mnebhi <[email protected]> Date: Mon Jun 10 14:57:02 2019 -0400 Add support for IPMB driver commit 554aae35007e49f533d3d10e788295f7141725bc Author: Vladimir Oltean <[email protected]> Date: Thu May 2 23:23:29 2019 +0300 lib: Add support for generic packing operations
We'll never finish organizing documents while people don't stop adding new files to Documentation/ directory.
Thanks,
Mauro
Peter Zijlstra
maintainerQuoted 5 lines · Mauro Carvalho Chehab
(c/c list cleaned)
Em Wed, 19 Jun 2019 13:43:56 +0200
Peter Zijlstra <[email protected]> escreveu:
Quoted 8 lines
Quoted 5 lines · Mauro Carvalho Chehab
Quoted 2 lines
.../{ => driver-api}/atomic_bitops.rst | 2 -That's a .txt file, big fat NAK for making it an rst.
Rst is a text file. This one is parsed properly by Sphinx without any changes.
In my tree it is a .txt file, I've not seen patches changing it. And I disagree, rst is just as much 'a text file' as .c is.
Quoted 11 lines
Quoted 8 lines
Quoted 6 lines
.../{ => driver-api}/futex-requeue-pi.rst | 2 -.../{ => driver-api}/gcc-plugins.rst | 2 -Documentation/{ => driver-api}/kprobes.rst | 2 - .../{ => driver-api}/percpu-rw-semaphore.rst | 2 -More NAK for rst conversion
Again, those don't need any conversion. Those files already parse as-is by Sphinx, with no need for any change.
And yet, they're a .txt file in my tree. And I've not seen a rename, just this move.
Quoted 3 lines
The only change here is that, on patch 1/22, the files that aren't listed on an index file got a :orphan: added in order to make this explicit. This patch removes it.
I've no idea what :orphan: is. Text file don't have markup.
Quoted 11 lines
Quoted 11 lines
Quoted 10 lines
Documentation/{ => driver-api}/pi-futex.rst | 2 - .../{ => driver-api}/preempt-locking.rst | 2 -Documentation/{ => driver-api}/rbtree.rst | 2 -.../{ => driver-api}/robust-futex-ABI.rst | 2 - .../{ => driver-api}/robust-futexes.rst | 2 -.../{ => driver-api}/speculation.rst | 8 +-- .../{ => driver-api}/static-keys.rst | 2 -
Quoted 7 lines
Quoted 5 lines
Quoted 3 lines
.../{ => driver-api}/this_cpu_ops.rst | 2 -Documentation/locking/rt-mutex.rst | 2 +-NAK. None of the above have anything to do with driver-api.
Ok. Where do you think they should sit instead? core-api?
Pretty much all of then are core-api I tihnk, with exception of the one that are ABI, which have nothing to do with API. And i've no idea where GCC plugins go, but it's definitely nothing to do with drivers.
Many of the futex ones are about the sys_futex user API, which apparently we have Documentation/userspace-api/ for.
Why are you doing this if you've no clue what they're on about?
Just randomly moving files about isn't helpful.
Em Wed, 19 Jun 2019 23:27:53 +0200
Peter Zijlstra <[email protected]> escreveu:
Quoted 10 lines · Mauro Carvalho Chehab
Quoted 9 lines
(c/c list cleaned)
Em Wed, 19 Jun 2019 13:43:56 +0200
Peter Zijlstra <[email protected]> escreveu:Quoted 4 lines · Mauro Carvalho Chehab
Quoted 2 lines
.../{ => driver-api}/atomic_bitops.rst | 2 -
Quoted 7 lines
Quoted 4 lines
Quoted 1 line
That's a .txt file, big fat NAK for making it an rst.
Rst is a text file. This one is parsed properly by Sphinx without any changes.
In my tree it is a .txt file, I've not seen patches changing it. And I disagree, rst is just as much 'a text file' as .c is.
ReStructured text is just text with a stricter style + some commands, if the text author wants to enhance it.
Btw, I'm glad you mentioned c.
This is c:
int
func( int a, int
b ) {
return a + b;
}This is also c:
func(int a,int b) { goto foo;
foo:
return(a+b) }K&R style is also c, and this is also c:
#define f(a,b) (a+b)
Despite none of the above matches my taste - and some have issues - they all build with gcc.
Yet, none of the above follows the Kernel coding style.
The way we use ReST (with absolute minimal changes), it becomes just a text style.
Btw, I agree with you: there are some odd things at its style - and we should work to try to reduce this to its minimal extent.
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 7 lines
.../{ => driver-api}/futex-requeue-pi.rst | 2 -.../{ => driver-api}/gcc-plugins.rst | 2 -Documentation/{ => driver-api}/kprobes.rst | 2 - .../{ => driver-api}/percpu-rw-semaphore.rst | 2 -
Quoted 7 lines
Quoted 4 lines
Quoted 1 line
More NAK for rst conversion
Again, those don't need any conversion. Those files already parse as-is by Sphinx, with no need for any change.
And yet, they're a .txt file in my tree. And I've not seen a rename, just this move.
Rename is on patch 1/22.
No matter the extension, all the above files pass at the Sphinx style validation without warnings or errors. Patch 1/22 doesn't make any conversion.
Btw, the .rst extension is just a convenient way to help identifying what was not validated. If I'm not mistaken, when the discussions about a replacement for DocBook started at at linux-doc, someone proposed to keep the .txt extension (changing it to accept .rst, .txt or both is a single line change at conf.py).
Quoted 20 lines
Quoted 4 lines
The only change here is that, on patch 1/22, the files that aren't listed on an index file got a :orphan: added in order to make this explicit. This patch removes it.
I've no idea what :orphan: is. Text file don't have markup.
Quoted 13 lines
Quoted 13 lines
Quoted 12 lines
Documentation/{ => driver-api}/pi-futex.rst | 2 - .../{ => driver-api}/preempt-locking.rst | 2 -Documentation/{ => driver-api}/rbtree.rst | 2 -.../{ => driver-api}/robust-futex-ABI.rst | 2 - .../{ => driver-api}/robust-futexes.rst | 2 -.../{ => driver-api}/speculation.rst | 8 +-- .../{ => driver-api}/static-keys.rst | 2 -.../{ => driver-api}/this_cpu_ops.rst | 2 -
Quoted 8 lines
Quoted 5 lines
Quoted 3 lines
Quoted 1 line
Documentation/locking/rt-mutex.rst | 2 +-NAK. None of the above have anything to do with driver-api.
Ok. Where do you think they should sit instead? core-api?
Pretty much all of then are core-api I tihnk, with exception of the one that are ABI, which have nothing to do with API.
OK.
Quoted 2 lines
And i've no idea where
GCC plugins go, but it's definitely nothing to do with drivers.
I suspect that Documentation/security would be a better place for GCC plugins (as it has been discussed at kernel-hardening ML), but I'm waiting a feedback from Kees.
Quoted 3 lines
Many of the futex ones are about the
sys_futexuser API, which apparently we haveDocumentation/userspace-api/for.
Yeah, it makes sense to place sys_futex there.
Despite being an old dir, it is not too popular: there are very few document there. I only discovered this one a few days ago.
Quoted 2 lines
Why are you doing this if you've no clue what they're on about?
I don't pretend to know precisely where each document will fit. If you read carefully the content of each orphaned document, you'll see that many of them have uAPI, kAPI and admin-guide info inside.
To be frank, I actually tried to get rid of this document shift part, but a Jon's feedback when I submitted a much simpler RFC patchset challenged me to try to place each document on some place. The renaming part is by far a lot more complex than the conversion, because depending on how you interpret the file contents - and the description of each documentation chapter - it may fit on a different subdir.
-
My main goal is to have an organized body with the documentation.
Try to read our docs as if it is a book, and you'll see what I'm talking
about: there are important missing parts, the document order isn't in an order that would make easier for the headers, several documents are placed on random places, etc.
Just like we have Makefiles, the index.rst files, plus the subdirectories help to classify and organize the documentation on a coherent way.
-
The main problem I want to address with this particular patch is that there are so many random documents from all sorts of subject at Documentation/*.txt that it makes really hard to see the document structure or to organize them.
Also, keeping txt files there at the root doc dir is a bad idea, as people keep flooding Documentation/ root with new unclassified documents on almost every Kernel version.
After 5.1, there are two new documents added inside Documentation/*.txt (I guess both added at linux-next for 5.3).
I proposed a few months ago to create a Documentation/staging, and do:
mv Documentation/*.txt Documentation/*.rst Documentation/staging
Jani proposed today something similar to it (Documentation/attic)
The name is not important. Having a place were we can temporarily place documents while we organize the directory structure and the documentation indexes seem to be the best way to reorganize the docs on a coherent way.
Thanks,
Mauro
Re: [PATCH v2 02/29] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
Yeah, the plan is to move all text files inside
Documentation/to .rst[1].[1] There are some exceptions: for ABI and features, the current plan is to have a script that parses their strict formats and produce a ReST output.
Quoted 8 lines
Btw, Still pending to be sent, I have already a patch removing the :orphan: from this file and adding it to the admin guide:
https://git.linuxtv.org/mchehab/experimental.git/commit/?h=convert_rst_renames_v5.1&id=eae5b48cab115c83be8dd59ee99b9e45f8142134And the corresponding output, after the patches I currently have:
https://www.infradead.org/~mchehab/rst_conversion/admin-guide/lcd-panel-cgram.html
Thanks for the pointers! I guess you will take all these patches/series on your tree(s), but if you want maintainers to do it, please let me know!
Cheers,
Miguel
Re: [PATCH v2 20/29] docs: leds: convert to ReST
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
Rename the leds documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new
index.rst, let's add a :orphan: while this is not linked to the mainindex.rstfile, in order to avoid build warnings.Signed-off-by Mauro Carvalho Chehab <[email protected]>
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Re: [PATCH v2 10/29] docs: arm: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabQuoted 13 lines · Mauro Carvalho Chehab
Converts ARM the text files to ReST, preparing them to be an architecture book.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.At its new
index.rst, let's add a :orphan: while this is not linked to the mainindex.rstfile, in order to avoid build warnings.
Quoted 7 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/arm/{sunxi/README => sunxi.rst} | 98 +++- drivers/crypto/sunxi-ss/sun4i-ss-cipher.c | 2 +- drivers/crypto/sunxi-ss/sun4i-ss-core.c | 2 +- drivers/crypto/sunxi-ss/sun4i-ss-hash.c | 2 +- drivers/crypto/sunxi-ss/sun4i-ss.h | 2 +-
For sun4i-s::
Reviewed-by Corentin Labbe <[email protected]>
Greg Kroah-Hartman
maintainerRe: [PATCH v2 09/29] docs: driver-model: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabQuoted 10 lines · Mauro Carvalho Chehab
Convert the various documents at the driver-model, preparing them to be part of the driver-api book.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
Quoted 5 lines
At its new
index.rst, let's add a :orphan: while this is not linked to the mainindex.rstfile, in order to avoid build warnings.Signed-off-by Mauro Carvalho Chehab <[email protected]>
Now applied, thanks.
greg k-h
Re: [PATCH v2 06/29] docs: console.txt: convert docs to ReST and rename to *.rst
In reply to Mauro Carvalho ChehabQuoted 7 lines · Mauro Carvalho Chehab
Convert this small file to ReST in preparation for adding it to the driver-api book.
While this is not part of the driver-api book, mark it as :orphan:, in order to avoid build warnings.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Jonathan Cameron
maintainerRe: [PATCH v2 22/29] docs: iio: convert to ReST
In reply to Mauro Carvalho ChehabQuoted 9 lines · On Tue, 18 Jun 2019 17:53:40 -0300 Mauro Carvalho Chehab…
Rename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
At its new
index.rst, let's add a :orphan: while this is not linked to the mainindex.rstfile, in order to avoid build warnings.Signed-off-by Mauro Carvalho Chehab <[email protected]>Acked-by Jonathan Cameron <[email protected]>
I'll take this via IIO.
Applied to the togreg branch of iio.git and pushed out as testing. I'll probably do a pull request to Greg tomorrow and these will hopefully turn up in linux-next not long after that.
Thanks Mauro!
Jonathan
Quoted 216 lines
--- .../iio/{ep93xx_adc.txt => ep93xx_adc.rst} | 15 +++++- .../{iio_configfs.txt => iio_configfs.rst} | 52 +++++++++++-------- Documentation/iio/index.rst | 12 +++++ drivers/iio/Kconfig | 2 +- 4 files changed, 56 insertions(+), 25 deletions(-) rename Documentation/iio/{ep93xx_adc.txt => ep93xx_adc.rst} (71%) rename Documentation/iio/{iio_configfs.txt => iio_configfs.rst} (73%) create mode 100644 Documentation/iio/index.rstDocumentation/iio/ep93xx_adc.rst renamed from Documentation/iio/ep93xx_adc.txt +13
-2@@ -1,12 +1,16 @@ -Cirrus Logic EP93xx ADC driver. +============================== +Cirrus Logic EP93xx ADC driver +============================== 1. Overview +=========== The driver is intended to work on both low-end (EP9301, EP9302) devices with 5-channel ADC and high-end (EP9307, EP9312, EP9315) devices with 10-channel touchscreen/ADC module. 2. Channel numbering +==================== Numbering scheme for channels 0..4 is defined in EP9301 and EP9302 datasheets. EP9307, EP9312 and EP9312 have 3 channels more (total 8), but the numbering is@@ -17,13 +21,20 @@ Assuming ep93xx_adc is IIO device0, you'd find the following entries under +-----------------+---------------+ | sysfs entry | ball/pin name | - +-----------------+---------------+ + +=================+===============+ | in_voltage0_raw | YM | + +-----------------+---------------+ | in_voltage1_raw | SXP | + +-----------------+---------------+ | in_voltage2_raw | SXM | + +-----------------+---------------+ | in_voltage3_raw | SYP | + +-----------------+---------------+ | in_voltage4_raw | SYM | + +-----------------+---------------+ | in_voltage5_raw | XP | + +-----------------+---------------+ | in_voltage6_raw | XM | + +-----------------+---------------+ | in_voltage7_raw | YP | +-----------------+---------------+Documentation/iio/iio_configfs.rst renamed from Documentation/iio/iio_configfs.txt +30
-22@@ -1,6 +1,9 @@ +=============================== Industrial IIO configfs support +=============================== 1. Overview +=========== Configfs is a filesystem-based manager of kernel objects. IIO uses some objects that could be easily configured using configfs (e.g.: devices,@@ -10,20 +13,22 @@ See Documentation/filesystems/configfs/configfs.txt for more information about how configfs works. 2. Usage +======== In order to use configfs support in IIO we need to select it at compile time via CONFIG_IIO_CONFIGFS config option. -Then, mount the configfs filesystem (usually under /config directory): +Then, mount the configfs filesystem (usually under /config directory):: -$ mkdir /config -$ mount -t configfs none /config + $ mkdir /config + $ mount -t configfs none /config At this point, all default IIO groups will be created and can be accessed under /config/iio. Next chapters will describe available IIO configuration objects. 3. Software triggers +==================== One of the IIO default configfs groups is the "triggers" group. It is automagically accessible when the configfs is mounted and can be found@@ -31,40 +36,40 @@ under /config/iio/triggers. IIO software triggers implementation offers support for creating multiple trigger types. A new trigger type is usually implemented as a separate -kernel module following the interface in include/linux/iio/sw_trigger.h: +kernel module following the interface in include/linux/iio/sw_trigger.h:: -/* - * drivers/iio/trigger/iio-trig-sample.c - * sample kernel module implementing a new trigger type - */ -#include <linux/iio/sw_trigger.h> + /* + * drivers/iio/trigger/iio-trig-sample.c + * sample kernel module implementing a new trigger type + */ + #include <linux/iio/sw_trigger.h> -static struct iio_sw_trigger *iio_trig_sample_probe(const char *name) -{ + static struct iio_sw_trigger *iio_trig_sample_probe(const char *name) + { /* * This allocates and registers an IIO trigger plus other * trigger type specific initialization. */ -} + } -static int iio_trig_hrtimer_remove(struct iio_sw_trigger *swt) -{ + static int iio_trig_hrtimer_remove(struct iio_sw_trigger *swt) + { /* * This undoes the actions in iio_trig_sample_probe */ -} + } -static const struct iio_sw_trigger_ops iio_trig_sample_ops = { + static const struct iio_sw_trigger_ops iio_trig_sample_ops = { .probe = iio_trig_sample_probe, .remove = iio_trig_sample_remove, -}; + }; -static struct iio_sw_trigger_type iio_trig_sample = { + static struct iio_sw_trigger_type iio_trig_sample = { .name = "trig-sample", .owner = THIS_MODULE, .ops = &iio_trig_sample_ops, -}; + }; module_iio_sw_trigger_driver(iio_trig_sample);@@ -73,21 +78,24 @@ iio-trig-sample module will create 'trig-sample' trigger type directory /config/iio/triggers/trig-sample. We support the following interrupt sources (trigger types): + * hrtimer, uses high resolution timers as interrupt source 3.1 Hrtimer triggers creation and destruction +--------------------------------------------- Loading iio-trig-hrtimer module will register hrtimer trigger types allowing users to create hrtimer triggers under /config/iio/triggers/hrtimer. -e.g: +e.g:: -$ mkdir /config/iio/triggers/hrtimer/instance1 -$ rmdir /config/iio/triggers/hrtimer/instance1 + $ mkdir /config/iio/triggers/hrtimer/instance1 + $ rmdir /config/iio/triggers/hrtimer/instance1 Each trigger can have one or more attributes specific to the trigger type. 3.2 "hrtimer" trigger types attributes +-------------------------------------- "hrtimer" trigger type doesn't have any configurable attribute from /config dir. It does introduce the sampling_frequency attribute to trigger directory.Documentation/iio/index.rst new file +12
-0@@ -0,0 +1,12 @@ +:orphan: + +============== +Industrial I/O +============== + +.. toctree:: + :maxdepth: 1 + + iio_configfs + + ep93xx_adcdrivers/iio/Kconfig +1
-1@@ -28,7 +28,7 @@ config IIO_CONFIGFS help This allows configuring various IIO bits through configfs (e.g. software triggers). For more info see - Documentation/iio/iio_configfs.txt. + Documentation/iio/iio_configfs.rst. config IIO_TRIGGER bool "Enable triggered sampling support"