2 * Core driver for the generic pin config portions of the pin control subsystem
4 * Copyright (C) 2011 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
7 * Author: Linus Walleij <linus.walleij@linaro.org>
9 * License terms: GNU General Public License (GPL) version 2
12 #define pr_fmt(fmt) "generic pinconfig core: " fmt
14 #include <linux/kernel.h>
15 #include <linux/module.h>
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>
27 #include "pinctrl-utils.h"
29 #ifdef CONFIG_DEBUG_FS
30 static const struct pin_config_item conf_items[] = {
31 PCONFDUMP(PIN_CONFIG_BIAS_BUS_HOLD, "input bias bus hold", NULL, false),
32 PCONFDUMP(PIN_CONFIG_BIAS_DISABLE, "input bias disabled", NULL, false),
33 PCONFDUMP(PIN_CONFIG_BIAS_HIGH_IMPEDANCE, "input bias high impedance", NULL, false),
34 PCONFDUMP(PIN_CONFIG_BIAS_PULL_DOWN, "input bias pull down", NULL, false),
35 PCONFDUMP(PIN_CONFIG_BIAS_PULL_PIN_DEFAULT,
36 "input bias pull to pin specific state", NULL, false),
37 PCONFDUMP(PIN_CONFIG_BIAS_PULL_UP, "input bias pull up", NULL, false),
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),
40 PCONFDUMP(PIN_CONFIG_DRIVE_PUSH_PULL, "output drive push pull", NULL, false),
41 PCONFDUMP(PIN_CONFIG_DRIVE_STRENGTH, "output drive strength", "mA", true),
42 PCONFDUMP(PIN_CONFIG_DRIVE_STRENGTH_UA, "output drive strength", "uA", true),
43 PCONFDUMP(PIN_CONFIG_INPUT_DEBOUNCE, "input debounce", "usec", true),
44 PCONFDUMP(PIN_CONFIG_INPUT_ENABLE, "input enabled", NULL, false),
45 PCONFDUMP(PIN_CONFIG_INPUT_SCHMITT, "input schmitt trigger", NULL, false),
46 PCONFDUMP(PIN_CONFIG_INPUT_SCHMITT_ENABLE, "input schmitt enabled", NULL, false),
47 PCONFDUMP(PIN_CONFIG_LOW_POWER_MODE, "pin low power", "mode", true),
48 PCONFDUMP(PIN_CONFIG_OUTPUT_ENABLE, "output enabled", NULL, false),
49 PCONFDUMP(PIN_CONFIG_OUTPUT, "pin output", "level", true),
50 PCONFDUMP(PIN_CONFIG_POWER_SOURCE, "pin power source", "selector", true),
51 PCONFDUMP(PIN_CONFIG_SLEEP_HARDWARE_STATE, "sleep hardware state", NULL, false),
52 PCONFDUMP(PIN_CONFIG_SLEW_RATE, "slew rate", NULL, true),
53 PCONFDUMP(PIN_CONFIG_SKEW_DELAY, "skew delay", NULL, true),
56 static void pinconf_generic_dump_one(struct pinctrl_dev *pctldev,
57 struct seq_file *s, const char *gname,
59 const struct pin_config_item *items,
60 int nitems, int *print_sep)
64 for (i = 0; i < nitems; i++) {
68 /* We want to check out this parameter */
69 config = pinconf_to_config_packed(items[i].param, 0);
71 ret = pin_config_group_get(dev_name(pctldev->dev),
74 ret = pin_config_get_for_pin(pctldev, pin, &config);
75 /* These are legal errors */
76 if (ret == -EINVAL || ret == -ENOTSUPP)
79 seq_printf(s, "ERROR READING CONFIG SETTING %d ", i);
82 /* comma between multiple configs */
86 seq_puts(s, items[i].display);
87 /* Print unit if available */
88 if (items[i].has_arg) {
90 pinconf_to_config_argument(config));
92 seq_printf(s, " %s)", items[i].format);
100 * pinconf_generic_dump_pins - Print information about pin or group of pins
101 * @pctldev: Pincontrol device
102 * @s: File to print to
103 * @gname: Group name specifying pins
104 * @pin: Pin number specyfying pin
106 * Print the pinconf configuration for the requested pin(s) to @s. Pins can be
107 * specified either by pin using @pin or by group using @gname. Only one needs
108 * to be specified the other can be NULL/0.
110 void pinconf_generic_dump_pins(struct pinctrl_dev *pctldev, struct seq_file *s,
111 const char *gname, unsigned pin)
113 const struct pinconf_ops *ops = pctldev->desc->confops;
116 if (!ops->is_generic)
119 /* generic parameters */
120 pinconf_generic_dump_one(pctldev, s, gname, pin, conf_items,
121 ARRAY_SIZE(conf_items), &print_sep);
122 /* driver-specific parameters */
123 if (pctldev->desc->num_custom_params &&
124 pctldev->desc->custom_conf_items)
125 pinconf_generic_dump_one(pctldev, s, gname, pin,
126 pctldev->desc->custom_conf_items,
127 pctldev->desc->num_custom_params,
131 void pinconf_generic_dump_config(struct pinctrl_dev *pctldev,
132 struct seq_file *s, unsigned long config)
136 for (i = 0; i < ARRAY_SIZE(conf_items); i++) {
137 if (pinconf_to_config_param(config) != conf_items[i].param)
139 seq_printf(s, "%s: 0x%x", conf_items[i].display,
140 pinconf_to_config_argument(config));
143 if (!pctldev->desc->num_custom_params ||
144 !pctldev->desc->custom_conf_items)
147 for (i = 0; i < pctldev->desc->num_custom_params; i++) {
148 if (pinconf_to_config_param(config) !=
149 pctldev->desc->custom_conf_items[i].param)
151 seq_printf(s, "%s: 0x%x",
152 pctldev->desc->custom_conf_items[i].display,
153 pinconf_to_config_argument(config));
156 EXPORT_SYMBOL_GPL(pinconf_generic_dump_config);
160 static const struct pinconf_generic_params dt_params[] = {
161 { "bias-bus-hold", PIN_CONFIG_BIAS_BUS_HOLD, 0 },
162 { "bias-disable", PIN_CONFIG_BIAS_DISABLE, 0 },
163 { "bias-high-impedance", PIN_CONFIG_BIAS_HIGH_IMPEDANCE, 0 },
164 { "bias-pull-up", PIN_CONFIG_BIAS_PULL_UP, 1 },
165 { "bias-pull-pin-default", PIN_CONFIG_BIAS_PULL_PIN_DEFAULT, 1 },
166 { "bias-pull-down", PIN_CONFIG_BIAS_PULL_DOWN, 1 },
167 { "drive-open-drain", PIN_CONFIG_DRIVE_OPEN_DRAIN, 0 },
168 { "drive-open-source", PIN_CONFIG_DRIVE_OPEN_SOURCE, 0 },
169 { "drive-push-pull", PIN_CONFIG_DRIVE_PUSH_PULL, 0 },
170 { "drive-strength", PIN_CONFIG_DRIVE_STRENGTH, 0 },
171 { "drive-strength-microamp", PIN_CONFIG_DRIVE_STRENGTH_UA, 0 },
172 { "input-debounce", PIN_CONFIG_INPUT_DEBOUNCE, 0 },
173 { "input-disable", PIN_CONFIG_INPUT_ENABLE, 0 },
174 { "input-enable", PIN_CONFIG_INPUT_ENABLE, 1 },
175 { "input-schmitt", PIN_CONFIG_INPUT_SCHMITT, 0 },
176 { "input-schmitt-disable", PIN_CONFIG_INPUT_SCHMITT_ENABLE, 0 },
177 { "input-schmitt-enable", PIN_CONFIG_INPUT_SCHMITT_ENABLE, 1 },
178 { "low-power-disable", PIN_CONFIG_LOW_POWER_MODE, 0 },
179 { "low-power-enable", PIN_CONFIG_LOW_POWER_MODE, 1 },
180 { "output-disable", PIN_CONFIG_OUTPUT_ENABLE, 0 },
181 { "output-enable", PIN_CONFIG_OUTPUT_ENABLE, 1 },
182 { "output-high", PIN_CONFIG_OUTPUT, 1, },
183 { "output-low", PIN_CONFIG_OUTPUT, 0, },
184 { "power-source", PIN_CONFIG_POWER_SOURCE, 0 },
185 { "sleep-hardware-state", PIN_CONFIG_SLEEP_HARDWARE_STATE, 0 },
186 { "slew-rate", PIN_CONFIG_SLEW_RATE, 0 },
187 { "skew-delay", PIN_CONFIG_SKEW_DELAY, 0 },
191 * parse_dt_cfg() - Parse DT pinconf parameters
193 * @params: Array of describing generic parameters
194 * @count: Number of entries in @params
195 * @cfg: Array of parsed config options
196 * @ncfg: Number of entries in @cfg
198 * Parse the config options described in @params from @np and puts the result
199 * in @cfg. @cfg does not need to be empty, entries are added beginning at
200 * @ncfg. @ncfg is updated to reflect the number of entries after parsing. @cfg
201 * needs to have enough memory allocated to hold all possible entries.
203 static void parse_dt_cfg(struct device_node *np,
204 const struct pinconf_generic_params *params,
205 unsigned int count, unsigned long *cfg,
210 for (i = 0; i < count; i++) {
213 const struct pinconf_generic_params *par = ¶ms[i];
215 ret = of_property_read_u32(np, par->property, &val);
217 /* property not found */
221 /* use default value, when no value is specified */
223 val = par->default_value;
225 pr_debug("found %s with value %u\n", par->property, val);
226 cfg[*ncfg] = pinconf_to_config_packed(par->param, val);
232 * pinconf_generic_parse_dt_config()
233 * parse the config properties into generic pinconfig values.
234 * @np: node containing the pinconfig properties
235 * @configs: array with nconfigs entries containing the generic pinconf values
236 * must be freed when no longer necessary.
237 * @nconfigs: umber of configurations
239 int pinconf_generic_parse_dt_config(struct device_node *np,
240 struct pinctrl_dev *pctldev,
241 unsigned long **configs,
242 unsigned int *nconfigs)
245 unsigned int max_cfg, ncfg = 0;
251 /* allocate a temporary array big enough to hold one of each option */
252 max_cfg = ARRAY_SIZE(dt_params);
254 max_cfg += pctldev->desc->num_custom_params;
255 cfg = kcalloc(max_cfg, sizeof(*cfg), GFP_KERNEL);
259 parse_dt_cfg(np, dt_params, ARRAY_SIZE(dt_params), cfg, &ncfg);
260 if (pctldev && pctldev->desc->num_custom_params &&
261 pctldev->desc->custom_params)
262 parse_dt_cfg(np, pctldev->desc->custom_params,
263 pctldev->desc->num_custom_params, cfg, &ncfg);
267 /* no configs found at all */
275 * Now limit the number of configs to the real number of
278 *configs = kmemdup(cfg, ncfg * sizeof(unsigned long), GFP_KERNEL);
291 int pinconf_generic_dt_subnode_to_map(struct pinctrl_dev *pctldev,
292 struct device_node *np, struct pinctrl_map **map,
293 unsigned *reserved_maps, unsigned *num_maps,
294 enum pinctrl_map_type type)
297 const char *function;
298 struct device *dev = pctldev->dev;
299 unsigned long *configs = NULL;
300 unsigned num_configs = 0;
301 unsigned reserve, strings_count;
302 struct property *prop;
304 const char *subnode_target_type = "pins";
306 ret = of_property_count_strings(np, "pins");
308 ret = of_property_count_strings(np, "groups");
310 /* skip this node; may contain config child nodes */
312 if (type == PIN_MAP_TYPE_INVALID)
313 type = PIN_MAP_TYPE_CONFIGS_GROUP;
314 subnode_target_type = "groups";
316 if (type == PIN_MAP_TYPE_INVALID)
317 type = PIN_MAP_TYPE_CONFIGS_PIN;
321 ret = of_property_read_string(np, "function", &function);
323 /* EINVAL=missing, which is fine since it's optional */
325 dev_err(dev, "%pOF: could not parse property function\n",
330 ret = pinconf_generic_parse_dt_config(np, pctldev, &configs,
333 dev_err(dev, "%pOF: could not parse node property\n", np);
338 if (function != NULL)
343 reserve *= strings_count;
345 ret = pinctrl_utils_reserve_map(pctldev, map, reserved_maps,
350 of_property_for_each_string(np, subnode_target_type, prop, group) {
352 ret = pinctrl_utils_add_map_mux(pctldev, map,
353 reserved_maps, num_maps, group,
360 ret = pinctrl_utils_add_map_configs(pctldev, map,
361 reserved_maps, num_maps, group, configs,
373 EXPORT_SYMBOL_GPL(pinconf_generic_dt_subnode_to_map);
375 int pinconf_generic_dt_node_to_map(struct pinctrl_dev *pctldev,
376 struct device_node *np_config, struct pinctrl_map **map,
377 unsigned *num_maps, enum pinctrl_map_type type)
379 unsigned reserved_maps;
380 struct device_node *np;
387 ret = pinconf_generic_dt_subnode_to_map(pctldev, np_config, map,
388 &reserved_maps, num_maps, type);
392 for_each_available_child_of_node(np_config, np) {
393 ret = pinconf_generic_dt_subnode_to_map(pctldev, np, map,
394 &reserved_maps, num_maps, type);
401 pinctrl_utils_free_map(pctldev, *map, *num_maps);
404 EXPORT_SYMBOL_GPL(pinconf_generic_dt_node_to_map);
406 void pinconf_generic_dt_free_map(struct pinctrl_dev *pctldev,
407 struct pinctrl_map *map,
410 pinctrl_utils_free_map(pctldev, map, num_maps);
412 EXPORT_SYMBOL_GPL(pinconf_generic_dt_free_map);