xref: /openbmc/linux/drivers/regulator/internal.h (revision 5d331b7f)
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 	struct regulator_voltage voltage[REGULATOR_STATES_NUM];
46 	const char *supply_name;
47 	struct device_attribute dev_attr;
48 	struct regulator_dev *rdev;
49 	struct dentry *debugfs;
50 };
51 
52 extern struct class regulator_class;
53 
54 static inline struct regulator_dev *dev_to_rdev(struct device *dev)
55 {
56 	return container_of(dev, struct regulator_dev, dev);
57 }
58 
59 #ifdef CONFIG_OF
60 struct regulator_dev *of_find_regulator_by_node(struct device_node *np);
61 struct regulator_init_data *regulator_of_get_init_data(struct device *dev,
62 			         const struct regulator_desc *desc,
63 				 struct regulator_config *config,
64 				 struct device_node **node);
65 
66 struct regulator_dev *of_parse_coupled_regulator(struct regulator_dev *rdev,
67 						 int index);
68 
69 int of_get_n_coupled(struct regulator_dev *rdev);
70 
71 bool of_check_coupling_data(struct regulator_dev *rdev);
72 
73 #else
74 static inline struct regulator_dev *
75 of_find_regulator_by_node(struct device_node *np)
76 {
77 	return NULL;
78 }
79 
80 static inline struct regulator_init_data *
81 regulator_of_get_init_data(struct device *dev,
82 			   const struct regulator_desc *desc,
83 			   struct regulator_config *config,
84 			   struct device_node **node)
85 {
86 	return NULL;
87 }
88 
89 static inline struct regulator_dev *
90 of_parse_coupled_regulator(struct regulator_dev *rdev,
91 			   int index)
92 {
93 	return NULL;
94 }
95 
96 static inline int of_get_n_coupled(struct regulator_dev *rdev)
97 {
98 	return 0;
99 }
100 
101 static inline bool of_check_coupling_data(struct regulator_dev *rdev)
102 {
103 	return false;
104 }
105 
106 #endif
107 enum regulator_get_type {
108 	NORMAL_GET,
109 	EXCLUSIVE_GET,
110 	OPTIONAL_GET,
111 	MAX_GET_TYPE
112 };
113 
114 struct regulator *_regulator_get(struct device *dev, const char *id,
115 				 enum regulator_get_type get_type);
116 #endif
117