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