zephyr/doc/hardware/peripherals
Henrik Brix Andersen a57db0ddcb drivers: can: rework support for manual bus-off recovery
Since all CAN controllers drivers seem to support automatic recovery (for
any future drivers for hardware without this hardware capability this can
easily be implemented in the driver), change the Zephyr CAN controller API
policy to:

- Always enable automatic bus recovery upon driver initialization,
  regardless of Kconfig options. Since CAN controllers are initialized in
  "stopped" state, no unwanted bus-off recovery will be started at this
  point.

- Invert and rename the Kconfig CONFIG_CAN_AUTO_BUS_OFF_RECOVERY, which is
  enabled by default, to CONFIG_CAN_MANUAL_RECOVERY_MODE, which is disabled
  by default. Enabling CONFIG_CAN_MANUAL_RECOVERY_MODE=y enables support
  for the can_recover() API function and a new manual recovery mode (see
  next bullet). Keeping this guarded by Kconfig allows keeping the flash
  footprint down for applications not using manual bus-off recovery.

- Introduce a new CAN controller operational mode
  CAN_MODE_MANUAL_RECOVERY. Support for this is only enabled if
  CONFIG_CAN_MANUAL_RECOVERY_MODE=y. Having this as a mode allows
  applications to inquire whether the CAN controller supports manual
  recovery mode via the can_get_capabilities() API function and either fail
  or rely on automatic recovery - and it allows CAN controller drivers not
  supporting manual recovery mode to fail early in can_set_mode() during
  application startup instead of failing when can_recover() is called at a
  later point in time.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2024-03-02 18:26:48 +01:00
..
audio doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
can drivers: can: rework support for manual bus-off recovery 2024-03-02 18:26:48 +01:00
display doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
edac doc: edac: Update EDAC / IBECC documentation 2023-03-30 17:33:41 -04:00
1-Wire_bus_topology.drawio.svg
adc.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
auxdisplay.rst doc: Fix occurrences of repeated words 2023-11-15 17:34:39 -05:00
bbram.rst bbram: Add documentation 2023-05-05 10:57:01 -05:00
bc12.rst doc: Fix occurrences of repeated words 2023-11-15 17:34:39 -05:00
charger.rst drivers: charger: Adds charge_enable handler 2023-12-12 10:49:39 -06:00
clock_control.rst
coredump.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
counter.rst
dac.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
dma.rst docs: Better document the DMA API and expectations 2023-11-10 10:40:10 +01:00
eeprom.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
entropy.rst
espi.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
flash.rst doc: Add missing kconfig option prefix 2022-10-13 13:16:06 -04:00
fuel_gauge.rst fuel_gauge: Repl property struct w/ union 2023-09-27 12:07:59 +02:00
gnss.rst doc: fix typo in multiple directories (build, hardware, kernel, project) 2024-01-26 13:16:18 +01:00
gpio.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
hwinfo.rst
i2c_eeprom_target.rst
i2c.rst doc: i2c: fixed non-working link to I2C spec 2023-06-07 04:40:47 -04:00
i3c.rst doc: fix typo in multiple directories (build, hardware, kernel, project) 2024-01-26 13:16:18 +01:00
index.rst doc: hardware: add peripheral documentation for MIPI DBI 2024-01-31 16:01:45 +00:00
ipm.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
kscan.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
led.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
mbox.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
mdio.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
mipi_dbi.rst doc: hardware: add peripheral documentation for MIPI DBI 2024-01-31 16:01:45 +00:00
mipi_dsi.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
pcie.rst doc/pcie: Add basic entry for PCIe doxygen documentation 2023-06-17 07:58:41 -04:00
peci.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
ps2.rst
pwm.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
regulators.rst doc: regulators: improve introduction 2023-04-12 16:43:23 +02:00
reset.rst
retained_mem.rst doc: retained_mem: Add note on mutex configuration 2023-10-10 16:27:10 +03:00
rtc.rst doc: peripherals: Add emulated RTC doc to docs 2024-01-08 10:10:13 +01:00
sdhc.rst doc: disk: Mention eMMC support in disk subsystem 2023-08-18 10:14:01 +02:00
sensor.rst emul: Introduce emulator backend API and generic sensor test 2023-07-28 17:48:31 +02:00
smbus.rst doc: smbus: Correct SMBus documentation 2023-06-01 18:04:58 -04:00
spi.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
tcpc.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
tgpio.rst doc: hardware: peripherals: Added tgpio.rst 2023-09-29 16:28:09 +02:00
uart.rst doc: peripherals: Document limitation 2024-01-30 08:28:57 -05:00
usbc_vbus.rst doc: add API documentation for USB-C VBUS Driver 2022-10-22 18:38:35 -04:00
video.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
w1.rst doc: peripherals: unify title strings 2023-03-29 09:48:13 +00:00
watchdog.rst