Skip to content

Commit 028eaf5

Browse files
committed
doc: peripherals: add structure/categorization to peripherals index
The very flat and unorganized list of peripherals deserved a bit of love and this commit introduced some grouping Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 04a4748 commit 028eaf5

File tree

1 file changed

+206
-45
lines changed

1 file changed

+206
-45
lines changed

doc/hardware/peripherals/index.rst

Lines changed: 206 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,65 +4,226 @@ Peripherals
44
###########
55

66
..
7-
Please keep the ToC tree sorted based on the titles of the pages included
7+
Please keep the ToC trees sorted based on the titles of the pages included
8+
9+
.. grid:: 1 1 2 3
10+
:gutter: 2
11+
12+
.. grid-item-card:: :material-twotone:`show_chart;36px` Analog
13+
:link: analog_peripherals
14+
:link-type: ref
15+
16+
Analog-to-Digital and Digital-to-Analog converters, Comparators, and Amplifiers.
17+
18+
.. grid-item-card:: :material-twotone:`speaker;36px` Audio
19+
:link: audio_reference
20+
:link-type: ref
21+
22+
Audio interfaces and sound processing.
23+
24+
.. grid-item-card:: :material-twotone:`settings_ethernet;36px` Communication
25+
:link: communication_peripherals
26+
:link-type: ref
27+
28+
Serial buses (I2C, SPI, UART, CAN) and other communication interfaces.
29+
30+
.. grid-item-card:: :material-twotone:`monitor;36px` Display
31+
:link: display_peripherals
32+
:link-type: ref
33+
34+
Visual output, video interfaces, and LED control.
35+
36+
.. grid-item-card:: :material-twotone:`touch_app;36px` GPIO & Input
37+
:link: gpio_input_peripherals
38+
:link-type: ref
39+
40+
General Purpose I/O, tactile feedback, and input devices.
41+
42+
.. grid-item-card:: :material-twotone:`save;36px` Memory & Storage
43+
:link: memory_storage_peripherals
44+
:link-type: ref
45+
46+
Non-volatile memory, flash storage, and EEPROM.
47+
48+
.. grid-item-card:: :material-twotone:`battery_charging_full;36px` Power
49+
:link: power_peripherals
50+
:link-type: ref
51+
52+
Power management, charging, regulators, and reset controllers.
53+
54+
.. grid-item-card:: :material-twotone:`sensors;36px` Sensors
55+
:link: sensor_peripherals
56+
:link-type: ref
57+
58+
Environmental and motion sensors, GNSS, and sensor interfaces.
59+
60+
.. grid-item-card:: :material-twotone:`precision_manufacturing;36px` Motion & Actuation
61+
:link: motion_actuation_peripherals
62+
:link-type: ref
63+
64+
PWM, stepper motors, haptics, and other actuators.
65+
66+
.. grid-item-card:: :material-twotone:`bug_report;36px` System
67+
:link: system_diagnostics_peripherals
68+
:link-type: ref
69+
70+
System information, synchronization, DMA, buses, and diagnostics.
71+
72+
.. grid-item-card:: :material-twotone:`schedule;36px` Timing
73+
:link: timing_peripherals
74+
:link-type: ref
75+
76+
Timers, clocks, watchdogs, and timekeeping primitives.
77+
78+
.. toctree::
79+
:maxdepth: 2
80+
:hidden:
81+
82+
audio/index.rst
83+
84+
85+
.. _analog_peripherals:
86+
87+
Analog
88+
******
889

990
.. toctree::
1091
:maxdepth: 1
1192

12-
w1.rst
1393
adc.rst
14-
auxdisplay.rst
15-
audio/index.rst
16-
bbram.rst
17-
bc12.rst
18-
clock_control.rst
19-
can/index.rst
20-
charger.rst
21-
comparator.rst
22-
coredump.rst
23-
counter.rst
24-
crc.rst
2594
dac.rst
26-
dma.rst
27-
display/index.rst
28-
eeprom/index.rst
29-
espi.rst
30-
entropy.rst
31-
edac/index.rst
32-
flash.rst
33-
fuel_gauge.rst
34-
gnss.rst
35-
gpio.rst
36-
haptics.rst
37-
hwinfo.rst
38-
hwspinlock.rst
39-
i2c_eeprom_target.rst
40-
i3c.rst
95+
comparator.rst
96+
opamp.rst
97+
98+
.. _communication_peripherals:
99+
100+
Communication
101+
*************
102+
103+
.. toctree::
104+
:maxdepth: 1
105+
106+
can/index.rst
41107
i2c.rst
42-
ipm.rst
43-
led.rst
108+
i3c.rst
109+
spi.rst
110+
pcie.rst
111+
uart.rst
112+
espi.rst
44113
mdio.rst
45114
mspi.rst
115+
smbus.rst
116+
ipm.rst
46117
mbox.rst
47-
opamp.rst
48-
pcie.rst
49-
peci.rst
118+
w1.rst
119+
120+
.. _display_peripherals:
121+
122+
Display
123+
*******
124+
125+
.. toctree::
126+
:maxdepth: 1
127+
128+
display/index.rst
129+
auxdisplay.rst
130+
video.rst
131+
led.rst
132+
133+
.. _gpio_input_peripherals:
134+
135+
GPIO & Input
136+
************
137+
138+
.. toctree::
139+
:maxdepth: 1
140+
141+
gpio.rst
50142
ps2.rst
51-
psi5.rst
52-
pwm.rst
53-
rtc.rst
143+
tgpio.rst
144+
145+
.. _memory_storage_peripherals:
146+
147+
Memory & Storage
148+
****************
149+
150+
.. toctree::
151+
:maxdepth: 1
152+
153+
flash.rst
154+
eeprom/index.rst
155+
sdhc.rst
156+
bbram.rst
157+
retained_mem.rst
158+
i2c_eeprom_target.rst
159+
160+
.. _power_peripherals:
161+
162+
Power
163+
*****
164+
165+
.. toctree::
166+
:maxdepth: 1
167+
168+
bc12.rst
169+
charger.rst
170+
fuel_gauge.rst
54171
regulators.rst
55172
reset.rst
56-
retained_mem.rst
57-
sdhc.rst
173+
tcpc.rst
174+
usbc_vbus.rst
175+
176+
.. _sensor_peripherals:
177+
178+
Sensors
179+
*******
180+
181+
.. toctree::
182+
:maxdepth: 1
183+
58184
sensor/index.rst
185+
gnss.rst
186+
psi5.rst
59187
sent.rst
60-
spi.rst
188+
189+
.. _motion_actuation_peripherals:
190+
191+
Motion & Actuation
192+
******************
193+
194+
.. toctree::
195+
:maxdepth: 1
196+
197+
haptics.rst
198+
pwm.rst
61199
stepper.rst
62-
smbus.rst
63-
uart.rst
64-
usbc_vbus.rst
65-
tcpc.rst
66-
tgpio.rst
67-
video.rst
200+
201+
.. _system_diagnostics_peripherals:
202+
203+
System & Diagnostics
204+
********************
205+
206+
.. toctree::
207+
:maxdepth: 1
208+
209+
hwinfo.rst
210+
hwspinlock.rst
211+
entropy.rst
212+
edac/index.rst
213+
coredump.rst
214+
crc.rst
215+
peci.rst
216+
dma.rst
217+
218+
.. _timing_peripherals:
219+
220+
Timing
221+
******
222+
223+
.. toctree::
224+
:maxdepth: 1
225+
226+
clock_control.rst
227+
counter.rst
228+
rtc.rst
68229
watchdog.rst

0 commit comments

Comments
 (0)