include/linux/regulator/machine.h

   1 /*
   2  * machine.h -- SoC Regulator support, machine/board driver API.
   3  *
   4  * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
   5  *
   6  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * Regulator Machine/Board Interface.
  13  */
  14
  15 #ifndef __LINUX_REGULATOR_MACHINE_H_
  16 #define __LINUX_REGULATOR_MACHINE_H_
  17
  18 #include <linux/regulator/consumer.h>
  19 #include <linux/suspend.h>
  20
  21 struct regulator;
  22
  23 /*
  24  * Regulator operation constraint flags. These flags are used to enable
  25  * certain regulator operations and can be OR'ed together.
  26  *
  27  * VOLTAGE:  Regulator output voltage can be changed by software on this
  28  *           board/machine.
  29  * CURRENT:  Regulator output current can be changed by software on this
  30  *           board/machine.
  31  * MODE:     Regulator operating mode can be changed by software on this
  32  *           board/machine.
  33  * STATUS:   Regulator can be enabled and disabled.
  34  * DRMS:     Dynamic Regulator Mode Switching is enabled for this regulator.
  35  * BYPASS:   Regulator can be put into bypass mode
  36  */
  37
  38 #define REGULATOR_CHANGE_VOLTAGE        0x1
  39 #define REGULATOR_CHANGE_CURRENT        0x2
  40 #define REGULATOR_CHANGE_MODE           0x4
  41 #define REGULATOR_CHANGE_STATUS         0x8
  42 #define REGULATOR_CHANGE_DRMS           0x10
  43 #define REGULATOR_CHANGE_BYPASS         0x20
  44
  45 /**
  46  * struct regulator_state - regulator state during low power system states
  47  *
  48  * This describes a regulators state during a system wide low power
  49  * state.  One of enabled or disabled must be set for the
  50  * configuration to be applied.
  51  *
  52  * @uV: Operating voltage during suspend.
  53  * @mode: Operating mode during suspend.
  54  * @enabled: Enabled during suspend.
  55  * @disabled: Disabled during suspend.
  56  */
  57 struct regulator_state {
  58         int uV; /* suspend voltage */
  59         unsigned int mode; /* suspend regulator operating mode */
  60         int enabled; /* is regulator enabled in this suspend state */
  61         int disabled; /* is the regulator disbled in this suspend state */
  62 };
  63
  64 /**
  65  * struct regulation_constraints - regulator operating constraints.
  66  *
  67  * This struct describes regulator and board/machine specific constraints.
  68  *
  69  * @name: Descriptive name for the constraints, used for display purposes.
  70  *
  71  * @min_uV: Smallest voltage consumers may set.
  72  * @max_uV: Largest voltage consumers may set.
  73  * @uV_offset: Offset applied to voltages from consumer to compensate for
  74  *             voltage drops.
  75  *
  76  * @min_uA: Smallest current consumers may set.
  77  * @max_uA: Largest current consumers may set.
  78  * @ilim_uA: Maximum input current.
  79  * @system_load: Load that isn't captured by any consumer requests.
  80  *
  81  * @valid_modes_mask: Mask of modes which may be configured by consumers.
  82  * @valid_ops_mask: Operations which may be performed by consumers.
  83  *
  84  * @always_on: Set if the regulator should never be disabled.
  85  * @boot_on: Set if the regulator is enabled when the system is initially
  86  *           started.  If the regulator is not enabled by the hardware or
  87  *           bootloader then it will be enabled when the constraints are
  88  *           applied.
  89  * @apply_uV: Apply the voltage constraint when initialising.
  90  * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
  91  * @soft_start: Enable soft start so that voltage ramps slowly.
  92  * @pull_down: Enable pull down when regulator is disabled.
  93  *
  94  * @input_uV: Input voltage for regulator when supplied by another regulator.
  95  *
  96  * @state_disk: State for regulator when system is suspended in disk mode.
  97  * @state_mem: State for regulator when system is suspended in mem mode.
  98  * @state_standby: State for regulator when system is suspended in standby
  99  *                 mode.
 100  * @initial_state: Suspend state to set by default.
 101  * @initial_mode: Mode to set at startup.
 102  * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
 103  * @enable_time: Turn-on time of the rails (unit: microseconds)
 104  */
 105 struct regulation_constraints {
 106
 107         const char *name;
 108
 109         /* voltage output range (inclusive) - for voltage control */
 110         int min_uV;
 111         int max_uV;
 112
 113         int uV_offset;
 114
 115         /* current output range (inclusive) - for current control */
 116         int min_uA;
 117         int max_uA;
 118         int ilim_uA;
 119
 120         int system_load;
 121
 122         /* valid regulator operating modes for this machine */
 123         unsigned int valid_modes_mask;
 124
 125         /* valid operations for regulator on this machine */
 126         unsigned int valid_ops_mask;
 127
 128         /* regulator input voltage - only if supply is another regulator */
 129         int input_uV;
 130
 131         /* regulator suspend states for global PMIC STANDBY/HIBERNATE */
 132         struct regulator_state state_disk;
 133         struct regulator_state state_mem;
 134         struct regulator_state state_standby;
 135         suspend_state_t initial_state; /* suspend state to set at init */
 136
 137         /* mode to set on startup */
 138         unsigned int initial_mode;
 139
 140         unsigned int ramp_delay;
 141         unsigned int enable_time;
 142
 143         /* constraint flags */
 144         unsigned always_on:1;   /* regulator never off when system is on */
 145         unsigned boot_on:1;     /* bootloader/firmware enabled regulator */
 146         unsigned apply_uV:1;    /* apply uV constraint if min == max */
 147         unsigned ramp_disable:1; /* disable ramp delay */
 148         unsigned soft_start:1;  /* ramp voltage slowly */
 149         unsigned pull_down:1;   /* pull down resistor when regulator off */
 150         unsigned over_current_protection:1; /* auto disable on over current */
 151 };
 152
 153 /**
 154  * struct regulator_consumer_supply - supply -> device mapping
 155  *
 156  * This maps a supply name to a device. Use of dev_name allows support for
 157  * buses which make struct device available late such as I2C.
 158  *
 159  * @dev_name: Result of dev_name() for the consumer.
 160  * @supply: Name for the supply.
 161  */
 162 struct regulator_consumer_supply {
 163         const char *dev_name;   /* dev_name() for consumer */
 164         const char *supply;     /* consumer supply - e.g. "vcc" */
 165 };
 166
 167 /* Initialize struct regulator_consumer_supply */
 168 #define REGULATOR_SUPPLY(_name, _dev_name)                      \
 169 {                                                               \
 170         .supply         = _name,                                \
 171         .dev_name       = _dev_name,                            \
 172 }
 173
 174 /**
 175  * struct regulator_init_data - regulator platform initialisation data.
 176  *
 177  * Initialisation constraints, our supply and consumers supplies.
 178  *
 179  * @supply_regulator: Parent regulator.  Specified using the regulator name
 180  *                    as it appears in the name field in sysfs, which can
 181  *                    be explicitly set using the constraints field 'name'.
 182  *
 183  * @constraints: Constraints.  These must be specified for the regulator to
 184  *               be usable.
 185  * @num_consumer_supplies: Number of consumer device supplies.
 186  * @consumer_supplies: Consumer device supply configuration.
 187  *
 188  * @regulator_init: Callback invoked when the regulator has been registered.
 189  * @driver_data: Data passed to regulator_init.
 190  */
 191 struct regulator_init_data {
 192         const char *supply_regulator;        /* or NULL for system supply */
 193
 194         struct regulation_constraints constraints;
 195
 196         int num_consumer_supplies;
 197         struct regulator_consumer_supply *consumer_supplies;
 198
 199         /* optional regulator machine specific init */
 200         int (*regulator_init)(void *driver_data);
 201         void *driver_data;      /* core does not touch this */
 202 };
 203
 204 #ifdef CONFIG_REGULATOR
 205 void regulator_has_full_constraints(void);
 206 int regulator_suspend_prepare(suspend_state_t state);
 207 int regulator_suspend_finish(void);
 208 #else
 209 static inline void regulator_has_full_constraints(void)
 210 {
 211 }
 212 static inline int regulator_suspend_prepare(suspend_state_t state)
 213 {
 214         return 0;
 215 }
 216 static inline int regulator_suspend_finish(void)
 217 {
 218         return 0;
 219 }
 220 #endif
 221
 222 #endif