<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>regulator_set_optimum_mode</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="Voltage and current regulator API" /><link rel="up" href="ch05.html" title="Chapter 5. API reference" /><link rel="prev" href="re22.html" title="regulator_get_mode" /><link rel="next" href="re24.html" title="regulator_register_notifier" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>regulator_set_optimum_mode</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re22.html">Prev</a> </td><th width="60%" align="center">Chapter 5. API reference</th><td width="20%" align="right"> <a accesskey="n" href="re24.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="regulator_set_optimum_mode"><a id="API-regulator-set-optimum-mode"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>regulator_set_optimum_mode —
set regulator optimum operating mode
</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">int <b class="fsfunc">regulator_set_optimum_mode </b>(</code></td><td>struct regulator * <var class="pdparam">regulator</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">uA_load</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id2930606"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>regulator</code></em></span></dt><dd><p>
regulator source
</p></dd><dt><span class="term"><em class="parameter"><code>uA_load</code></em></span></dt><dd><p>
load current
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id2930647"></a><h2>Description</h2><p>
Notifies the regulator core of a new device load. This is then used by
DRMS (if enabled by constraints) to set the most efficient regulator
operating mode for the new regulator loading.
</p><p>
Consumer devices notify their supply regulator of the maximum power
they will require (can be taken from device datasheet in the power
consumption tables) when they change operational status and hence power
state. Examples of operational state changes that can affect power
</p></div><div class="refsect1" title="consumption are"><a id="id2930667"></a><h2>consumption are </h2><p>
-
</p><p>
o Device is opened / closed.
o Device I/O is about to begin or has just finished.
o Device is idling in between work.
</p><p>
This information is also exported via sysfs to userspace.
</p><p>
DRMS will sum the total requested load on the regulator and change
to the most efficient operating mode if platform constraints allow.
</p><p>
Returns the new regulator mode or error.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re22.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch05.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re24.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>regulator_get_mode</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>regulator_register_notifier</span></td></tr></table></div></body></html>
