drivers/pinctrl/pinmux.c

   1 /*
   2  * Core driver for the pin muxing portions of 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) "pinmux core: " fmt
  15
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18 #include <linux/init.h>
  19 #include <linux/device.h>
  20 #include <linux/slab.h>
  21 #include <linux/radix-tree.h>
  22 #include <linux/err.h>
  23 #include <linux/list.h>
  24 #include <linux/string.h>
  25 #include <linux/sysfs.h>
  26 #include <linux/debugfs.h>
  27 #include <linux/seq_file.h>
  28 #include <linux/pinctrl/machine.h>
  29 #include <linux/pinctrl/pinmux.h>
  30 #include "core.h"
  31 #include "pinmux.h"
  32
  33 int pinmux_check_ops(struct pinctrl_dev *pctldev)
  34 {
  35         const struct pinmux_ops *ops = pctldev->desc->pmxops;
  36         unsigned nfuncs;
  37         unsigned selector = 0;
  38
  39         /* Check that we implement required operations */
  40         if (!ops ||
  41             !ops->get_functions_count ||
  42             !ops->get_function_name ||
  43             !ops->get_function_groups ||
  44             !ops->enable ||
  45             !ops->disable) {
  46                 dev_err(pctldev->dev, "pinmux ops lacks necessary functions\n");
  47                 return -EINVAL;
  48         }
  49         /* Check that all functions registered have names */
  50         nfuncs = ops->get_functions_count(pctldev);
  51         while (selector < nfuncs) {
  52                 const char *fname = ops->get_function_name(pctldev,
  53                                                            selector);
  54                 if (!fname) {
  55                         dev_err(pctldev->dev, "pinmux ops has no name for function%u\n",
  56                                 selector);
  57                         return -EINVAL;
  58                 }
  59                 selector++;
  60         }
  61
  62         return 0;
  63 }
  64
  65 int pinmux_validate_map(struct pinctrl_map const *map, int i)
  66 {
  67         if (!map->data.mux.function) {
  68                 pr_err("failed to register map %s (%d): no function given\n",
  69                        map->name, i);
  70                 return -EINVAL;
  71         }
  72
  73         return 0;
  74 }
  75
  76 /**
  77  * pin_request() - request a single pin to be muxed in, typically for GPIO
  78  * @pin: the pin number in the global pin space
  79  * @owner: a representation of the owner of this pin; typically the device
  80  *      name that controls its mux function, or the requested GPIO name
  81  * @gpio_range: the range matching the GPIO pin if this is a request for a
  82  *      single GPIO pin
  83  */
  84 static int pin_request(struct pinctrl_dev *pctldev,
  85                        int pin, const char *owner,
  86                        struct pinctrl_gpio_range *gpio_range)
  87 {
  88         struct pin_desc *desc;
  89         const struct pinmux_ops *ops = pctldev->desc->pmxops;
  90         int status = -EINVAL;
  91
  92         desc = pin_desc_get(pctldev, pin);
  93         if (desc == NULL) {
  94                 dev_err(pctldev->dev,
  95                         "pin %d is not registered so it cannot be requested\n",
  96                         pin);
  97                 goto out;
  98         }
  99
 100         dev_dbg(pctldev->dev, "request pin %d (%s) for %s\n",
 101                 pin, desc->name, owner);
 102
 103         if (gpio_range) {
 104                 /* There's no need to support multiple GPIO requests */
 105                 if (desc->gpio_owner) {
 106                         dev_err(pctldev->dev,
 107                                 "pin %s already requested by %s; cannot claim for %s\n",
 108                                 desc->name, desc->gpio_owner, owner);
 109                         goto out;
 110                 }
 111
 112                 desc->gpio_owner = owner;
 113         } else {
 114                 if (desc->mux_usecount && strcmp(desc->mux_owner, owner)) {
 115                         dev_err(pctldev->dev,
 116                                 "pin %s already requested by %s; cannot claim for %s\n",
 117                                 desc->name, desc->mux_owner, owner);
 118                         goto out;
 119                 }
 120
 121                 desc->mux_usecount++;
 122                 if (desc->mux_usecount > 1)
 123                         return 0;
 124
 125                 desc->mux_owner = owner;
 126         }
 127
 128         /* Let each pin increase references to this module */
 129         if (!try_module_get(pctldev->owner)) {
 130                 dev_err(pctldev->dev,
 131                         "could not increase module refcount for pin %d\n",
 132                         pin);
 133                 status = -EINVAL;
 134                 goto out_free_pin;
 135         }
 136
 137         /*
 138          * If there is no kind of request function for the pin we just assume
 139          * we got it by default and proceed.
 140          */
 141         if (gpio_range && ops->gpio_request_enable)
 142                 /* This requests and enables a single GPIO pin */
 143                 status = ops->gpio_request_enable(pctldev, gpio_range, pin);
 144         else if (ops->request)
 145                 status = ops->request(pctldev, pin);
 146         else
 147                 status = 0;
 148
 149         if (status) {
 150                 dev_err(pctldev->dev, "request() failed for pin %d\n", pin);
 151                 module_put(pctldev->owner);
 152         }
 153
 154 out_free_pin:
 155         if (status) {
 156                 if (gpio_range) {
 157                         desc->gpio_owner = NULL;
 158                 } else {
 159                         desc->mux_usecount--;
 160                         if (!desc->mux_usecount)
 161                                 desc->mux_owner = NULL;
 162                 }
 163         }
 164 out:
 165         if (status)
 166                 dev_err(pctldev->dev, "pin-%d (%s) status %d\n",
 167                         pin, owner, status);
 168
 169         return status;
 170 }
 171
 172 /**
 173  * pin_free() - release a single muxed in pin so something else can be muxed
 174  * @pctldev: pin controller device handling this pin
 175  * @pin: the pin to free
 176  * @gpio_range: the range matching the GPIO pin if this is a request for a
 177  *      single GPIO pin
 178  *
 179  * This function returns a pointer to the previous owner. This is used
 180  * for callers that dynamically allocate an owner name so it can be freed
 181  * once the pin is free. This is done for GPIO request functions.
 182  */
 183 static const char *pin_free(struct pinctrl_dev *pctldev, int pin,
 184                             struct pinctrl_gpio_range *gpio_range)
 185 {
 186         const struct pinmux_ops *ops = pctldev->desc->pmxops;
 187         struct pin_desc *desc;
 188         const char *owner;
 189
 190         desc = pin_desc_get(pctldev, pin);
 191         if (desc == NULL) {
 192                 dev_err(pctldev->dev,
 193                         "pin is not registered so it cannot be freed\n");
 194                 return NULL;
 195         }
 196
 197         if (!gpio_range) {
 198                 desc->mux_usecount--;
 199                 if (desc->mux_usecount)
 200                         return NULL;
 201         }
 202
 203         /*
 204          * If there is no kind of request function for the pin we just assume
 205          * we got it by default and proceed.
 206          */
 207         if (gpio_range && ops->gpio_disable_free)
 208                 ops->gpio_disable_free(pctldev, gpio_range, pin);
 209         else if (ops->free)
 210                 ops->free(pctldev, pin);
 211
 212         if (gpio_range) {
 213                 owner = desc->gpio_owner;
 214                 desc->gpio_owner = NULL;
 215         } else {
 216                 owner = desc->mux_owner;
 217                 desc->mux_owner = NULL;
 218                 desc->mux_setting = NULL;
 219         }
 220
 221         module_put(pctldev->owner);
 222
 223         return owner;
 224 }
 225
 226 /**
 227  * pinmux_request_gpio() - request pinmuxing for a GPIO pin
 228  * @pctldev: pin controller device affected
 229  * @pin: the pin to mux in for GPIO
 230  * @range: the applicable GPIO range
 231  */
 232 int pinmux_request_gpio(struct pinctrl_dev *pctldev,
 233                         struct pinctrl_gpio_range *range,
 234                         unsigned pin, unsigned gpio)
 235 {
 236         char gpiostr[16];
 237         const char *owner;
 238         int ret;
 239
 240         /* Conjure some name stating what chip and pin this is taken by */
 241         snprintf(gpiostr, 15, "%s:%d", range->name, gpio);
 242
 243         owner = kstrdup(gpiostr, GFP_KERNEL);
 244         if (!owner)
 245                 return -EINVAL;
 246
 247         ret = pin_request(pctldev, pin, owner, range);
 248         if (ret < 0)
 249                 kfree(owner);
 250
 251         return ret;
 252 }
 253
 254 /**
 255  * pinmux_free_gpio() - release a pin from GPIO muxing
 256  * @pctldev: the pin controller device for the pin
 257  * @pin: the affected currently GPIO-muxed in pin
 258  * @range: applicable GPIO range
 259  */
 260 void pinmux_free_gpio(struct pinctrl_dev *pctldev, unsigned pin,
 261                       struct pinctrl_gpio_range *range)
 262 {
 263         const char *owner;
 264
 265         owner = pin_free(pctldev, pin, range);
 266         kfree(owner);
 267 }
 268
 269 /**
 270  * pinmux_gpio_direction() - set the direction of a single muxed-in GPIO pin
 271  * @pctldev: the pin controller handling this pin
 272  * @range: applicable GPIO range
 273  * @pin: the affected GPIO pin in this controller
 274  * @input: true if we set the pin as input, false for output
 275  */
 276 int pinmux_gpio_direction(struct pinctrl_dev *pctldev,
 277                           struct pinctrl_gpio_range *range,
 278                           unsigned pin, bool input)
 279 {
 280         const struct pinmux_ops *ops;
 281         int ret;
 282
 283         ops = pctldev->desc->pmxops;
 284
 285         if (ops->gpio_set_direction)
 286                 ret = ops->gpio_set_direction(pctldev, range, pin, input);
 287         else
 288                 ret = 0;
 289
 290         return ret;
 291 }
 292
 293 static int pinmux_func_name_to_selector(struct pinctrl_dev *pctldev,
 294                                         const char *function)
 295 {
 296         const struct pinmux_ops *ops = pctldev->desc->pmxops;
 297         unsigned nfuncs = ops->get_functions_count(pctldev);
 298         unsigned selector = 0;
 299
 300         /* See if this pctldev has this function */
 301         while (selector < nfuncs) {
 302                 const char *fname = ops->get_function_name(pctldev,
 303                                                            selector);
 304
 305                 if (!strcmp(function, fname))
 306                         return selector;
 307
 308                 selector++;
 309         }
 310
 311         pr_err("%s does not support function %s\n",
 312                pinctrl_dev_get_name(pctldev), function);
 313         return -EINVAL;
 314 }
 315
 316 int pinmux_map_to_setting(struct pinctrl_map const *map,
 317                           struct pinctrl_setting *setting)
 318 {
 319         struct pinctrl_dev *pctldev = setting->pctldev;
 320         const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
 321         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 322         char const * const *groups;
 323         unsigned num_groups;
 324         int ret;
 325         const char *group;
 326         int i;
 327         const unsigned *pins;
 328         unsigned num_pins;
 329
 330         if (!pmxops) {
 331                 dev_err(pctldev->dev, "does not support mux function\n");
 332                 return -EINVAL;
 333         }
 334
 335         ret = pinmux_func_name_to_selector(pctldev, map->data.mux.function);
 336         if (ret < 0) {
 337                 dev_err(pctldev->dev, "invalid function %s in map table\n",
 338                         map->data.mux.function);
 339                 return ret;
 340         }
 341         setting->data.mux.func = ret;
 342
 343         ret = pmxops->get_function_groups(pctldev, setting->data.mux.func,
 344                                           &groups, &num_groups);
 345         if (ret < 0) {
 346                 dev_err(pctldev->dev, "can't query groups for function %s\n",
 347                         map->data.mux.function);
 348                 return ret;
 349         }
 350         if (!num_groups) {
 351                 dev_err(pctldev->dev,
 352                         "function %s can't be selected on any group\n",
 353                         map->data.mux.function);
 354                 return -EINVAL;
 355         }
 356         if (map->data.mux.group) {
 357                 bool found = false;
 358                 group = map->data.mux.group;
 359                 for (i = 0; i < num_groups; i++) {
 360                         if (!strcmp(group, groups[i])) {
 361                                 found = true;
 362                                 break;
 363                         }
 364                 }
 365                 if (!found) {
 366                         dev_err(pctldev->dev,
 367                                 "invalid group \"%s\" for function \"%s\"\n",
 368                                 group, map->data.mux.function);
 369                         return -EINVAL;
 370                 }
 371         } else {
 372                 group = groups[0];
 373         }
 374
 375         ret = pinctrl_get_group_selector(pctldev, group);
 376         if (ret < 0) {
 377                 dev_err(pctldev->dev, "invalid group %s in map table\n",
 378                         map->data.mux.group);
 379                 return ret;
 380         }
 381         setting->data.mux.group = ret;
 382
 383         ret = pctlops->get_group_pins(pctldev, setting->data.mux.group, &pins,
 384                                       &num_pins);
 385         if (ret) {
 386                 dev_err(pctldev->dev,
 387                         "could not get pins for device %s group selector %d\n",
 388                         pinctrl_dev_get_name(pctldev), setting->data.mux.group);
 389                         return -ENODEV;
 390         }
 391
 392         /* Try to allocate all pins in this group, one by one */
 393         for (i = 0; i < num_pins; i++) {
 394                 ret = pin_request(pctldev, pins[i], map->dev_name, NULL);
 395                 if (ret) {
 396                         dev_err(pctldev->dev,
 397                                 "could not request pin %d on device %s\n",
 398                                 pins[i], pinctrl_dev_get_name(pctldev));
 399                         /* On error release all taken pins */
 400                         i--; /* this pin just failed */
 401                         for (; i >= 0; i--)
 402                                 pin_free(pctldev, pins[i], NULL);
 403                         return -ENODEV;
 404                 }
 405         }
 406
 407         return 0;
 408 }
 409
 410 void pinmux_free_setting(struct pinctrl_setting const *setting)
 411 {
 412         struct pinctrl_dev *pctldev = setting->pctldev;
 413         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 414         const unsigned *pins;
 415         unsigned num_pins;
 416         int ret;
 417         int i;
 418
 419         ret = pctlops->get_group_pins(pctldev, setting->data.mux.group,
 420                                       &pins, &num_pins);
 421         if (ret) {
 422                 dev_err(pctldev->dev,
 423                         "could not get pins for device %s group selector %d\n",
 424                         pinctrl_dev_get_name(pctldev), setting->data.mux.group);
 425                 return;
 426         }
 427
 428         for (i = 0; i < num_pins; i++)
 429                 pin_free(pctldev, pins[i], NULL);
 430 }
 431
 432 int pinmux_enable_setting(struct pinctrl_setting const *setting)
 433 {
 434         struct pinctrl_dev *pctldev = setting->pctldev;
 435         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 436         const struct pinmux_ops *ops = pctldev->desc->pmxops;
 437         int ret;
 438         const unsigned *pins;
 439         unsigned num_pins;
 440         int i;
 441         struct pin_desc *desc;
 442
 443         ret = pctlops->get_group_pins(pctldev, setting->data.mux.group,
 444                                       &pins, &num_pins);
 445         if (ret) {
 446                 /* errors only affect debug data, so just warn */
 447                 dev_warn(pctldev->dev,
 448                          "could not get pins for group selector %d\n",
 449                          setting->data.mux.group);
 450                 num_pins = 0;
 451         }
 452
 453         for (i = 0; i < num_pins; i++) {
 454                 desc = pin_desc_get(pctldev, pins[i]);
 455                 if (desc == NULL) {
 456                         dev_warn(pctldev->dev,
 457                                  "could not get pin desc for pin %d\n",
 458                                  pins[i]);
 459                         continue;
 460                 }
 461                 desc->mux_setting = &(setting->data.mux);
 462         }
 463
 464         return ops->enable(pctldev, setting->data.mux.func,
 465                            setting->data.mux.group);
 466 }
 467
 468 void pinmux_disable_setting(struct pinctrl_setting const *setting)
 469 {
 470         struct pinctrl_dev *pctldev = setting->pctldev;
 471         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 472         const struct pinmux_ops *ops = pctldev->desc->pmxops;
 473         int ret;
 474         const unsigned *pins;
 475         unsigned num_pins;
 476         int i;
 477         struct pin_desc *desc;
 478
 479         ret = pctlops->get_group_pins(pctldev, setting->data.mux.group,
 480                                       &pins, &num_pins);
 481         if (ret) {
 482                 /* errors only affect debug data, so just warn */
 483                 dev_warn(pctldev->dev,
 484                          "could not get pins for group selector %d\n",
 485                          setting->data.mux.group);
 486                 num_pins = 0;
 487         }
 488
 489         for (i = 0; i < num_pins; i++) {
 490                 desc = pin_desc_get(pctldev, pins[i]);
 491                 if (desc == NULL) {
 492                         dev_warn(pctldev->dev,
 493                                  "could not get pin desc for pin %d\n",
 494                                  pins[i]);
 495                         continue;
 496                 }
 497                 desc->mux_setting = NULL;
 498         }
 499
 500         ops->disable(pctldev, setting->data.mux.func, setting->data.mux.group);
 501 }
 502
 503 #ifdef CONFIG_DEBUG_FS
 504
 505 /* Called from pincontrol core */
 506 static int pinmux_functions_show(struct seq_file *s, void *what)
 507 {
 508         struct pinctrl_dev *pctldev = s->private;
 509         const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
 510         unsigned nfuncs;
 511         unsigned func_selector = 0;
 512
 513         if (!pmxops)
 514                 return 0;
 515
 516         mutex_lock(&pinctrl_mutex);
 517         nfuncs = pmxops->get_functions_count(pctldev);
 518         while (func_selector < nfuncs) {
 519                 const char *func = pmxops->get_function_name(pctldev,
 520                                                           func_selector);
 521                 const char * const *groups;
 522                 unsigned num_groups;
 523                 int ret;
 524                 int i;
 525
 526                 ret = pmxops->get_function_groups(pctldev, func_selector,
 527                                                   &groups, &num_groups);
 528                 if (ret)
 529                         seq_printf(s, "function %s: COULD NOT GET GROUPS\n",
 530                                    func);
 531
 532                 seq_printf(s, "function: %s, groups = [ ", func);
 533                 for (i = 0; i < num_groups; i++)
 534                         seq_printf(s, "%s ", groups[i]);
 535                 seq_puts(s, "]\n");
 536
 537                 func_selector++;
 538         }
 539
 540         mutex_unlock(&pinctrl_mutex);
 541
 542         return 0;
 543 }
 544
 545 static int pinmux_pins_show(struct seq_file *s, void *what)
 546 {
 547         struct pinctrl_dev *pctldev = s->private;
 548         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 549         const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
 550         unsigned i, pin;
 551
 552         if (!pmxops)
 553                 return 0;
 554
 555         seq_puts(s, "Pinmux settings per pin\n");
 556         seq_puts(s, "Format: pin (name): mux_owner gpio_owner hog?\n");
 557
 558         mutex_lock(&pinctrl_mutex);
 559
 560         /* The pin number can be retrived from the pin controller descriptor */
 561         for (i = 0; i < pctldev->desc->npins; i++) {
 562                 struct pin_desc *desc;
 563                 bool is_hog = false;
 564
 565                 pin = pctldev->desc->pins[i].number;
 566                 desc = pin_desc_get(pctldev, pin);
 567                 /* Skip if we cannot search the pin */
 568                 if (desc == NULL)
 569                         continue;
 570
 571                 if (desc->mux_owner &&
 572                     !strcmp(desc->mux_owner, pinctrl_dev_get_name(pctldev)))
 573                         is_hog = true;
 574
 575                 seq_printf(s, "pin %d (%s): %s %s%s", pin,
 576                            desc->name ? desc->name : "unnamed",
 577                            desc->mux_owner ? desc->mux_owner
 578                                 : "(MUX UNCLAIMED)",
 579                            desc->gpio_owner ? desc->gpio_owner
 580                                 : "(GPIO UNCLAIMED)",
 581                            is_hog ? " (HOG)" : "");
 582
 583                 if (desc->mux_setting)
 584                         seq_printf(s, " function %s group %s\n",
 585                                    pmxops->get_function_name(pctldev,
 586                                         desc->mux_setting->func),
 587                                    pctlops->get_group_name(pctldev,
 588                                         desc->mux_setting->group));
 589                 else
 590                         seq_printf(s, "\n");
 591         }
 592
 593         mutex_unlock(&pinctrl_mutex);
 594
 595         return 0;
 596 }
 597
 598 void pinmux_show_map(struct seq_file *s, struct pinctrl_map const *map)
 599 {
 600         seq_printf(s, "group %s\nfunction %s\n",
 601                 map->data.mux.group ? map->data.mux.group : "(default)",
 602                 map->data.mux.function);
 603 }
 604
 605 void pinmux_show_setting(struct seq_file *s,
 606                          struct pinctrl_setting const *setting)
 607 {
 608         struct pinctrl_dev *pctldev = setting->pctldev;
 609         const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
 610         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 611
 612         seq_printf(s, "group: %s (%u) function: %s (%u)\n",
 613                    pctlops->get_group_name(pctldev, setting->data.mux.group),
 614                    setting->data.mux.group,
 615                    pmxops->get_function_name(pctldev, setting->data.mux.func),
 616                    setting->data.mux.func);
 617 }
 618
 619 static int pinmux_functions_open(struct inode *inode, struct file *file)
 620 {
 621         return single_open(file, pinmux_functions_show, inode->i_private);
 622 }
 623
 624 static int pinmux_pins_open(struct inode *inode, struct file *file)
 625 {
 626         return single_open(file, pinmux_pins_show, inode->i_private);
 627 }
 628
 629 static const struct file_operations pinmux_functions_ops = {
 630         .open           = pinmux_functions_open,
 631         .read           = seq_read,
 632         .llseek         = seq_lseek,
 633         .release        = single_release,
 634 };
 635
 636 static const struct file_operations pinmux_pins_ops = {
 637         .open           = pinmux_pins_open,
 638         .read           = seq_read,
 639         .llseek         = seq_lseek,
 640         .release        = single_release,
 641 };
 642
 643 void pinmux_init_device_debugfs(struct dentry *devroot,
 644                          struct pinctrl_dev *pctldev)
 645 {
 646         debugfs_create_file("pinmux-functions", S_IFREG | S_IRUGO,
 647                             devroot, pctldev, &pinmux_functions_ops);
 648         debugfs_create_file("pinmux-pins", S_IFREG | S_IRUGO,
 649                             devroot, pctldev, &pinmux_pins_ops);
 650 }
 651
 652 #endif /* CONFIG_DEBUG_FS */