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