linux/pinctrl/pinctrl.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Interface the pinctrl subsystem
5  * Copyright (C) 2011 ST-Ericsson SA
6  * Written on behalf of Linaro for ST-Ericsson
30  * struct pingroup - provides information on pingroup
32  * @pins: an array of pins in the pingroup
50  * struct pinctrl_pin_desc - boards/machines provide information on their
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
62 /* Convenience macro to define a single named or anonymous pin descriptor */
67  * struct pinctrl_gpio_range - each pin controller can provide subranges of
73  * @pin_base: base pin number of the GPIO range if pins == NULL
90  * struct pinctrl_ops - global pin control operations, to be implemented by
91  * pin controller drivers.
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
101  *	omitted for pinctrl drivers that do not support device tree.
103  *	top-level @map pointer must be freed, along with any dynamically
105  *	function is optional, and may be omitted for pinctrl drivers that do
126  * struct pinctrl_desc - pin controller descriptor, register this to pin
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()
133  * @pctlops: pin control operation vtable, to support global concepts like
136  * @confops: pin config operations vtable, if you support pin configuration in
138  * @owner: module providing the pin controller, used for refcounting
139  * @num_custom_params: Number of driver-specific custom parameters to be parsed
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
166 /* External interface to pin controller */
204 				 unsigned int pin);
210  * struct pinfunction - Description about a function
212  * @groups: An array of groups for this function