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