~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/regulator/consumer.h

Version: ~ [ linux-5.9 ] ~ [ linux-5.8.14 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.70 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.150 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.200 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.238 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.238 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  * consumer.h -- SoC Regulator consumer 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 Consumer Interface.
 13  *
 14  * A Power Management Regulator framework for SoC based devices.
 15  * Features:-
 16  *   o Voltage and current level control.
 17  *   o Operating mode control.
 18  *   o Regulator status.
 19  *   o sysfs entries for showing client devices and status
 20  *
 21  * EXPERIMENTAL FEATURES:
 22  *   Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
 23  *   to use most efficient operating mode depending upon voltage and load and
 24  *   is transparent to client drivers.
 25  *
 26  *   e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
 27  *   IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
 28  *   idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
 29  *   but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
 30  *   efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
 31  *   in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
 32  *
 33  */
 34 
 35 #ifndef __LINUX_REGULATOR_CONSUMER_H_
 36 #define __LINUX_REGULATOR_CONSUMER_H_
 37 
 38 struct device;
 39 struct notifier_block;
 40 
 41 /*
 42  * Regulator operating modes.
 43  *
 44  * Regulators can run in a variety of different operating modes depending on
 45  * output load. This allows further system power savings by selecting the
 46  * best (and most efficient) regulator mode for a desired load.
 47  *
 48  * Most drivers will only care about NORMAL. The modes below are generic and
 49  * will probably not match the naming convention of your regulator data sheet
 50  * but should match the use cases in the datasheet.
 51  *
 52  * In order of power efficiency (least efficient at top).
 53  *
 54  *  Mode       Description
 55  *  FAST       Regulator can handle fast changes in it's load.
 56  *             e.g. useful in CPU voltage & frequency scaling where
 57  *             load can quickly increase with CPU frequency increases.
 58  *
 59  *  NORMAL     Normal regulator power supply mode. Most drivers will
 60  *             use this mode.
 61  *
 62  *  IDLE       Regulator runs in a more efficient mode for light
 63  *             loads. Can be used for devices that have a low power
 64  *             requirement during periods of inactivity. This mode
 65  *             may be more noisy than NORMAL and may not be able
 66  *             to handle fast load switching.
 67  *
 68  *  STANDBY    Regulator runs in the most efficient mode for very
 69  *             light loads. Can be used by devices when they are
 70  *             in a sleep/standby state. This mode is likely to be
 71  *             the most noisy and may not be able to handle fast load
 72  *             switching.
 73  *
 74  * NOTE: Most regulators will only support a subset of these modes. Some
 75  * will only just support NORMAL.
 76  *
 77  * These modes can be OR'ed together to make up a mask of valid register modes.
 78  */
 79 
 80 #define REGULATOR_MODE_FAST                     0x1
 81 #define REGULATOR_MODE_NORMAL                   0x2
 82 #define REGULATOR_MODE_IDLE                     0x4
 83 #define REGULATOR_MODE_STANDBY                  0x8
 84 
 85 /*
 86  * Regulator notifier events.
 87  *
 88  * UNDER_VOLTAGE  Regulator output is under voltage.
 89  * OVER_CURRENT   Regulator output current is too high.
 90  * REGULATION_OUT Regulator output is out of regulation.
 91  * FAIL           Regulator output has failed.
 92  * OVER_TEMP      Regulator over temp.
 93  * FORCE_DISABLE  Regulator forcibly shut down by software.
 94  * VOLTAGE_CHANGE Regulator voltage changed.
 95  * DISABLE        Regulator was disabled.
 96  *
 97  * NOTE: These events can be OR'ed together when passed into handler.
 98  */
 99 
100 #define REGULATOR_EVENT_UNDER_VOLTAGE           0x01
101 #define REGULATOR_EVENT_OVER_CURRENT            0x02
102 #define REGULATOR_EVENT_REGULATION_OUT          0x04
103 #define REGULATOR_EVENT_FAIL                    0x08
104 #define REGULATOR_EVENT_OVER_TEMP               0x10
105 #define REGULATOR_EVENT_FORCE_DISABLE           0x20
106 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
107 #define REGULATOR_EVENT_DISABLE                 0x80
108 
109 struct regulator;
110 
111 /**
112  * struct regulator_bulk_data - Data used for bulk regulator operations.
113  *
114  * @supply:   The name of the supply.  Initialised by the user before
115  *            using the bulk regulator APIs.
116  * @consumer: The regulator consumer for the supply.  This will be managed
117  *            by the bulk API.
118  *
119  * The regulator APIs provide a series of regulator_bulk_() API calls as
120  * a convenience to consumers which require multiple supplies.  This
121  * structure is used to manage data for these calls.
122  */
123 struct regulator_bulk_data {
124         const char *supply;
125         struct regulator *consumer;
126 
127         /* private: Internal use */
128         int ret;
129 };
130 
131 #if defined(CONFIG_REGULATOR)
132 
133 /* regulator get and put */
134 struct regulator *__must_check regulator_get(struct device *dev,
135                                              const char *id);
136 struct regulator *__must_check devm_regulator_get(struct device *dev,
137                                              const char *id);
138 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
139                                                        const char *id);
140 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
141                                                         const char *id);
142 struct regulator *__must_check regulator_get_optional(struct device *dev,
143                                                       const char *id);
144 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
145                                                            const char *id);
146 void regulator_put(struct regulator *regulator);
147 void devm_regulator_put(struct regulator *regulator);
148 
149 int regulator_register_supply_alias(struct device *dev, const char *id,
150                                     struct device *alias_dev,
151                                     const char *alias_id);
152 void regulator_unregister_supply_alias(struct device *dev, const char *id);
153 
154 int regulator_bulk_register_supply_alias(struct device *dev, const char **id,
155                                          struct device *alias_dev,
156                                          const char **alias_id, int num_id);
157 void regulator_bulk_unregister_supply_alias(struct device *dev,
158                                             const char **id, int num_id);
159 
160 int devm_regulator_register_supply_alias(struct device *dev, const char *id,
161                                          struct device *alias_dev,
162                                          const char *alias_id);
163 void devm_regulator_unregister_supply_alias(struct device *dev,
164                                             const char *id);
165 
166 int devm_regulator_bulk_register_supply_alias(struct device *dev,
167                                               const char **id,
168                                               struct device *alias_dev,
169                                               const char **alias_id,
170                                               int num_id);
171 void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
172                                                  const char **id,
173                                                  int num_id);
174 
175 /* regulator output control and status */
176 int __must_check regulator_enable(struct regulator *regulator);
177 int regulator_disable(struct regulator *regulator);
178 int regulator_force_disable(struct regulator *regulator);
179 int regulator_is_enabled(struct regulator *regulator);
180 int regulator_disable_deferred(struct regulator *regulator, int ms);
181 
182 int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
183                                     struct regulator_bulk_data *consumers);
184 int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
185                                          struct regulator_bulk_data *consumers);
186 int __must_check regulator_bulk_enable(int num_consumers,
187                                        struct regulator_bulk_data *consumers);
188 int regulator_bulk_disable(int num_consumers,
189                            struct regulator_bulk_data *consumers);
190 int regulator_bulk_force_disable(int num_consumers,
191                            struct regulator_bulk_data *consumers);
192 void regulator_bulk_free(int num_consumers,
193                          struct regulator_bulk_data *consumers);
194 
195 int regulator_can_change_voltage(struct regulator *regulator);
196 int regulator_count_voltages(struct regulator *regulator);
197 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
198 int regulator_is_supported_voltage(struct regulator *regulator,
199                                    int min_uV, int max_uV);
200 unsigned int regulator_get_linear_step(struct regulator *regulator);
201 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
202 int regulator_set_voltage_time(struct regulator *regulator,
203                                int old_uV, int new_uV);
204 int regulator_get_voltage(struct regulator *regulator);
205 int regulator_sync_voltage(struct regulator *regulator);
206 int regulator_set_current_limit(struct regulator *regulator,
207                                int min_uA, int max_uA);
208 int regulator_get_current_limit(struct regulator *regulator);
209 
210 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
211 unsigned int regulator_get_mode(struct regulator *regulator);
212 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
213 
214 int regulator_allow_bypass(struct regulator *regulator, bool allow);
215 
216 /* regulator notifier block */
217 int regulator_register_notifier(struct regulator *regulator,
218                               struct notifier_block *nb);
219 int regulator_unregister_notifier(struct regulator *regulator,
220                                 struct notifier_block *nb);
221 
222 /* driver data - core doesn't touch */
223 void *regulator_get_drvdata(struct regulator *regulator);
224 void regulator_set_drvdata(struct regulator *regulator, void *data);
225 
226 #else
227 
228 /*
229  * Make sure client drivers will still build on systems with no software
230  * controllable voltage or current regulators.
231  */
232 static inline struct regulator *__must_check regulator_get(struct device *dev,
233         const char *id)
234 {
235         /* Nothing except the stubbed out regulator API should be
236          * looking at the value except to check if it is an error
237          * value. Drivers are free to handle NULL specifically by
238          * skipping all regulator API calls, but they don't have to.
239          * Drivers which don't, should make sure they properly handle
240          * corner cases of the API, such as regulator_get_voltage()
241          * returning 0.
242          */
243         return NULL;
244 }
245 
246 static inline struct regulator *__must_check
247 devm_regulator_get(struct device *dev, const char *id)
248 {
249         return NULL;
250 }
251 
252 static inline struct regulator *__must_check
253 regulator_get_exclusive(struct device *dev, const char *id)
254 {
255         return NULL;
256 }
257 
258 static inline struct regulator *__must_check
259 regulator_get_optional(struct device *dev, const char *id)
260 {
261         return ERR_PTR(-ENODEV);
262 }
263 
264 
265 static inline struct regulator *__must_check
266 devm_regulator_get_optional(struct device *dev, const char *id)
267 {
268         return ERR_PTR(-ENODEV);
269 }
270 
271 static inline void regulator_put(struct regulator *regulator)
272 {
273 }
274 
275 static inline void devm_regulator_put(struct regulator *regulator)
276 {
277 }
278 
279 static inline int regulator_register_supply_alias(struct device *dev,
280                                                   const char *id,
281                                                   struct device *alias_dev,
282                                                   const char *alias_id)
283 {
284         return 0;
285 }
286 
287 static inline void regulator_unregister_supply_alias(struct device *dev,
288                                                     const char *id)
289 {
290 }
291 
292 static inline int regulator_bulk_register_supply_alias(struct device *dev,
293                                                        const char **id,
294                                                        struct device *alias_dev,
295                                                        const char **alias_id,
296                                                        int num_id)
297 {
298         return 0;
299 }
300 
301 static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
302                                                           const char **id,
303                                                           int num_id)
304 {
305 }
306 
307 static inline int devm_regulator_register_supply_alias(struct device *dev,
308                                                        const char *id,
309                                                        struct device *alias_dev,
310                                                        const char *alias_id)
311 {
312         return 0;
313 }
314 
315 static inline void devm_regulator_unregister_supply_alias(struct device *dev,
316                                                           const char *id)
317 {
318 }
319 
320 static inline int devm_regulator_bulk_register_supply_alias(
321                 struct device *dev, const char **id, struct device *alias_dev,
322                 const char **alias_id, int num_id)
323 {
324         return 0;
325 }
326 
327 static inline void devm_regulator_bulk_unregister_supply_alias(
328                 struct device *dev, const char **id, int num_id)
329 {
330 }
331 
332 static inline int regulator_enable(struct regulator *regulator)
333 {
334         return 0;
335 }
336 
337 static inline int regulator_disable(struct regulator *regulator)
338 {
339         return 0;
340 }
341 
342 static inline int regulator_force_disable(struct regulator *regulator)
343 {
344         return 0;
345 }
346 
347 static inline int regulator_disable_deferred(struct regulator *regulator,
348                                              int ms)
349 {
350         return 0;
351 }
352 
353 static inline int regulator_is_enabled(struct regulator *regulator)
354 {
355         return 1;
356 }
357 
358 static inline int regulator_bulk_get(struct device *dev,
359                                      int num_consumers,
360                                      struct regulator_bulk_data *consumers)
361 {
362         return 0;
363 }
364 
365 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
366                                           struct regulator_bulk_data *consumers)
367 {
368         return 0;
369 }
370 
371 static inline int regulator_bulk_enable(int num_consumers,
372                                         struct regulator_bulk_data *consumers)
373 {
374         return 0;
375 }
376 
377 static inline int regulator_bulk_disable(int num_consumers,
378                                          struct regulator_bulk_data *consumers)
379 {
380         return 0;
381 }
382 
383 static inline int regulator_bulk_force_disable(int num_consumers,
384                                         struct regulator_bulk_data *consumers)
385 {
386         return 0;
387 }
388 
389 static inline void regulator_bulk_free(int num_consumers,
390                                        struct regulator_bulk_data *consumers)
391 {
392 }
393 
394 static inline int regulator_set_voltage(struct regulator *regulator,
395                                         int min_uV, int max_uV)
396 {
397         return 0;
398 }
399 
400 static inline int regulator_get_voltage(struct regulator *regulator)
401 {
402         return -EINVAL;
403 }
404 
405 static inline int regulator_is_supported_voltage(struct regulator *regulator,
406                                    int min_uV, int max_uV)
407 {
408         return 0;
409 }
410 
411 static inline int regulator_set_current_limit(struct regulator *regulator,
412                                              int min_uA, int max_uA)
413 {
414         return 0;
415 }
416 
417 static inline int regulator_get_current_limit(struct regulator *regulator)
418 {
419         return 0;
420 }
421 
422 static inline int regulator_set_mode(struct regulator *regulator,
423         unsigned int mode)
424 {
425         return 0;
426 }
427 
428 static inline unsigned int regulator_get_mode(struct regulator *regulator)
429 {
430         return REGULATOR_MODE_NORMAL;
431 }
432 
433 static inline int regulator_set_optimum_mode(struct regulator *regulator,
434                                         int load_uA)
435 {
436         return REGULATOR_MODE_NORMAL;
437 }
438 
439 static inline int regulator_allow_bypass(struct regulator *regulator,
440                                          bool allow)
441 {
442         return 0;
443 }
444 
445 static inline int regulator_register_notifier(struct regulator *regulator,
446                               struct notifier_block *nb)
447 {
448         return 0;
449 }
450 
451 static inline int regulator_unregister_notifier(struct regulator *regulator,
452                                 struct notifier_block *nb)
453 {
454         return 0;
455 }
456 
457 static inline void *regulator_get_drvdata(struct regulator *regulator)
458 {
459         return NULL;
460 }
461 
462 static inline void regulator_set_drvdata(struct regulator *regulator,
463         void *data)
464 {
465 }
466 
467 static inline int regulator_count_voltages(struct regulator *regulator)
468 {
469         return 0;
470 }
471 #endif
472 
473 static inline int regulator_set_voltage_tol(struct regulator *regulator,
474                                             int new_uV, int tol_uV)
475 {
476         if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
477                 return 0;
478         else
479                 return regulator_set_voltage(regulator,
480                                              new_uV - tol_uV, new_uV + tol_uV);
481 }
482 
483 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
484                                                      int target_uV, int tol_uV)
485 {
486         return regulator_is_supported_voltage(regulator,
487                                               target_uV - tol_uV,
488                                               target_uV + tol_uV);
489 }
490 
491 #endif
492 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp