openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Leonard Crestez 2019-11-19 18:38:56 +02:00 committed by Jonathan Corbet
parent 291084904e
commit 83ededdb72
2 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/driver-api/devfreq.rst Normal file
View File

@ -0,0 +1,30 @@
.. SPDX-License-Identifier: GPL-2.0
========================
Device Frequency Scaling
========================
Introduction
------------
This framework provides a standard kernel interface for Dynamic Voltage and
Frequency Switching on arbitrary devices.
It exposes controls for adjusting frequency through sysfs files which are
similar to the cpufreq subsystem.
Devices for which current usage can be measured can have their frequency
automatically adjusted by governors.
API
---
Device drivers need to initialize a :c:type:`devfreq_profile` and call the
:c:func:`devfreq_add_device` function to create a :c:type:`devfreq` instance.
.. kernel-doc:: include/linux/devfreq.h
.. kernel-doc:: include/linux/devfreq-event.h
.. kernel-doc:: drivers/devfreq/devfreq.c
:export:
.. kernel-doc:: drivers/devfreq/devfreq-event.c
:export:

1
Documentation/driver-api/index.rst
View File

@ -39,6 +39,7 @@ available subsections can be seen below.
ipmb
i3c/index
interconnect
devfreq
hsi
edac
scsi