STRUCT REGULATION_CO

Section: API reference (9)
Updated: February 2011
Index Return to Main Contents
 

NAME

struct_regulation_constraints - regulator operating constraints.  

SYNOPSIS

struct regulation_constraints {
  char * name;
  int min_uV;
  int max_uV;
  int min_uA;
  int max_uA;
  unsigned int valid_modes_mask;
  unsigned int valid_ops_mask;
  int input_uV;
  struct regulator_state state_disk;
  struct regulator_state state_mem;
  struct regulator_state state_standby;
  suspend_state_t initial_state;
  unsigned int initial_mode;
  unsigned always_on:1;
  unsigned boot_on:1;
  unsigned apply_uV:1;
};  
 

MEMBERS

name

Descriptive name for the constraints, used for display purposes.

min_uV

Smallest voltage consumers may set.

max_uV

Largest voltage consumers may set.

min_uA

Smallest consumers consumers may set.

max_uA

Largest current consumers may set.

valid_modes_mask

Mask of modes which may be configured by consumers.

valid_ops_mask

Operations which may be performed by consumers.

input_uV

Input voltage for regulator when supplied by another regulator.

state_disk

State for regulator when system is suspended in disk mode.

state_mem

State for regulator when system is suspended in mem mode.

state_standby

State for regulator when system is suspended in standby mode.

initial_state

Suspend state to set by default.

initial_mode

Mode to set at startup.

always_on

Set if the regulator should never be disabled.

boot_on

Set if the regulator is enabled when the system is initially started. If the regulator is not enabled by the hardware or bootloader then it will be enabled when the constraints are applied.

apply_uV

Apply the voltage constraint when initialising.
 

DESCRIPTION

This struct describes regulator and board/machine specific constraints.  

AUTHORS

Liam Girdwood <lrg@slimlogic.co.uk>

Author.

Mark Brown <broonie@opensource.wolfsonmicro.com>
Wolfson Microelectronics,
      
     

Author.
 

COPYRIGHT