zephyr/doc/reference
Andy Ross aa825d77b0 doc: Clarify k_poll() behavior with respect to signal synchronization
Bug #40189 tripped over an interesting synchronization scenario that
wasn't called out in the docs.  Poll signals are level triggered, and
if you're adjusting the level from a racing context (e.g. resetting it
before the next "event" from an ISR or another thread) the polling
thread might wake up but then miss the event.  Mention this case
explicitly in documentation.

Fixes #40189

Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2022-01-20 10:57:31 -05:00
..
api doc: reference: api: overview: note that the CAN API was changed in v3.0 2022-01-01 07:40:41 -05:00
audio doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
bluetooth doc: bluetooth/mesh: Add app_key_upd document 2021-11-23 13:08:45 +02:00
canbus drivers: can: rename API functions for better consistency 2022-01-10 10:44:37 +01:00
crypto doc: remove redundant breathe project 2021-05-20 20:04:51 +02:00
data_structures doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
devicetree doc: devicetree: add "zephyr,display" to chosen nodes table 2021-12-10 12:47:30 +01:00
display doc: remove redundant breathe project 2021-05-20 20:04:51 +02:00
drivers doc: reference: drivers: update system drivers section 2021-12-24 20:59:10 -05:00
edac doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
file_system doc: remove redundant breathe project 2021-05-20 20:04:51 +02:00
iterable_sections doc: fix C domain reference usage 2021-10-26 10:57:45 +02:00
kernel doc: Clarify k_poll() behavior with respect to signal synchronization 2022-01-20 10:57:31 -05:00
libc doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
logging logging: Add assert when wrong backend is used 2022-01-17 15:49:10 -05:00
memory_management doc: add a page for the new memory blocks allocator 2022-01-11 16:10:53 -05:00
misc doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
modbus doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
networking net: introduce a network packet filter framework 2021-12-21 17:06:35 +01:00
peripherals docs: api: uart: Restructure and provide introduction 2022-01-07 14:01:12 -05:00
pinctrl doc: reference: add pinctrl API 2021-10-25 15:26:47 -05:00
pm doc: reference: pm: include all API and move to pm 2021-11-13 07:59:51 -05:00
random random: deprecate XOROSHIRO_RANDOM_GENERATOR 2021-08-05 11:24:44 +02:00
resource_management doc: remove redundant breathe project 2021-05-20 20:04:51 +02:00
settings doc: note on the settings for the secure-domain 2021-12-23 12:39:20 +01:00
shell doc: shell getopt support 2022-01-06 21:26:59 +01:00
storage doc: fix C domain reference usage 2021-10-26 10:57:45 +02:00
task_wdt doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
timing_functions doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
usb doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
usermode doc: misc fixes 2021-10-04 16:42:08 -04:00
util doc: remove redundant breathe project 2021-05-20 20:04:51 +02:00
virtualization doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
index.rst doc: reference: include two levels of titles in the toc 2021-12-15 14:59:21 -05:00