Convert files to ReST - part 3
Subsystems (108)
cover Convert files to ReST - part 3
This is the third 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. The second part has 29 patches. This series with 22 patches finishes the conversion part of my series. 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.
After having those three patch series merged, I should submit a final patch series adding orphaned books to existing ones (with ~50 patches), to be applied on a convenient moment (probably late on a merge window).
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.
Mauro Carvalho Chehab (22):
docs: Documentation/*.txt: rename all ReST files to *.rst
docs: ioctl-number.txt: convert it to ReST format
docs: ioctl: convert to ReST
docs: thermal: convert to ReST
docs: rapidio: convert to ReST
docs: blockdev: convert to ReST
docs: perf: convert to ReST
docs: sysctl: convert to ReST
docs: block: convert to ReST
docs: security: move some books to it and update
docs: admin-guide: add .rst files from the main dir
docs: driver-api: add .rst files from the main dir
docs: x86: move two x86-specific files to x86 arch dir
docs: usb: rename files to .rst and add them to drivers-api
docs: driver-api: add a chapter for memory-related API
docs: driver-api: add xilinx driver API documentation
docs: add arch doc directories to the index
docs: admin-guide: move sysctl directory to it
docs: driver-api: add remaining converted dirs to it
docs: extcon: move it to acpi dir and convert it to ReST
docs: admin-guide: add laptops documentation
admin-guide: add kdump documentation into it
CREDITS | 2 +-
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
Documentation/ABI/testing/sysfs-block-device | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 +-
.../ABI/testing/sysfs-platform-asus-laptop | 2 +-
Documentation/PCI/pci.rst | 8 +-
Documentation/{ => admin-guide}/aoe/aoe.rst | 4 +-
.../{ => admin-guide}/aoe/autoload.sh | 1 -
.../{ => admin-guide}/aoe/examples.rst | 0
Documentation/{ => admin-guide}/aoe/index.rst | 2 -
Documentation/{ => admin-guide}/aoe/status.sh | 0
Documentation/{ => admin-guide}/aoe/todo.rst | 0
.../{ => admin-guide}/aoe/udev-install.sh | 4 +-
Documentation/{ => admin-guide}/aoe/udev.txt | 8 +-
.../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
Documentation/admin-guide/bug-hunting.rst | 4 +-
.../cgroup-v1/blkio-controller.rst | 0
.../{ => admin-guide}/cgroup-v1/cgroups.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/cpuacct.rst | 0
.../{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +-
.../{ => admin-guide}/cgroup-v1/devices.rst | 0
.../cgroup-v1/freezer-subsystem.rst | 0
.../{ => admin-guide}/cgroup-v1/hugetlb.rst | 0
.../{ => admin-guide}/cgroup-v1/index.rst | 2 -
.../cgroup-v1/memcg_test.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/memory.rst | 0
.../{ => admin-guide}/cgroup-v1/net_cls.rst | 0
.../{ => admin-guide}/cgroup-v1/net_prio.rst | 0
.../{ => admin-guide}/cgroup-v1/pids.rst | 0
.../{ => admin-guide}/cgroup-v1/rdma.rst | 0
Documentation/admin-guide/cgroup-v2.rst | 2 +-
.../clearing-warn-once.rst} | 0
.../cpu-load.rst} | 0
.../cputopology.rst} | 0
.../efi-stub.rst} | 0
.../{highuid.txt => admin-guide/highuid.rst} | 2 +-
Documentation/admin-guide/hw-vuln/l1tf.rst | 4 +-
.../hw_random.rst} | 0
Documentation/admin-guide/index.rst | 26 +
.../{iostats.txt => admin-guide/iostats.rst} | 0
.../{ => admin-guide}/kdump/gdbmacros.txt | 0
.../{ => admin-guide}/kdump/index.rst | 1 -
.../{ => admin-guide}/kdump/kdump.rst | 0
.../{ => admin-guide}/kdump/vmcoreinfo.rst | 0
.../admin-guide/kernel-parameters.txt | 46 +-
.../kernel-per-cpu-kthreads.rst} | 4 +-
.../{ => admin-guide}/laptops/asus-laptop.rst | 0
.../laptops/disk-shock-protection.rst | 0
.../{ => admin-guide}/laptops/index.rst | 1 -
.../{ => admin-guide}/laptops/laptop-mode.rst | 0
.../{ => admin-guide}/laptops/lg-laptop.rst | 1 -
.../{ => admin-guide}/laptops/sony-laptop.rst | 0
.../{ => admin-guide}/laptops/sonypi.rst | 0
.../laptops/thinkpad-acpi.rst | 6 +-
.../laptops/toshiba_haps.rst | 0
.../lcd-panel-cgram.rst | 2 -
.../{ldm.txt => admin-guide/ldm.rst} | 3 +-
.../lockup-watchdogs.rst} | 0
.../mm/cma_debugfs.rst} | 2 -
Documentation/admin-guide/mm/index.rst | 2 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
.../admin-guide/mm/numa_memory_policy.rst | 2 +-
.../numastat.rst} | 3 +-
.../{pnp.txt => admin-guide/pnp.rst} | 11 +-
.../{rtc.txt => admin-guide/rtc.rst} | 6 +-
.../{svga.txt => admin-guide/svga.rst} | 0
.../abi.txt => admin-guide/sysctl/abi.rst} | 71 +-
.../fs.txt => admin-guide/sysctl/fs.rst} | 142 +--
.../README => admin-guide/sysctl/index.rst} | 34 +-
.../sysctl/kernel.rst} | 378 ++++----
.../net.txt => admin-guide/sysctl/net.rst} | 141 ++-
.../sysctl/sunrpc.rst} | 13 +-
.../user.txt => admin-guide/sysctl/user.rst} | 32 +-
.../vm.txt => admin-guide/sysctl/vm.rst} | 264 ++---
.../video-output.rst} | 1 -
Documentation/arm/index.rst | 2 -
Documentation/arm64/index.rst | 2 -
.../{bfq-iosched.txt => bfq-iosched.rst} | 68 +-
.../block/{biodoc.txt => biodoc.rst} | 366 ++++---
.../block/{biovecs.txt => biovecs.rst} | 20 +-
.../block/{capability.txt => capability.rst} | 17 +-
...ne-partition.txt => cmdline-partition.rst} | 13 +-
...{data-integrity.txt => data-integrity.rst} | 60 +-
...dline-iosched.txt => deadline-iosched.rst} | 21 +-
Documentation/block/index.rst | 25 +
.../block/{ioprio.txt => ioprio.rst} | 95 +-
.../{kyber-iosched.txt => kyber-iosched.rst} | 3 +-
.../block/{null_blk.txt => null_blk.rst} | 65 +-
Documentation/block/{pr.txt => pr.rst} | 18 +-
.../{queue-sysfs.txt => queue-sysfs.rst} | 7 +-
.../block/{request.txt => request.rst} | 47 +-
Documentation/block/{stat.txt => stat.rst} | 13 +-
...witching-sched.txt => switching-sched.rst} | 28 +-
...ontrol.txt => writeback_cache_control.rst} | 12 +-
...structure-v9.txt => data-structure-v9.rst} | 6 +-
Documentation/blockdev/drbd/figures.rst | 28 +
.../blockdev/drbd/{README.txt => index.rst} | 15 +-
.../blockdev/{floppy.txt => floppy.rst} | 88 +-
Documentation/blockdev/index.rst | 16 +
Documentation/blockdev/{nbd.txt => nbd.rst} | 2 +-
.../blockdev/{paride.txt => paride.rst} | 194 ++--
.../blockdev/{ramdisk.txt => ramdisk.rst} | 55 +-
Documentation/blockdev/{zram.txt => zram.rst} | 197 ++--
Documentation/core-api/printk-formats.rst | 2 +-
Documentation/device-mapper/statistics.rst | 4 +-
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../atomic_bitops.rst} | 1 -
.../bt8xxgpio.rst} | 1 -
.../bus-virt-phys-mapping.rst} | 52 +-
.../{connector => driver-api}/connector.rst | 2 -
.../{console => driver-api}/console.rst | 2 -
.../{crc32.txt => driver-api/crc32.rst} | 0
.../{dcdbas.txt => driver-api/dcdbas.rst} | 0
.../debugging-modules.rst} | 0
.../debugging-via-ohci1394.rst} | 0
.../{dell_rbu.txt => driver-api/dell_rbu.rst} | 1 -
.../{digsig.txt => driver-api/digsig.rst} | 0
.../{EDID/howto.rst => driver-api/edid.rst} | 2 -
.../{eisa.txt => driver-api/eisa.rst} | 0
.../futex-requeue-pi.rst} | 0
.../gcc-plugins.rst} | 0
.../hwspinlock.rst} | 0
Documentation/driver-api/index.rst | 71 +-
.../io-mapping.rst} | 0
.../io_ordering.rst} | 0
.../{IPMI.txt => driver-api/ipmi.rst} | 0
.../irq-affinity.rst} | 0
.../irq-domain.rst} | 0
Documentation/{IRQ.txt => driver-api/irq.rst} | 0
.../irqflags-tracing.rst} | 1 -
Documentation/{isa.txt => driver-api/isa.rst} | 0
.../{isapnp.txt => driver-api/isapnp.rst} | 0
.../{kobject.txt => driver-api/kobject.rst} | 4 +-
.../{kprobes.txt => driver-api/kprobes.rst} | 1 -
.../{kref.txt => driver-api/kref.rst} | 0
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
Documentation/{lzo.txt => driver-api/lzo.rst} | 0
.../{mailbox.txt => driver-api/mailbox.rst} | 0
.../men-chameleon-bus.rst} | 0
.../mm/dma-api-howto.rst} | 0
.../mm/dma-api.rst} | 6 +-
.../mm/dma-attributes.rst} | 0
.../mm/dma-isa-lpc.rst} | 2 +-
Documentation/driver-api/mm/index.rst | 11 +
.../nommu-mmap.rst} | 0
Documentation/{ntb.txt => driver-api/ntb.rst} | 0
Documentation/{nvmem => driver-api}/nvmem.rst | 2 -
.../{padata.txt => driver-api/padata.rst} | 0
.../parport-lowlevel.rst} | 0
.../percpu-rw-semaphore.rst} | 0
.../{pi-futex.txt => driver-api/pi-futex.rst} | 0
Documentation/driver-api/pps.rst | 2 -
.../preempt-locking.rst} | 2 +-
.../{pti => driver-api}/pti_intel_mid.rst | 2 -
Documentation/driver-api/ptp.rst | 2 -
Documentation/{pwm.txt => driver-api/pwm.rst} | 0
.../{rbtree.txt => driver-api/rbtree.rst} | 52 +-
.../remoteproc.rst} | 2 +-
.../{rfkill.txt => driver-api/rfkill.rst} | 0
.../robust-futex-ABI.rst} | 0
.../robust-futexes.rst} | 0
.../{rpmsg.txt => driver-api/rpmsg.rst} | 0
.../{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} | 0
.../{SM501.txt => driver-api/sm501.rst} | 0
.../smsc_ece1099.rst} | 0
.../speculation.rst} | 8 +-
.../static-keys.rst} | 0
.../switchtec.rst} | 2 +-
.../sync_file.rst} | 0
Documentation/{tee.txt => driver-api/tee.rst} | 0
.../this_cpu_ops.rst} | 0
.../unaligned-memory-access.rst} | 0
Documentation/driver-api/usb/dma.rst | 6 +-
.../vfio-mediated-device.rst} | 2 +-
.../{vfio.txt => driver-api/vfio.rst} | 0
.../{ => driver-api}/xilinx/eemi.rst | 0
.../{ => driver-api}/xilinx/index.rst | 1 -
.../{xillybus.txt => driver-api/xillybus.rst} | 0
Documentation/{xz.txt => driver-api/xz.rst} | 0
.../{zorro.txt => driver-api/zorro.rst} | 5 +-
Documentation/driver-model/device.rst | 2 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/proc.txt | 2 +-
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
.../acpi/extcon-intel-int3496.rst} | 14 +-
Documentation/firmware-guide/acpi/index.rst | 1 +
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/ia64/index.rst | 2 -
Documentation/ia64/irq-redir.rst | 2 +-
Documentation/index.rst | 14 +
...g-up-ioctls.txt => botching-up-ioctls.rst} | 1 +
Documentation/ioctl/{cdrom.txt => cdrom.rst} | 908 +++++++++++-------
Documentation/ioctl/{hdio.txt => hdio.rst} | 835 ++++++++++------
Documentation/ioctl/index.rst | 16 +
...{ioctl-decoding.txt => ioctl-decoding.rst} | 13 +-
.../{ioctl-number.txt => ioctl-number.rst} | 588 ++++++------
Documentation/locking/rt-mutex.rst | 2 +-
Documentation/m68k/index.rst | 2 -
Documentation/memory-barriers.txt | 6 +-
Documentation/mic/index.rst | 2 -
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/networking/scaling.rst | 4 +-
.../perf/{arm-ccn.txt => arm-ccn.rst} | 18 +-
.../perf/{arm_dsu_pmu.txt => arm_dsu_pmu.rst} | 5 +-
.../perf/{hisi-pmu.txt => hisi-pmu.rst} | 35 +-
Documentation/perf/index.rst | 16 +
.../perf/{qcom_l2_pmu.txt => qcom_l2_pmu.rst} | 3 +-
.../perf/{qcom_l3_pmu.txt => qcom_l3_pmu.rst} | 3 +-
.../{thunderx2-pmu.txt => thunderx2-pmu.rst} | 25 +-
.../perf/{xgene-pmu.txt => xgene-pmu.rst} | 3 +-
Documentation/{phy.txt => phy.rst} | 2 +
Documentation/phy/samsung-usb2.rst | 2 -
.../powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/process/submit-checklist.rst | 2 +-
Documentation/rapidio/index.rst | 15 +
.../{mport_cdev.txt => mport_cdev.rst} | 47 +-
.../rapidio/{rapidio.txt => rapidio.rst} | 39 +-
.../rapidio/{rio_cm.txt => rio_cm.rst} | 66 +-
.../rapidio/{sysfs.txt => sysfs.rst} | 4 +
.../rapidio/{tsi721.txt => tsi721.rst} | 45 +-
Documentation/riscv/index.rst | 2 -
Documentation/s390/index.rst | 2 -
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/scheduler/index.rst | 2 -
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/security/index.rst | 5 +-
.../security/{LSM.rst => lsm-development.rst} | 0
Documentation/{lsm.txt => security/lsm.rst} | 0
Documentation/{SAK.txt => security/sak.rst} | 1 -
.../{siphash.txt => security/siphash.rst} | 0
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/xen-tpmfront.rst | 2 -
Documentation/sparc/index.rst | 2 -
...pu-cooling-api.txt => cpu-cooling-api.rst} | 39 +-
.../{exynos_thermal => exynos_thermal.rst} | 47 +-
...emulation => exynos_thermal_emulation.rst} | 66 +-
Documentation/thermal/index.rst | 18 +
...el_powerclamp.txt => intel_powerclamp.rst} | 177 ++--
.../{nouveau_thermal => nouveau_thermal.rst} | 54 +-
...ower_allocator.txt => power_allocator.rst} | 140 +--
.../thermal/{sysfs-api.txt => sysfs-api.rst} | 490 ++++++----
...hermal => x86_pkg_temperature_thermal.rst} | 28 +-
Documentation/trace/kprobetrace.rst | 2 +-
.../it_IT/process/submit-checklist.rst | 2 +-
.../translations/ko_KR/memory-barriers.txt | 6 +-
Documentation/translations/zh_CN/IRQ.txt | 4 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
.../translations/zh_CN/io_ordering.txt | 4 +-
.../translations/zh_CN/oops-tracing.txt | 4 +-
.../zh_CN/process/submit-checklist.rst | 2 +-
Documentation/usb/{acm.txt => acm.rst} | 0
.../{authorization.txt => authorization.rst} | 0
.../usb/{chipidea.txt => chipidea.rst} | 0
Documentation/usb/{dwc3.txt => dwc3.rst} | 0
Documentation/usb/{ehci.txt => ehci.rst} | 0
.../usb/{functionfs.txt => functionfs.rst} | 0
...{gadget-testing.txt => gadget-testing.rst} | 4 +-
...adget_configfs.txt => gadget_configfs.rst} | 0
.../usb/{gadget_hid.txt => gadget_hid.rst} | 0
.../{gadget_multi.txt => gadget_multi.rst} | 0
...{gadget_printer.txt => gadget_printer.rst} | 0
.../{gadget_serial.txt => gadget_serial.rst} | 0
Documentation/usb/index.rst | 39 +
.../usb/{iuu_phoenix.txt => iuu_phoenix.rst} | 0
.../{mass-storage.txt => mass-storage.rst} | 0
...{misc_usbsevseg.txt => misc_usbsevseg.rst} | 0
.../usb/{mtouchusb.txt => mtouchusb.rst} | 0
Documentation/usb/{ohci.txt => ohci.rst} | 0
Documentation/usb/{rio.txt => rio.rst} | 0
Documentation/usb/text_files.rst | 29 +
.../usb/{usb-help.txt => usb-help.rst} | 0
.../usb/{usb-serial.txt => usb-serial.rst} | 0
...{usbip_protocol.txt => usbip_protocol.rst} | 0
Documentation/usb/{usbmon.txt => usbmon.rst} | 0
...-overview.txt => wusb-design-overview.rst} | 0
Documentation/vm/numa.rst | 4 +-
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 4 +-
Documentation/w1/w1.netlink | 2 +-
Documentation/watchdog/hpwdt.rst | 4 +-
Documentation/x86/index.rst | 2 +
.../{Intel-IOMMU.txt => x86/intel-iommu.rst} | 1 +
.../{intel_txt.txt => x86/intel_txt.rst} | 1 +
Documentation/x86/topology.rst | 2 +-
.../x86/x86_64/fake-numa-for-cpusets.rst | 4 +-
Documentation/xtensa/index.rst | 2 -
MAINTAINERS | 106 +-
arch/Kconfig | 4 +-
arch/arm/Kconfig | 4 +-
arch/arm64/Kconfig | 2 +-
arch/ia64/hp/common/sba_iommu.c | 12 +-
arch/ia64/sn/pci/pci_dma.c | 4 +-
arch/parisc/Kconfig | 2 +-
arch/parisc/kernel/pci-dma.c | 2 +-
arch/sh/Kconfig | 4 +-
arch/sparc/Kconfig | 2 +-
arch/unicore32/include/asm/io.h | 2 +-
arch/x86/Kconfig | 8 +-
arch/x86/include/asm/dma-mapping.h | 4 +-
arch/x86/kernel/amd_gart_64.c | 2 +-
block/Kconfig | 4 +-
block/Kconfig.iosched | 2 +-
block/bfq-iosched.c | 2 +-
block/blk-integrity.c | 2 +-
block/ioprio.c | 2 +-
block/mq-deadline.c | 2 +-
block/partitions/Kconfig | 2 +-
block/partitions/cmdline.c | 2 +-
drivers/base/core.c | 2 +-
drivers/block/Kconfig | 8 +-
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +-
drivers/char/Kconfig | 6 +-
drivers/char/hw_random/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/gpu/drm/drm_ioctl.c | 2 +-
drivers/parisc/sba_iommu.c | 16 +-
drivers/pci/switch/Kconfig | 2 +-
drivers/perf/qcom_l3_pmu.c | 2 +-
drivers/platform/x86/Kconfig | 8 +-
drivers/platform/x86/dcdbas.c | 2 +-
drivers/platform/x86/dell_rbu.c | 2 +-
drivers/pnp/isapnp/Kconfig | 2 +-
drivers/rapidio/Kconfig | 2 +-
drivers/tty/Kconfig | 2 +-
drivers/usb/Kconfig | 2 +-
drivers/usb/class/Kconfig | 2 +-
drivers/usb/gadget/Kconfig | 6 +-
drivers/usb/gadget/function/f_mass_storage.c | 2 +-
drivers/usb/gadget/legacy/Kconfig | 6 +-
drivers/usb/host/Kconfig | 2 +-
drivers/usb/misc/Kconfig | 2 +-
drivers/usb/mon/Kconfig | 2 +-
drivers/usb/serial/Kconfig | 10 +-
drivers/usb/serial/belkin_sa.c | 2 +-
drivers/usb/serial/belkin_sa.h | 2 +-
drivers/usb/serial/cypress_m8.c | 2 +-
drivers/usb/serial/empeg.c | 2 +-
drivers/usb/serial/ftdi_sio.c | 2 +-
drivers/usb/serial/ir-usb.c | 2 +-
drivers/usb/serial/keyspan_pda.c | 2 +-
drivers/usb/serial/omninet.c | 2 +-
drivers/usb/serial/oti6858.c | 2 +-
drivers/usb/serial/pl2303.c | 2 +-
drivers/usb/serial/usb-serial.c | 2 +-
drivers/usb/serial/visor.c | 2 +-
drivers/usb/serial/visor.h | 2 +-
drivers/usb/serial/whiteheat.c | 2 +-
drivers/usb/serial/whiteheat.h | 2 +-
drivers/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
fs/proc/Kconfig | 2 +-
include/asm-generic/bitops/atomic.h | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/linux/dma-mapping.h | 2 +-
include/linux/hw_random.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 +-
include/linux/thermal.h | 4 +-
include/media/videobuf-dma-sg.h | 2 +-
include/uapi/linux/bpf.h | 2 +-
include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +-
init/Kconfig | 6 +-
kernel/cgroup/cpuset.c | 2 +-
kernel/dma/debug.c | 2 +-
kernel/padata.c | 2 +-
kernel/panic.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 +-
mm/swap.c | 2 +-
samples/Kconfig | 2 +-
samples/kprobes/kprobe_example.c | 2 +-
samples/kprobes/kretprobe_example.c | 2 +-
scripts/gcc-plugins/Kconfig | 2 +-
security/Kconfig | 2 +-
security/device_cgroup.c | 2 +-
tools/include/linux/rbtree.h | 2 +-
tools/include/linux/rbtree_augmented.h | 2 +-
tools/include/uapi/linux/bpf.h | 2 +-
tools/testing/selftests/zram/README | 2 +-
405 files changed, 4491 insertions(+), 2896 deletions(-)
rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%)
rename Documentation/{ => admin-guide}/aoe/autoload.sh (99%)
rename Documentation/{ => admin-guide}/aoe/examples.rst (100%)
rename Documentation/{ => admin-guide}/aoe/index.rst (95%)
rename Documentation/{ => admin-guide}/aoe/status.sh (100%)
rename Documentation/{ => admin-guide}/aoe/todo.rst (100%)
rename Documentation/{ => admin-guide}/aoe/udev-install.sh (92%)
rename Documentation/{ => admin-guide}/aoe/udev.txt (91%)
rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%)
rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%)
rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%)
rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
rename Documentation/{highuid.txt => admin-guide/highuid.rst} (99%)
rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%)
rename Documentation/{ => admin-guide}/kdump/index.rst (97%)
rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%)
rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)
rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-cpu-kthreads.rst} (98%)
rename Documentation/{ => admin-guide}/laptops/asus-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/disk-shock-protection.rst (100%)
rename Documentation/{ => admin-guide}/laptops/index.rst (95%)
rename Documentation/{ => admin-guide}/laptops/laptop-mode.rst (100%)
rename Documentation/{ => admin-guide}/laptops/lg-laptop.rst (99%)
rename Documentation/{ => admin-guide}/laptops/sony-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/sonypi.rst (100%)
rename Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst (99%)
rename Documentation/{ => admin-guide}/laptops/toshiba_haps.rst (100%)
rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
rename Documentation/{ldm.txt => admin-guide/ldm.rst} (98%)
rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
rename Documentation/{numastat.txt => admin-guide/numastat.rst} (93%)
rename Documentation/{pnp.txt => admin-guide/pnp.rst} (98%)
rename Documentation/{rtc.txt => admin-guide/rtc.rst} (99%)
rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
rename Documentation/{sysctl/abi.txt => admin-guide/sysctl/abi.rst} (30%)
rename Documentation/{sysctl/fs.txt => admin-guide/sysctl/fs.rst} (77%)
rename Documentation/{sysctl/README => admin-guide/sysctl/index.rst} (78%)
rename Documentation/{sysctl/kernel.txt => admin-guide/sysctl/kernel.rst} (79%)
rename Documentation/{sysctl/net.txt => admin-guide/sysctl/net.rst} (85%)
rename Documentation/{sysctl/sunrpc.txt => admin-guide/sysctl/sunrpc.rst} (62%)
rename Documentation/{sysctl/user.txt => admin-guide/sysctl/user.rst} (77%)
rename Documentation/{sysctl/vm.txt => admin-guide/sysctl/vm.rst} (84%)
rename Documentation/{video-output.txt => admin-guide/video-output.rst} (99%)
rename Documentation/block/{bfq-iosched.txt => bfq-iosched.rst} (95%)
rename Documentation/block/{biodoc.txt => biodoc.rst} (83%)
rename Documentation/block/{biovecs.txt => biovecs.rst} (92%)
rename Documentation/block/{capability.txt => capability.rst} (40%)
rename Documentation/block/{cmdline-partition.txt => cmdline-partition.rst} (92%)
rename Documentation/block/{data-integrity.txt => data-integrity.rst} (91%)
rename Documentation/block/{deadline-iosched.txt => deadline-iosched.rst} (89%)
create mode 100644 Documentation/block/index.rst
rename Documentation/block/{ioprio.txt => ioprio.rst} (75%)
rename Documentation/block/{kyber-iosched.txt => kyber-iosched.rst} (86%)
rename Documentation/block/{null_blk.txt => null_blk.rst} (60%)
rename Documentation/block/{pr.txt => pr.rst} (93%)
rename Documentation/block/{queue-sysfs.txt => queue-sysfs.rst} (99%)
rename Documentation/block/{request.txt => request.rst} (59%)
rename Documentation/block/{stat.txt => stat.rst} (89%)
rename Documentation/block/{switching-sched.txt => switching-sched.rst} (67%)
rename Documentation/block/{writeback_cache_control.txt => writeback_cache_control.rst} (94%)
rename Documentation/blockdev/drbd/{data-structure-v9.txt => data-structure-v9.rst} (94%)
create mode 100644 Documentation/blockdev/drbd/figures.rst
rename Documentation/blockdev/drbd/{README.txt => index.rst} (55%)
rename Documentation/blockdev/{floppy.txt => floppy.rst} (81%)
create mode 100644 Documentation/blockdev/index.rst
rename Documentation/blockdev/{nbd.txt => nbd.rst} (96%)
rename Documentation/blockdev/{paride.txt => paride.rst} (81%)
rename Documentation/blockdev/{ramdisk.txt => ramdisk.rst} (84%)
rename Documentation/blockdev/{zram.txt => zram.rst} (76%)
rename Documentation/{atomic_bitops.txt => driver-api/atomic_bitops.rst} (99%)
rename Documentation/{bt8xxgpio.txt => driver-api/bt8xxgpio.rst} (99%)
rename Documentation/{bus-virt-phys-mapping.txt => driver-api/bus-virt-phys-mapping.rst} (93%)
rename Documentation/{connector => driver-api}/connector.rst (99%)
rename Documentation/{console => driver-api}/console.rst (99%)
rename Documentation/{crc32.txt => driver-api/crc32.rst} (100%)
rename Documentation/{dcdbas.txt => driver-api/dcdbas.rst} (100%)
rename Documentation/{debugging-modules.txt => driver-api/debugging-modules.rst} (100%)
rename Documentation/{debugging-via-ohci1394.txt => driver-api/debugging-via-ohci1394.rst} (100%)
rename Documentation/{dell_rbu.txt => driver-api/dell_rbu.rst} (99%)
rename Documentation/{digsig.txt => driver-api/digsig.rst} (100%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (99%)
rename Documentation/{eisa.txt => driver-api/eisa.rst} (100%)
rename Documentation/{futex-requeue-pi.txt => driver-api/futex-requeue-pi.rst} (100%)
rename Documentation/{gcc-plugins.txt => driver-api/gcc-plugins.rst} (100%)
rename Documentation/{hwspinlock.txt => driver-api/hwspinlock.rst} (100%)
rename Documentation/{io-mapping.txt => driver-api/io-mapping.rst} (100%)
rename Documentation/{io_ordering.txt => driver-api/io_ordering.rst} (100%)
rename Documentation/{IPMI.txt => driver-api/ipmi.rst} (100%)
rename Documentation/{IRQ-affinity.txt => driver-api/irq-affinity.rst} (100%)
rename Documentation/{IRQ-domain.txt => driver-api/irq-domain.rst} (100%)
rename Documentation/{IRQ.txt => driver-api/irq.rst} (100%)
rename Documentation/{irqflags-tracing.txt => driver-api/irqflags-tracing.rst} (99%)
rename Documentation/{isa.txt => driver-api/isa.rst} (100%)
rename Documentation/{isapnp.txt => driver-api/isapnp.rst} (100%)
rename Documentation/{kobject.txt => driver-api/kobject.rst} (99%)
rename Documentation/{kprobes.txt => driver-api/kprobes.rst} (99%)
rename Documentation/{kref.txt => driver-api/kref.rst} (100%)
rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%)
rename Documentation/{lzo.txt => driver-api/lzo.rst} (100%)
rename Documentation/{mailbox.txt => driver-api/mailbox.rst} (100%)
rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%)
rename Documentation/{DMA-API-HOWTO.txt => driver-api/mm/dma-api-howto.rst} (100%)
rename Documentation/{DMA-API.txt => driver-api/mm/dma-api.rst} (99%)
rename Documentation/{DMA-attributes.txt => driver-api/mm/dma-attributes.rst} (100%)
rename Documentation/{DMA-ISA-LPC.txt => driver-api/mm/dma-isa-lpc.rst} (98%)
create mode 100644 Documentation/driver-api/mm/index.rst
rename Documentation/{nommu-mmap.txt => driver-api/nommu-mmap.rst} (100%)
rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{padata.txt => driver-api/padata.rst} (100%)
rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%)
rename Documentation/{percpu-rw-semaphore.txt => driver-api/percpu-rw-semaphore.rst} (100%)
rename Documentation/{pi-futex.txt => driver-api/pi-futex.rst} (100%)
rename Documentation/{preempt-locking.txt => driver-api/preempt-locking.rst} (99%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%)
rename Documentation/{rbtree.txt => driver-api/rbtree.rst} (94%)
rename Documentation/{remoteproc.txt => driver-api/remoteproc.rst} (99%)
rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%)
rename Documentation/{robust-futex-ABI.txt => driver-api/robust-futex-ABI.rst} (100%)
rename Documentation/{robust-futexes.txt => driver-api/robust-futexes.rst} (100%)
rename Documentation/{rpmsg.txt => driver-api/rpmsg.rst} (100%)
rename Documentation/{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} (100%)
rename Documentation/{SM501.txt => driver-api/sm501.rst} (100%)
rename Documentation/{smsc_ece1099.txt => driver-api/smsc_ece1099.rst} (100%)
rename Documentation/{speculation.txt => driver-api/speculation.rst} (100%)
rename Documentation/{static-keys.txt => driver-api/static-keys.rst} (100%)
rename Documentation/{switchtec.txt => driver-api/switchtec.rst} (97%)
rename Documentation/{sync_file.txt => driver-api/sync_file.rst} (100%)
rename Documentation/{tee.txt => driver-api/tee.rst} (100%)
rename Documentation/{this_cpu_ops.txt => driver-api/this_cpu_ops.rst} (100%)
rename Documentation/{unaligned-memory-access.txt => driver-api/unaligned-memory-access.rst} (100%)
rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%)
rename Documentation/{ => driver-api}/xilinx/eemi.rst (100%)
rename Documentation/{ => driver-api}/xilinx/index.rst (94%)
rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%)
rename Documentation/{xz.txt => driver-api/xz.rst} (100%)
rename Documentation/{zorro.txt => driver-api/zorro.rst} (99%)
rename Documentation/{extcon/intel-int3496.txt => firmware-guide/acpi/extcon-intel-int3496.rst} (66%)
rename Documentation/ioctl/{botching-up-ioctls.txt => botching-up-ioctls.rst} (99%)
rename Documentation/ioctl/{cdrom.txt => cdrom.rst} (39%)
rename Documentation/ioctl/{hdio.txt => hdio.rst} (54%)
create mode 100644 Documentation/ioctl/index.rst
rename Documentation/ioctl/{ioctl-decoding.txt => ioctl-decoding.rst} (54%)
rename Documentation/ioctl/{ioctl-number.txt => ioctl-number.rst} (11%)
rename Documentation/perf/{arm-ccn.txt => arm-ccn.rst} (86%)
rename Documentation/perf/{arm_dsu_pmu.txt => arm_dsu_pmu.rst} (92%)
rename Documentation/perf/{hisi-pmu.txt => hisi-pmu.rst} (73%)
create mode 100644 Documentation/perf/index.rst
rename Documentation/perf/{qcom_l2_pmu.txt => qcom_l2_pmu.rst} (94%)
rename Documentation/perf/{qcom_l3_pmu.txt => qcom_l3_pmu.rst} (93%)
rename Documentation/perf/{thunderx2-pmu.txt => thunderx2-pmu.rst} (73%)
rename Documentation/perf/{xgene-pmu.txt => xgene-pmu.rst} (96%)
rename Documentation/{phy.txt => phy.rst} (99%)
create mode 100644 Documentation/rapidio/index.rst
rename Documentation/rapidio/{mport_cdev.txt => mport_cdev.rst} (84%)
rename Documentation/rapidio/{rapidio.txt => rapidio.rst} (97%)
rename Documentation/rapidio/{rio_cm.txt => rio_cm.rst} (76%)
rename Documentation/rapidio/{sysfs.txt => sysfs.rst} (75%)
rename Documentation/rapidio/{tsi721.txt => tsi721.rst} (79%)
rename Documentation/security/{LSM.rst => lsm-development.rst} (100%)
rename Documentation/{lsm.txt => security/lsm.rst} (100%)
rename Documentation/{SAK.txt => security/sak.rst} (99%)
rename Documentation/{siphash.txt => security/siphash.rst} (100%)
rename Documentation/thermal/{cpu-cooling-api.txt => cpu-cooling-api.rst} (82%)
rename Documentation/thermal/{exynos_thermal => exynos_thermal.rst} (67%)
rename Documentation/thermal/{exynos_thermal_emulation => exynos_thermal_emulation.rst} (36%)
create mode 100644 Documentation/thermal/index.rst
rename Documentation/thermal/{intel_powerclamp.txt => intel_powerclamp.rst} (76%)
rename Documentation/thermal/{nouveau_thermal => nouveau_thermal.rst} (64%)
rename Documentation/thermal/{power_allocator.txt => power_allocator.rst} (74%)
rename Documentation/thermal/{sysfs-api.txt => sysfs-api.rst} (66%)
rename Documentation/thermal/{x86_pkg_temperature_thermal => x86_pkg_temperature_thermal.rst} (80%)
rename Documentation/usb/{acm.txt => acm.rst} (100%)
rename Documentation/usb/{authorization.txt => authorization.rst} (100%)
rename Documentation/usb/{chipidea.txt => chipidea.rst} (100%)
rename Documentation/usb/{dwc3.txt => dwc3.rst} (100%)
rename Documentation/usb/{ehci.txt => ehci.rst} (100%)
rename Documentation/usb/{functionfs.txt => functionfs.rst} (100%)
rename Documentation/usb/{gadget-testing.txt => gadget-testing.rst} (99%)
rename Documentation/usb/{gadget_configfs.txt => gadget_configfs.rst} (100%)
rename Documentation/usb/{gadget_hid.txt => gadget_hid.rst} (100%)
rename Documentation/usb/{gadget_multi.txt => gadget_multi.rst} (100%)
rename Documentation/usb/{gadget_printer.txt => gadget_printer.rst} (100%)
rename Documentation/usb/{gadget_serial.txt => gadget_serial.rst} (100%)
create mode 100644 Documentation/usb/index.rst
rename Documentation/usb/{iuu_phoenix.txt => iuu_phoenix.rst} (100%)
rename Documentation/usb/{mass-storage.txt => mass-storage.rst} (100%)
rename Documentation/usb/{misc_usbsevseg.txt => misc_usbsevseg.rst} (100%)
rename Documentation/usb/{mtouchusb.txt => mtouchusb.rst} (100%)
rename Documentation/usb/{ohci.txt => ohci.rst} (100%)
rename Documentation/usb/{rio.txt => rio.rst} (100%)
create mode 100644 Documentation/usb/text_files.rst
rename Documentation/usb/{usb-help.txt => usb-help.rst} (100%)
rename Documentation/usb/{usb-serial.txt => usb-serial.rst} (100%)
rename Documentation/usb/{usbip_protocol.txt => usbip_protocol.rst} (100%)
rename Documentation/usb/{usbmon.txt => usbmon.rst} (100%)
rename Documentation/usb/{WUSB-Design-overview.txt => wusb-design-overview.rst} (100%)
rename Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} (99%)
rename Documentation/{intel_txt.txt => x86/intel_txt.rst} (99%)Signature · 8 lines
2.21.0 _______________________________________________ linux-riscv mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-riscv
PATCH 1/22 docs: Documentation/*.txt: rename all ReST files to *.rst
Those files are actually at ReST format. Ok, currently, they don't belong to any place yet at the organized book series, but we don't want patches to break them as ReST files. So, rename them and add a :orphan: in order to shut up warning messages like those:
...
Documentation/svga.rst: WARNING: document isn't included in any toctree Documentation/switchtec.rst: WARNING: document isn't included in any toctree
...
Later patches will move them to a better place and remove the :orphan: markup.
---
I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists.
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 +-
.../{DMA-API-HOWTO.txt => DMA-API-HOWTO.rst} | 2 +
Documentation/{DMA-API.txt => DMA-API.rst} | 8 ++-
.../{DMA-ISA-LPC.txt => DMA-ISA-LPC.rst} | 4 +-
...{DMA-attributes.txt => DMA-attributes.rst} | 2 +
Documentation/{IPMI.txt => IPMI.rst} | 2 +
.../{IRQ-affinity.txt => IRQ-affinity.rst} | 2 +
.../{IRQ-domain.txt => IRQ-domain.rst} | 2 +
Documentation/{IRQ.txt => IRQ.rst} | 2 +
.../{Intel-IOMMU.txt => Intel-IOMMU.rst} | 2 +
Documentation/PCI/pci.rst | 8 +--
Documentation/{SAK.txt => SAK.rst} | 3 +-
Documentation/{SM501.txt => SM501.rst} | 2 +
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../admin-guide/kernel-parameters.txt | 4 +-
.../{atomic_bitops.txt => atomic_bitops.rst} | 3 +-
Documentation/block/biodoc.txt | 2 +-
.../{bt8xxgpio.txt => bt8xxgpio.rst} | 3 +-
Documentation/{btmrvl.txt => btmrvl.rst} | 2 +
...-mapping.txt => bus-virt-phys-mapping.rst} | 54 +++++++++---------
...g-warn-once.txt => clearing-warn-once.rst} | 2 +
Documentation/{cpu-load.txt => cpu-load.rst} | 2 +
.../{cputopology.txt => cputopology.rst} | 2 +
Documentation/{crc32.txt => crc32.rst} | 2 +
Documentation/{dcdbas.txt => dcdbas.rst} | 2 +
...ging-modules.txt => debugging-modules.rst} | 2 +
...hci1394.txt => debugging-via-ohci1394.rst} | 2 +
Documentation/{dell_rbu.txt => dell_rbu.rst} | 3 +-
Documentation/device-mapper/statistics.rst | 4 +-
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
Documentation/{digsig.txt => digsig.rst} | 2 +
Documentation/driver-api/usb/dma.rst | 6 +-
Documentation/driver-model/device.rst | 2 +-
Documentation/{efi-stub.txt => efi-stub.rst} | 2 +
Documentation/{eisa.txt => eisa.rst} | 2 +
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/sysfs.txt | 2 +-
...ex-requeue-pi.txt => futex-requeue-pi.rst} | 2 +
.../{gcc-plugins.txt => gcc-plugins.rst} | 2 +
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/{highuid.txt => highuid.rst} | 4 +-
.../{hw_random.txt => hw_random.rst} | 2 +
.../{hwspinlock.txt => hwspinlock.rst} | 2 +
Documentation/ia64/irq-redir.rst | 2 +-
.../{intel_txt.txt => intel_txt.rst} | 2 +
.../{io-mapping.txt => io-mapping.rst} | 2 +
.../{io_ordering.txt => io_ordering.rst} | 2 +
Documentation/{iostats.txt => iostats.rst} | 2 +
...flags-tracing.txt => irqflags-tracing.rst} | 3 +-
Documentation/{isa.txt => isa.rst} | 2 +
Documentation/{isapnp.txt => isapnp.rst} | 2 +
...hreads.txt => kernel-per-CPU-kthreads.rst} | 4 +-
Documentation/{kobject.txt => kobject.rst} | 6 +-
Documentation/{kprobes.txt => kprobes.rst} | 3 +-
Documentation/{kref.txt => kref.rst} | 2 +
Documentation/laptops/thinkpad-acpi.rst | 6 +-
Documentation/{ldm.txt => ldm.rst} | 5 +-
Documentation/locking/rt-mutex.rst | 2 +-
...kup-watchdogs.txt => lockup-watchdogs.rst} | 2 +
Documentation/{lsm.txt => lsm.rst} | 2 +
Documentation/{lzo.txt => lzo.rst} | 2 +
Documentation/{mailbox.txt => mailbox.rst} | 2 +
Documentation/memory-barriers.txt | 6 +-
...hameleon-bus.txt => men-chameleon-bus.rst} | 2 +
Documentation/networking/scaling.rst | 4 +-
.../{nommu-mmap.txt => nommu-mmap.rst} | 2 +
Documentation/{ntb.txt => ntb.rst} | 2 +
Documentation/{numastat.txt => numastat.rst} | 3 +-
Documentation/{padata.txt => padata.rst} | 2 +
...port-lowlevel.txt => parport-lowlevel.rst} | 2 +
...-semaphore.txt => percpu-rw-semaphore.rst} | 2 +
Documentation/{phy.txt => phy.rst} | 2 +
Documentation/{pi-futex.txt => pi-futex.rst} | 2 +
Documentation/{pnp.txt => pnp.rst} | 13 +++--
...reempt-locking.txt => preempt-locking.rst} | 4 +-
Documentation/{pwm.txt => pwm.rst} | 2 +
Documentation/{rbtree.txt => rbtree.rst} | 54 +++++++++---------
.../{remoteproc.txt => remoteproc.rst} | 4 +-
Documentation/{rfkill.txt => rfkill.rst} | 2 +
...ust-futex-ABI.txt => robust-futex-ABI.rst} | 2 +
...{robust-futexes.txt => robust-futexes.rst} | 2 +
Documentation/{rpmsg.txt => rpmsg.rst} | 2 +
Documentation/{rtc.txt => rtc.rst} | 8 ++-
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/{sgi-ioc4.txt => sgi-ioc4.rst} | 2 +
Documentation/{siphash.txt => siphash.rst} | 2 +
.../{smsc_ece1099.txt => smsc_ece1099.rst} | 2 +
.../{speculation.txt => speculation.rst} | 2 +
.../{static-keys.txt => static-keys.rst} | 2 +
Documentation/{svga.txt => svga.rst} | 2 +
.../{switchtec.txt => switchtec.rst} | 4 +-
.../{sync_file.txt => sync_file.rst} | 2 +
Documentation/sysctl/kernel.txt | 4 +-
Documentation/sysctl/vm.txt | 2 +-
Documentation/{tee.txt => tee.rst} | 2 +
.../{this_cpu_ops.txt => this_cpu_ops.rst} | 2 +
Documentation/trace/kprobetrace.rst | 2 +-
.../translations/ko_KR/memory-barriers.txt | 6 +-
Documentation/translations/zh_CN/IRQ.txt | 4 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
.../translations/zh_CN/io_ordering.txt | 4 +-
...access.txt => unaligned-memory-access.rst} | 2 +
...ed-device.txt => vfio-mediated-device.rst} | 4 +-
Documentation/{vfio.txt => vfio.rst} | 2 +
.../{video-output.txt => video-output.rst} | 3 +-
Documentation/watchdog/hpwdt.rst | 2 +-
Documentation/x86/topology.rst | 2 +-
Documentation/{xillybus.txt => xillybus.rst} | 2 +
Documentation/{xz.txt => xz.rst} | 2 +
Documentation/{zorro.txt => zorro.rst} | 7 ++-
MAINTAINERS | 56 +++++++++----------
arch/Kconfig | 4 +-
arch/arm/Kconfig | 2 +-
arch/ia64/hp/common/sba_iommu.c | 12 ++--
arch/ia64/sn/pci/pci_dma.c | 4 +-
arch/parisc/Kconfig | 2 +-
arch/parisc/kernel/pci-dma.c | 2 +-
arch/sh/Kconfig | 2 +-
arch/sparc/Kconfig | 2 +-
arch/unicore32/include/asm/io.h | 2 +-
arch/x86/Kconfig | 4 +-
arch/x86/include/asm/dma-mapping.h | 4 +-
arch/x86/kernel/amd_gart_64.c | 2 +-
block/partitions/Kconfig | 2 +-
drivers/base/core.c | 2 +-
drivers/char/Kconfig | 4 +-
drivers/char/hw_random/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/parisc/sba_iommu.c | 16 +++---
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/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
include/asm-generic/bitops/atomic.h | 2 +-
include/linux/dma-mapping.h | 2 +-
include/linux/hw_random.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 +-
include/media/videobuf-dma-sg.h | 2 +-
init/Kconfig | 2 +-
kernel/dma/debug.c | 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/kprobes/kprobe_example.c | 2 +-
samples/kprobes/kretprobe_example.c | 2 +-
scripts/gcc-plugins/Kconfig | 2 +-
security/Kconfig | 2 +-
tools/include/linux/rbtree.h | 2 +-
tools/include/linux/rbtree_augmented.h | 2 +-
173 files changed, 397 insertions(+), 242 deletions(-)
rename Documentation/{DMA-API-HOWTO.txt => DMA-API-HOWTO.rst} (99%)
rename Documentation/{DMA-API.txt => DMA-API.rst} (99%)
rename Documentation/{DMA-ISA-LPC.txt => DMA-ISA-LPC.rst} (98%)
rename Documentation/{DMA-attributes.txt => DMA-attributes.rst} (99%)
rename Documentation/{IPMI.txt => IPMI.rst} (99%)
rename Documentation/{IRQ-affinity.txt => IRQ-affinity.rst} (99%)
rename Documentation/{IRQ-domain.txt => IRQ-domain.rst} (99%)
rename Documentation/{IRQ.txt => IRQ.rst} (99%)
rename Documentation/{Intel-IOMMU.txt => Intel-IOMMU.rst} (99%)
rename Documentation/{SAK.txt => SAK.rst} (99%)
rename Documentation/{SM501.txt => SM501.rst} (99%)
rename Documentation/{atomic_bitops.txt => atomic_bitops.rst} (99%)
rename Documentation/{bt8xxgpio.txt => bt8xxgpio.rst} (99%)
rename Documentation/{btmrvl.txt => btmrvl.rst} (99%)
rename Documentation/{bus-virt-phys-mapping.txt => bus-virt-phys-mapping.rst} (93%)
rename Documentation/{clearing-warn-once.txt => clearing-warn-once.rst} (96%)
rename Documentation/{cpu-load.txt => cpu-load.rst} (99%)
rename Documentation/{cputopology.txt => cputopology.rst} (99%)
rename Documentation/{crc32.txt => crc32.rst} (99%)
rename Documentation/{dcdbas.txt => dcdbas.rst} (99%)
rename Documentation/{debugging-modules.txt => debugging-modules.rst} (98%)
rename Documentation/{debugging-via-ohci1394.txt => debugging-via-ohci1394.rst} (99%)
rename Documentation/{dell_rbu.txt => dell_rbu.rst} (99%)
rename Documentation/{digsig.txt => digsig.rst} (99%)
rename Documentation/{efi-stub.txt => efi-stub.rst} (99%)
rename Documentation/{eisa.txt => eisa.rst} (99%)
rename Documentation/{futex-requeue-pi.txt => futex-requeue-pi.rst} (99%)
rename Documentation/{gcc-plugins.txt => gcc-plugins.rst} (99%)
rename Documentation/{highuid.txt => highuid.rst} (99%)
rename Documentation/{hw_random.txt => hw_random.rst} (99%)
rename Documentation/{hwspinlock.txt => hwspinlock.rst} (99%)
rename Documentation/{intel_txt.txt => intel_txt.rst} (99%)
rename Documentation/{io-mapping.txt => io-mapping.rst} (99%)
rename Documentation/{io_ordering.txt => io_ordering.rst} (99%)
rename Documentation/{iostats.txt => iostats.rst} (99%)
rename Documentation/{irqflags-tracing.txt => irqflags-tracing.rst} (99%)
rename Documentation/{isa.txt => isa.rst} (99%)
rename Documentation/{isapnp.txt => isapnp.rst} (98%)
rename Documentation/{kernel-per-CPU-kthreads.txt => kernel-per-CPU-kthreads.rst} (99%)
rename Documentation/{kobject.txt => kobject.rst} (99%)
rename Documentation/{kprobes.txt => kprobes.rst} (99%)
rename Documentation/{kref.txt => kref.rst} (99%)
rename Documentation/{ldm.txt => ldm.rst} (98%)
rename Documentation/{lockup-watchdogs.txt => lockup-watchdogs.rst} (99%)
rename Documentation/{lsm.txt => lsm.rst} (99%)
rename Documentation/{lzo.txt => lzo.rst} (99%)
rename Documentation/{mailbox.txt => mailbox.rst} (99%)
rename Documentation/{men-chameleon-bus.txt => men-chameleon-bus.rst} (99%)
rename Documentation/{nommu-mmap.txt => nommu-mmap.rst} (99%)
rename Documentation/{ntb.txt => ntb.rst} (99%)
rename Documentation/{numastat.txt => numastat.rst} (99%)
rename Documentation/{padata.txt => padata.rst} (99%)
rename Documentation/{parport-lowlevel.txt => parport-lowlevel.rst} (99%)
rename Documentation/{percpu-rw-semaphore.txt => percpu-rw-semaphore.rst} (99%)
rename Documentation/{phy.txt => phy.rst} (99%)
rename Documentation/{pi-futex.txt => pi-futex.rst} (99%)
rename Documentation/{pnp.txt => pnp.rst} (98%)
rename Documentation/{preempt-locking.txt => preempt-locking.rst} (99%)
rename Documentation/{pwm.txt => pwm.rst} (99%)
rename Documentation/{rbtree.txt => rbtree.rst} (94%)
rename Documentation/{remoteproc.txt => remoteproc.rst} (99%)
rename Documentation/{rfkill.txt => rfkill.rst} (99%)
rename Documentation/{robust-futex-ABI.txt => robust-futex-ABI.rst} (99%)
rename Documentation/{robust-futexes.txt => robust-futexes.rst} (99%)
rename Documentation/{rpmsg.txt => rpmsg.rst} (99%)
rename Documentation/{rtc.txt => rtc.rst} (99%)
rename Documentation/{sgi-ioc4.txt => sgi-ioc4.rst} (99%)
rename Documentation/{siphash.txt => siphash.rst} (99%)
rename Documentation/{smsc_ece1099.txt => smsc_ece1099.rst} (99%)
rename Documentation/{speculation.txt => speculation.rst} (99%)
rename Documentation/{static-keys.txt => static-keys.rst} (99%)
rename Documentation/{svga.txt => svga.rst} (99%)
rename Documentation/{switchtec.txt => switchtec.rst} (98%)
rename Documentation/{sync_file.txt => sync_file.rst} (99%)
rename Documentation/{tee.txt => tee.rst} (99%)
rename Documentation/{this_cpu_ops.txt => this_cpu_ops.rst} (99%)
rename Documentation/{unaligned-memory-access.txt => unaligned-memory-access.rst} (99%)
rename Documentation/{vfio-mediated-device.txt => vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => vfio.rst} (99%)
rename Documentation/{video-output.txt => video-output.rst} (99%)
rename Documentation/{xillybus.txt => xillybus.rst} (99%)
rename Documentation/{xz.txt => xz.rst} (99%)
rename Documentation/{zorro.txt => 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.txt. +For details to this subsystem look at Documentation/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.txt. +For details to this subsystem look at Documentation/rfkill.rst. For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in Documentation/ABI/removed/sysfs-class-rfkill.
Documentation/ABI/stable/sysfs-devices-node +1 -1
@@ -61,7 +61,7 @@ Date: October 2002 Contact: Linux Memory Management list <[email protected]> Description: The node's hit/miss statistics, in units of pages. - See Documentation/numastat.txt + See Documentation/numastat.rst What: /sys/devices/system/node/nodeX/distance Date: October 2002
Documentation/ABI/testing/procfs-diskstats +1 -1
@@ -29,4 +29,4 @@ Description: 17 - sectors discarded 18 - time spent discarding - For more details refer to Documentation/iostats.txt + For more details refer to Documentation/iostats.rst
Documentation/ABI/testing/sysfs-block +1 -1
@@ -15,7 +15,7 @@ Description: 9 - I/Os currently in progress 10 - time spent doing I/Os (ms) 11 - weighted time spent doing I/Os (ms) - For more details refer Documentation/iostats.txt + For more details refer Documentation/iostats.rst What: /sys/block/<disk>/<part>/stat
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.txt. +For details on this subsystem look at Documentation/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017
Documentation/ABI/testing/sysfs-devices-system-cpu +2 -2
@@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to present: cpus that have been identified as being present in the system. - See Documentation/cputopology.txt for more information. + See Documentation/cputopology.rst for more information. What: /sys/devices/system/cpu/probe
@@ -103,7 +103,7 @@ Description: CPU topology files that describe a logical CPU's relationship thread_siblings_list: human-readable list of cpu#'s hardware threads within the same core as cpu# - See Documentation/cputopology.txt for more information. + See Documentation/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driver
Documentation/DMA-API-HOWTO.rst renamed from Documentation/DMA-API-HOWTO.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ========================= Dynamic DMA mapping Guide =========================
Documentation/DMA-API.rst renamed from Documentation/DMA-API.txt +5 -3
@@ -1,3 +1,5 @@ +:orphan: + ============================================ Dynamic DMA mapping using the generic device ============================================
@@ -5,7 +7,7 @@ Dynamic DMA mapping using the generic device :Author: James E.J. Bottomley <[email protected]> This document describes the DMA API. For a more gentle introduction -of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt. +of the API (and actual examples), see Documentation/DMA-API-HOWTO.rst. This API is split into two pieces. Part I describes the basic API. Part II describes extensions for supporting non-consistent memory
@@ -463,7 +465,7 @@ without the _attrs suffixes, except that they pass an optional dma_attrs. The interpretation of DMA attributes is architecture-specific, and -each attribute should be documented in Documentation/DMA-attributes.txt. +each attribute should be documented in Documentation/DMA-attributes.rst. If dma_attrs are 0, the semantics of each of these functions is identical to those of the corresponding function
@@ -476,7 +478,7 @@ for DMA:: #include <linux/dma-mapping.h> /* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and - * documented in Documentation/DMA-attributes.txt */ + * documented in Documentation/DMA-attributes.rst */ ... unsigned long attr;
Documentation/DMA-ISA-LPC.rst renamed from Documentation/DMA-ISA-LPC.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + ============================ DMA with ISA and LPC devices ============================
@@ -17,7 +19,7 @@ To do ISA style DMA you need to include two headers:: #include <asm/dma.h> The first is the generic DMA API used to convert virtual addresses to -bus addresses (see Documentation/DMA-API.txt for details). +bus addresses (see Documentation/DMA-API.rst for details). The second contains the routines specific to ISA DMA transfers. Since this is not present on all platforms make sure you construct your
Documentation/DMA-attributes.rst renamed from Documentation/DMA-attributes.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============== DMA attributes ==============
Documentation/IPMI.rst renamed from Documentation/IPMI.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ===================== The Linux IPMI Driver =====================
Documentation/IRQ-affinity.rst renamed from Documentation/IRQ-affinity.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================ SMP IRQ affinity ================
Documentation/IRQ-domain.rst renamed from Documentation/IRQ-domain.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =============================================== The irq_domain interrupt number mapping library ===============================================
Documentation/IRQ.rst renamed from Documentation/IRQ.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =============== What is an IRQ? ===============
Documentation/Intel-IOMMU.rst renamed from Documentation/Intel-IOMMU.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =================== Linux IOMMU Support ===================
Documentation/PCI/pci.rst +4 -4
@@ -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.txt for how to access device registers +See Documentation/io-mapping.rst for how to access device registers or device memory. The device driver needs to call pci_request_region() to verify
@@ -265,7 +265,7 @@ Set the DMA mask size --------------------- .. note:: If anything below doesn't make sense, please refer to - Documentation/DMA-API.txt. This section is just a reminder that + Documentation/DMA-API.rst. This section is just a reminder that drivers need to indicate DMA capabilities of the device and is not an authoritative source for DMA interfaces.
@@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are Setup shared control data ------------------------- Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) -memory. See Documentation/DMA-API.txt for a full description of +memory. See Documentation/DMA-API.rst for a full description of the DMA APIs. This section is just a reminder that it needs to be done before enabling DMA on the device.
@@ -421,7 +421,7 @@ owners if there is one. Then clean up "consistent" buffers which contain the control data. -See Documentation/DMA-API.txt for details on unmapping interfaces. +See Documentation/DMA-API.rst for details on unmapping interfaces. Unregister from other subsystems
Documentation/SAK.rst renamed from Documentation/SAK.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + ========================================= Linux Secure Attention Key (SAK) handling =========================================
@@ -88,4 +90,3 @@ And that's it! Only the superuser may reprogram the SAK key. /dev/console. So SAK kills them all. A workaround is to simply delete these lines, but this may cause system management applications to malfunction - test everything well. -
Documentation/SM501.rst renamed from Documentation/SM501.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + .. include:: <isonum.txt> ============
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.txt + https://www.kernel.org/doc/Documentation/IRQ-affinity.rst .. _smt_control:
Documentation/admin-guide/kernel-parameters.txt +2 -2
@@ -3162,7 +3162,7 @@ See Documentation/sysctl/vm.txt for details. ohci1394_dma=early [HW] enable debugging via the ohci1394 driver. - See Documentation/debugging-via-ohci1394.txt for more + See Documentation/debugging-via-ohci1394.rst for more info. olpc_ec_timeout= [OLPC] ms delay when issuing EC commands
@@ -5075,7 +5075,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.txt. + Documentation/svga.rst. Use vga=ask for menu. This is actually a boot loader parameter; the value is passed to the kernel using a special protocol.
Documentation/atomic_bitops.rst renamed from Documentation/atomic_bitops.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + ============= Atomic bitops =============
@@ -68,4 +70,3 @@ clear_bit_unlock() which has RELEASE semantics. Since a platform only has a single means of achieving atomic operations the same barriers as for atomic_t are used, see atomic_t.txt. -
Documentation/block/biodoc.txt +1 -1
@@ -184,7 +184,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address do not have a corresponding kernel virtual address space mapping) and low-memory pages. -Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion +Note: Please refer to Documentation/DMA-API-HOWTO.rst for a discussion on PCI high mem DMA aspects and mapping of scatter gather lists, and support for 64 bit PCI.
Documentation/bt8xxgpio.rst renamed from Documentation/bt8xxgpio.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + =================================================================== A driver for a selfmade cheap BT8xx based PCI GPIO-card (bt8xxgpio) ===================================================================
@@ -59,4 +61,3 @@ The GPIO pins are marked with G00-G23:: | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ^ This is pin 1 -
Documentation/btmrvl.rst renamed from Documentation/btmrvl.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============= btmrvl driver =============
Documentation/bus-virt-phys-mapping.rst renamed from Documentation/bus-virt-phys-mapping.txt +28 -26
144 lines not on this page · raw message
Documentation/clearing-warn-once.rst renamed from Documentation/clearing-warn-once.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + Clearing WARN_ONCE ------------------
Documentation/cpu-load.rst renamed from Documentation/cpu-load.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ======== CPU load ========
Documentation/cputopology.rst renamed from Documentation/cputopology.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========================================== How CPU topology info is exported via sysfs ===========================================
Documentation/crc32.rst renamed from Documentation/crc32.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================================= brief tutorial on CRC computation =================================
Documentation/dcdbas.rst renamed from Documentation/dcdbas.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =================================== Dell Systems Management Base Driver ===================================
Documentation/debugging-modules.rst renamed from Documentation/debugging-modules.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + Debugging Modules after 2.6.3 -----------------------------
Documentation/debugging-via-ohci1394.rst renamed from Documentation/debugging-via-ohci1394.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========================================================================== Using physical DMA provided by OHCI-1394 FireWire controllers for debugging ===========================================================================
Documentation/dell_rbu.rst renamed from Documentation/dell_rbu.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + ============================================================= Usage of the new open sourced rbu (Remote BIOS Update) driver =============================================================
@@ -125,4 +127,3 @@ read back the image downloaded. code which sends the BIOS update request to the BIOS. So on the next reboot the BIOS knows about the new image downloaded and it updates itself. Also don't unload the rbu driver if the image has to be updated. -
Documentation/device-mapper/statistics.rst +2 -2
@@ -13,7 +13,7 @@ the range specified. The I/O statistics counters for each step-sized area of a region are in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see: -Documentation/iostats.txt). But two extra counters (12 and 13) are +Documentation/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending
@@ -151,7 +151,7 @@ Messages The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. - Please refer to Documentation/iostats.txt for details. + Please refer to Documentation/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged
Documentation/devicetree/bindings/phy/phy-bindings.txt +1 -1
@@ -1,5 +1,5 @@ This document explains only the device tree data binding. For general -information about PHY subsystem refer to Documentation/phy.txt +information about PHY subsystem refer to Documentation/phy.rst PHY device node ===============
Documentation/digsig.rst renamed from Documentation/digsig.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================================== Digital Signature Verification API ==================================
Documentation/driver-api/usb/dma.rst +3 -3
@@ -10,7 +10,7 @@ API overview The big picture is that USB drivers can continue to ignore most DMA issues, though they still must provide DMA-ready buffers (see -``Documentation/DMA-API-HOWTO.txt``). That's how they've worked through +``Documentation/DMA-API-HOWTO.rst``). That's how they've worked through the 2.4 (and earlier) kernels, or they can now be DMA-aware. DMA-aware usb drivers:
@@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties. force a consistent memory access ordering by using memory barriers. It's not using a streaming DMA mapping, so it's good for small transfers on systems where the I/O would otherwise thrash an IOMMU mapping. (See - ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and + ``Documentation/DMA-API-HOWTO.rst`` for definitions of "coherent" and "streaming" DMA mappings.) Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
@@ -91,7 +91,7 @@ Working with existing buffers Existing buffers aren't usable for DMA without first being mapped into the DMA address space of the device. However, most buffers passed to your driver can safely be used with such DMA mapping. (See the first section -of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?") +of Documentation/DMA-API-HOWTO.rst, titled "What memory is DMA-able?") - When you're using scatterlists, you can map everything at once. On some systems, this kicks in an IOMMU and turns the scatterlists into single
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.txt, device attributes must be +As explained in Documentation/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/efi-stub.rst renamed from Documentation/efi-stub.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================= The EFI Boot Stub =================
Documentation/eisa.rst renamed from Documentation/eisa.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================ EISA bus support ================
Documentation/fb/vesafb.rst +1 -1
@@ -30,7 +30,7 @@ How to use it? ============== Switching modes is done using the vga=... boot parameter. Read -Documentation/svga.txt for details. +Documentation/svga.rst for details. You should compile in both vgacon (for text mode) and vesafb (for graphics mode). Which of them takes over the console depends on
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.txt for more information concerning the kobject +Documentation/kobject.rst for more information concerning the kobject interface.
Documentation/futex-requeue-pi.rst renamed from Documentation/futex-requeue-pi.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================ Futex Requeue PI ================
Documentation/gcc-plugins.rst renamed from Documentation/gcc-plugins.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ========================= GCC plugin infrastructure =========================
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.txt +Documentation/nommu-mmap.rst Memory Coherency ----------------
Documentation/highuid.rst renamed from Documentation/highuid.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + =================================================== Notes on the change from 16-bit UIDs to 32-bit UIDs ===================================================
@@ -19,7 +21,7 @@ What's left to be done for 32-bit UIDs on all Linux architectures: underlying filesystem, because quota records are written at offsets corresponding to the UID in question. Further investigation is needed to see if the quota system can cope - properly with huge UIDs. If it can deal with 64-bit file offsets on all + properly with huge UIDs. If it can deal with 64-bit file offsets on all architectures, this should not be a problem. - Decide whether or not to keep backwards compatibility with the system
Documentation/hw_random.rst renamed from Documentation/hw_random.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ========================================================== Linux support for random number generator in i8xx chipsets ==========================================================
Documentation/hwspinlock.rst renamed from Documentation/hwspinlock.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========================== Hardware Spinlock Framework ===========================
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.txt for i386 systems. +that described in Documentation/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/intel_txt.rst renamed from Documentation/intel_txt.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ===================== Intel(R) TXT Overview =====================
Documentation/io-mapping.rst renamed from Documentation/io-mapping.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ======================== The io_mapping functions ========================
Documentation/io_ordering.rst renamed from Documentation/io_ordering.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============================================== Ordering I/O writes to memory-mapped addresses ==============================================
Documentation/iostats.rst renamed from Documentation/iostats.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ===================== I/O statistics fields =====================
Documentation/irqflags-tracing.rst renamed from Documentation/irqflags-tracing.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + ======================= IRQ-flags state tracing =======================
@@ -49,4 +51,3 @@ turn itself off. I.e. the lock validator will still be reliable. There should be no crashes due to irq-tracing bugs. (except if the assembly changes break other code by modifying conditions or registers that shouldn't be) -
Documentation/isa.rst renamed from Documentation/isa.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========== ISA Drivers ===========
Documentation/isapnp.rst renamed from Documentation/isapnp.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ========================================================== ISA Plug & Play support by Jaroslav Kysela <[email protected]> ==========================================================
Documentation/kernel-per-CPU-kthreads.rst renamed from Documentation/kernel-per-CPU-kthreads.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + ========================================== Reducing OS jitter due to per-cpu kthreads ==========================================
@@ -10,7 +12,7 @@ them to a "housekeeping" CPU dedicated to such work. References ========== -- Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs. +- Documentation/IRQ-affinity.rst: Binding interrupts to sets of CPUs. - Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
Documentation/kobject.rst renamed from Documentation/kobject.txt +4 -2
@@ -1,3 +1,5 @@ +:orphan: + ===================================================================== Everything you never wanted to know about kobjects, ksets, and ktypes =====================================================================
@@ -210,7 +212,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.txt in the Linux kernel source tree. +file Documentation/kref.rst in the Linux kernel source tree. Creating "simple" kobjects
@@ -270,7 +272,7 @@ such a method has a form like:: void my_object_release(struct kobject *kobj) { - struct my_object *mine = container_of(kobj, struct my_object, kobj); + struct my_object *mine = container_of(kobj, struct my_object, kobj); /* Perform any additional cleanup on this object, then... */ kfree(mine);
Documentation/kprobes.rst renamed from Documentation/kprobes.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + ======================= Kernel Probes (Kprobes) =======================
@@ -798,4 +800,3 @@ unoptimized, and any new probes registered after that will not be optimized. Note that this knob *changes* the optimized state. This means that optimized probes (marked [OPTIMIZED]) will be unoptimized ([OPTIMIZED] tag will be removed). If the knob is turned on, they will be optimized again. -
Documentation/kref.rst renamed from Documentation/kref.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =================================================== Adding reference counters (krefs) to kernel objects ===================================================
Documentation/laptops/thinkpad-acpi.rst +3 -3
@@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.txt for details. + Documentation/rfkill.rst for details. Video output control -- /proc/acpi/ibm/video
@@ -1406,7 +1406,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_wwan_sw": refer to - Documentation/rfkill.txt for details. + Documentation/rfkill.rst for details. EXPERIMENTAL: UWB
@@ -1426,7 +1426,7 @@ Sysfs notes ^^^^^^^^^^^ rfkill controller switch "tpacpi_uwb_sw": refer to - Documentation/rfkill.txt for details. + Documentation/rfkill.rst for details. Adaptive keyboard -----------------
Documentation/ldm.rst renamed from Documentation/ldm.txt +3 -2
@@ -1,3 +1,5 @@ +:orphan: + ========================================== LDM - Logical Disk Manager (Dynamic Disks) ==========================================
@@ -75,7 +77,7 @@ When Linux boots, you will see something like:: Compiling LDM Support --------------------- -To enable LDM, choose the following two options: +To enable LDM, choose the following two options: - "Advanced partition selection" CONFIG_PARTITION_ADVANCED - "Windows Logical Disk Manager (Dynamic Disk) support" CONFIG_LDM_PARTITION
@@ -118,4 +120,3 @@ me. Cheers, FlatCap - Richard Russon [email protected] -
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.txt for more details +(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.rst for more details about PI-futexes.] This technology was developed in the -rt tree and streamlined for
Documentation/lockup-watchdogs.rst renamed from Documentation/lockup-watchdogs.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =============================================================== Softlockup detector and hardlockup detector (aka nmi_watchdog) ===============================================================
Documentation/lsm.rst renamed from Documentation/lsm.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ======================================================== Linux Security Modules: General Security Hooks for Linux ========================================================
Documentation/lzo.rst renamed from Documentation/lzo.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========================================================== LZO stream format as understood by Linux's LZO decompressor ===========================================================
Documentation/mailbox.rst renamed from Documentation/mailbox.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============================ The Common Mailbox Framework ============================
Documentation/memory-barriers.txt +3 -3
@@ -549,8 +549,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee: [*] For information on bus mastering DMA and coherency please read: Documentation/PCI/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/DMA-API-HOWTO.rst + Documentation/DMA-API.rst DATA DEPENDENCY BARRIERS (HISTORICAL)
@@ -1933,7 +1933,7 @@ There are some more advanced barrier functions: here. See the subsection "Kernel I/O barrier effects" for more information on - relaxed I/O accessors and the Documentation/DMA-API.txt file for more + relaxed I/O accessors and the Documentation/DMA-API.rst file for more information on consistent memory.
Documentation/men-chameleon-bus.rst renamed from Documentation/men-chameleon-bus.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================= MEN Chameleon Bus =================
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.txt. Some systems +affinity of each interrupt see Documentation/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.txt explains how CPUs are assigned to +CPU. Documentation/IRQ-affinity.rst explains how CPUs are assigned to the bitmap.
Documentation/nommu-mmap.rst renamed from Documentation/nommu-mmap.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============================= No-MMU memory mapping support =============================
Documentation/ntb.rst renamed from Documentation/ntb.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========== NTB Drivers ===========
Documentation/numastat.rst renamed from Documentation/numastat.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + =============================== Numa policy hit/miss statistics ===============================
@@ -27,4 +29,3 @@ interleave_hit Interleaving wanted to allocate from this node For easier reading you can use the numastat utility from the numactl package (http://oss.sgi.com/projects/libnuma/). Note that it only works well right now on machines with a small number of CPUs. -
Documentation/padata.rst renamed from Documentation/padata.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ======================================= The padata parallel execution mechanism =======================================
Documentation/parport-lowlevel.rst renamed from Documentation/parport-lowlevel.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =============================== PARPORT interface documentation ===============================
Documentation/percpu-rw-semaphore.rst renamed from Documentation/percpu-rw-semaphore.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ==================== Percpu rw semaphores ====================
Documentation/phy.rst renamed from Documentation/phy.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============= PHY subsystem =============
Documentation/pi-futex.rst renamed from Documentation/pi-futex.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ====================== Lightweight PI-futexes ======================
Documentation/pnp.rst renamed from Documentation/pnp.txt +7 -6
@@ -1,3 +1,5 @@ +:orphan: + ================================= Linux Plug and Play Documentation =================================
@@ -10,7 +12,7 @@ Overview -------- Plug and Play provides a means of detecting and setting resources for legacy or -otherwise unconfigurable devices. The Linux Plug and Play Layer provides these +otherwise unconfigurable devices. The Linux Plug and Play Layer provides these services to compatible drivers.
@@ -18,7 +20,7 @@ The User Interface ------------------ The Linux Plug and Play user interface provides a means to activate PnP devices -for legacy and user level drivers that do not support Linux Plug and Play. The +for legacy and user level drivers that do not support Linux Plug and Play. The user interface is integrated into sysfs. In addition to the standard sysfs file the following are created in each
@@ -113,9 +115,9 @@ The Unified Plug and Play Layer ------------------------------- All Plug and Play drivers, protocols, and services meet at a central location -called the Plug and Play Layer. This layer is responsible for the exchange of -information between PnP drivers and PnP protocols. Thus it automatically -forwards commands to the proper protocol. This makes writing PnP drivers +called the Plug and Play Layer. This layer is responsible for the exchange of +information between PnP drivers and PnP protocols. Thus it automatically +forwards commands to the proper protocol. This makes writing PnP drivers significantly easier. The following functions are available from the Plug and Play Layer:
@@ -289,4 +291,3 @@ They are as follows:: unsigned short vendor, unsigned short function, struct pnp_dev *from) -
Documentation/preempt-locking.rst renamed from Documentation/preempt-locking.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + =========================================================================== Proper Locking Under a Preemptible Kernel: Keeping Kernel Code Preempt-Safe ===========================================================================
@@ -16,7 +18,7 @@ requires explicit additional locking for very few additional situations. This document is for all kernel hackers. Developing code in the kernel requires protecting these situations. - + RULE #1: Per-CPU data structures need explicit protection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Documentation/pwm.rst renamed from Documentation/pwm.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ====================================== Pulse Width Modulation (PWM) interface ======================================
Documentation/rbtree.rst renamed from Documentation/rbtree.txt +28 -26
98 lines not on this page · raw message
Documentation/remoteproc.rst renamed from Documentation/remoteproc.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + ========================== Remote Processor Framework ==========================
@@ -22,7 +24,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.txt). +please read Documentation/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/rfkill.rst renamed from Documentation/rfkill.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =============================== rfkill - RF kill switch support ===============================
Documentation/robust-futex-ABI.rst renamed from Documentation/robust-futex-ABI.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ==================== The robust futex ABI ====================
Documentation/robust-futexes.rst renamed from Documentation/robust-futexes.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ======================================== A description of what robust futexes are ========================================
Documentation/rpmsg.rst renamed from Documentation/rpmsg.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============================================ Remote Processor Messaging (rpmsg) Framework ============================================
Documentation/rtc.rst renamed from Documentation/rtc.txt +5 -3
@@ -1,3 +1,5 @@ +:orphan: + ======================================= Real Time Clock (RTC) Drivers for Linux =======================================
@@ -86,9 +88,9 @@ a different value to /proc/sys/dev/rtc/max-user-freq. Note that the interrupt handler is only a few lines of code to minimize any possibility of this effect. -Also, if the kernel time is synchronized with an external source, the -kernel will write the time back to the CMOS clock every 11 minutes. In -the process of doing this, the kernel briefly turns off RTC periodic +Also, if the kernel time is synchronized with an external source, the +kernel will write the time back to the CMOS clock every 11 minutes. In +the process of doing this, the kernel briefly turns off RTC periodic interrupts, so be aware of this if you are doing serious work. If you don't synchronize the kernel time with an external source (via ntp or whatever) then the kernel will keep its hands off the RTC, allowing you
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.txt +- Documentation/vfio-mediated-device.rst Motivation of vfio-ccw ----------------------
@@ -322,5 +322,5 @@ Reference 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204) 3. https://en.wikipedia.org/wiki/Channel_I/O 4. Documentation/s390/cds.rst -5. Documentation/vfio.txt -6. Documentation/vfio-mediated-device.txt +5. Documentation/vfio.rst +6. Documentation/vfio-mediated-device.rst
Documentation/sgi-ioc4.rst renamed from Documentation/sgi-ioc4.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ==================================== SGI IOC4 PCI (multi function) device ====================================
Documentation/siphash.rst renamed from Documentation/siphash.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========================== SipHash - a short input PRF ===========================
Documentation/smsc_ece1099.rst renamed from Documentation/smsc_ece1099.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================================================= Msc Keyboard Scan Expansion/GPIO Expansion device =================================================
Documentation/speculation.rst renamed from Documentation/speculation.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + This document explains potential effects of speculation, and how undesirable effects can be mitigated portably using common APIs.
Documentation/static-keys.rst renamed from Documentation/static-keys.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =========== Static Keys ===========
Documentation/svga.rst renamed from Documentation/svga.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + .. include:: <isonum.txt> =================================
Documentation/switchtec.rst renamed from Documentation/switchtec.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + ======================== Linux Switchtec Support ========================
@@ -97,6 +99,6 @@ the following configuration settings: NT EP BAR 2 will be dynamically configured as a Direct Window, and the configuration file does not need to configure it explicitly. -Please refer to Documentation/ntb.txt in Linux source tree for an overall +Please refer to Documentation/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/sync_file.rst renamed from Documentation/sync_file.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =================== Sync File API Guide ===================
Documentation/sysctl/kernel.txt +2 -2
@@ -44,7 +44,7 @@ show up in /proc/sys/kernel: - kexec_load_disabled - kptr_restrict - l2cr [ PPC only ] -- modprobe ==> Documentation/debugging-modules.txt +- modprobe ==> Documentation/debugging-modules.rst - modules_disabled - msg_next_id [ sysv ipc ] - msgmax
@@ -327,7 +327,7 @@ when a hard lockup is detected. 0 - don't panic on hard lockup 1 - panic on hard lockup -See Documentation/lockup-watchdogs.txt for more information. This can +See Documentation/lockup-watchdogs.rst for more information. This can also be set using the nmi_watchdog kernel parameter. ==============================================================
Documentation/sysctl/vm.txt +1 -1
@@ -566,7 +566,7 @@ trimming of allocations is initiated. The default value is 1. -See Documentation/nommu-mmap.txt for more information. +See Documentation/nommu-mmap.rst for more information. ==============================================================
Documentation/tee.rst renamed from Documentation/tee.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============= TEE subsystem =============
Documentation/this_cpu_ops.rst renamed from Documentation/this_cpu_ops.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + =================== this_cpu operations ===================
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.txt section 1.3.1. + as defined in Documentation/kprobes.rst section 1.3.1. FETCHARGS : Arguments. Each probe can have up to 128 args. %REG : Fetch register REG
Documentation/translations/ko_KR/memory-barriers.txt +3 -3
@@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE [*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다: Documentation/PCI/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/DMA-API-HOWTO.rst + Documentation/DMA-API.rst 데이터 의존성 배리어 (역사적)
@@ -1904,7 +1904,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효 writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는 "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을 - 위해선 Documentation/DMA-API.txt 문서를 참고하세요. + 위해선 Documentation/DMA-API.rst 문서를 참고하세요. MMIO 쓰기 배리어
Documentation/translations/zh_CN/IRQ.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/IRQ.txt +Chinese translated version of Documentation/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.txt 的中文翻译 +Documentation/IRQ.rst 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
Documentation/translations/zh_CN/filesystems/sysfs.txt +1 -1
@@ -40,7 +40,7 @@ sysfs 是一个最初基于 ramfs 且位于内存的文件系统。它提供导 数据结构及其属性,以及它们之间的关联到用户空间的方法。 sysfs 始终与 kobject 的底层结构紧密相关。请阅读 -Documentation/kobject.txt 文档以获得更多关于 kobject 接口的 +Documentation/kobject.rst 文档以获得更多关于 kobject 接口的 信息。
Documentation/translations/zh_CN/io_ordering.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/io_ordering.txt +Chinese translated version of Documentation/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.txt 的中文翻译 +Documentation/io_ordering.rst 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
Documentation/unaligned-memory-access.rst renamed from Documentation/unaligned-memory-access.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ========================= Unaligned Memory Accesses =========================
Documentation/vfio-mediated-device.rst renamed from Documentation/vfio-mediated-device.txt +3 -1
@@ -1,3 +1,5 @@ +:orphan: + .. include:: <isonum.txt> =====================
@@ -408,7 +410,7 @@ card. References ========== -1. See Documentation/vfio.txt for more information on VFIO. +1. See Documentation/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/vfio.rst renamed from Documentation/vfio.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ================================== VFIO - "Virtual Function I/O" [1]_ ==================================
Documentation/video-output.rst renamed from Documentation/video-output.txt +2 -1
@@ -1,3 +1,5 @@ +:orphan: + Video Output Switcher Control ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -31,4 +33,3 @@ method for 'state' with output sysfs class. The user interface under sysfs is:: |-- state |-- subsystem -> ../../../class/video_output `-- uevent -
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.txt. + Documentation/watchdog/watchdog-api.rst and Documentation/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
Documentation/x86/topology.rst +1 -1
@@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the respective code. The architecture-agnostic topology definitions are in -Documentation/cputopology.txt. This file holds x86-specific +Documentation/cputopology.rst. This file holds x86-specific differences/specialities which must not necessarily apply to the generic definitions. Thus, the way to read up on Linux topology on x86 is to start with the generic one and look at this one in parallel for the x86 specifics.
Documentation/xillybus.rst renamed from Documentation/xillybus.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ========================================== Xillybus driver for generic FPGA interface ==========================================
Documentation/xz.rst renamed from Documentation/xz.txt +2 -0
@@ -1,3 +1,5 @@ +:orphan: + ============================ XZ data compression in Linux ============================
Documentation/zorro.rst renamed from Documentation/zorro.txt +4 -3
@@ -1,3 +1,5 @@ +:orphan: + ======================================== Writing Device Drivers for Zorro Devices ========================================
@@ -77,7 +79,7 @@ The treatment of these regions depends on the type of Zorro space: - Zorro II address space is always mapped and does not have to be mapped explicitly using z_ioremap(). - + Conversion from bus/physical Zorro II addresses to kernel virtual addresses and vice versa is done using::
@@ -86,7 +88,7 @@ The treatment of these regions depends on the type of Zorro space: - Zorro III address space must be mapped explicitly using z_ioremap() first before it can be accessed:: - + virt_addr = z_ioremap(bus_addr, size); ... z_iounmap(virt_addr);
@@ -101,4 +103,3 @@ References #. linux/arch/m68k/include/asm/zorro.h #. linux/drivers/zorro #. /proc/bus/zorro -
MAINTAINERS +28 -28
224 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.txt for more + See Documentation/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.txt for more + See Documentation/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config ARCH_USE_BUILTIN_BSWAP
arch/arm/Kconfig +1 -1
@@ -1266,7 +1266,7 @@ config SMP will run faster if you say N here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://tldp.org/HOWTO/SMP-HOWTO.html>. If you don't know what to do here, say N.
arch/ia64/hp/common/sba_iommu.c +6 -6
@@ -912,7 +912,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dir: dma direction * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static dma_addr_t sba_map_page(struct device *dev, struct page *page, unsigned long poff, size_t size,
@@ -1033,7 +1033,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size)* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_page (struct device *dev,dma_addr_t iova,size_t size,enum dma_data_direction dir,unsigned long attrs)
@@ -1110,7 +1110,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void * sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
@@ -1167,7 +1167,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void sba_free_coherent (struct device *dev,size_t size,void *vaddr,dma_addr_t dma_handle,unsigned long attrs)
@@ -1430,7 +1430,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,
@@ -1529,7 +1529,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,
arch/ia64/sn/pci/pci_dma.c +2 -2
@@ -5,7 +5,7 @@* * Copyright (C) 2000,2002-2005 Silicon Graphics, Inc. All rights reserved. * -* Routines for PCI DMA mapping. See Documentation/DMA-API.txt for +* Routines for PCI DMA mapping. See Documentation/DMA-API.rst for * a description of how these routines should be used. */
@@ -72,7 +72,7 @@ EXPORT_SYMBOL(sn_dma_set_mask);* that @dma_handle will have the %PCIIO_DMA_CMD flag set. * * This interface is usually used for "command" streams (e.g. the command -* queue for a SCSI controller). See Documentation/DMA-API.txt for +* queue for a SCSI controller). See Documentation/DMA-API.rst for * more information. */ static void *sn_dma_alloc_coherent(struct device *dev, size_t size,
arch/parisc/Kconfig +1 -1
@@ -275,7 +275,7 @@ config SMP machines, but will use only one CPU of a multiprocessor machine. On a uniprocessor machine, the kernel will run faster if you say N. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
arch/parisc/kernel/pci-dma.c +1 -1
@@ -3,7 +3,7 @@ ** PARISC 1.1 Dynamic DMA mapping support. ** This implementation is for PA-RISC platforms that do not support ** I/O TLBs (aka DMA address translation hardware). -** See Documentation/DMA-API-HOWTO.txt for interface definitions. +** See Documentation/DMA-API-HOWTO.rst for interface definitions. ** ** (c) Copyright 1999,2000 Hewlett-Packard Company ** (c) Copyright 2000 Grant Grundler
arch/sh/Kconfig +1 -1
@@ -677,7 +677,7 @@ config SMP People using multiprocessor machines who say Y here should also say Y to "Enhanced Real Time Clock Support", below. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
arch/sparc/Kconfig +1 -1
@@ -179,7 +179,7 @@ config SMP Y to "Enhanced Real Time Clock Support", below. The "Advanced Power Management" code will be disabled if you say Y here. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
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.txt. +* Documentation/io-mapping.rst. * */ #define ioremap (cookie, size) __uc32_ioremap(cookie, size)
arch/x86/Kconfig +2 -2
@@ -397,7 +397,7 @@ config SMP Management" code will be disabled if you say Y here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
@@ -1954,7 +1954,7 @@ config EFI_STUB This kernel feature allows a bzImage to be loaded directly by EFI firmware without the use of a bootloader. - See Documentation/efi-stub.txt for more information. + See Documentation/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support"
arch/x86/include/asm/dma-mapping.h +2 -2
@@ -3,8 +3,8 @@#define _ASM_X86_DMA_MAPPING_H/* -* IOMMU interface. See Documentation/DMA-API-HOWTO.txt and -* Documentation/DMA-API.txt for documentation. +* IOMMU interface. See Documentation/DMA-API-HOWTO.rst and +* Documentation/DMA-API.rst for documentation. */ #include <linux/scatterlist.h>
arch/x86/kernel/amd_gart_64.c +1 -1
@@ -6,7 +6,7 @@* This allows to use PCI devices that only support 32bit addresses on systems * with more than 4GB. * -* See Documentation/DMA-API-HOWTO.txt for the interface specification. +* See Documentation/DMA-API-HOWTO.rst for the interface specification. * * Copyright 2002 Andi Kleen, SuSE Labs. */
block/partitions/Kconfig +1 -1
@@ -194,7 +194,7 @@ config LDM_PARTITION Normal partitions are now called Basic Disks under Windows 2000, XP, and Vista. - For a fuller description read <file:Documentation/ldm.txt>. + For a fuller description read <file:Documentation/ldm.rst>. If unsure, say N.
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.txt.\n" , +WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/kobject.rst.\n" ,dev_name (dev));kfree (p); }
drivers/char/Kconfig +2 -2
@@ -291,7 +291,7 @@ config RTC and set the RTC in an SMP compatible fashion. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/rtc.rst> for details. To compile this driver as a module, choose M here: the
@@ -313,7 +313,7 @@ config JS_RTC /dev/rtc. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/rtc.rst> for details. To compile this driver as a module, choose M here: the
drivers/char/hw_random/core.c +1 -1
@@ -4,7 +4,7 @@* Copyright 2006 Michael Buesch <[email protected]> * Copyright 2005 (c) MontaVista Software, Inc. * -* Please read Documentation/hw_random.txt for details on use. +* Please read Documentation/hw_random.rst for details on use. * * This software may be used and distributed according to the terms * of the GNU General Public License, incorporated herein by reference.
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.txt> for more details on the driver. + See <file:Documentation/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.txt in the kernel sources for the" +" Documentation/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.txt for details. +* Documentation/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.txt. + Documentation/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.txt + Documentation/bt8xxgpio.rst If unsure, say N.
drivers/parisc/sba_iommu.c +8 -8
@@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dev: instance of PCI owned by the driver that's asking * @mask: number of address bits this PCI device can handle * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static int sba_dma_supported (struct device *dev,u64 mask) {
@@ -678,7 +678,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)return (0 ); } -/* Documentation/DMA-API-HOWTO.txt tells drivers to try 64-bit +/* Documentation/DMA-API-HOWTO.rst tells drivers to try 64-bit * first, then fall back to 32-bit if that fails. * We are just "encouraging" 32-bit DMA masks here since we can * never allow IOMMU bypass unless we add special support for ZX1.
@@ -706,7 +706,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)* @size: number of bytes to map in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static dma_addr_t sba_map_single(struct device *dev, void *addr, size_t size,
@@ -796,7 +796,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset,* @size: number of bytes mapped in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
@@ -875,7 +875,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void *sba_alloc (struct device *hwdev,size_t size,dma_addr_t *dma_handle,gfp_t gfp,unsigned long attrs)
@@ -906,7 +906,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void sba_free(struct device *hwdev, size_t size, void *vaddr,
@@ -941,7 +941,7 @@ int dump_run_sg = 0;* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static int sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
@@ -1025,7 +1025,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,
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.txt> for more + devices. See <file:Documentation/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.txt> for more details on the driver + See <file:Documentation/dcdbas.rst> for more details on the driver and the Dell systems on which Dell systems management software makes use of this driver.
@@ -259,7 +259,7 @@ config DELL_RBU DELL system. Note you need a Dell OpenManage or Dell Update package (DUP) supporting application to communicate with the BIOS regarding the new image for the image update to take effect. - See <file:Documentation/dell_rbu.txt> for more details on the driver. + See <file:Documentation/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.txt for more information. +* See Documentation/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.txt for more info. +* See Documentation/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.txt>. + Some information is in <file:Documentation/isapnp.rst>. If unsure, say Y.
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.txt for more details. + See Documentation/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.txt for more details. + See Documentation/vfio-mediated-device.rst for more details. If you don't know what do here, say N.
include/asm-generic/bitops/atomic.h +1 -1
@@ -8,7 +8,7 @@/* * Implementation of atomic bitops using atomic-fetch ops. -* See Documentation/atomic_bitops.txt for details. +* See Documentation/atomic_bitops.rst for details. */ static inline void set_bit (unsigned int nr,volatile unsigned long *p)
include/linux/dma-mapping.h +1 -1
@@ -14,7 +14,7 @@/** * List of possible attributes associated with a DMA mapping. The semantics -* of each attribute should be defined in Documentation/DMA-attributes.txt. +* of each attribute should be defined in Documentation/DMA-attributes.rst. * * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute * forces all pending DMA writes to complete.
include/linux/hw_random.h +1 -1
@@ -1,7 +1,7 @@/* Hardware Random Number Generator -Please read Documentation/hw_random.txt for details on use. +Please read Documentation/hw_random.rst for details on use. ---------------------------------------------------------- This software may be used and distributed according to the terms
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.txt +* See Documentation/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.txt +* Additional babbling in: Documentation/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.txt before using the kobject +* Please read Documentation/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.txt before using the kobject +* Please read Documentation/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.txt for documentation and samples. +See Documentation/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.txt for documentation and samples. +* See Documentation/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {
include/media/videobuf-dma-sg.h +1 -1
@@ -34,7 +34,7 @@* does memory allocation too using vmalloc_32(). * * videobuf_dma_*() -* see Documentation/DMA-API-HOWTO.txt, these functions to +* see Documentation/DMA-API-HOWTO.rst, these functions to * basically the same. The map function does also build a * scatterlist for the buffer (and unmap frees it ...) *
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.txt for more information. + See Documentation/nommu-mmap.rst for more information. config SYSTEM_DATA_VERIFICATION def_bool n
kernel/dma/debug.c +1 -1
@@ -1069,7 +1069,7 @@ static void check_unmap(struct dma_debug_entry *ref)/* * Drivers should use dma_mapping_error() to check the returned * addresses of dma_map_single() and dma_map_page(). -* If not, print this warning message. See Documentation/DMA-API.txt. +* If not, print this warning message. See Documentation/DMA-API.rst. */ if (entry->map_err_type ==MAP_ERR_NOT_CHECKED ) { err_printk(ref->dev, entry,
kernel/padata.c +1 -1
@@ -2,7 +2,7 @@/* * padata.c - generic interface to process data streams in parallel * -* See Documentation/padata.txt for an api documentation. +* See Documentation/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.txt + Documentation/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.txt for more information. + See Documentation/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.txt for a description of algorithms */ +/* see: Documentation/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.txt for critical information +* Please see the file Documentation/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.txt.\n" , +pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/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.txt for more information. +* two less 255 steps. See Documentation/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.txt for more information. + CRC32 is supported. See Documentation/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.txt for more information. + See Documentation/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.txt +* See Documentation/nommu-mmap.rst * * Copyright (c) 2004-2008 David Howells <[email protected]> * Copyright (c) 2000-2003 David McCullough <[email protected]>
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.txt +* Documentation/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.txt +* Documentation/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.txt for details. + See Documentation/gcc-plugins.rst for details. menu "GCC plugins" depends on GCC_PLUGINS
security/Kconfig +1 -1
@@ -121,7 +121,7 @@ config INTEL_TXT See <http://www.intel.com/technology/security/> for more information about Intel(R) TXT. See <http://tboot.sourceforge.net> for more information about tboot. - See Documentation/intel_txt.txt for a description of how to enable + See Documentation/intel_txt.rst for a description of how to enable Intel TXT support in a kernel boot. If you are unsure as to whether this is required, answer N.
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.txt for documentation and samples. +See Documentation/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.txt for documentation and samples. +* See Documentation/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {
Signature · 1 line
2.21.0
Re: [PATCH v1 01/22] docs: Documentation/*.txt: rename all ReST files to *.rst
Quoted 49 lines · Mauro Carvalho Chehab
Those files are actually at ReST format. Ok, currently, they don't belong to any place yet at the organized book series, but we don't want patches to break them as ReST files. So, rename them and add a :orphan: in order to shut up warning messages like those:
...
Documentation/svga.rst: WARNING: document isn't included in any toctreeDocumentation/switchtec.rst: WARNING: document isn't included in any toctree
...Later patches will move them to a better place and remove the :orphan: markup.
Signed-off-by Mauro Carvalho Chehab <[email protected]>---
I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists.
Documentation/ABI/removed/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-diskstats | 2 +- Documentation/ABI/testing/sysfs-block | 2 +- .../ABI/testing/sysfs-class-switchtec | 2 +- .../ABI/testing/sysfs-devices-system-cpu | 4 +- .../{DMA-API-HOWTO.txt => DMA-API-HOWTO.rst} | 2 + Documentation/{DMA-API.txt => DMA-API.rst} | 8 ++- .../{DMA-ISA-LPC.txt => DMA-ISA-LPC.rst} | 4 +- ...{DMA-attributes.txt => DMA-attributes.rst} | 2 + Documentation/{IPMI.txt => IPMI.rst} | 2 + .../{IRQ-affinity.txt => IRQ-affinity.rst} | 2 + .../{IRQ-domain.txt => IRQ-domain.rst} | 2 + Documentation/{IRQ.txt => IRQ.rst} | 2 + .../{Intel-IOMMU.txt => Intel-IOMMU.rst} | 2 + Documentation/PCI/pci.rst | 8 +-- Documentation/{SAK.txt => SAK.rst} | 3 +- Documentation/{SM501.txt => SM501.rst} | 2 + Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- .../admin-guide/kernel-parameters.txt | 4 +- .../{atomic_bitops.txt => atomic_bitops.rst} | 3 +- Documentation/block/biodoc.txt | 2 +- .../{bt8xxgpio.txt => bt8xxgpio.rst} | 3 +- Documentation/{btmrvl.txt => btmrvl.rst} | 2 + ...-mapping.txt => bus-virt-phys-mapping.rst} | 54 +++++++++--------- ...g-warn-once.txt => clearing-warn-once.rst} | 2 + Documentation/{cpu-load.txt => cpu-load.rst} | 2 +
Quoted 8 lines
.../{cputopology.txt => cputopology.rst} | 2 +
Documentation/{crc32.txt => crc32.rst} | 2 +
Documentation/{dcdbas.txt => dcdbas.rst} | 2 +
...ging-modules.txt => debugging-modules.rst} | 2 +
...hci1394.txt => debugging-via-ohci1394.rst} | 2 +
Documentation/{dell_rbu.txt => dell_rbu.rst} | 3 +-
Documentation/device-mapper/statistics.rst | 4 +-
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-Quoted 213 lines
Documentation/{digsig.txt => digsig.rst} | 2 +
Documentation/driver-api/usb/dma.rst | 6 +-
Documentation/driver-model/device.rst | 2 +-
Documentation/{efi-stub.txt => efi-stub.rst} | 2 +
Documentation/{eisa.txt => eisa.rst} | 2 +
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/sysfs.txt | 2 +-
...ex-requeue-pi.txt => futex-requeue-pi.rst} | 2 +
.../{gcc-plugins.txt => gcc-plugins.rst} | 2 +
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/{highuid.txt => highuid.rst} | 4 +-
.../{hw_random.txt => hw_random.rst} | 2 +
.../{hwspinlock.txt => hwspinlock.rst} | 2 +
Documentation/ia64/irq-redir.rst | 2 +-
.../{intel_txt.txt => intel_txt.rst} | 2 +
.../{io-mapping.txt => io-mapping.rst} | 2 +
.../{io_ordering.txt => io_ordering.rst} | 2 +
Documentation/{iostats.txt => iostats.rst} | 2 +
...flags-tracing.txt => irqflags-tracing.rst} | 3 +-
Documentation/{isa.txt => isa.rst} | 2 +
Documentation/{isapnp.txt => isapnp.rst} | 2 +
...hreads.txt => kernel-per-CPU-kthreads.rst} | 4 +-
Documentation/{kobject.txt => kobject.rst} | 6 +-
Documentation/{kprobes.txt => kprobes.rst} | 3 +-
Documentation/{kref.txt => kref.rst} | 2 +
Documentation/laptops/thinkpad-acpi.rst | 6 +-
Documentation/{ldm.txt => ldm.rst} | 5 +-
Documentation/locking/rt-mutex.rst | 2 +-
...kup-watchdogs.txt => lockup-watchdogs.rst} | 2 +
Documentation/{lsm.txt => lsm.rst} | 2 +
Documentation/{lzo.txt => lzo.rst} | 2 +
Documentation/{mailbox.txt => mailbox.rst} | 2 +
Documentation/memory-barriers.txt | 6 +-
...hameleon-bus.txt => men-chameleon-bus.rst} | 2 +
Documentation/networking/scaling.rst | 4 +-
.../{nommu-mmap.txt => nommu-mmap.rst} | 2 +
Documentation/{ntb.txt => ntb.rst} | 2 +
Documentation/{numastat.txt => numastat.rst} | 3 +-
Documentation/{padata.txt => padata.rst} | 2 +
...port-lowlevel.txt => parport-lowlevel.rst} | 2 +
...-semaphore.txt => percpu-rw-semaphore.rst} | 2 +
Documentation/{phy.txt => phy.rst} | 2 +
Documentation/{pi-futex.txt => pi-futex.rst} | 2 +
Documentation/{pnp.txt => pnp.rst} | 13 +++--
...reempt-locking.txt => preempt-locking.rst} | 4 +-
Documentation/{pwm.txt => pwm.rst} | 2 +
Documentation/{rbtree.txt => rbtree.rst} | 54 +++++++++---------
.../{remoteproc.txt => remoteproc.rst} | 4 +-
Documentation/{rfkill.txt => rfkill.rst} | 2 +
...ust-futex-ABI.txt => robust-futex-ABI.rst} | 2 +
...{robust-futexes.txt => robust-futexes.rst} | 2 +
Documentation/{rpmsg.txt => rpmsg.rst} | 2 +
Documentation/{rtc.txt => rtc.rst} | 8 ++-
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/{sgi-ioc4.txt => sgi-ioc4.rst} | 2 +
Documentation/{siphash.txt => siphash.rst} | 2 +
.../{smsc_ece1099.txt => smsc_ece1099.rst} | 2 +
.../{speculation.txt => speculation.rst} | 2 +
.../{static-keys.txt => static-keys.rst} | 2 +
Documentation/{svga.txt => svga.rst} | 2 +
.../{switchtec.txt => switchtec.rst} | 4 +-
.../{sync_file.txt => sync_file.rst} | 2 +
Documentation/sysctl/kernel.txt | 4 +-
Documentation/sysctl/vm.txt | 2 +-
Documentation/{tee.txt => tee.rst} | 2 +
.../{this_cpu_ops.txt => this_cpu_ops.rst} | 2 +
Documentation/trace/kprobetrace.rst | 2 +-
.../translations/ko_KR/memory-barriers.txt | 6 +-
Documentation/translations/zh_CN/IRQ.txt | 4 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
.../translations/zh_CN/io_ordering.txt | 4 +-
...access.txt => unaligned-memory-access.rst} | 2 +
...ed-device.txt => vfio-mediated-device.rst} | 4 +-
Documentation/{vfio.txt => vfio.rst} | 2 +
.../{video-output.txt => video-output.rst} | 3 +-
Documentation/watchdog/hpwdt.rst | 2 +-
Documentation/x86/topology.rst | 2 +-
Documentation/{xillybus.txt => xillybus.rst} | 2 +
Documentation/{xz.txt => xz.rst} | 2 +
Documentation/{zorro.txt => zorro.rst} | 7 ++-
MAINTAINERS | 56 +++++++++----------
arch/Kconfig | 4 +-
arch/arm/Kconfig | 2 +-
arch/ia64/hp/common/sba_iommu.c | 12 ++--
arch/ia64/sn/pci/pci_dma.c | 4 +-
arch/parisc/Kconfig | 2 +-
arch/parisc/kernel/pci-dma.c | 2 +-
arch/sh/Kconfig | 2 +-
arch/sparc/Kconfig | 2 +-
arch/unicore32/include/asm/io.h | 2 +-
arch/x86/Kconfig | 4 +-
arch/x86/include/asm/dma-mapping.h | 4 +-
arch/x86/kernel/amd_gart_64.c | 2 +-
block/partitions/Kconfig | 2 +-
drivers/base/core.c | 2 +-
drivers/char/Kconfig | 4 +-
drivers/char/hw_random/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/parisc/sba_iommu.c | 16 +++---
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/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
include/asm-generic/bitops/atomic.h | 2 +-
include/linux/dma-mapping.h | 2 +-
include/linux/hw_random.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 +-
include/media/videobuf-dma-sg.h | 2 +-
init/Kconfig | 2 +-
kernel/dma/debug.c | 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/kprobes/kprobe_example.c | 2 +-
samples/kprobes/kretprobe_example.c | 2 +-
scripts/gcc-plugins/Kconfig | 2 +-
security/Kconfig | 2 +-
tools/include/linux/rbtree.h | 2 +-
tools/include/linux/rbtree_augmented.h | 2 +-
173 files changed, 397 insertions(+), 242 deletions(-)
rename Documentation/{DMA-API-HOWTO.txt => DMA-API-HOWTO.rst} (99%)
rename Documentation/{DMA-API.txt => DMA-API.rst} (99%)
rename Documentation/{DMA-ISA-LPC.txt => DMA-ISA-LPC.rst} (98%)
rename Documentation/{DMA-attributes.txt => DMA-attributes.rst} (99%)
rename Documentation/{IPMI.txt => IPMI.rst} (99%)
rename Documentation/{IRQ-affinity.txt => IRQ-affinity.rst} (99%)
rename Documentation/{IRQ-domain.txt => IRQ-domain.rst} (99%)
rename Documentation/{IRQ.txt => IRQ.rst} (99%)
rename Documentation/{Intel-IOMMU.txt => Intel-IOMMU.rst} (99%)
rename Documentation/{SAK.txt => SAK.rst} (99%)
rename Documentation/{SM501.txt => SM501.rst} (99%)
rename Documentation/{atomic_bitops.txt => atomic_bitops.rst} (99%)
rename Documentation/{bt8xxgpio.txt => bt8xxgpio.rst} (99%)
rename Documentation/{btmrvl.txt => btmrvl.rst} (99%)
rename Documentation/{bus-virt-phys-mapping.txt => bus-virt-phys-mapping.rst} (93%)
rename Documentation/{clearing-warn-once.txt => clearing-warn-once.rst} (96%)
rename Documentation/{cpu-load.txt => cpu-load.rst} (99%)
rename Documentation/{cputopology.txt => cputopology.rst} (99%)
rename Documentation/{crc32.txt => crc32.rst} (99%)
rename Documentation/{dcdbas.txt => dcdbas.rst} (99%)
rename Documentation/{debugging-modules.txt => debugging-modules.rst} (98%)
rename Documentation/{debugging-via-ohci1394.txt => debugging-via-ohci1394.rst} (99%)
rename Documentation/{dell_rbu.txt => dell_rbu.rst} (99%)
rename Documentation/{digsig.txt => digsig.rst} (99%)
rename Documentation/{efi-stub.txt => efi-stub.rst} (99%)
rename Documentation/{eisa.txt => eisa.rst} (99%)
rename Documentation/{futex-requeue-pi.txt => futex-requeue-pi.rst} (99%)
rename Documentation/{gcc-plugins.txt => gcc-plugins.rst} (99%)
rename Documentation/{highuid.txt => highuid.rst} (99%)
rename Documentation/{hw_random.txt => hw_random.rst} (99%)
rename Documentation/{hwspinlock.txt => hwspinlock.rst} (99%)
rename Documentation/{intel_txt.txt => intel_txt.rst} (99%)
rename Documentation/{io-mapping.txt => io-mapping.rst} (99%)
rename Documentation/{io_ordering.txt => io_ordering.rst} (99%)
rename Documentation/{iostats.txt => iostats.rst} (99%)
rename Documentation/{irqflags-tracing.txt => irqflags-tracing.rst} (99%)
rename Documentation/{isa.txt => isa.rst} (99%)
rename Documentation/{isapnp.txt => isapnp.rst} (98%)
rename Documentation/{kernel-per-CPU-kthreads.txt => kernel-per-CPU-kthreads.rst} (99%)
rename Documentation/{kobject.txt => kobject.rst} (99%)
rename Documentation/{kprobes.txt => kprobes.rst} (99%)
rename Documentation/{kref.txt => kref.rst} (99%)
rename Documentation/{ldm.txt => ldm.rst} (98%)
rename Documentation/{lockup-watchdogs.txt => lockup-watchdogs.rst} (99%)
rename Documentation/{lsm.txt => lsm.rst} (99%)
rename Documentation/{lzo.txt => lzo.rst} (99%)
rename Documentation/{mailbox.txt => mailbox.rst} (99%)
rename Documentation/{men-chameleon-bus.txt => men-chameleon-bus.rst} (99%)
rename Documentation/{nommu-mmap.txt => nommu-mmap.rst} (99%)
rename Documentation/{ntb.txt => ntb.rst} (99%)
rename Documentation/{numastat.txt => numastat.rst} (99%)
rename Documentation/{padata.txt => padata.rst} (99%)
rename Documentation/{parport-lowlevel.txt => parport-lowlevel.rst} (99%)
rename Documentation/{percpu-rw-semaphore.txt => percpu-rw-semaphore.rst} (99%)
rename Documentation/{phy.txt => phy.rst} (99%)
rename Documentation/{pi-futex.txt => pi-futex.rst} (99%)
rename Documentation/{pnp.txt => pnp.rst} (98%)
rename Documentation/{preempt-locking.txt => preempt-locking.rst} (99%)
rename Documentation/{pwm.txt => pwm.rst} (99%)
rename Documentation/{rbtree.txt => rbtree.rst} (94%)
rename Documentation/{remoteproc.txt => remoteproc.rst} (99%)
rename Documentation/{rfkill.txt => rfkill.rst} (99%)
rename Documentation/{robust-futex-ABI.txt => robust-futex-ABI.rst} (99%)
rename Documentation/{robust-futexes.txt => robust-futexes.rst} (99%)
rename Documentation/{rpmsg.txt => rpmsg.rst} (99%)
rename Documentation/{rtc.txt => rtc.rst} (99%)
rename Documentation/{sgi-ioc4.txt => sgi-ioc4.rst} (99%)
rename Documentation/{siphash.txt => siphash.rst} (99%)
rename Documentation/{smsc_ece1099.txt => smsc_ece1099.rst} (99%)
rename Documentation/{speculation.txt => speculation.rst} (99%)
rename Documentation/{static-keys.txt => static-keys.rst} (99%)
rename Documentation/{svga.txt => svga.rst} (99%)
rename Documentation/{switchtec.txt => switchtec.rst} (98%)
rename Documentation/{sync_file.txt => sync_file.rst} (99%)
rename Documentation/{tee.txt => tee.rst} (99%)Quoted 8 lines
rename Documentation/{this_cpu_ops.txt => this_cpu_ops.rst} (99%)
rename Documentation/{unaligned-memory-access.txt => unaligned-memory-access.rst} (99%)
rename Documentation/{vfio-mediated-device.txt => vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => vfio.rst} (99%)
rename Documentation/{video-output.txt => video-output.rst} (99%)
rename Documentation/{xillybus.txt => xillybus.rst} (99%)
rename Documentation/{xz.txt => xz.rst} (99%)
rename Documentation/{zorro.txt => zorro.rst} (99%)_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH 2/22 docs: ioctl-number.txt: convert it to ReST format
In reply to Mauro Carvalho ChehabThe conversion itself is simple: add a markup for the title of this file and add markups for both tables.
Yet, the big table here with IOCTL numbers is badly formatted:
on several lines, the "Include File" column has some values that are bigger than the reserved space there.
Also, on several places, a comment was misplaced at the "Include File" space.
So, most of the work here is to actually ensure that each field will be properly fixed.
Also worth to mention that some URLs have the asterisk character on it. Well, Sphinx has an issue with asterisks in the middle of an string. As this is URL, use the alternate format: %2A.
As a side effect of this patch, it is now a lot easier to see that some reserved ioctl numbers are missing the include files where it is supposed to be used.
PS.: While this is part of a subdir, I opted to convert this single file alone, as this file has a potential of conflicts, as most subsystem maintainers touch it.
---
.../{ioctl-number.txt => ioctl-number.rst} | 588 +++++++++---------
Documentation/process/submit-checklist.rst | 2 +-
.../it_IT/process/submit-checklist.rst | 2 +-
.../zh_CN/process/submit-checklist.rst | 2 +-
include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +-
5 files changed, 304 insertions(+), 292 deletions(-)
rename Documentation/ioctl/{ioctl-number.txt => ioctl-number.rst} (11%)Documentation/ioctl/ioctl-number.rst renamed from Documentation/ioctl/ioctl-number.txt +300 -288
@@ -1,15 +1,23 @@ +:orphan: + +============= Ioctl Numbers +============= + 19 October 1999 + Michael Elizabeth Chastain <[email protected]> If you are adding new ioctl's to the kernel, you should use the _IO macros defined in <linux/ioctl.h>: + ====== == ============================================ _IO an ioctl with no parameters _IOW an ioctl with write parameters (copy_from_user) _IOR an ioctl with read parameters (copy_to_user) _IOWR an ioctl with both write and read parameters. + ====== == ============================================ 'Write' and 'read' are from the user's point of view, just like the system calls 'write' and 'read'. For example, a SET_FOO ioctl would
@@ -60,291 +68,295 @@ This table lists ioctls visible from user land for Linux/x86. It contains most drivers up to 2.6.31, but I know I am missing some. There has been no attempt to list non-X86 architectures or ioctls from drivers/staging/. -Code Seq#(hex) Include File Comments -======================================================== -0x00 00-1F linux/fs.h conflict! -0x00 00-1F scsi/scsi_ioctl.h conflict! -0x00 00-1F linux/fb.h conflict! -0x00 00-1F linux/wavefront.h conflict! -0x02 all linux/fd.h -0x03 all linux/hdreg.h -0x04 D2-DC linux/umsdos_fs.h Dead since 2.6.11, but don't reuse these. -0x06 all linux/lp.h -0x09 all linux/raid/md_u.h -0x10 00-0F drivers/char/s390/vmcp.h -0x10 10-1F arch/s390/include/uapi/sclp_ctl.h -0x10 20-2F arch/s390/include/uapi/asm/hypfs.h -0x12 all linux/fs.h - linux/blkpg.h -0x1b all InfiniBand Subsystem <http://infiniband.sourceforge.net/> -0x20 all drivers/cdrom/cm206.h -0x22 all scsi/sg.h -'!' 00-1F uapi/linux/seccomp.h -'#' 00-3F IEEE 1394 Subsystem Block for the entire subsystem -'$' 00-0F linux/perf_counter.h, linux/perf_event.h -'%' 00-0F include/uapi/linux/stm.h - System Trace Module subsystem - <mailto:[email protected]> -'&' 00-07 drivers/firewire/nosy-user.h -'1' 00-1F <linux/timepps.h> PPS kit from Ulrich Windl - <ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/> -'2' 01-04 linux/i2o.h -'3' 00-0F drivers/s390/char/raw3270.h conflict! -'3' 00-1F linux/suspend_ioctls.h conflict! - and kernel/power/user.c -'8' all SNP8023 advanced NIC card - <mailto:[email protected]> -';' 64-7F linux/vfio.h -'@' 00-0F linux/radeonfb.h conflict! -'@' 00-0F drivers/video/aty/aty128fb.c conflict! -'A' 00-1F linux/apm_bios.h conflict! -'A' 00-0F linux/agpgart.h conflict! - and drivers/char/agp/compat_ioctl.h -'A' 00-7F sound/asound.h conflict! -'B' 00-1F linux/cciss_ioctl.h conflict! -'B' 00-0F include/linux/pmu.h conflict! -'B' C0-FF advanced bbus - <mailto:[email protected]> -'C' all linux/soundcard.h conflict! -'C' 01-2F linux/capi.h conflict! -'C' F0-FF drivers/net/wan/cosa.h conflict! -'D' all arch/s390/include/asm/dasd.h -'D' 40-5F drivers/scsi/dpt/dtpi_ioctl.h -'D' 05 drivers/scsi/pmcraid.h -'E' all linux/input.h conflict! -'E' 00-0F xen/evtchn.h conflict! -'F' all linux/fb.h conflict! -'F' 01-02 drivers/scsi/pmcraid.h conflict! -'F' 20 drivers/video/fsl-diu-fb.h conflict! -'F' 20 drivers/video/intelfb/intelfb.h conflict! -'F' 20 linux/ivtvfb.h conflict! -'F' 20 linux/matroxfb.h conflict! -'F' 20 drivers/video/aty/atyfb_base.c conflict! -'F' 00-0F video/da8xx-fb.h conflict! -'F' 80-8F linux/arcfb.h conflict! -'F' DD video/sstfb.h conflict! -'G' 00-3F drivers/misc/sgi-gru/grulib.h conflict! -'G' 00-0F linux/gigaset_dev.h conflict! -'H' 00-7F linux/hiddev.h conflict! -'H' 00-0F linux/hidraw.h conflict! -'H' 01 linux/mei.h conflict! -'H' 02 linux/mei.h conflict! -'H' 03 linux/mei.h conflict! -'H' 00-0F sound/asound.h conflict! -'H' 20-40 sound/asound_fm.h conflict! -'H' 80-8F sound/sfnt_info.h conflict! -'H' 10-8F sound/emu10k1.h conflict! -'H' 10-1F sound/sb16_csp.h conflict! -'H' 10-1F sound/hda_hwdep.h conflict! -'H' 40-4F sound/hdspm.h conflict! -'H' 40-4F sound/hdsp.h conflict! -'H' 90 sound/usb/usx2y/usb_stream.h -'H' A0 uapi/linux/usb/cdc-wdm.h -'H' C0-F0 net/bluetooth/hci.h conflict! -'H' C0-DF net/bluetooth/hidp/hidp.h conflict! -'H' C0-DF net/bluetooth/cmtp/cmtp.h conflict! -'H' C0-DF net/bluetooth/bnep/bnep.h conflict! -'H' F1 linux/hid-roccat.h <mailto:[email protected]> -'H' F8-FA sound/firewire.h -'I' all linux/isdn.h conflict! -'I' 00-0F drivers/isdn/divert/isdn_divert.h conflict! -'I' 40-4F linux/mISDNif.h conflict! -'J' 00-1F drivers/scsi/gdth_ioctl.h -'K' all linux/kd.h -'L' 00-1F linux/loop.h conflict! -'L' 10-1F drivers/scsi/mpt3sas/mpt3sas_ctl.h conflict! -'L' 20-2F linux/lightnvm.h -'L' E0-FF linux/ppdd.h encrypted disk device driver - <http://linux01.gwdg.de/~alatham/ppdd.html> -'M' all linux/soundcard.h conflict! -'M' 01-16 mtd/mtd-abi.h conflict! - and drivers/mtd/mtdchar.c -'M' 01-03 drivers/scsi/megaraid/megaraid_sas.h -'M' 00-0F drivers/video/fsl-diu-fb.h conflict! -'N' 00-1F drivers/usb/scanner.h -'N' 40-7F drivers/block/nvme.c -'O' 00-06 mtd/ubi-user.h UBI -'P' all linux/soundcard.h conflict! -'P' 60-6F sound/sscape_ioctl.h conflict! -'P' 00-0F drivers/usb/class/usblp.c conflict! -'P' 01-09 drivers/misc/pci_endpoint_test.c conflict! -'Q' all linux/soundcard.h -'R' 00-1F linux/random.h conflict! -'R' 01 linux/rfkill.h conflict! -'R' C0-DF net/bluetooth/rfcomm.h -'S' all linux/cdrom.h conflict! -'S' 80-81 scsi/scsi_ioctl.h conflict! -'S' 82-FF scsi/scsi.h conflict! -'S' 00-7F sound/asequencer.h conflict! -'T' all linux/soundcard.h conflict! -'T' 00-AF sound/asound.h conflict! -'T' all arch/x86/include/asm/ioctls.h conflict! -'T' C0-DF linux/if_tun.h conflict! -'U' all sound/asound.h conflict! -'U' 00-CF linux/uinput.h conflict! -'U' 00-EF linux/usbdevice_fs.h -'U' C0-CF drivers/bluetooth/hci_uart.h -'V' all linux/vt.h conflict! -'V' all linux/videodev2.h conflict! -'V' C0 linux/ivtvfb.h conflict! -'V' C0 linux/ivtv.h conflict! -'V' C0 media/davinci/vpfe_capture.h conflict! -'V' C0 media/si4713.h conflict! -'W' 00-1F linux/watchdog.h conflict! -'W' 00-1F linux/wanrouter.h conflict! (pre 3.9) -'W' 00-3F sound/asound.h conflict! -'W' 40-5F drivers/pci/switch/switchtec.c -'X' all fs/xfs/xfs_fs.h conflict! - and fs/xfs/linux-2.6/xfs_ioctl32.h - and include/linux/falloc.h - and linux/fs.h -'X' all fs/ocfs2/ocfs_fs.h conflict! -'X' 01 linux/pktcdvd.h conflict! -'Y' all linux/cyclades.h -'Z' 14-15 drivers/message/fusion/mptctl.h -'[' 00-3F linux/usb/tmc.h USB Test and Measurement Devices - <mailto:[email protected]> -'a' all linux/atm*.h, linux/sonet.h ATM on linux - <http://lrcwww.epfl.ch/> -'a' 00-0F drivers/crypto/qat/qat_common/adf_cfg_common.h conflict! qat driver -'b' 00-FF conflict! bit3 vme host bridge - <mailto:[email protected]> -'c' all linux/cm4000_cs.h conflict! -'c' 00-7F linux/comstats.h conflict! -'c' 00-7F linux/coda.h conflict! -'c' 00-1F linux/chio.h conflict! -'c' 80-9F arch/s390/include/asm/chsc.h conflict! -'c' A0-AF arch/x86/include/asm/msr.h conflict! -'d' 00-FF linux/char/drm/drm.h conflict! -'d' 02-40 pcmcia/ds.h conflict! -'d' F0-FF linux/digi1.h -'e' all linux/digi1.h conflict! -'f' 00-1F linux/ext2_fs.h conflict! -'f' 00-1F linux/ext3_fs.h conflict! -'f' 00-0F fs/jfs/jfs_dinode.h conflict! -'f' 00-0F fs/ext4/ext4.h conflict! -'f' 00-0F linux/fs.h conflict! -'f' 00-0F fs/ocfs2/ocfs2_fs.h conflict! -'g' 00-0F linux/usb/gadgetfs.h -'g' 20-2F linux/usb/g_printer.h -'h' 00-7F conflict! Charon filesystem - <mailto:[email protected]> -'h' 00-1F linux/hpet.h conflict! -'h' 80-8F fs/hfsplus/ioctl.c -'i' 00-3F linux/i2o-dev.h conflict! -'i' 0B-1F linux/ipmi.h conflict! -'i' 80-8F linux/i8k.h -'j' 00-3F linux/joystick.h -'k' 00-0F linux/spi/spidev.h conflict! -'k' 00-05 video/kyro.h conflict! -'k' 10-17 linux/hsi/hsi_char.h HSI character device -'l' 00-3F linux/tcfs_fs.h transparent cryptographic file system - <http://web.archive.org/web/*/http://mikonos.dia.unisa.it/tcfs> -'l' 40-7F linux/udf_fs_i.h in development: - <http://sourceforge.net/projects/linux-udf/> -'m' 00-09 linux/mmtimer.h conflict! -'m' all linux/mtio.h conflict! -'m' all linux/soundcard.h conflict! -'m' all linux/synclink.h conflict! -'m' 00-19 drivers/message/fusion/mptctl.h conflict! -'m' 00 drivers/scsi/megaraid/megaraid_ioctl.h conflict! -'n' 00-7F linux/ncp_fs.h and fs/ncpfs/ioctl.c -'n' 80-8F uapi/linux/nilfs2_api.h NILFS2 -'n' E0-FF linux/matroxfb.h matroxfb -'o' 00-1F fs/ocfs2/ocfs2_fs.h OCFS2 -'o' 00-03 mtd/ubi-user.h conflict! (OCFS2 and UBI overlaps) -'o' 40-41 mtd/ubi-user.h UBI -'o' 01-A1 linux/dvb/*.h DVB -'p' 00-0F linux/phantom.h conflict! (OpenHaptics needs this) -'p' 00-1F linux/rtc.h conflict! -'p' 00-3F linux/mc146818rtc.h conflict! -'p' 40-7F linux/nvram.h -'p' 80-9F linux/ppdev.h user-space parport - <mailto:[email protected]> -'p' A1-A5 linux/pps.h LinuxPPS - <mailto:[email protected]> -'q' 00-1F linux/serio.h -'q' 80-FF linux/telephony.h Internet PhoneJACK, Internet LineJACK - linux/ixjuser.h <http://web.archive.org/web/*/http://www.quicknet.net> -'r' 00-1F linux/msdos_fs.h and fs/fat/dir.c -'s' all linux/cdk.h -'t' 00-7F linux/ppp-ioctl.h -'t' 80-8F linux/isdn_ppp.h -'t' 90-91 linux/toshiba.h toshiba and toshiba_acpi SMM -'u' 00-1F linux/smb_fs.h gone -'u' 20-3F linux/uvcvideo.h USB video class host driver -'u' 40-4f linux/udmabuf.h userspace dma-buf misc device -'v' 00-1F linux/ext2_fs.h conflict! -'v' 00-1F linux/fs.h conflict! -'v' 00-0F linux/sonypi.h conflict! -'v' 00-0F media/v4l2-subdev.h conflict! -'v' C0-FF linux/meye.h conflict! -'w' all CERN SCI driver -'y' 00-1F packet based user level communications - <mailto:[email protected]> -'z' 00-3F CAN bus card conflict! - <mailto:[email protected]> -'z' 40-7F CAN bus card conflict! - <mailto:[email protected]> -'z' 10-4F drivers/s390/crypto/zcrypt_api.h conflict! -'|' 00-7F linux/media.h -0x80 00-1F linux/fb.h -0x89 00-06 arch/x86/include/asm/sockios.h -0x89 0B-DF linux/sockios.h -0x89 E0-EF linux/sockios.h SIOCPROTOPRIVATE range -0x89 E0-EF linux/dn.h PROTOPRIVATE range -0x89 F0-FF linux/sockios.h SIOCDEVPRIVATE range -0x8B all linux/wireless.h -0x8C 00-3F WiNRADiO driver - <http://www.winradio.com.au/> -0x90 00 drivers/cdrom/sbpcd.h -0x92 00-0F drivers/usb/mon/mon_bin.c -0x93 60-7F linux/auto_fs.h -0x94 all fs/btrfs/ioctl.h Btrfs filesystem - and linux/fs.h some lifted to vfs/generic -0x97 00-7F fs/ceph/ioctl.h Ceph file system -0x99 00-0F 537-Addinboard driver - <mailto:[email protected]> -0xA0 all linux/sdp/sdp.h Industrial Device Project - <mailto:[email protected]> -0xA1 0 linux/vtpm_proxy.h TPM Emulator Proxy Driver -0xA3 80-8F Port ACL in development: - <mailto:[email protected]> -0xA3 90-9F linux/dtlk.h -0xA4 00-1F uapi/linux/tee.h Generic TEE subsystem -0xAA 00-3F linux/uapi/linux/userfaultfd.h -0xAB 00-1F linux/nbd.h -0xAC 00-1F linux/raw.h -0xAD 00 Netfilter device in development: - <mailto:[email protected]> -0xAE all linux/kvm.h Kernel-based Virtual Machine - <mailto:[email protected]> -0xAF 00-1F linux/fsl_hypervisor.h Freescale hypervisor -0xB0 all RATIO devices in development: - <mailto:[email protected]> -0xB1 00-1F PPPoX <mailto:[email protected]> -0xB3 00 linux/mmc/ioctl.h -0xB4 00-0F linux/gpio.h <mailto:[email protected]> -0xB5 00-0F uapi/linux/rpmsg.h <mailto:[email protected]> -0xB6 all linux/fpga-dfl.h -0xC0 00-0F linux/usb/iowarrior.h -0xCA 00-0F uapi/misc/cxl.h -0xCA 10-2F uapi/misc/ocxl.h -0xCA 80-BF uapi/scsi/cxlflash_ioctl.h -0xCB 00-1F CBM serial IEC bus in development: - <mailto:[email protected]> -0xCC 00-0F drivers/misc/ibmvmc.h pseries VMC driver -0xCD 01 linux/reiserfs_fs.h -0xCF 02 fs/cifs/ioctl.c -0xDB 00-0F drivers/char/mwave/mwavepub.h -0xDD 00-3F ZFCP device driver see drivers/s390/scsi/ - <mailto:[email protected]> -0xE5 00-3F linux/fuse.h -0xEC 00-01 drivers/platform/chrome/cros_ec_dev.h ChromeOS EC driver -0xF3 00-3F drivers/usb/misc/sisusbvga/sisusb.h sisfb (in development) - <mailto:[email protected]> -0xF4 00-1F video/mbxfb.h mbxfb - <mailto:[email protected]> -0xF6 all LTTng Linux Trace Toolkit Next Generation - <mailto:[email protected]> -0xFD all linux/dm-ioctl.h +==== ===== ======================================================= ================================================================ +Code Seq# Include File Comments + (hex) +==== ===== ======================================================= ================================================================ +0x00 00-1F linux/fs.h conflict! +0x00 00-1F scsi/scsi_ioctl.h conflict! +0x00 00-1F linux/fb.h conflict! +0x00 00-1F linux/wavefront.h conflict! +0x02 all linux/fd.h +0x03 all linux/hdreg.h +0x04 D2-DC linux/umsdos_fs.h Dead since 2.6.11, but don't reuse these. +0x06 all linux/lp.h +0x09 all linux/raid/md_u.h +0x10 00-0F drivers/char/s390/vmcp.h +0x10 10-1F arch/s390/include/uapi/sclp_ctl.h +0x10 20-2F arch/s390/include/uapi/asm/hypfs.h +0x12 all linux/fs.h + linux/blkpg.h +0x1b all InfiniBand Subsystem + <http://infiniband.sourceforge.net/> +0x20 all drivers/cdrom/cm206.h +0x22 all scsi/sg.h +'!' 00-1F uapi/linux/seccomp.h +'#' 00-3F IEEE 1394 Subsystem + Block for the entire subsystem +'$' 00-0F linux/perf_counter.h, linux/perf_event.h +'%' 00-0F include/uapi/linux/stm.h System Trace Module subsystem + <mailto:[email protected]> +'&' 00-07 drivers/firewire/nosy-user.h +'1' 00-1F linux/timepps.h PPS kit from Ulrich Windl + <ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/> +'2' 01-04 linux/i2o.h +'3' 00-0F drivers/s390/char/raw3270.h conflict! +'3' 00-1F linux/suspend_ioctls.h, conflict! + kernel/power/user.c +'8' all SNP8023 advanced NIC card + <mailto:[email protected]> +';' 64-7F linux/vfio.h +'@' 00-0F linux/radeonfb.h conflict! +'@' 00-0F drivers/video/aty/aty128fb.c conflict! +'A' 00-1F linux/apm_bios.h conflict! +'A' 00-0F linux/agpgart.h, conflict! + drivers/char/agp/compat_ioctl.h +'A' 00-7F sound/asound.h conflict! +'B' 00-1F linux/cciss_ioctl.h conflict! +'B' 00-0F include/linux/pmu.h conflict! +'B' C0-FF advanced bbus <mailto:[email protected]> +'C' all linux/soundcard.h conflict! +'C' 01-2F linux/capi.h conflict! +'C' F0-FF drivers/net/wan/cosa.h conflict! +'D' all arch/s390/include/asm/dasd.h +'D' 40-5F drivers/scsi/dpt/dtpi_ioctl.h +'D' 05 drivers/scsi/pmcraid.h +'E' all linux/input.h conflict! +'E' 00-0F xen/evtchn.h conflict! +'F' all linux/fb.h conflict! +'F' 01-02 drivers/scsi/pmcraid.h conflict! +'F' 20 drivers/video/fsl-diu-fb.h conflict! +'F' 20 drivers/video/intelfb/intelfb.h conflict! +'F' 20 linux/ivtvfb.h conflict! +'F' 20 linux/matroxfb.h conflict! +'F' 20 drivers/video/aty/atyfb_base.c conflict! +'F' 00-0F video/da8xx-fb.h conflict! +'F' 80-8F linux/arcfb.h conflict! +'F' DD video/sstfb.h conflict! +'G' 00-3F drivers/misc/sgi-gru/grulib.h conflict! +'G' 00-0F linux/gigaset_dev.h conflict! +'H' 00-7F linux/hiddev.h conflict! +'H' 00-0F linux/hidraw.h conflict! +'H' 01 linux/mei.h conflict! +'H' 02 linux/mei.h conflict! +'H' 03 linux/mei.h conflict! +'H' 00-0F sound/asound.h conflict! +'H' 20-40 sound/asound_fm.h conflict! +'H' 80-8F sound/sfnt_info.h conflict! +'H' 10-8F sound/emu10k1.h conflict! +'H' 10-1F sound/sb16_csp.h conflict! +'H' 10-1F sound/hda_hwdep.h conflict! +'H' 40-4F sound/hdspm.h conflict! +'H' 40-4F sound/hdsp.h conflict! +'H' 90 sound/usb/usx2y/usb_stream.h +'H' A0 uapi/linux/usb/cdc-wdm.h +'H' C0-F0 net/bluetooth/hci.h conflict! +'H' C0-DF net/bluetooth/hidp/hidp.h conflict! +'H' C0-DF net/bluetooth/cmtp/cmtp.h conflict! +'H' C0-DF net/bluetooth/bnep/bnep.h conflict! +'H' F1 linux/hid-roccat.h <mailto:[email protected]> +'H' F8-FA sound/firewire.h +'I' all linux/isdn.h conflict! +'I' 00-0F drivers/isdn/divert/isdn_divert.h conflict! +'I' 40-4F linux/mISDNif.h conflict! +'J' 00-1F drivers/scsi/gdth_ioctl.h +'K' all linux/kd.h +'L' 00-1F linux/loop.h conflict! +'L' 10-1F drivers/scsi/mpt3sas/mpt3sas_ctl.h conflict! +'L' 20-2F linux/lightnvm.h +'L' E0-FF linux/ppdd.h encrypted disk device driver + <http://linux01.gwdg.de/~alatham/ppdd.html> +'M' all linux/soundcard.h conflict! +'M' 01-16 mtd/mtd-abi.h conflict! + and drivers/mtd/mtdchar.c +'M' 01-03 drivers/scsi/megaraid/megaraid_sas.h +'M' 00-0F drivers/video/fsl-diu-fb.h conflict! +'N' 00-1F drivers/usb/scanner.h +'N' 40-7F drivers/block/nvme.c +'O' 00-06 mtd/ubi-user.h UBI +'P' all linux/soundcard.h conflict! +'P' 60-6F sound/sscape_ioctl.h conflict! +'P' 00-0F drivers/usb/class/usblp.c conflict! +'P' 01-09 drivers/misc/pci_endpoint_test.c conflict! +'Q' all linux/soundcard.h +'R' 00-1F linux/random.h conflict! +'R' 01 linux/rfkill.h conflict! +'R' C0-DF net/bluetooth/rfcomm.h +'S' all linux/cdrom.h conflict! +'S' 80-81 scsi/scsi_ioctl.h conflict! +'S' 82-FF scsi/scsi.h conflict! +'S' 00-7F sound/asequencer.h conflict! +'T' all linux/soundcard.h conflict! +'T' 00-AF sound/asound.h conflict! +'T' all arch/x86/include/asm/ioctls.h conflict! +'T' C0-DF linux/if_tun.h conflict! +'U' all sound/asound.h conflict! +'U' 00-CF linux/uinput.h conflict! +'U' 00-EF linux/usbdevice_fs.h +'U' C0-CF drivers/bluetooth/hci_uart.h +'V' all linux/vt.h conflict! +'V' all linux/videodev2.h conflict! +'V' C0 linux/ivtvfb.h conflict! +'V' C0 linux/ivtv.h conflict! +'V' C0 media/davinci/vpfe_capture.h conflict! +'V' C0 media/si4713.h conflict! +'W' 00-1F linux/watchdog.h conflict! +'W' 00-1F linux/wanrouter.h conflict! (pre 3.9) +'W' 00-3F sound/asound.h conflict! +'W' 40-5F drivers/pci/switch/switchtec.c +'X' all fs/xfs/xfs_fs.h, conflict! + fs/xfs/linux-2.6/xfs_ioctl32.h, + include/linux/falloc.h, + linux/fs.h, +'X' all fs/ocfs2/ocfs_fs.h conflict! +'X' 01 linux/pktcdvd.h conflict! +'Y' all linux/cyclades.h +'Z' 14-15 drivers/message/fusion/mptctl.h +'[' 00-3F linux/usb/tmc.h USB Test and Measurement Devices + <mailto:[email protected]> +'a' all linux/atm*.h, linux/sonet.h ATM on linux + <http://lrcwww.epfl.ch/> +'a' 00-0F drivers/crypto/qat/qat_common/adf_cfg_common.h conflict! qat driver +'b' 00-FF conflict! bit3 vme host bridge + <mailto:[email protected]> +'c' all linux/cm4000_cs.h conflict! +'c' 00-7F linux/comstats.h conflict! +'c' 00-7F linux/coda.h conflict! +'c' 00-1F linux/chio.h conflict! +'c' 80-9F arch/s390/include/asm/chsc.h conflict! +'c' A0-AF arch/x86/include/asm/msr.h conflict! +'d' 00-FF linux/char/drm/drm.h conflict! +'d' 02-40 pcmcia/ds.h conflict! +'d' F0-FF linux/digi1.h +'e' all linux/digi1.h conflict! +'f' 00-1F linux/ext2_fs.h conflict! +'f' 00-1F linux/ext3_fs.h conflict! +'f' 00-0F fs/jfs/jfs_dinode.h conflict! +'f' 00-0F fs/ext4/ext4.h conflict! +'f' 00-0F linux/fs.h conflict! +'f' 00-0F fs/ocfs2/ocfs2_fs.h conflict! +'g' 00-0F linux/usb/gadgetfs.h +'g' 20-2F linux/usb/g_printer.h +'h' 00-7F conflict! Charon filesystem + <mailto:[email protected]> +'h' 00-1F linux/hpet.h conflict! +'h' 80-8F fs/hfsplus/ioctl.c +'i' 00-3F linux/i2o-dev.h conflict! +'i' 0B-1F linux/ipmi.h conflict! +'i' 80-8F linux/i8k.h +'j' 00-3F linux/joystick.h +'k' 00-0F linux/spi/spidev.h conflict! +'k' 00-05 video/kyro.h conflict! +'k' 10-17 linux/hsi/hsi_char.h HSI character device +'l' 00-3F linux/tcfs_fs.h transparent cryptographic file system + <http://web.archive.org/web/%2A/http://mikonos.dia.unisa.it/tcfs> +'l' 40-7F linux/udf_fs_i.h in development: + <http://sourceforge.net/projects/linux-udf/> +'m' 00-09 linux/mmtimer.h conflict! +'m' all linux/mtio.h conflict! +'m' all linux/soundcard.h conflict! +'m' all linux/synclink.h conflict! +'m' 00-19 drivers/message/fusion/mptctl.h conflict! +'m' 00 drivers/scsi/megaraid/megaraid_ioctl.h conflict! +'n' 00-7F linux/ncp_fs.h and fs/ncpfs/ioctl.c +'n' 80-8F uapi/linux/nilfs2_api.h NILFS2 +'n' E0-FF linux/matroxfb.h matroxfb +'o' 00-1F fs/ocfs2/ocfs2_fs.h OCFS2 +'o' 00-03 mtd/ubi-user.h conflict! (OCFS2 and UBI overlaps) +'o' 40-41 mtd/ubi-user.h UBI +'o' 01-A1 `linux/dvb/*.h` DVB +'p' 00-0F linux/phantom.h conflict! (OpenHaptics needs this) +'p' 00-1F linux/rtc.h conflict! +'p' 00-3F linux/mc146818rtc.h conflict! +'p' 40-7F linux/nvram.h +'p' 80-9F linux/ppdev.h user-space parport + <mailto:[email protected]> +'p' A1-A5 linux/pps.h LinuxPPS + <mailto:[email protected]> +'q' 00-1F linux/serio.h +'q' 80-FF linux/telephony.h Internet PhoneJACK, Internet LineJACK + linux/ixjuser.h <http://web.archive.org/web/%2A/http://www.quicknet.net> +'r' 00-1F linux/msdos_fs.h and fs/fat/dir.c +'s' all linux/cdk.h +'t' 00-7F linux/ppp-ioctl.h +'t' 80-8F linux/isdn_ppp.h +'t' 90-91 linux/toshiba.h toshiba and toshiba_acpi SMM +'u' 00-1F linux/smb_fs.h gone +'u' 20-3F linux/uvcvideo.h USB video class host driver +'u' 40-4f linux/udmabuf.h userspace dma-buf misc device +'v' 00-1F linux/ext2_fs.h conflict! +'v' 00-1F linux/fs.h conflict! +'v' 00-0F linux/sonypi.h conflict! +'v' 00-0F media/v4l2-subdev.h conflict! +'v' C0-FF linux/meye.h conflict! +'w' all CERN SCI driver +'y' 00-1F packet based user level communications + <mailto:[email protected]> +'z' 00-3F CAN bus card conflict! + <mailto:[email protected]> +'z' 40-7F CAN bus card conflict! + <mailto:[email protected]> +'z' 10-4F drivers/s390/crypto/zcrypt_api.h conflict! +'|' 00-7F linux/media.h +0x80 00-1F linux/fb.h +0x89 00-06 arch/x86/include/asm/sockios.h +0x89 0B-DF linux/sockios.h +0x89 E0-EF linux/sockios.h SIOCPROTOPRIVATE range +0x89 E0-EF linux/dn.h PROTOPRIVATE range +0x89 F0-FF linux/sockios.h SIOCDEVPRIVATE range +0x8B all linux/wireless.h +0x8C 00-3F WiNRADiO driver + <http://www.winradio.com.au/> +0x90 00 drivers/cdrom/sbpcd.h +0x92 00-0F drivers/usb/mon/mon_bin.c +0x93 60-7F linux/auto_fs.h +0x94 all fs/btrfs/ioctl.h Btrfs filesystem + and linux/fs.h some lifted to vfs/generic +0x97 00-7F fs/ceph/ioctl.h Ceph file system +0x99 00-0F 537-Addinboard driver + <mailto:[email protected]> +0xA0 all linux/sdp/sdp.h Industrial Device Project + <mailto:[email protected]> +0xA1 0 linux/vtpm_proxy.h TPM Emulator Proxy Driver +0xA3 80-8F Port ACL in development: + <mailto:[email protected]> +0xA3 90-9F linux/dtlk.h +0xA4 00-1F uapi/linux/tee.h Generic TEE subsystem +0xAA 00-3F linux/uapi/linux/userfaultfd.h +0xAB 00-1F linux/nbd.h +0xAC 00-1F linux/raw.h +0xAD 00 Netfilter device in development: + <mailto:[email protected]> +0xAE all linux/kvm.h Kernel-based Virtual Machine + <mailto:[email protected]> +0xAF 00-1F linux/fsl_hypervisor.h Freescale hypervisor +0xB0 all RATIO devices in development: + <mailto:[email protected]> +0xB1 00-1F PPPoX + <mailto:[email protected]> +0xB3 00 linux/mmc/ioctl.h +0xB4 00-0F linux/gpio.h <mailto:[email protected]> +0xB5 00-0F uapi/linux/rpmsg.h <mailto:[email protected]> +0xB6 all linux/fpga-dfl.h +0xC0 00-0F linux/usb/iowarrior.h +0xCA 00-0F uapi/misc/cxl.h +0xCA 10-2F uapi/misc/ocxl.h +0xCA 80-BF uapi/scsi/cxlflash_ioctl.h +0xCB 00-1F CBM serial IEC bus in development: + <mailto:[email protected]> +0xCC 00-0F drivers/misc/ibmvmc.h pseries VMC driver +0xCD 01 linux/reiserfs_fs.h +0xCF 02 fs/cifs/ioctl.c +0xDB 00-0F drivers/char/mwave/mwavepub.h +0xDD 00-3F ZFCP device driver see drivers/s390/scsi/ + <mailto:[email protected]> +0xE5 00-3F linux/fuse.h +0xEC 00-01 drivers/platform/chrome/cros_ec_dev.h ChromeOS EC driver +0xF3 00-3F drivers/usb/misc/sisusbvga/sisusb.h sisfb (in development) + <mailto:[email protected]> +0xF4 00-1F video/mbxfb.h mbxfb + <mailto:[email protected]> +0xF6 all LTTng Linux Trace Toolkit Next Generation + <mailto:[email protected]> +0xFD all linux/dm-ioctl.h +==== ===== ======================================================= ================================================================
Documentation/process/submit-checklist.rst +1 -1
@@ -107,7 +107,7 @@ and elsewhere regarding submitting Linux kernel patches. and why. 26) If any ioctl's are added by the patch, then also update - ``Documentation/ioctl/ioctl-number.txt``. + ``Documentation/ioctl/ioctl-number.rst``. 27) If your modified source code depends on or uses any of the kernel APIs or features that are related to the following ``Kconfig`` symbols,
Documentation/translations/it_IT/process/submit-checklist.rst +1 -1
@@ -117,7 +117,7 @@ sottomissione delle patch, in particolare sorgenti che ne spieghi la logica: cosa fanno e perché. 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate - ``Documentation/ioctl/ioctl-number.txt``. + ``Documentation/ioctl/ioctl-number.rst``. 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o funzionalità del kernel che è associata a uno dei seguenti simboli
Documentation/translations/zh_CN/process/submit-checklist.rst +1 -1
@@ -97,7 +97,7 @@ Linux内核补丁提交清单 24) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注 释来解释它们正在执行的操作及其原因的逻辑。 -25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/ioctl/ioctl-number.txt`` +25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/ioctl/ioctl-number.rst`` 26) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或 功能,则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` (如果该选项可用)的情况
include/uapi/rdma/rdma_user_ioctl_cmds.h +1 -1
@@ -36,7 +36,7 @@#include <linux/types.h> #include <linux/ioctl.h> -/* Documentation/ioctl/ioctl-number.txt */ +/* Documentation/ioctl/ioctl-number.rst */ #define RDMA_IOCTL_MAGIC 0x1b#define RDMA_VERBS_IOCTL \ _IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
Signature · 1 line
2.21.0
Re: [PATCH v1 02/22] docs: ioctl-number.txt: convert it to ReST format
Quoted 25 lines · CEST Mauro Carvalho Chehab
The conversion itself is simple: add a markup for the title of this file and add markups for both tables.
Yet, the big table here with IOCTL numbers is badly formatted:
on several lines, the "Include File" column has some values that are bigger than the reserved space there.Also, on several places, a comment was misplaced at the "Include File" space.
So, most of the work here is to actually ensure that each field will be properly fixed.
Also worth to mention that some URLs have the asterisk character on it. Well, Sphinx has an issue with asterisks in the middle of an string. As this is URL, use the alternate format: %2A.
As a side effect of this patch, it is now a lot easier to see that some reserved ioctl numbers are missing the include files where it is supposed to be used.
PS.: While this is part of a subdir, I opted to convert this single file alone, as this file has a potential of conflicts, as most subsystem maintainers touch it.
Quoted 7 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- .../{ioctl-number.txt => ioctl-number.rst} | 588 +++++++++--------- Documentation/process/submit-checklist.rst | 2 +- .../it_IT/process/submit-checklist.rst | 2 +- .../zh_CN/process/submit-checklist.rst | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +-
Signature · 2 lines
Federico Vaga http://www.federicovaga.it/
PATCH 3/22 docs: ioctl: 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.
The cdrom.txt and hdio.txt have their own particular syntax. In order to speedup the conversion, I used a small ancillary perl script:
my $d; $d .= $_ while(<>); $d =~ s/(\nCDROM\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\nHDIO\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\n\s*usage:)[\s\n]*(\w[^\n]*)/$1:\n\n\t $2\n/g; $d =~ s/(\n\s*)(E\w+[\s\n]*\w[^\n]*)/$1- $2/g; $d =~ s/(\n\s*)(inputs|outputs|notes):\s*(\w[^\n]*)/$1$2:\n\t\t$3\n/g; print $d;
It basically add blank lines on a few interesting places. The script is not perfect: still several things require manual work, but it saved quite some time doing some obvious stuff.
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.
---
...g-up-ioctls.txt => botching-up-ioctls.rst} | 1 +
Documentation/ioctl/{cdrom.txt => cdrom.rst} | 908 +++++++++++-------
Documentation/ioctl/{hdio.txt => hdio.rst} | 835 ++++++++++------
Documentation/ioctl/index.rst | 16 +
...{ioctl-decoding.txt => ioctl-decoding.rst} | 13 +-
drivers/gpu/drm/drm_ioctl.c | 2 +-
6 files changed, 1168 insertions(+), 607 deletions(-)
rename Documentation/ioctl/{botching-up-ioctls.txt => botching-up-ioctls.rst} (99%)
rename Documentation/ioctl/{cdrom.txt => cdrom.rst} (39%)
rename Documentation/ioctl/{hdio.txt => hdio.rst} (54%)
create mode 100644 Documentation/ioctl/index.rst
rename Documentation/ioctl/{ioctl-decoding.txt => ioctl-decoding.rst} (54%)Documentation/ioctl/botching-up-ioctls.rst renamed from Documentation/ioctl/botching-up-ioctls.txt +1 -0
@@ -1,3 +1,4 @@ +================================= (How to avoid) Botching up ioctls =================================
Documentation/ioctl/cdrom.rst renamed from Documentation/ioctl/cdrom.txt +587 -321
1,512 lines not on this page · raw message
Documentation/ioctl/hdio.rst renamed from Documentation/ioctl/hdio.txt +553 -282
1,473 lines not on this page · raw message
Documentation/ioctl/index.rst new file +16 -0
@@ -0,0 +1,16 @@ +:orphan: + +====== +IOCTLs +====== + +.. toctree:: + :maxdepth: 1 + + ioctl-number +
Lines of this file are not shown. View the raw message.
Documentation/ioctl/ioctl-decoding.rst renamed from Documentation/ioctl/ioctl-decoding.txt +10 -3
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 6 lines
2.21.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Part of the diff is not shown here. View the raw message.
PATCH 4/22 docs: thermal: convert to ReST
In reply to Mauro Carvalho ChehabRename the thermal 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.
---
...pu-cooling-api.txt => cpu-cooling-api.rst} | 39 +-
.../{exynos_thermal => exynos_thermal.rst} | 47 +-
...emulation => exynos_thermal_emulation.rst} | 66 +--
Documentation/thermal/index.rst | 18 +
...el_powerclamp.txt => intel_powerclamp.rst} | 177 +++----
.../{nouveau_thermal => nouveau_thermal.rst} | 54 +-
...ower_allocator.txt => power_allocator.rst} | 140 ++---
.../thermal/{sysfs-api.txt => sysfs-api.rst} | 490 ++++++++++++------
...hermal => x86_pkg_temperature_thermal.rst} | 28 +-
MAINTAINERS | 2 +-
include/linux/thermal.h | 4 +-
11 files changed, 665 insertions(+), 400 deletions(-)
rename Documentation/thermal/{cpu-cooling-api.txt => cpu-cooling-api.rst} (82%)
rename Documentation/thermal/{exynos_thermal => exynos_thermal.rst} (67%)
rename Documentation/thermal/{exynos_thermal_emulation => exynos_thermal_emulation.rst} (36%)
create mode 100644 Documentation/thermal/index.rst
rename Documentation/thermal/{intel_powerclamp.txt => intel_powerclamp.rst} (76%)
rename Documentation/thermal/{nouveau_thermal => nouveau_thermal.rst} (64%)
rename Documentation/thermal/{power_allocator.txt => power_allocator.rst} (74%)
rename Documentation/thermal/{sysfs-api.txt => sysfs-api.rst} (66%)
rename Documentation/thermal/{x86_pkg_temperature_thermal => x86_pkg_temperature_thermal.rst} (80%)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +27 -12
@@ -1,5 +1,6 @@ +======================= CPU cooling APIs How To -=================================== +======================= Written by Amit Daniel Kachhap <[email protected]>
@@ -8,40 +9,54 @@ Updated: 6 Jan 2015 Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.samsung.com) 0. Introduction +=============== The generic cpu cooling(freq clipping) provides registration/unregistration APIs to the caller. The binding of the cooling devices to the trip point is left for the user. The registration APIs returns the cooling device pointer. 1. cpu cooling APIs +=================== 1.1 cpufreq registration/unregistration APIs -1.1.1 struct thermal_cooling_device *cpufreq_cooling_register( - struct cpumask *clip_cpus) +-------------------------------------------- + + :: + + struct thermal_cooling_device + *cpufreq_cooling_register(struct cpumask *clip_cpus) This interface function registers the cpufreq cooling device with the name "thermal-cpufreq-%x". This api can support multiple instances of cpufreq cooling devices. - clip_cpus: cpumask of cpus where the frequency constraints will happen. + clip_cpus: + cpumask of cpus where the frequency constraints will happen. -1.1.2 struct thermal_cooling_device *of_cpufreq_cooling_register( - struct cpufreq_policy *policy) + :: + + struct thermal_cooling_device + *of_cpufreq_cooling_register(struct cpufreq_policy *policy) This interface function registers the cpufreq cooling device with the name "thermal-cpufreq-%x" linking it with a device tree node, in order to bind it via the thermal DT code. This api can support multiple instances of cpufreq cooling devices. - policy: CPUFreq policy. + policy: + CPUFreq policy. -1.1.3 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev) + + :: + + void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev) This interface function unregisters the "thermal-cpufreq-%x" cooling device. cdev: Cooling device pointer which has to be unregistered. 2. Power models +=============== The power API registration functions provide a simple power model for CPUs. The current power is calculated as dynamic power (static power isn't
@@ -65,9 +80,9 @@ For a given processor implementation the primary factors are: variation. In pathological cases this variation can be significant, but typically it is of a much lesser impact than the factors above. -A high level dynamic power consumption model may then be represented as: +A high level dynamic power consumption model may then be represented as:: -Pdyn = f(run) * Voltage^2 * Frequency * Utilisation + Pdyn = f(run) * Voltage^2 * Frequency * Utilisation f(run) here represents the described execution behaviour and its result has a units of Watts/Hz/Volt^2 (this often expressed in
@@ -80,9 +95,9 @@ factors. Therefore, in initial implementation that contribution is represented as a constant coefficient. This is a simplification consistent with the relative contribution to overall power variation. -In this simplified representation our model becomes: +In this simplified representation our model becomes:: -Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation + Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation Where `capacitance` is a constant that represents an indicative running time dynamic power coefficient in fundamental units of
Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +30 -17
94 lines not on this page · raw message
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +37 -29
88 lines not on this page · raw message
Documentation/thermal/index.rst new file +18 -0
@@ -0,0 +1,18 @@ +:orphan: + +======= +Thermal +======= + +.. toctree:: + :maxdepth: 1 + + cpu-cooling-api + sysfs-api + power_allocator + + exynos_thermal + exynos_thermal_emulation + intel_powerclamp + nouveau_thermal + x86_pkg_temperature_thermal
Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +90 -87
249 lines not on this page · raw message
Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +34 -20
100 lines not on this page · raw message
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +82 -58
208 lines not on this page · raw message
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +326 -164
837 lines not on this page · raw message
Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +18 -10
@@ -1,19 +1,23 @@ +=================================== Kernel driver: x86_pkg_temp_thermal -=================== +=================================== Supported chips: + * x86: with package level thermal management + (Verify using: CPUID.06H:EAX[bit 6] =1) Authors: Srinivas Pandruvada <[email protected]> Reference ---- +--------- + Intel® 64 and IA-32 Architectures Software Developer’s Manual (Jan, 2013): Chapter 14.6: PACKAGE LEVEL THERMAL MANAGEMENT Description ---------- +----------- This driver register CPU digital temperature package level sensor as a thermal zone with maximum two user mode configurable trip points. Number of trip points
@@ -25,23 +29,27 @@ take any action to control temperature. Threshold management -------------------- Each package will register as a thermal zone under /sys/class/thermal. -Example: -/sys/class/thermal/thermal_zone1 + +Example:: + + /sys/class/thermal/thermal_zone1 This contains two trip points: + - trip_point_0_temp - trip_point_1_temp User can set any temperature between 0 to TJ-Max temperature. Temperature units -are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.txt" for +are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for thermal sys-fs details. Any value other than 0 in these trip points, can trigger thermal notifications. Setting 0, stops sending thermal notifications. -Thermal notifications: To get kobject-uevent notifications, set the thermal zone -policy to "user_space". For example: echo -n "user_space" > policy - - +Thermal notifications: +To get kobject-uevent notifications, set the thermal zone +policy to "user_space". +For example:: + echo -n "user_space" > policy
MAINTAINERS +1 -1
@@ -15687,7 +15687,7 @@ M: Viresh Kumar <[email protected]> M: Javi Merino <[email protected]> L: [email protected] S: Supported -F: Documentation/thermal/cpu-cooling-api.txt +F: Documentation/thermal/cpu-cooling-api.rst F: drivers/thermal/cpu_cooling.c F: include/linux/cpu_cooling.h
include/linux/thermal.h +2 -2
@@ -251,7 +251,7 @@ struct thermal_bind_params {* platform characterization. This value is relative to the * rest of the weights so a cooling device whose weight is * double that of another cooling device is twice as -* effective. See Documentation/thermal/sysfs-api.txt for more +* effective. See Documentation/thermal/sysfs-api.rst for more * information. */ int weight;
@@ -259,7 +259,7 @@ struct thermal_bind_params {/* * This is a bit mask that gives the binding relation between this * thermal zone and cdev, for a particular trip point. -* See Documentation/thermal/sysfs-api.txt for more information. +* See Documentation/thermal/sysfs-api.rst for more information. */ int trip_mask;
Signature · 1 line
2.21.0
Re: [PATCH v1 04/22] docs: thermal: convert to ReST
Quoted 9 lines · Mauro Carvalho Chehab
Rename the thermal 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]>
should I apply this patch or you have a separate tree for all these changes?
thanks,
rui
Quoted 2,358 lines
---
...pu-cooling-api.txt =>cpu-cooling-api.rst} | 39 +- .../{exynos_thermal => exynos_thermal.rst} | 47 +- ...emulation =>exynos_thermal_emulation.rst} | 66 +-- Documentation/thermal/index.rst | 18 + ...el_powerclamp.txt =>intel_powerclamp.rst} | 177 +++---- .../{nouveau_thermal => nouveau_thermal.rst} | 54 +- ...ower_allocator.txt =>power_allocator.rst} | 140 ++---.../thermal/{sysfs-api.txt=> sysfs-api.rst} | 490 ++++++++++++--
----
...hermal =>x86_pkg_temperature_thermal.rst} | 28 +- MAINTAINERS | 2 +- include/linux/thermal.h | 4 +-11 files changed, 665 insertions(+), 400 deletions(-)rename
Documentation/thermal/{cpu-cooling-api.txt=> cpu-cooling-api.rst} (82%)
renameDocumentation/thermal/{exynos_thermal=>exynos_thermal.rst} (67%)
renameDocumentation/thermal/{exynos_thermal_emulation=>exynos_thermal_emulation.rst} (36%)
create mode 100644Documentation/thermal/index.rstrenameDocumentation/thermal/{intel_powerclamp.txt=>intel_powerclamp.rst} (76%)
renameDocumentation/thermal/{nouveau_thermal=>nouveau_thermal.rst} (64%)
renameDocumentation/thermal/{power_allocator.txt=>power_allocator.rst} (74%)
renameDocumentation/thermal/{sysfs-api.txt=>sysfs-api.rst} (66%) renameDocumentation/thermal/{x86_pkg_temperature_thermal=>x86_pkg_temperature_thermal.rst} (80%)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0@@ -1,5 +1,6 @@ +=======================CPU cooling APIs How To
-===================================
+=======================
Written by Amit Daniel Kachhap <[email protected]>Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -8,40 +9,54 @@ Updated: 6 Jan 2015Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.samsung. com)
0. Introduction
+===============
The generic cpu cooling(freq clipping) provides registration/unregistration APIs
to the caller. The binding of the cooling devices to the trip point is left for
the user. The registration APIs returns the cooling device pointer.
1. cpu cooling APIs
+===================
1.1 cpufreq registration/unregistration APIs
-1.1.1 structthermal_cooling_device*cpufreq_cooling_register(Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +6
-1- struct cpumask *clip_cpus) +-------------------------------------------- + + :: + + struct thermal_cooling_device + *cpufreq_cooling_register(struct cpumask *clip_cpus)
This interface function registers the cpufreq cooling device with the name
"thermal-cpufreq-%x". This api can support multiple instances of cpufreq
cooling devices.
- clip_cpus: cpumask of cpus where the frequency constraints will happen.
+ clip_cpus:Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0+ cpumask of cpus where the frequency constraints will happen.
-1.1.2 structthermal_cooling_device*of_cpufreq_cooling_register(Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-1- struct cpufreq_policy*policy)
+ ::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +3
-0+ + struct thermal_cooling_device + *of_cpufreq_cooling_register(struct cpufreq_policy *policy)
This interface function registers the cpufreq cooling device with
the name "thermal-cpufreq-%x" linking it with a device tree node, in
order to bind it via the thermal DT code. This api can support multiple
instances of cpufreq cooling devices.
- policy: CPUFreq policy.
+ policy:Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0+ CPUFreq policy.
-1.1.3 voidcpufreq_cooling_unregister(struct thermal_cooling_device *cdev)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +4
-0+ + :: + + void cpufreq_cooling_unregister(struct
thermal_cooling_device*cdev)
This interface function unregisters the "thermal-cpufreq-%x" cooling device.
cdev: Cooling device pointer which has to be unregistered.
2. Power models
+===============
The power API registration functions provide a simple power model for
CPUs. The current power is calculated as dynamic power (static power isn'tDocumentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -65,9 +80,9 @@ For a given processor implementation the primaryfactors are:
variation. In pathological cases this variation can be significant,
but typically it is of a much lesser impact than the factors above.
-A high level dynamic power consumption model may then be represented as:
+A high level dynamic power consumption model may then be represented as::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-Pdyn = f(run) * Voltage^2 * Frequency * Utilisation + Pdyn = f(run) * Voltage^2 * Frequency * Utilisation
f(run) here represents the described execution behaviour and its result has a units of Watts/Hz/Volt^2 (this often expressed inDocumentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -80,9 +95,9 @@ factors. Therefore, in initial implementation thatcontribution is
represented as a constant coefficient. This is a simplification consistent with the relative contribution to overall power variation.Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-In this simplified representation our model becomes: +In this simplified representation our model becomes::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation + Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation
Wherecapacitanceis a constant that represents an indicative running time dynamic power coefficient in fundamental units ofDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +1
-0@@ -1,8 +1,11 @@ +========================Kernel driver
exynos_tmu
-=================
+========================
Supported chips:
+
* ARM SAMSUNG EXYNOS4, EXYNOS5 series of SoC
+
Datasheet: Not publicly available
Authors: Donggeun Kim <[email protected]>Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +0
-0@@ -19,32 +22,39 @@ Temperature can be taken from the temperaturecode.
There are three equations converting from temperature to temperature code.
The three equations are:
- 1. Two point trimming
+ 1. Two point trimming::
+
Tc = (T - 25) * (TI2 - TI1) / (85 - 25) + TI1
- 2. One point trimming
+ 2. One point trimming::
+
Tc = T + TI1 - 25
- 3. No trimming
+ 3. No trimming::
+
Tc = T + 50
- Tc: Temperature code, T: Temperature,
- TI1: Trimming info for 25 degree Celsius (stored at TRIMINFO register)
+ Tc:
+ Temperature code, T: Temperature,
+ TI1:
+ Trimming info for 25 degree Celsius (stored at TRIMINFO register)
Temperature code measured at 25 degree Celsius which is unchanged
- TI2: Trimming info for 85 degree Celsius (stored at TRIMINFO register)
+ TI2:
+ Trimming info for 85 degree Celsius (stored at TRIMINFO register)
Temperature code measured at 85 degree Celsius which is unchanged
TMU(Thermal Management Unit) in EXYNOS4/5 generates interrupt when temperature exceeds pre-defined levels.
The maximum number of configurable threshold is five.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-1-The threshold levels are defined as follows: +The threshold levels are defined as follows:: +Level_0: current temperature >
trigger_level_0+ threshold
Level_1: current temperature >trigger_level_1+ threshold
Level_2: current temperature >trigger_level_2+ threshold
Level_3: current temperature >trigger_level_3+ threshold
- The threshold and eachtrigger_levelare set
- through the corresponding registers.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+The threshold and each trigger_level are set +through the corresponding registers.
When an interrupt occurs, this driver notify kernel thermal framework
with the functionexynos_report_trigger.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +0
-0@@ -54,24 +64,27 @@ it can be used to synchronize the cooling action.TMU driver description:
-----------------------Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +1
-1-The exynos thermal driver is structured as, +The exynos thermal driver is structured as::
Kernel Core thermal framework
(thermal_core.c,step_wise.c,cpu_cooling.c)
^ | | -TMU configuration data -------> TMU Driver <------> Exynos Core thermal wrapper
-(exynos_tmu_data.c) (exynos_tmu.c) (exynos_thermal_common.c)
-(exynos_tmu_data.h) (exynos_tmu.h) (exynos_thermal_common.h)
+ TMU configuration data -----> TMU Driver <----> Exynos Core thermal wrapper
+ (exynos_tmu_data.c) (exynos_tmu.c) (exynos_thermal_common.c)
+ (exynos_tmu_data.h) (exynos_tmu.h) (exynos_thermal_common.h)
-a) TMU configuration data: This consist of TMU register offsets/bitfieldsDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+a) TMU configuration data: + This consist of TMU register offsets/bitfieldsdescribed through structure
exynos_tmu_registers. Also several
other platform data (structexynos_tmu_platform_data) members
are used to configure the TMU.
-b) TMU driver: This component initialises the TMU controller and sets differentDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+b) TMU driver: + This component initialises the TMU controller andsets different
thresholds. It invokes core thermal implementation with the call
exynos_report_trigger.
-c) Exynos Core thermal wrapper: This provides 3 wrapper function to use theDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+c) Exynos Core thermal wrapper: + This provides 3 wrapper function to use theKernel core thermal framework. They are
exynos_unregister_thermal,
exynos_register_thermalandexynos_report_trigger.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-2@@ -1,5 +1,6 @@ -EXYNOS EMULATION MODE -======================== +===================== +Exynos Emulation Mode +=====================
Copyright (C) 2012 Samsung ElectronicsDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-0@@ -8,46 +9,53 @@ Written by Jonghwa Lee <[email protected]>Description
-----------
-Exynos 4x12 (4212, 4412) and 5 series provide emulation mode for thermal management unit.
-Thermal emulation mode supports software debug for TMU's operation. User can set temperature
-manually with software code and TMU will read current temperature from user value not fromDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-1-sensor's value. +Exynos 4x12 (4212, 4412) and 5 series provide emulation mode forthermal
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-0+management unit. Thermal emulation mode supports software debug for +TMU's operation. User can set temperature manually with softwarecode
+and TMU will read current temperature from user value not from sensor's
+value.
-EnablingCONFIG_THERMAL_EMULATIONoption will make this support available.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-1-When it's enabled, sysfs node will be created as +Enabling CONFIG_THERMAL_EMULATION option will make this support +available. When it's enabled, sysfs node will be created as/sys/devices/virtual/thermal/thermal_zone'zone id'/emul_temp.
-The sysfs node, 'emul_node', will contain value 0 for the initial state. When you input any
-temperature you want to update to sysfs node, it automatically enable emulation mode andDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-2-current temperature will be changed into it. -(Exynos also supports user changeable delay time which would be usedto delay of
- changing temperature. However, this node only uses same delay of real sensing time, 938us.)
+The sysfs node, 'emul_node', will contain value 0 for the initial state.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-0+When you input any temperature you want to update to sysfs node, it +automatically enable emulation mode and current temperature will be +changed into it.
-Exynos emulation mode requires synchronous of value changing and enabling. It means when you
-want to update the any value of delay or next temperature, then you have to enable emulation
-mode at the same time. (Or you have to keep the mode enabling.) If you don't, it fails to
-change the value to updated one and just use last succeessful value repeatedly. That's why
-this node gives users the right to change termerpature only. Just one interface makes it moreDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-1-simply to use. +(Exynos also supports user changeable delay time which would be usedto
+delay of changing temperature. However, this node only uses same delayDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +6
-0+of real sensing time, 938us.) + +Exynos emulation mode requires synchronous of value changing and +enabling. It means when you want to update the any value of delay or +next temperature, then you have to enable emulation mode at the same +time. (Or you have to keep the mode enabling.) If you don't, itfails to
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-0+change the value to updated one and just use last succeessful value +repeatedly. That's why this node gives users the right to change +termerpature only. Just one interface makes it more simply to use.
Disabling emulation mode only requires writing value 0 to sysfs node.
+::Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-1-TEMP 120 | + + TEMP 120 ||
100 |
|
80 |Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-3- | +----------- - 60 | | | - | +-------------| | + | +----------- + 60 | | | + | +-------------| |40 | | | |
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-4- | | | | - 20 | | | +- --------- - | | | ||
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-1+ | | | | + 20 | | | +---- ------ + | | | ||
0 |______________|_____________|__________|__________|_________Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-1- A A AA TIME
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-0+ A A AA TIME
|<----->| |<----->| |<----->| | | 938us | | | | | | -emulation : 0 50 | 70 | 20 |0
-current temp : sensor 50 70 20
sensor
+ emulation : 0 50 | 70 | 20 |
0
+ current temp: sensor 50 70 20
sensorDocumentation/thermal/index.rst new file +18
-0@@ -0,0 +1,18 @@ +:orphan: + +======= +Thermal +======= + +.. toctree:: + :maxdepth: 1 + + cpu-cooling-api + sysfs-api + power_allocator + + exynos_thermal + exynos_thermal_emulation + intel_powerclamp + nouveau_thermal + x86_pkg_temperature_thermalDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +9
-5@@ -1,10 +1,13 @@ - ======================= - INTEL POWERCLAMP DRIVER - ======================= -By: Arjan van de Ven <[email protected]> - Jacob Pan <[email protected]> +======================= +Intel Powerclamp Driver +======================= + +By: + - Arjan van de Ven <[email protected]> + - Jacob Pan <[email protected]> + +.. Contents:
-Contents:
(*) Introduction
- Goals and ObjectivesDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -23,7 +26,6 @@ Contents: - Generic Thermal Layer (sysfs) - Kernel APIs (TBD)
-============
INTRODUCTION
============Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -47,7 +49,6 @@ scalability, and user experience. In many cases,clear advantage is
shown over taking the CPU offline or modulating the CPU clock.
-===================
THEORY OF OPERATION
===================Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -57,11 +58,12 @@ Idle InjectionOn modern Intel processors (Nehalem or later), package level C-state residency is available in MSRs, thus also available to the kernel.
Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +6
-5-These MSRs are: - #define MSR_PKG_C2_RESIDENCY 0x60D - #define MSR_PKG_C3_RESIDENCY 0x3F8 - #define MSR_PKG_C6_RESIDENCY 0x3F9 - #define MSR_PKG_C7_RESIDENCY 0x3FA +These MSRs are:: + + #define MSR_PKG_C2_RESIDENCY 0x60D + #define MSR_PKG_C3_RESIDENCY 0x3F8 + #define MSR_PKG_C6_RESIDENCY 0x3F9 + #define MSR_PKG_C7_RESIDENCY 0x3FA
If the kernel can also inject idle time to the system, then a closed-loop control system can be established that manages packageDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -96,19 +98,21 @@ are not masked. Tests show that the extra wakeupsfrom scheduler tick
have a dramatic impact on the effectiveness of the powerclamp driver on large scale systems (Westmere system with 80 processors).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +15
-13-CPU0 - ____________ ____________ -kidle_inject/0 | sleep | mwait | sleep | - _________| |________| |_______ - duration -CPU1 - ____________ ____________ -kidle_inject/1 | sleep | mwait | sleep | - _________| |________| |_______ - ^ - | - | - roundup(jiffies, interval) +:: + + CPU0 + ____________ ____________ + kidle_inject/0 | sleep | mwait | sleep | + _________| |________| |_______ + duration + CPU1 + ____________ ____________ + kidle_inject/1 | sleep | mwait | sleep | + _________| |________| |_______ + ^ + | + | + roundup(jiffies, interval)
Only one CPU is allowed to collect statistics and update global control parameters. This CPU is referred to as the controlling CPU inDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -148,7 +152,7 @@ b) determine the amount of compensation needed ateach target ratio
Compensation to each target ratio consists of two parts:
- a) steady state error compensationDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +1
-0+ a) steady state error compensationThis is to offset the error occurring when the system can enter idle without extra wakeups (such as external interrupts).
Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -158,41 +162,42 @@ Compensation to each target ratio consists oftwo parts:
slowing down CPU activities.
A debugfs file is provided for the user to examine compensationDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +36
-35-progress and results, such as on a Westmere system. -[jacob@nex01 ~]$ cat -/sys/kernel/debug/intel_powerclamp/powerclamp_calib -controlling cpu: 0 -pct confidence steady dynamic (compensation) -0 0 0 0 -1 1 0 0 -2 1 1 0 -3 3 1 0 -4 3 1 0 -5 3 1 0 -6 3 1 0 -7 3 1 0 -8 3 1 0 -... -30 3 2 0 -31 3 2 0 -32 3 1 0 -33 3 2 0 -34 3 1 0 -35 3 2 0 -36 3 1 0 -37 3 2 0 -38 3 1 0 -39 3 2 0 -40 3 3 0 -41 3 1 0 -42 3 2 0 -43 3 1 0 -44 3 1 0 -45 3 2 0 -46 3 3 0 -47 3 0 0 -48 3 2 0 -49 3 3 0 +progress and results, such as on a Westmere system:: + + [jacob@nex01 ~]$ cat + /sys/kernel/debug/intel_powerclamp/powerclamp_calib + controlling cpu: 0 + pct confidence steady dynamic (compensation) + 0 0 0 0 + 1 1 0 0 + 2 1 1 0 + 3 3 1 0 + 4 3 1 0 + 5 3 1 0 + 6 3 1 0 + 7 3 1 0 + 8 3 1 0 + ... + 30 3 2 0 + 31 3 2 0 + 32 3 1 0 + 33 3 2 0 + 34 3 1 0 + 35 3 2 0 + 36 3 1 0 + 37 3 2 0 + 38 3 1 0 + 39 3 2 0 + 40 3 3 0 + 41 3 1 0 + 42 3 2 0 + 43 3 1 0 + 44 3 1 0 + 45 3 2 0 + 46 3 3 0 + 47 3 0 0 + 48 3 2 0 + 49 3 3 0
Calibration occurs during runtime. No offline method is available. Steady state compensation is used only when confidence levels of allDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -217,9 +222,8 @@ keeps track of clamping kernel threads, evenafter they are migrated
to other CPUs, after a CPU offline event.
-=====================
Performance Analysis
-=====================
+====================
This section describes the general performance data collected on multiple systems, including Westmere (80P) and Ivy Bridge (4P, 8P).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -257,16 +261,15 @@ achieve up to 40% better performance per watt.(measured by a spin
counter summed over per CPU counting threads spawned for all running CPUs).
-====================
Usage and Interfaces
====================
The powerclamp driver is registered to the generic thermal layer as aDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +1
-1-cooling device. Currently, it’s not bound to any thermal zones. +cooling device. Currently, it’s not bound to any thermal zones::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +4
-4-jacob@chromoly:/sys/class/thermal/cooling_device14$ grep . * -cur_state:0 -max_state:50 -type:intel_powerclamp + jacob@chromoly:/sys/class/thermal/cooling_device14$ grep . * + cur_state:0 + max_state:50 + type:intel_powerclamp
cur_state allows user to set the desired idle percentage. Writing 0 to
cur_state will stop idle injection. Writing a value between 1 andDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -278,9 +281,9 @@ cur_state returns value -1 instead of 0 which isto avoid confusing
100% busy state with the disabled state.
Example usage:
-- To inject 25% idle time
-$ sudo sh -c "echo 25 >/sys/class/thermal/cooling_device80/cur_state
-"
+- To inject 25% idle time::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +2
-0+ + $ sudo sh -c "echo 25 >
/sys/class/thermal/cooling_device80/cur_state
If the system is not busy and has more than 25% idle time already, then the powerclamp driver will not start idle injection. Using TopDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -292,23 +295,23 @@ idle time is accounted as normal idle in thatcommon code path is
taken as the idle task.
In this example, 24.1% idle is shown. This helps the system admin or -user determine the cause of slowdown, when a powerclamp driver is in action.
+user determine the cause of slowdown, when a powerclamp driver is in action::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-2-Tasks: 197 total, 1 running, 196 sleeping, 0 stopped, 0 zombie -Cpu(s): 71.2%us, 4.7%sy, 0.0%ni,24.1%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
-Mem: 3943228k total, 1689632k used, 2253596k free, 74960k buffers
-Swap: 4087804k total, 0k used, 4087804k free, 945336k cached
+ Tasks: 197 total, 1 running, 196 sleeping, 0 stopped, 0 zombie
+ Cpu(s): 71.2%us, 4.7%sy, 0.0%ni,
24.1%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
+ Mem: 3943228k total, 1689632k used, 2253596k free, 74960k buffers
+ Swap: 4087804k total, 0k used, 4087804k free, 945336k cached
- PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
- 3352 jacob 20 0 262m 644 428 S 286 0.0 0:17.16 spin
- 3341 root -51 0 0 0 0 D 25 0.0 0:01.62 kidle_inject/0
- 3344 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/3
- 3342 root -51 0 0 0 0 D 25 0.0 0:01.61 kidle_inject/1
- 3343 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/2
- 2935 jacob 20 0 696m 125m 35m S 5 3.3 0:31.11 firefox
- 1546 root 20 0 158m 20m 6640 S 3 0.5 0:26.97 Xorg
- 2100 jacob 20 0 1223m 88m 30m S 3 2.3 0:23.68 compiz + PID USER PR NI VIRT RES SHR S %CPU
%MEM TIME+ COMMAND
+ 3352 jacob 20 0 262m 644 428 S 286 0.0 0:17.16 spin + 3341 root -51 0 0 0 0 D 25 0.0 0:01.62 kidle_inject/0
+ 3344 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/3
+ 3342 root -51 0 0 0 0 D 25 0.0 0:01.61 kidle_inject/1
+ 3343 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/2
+ 2935 jacob 20 0 696m 125m 35m S 5 3.3 0:31.11 firefox
+ 1546 root 20 0 158m 20m 6640 S 3 0.5 0:26.97 Xorg + 2100 jacob 20 0 1223m 88m 30m S 3 2.3 0:23.68 compiz
Tests have shown that by using the powerclamp driver as a cooling device, a PID based userspace thermal controller can manage toDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0@@ -1,13 +1,15 @@ +=====================Kernel driver nouveau
-===================
+=====================
Supported chips:
+
* NV43+
Authors: Martin Peres (mupuf) <[email protected]>
Description
----------
+-----------
This driver allows to read the GPU core temperature, drive the GPU fan and
set temperature alarms.Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -19,20 +21,25 @@ interface is likely not to work. This documentmay then not cover your situation
entirely.
Temperature management
---------------------
+----------------------
Temperature is exposed under as a read-only HWMON attributetemp1_input.
In order to protect the GPU from overheating, Nouveau supports 4 configurable
temperature thresholds:
- *Fan_boost: Fan speed is set to 100% when reaching this temperature;
- * Downclock: The GPU will be downclocked to reduce its power dissipation;
- * Critical: The GPU is put on hold to further lower power dissipation;
- * Shutdown: Shut the computer down to protect your GPU.
+ *Fan_boost:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +7
-0+ Fan speed is set to 100% when reaching this temperature; + * Downclock: + The GPU will be downclocked to reduce its power dissipation; + * Critical: + The GPU is put on hold to further lower power dissipation; + * Shutdown: + Shut the computer down to protect your GPU.
-WARNING: Some of these thresholds may not be used by Nouveau dependingDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +2
-1-on your chipset. +WARNING: + Some of these thresholds may not be used by Nouveaudepending
Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ on your chipset.
The default value for these thresholds comes from the GPU's vbios. These
thresholds can be configured thanks to the following HWMON attributes:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -46,19 +53,24 @@ NOTE: Remember that the values are stored asmilli degrees Celsius. Don't forget
to multiply!
Fan management
-------------
+--------------
Not all cards have a drivable fan. If you do, then the following HWMON
attributes should be available:
- *pwm1_enable: Current fan management mode (NONE, MANUAL or AUTO);
- * pwm1: Current PWM value (power percentage);
- *pwm1_min: The minimum PWM speed allowed;
- *pwm1_max: The maximum PWM speed allowed (bypassed when hittingFan_boost);
+ *pwm1_enable:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +7
-0+ Current fan management mode (NONE, MANUAL or AUTO); + * pwm1: + Current PWM value (power percentage); + * pwm1_min: + The minimum PWM speed allowed; + * pwm1_max: + The maximum PWM speed allowed (bypassed when hitting
Fan_boost);
You may also have the following attribute:
- *fan1_input: Speed in RPM of your fan.
+ *fan1_input:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ Speed in RPM of your fan.
Your fan can be driven in different modes:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -66,14 +78,16 @@ Your fan can be driven in different modes: * 1: The fan can be driven in manual (use pwm1 to change the speed); * 2; The fan is driven automatically depending on the temperature.
-NOTE: Be sure to use the manual mode if you want to drive the fan speed manually
+NOTE:
+ Be sure to use the manual mode if you want to drive the fan speed manually
-NOTE2: When operating in manual mode outside the vbios-defined -[PWM_min,PWM_max] range, the reported fan speed (RPM) may not be accurateDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +3
-1-depending on your hardware. +NOTE2: + When operating in manual mode outside the vbios-defined + [PWM_min, PWM_max] range, the reported fan speed (RPM) may not beaccurate
+ depending on your hardware.
Bug reports
----------
+-----------
Thermal management on Nouveau is new and may not work on all cards. If you have
inquiries, please ping mupuf on IRC (#nouveau, freenode).Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0@@ -1,3 +1,4 @@ +=================================Power allocator governor tunables
=================================Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -25,36 +26,36 @@ temperature as the control input and power as thecontrolled output:
P_max =k_p* e +k_i*err_integral+k_d*diff_err+sustainable_power
where
- e =desired_temperature-current_temperature- err_integral is the sum of previous errors
- diff_err = e -previous_error
+ - e =desired_temperature-current_temperature+ - err_integral is the sum of previous errors + - diff_err = e -previous_errorDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-It is similar to the one depicted below: +It is similar to the one depicted below::
- k_d
- |
-current_temp |- | v - | +----------+ +---+ - | +----->| diff_err |-->| X |------+ - | | +----------+ +---+ | - | | | tdp actor
- | | k_i | | get_requested_power()
- | | | | | | |
- | | | | | | | ...
- v | v v v v v
- +---+ | +-------+ +---+ +---+ +---+ +-----
-----+
- | S |-------+----->| sum e |----->| X |--->| S |-->| S | -->|power |
- +---+ | +-------+ +---+ +---+ +--- + |allocation|
- ^ | ^ +-----
-----+
- | | | | |
- | | +---
+ | | |
- | +------->| X |-------------------
+ v v
- | +---+ granted performanceDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-4-desired_temperature ^ - | - | - k_po/k_pu + k_d + | + current_temp | + | v + | +----------+ +---+ + | +----->| diff_err |-->| X |------+ + | | +----------+ +---+ | + | | | tdp actor
+ | | k_i | | get_requested_power()
+ | | | | | | |
+ | | | | | | | ...
+ v | v v v v v
+ +---+ | +-------+ +---+ +---+ +---+ +-----
-----+
+ | S |-----+----->| sum e |----->| X |--->| S |-->| S | -->|power |
+ +---+ | +-------+ +---+ +---+ +--- + |allocation|
+ ^ | ^ +-----
-----+
+ | | | | |
+ | | +---
+ | | |
+ | +------->| X |-------------------
+ v v
+ | +---+ granted performance
+ desired_temperature ^Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-0+ | + | + k_po/k_pu
Sustainable power
-----------------Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -73,7 +74,7 @@ is typically 2000mW, while on a 10" tablet isaround 4500mW (may vary
depending on screen size).
If you are using device tree, do add it as a property of theDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-thermal-zone. For example: +thermal-zone. For example::
thermal-zones {
soc_thermal{Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -85,7 +86,7 @@ thermal-zone. For example: Instead, if the thermal zone is registered from the platform code,pass a
thermal_zone_paramsthat has asustainable_power. If nothermal_zone_paramswere being passed, then something like belowDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-will suffice: +will suffice::
static const structthermal_zone_paramstz_params= { .sustainable_power = 3500,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -112,18 +113,18 @@ available capacity at a low temperature. Onthe other hand, a high
value ofk_puwill result in the governor granting very high power while temperature is low, and may lead to temperature overshooting.Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-The default value for `k_pu` is: +The default value for `k_pu` is::
2 *sustainable_power/ (desired_temperature-switch_on_temp)
This means that atswitch_on_tempthe output of the controller's proportional term will be 2 *sustainable_power. The default valueDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-for `k_po` is: +for `k_po` is::
sustainable_power / (desired_temperature-switch_on_temp)
Focusing on the proportional and feed forward values of the PIDDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-controller equation we have: +controller equation we have::
P_max =k_p* e +sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -134,21 +135,23 @@ is the desired one, then the proportionalcomponent is zero and
thermal equilibrium under constant load.sustainable_poweris only
an estimate, which is the reason for closed-loop control such as this.Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +2
-1-Expanding `k_pu` we get: +Expanding `k_pu` we get:: +P_max = 2 *
sustainable_power* (T_set- T) / (T_set-T_on) + - sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +5
-4-where - T_set is the desired temperature - T is the current temperature - T_on is the switch on temperature +where: + + - T_set is the desired temperature + - T is the current temperature + - T_on is the switch on temperature
When the current temperature is theswitch_ontemperature, the aboveDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-formula becomes: +formula becomes::
P_max = 2 *sustainable_power* (T_set-T_on) / (T_set-T_on) +
- sustainable_power = 2 *sustainable_power+sustainable_power=
- 3 *sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ sustainable_power = 2 * sustainable_power +
sustainable_power=Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ 3 * sustainable_power
Therefore, the proportional term alone linearly decreases power from 3 *sustainable_powertosustainable_poweras the temperatureDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -178,11 +181,18 @@ Cooling device power APICooling devices controlled by this governor must supply the additional
"power" API in theircooling_device_ops. It consists on three ops:
-1. int get_requested_power(structthermal_cooling_device*cdev,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +4
-4- struct thermal_zone_device *tz, u32 *power); -@cdev: The `struct thermal_cooling_device` pointer -@tz: thermal zone in which we are currently operating -@power: pointer in which to store the calculated power +1. :: + + int get_requested_power(struct thermal_cooling_device *cdev, + struct thermal_zone_device *tz, u32*power);
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-0+ + +@cdev: + The `struct thermal_cooling_device` pointer +@tz: + thermal zone in which we are currently operating +@power: + pointer in which to store the calculated power
get_requested_power()calculates the power requested by the device in milliwatts and stores it in @power . It should return 0 onDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -190,23 +200,37 @@ success, -E* on failure. This is currentlyused by the power
allocator governor to calculate how much power to give to each cooling
device.
-2. int state2power(structthermal_cooling_device*cdev, struct - thermal_zone_device *tz, unsigned long state, u32 *power); -@cdev: Thestruct thermal_cooling_devicepointer -@tz: thermal zone in which we are currently operating -@state: A cooling device state
-@power: pointer in which to store the equivalent power +2. ::Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-0+ + int state2power(struct thermal_cooling_device *cdev, struct + thermal_zone_device *tz, unsigned longstate,
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +10
-0+ u32 *power); + +@cdev: + The `struct thermal_cooling_device` pointer +@tz: + thermal zone in which we are currently operating +@state: + A cooling device state +@power: + pointer in which to store the equivalent power
Convert cooling device state @state into power consumption in milliwatts and store it in @power. It should return 0 on success, -E*
on failure. This is currently used by thermal core to calculate the maximum power that an actor can consume.
-3. int power2state(structthermal_cooling_device*cdev, u32 power,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-4- unsigned long *state); -@cdev: The `struct thermal_cooling_device` pointer -@power: power in milliwatts -@state: pointer in which to store the resulting state +3. :: + + int power2state(struct thermal_cooling_device *cdev, u32power,
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-0+ unsigned long *state); + +@cdev: + The `struct thermal_cooling_device` pointer +@power: + power in milliwatts +@state: + pointer in which to store the resulting state
Calculate a cooling device state that would make the device consume at
most @power mW and store it in @state. It should return 0 on success,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0@@ -1,3 +1,4 @@ +===================================Generic Thermal Sysfs driver How To
===================================Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -9,6 +10,7 @@ Copyright (c) 2008 Intel Corporation
0. Introduction
+===============
The generic thermal sysfs provides a set of interfaces for thermal zone
devices (sensors) and thermal cooling devices (fan, processor...) to registerDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -25,59 +27,90 @@ An intelligent thermal management application canmake decisions based on
inputs from thermal zone attributes (the current temperature and trip point
temperature) and throttle appropriate devices.
-[0-*] denotes any positive number starting from 0
-[1-*] denotes any positive number starting from 1+- `[0-*]` denotes any positive number starting from 0 +- `[1-*]` denotes any positive number starting from 1
1. thermal sysfs driver interface functions
+===========================================
1.1 thermal zone device interface
-1.1.1 structthermal_zone_device*thermal_zone_device_register(char *type,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-4- int trips, int mask, void *devdata, - struct thermal_zone_device_ops *ops, - const struct thermal_zone_params *tzp, - int passive_delay, int polling_delay)) +--------------------------------- + + :: + + struct thermal_zone_device + *thermal_zone_device_register(char *type, + int trips, int mask, void*devdata,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct thermal_zone_device_ops*ops,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ const struct
thermal_zone_params*tzp,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ int passive_delay, int
polling_delay))
This interface function adds a new thermal zone device (sensor) to
- /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
+ /sys/class/thermal folder asthermal_zone[0-*]. It tries to bind all the
thermal cooling devices registered at the same time.
- type: the thermal zone type.
- trips: the total number of trip points this thermal zone supports.
- mask: Bit string: If 'n'th bit is set, then trip point 'n' is writeable.
- devdata: device private data
- ops: thermal zone device call-backs.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .bind: bind the thermal zone device with a thermal coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .unbind: unbind the thermal zone device with a thermalcooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- .get_temp: get the current temperature of the thermal zone. - .set_trips: set the trip points window. Whenever the currenttemperature
+ type:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ the thermal zone type. + trips: + the total number of trip points this thermal zone supports. + mask: + Bit string: If 'n'th bit is set, then trip point 'n' iswriteable.
+ devdata:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +6
-0+ device private data + ops: + thermal zone device call-backs. + + .bind: + bind the thermal zone device with a thermal coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .unbind: + unbind the thermal zone device with a thermalcooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ .get_temp: + get the current temperature of the thermal zone. + .set_trips: + set the trip points window. Whenever the currenttemperature
is updated, the trip points immediately below and above the
current temperature are found.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_mode: get the current mode (enabled/disabled) of thethermal zone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- - "enabled" means the kernel thermal management isenabled.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- - "disabled" will prevent kernel thermal driver actionupon trip points
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- so that user applications can take charge of thermalmanagement.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_mode: set the mode (enabled/disabled) of the thermalzone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- .get_trip_type: get the type of certain trip point. - .get_trip_temp: get the temperature above which the certaintrip point
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .get_mode: + get the current mode (enabled/disabled) of thethermal zone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ + - "enabled" means the kernel thermalmanagement is
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ enabled. + - "disabled" will prevent kernel thermaldriver action
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ upon trip points so that user applicationscan take
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ charge of thermal management. + .set_mode: + set the mode (enabled/disabled) of the thermal zone. + .get_trip_type: + get the type of certain trip point. + .get_trip_temp: + get the temperature above which the certaintrip point
will be fired.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_emul_temp: set the emulation temperature which helps indebugging
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .set_emul_temp: + set the emulation temperature which helps indebugging
different threshold temperature points. - tzp: thermal zone platform parameters.
- passive_delay: number of milliseconds to wait between polls when + tzp:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ thermal zone platform parameters. + passive_delay: + number of milliseconds to wait between polls whenperforming passive cooling.
- polling_delay: number of milliseconds to wait between polls when checking
+ polling_delay:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ number of milliseconds to wait between polls when checkingwhether trip points have been crossed (0 for interrupt driven systems).
+ ::
-1.1.2 voidthermal_zone_device_unregister(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ void thermal_zone_device_unregister(struct
thermal_zone_device*tz)
This interface function removes the thermal zone device. It deletes the corresponding entry from/sys/class/thermalfolder and
unbinds all the thermal cooling devices it uses.
-1.1.3 structthermal_zone_device*thermal_zone_of_sensor_register(Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-2- struct device *dev, int sensor_id, void *data, - const struct thermal_zone_of_device_ops *ops) + :: + + struct thermal_zone_device + *thermal_zone_of_sensor_register(struct device *dev, int
sensor_id,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ void *data, + const struct
thermal_zone_of_device_ops*ops)
This interface adds a new sensor to a DT thermal zone. This function will search the list of thermal zones described inDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -87,25 +120,33 @@ temperature) and throttle appropriate devices.thermal zone device.
The parameters for this interface are:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- dev: Device node of sensor containing validnode pointer in
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ + dev: + Device node of sensor containing valid nodepointer in
dev->of_node.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- sensor_id: a sensor identifier, in case the sensor IPhas more
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ sensor_id: + a sensor identifier, in case the sensor IPhas more
than one sensorsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- data: a private pointer (owned by the caller)that will be
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ data: + a private pointer (owned by the caller) thatwill be
passed back, when a temperature reading is needed.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- ops: struct thermal_zone_of_device_ops *. + ops: + `struct thermal_zone_of_device_ops *`.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- get_temp: a pointer to a functionthat reads the
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ ============== =======================================
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ get_temp a pointer to a function thatreads the
sensor temperature. This is mandatory
callback provided by sensor driver.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- set_trips: a pointer to a function thatsets a
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ set_trips a pointer to a functionthat sets a
temperature window. When this window is
left the driver must inform the thermal
core viathermal_zone_device_update.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- get_trend: a pointer to a functionthat reads the
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ get_trend a pointer to a functionthat reads the
sensor temperature trend.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- set_emul_temp: a pointer to afunction that sets
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ set_emul_temp a pointer to a functionthat sets
sensor emulated temperature.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ ============== =======================================
+
The thermal zone temperature is provided by theget_temp()function
pointer ofthermal_zone_of_device_ops. When called, it will have the private pointer @data back.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -114,8 +155,10 @@ temperature) and throttle appropriate devices. handle. Caller should check the return handle with IS_ERR()for finding
whether success or not.
-1.1.4 void thermal_zone_of_sensor_unregister(struct device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- struct thermal_zone_device *tzd) + :: + + void thermal_zone_of_sensor_unregister(struct device*dev,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device*tzd)
This interface unregisters a sensor from a DT thermal zone which was
successfully added by interfacethermal_zone_of_sensor_register().Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -124,21 +167,29 @@ temperature) and throttle appropriate devices.interface. It will also silent the zone by remove the .get_temp() and
get_trend()thermal zone device callbacks.
-1.1.5 structthermal_zone_device*devm_thermal_zone_of_sensor_register(Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- struct device *dev, int sensor_id, - void *data, const struct thermal_zone_of_device_ops*ops)
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ :: + + struct thermal_zone_device + *devm_thermal_zone_of_sensor_register(struct device *dev, + int sensor_id, + void *data, + const struct
thermal_zone_of_device_ops*ops)
This interface is resource managed version ofthermal_zone_of_sensor_register().
+
All details ofthermal_zone_of_sensor_register()described in
section 1.1.3 is applicable here.
+
The benefit of using this interface to register sensor is that it
is not require to explicitly callthermal_zone_of_sensor_unregister()
in error path or during driver unbinding as this is done by driver
resource manager.
-1.1.6 void devm_thermal_zone_of_sensor_unregister(struct device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- struct thermal_zone_device *tzd) + :: + + void devm_thermal_zone_of_sensor_unregister(structdevice *dev,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device*tzd)
This interface is resource managed version ofthermal_zone_of_sensor_unregister().Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -147,123 +198,186 @@ temperature) and throttle appropriatedevices.
Normally this function will not need to be called and the resource
management code will ensure that the resource is freed.
-1.1.7 intthermal_zone_get_slope(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ :: + + int thermal_zone_get_slope(struct
thermal_zone_device*tz)
This interface is used to read the slope attribute value for the thermal zone device, which might be useful for platform
drivers for temperature calculations.
-1.1.8 intthermal_zone_get_offset(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ :: + + int thermal_zone_get_offset(struct
thermal_zone_device*tz)
This interface is used to read the offset attribute value for the thermal zone device, which might be useful for platform
drivers for temperature calculations.
1.2 thermal cooling device interface
-1.2.1 structthermal_cooling_device*thermal_cooling_device_register(char *name,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +8
-1- void *devdata, struct thermal_cooling_device_ops *) +------------------------------------ + + + :: + + struct thermal_cooling_device + *thermal_cooling_device_register(char *name, + void *devdata, struct
thermal_cooling_device_ops*)
This interface function adds a new thermal cooling device (fan/processor/...)
- to/sys/class/thermal/folder as cooling_device[0-*]. It tries to bind itself
+ to/sys/class/thermal/folder ascooling_device[0-*]. It tries to bind itself
to all the thermal zone devices registered at the same time. - name: the cooling device name.
- devdata: device private data.
- ops: thermal cooling devices call-backs.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_max_state: get the Maximum throttle state of thecooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_cur_state: get the Currently requested throttle stateof the cooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_cur_state: set the Current throttle state of thecooling device.
-
-1.2.2 voidthermal_cooling_device_unregister(struct thermal_cooling_device *cdev)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +10
-0+ + name: + the cooling device name. + devdata: + device private data. + ops: + thermal cooling devices call-backs. + + .get_max_state: + get the Maximum throttle state of the coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ .get_cur_state: + get the Currently requested throttle state of the + cooling device. + .set_cur_state: + set the Current throttle state of the coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ + :: + + void thermal_cooling_device_unregister(struct
thermal_cooling_device*cdev)
This interface function removes the thermal cooling device. It deletes the corresponding entry from/sys/class/thermalfolder and
unbinds itself from all the thermal zone devices using it.
1.3 interface for binding a thermal zone device with a thermal cooling device
-1.3.1 int thermal_zone_bind_cooling_device(structthermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- int trip, struct thermal_cooling_device *cdev, - unsigned long upper, unsigned long lower, unsigned intweight);
+------------------------------------------------------------------
-----------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ + :: + + int thermal_zone_bind_cooling_device(struct
thermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ int trip, struct thermal_cooling_device *cdev, + unsigned long upper, unsigned long lower, unsignedint weight);
This interface function binds a thermal cooling device to a particular trip
point of a thermal zone device.
+
This function is usually called in the thermal zone device .bind callback.
- tz: the thermal zone device
- cdev: thermal cooling device
- trip: indicates which trip point in this thermal zone the cooling device
- is associated with.
- upper:the Maximum cooling state for this trip point. - THERMAL_NO_LIMIT means no upper limit,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + tz: + the thermal zone device + cdev: + thermal cooling device + trip: + indicates which trip point in this thermal zone thecooling device
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ is associated with. + upper: + the Maximum cooling state for this trip point. + THERMAL_NO_LIMIT means no upper limit,and the cooling device can be in
max_state.
- lower:the Minimum cooling state can be used for this trip point. - THERMAL_NO_LIMIT means no lower limit,
+ lower:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ the Minimum cooling state can be used for this trip point. + THERMAL_NO_LIMIT means no lower limit,and the cooling device can be in cooling state 0. - weight: the influence of this cooling device in this thermal - zone. See 1.4.1 below for more information. + weight:
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ the influence of this cooling device in this thermal + zone. See 1.4.1 below for more information.
-1.3.2 int thermal_zone_unbind_cooling_device(structthermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- int trip, struct thermal_cooling_device *cdev); + :: + + int thermal_zone_unbind_cooling_device(struct
thermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ int trip, struct
thermal_cooling_device*cdev);
This interface function unbinds a thermal cooling device from a particular
trip point of a thermal zone device. This function is usually called in
the thermal zone device .unbind callback.
- tz: the thermal zone device
- cdev: thermal cooling device
- trip: indicates which trip point in this thermal zone the cooling device
- is associated with.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + tz: + the thermal zone device + cdev: + thermal cooling device + trip: + indicates which trip point in this thermal zone the coolingdevice
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is associated with.
1.4 Thermal Zone Parameters
-1.4.1 structthermal_bind_params
+---------------------------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + :: + + struct thermal_bind_params +This structure defines the following parameters that are used to bind
a zone with a cooling device for a particular trip point. - .cdev: The cooling device pointer
- .weight: The 'influence' of a particular cooling device on this - zone. This is relative to the rest of the cooling - devices. For example, if all cooling devices have a - weight of 1, then they all contribute the same. You can - use percentages if you want, but it's not mandatory. A - weight of 0 means that this cooling device doesn't - contribute to the cooling of this zone unless all cooling
- devices have a weight of 0. If all weights are 0, then - they all contribute the same.
- .trip_mask:This is a bit mask that gives the binding relation between
- this thermal zone and cdev, for a particular trip point.
- If nth bit is set, then the cdev and thermal zone are bound
- for trip point n.
- .binding_limits: This is an array of cooling state limits. Must have
- exactly 2 * thermal_zone.number_of_trip_points. It is an
- array consisting of tuples <lower-state upper- state> of
- state limits. Each trip will be associated with one state
- limit tuple when binding. A NULL pointer means - <THERMAL_NO_LIMITSTHERMAL_NO_LIMITS> on all trips.
- These limits are used when binding a cdev to a trip point.
- .match: This call back returns success(0) if the 'tz and cdev' need toDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +11
-0+ + .cdev: + The cooling device pointer + .weight: + The 'influence' of a particular cooling device on this + zone. This is relative to the rest of the cooling + devices. For example, if all cooling devices have a + weight of 1, then they all contribute the same. You can + use percentages if you want, but it's not mandatory. A + weight of 0 means that this cooling device doesn't + contribute to the cooling of this zone unless allcooling
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ devices have a weight of 0. If all weights are 0, then + they all contribute the same. + .trip_mask: + This is a bit mask that gives the binding relationbetween
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ this thermal zone and cdev, for a particular trippoint.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ If nth bit is set, then the cdev and thermal zone arebound
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ for trip point n. + .binding_limits: + This is an array of cooling state limits. Musthave
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ exactly 2 * thermal_zone.number_of_trip_points.It is an
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ array consisting of tuples <lower-state upper-state> of
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ state limits. Each trip will be associated withone state
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ limit tuple when binding. A NULL pointer means + <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on alltrips.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ These limits are used when binding a cdev to atrip point.
+ .match:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ This call back returns success(0) if the 'tz and cdev'need to
be bound, as per platform data.
-1.4.2 structthermal_zone_paramsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + :: + + struct thermal_zone_params +This structure defines the platform level parameters for a thermal zone.
This data, for each thermal zone should come from the platform layer.
This is an optional feature where some platforms can choose not to
provide this data.
- .governor_name: Name of the thermal governor used for this zone - .no_hwmon: a boolean to indicate if the thermal to hwmon sysfs interface
- is required. whenno_hwmon== false, a hwmon sysfs interface
- will be created. whenno_hwmon== true, nothing will be done.
- In case thethermal_zone_paramsis NULL, the hwmon interface
- will be created (for backward compatibility). - .num_tbps: Number ofthermal_bind_paramsentries for this zone - .tbp:thermal_bind_paramsentriesDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + .governor_name: + Name of the thermal governor used for this zone + .no_hwmon: + a boolean to indicate if the thermal to hwmon sysfsinterface
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is required. when no_hwmon == false, a hwmon sysfsinterface
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ will be created. when no_hwmon == true, nothing willbe done.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ In case the thermal_zone_params is NULL, the hwmoninterface
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ will be created (for backward compatibility). + .num_tbps: + Number of thermal_bind_params entries for this zone + .tbp: + thermal_bind_params entries
2. sysfs attributes structure
+=============================
+== ================
RO read only value
WO write only value
RW read/write value
+== ================
Thermal sysfs attributes will be represented under/sys/class/thermal.
Hwmon sysfs I/F extension is also available under/sys/class/hwmonif hwmon is compiled in or built as a module.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-2-Thermal zone device sys I/F, created once it's registered: -/sys/class/thermal/thermal_zone[0-*]: +Thermal zone device sys I/F, created once it's registered:: + + /sys/class/thermal/thermal_zone[0-*]:|---type: Type of the thermal zone |---temp: Current temperature |---mode: Working mode of the thermalzone
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -282,8 +396,9 @@ Thermal zone device sys I/F, created once it'sregistered:
|---slope: Slope constant applied as linear extrapolation
|---offset: Offset constant applied as linear extrapolationDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-2-Thermal cooling device sys I/F, created once it's registered: -/sys/class/thermal/cooling_device[0-*]: +Thermal cooling device sys I/F, created once it's registered:: + + /sys/class/thermal/cooling_device[0-*]:|---type: Type of the cooling
device(processor/fan/...)
|---max_state: Maximum cooling state of the
cooling device
|---cur_state: Current cooling state of the
cooling deviceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -299,11 +414,13 @@ the relationship between a thermal zone and itsassociated cooling device.
They are created/removed for each successful execution of thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1-/sys/class/thermal/thermal_zone[0-*]: +:: + + /sys/class/thermal/thermal_zone[0-*]:|---cdev[0-*]: [0-*]th cooling device in current
thermal zone
|---cdev[0-*]_trip_point: Trip point that cdev[0-*] is
associated with
|---cdev[0-*]_weight: Influence of the cooling device in - this thermal zoneDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ this thermal zone
Besides the thermal zone device sysfs I/F and cooling device sysfs I/F,
the generic thermal driver also creates a hwmon sysfs I/F for each _type_Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -311,16 +428,17 @@ of thermal zone device. E.g. the genericthermal driver registers one hwmon
class device and build the associated hwmon sysfs I/F for all the registered
ACPI thermal zones.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1-/sys/class/hwmon/hwmon[0-*]: +:: + + /sys/class/hwmon/hwmon[0-*]:|---name: The type of the thermal zone
devices
|---temp[1-*]_input: The current temperature of thermal
zone [1-*]
|---temp[1-*]_critical: The critical trip point of
thermal zone [1-*]
Please readDocumentation/hwmon/sysfs-interface.rstfor additional information.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-*************************** -* Thermal zone attributes * -*************************** +Thermal zone attributes +-----------------------
type
Strings which represent the thermal zone type.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -340,54 +458,67 @@ modeThis file gives information about the algorithm that is currently
managing the thermal zone. It can be either default kernel based
algorithm or user space application.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- enabled = enable Kernel Thermal management. - disabled = Preventing kernel thermal zone driveractions upon
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + enabled + enable Kernel Thermal management. + disabled + Preventing kernel thermal zone driveractions upon
trip points so that user application can take full
charge of the thermal management. +
RW, Optional
policy
One of the various thermal governors used for a particular zone.
+
RW, Required
available_policies
Available thermal governors which can be used for a particular zone.
+
RO, Required
-trip_point_[0-*]_temp
+trip_point_[0-*]_temp
The temperature above which trip point will be fired. +
Unit: millidegree Celsius
+
RO, Optional
-trip_point_[0-*]_type
+trip_point_[0-*]_type
Strings which indicate the type of the trip point.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- E.g. it can be one of critical, hot, passive, active[0-*]for ACPI
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ + E.g. it can be one of critical, hot, passive, `active[0-*]`for ACPI
thermal zone.
+
RO, Optional
-trip_point_[0-*]_hyst
+trip_point_[0-*]_hyst
The hysteresis value for a trip point, represented as an integer
Unit: Celsius
RW, Optional
-cdev[0-*]
+cdev[0-*]
Sysfs link to the thermal cooling device node where the sys I/F
for cooling device throttling control represents. +
RO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2-cdev[0-*]_trip_point - The trip point in this thermal zone which cdev[0-*] isassociated
+cdev[0-*]_trip_pointDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ The trip point in this thermal zone which `cdev[0-*]` isassociated
with; -1 means the cooling device is not associated with any trip
point.
+
RO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-7-cdev[0-*]_weight - The influence of cdev[0-*] in this thermal zone. This value - is relative to the rest of cooling devices in the thermal - zone. For example, if a cooling device has a weight double - than that of other, it's twice as effective in cooling the - thermal zone. - RW, Optional +`cdev[0-*]_weight` + The influence of `cdev[0-*]` in this thermal zone. Thisvalue
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +6
-0+ is relative to the rest of cooling devices in the thermal + zone. For example, if a cooling device has a weight double + than that of other, it's twice as effective in cooling the + thermal zone. + + RW, Optional
passive
Attribute is only present for zones in which the passive coolingDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -395,8 +526,11 @@ passiveand can be set to a temperature (in millidegrees) to enable a
passive trip point for the zone. Activation is done by polling with
an interval of 1 second.
+
Unit: millidegrees Celsius
+
Valid values: 0 (disabled) or greater than 1000 +
RW, Optional
emul_tempDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -407,17 +541,21 @@ emul_tempthreshold and its associated cooling action. This is write only node
and writing 0 on this node should disable emulation.
Unit: millidegree Celsius
+
WO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- WARNING: Be careful while enabling this option onproduction systems,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- because userland can easily disable the thermal policy bysimply
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- flooding this sysfs node with low temperature values. + WARNING: + Be careful while enabling this option on productionsystems,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ because userland can easily disable the thermal policyby simply
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ flooding this sysfs node with low temperature values.
sustainable_power
An estimate of the sustained power that can be dissipated by the thermal zone. Used by the power allocator governor. ForDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- more information see
Documentation/thermal/power_allocator.txtDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ more information see
Documentation/thermal/power_allocator.rst
+
Unit: milliwatts
+
RW, Optional
k_poDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -425,7 +563,8 @@ k_pocontroller during temperature overshoot. Temperature overshoot
is when the current temperature is above the "desired temperature" trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_puDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -433,20 +572,23 @@ k_pucontroller during temperature undershoot. Temperature undershoot
is when the current temperature is below the "desired temperature" trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_i
The integral term of the power allocator governor's PID controller. This term allows the PID controller to compensate
for long term drift. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_d
The derivative term of the power allocator governor's PID controller. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
integral_cutoffDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -456,8 +598,10 @@ integral_cutoffexample, if
integral_cutoffis 0, then the integral term only
accumulates error when temperature is above the desired temperature trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +Unit: millidegree Celsius
+
RW, Optional
slopeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -465,6 +609,7 @@ slopeto determine a hotspot temperature based off the sensor's raw readings. It is up to the device driver to determine the usage of these values.
+
RW, Optional
offsetDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -472,28 +617,33 @@ offsetto determine a hotspot temperature based off the sensor's raw readings. It is up to the device driver to determine the usage of these values.
+
RW, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-***************************** -* Cooling device attributes * -***************************** +Cooling device attributes +-------------------------
type
String which represents the type of device, e.g:
+
- for generic ACPI: should be "Fan", "Processor" or "LCD"
- for memory controller device onintel_menlowplatform:
should be "Memory controller".
+
RO, Required
max_state
The maximum permissible cooling state of this cooling device.
+
RO, Required
cur_state
The current cooling state of this cooling device. The value can any integer numbers between 0 andmax_state:
+
-cur_state== 0 means no cooling
-cur_state==max_statemeans the maximum cooling. +
RW, Required
stats/resetDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -508,9 +658,11 @@ stats/time_in_state_ms:units here is 10mS (similar to other time exported in /proc).
RO, Required
+
stats/total_trans:
A single positive value showing the total number of times the state of a
cooling device is changed.
+
RO, Required
stats/trans_table:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -522,6 +674,7 @@ stats/trans_table:RO, Required
3. A simple implementation
+==========================
ACPI thermal zone may support multiple trip points like critical, hot,
passive, active. If an ACPI thermal zone supports critical, passive,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -532,11 +685,10 @@ thermal_cooling_device. Both are considered tohave the same
effectiveness in cooling the thermal zone.
If the processor is listed in_PSLmethod, and the fan is listed in_AL0Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-1-method, the sys I/F structure will be built like this: +method, the sys I/F structure will be built like this::Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-/sys/class/thermal: - -|thermal_zone1: + /sys/class/thermal: + |thermal_zone1:|---type: acpitz |---temp: 37000 |---mode: enabledDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -557,24 +709,24 @@ method, the sys I/F structure will be builtlike this:
|---cdev1_trip_point: 2 /* cdev1 can be used for
active[0]*/
|---cdev1_weight: 1024
-|cooling_device0:
+ |cooling_device0:|---type: Processor |---max_state: 8 |---cur_state: 0 -|cooling_device3: + |cooling_device3: |---type: Fan |---max_state: 2 |---cur_state: 0Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-/sys/class/hwmon: - -|hwmon0: + /sys/class/hwmon: + |hwmon0:|---name: acpitz |---temp1_input: 37000 |---temp1_crit: 100000
4. Event Notification
+=====================
The framework includes a simple notification mechanism, in the form of a
netlink event. Netlink socket initialization is done during the _init_Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -587,21 +739,28 @@ event will be one of:{THERMAL_AUX0, THERMAL_AUX1, THERMAL_CRITICAL,THERMAL_DEV_FAULT}. Notification can be sent when the current temperature
crosses any of the configured thresholds.
-5. Export Symbol APIs:
+5. Export Symbol APIs
+=====================
+
+5.1.get_tz_trend
+-----------------
-5.1:get_tz_trend:
This function returns the trend of a thermal zone, i.e the rate of change
of temperature of the thermal zone. Ideally, the thermal sensor drivers
are supposed to implement the callback. If they don't, the thermal framework calculated the trend by comparing the previous and the current
temperature values.
-5.2:get_thermal_instance:
+5.2.get_thermal_instance
+-------------------------
+
This function returns thethermal_instancecorresponding to a given {thermal_zone,cooling_device,trip_point} combination. Returns NULL if such an instance does not exist.
-5.3:thermal_notify_framework:
+5.3.thermal_notify_framework
+-----------------------------
+
This function handles the trip events from sensor drivers. It starts throttling the cooling devices according to the policy configured. For CRITICAL and HOT trip points, this notifies the respective drivers,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -609,12 +768,15 @@ and does actual throttling for other trippoints i.e ACTIVE and PASSIVE.
The throttling policy is based on the configured platform data; if no
platform data is provided, this uses thestep_wisethrottling policy.
-5.4:thermal_cdev_update:
+5.4.thermal_cdev_update
+------------------------
+
This function serves as an arbitrator to set the state of a cooling device. It sets the cooling device to the deepest cooling state if possible.
-6.thermal_emergency_poweroff:
+6.thermal_emergency_poweroff
+=============================
On an event of critical trip temperature crossing. Thermal framework allows the system to shutdown gracefully by callingorderly_poweroff().Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +1
-0@@ -1,19 +1,23 @@ +===================================Kernel driver:
x86_pkg_temp_thermal
-===================
+===================================
Supported chips:
+
* x86: with package level thermal management
+
(Verify using: CPUID.06H:EAX[bit 6] =1)
Authors: Srinivas Pandruvada <[email protected]>
Reference
----
+---------
+
Intel® 64 and IA-32 Architectures Software Developer’s Manual (Jan, 2013):
Chapter 14.6: PACKAGE LEVEL THERMAL MANAGEMENT
Description
----------
+-----------
This driver register CPU digital temperature package level sensor as a thermal
zone with maximum two user mode configurable trip points. Number of trip pointsDocumentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +0
-0@@ -25,23 +29,27 @@ take any action to control temperature.Threshold management
--------------------
Each package will register as a thermal zone under/sys/class/thermal.Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +4
-2-Example: -/sys/class/thermal/thermal_zone1 + +Example:: + + /sys/class/thermal/thermal_zone1
This contains two trip points:
+
-trip_point_0_temp
-trip_point_1_temp
User can set any temperature between 0 to TJ-Max temperature. Temperature units
-are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.txt" for
+are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for
thermal sys-fs details.
Any value other than 0 in these trip points, can trigger thermal notifications.
Setting 0, stops sending thermal notifications.
-Thermal notifications: To get kobject-uevent notifications, set the thermal zoneDocumentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +3
-3-policy to "user_space". For example: echo -n "user_space" > policy - - +Thermal notifications: +To get kobject-uevent notifications, set the thermal zone +policy to "user_space".
+For example::Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +1
-0+ echo -n "user_space" > policyMAINTAINERS +0
-0@@ -15687,7 +15687,7 @@ M: Viresh Kumar <[email protected]rg>
M: Javi Merino <[email protected]>
L: [email protected]
S: SupportedMAINTAINERS +1
-1-F: Documentation/thermal/cpu-cooling-api.txt +F: Documentation/thermal/cpu-cooling-api.rstF:
drivers/thermal/cpu_cooling.c
F:include/linux/cpu_cooling.hinclude/linux/thermal.h +0
-1@@ -251,7 +251,7 @@ struct thermal_bind_params { * platform characterization. This value is relative to the * rest of the weights so a cooling device whose weight is * double that of another cooling device is twice as - * effective. See Documentation/thermal/sysfs-api.txt formore
include/linux/thermal.h +1
-0+ * effective. See Documentation/thermal/sysfs-api.rst formore
* information.
*/
int weight;include/linux/thermal.h +0
-0@@ -259,7 +259,7 @@ struct thermal_bind_params { /** This is a bit mask that gives the binding relation between this
* thermal zone and cdev, for a particular trip point.include/linux/thermal.h +0
-1- * See Documentation/thermal/sysfs-api.txt for moreinformation.
include/linux/thermal.h +1
-0+ * See Documentation/thermal/sysfs-api.rst for moreinformation.
*/
inttrip_mask;
Re: [PATCH v1 04/22] docs: thermal: convert to ReST
Em Tue, 25 Jun 2019 21:40:11 +0800
Zhang Rui <[email protected]> escreveu:
Quoted 9 lines · Mauro Carvalho Chehab
Quoted 8 lines
Rename the thermal 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.
Quoted 6 lines
Quoted 1 line
Signed-off-by Mauro Carvalho Chehab <[email protected]>Acked-by Zhang Rui <[email protected]>should I apply this patch or you have a separate tree for all these changes?
Feel free to apply it directly to your tree. The patches on this series are pretty much independent.
Quoted 2,353 lines
thanks,
ruiQuoted 2,350 lines
---
...pu-cooling-api.txt =>cpu-cooling-api.rst} | 39 +- .../{exynos_thermal => exynos_thermal.rst} | 47 +- ...emulation =>exynos_thermal_emulation.rst} | 66 +-- Documentation/thermal/index.rst | 18 + ...el_powerclamp.txt =>intel_powerclamp.rst} | 177 +++---- .../{nouveau_thermal => nouveau_thermal.rst} | 54 +- ...ower_allocator.txt =>power_allocator.rst} | 140 ++---.../thermal/{sysfs-api.txt=> sysfs-api.rst} | 490 ++++++++++++--
----
...hermal =>x86_pkg_temperature_thermal.rst} | 28 +- MAINTAINERS | 2 +- include/linux/thermal.h | 4 +-11 files changed, 665 insertions(+), 400 deletions(-)rename
Documentation/thermal/{cpu-cooling-api.txt=> cpu-cooling-api.rst} (82%)
renameDocumentation/thermal/{exynos_thermal=>exynos_thermal.rst} (67%)
renameDocumentation/thermal/{exynos_thermal_emulation=>exynos_thermal_emulation.rst} (36%)
create mode 100644Documentation/thermal/index.rstrenameDocumentation/thermal/{intel_powerclamp.txt=>intel_powerclamp.rst} (76%)
renameDocumentation/thermal/{nouveau_thermal=>nouveau_thermal.rst} (64%)
renameDocumentation/thermal/{power_allocator.txt=>power_allocator.rst} (74%)
renameDocumentation/thermal/{sysfs-api.txt=>sysfs-api.rst} (66%) renameDocumentation/thermal/{x86_pkg_temperature_thermal=>x86_pkg_temperature_thermal.rst} (80%)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0@@ -1,5 +1,6 @@ +=======================CPU cooling APIs How To
-===================================
+=======================
Written by Amit Daniel Kachhap <[email protected]>Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -8,40 +9,54 @@ Updated: 6 Jan 2015Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.samsung. com)
0. Introduction
+===============
The generic cpu cooling(freq clipping) provides registration/unregistration APIs
to the caller. The binding of the cooling devices to the trip point is left for
the user. The registration APIs returns the cooling device pointer.
1. cpu cooling APIs
+===================
1.1 cpufreq registration/unregistration APIs
-1.1.1 structthermal_cooling_device*cpufreq_cooling_register(Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +6
-1- struct cpumask *clip_cpus) +-------------------------------------------- + + :: + + struct thermal_cooling_device + *cpufreq_cooling_register(struct cpumask *clip_cpus)
This interface function registers the cpufreq cooling device with the name
"thermal-cpufreq-%x". This api can support multiple instances of cpufreq
cooling devices.
- clip_cpus: cpumask of cpus where the frequency constraints will happen.
+ clip_cpus:Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0+ cpumask of cpus where the frequency constraints will happen.
-1.1.2 structthermal_cooling_device*of_cpufreq_cooling_register(Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-1- struct cpufreq_policy*policy)
+ ::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +3
-0+ + struct thermal_cooling_device + *of_cpufreq_cooling_register(struct cpufreq_policy *policy)
This interface function registers the cpufreq cooling device with
the name "thermal-cpufreq-%x" linking it with a device tree node, in
order to bind it via the thermal DT code. This api can support multiple
instances of cpufreq cooling devices.
- policy: CPUFreq policy.
+ policy:Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0+ CPUFreq policy.
-1.1.3 voidcpufreq_cooling_unregister(struct thermal_cooling_device *cdev)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +4
-0+ + :: + + void cpufreq_cooling_unregister(struct
thermal_cooling_device*cdev)
This interface function unregisters the "thermal-cpufreq-%x" cooling device.
cdev: Cooling device pointer which has to be unregistered.
2. Power models
+===============
The power API registration functions provide a simple power model for
CPUs. The current power is calculated as dynamic power (static power isn'tDocumentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -65,9 +80,9 @@ For a given processor implementation the primaryfactors are:
variation. In pathological cases this variation can be significant,
but typically it is of a much lesser impact than the factors above.
-A high level dynamic power consumption model may then be represented as:
+A high level dynamic power consumption model may then be represented as::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-Pdyn = f(run) * Voltage^2 * Frequency * Utilisation + Pdyn = f(run) * Voltage^2 * Frequency * Utilisation
f(run) here represents the described execution behaviour and its result has a units of Watts/Hz/Volt^2 (this often expressed inDocumentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -80,9 +95,9 @@ factors. Therefore, in initial implementation thatcontribution is
represented as a constant coefficient. This is a simplification consistent with the relative contribution to overall power variation.Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-In this simplified representation our model becomes: +In this simplified representation our model becomes::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation + Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation
Wherecapacitanceis a constant that represents an indicative running time dynamic power coefficient in fundamental units ofDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +1
-0@@ -1,8 +1,11 @@ +========================Kernel driver
exynos_tmu
-=================
+========================
Supported chips:
+
* ARM SAMSUNG EXYNOS4, EXYNOS5 series of SoC
+
Datasheet: Not publicly available
Authors: Donggeun Kim <[email protected]>Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +0
-0@@ -19,32 +22,39 @@ Temperature can be taken from the temperaturecode.
There are three equations converting from temperature to temperature code.
The three equations are:
- 1. Two point trimming
+ 1. Two point trimming::
+
Tc = (T - 25) * (TI2 - TI1) / (85 - 25) + TI1
- 2. One point trimming
+ 2. One point trimming::
+
Tc = T + TI1 - 25
- 3. No trimming
+ 3. No trimming::
+
Tc = T + 50
- Tc: Temperature code, T: Temperature,
- TI1: Trimming info for 25 degree Celsius (stored at TRIMINFO register)
+ Tc:
+ Temperature code, T: Temperature,
+ TI1:
+ Trimming info for 25 degree Celsius (stored at TRIMINFO register)
Temperature code measured at 25 degree Celsius which is unchanged
- TI2: Trimming info for 85 degree Celsius (stored at TRIMINFO register)
+ TI2:
+ Trimming info for 85 degree Celsius (stored at TRIMINFO register)
Temperature code measured at 85 degree Celsius which is unchanged
TMU(Thermal Management Unit) in EXYNOS4/5 generates interrupt when temperature exceeds pre-defined levels.
The maximum number of configurable threshold is five.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-1-The threshold levels are defined as follows: +The threshold levels are defined as follows:: +Level_0: current temperature >
trigger_level_0+ threshold
Level_1: current temperature >trigger_level_1+ threshold
Level_2: current temperature >trigger_level_2+ threshold
Level_3: current temperature >trigger_level_3+ threshold
- The threshold and eachtrigger_levelare set
- through the corresponding registers.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+The threshold and each trigger_level are set +through the corresponding registers.
When an interrupt occurs, this driver notify kernel thermal framework
with the functionexynos_report_trigger.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +0
-0@@ -54,24 +64,27 @@ it can be used to synchronize the cooling action.TMU driver description:
-----------------------Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +1
-1-The exynos thermal driver is structured as, +The exynos thermal driver is structured as::
Kernel Core thermal framework
(thermal_core.c,step_wise.c,cpu_cooling.c)
^ | | -TMU configuration data -------> TMU Driver <------> Exynos Core thermal wrapper
-(exynos_tmu_data.c) (exynos_tmu.c) (exynos_thermal_common.c)
-(exynos_tmu_data.h) (exynos_tmu.h) (exynos_thermal_common.h)
+ TMU configuration data -----> TMU Driver <----> Exynos Core thermal wrapper
+ (exynos_tmu_data.c) (exynos_tmu.c) (exynos_thermal_common.c)
+ (exynos_tmu_data.h) (exynos_tmu.h) (exynos_thermal_common.h)
-a) TMU configuration data: This consist of TMU register offsets/bitfieldsDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+a) TMU configuration data: + This consist of TMU register offsets/bitfieldsdescribed through structure
exynos_tmu_registers. Also several
other platform data (structexynos_tmu_platform_data) members
are used to configure the TMU.
-b) TMU driver: This component initialises the TMU controller and sets differentDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+b) TMU driver: + This component initialises the TMU controller andsets different
thresholds. It invokes core thermal implementation with the call
exynos_report_trigger.
-c) Exynos Core thermal wrapper: This provides 3 wrapper function to use theDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+c) Exynos Core thermal wrapper: + This provides 3 wrapper function to use theKernel core thermal framework. They are
exynos_unregister_thermal,
exynos_register_thermalandexynos_report_trigger.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-2@@ -1,5 +1,6 @@ -EXYNOS EMULATION MODE -======================== +===================== +Exynos Emulation Mode +=====================
Copyright (C) 2012 Samsung ElectronicsDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-0@@ -8,46 +9,53 @@ Written by Jonghwa Lee <[email protected]>Description
-----------
-Exynos 4x12 (4212, 4412) and 5 series provide emulation mode for thermal management unit.
-Thermal emulation mode supports software debug for TMU's operation. User can set temperature
-manually with software code and TMU will read current temperature from user value not fromDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-1-sensor's value. +Exynos 4x12 (4212, 4412) and 5 series provide emulation mode forthermal
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-0+management unit. Thermal emulation mode supports software debug for +TMU's operation. User can set temperature manually with softwarecode
+and TMU will read current temperature from user value not from sensor's
+value.
-EnablingCONFIG_THERMAL_EMULATIONoption will make this support available.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-1-When it's enabled, sysfs node will be created as +Enabling CONFIG_THERMAL_EMULATION option will make this support +available. When it's enabled, sysfs node will be created as/sys/devices/virtual/thermal/thermal_zone'zone id'/emul_temp.
-The sysfs node, 'emul_node', will contain value 0 for the initial state. When you input any
-temperature you want to update to sysfs node, it automatically enable emulation mode andDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-2-current temperature will be changed into it. -(Exynos also supports user changeable delay time which would be usedto delay of
- changing temperature. However, this node only uses same delay of real sensing time, 938us.)
+The sysfs node, 'emul_node', will contain value 0 for the initial state.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-0+When you input any temperature you want to update to sysfs node, it +automatically enable emulation mode and current temperature will be +changed into it.
-Exynos emulation mode requires synchronous of value changing and enabling. It means when you
-want to update the any value of delay or next temperature, then you have to enable emulation
-mode at the same time. (Or you have to keep the mode enabling.) If you don't, it fails to
-change the value to updated one and just use last succeessful value repeatedly. That's why
-this node gives users the right to change termerpature only. Just one interface makes it moreDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-1-simply to use. +(Exynos also supports user changeable delay time which would be usedto
+delay of changing temperature. However, this node only uses same delayDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +6
-0+of real sensing time, 938us.) + +Exynos emulation mode requires synchronous of value changing and +enabling. It means when you want to update the any value of delay or +next temperature, then you have to enable emulation mode at the same +time. (Or you have to keep the mode enabling.) If you don't, itfails to
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-0+change the value to updated one and just use last succeessful value +repeatedly. That's why this node gives users the right to change +termerpature only. Just one interface makes it more simply to use.
Disabling emulation mode only requires writing value 0 to sysfs node.
+::Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-1-TEMP 120 | + + TEMP 120 ||
100 |
|
80 |Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-3- | +----------- - 60 | | | - | +-------------| | + | +----------- + 60 | | | + | +-------------| |40 | | | |
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-4- | | | | - 20 | | | +- --------- - | | | ||
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-1+ | | | | + 20 | | | +---- ------ + | | | ||
0 |______________|_____________|__________|__________|_________Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-1- A A AA TIME
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-0+ A A AA TIME
|<----->| |<----->| |<----->| | | 938us | | | | | | -emulation : 0 50 | 70 | 20 |0
-current temp : sensor 50 70 20
sensor
+ emulation : 0 50 | 70 | 20 |
0
+ current temp: sensor 50 70 20
sensorDocumentation/thermal/index.rst new file +18
-0@@ -0,0 +1,18 @@ +:orphan: + +======= +Thermal +======= + +.. toctree:: + :maxdepth: 1 + + cpu-cooling-api + sysfs-api + power_allocator + + exynos_thermal + exynos_thermal_emulation + intel_powerclamp + nouveau_thermal + x86_pkg_temperature_thermalDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +9
-5@@ -1,10 +1,13 @@ - ======================= - INTEL POWERCLAMP DRIVER - ======================= -By: Arjan van de Ven <[email protected]> - Jacob Pan <[email protected]> +======================= +Intel Powerclamp Driver +======================= + +By: + - Arjan van de Ven <[email protected]> + - Jacob Pan <[email protected]> + +.. Contents:
-Contents:
(*) Introduction
- Goals and ObjectivesDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -23,7 +26,6 @@ Contents: - Generic Thermal Layer (sysfs) - Kernel APIs (TBD)
-============
INTRODUCTION
============Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -47,7 +49,6 @@ scalability, and user experience. In many cases,clear advantage is
shown over taking the CPU offline or modulating the CPU clock.
-===================
THEORY OF OPERATION
===================Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -57,11 +58,12 @@ Idle InjectionOn modern Intel processors (Nehalem or later), package level C-state residency is available in MSRs, thus also available to the kernel.
Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +6
-5-These MSRs are: - #define MSR_PKG_C2_RESIDENCY 0x60D - #define MSR_PKG_C3_RESIDENCY 0x3F8 - #define MSR_PKG_C6_RESIDENCY 0x3F9 - #define MSR_PKG_C7_RESIDENCY 0x3FA +These MSRs are:: + + #define MSR_PKG_C2_RESIDENCY 0x60D + #define MSR_PKG_C3_RESIDENCY 0x3F8 + #define MSR_PKG_C6_RESIDENCY 0x3F9 + #define MSR_PKG_C7_RESIDENCY 0x3FA
If the kernel can also inject idle time to the system, then a closed-loop control system can be established that manages packageDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -96,19 +98,21 @@ are not masked. Tests show that the extra wakeupsfrom scheduler tick
have a dramatic impact on the effectiveness of the powerclamp driver on large scale systems (Westmere system with 80 processors).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +15
-13-CPU0 - ____________ ____________ -kidle_inject/0 | sleep | mwait | sleep | - _________| |________| |_______ - duration -CPU1 - ____________ ____________ -kidle_inject/1 | sleep | mwait | sleep | - _________| |________| |_______ - ^ - | - | - roundup(jiffies, interval) +:: + + CPU0 + ____________ ____________ + kidle_inject/0 | sleep | mwait | sleep | + _________| |________| |_______ + duration + CPU1 + ____________ ____________ + kidle_inject/1 | sleep | mwait | sleep | + _________| |________| |_______ + ^ + | + | + roundup(jiffies, interval)
Only one CPU is allowed to collect statistics and update global control parameters. This CPU is referred to as the controlling CPU inDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -148,7 +152,7 @@ b) determine the amount of compensation needed ateach target ratio
Compensation to each target ratio consists of two parts:
- a) steady state error compensationDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +1
-0+ a) steady state error compensationThis is to offset the error occurring when the system can enter idle without extra wakeups (such as external interrupts).
Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -158,41 +162,42 @@ Compensation to each target ratio consists oftwo parts:
slowing down CPU activities.
A debugfs file is provided for the user to examine compensationDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +36
-35-progress and results, such as on a Westmere system. -[jacob@nex01 ~]$ cat -/sys/kernel/debug/intel_powerclamp/powerclamp_calib -controlling cpu: 0 -pct confidence steady dynamic (compensation) -0 0 0 0 -1 1 0 0 -2 1 1 0 -3 3 1 0 -4 3 1 0 -5 3 1 0 -6 3 1 0 -7 3 1 0 -8 3 1 0 -... -30 3 2 0 -31 3 2 0 -32 3 1 0 -33 3 2 0 -34 3 1 0 -35 3 2 0 -36 3 1 0 -37 3 2 0 -38 3 1 0 -39 3 2 0 -40 3 3 0 -41 3 1 0 -42 3 2 0 -43 3 1 0 -44 3 1 0 -45 3 2 0 -46 3 3 0 -47 3 0 0 -48 3 2 0 -49 3 3 0 +progress and results, such as on a Westmere system:: + + [jacob@nex01 ~]$ cat + /sys/kernel/debug/intel_powerclamp/powerclamp_calib + controlling cpu: 0 + pct confidence steady dynamic (compensation) + 0 0 0 0 + 1 1 0 0 + 2 1 1 0 + 3 3 1 0 + 4 3 1 0 + 5 3 1 0 + 6 3 1 0 + 7 3 1 0 + 8 3 1 0 + ... + 30 3 2 0 + 31 3 2 0 + 32 3 1 0 + 33 3 2 0 + 34 3 1 0 + 35 3 2 0 + 36 3 1 0 + 37 3 2 0 + 38 3 1 0 + 39 3 2 0 + 40 3 3 0 + 41 3 1 0 + 42 3 2 0 + 43 3 1 0 + 44 3 1 0 + 45 3 2 0 + 46 3 3 0 + 47 3 0 0 + 48 3 2 0 + 49 3 3 0
Calibration occurs during runtime. No offline method is available. Steady state compensation is used only when confidence levels of allDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -217,9 +222,8 @@ keeps track of clamping kernel threads, evenafter they are migrated
to other CPUs, after a CPU offline event.
-=====================
Performance Analysis
-=====================
+====================
This section describes the general performance data collected on multiple systems, including Westmere (80P) and Ivy Bridge (4P, 8P).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -257,16 +261,15 @@ achieve up to 40% better performance per watt.(measured by a spin
counter summed over per CPU counting threads spawned for all running CPUs).
-====================
Usage and Interfaces
====================
The powerclamp driver is registered to the generic thermal layer as aDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +1
-1-cooling device. Currently, it’s not bound to any thermal zones. +cooling device. Currently, it’s not bound to any thermal zones::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +4
-4-jacob@chromoly:/sys/class/thermal/cooling_device14$ grep . * -cur_state:0 -max_state:50 -type:intel_powerclamp + jacob@chromoly:/sys/class/thermal/cooling_device14$ grep . * + cur_state:0 + max_state:50 + type:intel_powerclamp
cur_state allows user to set the desired idle percentage. Writing 0 to
cur_state will stop idle injection. Writing a value between 1 andDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -278,9 +281,9 @@ cur_state returns value -1 instead of 0 which isto avoid confusing
100% busy state with the disabled state.
Example usage:
-- To inject 25% idle time
-$ sudo sh -c "echo 25 >/sys/class/thermal/cooling_device80/cur_state
-"
+- To inject 25% idle time::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +2
-0+ + $ sudo sh -c "echo 25 >
/sys/class/thermal/cooling_device80/cur_state
If the system is not busy and has more than 25% idle time already, then the powerclamp driver will not start idle injection. Using TopDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -292,23 +295,23 @@ idle time is accounted as normal idle in thatcommon code path is
taken as the idle task.
In this example, 24.1% idle is shown. This helps the system admin or -user determine the cause of slowdown, when a powerclamp driver is in action.
+user determine the cause of slowdown, when a powerclamp driver is in action::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-2-Tasks: 197 total, 1 running, 196 sleeping, 0 stopped, 0 zombie -Cpu(s): 71.2%us, 4.7%sy, 0.0%ni,24.1%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
-Mem: 3943228k total, 1689632k used, 2253596k free, 74960k buffers
-Swap: 4087804k total, 0k used, 4087804k free, 945336k cached
+ Tasks: 197 total, 1 running, 196 sleeping, 0 stopped, 0 zombie
+ Cpu(s): 71.2%us, 4.7%sy, 0.0%ni,
24.1%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
+ Mem: 3943228k total, 1689632k used, 2253596k free, 74960k buffers
+ Swap: 4087804k total, 0k used, 4087804k free, 945336k cached
- PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
- 3352 jacob 20 0 262m 644 428 S 286 0.0 0:17.16 spin
- 3341 root -51 0 0 0 0 D 25 0.0 0:01.62 kidle_inject/0
- 3344 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/3
- 3342 root -51 0 0 0 0 D 25 0.0 0:01.61 kidle_inject/1
- 3343 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/2
- 2935 jacob 20 0 696m 125m 35m S 5 3.3 0:31.11 firefox
- 1546 root 20 0 158m 20m 6640 S 3 0.5 0:26.97 Xorg
- 2100 jacob 20 0 1223m 88m 30m S 3 2.3 0:23.68 compiz + PID USER PR NI VIRT RES SHR S %CPU
%MEM TIME+ COMMAND
+ 3352 jacob 20 0 262m 644 428 S 286 0.0 0:17.16 spin + 3341 root -51 0 0 0 0 D 25 0.0 0:01.62 kidle_inject/0
+ 3344 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/3
+ 3342 root -51 0 0 0 0 D 25 0.0 0:01.61 kidle_inject/1
+ 3343 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/2
+ 2935 jacob 20 0 696m 125m 35m S 5 3.3 0:31.11 firefox
+ 1546 root 20 0 158m 20m 6640 S 3 0.5 0:26.97 Xorg + 2100 jacob 20 0 1223m 88m 30m S 3 2.3 0:23.68 compiz
Tests have shown that by using the powerclamp driver as a cooling device, a PID based userspace thermal controller can manage toDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0@@ -1,13 +1,15 @@ +=====================Kernel driver nouveau
-===================
+=====================
Supported chips:
+
* NV43+
Authors: Martin Peres (mupuf) <[email protected]>
Description
----------
+-----------
This driver allows to read the GPU core temperature, drive the GPU fan and
set temperature alarms.Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -19,20 +21,25 @@ interface is likely not to work. This documentmay then not cover your situation
entirely.
Temperature management
---------------------
+----------------------
Temperature is exposed under as a read-only HWMON attributetemp1_input.
In order to protect the GPU from overheating, Nouveau supports 4 configurable
temperature thresholds:
- *Fan_boost: Fan speed is set to 100% when reaching this temperature;
- * Downclock: The GPU will be downclocked to reduce its power dissipation;
- * Critical: The GPU is put on hold to further lower power dissipation;
- * Shutdown: Shut the computer down to protect your GPU.
+ *Fan_boost:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +7
-0+ Fan speed is set to 100% when reaching this temperature; + * Downclock: + The GPU will be downclocked to reduce its power dissipation; + * Critical: + The GPU is put on hold to further lower power dissipation; + * Shutdown: + Shut the computer down to protect your GPU.
-WARNING: Some of these thresholds may not be used by Nouveau dependingDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +2
-1-on your chipset. +WARNING: + Some of these thresholds may not be used by Nouveaudepending
Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ on your chipset.
The default value for these thresholds comes from the GPU's vbios. These
thresholds can be configured thanks to the following HWMON attributes:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -46,19 +53,24 @@ NOTE: Remember that the values are stored asmilli degrees Celsius. Don't forget
to multiply!
Fan management
-------------
+--------------
Not all cards have a drivable fan. If you do, then the following HWMON
attributes should be available:
- *pwm1_enable: Current fan management mode (NONE, MANUAL or AUTO);
- * pwm1: Current PWM value (power percentage);
- *pwm1_min: The minimum PWM speed allowed;
- *pwm1_max: The maximum PWM speed allowed (bypassed when hittingFan_boost);
+ *pwm1_enable:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +7
-0+ Current fan management mode (NONE, MANUAL or AUTO); + * pwm1: + Current PWM value (power percentage); + * pwm1_min: + The minimum PWM speed allowed; + * pwm1_max: + The maximum PWM speed allowed (bypassed when hitting
Fan_boost);
You may also have the following attribute:
- *fan1_input: Speed in RPM of your fan.
+ *fan1_input:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ Speed in RPM of your fan.
Your fan can be driven in different modes:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -66,14 +78,16 @@ Your fan can be driven in different modes: * 1: The fan can be driven in manual (use pwm1 to change the speed); * 2; The fan is driven automatically depending on the temperature.
-NOTE: Be sure to use the manual mode if you want to drive the fan speed manually
+NOTE:
+ Be sure to use the manual mode if you want to drive the fan speed manually
-NOTE2: When operating in manual mode outside the vbios-defined -[PWM_min,PWM_max] range, the reported fan speed (RPM) may not be accurateDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +3
-1-depending on your hardware. +NOTE2: + When operating in manual mode outside the vbios-defined + [PWM_min, PWM_max] range, the reported fan speed (RPM) may not beaccurate
+ depending on your hardware.
Bug reports
----------
+-----------
Thermal management on Nouveau is new and may not work on all cards. If you have
inquiries, please ping mupuf on IRC (#nouveau, freenode).Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0@@ -1,3 +1,4 @@ +=================================Power allocator governor tunables
=================================Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -25,36 +26,36 @@ temperature as the control input and power as thecontrolled output:
P_max =k_p* e +k_i*err_integral+k_d*diff_err+sustainable_power
where
- e =desired_temperature-current_temperature- err_integral is the sum of previous errors
- diff_err = e -previous_error
+ - e =desired_temperature-current_temperature+ - err_integral is the sum of previous errors + - diff_err = e -previous_errorDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-It is similar to the one depicted below: +It is similar to the one depicted below::
- k_d
- |
-current_temp |- | v - | +----------+ +---+ - | +----->| diff_err |-->| X |------+ - | | +----------+ +---+ | - | | | tdp actor
- | | k_i | | get_requested_power()
- | | | | | | |
- | | | | | | | ...
- v | v v v v v
- +---+ | +-------+ +---+ +---+ +---+ +-----
-----+
- | S |-------+----->| sum e |----->| X |--->| S |-->| S | -->|power |
- +---+ | +-------+ +---+ +---+ +--- + |allocation|
- ^ | ^ +-----
-----+
- | | | | |
- | | +---
+ | | |
- | +------->| X |-------------------
+ v v
- | +---+ granted performanceDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-4-desired_temperature ^ - | - | - k_po/k_pu + k_d + | + current_temp | + | v + | +----------+ +---+ + | +----->| diff_err |-->| X |------+ + | | +----------+ +---+ | + | | | tdp actor
+ | | k_i | | get_requested_power()
+ | | | | | | |
+ | | | | | | | ...
+ v | v v v v v
+ +---+ | +-------+ +---+ +---+ +---+ +-----
-----+
+ | S |-----+----->| sum e |----->| X |--->| S |-->| S | -->|power |
+ +---+ | +-------+ +---+ +---+ +--- + |allocation|
+ ^ | ^ +-----
-----+
+ | | | | |
+ | | +---
+ | | |
+ | +------->| X |-------------------
+ v v
+ | +---+ granted performance
+ desired_temperature ^Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-0+ | + | + k_po/k_pu
Sustainable power
-----------------Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -73,7 +74,7 @@ is typically 2000mW, while on a 10" tablet isaround 4500mW (may vary
depending on screen size).
If you are using device tree, do add it as a property of theDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-thermal-zone. For example: +thermal-zone. For example::
thermal-zones {
soc_thermal{Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -85,7 +86,7 @@ thermal-zone. For example: Instead, if the thermal zone is registered from the platform code,pass a
thermal_zone_paramsthat has asustainable_power. If nothermal_zone_paramswere being passed, then something like belowDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-will suffice: +will suffice::
static const structthermal_zone_paramstz_params= { .sustainable_power = 3500,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -112,18 +113,18 @@ available capacity at a low temperature. Onthe other hand, a high
value ofk_puwill result in the governor granting very high power while temperature is low, and may lead to temperature overshooting.Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-The default value for `k_pu` is: +The default value for `k_pu` is::
2 *sustainable_power/ (desired_temperature-switch_on_temp)
This means that atswitch_on_tempthe output of the controller's proportional term will be 2 *sustainable_power. The default valueDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-for `k_po` is: +for `k_po` is::
sustainable_power / (desired_temperature-switch_on_temp)
Focusing on the proportional and feed forward values of the PIDDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-controller equation we have: +controller equation we have::
P_max =k_p* e +sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -134,21 +135,23 @@ is the desired one, then the proportionalcomponent is zero and
thermal equilibrium under constant load.sustainable_poweris only
an estimate, which is the reason for closed-loop control such as this.Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +2
-1-Expanding `k_pu` we get: +Expanding `k_pu` we get:: +P_max = 2 *
sustainable_power* (T_set- T) / (T_set-T_on) + - sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +5
-4-where - T_set is the desired temperature - T is the current temperature - T_on is the switch on temperature +where: + + - T_set is the desired temperature + - T is the current temperature + - T_on is the switch on temperature
When the current temperature is theswitch_ontemperature, the aboveDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-formula becomes: +formula becomes::
P_max = 2 *sustainable_power* (T_set-T_on) / (T_set-T_on) +
- sustainable_power = 2 *sustainable_power+sustainable_power=
- 3 *sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ sustainable_power = 2 * sustainable_power +
sustainable_power=Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ 3 * sustainable_power
Therefore, the proportional term alone linearly decreases power from 3 *sustainable_powertosustainable_poweras the temperatureDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -178,11 +181,18 @@ Cooling device power APICooling devices controlled by this governor must supply the additional
"power" API in theircooling_device_ops. It consists on three ops:
-1. int get_requested_power(structthermal_cooling_device*cdev,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +4
-4- struct thermal_zone_device *tz, u32 *power); -@cdev: The `struct thermal_cooling_device` pointer -@tz: thermal zone in which we are currently operating -@power: pointer in which to store the calculated power +1. :: + + int get_requested_power(struct thermal_cooling_device *cdev, + struct thermal_zone_device *tz, u32*power);
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-0+ + +@cdev: + The `struct thermal_cooling_device` pointer +@tz: + thermal zone in which we are currently operating +@power: + pointer in which to store the calculated power
get_requested_power()calculates the power requested by the device in milliwatts and stores it in @power . It should return 0 onDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -190,23 +200,37 @@ success, -E* on failure. This is currentlyused by the power
allocator governor to calculate how much power to give to each cooling
device.
-2. int state2power(structthermal_cooling_device*cdev, struct - thermal_zone_device *tz, unsigned long state, u32 *power); -@cdev: Thestruct thermal_cooling_devicepointer -@tz: thermal zone in which we are currently operating -@state: A cooling device state
-@power: pointer in which to store the equivalent power +2. ::Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-0+ + int state2power(struct thermal_cooling_device *cdev, struct + thermal_zone_device *tz, unsigned longstate,
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +10
-0+ u32 *power); + +@cdev: + The `struct thermal_cooling_device` pointer +@tz: + thermal zone in which we are currently operating +@state: + A cooling device state +@power: + pointer in which to store the equivalent power
Convert cooling device state @state into power consumption in milliwatts and store it in @power. It should return 0 on success, -E*
on failure. This is currently used by thermal core to calculate the maximum power that an actor can consume.
-3. int power2state(structthermal_cooling_device*cdev, u32 power,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-4- unsigned long *state); -@cdev: The `struct thermal_cooling_device` pointer -@power: power in milliwatts -@state: pointer in which to store the resulting state +3. :: + + int power2state(struct thermal_cooling_device *cdev, u32power,
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-0+ unsigned long *state); + +@cdev: + The `struct thermal_cooling_device` pointer +@power: + power in milliwatts +@state: + pointer in which to store the resulting state
Calculate a cooling device state that would make the device consume at
most @power mW and store it in @state. It should return 0 on success,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0@@ -1,3 +1,4 @@ +===================================Generic Thermal Sysfs driver How To
===================================Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -9,6 +10,7 @@ Copyright (c) 2008 Intel Corporation
0. Introduction
+===============
The generic thermal sysfs provides a set of interfaces for thermal zone
devices (sensors) and thermal cooling devices (fan, processor...) to registerDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -25,59 +27,90 @@ An intelligent thermal management application canmake decisions based on
inputs from thermal zone attributes (the current temperature and trip point
temperature) and throttle appropriate devices.
-[0-*] denotes any positive number starting from 0
-[1-*] denotes any positive number starting from 1+- `[0-*]` denotes any positive number starting from 0 +- `[1-*]` denotes any positive number starting from 1
1. thermal sysfs driver interface functions
+===========================================
1.1 thermal zone device interface
-1.1.1 structthermal_zone_device*thermal_zone_device_register(char *type,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-4- int trips, int mask, void *devdata, - struct thermal_zone_device_ops *ops, - const struct thermal_zone_params *tzp, - int passive_delay, int polling_delay)) +--------------------------------- + + :: + + struct thermal_zone_device + *thermal_zone_device_register(char *type, + int trips, int mask, void*devdata,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct thermal_zone_device_ops*ops,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ const struct
thermal_zone_params*tzp,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ int passive_delay, int
polling_delay))
This interface function adds a new thermal zone device (sensor) to
- /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
+ /sys/class/thermal folder asthermal_zone[0-*]. It tries to bind all the
thermal cooling devices registered at the same time.
- type: the thermal zone type.
- trips: the total number of trip points this thermal zone supports.
- mask: Bit string: If 'n'th bit is set, then trip point 'n' is writeable.
- devdata: device private data
- ops: thermal zone device call-backs.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .bind: bind the thermal zone device with a thermal coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .unbind: unbind the thermal zone device with a thermalcooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- .get_temp: get the current temperature of the thermal zone. - .set_trips: set the trip points window. Whenever the currenttemperature
+ type:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ the thermal zone type. + trips: + the total number of trip points this thermal zone supports. + mask: + Bit string: If 'n'th bit is set, then trip point 'n' iswriteable.
+ devdata:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +6
-0+ device private data + ops: + thermal zone device call-backs. + + .bind: + bind the thermal zone device with a thermal coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .unbind: + unbind the thermal zone device with a thermalcooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ .get_temp: + get the current temperature of the thermal zone. + .set_trips: + set the trip points window. Whenever the currenttemperature
is updated, the trip points immediately below and above the
current temperature are found.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_mode: get the current mode (enabled/disabled) of thethermal zone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- - "enabled" means the kernel thermal management isenabled.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- - "disabled" will prevent kernel thermal driver actionupon trip points
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- so that user applications can take charge of thermalmanagement.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_mode: set the mode (enabled/disabled) of the thermalzone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- .get_trip_type: get the type of certain trip point. - .get_trip_temp: get the temperature above which the certaintrip point
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .get_mode: + get the current mode (enabled/disabled) of thethermal zone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ + - "enabled" means the kernel thermalmanagement is
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ enabled. + - "disabled" will prevent kernel thermaldriver action
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ upon trip points so that user applicationscan take
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ charge of thermal management. + .set_mode: + set the mode (enabled/disabled) of the thermal zone. + .get_trip_type: + get the type of certain trip point. + .get_trip_temp: + get the temperature above which the certaintrip point
will be fired.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_emul_temp: set the emulation temperature which helps indebugging
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .set_emul_temp: + set the emulation temperature which helps indebugging
different threshold temperature points. - tzp: thermal zone platform parameters.
- passive_delay: number of milliseconds to wait between polls when + tzp:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ thermal zone platform parameters. + passive_delay: + number of milliseconds to wait between polls whenperforming passive cooling.
- polling_delay: number of milliseconds to wait between polls when checking
+ polling_delay:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ number of milliseconds to wait between polls when checkingwhether trip points have been crossed (0 for interrupt driven systems).
+ ::
-1.1.2 voidthermal_zone_device_unregister(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ void thermal_zone_device_unregister(struct
thermal_zone_device*tz)
This interface function removes the thermal zone device. It deletes the corresponding entry from/sys/class/thermalfolder and
unbinds all the thermal cooling devices it uses.
-1.1.3 structthermal_zone_device*thermal_zone_of_sensor_register(Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-2- struct device *dev, int sensor_id, void *data, - const struct thermal_zone_of_device_ops *ops) + :: + + struct thermal_zone_device + *thermal_zone_of_sensor_register(struct device *dev, int
sensor_id,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ void *data, + const struct
thermal_zone_of_device_ops*ops)
This interface adds a new sensor to a DT thermal zone. This function will search the list of thermal zones described inDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -87,25 +120,33 @@ temperature) and throttle appropriate devices.thermal zone device.
The parameters for this interface are:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- dev: Device node of sensor containing validnode pointer in
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ + dev: + Device node of sensor containing valid nodepointer in
dev->of_node.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- sensor_id: a sensor identifier, in case the sensor IPhas more
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ sensor_id: + a sensor identifier, in case the sensor IPhas more
than one sensorsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- data: a private pointer (owned by the caller)that will be
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ data: + a private pointer (owned by the caller) thatwill be
passed back, when a temperature reading is needed.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- ops: struct thermal_zone_of_device_ops *. + ops: + `struct thermal_zone_of_device_ops *`.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- get_temp: a pointer to a functionthat reads the
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ ============== =======================================
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ get_temp a pointer to a function thatreads the
sensor temperature. This is mandatory
callback provided by sensor driver.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- set_trips: a pointer to a function thatsets a
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ set_trips a pointer to a functionthat sets a
temperature window. When this window is
left the driver must inform the thermal
core viathermal_zone_device_update.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- get_trend: a pointer to a functionthat reads the
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ get_trend a pointer to a functionthat reads the
sensor temperature trend.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- set_emul_temp: a pointer to afunction that sets
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ set_emul_temp a pointer to a functionthat sets
sensor emulated temperature.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ ============== =======================================
+
The thermal zone temperature is provided by theget_temp()function
pointer ofthermal_zone_of_device_ops. When called, it will have the private pointer @data back.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -114,8 +155,10 @@ temperature) and throttle appropriate devices. handle. Caller should check the return handle with IS_ERR()for finding
whether success or not.
-1.1.4 void thermal_zone_of_sensor_unregister(struct device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- struct thermal_zone_device *tzd) + :: + + void thermal_zone_of_sensor_unregister(struct device*dev,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device*tzd)
This interface unregisters a sensor from a DT thermal zone which was
successfully added by interfacethermal_zone_of_sensor_register().Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -124,21 +167,29 @@ temperature) and throttle appropriate devices.interface. It will also silent the zone by remove the .get_temp() and
get_trend()thermal zone device callbacks.
-1.1.5 structthermal_zone_device*devm_thermal_zone_of_sensor_register(Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- struct device *dev, int sensor_id, - void *data, const struct thermal_zone_of_device_ops*ops)
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ :: + + struct thermal_zone_device + *devm_thermal_zone_of_sensor_register(struct device *dev, + int sensor_id, + void *data, + const struct
thermal_zone_of_device_ops*ops)
This interface is resource managed version ofthermal_zone_of_sensor_register().
+
All details ofthermal_zone_of_sensor_register()described in
section 1.1.3 is applicable here.
+
The benefit of using this interface to register sensor is that it
is not require to explicitly callthermal_zone_of_sensor_unregister()
in error path or during driver unbinding as this is done by driver
resource manager.
-1.1.6 void devm_thermal_zone_of_sensor_unregister(struct device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- struct thermal_zone_device *tzd) + :: + + void devm_thermal_zone_of_sensor_unregister(structdevice *dev,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device*tzd)
This interface is resource managed version ofthermal_zone_of_sensor_unregister().Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -147,123 +198,186 @@ temperature) and throttle appropriatedevices.
Normally this function will not need to be called and the resource
management code will ensure that the resource is freed.
-1.1.7 intthermal_zone_get_slope(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ :: + + int thermal_zone_get_slope(struct
thermal_zone_device*tz)
This interface is used to read the slope attribute value for the thermal zone device, which might be useful for platform
drivers for temperature calculations.
-1.1.8 intthermal_zone_get_offset(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ :: + + int thermal_zone_get_offset(struct
thermal_zone_device*tz)
This interface is used to read the offset attribute value for the thermal zone device, which might be useful for platform
drivers for temperature calculations.
1.2 thermal cooling device interface
-1.2.1 structthermal_cooling_device*thermal_cooling_device_register(char *name,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +8
-1- void *devdata, struct thermal_cooling_device_ops *) +------------------------------------ + + + :: + + struct thermal_cooling_device + *thermal_cooling_device_register(char *name, + void *devdata, struct
thermal_cooling_device_ops*)
This interface function adds a new thermal cooling device (fan/processor/...)
- to/sys/class/thermal/folder as cooling_device[0-*]. It tries to bind itself
+ to/sys/class/thermal/folder ascooling_device[0-*]. It tries to bind itself
to all the thermal zone devices registered at the same time. - name: the cooling device name.
- devdata: device private data.
- ops: thermal cooling devices call-backs.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_max_state: get the Maximum throttle state of thecooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_cur_state: get the Currently requested throttle stateof the cooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_cur_state: set the Current throttle state of thecooling device.
-
-1.2.2 voidthermal_cooling_device_unregister(struct thermal_cooling_device *cdev)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +10
-0+ + name: + the cooling device name. + devdata: + device private data. + ops: + thermal cooling devices call-backs. + + .get_max_state: + get the Maximum throttle state of the coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ .get_cur_state: + get the Currently requested throttle state of the + cooling device. + .set_cur_state: + set the Current throttle state of the coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ + :: + + void thermal_cooling_device_unregister(struct
thermal_cooling_device*cdev)
This interface function removes the thermal cooling device. It deletes the corresponding entry from/sys/class/thermalfolder and
unbinds itself from all the thermal zone devices using it.
1.3 interface for binding a thermal zone device with a thermal cooling device
-1.3.1 int thermal_zone_bind_cooling_device(structthermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- int trip, struct thermal_cooling_device *cdev, - unsigned long upper, unsigned long lower, unsigned intweight);
+------------------------------------------------------------------
-----------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ + :: + + int thermal_zone_bind_cooling_device(struct
thermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ int trip, struct thermal_cooling_device *cdev, + unsigned long upper, unsigned long lower, unsignedint weight);
This interface function binds a thermal cooling device to a particular trip
point of a thermal zone device.
+
This function is usually called in the thermal zone device .bind callback.
- tz: the thermal zone device
- cdev: thermal cooling device
- trip: indicates which trip point in this thermal zone the cooling device
- is associated with.
- upper:the Maximum cooling state for this trip point. - THERMAL_NO_LIMIT means no upper limit,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + tz: + the thermal zone device + cdev: + thermal cooling device + trip: + indicates which trip point in this thermal zone thecooling device
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ is associated with. + upper: + the Maximum cooling state for this trip point. + THERMAL_NO_LIMIT means no upper limit,and the cooling device can be in
max_state.
- lower:the Minimum cooling state can be used for this trip point. - THERMAL_NO_LIMIT means no lower limit,
+ lower:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ the Minimum cooling state can be used for this trip point. + THERMAL_NO_LIMIT means no lower limit,and the cooling device can be in cooling state 0. - weight: the influence of this cooling device in this thermal - zone. See 1.4.1 below for more information. + weight:
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ the influence of this cooling device in this thermal + zone. See 1.4.1 below for more information.
-1.3.2 int thermal_zone_unbind_cooling_device(structthermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- int trip, struct thermal_cooling_device *cdev); + :: + + int thermal_zone_unbind_cooling_device(struct
thermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ int trip, struct
thermal_cooling_device*cdev);
This interface function unbinds a thermal cooling device from a particular
trip point of a thermal zone device. This function is usually called in
the thermal zone device .unbind callback.
- tz: the thermal zone device
- cdev: thermal cooling device
- trip: indicates which trip point in this thermal zone the cooling device
- is associated with.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + tz: + the thermal zone device + cdev: + thermal cooling device + trip: + indicates which trip point in this thermal zone the coolingdevice
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is associated with.
1.4 Thermal Zone Parameters
-1.4.1 structthermal_bind_params
+---------------------------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + :: + + struct thermal_bind_params +This structure defines the following parameters that are used to bind
a zone with a cooling device for a particular trip point. - .cdev: The cooling device pointer
- .weight: The 'influence' of a particular cooling device on this - zone. This is relative to the rest of the cooling - devices. For example, if all cooling devices have a - weight of 1, then they all contribute the same. You can - use percentages if you want, but it's not mandatory. A - weight of 0 means that this cooling device doesn't - contribute to the cooling of this zone unless all cooling
- devices have a weight of 0. If all weights are 0, then - they all contribute the same.
- .trip_mask:This is a bit mask that gives the binding relation between
- this thermal zone and cdev, for a particular trip point.
- If nth bit is set, then the cdev and thermal zone are bound
- for trip point n.
- .binding_limits: This is an array of cooling state limits. Must have
- exactly 2 * thermal_zone.number_of_trip_points. It is an
- array consisting of tuples <lower-state upper- state> of
- state limits. Each trip will be associated with one state
- limit tuple when binding. A NULL pointer means - <THERMAL_NO_LIMITSTHERMAL_NO_LIMITS> on all trips.
- These limits are used when binding a cdev to a trip point.
- .match: This call back returns success(0) if the 'tz and cdev' need toDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +11
-0+ + .cdev: + The cooling device pointer + .weight: + The 'influence' of a particular cooling device on this + zone. This is relative to the rest of the cooling + devices. For example, if all cooling devices have a + weight of 1, then they all contribute the same. You can + use percentages if you want, but it's not mandatory. A + weight of 0 means that this cooling device doesn't + contribute to the cooling of this zone unless allcooling
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ devices have a weight of 0. If all weights are 0, then + they all contribute the same. + .trip_mask: + This is a bit mask that gives the binding relationbetween
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ this thermal zone and cdev, for a particular trippoint.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ If nth bit is set, then the cdev and thermal zone arebound
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ for trip point n. + .binding_limits: + This is an array of cooling state limits. Musthave
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ exactly 2 * thermal_zone.number_of_trip_points.It is an
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ array consisting of tuples <lower-state upper-state> of
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ state limits. Each trip will be associated withone state
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ limit tuple when binding. A NULL pointer means + <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on alltrips.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ These limits are used when binding a cdev to atrip point.
+ .match:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ This call back returns success(0) if the 'tz and cdev'need to
be bound, as per platform data.
-1.4.2 structthermal_zone_paramsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + :: + + struct thermal_zone_params +This structure defines the platform level parameters for a thermal zone.
This data, for each thermal zone should come from the platform layer.
This is an optional feature where some platforms can choose not to
provide this data.
- .governor_name: Name of the thermal governor used for this zone - .no_hwmon: a boolean to indicate if the thermal to hwmon sysfs interface
- is required. whenno_hwmon== false, a hwmon sysfs interface
- will be created. whenno_hwmon== true, nothing will be done.
- In case thethermal_zone_paramsis NULL, the hwmon interface
- will be created (for backward compatibility). - .num_tbps: Number ofthermal_bind_paramsentries for this zone - .tbp:thermal_bind_paramsentriesDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + .governor_name: + Name of the thermal governor used for this zone + .no_hwmon: + a boolean to indicate if the thermal to hwmon sysfsinterface
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is required. when no_hwmon == false, a hwmon sysfsinterface
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ will be created. when no_hwmon == true, nothing willbe done.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ In case the thermal_zone_params is NULL, the hwmoninterface
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ will be created (for backward compatibility). + .num_tbps: + Number of thermal_bind_params entries for this zone + .tbp: + thermal_bind_params entries
2. sysfs attributes structure
+=============================
+== ================
RO read only value
WO write only value
RW read/write value
+== ================
Thermal sysfs attributes will be represented under/sys/class/thermal.
Hwmon sysfs I/F extension is also available under/sys/class/hwmonif hwmon is compiled in or built as a module.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-2-Thermal zone device sys I/F, created once it's registered: -/sys/class/thermal/thermal_zone[0-*]: +Thermal zone device sys I/F, created once it's registered:: + + /sys/class/thermal/thermal_zone[0-*]:|---type: Type of the thermal zone |---temp: Current temperature |---mode: Working mode of the thermalzone
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -282,8 +396,9 @@ Thermal zone device sys I/F, created once it'sregistered:
|---slope: Slope constant applied as linear extrapolation
|---offset: Offset constant applied as linear extrapolationDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-2-Thermal cooling device sys I/F, created once it's registered: -/sys/class/thermal/cooling_device[0-*]: +Thermal cooling device sys I/F, created once it's registered:: + + /sys/class/thermal/cooling_device[0-*]:|---type: Type of the cooling
device(processor/fan/...)
|---max_state: Maximum cooling state of the
cooling device
|---cur_state: Current cooling state of the
cooling deviceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -299,11 +414,13 @@ the relationship between a thermal zone and itsassociated cooling device.
They are created/removed for each successful execution of thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1-/sys/class/thermal/thermal_zone[0-*]: +:: + + /sys/class/thermal/thermal_zone[0-*]:|---cdev[0-*]: [0-*]th cooling device in current
thermal zone
|---cdev[0-*]_trip_point: Trip point that cdev[0-*] is
associated with
|---cdev[0-*]_weight: Influence of the cooling device in - this thermal zoneDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ this thermal zone
Besides the thermal zone device sysfs I/F and cooling device sysfs I/F,
the generic thermal driver also creates a hwmon sysfs I/F for each _type_Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -311,16 +428,17 @@ of thermal zone device. E.g. the genericthermal driver registers one hwmon
class device and build the associated hwmon sysfs I/F for all the registered
ACPI thermal zones.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1-/sys/class/hwmon/hwmon[0-*]: +:: + + /sys/class/hwmon/hwmon[0-*]:|---name: The type of the thermal zone
devices
|---temp[1-*]_input: The current temperature of thermal
zone [1-*]
|---temp[1-*]_critical: The critical trip point of
thermal zone [1-*]
Please readDocumentation/hwmon/sysfs-interface.rstfor additional information.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-*************************** -* Thermal zone attributes * -*************************** +Thermal zone attributes +-----------------------
type
Strings which represent the thermal zone type.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -340,54 +458,67 @@ modeThis file gives information about the algorithm that is currently
managing the thermal zone. It can be either default kernel based
algorithm or user space application.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- enabled = enable Kernel Thermal management. - disabled = Preventing kernel thermal zone driveractions upon
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + enabled + enable Kernel Thermal management. + disabled + Preventing kernel thermal zone driveractions upon
trip points so that user application can take full
charge of the thermal management. +
RW, Optional
policy
One of the various thermal governors used for a particular zone.
+
RW, Required
available_policies
Available thermal governors which can be used for a particular zone.
+
RO, Required
-trip_point_[0-*]_temp
+trip_point_[0-*]_temp
The temperature above which trip point will be fired. +
Unit: millidegree Celsius
+
RO, Optional
-trip_point_[0-*]_type
+trip_point_[0-*]_type
Strings which indicate the type of the trip point.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- E.g. it can be one of critical, hot, passive, active[0-*]for ACPI
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ + E.g. it can be one of critical, hot, passive, `active[0-*]`for ACPI
thermal zone.
+
RO, Optional
-trip_point_[0-*]_hyst
+trip_point_[0-*]_hyst
The hysteresis value for a trip point, represented as an integer
Unit: Celsius
RW, Optional
-cdev[0-*]
+cdev[0-*]
Sysfs link to the thermal cooling device node where the sys I/F
for cooling device throttling control represents. +
RO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2-cdev[0-*]_trip_point - The trip point in this thermal zone which cdev[0-*] isassociated
+cdev[0-*]_trip_pointDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ The trip point in this thermal zone which `cdev[0-*]` isassociated
with; -1 means the cooling device is not associated with any trip
point.
+
RO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-7-cdev[0-*]_weight - The influence of cdev[0-*] in this thermal zone. This value - is relative to the rest of cooling devices in the thermal - zone. For example, if a cooling device has a weight double - than that of other, it's twice as effective in cooling the - thermal zone. - RW, Optional +`cdev[0-*]_weight` + The influence of `cdev[0-*]` in this thermal zone. Thisvalue
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +6
-0+ is relative to the rest of cooling devices in the thermal + zone. For example, if a cooling device has a weight double + than that of other, it's twice as effective in cooling the + thermal zone. + + RW, Optional
passive
Attribute is only present for zones in which the passive coolingDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -395,8 +526,11 @@ passiveand can be set to a temperature (in millidegrees) to enable a
passive trip point for the zone. Activation is done by polling with
an interval of 1 second.
+
Unit: millidegrees Celsius
+
Valid values: 0 (disabled) or greater than 1000 +
RW, Optional
emul_tempDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -407,17 +541,21 @@ emul_tempthreshold and its associated cooling action. This is write only node
and writing 0 on this node should disable emulation.
Unit: millidegree Celsius
+
WO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- WARNING: Be careful while enabling this option onproduction systems,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- because userland can easily disable the thermal policy bysimply
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- flooding this sysfs node with low temperature values. + WARNING: + Be careful while enabling this option on productionsystems,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ because userland can easily disable the thermal policyby simply
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ flooding this sysfs node with low temperature values.
sustainable_power
An estimate of the sustained power that can be dissipated by the thermal zone. Used by the power allocator governor. ForDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- more information see
Documentation/thermal/power_allocator.txtDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ more information see
Documentation/thermal/power_allocator.rst
+
Unit: milliwatts
+
RW, Optional
k_poDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -425,7 +563,8 @@ k_pocontroller during temperature overshoot. Temperature overshoot
is when the current temperature is above the "desired temperature" trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_puDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -433,20 +572,23 @@ k_pucontroller during temperature undershoot. Temperature undershoot
is when the current temperature is below the "desired temperature" trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_i
The integral term of the power allocator governor's PID controller. This term allows the PID controller to compensate
for long term drift. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_d
The derivative term of the power allocator governor's PID controller. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
integral_cutoffDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -456,8 +598,10 @@ integral_cutoffexample, if
integral_cutoffis 0, then the integral term only
accumulates error when temperature is above the desired temperature trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +Unit: millidegree Celsius
+
RW, Optional
slopeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -465,6 +609,7 @@ slopeto determine a hotspot temperature based off the sensor's raw readings. It is up to the device driver to determine the usage of these values.
+
RW, Optional
offsetDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -472,28 +617,33 @@ offsetto determine a hotspot temperature based off the sensor's raw readings. It is up to the device driver to determine the usage of these values.
+
RW, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-***************************** -* Cooling device attributes * -***************************** +Cooling device attributes +-------------------------
type
String which represents the type of device, e.g:
+
- for generic ACPI: should be "Fan", "Processor" or "LCD"
- for memory controller device onintel_menlowplatform:
should be "Memory controller".
+
RO, Required
max_state
The maximum permissible cooling state of this cooling device.
+
RO, Required
cur_state
The current cooling state of this cooling device. The value can any integer numbers between 0 andmax_state:
+
-cur_state== 0 means no cooling
-cur_state==max_statemeans the maximum cooling. +
RW, Required
stats/resetDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -508,9 +658,11 @@ stats/time_in_state_ms:units here is 10mS (similar to other time exported in /proc).
RO, Required
+
stats/total_trans:
A single positive value showing the total number of times the state of a
cooling device is changed.
+
RO, Required
stats/trans_table:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -522,6 +674,7 @@ stats/trans_table:RO, Required
3. A simple implementation
+==========================
ACPI thermal zone may support multiple trip points like critical, hot,
passive, active. If an ACPI thermal zone supports critical, passive,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -532,11 +685,10 @@ thermal_cooling_device. Both are considered tohave the same
effectiveness in cooling the thermal zone.
If the processor is listed in_PSLmethod, and the fan is listed in_AL0Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-1-method, the sys I/F structure will be built like this: +method, the sys I/F structure will be built like this::Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-/sys/class/thermal: - -|thermal_zone1: + /sys/class/thermal: + |thermal_zone1:|---type: acpitz |---temp: 37000 |---mode: enabledDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -557,24 +709,24 @@ method, the sys I/F structure will be builtlike this:
|---cdev1_trip_point: 2 /* cdev1 can be used for
active[0]*/
|---cdev1_weight: 1024
-|cooling_device0:
+ |cooling_device0:|---type: Processor |---max_state: 8 |---cur_state: 0 -|cooling_device3: + |cooling_device3: |---type: Fan |---max_state: 2 |---cur_state: 0Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-/sys/class/hwmon: - -|hwmon0: + /sys/class/hwmon: + |hwmon0:|---name: acpitz |---temp1_input: 37000 |---temp1_crit: 100000
4. Event Notification
+=====================
The framework includes a simple notification mechanism, in the form of a
netlink event. Netlink socket initialization is done during the _init_Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -587,21 +739,28 @@ event will be one of:{THERMAL_AUX0, THERMAL_AUX1, THERMAL_CRITICAL,THERMAL_DEV_FAULT}. Notification can be sent when the current temperature
crosses any of the configured thresholds.
-5. Export Symbol APIs:
+5. Export Symbol APIs
+=====================
+
+5.1.get_tz_trend
+-----------------
-5.1:get_tz_trend:
This function returns the trend of a thermal zone, i.e the rate of change
of temperature of the thermal zone. Ideally, the thermal sensor drivers
are supposed to implement the callback. If they don't, the thermal framework calculated the trend by comparing the previous and the current
temperature values.
-5.2:get_thermal_instance:
+5.2.get_thermal_instance
+-------------------------
+
This function returns thethermal_instancecorresponding to a given {thermal_zone,cooling_device,trip_point} combination. Returns NULL if such an instance does not exist.
-5.3:thermal_notify_framework:
+5.3.thermal_notify_framework
+-----------------------------
+
This function handles the trip events from sensor drivers. It starts throttling the cooling devices according to the policy configured. For CRITICAL and HOT trip points, this notifies the respective drivers,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -609,12 +768,15 @@ and does actual throttling for other trippoints i.e ACTIVE and PASSIVE.
The throttling policy is based on the configured platform data; if no
platform data is provided, this uses thestep_wisethrottling policy.
-5.4:thermal_cdev_update:
+5.4.thermal_cdev_update
+------------------------
+
This function serves as an arbitrator to set the state of a cooling device. It sets the cooling device to the deepest cooling state if possible.
-6.thermal_emergency_poweroff:
+6.thermal_emergency_poweroff
+=============================
On an event of critical trip temperature crossing. Thermal framework allows the system to shutdown gracefully by callingorderly_poweroff().Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +1
-0@@ -1,19 +1,23 @@ +===================================Kernel driver:
x86_pkg_temp_thermal
-===================
+===================================
Supported chips:
+
* x86: with package level thermal management
+
(Verify using: CPUID.06H:EAX[bit 6] =1)
Authors: Srinivas Pandruvada <[email protected]>
Reference
----
+---------
+
Intel® 64 and IA-32 Architectures Software Developer’s Manual (Jan, 2013):
Chapter 14.6: PACKAGE LEVEL THERMAL MANAGEMENT
Description
----------
+-----------
This driver register CPU digital temperature package level sensor as a thermal
zone with maximum two user mode configurable trip points. Number of trip pointsDocumentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +0
-0@@ -25,23 +29,27 @@ take any action to control temperature.Threshold management
--------------------
Each package will register as a thermal zone under/sys/class/thermal.Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +4
-2-Example: -/sys/class/thermal/thermal_zone1 + +Example:: + + /sys/class/thermal/thermal_zone1
This contains two trip points:
+
-trip_point_0_temp
-trip_point_1_temp
User can set any temperature between 0 to TJ-Max temperature. Temperature units
-are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.txt" for
+are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for
thermal sys-fs details.
Any value other than 0 in these trip points, can trigger thermal notifications.
Setting 0, stops sending thermal notifications.
-Thermal notifications: To get kobject-uevent notifications, set the thermal zoneDocumentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +3
-3-policy to "user_space". For example: echo -n "user_space" > policy - - +Thermal notifications: +To get kobject-uevent notifications, set the thermal zone +policy to "user_space".
+For example::Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +1
-0+ echo -n "user_space" > policyMAINTAINERS +0
-0@@ -15687,7 +15687,7 @@ M: Viresh Kumar <[email protected]rg>
M: Javi Merino <[email protected]>
L: [email protected]
S: SupportedMAINTAINERS +1
-1-F: Documentation/thermal/cpu-cooling-api.txt +F: Documentation/thermal/cpu-cooling-api.rstF:
drivers/thermal/cpu_cooling.c
F:include/linux/cpu_cooling.hinclude/linux/thermal.h +0
-1@@ -251,7 +251,7 @@ struct thermal_bind_params { * platform characterization. This value is relative to the * rest of the weights so a cooling device whose weight is * double that of another cooling device is twice as - * effective. See Documentation/thermal/sysfs-api.txt formore
include/linux/thermal.h +1
-0+ * effective. See Documentation/thermal/sysfs-api.rst formore
* information.
*/
int weight;include/linux/thermal.h +0
-0@@ -259,7 +259,7 @@ struct thermal_bind_params { /** This is a bit mask that gives the binding relation between this
Quoted 8 lines
Quoted 8 lines
* thermal zone and cdev, for a particular trip point.
include/linux/thermal.h +0
-1- * See Documentation/thermal/sysfs-api.txt for moreinformation.
include/linux/thermal.h +1
-0+ * See Documentation/thermal/sysfs-api.rst for moreinformation.
*/
inttrip_mask;
Thanks,
Mauro
Zhang Rui
reviewerRe: [PATCH v1 04/22] docs: thermal: convert to ReST
Quoted 15 lines · Mauro Carvalho Chehab
Em Tue, 25 Jun 2019 21:40:11 +0800
Zhang Rui <[email protected]> escreveu:Quoted 12 lines · Mauro Carvalho Chehab
Quoted 10 lines
Rename the thermal 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.
Quoted 9 lines
Quoted 6 lines
Quoted 2 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>Acked-by Zhang Rui <[email protected]>should I apply this patch or you have a separate tree for all these changes?
Feel free to apply it directly to your tree. The patches on this series are pretty much independent.
okay, queued for 5.3-rc1.
thanks,
rui
Quoted 2,714 lines
Quoted 2,702 lines
thanks,
ruiQuoted 2,698 lines
---
...pu-cooling-api.txt =>cpu-cooling-api.rst} | 39 +- .../{exynos_thermal => exynos_thermal.rst} | 47 +- ...emulation =>exynos_thermal_emulation.rst} | 66 +-- Documentation/thermal/index.rst | 18 + ...el_powerclamp.txt =>intel_powerclamp.rst} | 177 +++---- .../{nouveau_thermal => nouveau_thermal.rst} | 54 +- ...ower_allocator.txt =>power_allocator.rst} | 140 ++---.../thermal/{sysfs-api.txt=> sysfs-api.rst} | 490
++++++++++++--
----
...hermal =>x86_pkg_temperature_thermal.rst} | 28 +- MAINTAINERS | 2 +- include/linux/thermal.h | 4 +-11 files changed, 665 insertions(+), 400 deletions(-)rename
Documentation/thermal/{cpu-cooling-api.txt=> cpu- cooling-api.rst} (82%)
renameDocumentation/thermal/{exynos_thermal=>exynos_thermal.rst}
(67%)
renameDocumentation/thermal/{exynos_thermal_emulation=>exynos_thermal_emulation.rst} (36%)
create mode 100644Documentation/thermal/index.rstrenameDocumentation/thermal/{intel_powerclamp.txt=>intel_powerclamp.rst} (76%)
renameDocumentation/thermal/{nouveau_thermal=>nouveau_thermal.rst} (64%)
renameDocumentation/thermal/{power_allocator.txt=>power_allocator.rst} (74%)
renameDocumentation/thermal/{sysfs-api.txt=>sysfs-api.rst} (66%)
renameDocumentation/thermal/{x86_pkg_temperature_thermal=>x86_pkg_temperature_thermal.rst} (80%)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0@@ -1,5 +1,6 @@ +=======================CPU cooling APIs How To
-===================================
+=======================
Written by Amit Daniel Kachhap <[email protected]>Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -8,40 +9,54 @@ Updated: 6 Jan 2015Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.sams ung.
com)
0. Introduction
+===============
The generic cpu cooling(freq clipping) provides registration/unregistration APIs
to the caller. The binding of the cooling devices to the trip point
is left for
the user. The registration APIs returns the cooling device pointer.
1. cpu cooling APIs
+===================
1.1 cpufreq registration/unregistration APIs
-1.1.1 structthermal_cooling_device*cpufreq_cooling_register(Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +6
-1- struct cpumask *clip_cpus) +-------------------------------------------- + + :: + + struct thermal_cooling_device + *cpufreq_cooling_register(struct cpumask *clip_cpus)
This interface function registers the cpufreq cooling device with the name
"thermal-cpufreq-%x". This api can support multiple instances of
cpufreq
cooling devices.
- clip_cpus: cpumask of cpus where the frequency constraints will
happen.
+ clip_cpus:Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0+ cpumask of cpus where the frequency constraints willhappen.
-1.1.2 structthermal_cooling_device
*of_cpufreq_cooling_register(Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-1- struct cpufreq_policy*policy)
+ ::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +3
-0+ + struct thermal_cooling_device + *of_cpufreq_cooling_register(struct cpufreq_policy*policy)
This interface function registers the cpufreq cooling device with
the name "thermal-cpufreq-%x" linking it with a device tree node, in
order to bind it via the thermal DT code. This api can support
multiple
instances of cpufreq cooling devices.
- policy: CPUFreq policy.
+ policy:Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-0+ CPUFreq policy.
-1.1.3 void cpufreq_cooling_unregister(structthermal_cooling_device
*cdev)Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +4
-0+ + :: + + void cpufreq_cooling_unregister(struct
thermal_cooling_device*cdev)
This interface function unregisters the "thermal-cpufreq-%x" cooling device.
cdev: Cooling device pointer which has to be unregistered.
2. Power models
+===============
The power API registration functions provide a simple power model
for
CPUs. The current power is calculated as dynamic power (static power isn'tDocumentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -65,9 +80,9 @@ For a given processor implementation theprimary
factors are:
variation. In pathological cases this variation can be significant,
but typically it is of a much lesser impact than the factors above.
-A high level dynamic power consumption model may then be represented
as:
+A high level dynamic power consumption model may then be represented
as::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-Pdyn = f(run) * Voltage^2 * Frequency * Utilisation + Pdyn = f(run) * Voltage^2 * Frequency * Utilisation
f(run) here represents the described execution behaviour and its result has a units of Watts/Hz/Volt^2 (this often expressed inDocumentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +0
-0@@ -80,9 +95,9 @@ factors. Therefore, in initial implementationthat
contribution is
represented as a constant coefficient. This is a simplification consistent with the relative contribution to overall power variation.Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-In this simplified representation our model becomes: +In this simplified representation our model becomes::Documentation/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.txt +1
-1-Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation + Pdyn = Capacitance * Voltage^2 * Frequency * Utilisation
Wherecapacitanceis a constant that represents an indicative running time dynamic power coefficient in fundamental units ofDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +1
-0@@ -1,8 +1,11 @@ +========================Kernel driver
exynos_tmu
-=================
+========================
Supported chips:
+
* ARM SAMSUNG EXYNOS4, EXYNOS5 series of SoC
+
Datasheet: Not publicly available
Authors: Donggeun Kim <[email protected]>Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +0
-0@@ -19,32 +22,39 @@ Temperature can be taken from the temperaturecode.
There are three equations converting from temperature to temperature
code.
The three equations are:
- 1. Two point trimming
+ 1. Two point trimming::
+
Tc = (T - 25) * (TI2 - TI1) / (85 - 25) + TI1
- 2. One point trimming
+ 2. One point trimming::
+
Tc = T + TI1 - 25
- 3. No trimming
+ 3. No trimming::
+
Tc = T + 50
- Tc: Temperature code, T: Temperature,
- TI1: Trimming info for 25 degree Celsius (stored at TRIMINFO register)
+ Tc:
+ Temperature code, T: Temperature,
+ TI1:
+ Trimming info for 25 degree Celsius (stored at TRIMINFO register)
Temperature code measured at 25 degree Celsius which is unchanged
- TI2: Trimming info for 85 degree Celsius (stored at TRIMINFO register)
+ TI2:
+ Trimming info for 85 degree Celsius (stored at TRIMINFO register)
Temperature code measured at 85 degree Celsius which is unchanged
TMU(Thermal Management Unit) in EXYNOS4/5 generates interrupt when temperature exceeds pre-defined levels.
The maximum number of configurable threshold is five.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-1-The threshold levels are defined as follows: +The threshold levels are defined as follows:: +Level_0: current temperature >
trigger_level_0+ threshold
Level_1: current temperature >trigger_level_1+ threshold
Level_2: current temperature >trigger_level_2+ threshold
Level_3: current temperature >trigger_level_3+ threshold
- The threshold and eachtrigger_levelare set
- through the corresponding registers.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+The threshold and each trigger_level are set +through the corresponding registers.
When an interrupt occurs, this driver notify kernel thermal framework
with the functionexynos_report_trigger.Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +0
-0@@ -54,24 +64,27 @@ it can be used to synchronize the coolingaction.
TMU driver description:
-----------------------Documentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +1
-1-The exynos thermal driver is structured as, +The exynos thermal driver is structured as::
Kernel Core thermal framework
(thermal_core.c,step_wise.c,cpu_cooling.c)
^
|
|
-TMU configuration data -------> TMU Driver <------> Exynos Core thermal wrapper
-(exynos_tmu_data.c) (exynos_tmu.c) (exynos_thermal_common.c)
-(exynos_tmu_data.h) (exynos_tmu.h) (exynos_thermal_common.h)
+ TMU configuration data -----> TMU Driver <----> Exynos Core thermal wrapper
+ (exynos_tmu_data.c) (exynos_tmu.c) (exynos_thermal_common.c)
+ (exynos_tmu_data.h) (exynos_tmu.h) (exynos_thermal_common.h)
-a) TMU configuration data: This consist of TMU register offsets/bitfieldsDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+a) TMU configuration data: + This consist of TMU register offsets/bitfieldsdescribed through structure
exynos_tmu_registers.
Also several
other platform data (structexynos_tmu_platform_data) members
are used to configure the TMU.
-b) TMU driver: This component initialises the TMU controller and sets differentDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+b) TMU driver: + This component initialises the TMU controllerand
sets different
thresholds. It invokes core thermal implementation
with the call
exynos_report_trigger.
-c) Exynos Core thermal wrapper: This provides 3 wrapper function to
use theDocumentation/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal +2
-0+c) Exynos Core thermal wrapper: + This provides 3 wrapper function to use theKernel core thermal framework. They are
exynos_unregister_thermal,exynos_register_thermalandexynos_report_trigger.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-2@@ -1,5 +1,6 @@ -EXYNOS EMULATION MODE -======================== +===================== +Exynos Emulation Mode +=====================
Copyright (C) 2012 Samsung ElectronicsDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-0@@ -8,46 +9,53 @@ Written by Jonghwa Lee <[email protected]m>
Description
-----------
-Exynos 4x12 (4212, 4412) and 5 series provide emulation mode for thermal management unit.
-Thermal emulation mode supports software debug for TMU's operation.
User can set temperature
-manually with software code and TMU will read current temperature
from user value not fromDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-1-sensor's value. +Exynos 4x12 (4212, 4412) and 5 series provide emulation mode forthermal
+management unit. Thermal emulation mode supports software debug for
+TMU's operation. User can set temperature manually with software code
+and TMU will read current temperature from user value not from sensor's
+value.
-EnablingCONFIG_THERMAL_EMULATIONoption will make this support available.Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-1-When it's enabled, sysfs node will be created as +Enabling CONFIG_THERMAL_EMULATION option will make this support +available. When it's enabled, sysfs node will be created as/sys/devices/virtual/thermal/thermal_zone'zone id'/emul_temp.
-The sysfs node, 'emul_node', will contain value 0 for the initial
state. When you input any
-temperature you want to update to sysfs node, it automatically enable emulation mode andDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-2-current temperature will be changed into it. -(Exynos also supports user changeable delay time which would beused
to delay of
- changing temperature. However, this node only uses same delay of
real sensing time, 938us.)
+The sysfs node, 'emul_node', will contain value 0 for the initial
state.
+When you input any temperature you want to update to sysfs node, it
+automatically enable emulation mode and current temperature will be
+changed into it.
-Exynos emulation mode requires synchronous of value changing and enabling. It means when you
-want to update the any value of delay or next temperature, then you
have to enable emulation
-mode at the same time. (Or you have to keep the mode enabling.) If
you don't, it fails to
-change the value to updated one and just use last succeessful value
repeatedly. That's why
-this node gives users the right to change termerpature only. Just
one interface makes it moreDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-1-simply to use. +(Exynos also supports user changeable delay time which would beused
to
+delay of changing temperature. However, this node only uses same delayDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +4
-0+of real sensing time, 938us.) + +Exynos emulation mode requires synchronous of value changing and +enabling. It means when you want to update the any value ofdelay or
+next temperature, then you have to enable emulation mode at the same
+time. (Or you have to keep the mode enabling.) If you don't, it fails to
+change the value to updated one and just use last succeessful valueDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-0+repeatedly. That's why this node gives users the right to change +termerpature only. Just one interface makes it more simply touse.
Disabling emulation mode only requires writing value 0 to sysfs node.
+::Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +2
-1-TEMP 120 | + + TEMP 120 ||
100 |
|
80 |Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-3- | +----------- - 60 | | | - | +-------------| | + | +----------- + 60 | | | + | +-------------| |40 | | | |
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-1- | | ||
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-1- 20 | | |+-
---------Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-1- | | ||
|Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +3
-2+ | | | | + 20 | | | + ---- ------ + | | | |
|
0Quoted 2 lines
______________|_____________|__________|__________|_________
Documentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +0
-1- A A A
A TIMEDocumentation/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation +1
-0+ A A A
A TIME
|<----->| |<----->| |<----->|
|
| 938us | | | | |
|
-emulation : 0 50 | 70 | 20 |
0
-current temp : sensor 50 70 20
sensor
+ emulation : 0 50 | 70 | 20 |
0
+ current temp: sensor 50 70 20
sensorDocumentation/thermal/index.rst new file +18
-0@@ -0,0 +1,18 @@ +:orphan: + +======= +Thermal +======= + +.. toctree:: + :maxdepth: 1 + + cpu-cooling-api + sysfs-api + power_allocator + + exynos_thermal + exynos_thermal_emulation + intel_powerclamp + nouveau_thermal + x86_pkg_temperature_thermalDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +9
-5@@ -1,10 +1,13 @@ - ======================= - INTEL POWERCLAMP DRIVER - ======================= -By: Arjan van de Ven <[email protected]> - Jacob Pan <[email protected]> +======================= +Intel Powerclamp Driver +======================= + +By: + - Arjan van de Ven <[email protected]> + - Jacob Pan <[email protected]> + +.. Contents:
-Contents:
(*) Introduction
- Goals and ObjectivesDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -23,7 +26,6 @@ Contents: - Generic Thermal Layer (sysfs) - Kernel APIs (TBD)
-============
INTRODUCTION
============Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -47,7 +49,6 @@ scalability, and user experience. In many cases,clear advantage is
shown over taking the CPU offline or modulating the CPU clock.
-===================
THEORY OF OPERATION
===================Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -57,11 +58,12 @@ Idle InjectionOn modern Intel processors (Nehalem or later), package level C- state
residency is available in MSRs, thus also available to the kernel.Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +6
-5-These MSRs are: - #define MSR_PKG_C2_RESIDENCY 0x60D - #define MSR_PKG_C3_RESIDENCY 0x3F8 - #define MSR_PKG_C6_RESIDENCY 0x3F9 - #define MSR_PKG_C7_RESIDENCY 0x3FA +These MSRs are:: + + #define MSR_PKG_C2_RESIDENCY 0x60D + #define MSR_PKG_C3_RESIDENCY 0x3F8 + #define MSR_PKG_C6_RESIDENCY 0x3F9 + #define MSR_PKG_C7_RESIDENCY 0x3FA
If the kernel can also inject idle time to the system, then a closed-loop control system can be established that manages packageDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -96,19 +98,21 @@ are not masked. Tests show that the extrawakeups
from scheduler tick
have a dramatic impact on the effectiveness of the powerclamp driver
on large scale systems (Westmere system with 80 processors).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +15
-13-CPU0 - ____________ ____________ -kidle_inject/0 | sleep | mwait | sleep | - _________| |________| |_______ - duration -CPU1 - ____________ ____________ -kidle_inject/1 | sleep | mwait | sleep | - _________| |________| |_______ - ^ - | - | - roundup(jiffies, interval) +:: + + CPU0 + ____________ ____________ + kidle_inject/0 | sleep | mwait | sleep | + _________| |________| |_______ + duration + CPU1 + ____________ ____________ + kidle_inject/1 | sleep | mwait | sleep | + _________| |________| |_______ + ^ + | + | + roundup(jiffies, interval)
Only one CPU is allowed to collect statistics and update global control parameters. This CPU is referred to as the controlling CPU
inDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -148,7 +152,7 @@ b) determine the amount of compensationneeded at
each target ratio
Compensation to each target ratio consists of two parts:
- a) steady state error compensationDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +1
-0+ a) steady state error compensationThis is to offset the error occurring when the system can
enter idle without extra wakeups (such as external interrupts).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -158,41 +162,42 @@ Compensation to each target ratio consistsof
two parts:
slowing down CPU activities.
A debugfs file is provided for the user to examine compensationDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +36
-35-progress and results, such as on a Westmere system. -[jacob@nex01 ~]$ cat -/sys/kernel/debug/intel_powerclamp/powerclamp_calib -controlling cpu: 0 -pct confidence steady dynamic (compensation) -0 0 0 0 -1 1 0 0 -2 1 1 0 -3 3 1 0 -4 3 1 0 -5 3 1 0 -6 3 1 0 -7 3 1 0 -8 3 1 0 -... -30 3 2 0 -31 3 2 0 -32 3 1 0 -33 3 2 0 -34 3 1 0 -35 3 2 0 -36 3 1 0 -37 3 2 0 -38 3 1 0 -39 3 2 0 -40 3 3 0 -41 3 1 0 -42 3 2 0 -43 3 1 0 -44 3 1 0 -45 3 2 0 -46 3 3 0 -47 3 0 0 -48 3 2 0 -49 3 3 0 +progress and results, such as on a Westmere system:: + + [jacob@nex01 ~]$ cat + /sys/kernel/debug/intel_powerclamp/powerclamp_calib + controlling cpu: 0 + pct confidence steady dynamic (compensation) + 0 0 0 0 + 1 1 0 0 + 2 1 1 0 + 3 3 1 0 + 4 3 1 0 + 5 3 1 0 + 6 3 1 0 + 7 3 1 0 + 8 3 1 0 + ... + 30 3 2 0 + 31 3 2 0 + 32 3 1 0 + 33 3 2 0 + 34 3 1 0 + 35 3 2 0 + 36 3 1 0 + 37 3 2 0 + 38 3 1 0 + 39 3 2 0 + 40 3 3 0 + 41 3 1 0 + 42 3 2 0 + 43 3 1 0 + 44 3 1 0 + 45 3 2 0 + 46 3 3 0 + 47 3 0 0 + 48 3 2 0 + 49 3 3 0
Calibration occurs during runtime. No offline method is available.
Steady state compensation is used only when confidence levels of allDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -217,9 +222,8 @@ keeps track of clamping kernel threads, evenafter they are migrated
to other CPUs, after a CPU offline event.
-=====================
Performance Analysis
-=====================
+====================
This section describes the general performance data collected on multiple systems, including Westmere (80P) and Ivy Bridge (4P, 8P).Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -257,16 +261,15 @@ achieve up to 40% better performance perwatt.
(measured by a spin
counter summed over per CPU counting threads spawned for all running
CPUs).
-====================
Usage and Interfaces
====================
The powerclamp driver is registered to the generic thermal layer as
aDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +1
-1-cooling device. Currently, it’s not bound to any thermal zones. +cooling device. Currently, it’s not bound to any thermal zones::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +4
-4-jacob@chromoly:/sys/class/thermal/cooling_device14$ grep . * -cur_state:0 -max_state:50 -type:intel_powerclamp + jacob@chromoly:/sys/class/thermal/cooling_device14$ grep . * + cur_state:0 + max_state:50 + type:intel_powerclamp
cur_state allows user to set the desired idle percentage. Writing 0
to
cur_state will stop idle injection. Writing a value between 1 andDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -278,9 +281,9 @@ cur_state returns value -1 instead of 0 whichis
to avoid confusing
100% busy state with the disabled state.
Example usage:
-- To inject 25% idle time
-$ sudo sh -c "echo 25 >/sys/class/thermal/cooling_device80/cur_state
-"
+- To inject 25% idle time::Documentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +2
-0+ + $ sudo sh -c "echo 25 >
/sys/class/thermal/cooling_device80/cur_state
If the system is not busy and has more than 25% idle time already,
then the powerclamp driver will not start idle injection. Using TopDocumentation/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.txt +0
-0@@ -292,23 +295,23 @@ idle time is accounted as normal idle inthat
common code path is
taken as the idle task.
In this example, 24.1% idle is shown. This helps the system admin or
-user determine the cause of slowdown, when a powerclamp driver is in
action.
+user determine the cause of slowdown, when a powerclamp driver is in
action::
-Tasks: 197 total, 1 running, 196 sleeping, 0 stopped, 0 zombie
-Cpu(s): 71.2%us, 4.7%sy, 0.0%ni,
24.1%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
-Mem: 3943228k total, 1689632k used, 2253596k free, 74960k buffers
-Swap: 4087804k total, 0k used, 4087804k free, 945336k cached
+ Tasks: 197 total, 1 running, 196 sleeping, 0 stopped, 0 zombie
+ Cpu(s): 71.2%us, 4.7%sy, 0.0%ni,
24.1%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
+ Mem: 3943228k total, 1689632k used, 2253596k free, 74960k
buffers
+ Swap: 4087804k total, 0k used, 4087804k free, 945336k
cached
- PID USER PR NI VIRT RES SHR S %CPU
%MEM TIME+ COMMAND
- 3352 jacob 20 0 262m 644 428 S 286 0.0 0:17.16 spin
- 3341 root -51 0 0 0 0 D 25 0.0 0:01.62 kidle_inject/0
- 3344 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/3
- 3342 root -51 0 0 0 0 D 25 0.0 0:01.61 kidle_inject/1
- 3343 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/2
- 2935 jacob 20 0 696m 125m 35m S 5 3.3 0:31.11 firefox
- 1546 root 20 0 158m 20m 6640 S 3 0.5 0:26.97 Xorg
- 2100 jacob 20 0 1223m 88m 30m S 3 2.3 0:23.68 compiz
+ PID USER PR NI VIRT RES SHR S %CPU
%MEM TIME+ COMMAND
+ 3352 jacob 20 0 262m 644 428 S 286 0.0 0:17.16 spin
+ 3341 root -51 0 0 0 0 D 25 0.0 0:01.62 kidle_inject/0
+ 3344 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/3
+ 3342 root -51 0 0 0 0 D 25 0.0 0:01.61 kidle_inject/1
+ 3343 root -51 0 0 0 0 D 25 0.0 0:01.60 kidle_inject/2
+ 2935 jacob 20 0 696m 125m 35m S 5 3.3 0:31.11 firefox
+ 1546 root 20 0 158m 20m 6640 S 3 0.5 0:26.97 Xorg
+ 2100 jacob 20 0 1223m 88m 30m S 3 2.3 0:23.68 compiz
Tests have shown that by using the powerclamp driver as a cooling
device, a PID based userspace thermal controller can manage toDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0@@ -1,13 +1,15 @@ +=====================Kernel driver nouveau
-===================
+=====================
Supported chips:
+
* NV43+
Authors: Martin Peres (mupuf) <[email protected]>
Description
----------
+-----------
This driver allows to read the GPU core temperature, drive the GPU
fan and
set temperature alarms.Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -19,20 +21,25 @@ interface is likely not to work. Thisdocument
may then not cover your situation
entirely.
Temperature management
---------------------
+----------------------
Temperature is exposed under as a read-only HWMON attributetemp1_input.
In order to protect the GPU from overheating, Nouveau supports 4 configurable
temperature thresholds:
- *Fan_boost: Fan speed is set to 100% when reaching this temperature;
- * Downclock: The GPU will be downclocked to reduce its power dissipation;
- * Critical: The GPU is put on hold to further lower power dissipation;
- * Shutdown: Shut the computer down to protect your GPU.
+ *Fan_boost:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +3
-0+ Fan speed is set to 100% when reaching this temperature; + * Downclock: + The GPU will be downclocked to reduce its powerdissipation;
+ * Critical:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ The GPU is put on hold to further lower powerdissipation;
+ * Shutdown:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ Shut the computer down to protect your GPU.
-WARNING: Some of these thresholds may not be used by Nouveau dependingDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +2
-1-on your chipset. +WARNING: + Some of these thresholds may not be used by Nouveaudepending
Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ on your chipset.
The default value for these thresholds comes from the GPU's vbios.
These
thresholds can be configured thanks to the following HWMON attributes:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -46,19 +53,24 @@ NOTE: Remember that the values are stored asmilli degrees Celsius. Don't forget
to multiply!
Fan management
-------------
+--------------
Not all cards have a drivable fan. If you do, then the following HWMON
attributes should be available:
- *pwm1_enable: Current fan management mode (NONE, MANUAL or AUTO);
- * pwm1: Current PWM value (power percentage);
- *pwm1_min: The minimum PWM speed allowed;
- *pwm1_max: The maximum PWM speed allowed (bypassed when hittingFan_boost);
+ *pwm1_enable:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +7
-0+ Current fan management mode (NONE, MANUAL or AUTO); + * pwm1: + Current PWM value (power percentage); + * pwm1_min: + The minimum PWM speed allowed; + * pwm1_max: + The maximum PWM speed allowed (bypassed when hitting
Fan_boost);
You may also have the following attribute:
- *fan1_input: Speed in RPM of your fan.
+ *fan1_input:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +1
-0+ Speed in RPM of your fan.
Your fan can be driven in different modes:Documentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +0
-0@@ -66,14 +78,16 @@ Your fan can be driven in different modes: * 1: The fan can be driven in manual (use pwm1 to change the speed); * 2; The fan is driven automatically depending on thetemperature.
-NOTE: Be sure to use the manual mode if you want to drive the fan
speed manually
+NOTE:
+ Be sure to use the manual mode if you want to drive the fan speed
manually
-NOTE2: When operating in manual mode outside the vbios-defined -[PWM_min,PWM_max] range, the reported fan speed (RPM) may not be
accurateDocumentation/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal +3
-1-depending on your hardware. +NOTE2: + When operating in manual mode outside the vbios-defined + [PWM_min, PWM_max] range, the reported fan speed (RPM) may notbe
accurate
+ depending on your hardware.
Bug reports
----------
+-----------
Thermal management on Nouveau is new and may not work on all cards.
If you have
inquiries, please ping mupuf on IRC (#nouveau, freenode).Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0@@ -1,3 +1,4 @@ +=================================Power allocator governor tunables
=================================Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -25,36 +26,36 @@ temperature as the control input and power asthe
controlled output:
P_max =k_p* e +k_i*err_integral+k_d*diff_err+sustainable_power
where
- e =desired_temperature-current_temperature- err_integral is the sum of previous errors
- diff_err = e -previous_error
+ - e =desired_temperature-current_temperature+ - err_integral is the sum of previous errors + - diff_err = e -previous_errorDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-It is similar to the one depicted below: +It is similar to the one depicted below::
- k_d
- |
-current_temp |- | v - | +----------+ +---+ - | +----->| diff_err |-->| X |------+ - | | +----------+ +---+ | - | | | tdpac
tor
- | | k_i | | get_r equested_power()
- | | | | | |
|
- | | | | | |
| ...
- v | v v v v
v
- +---+ | +-------+ +---+ +---+ +---+ +-
----
-----+
- | S |-------+----->| sum e |----->| X |--->| S |-->| S | -->|power |
- +---+ | +-------+ +---+ +---+ +--- + |allocation|
- ^ | ^ +-
----
-----+
- | | |
|
|
- | | +---
+ | | |
- | +------->| X |-------------------
+ v v
- | +---
+ granted
performanceDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-4-desired_temperature ^ - | - | - k_po/k_pu + k_d + | + current_temp | + | v + | +----------+ +---+ + | +----->| diff_err |-->| X |------+ + | | +----------+ +---+ | + | | | tdpac
tor
+ | | k_i | | get_r equested_power()
+ | | | | | |
|
+ | | | | | |
| ...
+ v | v v v v
v
+ +---+ | +-------+ +---+ +---+ +---+ +-
----
-----+
+ | S |-----+----->| sum e |----->| X |--->| S |-->| S | -->|power |
+ +---+ | +-------+ +---+ +---+ +--- + |allocation|
+ ^ | ^ +-
----
-----+
+ | | |
|
|
+ | | +---
+ | | |
+ | +------->| X |-------------------
+ v v
+ | +---
+ granted
performance
+ desired_temperature ^Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-0+ | + | + k_po/k_pu
Sustainable power
-----------------Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -73,7 +74,7 @@ is typically 2000mW, while on a 10" tablet isaround 4500mW (may vary
depending on screen size).
If you are using device tree, do add it as a property of theDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-thermal-zone. For example: +thermal-zone. For example::
thermal-zones {
soc_thermal{Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -85,7 +86,7 @@ thermal-zone. For example:Instead, if the thermal zone is registered from the platform code,
pass a
thermal_zone_paramsthat has asustainable_power. If nothermal_zone_paramswere being passed, then something like belowDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-will suffice: +will suffice::
static const structthermal_zone_paramstz_params= { .sustainable_power = 3500,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -112,18 +113,18 @@ available capacity at a lowtemperature. On
the other hand, a high
value ofk_puwill result in the governor granting very high power
while temperature is low, and may lead to temperature overshooting.Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-The default value for `k_pu` is: +The default value for `k_pu` is::
2 *sustainable_power/ (desired_temperature-switch_on_temp)
This means that atswitch_on_tempthe output of the controller's
proportional term will be 2 *sustainable_power. The default valueDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-for `k_po` is: +for `k_po` is::
sustainable_power / (desired_temperature-switch_on_temp)
Focusing on the proportional and feed forward values of the PIDDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-controller equation we have: +controller equation we have::
P_max =k_p* e +sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -134,21 +135,23 @@ is the desired one, then the proportionalcomponent is zero and
thermal equilibrium under constant load.sustainable_poweris only
an estimate, which is the reason for closed-loop control such as this.Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +2
-1-Expanding `k_pu` we get: +Expanding `k_pu` we get:: +P_max = 2 *
sustainable_power* (T_set- T) / (T_set-T_on)Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +2
-1+ - sustainable_power + sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +5
-4-where - T_set is the desired temperature - T is the current temperature - T_on is the switch on temperature +where: + + - T_set is the desired temperature + - T is the current temperature + - T_on is the switch on temperature
When the current temperature is theswitch_ontemperature, the aboveDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-1-formula becomes: +formula becomes::
P_max = 2 *sustainable_power* (T_set-T_on) / (T_set-T_on)
+
- sustainable_power = 2 *sustainable_power+sustainable_power=
- 3 *sustainable_powerDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ sustainable_power = 2 * sustainable_power +
sustainable_power=Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ 3 * sustainable_power
Therefore, the proportional term alone linearly decreases power from
3 *sustainable_powertosustainable_poweras the temperatureDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -178,11 +181,18 @@ Cooling device power APICooling devices controlled by this governor must supply the additional
"power" API in theircooling_device_ops. It consists on three ops:
-1. int get_requested_power(structthermal_cooling_device*cdev,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +4
-4- struct thermal_zone_device *tz, u32 *power); -@cdev: The `struct thermal_cooling_device` pointer -@tz: thermal zone in which we are currently operating -@power: pointer in which to store the calculated power +1. :: + + int get_requested_power(struct thermal_cooling_device *cdev, + struct thermal_zone_device *tz, u32*power);
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-0+ + +@cdev: + The `struct thermal_cooling_device` pointer +@tz: + thermal zone in which we are currently operating +@power: + pointer in which to store the calculated power
get_requested_power()calculates the power requested by the device
in milliwatts and stores it in @power . It should return 0 onDocumentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +0
-0@@ -190,23 +200,37 @@ success, -E* on failure. This is currentlyused by the power
allocator governor to calculate how much power to give to each cooling
device.
-2. int state2power(structthermal_cooling_device*cdev, struct - thermal_zone_device *tz, unsigned long state, u32 *power);
-@cdev: Thestruct thermal_cooling_devicepointer -@tz: thermal zone in which we are currently operating -@state: A cooling device state
-@power: pointer in which to store the equivalent power +2. ::Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +2
-0+ + int state2power(struct thermal_cooling_device *cdev,struct
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +1
-0+ thermal_zone_device *tz, unsigned longstate,
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +10
-0+ u32 *power); + +@cdev: + The `struct thermal_cooling_device` pointer +@tz: + thermal zone in which we are currently operating +@state: + A cooling device state +@power: + pointer in which to store the equivalent power
Convert cooling device state @state into power consumption in milliwatts and store it in @power. It should return 0 on success,
-E*
on failure. This is currently used by thermal core to calculate the
maximum power that an actor can consume.
-3. int power2state(structthermal_cooling_device*cdev, u32 power,Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +3
-4- unsigned long *state); -@cdev: The `struct thermal_cooling_device` pointer -@power: power in milliwatts -@state: pointer in which to store the resulting state +3. :: + + int power2state(struct thermal_cooling_device *cdev, u32power,
Documentation/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.txt +8
-0+ unsigned long *state); + +@cdev: + The `struct thermal_cooling_device` pointer +@power: + power in milliwatts +@state: + pointer in which to store the resulting state
Calculate a cooling device state that would make the device consume
at
most @power mW and store it in @state. It should return 0 on success,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0@@ -1,3 +1,4 @@ +===================================Generic Thermal Sysfs driver How To
===================================Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -9,6 +10,7 @@ Copyright (c) 2008 Intel Corporation
0. Introduction
+===============
The generic thermal sysfs provides a set of interfaces for thermal
zone
devices (sensors) and thermal cooling devices (fan, processor...) to
registerDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -25,59 +27,90 @@ An intelligent thermal management applicationcan
make decisions based on
inputs from thermal zone attributes (the current temperature and trip point
temperature) and throttle appropriate devices.
-[0-*] denotes any positive number starting from 0
-[1-*] denotes any positive number starting from 1+- `[0-*]` denotes any positive number starting from 0 +- `[1-*]` denotes any positive number starting from 1
1. thermal sysfs driver interface functions
+===========================================
1.1 thermal zone device interface
-1.1.1 structthermal_zone_device
*thermal_zone_device_register(char
*type,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-4- int trips, int mask, void *devdata, - struct thermal_zone_device_ops *ops, - const struct thermal_zone_params *tzp, - int passive_delay, int polling_delay)) +--------------------------------- + + :: + + struct thermal_zone_device + *thermal_zone_device_register(char *type, + int trips, int mask, void*devdata,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device_ops
*ops,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ const struct
thermal_zone_params*tzp,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ int passive_delay, int
polling_delay))
This interface function adds a new thermal zone device (sensor)
to
- /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind
all the
+ /sys/class/thermal folder asthermal_zone[0-*]. It tries to
bind all the
thermal cooling devices registered at the same time.
- type: the thermal zone type.
- trips: the total number of trip points this thermal zone supports.
- mask: Bit string: If 'n'th bit is set, then trip point 'n' is
writeable.
- devdata: device private data
- ops: thermal zone device call-backs.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .bind: bind the thermal zone device with a thermalcooling
device.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .unbind: unbind the thermal zone device with a thermalcooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_temp: get the current temperature of the thermalzone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_trips: set the trip points window. Whenever thecurrent
temperature
+ type:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ the thermal zone type. + trips: + the total number of trip points this thermal zonesupports.
+ mask:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ Bit string: If 'n'th bit is set, then trip point 'n' iswriteable.
+ devdata:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +6
-0+ device private data + ops: + thermal zone device call-backs. + + .bind: + bind the thermal zone device with a thermalcooling
device.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .unbind: + unbind the thermal zone device with a thermalcooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ .get_temp: + get the current temperature of the thermal zone. + .set_trips: + set the trip points window. Whenever thecurrent
temperature
is updated, the trip points immediately below
and above the
current temperature are found.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_mode: get the current mode (enabled/disabled) ofthe
thermal zone.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- - "enabled" means the kernel thermal management isenabled.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- - "disabled" will prevent kernel thermal driveraction
upon trip pointsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- so that user applications can take charge ofthermal
management.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_mode: set the mode (enabled/disabled) of thethermal
zone.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- .get_trip_type: get the type of certain trip point. - .get_trip_temp: get the temperature above which thecertain
trip pointDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .get_mode: + get the current mode (enabled/disabled) ofthe
thermal zone.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ + - "enabled" means the kernel thermalmanagement is
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ enabled. + - "disabled" will prevent kernel thermaldriver action
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ upon trip points so that userapplications
can takeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ charge of thermal management. + .set_mode: + set the mode (enabled/disabled) of the thermalzone.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ .get_trip_type: + get the type of certain trip point. + .get_trip_temp: + get the temperature above which thecertain
trip point
will be fired.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_emul_temp: set the emulation temperature whichhelps in
debuggingDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .set_emul_temp: + set the emulation temperature whichhelps in
debugging
different threshold temperature points. - tzp: thermal zone platform parameters.
- passive_delay: number of milliseconds to wait between polls when
+ tzp:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ thermal zone platform parameters. + passive_delay: + number of milliseconds to wait between polls whenperforming passive cooling.
- polling_delay: number of milliseconds to wait between polls when
checking
+ polling_delay:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ number of milliseconds to wait between polls whenchecking
whether trip points have been crossed (0 for interrupt driven systems).
+ ::
-1.1.2 void thermal_zone_device_unregister(structthermal_zone_device
*tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ void thermal_zone_device_unregister(struct
thermal_zone_device*tz)
This interface function removes the thermal zone device. It deletes the corresponding entry from/sys/class/thermalfolder and
unbinds all the thermal cooling devices it uses.
-1.1.3 structthermal_zone_device*thermal_zone_of_sensor_register(Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-2- struct device *dev, int sensor_id, void *data, - const struct thermal_zone_of_device_ops *ops) + :: + + struct thermal_zone_device + *thermal_zone_of_sensor_register(struct device *dev,int
sensor_id,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ void *data, + const struct
thermal_zone_of_device_ops*ops)
This interface adds a new sensor to a DT thermal zone. This function will search the list of thermal zones described inDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -87,25 +120,33 @@ temperature) and throttle appropriatedevices.
thermal zone device.
The parameters for this interface are:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- dev: Device node of sensor containingvalid
node pointer inDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ + dev: + Device node of sensor containing validnode
pointer in
dev->of_node.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- sensor_id: a sensor identifier, in case thesensor IP
has moreDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ sensor_id: + a sensor identifier, in case the sensorIP
has more
than one sensorsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- data: a private pointer (owned by thecaller)
that will beDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ data: + a private pointer (owned by the caller)that
will be
passed back, when a temperature reading is
needed.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- ops: struct thermal_zone_of_device_ops *. + ops: + `struct thermal_zone_of_device_ops *`.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- get_temp: a pointer to a functionthat reads the
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ ============== ============================
===========Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ get_temp a pointer to a functionthat
reads the
sensor temperature. This is
mandatory
callback provided by sensor
driver.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- set_trips: a pointer to a functionthat
sets aDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ set_trips a pointer to a functionthat sets a
temperature window. When this window is
left the driver must inform
the thermal
core viathermal_zone_device_update.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- get_trend: a pointer to afunction
that reads theDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ get_trend a pointer to afunction
that reads the
sensor temperature trend.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- set_emul_temp: a pointer to afunction that sets
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ set_emul_temp a pointer to afunction
that sets
sensor emulated temperature.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ ============== ============================
===========
+
The thermal zone temperature is provided by theget_temp()
function
pointer ofthermal_zone_of_device_ops. When called, it will
have the private pointer @data back.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -114,8 +155,10 @@ temperature) and throttle appropriatedevices.
handle. Caller should check the return handle withIS_ERR()
for finding
whether success or not.
-1.1.4 void thermal_zone_of_sensor_unregister(struct device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- struct thermal_zone_device *tzd) + :: + + void thermal_zone_of_sensor_unregister(struct device*dev,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device*tzd)
This interface unregisters a sensor from a DT thermal zone
which was
successfully added by interfacethermal_zone_of_sensor_register().Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -124,21 +167,29 @@ temperature) and throttle appropriatedevices.
interface. It will also silent the zone by remove the .get_temp() and
get_trend()thermal zone device callbacks.
-1.1.5 structthermal_zone_device*devm_thermal_zone_of_sensor_register(Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- struct device *dev, int sensor_id, - void *data, const struct
thermal_zone_of_device_ops
*ops)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ :: + + struct thermal_zone_device + *devm_thermal_zone_of_sensor_register(struct device*dev,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ int sensor_id, + void *data, + const struct
thermal_zone_of_device_ops*ops)
This interface is resource managed version ofthermal_zone_of_sensor_register().
+
All details ofthermal_zone_of_sensor_register()described
in
section 1.1.3 is applicable here.
+
The benefit of using this interface to register sensor is
that it
is not require to explicitly callthermal_zone_of_sensor_unregister()
in error path or during driver unbinding as this is done by
driver
resource manager.
-1.1.6 void devm_thermal_zone_of_sensor_unregister(struct device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- struct thermal_zone_device *tzd) + :: + + voiddevm_thermal_zone_of_sensor_unregister(struct
device *dev,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ struct
thermal_zone_device*tzd)
This interface is resource managed version ofthermal_zone_of_sensor_unregister().Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -147,123 +198,186 @@ temperature) and throttle appropriatedevices.
Normally this function will not need to be called and the
resource
management code will ensure that the resource is freed.
-1.1.7 intthermal_zone_get_slope(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ :: + + int thermal_zone_get_slope(struct
thermal_zone_device*tz)
This interface is used to read the slope attribute value for the thermal zone device, which might be useful for platform
drivers for temperature calculations.
-1.1.8 intthermal_zone_get_offset(struct thermal_zone_device *tz)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ :: + + int thermal_zone_get_offset(struct
thermal_zone_device*tz)
This interface is used to read the offset attribute value
for the thermal zone device, which might be useful for platform
drivers for temperature calculations.
1.2 thermal cooling device interface
-1.2.1 structthermal_cooling_device*thermal_cooling_device_register(char *name,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- void *devdata, struct thermal_cooling_device_ops*)
+------------------------------------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + + :: + + struct thermal_cooling_device + *thermal_cooling_device_register(char *name, + void *devdata, struct
thermal_cooling_device_ops*)
This interface function adds a new thermal cooling device (fan/processor/...)
- to/sys/class/thermal/folder as cooling_device[0-*]. It tries
to bind itself
+ to/sys/class/thermal/folder ascooling_device[0-*]. It tries
to bind itself
to all the thermal zone devices registered at the same time. - name: the cooling device name.
- devdata: device private data.
- ops: thermal cooling devices call-backs.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_max_state: get the Maximum throttle state of thecooling device.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .get_cur_state: get the Currently requested throttlestate
of the cooling device.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- .set_cur_state: set the Current throttle state of thecooling device.
-
-1.2.2 voidthermal_cooling_device_unregister(struct thermal_cooling_device *cdev)Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +10
-0+ + name: + the cooling device name. + devdata: + device private data. + ops: + thermal cooling devices call-backs. + + .get_max_state: + get the Maximum throttle state of the coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ .get_cur_state: + get the Currently requested throttle state ofthe
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ cooling device. + .set_cur_state: + set the Current throttle state of the coolingdevice.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ + :: + + void thermal_cooling_device_unregister(struct
thermal_cooling_device*cdev)
This interface function removes the thermal cooling device. It deletes the corresponding entry from/sys/class/thermalfolder and
unbinds itself from all the thermal zone devices using it.
1.3 interface for binding a thermal zone device with a thermal cooling device
-1.3.1 int thermal_zone_bind_cooling_device(structthermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2- int trip, struct thermal_cooling_device *cdev, - unsigned long upper, unsigned long lower, unsigned intweight);
+--------------------------------------------------------------
----
-----------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ + :: + + int thermal_zone_bind_cooling_device(struct
thermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ int trip, struct thermal_cooling_device *cdev, + unsigned long upper, unsigned long lower,unsigned
int weight);
This interface function binds a thermal cooling device to a particular trip
point of a thermal zone device.
+
This function is usually called in the thermal zone device .bind
callback.
- tz: the thermal zone device
- cdev: thermal cooling device
- trip: indicates which trip point in this thermal zone the cooling device
- is associated with.
- upper:the Maximum cooling state for this trip point. - THERMAL_NO_LIMIT means no upper limit,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + tz: + the thermal zone device + cdev: + thermal cooling device + trip: + indicates which trip point in this thermal zone thecooling device
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +4
-0+ is associated with. + upper: + the Maximum cooling state for this trip point. + THERMAL_NO_LIMIT means no upper limit,and the cooling device can be in
max_state. - lower:the Minimum cooling state can be used for this trip point.
- THERMAL_NO_LIMIT means no lower limit,
+ lower:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ the Minimum cooling state can be used for this trippoint.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ THERMAL_NO_LIMIT means no lower limit,and the cooling device can be in cooling state 0. - weight: the influence of this cooling device in this thermal - zone. See 1.4.1 below for more information. + weight:
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ the influence of this cooling device in this thermal + zone. See 1.4.1 below for more information.
-1.3.2 int thermal_zone_unbind_cooling_device(structthermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1- int trip, struct thermal_cooling_device *cdev); + :: + + int thermal_zone_unbind_cooling_device(struct
thermal_zone_device*tz,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ int trip, struct
thermal_cooling_device*cdev);
This interface function unbinds a thermal cooling device from a
particular
trip point of a thermal zone device. This function is usually
called in
the thermal zone device .unbind callback.
- tz: the thermal zone device
- cdev: thermal cooling device
- trip: indicates which trip point in this thermal zone the cooling device
- is associated with.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +7
-0+ + tz: + the thermal zone device + cdev: + thermal cooling device + trip: + indicates which trip point in this thermal zone thecooling
deviceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is associated with.
1.4 Thermal Zone Parameters
-1.4.1 structthermal_bind_params
+---------------------------Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + :: + + struct thermal_bind_params +This structure defines the following parameters that are used to
bind
a zone with a cooling device for a particular trip point. - .cdev: The cooling device pointer
- .weight: The 'influence' of a particular cooling device on this
- zone. This is relative to the rest of the cooling - devices. For example, if all cooling devices have a - weight of 1, then they all contribute the same. You can
- use percentages if you want, but it's not mandatory. A
- weight of 0 means that this cooling device doesn't - contribute to the cooling of this zone unless all cooling
- devices have a weight of 0. If all weights are 0, then
- they all contribute the same.
- .trip_mask:This is a bit mask that gives the binding relation
between
- this thermal zone and cdev, for a particular trip point.
- If nth bit is set, then the cdev and thermal zone are
bound
- for trip point n.
- .binding_limits: This is an array of cooling state limits. Must
have
- exactly 2 * thermal_zone.number_of_trip_points.
It is an
- array consisting of tuples <lower-state upper-
state> of
- state limits. Each trip will be associated with
one state
- limit tuple when binding. A NULL pointer means
- <THERMAL_NO_LIMITSTHERMAL_NO_LIMITS> on all
trips.
- These limits are used when binding a cdev to a
trip point.
- .match: This call back returns success(0) if the 'tz and cdev'
need toDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + .cdev: + The cooling device pointer + .weight: + The 'influence' of a particular cooling device onthis
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ zone. This is relative to the rest of the cooling + devices. For example, if all cooling devices have a + weight of 1, then they all contribute the same. Youcan
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ use percentages if you want, but it's notmandatory. A
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ weight of 0 means that this cooling device doesn't + contribute to the cooling of this zone unless allcooling
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ devices have a weight of 0. If all weights are 0,then
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ they all contribute the same. + .trip_mask: + This is a bit mask that gives the bindingrelation
betweenDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ this thermal zone and cdev, for a particular trippoint.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ If nth bit is set, then the cdev and thermal zoneare
boundDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ for trip point n. + .binding_limits: + This is an array of cooling state limits.Must
haveDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ exactly 2 *thermal_zone.number_of_trip_points.
It is anDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ array consisting of tuples <lower-stateupper-
state> ofDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ state limits. Each trip will be associatedwith
one stateDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ limit tuple when binding. A NULL pointermeans
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> onall
trips.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ These limits are used when binding a cdevto a
trip point.
+ .match:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ This call back returns success(0) if the 'tz andcdev'
need to
be bound, as per platform data.
-1.4.2 structthermal_zone_paramsDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + :: + + struct thermal_zone_params +This structure defines the platform level parameters for a thermal zone.
This data, for each thermal zone should come from the platform
layer.
This is an optional feature where some platforms can choose not
to
provide this data.
- .governor_name: Name of the thermal governor used for this zone
- .no_hwmon: a boolean to indicate if the thermal to hwmon sysfs
interface
- is required. whenno_hwmon== false, a hwmon sysfs
interface
- will be created. whenno_hwmon== true, nothing will
be done.
- In case thethermal_zone_paramsis NULL, the hwmon
interface
- will be created (for backward compatibility). - .num_tbps: Number ofthermal_bind_paramsentries for this zone
- .tbp:thermal_bind_paramsentriesDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + .governor_name: + Name of the thermal governor used for this zone + .no_hwmon: + a boolean to indicate if the thermal to hwmonsysfs
interfaceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is required. when no_hwmon == false, a hwmonsysfs
interfaceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ will be created. when no_hwmon == true, nothingwill
be done.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ In case the thermal_zone_params is NULL, thehwmon
interfaceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ will be created (for backward compatibility). + .num_tbps: + Number of thermal_bind_params entries for thiszone
+ .tbp:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ thermal_bind_params entries
2. sysfs attributes structure
+=============================
+== ================
RO read only value
WO write only value
RW read/write value
+== ================
Thermal sysfs attributes will be represented under/sys/class/thermal.
Hwmon sysfs I/F extension is also available under/sys/class/hwmon
if hwmon is compiled in or built as a module.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-2-Thermal zone device sys I/F, created once it's registered: -/sys/class/thermal/thermal_zone[0-*]: +Thermal zone device sys I/F, created once it's registered:: + + /sys/class/thermal/thermal_zone[0-*]:|---type: Type of the thermal zone |---temp: Current temperature |---mode: Working mode of the thermalzone
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -282,8 +396,9 @@ Thermal zone device sys I/F, created onceit's
registered:
|---slope: Slope constant applied as linear extrapolation
|---offset: Offset constant applied as linear
extrapolationDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-2-Thermal cooling device sys I/F, created once it's registered: -/sys/class/thermal/cooling_device[0-*]: +Thermal cooling device sys I/F, created once it's registered:: + + /sys/class/thermal/cooling_device[0-*]:|---type: Type of the cooling
device(processor/fan/...)
|---max_state: Maximum cooling state of the
cooling device
|---cur_state: Current cooling state of the
cooling deviceDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -299,11 +414,13 @@ the relationship between a thermal zone andits
associated cooling device.
They are created/removed for each successful execution of thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_dev ice.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1-/sys/class/thermal/thermal_zone[0-*]: +:: + + /sys/class/thermal/thermal_zone[0-*]:|---cdev[0-*]: [0-*]th cooling device in
current
thermal zone
|---cdev[0-*]_trip_point: Trip point that cdev[0-*]
is
associated with
|---cdev[0-*]_weight: Influence of the cooling device in
- this thermal zoneDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ this thermal zone
Besides the thermal zone device sysfs I/F and cooling device sysfs
I/F,
the generic thermal driver also creates a hwmon sysfs I/F for each
_type_Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -311,16 +428,17 @@ of thermal zone device. E.g. the genericthermal driver registers one hwmon
class device and build the associated hwmon sysfs I/F for all the
registered
ACPI thermal zones.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-1-/sys/class/hwmon/hwmon[0-*]: +:: + + /sys/class/hwmon/hwmon[0-*]:|---name: The type of the thermal
zone
devices
|---temp[1-*]_input: The current temperature of
thermal
zone [1-*]
|---temp[1-*]_critical: The critical trip point of
thermal zone [1-*]
Please readDocumentation/hwmon/sysfs-interface.rstfor additional
information.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-*************************** -* Thermal zone attributes * -*************************** +Thermal zone attributes +-----------------------
type
Strings which represent the thermal zone type.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -340,54 +458,67 @@ modeThis file gives information about the algorithm that is currently
managing the thermal zone. It can be either default kernel
based
algorithm or user space application.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- enabled = enable Kernel Thermalmanagement.
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- disabled = Preventing kernel thermal zone driveractions upon
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +5
-0+ + enabled + enable Kernel Thermal management. + disabled + Preventing kernel thermal zone driveractions upon
trip points so that user application can
take full
charge of the thermal management. +
RW, Optional
policy
One of the various thermal governors used for a particular
zone.
+
RW, Required
available_policies
Available thermal governors which can be used for a particular zone.
+
RO, Required
-trip_point_[0-*]_temp
+trip_point_[0-*]_temp
The temperature above which trip point will be fired. +
Unit: millidegree Celsius
+
RO, Optional
-trip_point_[0-*]_type
+trip_point_[0-*]_type
Strings which indicate the type of the trip point.Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- E.g. it can be one of critical, hot, passive, active[0-*]
for ACPIDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-0+ + E.g. it can be one of critical, hot, passive, `active[0-*]`
for ACPI
thermal zone.
+
RO, Optional
-trip_point_[0-*]_hyst
+trip_point_[0-*]_hyst
The hysteresis value for a trip point, represented as an integer
Unit: Celsius
RW, Optional
-cdev[0-*]
+cdev[0-*]
Sysfs link to the thermal cooling device node where the sys
I/F
for cooling device throttling control represents. +
RO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-2-cdev[0-*]_trip_point - The trip point in this thermal zone which cdev[0-*] isassociated
+cdev[0-*]_trip_pointDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ The trip point in this thermal zone which `cdev[0-*]` isassociated
with; -1 means the cooling device is not associated with any
trip
point.
+
RO, Optional
-cdev[0-*]_weight
- The influence of cdev[0-*] in this thermal zone. This value
- is relative to the rest of cooling devices in the thermal
- zone. For example, if a cooling device has a weight double
- than that of other, it's twice as effective in cooling the
- thermal zone.
- RW, Optional
+cdev[0-*]_weightDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ The influence of `cdev[0-*]` in this thermal zone. Thisvalue
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ is relative to the rest of cooling devices in thethermal
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ zone. For example, if a cooling device has a weightdouble
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ than that of other, it's twice as effective in coolingthe
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +3
-0+ thermal zone. + + RW, Optional
passive
Attribute is only present for zones in which the passive coolingDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -395,8 +526,11 @@ passiveand can be set to a temperature (in millidegrees) to enable
a
passive trip point for the zone. Activation is done by polling with
an interval of 1 second.
+
Unit: millidegrees Celsius
+
Valid values: 0 (disabled) or greater than 1000 +
RW, Optional
emul_tempDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -407,17 +541,21 @@ emul_tempthreshold and its associated cooling action. This is write
only node
and writing 0 on this node should disable emulation.
Unit: millidegree Celsius
+
WO, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- WARNING: Be careful while enabling this option onproduction systems,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- because userland can easily disable the thermal policyby
simplyDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- flooding this sysfs node with low temperature values. + WARNING: + Be careful while enabling this option on productionsystems,
Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ because userland can easily disable the thermalpolicy
by simplyDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ flooding this sysfs node with low temperaturevalues.
sustainable_power
An estimate of the sustained power that can be dissipated by
the thermal zone. Used by the power allocator governor. ForDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-1- more information see
Documentation/thermal/power_allocator.txtDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-0+ more information see
Documentation/thermal/power_allocator.rst
+
Unit: milliwatts
+
RW, Optional
k_poDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -425,7 +563,8 @@ k_pocontroller during temperature overshoot. Temperature overshoot
is when the current temperature is above the "desired temperature" trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_puDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -433,20 +572,23 @@ k_pucontroller during temperature undershoot. Temperature undershoot
is when the current temperature is below the "desired temperature" trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_i
The integral term of the power allocator governor's PID controller. This term allows the PID controller to compensate
for long term drift. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
k_d
The derivative term of the power allocator governor's PID
controller. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +RW, Optional
integral_cutoffDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -456,8 +598,10 @@ integral_cutoffexample, if
integral_cutoffis 0, then the integral term only
accumulates error when temperature is above the desired temperature trip point. For more information seeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-1- Documentation/thermal/power_allocator.txt + Documentation/thermal/power_allocator.rst +Unit: millidegree Celsius
+
RW, Optional
slopeDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -465,6 +609,7 @@ slopeto determine a hotspot temperature based off the sensor's
raw readings. It is up to the device driver to determine the usage of these values.
+
RW, Optional
offsetDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -472,28 +617,33 @@ offsetto determine a hotspot temperature based off the sensor's
raw readings. It is up to the device driver to determine the usage of these values.
+
RW, OptionalDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-***************************** -* Cooling device attributes * -***************************** +Cooling device attributes +-------------------------
type
String which represents the type of device, e.g:
+
- for generic ACPI: should be "Fan", "Processor" or "LCD"
- for memory controller device onintel_menlowplatform:
should be "Memory controller".
+
RO, Required
max_state
The maximum permissible cooling state of this cooling device.
+
RO, Required
cur_state
The current cooling state of this cooling device. The value can any integer numbers between 0 andmax_state:
+
-cur_state== 0 means no cooling
-cur_state==max_statemeans the maximum cooling. +
RW, Required
stats/resetDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -508,9 +658,11 @@ stats/time_in_state_ms:units here is 10mS (similar to other time exported in /proc).
RO, Required
+
stats/total_trans:
A single positive value showing the total number of times
the state of a
cooling device is changed.
+
RO, Required
stats/trans_table:Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -522,6 +674,7 @@ stats/trans_table:RO, Required
3. A simple implementation
+==========================
ACPI thermal zone may support multiple trip points like critical,
hot,
passive, active. If an ACPI thermal zone supports critical, passive,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -532,11 +685,10 @@ thermal_cooling_device. Both are consideredto
have the same
effectiveness in cooling the thermal zone.
If the processor is listed in_PSLmethod, and the fan is listed in_AL0Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +1
-1-method, the sys I/F structure will be built like this: +method, the sys I/F structure will be built like this::Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-/sys/class/thermal: - -|thermal_zone1: + /sys/class/thermal: + |thermal_zone1:|---type: acpitz |---temp: 37000 |---mode: enabledDocumentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -557,24 +709,24 @@ method, the sys I/F structure will be builtlike this:
|---cdev1_trip_point: 2 /* cdev1 can be used
for
active[0]*/
|---cdev1_weight: 1024
-|cooling_device0:
+ |cooling_device0:|---type: Processor |---max_state: 8 |---cur_state: 0 -|cooling_device3: + |cooling_device3: |---type: Fan |---max_state: 2 |---cur_state: 0Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +2
-3-/sys/class/hwmon: - -|hwmon0: + /sys/class/hwmon: + |hwmon0:|---name: acpitz |---temp1_input: 37000 |---temp1_crit: 100000
4. Event Notification
+=====================
The framework includes a simple notification mechanism, in the form
of a
netlink event. Netlink socket initialization is done during the _init_Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -587,21 +739,28 @@ event will be one of:{THERMAL_AUX0, THERMAL_AUX1, THERMAL_CRITICAL,THERMAL_DEV_FAULT}. Notification can be sent when the current temperature
crosses any of the configured thresholds.
-5. Export Symbol APIs:
+5. Export Symbol APIs
+=====================
+
+5.1.get_tz_trend
+-----------------
-5.1:get_tz_trend:
This function returns the trend of a thermal zone, i.e the rate of
change
of temperature of the thermal zone. Ideally, the thermal sensor drivers
are supposed to implement the callback. If they don't, the thermal
framework calculated the trend by comparing the previous and the current
temperature values.
-5.2:get_thermal_instance:
+5.2.get_thermal_instance
+-------------------------
+
This function returns thethermal_instancecorresponding to a given
{thermal_zone,cooling_device,trip_point} combination. Returns NULL
if such an instance does not exist.
-5.3:thermal_notify_framework:
+5.3.thermal_notify_framework
+-----------------------------
+
This function handles the trip events from sensor drivers. It starts
throttling the cooling devices according to the policy configured.
For CRITICAL and HOT trip points, this notifies the respective drivers,Documentation/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.txt +0
-0@@ -609,12 +768,15 @@ and does actual throttling for other trippoints i.e ACTIVE and PASSIVE.
The throttling policy is based on the configured platform data; if
no
platform data is provided, this uses thestep_wisethrottling policy.
-5.4:thermal_cdev_update:
+5.4.thermal_cdev_update
+------------------------
+
This function serves as an arbitrator to set the state of a cooling
device. It sets the cooling device to the deepest cooling state if
possible.
-6.thermal_emergency_poweroff:
+6.thermal_emergency_poweroff
+=============================
On an event of critical trip temperature crossing. Thermal framework
allows the system to shutdown gracefully by callingorderly_poweroff().Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +1
-0@@ -1,19 +1,23 @@ +===================================Kernel driver:
x86_pkg_temp_thermal
-===================
+===================================
Supported chips:
+
* x86: with package level thermal management
+
(Verify using: CPUID.06H:EAX[bit 6] =1)
Authors: Srinivas Pandruvada <[email protected] m>
Reference
----
+---------
+
Intel® 64 and IA-32 Architectures Software Developer’s Manual (Jan,
2013):
Chapter 14.6: PACKAGE LEVEL THERMAL MANAGEMENT
Description
----------
+-----------
This driver register CPU digital temperature package level sensor as
a thermal
zone with maximum two user mode configurable trip points. Number of
trip pointsDocumentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +0
-0@@ -25,23 +29,27 @@ take any action to control temperature.Threshold management
--------------------
Each package will register as a thermal zone under/sys/class/thermal.Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +4
-2-Example: -/sys/class/thermal/thermal_zone1 + +Example:: + + /sys/class/thermal/thermal_zone1
This contains two trip points:
+
-trip_point_0_temp
-trip_point_1_temp
User can set any temperature between 0 to TJ-Max temperature. Temperature units
-are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-
api.txt" for
+are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for
thermal sys-fs details.
Any value other than 0 in these trip points, can trigger thermal notifications.
Setting 0, stops sending thermal notifications.
-Thermal notifications: To get kobject-uevent notifications, set the
thermal zone
-policy to "user_space". For example: echo -n "user_space" > policyDocumentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +3
-2- - +Thermal notifications: +To get kobject-uevent notifications, set the thermal zone +policy to "user_space".
+For example::Documentation/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal +1
-0+ echo -n "user_space" > policyMAINTAINERS +0
-0@@ -15687,7 +15687,7 @@ M: Viresh Kumar <viresh.kumar@linaro.o
rg>
M: Javi Merino <[email protected]>
L: [email protected]
S: SupportedMAINTAINERS +1
-1-F: Documentation/thermal/cpu-cooling-api.txt +F: Documentation/thermal/cpu-cooling-api.rstF:
drivers/thermal/cpu_cooling.c
F:include/linux/cpu_cooling.hinclude/linux/thermal.h +0
-0@@ -251,7 +251,7 @@ struct thermal_bind_params { * platform characterization. This value is relative tothe
* rest of the weights so a cooling device whose weight is
* double that of another cooling device is twice asinclude/linux/thermal.h +0
-1- * effective. See Documentation/thermal/sysfs-api.txtfor
moreinclude/linux/thermal.h +1
-0+ * effective. See Documentation/thermal/sysfs-api.rstfor
more
* information.
*/
int weight;include/linux/thermal.h +0
-0@@ -259,7 +259,7 @@ struct thermal_bind_params { /** This is a bit mask that gives the binding relation between this
Quoted 8 lines
Quoted 8 lines
* thermal zone and cdev, for a particular trip point.
include/linux/thermal.h +0
-1- * See Documentation/thermal/sysfs-api.txt for moreinformation.
include/linux/thermal.h +1
-0+ * See Documentation/thermal/sysfs-api.rst for moreinformation.
*/
inttrip_mask;Thanks,
Mauro
PATCH 5/22 docs: rapidio: convert to ReST
In reply to Mauro Carvalho ChehabRename the rapidio 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/rapidio/index.rst | 15 +++++
.../{mport_cdev.txt => mport_cdev.rst} | 47 ++++++-------
.../rapidio/{rapidio.txt => rapidio.rst} | 39 +++++++----
.../rapidio/{rio_cm.txt => rio_cm.rst} | 66 ++++++++++++-------
.../rapidio/{sysfs.txt => sysfs.rst} | 4 ++
.../rapidio/{tsi721.txt => tsi721.rst} | 45 ++++++++-----
drivers/rapidio/Kconfig | 2 +-
7 files changed, 141 insertions(+), 77 deletions(-)
create mode 100644 Documentation/rapidio/index.rst
rename Documentation/rapidio/{mport_cdev.txt => mport_cdev.rst} (84%)
rename Documentation/rapidio/{rapidio.txt => rapidio.rst} (97%)
rename Documentation/rapidio/{rio_cm.txt => rio_cm.rst} (76%)
rename Documentation/rapidio/{sysfs.txt => sysfs.rst} (75%)
rename Documentation/rapidio/{tsi721.txt => tsi721.rst} (79%)Documentation/rapidio/index.rst new file +15 -0
@@ -0,0 +1,15 @@ +:orphan: + +=========================== +The Linux RapidIO Subsystem +=========================== + +.. toctree:: + :maxdepth: 1 + + rapidio + sysfs + + tsi721 + mport_cdev + rio_cm
Documentation/rapidio/mport_cdev.rst renamed from Documentation/rapidio/mport_cdev.txt +25 -22
107 lines not on this page · raw message
Documentation/rapidio/rapidio.rst renamed from Documentation/rapidio/rapidio.txt +25 -14
@@ -1,6 +1,6 @@ - The Linux RapidIO Subsystem - -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +============ +Introduction +============ The RapidIO standard is a packet-based fabric interconnect standard designed for use in embedded systems. Development of the RapidIO standard is directed by the
@@ -11,7 +11,7 @@ This document describes the basics of the Linux RapidIO subsystem and provides information on its major components. 1 Overview ----------- +========== Because the RapidIO subsystem follows the Linux device model it is integrated into the kernel similarly to other buses by defining RapidIO-specific device and
@@ -22,7 +22,7 @@ architecture-specific interfaces that provide support for common RapidIO subsystem operations. 2. Core Components ------------------- +================== A typical RapidIO network is a combination of endpoints and switches. Each of these components is represented in the subsystem by an associated data
@@ -30,6 +30,7 @@ structure. The core logical components of the RapidIO subsystem are defined in include/linux/rio.h file. 2.1 Master Port +--------------- A master port (or mport) is a RapidIO interface controller that is local to the processor executing the Linux code. A master port generates and receives RapidIO
@@ -46,6 +47,7 @@ includes rio_ops data structure which contains pointers to hardware specific implementations of RapidIO functions. 2.2 Device +---------- A RapidIO device is any endpoint (other than mport) or switch in the network. All devices are presented in the RapidIO subsystem by corresponding rio_dev data
@@ -53,6 +55,7 @@ structure. Devices form one global device list and per-network device lists (depending on number of available mports and networks). 2.3 Switch +---------- A RapidIO switch is a special class of device that routes packets between its ports towards their final destination. The packet destination port within a
@@ -66,6 +69,7 @@ specific switch drivers that are designed to provide hardware-specific implementation of common switch management routines. 2.4 Network +----------- A RapidIO network is a combination of interconnected endpoint and switch devices. Each RapidIO network known to the system is represented by corresponding rio_net
@@ -74,11 +78,13 @@ ports that form the same network. It also contains a pointer to the default master port that is used to communicate with devices within the network. 2.5 Device Drivers +------------------ RapidIO device-specific drivers follow Linux Kernel Driver Model and are intended to support specific RapidIO devices attached to the RapidIO network. 2.6 Subsystem Interfaces +------------------------ RapidIO interconnect specification defines features that may be used to provide one or more common service layers for all participating RapidIO devices. These
@@ -90,7 +96,7 @@ subsystem interfaces. This allows to have multiple common services attached to the same device without blocking attachment of a device-specific driver. 3. Subsystem Initialization ---------------------------- +=========================== In order to initialize the RapidIO subsystem, a platform must initialize and register at least one master port within the RapidIO network. To register mport
@@ -105,7 +111,7 @@ RapidIO subsystem can be configured to be built as a statically linked or modular component of the kernel (see details below). 4. Enumeration and Discovery ----------------------------- +============================ 4.1 Overview ------------
@@ -168,14 +174,16 @@ on RapidIO subsystem build configuration: (b) If the RapidIO subsystem core is built as a loadable module, in addition to the method shown above, the host destination ID(s) can be specified using traditional methods of passing module parameter "hdid=" during its loading: + - from command line: "modprobe rapidio hdid=-1,7", or - from modprobe configuration file using configuration command "options", like in this example: "options rapidio hdid=-1,7". An example of modprobe configuration file is provided in the section below. - NOTES: +NOTES: (i) if "hdid=" parameter is omitted all available mport will be assigned destination ID = -1; + (ii) the "hdid=" parameter in systems with multiple mports can have destination ID assignments omitted from the end of list (default = -1).
@@ -317,8 +325,7 @@ must ensure that they are loaded before the enumeration/discovery starts. This process can be automated by specifying pre- or post- dependencies in the RapidIO-specific modprobe configuration file as shown in the example below. - File /etc/modprobe.d/rapidio.conf: - ---------------------------------- +File /etc/modprobe.d/rapidio.conf:: # Configure RapidIO subsystem modules
@@ -335,17 +342,21 @@ RapidIO-specific modprobe configuration file as shown in the example below. -------------------------- -NOTE: In the example above, one of "softdep" commands must be removed or -commented out to keep required module loading sequence. +NOTE: + In the example above, one of "softdep" commands must be removed or + commented out to keep required module loading sequence. -A. References -------------- +5. References +============= [1] RapidIO Trade Association. RapidIO Interconnect Specifications. http://www.rapidio.org. + [2] Rapidio TA. Technology Comparisons. http://www.rapidio.org/education/technology_comparisons/ + [3] RapidIO support for Linux. http://lwn.net/Articles/139118/ + [4] Matt Porter. RapidIO for Linux. Ottawa Linux Symposium, 2005 http://www.kernel.org/doc/ols/2005/ols2005v2-pages-43-56.pdf
Documentation/rapidio/rio_cm.rst renamed from Documentation/rapidio/rio_cm.txt +41 -25
133 lines not on this page · raw message
Documentation/rapidio/sysfs.rst renamed from Documentation/rapidio/sysfs.txt +4 -0
@@ -1,3 +1,7 @@ +============= +Sysfs entries +============= + The RapidIO sysfs files have moved to: Documentation/ABI/testing/sysfs-bus-rapidio and Documentation/ABI/testing/sysfs-class-rapidio
Documentation/rapidio/tsi721.rst renamed from Documentation/rapidio/tsi721.txt +30 -15
98 lines not on this page · raw message
drivers/rapidio/Kconfig +1 -1
@@ -86,7 +86,7 @@ config RAPIDIO_CHMAN This option includes RapidIO channelized messaging driver which provides socket-like interface to allow sharing of single RapidIO messaging mailbox between multiple user-space applications. - See "Documentation/rapidio/rio_cm.txt" for driver description. + See "Documentation/rapidio/rio_cm.rst" for driver description. config RAPIDIO_MPORT_CDEV tristate "RapidIO /dev mport device driver"
Signature · 1 line
2.21.0
PATCH 6/22 docs: blockdev: convert to ReST
In reply to Mauro Carvalho ChehabRename the blockdev documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system.
The drbd sub-directory contains some graphs and data flows. Add those too to the 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.
---
.../admin-guide/kernel-parameters.txt | 18 +-
...structure-v9.txt => data-structure-v9.rst} | 6 +-
Documentation/blockdev/drbd/figures.rst | 28 +++
.../blockdev/drbd/{README.txt => index.rst} | 15 +-
.../blockdev/{floppy.txt => floppy.rst} | 88 ++++----
Documentation/blockdev/index.rst | 16 ++
Documentation/blockdev/{nbd.txt => nbd.rst} | 2 +-
.../blockdev/{paride.txt => paride.rst} | 194 +++++++++--------
.../blockdev/{ramdisk.txt => ramdisk.rst} | 55 ++---
Documentation/blockdev/{zram.txt => zram.rst} | 195 ++++++++++++------
MAINTAINERS | 8 +-
drivers/block/Kconfig | 8 +-
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +-
tools/testing/selftests/zram/README | 2 +-
15 files changed, 398 insertions(+), 245 deletions(-)
rename Documentation/blockdev/drbd/{data-structure-v9.txt => data-structure-v9.rst} (94%)
create mode 100644 Documentation/blockdev/drbd/figures.rst
rename Documentation/blockdev/drbd/{README.txt => index.rst} (55%)
rename Documentation/blockdev/{floppy.txt => floppy.rst} (81%)
create mode 100644 Documentation/blockdev/index.rst
rename Documentation/blockdev/{nbd.txt => nbd.rst} (96%)
rename Documentation/blockdev/{paride.txt => paride.rst} (81%)
rename Documentation/blockdev/{ramdisk.txt => ramdisk.rst} (84%)
rename Documentation/blockdev/{zram.txt => zram.rst} (76%)Documentation/admin-guide/kernel-parameters.txt +9 -9
@@ -1249,7 +1249,7 @@ See also Documentation/fault-injection/. floppy= [HW] - See Documentation/blockdev/floppy.txt. + See Documentation/blockdev/floppy.rst. force_pal_cache_flush [IA-64] Avoid check_sal_cache_flush which may hang on
@@ -2238,7 +2238,7 @@ memblock=debug [KNL] Enable memblock debug messages. load_ramdisk= [RAM] List of ramdisks to load from floppy - See Documentation/blockdev/ramdisk.txt. + See Documentation/blockdev/ramdisk.rst. lockd.nlm_grace_period=P [NFS] Assign grace period. Format: <integer>
@@ -3283,7 +3283,7 @@ pcd. [PARIDE] See header of drivers/block/paride/pcd.c. - See also Documentation/blockdev/paride.txt. + See also Documentation/blockdev/paride.rst. pci=option[,option...] [PCI] various PCI subsystem options.
@@ -3527,7 +3527,7 @@ needed on a platform with proper driver support. pd. [PARIDE] - See Documentation/blockdev/paride.txt. + See Documentation/blockdev/paride.rst. pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at boot time.
@@ -3542,10 +3542,10 @@ and performance comparison. pf. [PARIDE] - See Documentation/blockdev/paride.txt. + See Documentation/blockdev/paride.rst. pg. [PARIDE] - See Documentation/blockdev/paride.txt. + See Documentation/blockdev/paride.rst. pirq= [SMP,APIC] Manual mp-table setup See Documentation/x86/i386/IO-APIC.rst.
@@ -3657,7 +3657,7 @@ prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk before loading. - See Documentation/blockdev/ramdisk.txt. + See Documentation/blockdev/ramdisk.rst. psi= [KNL] Enable or disable pressure stall information tracking.
@@ -3679,7 +3679,7 @@ pstore.backend= Specify the name of the pstore backend to use pt. [PARIDE] - See Documentation/blockdev/paride.txt. + See Documentation/blockdev/paride.rst. pti= [X86_64] Control Page Table Isolation of user and kernel address spaces. Disabling this feature
@@ -3708,7 +3708,7 @@ See Documentation/admin-guide/md.rst. ramdisk_size= [RAM] Sizes of RAM disks in kilobytes - See Documentation/blockdev/ramdisk.txt. + See Documentation/blockdev/ramdisk.rst. random.trust_cpu={on,off} [KNL] Enable or disable trusting the use of the
Documentation/blockdev/drbd/data-structure-v9.rst renamed from Documentation/blockdev/drbd/data-structure-v9.txt +5 -1
@@ -1,3 +1,7 @@ +================================ +kernel data structure for DRBD-9 +================================ + This describes the in kernel data structure for DRBD-9. Starting with Linux v3.14 we are reorganizing DRBD to use this data structure.
@@ -10,7 +14,7 @@ device is represented by a block device locally. The DRBD objects are interconnected to form a matrix as depicted below; a drbd_peer_device object sits at each intersection between a drbd_device and a -drbd_connection: +drbd_connection:: /--------------+---------------+.....+---------------\ | resource | device | | device |
Documentation/blockdev/drbd/figures.rst new file +28 -0
@@ -0,0 +1,28 @@ +.. The here included files are intended to help understand the implementation + +Data flows that Relate some functions, and write packets +======================================================== + +.. kernel-figure:: DRBD-8.3-data-packets.svg + :alt: DRBD-8.3-data-packets.svg + :align: center + +.. kernel-figure:: DRBD-data-packets.svg + :alt: DRBD-data-packets.svg + :align: center + + +Sub graphs of DRBD's state transitions +====================================== + +.. kernel-figure:: conn-states-8.dot + :alt: conn-states-8.dot + :align: center + +.. kernel-figure:: disk-states-8.dot + :alt: disk-states-8.dot + :align: center + +.. kernel-figure:: node-states-8.dot + :alt: node-states-8.dot + :align: center
Documentation/blockdev/drbd/index.rst renamed from Documentation/blockdev/drbd/README.txt +9 -6
@@ -1,4 +1,9 @@ +========================================== +Distributed Replicated Block Device - DRBD +========================================== + Description +=========== DRBD is a shared-nothing, synchronously replicated block device. It is designed to serve as a building block for high availability
@@ -7,10 +12,8 @@ Description Please visit http://www.drbd.org to find out more. -The here included files are intended to help understand the implementation +.. toctree:: + :maxdepth: 1 -DRBD-8.3-data-packets.svg, DRBD-data-packets.svg - relates some functions, and write packets. - -conn-states-8.dot, disk-states-8.dot, node-states-8.dot - The sub graphs of DRBD's state transitions + data-structure-v9 + figures
Documentation/blockdev/floppy.rst renamed from Documentation/blockdev/floppy.txt +49 -39
190 lines not on this page · raw message
Documentation/blockdev/index.rst new file +16 -0
@@ -0,0 +1,16 @@ +:orphan: + +=========================== +The Linux RapidIO Subsystem +=========================== + +.. toctree:: + :maxdepth: 1 + + floppy + nbd + paride + ramdisk + zram + + drbd/index
Documentation/blockdev/nbd.rst renamed from Documentation/blockdev/nbd.txt +1 -1
@@ -1,3 +1,4 @@ +================================== Network Block Device (TCP version) ==================================
@@ -28,4 +29,3 @@ max_part nbds_max Number of block devices that should be initialized (default: 16). -
Documentation/blockdev/paride.rst renamed from Documentation/blockdev/paride.txt +108 -86
417 lines not on this page · raw message
Documentation/blockdev/ramdisk.rst renamed from Documentation/blockdev/ramdisk.txt +29 -26
140 lines not on this page · raw message
Documentation/blockdev/zram.rst renamed from Documentation/blockdev/zram.txt +131 -64
418 lines not on this page · raw message
MAINTAINERS +4 -4
@@ -10961,7 +10961,7 @@ M: Josef Bacik <[email protected]> S: Maintained L: [email protected] L: [email protected] -F: Documentation/blockdev/nbd.txt +F: Documentation/blockdev/nbd.rst F: drivers/block/nbd.c F: include/trace/events/nbd.h F: include/uapi/linux/nbd.h
@@ -11963,7 +11963,7 @@ PARIDE DRIVERS FOR PARALLEL PORT IDE DEVICES M: Tim Waugh <[email protected]> L: [email protected] (subscribers-only) S: Maintained -F: Documentation/blockdev/paride.txt +F: Documentation/blockdev/paride.rst F: drivers/block/paride/ PARISC ARCHITECTURE
@@ -13245,7 +13245,7 @@ F: drivers/net/wireless/ralink/rt2x00/ RAMDISK RAM BLOCK DEVICE DRIVER M: Jens Axboe <[email protected]> S: Maintained -F: Documentation/blockdev/ramdisk.txt +F: Documentation/blockdev/ramdisk.rst F: drivers/block/brd.c RANCHU VIRTUAL BOARD FOR MIPS
@@ -17584,7 +17584,7 @@ R: Sergey Senozhatsky <[email protected]> L: [email protected] S: Maintained F: drivers/block/zram/ -F: Documentation/blockdev/zram.txt +F: Documentation/blockdev/zram.rst ZS DECSTATION Z85C30 SERIAL DRIVER M: "Maciej W. Rozycki" <[email protected]>
drivers/block/Kconfig +4 -4
@@ -31,7 +31,7 @@ config BLK_DEV_FD If you want to use the floppy disk drive(s) of your PC under Linux, say Y. Information about this driver, especially important for IBM Thinkpad users, is contained in - <file:Documentation/blockdev/floppy.txt>. + <file:Documentation/blockdev/floppy.rst>. That file also contains the location of the Floppy driver FAQ as well as location of the fdutils package used to configure additional parameters of the driver at run time.
@@ -96,7 +96,7 @@ config PARIDE your computer's parallel port. Most of them are actually IDE devices using a parallel port IDE adapter. This option enables the PARIDE subsystem which contains drivers for many of these external drives. - Read <file:Documentation/blockdev/paride.txt> for more information. + Read <file:Documentation/blockdev/paride.rst> for more information. If you have said Y to the "Parallel-port support" configuration option, you may share a single port between your printer and other
@@ -261,7 +261,7 @@ config BLK_DEV_NBD userland (making server and client physically the same computer, communicating using the loopback network device). - Read <file:Documentation/blockdev/nbd.txt> for more information, + Read <file:Documentation/blockdev/nbd.rst> for more information, especially about where to find the server code, which runs in user space and does not need special kernel support.
@@ -303,7 +303,7 @@ config BLK_DEV_RAM during the initial install of Linux. Note that the kernel command line option "ramdisk=XX" is now obsolete. - For details, read <file:Documentation/blockdev/ramdisk.txt>. + For details, read <file:Documentation/blockdev/ramdisk.rst>. To compile this driver as a module, choose M here: the module will be called brd. An alias "rd" has been defined
drivers/block/floppy.c +1 -1
@@ -4424,7 +4424,7 @@ static int __init floppy_setup(char *str)pr_cont ("\n" ); }else DPRINT ("botched floppy option\n" ); -DPRINT ("Read Documentation/blockdev/floppy.txt\n" ); +DPRINT ("Read Documentation/blockdev/floppy.rst\n" );return 0 ; }
drivers/block/zram/Kconfig +3 -3
@@ -12,7 +12,7 @@ config ZRAM It has several use cases, for example: /tmp storage, use as swap disks and maybe many more. - See Documentation/blockdev/zram.txt for more information. + See Documentation/blockdev/zram.rst for more information. config ZRAM_WRITEBACK bool "Write back incompressible or idle page to backing device"
@@ -26,7 +26,7 @@ config ZRAM_WRITEBACK With /sys/block/zramX/{idle,writeback}, application could ask idle page's writeback to the backing device to save in memory. - See Documentation/blockdev/zram.txt for more information. + See Documentation/blockdev/zram.rst for more information. config ZRAM_MEMORY_TRACKING bool "Track zRam block status"
@@ -36,4 +36,4 @@ config ZRAM_MEMORY_TRACKING of zRAM. Admin could see the information via /sys/kernel/debug/zram/zramX/block_state. - See Documentation/blockdev/zram.txt for more information. + See Documentation/blockdev/zram.rst for more information.
tools/testing/selftests/zram/README +1 -1
@@ -37,4 +37,4 @@ Commands required for testing: - mkfs/ mkfs.ext4 For more information please refer: -kernel-source-tree/Documentation/blockdev/zram.txt +kernel-source-tree/Documentation/blockdev/zram.rst
Signature · 1 line
2.21.0
PATCH 7/22 docs: perf: convert to ReST
In reply to Mauro Carvalho ChehabRename the perf 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.
---
.../perf/{arm-ccn.txt => arm-ccn.rst} | 18 +++++-----
.../perf/{arm_dsu_pmu.txt => arm_dsu_pmu.rst} | 5 +--
.../perf/{hisi-pmu.txt => hisi-pmu.rst} | 35 +++++++++++--------
Documentation/perf/index.rst | 16 +++++++++
.../perf/{qcom_l2_pmu.txt => qcom_l2_pmu.rst} | 3 +-
.../perf/{qcom_l3_pmu.txt => qcom_l3_pmu.rst} | 3 +-
.../{thunderx2-pmu.txt => thunderx2-pmu.rst} | 25 ++++++-------
.../perf/{xgene-pmu.txt => xgene-pmu.rst} | 3 +-
MAINTAINERS | 4 +--
drivers/perf/qcom_l3_pmu.c | 2 +-
10 files changed, 72 insertions(+), 42 deletions(-)
rename Documentation/perf/{arm-ccn.txt => arm-ccn.rst} (86%)
rename Documentation/perf/{arm_dsu_pmu.txt => arm_dsu_pmu.rst} (92%)
rename Documentation/perf/{hisi-pmu.txt => hisi-pmu.rst} (73%)
create mode 100644 Documentation/perf/index.rst
rename Documentation/perf/{qcom_l2_pmu.txt => qcom_l2_pmu.rst} (94%)
rename Documentation/perf/{qcom_l3_pmu.txt => qcom_l3_pmu.rst} (93%)
rename Documentation/perf/{thunderx2-pmu.txt => thunderx2-pmu.rst} (73%)
rename Documentation/perf/{xgene-pmu.txt => xgene-pmu.rst} (96%)Documentation/perf/arm-ccn.rst renamed from Documentation/perf/arm-ccn.txt +10 -8
@@ -1,3 +1,4 @@ +========================== ARM Cache Coherent Network ==========================
@@ -29,6 +30,7 @@ Crosspoint watchpoint-based events (special "event" value 0xfe) require "xp" and "vc" as as above plus "port" (device port index), "dir" (transmit/receive direction), comparator values ("cmp_l" and "cmp_h") and "mask", being index of the comparator mask. + Masks are defined separately from the event description (due to limited number of the config values) in the "cmp_mask" directory, with first 8 configurable by user and additional
@@ -44,16 +46,16 @@ request the events on this processor (if not, the perf_event->cpu value will be overwritten anyway). In case of this processor being offlined, the events are migrated to another one and the attribute is updated. -Example of perf tool use: +Example of perf tool use:: -/ # perf list | grep ccn - ccn/cycles/ [Kernel PMU event] -<...> - ccn/xp_valid_flit,xp=?,port=?,vc=?,dir=?/ [Kernel PMU event] -<...> + / # perf list | grep ccn + ccn/cycles/ [Kernel PMU event] + <...> + ccn/xp_valid_flit,xp=?,port=?,vc=?,dir=?/ [Kernel PMU event] + <...> -/ # perf stat -a -e ccn/cycles/,ccn/xp_valid_flit,xp=1,port=0,vc=1,dir=1/ \ - sleep 1 + / # perf stat -a -e ccn/cycles/,ccn/xp_valid_flit,xp=1,port=0,vc=1,dir=1/ \ + sleep 1 The driver does not support sampling, therefore "perf record" will not work. Per-task (without "-a") perf sessions are not supported.
Documentation/perf/arm_dsu_pmu.rst renamed from Documentation/perf/arm_dsu_pmu.txt +3 -2
@@ -1,3 +1,4 @@ +================================== ARM DynamIQ Shared Unit (DSU) PMU ==================================
@@ -13,7 +14,7 @@ PMU doesn't support process specific events and cannot be used in sampling mode. The DSU provides a bitmap for a subset of implemented events via hardware registers. There is no way for the driver to determine if the other events are available or not. Hence the driver exposes only those events advertised -by the DSU, in "events" directory under : +by the DSU, in "events" directory under:: /sys/bus/event_sources/devices/arm_dsu_<N>/
@@ -23,6 +24,6 @@ and use the raw event code for the unlisted events. The driver also exposes the CPUs connected to the DSU instance in "associated_cpus". -e.g usage : +e.g usage:: perf stat -a -e arm_dsu_0/cycles/
Documentation/perf/hisi-pmu.rst renamed from Documentation/perf/hisi-pmu.txt +21 -14
@@ -1,5 +1,7 @@ +====================================================== HiSilicon SoC uncore Performance Monitoring Unit (PMU) ====================================================== + The HiSilicon SoC chip includes various independent system device PMUs such as L3 cache (L3C), Hydra Home Agent (HHA) and DDRC. These PMUs are independent and have hardware logic to gather statistics and performance
@@ -11,11 +13,13 @@ called Super CPU cluster (SCCL) and is made up of 6 CCLs. Each SCCL has two HHAs (0 - 1) and four DDRCs (0 - 3), respectively. HiSilicon SoC uncore PMU driver ---------------------------------------- +------------------------------- + Each device PMU has separate registers for event counting, control and interrupt, and the PMU driver shall register perf PMU drivers like L3C, HHA and DDRC etc. The available events and configuration options shall -be described in the sysfs, see : +be described in the sysfs, see: + /sys/devices/hisi_sccl{X}_<l3c{Y}/hha{Y}/ddrc{Y}>/, or /sys/bus/event_source/devices/hisi_sccl{X}_<l3c{Y}/hha{Y}/ddrc{Y}>. The "perf list" command shall list the available events from sysfs.
@@ -24,27 +28,30 @@ Each L3C, HHA and DDRC is registered as a separate PMU with perf. The PMU name will appear in event listing as hisi_sccl<sccl-id>_module<index-id>. where "sccl-id" is the identifier of the SCCL and "index-id" is the index of module. + e.g. hisi_sccl3_l3c0/rd_hit_cpipe is READ_HIT_CPIPE event of L3C index #0 in SCCL ID #3. + e.g. hisi_sccl1_hha0/rx_operations is RX_OPERATIONS event of HHA index #0 in SCCL ID #1. The driver also provides a "cpumask" sysfs attribute, which shows the CPU core ID used to count the uncore PMU event. -Example usage of perf: -$# perf list -hisi_sccl3_l3c0/rd_hit_cpipe/ [kernel PMU event] ------------------------------------------- -hisi_sccl3_l3c0/wr_hit_cpipe/ [kernel PMU event] ------------------------------------------- -hisi_sccl1_l3c0/rd_hit_cpipe/ [kernel PMU event] ------------------------------------------- -hisi_sccl1_l3c0/wr_hit_cpipe/ [kernel PMU event] ------------------------------------------- +Example usage of perf:: -$# perf stat -a -e hisi_sccl3_l3c0/rd_hit_cpipe/ sleep 5 -$# perf stat -a -e hisi_sccl3_l3c0/config=0x02/ sleep 5 + $# perf list + hisi_sccl3_l3c0/rd_hit_cpipe/ [kernel PMU event] + ------------------------------------------ + hisi_sccl3_l3c0/wr_hit_cpipe/ [kernel PMU event] + ------------------------------------------ + hisi_sccl1_l3c0/rd_hit_cpipe/ [kernel PMU event] + ------------------------------------------ + hisi_sccl1_l3c0/wr_hit_cpipe/ [kernel PMU event] + ------------------------------------------ + + $# perf stat -a -e hisi_sccl3_l3c0/rd_hit_cpipe/ sleep 5 + $# perf stat -a -e hisi_sccl3_l3c0/config=0x02/ sleep 5 The current driver does not support sampling. So "perf record" is unsupported. Also attach to a task is unsupported as the events are all uncore.
Documentation/perf/index.rst new file +16 -0
@@ -0,0 +1,16 @@ +:orphan: + +=========================== +Performance monitor support +=========================== + +.. toctree:: + :maxdepth: 1 + + hisi-pmu + qcom_l2_pmu + qcom_l3_pmu + arm-ccn + xgene-pmu + arm_dsu_pmu + thunderx2-pmu
Documentation/perf/qcom_l2_pmu.rst renamed from Documentation/perf/qcom_l2_pmu.txt +2 -1
@@ -1,3 +1,4 @@ +===================================================================== Qualcomm Technologies Level-2 Cache Performance Monitoring Unit (PMU) =====================================================================
@@ -28,7 +29,7 @@ The driver provides a "cpumask" sysfs attribute which contains a mask consisting of one CPU per cluster which will be used to handle all the PMU events on that cluster. -Examples for use with perf: +Examples for use with perf:: perf stat -e l2cache_0/config=0x001/,l2cache_0/config=0x042/ -a sleep 1
Documentation/perf/qcom_l3_pmu.rst renamed from Documentation/perf/qcom_l3_pmu.txt +2 -1
@@ -1,3 +1,4 @@ +=========================================================================== Qualcomm Datacenter Technologies L3 Cache Performance Monitoring Unit (PMU) ===========================================================================
@@ -17,7 +18,7 @@ The hardware implements 32bit event counters and has a flat 8bit event space exposed via the "event" format attribute. In addition to the 32bit physical counters the driver supports virtual 64bit hardware counters by using hardware counter chaining. This feature is exposed via the "lc" (long counter) format -flag. E.g.: +flag. E.g.:: perf stat -e l3cache_0_0/read-miss,lc/
Documentation/perf/thunderx2-pmu.rst renamed from Documentation/perf/thunderx2-pmu.txt +13 -12
@@ -1,3 +1,4 @@ +============================================================= Cavium ThunderX2 SoC Performance Monitoring Unit (PMU UNCORE) =============================================================
@@ -24,18 +25,18 @@ and configuration options under sysfs, see The driver does not support sampling, therefore "perf record" will not work. Per-task perf sessions are also not supported. -Examples: +Examples:: -# perf stat -a -e uncore_dmc_0/cnt_cycles/ sleep 1 + # perf stat -a -e uncore_dmc_0/cnt_cycles/ sleep 1 -# perf stat -a -e \ -uncore_dmc_0/cnt_cycles/,\ -uncore_dmc_0/data_transfers/,\ -uncore_dmc_0/read_txns/,\ -uncore_dmc_0/write_txns/ sleep 1 + # perf stat -a -e \ + uncore_dmc_0/cnt_cycles/,\ + uncore_dmc_0/data_transfers/,\ + uncore_dmc_0/read_txns/,\ + uncore_dmc_0/write_txns/ sleep 1 -# perf stat -a -e \ -uncore_l3c_0/read_request/,\ -uncore_l3c_0/read_hit/,\ -uncore_l3c_0/inv_request/,\ -uncore_l3c_0/inv_hit/ sleep 1 + # perf stat -a -e \ + uncore_l3c_0/read_request/,\ + uncore_l3c_0/read_hit/,\ + uncore_l3c_0/inv_request/,\ + uncore_l3c_0/inv_hit/ sleep 1
Documentation/perf/xgene-pmu.rst renamed from Documentation/perf/xgene-pmu.txt +2 -1
@@ -1,3 +1,4 @@ +================================================ APM X-Gene SoC Performance Monitoring Unit (PMU) ================================================
@@ -33,7 +34,7 @@ each PMU, please refer to APM X-Gene User Manual. Each perf driver also provides a "cpumask" sysfs attribute, which contains a single CPU ID of the processor which will be used to handle all the PMU events. -Example for perf tool use: +Example for perf tool use:: / # perf list | grep -e l3c -e iob -e mcb -e mc l3c0/ackq-full/ [Kernel PMU event]
MAINTAINERS +2 -2
@@ -1139,7 +1139,7 @@ APPLIED MICRO (APM) X-GENE SOC PMU M: Khuong Dinh <[email protected]> S: Supported F: drivers/perf/xgene_pmu.c -F: Documentation/perf/xgene-pmu.txt +F: Documentation/perf/xgene-pmu.rst F: Documentation/devicetree/bindings/perf/apm-xgene-pmu.txt APTINA CAMERA SENSOR PLL
@@ -7180,7 +7180,7 @@ M: Shaokun Zhang <[email protected]> W: http://www.hisilicon.com S: Supported F: drivers/perf/hisilicon -F: Documentation/perf/hisi-pmu.txt +F: Documentation/perf/hisi-pmu.rst HISILICON ROCE DRIVER M: Lijun Ou <[email protected]>
drivers/perf/qcom_l3_pmu.c +1 -1
@@ -8,7 +8,7 @@* the slices. User space needs to aggregate to individual counts to provide * a global picture. * -* See Documentation/perf/qcom_l3_pmu.txt for more details. +* See Documentation/perf/qcom_l3_pmu.rst for more details. * * Copyright (c) 2015-2017, The Linux Foundation. All rights reserved. */
Signature · 7 lines
2.21.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH 8/22 docs: sysctl: convert to ReST
In reply to Mauro Carvalho ChehabRename the /proc/sys/ documentation files to ReST, using the README file as a template for an index.rst, adding the other files there via TOC markup.
Despite being written on different times with different styles, try to make them somewhat coherent with a similar look and feel, ensuring that they'll look nice as both raw text file and as via the html output produced by 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.
---
.../admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/mm/index.rst | 2 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
Documentation/core-api/printk-formats.rst | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/sysctl/{abi.txt => abi.rst} | 71 ++--
Documentation/sysctl/{fs.txt => fs.rst} | 142 +++----
Documentation/sysctl/{README => index.rst} | 36 +-
.../sysctl/{kernel.txt => kernel.rst} | 374 ++++++++++--------
Documentation/sysctl/{net.txt => net.rst} | 141 ++++---
.../sysctl/{sunrpc.txt => sunrpc.rst} | 13 +-
Documentation/sysctl/{user.txt => user.rst} | 32 +-
Documentation/sysctl/{vm.txt => vm.rst} | 258 ++++++------
Documentation/vm/unevictable-lru.rst | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
16 files changed, 626 insertions(+), 457 deletions(-)
rename Documentation/sysctl/{abi.txt => abi.rst} (30%)
rename Documentation/sysctl/{fs.txt => fs.rst} (77%)
rename Documentation/sysctl/{README => index.rst} (78%)
rename Documentation/sysctl/{kernel.txt => kernel.rst} (79%)
rename Documentation/sysctl/{net.txt => net.rst} (85%)
rename Documentation/sysctl/{sunrpc.txt => sunrpc.rst} (62%)
rename Documentation/sysctl/{user.txt => user.rst} (77%)
rename Documentation/sysctl/{vm.txt => vm.rst} (85%)Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -3159,7 +3159,7 @@ numa_zonelist_order= [KNL, BOOT] Select zonelist order for NUMA. 'node', 'default' can be specified This can be set from sysctl after boot. - See Documentation/sysctl/vm.txt for details. + 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
Documentation/admin-guide/mm/index.rst +1 -1
@@ -11,7 +11,7 @@ processes address space and many other cool things. Linux memory management is a complex system with many configurable settings. Most of these settings are available via ``/proc`` filesystem and can be quired and adjusted using ``sysctl``. These APIs -are described in Documentation/sysctl/vm.txt and in `man 5 proc`_. +are described in Documentation/sysctl/vm.rst and in `man 5 proc`_. .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
Documentation/admin-guide/mm/ksm.rst +1 -1
@@ -59,7 +59,7 @@ MADV_UNMERGEABLE is applied to a range which was never MADV_MERGEABLE. If a region of memory must be split into at least one new MADV_MERGEABLE or MADV_UNMERGEABLE region, the madvise may return ENOMEM if the process -will exceed ``vm.max_map_count`` (see Documentation/sysctl/vm.txt). +will exceed ``vm.max_map_count`` (see Documentation/sysctl/vm.rst). Like other madvise calls, they are intended for use on mapped areas of the user address space: they will report ENOMEM if the specified range
Documentation/core-api/printk-formats.rst +1 -1
@@ -119,7 +119,7 @@ Kernel Pointers For printing kernel pointers which should be hidden from unprivileged users. The behaviour of %pK depends on the kptr_restrict sysctl - see -Documentation/sysctl/kernel.txt for more details. +Documentation/sysctl/kernel.rst for more details. Unmodified Addresses --------------------
Documentation/networking/ip-sysctl.txt +1 -1
@@ -2276,7 +2276,7 @@ addr_scope_policy - INTEGER /proc/sys/net/core/* - Please see: Documentation/sysctl/net.txt for descriptions of these entries. + Please see: Documentation/sysctl/net.rst for descriptions of these entries. /proc/sys/net/unix/*
Documentation/sysctl/abi.rst renamed from Documentation/sysctl/abi.txt +42 -29
94 lines not on this page · raw message
Documentation/sysctl/fs.rst renamed from Documentation/sysctl/fs.txt +76 -66
302 lines not on this page · raw message
Documentation/sysctl/index.rst renamed from Documentation/sysctl/README +30 -6
@@ -1,5 +1,12 @@ -Documentation for /proc/sys/ kernel version 2.2.10 - (c) 1998, 1999, Rik van Riel <[email protected]> +:orphan: + +=========================== +Documentation for /proc/sys +=========================== + +Copyright (c) 1998, 1999, Rik van Riel <[email protected]> + +------------------------------------------------------------------------------ 'Why', I hear you ask, 'would anyone even _want_ documentation for them sysctl files? If anybody really needs it, it's all in
@@ -12,11 +19,12 @@ have the time or knowledge to read the source code. Furthermore, the programmers who built sysctl have built it to be actually used, not just for the fun of programming it :-) -============================================================== +------------------------------------------------------------------------------ Legal blurb: As usual, there are two main things to consider: + 1. you get what you pay for 2. it's free
@@ -35,15 +43,17 @@ stories to: <[email protected]> Rik van Riel. -============================================================== +-------------------------------------------------------------- -Introduction: +Introduction +============ Sysctl is a means of configuring certain aspects of the kernel at run-time, and the /proc/sys/ directory is there so that you don't even need special tools to do it! In fact, there are only four things needed to use these config facilities: + - a running Linux system - root access - common sense (this is especially hard to come by these days)
@@ -54,7 +64,9 @@ several (arch-dependent?) subdirs. Each subdir is mainly about one part of the kernel, so you can do configuration on a piece by piece basis, or just some 'thematic frobbing'. -The subdirs are about: +This documentation is about: + +=============== =============================================================== abi/ execution domains & personalities debug/ <empty> dev/ device specific information (eg dev/cdrom/info)
@@ -70,7 +82,19 @@ sunrpc/ SUN Remote Procedure Call (NFS) vm/ memory management tuning buffer and cache management user/ Per user per user namespace limits +=============== =============================================================== These are the subdirs I have on my system. There might be more or other subdirs in another setup. If you see another dir, I'd really like to hear about it :-) + +.. toctree:: + :maxdepth: 1 + + abi + fs + kernel + net + sunrpc + user + vm
Documentation/sysctl/kernel.rst renamed from Documentation/sysctl/kernel.txt +211 -163
1,023 lines not on this page · raw message
Documentation/sysctl/net.rst renamed from Documentation/sysctl/net.txt +90 -51
300 lines not on this page · raw message
Documentation/sysctl/sunrpc.rst renamed from Documentation/sysctl/sunrpc.txt +9 -4
@@ -1,9 +1,14 @@ -Documentation for /proc/sys/sunrpc/* kernel version 2.2.10 - (c) 1998, 1999, Rik van Riel <[email protected]> +=================================== +Documentation for /proc/sys/sunrpc/ +=================================== -For general info and legal blurb, please look in README. +kernel version 2.2.10 -============================================================== +Copyright (c) 1998, 1999, Rik van Riel <[email protected]> + +For general info and legal blurb, please look in index.rst. + +------------------------------------------------------------------------------ This file contains the documentation for the sysctl files in /proc/sys/sunrpc and is valid for Linux kernel version 2.2.
Documentation/sysctl/user.rst renamed from Documentation/sysctl/user.txt +22 -10
@@ -1,7 +1,12 @@ -Documentation for /proc/sys/user/* kernel version 4.9.0 - (c) 2016 Eric Biederman <[email protected]> +================================= +Documentation for /proc/sys/user/ +================================= -============================================================== +kernel version 4.9.0 + +Copyright (c) 2016 Eric Biederman <[email protected]> + +------------------------------------------------------------------------------ This file contains the documentation for the sysctl files in /proc/sys/user.
@@ -30,37 +35,44 @@ user namespace does not allow a user to escape their current limits. Currently, these files are in /proc/sys/user: -- max_cgroup_namespaces +max_cgroup_namespaces +===================== The maximum number of cgroup namespaces that any user in the current user namespace may create. -- max_ipc_namespaces +max_ipc_namespaces +================== The maximum number of ipc namespaces that any user in the current user namespace may create. -- max_mnt_namespaces +max_mnt_namespaces +================== The maximum number of mount namespaces that any user in the current user namespace may create. -- max_net_namespaces +max_net_namespaces +================== The maximum number of network namespaces that any user in the current user namespace may create. -- max_pid_namespaces +max_pid_namespaces +================== The maximum number of pid namespaces that any user in the current user namespace may create. -- max_user_namespaces +max_user_namespaces +=================== The maximum number of user namespaces that any user in the current user namespace may create. -- max_uts_namespaces +max_uts_namespaces +================== The maximum number of user namespaces that any user in the current user namespace may create.
Documentation/sysctl/vm.rst renamed from Documentation/sysctl/vm.txt +138 -120
723 lines not on this page · raw message
Documentation/vm/unevictable-lru.rst +1 -1
@@ -439,7 +439,7 @@ Compacting MLOCKED Pages The unevictable LRU can be scanned for compactable regions and the default behavior is to do so. /proc/sys/vm/compact_unevictable_allowed controls -this behavior (see Documentation/sysctl/vm.txt). Once scanning of the +this behavior (see Documentation/sysctl/vm.rst). Once scanning of the unevictable LRU is enabled, the work of compaction is mostly handled by the page migration code and the same work flow as described in MIGRATING MLOCKED PAGES will apply.
kernel/panic.c +1 -1
@@ -372,7 +372,7 @@ const struct taint_flag taint_flags[TAINT_FLAGS_COUNT] = {/** * print_tainted - return a string to represent the kernel taint state. * -* For individual taint flag meanings, see Documentation/sysctl/kernel.txt +* For individual taint flag meanings, see Documentation/sysctl/kernel.rst * * The string is overwritten by the next call to print_tainted(), * but is always NULL terminated.
mm/swap.c +1 -1
@@ -8,7 +8,7 @@/* * This file contains the default values for the operation of the * Linux VM subsystem. Fine-tuning documentation can be found in -* Documentation/sysctl/vm.txt. +* Documentation/sysctl/vm.rst. * Started 18.12.91 * Swap aging added 23.2.95, Stephen Tweedie. * Buffermem limits added 12.3.98, Rik van Riel.
Signature · 1 line
2.21.0
PATCH 9/22 docs: block: convert to ReST
In reply to Mauro Carvalho ChehabRename the block 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.
---
.../admin-guide/kernel-parameters.txt | 8 +-
.../{bfq-iosched.txt => bfq-iosched.rst} | 66 ++--
.../block/{biodoc.txt => biodoc.rst} | 364 +++++++++++-------
.../block/{biovecs.txt => biovecs.rst} | 20 +-
.../block/{capability.txt => capability.rst} | 17 +-
...ne-partition.txt => cmdline-partition.rst} | 13 +-
...{data-integrity.txt => data-integrity.rst} | 60 +--
...dline-iosched.txt => deadline-iosched.rst} | 21 +-
Documentation/block/index.rst | 25 ++
.../block/{ioprio.txt => ioprio.rst} | 95 +++--
.../{kyber-iosched.txt => kyber-iosched.rst} | 3 +-
.../block/{null_blk.txt => null_blk.rst} | 65 +++-
Documentation/block/{pr.txt => pr.rst} | 18 +-
.../{queue-sysfs.txt => queue-sysfs.rst} | 7 +-
.../block/{request.txt => request.rst} | 47 ++-
Documentation/block/{stat.txt => stat.rst} | 13 +-
...witching-sched.txt => switching-sched.rst} | 28 +-
...ontrol.txt => writeback_cache_control.rst} | 12 +-
Documentation/blockdev/zram.rst | 2 +-
MAINTAINERS | 2 +-
block/Kconfig | 2 +-
block/Kconfig.iosched | 2 +-
block/bfq-iosched.c | 2 +-
block/blk-integrity.c | 2 +-
block/ioprio.c | 2 +-
block/mq-deadline.c | 2 +-
block/partitions/cmdline.c | 2 +-
27 files changed, 550 insertions(+), 350 deletions(-)
rename Documentation/block/{bfq-iosched.txt => bfq-iosched.rst} (95%)
rename Documentation/block/{biodoc.txt => biodoc.rst} (83%)
rename Documentation/block/{biovecs.txt => biovecs.rst} (92%)
rename Documentation/block/{capability.txt => capability.rst} (40%)
rename Documentation/block/{cmdline-partition.txt => cmdline-partition.rst} (92%)
rename Documentation/block/{data-integrity.txt => data-integrity.rst} (91%)
rename Documentation/block/{deadline-iosched.txt => deadline-iosched.rst} (89%)
create mode 100644 Documentation/block/index.rst
rename Documentation/block/{ioprio.txt => ioprio.rst} (75%)
rename Documentation/block/{kyber-iosched.txt => kyber-iosched.rst} (86%)
rename Documentation/block/{null_blk.txt => null_blk.rst} (60%)
rename Documentation/block/{pr.txt => pr.rst} (93%)
rename Documentation/block/{queue-sysfs.txt => queue-sysfs.rst} (99%)
rename Documentation/block/{request.txt => request.rst} (59%)
rename Documentation/block/{stat.txt => stat.rst} (89%)
rename Documentation/block/{switching-sched.txt => switching-sched.rst} (67%)
rename Documentation/block/{writeback_cache_control.txt => writeback_cache_control.rst} (94%)Documentation/admin-guide/kernel-parameters.txt +4 -4
@@ -430,7 +430,7 @@ blkdevparts= Manual partition parsing of block device(s) for embedded devices based on command line input. - See Documentation/block/cmdline-partition.txt + See Documentation/block/cmdline-partition.rst boot_delay= Milliseconds to delay each printk during boot. Values larger than 10 seconds (10000) are changed to
@@ -1199,9 +1199,9 @@ elevator= [IOSCHED] Format: { "mq-deadline" | "kyber" | "bfq" } - See Documentation/block/deadline-iosched.txt, - Documentation/block/kyber-iosched.txt and - Documentation/block/bfq-iosched.txt for details. + See Documentation/block/deadline-iosched.rst, + Documentation/block/kyber-iosched.rst and + Documentation/block/bfq-iosched.rst for details. elfcorehdr=[size[KMG]@]offset[KMG] [IA64,PPC,SH,X86,S390] Specifies physical address of start of kernel core
Documentation/block/bfq-iosched.rst renamed from Documentation/block/bfq-iosched.txt +40 -26
159 lines not on this page · raw message
Documentation/block/biodoc.rst renamed from Documentation/block/biodoc.txt +228 -136
714 lines not on this page · raw message
Documentation/block/biovecs.rst renamed from Documentation/block/biovecs.txt +11 -9
@@ -1,6 +1,6 @@ - -Immutable biovecs and biovec iterators: -======================================= +====================================== +Immutable biovecs and biovec iterators +====================================== Kent Overstreet <[email protected]>
@@ -121,10 +121,12 @@ Other implications: Usage of helpers: ================= -* The following helpers whose names have the suffix of "_all" can only be used -on non-BIO_CLONED bio. They are usually used by filesystem code. Drivers -shouldn't use them because the bio may have been split before it reached the -driver. +* The following helpers whose names have the suffix of `_all` can only be used + on non-BIO_CLONED bio. They are usually used by filesystem code. Drivers + shouldn't use them because the bio may have been split before it reached the + driver. + +:: bio_for_each_segment_all() bio_first_bvec_all()
@@ -132,13 +134,13 @@ driver. bio_last_bvec_all() * The following helpers iterate over single-page segment. The passed 'struct -bio_vec' will contain a single-page IO vector during the iteration + bio_vec' will contain a single-page IO vector during the iteration:: bio_for_each_segment() bio_for_each_segment_all() * The following helpers iterate over multi-page bvec. The passed 'struct -bio_vec' will contain a multi-page IO vector during the iteration + bio_vec' will contain a multi-page IO vector during the iteration:: bio_for_each_bvec() rq_for_each_bvec()
Documentation/block/capability.rst renamed from Documentation/block/capability.txt +10 -7
@@ -1,15 +1,18 @@ +=============================== Generic Block Device Capability -=============================================================================== +=============================== + This file documents the sysfs file block/<disk>/capability capability is a hex word indicating which capabilities a specific disk supports. For more information on bits not listed here, see include/linux/genhd.h -Capability Value -------------------------------------------------------------------------------- -GENHD_FL_MEDIA_CHANGE_NOTIFY 4 - When this bit is set, the disk supports Asynchronous Notification - of media change events. These events will be broadcast to user - space via kernel uevent. +GENHD_FL_MEDIA_CHANGE_NOTIFY +---------------------------- +Value: 4 + +When this bit is set, the disk supports Asynchronous Notification +of media change events. These events will be broadcast to user +space via kernel uevent.
Documentation/block/cmdline-partition.rst renamed from Documentation/block/cmdline-partition.txt +10 -3
@@ -1,5 +1,6 @@ +============================================== Embedded device command line partition parsing -===================================================================== +============================================== The "blkdevparts" command line option adds support for reading the block device partition table from the kernel command line.
@@ -22,12 +23,15 @@ blkdevparts=<blkdev-def>[;<blkdev-def>] <size> partition size, in bytes, such as: 512, 1m, 1G. size may contain an optional suffix of (upper or lower case): + K, M, G, T, P, E. + "-" is used to denote all remaining space. <offset> partition start address, in bytes. offset may contain an optional suffix of (upper or lower case): + K, M, G, T, P, E. (part-name)
@@ -36,11 +40,14 @@ blkdevparts=<blkdev-def>[;<blkdev-def>] User space application can access partition by partition name. Example: + eMMC disk names are "mmcblk0" and "mmcblk0boot0". - bootargs: + bootargs:: + 'blkdevparts=mmcblk0:1G(data0),1G(data1),-;mmcblk0boot0:1m(boot),-(kernel)' - dmesg: + dmesg:: + mmcblk0: p1(data0) p2(data1) p3() mmcblk0boot0: p1(boot) p2(kernel)
Documentation/block/data-integrity.rst renamed from Documentation/block/data-integrity.txt +35 -25
154 lines not on this page · raw message
Documentation/block/deadline-iosched.rst renamed from Documentation/block/deadline-iosched.txt +9 -12
@@ -1,3 +1,4 @@ +============================== Deadline IO scheduler tunables ==============================
@@ -7,15 +8,13 @@ of interest to power users. Selecting IO schedulers ----------------------- -Refer to Documentation/block/switching-sched.txt for information on +Refer to Documentation/block/switching-sched.rst for information on selecting an io scheduler on a per-device basis. - -******************************************************************************** - +------------------------------------------------------------------------------ read_expire (in ms) ------------ +----------------------- The goal of the deadline io scheduler is to attempt to guarantee a start service time for a request. As we focus mainly on read latencies, this is
@@ -25,15 +24,15 @@ milliseconds. write_expire (in ms) ------------ +----------------------- Similar to read_expire mentioned above, but for writes. fifo_batch (number of requests) ----------- +------------------------------------ -Requests are grouped into ``batches'' of a particular data direction (read or +Requests are grouped into ``batches`` of a particular data direction (read or write) which are serviced in increasing sector order. To limit extra seeking, deadline expiries are only checked between batches. fifo_batch controls the maximum number of requests per batch.
@@ -45,7 +44,7 @@ generally improves throughput, at the cost of latency variation. writes_starved (number of dispatches) --------------- +-------------------------------------- When we have to move requests from the io scheduler queue to the block device dispatch queue, we always give a preference to reads. However, we
@@ -56,7 +55,7 @@ same criteria as reads. front_merges (bool) ------------- +---------------------- Sometimes it happens that a request enters the io scheduler that is contiguous with a request that is already on the queue. Either it fits in the back of that
@@ -71,5 +70,3 @@ rbtree front sector lookup when the io scheduler merge function is called. Nov 11 2002, Jens Axboe <[email protected]> - -
Documentation/block/index.rst new file +25 -0
@@ -0,0 +1,25 @@ +:orphan: + +===== +Block +===== + +.. toctree:: + :maxdepth: 1 + + bfq-iosched + biodoc + biovecs + capability + cmdline-partition + data-integrity + deadline-iosched + ioprio + kyber-iosched + null_blk + pr + queue-sysfs + request + stat + switching-sched + writeback_cache_control
Documentation/block/ioprio.rst renamed from Documentation/block/ioprio.txt +47 -48
140 lines not on this page · raw message
Documentation/block/kyber-iosched.rst renamed from Documentation/block/kyber-iosched.txt +2 -1
@@ -1,5 +1,6 @@ +============================ Kyber I/O scheduler tunables -=========================== +============================ The only two tunables for the Kyber scheduler are the target latencies for reads and synchronous writes. Kyber will throttle requests in order to meet
Documentation/block/null_blk.rst renamed from Documentation/block/null_blk.txt +46 -19
121 lines not on this page · raw message
Documentation/block/pr.rst renamed from Documentation/block/pr.txt +9 -9
@@ -1,4 +1,4 @@ - +=============================================== Block layer support for Persistent Reservations ===============================================
@@ -23,22 +23,18 @@ The following types of reservations are supported: -------------------------------------------------- - PR_WRITE_EXCLUSIVE - Only the initiator that owns the reservation can write to the device. Any initiator can read from the device. - PR_EXCLUSIVE_ACCESS - Only the initiator that owns the reservation can access the device. - PR_WRITE_EXCLUSIVE_REG_ONLY - Only initiators with a registered key can write to the device, Any initiator can read from the device. - PR_EXCLUSIVE_ACCESS_REG_ONLY - Only initiators with a registered key can access the device. - PR_WRITE_EXCLUSIVE_ALL_REGS
@@ -48,21 +44,21 @@ The following types of reservations are supported: All initiators with a registered key are considered reservation holders. Please reference the SPC spec on the meaning of a reservation - holder if you want to use this type. + holder if you want to use this type. - PR_EXCLUSIVE_ACCESS_ALL_REGS - Only initiators with a registered key can access the device. All initiators with a registered key are considered reservation holders. Please reference the SPC spec on the meaning of a reservation - holder if you want to use this type. + holder if you want to use this type. The following ioctl are supported: ---------------------------------- 1. IOC_PR_REGISTER +^^^^^^^^^^^^^^^^^^ This ioctl command registers a new reservation if the new_key argument is non-null. If no existing reservation exists old_key must be zero,
@@ -74,6 +70,7 @@ in old_key. 2. IOC_PR_RESERVE +^^^^^^^^^^^^^^^^^ This ioctl command reserves the device and thus restricts access for other devices based on the type argument. The key argument must be the existing
@@ -82,12 +79,14 @@ IOC_PR_REGISTER_IGNORE, IOC_PR_PREEMPT or IOC_PR_PREEMPT_ABORT commands. 3. IOC_PR_RELEASE +^^^^^^^^^^^^^^^^^ This ioctl command releases the reservation specified by key and flags and thus removes any access restriction implied by it. 4. IOC_PR_PREEMPT +^^^^^^^^^^^^^^^^^ This ioctl command releases the existing reservation referred to by old_key and replaces it with a new reservation of type for the
@@ -95,11 +94,13 @@ reservation key new_key. 5. IOC_PR_PREEMPT_ABORT +^^^^^^^^^^^^^^^^^^^^^^^ This ioctl command works like IOC_PR_PREEMPT except that it also aborts any outstanding command sent over a connection identified by old_key. 6. IOC_PR_CLEAR +^^^^^^^^^^^^^^^ This ioctl command unregisters both key and any other reservation key registered with the device and drops any existing reservation.
@@ -111,7 +112,6 @@ Flags All the ioctls have a flag field. Currently only one flag is supported: - PR_FL_IGNORE_KEY - Ignore the existing reservation key. This is commonly supported for IOC_PR_REGISTER, and some implementation may support the flag for IOC_PR_RESERVE.
Documentation/block/queue-sysfs.rst renamed from Documentation/block/queue-sysfs.txt +4 -3
@@ -1,3 +1,4 @@ +================= Queue sysfs files =================
@@ -10,7 +11,7 @@ Files denoted with a RO postfix are readonly and the RW postfix means read-write. add_random (RW) ----------------- +--------------- This file allows to turn off the disk entropy contribution. Default value of this file is '1'(on).
@@ -21,13 +22,13 @@ used by CPU-addressable storage to bypass the pagecache. It shows '1' if true, '0' if not. discard_granularity (RO) ------------------------ +------------------------ This shows the size of internal allocation of the device in bytes, if reported by the device. A value of '0' means device does not support the discard functionality. discard_max_hw_bytes (RO) ----------------------- +------------------------- Devices that support discard functionality may have internal limits on the number of bytes that can be trimmed or unmapped in a single operation. The discard_max_bytes parameter is set by the device driver to the maximum
Documentation/block/request.rst renamed from Documentation/block/request.txt +29 -18
87 lines not on this page · raw message
Documentation/block/stat.rst renamed from Documentation/block/stat.txt +10 -3
@@ -1,3 +1,4 @@ +=============================================== Block layer statistics in /sys/block/<dev>/stat ===============================================
@@ -6,9 +7,12 @@ This file documents the contents of the /sys/block/<dev>/stat file. The stat file provides several statistics about the state of block device <dev>. -Q. Why are there multiple statistics in a single file? Doesn't sysfs +Q. + Why are there multiple statistics in a single file? Doesn't sysfs normally contain a single value per file? -A. By having a single file, the kernel can guarantee that the statistics + +A. + By having a single file, the kernel can guarantee that the statistics represent a consistent snapshot of the state of the device. If the statistics were exported as multiple files containing one statistic each, it would be impossible to guarantee that a set of readings
@@ -18,8 +22,10 @@ The stat file consists of a single line of text containing 11 decimal values separated by whitespace. The fields are summarized in the following table, and described in more detail below. + +=============== ============= ================================================= Name units description ----- ----- ----------- +=============== ============= ================================================= read I/Os requests number of read I/Os processed read merges requests number of read I/Os merged with in-queue I/O read sectors sectors number of sectors read
@@ -35,6 +41,7 @@ discard I/Os requests number of discard I/Os processed discard merges requests number of discard I/Os merged with in-queue I/O discard sectors sectors number of sectors discarded discard ticks milliseconds total wait time for discard requests +=============== ============= ================================================= read I/Os, write I/Os, discard I/0s ===================================
Documentation/block/switching-sched.rst renamed from Documentation/block/switching-sched.txt +16 -12
@@ -1,35 +1,39 @@ +=================== +Switching Scheduler +=================== + To choose IO schedulers at boot time, use the argument 'elevator=deadline'. 'noop' and 'cfq' (the default) are also available. IO schedulers are assigned globally at boot time only presently. Each io queue has a set of io scheduler tunables associated with it. These tunables control how the io scheduler works. You can find these entries -in: +in:: -/sys/block/<device>/queue/iosched + /sys/block/<device>/queue/iosched assuming that you have sysfs mounted on /sys. If you don't have sysfs mounted, -you can do so by typing: +you can do so by typing:: -# mount none /sys -t sysfs + # mount none /sys -t sysfs It is possible to change the IO scheduler for a given block device on the fly to select one of mq-deadline, none, bfq, or kyber schedulers - which can improve that device's throughput. -To set a specific scheduler, simply do this: +To set a specific scheduler, simply do this:: -echo SCHEDNAME > /sys/block/DEV/queue/scheduler + echo SCHEDNAME > /sys/block/DEV/queue/scheduler where SCHEDNAME is the name of a defined IO scheduler, and DEV is the device name (hda, hdb, sga, or whatever you happen to have). The list of defined schedulers can be found by simply doing a "cat /sys/block/DEV/queue/scheduler" - the list of valid names -will be displayed, with the currently selected scheduler in brackets: +will be displayed, with the currently selected scheduler in brackets:: -# cat /sys/block/sda/queue/scheduler -[mq-deadline] kyber bfq none -# echo none >/sys/block/sda/queue/scheduler -# cat /sys/block/sda/queue/scheduler -[none] mq-deadline kyber bfq + # cat /sys/block/sda/queue/scheduler + [mq-deadline] kyber bfq none + # echo none >/sys/block/sda/queue/scheduler + # cat /sys/block/sda/queue/scheduler + [none] mq-deadline kyber bfq
Documentation/block/writeback_cache_control.rst renamed from Documentation/block/writeback_cache_control.txt +6 -6
@@ -1,6 +1,6 @@ - +========================================== Explicit volatile write back cache control -===================================== +========================================== Introduction ------------
@@ -31,7 +31,7 @@ the blkdev_issue_flush() helper for a pure cache flush. Forced Unit Access ------------------ +------------------ The REQ_FUA flag can be OR ed into the r/w flags of a bio submitted from the filesystem and will make sure that I/O completion for this request is only
@@ -62,14 +62,14 @@ flags themselves without any help from the block layer. Implementation details for request_fn based block drivers --------------------------------------------------------------- +--------------------------------------------------------- For devices that do not support volatile write caches there is no driver support required, the block layer completes empty REQ_PREFLUSH requests before entering the driver and strips off the REQ_PREFLUSH and REQ_FUA bits from requests that have a payload. For devices with volatile write caches the driver needs to tell the block layer that it supports flushing caches by -doing: +doing:: blk_queue_write_cache(sdkp->disk->queue, true, false);
@@ -77,7 +77,7 @@ and handle empty REQ_OP_FLUSH requests in its prep_fn/request_fn. Note that REQ_PREFLUSH requests with a payload are automatically turned into a sequence of an empty REQ_OP_FLUSH request followed by the actual write by the block layer. For devices that also support the FUA bit the block layer needs -to be told to pass through the REQ_FUA bit using: +to be told to pass through the REQ_FUA bit using:: blk_queue_write_cache(sdkp->disk->queue, true, true);
Documentation/blockdev/zram.rst +1 -1
@@ -215,7 +215,7 @@ User space is advised to use the following files to read the device statistics. File /sys/block/zram<id>/stat -Represents block layer statistics. Read Documentation/block/stat.txt for +Represents block layer statistics. Read Documentation/block/stat.rst for details. File /sys/block/zram<id>/io_stat
MAINTAINERS +1 -1
@@ -2930,7 +2930,7 @@ M: Jens Axboe <[email protected]> L: [email protected] S: Maintained F: block/bfq-* -F: Documentation/block/bfq-iosched.txt +F: Documentation/block/bfq-iosched.rst BFS FILE SYSTEM M: "Tigran A. Aivazian" <[email protected]>
block/Kconfig +1 -1
@@ -110,7 +110,7 @@ config BLK_CMDLINE_PARSER which don't otherwise have any standardized method for listing the partitions on a block device. - See Documentation/block/cmdline-partition.txt for more information. + See Documentation/block/cmdline-partition.rst for more information. config BLK_WBT bool "Enable support for block device writeback throttling"
block/Kconfig.iosched +1 -1
@@ -26,7 +26,7 @@ config IOSCHED_BFQ regardless of the device parameters and with any workload. It also guarantees a low latency to interactive and soft real-time applications. Details in - Documentation/block/bfq-iosched.txt + Documentation/block/bfq-iosched.rst config BFQ_GROUP_IOSCHED bool "BFQ hierarchical scheduling support"
block/bfq-iosched.c +1 -1
@@ -17,7 +17,7 @@* low-latency capabilities. BFQ also supports full hierarchical * scheduling through cgroups. Next paragraphs provide an introduction * on BFQ inner workings. Details on BFQ benefits, usage and -* limitations can be found in Documentation/block/bfq-iosched.txt. +* limitations can be found in Documentation/block/bfq-iosched.rst. * * BFQ is a proportional-share storage-I/O scheduling algorithm based * on the slice-by-slice service scheme of CFQ. But BFQ assigns
block/blk-integrity.c +1 -1
@@ -383,7 +383,7 @@ static const struct blk_integrity_profile nop_profile = {* send/receive integrity metadata it must use this function to register * the capability with the block layer. The template is a blk_integrity * struct with values appropriate for the underlying hardware. See -* Documentation/block/data-integrity.txt. +* Documentation/block/data-integrity.rst. */ void blk_integrity_register (struct gendisk *disk,struct blk_integrity *template) {
block/ioprio.c +1 -1
@@ -17,7 +17,7 @@* * ioprio_set(PRIO_PROCESS, pid, prio); * -* See also Documentation/block/ioprio.txt +* See also Documentation/block/ioprio.rst * */ #include <linux/gfp.h>
block/mq-deadline.c +1 -1
@@ -25,7 +25,7 @@#include "blk-mq-sched.h" /* -* See Documentation/block/deadline-iosched.txt +* See Documentation/block/deadline-iosched.rst */ static const int read_expire =HZ /2 ;/* max time before a read is submitted. */ static const int write_expire =5 *HZ ;/* ditto for writes, these limits are SOFT! */
block/partitions/cmdline.c +1 -1
@@ -11,7 +11,7 @@* * The format for the command line is just like mtdparts. * -* For further information, see "Documentation/block/cmdline-partition.txt" +* For further information, see "Documentation/block/cmdline-partition.rst" * */
Signature · 1 line
2.21.0
PATCH 10/22 docs: security: move some books to it and update
In reply to Mauro Carvalho ChehabThe following files belong to security:
Documentation/security/LSM.rst -> Documentation/security/lsm-development.rst Documentation/lsm.txt -> Documentation/security/lsm.rst Documentation/SAK.txt -> Documentation/security/sak.rst Documentation/siphash.txt -> Documentation/security/siphash.rst
---
Documentation/security/index.rst | 5 ++++-
Documentation/security/{LSM.rst => lsm-development.rst} | 0
Documentation/{ => security}/lsm.rst | 2 --
Documentation/{SAK.rst => security/sak.rst} | 2 --
Documentation/{ => security}/siphash.rst | 2 --
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/xen-tpmfront.rst | 2 --
7 files changed, 5 insertions(+), 9 deletions(-)
rename Documentation/security/{LSM.rst => lsm-development.rst} (100%)
rename Documentation/{ => security}/lsm.rst (99%)
rename Documentation/{SAK.rst => security/sak.rst} (99%)
rename Documentation/{ => security}/siphash.rst (99%)Documentation/security/index.rst +4 -1
@@ -8,7 +8,10 @@ Security Documentation credentials IMA-templates keys/index - LSM + lsm + lsm-development + sak SCTP self-protection + siphash tpm/index
Documentation/security/lsm-development.rst renamed from Documentation/security/LSM.rst +0 -0
Documentation/security/lsm.rst renamed from Documentation/lsm.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================================== Linux Security Modules: General Security Hooks for Linux ========================================================
Documentation/security/sak.rst renamed from Documentation/SAK.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================= Linux Secure Attention Key (SAK) handling =========================================
Documentation/security/siphash.rst renamed from Documentation/siphash.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== SipHash - a short input PRF ===========================
Documentation/security/tpm/index.rst +1 -0
@@ -5,3 +5,4 @@ Trusted Platform Module documentation .. toctree:: tpm_vtpm_proxy + xen-tpmfront
Documentation/security/tpm/xen-tpmfront.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================= Virtual TPM interface for Xen =============================
Signature · 1 line
2.21.0