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