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 #include <linux/pinctrl/machine.h>
  16
  17 struct pinctrl_gpio_range;
  18
  19 /**
  20  * struct pinctrl_dev - pin control class device
  21  * @node: node to include this pin controller in the global pin controller list
  22  * @desc: the pin controller descriptor supplied when initializing this pin
  23  *      controller
  24  * @pin_desc_tree: each pin descriptor for this pin controller is stored in
  25  *      this radix tree
  26  * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller,
  27  *      ranges are added to this list at runtime
  28  * @dev: the device entry for this pin controller
  29  * @owner: module providing the pin controller, used for refcounting
  30  * @driver_data: driver data for drivers registering to the pin controller
  31  *      subsystem
  32  * @p: result of pinctrl_get() for this device
  33  * @device_root: debugfs root for this device
  34  */
  35 struct pinctrl_dev {
  36         struct list_head node;
  37         struct pinctrl_desc *desc;
  38         struct radix_tree_root pin_desc_tree;
  39         struct list_head gpio_ranges;
  40         struct device *dev;
  41         struct module *owner;
  42         void *driver_data;
  43         struct pinctrl *p;
  44 #ifdef CONFIG_DEBUG_FS
  45         struct dentry *device_root;
  46 #endif
  47 };
  48
  49 /**
  50  * struct pinctrl - per-device pin control state holder
  51  * @node: global list node
  52  * @dev: the device using this pin control handle
  53  * @states: a list of states for this device
  54  * @state: the current state
  55  */
  56 struct pinctrl {
  57         struct list_head node;
  58         struct device *dev;
  59         struct list_head states;
  60         struct pinctrl_state *state;
  61 };
  62
  63 /**
  64  * struct pinctrl_state - a pinctrl state for a device
  65  * @node: list not for struct pinctrl's @states field
  66  * @name: the name of this state
  67  * @settings: a list of settings for this state
  68  */
  69 struct pinctrl_state {
  70         struct list_head node;
  71         const char *name;
  72         struct list_head settings;
  73 };
  74
  75 /**
  76  * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP
  77  * @group: the group selector to program
  78  * @func: the function selector to program
  79  */
  80 struct pinctrl_setting_mux {
  81         unsigned group;
  82         unsigned func;
  83 };
  84
  85 /**
  86  * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_*
  87  * @group_or_pin: the group selector or pin ID to program
  88  * @configs: a pointer to an array of config parameters/values to program into
  89  *      hardware. Each individual pin controller defines the format and meaning
  90  *      of config parameters.
  91  * @num_configs: the number of entries in array @configs
  92  */
  93 struct pinctrl_setting_configs {
  94         unsigned group_or_pin;
  95         unsigned long *configs;
  96         unsigned num_configs;
  97 };
  98
  99 /**
 100  * struct pinctrl_setting - an individual mux or config setting
 101  * @node: list node for struct pinctrl_settings's @settings field
 102  * @type: the type of setting
 103  * @pctldev: pin control device handling to be programmed
 104  * @data: Data specific to the setting type
 105  */
 106 struct pinctrl_setting {
 107         struct list_head node;
 108         enum pinctrl_map_type type;
 109         struct pinctrl_dev *pctldev;
 110         union {
 111                 struct pinctrl_setting_mux mux;
 112                 struct pinctrl_setting_configs configs;
 113         } data;
 114 };
 115
 116 /**
 117  * struct pin_desc - pin descriptor for each physical pin in the arch
 118  * @pctldev: corresponding pin control device
 119  * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
 120  *      datasheet or such
 121  * @dynamic_name: if the name of this pin was dynamically allocated
 122  * @mux_usecount: If zero, the pin is not claimed, and @owner should be NULL.
 123  *      If non-zero, this pin is claimed by @owner. This field is an integer
 124  *      rather than a boolean, since pinctrl_get() might process multiple
 125  *      mapping table entries that refer to, and hence claim, the same group
 126  *      or pin, and each of these will increment the @usecount.
 127  * @mux_owner: The name of device that called pinctrl_get().
 128  * @mux_setting: The most recent selected mux setting for this pin, if any.
 129  * @gpio_owner: If pinctrl_request_gpio() was called for this pin, this is
 130  *      the name of the GPIO that "owns" this pin.
 131  */
 132 struct pin_desc {
 133         struct pinctrl_dev *pctldev;
 134         const char *name;
 135         bool dynamic_name;
 136         /* These fields only added when supporting pinmux drivers */
 137 #ifdef CONFIG_PINMUX
 138         unsigned mux_usecount;
 139         const char *mux_owner;
 140         const struct pinctrl_setting_mux *mux_setting;
 141         const char *gpio_owner;
 142 #endif
 143 };
 144
 145 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name);
 146 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
 147 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
 148                                const char *pin_group);
 149
 150 static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev,
 151                                             unsigned int pin)
 152 {
 153         return radix_tree_lookup(&pctldev->pin_desc_tree, pin);
 154 }
 155
 156 extern struct mutex pinctrl_mutex;