mirror of
https://github.com/AuxXxilium/linux_dsm_epyc7002.git
synced 2024-11-24 06:10:53 +07:00
83ededdb72
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>
31 lines
852 B
ReStructuredText
31 lines
852 B
ReStructuredText
.. 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:
|