Commit 4b3d5006 authored by Linus Walleij's avatar Linus Walleij

gpio: Fix minor grammar errors in documentation

This fixes up some of my own mistakes when I stressed to refresh
the documentation.
Signed-off-by: default avatarLinus Walleij <linus.walleij@linaro.org>
parent db9477f8
...@@ -235,7 +235,7 @@ means that a pull up or pull-down resistor is available on the output of the ...@@ -235,7 +235,7 @@ means that a pull up or pull-down resistor is available on the output of the
GPIO line, and this resistor is software controlled. GPIO line, and this resistor is software controlled.
In discrete designs, a pull-up or pull-down resistor is simply soldered on In discrete designs, a pull-up or pull-down resistor is simply soldered on
the circuit board. This is not something we deal or model in software. The the circuit board. This is not something we deal with or model in software. The
most you will think about these lines is that they will very likely be most you will think about these lines is that they will very likely be
configured as open drain or open source (see the section above). configured as open drain or open source (see the section above).
...@@ -292,18 +292,18 @@ We can divide GPIO irqchips in two broad categories: ...@@ -292,18 +292,18 @@ We can divide GPIO irqchips in two broad categories:
- HIERARCHICAL INTERRUPT CHIPS: this means that each GPIO line has a dedicated - HIERARCHICAL INTERRUPT CHIPS: this means that each GPIO line has a dedicated
irq line to a parent interrupt controller one level up. There is no need irq line to a parent interrupt controller one level up. There is no need
to inquire the GPIO hardware to figure out which line has figured, but it to inquire the GPIO hardware to figure out which line has fired, but it
may still be necessary to acknowledge the interrupt and set up the may still be necessary to acknowledge the interrupt and set up configuration
configuration such as edge sensitivity. such as edge sensitivity.
Realtime considerations: a realtime compliant GPIO driver should not use Realtime considerations: a realtime compliant GPIO driver should not use
spinlock_t or any sleepable APIs (like PM runtime) as part of its irqchip spinlock_t or any sleepable APIs (like PM runtime) as part of its irqchip
implementation. implementation.
- spinlock_t should be replaced with raw_spinlock_t [1]. - spinlock_t should be replaced with raw_spinlock_t.[1]
- If sleepable APIs have to be used, these can be done from the .irq_bus_lock() - If sleepable APIs have to be used, these can be done from the .irq_bus_lock()
and .irq_bus_unlock() callbacks, as these are the only slowpath callbacks and .irq_bus_unlock() callbacks, as these are the only slowpath callbacks
on an irqchip. Create the callbacks if needed [2]. on an irqchip. Create the callbacks if needed.[2]
Cascaded GPIO irqchips Cascaded GPIO irqchips
...@@ -361,7 +361,7 @@ Cascaded GPIO irqchips usually fall in one of three categories: ...@@ -361,7 +361,7 @@ Cascaded GPIO irqchips usually fall in one of three categories:
Realtime considerations: this kind of handlers will be forced threaded on -RT, Realtime considerations: this kind of handlers will be forced threaded on -RT,
and as result the IRQ core will complain that generic_handle_irq() is called and as result the IRQ core will complain that generic_handle_irq() is called
with IRQ enabled and the same work around as for "CHAINED GPIO irqchips" can with IRQ enabled and the same work-around as for "CHAINED GPIO irqchips" can
be applied. be applied.
- NESTED THREADED GPIO IRQCHIPS: these are off-chip GPIO expanders and any - NESTED THREADED GPIO IRQCHIPS: these are off-chip GPIO expanders and any
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment