zephyr/doc/reference
Henrik Brix Andersen 8af4bb722d drivers: can: rename API functions for better consistency
Rename a few CAN API functions for clarity and consistency with other
Zephyr RTOS APIs.

CAN_DEFINE_MSGQ() becomes CAN_MSGQ_DEFINE() to match K_MSGQ_DEFINE().

can_attach_isr() becomes can_add_rx_filter() since a filter callback
function is not an interrupt service routine (although it is called in
isr context). The word "attach" is replaced with "add" since filters are
added, not attached. This matches the terminology used is other Zephyr
APIs better.

can_detach() becomes can_remove_rx_filter() to pair with
can_add_rx_filter().

can_attach_msgq() becomes can_add_rx_filter_msgq() and documentation is
updated to mention its relationship with can_add_rx_filter().

can_register_state_change_isr() becomes can_set_state_change_callback()
since a state change callback function is not an interrupt service
routine (although it is called in isr context). The word "register" is
replaced with "set" since only one state change callback can be in
place.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-01-10 10:44:37 +01: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 kernel: atomics: support for 64-bit atomic operations 2021-11-15 09:59:01 -05:00
libc doc: use kconfig role and directive 2021-06-29 10:26:28 -04:00
logging logging: Add configurable logging thread delay 2021-08-13 11:19:27 -04:00
memory_management multi_heap: Introduce shared multi-heap memory pool manager 2021-10-12 07:44:46 -04: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