| Message ID | e32fa9de8a60060a6ee5fc42f163111034f9a550.1574181341.git.leonard.crestez@nxp.com (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
| Series | docs: Add initial documentation for devfreq | expand |
On Tue, 19 Nov 2019 18:38:56 +0200 Leonard Crestez <leonard.crestez@nxp.com> wrote: > 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> > --- > Documentation/driver-api/devfreq.rst | 30 ++++++++++++++++++++++++++++ > Documentation/driver-api/index.rst | 1 + > 2 files changed, 31 insertions(+) > create mode 100644 Documentation/driver-api/devfreq.rst Applied, thanks. jon
diff --git a/Documentation/driver-api/devfreq.rst b/Documentation/driver-api/devfreq.rst new file mode 100644 index 000000000000..4a0bf87a3b13 --- /dev/null +++ b/Documentation/driver-api/devfreq.rst @@ -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: diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index c6094377f1a3..0ebe205efd0c 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -38,10 +38,11 @@ available subsections can be seen below. spi i2c ipmb i3c/index interconnect + devfreq hsi edac scsi libata target
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> --- Documentation/driver-api/devfreq.rst | 30 ++++++++++++++++++++++++++++ Documentation/driver-api/index.rst | 1 + 2 files changed, 31 insertions(+) create mode 100644 Documentation/driver-api/devfreq.rst