<?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>Chapter 5. API reference</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="index.html" title="Voltage and current regulator API" /><link rel="prev" href="machine-constraint.html" title="Constraints" /><link rel="next" href="API-struct-regulator-bulk-data.html" title="struct regulator_bulk_data" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. API reference</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="machine-constraint.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="API-struct-regulator-bulk-data.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="api"></a>Chapter 5. API reference</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="refentrytitle"><a href="API-struct-regulator-bulk-data.html"><span class="phrase">struct regulator_bulk_data</span></a></span><span class="refpurpose"> —
Data used for bulk regulator operations.
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulator-state.html"><span class="phrase">struct regulator_state</span></a></span><span class="refpurpose"> —
regulator state during low power system states
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulation-constraints.html"><span class="phrase">struct regulation_constraints</span></a></span><span class="refpurpose"> —
regulator operating constraints.
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulator-consumer-supply.html"><span class="phrase">struct regulator_consumer_supply</span></a></span><span class="refpurpose"> —
supply -> device mapping
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulator-init-data.html"><span class="phrase">struct regulator_init_data</span></a></span><span class="refpurpose"> —
regulator platform initialisation data.
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulator-ops.html"><span class="phrase">struct regulator_ops</span></a></span><span class="refpurpose"> —
regulator operations.
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulator-desc.html"><span class="phrase">struct regulator_desc</span></a></span><span class="refpurpose"> —
Static regulator descriptor
</span></dt><dt><span class="refentrytitle"><a href="API-struct-regulator-config.html"><span class="phrase">struct regulator_config</span></a></span><span class="refpurpose"> —
Dynamic regulator descriptor
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get.html"><span class="phrase">regulator_get</span></a></span><span class="refpurpose"> —
lookup and obtain a reference to a regulator.
</span></dt><dt><span class="refentrytitle"><a href="API-devm-regulator-get.html"><span class="phrase">devm_regulator_get</span></a></span><span class="refpurpose"> —
Resource managed <code class="function">regulator_get</code>
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-exclusive.html"><span class="phrase">regulator_get_exclusive</span></a></span><span class="refpurpose"> —
obtain exclusive access to a regulator.
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-put.html"><span class="phrase">regulator_put</span></a></span><span class="refpurpose"> —
"free" the regulator source
</span></dt><dt><span class="refentrytitle"><a href="API-devm-regulator-put.html"><span class="phrase">devm_regulator_put</span></a></span><span class="refpurpose"> —
Resource managed <code class="function">regulator_put</code>
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-enable.html"><span class="phrase">regulator_enable</span></a></span><span class="refpurpose"> —
enable regulator output
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-disable.html"><span class="phrase">regulator_disable</span></a></span><span class="refpurpose"> —
disable regulator output
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-force-disable.html"><span class="phrase">regulator_force_disable</span></a></span><span class="refpurpose"> —
force disable regulator output
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-disable-deferred.html"><span class="phrase">regulator_disable_deferred</span></a></span><span class="refpurpose"> —
disable regulator output with delay
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-is-enabled-regmap.html"><span class="phrase">regulator_is_enabled_regmap</span></a></span><span class="refpurpose"> —
standard <code class="function">is_enabled</code> for regmap users
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-enable-regmap.html"><span class="phrase">regulator_enable_regmap</span></a></span><span class="refpurpose"> —
standard <code class="function">enable</code> for regmap users
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-disable-regmap.html"><span class="phrase">regulator_disable_regmap</span></a></span><span class="refpurpose"> —
standard <code class="function">disable</code> for regmap users
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-is-enabled.html"><span class="phrase">regulator_is_enabled</span></a></span><span class="refpurpose"> —
is the regulator output enabled
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-can-change-voltage.html"><span class="phrase">regulator_can_change_voltage</span></a></span><span class="refpurpose"> —
check if regulator can change voltage
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-count-voltages.html"><span class="phrase">regulator_count_voltages</span></a></span><span class="refpurpose"> —
count <code class="function">regulator_list_voltage</code> selectors
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-list-voltage-linear.html"><span class="phrase">regulator_list_voltage_linear</span></a></span><span class="refpurpose"> —
List voltages with simple calculation
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-list-voltage-table.html"><span class="phrase">regulator_list_voltage_table</span></a></span><span class="refpurpose"> —
List voltages with table based mapping
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-list-voltage.html"><span class="phrase">regulator_list_voltage</span></a></span><span class="refpurpose"> —
enumerate supported voltages
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-linear-step.html"><span class="phrase">regulator_get_linear_step</span></a></span><span class="refpurpose"> —
return the voltage step size between VSEL values
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-is-supported-voltage.html"><span class="phrase">regulator_is_supported_voltage</span></a></span><span class="refpurpose"> —
check if a voltage range can be supported
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-voltage-sel-regmap.html"><span class="phrase">regulator_get_voltage_sel_regmap</span></a></span><span class="refpurpose"> —
standard get_voltage_sel for regmap users
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-voltage-sel-regmap.html"><span class="phrase">regulator_set_voltage_sel_regmap</span></a></span><span class="refpurpose"> —
standard set_voltage_sel for regmap users
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-map-voltage-iterate.html"><span class="phrase">regulator_map_voltage_iterate</span></a></span><span class="refpurpose"> —
<code class="function">map_voltage</code> based on <code class="function">list_voltage</code>
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-map-voltage-ascend.html"><span class="phrase">regulator_map_voltage_ascend</span></a></span><span class="refpurpose"> —
<code class="function">map_voltage</code> for ascendant voltage list
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-map-voltage-linear.html"><span class="phrase">regulator_map_voltage_linear</span></a></span><span class="refpurpose"> —
<code class="function">map_voltage</code> for simple linear mappings
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-voltage.html"><span class="phrase">regulator_set_voltage</span></a></span><span class="refpurpose"> —
set regulator output voltage
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-voltage-time.html"><span class="phrase">regulator_set_voltage_time</span></a></span><span class="refpurpose"> —
get raise/fall time
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-voltage-time-sel.html"><span class="phrase">regulator_set_voltage_time_sel</span></a></span><span class="refpurpose"> —
get raise/fall time
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-sync-voltage.html"><span class="phrase">regulator_sync_voltage</span></a></span><span class="refpurpose"> —
re-apply last regulator output voltage
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-voltage.html"><span class="phrase">regulator_get_voltage</span></a></span><span class="refpurpose"> —
get regulator output voltage
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-current-limit.html"><span class="phrase">regulator_set_current_limit</span></a></span><span class="refpurpose"> —
set regulator output current limit
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-current-limit.html"><span class="phrase">regulator_get_current_limit</span></a></span><span class="refpurpose"> —
get regulator output current
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-mode.html"><span class="phrase">regulator_set_mode</span></a></span><span class="refpurpose"> —
set regulator operating mode
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-mode.html"><span class="phrase">regulator_get_mode</span></a></span><span class="refpurpose"> —
get regulator operating mode
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-optimum-mode.html"><span class="phrase">regulator_set_optimum_mode</span></a></span><span class="refpurpose"> —
set regulator optimum operating mode
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-bypass-regmap.html"><span class="phrase">regulator_set_bypass_regmap</span></a></span><span class="refpurpose"> —
Default <code class="function">set_bypass</code> using regmap
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-bypass-regmap.html"><span class="phrase">regulator_get_bypass_regmap</span></a></span><span class="refpurpose"> —
Default <code class="function">get_bypass</code> using regmap
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-allow-bypass.html"><span class="phrase">regulator_allow_bypass</span></a></span><span class="refpurpose"> —
allow the regulator to go into bypass mode
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-register-notifier.html"><span class="phrase">regulator_register_notifier</span></a></span><span class="refpurpose"> —
register regulator event notifier
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-unregister-notifier.html"><span class="phrase">regulator_unregister_notifier</span></a></span><span class="refpurpose"> —
unregister regulator event notifier
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-bulk-get.html"><span class="phrase">regulator_bulk_get</span></a></span><span class="refpurpose"> —
get multiple regulator consumers
</span></dt><dt><span class="refentrytitle"><a href="API-devm-regulator-bulk-get.html"><span class="phrase">devm_regulator_bulk_get</span></a></span><span class="refpurpose"> —
managed get multiple regulator consumers
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-bulk-enable.html"><span class="phrase">regulator_bulk_enable</span></a></span><span class="refpurpose"> —
enable multiple regulator consumers
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-bulk-disable.html"><span class="phrase">regulator_bulk_disable</span></a></span><span class="refpurpose"> —
disable multiple regulator consumers
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-bulk-force-disable.html"><span class="phrase">regulator_bulk_force_disable</span></a></span><span class="refpurpose"> —
force disable multiple regulator consumers
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-bulk-free.html"><span class="phrase">regulator_bulk_free</span></a></span><span class="refpurpose"> —
free multiple regulator consumers
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-notifier-call-chain.html"><span class="phrase">regulator_notifier_call_chain</span></a></span><span class="refpurpose"> —
call regulator event notifier
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-mode-to-status.html"><span class="phrase">regulator_mode_to_status</span></a></span><span class="refpurpose"> —
convert a regulator mode into a status
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-register.html"><span class="phrase">regulator_register</span></a></span><span class="refpurpose"> —
register regulator
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-unregister.html"><span class="phrase">regulator_unregister</span></a></span><span class="refpurpose"> —
unregister regulator
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-suspend-prepare.html"><span class="phrase">regulator_suspend_prepare</span></a></span><span class="refpurpose"> —
prepare regulators for system wide suspend
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-suspend-finish.html"><span class="phrase">regulator_suspend_finish</span></a></span><span class="refpurpose"> —
resume regulators from system wide suspend
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-has-full-constraints.html"><span class="phrase">regulator_has_full_constraints</span></a></span><span class="refpurpose"> —
the system has fully specified constraints
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-use-dummy-regulator.html"><span class="phrase">regulator_use_dummy_regulator</span></a></span><span class="refpurpose"> —
Provide a dummy regulator when none is found
</span></dt><dt><span class="refentrytitle"><a href="API-rdev-get-drvdata.html"><span class="phrase">rdev_get_drvdata</span></a></span><span class="refpurpose"> —
get rdev regulator driver data
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-get-drvdata.html"><span class="phrase">regulator_get_drvdata</span></a></span><span class="refpurpose"> —
get regulator driver data
</span></dt><dt><span class="refentrytitle"><a href="API-regulator-set-drvdata.html"><span class="phrase">regulator_set_drvdata</span></a></span><span class="refpurpose"> —
set regulator driver data
</span></dt><dt><span class="refentrytitle"><a href="API-rdev-get-id.html"><span class="phrase">rdev_get_id</span></a></span><span class="refpurpose"> —
get regulator ID
</span></dt></dl></div><p>
Due to limitations of the kernel documentation framework and the
existing layout of the source code the entire regulator API is
documented here.
</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="machine-constraint.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="API-struct-regulator-bulk-data.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Constraints </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_bulk_data</span></td></tr></table></div></body></html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
1a595394b241504ff370a8d12ebfcea7
>
files
>
4691
