xref: /openbmc/linux/drivers/regulator/internal.h (revision e657c18a)
1 /*
2  * internal.h  --  Voltage/Current Regulator framework internal code
3  *
4  * Copyright 2007, 2008 Wolfson Microelectronics PLC.
5  * Copyright 2008 SlimLogic Ltd.
6  *
7  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
8  *
9  *  This program is free software; you can redistribute  it and/or modify it
10  *  under  the terms of  the GNU General  Public License as published by the
11  *  Free Software Foundation;  either version 2 of the  License, or (at your
12  *  option) any later version.
13  *
14  */
15 
16 #ifndef __REGULATOR_INTERNAL_H
17 #define __REGULATOR_INTERNAL_H
18 
19 #include <linux/suspend.h>
20 
21 #define REGULATOR_STATES_NUM	(PM_SUSPEND_MAX + 1)
22 
23 struct regulator_voltage {
24 	int min_uV;
25 	int max_uV;
26 };
27 
28 /*
29  * struct regulator
30  *
31  * One for each consumer device.
32  * @voltage - a voltage array for each state of runtime, i.e.:
33  *            PM_SUSPEND_ON
34  *            PM_SUSPEND_TO_IDLE
35  *            PM_SUSPEND_STANDBY
36  *            PM_SUSPEND_MEM
37  *            PM_SUSPEND_MAX
38  */
39 struct regulator {
40 	struct device *dev;
41 	struct list_head list;
42 	unsigned int always_on:1;
43 	unsigned int bypass:1;
44 	int uA_load;
45 	unsigned int enable_count;
46 	unsigned int deferred_disables;
47 	struct regulator_voltage voltage[REGULATOR_STATES_NUM];
48 	const char *supply_name;
49 	struct device_attribute dev_attr;
50 	struct regulator_dev *rdev;
51 	struct dentry *debugfs;
52 };
53 
54 extern struct class regulator_class;
55 
56 static inline struct regulator_dev *dev_to_rdev(struct device *dev)
57 {
58 	return container_of(dev, struct regulator_dev, dev);
59 }
60 
61 #ifdef CONFIG_OF
62 struct regulator_dev *of_find_regulator_by_node(struct device_node *np);
63 struct regulator_init_data *regulator_of_get_init_data(struct device *dev,
64 			         const struct regulator_desc *desc,
65 				 struct regulator_config *config,
66 				 struct device_node **node);
67 
68 struct regulator_dev *of_parse_coupled_regulator(struct regulator_dev *rdev,
69 						 int index);
70 
71 int of_get_n_coupled(struct regulator_dev *rdev);
72 
73 bool of_check_coupling_data(struct regulator_dev *rdev);
74 
75 #else
76 static inline struct regulator_dev *
77 of_find_regulator_by_node(struct device_node *np)
78 {
79 	return NULL;
80 }
81 
82 static inline struct regulator_init_data *
83 regulator_of_get_init_data(struct device *dev,
84 			   const struct regulator_desc *desc,
85 			   struct regulator_config *config,
86 			   struct device_node **node)
87 {
88 	return NULL;
89 }
90 
91 static inline struct regulator_dev *
92 of_parse_coupled_regulator(struct regulator_dev *rdev,
93 			   int index)
94 {
95 	return NULL;
96 }
97 
98 static inline int of_get_n_coupled(struct regulator_dev *rdev)
99 {
100 	return 0;
101 }
102 
103 static inline bool of_check_coupling_data(struct regulator_dev *rdev)
104 {
105 	return false;
106 }
107 
108 #endif
109 enum regulator_get_type {
110 	NORMAL_GET,
111 	EXCLUSIVE_GET,
112 	OPTIONAL_GET,
113 	MAX_GET_TYPE
114 };
115 
116 struct regulator *_regulator_get(struct device *dev, const char *id,
117 				 enum regulator_get_type get_type);
118 #endif
119