forked from ~ljy/RK356X_SDK_RELEASE
blame | history | patch | commit | commitdiff
hc
2024-10-09 244b2c5ca8b14627e4a17755e5922221e121c771 
 kernel/Documentation/gpu/drm-kms-helpers.rst
....@@ -59,12 +59,6 @@
5959 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
6060    :doc: implementing nonblocking commit
6161 
62
-Atomic State Reset and Initialization
63
--------------------------------------
64
-
65
-.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
66
-   :doc: atomic state reset and initialization
67
-
6862 Helper Functions Reference
6963 --------------------------
7064 
....@@ -72,6 +66,18 @@
7266    :internal:
7367 
7468 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
69
+   :export:
70
+
71
+Atomic State Reset and Initialization
72
+-------------------------------------
73
+
74
+.. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
75
+   :doc: atomic state reset and initialization
76
+
77
+Atomic State Helper Reference
78
+-----------------------------
79
+
80
+.. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
7581    :export:
7682 
7783 Simple KMS Helper Reference
....@@ -98,6 +104,12 @@
98104 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
99105    :export:
100106 
107
+format Helper Functions Reference
108
+=================================
109
+
110
+.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
111
+   :export:
112
+
101113 Framebuffer CMA Helper Functions Reference
102114 ==========================================
103115 
....@@ -106,8 +118,6 @@
106118 
107119 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
108120    :export:
109
-
110
-.. _drm_bridges:
111121 
112122 Framebuffer GEM Helper Reference
113123 ================================
....@@ -118,6 +128,8 @@
118128 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
119129    :export:
120130 
131
+.. _drm_bridges:
132
+
121133 Bridges
122134 =======
123135 
....@@ -127,11 +139,17 @@
127139 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
128140    :doc: overview
129141 
130
-Default bridge callback sequence
131
---------------------------------
142
+Bridge Operations
143
+-----------------
132144 
133145 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
134
-   :doc: bridge callbacks
146
+   :doc: bridge operations
147
+
148
+Bridge Connector Helper
149
+-----------------------
150
+
151
+.. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
152
+   :doc: overview
135153 
136154 
137155 Bridge Helper Reference
....@@ -141,6 +159,12 @@
141159    :internal:
142160 
143161 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
162
+   :export:
163
+
164
+Bridge Connector Helper Reference
165
+---------------------------------
166
+
167
+.. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
144168    :export:
145169 
146170 Panel-Bridge Helper Reference
....@@ -164,6 +188,21 @@
164188    :export:
165189 
166190 .. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c
191
+   :export:
192
+
193
+Panel Self Refresh Helper Reference
194
+===================================
195
+
196
+.. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
197
+   :doc: overview
198
+
199
+.. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
200
+   :export:
201
+
202
+HDCP Helper Functions Reference
203
+===============================
204
+
205
+.. kernel-doc:: drivers/gpu/drm/drm_hdcp.c
167206    :export:
168207 
169208 Display Port Helper Functions Reference
....@@ -199,16 +238,50 @@
199238 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
200239    :export:
201240 
202
-Display Port MST Helper Functions Reference
203
-===========================================
241
+Display Port MST Helpers
242
+========================
243
+
244
+Overview
245
+--------
204246 
205247 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
206248    :doc: dp mst helper
249
+
250
+.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
251
+   :doc: Branch device and port refcounting
252
+
253
+Functions Reference
254
+-------------------
207255 
208256 .. kernel-doc:: include/drm/drm_dp_mst_helper.h
209257    :internal:
210258 
211259 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
260
+   :export:
261
+
262
+Topology Lifetime Internals
263
+---------------------------
264
+
265
+These functions aren't exported to drivers, but are documented here to help make
266
+the MST topology helpers easier to understand
267
+
268
+.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
269
+   :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
270
+               drm_dp_mst_topology_put_mstb
271
+               drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
272
+               drm_dp_mst_topology_put_port
273
+               drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc
274
+
275
+MIPI DBI Helper Functions Reference
276
+===================================
277
+
278
+.. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
279
+   :doc: overview
280
+
281
+.. kernel-doc:: include/drm/drm_mipi_dbi.h
282
+   :internal:
283
+
284
+.. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
212285    :export:
213286 
214287 MIPI DSI Helper Functions Reference
....@@ -265,18 +338,6 @@
265338 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
266339    :export:
267340 
268
-Rectangle Utilities Reference
269
-=============================
270
-
271
-.. kernel-doc:: include/drm/drm_rect.h
272
-   :doc: rect utils
273
-
274
-.. kernel-doc:: include/drm/drm_rect.h
275
-   :internal:
276
-
277
-.. kernel-doc:: drivers/gpu/drm/drm_rect.c
278
-   :export:
279
-
280341 HDMI Infoframes Helper Reference
281342 ================================
282343 
....@@ -291,6 +352,18 @@
291352 .. kernel-doc:: drivers/video/hdmi.c
292353    :export:
293354 
355
+Rectangle Utilities Reference
356
+=============================
357
+
358
+.. kernel-doc:: include/drm/drm_rect.h
359
+   :doc: rect utils
360
+
361
+.. kernel-doc:: include/drm/drm_rect.h
362
+   :internal:
363
+
364
+.. kernel-doc:: drivers/gpu/drm/drm_rect.c
365
+   :export:
366
+
294367 Flip-work Helper Reference
295368 ==========================
296369