2 * OF helpers for regulator framework
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Rajendra Nayak <rnayak@ti.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
13 #include <linux/module.h>
14 #include <linux/slab.h>
16 #include <linux/regulator/machine.h>
17 #include <linux/regulator/driver.h>
18 #include <linux/regulator/of_regulator.h>
22 static const char *const regulator_states
[PM_SUSPEND_MAX
+ 1] = {
23 [PM_SUSPEND_MEM
] = "regulator-state-mem",
24 [PM_SUSPEND_MAX
] = "regulator-state-disk",
27 static void of_get_regulation_constraints(struct device_node
*np
,
28 struct regulator_init_data
**init_data
,
29 const struct regulator_desc
*desc
)
31 const __be32
*min_uV
, *max_uV
;
32 struct regulation_constraints
*constraints
= &(*init_data
)->constraints
;
33 struct regulator_state
*suspend_state
;
34 struct device_node
*suspend_np
;
38 constraints
->name
= of_get_property(np
, "regulator-name", NULL
);
40 min_uV
= of_get_property(np
, "regulator-min-microvolt", NULL
);
42 constraints
->min_uV
= be32_to_cpu(*min_uV
);
43 max_uV
= of_get_property(np
, "regulator-max-microvolt", NULL
);
45 constraints
->max_uV
= be32_to_cpu(*max_uV
);
47 /* Voltage change possible? */
48 if (constraints
->min_uV
!= constraints
->max_uV
)
49 constraints
->valid_ops_mask
|= REGULATOR_CHANGE_VOLTAGE
;
50 /* Only one voltage? Then make sure it's set. */
51 if (min_uV
&& max_uV
&& constraints
->min_uV
== constraints
->max_uV
)
52 constraints
->apply_uV
= true;
54 if (!of_property_read_u32(np
, "regulator-microvolt-offset", &pval
))
55 constraints
->uV_offset
= pval
;
56 if (!of_property_read_u32(np
, "regulator-min-microamp", &pval
))
57 constraints
->min_uA
= pval
;
58 if (!of_property_read_u32(np
, "regulator-max-microamp", &pval
))
59 constraints
->max_uA
= pval
;
61 if (!of_property_read_u32(np
, "regulator-input-current-limit-microamp",
63 constraints
->ilim_uA
= pval
;
65 /* Current change possible? */
66 if (constraints
->min_uA
!= constraints
->max_uA
)
67 constraints
->valid_ops_mask
|= REGULATOR_CHANGE_CURRENT
;
69 constraints
->boot_on
= of_property_read_bool(np
, "regulator-boot-on");
70 constraints
->always_on
= of_property_read_bool(np
, "regulator-always-on");
71 if (!constraints
->always_on
) /* status change should be possible. */
72 constraints
->valid_ops_mask
|= REGULATOR_CHANGE_STATUS
;
74 constraints
->pull_down
= of_property_read_bool(np
, "regulator-pull-down");
76 if (of_property_read_bool(np
, "regulator-allow-bypass"))
77 constraints
->valid_ops_mask
|= REGULATOR_CHANGE_BYPASS
;
79 ret
= of_property_read_u32(np
, "regulator-ramp-delay", &pval
);
82 constraints
->ramp_delay
= pval
;
84 constraints
->ramp_disable
= true;
87 ret
= of_property_read_u32(np
, "regulator-enable-ramp-delay", &pval
);
89 constraints
->enable_time
= pval
;
91 constraints
->soft_start
= of_property_read_bool(np
,
92 "regulator-soft-start");
94 if (!of_property_read_u32(np
, "regulator-initial-mode", &pval
)) {
95 if (desc
&& desc
->of_map_mode
) {
96 ret
= desc
->of_map_mode(pval
);
98 pr_err("%s: invalid mode %u\n", np
->name
, pval
);
100 constraints
->initial_mode
= ret
;
102 pr_warn("%s: mapping for mode %d not defined\n",
107 if (!of_property_read_u32(np
, "regulator-system-load", &pval
))
108 constraints
->system_load
= pval
;
110 constraints
->over_current_protection
= of_property_read_bool(np
,
111 "regulator-over-current-protection");
113 for (i
= 0; i
< ARRAY_SIZE(regulator_states
); i
++) {
116 suspend_state
= &constraints
->state_mem
;
119 suspend_state
= &constraints
->state_disk
;
122 case PM_SUSPEND_FREEZE
:
123 case PM_SUSPEND_STANDBY
:
128 suspend_np
= of_get_child_by_name(np
, regulator_states
[i
]);
129 if (!suspend_np
|| !suspend_state
)
132 if (!of_property_read_u32(suspend_np
, "regulator-mode",
134 if (desc
&& desc
->of_map_mode
) {
135 ret
= desc
->of_map_mode(pval
);
137 pr_err("%s: invalid mode %u\n",
140 suspend_state
->mode
= ret
;
142 pr_warn("%s: mapping for mode %d not defined\n",
147 if (of_property_read_bool(suspend_np
,
148 "regulator-on-in-suspend"))
149 suspend_state
->enabled
= true;
150 else if (of_property_read_bool(suspend_np
,
151 "regulator-off-in-suspend"))
152 suspend_state
->disabled
= true;
154 if (!of_property_read_u32(suspend_np
,
155 "regulator-suspend-microvolt", &pval
))
156 suspend_state
->uV
= pval
;
158 of_node_put(suspend_np
);
159 suspend_state
= NULL
;
165 * of_get_regulator_init_data - extract regulator_init_data structure info
166 * @dev: device requesting for regulator_init_data
167 * @node: regulator device node
168 * @desc: regulator description
170 * Populates regulator_init_data structure by extracting data from device
171 * tree node, returns a pointer to the populated struture or NULL if memory
174 struct regulator_init_data
*of_get_regulator_init_data(struct device
*dev
,
175 struct device_node
*node
,
176 const struct regulator_desc
*desc
)
178 struct regulator_init_data
*init_data
;
183 init_data
= devm_kzalloc(dev
, sizeof(*init_data
), GFP_KERNEL
);
185 return NULL
; /* Out of memory? */
187 of_get_regulation_constraints(node
, &init_data
, desc
);
190 EXPORT_SYMBOL_GPL(of_get_regulator_init_data
);
192 struct devm_of_regulator_matches
{
193 struct of_regulator_match
*matches
;
194 unsigned int num_matches
;
197 static void devm_of_regulator_put_matches(struct device
*dev
, void *res
)
199 struct devm_of_regulator_matches
*devm_matches
= res
;
202 for (i
= 0; i
< devm_matches
->num_matches
; i
++)
203 of_node_put(devm_matches
->matches
[i
].of_node
);
207 * of_regulator_match - extract multiple regulator init data from device tree.
208 * @dev: device requesting the data
209 * @node: parent device node of the regulators
210 * @matches: match table for the regulators
211 * @num_matches: number of entries in match table
213 * This function uses a match table specified by the regulator driver to
214 * parse regulator init data from the device tree. @node is expected to
215 * contain a set of child nodes, each providing the init data for one
216 * regulator. The data parsed from a child node will be matched to a regulator
217 * based on either the deprecated property regulator-compatible if present,
218 * or otherwise the child node's name. Note that the match table is modified
219 * in place and an additional of_node reference is taken for each matched
222 * Returns the number of matches found or a negative error code on failure.
224 int of_regulator_match(struct device
*dev
, struct device_node
*node
,
225 struct of_regulator_match
*matches
,
226 unsigned int num_matches
)
228 unsigned int count
= 0;
231 struct device_node
*child
;
232 struct devm_of_regulator_matches
*devm_matches
;
237 devm_matches
= devres_alloc(devm_of_regulator_put_matches
,
238 sizeof(struct devm_of_regulator_matches
),
243 devm_matches
->matches
= matches
;
244 devm_matches
->num_matches
= num_matches
;
246 devres_add(dev
, devm_matches
);
248 for (i
= 0; i
< num_matches
; i
++) {
249 struct of_regulator_match
*match
= &matches
[i
];
250 match
->init_data
= NULL
;
251 match
->of_node
= NULL
;
254 for_each_child_of_node(node
, child
) {
255 name
= of_get_property(child
,
256 "regulator-compatible", NULL
);
259 for (i
= 0; i
< num_matches
; i
++) {
260 struct of_regulator_match
*match
= &matches
[i
];
264 if (strcmp(match
->name
, name
))
268 of_get_regulator_init_data(dev
, child
,
270 if (!match
->init_data
) {
272 "failed to parse DT for regulator %s\n",
276 match
->of_node
= of_node_get(child
);
284 EXPORT_SYMBOL_GPL(of_regulator_match
);
286 struct regulator_init_data
*regulator_of_get_init_data(struct device
*dev
,
287 const struct regulator_desc
*desc
,
288 struct regulator_config
*config
,
289 struct device_node
**node
)
291 struct device_node
*search
, *child
;
292 struct regulator_init_data
*init_data
= NULL
;
295 if (!dev
->of_node
|| !desc
->of_match
)
298 if (desc
->regulators_node
)
299 search
= of_get_child_by_name(dev
->of_node
,
300 desc
->regulators_node
);
302 search
= dev
->of_node
;
305 dev_dbg(dev
, "Failed to find regulator container node '%s'\n",
306 desc
->regulators_node
);
310 for_each_available_child_of_node(search
, child
) {
311 name
= of_get_property(child
, "regulator-compatible", NULL
);
315 if (strcmp(desc
->of_match
, name
))
318 init_data
= of_get_regulator_init_data(dev
, child
, desc
);
321 "failed to parse DT for regulator %s\n",
326 if (desc
->of_parse_cb
) {
327 if (desc
->of_parse_cb(child
, desc
, config
)) {
329 "driver callback failed to parse DT for regulator %s\n",