drivers/pinctrl/pinctrl-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2015  Masahiro Yamada <yamada.masahiro@socionext.com>
   4  */
   5
   6 #define LOG_CATEGORY UCLASS_PINCTRL
   7
   8 #include <common.h>
   9 #include <malloc.h>
  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>
  15 #include <dm.h>
  16 #include <dm/lists.h>
  17 #include <dm/pinctrl.h>
  18 #include <dm/util.h>
  19 #include <dm/of_access.h>
  20
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 #if CONFIG_IS_ENABLED(PINCTRL_FULL)
  24 /**
  25  * pinctrl_config_one() - apply pinctrl settings for a single node
  26  *
  27  * @config: pin configuration node
  28  * @return: 0 on success, or negative error code on failure
  29  */
  30 static int pinctrl_config_one(struct udevice *config)
  31 {
  32         struct udevice *pctldev;
  33         const struct pinctrl_ops *ops;
  34
  35         pctldev = config;
  36         for (;;) {
  37                 pctldev = dev_get_parent(pctldev);
  38                 if (!pctldev) {
  39                         dev_err(config, "could not find pctldev\n");
  40                         return -EINVAL;
  41                 }
  42                 if (pctldev->uclass->uc_drv->id == UCLASS_PINCTRL)
  43                         break;
  44         }
  45
  46         ops = pinctrl_get_ops(pctldev);
  47         return ops->set_state(pctldev, config);
  48 }
  49
  50 /**
  51  * pinctrl_select_state_full() - full implementation of pinctrl_select_state
  52  *
  53  * @dev: peripheral device
  54  * @statename: state name, like "default"
  55  * @return: 0 on success, or negative error code on failure
  56  */
  57 static int pinctrl_select_state_full(struct udevice *dev, const char *statename)
  58 {
  59         char propname[32]; /* long enough */
  60         const fdt32_t *list;
  61         uint32_t phandle;
  62         struct udevice *config;
  63         int state, size, i, ret;
  64
  65         state = dev_read_stringlist_search(dev, "pinctrl-names", statename);
  66         if (state < 0) {
  67                 char *end;
  68                 /*
  69                  * If statename is not found in "pinctrl-names",
  70                  * assume statename is just the integer state ID.
  71                  */
  72                 state = dectoul(statename, &end);
  73                 if (*end)
  74                         return -EINVAL;
  75         }
  76
  77         snprintf(propname, sizeof(propname), "pinctrl-%d", state);
  78         list = dev_read_prop(dev, propname, &size);
  79         if (!list)
  80                 return -EINVAL;
  81
  82         size /= sizeof(*list);
  83         for (i = 0; i < size; i++) {
  84                 phandle = fdt32_to_cpu(*list++);
  85                 ret = uclass_get_device_by_phandle_id(UCLASS_PINCONFIG, phandle,
  86                                                       &config);
  87                 if (ret) {
  88                         dev_warn(dev, "%s: uclass_get_device_by_phandle_id: err=%d\n",
  89                                 __func__, ret);
  90                         continue;
  91                 }
  92
  93                 ret = pinctrl_config_one(config);
  94                 if (ret) {
  95                         dev_warn(dev, "%s: pinctrl_config_one: err=%d\n",
  96                                 __func__, ret);
  97                         continue;
  98                 }
  99         }
 100
 101         return 0;
 102 }
 103
 104 /**
 105  * pinconfig_post_bind() - post binding for PINCONFIG uclass
 106  * Recursively bind its children as pinconfig devices.
 107  *
 108  * @dev: pinconfig device
 109  * @return: 0 on success, or negative error code on failure
 110  */
 111 static int pinconfig_post_bind(struct udevice *dev)
 112 {
 113         bool pre_reloc_only = !(gd->flags & GD_FLG_RELOC);
 114         const char *name;
 115         ofnode node;
 116         int ret;
 117
 118         if (!dev_has_ofnode(dev))
 119                 return 0;
 120
 121         dev_for_each_subnode(node, dev) {
 122                 if (pre_reloc_only &&
 123                     !ofnode_pre_reloc(node))
 124                         continue;
 125                 /*
 126                  * If this node has "compatible" property, this is not
 127                  * a pin configuration node, but a normal device. skip.
 128                  */
 129                 ofnode_get_property(node, "compatible", &ret);
 130                 if (ret >= 0)
 131                         continue;
 132                 /* If this node has "gpio-controller" property, skip */
 133                 if (ofnode_read_bool(node, "gpio-controller"))
 134                         continue;
 135
 136                 if (ret != -FDT_ERR_NOTFOUND)
 137                         return ret;
 138
 139                 name = ofnode_get_name(node);
 140                 if (!name)
 141                         return -EINVAL;
 142                 ret = device_bind_driver_to_node(dev, "pinconfig", name,
 143                                                  node, NULL);
 144                 if (ret)
 145                         return ret;
 146         }
 147
 148         return 0;
 149 }
 150
 151 UCLASS_DRIVER(pinconfig) = {
 152         .id = UCLASS_PINCONFIG,
 153 #if CONFIG_IS_ENABLED(PINCONF_RECURSIVE)
 154         .post_bind = pinconfig_post_bind,
 155 #endif
 156         .name = "pinconfig",
 157 };
 158
 159 U_BOOT_DRIVER(pinconfig_generic) = {
 160         .name = "pinconfig",
 161         .id = UCLASS_PINCONFIG,
 162 };
 163
 164 #else
 165 static int pinctrl_select_state_full(struct udevice *dev, const char *statename)
 166 {
 167         return -ENODEV;
 168 }
 169
 170 static int pinconfig_post_bind(struct udevice *dev)
 171 {
 172         return 0;
 173 }
 174 #endif
 175
 176 static int
 177 pinctrl_gpio_get_pinctrl_and_offset(struct udevice *dev, unsigned offset,
 178                                     struct udevice **pctldev,
 179                                     unsigned int *pin_selector)
 180 {
 181         struct ofnode_phandle_args args;
 182         unsigned gpio_offset, pfc_base, pfc_pins;
 183         int ret;
 184
 185         ret = dev_read_phandle_with_args(dev, "gpio-ranges", NULL, 3,
 186                                          0, &args);
 187         if (ret) {
 188                 dev_dbg(dev, "%s: dev_read_phandle_with_args: err=%d\n",
 189                         __func__, ret);
 190                 return ret;
 191         }
 192
 193         ret = uclass_get_device_by_ofnode(UCLASS_PINCTRL,
 194                                           args.node, pctldev);
 195         if (ret) {
 196                 dev_dbg(dev,
 197                         "%s: uclass_get_device_by_of_offset failed: err=%d\n",
 198                         __func__, ret);
 199                 return ret;
 200         }
 201
 202         gpio_offset = args.args[0];
 203         pfc_base = args.args[1];
 204         pfc_pins = args.args[2];
 205
 206         if (offset < gpio_offset || offset > gpio_offset + pfc_pins) {
 207                 dev_dbg(dev,
 208                         "%s: GPIO can not be mapped to pincontrol pin\n",
 209                         __func__);
 210                 return -EINVAL;
 211         }
 212
 213         offset -= gpio_offset;
 214         offset += pfc_base;
 215         *pin_selector = offset;
 216
 217         return 0;
 218 }
 219
 220 /**
 221  * pinctrl_gpio_request() - request a single pin to be used as GPIO
 222  *
 223  * @dev: GPIO peripheral device
 224  * @offset: the GPIO pin offset from the GPIO controller
 225  * @return: 0 on success, or negative error code on failure
 226  */
 227 int pinctrl_gpio_request(struct udevice *dev, unsigned offset)
 228 {
 229         const struct pinctrl_ops *ops;
 230         struct udevice *pctldev;
 231         unsigned int pin_selector;
 232         int ret;
 233
 234         ret = pinctrl_gpio_get_pinctrl_and_offset(dev, offset,
 235                                                   &pctldev, &pin_selector);
 236         if (ret)
 237                 return ret;
 238
 239         ops = pinctrl_get_ops(pctldev);
 240         assert(ops);
 241         if (!ops->gpio_request_enable)
 242                 return -ENOSYS;
 243
 244         return ops->gpio_request_enable(pctldev, pin_selector);
 245 }
 246
 247 /**
 248  * pinctrl_gpio_free() - free a single pin used as GPIO
 249  *
 250  * @dev: GPIO peripheral device
 251  * @offset: the GPIO pin offset from the GPIO controller
 252  * @return: 0 on success, or negative error code on failure
 253  */
 254 int pinctrl_gpio_free(struct udevice *dev, unsigned offset)
 255 {
 256         const struct pinctrl_ops *ops;
 257         struct udevice *pctldev;
 258         unsigned int pin_selector;
 259         int ret;
 260
 261         ret = pinctrl_gpio_get_pinctrl_and_offset(dev, offset,
 262                                                   &pctldev, &pin_selector);
 263         if (ret)
 264                 return ret;
 265
 266         ops = pinctrl_get_ops(pctldev);
 267         assert(ops);
 268         if (!ops->gpio_disable_free)
 269                 return -ENOSYS;
 270
 271         return ops->gpio_disable_free(pctldev, pin_selector);
 272 }
 273
 274 /**
 275  * pinctrl_select_state_simple() - simple implementation of pinctrl_select_state
 276  *
 277  * @dev: peripheral device
 278  * @return: 0 on success, or negative error code on failure
 279  */
 280 static int pinctrl_select_state_simple(struct udevice *dev)
 281 {
 282         struct udevice *pctldev;
 283         struct pinctrl_ops *ops;
 284         int ret;
 285
 286         /*
 287          * For most system, there is only one pincontroller device. But in
 288          * case of multiple pincontroller devices, probe the one with sequence
 289          * number 0 (defined by alias) to avoid race condition.
 290          */
 291         ret = uclass_get_device_by_seq(UCLASS_PINCTRL, 0, &pctldev);
 292         if (ret)
 293                 /* if not found, get the first one */
 294                 ret = uclass_get_device(UCLASS_PINCTRL, 0, &pctldev);
 295         if (ret)
 296                 return ret;
 297
 298         ops = pinctrl_get_ops(pctldev);
 299         if (!ops->set_state_simple) {
 300                 dev_dbg(dev, "set_state_simple op missing\n");
 301                 return -ENOSYS;
 302         }
 303
 304         return ops->set_state_simple(pctldev, dev);
 305 }
 306
 307 int pinctrl_select_state(struct udevice *dev, const char *statename)
 308 {
 309         /*
 310          * Some device which is logical like mmc.blk, do not have
 311          * a valid ofnode.
 312          */
 313         if (!dev_has_ofnode(dev))
 314                 return 0;
 315         /*
 316          * Try full-implemented pinctrl first.
 317          * If it fails or is not implemented, try simple one.
 318          */
 319         if (pinctrl_select_state_full(dev, statename))
 320                 return pinctrl_select_state_simple(dev);
 321
 322         return 0;
 323 }
 324
 325 int pinctrl_request(struct udevice *dev, int func, int flags)
 326 {
 327         struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 328
 329         if (!ops->request)
 330                 return -ENOSYS;
 331
 332         return ops->request(dev, func, flags);
 333 }
 334
 335 int pinctrl_request_noflags(struct udevice *dev, int func)
 336 {
 337         return pinctrl_request(dev, func, 0);
 338 }
 339
 340 int pinctrl_get_periph_id(struct udevice *dev, struct udevice *periph)
 341 {
 342         struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 343
 344         if (!ops->get_periph_id)
 345                 return -ENOSYS;
 346
 347         return ops->get_periph_id(dev, periph);
 348 }
 349
 350 int pinctrl_get_gpio_mux(struct udevice *dev, int banknum, int index)
 351 {
 352         struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 353
 354         if (!ops->get_gpio_mux)
 355                 return -ENOSYS;
 356
 357         return ops->get_gpio_mux(dev, banknum, index);
 358 }
 359
 360 int pinctrl_get_pins_count(struct udevice *dev)
 361 {
 362         struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 363
 364         if (!ops->get_pins_count)
 365                 return -ENOSYS;
 366
 367         return ops->get_pins_count(dev);
 368 }
 369
 370 int pinctrl_get_pin_name(struct udevice *dev, int selector, char *buf,
 371                          int size)
 372 {
 373         struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 374
 375         if (!ops->get_pin_name)
 376                 return -ENOSYS;
 377
 378         snprintf(buf, size, ops->get_pin_name(dev, selector));
 379
 380         return 0;
 381 }
 382
 383 int pinctrl_get_pin_muxing(struct udevice *dev, int selector, char *buf,
 384                            int size)
 385 {
 386         struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 387
 388         if (!ops->get_pin_muxing)
 389                 return -ENOSYS;
 390
 391         return ops->get_pin_muxing(dev, selector, buf, size);
 392 }
 393
 394 /**
 395  * pinconfig_post_bind() - post binding for PINCTRL uclass
 396  * Recursively bind child nodes as pinconfig devices in case of full pinctrl.
 397  *
 398  * @dev: pinctrl device
 399  * @return: 0 on success, or negative error code on failure
 400  */
 401 static int __maybe_unused pinctrl_post_bind(struct udevice *dev)
 402 {
 403         const struct pinctrl_ops *ops = pinctrl_get_ops(dev);
 404
 405         if (!ops) {
 406                 dev_dbg(dev, "ops is not set.  Do not bind.\n");
 407                 return -EINVAL;
 408         }
 409
 410         /*
 411          * If set_state callback is set, we assume this pinctrl driver is the
 412          * full implementation.  In this case, its child nodes should be bound
 413          * so that peripheral devices can easily search in parent devices
 414          * during later DT-parsing.
 415          */
 416         if (ops->set_state)
 417                 return pinconfig_post_bind(dev);
 418
 419         return 0;
 420 }
 421
 422 UCLASS_DRIVER(pinctrl) = {
 423         .id = UCLASS_PINCTRL,
 424 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
 425         .post_bind = pinctrl_post_bind,
 426 #endif
 427         .flags = DM_UC_FLAG_SEQ_ALIAS,
 428         .name = "pinctrl",
 429 };