drivers/pinctrl/pinconf.c

   1 /*
   2  * Core driver for the pin config portions of the pin control subsystem
   3  *
   4  * Copyright (C) 2011 ST-Ericsson SA
   5  * Written on behalf of Linaro for ST-Ericsson
   6  *
   7  * Author: Linus Walleij <linus.walleij@linaro.org>
   8  *
   9  * License terms: GNU General Public License (GPL) version 2
  10  */
  11 #define pr_fmt(fmt) "pinconfig core: " fmt
  12
  13 #include <linux/kernel.h>
  14 #include <linux/module.h>
  15 #include <linux/init.h>
  16 #include <linux/device.h>
  17 #include <linux/slab.h>
  18 #include <linux/debugfs.h>
  19 #include <linux/seq_file.h>
  20 #include <linux/uaccess.h>
  21 #include <linux/pinctrl/machine.h>
  22 #include <linux/pinctrl/pinctrl.h>
  23 #include <linux/pinctrl/pinconf.h>
  24 #include "core.h"
  25 #include "pinconf.h"
  26
  27 int pinconf_check_ops(struct pinctrl_dev *pctldev)
  28 {
  29         const struct pinconf_ops *ops = pctldev->desc->confops;
  30
  31         /* We have to be able to config the pins in SOME way */
  32         if (!ops->pin_config_set && !ops->pin_config_group_set) {
  33                 dev_err(pctldev->dev,
  34                         "pinconf has to be able to set a pins config\n");
  35                 return -EINVAL;
  36         }
  37         return 0;
  38 }
  39
  40 int pinconf_validate_map(struct pinctrl_map const *map, int i)
  41 {
  42         if (!map->data.configs.group_or_pin) {
  43                 pr_err("failed to register map %s (%d): no group/pin given\n",
  44                        map->name, i);
  45                 return -EINVAL;
  46         }
  47
  48         if (!map->data.configs.num_configs ||
  49                         !map->data.configs.configs) {
  50                 pr_err("failed to register map %s (%d): no configs given\n",
  51                        map->name, i);
  52                 return -EINVAL;
  53         }
  54
  55         return 0;
  56 }
  57
  58 int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
  59                            unsigned long *config)
  60 {
  61         const struct pinconf_ops *ops = pctldev->desc->confops;
  62
  63         if (!ops || !ops->pin_config_get) {
  64                 dev_dbg(pctldev->dev, "cannot get pin configuration, missing "
  65                         "pin_config_get() function in driver\n");
  66                 return -ENOTSUPP;
  67         }
  68
  69         return ops->pin_config_get(pctldev, pin, config);
  70 }
  71
  72 int pin_config_group_get(const char *dev_name, const char *pin_group,
  73                          unsigned long *config)
  74 {
  75         struct pinctrl_dev *pctldev;
  76         const struct pinconf_ops *ops;
  77         int selector, ret;
  78
  79         pctldev = get_pinctrl_dev_from_devname(dev_name);
  80         if (!pctldev) {
  81                 ret = -EINVAL;
  82                 return ret;
  83         }
  84
  85         mutex_lock(&pctldev->mutex);
  86
  87         ops = pctldev->desc->confops;
  88
  89         if (!ops || !ops->pin_config_group_get) {
  90                 dev_dbg(pctldev->dev, "cannot get configuration for pin "
  91                         "group, missing group config get function in "
  92                         "driver\n");
  93                 ret = -ENOTSUPP;
  94                 goto unlock;
  95         }
  96
  97         selector = pinctrl_get_group_selector(pctldev, pin_group);
  98         if (selector < 0) {
  99                 ret = selector;
 100                 goto unlock;
 101         }
 102
 103         ret = ops->pin_config_group_get(pctldev, selector, config);
 104
 105 unlock:
 106         mutex_unlock(&pctldev->mutex);
 107         return ret;
 108 }
 109
 110 int pinconf_map_to_setting(struct pinctrl_map const *map,
 111                           struct pinctrl_setting *setting)
 112 {
 113         struct pinctrl_dev *pctldev = setting->pctldev;
 114         int pin;
 115
 116         switch (setting->type) {
 117         case PIN_MAP_TYPE_CONFIGS_PIN:
 118                 pin = pin_get_from_name(pctldev,
 119                                         map->data.configs.group_or_pin);
 120                 if (pin < 0) {
 121                         dev_err(pctldev->dev, "could not map pin config for \"%s\"",
 122                                 map->data.configs.group_or_pin);
 123                         return pin;
 124                 }
 125                 setting->data.configs.group_or_pin = pin;
 126                 break;
 127         case PIN_MAP_TYPE_CONFIGS_GROUP:
 128                 pin = pinctrl_get_group_selector(pctldev,
 129                                          map->data.configs.group_or_pin);
 130                 if (pin < 0) {
 131                         dev_err(pctldev->dev, "could not map group config for \"%s\"",
 132                                 map->data.configs.group_or_pin);
 133                         return pin;
 134                 }
 135                 setting->data.configs.group_or_pin = pin;
 136                 break;
 137         default:
 138                 return -EINVAL;
 139         }
 140
 141         setting->data.configs.num_configs = map->data.configs.num_configs;
 142         setting->data.configs.configs = map->data.configs.configs;
 143
 144         return 0;
 145 }
 146
 147 void pinconf_free_setting(struct pinctrl_setting const *setting)
 148 {
 149 }
 150
 151 int pinconf_apply_setting(struct pinctrl_setting const *setting)
 152 {
 153         struct pinctrl_dev *pctldev = setting->pctldev;
 154         const struct pinconf_ops *ops = pctldev->desc->confops;
 155         int ret;
 156
 157         if (!ops) {
 158                 dev_err(pctldev->dev, "missing confops\n");
 159                 return -EINVAL;
 160         }
 161
 162         switch (setting->type) {
 163         case PIN_MAP_TYPE_CONFIGS_PIN:
 164                 if (!ops->pin_config_set) {
 165                         dev_err(pctldev->dev, "missing pin_config_set op\n");
 166                         return -EINVAL;
 167                 }
 168                 ret = ops->pin_config_set(pctldev,
 169                                 setting->data.configs.group_or_pin,
 170                                 setting->data.configs.configs,
 171                                 setting->data.configs.num_configs);
 172                 if (ret < 0) {
 173                         dev_err(pctldev->dev,
 174                                 "pin_config_set op failed for pin %d\n",
 175                                 setting->data.configs.group_or_pin);
 176                         return ret;
 177                 }
 178                 break;
 179         case PIN_MAP_TYPE_CONFIGS_GROUP:
 180                 if (!ops->pin_config_group_set) {
 181                         dev_err(pctldev->dev,
 182                                 "missing pin_config_group_set op\n");
 183                         return -EINVAL;
 184                 }
 185                 ret = ops->pin_config_group_set(pctldev,
 186                                 setting->data.configs.group_or_pin,
 187                                 setting->data.configs.configs,
 188                                 setting->data.configs.num_configs);
 189                 if (ret < 0) {
 190                         dev_err(pctldev->dev,
 191                                 "pin_config_group_set op failed for group %d\n",
 192                                 setting->data.configs.group_or_pin);
 193                         return ret;
 194                 }
 195                 break;
 196         default:
 197                 return -EINVAL;
 198         }
 199
 200         return 0;
 201 }
 202
 203 #ifdef CONFIG_DEBUG_FS
 204
 205 void pinconf_show_map(struct seq_file *s, struct pinctrl_map const *map)
 206 {
 207         struct pinctrl_dev *pctldev;
 208         const struct pinconf_ops *confops;
 209         int i;
 210
 211         pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
 212         if (pctldev)
 213                 confops = pctldev->desc->confops;
 214         else
 215                 confops = NULL;
 216
 217         switch (map->type) {
 218         case PIN_MAP_TYPE_CONFIGS_PIN:
 219                 seq_printf(s, "pin ");
 220                 break;
 221         case PIN_MAP_TYPE_CONFIGS_GROUP:
 222                 seq_printf(s, "group ");
 223                 break;
 224         default:
 225                 break;
 226         }
 227
 228         seq_printf(s, "%s\n", map->data.configs.group_or_pin);
 229
 230         for (i = 0; i < map->data.configs.num_configs; i++) {
 231                 seq_printf(s, "config ");
 232                 if (confops && confops->pin_config_config_dbg_show)
 233                         confops->pin_config_config_dbg_show(pctldev, s,
 234                                                 map->data.configs.configs[i]);
 235                 else
 236                         seq_printf(s, "%08lx", map->data.configs.configs[i]);
 237                 seq_printf(s, "\n");
 238         }
 239 }
 240
 241 void pinconf_show_setting(struct seq_file *s,
 242                           struct pinctrl_setting const *setting)
 243 {
 244         struct pinctrl_dev *pctldev = setting->pctldev;
 245         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 246         const struct pinconf_ops *confops = pctldev->desc->confops;
 247         struct pin_desc *desc;
 248         int i;
 249
 250         switch (setting->type) {
 251         case PIN_MAP_TYPE_CONFIGS_PIN:
 252                 desc = pin_desc_get(setting->pctldev,
 253                                     setting->data.configs.group_or_pin);
 254                 seq_printf(s, "pin %s (%d)",
 255                            desc->name ? desc->name : "unnamed",
 256                            setting->data.configs.group_or_pin);
 257                 break;
 258         case PIN_MAP_TYPE_CONFIGS_GROUP:
 259                 seq_printf(s, "group %s (%d)",
 260                            pctlops->get_group_name(pctldev,
 261                                         setting->data.configs.group_or_pin),
 262                            setting->data.configs.group_or_pin);
 263                 break;
 264         default:
 265                 break;
 266         }
 267
 268         /*
 269          * FIXME: We should really get the pin controler to dump the config
 270          * values, so they can be decoded to something meaningful.
 271          */
 272         for (i = 0; i < setting->data.configs.num_configs; i++) {
 273                 seq_printf(s, " ");
 274                 if (confops && confops->pin_config_config_dbg_show)
 275                         confops->pin_config_config_dbg_show(pctldev, s,
 276                                 setting->data.configs.configs[i]);
 277                 else
 278                         seq_printf(s, "%08lx",
 279                                    setting->data.configs.configs[i]);
 280         }
 281
 282         seq_printf(s, "\n");
 283 }
 284
 285 static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
 286                              struct seq_file *s, int pin)
 287 {
 288         const struct pinconf_ops *ops = pctldev->desc->confops;
 289
 290         /* no-op when not using generic pin config */
 291         pinconf_generic_dump_pin(pctldev, s, pin);
 292         if (ops && ops->pin_config_dbg_show)
 293                 ops->pin_config_dbg_show(pctldev, s, pin);
 294 }
 295
 296 static int pinconf_pins_show(struct seq_file *s, void *what)
 297 {
 298         struct pinctrl_dev *pctldev = s->private;
 299         const struct pinconf_ops *ops = pctldev->desc->confops;
 300         unsigned i, pin;
 301
 302         seq_puts(s, "Pin config settings per pin\n");
 303         seq_puts(s, "Format: pin (name): configs\n");
 304
 305         mutex_lock(&pctldev->mutex);
 306
 307         /* The pin number can be retrived from the pin controller descriptor */
 308         for (i = 0; i < pctldev->desc->npins; i++) {
 309                 struct pin_desc *desc;
 310
 311                 pin = pctldev->desc->pins[i].number;
 312                 desc = pin_desc_get(pctldev, pin);
 313                 /* Skip if we cannot search the pin */
 314                 if (desc == NULL)
 315                         continue;
 316
 317                 seq_printf(s, "pin %d (%s):", pin,
 318                            desc->name ? desc->name : "unnamed");
 319
 320                 pinconf_dump_pin(pctldev, s, pin);
 321
 322                 seq_printf(s, "\n");
 323         }
 324
 325         mutex_unlock(&pctldev->mutex);
 326
 327         return 0;
 328 }
 329
 330 static void pinconf_dump_group(struct pinctrl_dev *pctldev,
 331                                struct seq_file *s, unsigned selector,
 332                                const char *gname)
 333 {
 334         const struct pinconf_ops *ops = pctldev->desc->confops;
 335
 336         /* no-op when not using generic pin config */
 337         pinconf_generic_dump_group(pctldev, s, gname);
 338         if (ops && ops->pin_config_group_dbg_show)
 339                 ops->pin_config_group_dbg_show(pctldev, s, selector);
 340 }
 341
 342 static int pinconf_groups_show(struct seq_file *s, void *what)
 343 {
 344         struct pinctrl_dev *pctldev = s->private;
 345         const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
 346         const struct pinconf_ops *ops = pctldev->desc->confops;
 347         unsigned ngroups = pctlops->get_groups_count(pctldev);
 348         unsigned selector = 0;
 349
 350         seq_puts(s, "Pin config settings per pin group\n");
 351         seq_puts(s, "Format: group (name): configs\n");
 352
 353         while (selector < ngroups) {
 354                 const char *gname = pctlops->get_group_name(pctldev, selector);
 355
 356                 seq_printf(s, "%u (%s):", selector, gname);
 357                 pinconf_dump_group(pctldev, s, selector, gname);
 358                 seq_printf(s, "\n");
 359
 360                 selector++;
 361         }
 362
 363         return 0;
 364 }
 365
 366 static int pinconf_pins_open(struct inode *inode, struct file *file)
 367 {
 368         return single_open(file, pinconf_pins_show, inode->i_private);
 369 }
 370
 371 static int pinconf_groups_open(struct inode *inode, struct file *file)
 372 {
 373         return single_open(file, pinconf_groups_show, inode->i_private);
 374 }
 375
 376 static const struct file_operations pinconf_pins_ops = {
 377         .open           = pinconf_pins_open,
 378         .read           = seq_read,
 379         .llseek         = seq_lseek,
 380         .release        = single_release,
 381 };
 382
 383 static const struct file_operations pinconf_groups_ops = {
 384         .open           = pinconf_groups_open,
 385         .read           = seq_read,
 386         .llseek         = seq_lseek,
 387         .release        = single_release,
 388 };
 389
 390 #define MAX_NAME_LEN 15
 391
 392 struct dbg_cfg {
 393         enum pinctrl_map_type map_type;
 394         char dev_name[MAX_NAME_LEN+1];
 395         char state_name[MAX_NAME_LEN+1];
 396         char pin_name[MAX_NAME_LEN+1];
 397 };
 398
 399 /*
 400  * Goal is to keep this structure as global in order to simply read the
 401  * pinconf-config file after a write to check config is as expected
 402  */
 403 static struct dbg_cfg pinconf_dbg_conf;
 404
 405 /**
 406  * pinconf_dbg_config_print() - display the pinctrl config from the pinctrl
 407  * map, of the dev/pin/state that was last written to pinconf-config file.
 408  * @s: string filled in  with config description
 409  * @d: not used
 410  */
 411 static int pinconf_dbg_config_print(struct seq_file *s, void *d)
 412 {
 413         struct pinctrl_maps *maps_node;
 414         const struct pinctrl_map *map;
 415         const struct pinctrl_map *found = NULL;
 416         struct pinctrl_dev *pctldev;
 417         const struct pinconf_ops *confops = NULL;
 418         struct dbg_cfg *dbg = &pinconf_dbg_conf;
 419         int i, j;
 420         unsigned long config;
 421
 422         mutex_lock(&pinctrl_maps_mutex);
 423
 424         /* Parse the pinctrl map and look for the elected pin/state */
 425         for_each_maps(maps_node, i, map) {
 426                 if (map->type != dbg->map_type)
 427                         continue;
 428                 if (strcmp(map->dev_name, dbg->dev_name))
 429                         continue;
 430                 if (strcmp(map->name, dbg->state_name))
 431                         continue;
 432
 433                 for (j = 0; j < map->data.configs.num_configs; j++) {
 434                         if (!strcmp(map->data.configs.group_or_pin,
 435                                         dbg->pin_name)) {
 436                                 /* We found the right pin / state */
 437                                 found = map;
 438                                 break;
 439                         }
 440                 }
 441         }
 442
 443         if (!found) {
 444                 seq_printf(s, "No config found for dev/state/pin, expected:\n");
 445                 seq_printf(s, "Searched dev:%s\n", dbg->dev_name);
 446                 seq_printf(s, "Searched state:%s\n", dbg->state_name);
 447                 seq_printf(s, "Searched pin:%s\n", dbg->pin_name);
 448                 seq_printf(s, "Use: modify config_pin <devname> "\
 449                                 "<state> <pinname> <value>\n");
 450                 goto exit;
 451         }
 452
 453         pctldev = get_pinctrl_dev_from_devname(found->ctrl_dev_name);
 454         config = *found->data.configs.configs;
 455         seq_printf(s, "Dev %s has config of %s in state %s: 0x%08lX\n",
 456                         dbg->dev_name, dbg->pin_name,
 457                         dbg->state_name, config);
 458
 459         if (pctldev)
 460                 confops = pctldev->desc->confops;
 461
 462         if (confops && confops->pin_config_config_dbg_show)
 463                 confops->pin_config_config_dbg_show(pctldev, s, config);
 464
 465 exit:
 466         mutex_unlock(&pinctrl_maps_mutex);
 467
 468         return 0;
 469 }
 470
 471 /**
 472  * pinconf_dbg_config_write() - modify the pinctrl config in the pinctrl
 473  * map, of a dev/pin/state entry based on user entries to pinconf-config
 474  * @user_buf: contains the modification request with expected format:
 475  *     modify config_pin <devicename> <state> <pinname> <newvalue>
 476  * modify is literal string, alternatives like add/delete not supported yet
 477  * config_pin is literal, alternatives like config_mux not supported yet
 478  * <devicename> <state> <pinname> are values that should match the pinctrl-maps
 479  * <newvalue> reflects the new config and is driver dependant
 480  */
 481 static ssize_t pinconf_dbg_config_write(struct file *file,
 482         const char __user *user_buf, size_t count, loff_t *ppos)
 483 {
 484         struct pinctrl_maps *maps_node;
 485         const struct pinctrl_map *map;
 486         const struct pinctrl_map *found = NULL;
 487         struct pinctrl_dev *pctldev;
 488         const struct pinconf_ops *confops = NULL;
 489         struct dbg_cfg *dbg = &pinconf_dbg_conf;
 490         const struct pinctrl_map_configs *configs;
 491         char config[MAX_NAME_LEN+1];
 492         char buf[128];
 493         char *b = &buf[0];
 494         int buf_size;
 495         char *token;
 496         int i;
 497
 498         /* Get userspace string and assure termination */
 499         buf_size = min(count, sizeof(buf) - 1);
 500         if (copy_from_user(buf, user_buf, buf_size))
 501                 return -EFAULT;
 502         buf[buf_size] = 0;
 503
 504         /*
 505          * need to parse entry and extract parameters:
 506          * modify configs_pin devicename state pinname newvalue
 507          */
 508
 509         /* Get arg: 'modify' */
 510         token = strsep(&b, " ");
 511         if (!token)
 512                 return -EINVAL;
 513         if (strcmp(token, "modify"))
 514                 return -EINVAL;
 515
 516         /* Get arg type: "config_pin" type supported so far */
 517         token = strsep(&b, " ");
 518         if (!token)
 519                 return -EINVAL;
 520         if (strcmp(token, "config_pin"))
 521                 return -EINVAL;
 522         dbg->map_type = PIN_MAP_TYPE_CONFIGS_PIN;
 523
 524         /* get arg 'device_name' */
 525         token = strsep(&b, " ");
 526         if (token == NULL)
 527                 return -EINVAL;
 528         if (strlen(token) >= MAX_NAME_LEN)
 529                 return -EINVAL;
 530         strncpy(dbg->dev_name, token, MAX_NAME_LEN);
 531
 532         /* get arg 'state_name' */
 533         token = strsep(&b, " ");
 534         if (token == NULL)
 535                 return -EINVAL;
 536         if (strlen(token) >= MAX_NAME_LEN)
 537                 return -EINVAL;
 538         strncpy(dbg->state_name, token, MAX_NAME_LEN);
 539
 540         /* get arg 'pin_name' */
 541         token = strsep(&b, " ");
 542         if (token == NULL)
 543                 return -EINVAL;
 544         if (strlen(token) >= MAX_NAME_LEN)
 545                 return -EINVAL;
 546         strncpy(dbg->pin_name, token, MAX_NAME_LEN);
 547
 548         /* get new_value of config' */
 549         token = strsep(&b, " ");
 550         if (token == NULL)
 551                 return -EINVAL;
 552         if (strlen(token) >= MAX_NAME_LEN)
 553                 return -EINVAL;
 554         strncpy(config, token, MAX_NAME_LEN);
 555
 556         mutex_lock(&pinctrl_maps_mutex);
 557
 558         /* Parse the pinctrl map and look for the selected dev/state/pin */
 559         for_each_maps(maps_node, i, map) {
 560                 if (strcmp(map->dev_name, dbg->dev_name))
 561                         continue;
 562                 if (map->type != dbg->map_type)
 563                         continue;
 564                 if (strcmp(map->name, dbg->state_name))
 565                         continue;
 566
 567                 /*  we found the right pin / state, so overwrite config */
 568                 if (!strcmp(map->data.configs.group_or_pin, dbg->pin_name)) {
 569                         found = map;
 570                         break;
 571                 }
 572         }
 573
 574         if (!found) {
 575                 count = -EINVAL;
 576                 goto exit;
 577         }
 578
 579         pctldev = get_pinctrl_dev_from_devname(found->ctrl_dev_name);
 580         if (pctldev)
 581                 confops = pctldev->desc->confops;
 582
 583         if (confops && confops->pin_config_dbg_parse_modify) {
 584                 configs = &found->data.configs;
 585                 for (i = 0; i < configs->num_configs; i++) {
 586                         confops->pin_config_dbg_parse_modify(pctldev,
 587                                                      config,
 588                                                      &configs->configs[i]);
 589                 }
 590         }
 591
 592 exit:
 593         mutex_unlock(&pinctrl_maps_mutex);
 594
 595         return count;
 596 }
 597
 598 static int pinconf_dbg_config_open(struct inode *inode, struct file *file)
 599 {
 600         return single_open(file, pinconf_dbg_config_print, inode->i_private);
 601 }
 602
 603 static const struct file_operations pinconf_dbg_pinconfig_fops = {
 604         .open = pinconf_dbg_config_open,
 605         .write = pinconf_dbg_config_write,
 606         .read = seq_read,
 607         .llseek = seq_lseek,
 608         .release = single_release,
 609         .owner = THIS_MODULE,
 610 };
 611
 612 void pinconf_init_device_debugfs(struct dentry *devroot,
 613                          struct pinctrl_dev *pctldev)
 614 {
 615         debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
 616                             devroot, pctldev, &pinconf_pins_ops);
 617         debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
 618                             devroot, pctldev, &pinconf_groups_ops);
 619         debugfs_create_file("pinconf-config",  (S_IRUGO | S_IWUSR | S_IWGRP),
 620                             devroot, pctldev, &pinconf_dbg_pinconfig_fops);
 621 }
 622
 623 #endif