1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>struct regulation_constraints</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Voltage and current regulator API"><link rel="up" href="api.html" title="Chapter 5. API reference"><link rel="prev" href="API-struct-regulator-state.html" title="struct regulator_state"><link rel="next" href="API-struct-regulator-consumer-supply.html" title="struct regulator_consumer_supply"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">struct regulation_constraints</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-struct-regulator-state.html">Prev</a> </td><th width="60%" align="center">Chapter 5. API reference</th><td width="20%" align="right"> <a accesskey="n" href="API-struct-regulator-consumer-supply.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-struct-regulation-constraints"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>struct regulation_constraints — 2 regulator operating constraints. 3 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="programlisting"> 4struct regulation_constraints { 5 const char * name; 6 int min_uV; 7 int max_uV; 8 int uV_offset; 9 int min_uA; 10 int max_uA; 11 unsigned int valid_modes_mask; 12 unsigned int valid_ops_mask; 13 int input_uV; 14 struct regulator_state state_disk; 15 struct regulator_state state_mem; 16 struct regulator_state state_standby; 17 suspend_state_t initial_state; 18 unsigned int initial_mode; 19 unsigned int ramp_delay; 20 unsigned int enable_time; 21 unsigned always_on:1; 22 unsigned boot_on:1; 23 unsigned apply_uV:1; 24 unsigned ramp_disable:1; 25}; </pre></div><div class="refsect1"><a name="idp1121901180"></a><h2>Members</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> 26 Descriptive name for the constraints, used for display purposes. 27 </p></dd><dt><span class="term">min_uV</span></dt><dd><p> 28 Smallest voltage consumers may set. 29 </p></dd><dt><span class="term">max_uV</span></dt><dd><p> 30 Largest voltage consumers may set. 31 </p></dd><dt><span class="term">uV_offset</span></dt><dd><p> 32 Offset applied to voltages from consumer to compensate for 33 voltage drops. 34 </p></dd><dt><span class="term">min_uA</span></dt><dd><p> 35 Smallest current consumers may set. 36 </p></dd><dt><span class="term">max_uA</span></dt><dd><p> 37 Largest current consumers may set. 38 </p></dd><dt><span class="term">valid_modes_mask</span></dt><dd><p> 39 Mask of modes which may be configured by consumers. 40 </p></dd><dt><span class="term">valid_ops_mask</span></dt><dd><p> 41 Operations which may be performed by consumers. 42 </p></dd><dt><span class="term">input_uV</span></dt><dd><p> 43 Input voltage for regulator when supplied by another regulator. 44 </p></dd><dt><span class="term">state_disk</span></dt><dd><p> 45 State for regulator when system is suspended in disk mode. 46 </p></dd><dt><span class="term">state_mem</span></dt><dd><p> 47 State for regulator when system is suspended in mem mode. 48 </p></dd><dt><span class="term">state_standby</span></dt><dd><p> 49 State for regulator when system is suspended in standby 50 mode. 51 </p></dd><dt><span class="term">initial_state</span></dt><dd><p> 52 Suspend state to set by default. 53 </p></dd><dt><span class="term">initial_mode</span></dt><dd><p> 54 Mode to set at startup. 55 </p></dd><dt><span class="term">ramp_delay</span></dt><dd><p> 56 Time to settle down after voltage change (unit: uV/us) 57 </p></dd><dt><span class="term">enable_time</span></dt><dd><p> 58 Turn-on time of the rails (unit: microseconds) 59 </p></dd><dt><span class="term">always_on</span></dt><dd><p> 60 Set if the regulator should never be disabled. 61 </p></dd><dt><span class="term">boot_on</span></dt><dd><p> 62 Set if the regulator is enabled when the system is initially 63 started. If the regulator is not enabled by the hardware or 64 bootloader then it will be enabled when the constraints are 65 applied. 66 </p></dd><dt><span class="term">apply_uV</span></dt><dd><p> 67 Apply the voltage constraint when initialising. 68 </p></dd><dt><span class="term">ramp_disable</span></dt><dd><p> 69 Disable ramp delay when initialising or when setting voltage. 70 </p></dd></dl></div></div><div class="refsect1"><a name="idp1124810452"></a><h2>Description</h2><p> 71 </p><p> 72 73 This struct describes regulator and board/machine specific constraints. 74</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-struct-regulator-state.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="api.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-struct-regulator-consumer-supply.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">struct regulator_state</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span class="phrase">struct regulator_consumer_supply</span></td></tr></table></div></body></html> 75