blob: ca08723b9ee1e90fdfc792666cc7491ad5fc492e [file] [log] [blame]
Linus Walleij2744e8a2011-05-02 20:50:54 +02001/*
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
Linus Walleijab780292013-01-22 10:56:14 -070012#include <linux/kref.h>
Stephen Warren57b676f2012-03-02 13:05:44 -070013#include <linux/mutex.h>
14#include <linux/radix-tree.h>
Linus Walleijae6b4d82011-10-19 18:14:33 +020015#include <linux/pinctrl/pinconf.h>
Linus Walleij872acc32012-03-06 13:52:22 +010016#include <linux/pinctrl/machine.h>
Linus Walleijae6b4d82011-10-19 18:14:33 +020017
18struct pinctrl_gpio_range;
19
Linus Walleij2744e8a2011-05-02 20:50:54 +020020/**
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
Linus Walleij2744e8a2011-05-02 20:50:54 +020027 * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller,
28 * ranges are added to this list at runtime
Linus Walleij2744e8a2011-05-02 20:50:54 +020029 * @dev: the device entry for this pin controller
30 * @owner: module providing the pin controller, used for refcounting
31 * @driver_data: driver data for drivers registering to the pin controller
32 * subsystem
Stephen Warren46919ae2012-03-01 18:48:32 -070033 * @p: result of pinctrl_get() for this device
Julien Delacou840a47b2012-12-10 14:47:33 +010034 * @hog_default: default state for pins hogged by this device
35 * @hog_sleep: sleep state for pins hogged by this device
Patrice Chotard42fed7b2013-04-11 11:01:27 +020036 * @mutex: mutex taken on each pin controller specific action
Linus Walleijbefe5bd2012-02-09 19:47:48 +010037 * @device_root: debugfs root for this device
Linus Walleij2744e8a2011-05-02 20:50:54 +020038 */
39struct pinctrl_dev {
40 struct list_head node;
41 struct pinctrl_desc *desc;
42 struct radix_tree_root pin_desc_tree;
Linus Walleij2744e8a2011-05-02 20:50:54 +020043 struct list_head gpio_ranges;
Stephen Warren51cd24e2011-12-09 16:59:05 -070044 struct device *dev;
Linus Walleij2744e8a2011-05-02 20:50:54 +020045 struct module *owner;
46 void *driver_data;
Stephen Warren46919ae2012-03-01 18:48:32 -070047 struct pinctrl *p;
Julien Delacou840a47b2012-12-10 14:47:33 +010048 struct pinctrl_state *hog_default;
49 struct pinctrl_state *hog_sleep;
Patrice Chotard42fed7b2013-04-11 11:01:27 +020050 struct mutex mutex;
Tony Lindgren02157162012-01-20 08:17:22 -080051#ifdef CONFIG_DEBUG_FS
52 struct dentry *device_root;
53#endif
Linus Walleijbefe5bd2012-02-09 19:47:48 +010054};
55
56/**
57 * struct pinctrl - per-device pin control state holder
58 * @node: global list node
59 * @dev: the device using this pin control handle
Stephen Warren6e5e9592012-03-02 13:05:47 -070060 * @states: a list of states for this device
61 * @state: the current state
Stephen Warren57291ce2012-03-23 10:29:46 -060062 * @dt_maps: the mapping table chunks dynamically parsed from device tree for
63 * this device, if any
Linus Walleijab780292013-01-22 10:56:14 -070064 * @users: reference count
Linus Walleijbefe5bd2012-02-09 19:47:48 +010065 */
66struct pinctrl {
67 struct list_head node;
68 struct device *dev;
Stephen Warren6e5e9592012-03-02 13:05:47 -070069 struct list_head states;
70 struct pinctrl_state *state;
Stephen Warren57291ce2012-03-23 10:29:46 -060071 struct list_head dt_maps;
Linus Walleijab780292013-01-22 10:56:14 -070072 struct kref users;
Stephen Warren6e5e9592012-03-02 13:05:47 -070073};
74
75/**
76 * struct pinctrl_state - a pinctrl state for a device
Richard Genoud2c9abf82013-03-25 15:47:20 +010077 * @node: list node for struct pinctrl's @states field
Stephen Warren6e5e9592012-03-02 13:05:47 -070078 * @name: the name of this state
79 * @settings: a list of settings for this state
80 */
81struct pinctrl_state {
82 struct list_head node;
83 const char *name;
Stephen Warren7ecdb162012-03-02 13:05:45 -070084 struct list_head settings;
85};
86
87/**
Stephen Warren1e2082b2012-03-02 13:05:48 -070088 * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP
89 * @group: the group selector to program
90 * @func: the function selector to program
91 */
92struct pinctrl_setting_mux {
93 unsigned group;
94 unsigned func;
95};
96
97/**
98 * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_*
99 * @group_or_pin: the group selector or pin ID to program
100 * @configs: a pointer to an array of config parameters/values to program into
101 * hardware. Each individual pin controller defines the format and meaning
102 * of config parameters.
103 * @num_configs: the number of entries in array @configs
104 */
105struct pinctrl_setting_configs {
106 unsigned group_or_pin;
107 unsigned long *configs;
108 unsigned num_configs;
109};
110
111/**
Linus Walleij872acc32012-03-06 13:52:22 +0100112 * struct pinctrl_setting - an individual mux or config setting
Stephen Warren6e5e9592012-03-02 13:05:47 -0700113 * @node: list node for struct pinctrl_settings's @settings field
Stephen Warren1e2082b2012-03-02 13:05:48 -0700114 * @type: the type of setting
Stephen Warren57291ce2012-03-23 10:29:46 -0600115 * @pctldev: pin control device handling to be programmed. Not used for
116 * PIN_MAP_TYPE_DUMMY_STATE.
Linus Walleij1a789582012-10-17 20:51:54 +0200117 * @dev_name: the name of the device using this state
Stephen Warren1e2082b2012-03-02 13:05:48 -0700118 * @data: Data specific to the setting type
Stephen Warren7ecdb162012-03-02 13:05:45 -0700119 */
120struct pinctrl_setting {
121 struct list_head node;
Stephen Warren1e2082b2012-03-02 13:05:48 -0700122 enum pinctrl_map_type type;
Linus Walleijbefe5bd2012-02-09 19:47:48 +0100123 struct pinctrl_dev *pctldev;
Linus Walleij1a789582012-10-17 20:51:54 +0200124 const char *dev_name;
Stephen Warren1e2082b2012-03-02 13:05:48 -0700125 union {
126 struct pinctrl_setting_mux mux;
127 struct pinctrl_setting_configs configs;
128 } data;
Linus Walleij2744e8a2011-05-02 20:50:54 +0200129};
130
131/**
132 * struct pin_desc - pin descriptor for each physical pin in the arch
133 * @pctldev: corresponding pin control device
134 * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
135 * datasheet or such
Linus Walleijca53c5f2011-12-14 20:33:37 +0100136 * @dynamic_name: if the name of this pin was dynamically allocated
Stephen Warren652162d2012-03-05 17:22:15 -0700137 * @mux_usecount: If zero, the pin is not claimed, and @owner should be NULL.
Stephen Warren0e3db1732012-03-02 13:05:46 -0700138 * If non-zero, this pin is claimed by @owner. This field is an integer
139 * rather than a boolean, since pinctrl_get() might process multiple
140 * mapping table entries that refer to, and hence claim, the same group
141 * or pin, and each of these will increment the @usecount.
Stephen Warren652162d2012-03-05 17:22:15 -0700142 * @mux_owner: The name of device that called pinctrl_get().
Stephen Warrenba110d92012-03-02 13:05:49 -0700143 * @mux_setting: The most recent selected mux setting for this pin, if any.
Stephen Warren652162d2012-03-05 17:22:15 -0700144 * @gpio_owner: If pinctrl_request_gpio() was called for this pin, this is
145 * the name of the GPIO that "owns" this pin.
Linus Walleij2744e8a2011-05-02 20:50:54 +0200146 */
147struct pin_desc {
148 struct pinctrl_dev *pctldev;
Stephen Warren9af1e442011-10-19 16:19:27 -0600149 const char *name;
Linus Walleijca53c5f2011-12-14 20:33:37 +0100150 bool dynamic_name;
Linus Walleij2744e8a2011-05-02 20:50:54 +0200151 /* These fields only added when supporting pinmux drivers */
152#ifdef CONFIG_PINMUX
Stephen Warren652162d2012-03-05 17:22:15 -0700153 unsigned mux_usecount;
154 const char *mux_owner;
Stephen Warrenba110d92012-03-02 13:05:49 -0700155 const struct pinctrl_setting_mux *mux_setting;
Stephen Warren652162d2012-03-05 17:22:15 -0700156 const char *gpio_owner;
Linus Walleij2744e8a2011-05-02 20:50:54 +0200157#endif
158};
159
Laurent Meunier6f9e41f2013-02-06 09:09:44 +0100160/**
161 * struct pinctrl_maps - a list item containing part of the mapping table
162 * @node: mapping table list node
163 * @maps: array of mapping table entries
164 * @num_maps: the number of entries in @maps
165 */
166struct pinctrl_maps {
167 struct list_head node;
168 struct pinctrl_map const *maps;
169 unsigned num_maps;
170};
171
Linus Walleij9dfac4f2012-02-01 18:02:47 +0100172struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name);
Patrice Chotard42fed7b2013-04-11 11:01:27 +0200173struct pinctrl_dev *get_pinctrl_dev_from_of_node(struct device_node *np);
Linus Walleijae6b4d82011-10-19 18:14:33 +0200174int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
Dong Aishengdcb5dbc2012-04-17 15:00:46 +0800175const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin);
Linus Walleij7afde8b2011-10-19 17:07:16 +0200176int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
177 const char *pin_group);
Stephen Warren2304b472012-02-22 14:26:01 -0700178
179static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev,
180 unsigned int pin)
181{
182 return radix_tree_lookup(&pctldev->pin_desc_tree, pin);
183}
Stephen Warren57b676f2012-03-02 13:05:44 -0700184
Joachim Eastwoodb18537c2016-02-25 22:44:37 +0100185extern struct pinctrl_gpio_range *
186pinctrl_find_gpio_range_from_pin_nolock(struct pinctrl_dev *pctldev,
187 unsigned int pin);
188
Stephen Warren57291ce2012-03-23 10:29:46 -0600189int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps,
Doug Andersonc5272a22015-05-01 09:01:27 -0700190 bool dup);
Stephen Warren57291ce2012-03-23 10:29:46 -0600191void pinctrl_unregister_map(struct pinctrl_map const *map);
192
Julien Delacou840a47b2012-12-10 14:47:33 +0100193extern int pinctrl_force_sleep(struct pinctrl_dev *pctldev);
194extern int pinctrl_force_default(struct pinctrl_dev *pctldev);
195
Patrice Chotard42fed7b2013-04-11 11:01:27 +0200196extern struct mutex pinctrl_maps_mutex;
Laurent Meunier6f9e41f2013-02-06 09:09:44 +0100197extern struct list_head pinctrl_maps;
198
199#define for_each_maps(_maps_node_, _i_, _map_) \
200 list_for_each_entry(_maps_node_, &pinctrl_maps, node) \
201 for (_i_ = 0, _map_ = &_maps_node_->maps[_i_]; \
202 _i_ < _maps_node_->num_maps; \
203 _i_++, _map_ = &_maps_node_->maps[_i_])