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