'\" t
.\"     Title: regulator_set_load
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: January 2017
.\"    Manual: API reference
.\"    Source: Kernel Hackers Manual 4.8.15
.\"  Language: English
.\"
.TH "REGULATOR_SET_LOAD" "9" "January 2017" "Kernel Hackers Manual 4\&.8\&." "API reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
regulator_set_load \- set regulator load
.SH "SYNOPSIS"
.HP \w'int\ regulator_set_load('u
.BI "int regulator_set_load(struct\ regulator\ *\ " "regulator" ", int\ " "uA_load" ");"
.SH "ARGUMENTS"
.PP
\fIregulator\fR
.RS 4
regulator source
.RE
.PP
\fIuA_load\fR
.RS 4
load current
.RE
.SH "DESCRIPTION"
.PP
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\&.
.PP
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 consumption are :\-
.PP
o Device is opened / closed\&. o Device I/O is about to begin or has just finished\&. o Device is idling in between work\&.
.PP
This information is also exported via sysfs to userspace\&.
.PP
DRMS will sum the total requested load on the regulator and change to the most efficient operating mode if platform constraints allow\&.
.PP
On error a negative errno is returned\&.
.SH "AUTHORS"
.PP
\fBLiam Girdwood\fR <\&lrg@slimlogic.co.uk\&>
.RS 4
Author.
.RE
.PP
\fBMark Brown\fR <\&broonie@opensource.wolfsonmicro.com\&>
.br
Wolfson Microelectronics, 
      
     
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br