mirror of
https://github.com/brain-hackers/linux-brain.git
synced 2024-06-09 23:36:23 +09:00
151f4e2bdc
Convert the PM documents to ReST, in order to allow them to build with Sphinx. The conversion is actually: - add blank lines and indentation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Acked-by: Mark Brown <broonie@kernel.org> Acked-by: Srivatsa S. Bhat (VMware) <srivatsa@csail.mit.edu>
39 lines
1.3 KiB
ReStructuredText
39 lines
1.3 KiB
ReStructuredText
==========================
|
|
Regulator API design notes
|
|
==========================
|
|
|
|
This document provides a brief, partially structured, overview of some
|
|
of the design considerations which impact the regulator API design.
|
|
|
|
Safety
|
|
------
|
|
|
|
- Errors in regulator configuration can have very serious consequences
|
|
for the system, potentially including lasting hardware damage.
|
|
- It is not possible to automatically determine the power configuration
|
|
of the system - software-equivalent variants of the same chip may
|
|
have different power requirements, and not all components with power
|
|
requirements are visible to software.
|
|
|
|
.. note::
|
|
|
|
The API should make no changes to the hardware state unless it has
|
|
specific knowledge that these changes are safe to perform on this
|
|
particular system.
|
|
|
|
Consumer use cases
|
|
------------------
|
|
|
|
- The overwhelming majority of devices in a system will have no
|
|
requirement to do any runtime configuration of their power beyond
|
|
being able to turn it on or off.
|
|
|
|
- Many of the power supplies in the system will be shared between many
|
|
different consumers.
|
|
|
|
.. note::
|
|
|
|
The consumer API should be structured so that these use cases are
|
|
very easy to handle and so that consumers will work with shared
|
|
supplies without any additional effort.
|