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  * @states: a list of states for this device
  53  * @state: the current state
  54  */
  55 struct pinctrl {
  56         struct list_head node;
  57         struct device *dev;
  58         struct list_head states;
  59         struct pinctrl_state *state;
  60 };
  61
  62 /**
  63  * struct pinctrl_state - a pinctrl state for a device
  64  * @node: list not for struct pinctrl's @states field
  65  * @name: the name of this state
  66  * @settings: a list of settings for this state
  67  */
  68 struct pinctrl_state {
  69         struct list_head node;
  70         const char *name;
  71         struct list_head settings;
  72 };
  73
  74 /**
  75  * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP
  76  * @group: the group selector to program
  77  * @func: the function selector to program
  78  */
  79 struct pinctrl_setting_mux {
  80         unsigned group;
  81         unsigned func;
  82 };
  83
  84 /**
  85  * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_*
  86  * @group_or_pin: the group selector or pin ID to program
  87  * @configs: a pointer to an array of config parameters/values to program into
  88  *      hardware. Each individual pin controller defines the format and meaning
  89  *      of config parameters.
  90  * @num_configs: the number of entries in array @configs
  91  */
  92 struct pinctrl_setting_configs {
  93         unsigned group_or_pin;
  94         unsigned long *configs;
  95         unsigned num_configs;
  96 };
  97
  98 /**
  99  * struct pinctrl_setting - an individual mux setting
 100  * @node: list node for struct pinctrl_settings's @settings field
 101  * @type: the type of setting
 102  * @pctldev: pin control device handling to be programmed
 103  * @data: Data specific to the setting type
 104  */
 105 struct pinctrl_setting {
 106         struct list_head node;
 107         enum pinctrl_map_type type;
 108         struct pinctrl_dev *pctldev;
 109         union {
 110                 struct pinctrl_setting_mux mux;
 111                 struct pinctrl_setting_configs configs;
 112         } data;
 113 };
 114
 115 /**
 116  * struct pin_desc - pin descriptor for each physical pin in the arch
 117  * @pctldev: corresponding pin control device
 118  * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
 119  *      datasheet or such
 120  * @dynamic_name: if the name of this pin was dynamically allocated
 121  * @usecount: If zero, the pin is not claimed, and @owner should be NULL.
 122  *      If non-zero, this pin is claimed by @owner. This field is an integer
 123  *      rather than a boolean, since pinctrl_get() might process multiple
 124  *      mapping table entries that refer to, and hence claim, the same group
 125  *      or pin, and each of these will increment the @usecount.
 126  * @owner: The name of the entity owning the pin. Typically, this is the name
 127  *      of the device that called pinctrl_get(). Alternatively, it may be the
 128  *      name of the GPIO passed to pinctrl_request_gpio().
 129  */
 130 struct pin_desc {
 131         struct pinctrl_dev *pctldev;
 132         const char *name;
 133         bool dynamic_name;
 134         /* These fields only added when supporting pinmux drivers */
 135 #ifdef CONFIG_PINMUX
 136         unsigned usecount;
 137         const char *owner;
 138 #endif
 139 };
 140
 141 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name);
 142 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
 143 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
 144                                const char *pin_group);
 145
 146 static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev,
 147                                             unsigned int pin)
 148 {
 149         return radix_tree_lookup(&pctldev->pin_desc_tree, pin);
 150 }
 151
 152 extern struct mutex pinctrl_mutex;