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