2 * Core private header for the pin control subsystem
4 * Copyright (C) 2011 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
7 * Author: Linus Walleij <linus.walleij@linaro.org>
9 * License terms: GNU General Public License (GPL) version 2
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>
18 struct pinctrl_gpio_range
;
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
25 * @pin_desc_tree: each pin descriptor for this pin controller is stored in
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
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
43 struct list_head node
;
44 struct pinctrl_desc
*desc
;
45 struct radix_tree_root pin_desc_tree
;
46 #ifdef CONFIG_GENERIC_PINCTRL_GROUPS
47 struct radix_tree_root pin_group_tree
;
48 unsigned int num_groups
;
50 struct list_head gpio_ranges
;
55 struct pinctrl_state
*hog_default
;
56 struct pinctrl_state
*hog_sleep
;
57 struct delayed_work late_init
;
59 #ifdef CONFIG_DEBUG_FS
60 struct dentry
*device_root
;
65 * struct pinctrl - per-device pin control state holder
66 * @node: global list node
67 * @dev: the device using this pin control handle
68 * @states: a list of states for this device
69 * @state: the current state
70 * @dt_maps: the mapping table chunks dynamically parsed from device tree for
72 * @users: reference count
75 struct list_head node
;
77 struct list_head states
;
78 struct pinctrl_state
*state
;
79 struct list_head dt_maps
;
84 * struct pinctrl_state - a pinctrl state for a device
85 * @node: list node for struct pinctrl's @states field
86 * @name: the name of this state
87 * @settings: a list of settings for this state
89 struct pinctrl_state
{
90 struct list_head node
;
92 struct list_head settings
;
96 * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP
97 * @group: the group selector to program
98 * @func: the function selector to program
100 struct pinctrl_setting_mux
{
106 * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_*
107 * @group_or_pin: the group selector or pin ID to program
108 * @configs: a pointer to an array of config parameters/values to program into
109 * hardware. Each individual pin controller defines the format and meaning
110 * of config parameters.
111 * @num_configs: the number of entries in array @configs
113 struct pinctrl_setting_configs
{
114 unsigned group_or_pin
;
115 unsigned long *configs
;
116 unsigned num_configs
;
120 * struct pinctrl_setting - an individual mux or config setting
121 * @node: list node for struct pinctrl_settings's @settings field
122 * @type: the type of setting
123 * @pctldev: pin control device handling to be programmed. Not used for
124 * PIN_MAP_TYPE_DUMMY_STATE.
125 * @dev_name: the name of the device using this state
126 * @data: Data specific to the setting type
128 struct pinctrl_setting
{
129 struct list_head node
;
130 enum pinctrl_map_type type
;
131 struct pinctrl_dev
*pctldev
;
132 const char *dev_name
;
134 struct pinctrl_setting_mux mux
;
135 struct pinctrl_setting_configs configs
;
140 * struct pin_desc - pin descriptor for each physical pin in the arch
141 * @pctldev: corresponding pin control device
142 * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
144 * @dynamic_name: if the name of this pin was dynamically allocated
145 * @drv_data: driver-defined per-pin data. pinctrl core does not touch this
146 * @mux_usecount: If zero, the pin is not claimed, and @owner should be NULL.
147 * If non-zero, this pin is claimed by @owner. This field is an integer
148 * rather than a boolean, since pinctrl_get() might process multiple
149 * mapping table entries that refer to, and hence claim, the same group
150 * or pin, and each of these will increment the @usecount.
151 * @mux_owner: The name of device that called pinctrl_get().
152 * @mux_setting: The most recent selected mux setting for this pin, if any.
153 * @gpio_owner: If pinctrl_request_gpio() was called for this pin, this is
154 * the name of the GPIO that "owns" this pin.
157 struct pinctrl_dev
*pctldev
;
161 /* These fields only added when supporting pinmux drivers */
163 unsigned mux_usecount
;
164 const char *mux_owner
;
165 const struct pinctrl_setting_mux
*mux_setting
;
166 const char *gpio_owner
;
171 * struct pinctrl_maps - a list item containing part of the mapping table
172 * @node: mapping table list node
173 * @maps: array of mapping table entries
174 * @num_maps: the number of entries in @maps
176 struct pinctrl_maps
{
177 struct list_head node
;
178 struct pinctrl_map
const *maps
;
182 #ifdef CONFIG_GENERIC_PINCTRL_GROUPS
185 * struct group_desc - generic pin group descriptor
186 * @name: name of the pin group
187 * @pins: array of pins that belong to the group
188 * @num_pins: number of pins in the group
189 * @data: pin controller driver specific data
198 int pinctrl_generic_get_group_count(struct pinctrl_dev
*pctldev
);
200 const char *pinctrl_generic_get_group_name(struct pinctrl_dev
*pctldev
,
201 unsigned int group_selector
);
203 int pinctrl_generic_get_group_pins(struct pinctrl_dev
*pctldev
,
204 unsigned int group_selector
,
205 const unsigned int **pins
,
206 unsigned int *npins
);
208 struct group_desc
*pinctrl_generic_get_group(struct pinctrl_dev
*pctldev
,
209 unsigned int group_selector
);
211 int pinctrl_generic_add_group(struct pinctrl_dev
*pctldev
, const char *name
,
212 int *gpins
, int ngpins
, void *data
);
214 int pinctrl_generic_remove_group(struct pinctrl_dev
*pctldev
,
215 unsigned int group_selector
);
218 pinctrl_generic_remove_last_group(struct pinctrl_dev
*pctldev
)
220 return pinctrl_generic_remove_group(pctldev
, pctldev
->num_groups
- 1);
223 #endif /* CONFIG_GENERIC_PINCTRL_GROUPS */
225 struct pinctrl_dev
*get_pinctrl_dev_from_devname(const char *dev_name
);
226 struct pinctrl_dev
*get_pinctrl_dev_from_of_node(struct device_node
*np
);
227 int pin_get_from_name(struct pinctrl_dev
*pctldev
, const char *name
);
228 const char *pin_get_name(struct pinctrl_dev
*pctldev
, const unsigned pin
);
229 int pinctrl_get_group_selector(struct pinctrl_dev
*pctldev
,
230 const char *pin_group
);
232 static inline struct pin_desc
*pin_desc_get(struct pinctrl_dev
*pctldev
,
235 return radix_tree_lookup(&pctldev
->pin_desc_tree
, pin
);
238 extern struct pinctrl_gpio_range
*
239 pinctrl_find_gpio_range_from_pin_nolock(struct pinctrl_dev
*pctldev
,
242 int pinctrl_register_map(struct pinctrl_map
const *maps
, unsigned num_maps
,
244 void pinctrl_unregister_map(struct pinctrl_map
const *map
);
246 extern int pinctrl_force_sleep(struct pinctrl_dev
*pctldev
);
247 extern int pinctrl_force_default(struct pinctrl_dev
*pctldev
);
249 extern struct mutex pinctrl_maps_mutex
;
250 extern struct list_head pinctrl_maps
;
252 #define for_each_maps(_maps_node_, _i_, _map_) \
253 list_for_each_entry(_maps_node_, &pinctrl_maps, node) \
254 for (_i_ = 0, _map_ = &_maps_node_->maps[_i_]; \
255 _i_ < _maps_node_->num_maps; \
256 _i_++, _map_ = &_maps_node_->maps[_i_])