blob: 12f5694f3d5d9f02020cd2369603d6202e488b24 [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
Stephen Warren57b676f2012-03-02 13:05:44 -070012#include <linux/mutex.h>
13#include <linux/radix-tree.h>
Linus Walleijae6b4d82011-10-19 18:14:33 +020014#include <linux/pinctrl/pinconf.h>
Linus Walleij872acc32012-03-06 13:52:22 +010015#include <linux/pinctrl/machine.h>
Linus Walleijae6b4d82011-10-19 18:14:33 +020016
17struct pinctrl_gpio_range;
18
Linus Walleij2744e8a2011-05-02 20:50:54 +020019/**
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
Linus Walleij2744e8a2011-05-02 20:50:54 +020026 * @gpio_ranges: a list of GPIO ranges that is handled by this pin controller,
27 * ranges are added to this list at runtime
Linus Walleij2744e8a2011-05-02 20:50:54 +020028 * @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
Stephen Warren46919ae2012-03-01 18:48:32 -070032 * @p: result of pinctrl_get() for this device
Linus Walleijbefe5bd2012-02-09 19:47:48 +010033 * @device_root: debugfs root for this device
Linus Walleij2744e8a2011-05-02 20:50:54 +020034 */
35struct pinctrl_dev {
36 struct list_head node;
37 struct pinctrl_desc *desc;
38 struct radix_tree_root pin_desc_tree;
Linus Walleij2744e8a2011-05-02 20:50:54 +020039 struct list_head gpio_ranges;
Stephen Warren51cd24e2011-12-09 16:59:05 -070040 struct device *dev;
Linus Walleij2744e8a2011-05-02 20:50:54 +020041 struct module *owner;
42 void *driver_data;
Stephen Warren46919ae2012-03-01 18:48:32 -070043 struct pinctrl *p;
Tony Lindgren02157162012-01-20 08:17:22 -080044#ifdef CONFIG_DEBUG_FS
45 struct dentry *device_root;
46#endif
Linus Walleijbefe5bd2012-02-09 19:47:48 +010047};
48
49/**
50 * struct pinctrl - per-device pin control state holder
51 * @node: global list node
52 * @dev: the device using this pin control handle
Stephen Warren6e5e9592012-03-02 13:05:47 -070053 * @states: a list of states for this device
54 * @state: the current state
Stephen Warren57291ce2012-03-23 10:29:46 -060055 * @dt_maps: the mapping table chunks dynamically parsed from device tree for
56 * this device, if any
Linus Walleijbefe5bd2012-02-09 19:47:48 +010057 */
58struct pinctrl {
59 struct list_head node;
60 struct device *dev;
Stephen Warren6e5e9592012-03-02 13:05:47 -070061 struct list_head states;
62 struct pinctrl_state *state;
Stephen Warren57291ce2012-03-23 10:29:46 -060063 struct list_head dt_maps;
Stephen Warren6e5e9592012-03-02 13:05:47 -070064};
65
66/**
67 * struct pinctrl_state - a pinctrl state for a device
68 * @node: list not for struct pinctrl's @states field
69 * @name: the name of this state
70 * @settings: a list of settings for this state
71 */
72struct pinctrl_state {
73 struct list_head node;
74 const char *name;
Stephen Warren7ecdb162012-03-02 13:05:45 -070075 struct list_head settings;
76};
77
78/**
Stephen Warren1e2082b2012-03-02 13:05:48 -070079 * struct pinctrl_setting_mux - setting data for MAP_TYPE_MUX_GROUP
80 * @group: the group selector to program
81 * @func: the function selector to program
82 */
83struct pinctrl_setting_mux {
84 unsigned group;
85 unsigned func;
86};
87
88/**
89 * struct pinctrl_setting_configs - setting data for MAP_TYPE_CONFIGS_*
90 * @group_or_pin: the group selector or pin ID to program
91 * @configs: a pointer to an array of config parameters/values to program into
92 * hardware. Each individual pin controller defines the format and meaning
93 * of config parameters.
94 * @num_configs: the number of entries in array @configs
95 */
96struct pinctrl_setting_configs {
97 unsigned group_or_pin;
98 unsigned long *configs;
99 unsigned num_configs;
100};
101
102/**
Linus Walleij872acc32012-03-06 13:52:22 +0100103 * struct pinctrl_setting - an individual mux or config setting
Stephen Warren6e5e9592012-03-02 13:05:47 -0700104 * @node: list node for struct pinctrl_settings's @settings field
Stephen Warren1e2082b2012-03-02 13:05:48 -0700105 * @type: the type of setting
Stephen Warren57291ce2012-03-23 10:29:46 -0600106 * @pctldev: pin control device handling to be programmed. Not used for
107 * PIN_MAP_TYPE_DUMMY_STATE.
Linus Walleij1a789582012-10-17 20:51:54 +0200108 * @dev_name: the name of the device using this state
Stephen Warren1e2082b2012-03-02 13:05:48 -0700109 * @data: Data specific to the setting type
Stephen Warren7ecdb162012-03-02 13:05:45 -0700110 */
111struct pinctrl_setting {
112 struct list_head node;
Stephen Warren1e2082b2012-03-02 13:05:48 -0700113 enum pinctrl_map_type type;
Linus Walleijbefe5bd2012-02-09 19:47:48 +0100114 struct pinctrl_dev *pctldev;
Linus Walleij1a789582012-10-17 20:51:54 +0200115 const char *dev_name;
Stephen Warren1e2082b2012-03-02 13:05:48 -0700116 union {
117 struct pinctrl_setting_mux mux;
118 struct pinctrl_setting_configs configs;
119 } data;
Linus Walleij2744e8a2011-05-02 20:50:54 +0200120};
121
122/**
123 * struct pin_desc - pin descriptor for each physical pin in the arch
124 * @pctldev: corresponding pin control device
125 * @name: a name for the pin, e.g. the name of the pin/pad/finger on a
126 * datasheet or such
Linus Walleijca53c5f2011-12-14 20:33:37 +0100127 * @dynamic_name: if the name of this pin was dynamically allocated
Stephen Warren652162d2012-03-05 17:22:15 -0700128 * @mux_usecount: If zero, the pin is not claimed, and @owner should be NULL.
Stephen Warren0e3db1732012-03-02 13:05:46 -0700129 * If non-zero, this pin is claimed by @owner. This field is an integer
130 * rather than a boolean, since pinctrl_get() might process multiple
131 * mapping table entries that refer to, and hence claim, the same group
132 * or pin, and each of these will increment the @usecount.
Stephen Warren652162d2012-03-05 17:22:15 -0700133 * @mux_owner: The name of device that called pinctrl_get().
Stephen Warrenba110d92012-03-02 13:05:49 -0700134 * @mux_setting: The most recent selected mux setting for this pin, if any.
Stephen Warren652162d2012-03-05 17:22:15 -0700135 * @gpio_owner: If pinctrl_request_gpio() was called for this pin, this is
136 * the name of the GPIO that "owns" this pin.
Linus Walleij2744e8a2011-05-02 20:50:54 +0200137 */
138struct pin_desc {
139 struct pinctrl_dev *pctldev;
Stephen Warren9af1e442011-10-19 16:19:27 -0600140 const char *name;
Linus Walleijca53c5f2011-12-14 20:33:37 +0100141 bool dynamic_name;
Linus Walleij2744e8a2011-05-02 20:50:54 +0200142 /* These fields only added when supporting pinmux drivers */
143#ifdef CONFIG_PINMUX
Stephen Warren652162d2012-03-05 17:22:15 -0700144 unsigned mux_usecount;
145 const char *mux_owner;
Stephen Warrenba110d92012-03-02 13:05:49 -0700146 const struct pinctrl_setting_mux *mux_setting;
Stephen Warren652162d2012-03-05 17:22:15 -0700147 const char *gpio_owner;
Linus Walleij2744e8a2011-05-02 20:50:54 +0200148#endif
149};
150
Linus Walleij9dfac4f2012-02-01 18:02:47 +0100151struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *dev_name);
Linus Walleijae6b4d82011-10-19 18:14:33 +0200152int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name);
Dong Aishengdcb5dbc2012-04-17 15:00:46 +0800153const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin);
Linus Walleij7afde8b2011-10-19 17:07:16 +0200154int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
155 const char *pin_group);
Stephen Warren2304b472012-02-22 14:26:01 -0700156
157static inline struct pin_desc *pin_desc_get(struct pinctrl_dev *pctldev,
158 unsigned int pin)
159{
160 return radix_tree_lookup(&pctldev->pin_desc_tree, pin);
161}
Stephen Warren57b676f2012-03-02 13:05:44 -0700162
Stephen Warren57291ce2012-03-23 10:29:46 -0600163int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps,
164 bool dup, bool locked);
165void pinctrl_unregister_map(struct pinctrl_map const *map);
166
Stephen Warren57b676f2012-03-02 13:05:44 -0700167extern struct mutex pinctrl_mutex;
Stephen Warren57291ce2012-03-23 10:29:46 -0600168extern struct list_head pinctrldev_list;