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  * This struct describes regulator operations which can be implemented by
  39  * regulator chip drivers.
  40  *
  41  * @enable: Enable the regulator.
  42  * @disable: Disable the regulator.
  43  * @is_enabled: Return 1 if the regulator is enabled, 0 otherwise.
  44  *
  45  * @set_voltage: Set the voltage for the regulator within the range specified.
  46  *               The driver should select the voltage closest to min_uV.
  47  * @get_voltage: Return the currently configured voltage for the 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 limit for a current-limited regulator.
  55  *
  56  * @set_mode: Set the operating mode for the regulator.
  57  * @get_mode: Get the current operating mode for the regulator.
  58  * @get_status: Report the regulator status.
  59  * @get_optimum_mode: Get the most efficient operating mode for the regulator
  60  *                    when running with the specified parameters.
  61  *
  62  * @set_suspend_voltage: Set the voltage for the regulator when the system
  63  *                       is suspended.
  64  * @set_suspend_enable: Mark the regulator as enabled when the system is
  65  *                      suspended.
  66  * @set_suspend_disable: Mark the regulator as disabled when the system is
  67  *                       suspended.
  68  * @set_suspend_mode: Set the operating mode for the regulator when the
  69  *                    system is suspended.
  70  */
  71 struct regulator_ops {
  72
  73         /* enumerate supported voltages */
  74         int (*list_voltage) (struct regulator_dev *, unsigned selector);
  75
  76         /* get/set regulator voltage */
  77         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV);
  78         int (*get_voltage) (struct regulator_dev *);
  79
  80         /* get/set regulator current  */
  81         int (*set_current_limit) (struct regulator_dev *,
  82                                  int min_uA, int max_uA);
  83         int (*get_current_limit) (struct regulator_dev *);
  84
  85         /* enable/disable regulator */
  86         int (*enable) (struct regulator_dev *);
  87         int (*disable) (struct regulator_dev *);
  88         int (*is_enabled) (struct regulator_dev *);
  89
  90         /* get/set regulator operating mode (defined in regulator.h) */
  91         int (*set_mode) (struct regulator_dev *, unsigned int mode);
  92         unsigned int (*get_mode) (struct regulator_dev *);
  93
  94         /* report regulator status ... most other accessors report
  95          * control inputs, this reports results of combining inputs
  96          * from Linux (and other sources) with the actual load.
  97          */
  98         int (*get_status)(struct regulator_dev *);
  99
 100         /* get most efficient regulator operating mode for load */
 101         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
 102                                           int output_uV, int load_uA);
 103
 104         /* the operations below are for configuration of regulator state when
 105          * its parent PMIC enters a global STANDBY/HIBERNATE state */
 106
 107         /* set regulator suspend voltage */
 108         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
 109
 110         /* enable/disable regulator in suspend state */
 111         int (*set_suspend_enable) (struct regulator_dev *);
 112         int (*set_suspend_disable) (struct regulator_dev *);
 113
 114         /* set regulator suspend operating mode (defined in regulator.h) */
 115         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
 116 };
 117
 118 /*
 119  * Regulators can either control voltage or current.
 120  */
 121 enum regulator_type {
 122         REGULATOR_VOLTAGE,
 123         REGULATOR_CURRENT,
 124 };
 125
 126 /**
 127  * struct regulator_desc - Regulator descriptor
 128  *
 129  * Each regulator registered with the core is described with a structure of
 130  * this type.
 131  *
 132  * @name: Identifying name for the regulator.
 133  * @id: Numerical identifier for the regulator.
 134  * @n_voltages: Number of selectors available for ops.list_voltage().
 135  * @ops: Regulator operations table.
 136  * @irq: Interrupt number for the regulator.
 137  * @type: Indicates if the regulator is a voltage or current regulator.
 138  * @owner: Module providing the regulator, used for refcounting.
 139  */
 140 struct regulator_desc {
 141         const char *name;
 142         int id;
 143         unsigned n_voltages;
 144         struct regulator_ops *ops;
 145         int irq;
 146         enum regulator_type type;
 147         struct module *owner;
 148 };
 149
 150 /*
 151  * struct regulator_dev
 152  *
 153  * Voltage / Current regulator class device. One for each
 154  * regulator.
 155  *
 156  * This should *not* be used directly by anything except the regulator
 157  * core and notification injection (which should take the mutex and do
 158  * no other direct access).
 159  */
 160 struct regulator_dev {
 161         struct regulator_desc *desc;
 162         int use_count;
 163
 164         /* lists we belong to */
 165         struct list_head list; /* list of all regulators */
 166         struct list_head slist; /* list of supplied regulators */
 167
 168         /* lists we own */
 169         struct list_head consumer_list; /* consumers we supply */
 170         struct list_head supply_list; /* regulators we supply */
 171
 172         struct blocking_notifier_head notifier;
 173         struct mutex mutex; /* consumer lock */
 174         struct module *owner;
 175         struct device dev;
 176         struct regulation_constraints *constraints;
 177         struct regulator_dev *supply;   /* for tree */
 178
 179         void *reg_data;         /* regulator_dev data */
 180 };
 181
 182 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
 183         struct device *dev, struct regulator_init_data *init_data,
 184         void *driver_data);
 185 void regulator_unregister(struct regulator_dev *rdev);
 186
 187 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 188                                   unsigned long event, void *data);
 189
 190 void *rdev_get_drvdata(struct regulator_dev *rdev);
 191 struct device *rdev_get_dev(struct regulator_dev *rdev);
 192 int rdev_get_id(struct regulator_dev *rdev);
 193
 194 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
 195
 196 #endif