gpiolib: some edits of kernel docs for clarity
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 23 Mar 2021 22:19:05 +0000 (15:19 -0700)
committerBartosz Golaszewski <bgolaszewski@baylibre.com>
Fri, 26 Mar 2021 13:56:19 +0000 (14:56 +0100)
Fix a few typos and some punctuation. Also, change CONFIG_OF to
CONFIG_OF_GPIO in one comment.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bartosz Golaszewski <bgolaszewski@baylibre.com>
Cc: linux-gpio@vger.kernel.org
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
[Bartosz: tweaked the commit message]
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
include/linux/gpio/driver.h

index 286de05..63283de 100644 (file)
@@ -227,7 +227,7 @@ struct gpio_irq_chip {
        /**
         * @valid_mask:
         *
-        * If not %NULL holds bitmask of GPIOs which are valid to be included
+        * If not %NULL, holds bitmask of GPIOs which are valid to be included
         * in IRQ domain of the chip.
         */
        unsigned long *valid_mask;
@@ -346,7 +346,7 @@ struct gpio_irq_chip {
  *     output.
  *
  * A gpio_chip can help platforms abstract various sources of GPIOs so
- * they can all be accessed through a common programing interface.
+ * they can all be accessed through a common programming interface.
  * Example sources would be SOC controllers, FPGAs, multifunction
  * chips, dedicated GPIO expanders, and so on.
  *
@@ -435,15 +435,15 @@ struct gpio_chip {
        /**
         * @valid_mask:
         *
-        * If not %NULL holds bitmask of GPIOs which are valid to be used
+        * If not %NULL, holds bitmask of GPIOs which are valid to be used
         * from the chip.
         */
        unsigned long *valid_mask;
 
 #if defined(CONFIG_OF_GPIO)
        /*
-        * If CONFIG_OF is enabled, then all GPIO controllers described in the
-        * device tree automatically may have an OF translation
+        * If CONFIG_OF_GPIO is enabled, then all GPIO controllers described in
+        * the device tree automatically may have an OF translation
         */
 
        /**
@@ -508,7 +508,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
  * for GPIOs will fail rudely.
  *
  * gpiochip_add_data() must only be called after gpiolib initialization,
- * ie after core_initcall().
+ * i.e. after core_initcall().
  *
  * If gc->base is negative, this requests dynamic assignment of
  * a range of valid GPIOs.