drivers/pinctrl/core.h

   1 /*
   2  * Core private header for 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
  12 #include <linux/mutex.h>
  13 #include <linux/radix-tree.h>
  14 #include <linux/pinctrl/pinconf.h>
  15
  16 struct pinctrl_gpio_range;
  17
  18 /**
  19  * struct pinctrl_dev - pin control class device
  20  * @node: node to include this pin controller in the global pin controller list
  21  * @desc: the pin controller descriptor supplied when initializing this pin
  22  *      controller
  23  * @pin_desc_tree: each pin descriptor for this pin controller is stored in
  24  *      this radix tree
  25  * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller,
  26  *      ranges are added to this list at runtime
  27  * @dev: the device entry for this pin controller
  28  * @owner: module providing the pin controller, used for refcounting
  29  * @driver_data: driver data for drivers registering to the pin controller
  30  *      subsystem
  31  * @p: result of pinctrl_get() for this device
  32  * @device_root: debugfs root for this device
  33  */
  34 struct pinctrl_dev {
  35         struct list_head node;
  36         struct pinctrl_desc *desc;
  37         struct radix_tree_root pin_desc_tree;
  38         struct list_head gpio_ranges;
  39         struct device *dev;
  40         struct module *owner;
  41         void *driver_data;
  42         struct pinctrl *p;
  43 #ifdef CONFIG_DEBUG_FS
  44         struct dentry *device_root;
  45 #endif
  46 };
  47
  48 /**
  49  * struct pinctrl - per-device pin control state holder
  50  * @node: global list node
  51  * @dev: the device using this pin control handle
  52  * @state: the state name passed to pinctrl_get()
  53  * @usecount: the number of active users of this pin controller setting, used
  54  *      to keep track of nested use cases
  55  * @settings: a list of settings for this device/state
  56  */
  57 struct pinctrl {
  58         struct list_head node;
  59         struct device *dev;
  60         const char *state;
  61         unsigned usecount;
  62         struct list_head settings;
  63 };
  64
  65 /**
  66  * struct pinctrl_setting - an individual mux setting
  67  * @node: list node for struct pinctrl's @settings field
  68  * @pctldev: pin control device handling to be programmed
  69  * @group_selector: the group selector to program
  70  * @func_selector: the function selector to program
  71  */
  72 struct pinctrl_setting {
  73         struct list_head node;
  74         struct pinctrl_dev *pctldev;
  75         unsigned group_selector;
  76         unsigned func_selector;
  77 };
  78
  79 /**
  80  * struct pin_desc - pin descriptor for each physical pin in the arch
  81  * @pctldev: corresponding pin control device
  82  * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
  83  *      datasheet or such
  84  * @dynamic_name: if the name of this pin was dynamically allocated
  85  * @owner: the device holding this pin or NULL of no device has claimed it
  86  */
  87 struct pin_desc {
  88         struct pinctrl_dev *pctldev;
  89         const char *name;
  90         bool dynamic_name;
  91         /* These fields only added when supporting pinmux drivers */
  92 #ifdef CONFIG_PINMUX
  93         const char *owner;
  94 #endif
  95 };
  96
  97 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name);
  98 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
  99 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
 100                                const char *pin_group);
 101
 102 static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev,
 103                                             unsigned int pin)
 104 {
 105         return radix_tree_lookup(&pctldev->pin_desc_tree, pin);
 106 }
 107
 108 extern struct mutex pinctrl_mutex;