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  */
  36
  37 #define REGULATOR_CHANGE_VOLTAGE        0x1
  38 #define REGULATOR_CHANGE_CURRENT        0x2
  39 #define REGULATOR_CHANGE_MODE           0x4
  40 #define REGULATOR_CHANGE_STATUS         0x8
  41 #define REGULATOR_CHANGE_DRMS           0x10
  42
  43 /**
  44  * struct regulator_state - regulator state during low power system states
  45  *
  46  * This describes a regulators state during a system wide low power
  47  * state.  One of enabled or disabled must be set for the
  48  * configuration to be applied.
  49  *
  50  * @uV: Operating voltage during suspend.
  51  * @mode: Operating mode during suspend.
  52  * @enabled: Enabled during suspend.
  53  * @disabled: Disabled during suspend.
  54  */
  55 struct regulator_state {
  56         int uV; /* suspend voltage */
  57         unsigned int mode; /* suspend regulator operating mode */
  58         int enabled; /* is regulator enabled in this suspend state */
  59         int disabled; /* is the regulator disbled in this suspend state */
  60 };
  61
  62 /**
  63  * struct regulation_constraints - regulator operating constraints.
  64  *
  65  * This struct describes regulator and board/machine specific constraints.
  66  *
  67  * @name: Descriptive name for the constraints, used for display purposes.
  68  *
  69  * @min_uV: Smallest voltage consumers may set.
  70  * @max_uV: Largest voltage consumers may set.
  71  * @uV_offset: Offset applied to voltages from consumer to compensate for
  72  *             voltage drops.
  73  *
  74  * @min_uA: Smallest consumers consumers may set.
  75  * @max_uA: Largest current consumers may set.
  76  *
  77  * @valid_modes_mask: Mask of modes which may be configured by consumers.
  78  * @valid_ops_mask: Operations which may be performed by consumers.
  79  *
  80  * @always_on: Set if the regulator should never be disabled.
  81  * @boot_on: Set if the regulator is enabled when the system is initially
  82  *           started.  If the regulator is not enabled by the hardware or
  83  *           bootloader then it will be enabled when the constraints are
  84  *           applied.
  85  * @apply_uV: Apply the voltage constraint when initialising.
  86  *
  87  * @input_uV: Input voltage for regulator when supplied by another regulator.
  88  *
  89  * @state_disk: State for regulator when system is suspended in disk mode.
  90  * @state_mem: State for regulator when system is suspended in mem mode.
  91  * @state_standby: State for regulator when system is suspended in standby
  92  *                 mode.
  93  * @initial_state: Suspend state to set by default.
  94  * @initial_mode: Mode to set at startup.
  95  */
  96 struct regulation_constraints {
  97
  98         const char *name;
  99
 100         /* voltage output range (inclusive) - for voltage control */
 101         int min_uV;
 102         int max_uV;
 103
 104         int uV_offset;
 105
 106         /* current output range (inclusive) - for current control */
 107         int min_uA;
 108         int max_uA;
 109
 110         /* valid regulator operating modes for this machine */
 111         unsigned int valid_modes_mask;
 112
 113         /* valid operations for regulator on this machine */
 114         unsigned int valid_ops_mask;
 115
 116         /* regulator input voltage - only if supply is another regulator */
 117         int input_uV;
 118
 119         /* regulator suspend states for global PMIC STANDBY/HIBERNATE */
 120         struct regulator_state state_disk;
 121         struct regulator_state state_mem;
 122         struct regulator_state state_standby;
 123         suspend_state_t initial_state; /* suspend state to set at init */
 124
 125         /* mode to set on startup */
 126         unsigned int initial_mode;
 127
 128         /* constraint flags */
 129         unsigned always_on:1;   /* regulator never off when system is on */
 130         unsigned boot_on:1;     /* bootloader/firmware enabled regulator */
 131         unsigned apply_uV:1;    /* apply uV constraint if min == max */
 132 };
 133
 134 /**
 135  * struct regulator_consumer_supply - supply -> device mapping
 136  *
 137  * This maps a supply name to a device.  Only one of dev or dev_name
 138  * can be specified.  Use of dev_name allows support for buses which
 139  * make struct device available late such as I2C and is the preferred
 140  * form.
 141  *
 142  * @dev: Device structure for the consumer.
 143  * @dev_name: Result of dev_name() for the consumer.
 144  * @supply: Name for the supply.
 145  */
 146 struct regulator_consumer_supply {
 147         struct device *dev;     /* consumer */
 148         const char *dev_name;   /* dev_name() for consumer */
 149         const char *supply;     /* consumer supply - e.g. "vcc" */
 150 };
 151
 152 /* Initialize struct regulator_consumer_supply */
 153 #define REGULATOR_SUPPLY(_name, _dev_name)                      \
 154 {                                                               \
 155         .supply         = _name,                                \
 156         .dev_name       = _dev_name,                            \
 157 }
 158
 159 /**
 160  * struct regulator_init_data - regulator platform initialisation data.
 161  *
 162  * Initialisation constraints, our supply and consumers supplies.
 163  *
 164  * @supply_regulator: Parent regulator.  Specified using the regulator name
 165  *                    as it appears in the name field in sysfs, which can
 166  *                    be explicitly set using the constraints field 'name'.
 167  *
 168  * @constraints: Constraints.  These must be specified for the regulator to
 169  *               be usable.
 170  * @num_consumer_supplies: Number of consumer device supplies.
 171  * @consumer_supplies: Consumer device supply configuration.
 172  *
 173  * @regulator_init: Callback invoked when the regulator has been registered.
 174  * @driver_data: Data passed to regulator_init.
 175  */
 176 struct regulator_init_data {
 177         const char *supply_regulator;        /* or NULL for system supply */
 178
 179         struct regulation_constraints constraints;
 180
 181         int num_consumer_supplies;
 182         struct regulator_consumer_supply *consumer_supplies;
 183
 184         /* optional regulator machine specific init */
 185         int (*regulator_init)(void *driver_data);
 186         void *driver_data;      /* core does not touch this */
 187 };
 188
 189 int regulator_suspend_prepare(suspend_state_t state);
 190 int regulator_suspend_finish(void);
 191
 192 #ifdef CONFIG_REGULATOR
 193 void regulator_has_full_constraints(void);
 194 void regulator_use_dummy_regulator(void);
 195 #else
 196 static inline void regulator_has_full_constraints(void)
 197 {
 198 }
 199
 200 static inline void regulator_use_dummy_regulator(void)
 201 {
 202 }
 203 #endif
 204
 205 #endif