[U-Boot] [PATCH] sandbox: gpio: doc: Fix parameter documentation

The documentation of parameters in arch/sandbox/include/asm/gpio.h is either missing or faulty.
This patch corrects the documentation.
Signed-off-by: Mario Six mario.six@gdsys.cc --- arch/sandbox/include/asm/gpio.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/arch/sandbox/include/asm/gpio.h b/arch/sandbox/include/asm/gpio.h index 8317db1..6c39dde 100644 --- a/arch/sandbox/include/asm/gpio.h +++ b/arch/sandbox/include/asm/gpio.h @@ -26,7 +26,8 @@ /** * Return the simulated value of a GPIO (used only in sandbox test code) * - * @param gp GPIO number + * @param dev device to use + * @param offset GPIO offset within bank * @return -1 on error, 0 if GPIO is low, >0 if high */ int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset); @@ -34,8 +35,9 @@ int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset); /** * Set the simulated value of a GPIO (used only in sandbox test code) * - * @param gp GPIO number - * @param value value to set (0 for low, non-zero for high) + * @param dev device to use + * @param offset GPIO offset within bank + * @param value value to set (0 for low, non-zero for high) * @return -1 on error, 0 if ok */ int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value); @@ -43,7 +45,8 @@ int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value); /** * Return the simulated direction of a GPIO (used only in sandbox test code) * - * @param gp GPIO number + * @param dev device to use + * @param offset GPIO offset within bank * @return -1 on error, 0 if GPIO is input, >0 if output */ int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset); @@ -51,8 +54,9 @@ int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset); /** * Set the simulated direction of a GPIO (used only in sandbox test code) * - * @param gp GPIO number - * @param output 0 to set as input, 1 to set as output + * @param dev device to use + * @param offset GPIO offset within bank + * @param output 0 to set as input, 1 to set as output * @return -1 on error, 0 if ok */ int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset,

On 25 May 2016 at 07:18, Mario Six mario.six@gdsys.cc wrote:
The documentation of parameters in arch/sandbox/include/asm/gpio.h is either missing or faulty.
This patch corrects the documentation.
Signed-off-by: Mario Six mario.six@gdsys.cc
arch/sandbox/include/asm/gpio.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-)
Acked-by: Simon Glass sjg@chromium.org

On 25 May 2016 at 17:17, Simon Glass sjg@chromium.org wrote:
On 25 May 2016 at 07:18, Mario Six mario.six@gdsys.cc wrote:
The documentation of parameters in arch/sandbox/include/asm/gpio.h is either missing or faulty.
This patch corrects the documentation.
Signed-off-by: Mario Six mario.six@gdsys.cc
arch/sandbox/include/asm/gpio.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-)
Acked-by: Simon Glass sjg@chromium.org
Applied to u-boot-dm, thanks!
participants (2)
-
Mario Six
-
Simon Glass