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