Skip to content

Commit 5f5e311

Browse files
committed
doc: display: consolidate MIPI docs in Display section
Move MIPI-DBI and MIPI-DSI docs from top-level Peripherals section to under Display section. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent c0ed6c0 commit 5f5e311

File tree

6 files changed

+55
-47
lines changed

6 files changed

+55
-47
lines changed

MAINTAINERS.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1919,7 +1919,6 @@ Documentation Infrastructure:
19191919
status: odd fixes
19201920
files:
19211921
- drivers/mipi_dsi/
1922-
- doc/hardware/peripherals/mipi_dsi.rst
19231922
- include/zephyr/drivers/mipi_dsi.h
19241923
- include/zephyr/drivers/mipi_dsi/
19251924
- tests/drivers/mipi_dsi/

doc/_scripts/redirects.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@
168168
('guides/west/zephyr-cmds', 'develop/west/zephyr-cmds'),
169169
('guides/zephyr_cmake_package', 'build/zephyr_cmake_package'),
170170
('hardware/peripherals/eeprom', 'hardware/peripherals/eeprom/index'),
171+
('hardware/peripherals/mipi_dbi', 'hardware/peripherals/display/index'),
172+
('hardware/peripherals/mipi_dsi', 'hardware/peripherals/display/index'),
171173
('hardware/peripherals/sensor', 'hardware/peripherals/sensor/index'),
172174
('kernel/libc/index', 'develop/languages/c/index'),
173175
('reference/api/api_lifecycle', 'develop/api/api_lifecycle'),

doc/hardware/peripherals/display/index.rst

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,44 @@
1-
.. comment
2-
not documenting
3-
.. doxygengroup:: display_interfaces
4-
51
.. _display_api:
62

7-
Display Interface
8-
#################
3+
Display
4+
#######
5+
6+
The Display subsystem in Zephyr provides a unified way to interact with a wide range of display
7+
devices. The Display API is transport-agnostic: it describes what you want the display to do,
8+
without exposing how the data moves over the wire.
9+
10+
MIPI Display Bus Interface (DBI)
11+
********************************
12+
13+
The **MIPI DBI** specification defines several parallel and serial buses for connecting a host to a
14+
display controller. In Zephyr, DBI support provides bus-level primitives for command writes, reads,
15+
pixel transfers, reset, and related operations that a driver uses internally to implement the
16+
generic API.
17+
18+
Applications do not use DBI functions directly. Instead, they call the generic Display API (e.g., to
19+
write pixels), and the display driver handles the DBI protocol under the hood.
20+
21+
MIPI-DBI defines 3 interface types:
22+
23+
* Type A: Motorola 6800 parallel bus
24+
* Type B: Intel 8080 parallel bus
25+
* Type C: SPI Type serial bit bus with 3 options:
26+
27+
#. 9 write clocks per byte, final bit is command/data selection bit
28+
#. Same as above, but 16 write clocks per byte
29+
#. 8 write clocks per byte. Command/data selected via GPIO pin
30+
31+
Currently, the API does not support Type C controllers with 16 write clocks (option 2).
32+
33+
MIPI Display Serial Interface (DSI)
34+
***********************************
35+
36+
The **MIPI DSI** standard is a high-speed differential serial bus designed for modern color TFT
37+
panels. Zephyr's DSI support provides the primitives needed by drivers to implement the generic
38+
Display API on top of a DSI link.
39+
40+
As with DBI, applications never call DSI functions directly. They remain portable by using the
41+
generic Display API, while the driver handles the DSI transactions internally.
942

1043
API Reference
1144
*************
@@ -15,6 +48,20 @@ Generic Display Interface
1548

1649
.. doxygengroup:: display_interface
1750

51+
.. _mipi_dbi_api:
52+
53+
MIPI Display Bus Interface (DBI)
54+
================================
55+
56+
.. doxygengroup:: mipi_dbi_interface
57+
58+
.. _mipi_dsi_api:
59+
60+
MIPI Display Serial Interface (DSI)
61+
===================================
62+
63+
.. doxygengroup:: mipi_dsi_interface
64+
1865
Grove LCD Display
1966
=================
2067

doc/hardware/peripherals/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ Peripherals
4040
ipm.rst
4141
led.rst
4242
mdio.rst
43-
mipi_dbi.rst
44-
mipi_dsi.rst
4543
mspi.rst
4644
mbox.rst
4745
pcie.rst

doc/hardware/peripherals/mipi_dbi.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

doc/hardware/peripherals/mipi_dsi.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)