]> git.sur5r.net Git - u-boot/commitdiff
sandbox: gpio: doc: Fix parameter documentation
authormario.six@gdsys.cc <mario.six@gdsys.cc>
Wed, 25 May 2016 13:18:10 +0000 (15:18 +0200)
committerSimon Glass <sjg@chromium.org>
Sun, 19 Jun 2016 23:05:55 +0000 (17:05 -0600)
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>
Acked-by: Simon Glass <sjg@chromium.org>
arch/sandbox/include/asm/gpio.h

index 427af2c97018d6627a84a869d7a2f4f5f8b9eca6..73b42f0f08ddfefa6c0db7423b2dc843e6f10498 100644 (file)
@@ -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);
@@ -63,7 +65,8 @@ int sandbox_gpio_get_open_drain(struct udevice *dev, unsigned offset);
 /**
  * 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);
@@ -71,8 +74,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,