Commit | Line | Data |
---|---|---|
571a354b LG |
1 | /* |
2 | * driver.h -- SoC Regulator driver support. | |
3 | * | |
4 | * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. | |
5 | * | |
6 | * Author: Liam Girdwood <lg@opensource.wolfsonmicro.com> | |
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 | ||
571a354b | 21 | struct regulator_dev; |
a5766f11 | 22 | struct regulator_init_data; |
571a354b | 23 | |
853116a1 DB |
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 | ||
571a354b LG |
35 | /** |
36 | * struct regulator_ops - regulator operations. | |
37 | * | |
c8e7e464 MB |
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. | |
0ba4887c | 43 | * @is_enabled: Return 1 if the regulator is enabled, 0 otherwise. |
c8e7e464 MB |
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 | * | |
c8e7e464 MB |
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_optimum_mode: Get the most efficient operating mode for the regulator | |
55 | * when running with the specified parameters. | |
56 | * | |
57 | * @set_suspend_voltage: Set the voltage for the regulator when the system | |
58 | * is suspended. | |
59 | * @set_suspend_enable: Mark the regulator as enabled when the system is | |
60 | * suspended. | |
61 | * @set_suspend_disable: Mark the regulator as disabled when the system is | |
62 | * suspended. | |
63 | * @set_suspend_mode: Set the operating mode for the regulator when the | |
64 | * system is suspended. | |
571a354b LG |
65 | */ |
66 | struct regulator_ops { | |
67 | ||
68 | /* get/set regulator voltage */ | |
69 | int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV); | |
70 | int (*get_voltage) (struct regulator_dev *); | |
71 | ||
72 | /* get/set regulator current */ | |
73 | int (*set_current_limit) (struct regulator_dev *, | |
74 | int min_uA, int max_uA); | |
75 | int (*get_current_limit) (struct regulator_dev *); | |
76 | ||
77 | /* enable/disable regulator */ | |
78 | int (*enable) (struct regulator_dev *); | |
79 | int (*disable) (struct regulator_dev *); | |
80 | int (*is_enabled) (struct regulator_dev *); | |
81 | ||
82 | /* get/set regulator operating mode (defined in regulator.h) */ | |
83 | int (*set_mode) (struct regulator_dev *, unsigned int mode); | |
84 | unsigned int (*get_mode) (struct regulator_dev *); | |
85 | ||
853116a1 DB |
86 | /* report regulator status ... most other accessors report |
87 | * control inputs, this reports results of combining inputs | |
88 | * from Linux (and other sources) with the actual load. | |
89 | */ | |
90 | int (*get_status)(struct regulator_dev *); | |
91 | ||
571a354b LG |
92 | /* get most efficient regulator operating mode for load */ |
93 | unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, | |
94 | int output_uV, int load_uA); | |
95 | ||
96 | /* the operations below are for configuration of regulator state when | |
3de89609 | 97 | * its parent PMIC enters a global STANDBY/HIBERNATE state */ |
571a354b LG |
98 | |
99 | /* set regulator suspend voltage */ | |
100 | int (*set_suspend_voltage) (struct regulator_dev *, int uV); | |
101 | ||
102 | /* enable/disable regulator in suspend state */ | |
103 | int (*set_suspend_enable) (struct regulator_dev *); | |
104 | int (*set_suspend_disable) (struct regulator_dev *); | |
105 | ||
106 | /* set regulator suspend operating mode (defined in regulator.h) */ | |
107 | int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); | |
108 | }; | |
109 | ||
110 | /* | |
111 | * Regulators can either control voltage or current. | |
112 | */ | |
113 | enum regulator_type { | |
114 | REGULATOR_VOLTAGE, | |
115 | REGULATOR_CURRENT, | |
116 | }; | |
117 | ||
118 | /** | |
119 | * struct regulator_desc - Regulator descriptor | |
120 | * | |
c8e7e464 MB |
121 | * Each regulator registered with the core is described with a structure of |
122 | * this type. | |
123 | * | |
124 | * @name: Identifying name for the regulator. | |
125 | * @id: Numerical identifier for the regulator. | |
126 | * @ops: Regulator operations table. | |
0ba4887c | 127 | * @irq: Interrupt number for the regulator. |
c8e7e464 MB |
128 | * @type: Indicates if the regulator is a voltage or current regulator. |
129 | * @owner: Module providing the regulator, used for refcounting. | |
571a354b LG |
130 | */ |
131 | struct regulator_desc { | |
132 | const char *name; | |
133 | int id; | |
134 | struct regulator_ops *ops; | |
135 | int irq; | |
136 | enum regulator_type type; | |
137 | struct module *owner; | |
138 | }; | |
139 | ||
571a354b | 140 | struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc, |
a5766f11 | 141 | struct device *dev, void *driver_data); |
571a354b LG |
142 | void regulator_unregister(struct regulator_dev *rdev); |
143 | ||
144 | int regulator_notifier_call_chain(struct regulator_dev *rdev, | |
145 | unsigned long event, void *data); | |
146 | ||
147 | void *rdev_get_drvdata(struct regulator_dev *rdev); | |
a5766f11 | 148 | struct device *rdev_get_dev(struct regulator_dev *rdev); |
571a354b LG |
149 | int rdev_get_id(struct regulator_dev *rdev); |
150 | ||
a5766f11 LG |
151 | void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); |
152 | ||
571a354b | 153 | #endif |