Commit 83ededdb authored by Leonard Crestez's avatar Leonard Crestez Committed by Jonathan Corbet
Browse files

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: default avatarLeonard Crestez <leonard.crestez@nxp.com>
Link: https://lore.kernel.org/r/e32fa9de8a60060a6ee5fc42f163111034f9a550.1574181341.git.leonard.crestez@nxp.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 29108490
Loading
Loading
Loading
Loading
+30 −0
Original line number Diff line number Diff line
.. 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 −0
Original line number Diff line number Diff line
@@ -39,6 +39,7 @@ available subsections can be seen below.
   ipmb
   i3c/index
   interconnect
   devfreq
   hsi
   edac
   scsi