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

docs: Add initial documentation for devfreq

The devfreq subsystem has plenty of kernel-doc comments but they're not
currently included in sphinx documentation.

Add a minimal devfreq.rst file which mostly just includes kernel-doc
comments from devfreq source. This also exposes a number of kernel-doc
warnings on `make htmldocs`

Signed-off-by: Leonard Crestez <leonard.crestez@nxp.com>
Link: https://lore.kernel.org/r/e32fa9de8a60060a6ee5fc42f163111034f9a550.1574181341.git.leonard.crestez@nxp.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Leonard Crestez and committed by
Jonathan Corbet
83ededdb 29108490

+31
+30
Documentation/driver-api/devfreq.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ======================== 4 + Device Frequency Scaling 5 + ======================== 6 + 7 + Introduction 8 + ------------ 9 + 10 + This framework provides a standard kernel interface for Dynamic Voltage and 11 + Frequency Switching on arbitrary devices. 12 + 13 + It exposes controls for adjusting frequency through sysfs files which are 14 + similar to the cpufreq subsystem. 15 + 16 + Devices for which current usage can be measured can have their frequency 17 + automatically adjusted by governors. 18 + 19 + API 20 + --- 21 + 22 + Device drivers need to initialize a :c:type:`devfreq_profile` and call the 23 + :c:func:`devfreq_add_device` function to create a :c:type:`devfreq` instance. 24 + 25 + .. kernel-doc:: include/linux/devfreq.h 26 + .. kernel-doc:: include/linux/devfreq-event.h 27 + .. kernel-doc:: drivers/devfreq/devfreq.c 28 + :export: 29 + .. kernel-doc:: drivers/devfreq/devfreq-event.c 30 + :export:
+1
Documentation/driver-api/index.rst
··· 39 39 ipmb 40 40 i3c/index 41 41 interconnect 42 + devfreq 42 43 hsi 43 44 edac 44 45 scsi