Pileus Git - ~andy/linux/blob - include/linux/regulator/driver.h

   1 /*
   2  * driver.h -- SoC Regulator driver support.
   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 Driver Interface.
  13  */
  14
  15 #ifndef __LINUX_REGULATOR_DRIVER_H_
  16 #define __LINUX_REGULATOR_DRIVER_H_
  17
  18 #include <linux/device.h>
  19 #include <linux/notifier.h>
  20 #include <linux/regulator/consumer.h>
  21
  22 struct regmap;
  23 struct regulator_dev;
  24 struct regulator_init_data;
  25
  26 enum regulator_status {
  27         REGULATOR_STATUS_OFF,
  28         REGULATOR_STATUS_ON,
  29         REGULATOR_STATUS_ERROR,
  30         /* fast/normal/idle/standby are flavors of "on" */
  31         REGULATOR_STATUS_FAST,
  32         REGULATOR_STATUS_NORMAL,
  33         REGULATOR_STATUS_IDLE,
  34         REGULATOR_STATUS_STANDBY,
  35         /* in case that any other status doesn't apply */
  36         REGULATOR_STATUS_UNDEFINED,
  37 };
  38
  39 /**
  40  * struct regulator_ops - regulator operations.
  41  *
  42  * @enable: Configure the regulator as enabled.
  43  * @disable: Configure the regulator as disabled.
  44  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
  45  *              May also return negative errno.
  46  *
  47  * @set_voltage: Set the voltage for the regulator within the range specified.
  48  *               The driver should select the voltage closest to min_uV.
  49  * @set_voltage_sel: Set the voltage for the regulator using the specified
  50  *                   selector.
  51  * @map_voltage: Convert a voltage into a selector
  52  * @get_voltage: Return the currently configured voltage for the regulator.
  53  * @get_voltage_sel: Return the currently configured voltage selector for the
  54  *                   regulator.
  55  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  56  *      if the selector indicates a voltage that is unusable on this system;
  57  *      or negative errno.  Selectors range from zero to one less than
  58  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  59  *
  60  * @set_current_limit: Configure a limit for a current-limited regulator.
  61  * @get_current_limit: Get the configured limit for a current-limited regulator.
  62  *
  63  * @set_mode: Set the configured operating mode for the regulator.
  64  * @get_mode: Get the configured operating mode for the regulator.
  65  * @get_status: Return actual (not as-configured) status of regulator, as a
  66  *      REGULATOR_STATUS value (or negative errno)
  67  * @get_optimum_mode: Get the most efficient operating mode for the regulator
  68  *                    when running with the specified parameters.
  69  *
  70  * @enable_time: Time taken for the regulator voltage output voltage to
  71  *               stabilise after being enabled, in microseconds.
  72  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
  73  *               to stabilise after being set to a new value, in microseconds.
  74  *               The function provides the from and to voltage selector, the
  75  *               function should return the worst case.
  76  *
  77  * @set_suspend_voltage: Set the voltage for the regulator when the system
  78  *                       is suspended.
  79  * @set_suspend_enable: Mark the regulator as enabled when the system is
  80  *                      suspended.
  81  * @set_suspend_disable: Mark the regulator as disabled when the system is
  82  *                       suspended.
  83  * @set_suspend_mode: Set the operating mode for the regulator when the
  84  *                    system is suspended.
  85  *
  86  * This struct describes regulator operations which can be implemented by
  87  * regulator chip drivers.
  88  */
  89 struct regulator_ops {
  90
  91         /* enumerate supported voltages */
  92         int (*list_voltage) (struct regulator_dev *, unsigned selector);
  93
  94         /* get/set regulator voltage */
  95         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
  96                             unsigned *selector);
  97         int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
  98         int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
  99         int (*get_voltage) (struct regulator_dev *);
 100         int (*get_voltage_sel) (struct regulator_dev *);
 101
 102         /* get/set regulator current  */
 103         int (*set_current_limit) (struct regulator_dev *,
 104                                  int min_uA, int max_uA);
 105         int (*get_current_limit) (struct regulator_dev *);
 106
 107         /* enable/disable regulator */
 108         int (*enable) (struct regulator_dev *);
 109         int (*disable) (struct regulator_dev *);
 110         int (*is_enabled) (struct regulator_dev *);
 111
 112         /* get/set regulator operating mode (defined in consumer.h) */
 113         int (*set_mode) (struct regulator_dev *, unsigned int mode);
 114         unsigned int (*get_mode) (struct regulator_dev *);
 115
 116         /* Time taken to enable or set voltage on the regulator */
 117         int (*enable_time) (struct regulator_dev *);
 118         int (*set_voltage_time_sel) (struct regulator_dev *,
 119                                      unsigned int old_selector,
 120                                      unsigned int new_selector);
 121
 122         /* report regulator status ... most other accessors report
 123          * control inputs, this reports results of combining inputs
 124          * from Linux (and other sources) with the actual load.
 125          * returns REGULATOR_STATUS_* or negative errno.
 126          */
 127         int (*get_status)(struct regulator_dev *);
 128
 129         /* get most efficient regulator operating mode for load */
 130         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 131                                           int output_uV, int load_uA);
 132
 133         /* the operations below are for configuration of regulator state when
 134          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 135
 136         /* set regulator suspend voltage */
 137         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 138
 139         /* enable/disable regulator in suspend state */
 140         int (*set_suspend_enable) (struct regulator_dev *);
 141         int (*set_suspend_disable) (struct regulator_dev *);
 142
 143         /* set regulator suspend operating mode (defined in consumer.h) */
 144         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 145 };
 146
 147 /*
 148  * Regulators can either control voltage or current.
 149  */
 150 enum regulator_type {
 151         REGULATOR_VOLTAGE,
 152         REGULATOR_CURRENT,
 153 };
 154
 155 /**
 156  * struct regulator_desc - Static regulator descriptor
 157  *
 158  * Each regulator registered with the core is described with a
 159  * structure of this type and a struct regulator_config.  This
 160  * structure contains the non-varying parts of the regulator
 161  * description.
 162  *
 163  * @name: Identifying name for the regulator.
 164  * @supply_name: Identifying the regulator supply
 165  * @id: Numerical identifier for the regulator.
 166  * @ops: Regulator operations table.
 167  * @irq: Interrupt number for the regulator.
 168  * @type: Indicates if the regulator is a voltage or current regulator.
 169  * @owner: Module providing the regulator, used for refcounting.
 170  *
 171  * @n_voltages: Number of selectors available for ops.list_voltage().
 172  *
 173  * @min_uV: Voltage given by the lowest selector (if linear mapping)
 174  * @uV_step: Voltage increase with each selector (if linear mapping)
 175  * @volt_table: Voltage mapping table (if table based mapping)
 176  *
 177  * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
 178  * @vsel_mask: Mask for register bitfield used for selector
 179  * @enable_reg: Register for control when using regmap enable/disable ops
 180  * @enable_mask: Mask for control when using regmap enable/disable ops
 181  */
 182 struct regulator_desc {
 183         const char *name;
 184         const char *supply_name;
 185         int id;
 186         unsigned n_voltages;
 187         struct regulator_ops *ops;
 188         int irq;
 189         enum regulator_type type;
 190         struct module *owner;
 191
 192         unsigned int min_uV;
 193         unsigned int uV_step;
 194
 195         const unsigned int *volt_table;
 196
 197         unsigned int vsel_reg;
 198         unsigned int vsel_mask;
 199         unsigned int enable_reg;
 200         unsigned int enable_mask;
 201 };
 202
 203 /**
 204  * struct regulator_config - Dynamic regulator descriptor
 205  *
 206  * Each regulator registered with the core is described with a
 207  * structure of this type and a struct regulator_desc.  This structure
 208  * contains the runtime variable parts of the regulator description.
 209  *
 210  * @dev: struct device for the regulator
 211  * @init_data: platform provided init data, passed through by driver
 212  * @driver_data: private regulator data
 213  * @of_node: OpenFirmware node to parse for device tree bindings (may be
 214  *           NULL).
 215  * @regmap: regmap to use for core regmap helpers
 216  */
 217 struct regulator_config {
 218         struct device *dev;
 219         const struct regulator_init_data *init_data;
 220         void *driver_data;
 221         struct device_node *of_node;
 222         struct regmap *regmap;
 223 };
 224
 225 /*
 226  * struct regulator_dev
 227  *
 228  * Voltage / Current regulator class device. One for each
 229  * regulator.
 230  *
 231  * This should *not* be used directly by anything except the regulator
 232  * core and notification injection (which should take the mutex and do
 233  * no other direct access).
 234  */
 235 struct regulator_dev {
 236         const struct regulator_desc *desc;
 237         int exclusive;
 238         u32 use_count;
 239         u32 open_count;
 240
 241         /* lists we belong to */
 242         struct list_head list; /* list of all regulators */
 243
 244         /* lists we own */
 245         struct list_head consumer_list; /* consumers we supply */
 246
 247         struct blocking_notifier_head notifier;
 248         struct mutex mutex; /* consumer lock */
 249         struct module *owner;
 250         struct device dev;
 251         struct regulation_constraints *constraints;
 252         struct regulator *supply;       /* for tree */
 253         struct regmap *regmap;
 254
 255         struct delayed_work disable_work;
 256         int deferred_disables;
 257
 258         void *reg_data;         /* regulator_dev data */
 259
 260         struct dentry *debugfs;
 261 };
 262
 263 struct regulator_dev *
 264 regulator_register(const struct regulator_desc *regulator_desc,
 265                    const struct regulator_config *config);
 266 void regulator_unregister(struct regulator_dev *rdev);
 267
 268 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 269                                   unsigned long event, void *data);
 270
 271 void *rdev_get_drvdata(struct regulator_dev *rdev);
 272 struct device *rdev_get_dev(struct regulator_dev *rdev);
 273 int rdev_get_id(struct regulator_dev *rdev);
 274
 275 int regulator_mode_to_status(unsigned int);
 276
 277 int regulator_list_voltage_linear(struct regulator_dev *rdev,
 278                                   unsigned int selector);
 279 int regulator_list_voltage_table(struct regulator_dev *rdev,
 280                                   unsigned int selector);
 281 int regulator_map_voltage_linear(struct regulator_dev *rdev,
 282                                   int min_uV, int max_uV);
 283 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
 284                                   int min_uV, int max_uV);
 285 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
 286 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
 287 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
 288 int regulator_enable_regmap(struct regulator_dev *rdev);
 289 int regulator_disable_regmap(struct regulator_dev *rdev);
 290
 291 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 292
 293 #endif