Skip to content

Commit 4e29b70

Browse files
dwlsalmeidalinusw
authored andcommitted
Documentation: gpio: driver.rst: Fix warnings
Fix warnings due to incorrect rst markup. Also improved the presentation a little without changing the underlying content. Signed-off-by: Daniel W. S. Almeida <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Linus Walleij <[email protected]>
1 parent 808b993 commit 4e29b70

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

Documentation/driver-api/gpio/driver.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ GPIO Driver Interface
55
This document serves as a guide for writers of GPIO chip drivers.
66

77
Each GPIO controller driver needs to include the following header, which defines
8-
the structures used to define a GPIO driver:
8+
the structures used to define a GPIO driver::
99

1010
#include <linux/gpio/driver.h>
1111

@@ -398,12 +398,15 @@ provided. A big portion of overhead code will be managed by gpiolib,
398398
under the assumption that your interrupts are 1-to-1-mapped to the
399399
GPIO line index:
400400

401-
GPIO line offset Hardware IRQ
402-
0 0
403-
1 1
404-
2 2
405-
... ...
406-
ngpio-1 ngpio-1
401+
.. csv-table::
402+
:header: GPIO line offset, Hardware IRQ
403+
404+
0,0
405+
1,1
406+
2,2
407+
...,...
408+
ngpio-1, ngpio-1
409+
407410

408411
If some GPIO lines do not have corresponding IRQs, the bitmask valid_mask
409412
and the flag need_valid_mask in gpio_irq_chip can be used to mask off some
@@ -413,7 +416,7 @@ The preferred way to set up the helpers is to fill in the
413416
struct gpio_irq_chip inside struct gpio_chip before adding the gpio_chip.
414417
If you do this, the additional irq_chip will be set up by gpiolib at the
415418
same time as setting up the rest of the GPIO functionality. The following
416-
is a typical example of a cascaded interrupt handler using gpio_irq_chip:
419+
is a typical example of a cascaded interrupt handler using gpio_irq_chip::
417420

418421
.. code-block:: c
419422
@@ -450,7 +453,7 @@ is a typical example of a cascaded interrupt handler using gpio_irq_chip:
450453
return devm_gpiochip_add_data(dev, &g->gc, g);
451454
452455
The helper support using hierarchical interrupt controllers as well.
453-
In this case the typical set-up will look like this:
456+
In this case the typical set-up will look like this::
454457

455458
.. code-block:: c
456459

0 commit comments

Comments
 (0)