1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2015 Masahiro Yamada <yamada.masahiro@socionext.com>
6 #define LOG_CATEGORY UCLASS_PINCTRL
10 #include <asm/global_data.h>
11 #include <dm/device_compat.h>
12 #include <linux/libfdt.h>
13 #include <linux/err.h>
14 #include <linux/list.h>
17 #include <dm/pinctrl.h>
19 #include <dm/of_access.h>
21 DECLARE_GLOBAL_DATA_PTR;
24 * pinctrl_config_one() - apply pinctrl settings for a single node
26 * @config: pin configuration node
27 * @return: 0 on success, or negative error code on failure
29 static int pinctrl_config_one(struct udevice *config)
31 struct udevice *pctldev;
32 const struct pinctrl_ops *ops;
36 pctldev = dev_get_parent(pctldev);
38 dev_err(config, "could not find pctldev\n");
41 if (pctldev->uclass->uc_drv->id == UCLASS_PINCTRL)
45 ops = pinctrl_get_ops(pctldev);
46 return ops->set_state(pctldev, config);
50 * pinctrl_select_state_full() - full implementation of pinctrl_select_state
52 * @dev: peripheral device
53 * @statename: state name, like "default"
54 * @return: 0 on success, or negative error code on failure
56 static int pinctrl_select_state_full(struct udevice *dev, const char *statename)
58 char propname[32]; /* long enough */
61 struct udevice *config;
62 int state, size, i, ret;
64 state = dev_read_stringlist_search(dev, "pinctrl-names", statename);
68 * If statename is not found in "pinctrl-names",
69 * assume statename is just the integer state ID.
71 state = dectoul(statename, &end);
76 snprintf(propname, sizeof(propname), "pinctrl-%d", state);
77 list = dev_read_prop(dev, propname, &size);
81 size /= sizeof(*list);
82 for (i = 0; i < size; i++) {
83 phandle = fdt32_to_cpu(*list++);
84 ret = uclass_get_device_by_phandle_id(UCLASS_PINCONFIG, phandle,
87 dev_warn(dev, "%s: uclass_get_device_by_phandle_id: err=%d\n",
92 ret = pinctrl_config_one(config);
94 dev_warn(dev, "%s: pinctrl_config_one: err=%d\n",
104 * pinconfig_post_bind() - post binding for PINCONFIG uclass
105 * Recursively bind its children as pinconfig devices.
107 * @dev: pinconfig device
108 * @return: 0 on success, or negative error code on failure
110 static int pinconfig_post_bind(struct udevice *dev)
112 bool pre_reloc_only = !(gd->flags & GD_FLG_RELOC);
117 if (!dev_has_ofnode(dev))
120 dev_for_each_subnode(node, dev) {
121 if (pre_reloc_only &&
122 !ofnode_pre_reloc(node))
125 * If this node has "compatible" property, this is not
126 * a pin configuration node, but a normal device. skip.
128 ofnode_get_property(node, "compatible", &ret);
131 /* If this node has "gpio-controller" property, skip */
132 if (ofnode_read_bool(node, "gpio-controller"))
135 if (ret != -FDT_ERR_NOTFOUND)
138 name = ofnode_get_name(node);
141 ret = device_bind_driver_to_node(dev, "pinconfig", name,
150 #if CONFIG_IS_ENABLED(PINCTRL_FULL)
151 UCLASS_DRIVER(pinconfig) = {
152 .id = UCLASS_PINCONFIG,
153 #if CONFIG_IS_ENABLED(PINCONF_RECURSIVE)
154 .post_bind = pinconfig_post_bind,
159 U_BOOT_DRIVER(pinconfig_generic) = {
161 .id = UCLASS_PINCONFIG,
166 pinctrl_gpio_get_pinctrl_and_offset(struct udevice *dev, unsigned offset,
167 struct udevice **pctldev,
168 unsigned int *pin_selector)
170 struct ofnode_phandle_args args;
171 unsigned gpio_offset, pfc_base, pfc_pins;
176 ret = dev_read_phandle_with_args(dev, "gpio-ranges", NULL, 3,
179 dev_dbg(dev, "%s: dev_read_phandle_with_args: err=%d\n",
184 ret = uclass_get_device_by_ofnode(UCLASS_PINCTRL,
188 "%s: uclass_get_device_by_of_offset failed: err=%d\n",
193 gpio_offset = args.args[0];
194 pfc_base = args.args[1];
195 pfc_pins = args.args[2];
197 if (offset >= gpio_offset && offset <= gpio_offset + pfc_pins)
201 offset -= gpio_offset;
203 *pin_selector = offset;
209 * pinctrl_gpio_request() - request a single pin to be used as GPIO
211 * @dev: GPIO peripheral device
212 * @offset: the GPIO pin offset from the GPIO controller
213 * @label: the GPIO pin label
214 * @return: 0 on success, or negative error code on failure
216 int pinctrl_gpio_request(struct udevice *dev, unsigned offset, const char *label)
218 const struct pinctrl_ops *ops;
219 struct udevice *pctldev;
220 unsigned int pin_selector;
223 ret = pinctrl_gpio_get_pinctrl_and_offset(dev, offset,
224 &pctldev, &pin_selector);
228 ops = pinctrl_get_ops(pctldev);
230 if (!ops->gpio_request_enable)
233 return ops->gpio_request_enable(pctldev, pin_selector);
237 * pinctrl_gpio_free() - free a single pin used as GPIO
239 * @dev: GPIO peripheral device
240 * @offset: the GPIO pin offset from the GPIO controller
241 * @return: 0 on success, or negative error code on failure
243 int pinctrl_gpio_free(struct udevice *dev, unsigned offset)
245 const struct pinctrl_ops *ops;
246 struct udevice *pctldev;
247 unsigned int pin_selector;
250 ret = pinctrl_gpio_get_pinctrl_and_offset(dev, offset,
251 &pctldev, &pin_selector);
255 ops = pinctrl_get_ops(pctldev);
257 if (!ops->gpio_disable_free)
260 return ops->gpio_disable_free(pctldev, pin_selector);
264 * pinctrl_select_state_simple() - simple implementation of pinctrl_select_state
266 * @dev: peripheral device
267 * @return: 0 on success, or negative error code on failure
269 static int pinctrl_select_state_simple(struct udevice *dev)
271 struct udevice *pctldev;
272 struct pinctrl_ops *ops;
276 * For most system, there is only one pincontroller device. But in
277 * case of multiple pincontroller devices, probe the one with sequence
278 * number 0 (defined by alias) to avoid race condition.
280 ret = uclass_get_device_by_seq(UCLASS_PINCTRL, 0, &pctldev);
282 /* if not found, get the first one */
283 ret = uclass_get_device(UCLASS_PINCTRL, 0, &pctldev);
287 ops = pinctrl_get_ops(pctldev);
288 if (!ops->set_state_simple) {
289 dev_dbg(dev, "set_state_simple op missing\n");
293 return ops->set_state_simple(pctldev, dev);
296 int pinctrl_select_state(struct udevice *dev, const char *statename)
299 * Some device which is logical like mmc.blk, do not have
302 if (!dev_has_ofnode(dev))
305 * Try full-implemented pinctrl first.
306 * If it fails or is not implemented, try simple one.
308 if (CONFIG_IS_ENABLED(PINCTRL_FULL))
309 return pinctrl_select_state_full(dev, statename);
311 return pinctrl_select_state_simple(dev);
314 int pinctrl_request(struct udevice *dev, int func, int flags)
316 struct pinctrl_ops *ops = pinctrl_get_ops(dev);
321 return ops->request(dev, func, flags);
324 int pinctrl_request_noflags(struct udevice *dev, int func)
326 return pinctrl_request(dev, func, 0);
329 int pinctrl_get_periph_id(struct udevice *dev, struct udevice *periph)
331 struct pinctrl_ops *ops = pinctrl_get_ops(dev);
333 if (!ops->get_periph_id)
336 return ops->get_periph_id(dev, periph);
339 int pinctrl_get_gpio_mux(struct udevice *dev, int banknum, int index)
341 struct pinctrl_ops *ops = pinctrl_get_ops(dev);
343 if (!ops->get_gpio_mux)
346 return ops->get_gpio_mux(dev, banknum, index);
349 int pinctrl_get_pins_count(struct udevice *dev)
351 struct pinctrl_ops *ops = pinctrl_get_ops(dev);
353 if (!ops->get_pins_count)
356 return ops->get_pins_count(dev);
359 int pinctrl_get_pin_name(struct udevice *dev, int selector, char *buf,
362 struct pinctrl_ops *ops = pinctrl_get_ops(dev);
364 if (!ops->get_pin_name)
367 snprintf(buf, size, ops->get_pin_name(dev, selector));
372 int pinctrl_get_pin_muxing(struct udevice *dev, int selector, char *buf,
375 struct pinctrl_ops *ops = pinctrl_get_ops(dev);
377 if (!ops->get_pin_muxing)
380 return ops->get_pin_muxing(dev, selector, buf, size);
384 * pinctrl_post_bind() - post binding for PINCTRL uclass
385 * Recursively bind child nodes as pinconfig devices in case of full pinctrl.
387 * @dev: pinctrl device
388 * @return: 0 on success, or negative error code on failure
390 static int __maybe_unused pinctrl_post_bind(struct udevice *dev)
392 const struct pinctrl_ops *ops = pinctrl_get_ops(dev);
395 dev_dbg(dev, "ops is not set. Do not bind.\n");
400 * If the pinctrl driver has the full implementation, its child nodes
401 * should be bound so that peripheral devices can easily search in
402 * parent devices during later DT-parsing.
404 if (CONFIG_IS_ENABLED(PINCTRL_FULL))
405 return pinconfig_post_bind(dev);
410 UCLASS_DRIVER(pinctrl) = {
411 .id = UCLASS_PINCTRL,
412 #if CONFIG_IS_ENABLED(OF_REAL)
413 .post_bind = pinctrl_post_bind,
415 .flags = DM_UC_FLAG_SEQ_ALIAS,