diff options
author | Thierry Reding <treding@nvidia.com> | 2017-07-24 16:57:23 +0200 |
---|---|---|
committer | Linus Walleij <linus.walleij@linaro.org> | 2017-08-14 15:01:13 +0200 |
commit | 67049c505017d7b380e16aa4f4b02344c2be0d55 (patch) | |
tree | da155b5883e8e7d384bb1c3926f7190d982a2a20 /include/linux/gpio | |
parent | 950d55f5bf7991222e34428b5f779bd030b6a42a (diff) | |
download | linux-67049c505017d7b380e16aa4f4b02344c2be0d55.tar.gz linux-67049c505017d7b380e16aa4f4b02344c2be0d55.tar.xz |
gpio: of: Improve kerneldoc
Add descriptions for missing fields and fix up some parameter references
to match the code.
Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Diffstat (limited to 'include/linux/gpio')
-rw-r--r-- | include/linux/gpio/driver.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h index ad4150d075c3..fe66c9306caf 100644 --- a/include/linux/gpio/driver.h +++ b/include/linux/gpio/driver.h @@ -180,8 +180,27 @@ struct gpio_chip { * If CONFIG_OF is enabled, then all GPIO controllers described in the * 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; + + /** + * @of_gpio_n_cells: + * + * Number of cells used to form the GPIO specifier. + */ 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, const struct of_phandle_args *gpiospec, u32 *flags); #endif |