patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

driver: gpio: remove documentation related to pin-based callback config

Browse source 
This reverts the documentation component of commit
eb6ea28649.

The original change broke the API contract: drivers that use GPIOs need
to be able to configure callbacks without being aware of whether a
particular implementation expects to use a mask or a pin ordinal.

Revert the API documentation to its original format, and mark that the
added field should be removed when issue #11565 is resolved.

Signed-off-by: Peter A. Bigot <pab@pabigot.com>
This commit is contained in:
Peter A. Bigot 2019-01-16 06:10:45 -06:00 committed by Kumar Gala
parent aa826960d8
commit b48478fef3
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
include/gpio.h
View file

@ -77,15 +77,15 @@ struct gpio_callback {
/** Actual callback function being called when relevant. */
gpio_callback_handler_t handler;
/** A mask of pins (pin_mask) or a specific pin (pin) the callback
* is interested in, if 0 the callback will never be called.
* The pin_mask or pin can be modified whenever
/** A mask of pins the callback is interested in, if 0 the callback
* will never be called. Such pin_mask can be modified whenever
* necessary by the owner, and thus will affect the handler being
* called or not. The selected pins must be configured to trigger
* an interrupt.
*/
union {
u32_t pin_mask;
/* @todo Remove `pin` when #11565 is resolved */
u32_t pin;
};
};