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/regulator/consumer.h>
  20
  21 struct regulator_dev;
  22 struct regulator_init_data;
  23
  24 enum regulator_status {
  25         REGULATOR_STATUS_OFF,
  26         REGULATOR_STATUS_ON,
  27         REGULATOR_STATUS_ERROR,
  28         /* fast/normal/idle/standby are flavors of "on" */
  29         REGULATOR_STATUS_FAST,
  30         REGULATOR_STATUS_NORMAL,
  31         REGULATOR_STATUS_IDLE,
  32         REGULATOR_STATUS_STANDBY,
  33 };
  34
  35 /**
  36  * struct regulator_ops - regulator operations.
  37  *
  38  * @enable: Configure the regulator as enabled.
  39  * @disable: Configure the regulator as disabled.
  40  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
  41  *              May also return negative errno.
  42  *
  43  * @set_voltage: Set the voltage for the regulator within the range specified.
  44  *               The driver should select the voltage closest to min_uV.
  45  * @get_voltage: Return the currently configured voltage for the regulator.
  46  * @get_voltage_sel: Return the currently configured voltage selector for the
  47  *                   regulator.
  48  * @list_voltage: Return one of the supported voltages, in microvolts; zero
  49  *      if the selector indicates a voltage that is unusable on this system;
  50  *      or negative errno.  Selectors range from zero to one less than
  51  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
  52  *
  53  * @set_current_limit: Configure a limit for a current-limited regulator.
  54  * @get_current_limit: Get the configured limit for a current-limited regulator.
  55  *
  56  * @set_mode: Set the configured operating mode for the regulator.
  57  * @get_mode: Get the configured operating mode for the regulator.
  58  * @get_status: Return actual (not as-configured) status of regulator, as a
  59  *      REGULATOR_STATUS value (or negative errno)
  60  * @get_optimum_mode: Get the most efficient operating mode for the regulator
  61  *                    when running with the specified parameters.
  62  *
  63  * @enable_time: Time taken for the regulator voltage output voltage to
  64  *               stabalise after being enabled, in microseconds.
  65  *
  66  * @set_suspend_voltage: Set the voltage for the regulator when the system
  67  *                       is suspended.
  68  * @set_suspend_enable: Mark the regulator as enabled when the system is
  69  *                      suspended.
  70  * @set_suspend_disable: Mark the regulator as disabled when the system is
  71  *                       suspended.
  72  * @set_suspend_mode: Set the operating mode for the regulator when the
  73  *                    system is suspended.
  74  *
  75  * This struct describes regulator operations which can be implemented by
  76  * regulator chip drivers.
  77  */
  78 struct regulator_ops {
  79
  80         /* enumerate supported voltages */
  81         int (*list_voltage) (struct regulator_dev *, unsigned selector);
  82
  83         /* get/set regulator voltage */
  84         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
  85                             unsigned *selector);
  86         int (*get_voltage) (struct regulator_dev *);
  87         int (*get_voltage_sel) (struct regulator_dev *);
  88
  89         /* get/set regulator current  */
  90         int (*set_current_limit) (struct regulator_dev *,
  91                                  int min_uA, int max_uA);
  92         int (*get_current_limit) (struct regulator_dev *);
  93
  94         /* enable/disable regulator */
  95         int (*enable) (struct regulator_dev *);
  96         int (*disable) (struct regulator_dev *);
  97         int (*is_enabled) (struct regulator_dev *);
  98
  99         /* get/set regulator operating mode (defined in regulator.h) */
 100         int (*set_mode) (struct regulator_dev *, unsigned int mode);
 101         unsigned int (*get_mode) (struct regulator_dev *);
 102
 103         /* Time taken to enable the regulator */
 104         int (*enable_time) (struct regulator_dev *);
 105
 106         /* report regulator status ... most other accessors report
 107          * control inputs, this reports results of combining inputs
 108          * from Linux (and other sources) with the actual load.
 109          * returns REGULATOR_STATUS_* or negative errno.
 110          */
 111         int (*get_status)(struct regulator_dev *);
 112
 113         /* get most efficient regulator operating mode for load */
 114         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 115                                           int output_uV, int load_uA);
 116
 117         /* the operations below are for configuration of regulator state when
 118          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 119
 120         /* set regulator suspend voltage */
 121         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 122
 123         /* enable/disable regulator in suspend state */
 124         int (*set_suspend_enable) (struct regulator_dev *);
 125         int (*set_suspend_disable) (struct regulator_dev *);
 126
 127         /* set regulator suspend operating mode (defined in regulator.h) */
 128         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 129 };
 130
 131 /*
 132  * Regulators can either control voltage or current.
 133  */
 134 enum regulator_type {
 135         REGULATOR_VOLTAGE,
 136         REGULATOR_CURRENT,
 137 };
 138
 139 /**
 140  * struct regulator_desc - Regulator descriptor
 141  *
 142  * Each regulator registered with the core is described with a structure of
 143  * this type.
 144  *
 145  * @name: Identifying name for the regulator.
 146  * @id: Numerical identifier for the regulator.
 147  * @n_voltages: Number of selectors available for ops.list_voltage().
 148  * @ops: Regulator operations table.
 149  * @irq: Interrupt number for the regulator.
 150  * @type: Indicates if the regulator is a voltage or current regulator.
 151  * @owner: Module providing the regulator, used for refcounting.
 152  */
 153 struct regulator_desc {
 154         const char *name;
 155         int id;
 156         unsigned n_voltages;
 157         struct regulator_ops *ops;
 158         int irq;
 159         enum regulator_type type;
 160         struct module *owner;
 161 };
 162
 163 /*
 164  * struct regulator_dev
 165  *
 166  * Voltage / Current regulator class device. One for each
 167  * regulator.
 168  *
 169  * This should *not* be used directly by anything except the regulator
 170  * core and notification injection (which should take the mutex and do
 171  * no other direct access).
 172  */
 173 struct regulator_dev {
 174         struct regulator_desc *desc;
 175         int use_count;
 176         int open_count;
 177         int exclusive;
 178
 179         /* lists we belong to */
 180         struct list_head list; /* list of all regulators */
 181         struct list_head slist; /* list of supplied regulators */
 182
 183         /* lists we own */
 184         struct list_head consumer_list; /* consumers we supply */
 185         struct list_head supply_list; /* regulators we supply */
 186
 187         struct blocking_notifier_head notifier;
 188         struct mutex mutex; /* consumer lock */
 189         struct module *owner;
 190         struct device dev;
 191         struct regulation_constraints *constraints;
 192         struct regulator_dev *supply;   /* for tree */
 193
 194         void *reg_data;         /* regulator_dev data */
 195 };
 196
 197 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
 198         struct device *dev, const struct regulator_init_data *init_data,
 199         void *driver_data);
 200 void regulator_unregister(struct regulator_dev *rdev);
 201
 202 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 203                                   unsigned long event, void *data);
 204
 205 void *rdev_get_drvdata(struct regulator_dev *rdev);
 206 struct device *rdev_get_dev(struct regulator_dev *rdev);
 207 int rdev_get_id(struct regulator_dev *rdev);
 208
 209 int regulator_mode_to_status(unsigned int);
 210
 211 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 212
 213 #endif