struct regulation_constraints
Prev | Chapter 5. API reference | Next

## Name

struct regulation_constraints — regulator operating constraints.

## Synopsis

    struct regulation_constraints {
      const char * name;
      int min_uV;
      int max_uV;
      int uV_offset;
      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 int ramp_delay;
      unsigned int enable_time;
      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.

uV_offset

  Offset applied to voltages from consumer to compensate for voltage drops.

min_uA

  Smallest current 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.

ramp_delay

  Time to settle down after voltage change (unit: uV/us)

enable_time

  Turn-on time of the rails (unit: microseconds)

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.

Prev | Up | Next
struct regulator_state | Home | struct regulator_consumer_supply