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/kref.h> 13 #include <linux/mutex.h> 14 #include <linux/radix-tree.h> 15 #include <linux/pinctrl/pinconf.h> 16 #include <linux/pinctrl/machine.h> 17 18 struct pinctrl_gpio_range; 19 20 /** 21 * struct pinctrl_dev - pin control class device 22 * @node: node to include this pin controller in the global pin controller list 23 * @desc: the pin controller descriptor supplied when initializing this pin 24 * controller 25 * @pin_desc_tree: each pin descriptor for this pin controller is stored in 26 * this radix tree 27 * @pin_group_tree: optionally each pin group can be stored in this radix tree 28 * @num_groups: optionally number of groups can be kept here 29 * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller, 30 * ranges are added to this list at runtime 31 * @dev: the device entry for this pin controller 32 * @owner: module providing the pin controller, used for refcounting 33 * @driver_data: driver data for drivers registering to the pin controller 34 * subsystem 35 * @p: result of pinctrl_get() for this device 36 * @hog_default: default state for pins hogged by this device 37 * @hog_sleep: sleep state for pins hogged by this device 38 * @late_init: delayed work for pin controller to finish registration 39 * @mutex: mutex taken on each pin controller specific action 40 * @device_root: debugfs root for this device 41 */ 42 struct pinctrl_dev { 43 struct list_head node; 44 struct pinctrl_desc *desc; 45 struct radix_tree_root pin_desc_tree; 46 struct radix_tree_root pin_group_tree; 47 unsigned int num_groups; 48 struct list_head gpio_ranges; 49 struct device *dev; 50 struct module *owner; 51 void *driver_data; 52 struct pinctrl *p; 53 struct pinctrl_state *hog_default; 54 struct pinctrl_state *hog_sleep; 55 struct delayed_work late_init; 56 struct mutex mutex; 57 #ifdef CONFIG_DEBUG_FS 58 struct dentry *device_root; 59 #endif 60 }; 61 62 /** 63 * struct pinctrl - per-device pin control state holder 64 * @node: global list node 65 * @dev: the device using this pin control handle 66 * @states: a list of states for this device 67 * @state: the current state 68 * @dt_maps: the mapping table chunks dynamically parsed from device tree for 69 * this device, if any 70 * @users: reference count 71 */ 72 struct pinctrl { 73 struct list_head node; 74 struct device *dev; 75 struct list_head states; 76 struct pinctrl_state *state; 77 struct list_head dt_maps; 78 struct kref users; 79 }; 80 81 /** 82 * struct pinctrl_state - a pinctrl state for a device 83 * @node: list node for struct pinctrl's @states field 84 * @name: the name of this state 85 * @settings: a list of settings for this state 86 */ 87 struct pinctrl_state { 88 struct list_head node; 89 const char *name; 90 struct list_head settings; 91 }; 92 93 /** 94 * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP 95 * @group: the group selector to program 96 * @func: the function selector to program 97 */ 98 struct pinctrl_setting_mux { 99 unsigned group; 100 unsigned func; 101 }; 102 103 /** 104 * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_* 105 * @group_or_pin: the group selector or pin ID to program 106 * @configs: a pointer to an array of config parameters/values to program into 107 * hardware. Each individual pin controller defines the format and meaning 108 * of config parameters. 109 * @num_configs: the number of entries in array @configs 110 */ 111 struct pinctrl_setting_configs { 112 unsigned group_or_pin; 113 unsigned long *configs; 114 unsigned num_configs; 115 }; 116 117 /** 118 * struct pinctrl_setting - an individual mux or config setting 119 * @node: list node for struct pinctrl_settings's @settings field 120 * @type: the type of setting 121 * @pctldev: pin control device handling to be programmed. Not used for 122 * PIN_MAP_TYPE_DUMMY_STATE. 123 * @dev_name: the name of the device using this state 124 * @data: Data specific to the setting type 125 */ 126 struct pinctrl_setting { 127 struct list_head node; 128 enum pinctrl_map_type type; 129 struct pinctrl_dev *pctldev; 130 const char *dev_name; 131 union { 132 struct pinctrl_setting_mux mux; 133 struct pinctrl_setting_configs configs; 134 } data; 135 }; 136 137 /** 138 * struct pin_desc - pin descriptor for each physical pin in the arch 139 * @pctldev: corresponding pin control device 140 * @name: a name for the pin, e.g. the name of the pin/pad/finger on a 141 * datasheet or such 142 * @dynamic_name: if the name of this pin was dynamically allocated 143 * @drv_data: driver-defined per-pin data. pinctrl core does not touch this 144 * @mux_usecount: If zero, the pin is not claimed, and @owner should be NULL. 145 * If non-zero, this pin is claimed by @owner. This field is an integer 146 * rather than a boolean, since pinctrl_get() might process multiple 147 * mapping table entries that refer to, and hence claim, the same group 148 * or pin, and each of these will increment the @usecount. 149 * @mux_owner: The name of device that called pinctrl_get(). 150 * @mux_setting: The most recent selected mux setting for this pin, if any. 151 * @gpio_owner: If pinctrl_request_gpio() was called for this pin, this is 152 * the name of the GPIO that "owns" this pin. 153 */ 154 struct pin_desc { 155 struct pinctrl_dev *pctldev; 156 const char *name; 157 bool dynamic_name; 158 void *drv_data; 159 /* These fields only added when supporting pinmux drivers */ 160 #ifdef CONFIG_PINMUX 161 unsigned mux_usecount; 162 const char *mux_owner; 163 const struct pinctrl_setting_mux *mux_setting; 164 const char *gpio_owner; 165 #endif 166 }; 167 168 /** 169 * struct group_desc - generic pin group descriptor 170 * @name: name of the pin group 171 * @pins: array of pins that belong to the group 172 * @num_pins: number of pins in the group 173 * @data: pin controller driver specific data 174 */ 175 struct group_desc { 176 const char *name; 177 int *pins; 178 int num_pins; 179 void *data; 180 }; 181 182 /** 183 * struct pinctrl_maps - a list item containing part of the mapping table 184 * @node: mapping table list node 185 * @maps: array of mapping table entries 186 * @num_maps: the number of entries in @maps 187 */ 188 struct pinctrl_maps { 189 struct list_head node; 190 struct pinctrl_map const *maps; 191 unsigned num_maps; 192 }; 193 194 #ifdef CONFIG_GENERIC_PINCTRL 195 196 int pinctrl_generic_get_group_count(struct pinctrl_dev *pctldev); 197 198 const char *pinctrl_generic_get_group_name(struct pinctrl_dev *pctldev, 199 unsigned int group_selector); 200 201 int pinctrl_generic_get_group_pins(struct pinctrl_dev *pctldev, 202 unsigned int group_selector, 203 const unsigned int **pins, 204 unsigned int *npins); 205 206 struct group_desc *pinctrl_generic_get_group(struct pinctrl_dev *pctldev, 207 unsigned int group_selector); 208 209 int pinctrl_generic_add_group(struct pinctrl_dev *pctldev, const char *name, 210 int *gpins, int ngpins, void *data); 211 212 int pinctrl_generic_remove_group(struct pinctrl_dev *pctldev, 213 unsigned int group_selector); 214 215 static inline int 216 pinctrl_generic_remove_last_group(struct pinctrl_dev *pctldev) 217 { 218 return pinctrl_generic_remove_group(pctldev, pctldev->num_groups - 1); 219 } 220 221 #endif /* CONFIG_GENERIC_PINCTRL */ 222 223 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name); 224 struct pinctrl_dev *get_pinctrl_dev_from_of_node(struct device_node *np); 225 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name); 226 const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin); 227 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev, 228 const char *pin_group); 229 230 static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev, 231 unsigned int pin) 232 { 233 return radix_tree_lookup(&pctldev->pin_desc_tree, pin); 234 } 235 236 extern struct pinctrl_gpio_range * 237 pinctrl_find_gpio_range_from_pin_nolock(struct pinctrl_dev *pctldev, 238 unsigned int pin); 239 240 int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps, 241 bool dup); 242 void pinctrl_unregister_map(struct pinctrl_map const *map); 243 244 extern int pinctrl_force_sleep(struct pinctrl_dev *pctldev); 245 extern int pinctrl_force_default(struct pinctrl_dev *pctldev); 246 247 extern struct mutex pinctrl_maps_mutex; 248 extern struct list_head pinctrl_maps; 249 250 #define for_each_maps(_maps_node_, _i_, _map_) \ 251 list_for_each_entry(_maps_node_, &pinctrl_maps, node) \ 252 for (_i_ = 0, _map_ = &_maps_node_->maps[_i_]; \ 253 _i_ < _maps_node_->num_maps; \ 254 _i_++, _map_ = &_maps_node_->maps[_i_]) 255