Commit 67049c50 authored by Thierry Reding's avatar Thierry Reding Committed by Linus Walleij

gpio: of: Improve kerneldoc

Add descriptions for missing fields and fix up some parameter references
to match the code.
Signed-off-by: default avatarThierry Reding <treding@nvidia.com>
Signed-off-by: default avatarLinus Walleij <linus.walleij@linaro.org>
parent 950d55f5
...@@ -273,14 +273,13 @@ static int of_gpiochip_scan_gpios(struct gpio_chip *chip) ...@@ -273,14 +273,13 @@ static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
} }
/** /**
* of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags
* @gc: pointer to the gpio_chip structure * @gc: pointer to the gpio_chip structure
* @np: device node of the GPIO chip * @gpiospec: GPIO specifier as found in the device tree
* @gpio_spec: gpio specifier as found in the device tree
* @flags: a flags pointer to fill in * @flags: a flags pointer to fill in
* *
* This is simple translation function, suitable for the most 1:1 mapped * This is simple translation function, suitable for the most 1:1 mapped
* gpio chips. This function performs only one sanity check: whether gpio * GPIO chips. This function performs only one sanity check: whether GPIO
* is less than ngpios (that is specified in the gpio_chip). * is less than ngpios (that is specified in the gpio_chip).
*/ */
int of_gpio_simple_xlate(struct gpio_chip *gc, int of_gpio_simple_xlate(struct gpio_chip *gc,
......
...@@ -180,8 +180,27 @@ struct gpio_chip { ...@@ -180,8 +180,27 @@ struct gpio_chip {
* If CONFIG_OF is enabled, then all GPIO controllers described in the * If CONFIG_OF is enabled, then all GPIO controllers described in the
* device tree automatically may have an OF translation * device tree automatically may have an OF translation
*/ */
/**
* @of_node:
*
* Pointer to a device tree node representing this GPIO controller.
*/
struct device_node *of_node; struct device_node *of_node;
/**
* @of_gpio_n_cells:
*
* Number of cells used to form the GPIO specifier.
*/
int of_gpio_n_cells; int of_gpio_n_cells;
/**
* @of_xlate:
*
* Callback to translate a device tree GPIO specifier into a chip-
* relative GPIO number and flags.
*/
int (*of_xlate)(struct gpio_chip *gc, int (*of_xlate)(struct gpio_chip *gc,
const struct of_phandle_args *gpiospec, u32 *flags); const struct of_phandle_args *gpiospec, u32 *flags);
#endif #endif
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment