2 * driver.h -- SoC Regulator driver support.
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
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.
12 * Regulator Driver Interface.
15 #ifndef __LINUX_REGULATOR_DRIVER_H_
16 #define __LINUX_REGULATOR_DRIVER_H_
18 #include <linux/device.h>
19 #include <linux/regulator/consumer.h>
22 struct regulator_init_data;
24 enum regulator_status {
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,
36 * struct regulator_ops - regulator operations.
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 otherwise.
42 * @set_voltage: Set the voltage for the regulator within the range specified.
43 * The driver should select the voltage closest to min_uV.
44 * @get_voltage: Return the currently configured voltage for the regulator.
45 * @list_voltage: Return one of the supported voltages, in microvolts; zero
46 * if the selector indicates a voltage that is unusable on this system;
47 * or negative errno. Selectors range from zero to one less than
48 * regulator_desc.n_voltages. Voltages may be reported in any order.
50 * @set_current_limit: Configure a limit for a current-limited regulator.
51 * @get_current_limit: Get the configured limit for a current-limited regulator.
53 * @get_mode: Get the configured operating mode for the regulator.
54 * @get_status: Return actual (not as-configured) status of regulator, as a
55 * REGULATOR_STATUS value (or negative errno)
56 * @get_optimum_mode: Get the most efficient operating mode for the regulator
57 * when running with the specified parameters.
59 * @set_suspend_voltage: Set the voltage for the regulator when the system
61 * @set_suspend_enable: Mark the regulator as enabled when the system is
63 * @set_suspend_disable: Mark the regulator as disabled when the system is
65 * @set_suspend_mode: Set the operating mode for the regulator when the
66 * system is suspended.
68 * This struct describes regulator operations which can be implemented by
69 * regulator chip drivers.
71 struct regulator_ops {
73 /* enumerate supported voltages */
74 int (*list_voltage) (struct regulator_dev *, unsigned selector);
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 *);
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 *);
85 /* enable/disable regulator */
86 int (*enable) (struct regulator_dev *);
87 int (*disable) (struct regulator_dev *);
88 int (*is_enabled) (struct regulator_dev *);
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 *);
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 * returns REGULATOR_STATUS_* or negative errno.
99 int (*get_status)(struct regulator_dev *);
101 /* get most efficient regulator operating mode for load */
102 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
103 int output_uV, int load_uA);
105 /* the operations below are for configuration of regulator state when
106 * its parent PMIC enters a global STANDBY/HIBERNATE state */
108 /* set regulator suspend voltage */
109 int (*set_suspend_voltage) (struct regulator_dev *, int uV);
111 /* enable/disable regulator in suspend state */
112 int (*set_suspend_enable) (struct regulator_dev *);
113 int (*set_suspend_disable) (struct regulator_dev *);
115 /* set regulator suspend operating mode (defined in regulator.h) */
116 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
120 * Regulators can either control voltage or current.
122 enum regulator_type {
128 * struct regulator_desc - Regulator descriptor
130 * Each regulator registered with the core is described with a structure of
133 * @name: Identifying name for the regulator.
134 * @id: Numerical identifier for the regulator.
135 * @n_voltages: Number of selectors available for ops.list_voltage().
136 * @ops: Regulator operations table.
137 * @irq: Interrupt number for the regulator.
138 * @type: Indicates if the regulator is a voltage or current regulator.
139 * @owner: Module providing the regulator, used for refcounting.
141 struct regulator_desc {
145 struct regulator_ops *ops;
147 enum regulator_type type;
148 struct module *owner;
152 * struct regulator_dev
154 * Voltage / Current regulator class device. One for each
157 * This should *not* be used directly by anything except the regulator
158 * core and notification injection (which should take the mutex and do
159 * no other direct access).
161 struct regulator_dev {
162 struct regulator_desc *desc;
165 /* lists we belong to */
166 struct list_head list; /* list of all regulators */
167 struct list_head slist; /* list of supplied regulators */
170 struct list_head consumer_list; /* consumers we supply */
171 struct list_head supply_list; /* regulators we supply */
173 struct blocking_notifier_head notifier;
174 struct mutex mutex; /* consumer lock */
175 struct module *owner;
177 struct regulation_constraints *constraints;
178 struct regulator_dev *supply; /* for tree */
180 void *reg_data; /* regulator_dev data */
183 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
184 struct device *dev, struct regulator_init_data *init_data,
186 void regulator_unregister(struct regulator_dev *rdev);
188 int regulator_notifier_call_chain(struct regulator_dev *rdev,
189 unsigned long event, void *data);
191 void *rdev_get_drvdata(struct regulator_dev *rdev);
192 struct device *rdev_get_dev(struct regulator_dev *rdev);
193 int rdev_get_id(struct regulator_dev *rdev);
195 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);