acpi: Tidy up documentation for struct acpi_gpio
authorSimon Glass <sjg@chromium.org>
Sat, 23 Jan 2021 18:08:38 +0000 (11:08 -0700)
committerBin Meng <bmeng.cn@gmail.com>
Mon, 1 Feb 2021 07:11:41 +0000 (15:11 +0800)
Some comments were provided after this patch was applied. Address them.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
include/acpi/acpi_device.h

index ed4acd9..2c88462 100644 (file)
@@ -171,10 +171,11 @@ enum acpi_gpio_polarity {
  * @io_restrict: I/O restriction setting
  * @polarity: GPIO polarity
  *
- * Note that GpioIo doesn't have any means of Active Low / High setting, so a
- * _DSD must be provided to mitigate this.
+ * Note that GpioIo() doesn't have any means of Active Low / High setting, so a
+ * _DSD must be provided to mitigate this. This parameter does not make sense
+ * for GpioInt() since it has its own means to define it.
  *
- * GpioIo doesn't properly communicate the initial state of the output pin,
+ * GpioIo() doesn't properly communicate the initial state of the output pin,
  * thus Linux assumes the simple rule:
  *
  * Pull Bias       Polarity      Requested...
@@ -184,7 +185,7 @@ enum acpi_gpio_polarity {
  *                               assuming non-active (Polarity = !Pull Bias)
  *
  * Down            Low           as low, assuming active
- * Down            High          as high, assuming non-active
+ * Down            High          as low, assuming non-active
  * Up              Low           as high, assuming non-active
  * Up              High          as high, assuming active
  *