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