random-mirrors/smaeul-u-boot
1
0
Fork 0
mirror of https://github.com/smaeul/u-boot.git synced 2025-10-13 20:36:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

pinctrl: Reformat documentation in dm/pinctrl.h

Browse Source 
This normalizes the documentation to conform to kernel-doc style [1]. It
also moves the documentation for pinctrl_ops inline, and adds argument and
return-value documentation. I have kept the usual function style for these
comments. I could not find any existing examples of function documentation
inside structs.

[1] https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html

Signed-off-by: Sean Anderson <seanga2@gmail.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Sean Anderson 2020-09-14 11:01:56 -04:00 committed by Tom Rini
parent 9c08fbfc95
commit 5eee93e5b1
3 changed files with 347 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/index.rst
View File

@ -9,6 +9,7 @@ U-Boot API documentation
dfu dfu
efi efi
linker_lists linker_lists
pinctrl
rng rng
serial serial
unicode unicode

7
doc/api/pinctrl.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+
Pinctrl and Pinmux
==================
.. kernel-doc:: include/dm/pinctrl.h
:internal:

501
include/dm/pinctrl.h
View File

@ -1,6 +1,6 @@
/* SPDX-License-Identifier: GPL-2.0+ */ /* SPDX-License-Identifier: GPL-2.0+ */
/* /*
* Copyright (C) 2015 Masahiro Yamada <yamada.masahiro@socionext.com> * Copyright (C) 2015 Masahiro Yamada <yamada.masahiro@com>
*/ */
#ifndef __PINCTRL_H #ifndef __PINCTRL_H
@ -11,11 +11,10 @@
/** /**
* struct pinconf_param - pin config parameters * struct pinconf_param - pin config parameters
* * @property: Property name in DT nodes
* @property: property name in DT nodes * @param: ID for this config parameter
* @param: ID for this config parameter * @default_value: default value for this config parameter used in case
* @default_value: default value for this config parameter used in case * no value is specified in DT nodes
* no value is specified in DT nodes
*/ */
struct pinconf_param { struct pinconf_param {
const char * const property; const char * const property;
@ -27,111 +26,274 @@ struct pinconf_param {
* struct pinctrl_ops - pin control operations, to be implemented by * struct pinctrl_ops - pin control operations, to be implemented by
* pin controller drivers. * pin controller drivers.
* *
* The @set_state is the only mandatory operation. You can implement your * set_state() is the only mandatory operation. You can implement your pinctrl
* pinctrl driver with its own @set_state. In this case, the other callbacks * driver with its own @set_state. In this case, the other callbacks are not
* are not required. Otherwise, generic pinctrl framework is also available; * required. Otherwise, generic pinctrl framework is also available; use
* use pinctrl_generic_set_state for @set_state, and implement other operations * pinctrl_generic_set_state for @set_state, and implement other operations
* depending on your necessity. * depending on your necessity.
*
* @get_pins_count: return number of selectable named pins available
* in this driver. (necessary to parse "pins" property in DTS)
* @get_pin_name: return the pin name of the pin selector,
* called by the core to figure out which pin it shall do
* operations to. (necessary to parse "pins" property in DTS)
* @get_groups_count: return number of selectable named groups available
* in this driver. (necessary to parse "groups" property in DTS)
* @get_group_name: return the group name of the group selector,
* called by the core to figure out which pin group it shall do
* operations to. (necessary to parse "groups" property in DTS)
* @get_functions_count: return number of selectable named functions available
* in this driver. (necessary for pin-muxing)
* @get_function_name: return the function name of the muxing selector,
* called by the core to figure out which mux setting it shall map a
* certain device to. (necessary for pin-muxing)
* @pinmux_set: enable a certain muxing function with a certain pin.
* The @func_selector selects a certain function whereas @pin_selector
* selects a certain pin to be used. On simple controllers one of them
* may be ignored. (necessary for pin-muxing against a single pin)
* @pinmux_group_set: enable a certain muxing function with a certain pin
* group. The @func_selector selects a certain function whereas
* @group_selector selects a certain set of pins to be used. On simple
* controllers one of them may be ignored.
* (necessary for pin-muxing against a pin group)
* @pinmux_property_set: enable a pinmux group. @pinmux_group should specify the
* pin identifier and mux settings. The exact format of a pinmux group is
* left up to the driver. The pin selector for the mux-ed pin should be
* returned on success. (necessary to parse the "pinmux" property in DTS)
* @pinconf_num_params: number of driver-specific parameters to be parsed
* from device trees (necessary for pin-configuration)
* @pinconf_params: list of driver_specific parameters to be parsed from
* device trees (necessary for pin-configuration)
* @pinconf_set: configure an individual pin with a given parameter.
* (necessary for pin-configuration against a single pin)
* @pinconf_group_set: configure all pins in a group with a given parameter.
* (necessary for pin-configuration against a pin group)
* @set_state: do pinctrl operations specified by @config, a pseudo device
* pointing a config node. (necessary for pinctrl_full)
* @set_state_simple: do needed pinctrl operations for a peripherl @periph.
* (necessary for pinctrl_simple)
* @get_pin_muxing: display the muxing of a given pin.
* @gpio_request_enable: requests and enables GPIO on a certain pin.
* Implement this only if you can mux every pin individually as GPIO. The
* affected GPIO range is passed along with an offset(pin number) into that
* specific GPIO range - function selectors and pin groups are orthogonal
* to this, the core will however make sure the pins do not collide.
* @gpio_disable_free: free up GPIO muxing on a certain pin, the reverse of
* @gpio_request_enable
*/ */
struct pinctrl_ops { struct pinctrl_ops {
/**
* @get_pins_count: Get the number of selectable pins
*
* @dev: Pinctrl device to use
*
* This function is necessary to parse the "pins" property in DTS.
*
* @Return:
* number of selectable named pins available in this driver
*/
int (*get_pins_count)(struct udevice *dev); int (*get_pins_count)(struct udevice *dev);
/**
* @get_pin_name: Get the name of a pin
*
* @dev: Pinctrl device of the pin
*
* @selector: The pin selector
*
* This function is called by the core to figure out which pin it will
* do operations to. This function is necessary to parse the "pins"
* property in DTS.
*
* @Return: const pointer to the name of the pin
*/
const char *(*get_pin_name)(struct udevice *dev, unsigned selector); const char *(*get_pin_name)(struct udevice *dev, unsigned selector);
/**
* @get_groups_count: Get the number of selectable groups
*
* @dev: Pinctrl device to use
*
* This function is necessary to parse the "groups" property in DTS.
*
* @Return:
* number of selectable named groups available in the driver
*/
int (*get_groups_count)(struct udevice *dev); int (*get_groups_count)(struct udevice *dev);
/**
* @get_group_name: Get the name of a group
*
* @dev: Pinctrl device of the group
*
* @selector: The group selector
*
* This function is called by the core to figure out which group it
* will do operations to. This function is necessary to parse the
* "groups" property in DTS.
*
* @Return: Pointer to the name of the group
*/
const char *(*get_group_name)(struct udevice *dev, unsigned selector); const char *(*get_group_name)(struct udevice *dev, unsigned selector);
/**
* @get_functions_count: Get the number of selectable functions
*
* @dev: Pinctrl device to use
*
* This function is necessary for pin-muxing.
*
* @Return:
* number of selectable named functions available in this driver
*/
int (*get_functions_count)(struct udevice *dev); int (*get_functions_count)(struct udevice *dev);
/**
* @get_function_name: Get the name of a function
*
* @dev: Pinmux device of the function
*
* @selector: The function selector
*
* This function is called by the core to figure out which mux setting
* it will map a certain device to. This function is necessary for
* pin-muxing.
*
* @Return:
* Pointer to the function name of the muxing selector
*/
const char *(*get_function_name)(struct udevice *dev, const char *(*get_function_name)(struct udevice *dev,
unsigned selector); unsigned selector);
/**
* @pinmux_set: Mux a pin to a function
*
* @dev: Pinctrl device to use
*
* @pin_selector: The pin selector
*
* @func_selector: The func selector
*
* On simple controllers one of @pin_selector or @func_selector may be
* ignored. This function is necessary for pin-muxing against a single
* pin.
*
* @Return: 0 if OK, or negative error code on failure
*/
int (*pinmux_set)(struct udevice *dev, unsigned pin_selector, int (*pinmux_set)(struct udevice *dev, unsigned pin_selector,
unsigned func_selector); unsigned func_selector);
/**
* @pinmux_group_set: Mux a group of pins to a function
*
* @dev: Pinctrl device to use
*
* @group_selector: The group selector
*
* @func_selector: The func selector
*
* On simple controllers one of @group_selector or @func_selector may be
* ignored. This function is necessary for pin-muxing against a group of
* pins.
*
* @Return: 0 if OK, or negative error code on failure
*/
int (*pinmux_group_set)(struct udevice *dev, unsigned group_selector, int (*pinmux_group_set)(struct udevice *dev, unsigned group_selector,
unsigned func_selector); unsigned func_selector);
/**
* @pinmux_property_set: Enable a pinmux group
*
* @dev: Pinctrl device to use
*
* @pinmux_group: A u32 representing the pin identifier and mux
* settings. The exact format of a pinmux group is left
* up to the driver.
*
* Mux a single pin to a single function based on a driver-specific
* pinmux group. This function is necessary for parsing the "pinmux"
* property in DTS, and for pin-muxing against a pinmux group.
*
* @Return:
* Pin selector for the muxed pin if OK, or negative error code on
* failure
*/
int (*pinmux_property_set)(struct udevice *dev, u32 pinmux_group); int (*pinmux_property_set)(struct udevice *dev, u32 pinmux_group);
/**
* @pinconf_num_params:
* Number of driver-specific parameters to be parsed from device
* trees. This member is necessary for pin configuration.
*/
unsigned int pinconf_num_params; unsigned int pinconf_num_params;
/**
* @pinconf_params:
* List of driver-specific parameters to be parsed from the device
* tree. This member is necessary for pin configuration.
*/
const struct pinconf_param *pinconf_params; const struct pinconf_param *pinconf_params;
/**
* @pinconf_set: Configure an individual pin with a parameter
*
* @dev: Pinctrl device to use
*
* @pin_selector: The pin selector
*
* @param: An &enum pin_config_param from @pinconf_params
*
* @argument: The argument to this param from the device tree, or
* @pinconf_params.default_value
*
* This function is necessary for pin configuration against a single
* pin.
*
* @Return: 0 if OK, or negative error code on failure
*/
int (*pinconf_set)(struct udevice *dev, unsigned pin_selector, int (*pinconf_set)(struct udevice *dev, unsigned pin_selector,
unsigned param, unsigned argument); unsigned param, unsigned argument);
/**
* @pinconf_group_set: Configure all pins in a group with a parameter
*
* @dev: Pinctrl device to use
*
* @pin_selector: The group selector
*
* @param: A &enum pin_config_param from
* @pinconf_params
*
* @argument: The argument to this param from the device tree, or
* @pinconf_params.default_value
*
* This function is necessary for pin configuration against a group of
* pins.
*
* @Return: 0 if OK, or negative error code on failure
*/
int (*pinconf_group_set)(struct udevice *dev, unsigned group_selector, int (*pinconf_group_set)(struct udevice *dev, unsigned group_selector,
unsigned param, unsigned argument); unsigned param, unsigned argument);
/**
* @set_state: Configure a pinctrl device
*
* @dev: Pinctrl device to use
*
* @config: Pseudo device pointing a config node
*
* This function is required to be implemented by all pinctrl drivers.
* Drivers may set this member to pinctrl_generic_set_state(), which
* will call other functions in &struct pinctrl_ops to parse
* @config.
*
* @Return: 0 if OK, or negative error code on failure
*/
int (*set_state)(struct udevice *dev, struct udevice *config); int (*set_state)(struct udevice *dev, struct udevice *config);
/* for pinctrl-simple */
int (*set_state_simple)(struct udevice *dev, struct udevice *periph);
/** /**
* request() - Request a particular pinctrl function * @set_state_simple: Configure a pinctrl device
*
* @dev: Pinctrl device to use
*
* @config: Pseudo-device pointing a config node
*
* This function is usually a simpler version of set_state(). Only the
* first pinctrl device on the system is supported by this function.
*
* @Return: 0 if OK, or negative error code on failure
*/
int (*set_state_simple)(struct udevice *dev, struct udevice *periph);
/**
* @request: Request a particular pinctrl function
*
* @dev: Device to adjust (%UCLASS_PINCTRL)
*
* @func: Function number (driver-specific)
* *
* This activates the selected function. * This activates the selected function.
* *
* @dev: Device to adjust (UCLASS_PINCTRL) * @Return: 0 if OK, or negative error code on failure
* @func: Function number (driver-specific)
* @return 0 if OK, -ve on error
*/ */
int (*request)(struct udevice *dev, int func, int flags); int (*request)(struct udevice *dev, int func, int flags);
/** /**
* get_periph_id() - get the peripheral ID for a device * @get_periph_id: Get the peripheral ID for a device
*
* @dev: Pinctrl device to use for decoding
*
* @periph: Device to check
* *
* This generally looks at the peripheral's device tree node to work * This generally looks at the peripheral's device tree node to work
* out the peripheral ID. The return value is normally interpreted as * out the peripheral ID. The return value is normally interpreted as
* enum periph_id. so long as this is defined by the platform (which it * &enum periph_id. so long as this is defined by the platform (which it
* should be). * should be).
* *
* @dev: Pinctrl device to use for decoding * @Return:
* @periph: Device to check * Peripheral ID of @periph, or %-ENOENT on error
* @return peripheral ID of @periph, or -ENOENT on error
*/ */
int (*get_periph_id)(struct udevice *dev, struct udevice *periph); int (*get_periph_id)(struct udevice *dev, struct udevice *periph);
/** /**
* get_gpio_mux() - get the mux value for a particular GPIO * @get_gpio_mux: Get the mux value for a particular GPIO
*
* @dev: Pinctrl device to use
*
* @banknum: GPIO bank number
*
* @index: GPIO index within the bank
* *
* This allows the raw mux value for a GPIO to be obtained. It is * This allows the raw mux value for a GPIO to be obtained. It is
* useful for displaying the function being used by that GPIO, such * useful for displaying the function being used by that GPIO, such
@ -139,46 +301,60 @@ struct pinctrl_ops {
* subsystem and should not be used by generic code. Typically it is * subsystem and should not be used by generic code. Typically it is
* used by a GPIO driver with knowledge of the SoC pinctrl setup. * used by a GPIO driver with knowledge of the SoC pinctrl setup.
* *
* @dev: Pinctrl device to use * @Return:
* @banknum: GPIO bank number * Mux value (SoC-specific, e.g. 0 for input, 1 for output)
* @index: GPIO index within the bank
* @return mux value (SoC-specific, e.g. 0 for input, 1 for output)
*/ */
int (*get_gpio_mux)(struct udevice *dev, int banknum, int index); int (*get_gpio_mux)(struct udevice *dev, int banknum, int index);
/** /**
* get_pin_muxing() - show pin muxing * @get_pin_muxing: Show pin muxing
*
* @dev: Pinctrl device to use
*
* @selector: Pin selector
*
* @buf: Buffer to fill with pin muxing description
*
* @size: Size of @buf
* *
* This allows to display the muxing of a given pin. It's useful for * This allows to display the muxing of a given pin. It's useful for
* debug purpose to know if a pin is configured as GPIO or as an * debug purposes to know if a pin is configured as GPIO or as an
* alternate function and which one. * alternate function and which one. Typically it is used by a PINCTRL
* Typically it is used by a PINCTRL driver with knowledge of the SoC * driver with knowledge of the SoC pinctrl setup.
* pinctrl setup.
* *
* @dev: Pinctrl device to use * @Return: 0 if OK, or negative error code on failure
* @selector: Pin selector
* @buf Pin's muxing description
* @size Pin's muxing description length
* return 0 if OK, -ve on error
*/ */
int (*get_pin_muxing)(struct udevice *dev, unsigned int selector, int (*get_pin_muxing)(struct udevice *dev, unsigned int selector,
char *buf, int size); char *buf, int size);
/** /**
* gpio_request_enable: requests and enables GPIO on a certain pin. * @gpio_request_enable: Request and enable GPIO on a certain pin.
* *
* @dev: Pinctrl device to use * @dev: Pinctrl device to use
* @selector: Pin selector *
* return 0 if OK, -ve on error * @selector: Pin selector
*
* Implement this only if you can mux every pin individually as GPIO.
* The affected GPIO range is passed along with an offset(pin number)
* into that specific GPIO range - function selectors and pin groups are
* orthogonal to this, the core will however make sure the pins do not
* collide.
*
* @Return:
* 0 if OK, or negative error code on failure
*/ */
int (*gpio_request_enable)(struct udevice *dev, unsigned int selector); int (*gpio_request_enable)(struct udevice *dev, unsigned int selector);
/** /**
* gpio_disable_free: free up GPIO muxing on a certain pin. * @gpio_disable_free: Free up GPIO muxing on a certain pin.
* *
* @dev: Pinctrl device to use * @dev: Pinctrl device to use
* @selector: Pin selector *
* return 0 if OK, -ve on error * @selector: Pin selector
*
* This function is the reverse of @gpio_request_enable.
*
* @Return: 0 if OK, or negative error code on failure
*/ */
int (*gpio_disable_free)(struct udevice *dev, unsigned int selector); int (*gpio_disable_free)(struct udevice *dev, unsigned int selector);
}; };
@ -186,27 +362,26 @@ struct pinctrl_ops {
#define pinctrl_get_ops(dev) ((struct pinctrl_ops *)(dev)->driver->ops) #define pinctrl_get_ops(dev) ((struct pinctrl_ops *)(dev)->driver->ops)
/** /**
* Generic pin configuration paramters * enum pin_config_param - Generic pin configuration parameters
* *
* enum pin_config_param - possible pin configuration parameters * @PIN_CONFIG_BIAS_BUS_HOLD: The pin will be set to weakly latch so that it
* @PIN_CONFIG_BIAS_BUS_HOLD: the pin will be set to weakly latch so that it
* weakly drives the last value on a tristate bus, also known as a "bus * weakly drives the last value on a tristate bus, also known as a "bus
* holder", "bus keeper" or "repeater". This allows another device on the * holder", "bus keeper" or "repeater". This allows another device on the
* bus to change the value by driving the bus high or low and switching to * bus to change the value by driving the bus high or low and switching to
* tristate. The argument is ignored. * tristate. The argument is ignored.
* @PIN_CONFIG_BIAS_DISABLE: disable any pin bias on the pin, a * @PIN_CONFIG_BIAS_DISABLE: Disable any pin bias on the pin, a
* transition from say pull-up to pull-down implies that you disable * transition from say pull-up to pull-down implies that you disable
* pull-up in the process, this setting disables all biasing. * pull-up in the process, this setting disables all biasing.
* @PIN_CONFIG_BIAS_HIGH_IMPEDANCE: the pin will be set to a high impedance * @PIN_CONFIG_BIAS_HIGH_IMPEDANCE: The pin will be set to a high impedance
* mode, also know as "third-state" (tristate) or "high-Z" or "floating". * mode, also know as "third-state" (tristate) or "high-Z" or "floating".
* On output pins this effectively disconnects the pin, which is useful * On output pins this effectively disconnects the pin, which is useful
* if for example some other pin is going to drive the signal connected * if for example some other pin is going to drive the signal connected
* to it for a while. Pins used for input are usually always high * to it for a while. Pins used for input are usually always high
* impedance. * impedance.
* @PIN_CONFIG_BIAS_PULL_DOWN: the pin will be pulled down (usually with high * @PIN_CONFIG_BIAS_PULL_DOWN: The pin will be pulled down (usually with high
* impedance to GROUND). If the argument is != 0 pull-down is enabled, * impedance to GROUND). If the argument is != 0 pull-down is enabled,
* if it is 0, pull-down is total, i.e. the pin is connected to GROUND. * if it is 0, pull-down is total, i.e. the pin is connected to GROUND.
* @PIN_CONFIG_BIAS_PULL_PIN_DEFAULT: the pin will be pulled up or down based * @PIN_CONFIG_BIAS_PULL_PIN_DEFAULT: The pin will be pulled up or down based
* on embedded knowledge of the controller hardware, like current mux * on embedded knowledge of the controller hardware, like current mux
* function. The pull direction and possibly strength too will normally * function. The pull direction and possibly strength too will normally
* be decided completely inside the hardware block and not be readable * be decided completely inside the hardware block and not be readable
@ -214,67 +389,67 @@ struct pinctrl_ops {
* If the argument is != 0 pull up/down is enabled, if it is 0, the * If the argument is != 0 pull up/down is enabled, if it is 0, the
* configuration is ignored. The proper way to disable it is to use * configuration is ignored. The proper way to disable it is to use
* @PIN_CONFIG_BIAS_DISABLE. * @PIN_CONFIG_BIAS_DISABLE.
* @PIN_CONFIG_BIAS_PULL_UP: the pin will be pulled up (usually with high * @PIN_CONFIG_BIAS_PULL_UP: The pin will be pulled up (usually with high
* impedance to VDD). If the argument is != 0 pull-up is enabled, * impedance to VDD). If the argument is != 0 pull-up is enabled,
* if it is 0, pull-up is total, i.e. the pin is connected to VDD. * if it is 0, pull-up is total, i.e. the pin is connected to VDD.
* @PIN_CONFIG_DRIVE_OPEN_DRAIN: the pin will be driven with open drain (open * @PIN_CONFIG_DRIVE_OPEN_DRAIN: The pin will be driven with open drain (open
* collector) which means it is usually wired with other output ports * collector) which means it is usually wired with other output ports
* which are then pulled up with an external resistor. Setting this * which are then pulled up with an external resistor. Setting this
* config will enable open drain mode, the argument is ignored. * config will enable open drain mode, the argument is ignored.
* @PIN_CONFIG_DRIVE_OPEN_SOURCE: the pin will be driven with open source * @PIN_CONFIG_DRIVE_OPEN_SOURCE: The pin will be driven with open source
* (open emitter). Setting this config will enable open source mode, the * (open emitter). Setting this config will enable open source mode, the
* argument is ignored. * argument is ignored.
* @PIN_CONFIG_DRIVE_PUSH_PULL: the pin will be driven actively high and * @PIN_CONFIG_DRIVE_PUSH_PULL: The pin will be driven actively high and
* low, this is the most typical case and is typically achieved with two * low, this is the most typical case and is typically achieved with two
* active transistors on the output. Setting this config will enable * active transistors on the output. Setting this config will enable
* push-pull mode, the argument is ignored. * push-pull mode, the argument is ignored.
* @PIN_CONFIG_DRIVE_STRENGTH: the pin will sink or source at most the current * @PIN_CONFIG_DRIVE_STRENGTH: The pin will sink or source at most the current
* passed as argument. The argument is in mA. * passed as argument. The argument is in mA.
* @PIN_CONFIG_DRIVE_STRENGTH_UA: the pin will sink or source at most the current * @PIN_CONFIG_DRIVE_STRENGTH_UA: The pin will sink or source at most the
* passed as argument. The argument is in uA. * current passed as argument. The argument is in uA.
* @PIN_CONFIG_INPUT_DEBOUNCE: this will configure the pin to debounce mode, * @PIN_CONFIG_INPUT_DEBOUNCE: This will configure the pin to debounce mode,
* which means it will wait for signals to settle when reading inputs. The * which means it will wait for signals to settle when reading inputs. The
* argument gives the debounce time in usecs. Setting the * argument gives the debounce time in usecs. Setting the
* argument to zero turns debouncing off. * argument to zero turns debouncing off.
* @PIN_CONFIG_INPUT_ENABLE: enable the pin's input. Note that this does not * @PIN_CONFIG_INPUT_ENABLE: Enable the pin's input. Note that this does not
* affect the pin's ability to drive output. 1 enables input, 0 disables * affect the pin's ability to drive output. 1 enables input, 0 disables
* input. * input.
* @PIN_CONFIG_INPUT_SCHMITT: this will configure an input pin to run in * @PIN_CONFIG_INPUT_SCHMITT: This will configure an input pin to run in
* schmitt-trigger mode. If the schmitt-trigger has adjustable hysteresis, * schmitt-trigger mode. If the schmitt-trigger has adjustable hysteresis,
* the threshold value is given on a custom format as argument when * the threshold value is given on a custom format as argument when
* setting pins to this mode. * setting pins to this mode.
* @PIN_CONFIG_INPUT_SCHMITT_ENABLE: control schmitt-trigger mode on the pin. * @PIN_CONFIG_INPUT_SCHMITT_ENABLE: Control schmitt-trigger mode on the pin.
* If the argument != 0, schmitt-trigger mode is enabled. If it's 0, * If the argument != 0, schmitt-trigger mode is enabled. If it's 0,
* schmitt-trigger mode is disabled. * schmitt-trigger mode is disabled.
* @PIN_CONFIG_LOW_POWER_MODE: this will configure the pin for low power * @PIN_CONFIG_LOW_POWER_MODE: This will configure the pin for low power
* operation, if several modes of operation are supported these can be * operation, if several modes of operation are supported these can be
* passed in the argument on a custom form, else just use argument 1 * passed in the argument on a custom form, else just use argument 1
* to indicate low power mode, argument 0 turns low power mode off. * to indicate low power mode, argument 0 turns low power mode off.
* @PIN_CONFIG_OUTPUT_ENABLE: this will enable the pin's output mode * @PIN_CONFIG_OUTPUT_ENABLE: This will enable the pin's output mode
* without driving a value there. For most platforms this reduces to * without driving a value there. For most platforms this reduces to
* enable the output buffers and then let the pin controller current * enable the output buffers and then let the pin controller current
* configuration (eg. the currently selected mux function) drive values on * configuration (eg. the currently selected mux function) drive values on
* the line. Use argument 1 to enable output mode, argument 0 to disable * the line. Use argument 1 to enable output mode, argument 0 to disable
* it. * it.
* @PIN_CONFIG_OUTPUT: this will configure the pin as an output and drive a * @PIN_CONFIG_OUTPUT: This will configure the pin as an output and drive a
* value on the line. Use argument 1 to indicate high level, argument 0 to * value on the line. Use argument 1 to indicate high level, argument 0 to
* indicate low level. (Please see Documentation/driver-api/pinctl.rst, * indicate low level. (Please see Documentation/driver-api/pinctl.rst,
* section "GPIO mode pitfalls" for a discussion around this parameter.) * section "GPIO mode pitfalls" for a discussion around this parameter.)
* @PIN_CONFIG_POWER_SOURCE: if the pin can select between different power * @PIN_CONFIG_POWER_SOURCE: If the pin can select between different power
* supplies, the argument to this parameter (on a custom format) tells * supplies, the argument to this parameter (on a custom format) tells
* the driver which alternative power source to use. * the driver which alternative power source to use.
* @PIN_CONFIG_SLEEP_HARDWARE_STATE: indicate this is sleep related state. * @PIN_CONFIG_SLEEP_HARDWARE_STATE: Indicate this is sleep related state.
* @PIN_CONFIG_SLEW_RATE: if the pin can select slew rate, the argument to * @PIN_CONFIG_SLEW_RATE: If the pin can select slew rate, the argument to
* this parameter (on a custom format) tells the driver which alternative * this parameter (on a custom format) tells the driver which alternative
* slew rate to use. * slew rate to use.
* @PIN_CONFIG_SKEW_DELAY: if the pin has programmable skew rate (on inputs) * @PIN_CONFIG_SKEW_DELAY: If the pin has programmable skew rate (on inputs)
* or latch delay (on outputs) this parameter (in a custom format) * or latch delay (on outputs) this parameter (in a custom format)
* specifies the clock skew or latch delay. It typically controls how * specifies the clock skew or latch delay. It typically controls how
* many double inverters are put in front of the line. * many double inverters are put in front of the line.
* @PIN_CONFIG_END: this is the last enumerator for pin configurations, if * @PIN_CONFIG_END: This is the last enumerator for pin configurations, if
* you need to pass in custom configurations to the pin controller, use * you need to pass in custom configurations to the pin controller, use
* PIN_CONFIG_END+1 as the base offset. * PIN_CONFIG_END+1 as the base offset.
* @PIN_CONFIG_MAX: this is the maximum configuration value that can be * @PIN_CONFIG_MAX: This is the maximum configuration value that can be
* presented using the packed format. * presented using the packed format.
*/ */
enum pin_config_param { enum pin_config_param {
@ -306,13 +481,14 @@ enum pin_config_param {
#if CONFIG_IS_ENABLED(PINCTRL_GENERIC) #if CONFIG_IS_ENABLED(PINCTRL_GENERIC)
/** /**
* pinctrl_generic_set_state() - generic set_state operation * pinctrl_generic_set_state() - Generic set_state operation
* @pctldev: Pinctrl device to use
* @config: Config device (pseudo device), pointing a config node in DTS
*
* Parse the DT node of @config and its children and handle generic properties * Parse the DT node of @config and its children and handle generic properties
* such as "pins", "groups", "functions", and pin configuration parameters. * such as "pins", "groups", "functions", and pin configuration parameters.
* *
* @pctldev: pinctrl device * Return: 0 on success, or negative error code on failure
* @config: config device (pseudo device), pointing a config node in DTS
* @return: 0 on success, or negative error code on failure
*/ */
int pinctrl_generic_set_state(struct udevice *pctldev, struct udevice *config); int pinctrl_generic_set_state(struct udevice *pctldev, struct udevice *config);
#else #else
@ -325,11 +501,11 @@ static inline int pinctrl_generic_set_state(struct udevice *pctldev,
#if CONFIG_IS_ENABLED(PINCTRL) #if CONFIG_IS_ENABLED(PINCTRL)
/** /**
* pinctrl_select_state() - set a device to a given state * pinctrl_select_state() - Set a device to a given state
* @dev: Peripheral device
* @statename: State name, like "default"
* *
* @dev: peripheral device * Return: 0 on success, or negative error code on failure
* @statename: state name, like "default"
* @return: 0 on success, or negative error code on failure
*/ */
int pinctrl_select_state(struct udevice *dev, const char *statename); int pinctrl_select_state(struct udevice *dev, const char *statename);
#else #else
@ -342,40 +518,43 @@ static inline int pinctrl_select_state(struct udevice *dev,
/** /**
* pinctrl_request() - Request a particular pinctrl function * pinctrl_request() - Request a particular pinctrl function
* * @dev: Pinctrl device to use
* @dev: Device to check (UCLASS_PINCTRL)
* @func: Function number (driver-specific) * @func: Function number (driver-specific)
* @flags: Flags (driver-specific) * @flags: Flags (driver-specific)
* @return 0 if OK, -ve on error *
* Return: 0 if OK, or negative error code on failure
*/ */
int pinctrl_request(struct udevice *dev, int func, int flags); int pinctrl_request(struct udevice *dev, int func, int flags);
/** /**
* pinctrl_request_noflags() - Request a particular pinctrl function * pinctrl_request_noflags() - Request a particular pinctrl function
* @dev: Pinctrl device to use
* @func: Function number (driver-specific)
* *
* This is similar to pinctrl_request() but uses 0 for @flags. * This is similar to pinctrl_request() but uses 0 for @flags.
* *
* @dev: Device to check (UCLASS_PINCTRL) * Return: 0 if OK, or negative error code on failure
* @func: Function number (driver-specific)
* @return 0 if OK, -ve on error
*/ */
int pinctrl_request_noflags(struct udevice *dev, int func); int pinctrl_request_noflags(struct udevice *dev, int func);
/** /**
* pinctrl_get_periph_id() - get the peripheral ID for a device * pinctrl_get_periph_id() - Get the peripheral ID for a device
* @dev: Pinctrl device to use for decoding
* @periph: Device to check
* *
* This generally looks at the peripheral's device tree node to work out the * This generally looks at the peripheral's device tree node to work out the
* peripheral ID. The return value is normally interpreted as enum periph_id. * peripheral ID. The return value is normally interpreted as enum periph_id.
* so long as this is defined by the platform (which it should be). * so long as this is defined by the platform (which it should be).
* *
* @dev: Pinctrl device to use for decoding * Return: Peripheral ID of @periph, or -ENOENT on error
* @periph: Device to check
* @return peripheral ID of @periph, or -ENOENT on error
*/ */
int pinctrl_get_periph_id(struct udevice *dev, struct udevice *periph); int pinctrl_get_periph_id(struct udevice *dev, struct udevice *periph);
/** /**
* pinctrl_get_gpio_mux() - get the mux value for a particular GPIO * pinctrl_get_gpio_mux() - get the mux value for a particular GPIO
* @dev: Pinctrl device to use
* @banknum: GPIO bank number
* @index: GPIO index within the bank
* *
* This allows the raw mux value for a GPIO to be obtained. It is * This allows the raw mux value for a GPIO to be obtained. It is
* useful for displaying the function being used by that GPIO, such * useful for displaying the function being used by that GPIO, such
@ -383,66 +562,64 @@ int pinctrl_get_periph_id(struct udevice *dev, struct udevice *periph);
* subsystem and should not be used by generic code. Typically it is * subsystem and should not be used by generic code. Typically it is
* used by a GPIO driver with knowledge of the SoC pinctrl setup. * used by a GPIO driver with knowledge of the SoC pinctrl setup.
* *
* @dev: Pinctrl device to use * Return: Mux value (SoC-specific, e.g. 0 for input, 1 for output)
* @banknum: GPIO bank number
* @index: GPIO index within the bank
* @return mux value (SoC-specific, e.g. 0 for input, 1 for output)
*/ */
int pinctrl_get_gpio_mux(struct udevice *dev, int banknum, int index); int pinctrl_get_gpio_mux(struct udevice *dev, int banknum, int index);
/** /**
* pinctrl_get_pin_muxing() - Returns the muxing description * pinctrl_get_pin_muxing() - Returns the muxing description
* @dev: Pinctrl device to use
* @selector: Pin index within pin-controller
* @buf: Pin's muxing description
* @size: Pin's muxing description length
* *
* This allows to display the muxing description of the given pin for * This allows to display the muxing description of the given pin for
* debug purpose * debug purpose
* *
* @dev: Pinctrl device to use * Return: 0 if OK, or negative error code on failure
* @selector Pin index within pin-controller
* @buf Pin's muxing description
* @size Pin's muxing description length
* @return 0 if OK, -ve on error
*/ */
int pinctrl_get_pin_muxing(struct udevice *dev, int selector, char *buf, int pinctrl_get_pin_muxing(struct udevice *dev, int selector, char *buf,
int size); int size);
/** /**
* pinctrl_get_pins_count() - display pin-controller pins number * pinctrl_get_pins_count() - Display pin-controller pins number
* @dev: Pinctrl device to use
* *
* This allows to know the number of pins owned by a given pin-controller * This allows to know the number of pins owned by a given pin-controller
* *
* @dev: Pinctrl device to use * Return: Number of pins if OK, or negative error code on failure
* @return pins number if OK, -ve on error
*/ */
int pinctrl_get_pins_count(struct udevice *dev); int pinctrl_get_pins_count(struct udevice *dev);
/** /**
* pinctrl_get_pin_name() - Returns the pin's name * pinctrl_get_pin_name() - Returns the pin's name
* @dev: Pinctrl device to use
* @selector: Pin index within pin-controller
* @buf: Buffer to fill with the name of the pin
* @size: Size of @buf
* *
* This allows to display the pin's name for debug purpose * This allows to display the pin's name for debug purpose
* *
* @dev: Pinctrl device to use * Return: 0 if OK, or negative error code on failure
* @selector Pin index within pin-controller
* @buf Pin's name
* @return 0 if OK, -ve on error
*/ */
int pinctrl_get_pin_name(struct udevice *dev, int selector, char *buf, int pinctrl_get_pin_name(struct udevice *dev, int selector, char *buf,
int size); int size);
/** /**
* pinctrl_gpio_request() - request a single pin to be used as GPIO * pinctrl_gpio_request() - Request a single pin to be used as GPIO
* @dev: GPIO peripheral device
* @offset: GPIO pin offset from the GPIO controller
* *
* @dev: GPIO peripheral device * Return: 0 on success, or negative error code on failure
* @offset: the GPIO pin offset from the GPIO controller
* @return: 0 on success, or negative error code on failure
*/ */
int pinctrl_gpio_request(struct udevice *dev, unsigned offset); int pinctrl_gpio_request(struct udevice *dev, unsigned offset);
/** /**
* pinctrl_gpio_free() - free a single pin used as GPIO * pinctrl_gpio_free() - Free a single pin used as GPIO
* @dev: GPIO peripheral device
* @offset: GPIO pin offset from the GPIO controller
* *
* @dev: GPIO peripheral device * Return: 0 on success, or negative error code on failure
* @offset: the GPIO pin offset from the GPIO controller
* @return: 0 on success, or negative error code on failure
*/ */
int pinctrl_gpio_free(struct udevice *dev, unsigned offset); int pinctrl_gpio_free(struct udevice *dev, unsigned offset);