1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Interface the pinctrl subsystem
4 *
5 * Copyright (C) 2011 ST-Ericsson SA
6 * Written on behalf of Linaro for ST-Ericsson
7 * This interface is used in the core to keep track of pins.
8 *
9 * Author: Linus Walleij <linus.walleij@linaro.org>
10 */
11#ifndef __LINUX_PINCTRL_PINCTRL_H
12#define __LINUX_PINCTRL_PINCTRL_H
13
14#include <linux/types.h>
15
16struct device;
17struct device_node;
18struct gpio_chip;
19struct module;
20struct seq_file;
21
22struct pin_config_item;
23struct pinconf_generic_params;
24struct pinconf_ops;
25struct pinctrl_dev;
26struct pinctrl_map;
27struct pinmux_ops;
28
29/**
30 * struct pingroup - provides information on pingroup
31 * @name: a name for pingroup
32 * @pins: an array of pins in the pingroup
33 * @npins: number of pins in the pingroup
34 */
35struct pingroup {
36	const char *name;
37	const unsigned int *pins;
38	size_t npins;
39};
40
41/* Convenience macro to define a single named or anonymous pingroup */
42#define PINCTRL_PINGROUP(_name, _pins, _npins)	\
43(struct pingroup) {				\
44	.name = _name,				\
45	.pins = _pins,				\
46	.npins = _npins,			\
47}
48
49/**
50 * struct pinctrl_pin_desc - boards/machines provide information on their
51 * pins, pads or other muxable units in this struct
52 * @number: unique pin number from the global pin number space
53 * @name: a name for this pin
54 * @drv_data: driver-defined per-pin data. pinctrl core does not touch this
55 */
56struct pinctrl_pin_desc {
57	unsigned int number;
58	const char *name;
59	void *drv_data;
60};
61
62/* Convenience macro to define a single named or anonymous pin descriptor */
63#define PINCTRL_PIN(a, b) { .number = a, .name = b }
64#define PINCTRL_PIN_ANON(a) { .number = a }
65
66/**
67 * struct pinctrl_gpio_range - each pin controller can provide subranges of
68 * the GPIO number space to be handled by the controller
69 * @node: list node for internal use
70 * @name: a name for the chip in this range
71 * @id: an ID number for the chip in this range
72 * @base: base offset of the GPIO range
73 * @pin_base: base pin number of the GPIO range if pins == NULL
74 * @npins: number of pins in the GPIO range, including the base number
75 * @pins: enumeration of pins in GPIO range or NULL
76 * @gc: an optional pointer to a gpio_chip
77 */
78struct pinctrl_gpio_range {
79	struct list_head node;
80	const char *name;
81	unsigned int id;
82	unsigned int base;
83	unsigned int pin_base;
84	unsigned int npins;
85	unsigned int const *pins;
86	struct gpio_chip *gc;
87};
88
89/**
90 * struct pinctrl_ops - global pin control operations, to be implemented by
91 * pin controller drivers.
92 * @get_groups_count: Returns the count of total number of groups registered.
93 * @get_group_name: return the group name of the pin group
94 * @get_group_pins: return an array of pins corresponding to a certain
95 *	group selector @pins, and the size of the array in @num_pins
96 * @pin_dbg_show: optional debugfs display hook that will provide per-device
97 *	info for a certain pin in debugfs
98 * @dt_node_to_map: parse a device tree "pin configuration node", and create
99 *	mapping table entries for it. These are returned through the @map and
100 *	@num_maps output parameters. This function is optional, and may be
101 *	omitted for pinctrl drivers that do not support device tree.
102 * @dt_free_map: free mapping table entries created via @dt_node_to_map. The
103 *	top-level @map pointer must be freed, along with any dynamically
104 *	allocated members of the mapping table entries themselves. This
105 *	function is optional, and may be omitted for pinctrl drivers that do
106 *	not support device tree.
107 */
108struct pinctrl_ops {
109	int (*get_groups_count) (struct pinctrl_dev *pctldev);
110	const char *(*get_group_name) (struct pinctrl_dev *pctldev,
111				       unsigned int selector);
112	int (*get_group_pins) (struct pinctrl_dev *pctldev,
113			       unsigned int selector,
114			       const unsigned int **pins,
115			       unsigned int *num_pins);
116	void (*pin_dbg_show) (struct pinctrl_dev *pctldev, struct seq_file *s,
117			      unsigned int offset);
118	int (*dt_node_to_map) (struct pinctrl_dev *pctldev,
119			       struct device_node *np_config,
120			       struct pinctrl_map **map, unsigned int *num_maps);
121	void (*dt_free_map) (struct pinctrl_dev *pctldev,
122			     struct pinctrl_map *map, unsigned int num_maps);
123};
124
125/**
126 * struct pinctrl_desc - pin controller descriptor, register this to pin
127 * control subsystem
128 * @name: name for the pin controller
129 * @pins: an array of pin descriptors describing all the pins handled by
130 *	this pin controller
131 * @npins: number of descriptors in the array, usually just ARRAY_SIZE()
132 *	of the pins field above
133 * @pctlops: pin control operation vtable, to support global concepts like
134 *	grouping of pins, this is optional.
135 * @pmxops: pinmux operations vtable, if you support pinmuxing in your driver
136 * @confops: pin config operations vtable, if you support pin configuration in
137 *	your driver
138 * @owner: module providing the pin controller, used for refcounting
139 * @num_custom_params: Number of driver-specific custom parameters to be parsed
140 *	from the hardware description
141 * @custom_params: List of driver_specific custom parameters to be parsed from
142 *	the hardware description
143 * @custom_conf_items: Information how to print @params in debugfs, must be
144 *	the same size as the @custom_params, i.e. @num_custom_params
145 * @link_consumers: If true create a device link between pinctrl and its
146 *	consumers (i.e. the devices requesting pin control states). This is
147 *	sometimes necessary to ascertain the right suspend/resume order for
148 *	example.
149 */
150struct pinctrl_desc {
151	const char *name;
152	const struct pinctrl_pin_desc *pins;
153	unsigned int npins;
154	const struct pinctrl_ops *pctlops;
155	const struct pinmux_ops *pmxops;
156	const struct pinconf_ops *confops;
157	struct module *owner;
158#ifdef CONFIG_GENERIC_PINCONF
159	unsigned int num_custom_params;
160	const struct pinconf_generic_params *custom_params;
161	const struct pin_config_item *custom_conf_items;
162#endif
163	bool link_consumers;
164};
165
166/* External interface to pin controller */
167
168extern int pinctrl_register_and_init(struct pinctrl_desc *pctldesc,
169				     struct device *dev, void *driver_data,
170				     struct pinctrl_dev **pctldev);
171extern int pinctrl_enable(struct pinctrl_dev *pctldev);
172
173/* Please use pinctrl_register_and_init() and pinctrl_enable() instead */
174extern struct pinctrl_dev *pinctrl_register(struct pinctrl_desc *pctldesc,
175				struct device *dev, void *driver_data);
176
177extern void pinctrl_unregister(struct pinctrl_dev *pctldev);
178
179extern int devm_pinctrl_register_and_init(struct device *dev,
180				struct pinctrl_desc *pctldesc,
181				void *driver_data,
182				struct pinctrl_dev **pctldev);
183
184/* Please use devm_pinctrl_register_and_init() instead */
185extern struct pinctrl_dev *devm_pinctrl_register(struct device *dev,
186				struct pinctrl_desc *pctldesc,
187				void *driver_data);
188
189extern void devm_pinctrl_unregister(struct device *dev,
190				struct pinctrl_dev *pctldev);
191
192extern void pinctrl_add_gpio_range(struct pinctrl_dev *pctldev,
193				struct pinctrl_gpio_range *range);
194extern void pinctrl_add_gpio_ranges(struct pinctrl_dev *pctldev,
195				struct pinctrl_gpio_range *ranges,
196				unsigned int nranges);
197extern void pinctrl_remove_gpio_range(struct pinctrl_dev *pctldev,
198				struct pinctrl_gpio_range *range);
199
200extern struct pinctrl_dev *pinctrl_find_and_add_gpio_range(const char *devname,
201		struct pinctrl_gpio_range *range);
202extern struct pinctrl_gpio_range *
203pinctrl_find_gpio_range_from_pin(struct pinctrl_dev *pctldev,
204				 unsigned int pin);
205extern int pinctrl_get_group_pins(struct pinctrl_dev *pctldev,
206				  const char *pin_group, const unsigned int **pins,
207				  unsigned int *num_pins);
208
209/**
210 * struct pinfunction - Description about a function
211 * @name: Name of the function
212 * @groups: An array of groups for this function
213 * @ngroups: Number of groups in @groups
214 */
215struct pinfunction {
216	const char *name;
217	const char * const *groups;
218	size_t ngroups;
219};
220
221/* Convenience macro to define a single named pinfunction */
222#define PINCTRL_PINFUNCTION(_name, _groups, _ngroups)	\
223(struct pinfunction) {					\
224		.name = (_name),			\
225		.groups = (_groups),			\
226		.ngroups = (_ngroups),			\
227	}
228
229#if IS_ENABLED(CONFIG_OF) && IS_ENABLED(CONFIG_PINCTRL)
230extern struct pinctrl_dev *of_pinctrl_get(struct device_node *np);
231#else
232static inline
233struct pinctrl_dev *of_pinctrl_get(struct device_node *np)
234{
235	return NULL;
236}
237#endif /* CONFIG_OF */
238
239extern const char *pinctrl_dev_get_name(struct pinctrl_dev *pctldev);
240extern const char *pinctrl_dev_get_devname(struct pinctrl_dev *pctldev);
241extern void *pinctrl_dev_get_drvdata(struct pinctrl_dev *pctldev);
242
243#endif /* __LINUX_PINCTRL_PINCTRL_H */
244