]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/pinctrl/pinconf-generic.c
Merge tag 'sound-fix-4.4-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[mirror_ubuntu-bionic-kernel.git] / drivers / pinctrl / pinconf-generic.c
CommitLineData
394349f7
LW
1/*
2 * Core driver for the generic pin config portions of the pin control subsystem
3 *
4 * Copyright (C) 2011 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
6 *
7 * Author: Linus Walleij <linus.walleij@linaro.org>
8 *
9 * License terms: GNU General Public License (GPL) version 2
10 */
11
12#define pr_fmt(fmt) "generic pinconfig core: " fmt
13
14#include <linux/kernel.h>
9cfd1724 15#include <linux/module.h>
394349f7
LW
16#include <linux/init.h>
17#include <linux/device.h>
18#include <linux/slab.h>
19#include <linux/debugfs.h>
20#include <linux/seq_file.h>
21#include <linux/pinctrl/pinctrl.h>
22#include <linux/pinctrl/pinconf.h>
23#include <linux/pinctrl/pinconf-generic.h>
7db9af4b 24#include <linux/of.h>
394349f7
LW
25#include "core.h"
26#include "pinconf.h"
e81c8f18 27#include "pinctrl-utils.h"
394349f7
LW
28
29#ifdef CONFIG_DEBUG_FS
2500bcc9 30static const struct pin_config_item conf_items[] = {
3c4b23dd 31 PCONFDUMP(PIN_CONFIG_BIAS_BUS_HOLD, "input bias bus hold", NULL, false),
eec45071
SB
32 PCONFDUMP(PIN_CONFIG_BIAS_DISABLE, "input bias disabled", NULL, false),
33 PCONFDUMP(PIN_CONFIG_BIAS_HIGH_IMPEDANCE, "input bias high impedance", NULL, false),
eec45071 34 PCONFDUMP(PIN_CONFIG_BIAS_PULL_DOWN, "input bias pull down", NULL, false),
7970cb77 35 PCONFDUMP(PIN_CONFIG_BIAS_PULL_PIN_DEFAULT,
eec45071 36 "input bias pull to pin specific state", NULL, false),
3c4b23dd 37 PCONFDUMP(PIN_CONFIG_BIAS_PULL_UP, "input bias pull up", NULL, false),
eec45071
SB
38 PCONFDUMP(PIN_CONFIG_DRIVE_OPEN_DRAIN, "output drive open drain", NULL, false),
39 PCONFDUMP(PIN_CONFIG_DRIVE_OPEN_SOURCE, "output drive open source", NULL, false),
3c4b23dd 40 PCONFDUMP(PIN_CONFIG_DRIVE_PUSH_PULL, "output drive push pull", NULL, false),
eec45071 41 PCONFDUMP(PIN_CONFIG_DRIVE_STRENGTH, "output drive strength", "mA", true),
3c4b23dd 42 PCONFDUMP(PIN_CONFIG_INPUT_DEBOUNCE, "input debounce", "usec", true),
eec45071 43 PCONFDUMP(PIN_CONFIG_INPUT_ENABLE, "input enabled", NULL, false),
eec45071 44 PCONFDUMP(PIN_CONFIG_INPUT_SCHMITT, "input schmitt trigger", NULL, false),
3c4b23dd 45 PCONFDUMP(PIN_CONFIG_INPUT_SCHMITT_ENABLE, "input schmitt enabled", NULL, false),
eec45071
SB
46 PCONFDUMP(PIN_CONFIG_LOW_POWER_MODE, "pin low power", "mode", true),
47 PCONFDUMP(PIN_CONFIG_OUTPUT, "pin output", "level", true),
3c4b23dd
MY
48 PCONFDUMP(PIN_CONFIG_POWER_SOURCE, "pin power source", "selector", true),
49 PCONFDUMP(PIN_CONFIG_SLEW_RATE, "slew rate", NULL, true),
394349f7
LW
50};
51
dd4d01f7
SB
52static void pinconf_generic_dump_one(struct pinctrl_dev *pctldev,
53 struct seq_file *s, const char *gname,
54 unsigned pin,
55 const struct pin_config_item *items,
56 int nitems)
394349f7 57{
394349f7
LW
58 int i;
59
dd4d01f7 60 for (i = 0; i < nitems; i++) {
394349f7
LW
61 unsigned long config;
62 int ret;
63
64 /* We want to check out this parameter */
dd4d01f7
SB
65 config = pinconf_to_config_packed(items[i].param, 0);
66 if (gname)
67 ret = pin_config_group_get(dev_name(pctldev->dev),
68 gname, &config);
69 else
70 ret = pin_config_get_for_pin(pctldev, pin, &config);
394349f7
LW
71 /* These are legal errors */
72 if (ret == -EINVAL || ret == -ENOTSUPP)
73 continue;
74 if (ret) {
75 seq_printf(s, "ERROR READING CONFIG SETTING %d ", i);
76 continue;
77 }
78 /* Space between multiple configs */
79 seq_puts(s, " ");
dd4d01f7 80 seq_puts(s, items[i].display);
394349f7 81 /* Print unit if available */
dd4d01f7 82 if (items[i].has_arg) {
eec45071
SB
83 seq_printf(s, " (%u",
84 pinconf_to_config_argument(config));
dd4d01f7
SB
85 if (items[i].format)
86 seq_printf(s, " %s)", items[i].format);
eec45071
SB
87 else
88 seq_puts(s, ")");
89 }
394349f7
LW
90 }
91}
92
dd4d01f7
SB
93/**
94 * pinconf_generic_dump_pins - Print information about pin or group of pins
95 * @pctldev: Pincontrol device
96 * @s: File to print to
97 * @gname: Group name specifying pins
98 * @pin: Pin number specyfying pin
99 *
100 * Print the pinconf configuration for the requested pin(s) to @s. Pins can be
101 * specified either by pin using @pin or by group using @gname. Only one needs
102 * to be specified the other can be NULL/0.
103 */
104void pinconf_generic_dump_pins(struct pinctrl_dev *pctldev, struct seq_file *s,
105 const char *gname, unsigned pin)
394349f7
LW
106{
107 const struct pinconf_ops *ops = pctldev->desc->confops;
394349f7
LW
108
109 if (!ops->is_generic)
110 return;
111
dd4d01f7
SB
112 /* generic parameters */
113 pinconf_generic_dump_one(pctldev, s, gname, pin, conf_items,
114 ARRAY_SIZE(conf_items));
115 /* driver-specific parameters */
f684e4ac
LW
116 if (pctldev->desc->num_custom_params &&
117 pctldev->desc->custom_conf_items)
dd4d01f7 118 pinconf_generic_dump_one(pctldev, s, gname, pin,
f684e4ac
LW
119 pctldev->desc->custom_conf_items,
120 pctldev->desc->num_custom_params);
394349f7
LW
121}
122
9cfd1724
HZ
123void pinconf_generic_dump_config(struct pinctrl_dev *pctldev,
124 struct seq_file *s, unsigned long config)
125{
126 int i;
127
b6465424 128 for (i = 0; i < ARRAY_SIZE(conf_items); i++) {
9cfd1724
HZ
129 if (pinconf_to_config_param(config) != conf_items[i].param)
130 continue;
131 seq_printf(s, "%s: 0x%x", conf_items[i].display,
132 pinconf_to_config_argument(config));
133 }
dd4d01f7 134
f684e4ac
LW
135 if (!pctldev->desc->num_custom_params ||
136 !pctldev->desc->custom_conf_items)
dd4d01f7
SB
137 return;
138
f684e4ac
LW
139 for (i = 0; i < pctldev->desc->num_custom_params; i++) {
140 if (pinconf_to_config_param(config) !=
141 pctldev->desc->custom_conf_items[i].param)
dd4d01f7 142 continue;
f684e4ac
LW
143 seq_printf(s, "%s: 0x%x",
144 pctldev->desc->custom_conf_items[i].display,
145 pinconf_to_config_argument(config));
dd4d01f7 146 }
9cfd1724
HZ
147}
148EXPORT_SYMBOL_GPL(pinconf_generic_dump_config);
394349f7 149#endif
7db9af4b
HS
150
151#ifdef CONFIG_OF
f684e4ac 152static const struct pinconf_generic_params dt_params[] = {
3c4b23dd 153 { "bias-bus-hold", PIN_CONFIG_BIAS_BUS_HOLD, 0 },
7db9af4b
HS
154 { "bias-disable", PIN_CONFIG_BIAS_DISABLE, 0 },
155 { "bias-high-impedance", PIN_CONFIG_BIAS_HIGH_IMPEDANCE, 0 },
9ee1f7d2 156 { "bias-pull-up", PIN_CONFIG_BIAS_PULL_UP, 1 },
9ee1f7d2 157 { "bias-pull-pin-default", PIN_CONFIG_BIAS_PULL_PIN_DEFAULT, 1 },
3c4b23dd 158 { "bias-pull-down", PIN_CONFIG_BIAS_PULL_DOWN, 1 },
7db9af4b
HS
159 { "drive-open-drain", PIN_CONFIG_DRIVE_OPEN_DRAIN, 0 },
160 { "drive-open-source", PIN_CONFIG_DRIVE_OPEN_SOURCE, 0 },
3c4b23dd 161 { "drive-push-pull", PIN_CONFIG_DRIVE_PUSH_PULL, 0 },
7db9af4b 162 { "drive-strength", PIN_CONFIG_DRIVE_STRENGTH, 0 },
3c4b23dd 163 { "input-debounce", PIN_CONFIG_INPUT_DEBOUNCE, 0 },
8ba3f4d0 164 { "input-disable", PIN_CONFIG_INPUT_ENABLE, 0 },
3c4b23dd 165 { "input-enable", PIN_CONFIG_INPUT_ENABLE, 1 },
69c308e2 166 { "input-schmitt", PIN_CONFIG_INPUT_SCHMITT, 0 },
7db9af4b 167 { "input-schmitt-disable", PIN_CONFIG_INPUT_SCHMITT_ENABLE, 0 },
3c4b23dd 168 { "input-schmitt-enable", PIN_CONFIG_INPUT_SCHMITT_ENABLE, 1 },
9ee1f7d2 169 { "low-power-disable", PIN_CONFIG_LOW_POWER_MODE, 0 },
3c4b23dd 170 { "low-power-enable", PIN_CONFIG_LOW_POWER_MODE, 1 },
7db9af4b 171 { "output-high", PIN_CONFIG_OUTPUT, 1, },
3c4b23dd
MY
172 { "output-low", PIN_CONFIG_OUTPUT, 0, },
173 { "power-source", PIN_CONFIG_POWER_SOURCE, 0 },
174 { "slew-rate", PIN_CONFIG_SLEW_RATE, 0 },
7db9af4b
HS
175};
176
dd4d01f7 177/**
f684e4ac 178 * parse_dt_cfg() - Parse DT pinconf parameters
dd4d01f7 179 * @np: DT node
f684e4ac 180 * @params: Array of describing generic parameters
dd4d01f7
SB
181 * @count: Number of entries in @params
182 * @cfg: Array of parsed config options
183 * @ncfg: Number of entries in @cfg
184 *
185 * Parse the config options described in @params from @np and puts the result
186 * in @cfg. @cfg does not need to be empty, entries are added beggining at
187 * @ncfg. @ncfg is updated to reflect the number of entries after parsing. @cfg
188 * needs to have enough memory allocated to hold all possible entries.
189 */
190static void parse_dt_cfg(struct device_node *np,
f684e4ac 191 const struct pinconf_generic_params *params,
dd4d01f7
SB
192 unsigned int count, unsigned long *cfg,
193 unsigned int *ncfg)
194{
195 int i;
196
197 for (i = 0; i < count; i++) {
198 u32 val;
199 int ret;
f684e4ac 200 const struct pinconf_generic_params *par = &params[i];
dd4d01f7
SB
201
202 ret = of_property_read_u32(np, par->property, &val);
203
204 /* property not found */
205 if (ret == -EINVAL)
206 continue;
207
208 /* use default value, when no value is specified */
209 if (ret)
210 val = par->default_value;
211
212 pr_debug("found %s with value %u\n", par->property, val);
213 cfg[*ncfg] = pinconf_to_config_packed(par->param, val);
214 (*ncfg)++;
215 }
216}
217
7db9af4b
HS
218/**
219 * pinconf_generic_parse_dt_config()
220 * parse the config properties into generic pinconfig values.
221 * @np: node containing the pinconfig properties
222 * @configs: array with nconfigs entries containing the generic pinconf values
223 * @nconfigs: umber of configurations
224 */
225int pinconf_generic_parse_dt_config(struct device_node *np,
dd4d01f7 226 struct pinctrl_dev *pctldev,
7db9af4b
HS
227 unsigned long **configs,
228 unsigned int *nconfigs)
229{
6abab2d4 230 unsigned long *cfg;
dd4d01f7 231 unsigned int max_cfg, ncfg = 0;
7db9af4b 232 int ret;
7db9af4b
HS
233
234 if (!np)
235 return -EINVAL;
236
6abab2d4 237 /* allocate a temporary array big enough to hold one of each option */
dd4d01f7
SB
238 max_cfg = ARRAY_SIZE(dt_params);
239 if (pctldev)
f684e4ac 240 max_cfg += pctldev->desc->num_custom_params;
dd4d01f7 241 cfg = kcalloc(max_cfg, sizeof(*cfg), GFP_KERNEL);
6abab2d4
HS
242 if (!cfg)
243 return -ENOMEM;
244
dd4d01f7 245 parse_dt_cfg(np, dt_params, ARRAY_SIZE(dt_params), cfg, &ncfg);
f684e4ac
LW
246 if (pctldev && pctldev->desc->num_custom_params &&
247 pctldev->desc->custom_params)
248 parse_dt_cfg(np, pctldev->desc->custom_params,
249 pctldev->desc->num_custom_params, cfg, &ncfg);
7db9af4b 250
6abab2d4
HS
251 ret = 0;
252
e4a8844c
HS
253 /* no configs found at all */
254 if (ncfg == 0) {
255 *configs = NULL;
256 *nconfigs = 0;
6abab2d4 257 goto out;
e4a8844c
HS
258 }
259
7db9af4b
HS
260 /*
261 * Now limit the number of configs to the real number of
262 * found properties.
263 */
db388dfb 264 *configs = kmemdup(cfg, ncfg * sizeof(unsigned long), GFP_KERNEL);
6abab2d4
HS
265 if (!*configs) {
266 ret = -ENOMEM;
267 goto out;
268 }
7db9af4b 269
7db9af4b 270 *nconfigs = ncfg;
6abab2d4
HS
271
272out:
273 kfree(cfg);
274 return ret;
7db9af4b 275}
e81c8f18
LD
276
277int pinconf_generic_dt_subnode_to_map(struct pinctrl_dev *pctldev,
278 struct device_node *np, struct pinctrl_map **map,
3287c240
LD
279 unsigned *reserved_maps, unsigned *num_maps,
280 enum pinctrl_map_type type)
e81c8f18
LD
281{
282 int ret;
283 const char *function;
284 struct device *dev = pctldev->dev;
285 unsigned long *configs = NULL;
286 unsigned num_configs = 0;
c7289500 287 unsigned reserve, strings_count;
e81c8f18
LD
288 struct property *prop;
289 const char *group;
31c89c95 290 const char *subnode_target_type = "pins";
e81c8f18 291
c7289500
BS
292 ret = of_property_count_strings(np, "pins");
293 if (ret < 0) {
294 ret = of_property_count_strings(np, "groups");
295 if (ret < 0)
296 /* skip this node; may contain config child nodes */
297 return 0;
298 if (type == PIN_MAP_TYPE_INVALID)
299 type = PIN_MAP_TYPE_CONFIGS_GROUP;
300 subnode_target_type = "groups";
301 } else {
302 if (type == PIN_MAP_TYPE_INVALID)
303 type = PIN_MAP_TYPE_CONFIGS_PIN;
304 }
305 strings_count = ret;
306
e81c8f18
LD
307 ret = of_property_read_string(np, "function", &function);
308 if (ret < 0) {
309 /* EINVAL=missing, which is fine since it's optional */
310 if (ret != -EINVAL)
4024efb4
BS
311 dev_err(dev, "%s: could not parse property function\n",
312 of_node_full_name(np));
e81c8f18
LD
313 function = NULL;
314 }
315
dd4d01f7
SB
316 ret = pinconf_generic_parse_dt_config(np, pctldev, &configs,
317 &num_configs);
e81c8f18 318 if (ret < 0) {
4024efb4
BS
319 dev_err(dev, "%s: could not parse node property\n",
320 of_node_full_name(np));
e81c8f18
LD
321 return ret;
322 }
323
324 reserve = 0;
325 if (function != NULL)
326 reserve++;
327 if (num_configs)
328 reserve++;
31c89c95 329
c7289500 330 reserve *= strings_count;
e81c8f18
LD
331
332 ret = pinctrl_utils_reserve_map(pctldev, map, reserved_maps,
333 num_maps, reserve);
334 if (ret < 0)
335 goto exit;
336
31c89c95 337 of_property_for_each_string(np, subnode_target_type, prop, group) {
e81c8f18
LD
338 if (function) {
339 ret = pinctrl_utils_add_map_mux(pctldev, map,
340 reserved_maps, num_maps, group,
341 function);
342 if (ret < 0)
343 goto exit;
344 }
345
346 if (num_configs) {
347 ret = pinctrl_utils_add_map_configs(pctldev, map,
348 reserved_maps, num_maps, group, configs,
3287c240 349 num_configs, type);
e81c8f18
LD
350 if (ret < 0)
351 goto exit;
352 }
353 }
354 ret = 0;
355
356exit:
357 kfree(configs);
358 return ret;
359}
360EXPORT_SYMBOL_GPL(pinconf_generic_dt_subnode_to_map);
361
362int pinconf_generic_dt_node_to_map(struct pinctrl_dev *pctldev,
363 struct device_node *np_config, struct pinctrl_map **map,
3287c240 364 unsigned *num_maps, enum pinctrl_map_type type)
e81c8f18
LD
365{
366 unsigned reserved_maps;
367 struct device_node *np;
368 int ret;
369
370 reserved_maps = 0;
371 *map = NULL;
372 *num_maps = 0;
373
c7289500
BS
374 ret = pinconf_generic_dt_subnode_to_map(pctldev, np_config, map,
375 &reserved_maps, num_maps, type);
376 if (ret < 0)
377 goto exit;
378
e81c8f18
LD
379 for_each_child_of_node(np_config, np) {
380 ret = pinconf_generic_dt_subnode_to_map(pctldev, np, map,
3287c240 381 &reserved_maps, num_maps, type);
c7289500
BS
382 if (ret < 0)
383 goto exit;
e81c8f18
LD
384 }
385 return 0;
c7289500
BS
386
387exit:
388 pinctrl_utils_dt_free_map(pctldev, *map, *num_maps);
389 return ret;
e81c8f18
LD
390}
391EXPORT_SYMBOL_GPL(pinconf_generic_dt_node_to_map);
392
7db9af4b 393#endif