include/dm/pinctrl.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
13  * struct pinconf_param - pin config parameters
27  * struct pinctrl_ops - pin control operations, to be implemented by
47  *	in this driver.  (necessary for pin-muxing)
50  *	certain device to.  (necessary for pin-muxing)
54  *	may be ignored.  (necessary for pin-muxing against a single pin)
59  *	(necessary for pin-muxing against a pin group)
60  * @pinconf_num_params: number of driver-specific parameters to be parsed
61  *	from device trees  (necessary for pin-configuration)
63  *	device trees  (necessary for pin-configuration)
65  *	(necessary for pin-configuration against a single pin)
67  *	(necessary for pin-configuration against a pin group)
94 	/* for pinctrl-simple */
97 	 * request() - Request a particular pinctrl function
102 	 * @func:	Function number (driver-specific)
103 	 * @return 0 if OK, -ve on error
108 	* get_periph_id() - get the peripheral ID for a device
117 	* @return peripheral ID of @periph, or -ENOENT on error
122 	 * get_gpio_mux() - get the mux value for a particular GPIO
126 	 * as with the 'gpio' command. This function is internal to the GPIO
133 	* @return mux value (SoC-specific, e.g. 0 for input, 1 for output)
138 	 * get_pin_muxing() - show pin muxing
150 	 * return 0 if OK, -ve on error
156 #define pinctrl_get_ops(dev)	((struct pinctrl_ops *)(dev)->driver->ops)
161  * enum pin_config_param - possible pin configuration parameters
167  * @PIN_CONFIG_BIAS_DISABLE: disable any pin bias on the pin, a
168  *	transition from say pull-up to pull-down implies that you disable
169  *	pull-up in the process, this setting disables all biasing.
171  *	mode, also know as "third-state" (tristate) or "high-Z" or "floating".
177  *	impedance to GROUND). If the argument is != 0 pull-down is enabled,
178  *	if it is 0, pull-down is total, i.e. the pin is connected to GROUND.
188  *	impedance to VDD). If the argument is != 0 pull-up is enabled,
189  *	if it is 0, pull-up is total, i.e. the pin is connected to VDD.
192  *	which are then pulled up with an external resistor. Setting this
200  *	push-pull mode, the argument is ignored.
211  *	schmitt-trigger mode. If the schmitt-trigger has adjustable hysteresis,
214  * @PIN_CONFIG_INPUT_SCHMITT_ENABLE: control schmitt-trigger mode on the pin.
215  *      If the argument != 0, schmitt-trigger mode is enabled. If it's 0,
216  *      schmitt-trigger mode is disabled.
229  *	indicate low level. (Please see Documentation/driver-api/pinctl.rst,
276  * pinctrl_generic_set_state() - generic set_state operation
289 	return -EINVAL;  in pinctrl_generic_set_state()
295  * pinctrl_select_state() - set a device to a given state
306 	return -EINVAL;  in pinctrl_select_state()
311  * pinctrl_request() - Request a particular pinctrl function
314  * @func:	Function number (driver-specific)
315  * @flags:	Flags (driver-specific)
316  * @return 0 if OK, -ve on error
321  * pinctrl_request_noflags() - Request a particular pinctrl function
326  * @func:	Function number (driver-specific)
327  * @return 0 if OK, -ve on error
332  * pinctrl_get_periph_id() - get the peripheral ID for a device
340  * @return peripheral ID of @periph, or -ENOENT on error
345  * pinctrl_decode_pin_config() - decode pin configuration flags
353  * @return decoded flag value, or -ve on error
358  * pinctrl_decode_pin_config_dm() - decode pin configuration flags
365  * @return decoded flag value, or -ve on error
370  * pinctrl_get_gpio_mux() - get the mux value for a particular GPIO
374  * as with the 'gpio' command. This function is internal to the GPIO
381  * @return mux value (SoC-specific, e.g. 0 for input, 1 for output)
386  * pinctrl_get_pin_muxing() - Returns the muxing description
392  * @selector	Pin index within pin-controller
395  * @return 0 if OK, -ve on error
401  * pinctrl_get_pins_count() - display pin-controller pins number
403  * This allows to know the number of pins owned by a given pin-controller
406  * @return pins number if OK, -ve on error
411  * pinctrl_get_pin_name() - Returns the pin's name
416  * @selector	Pin index within pin-controller
418  * @return 0 if OK, -ve on error