Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
476 changes: 337 additions & 139 deletions doc/_static/css/custom.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"sphinx.ext.graphviz",
"sphinxcontrib.jquery",
"sphinxcontrib.programoutput",
"sphinx_design",
"zephyr.application",
"zephyr.html_redirects",
"zephyr.kconfig",
Expand Down
251 changes: 206 additions & 45 deletions doc/hardware/peripherals/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,65 +4,226 @@ Peripherals
###########

..
Please keep the ToC tree sorted based on the titles of the pages included
Please keep the ToC trees sorted based on the titles of the pages included

.. grid:: 1 1 2 3
:gutter: 2

.. grid-item-card:: :material-twotone:`show_chart;36px` Analog
:link: analog_peripherals
:link-type: ref

Analog-to-Digital and Digital-to-Analog converters, Comparators, and Amplifiers.

.. grid-item-card:: :material-twotone:`speaker;36px` Audio
:link: audio_reference
:link-type: ref

Audio interfaces and sound processing.

.. grid-item-card:: :material-twotone:`settings_ethernet;36px` Communication
:link: communication_peripherals
:link-type: ref

Serial buses (I2C, SPI, UART, CAN) and other communication interfaces.

.. grid-item-card:: :material-twotone:`monitor;36px` Display
:link: display_peripherals
:link-type: ref

Visual output, video interfaces, and LED control.

.. grid-item-card:: :material-twotone:`touch_app;36px` GPIO & Input
:link: gpio_input_peripherals
:link-type: ref

General Purpose I/O, tactile feedback, and input devices.

.. grid-item-card:: :material-twotone:`save;36px` Memory & Storage
:link: memory_storage_peripherals
:link-type: ref

Non-volatile memory, flash storage, and EEPROM.

.. grid-item-card:: :material-twotone:`battery_charging_full;36px` Power
:link: power_peripherals
:link-type: ref

Power management, charging, regulators, and reset controllers.

.. grid-item-card:: :material-twotone:`sensors;36px` Sensors
:link: sensor_peripherals
:link-type: ref

Environmental and motion sensors, GNSS, and sensor interfaces.

.. grid-item-card:: :material-twotone:`precision_manufacturing;36px` Motion & Actuation
:link: motion_actuation_peripherals
:link-type: ref

PWM, stepper motors, haptics, and other actuators.

.. grid-item-card:: :material-twotone:`bug_report;36px` System
:link: system_diagnostics_peripherals
:link-type: ref

System information, synchronization, DMA, buses, and diagnostics.

.. grid-item-card:: :material-twotone:`schedule;36px` Timing
:link: timing_peripherals
:link-type: ref

Timers, clocks, watchdogs, and timekeeping primitives.

.. toctree::
:maxdepth: 2
:hidden:

audio/index.rst


.. _analog_peripherals:

Analog
******

.. toctree::
:maxdepth: 1

w1.rst
adc.rst
auxdisplay.rst
audio/index.rst
bbram.rst
bc12.rst
clock_control.rst
can/index.rst
charger.rst
comparator.rst
coredump.rst
counter.rst
crc.rst
dac.rst
dma.rst
display/index.rst
eeprom/index.rst
espi.rst
entropy.rst
edac/index.rst
flash.rst
fuel_gauge.rst
gnss.rst
gpio.rst
haptics.rst
hwinfo.rst
hwspinlock.rst
i2c_eeprom_target.rst
i3c.rst
comparator.rst
opamp.rst

.. _communication_peripherals:

Communication
*************

.. toctree::
:maxdepth: 1

can/index.rst
i2c.rst
ipm.rst
led.rst
i3c.rst
spi.rst
pcie.rst
uart.rst
espi.rst
mdio.rst
mspi.rst
smbus.rst
ipm.rst
mbox.rst
opamp.rst
pcie.rst
peci.rst
w1.rst

.. _display_peripherals:

Display
*******

.. toctree::
:maxdepth: 1

display/index.rst
auxdisplay.rst
video.rst
led.rst

.. _gpio_input_peripherals:

GPIO & Input
************

.. toctree::
:maxdepth: 1

gpio.rst
ps2.rst
psi5.rst
pwm.rst
rtc.rst
tgpio.rst

.. _memory_storage_peripherals:

Memory & Storage
****************

.. toctree::
:maxdepth: 1

flash.rst
eeprom/index.rst
sdhc.rst
bbram.rst
retained_mem.rst
i2c_eeprom_target.rst

.. _power_peripherals:

Power
*****

.. toctree::
:maxdepth: 1

bc12.rst
charger.rst
fuel_gauge.rst
regulators.rst
reset.rst
retained_mem.rst
sdhc.rst
tcpc.rst
usbc_vbus.rst

.. _sensor_peripherals:

Sensors
*******

.. toctree::
:maxdepth: 1

sensor/index.rst
gnss.rst
psi5.rst
sent.rst
spi.rst

.. _motion_actuation_peripherals:

Motion & Actuation
******************

.. toctree::
:maxdepth: 1

haptics.rst
pwm.rst
stepper.rst
smbus.rst
uart.rst
usbc_vbus.rst
tcpc.rst
tgpio.rst
video.rst

.. _system_diagnostics_peripherals:

System & Diagnostics
********************

.. toctree::
:maxdepth: 1

hwinfo.rst
hwspinlock.rst
entropy.rst
edac/index.rst
coredump.rst
crc.rst
peci.rst
dma.rst

.. _timing_peripherals:

Timing
******

.. toctree::
:maxdepth: 1

clock_control.rst
counter.rst
rtc.rst
watchdog.rst
1 change: 0 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ Zephyr Project Documentation
kernel/index.rst
services/index.rst
build/index.rst
connectivity/index.rst
hardware/index.rst
contribute/index.rst
project/index.rst
Expand Down
2 changes: 1 addition & 1 deletion doc/releases/release-notes-4.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ New APIs and options

* :kconfig:option:`CONFIG_WIFI_USAGE_MODE`
* Added a new section to the Wi-Fi Management documentation
(``doc/connectivity/networking/api/wifi.rst``) with step-by-step instructions for generating
(``doc/services/connectivity/networking/api/wifi.rst``) with step-by-step instructions for generating
test certificates for Wi-Fi using FreeRADIUS scripts. This helps users reproduce the process
for their own test environments.
* Changed the hostap IPC mechanism from socketpair to k_fifo. Depending on the enabled Wi-Fi configuration options, this can save up to 6-8 kB memory when using native Wi-Fi stack.
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ sphinx-togglebutton
sphinx-sitemap
sphinx-autobuild
sphinxcontrib.programoutput
sphinx-design

# YAML validation. Used by zephyr_module.
PyYAML>=6.0
Expand Down
5 changes: 5 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,7 @@ sphinx==8.2.3 \
# -r requirements.in
# sphinx-autobuild
# sphinx-copybutton
# sphinx-design
# sphinx-last-updated-by-git
# sphinx-notfound-page
# sphinx-rtd-theme
Expand All @@ -545,6 +546,10 @@ sphinx-copybutton==0.5.2 \
--hash=sha256:4cf17c82fb9646d1bc9ca92ac280813a3b605d8c421225fd9913154103ee1fbd \
--hash=sha256:fb543fd386d917746c9a2c50360c7905b605726b9355cd26e9974857afeae06e
# via -r requirements.in
sphinx-design==0.6.1 \
--hash=sha256:b11f37db1a802a183d61b159d9a202314d4d2fe29c163437001324fe2f19549c \
--hash=sha256:b44eea3719386d04d765c1a8257caca2b3e6f8421d7b3a5e742c0fd45f84e632
# via -r requirements.in
sphinx-last-updated-by-git==0.3.8 \
--hash=sha256:6382c8285ac1f222483a58569b78c0371af5e55f7fbf9c01e5e8a72d6fdfa499 \
--hash=sha256:c145011f4609d841805b69a9300099fc02fed8f5bb9e5bcef77d97aea97b7761
Expand Down
13 changes: 13 additions & 0 deletions doc/services/algorithms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _algorithms_services:

Algorithms
**********

Algorithms for data transformation, encoding, and validation.

.. toctree::
:maxdepth: 1

crc/index.rst
dsp/index.rst
serialization/index.rst
14 changes: 14 additions & 0 deletions doc/services/application_services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _application_framework_services:

Application Services
********************

High-level frameworks and libraries for application development.

.. toctree::
:maxdepth: 1

smf/index.rst
sensing/index.rst
device_mgmt/index
llext/index.rst
14 changes: 14 additions & 0 deletions doc/services/communication.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _communication_services:

Communication
*************

Inter-thread, inter-processor, and external communication mechanisms.

.. toctree::
:maxdepth: 1

zbus/index.rst
ipc/index.rst
modem/index.rst
virtualization/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ The stack is split up as follows in the source tree:
functionality of the Bluetooth stack, but are not necessary the best
source for sample code (see ``samples/bluetooth`` instead).

``doc/connectivity/bluetooth/``
``doc/services/connectivity/bluetooth/``
Extra documentation, such as PICS documents.

.. _Bluetooth Specification: https://www.bluetooth.com/specifications/bluetooth-core-specification
File renamed without changes.
Loading