drivers/pinctrl/core.c

   1 /*
   2  * Core driver for the pin control subsystem
   3  *
   4  * Copyright (C) 2011-2012 ST-Ericsson SA
   5  * Written on behalf of Linaro for ST-Ericsson
   6  * Based on bits of regulator core, gpio core and clk core
   7  *
   8  * Author: Linus Walleij <linus.walleij@linaro.org>
   9  *
  10  * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
  11  *
  12  * License terms: GNU General Public License (GPL) version 2
  13  */
  14 #define pr_fmt(fmt) "pinctrl core: " fmt
  15
  16 #include <linux/kernel.h>
  17 #include <linux/export.h>
  18 #include <linux/init.h>
  19 #include <linux/device.h>
  20 #include <linux/slab.h>
  21 #include <linux/err.h>
  22 #include <linux/list.h>
  23 #include <linux/sysfs.h>
  24 #include <linux/debugfs.h>
  25 #include <linux/seq_file.h>
  26 #include <linux/pinctrl/consumer.h>
  27 #include <linux/pinctrl/pinctrl.h>
  28 #include <linux/pinctrl/machine.h>
  29 #include "core.h"
  30 #include "devicetree.h"
  31 #include "pinmux.h"
  32 #include "pinconf.h"
  33
  34 /**
  35  * struct pinctrl_maps - a list item containing part of the mapping table
  36  * @node: mapping table list node
  37  * @maps: array of mapping table entries
  38  * @num_maps: the number of entries in @maps
  39  */
  40 struct pinctrl_maps {
  41         struct list_head node;
  42         struct pinctrl_map const *maps;
  43         unsigned num_maps;
  44 };
  45
  46 static bool pinctrl_dummy_state;
  47
  48 /* Mutex taken by all entry points */
  49 DEFINE_MUTEX(pinctrl_mutex);
  50
  51 /* Global list of pin control devices (struct pinctrl_dev) */
  52 LIST_HEAD(pinctrldev_list);
  53
  54 /* List of pin controller handles (struct pinctrl) */
  55 static LIST_HEAD(pinctrl_list);
  56
  57 /* List of pinctrl maps (struct pinctrl_maps) */
  58 static LIST_HEAD(pinctrl_maps);
  59
  60 #define for_each_maps(_maps_node_, _i_, _map_) \
  61         list_for_each_entry(_maps_node_, &pinctrl_maps, node) \
  62                 for (_i_ = 0, _map_ = &_maps_node_->maps[_i_]; \
  63                         _i_ < _maps_node_->num_maps; \
  64                         _i_++, _map_ = &_maps_node_->maps[_i_])
  65
  66 /**
  67  * pinctrl_provide_dummies() - indicate if pinctrl provides dummy state support
  68  *
  69  * Usually this function is called by platforms without pinctrl driver support
  70  * but run with some shared drivers using pinctrl APIs.
  71  * After calling this function, the pinctrl core will return successfully
  72  * with creating a dummy state for the driver to keep going smoothly.
  73  */
  74 void pinctrl_provide_dummies(void)
  75 {
  76         pinctrl_dummy_state = true;
  77 }
  78
  79 const char *pinctrl_dev_get_name(struct pinctrl_dev *pctldev)
  80 {
  81         /* We're not allowed to register devices without name */
  82         return pctldev->desc->name;
  83 }
  84 EXPORT_SYMBOL_GPL(pinctrl_dev_get_name);
  85
  86 void *pinctrl_dev_get_drvdata(struct pinctrl_dev *pctldev)
  87 {
  88         return pctldev->driver_data;
  89 }
  90 EXPORT_SYMBOL_GPL(pinctrl_dev_get_drvdata);
  91
  92 /**
  93  * get_pinctrl_dev_from_devname() - look up pin controller device
  94  * @devname: the name of a device instance, as returned by dev_name()
  95  *
  96  * Looks up a pin control device matching a certain device name or pure device
  97  * pointer, the pure device pointer will take precedence.
  98  */
  99 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *devname)
 100 {
 101         struct pinctrl_dev *pctldev = NULL;
 102         bool found = false;
 103
 104         if (!devname)
 105                 return NULL;
 106
 107         list_for_each_entry(pctldev, &pinctrldev_list, node) {
 108                 if (!strcmp(dev_name(pctldev->dev), devname)) {
 109                         /* Matched on device name */
 110                         found = true;
 111                         break;
 112                 }
 113         }
 114
 115         return found ? pctldev : NULL;
 116 }
 117
 118 /**
 119  * pin_get_from_name() - look up a pin number from a name
 120  * @pctldev: the pin control device to lookup the pin on
 121  * @name: the name of the pin to look up
 122  */
 123 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name)
 124 {
 125         unsigned i, pin;
 126
 127         /* The pin number can be retrived from the pin controller descriptor */
 128         for (i = 0; i < pctldev->desc->npins; i++) {
 129                 struct pin_desc *desc;
 130
 131                 pin = pctldev->desc->pins[i].number;
 132                 desc = pin_desc_get(pctldev, pin);
 133                 /* Pin space may be sparse */
 134                 if (desc == NULL)
 135                         continue;
 136                 if (desc->name && !strcmp(name, desc->name))
 137                         return pin;
 138         }
 139
 140         return -EINVAL;
 141 }
 142
 143 /**
 144  * pin_get_name_from_id() - look up a pin name from a pin id
 145  * @pctldev: the pin control device to lookup the pin on
 146  * @name: the name of the pin to look up
 147  */
 148 const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin)
 149 {
 150         const struct pin_desc *desc;
 151
 152         desc = pin_desc_get(pctldev, pin);
 153         if (desc == NULL) {
 154                 dev_err(pctldev->dev, "failed to get pin(%d) name\n",
 155                         pin);
 156                 return NULL;
 157         }
 158
 159         return desc->name;
 160 }
 161
 162 /**
 163  * pin_is_valid() - check if pin exists on controller
 164  * @pctldev: the pin control device to check the pin on
 165  * @pin: pin to check, use the local pin controller index number
 166  *
 167  * This tells us whether a certain pin exist on a certain pin controller or
 168  * not. Pin lists may be sparse, so some pins may not exist.
 169  */
 170 bool pin_is_valid(struct pinctrl_dev *pctldev, int pin)
 171 {
 172         struct pin_desc *pindesc;
 173
 174         if (pin < 0)
 175                 return false;
 176
 177         mutex_lock(&pinctrl_mutex);
 178         pindesc = pin_desc_get(pctldev, pin);
 179         mutex_unlock(&pinctrl_mutex);
 180
 181         return pindesc != NULL;
 182 }
 183 EXPORT_SYMBOL_GPL(pin_is_valid);
 184
 185 /* Deletes a range of pin descriptors */
 186 static void pinctrl_free_pindescs(struct pinctrl_dev *pctldev,
 187                                   const struct pinctrl_pin_desc *pins,
 188                                   unsigned num_pins)
 189 {
 190         int i;
 191
 192         for (i = 0; i < num_pins; i++) {
 193                 struct pin_desc *pindesc;
 194
 195                 pindesc = radix_tree_lookup(&pctldev->pin_desc_tree,
 196                                             pins[i].number);
 197                 if (pindesc != NULL) {
 198                         radix_tree_delete(&pctldev->pin_desc_tree,
 199                                           pins[i].number);
 200                         if (pindesc->dynamic_name)
 201                                 kfree(pindesc->name);
 202                 }
 203                 kfree(pindesc);
 204         }
 205 }
 206
 207 static int pinctrl_register_one_pin(struct pinctrl_dev *pctldev,
 208                                     unsigned number, const char *name)
 209 {
 210         struct pin_desc *pindesc;
 211
 212         pindesc = pin_desc_get(pctldev, number);
 213         if (pindesc != NULL) {
 214                 pr_err("pin %d already registered on %s\n", number,
 215                        pctldev->desc->name);
 216                 return -EINVAL;
 217         }
 218
 219         pindesc = kzalloc(sizeof(*pindesc), GFP_KERNEL);
 220         if (pindesc == NULL) {
 221                 dev_err(pctldev->dev, "failed to alloc struct pin_desc\n");
 222                 return -ENOMEM;
 223         }
 224
 225         /* Set owner */
 226         pindesc->pctldev = pctldev;
 227
 228         /* Copy basic pin info */
 229         if (name) {
 230                 pindesc->name = name;
 231         } else {
 232                 pindesc->name = kasprintf(GFP_KERNEL, "PIN%u", number);
 233                 if (pindesc->name == NULL) {
 234                         kfree(pindesc);
 235                         return -ENOMEM;
 236                 }
 237                 pindesc->dynamic_name = true;
 238         }
 239
 240         radix_tree_insert(&pctldev->pin_desc_tree, number, pindesc);
 241         pr_debug("registered pin %d (%s) on %s\n",
 242                  number, pindesc->name, pctldev->desc->name);
 243         return 0;
 244 }
 245
 246 static int pinctrl_register_pins(struct pinctrl_dev *pctldev,
 247                                  struct pinctrl_pin_desc const *pins,
 248                                  unsigned num_descs)
 249 {
 250         unsigned i;
 251         int ret = 0;
 252
 253         for (i = 0; i < num_descs; i++) {
 254                 ret = pinctrl_register_one_pin(pctldev,
 255                                                pins[i].number, pins[i].name);
 256                 if (ret)
 257                         return ret;
 258         }
 259
 260         return 0;
 261 }
 262
 263 /**
 264  * pinctrl_match_gpio_range() - check if a certain GPIO pin is in range
 265  * @pctldev: pin controller device to check
 266  * @gpio: gpio pin to check taken from the global GPIO pin space
 267  *
 268  * Tries to match a GPIO pin number to the ranges handled by a certain pin
 269  * controller, return the range or NULL
 270  */
 271 static struct pinctrl_gpio_range *
 272 pinctrl_match_gpio_range(struct pinctrl_dev *pctldev, unsigned gpio)
 273 {
 274         struct pinctrl_gpio_range *range = NULL;
 275
 276         /* Loop over the ranges */
 277         list_for_each_entry(range, &pctldev->gpio_ranges, node) {
 278                 /* Check if we're in the valid range */
 279                 if (gpio >= range->base &&
 280                     gpio < range->base + range->npins) {
 281                         return range;
 282                 }
 283         }
 284
 285         return NULL;
 286 }
 287
 288 /**
 289  * pinctrl_get_device_gpio_range() - find device for GPIO range
 290  * @gpio: the pin to locate the pin controller for
 291  * @outdev: the pin control device if found
 292  * @outrange: the GPIO range if found
 293  *
 294  * Find the pin controller handling a certain GPIO pin from the pinspace of
 295  * the GPIO subsystem, return the device and the matching GPIO range. Returns
 296  * -EPROBE_DEFER if the GPIO range could not be found in any device since it
 297  * may still have not been registered.
 298  */
 299 static int pinctrl_get_device_gpio_range(unsigned gpio,
 300                                          struct pinctrl_dev **outdev,
 301                                          struct pinctrl_gpio_range **outrange)
 302 {
 303         struct pinctrl_dev *pctldev = NULL;
 304
 305         /* Loop over the pin controllers */
 306         list_for_each_entry(pctldev, &pinctrldev_list, node) {
 307                 struct pinctrl_gpio_range *range;
 308
 309                 range = pinctrl_match_gpio_range(pctldev, gpio);
 310                 if (range != NULL) {
 311                         *outdev = pctldev;
 312                         *outrange = range;
 313                         return 0;
 314                 }
 315         }
 316
 317         return -EPROBE_DEFER;
 318 }
 319
 320 /**
 321  * pinctrl_add_gpio_range() - register a GPIO range for a controller
 322  * @pctldev: pin controller device to add the range to
 323  * @range: the GPIO range to add
 324  *
 325  * This adds a range of GPIOs to be handled by a certain pin controller. Call
 326  * this to register handled ranges after registering your pin controller.
 327  */
 328 void pinctrl_add_gpio_range(struct pinctrl_dev *pctldev,
 329                             struct pinctrl_gpio_range *range)
 330 {
 331         mutex_lock(&pinctrl_mutex);
 332         list_add_tail(&range->node, &pctldev->gpio_ranges);
 333         mutex_unlock(&pinctrl_mutex);
 334 }
 335 EXPORT_SYMBOL_GPL(pinctrl_add_gpio_range);
 336
 337 void pinctrl_add_gpio_ranges(struct pinctrl_dev *pctldev,
 338                              struct pinctrl_gpio_range *ranges,
 339                              unsigned nranges)
 340 {
 341         int i;
 342
 343         for (i = 0; i < nranges; i++)
 344                 pinctrl_add_gpio_range(pctldev, &ranges[i]);
 345 }
 346 EXPORT_SYMBOL_GPL(pinctrl_add_gpio_ranges);
 347
 348 struct pinctrl_dev *pinctrl_find_and_add_gpio_range(const char *devname,
 349                 struct pinctrl_gpio_range *range)
 350 {
 351         struct pinctrl_dev *pctldev = get_pinctrl_dev_from_devname(devname);
 352
 353         /*
 354          * If we can't find this device, let's assume that is because
 355          * it has not probed yet, so the driver trying to register this
 356          * range need to defer probing.
 357          */
 358         if (!pctldev)
 359                 return ERR_PTR(-EPROBE_DEFER);
 360
 361         pinctrl_add_gpio_range(pctldev, range);
 362         return pctldev;
 363 }
 364 EXPORT_SYMBOL_GPL(pinctrl_find_and_add_gpio_range);
 365
 366 /**
 367  * pinctrl_find_gpio_range_from_pin() - locate the GPIO range for a pin
 368  * @pctldev: the pin controller device to look in
 369  * @pin: a controller-local number to find the range for
 370  */
 371 struct pinctrl_gpio_range *
 372 pinctrl_find_gpio_range_from_pin(struct pinctrl_dev *pctldev,
 373                                  unsigned int pin)
 374 {
 375         struct pinctrl_gpio_range *range = NULL;
 376
 377         /* Loop over the ranges */
 378         list_for_each_entry(range, &pctldev->gpio_ranges, node) {
 379                 /* Check if we're in the valid range */
 380                 if (pin >= range->pin_base &&
 381                     pin < range->pin_base + range->npins) {
 382                         return range;
 383                 }
 384         }
 385
 386         return NULL;
 387 }
 388 EXPORT_SYMBOL_GPL(pinctrl_find_gpio_range_from_pin);
 389
 390 /**
 391  * pinctrl_remove_gpio_range() - remove a range of GPIOs fro a pin controller
 392  * @pctldev: pin controller device to remove the range from
 393  * @range: the GPIO range to remove
 394  */
 395 void pinctrl_remove_gpio_range(struct pinctrl_dev *pctldev,
 396                                struct pinctrl_gpio_range *range)
 397 {
 398         mutex_lock(&pinctrl_mutex);
 399         list_del(&range->node);
 400         mutex_unlock(&pinctrl_mutex);
 401 }
 402 EXPORT_SYMBOL_GPL(pinctrl_remove_gpio_range);
 403
 404 /**
 405  * pinctrl_get_group_selector() - returns the group selector for a group
 406  * @pctldev: the pin controller handling the group
 407  * @pin_group: the pin group to look up
 408  */
 409 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
 410                                const char *pin_group)
 411 {
 412         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 413         unsigned ngroups = pctlops->get_groups_count(pctldev);
 414         unsigned group_selector = 0;
 415
 416         while (group_selector < ngroups) {
 417                 const char *gname = pctlops->get_group_name(pctldev,
 418                                                             group_selector);
 419                 if (!strcmp(gname, pin_group)) {
 420                         dev_dbg(pctldev->dev,
 421                                 "found group selector %u for %s\n",
 422                                 group_selector,
 423                                 pin_group);
 424                         return group_selector;
 425                 }
 426
 427                 group_selector++;
 428         }
 429
 430         dev_err(pctldev->dev, "does not have pin group %s\n",
 431                 pin_group);
 432
 433         return -EINVAL;
 434 }
 435
 436 /**
 437  * pinctrl_request_gpio() - request a single pin to be used in as GPIO
 438  * @gpio: the GPIO pin number from the GPIO subsystem number space
 439  *
 440  * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 441  * as part of their gpio_request() semantics, platforms and individual drivers
 442  * shall *NOT* request GPIO pins to be muxed in.
 443  */
 444 int pinctrl_request_gpio(unsigned gpio)
 445 {
 446         struct pinctrl_dev *pctldev;
 447         struct pinctrl_gpio_range *range;
 448         int ret;
 449         int pin;
 450
 451         mutex_lock(&pinctrl_mutex);
 452
 453         ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
 454         if (ret) {
 455                 mutex_unlock(&pinctrl_mutex);
 456                 return ret;
 457         }
 458
 459         /* Convert to the pin controllers number space */
 460         pin = gpio - range->base + range->pin_base;
 461
 462         ret = pinmux_request_gpio(pctldev, range, pin, gpio);
 463
 464         mutex_unlock(&pinctrl_mutex);
 465         return ret;
 466 }
 467 EXPORT_SYMBOL_GPL(pinctrl_request_gpio);
 468
 469 /**
 470  * pinctrl_free_gpio() - free control on a single pin, currently used as GPIO
 471  * @gpio: the GPIO pin number from the GPIO subsystem number space
 472  *
 473  * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 474  * as part of their gpio_free() semantics, platforms and individual drivers
 475  * shall *NOT* request GPIO pins to be muxed out.
 476  */
 477 void pinctrl_free_gpio(unsigned gpio)
 478 {
 479         struct pinctrl_dev *pctldev;
 480         struct pinctrl_gpio_range *range;
 481         int ret;
 482         int pin;
 483
 484         mutex_lock(&pinctrl_mutex);
 485
 486         ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
 487         if (ret) {
 488                 mutex_unlock(&pinctrl_mutex);
 489                 return;
 490         }
 491
 492         /* Convert to the pin controllers number space */
 493         pin = gpio - range->base + range->pin_base;
 494
 495         pinmux_free_gpio(pctldev, pin, range);
 496
 497         mutex_unlock(&pinctrl_mutex);
 498 }
 499 EXPORT_SYMBOL_GPL(pinctrl_free_gpio);
 500
 501 static int pinctrl_gpio_direction(unsigned gpio, bool input)
 502 {
 503         struct pinctrl_dev *pctldev;
 504         struct pinctrl_gpio_range *range;
 505         int ret;
 506         int pin;
 507
 508         ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
 509         if (ret)
 510                 return ret;
 511
 512         /* Convert to the pin controllers number space */
 513         pin = gpio - range->base + range->pin_base;
 514
 515         return pinmux_gpio_direction(pctldev, range, pin, input);
 516 }
 517
 518 /**
 519  * pinctrl_gpio_direction_input() - request a GPIO pin to go into input mode
 520  * @gpio: the GPIO pin number from the GPIO subsystem number space
 521  *
 522  * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 523  * as part of their gpio_direction_input() semantics, platforms and individual
 524  * drivers shall *NOT* touch pin control GPIO calls.
 525  */
 526 int pinctrl_gpio_direction_input(unsigned gpio)
 527 {
 528         int ret;
 529         mutex_lock(&pinctrl_mutex);
 530         ret = pinctrl_gpio_direction(gpio, true);
 531         mutex_unlock(&pinctrl_mutex);
 532         return ret;
 533 }
 534 EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_input);
 535
 536 /**
 537  * pinctrl_gpio_direction_output() - request a GPIO pin to go into output mode
 538  * @gpio: the GPIO pin number from the GPIO subsystem number space
 539  *
 540  * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 541  * as part of their gpio_direction_output() semantics, platforms and individual
 542  * drivers shall *NOT* touch pin control GPIO calls.
 543  */
 544 int pinctrl_gpio_direction_output(unsigned gpio)
 545 {
 546         int ret;
 547         mutex_lock(&pinctrl_mutex);
 548         ret = pinctrl_gpio_direction(gpio, false);
 549         mutex_unlock(&pinctrl_mutex);
 550         return ret;
 551 }
 552 EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_output);
 553
 554 static struct pinctrl_state *find_state(struct pinctrl *p,
 555                                         const char *name)
 556 {
 557         struct pinctrl_state *state;
 558
 559         list_for_each_entry(state, &p->states, node)
 560                 if (!strcmp(state->name, name))
 561                         return state;
 562
 563         return NULL;
 564 }
 565
 566 static struct pinctrl_state *create_state(struct pinctrl *p,
 567                                           const char *name)
 568 {
 569         struct pinctrl_state *state;
 570
 571         state = kzalloc(sizeof(*state), GFP_KERNEL);
 572         if (state == NULL) {
 573                 dev_err(p->dev,
 574                         "failed to alloc struct pinctrl_state\n");
 575                 return ERR_PTR(-ENOMEM);
 576         }
 577
 578         state->name = name;
 579         INIT_LIST_HEAD(&state->settings);
 580
 581         list_add_tail(&state->node, &p->states);
 582
 583         return state;
 584 }
 585
 586 static int add_setting(struct pinctrl *p, struct pinctrl_map const *map)
 587 {
 588         struct pinctrl_state *state;
 589         struct pinctrl_setting *setting;
 590         int ret;
 591
 592         state = find_state(p, map->name);
 593         if (!state)
 594                 state = create_state(p, map->name);
 595         if (IS_ERR(state))
 596                 return PTR_ERR(state);
 597
 598         if (map->type == PIN_MAP_TYPE_DUMMY_STATE)
 599                 return 0;
 600
 601         setting = kzalloc(sizeof(*setting), GFP_KERNEL);
 602         if (setting == NULL) {
 603                 dev_err(p->dev,
 604                         "failed to alloc struct pinctrl_setting\n");
 605                 return -ENOMEM;
 606         }
 607
 608         setting->type = map->type;
 609
 610         setting->pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
 611         if (setting->pctldev == NULL) {
 612                 dev_info(p->dev, "unknown pinctrl device %s in map entry, deferring probe",
 613                         map->ctrl_dev_name);
 614                 kfree(setting);
 615                 /*
 616                  * OK let us guess that the driver is not there yet, and
 617                  * let's defer obtaining this pinctrl handle to later...
 618                  */
 619                 return -EPROBE_DEFER;
 620         }
 621
 622         setting->dev_name = map->dev_name;
 623
 624         switch (map->type) {
 625         case PIN_MAP_TYPE_MUX_GROUP:
 626                 ret = pinmux_map_to_setting(map, setting);
 627                 break;
 628         case PIN_MAP_TYPE_CONFIGS_PIN:
 629         case PIN_MAP_TYPE_CONFIGS_GROUP:
 630                 ret = pinconf_map_to_setting(map, setting);
 631                 break;
 632         default:
 633                 ret = -EINVAL;
 634                 break;
 635         }
 636         if (ret < 0) {
 637                 kfree(setting);
 638                 return ret;
 639         }
 640
 641         list_add_tail(&setting->node, &state->settings);
 642
 643         return 0;
 644 }
 645
 646 static struct pinctrl *find_pinctrl(struct device *dev)
 647 {
 648         struct pinctrl *p;
 649
 650         list_for_each_entry(p, &pinctrl_list, node)
 651                 if (p->dev == dev)
 652                         return p;
 653
 654         return NULL;
 655 }
 656
 657 static void pinctrl_put_locked(struct pinctrl *p, bool inlist);
 658
 659 static struct pinctrl *create_pinctrl(struct device *dev)
 660 {
 661         struct pinctrl *p;
 662         const char *devname;
 663         struct pinctrl_maps *maps_node;
 664         int i;
 665         struct pinctrl_map const *map;
 666         int ret;
 667
 668         /*
 669          * create the state cookie holder struct pinctrl for each
 670          * mapping, this is what consumers will get when requesting
 671          * a pin control handle with pinctrl_get()
 672          */
 673         p = kzalloc(sizeof(*p), GFP_KERNEL);
 674         if (p == NULL) {
 675                 dev_err(dev, "failed to alloc struct pinctrl\n");
 676                 return ERR_PTR(-ENOMEM);
 677         }
 678         p->dev = dev;
 679         INIT_LIST_HEAD(&p->states);
 680         INIT_LIST_HEAD(&p->dt_maps);
 681
 682         ret = pinctrl_dt_to_map(p);
 683         if (ret < 0) {
 684                 kfree(p);
 685                 return ERR_PTR(ret);
 686         }
 687
 688         devname = dev_name(dev);
 689
 690         /* Iterate over the pin control maps to locate the right ones */
 691         for_each_maps(maps_node, i, map) {
 692                 /* Map must be for this device */
 693                 if (strcmp(map->dev_name, devname))
 694                         continue;
 695
 696                 ret = add_setting(p, map);
 697                 if (ret < 0) {
 698                         pinctrl_put_locked(p, false);
 699                         return ERR_PTR(ret);
 700                 }
 701         }
 702
 703         /* Add the pinmux to the global list */
 704         list_add_tail(&p->node, &pinctrl_list);
 705
 706         return p;
 707 }
 708
 709 static struct pinctrl *pinctrl_get_locked(struct device *dev)
 710 {
 711         struct pinctrl *p;
 712
 713         if (WARN_ON(!dev))
 714                 return ERR_PTR(-EINVAL);
 715
 716         p = find_pinctrl(dev);
 717         if (p != NULL)
 718                 return ERR_PTR(-EBUSY);
 719
 720         return create_pinctrl(dev);
 721 }
 722
 723 /**
 724  * pinctrl_get() - retrieves the pinctrl handle for a device
 725  * @dev: the device to obtain the handle for
 726  */
 727 struct pinctrl *pinctrl_get(struct device *dev)
 728 {
 729         struct pinctrl *p;
 730
 731         mutex_lock(&pinctrl_mutex);
 732         p = pinctrl_get_locked(dev);
 733         mutex_unlock(&pinctrl_mutex);
 734
 735         return p;
 736 }
 737 EXPORT_SYMBOL_GPL(pinctrl_get);
 738
 739 static void pinctrl_put_locked(struct pinctrl *p, bool inlist)
 740 {
 741         struct pinctrl_state *state, *n1;
 742         struct pinctrl_setting *setting, *n2;
 743
 744         list_for_each_entry_safe(state, n1, &p->states, node) {
 745                 list_for_each_entry_safe(setting, n2, &state->settings, node) {
 746                         switch (setting->type) {
 747                         case PIN_MAP_TYPE_MUX_GROUP:
 748                                 if (state == p->state)
 749                                         pinmux_disable_setting(setting);
 750                                 pinmux_free_setting(setting);
 751                                 break;
 752                         case PIN_MAP_TYPE_CONFIGS_PIN:
 753                         case PIN_MAP_TYPE_CONFIGS_GROUP:
 754                                 pinconf_free_setting(setting);
 755                                 break;
 756                         default:
 757                                 break;
 758                         }
 759                         list_del(&setting->node);
 760                         kfree(setting);
 761                 }
 762                 list_del(&state->node);
 763                 kfree(state);
 764         }
 765
 766         pinctrl_dt_free_maps(p);
 767
 768         if (inlist)
 769                 list_del(&p->node);
 770         kfree(p);
 771 }
 772
 773 /**
 774  * pinctrl_put() - release a previously claimed pinctrl handle
 775  * @p: the pinctrl handle to release
 776  */
 777 void pinctrl_put(struct pinctrl *p)
 778 {
 779         mutex_lock(&pinctrl_mutex);
 780         pinctrl_put_locked(p, true);
 781         mutex_unlock(&pinctrl_mutex);
 782 }
 783 EXPORT_SYMBOL_GPL(pinctrl_put);
 784
 785 static struct pinctrl_state *pinctrl_lookup_state_locked(struct pinctrl *p,
 786                                                          const char *name)
 787 {
 788         struct pinctrl_state *state;
 789
 790         state = find_state(p, name);
 791         if (!state) {
 792                 if (pinctrl_dummy_state) {
 793                         /* create dummy state */
 794                         dev_dbg(p->dev, "using pinctrl dummy state (%s)\n",
 795                                 name);
 796                         state = create_state(p, name);
 797                 } else
 798                         state = ERR_PTR(-ENODEV);
 799         }
 800
 801         return state;
 802 }
 803
 804 /**
 805  * pinctrl_lookup_state() - retrieves a state handle from a pinctrl handle
 806  * @p: the pinctrl handle to retrieve the state from
 807  * @name: the state name to retrieve
 808  */
 809 struct pinctrl_state *pinctrl_lookup_state(struct pinctrl *p, const char *name)
 810 {
 811         struct pinctrl_state *s;
 812
 813         mutex_lock(&pinctrl_mutex);
 814         s = pinctrl_lookup_state_locked(p, name);
 815         mutex_unlock(&pinctrl_mutex);
 816
 817         return s;
 818 }
 819 EXPORT_SYMBOL_GPL(pinctrl_lookup_state);
 820
 821 static int pinctrl_select_state_locked(struct pinctrl *p,
 822                                        struct pinctrl_state *state)
 823 {
 824         struct pinctrl_setting *setting, *setting2;
 825         int ret;
 826
 827         if (p->state == state)
 828                 return 0;
 829
 830         if (p->state) {
 831                 /*
 832                  * The set of groups with a mux configuration in the old state
 833                  * may not be identical to the set of groups with a mux setting
 834                  * in the new state. While this might be unusual, it's entirely
 835                  * possible for the "user"-supplied mapping table to be written
 836                  * that way. For each group that was configured in the old state
 837                  * but not in the new state, this code puts that group into a
 838                  * safe/disabled state.
 839                  */
 840                 list_for_each_entry(setting, &p->state->settings, node) {
 841                         bool found = false;
 842                         if (setting->type != PIN_MAP_TYPE_MUX_GROUP)
 843                                 continue;
 844                         list_for_each_entry(setting2, &state->settings, node) {
 845                                 if (setting2->type != PIN_MAP_TYPE_MUX_GROUP)
 846                                         continue;
 847                                 if (setting2->data.mux.group ==
 848                                                 setting->data.mux.group) {
 849                                         found = true;
 850                                         break;
 851                                 }
 852                         }
 853                         if (!found)
 854                                 pinmux_disable_setting(setting);
 855                 }
 856         }
 857
 858         p->state = state;
 859
 860         /* Apply all the settings for the new state */
 861         list_for_each_entry(setting, &state->settings, node) {
 862                 switch (setting->type) {
 863                 case PIN_MAP_TYPE_MUX_GROUP:
 864                         ret = pinmux_enable_setting(setting);
 865                         break;
 866                 case PIN_MAP_TYPE_CONFIGS_PIN:
 867                 case PIN_MAP_TYPE_CONFIGS_GROUP:
 868                         ret = pinconf_apply_setting(setting);
 869                         break;
 870                 default:
 871                         ret = -EINVAL;
 872                         break;
 873                 }
 874                 if (ret < 0) {
 875                         /* FIXME: Difficult to return to prev state */
 876                         return ret;
 877                 }
 878         }
 879
 880         return 0;
 881 }
 882
 883 /**
 884  * pinctrl_select() - select/activate/program a pinctrl state to HW
 885  * @p: the pinctrl handle for the device that requests configuratio
 886  * @state: the state handle to select/activate/program
 887  */
 888 int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *state)
 889 {
 890         int ret;
 891
 892         mutex_lock(&pinctrl_mutex);
 893         ret = pinctrl_select_state_locked(p, state);
 894         mutex_unlock(&pinctrl_mutex);
 895
 896         return ret;
 897 }
 898 EXPORT_SYMBOL_GPL(pinctrl_select_state);
 899
 900 static void devm_pinctrl_release(struct device *dev, void *res)
 901 {
 902         pinctrl_put(*(struct pinctrl **)res);
 903 }
 904
 905 /**
 906  * struct devm_pinctrl_get() - Resource managed pinctrl_get()
 907  * @dev: the device to obtain the handle for
 908  *
 909  * If there is a need to explicitly destroy the returned struct pinctrl,
 910  * devm_pinctrl_put() should be used, rather than plain pinctrl_put().
 911  */
 912 struct pinctrl *devm_pinctrl_get(struct device *dev)
 913 {
 914         struct pinctrl **ptr, *p;
 915
 916         ptr = devres_alloc(devm_pinctrl_release, sizeof(*ptr), GFP_KERNEL);
 917         if (!ptr)
 918                 return ERR_PTR(-ENOMEM);
 919
 920         p = pinctrl_get(dev);
 921         if (!IS_ERR(p)) {
 922                 *ptr = p;
 923                 devres_add(dev, ptr);
 924         } else {
 925                 devres_free(ptr);
 926         }
 927
 928         return p;
 929 }
 930 EXPORT_SYMBOL_GPL(devm_pinctrl_get);
 931
 932 static int devm_pinctrl_match(struct device *dev, void *res, void *data)
 933 {
 934         struct pinctrl **p = res;
 935
 936         return *p == data;
 937 }
 938
 939 /**
 940  * devm_pinctrl_put() - Resource managed pinctrl_put()
 941  * @p: the pinctrl handle to release
 942  *
 943  * Deallocate a struct pinctrl obtained via devm_pinctrl_get(). Normally
 944  * this function will not need to be called and the resource management
 945  * code will ensure that the resource is freed.
 946  */
 947 void devm_pinctrl_put(struct pinctrl *p)
 948 {
 949         WARN_ON(devres_destroy(p->dev, devm_pinctrl_release,
 950                                devm_pinctrl_match, p));
 951         pinctrl_put(p);
 952 }
 953 EXPORT_SYMBOL_GPL(devm_pinctrl_put);
 954
 955 int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps,
 956                          bool dup, bool locked)
 957 {
 958         int i, ret;
 959         struct pinctrl_maps *maps_node;
 960
 961         pr_debug("add %d pinmux maps\n", num_maps);
 962
 963         /* First sanity check the new mapping */
 964         for (i = 0; i < num_maps; i++) {
 965                 if (!maps[i].dev_name) {
 966                         pr_err("failed to register map %s (%d): no device given\n",
 967                                maps[i].name, i);
 968                         return -EINVAL;
 969                 }
 970
 971                 if (!maps[i].name) {
 972                         pr_err("failed to register map %d: no map name given\n",
 973                                i);
 974                         return -EINVAL;
 975                 }
 976
 977                 if (maps[i].type != PIN_MAP_TYPE_DUMMY_STATE &&
 978                                 !maps[i].ctrl_dev_name) {
 979                         pr_err("failed to register map %s (%d): no pin control device given\n",
 980                                maps[i].name, i);
 981                         return -EINVAL;
 982                 }
 983
 984                 switch (maps[i].type) {
 985                 case PIN_MAP_TYPE_DUMMY_STATE:
 986                         break;
 987                 case PIN_MAP_TYPE_MUX_GROUP:
 988                         ret = pinmux_validate_map(&maps[i], i);
 989                         if (ret < 0)
 990                                 return ret;
 991                         break;
 992                 case PIN_MAP_TYPE_CONFIGS_PIN:
 993                 case PIN_MAP_TYPE_CONFIGS_GROUP:
 994                         ret = pinconf_validate_map(&maps[i], i);
 995                         if (ret < 0)
 996                                 return ret;
 997                         break;
 998                 default:
 999                         pr_err("failed to register map %s (%d): invalid type given\n",
1000                                maps[i].name, i);
1001                         return -EINVAL;
1002                 }
1003         }
1004
1005         maps_node = kzalloc(sizeof(*maps_node), GFP_KERNEL);
1006         if (!maps_node) {
1007                 pr_err("failed to alloc struct pinctrl_maps\n");
1008                 return -ENOMEM;
1009         }
1010
1011         maps_node->num_maps = num_maps;
1012         if (dup) {
1013                 maps_node->maps = kmemdup(maps, sizeof(*maps) * num_maps,
1014                                           GFP_KERNEL);
1015                 if (!maps_node->maps) {
1016                         pr_err("failed to duplicate mapping table\n");
1017                         kfree(maps_node);
1018                         return -ENOMEM;
1019                 }
1020         } else {
1021                 maps_node->maps = maps;
1022         }
1023
1024         if (!locked)
1025                 mutex_lock(&pinctrl_mutex);
1026         list_add_tail(&maps_node->node, &pinctrl_maps);
1027         if (!locked)
1028                 mutex_unlock(&pinctrl_mutex);
1029
1030         return 0;
1031 }
1032
1033 /**
1034  * pinctrl_register_mappings() - register a set of pin controller mappings
1035  * @maps: the pincontrol mappings table to register. This should probably be
1036  *      marked with __initdata so it can be discarded after boot. This
1037  *      function will perform a shallow copy for the mapping entries.
1038  * @num_maps: the number of maps in the mapping table
1039  */
1040 int pinctrl_register_mappings(struct pinctrl_map const *maps,
1041                               unsigned num_maps)
1042 {
1043         return pinctrl_register_map(maps, num_maps, true, false);
1044 }
1045
1046 void pinctrl_unregister_map(struct pinctrl_map const *map)
1047 {
1048         struct pinctrl_maps *maps_node;
1049
1050         list_for_each_entry(maps_node, &pinctrl_maps, node) {
1051                 if (maps_node->maps == map) {
1052                         list_del(&maps_node->node);
1053                         return;
1054                 }
1055         }
1056 }
1057
1058 #ifdef CONFIG_DEBUG_FS
1059
1060 static int pinctrl_pins_show(struct seq_file *s, void *what)
1061 {
1062         struct pinctrl_dev *pctldev = s->private;
1063         const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1064         unsigned i, pin;
1065
1066         seq_printf(s, "registered pins: %d\n", pctldev->desc->npins);
1067
1068         mutex_lock(&pinctrl_mutex);
1069
1070         /* The pin number can be retrived from the pin controller descriptor */
1071         for (i = 0; i < pctldev->desc->npins; i++) {
1072                 struct pin_desc *desc;
1073
1074                 pin = pctldev->desc->pins[i].number;
1075                 desc = pin_desc_get(pctldev, pin);
1076                 /* Pin space may be sparse */
1077                 if (desc == NULL)
1078                         continue;
1079
1080                 seq_printf(s, "pin %d (%s) ", pin,
1081                            desc->name ? desc->name : "unnamed");
1082
1083                 /* Driver-specific info per pin */
1084                 if (ops->pin_dbg_show)
1085                         ops->pin_dbg_show(pctldev, s, pin);
1086
1087                 seq_puts(s, "\n");
1088         }
1089
1090         mutex_unlock(&pinctrl_mutex);
1091
1092         return 0;
1093 }
1094
1095 static int pinctrl_groups_show(struct seq_file *s, void *what)
1096 {
1097         struct pinctrl_dev *pctldev = s->private;
1098         const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1099         unsigned ngroups, selector = 0;
1100
1101         ngroups = ops->get_groups_count(pctldev);
1102         mutex_lock(&pinctrl_mutex);
1103
1104         seq_puts(s, "registered pin groups:\n");
1105         while (selector < ngroups) {
1106                 const unsigned *pins;
1107                 unsigned num_pins;
1108                 const char *gname = ops->get_group_name(pctldev, selector);
1109                 const char *pname;
1110                 int ret;
1111                 int i;
1112
1113                 ret = ops->get_group_pins(pctldev, selector,
1114                                           &pins, &num_pins);
1115                 if (ret)
1116                         seq_printf(s, "%s [ERROR GETTING PINS]\n",
1117                                    gname);
1118                 else {
1119                         seq_printf(s, "group: %s\n", gname);
1120                         for (i = 0; i < num_pins; i++) {
1121                                 pname = pin_get_name(pctldev, pins[i]);
1122                                 if (WARN_ON(!pname)) {
1123                                         mutex_unlock(&pinctrl_mutex);
1124                                         return -EINVAL;
1125                                 }
1126                                 seq_printf(s, "pin %d (%s)\n", pins[i], pname);
1127                         }
1128                         seq_puts(s, "\n");
1129                 }
1130                 selector++;
1131         }
1132
1133         mutex_unlock(&pinctrl_mutex);
1134
1135         return 0;
1136 }
1137
1138 static int pinctrl_gpioranges_show(struct seq_file *s, void *what)
1139 {
1140         struct pinctrl_dev *pctldev = s->private;
1141         struct pinctrl_gpio_range *range = NULL;
1142
1143         seq_puts(s, "GPIO ranges handled:\n");
1144
1145         mutex_lock(&pinctrl_mutex);
1146
1147         /* Loop over the ranges */
1148         list_for_each_entry(range, &pctldev->gpio_ranges, node) {
1149                 seq_printf(s, "%u: %s GPIOS [%u - %u] PINS [%u - %u]\n",
1150                            range->id, range->name,
1151                            range->base, (range->base + range->npins - 1),
1152                            range->pin_base,
1153                            (range->pin_base + range->npins - 1));
1154         }
1155
1156         mutex_unlock(&pinctrl_mutex);
1157
1158         return 0;
1159 }
1160
1161 static int pinctrl_devices_show(struct seq_file *s, void *what)
1162 {
1163         struct pinctrl_dev *pctldev;
1164
1165         seq_puts(s, "name [pinmux] [pinconf]\n");
1166
1167         mutex_lock(&pinctrl_mutex);
1168
1169         list_for_each_entry(pctldev, &pinctrldev_list, node) {
1170                 seq_printf(s, "%s ", pctldev->desc->name);
1171                 if (pctldev->desc->pmxops)
1172                         seq_puts(s, "yes ");
1173                 else
1174                         seq_puts(s, "no ");
1175                 if (pctldev->desc->confops)
1176                         seq_puts(s, "yes");
1177                 else
1178                         seq_puts(s, "no");
1179                 seq_puts(s, "\n");
1180         }
1181
1182         mutex_unlock(&pinctrl_mutex);
1183
1184         return 0;
1185 }
1186
1187 static inline const char *map_type(enum pinctrl_map_type type)
1188 {
1189         static const char * const names[] = {
1190                 "INVALID",
1191                 "DUMMY_STATE",
1192                 "MUX_GROUP",
1193                 "CONFIGS_PIN",
1194                 "CONFIGS_GROUP",
1195         };
1196
1197         if (type >= ARRAY_SIZE(names))
1198                 return "UNKNOWN";
1199
1200         return names[type];
1201 }
1202
1203 static int pinctrl_maps_show(struct seq_file *s, void *what)
1204 {
1205         struct pinctrl_maps *maps_node;
1206         int i;
1207         struct pinctrl_map const *map;
1208
1209         seq_puts(s, "Pinctrl maps:\n");
1210
1211         mutex_lock(&pinctrl_mutex);
1212
1213         for_each_maps(maps_node, i, map) {
1214                 seq_printf(s, "device %s\nstate %s\ntype %s (%d)\n",
1215                            map->dev_name, map->name, map_type(map->type),
1216                            map->type);
1217
1218                 if (map->type != PIN_MAP_TYPE_DUMMY_STATE)
1219                         seq_printf(s, "controlling device %s\n",
1220                                    map->ctrl_dev_name);
1221
1222                 switch (map->type) {
1223                 case PIN_MAP_TYPE_MUX_GROUP:
1224                         pinmux_show_map(s, map);
1225                         break;
1226                 case PIN_MAP_TYPE_CONFIGS_PIN:
1227                 case PIN_MAP_TYPE_CONFIGS_GROUP:
1228                         pinconf_show_map(s, map);
1229                         break;
1230                 default:
1231                         break;
1232                 }
1233
1234                 seq_printf(s, "\n");
1235         }
1236
1237         mutex_unlock(&pinctrl_mutex);
1238
1239         return 0;
1240 }
1241
1242 static int pinctrl_show(struct seq_file *s, void *what)
1243 {
1244         struct pinctrl *p;
1245         struct pinctrl_state *state;
1246         struct pinctrl_setting *setting;
1247
1248         seq_puts(s, "Requested pin control handlers their pinmux maps:\n");
1249
1250         mutex_lock(&pinctrl_mutex);
1251
1252         list_for_each_entry(p, &pinctrl_list, node) {
1253                 seq_printf(s, "device: %s current state: %s\n",
1254                            dev_name(p->dev),
1255                            p->state ? p->state->name : "none");
1256
1257                 list_for_each_entry(state, &p->states, node) {
1258                         seq_printf(s, "  state: %s\n", state->name);
1259
1260                         list_for_each_entry(setting, &state->settings, node) {
1261                                 struct pinctrl_dev *pctldev = setting->pctldev;
1262
1263                                 seq_printf(s, "    type: %s controller %s ",
1264                                            map_type(setting->type),
1265                                            pinctrl_dev_get_name(pctldev));
1266
1267                                 switch (setting->type) {
1268                                 case PIN_MAP_TYPE_MUX_GROUP:
1269                                         pinmux_show_setting(s, setting);
1270                                         break;
1271                                 case PIN_MAP_TYPE_CONFIGS_PIN:
1272                                 case PIN_MAP_TYPE_CONFIGS_GROUP:
1273                                         pinconf_show_setting(s, setting);
1274                                         break;
1275                                 default:
1276                                         break;
1277                                 }
1278                         }
1279                 }
1280         }
1281
1282         mutex_unlock(&pinctrl_mutex);
1283
1284         return 0;
1285 }
1286
1287 static int pinctrl_pins_open(struct inode *inode, struct file *file)
1288 {
1289         return single_open(file, pinctrl_pins_show, inode->i_private);
1290 }
1291
1292 static int pinctrl_groups_open(struct inode *inode, struct file *file)
1293 {
1294         return single_open(file, pinctrl_groups_show, inode->i_private);
1295 }
1296
1297 static int pinctrl_gpioranges_open(struct inode *inode, struct file *file)
1298 {
1299         return single_open(file, pinctrl_gpioranges_show, inode->i_private);
1300 }
1301
1302 static int pinctrl_devices_open(struct inode *inode, struct file *file)
1303 {
1304         return single_open(file, pinctrl_devices_show, NULL);
1305 }
1306
1307 static int pinctrl_maps_open(struct inode *inode, struct file *file)
1308 {
1309         return single_open(file, pinctrl_maps_show, NULL);
1310 }
1311
1312 static int pinctrl_open(struct inode *inode, struct file *file)
1313 {
1314         return single_open(file, pinctrl_show, NULL);
1315 }
1316
1317 static const struct file_operations pinctrl_pins_ops = {
1318         .open           = pinctrl_pins_open,
1319         .read           = seq_read,
1320         .llseek         = seq_lseek,
1321         .release        = single_release,
1322 };
1323
1324 static const struct file_operations pinctrl_groups_ops = {
1325         .open           = pinctrl_groups_open,
1326         .read           = seq_read,
1327         .llseek         = seq_lseek,
1328         .release        = single_release,
1329 };
1330
1331 static const struct file_operations pinctrl_gpioranges_ops = {
1332         .open           = pinctrl_gpioranges_open,
1333         .read           = seq_read,
1334         .llseek         = seq_lseek,
1335         .release        = single_release,
1336 };
1337
1338 static const struct file_operations pinctrl_devices_ops = {
1339         .open           = pinctrl_devices_open,
1340         .read           = seq_read,
1341         .llseek         = seq_lseek,
1342         .release        = single_release,
1343 };
1344
1345 static const struct file_operations pinctrl_maps_ops = {
1346         .open           = pinctrl_maps_open,
1347         .read           = seq_read,
1348         .llseek         = seq_lseek,
1349         .release        = single_release,
1350 };
1351
1352 static const struct file_operations pinctrl_ops = {
1353         .open           = pinctrl_open,
1354         .read           = seq_read,
1355         .llseek         = seq_lseek,
1356         .release        = single_release,
1357 };
1358
1359 static struct dentry *debugfs_root;
1360
1361 static void pinctrl_init_device_debugfs(struct pinctrl_dev *pctldev)
1362 {
1363         struct dentry *device_root;
1364
1365         device_root = debugfs_create_dir(dev_name(pctldev->dev),
1366                                          debugfs_root);
1367         pctldev->device_root = device_root;
1368
1369         if (IS_ERR(device_root) || !device_root) {
1370                 pr_warn("failed to create debugfs directory for %s\n",
1371                         dev_name(pctldev->dev));
1372                 return;
1373         }
1374         debugfs_create_file("pins", S_IFREG | S_IRUGO,
1375                             device_root, pctldev, &pinctrl_pins_ops);
1376         debugfs_create_file("pingroups", S_IFREG | S_IRUGO,
1377                             device_root, pctldev, &pinctrl_groups_ops);
1378         debugfs_create_file("gpio-ranges", S_IFREG | S_IRUGO,
1379                             device_root, pctldev, &pinctrl_gpioranges_ops);
1380         pinmux_init_device_debugfs(device_root, pctldev);
1381         pinconf_init_device_debugfs(device_root, pctldev);
1382 }
1383
1384 static void pinctrl_remove_device_debugfs(struct pinctrl_dev *pctldev)
1385 {
1386         debugfs_remove_recursive(pctldev->device_root);
1387 }
1388
1389 static void pinctrl_init_debugfs(void)
1390 {
1391         debugfs_root = debugfs_create_dir("pinctrl", NULL);
1392         if (IS_ERR(debugfs_root) || !debugfs_root) {
1393                 pr_warn("failed to create debugfs directory\n");
1394                 debugfs_root = NULL;
1395                 return;
1396         }
1397
1398         debugfs_create_file("pinctrl-devices", S_IFREG | S_IRUGO,
1399                             debugfs_root, NULL, &pinctrl_devices_ops);
1400         debugfs_create_file("pinctrl-maps", S_IFREG | S_IRUGO,
1401                             debugfs_root, NULL, &pinctrl_maps_ops);
1402         debugfs_create_file("pinctrl-handles", S_IFREG | S_IRUGO,
1403                             debugfs_root, NULL, &pinctrl_ops);
1404 }
1405
1406 #else /* CONFIG_DEBUG_FS */
1407
1408 static void pinctrl_init_device_debugfs(struct pinctrl_dev *pctldev)
1409 {
1410 }
1411
1412 static void pinctrl_init_debugfs(void)
1413 {
1414 }
1415
1416 static void pinctrl_remove_device_debugfs(struct pinctrl_dev *pctldev)
1417 {
1418 }
1419
1420 #endif
1421
1422 static int pinctrl_check_ops(struct pinctrl_dev *pctldev)
1423 {
1424         const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1425
1426         if (!ops ||
1427             !ops->get_groups_count ||
1428             !ops->get_group_name ||
1429             !ops->get_group_pins)
1430                 return -EINVAL;
1431
1432         if (ops->dt_node_to_map && !ops->dt_free_map)
1433                 return -EINVAL;
1434
1435         return 0;
1436 }
1437
1438 /**
1439  * pinctrl_register() - register a pin controller device
1440  * @pctldesc: descriptor for this pin controller
1441  * @dev: parent device for this pin controller
1442  * @driver_data: private pin controller data for this pin controller
1443  */
1444 struct pinctrl_dev *pinctrl_register(struct pinctrl_desc *pctldesc,
1445                                     struct device *dev, void *driver_data)
1446 {
1447         struct pinctrl_dev *pctldev;
1448         int ret;
1449
1450         if (!pctldesc)
1451                 return NULL;
1452         if (!pctldesc->name)
1453                 return NULL;
1454
1455         pctldev = kzalloc(sizeof(*pctldev), GFP_KERNEL);
1456         if (pctldev == NULL) {
1457                 dev_err(dev, "failed to alloc struct pinctrl_dev\n");
1458                 return NULL;
1459         }
1460
1461         /* Initialize pin control device struct */
1462         pctldev->owner = pctldesc->owner;
1463         pctldev->desc = pctldesc;
1464         pctldev->driver_data = driver_data;
1465         INIT_RADIX_TREE(&pctldev->pin_desc_tree, GFP_KERNEL);
1466         INIT_LIST_HEAD(&pctldev->gpio_ranges);
1467         pctldev->dev = dev;
1468
1469         /* check core ops for sanity */
1470         if (pinctrl_check_ops(pctldev)) {
1471                 dev_err(dev, "pinctrl ops lacks necessary functions\n");
1472                 goto out_err;
1473         }
1474
1475         /* If we're implementing pinmuxing, check the ops for sanity */
1476         if (pctldesc->pmxops) {
1477                 if (pinmux_check_ops(pctldev))
1478                         goto out_err;
1479         }
1480
1481         /* If we're implementing pinconfig, check the ops for sanity */
1482         if (pctldesc->confops) {
1483                 if (pinconf_check_ops(pctldev))
1484                         goto out_err;
1485         }
1486
1487         /* Register all the pins */
1488         dev_dbg(dev, "try to register %d pins ...\n",  pctldesc->npins);
1489         ret = pinctrl_register_pins(pctldev, pctldesc->pins, pctldesc->npins);
1490         if (ret) {
1491                 dev_err(dev, "error during pin registration\n");
1492                 pinctrl_free_pindescs(pctldev, pctldesc->pins,
1493                                       pctldesc->npins);
1494                 goto out_err;
1495         }
1496
1497         mutex_lock(&pinctrl_mutex);
1498
1499         list_add_tail(&pctldev->node, &pinctrldev_list);
1500
1501         pctldev->p = pinctrl_get_locked(pctldev->dev);
1502         if (!IS_ERR(pctldev->p)) {
1503                 struct pinctrl_state *s =
1504                         pinctrl_lookup_state_locked(pctldev->p,
1505                                                     PINCTRL_STATE_DEFAULT);
1506                 if (IS_ERR(s)) {
1507                         dev_dbg(dev, "failed to lookup the default state\n");
1508                 } else {
1509                         if (pinctrl_select_state_locked(pctldev->p, s))
1510                                 dev_err(dev,
1511                                         "failed to select default state\n");
1512                 }
1513         }
1514
1515         mutex_unlock(&pinctrl_mutex);
1516
1517         pinctrl_init_device_debugfs(pctldev);
1518
1519         return pctldev;
1520
1521 out_err:
1522         kfree(pctldev);
1523         return NULL;
1524 }
1525 EXPORT_SYMBOL_GPL(pinctrl_register);
1526
1527 /**
1528  * pinctrl_unregister() - unregister pinmux
1529  * @pctldev: pin controller to unregister
1530  *
1531  * Called by pinmux drivers to unregister a pinmux.
1532  */
1533 void pinctrl_unregister(struct pinctrl_dev *pctldev)
1534 {
1535         struct pinctrl_gpio_range *range, *n;
1536         if (pctldev == NULL)
1537                 return;
1538
1539         pinctrl_remove_device_debugfs(pctldev);
1540
1541         mutex_lock(&pinctrl_mutex);
1542
1543         if (!IS_ERR(pctldev->p))
1544                 pinctrl_put_locked(pctldev->p, true);
1545
1546         /* TODO: check that no pinmuxes are still active? */
1547         list_del(&pctldev->node);
1548         /* Destroy descriptor tree */
1549         pinctrl_free_pindescs(pctldev, pctldev->desc->pins,
1550                               pctldev->desc->npins);
1551         /* remove gpio ranges map */
1552         list_for_each_entry_safe(range, n, &pctldev->gpio_ranges, node)
1553                 list_del(&range->node);
1554
1555         kfree(pctldev);
1556
1557         mutex_unlock(&pinctrl_mutex);
1558 }
1559 EXPORT_SYMBOL_GPL(pinctrl_unregister);
1560
1561 static int __init pinctrl_init(void)
1562 {
1563         pr_info("initialized pinctrl subsystem\n");
1564         pinctrl_init_debugfs();
1565         return 0;
1566 }
1567
1568 /* init early since many drivers really need to initialized pinmux early */
1569 core_initcall(pinctrl_init);