478 lines · plain
1=============================2Mode Setting Helper Functions3=============================4 5The DRM subsystem aims for a strong separation between core code and helper6libraries. Core code takes care of general setup and teardown and decoding7userspace requests to kernel internal objects. Everything else is handled by a8large set of helper libraries, which can be combined freely to pick and choose9for each driver what fits, and avoid shared code where special behaviour is10needed.11 12This distinction between core code and helpers is especially strong in the13modesetting code, where there's a shared userspace ABI for all drivers. This is14in contrast to the render side, where pretty much everything (with very few15exceptions) can be considered optional helper code.16 17There are a few areas these helpers can grouped into:18 19* Helpers to implement modesetting. The important ones here are the atomic20 helpers. Old drivers still often use the legacy CRTC helpers. They both share21 the same set of common helper vtables. For really simple drivers (anything22 that would have been a great fit in the deprecated fbdev subsystem) there's23 also the simple display pipe helpers.24 25* There's a big pile of helpers for handling outputs. First the generic bridge26 helpers for handling encoder and transcoder IP blocks. Second the panel helpers27 for handling panel-related information and logic. Plus then a big set of28 helpers for the various sink standards (DisplayPort, HDMI, MIPI DSI). Finally29 there's also generic helpers for handling output probing, and for dealing with30 EDIDs.31 32* The last group of helpers concerns itself with the frontend side of a display33 pipeline: Planes, handling rectangles for visibility checking and scissoring,34 flip queues and assorted bits.35 36Modeset Helper Reference for Common Vtables37===========================================38 39.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h40 :doc: overview41 42.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h43 :internal:44 45.. _drm_atomic_helper:46 47Atomic Modeset Helper Functions Reference48=========================================49 50Overview51--------52 53.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c54 :doc: overview55 56Implementing Asynchronous Atomic Commit57---------------------------------------58 59.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c60 :doc: implementing nonblocking commit61 62Helper Functions Reference63--------------------------64 65.. kernel-doc:: include/drm/drm_atomic_helper.h66 :internal:67 68.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c69 :export:70 71Atomic State Reset and Initialization72-------------------------------------73 74.. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c75 :doc: atomic state reset and initialization76 77Atomic State Helper Reference78-----------------------------79 80.. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c81 :export:82 83GEM Atomic Helper Reference84---------------------------85 86.. kernel-doc:: drivers/gpu/drm/drm_gem_atomic_helper.c87 :doc: overview88 89.. kernel-doc:: include/drm/drm_gem_atomic_helper.h90 :internal:91 92.. kernel-doc:: drivers/gpu/drm/drm_gem_atomic_helper.c93 :export:94 95Simple KMS Helper Reference96===========================97 98.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c99 :doc: overview100 101.. kernel-doc:: include/drm/drm_simple_kms_helper.h102 :internal:103 104.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c105 :export:106 107fbdev Helper Functions Reference108================================109 110.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c111 :doc: fbdev helpers112 113.. kernel-doc:: drivers/gpu/drm/drm_fbdev_dma.c114 :export:115 116.. kernel-doc:: drivers/gpu/drm/drm_fbdev_shmem.c117 :export:118 119.. kernel-doc:: drivers/gpu/drm/drm_fbdev_ttm.c120 :export:121 122.. kernel-doc:: include/drm/drm_fb_helper.h123 :internal:124 125.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c126 :export:127 128format Helper Functions Reference129=================================130 131.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c132 :export:133 134Framebuffer DMA Helper Functions Reference135==========================================136 137.. kernel-doc:: drivers/gpu/drm/drm_fb_dma_helper.c138 :doc: framebuffer dma helper functions139 140.. kernel-doc:: drivers/gpu/drm/drm_fb_dma_helper.c141 :export:142 143Framebuffer GEM Helper Reference144================================145 146.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c147 :doc: overview148 149.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c150 :export:151 152.. _drm_bridges:153 154Bridges155=======156 157Overview158--------159 160.. kernel-doc:: drivers/gpu/drm/drm_bridge.c161 :doc: overview162 163Display Driver Integration164--------------------------165 166.. kernel-doc:: drivers/gpu/drm/drm_bridge.c167 :doc: display driver integration168 169Special Care with MIPI-DSI bridges170----------------------------------171 172.. kernel-doc:: drivers/gpu/drm/drm_bridge.c173 :doc: special care dsi174 175Bridge Operations176-----------------177 178.. kernel-doc:: drivers/gpu/drm/drm_bridge.c179 :doc: bridge operations180 181Bridge Connector Helper182-----------------------183 184.. kernel-doc:: drivers/gpu/drm/display/drm_bridge_connector.c185 :doc: overview186 187 188Bridge Helper Reference189-------------------------190 191.. kernel-doc:: include/drm/drm_bridge.h192 :internal:193 194.. kernel-doc:: drivers/gpu/drm/drm_bridge.c195 :export:196 197MIPI-DSI bridge operation198-------------------------199 200.. kernel-doc:: drivers/gpu/drm/drm_bridge.c201 :doc: dsi bridge operations202 203 204Bridge Connector Helper Reference205---------------------------------206 207.. kernel-doc:: drivers/gpu/drm/display/drm_bridge_connector.c208 :export:209 210Panel-Bridge Helper Reference211-----------------------------212 213.. kernel-doc:: drivers/gpu/drm/bridge/panel.c214 :export:215 216.. _drm_panel_helper:217 218Panel Helper Reference219======================220 221.. kernel-doc:: drivers/gpu/drm/drm_panel.c222 :doc: drm panel223 224.. kernel-doc:: include/drm/drm_panel.h225 :internal:226 227.. kernel-doc:: drivers/gpu/drm/drm_panel.c228 :export:229 230.. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c231 :export:232 233Panel Self Refresh Helper Reference234===================================235 236.. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c237 :doc: overview238 239.. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c240 :export:241 242HDCP Helper Functions Reference243===============================244 245.. kernel-doc:: drivers/gpu/drm/display/drm_hdcp_helper.c246 :export:247 248Display Port Helper Functions Reference249=======================================250 251.. kernel-doc:: drivers/gpu/drm/display/drm_dp_helper.c252 :doc: dp helpers253 254.. kernel-doc:: include/drm/display/drm_dp.h255 :internal:256 257.. kernel-doc:: include/drm/display/drm_dp_helper.h258 :internal:259 260.. kernel-doc:: drivers/gpu/drm/display/drm_dp_helper.c261 :export:262 263Display Port CEC Helper Functions Reference264===========================================265 266.. kernel-doc:: drivers/gpu/drm/display/drm_dp_cec.c267 :doc: dp cec helpers268 269.. kernel-doc:: drivers/gpu/drm/display/drm_dp_cec.c270 :export:271 272Display Port Dual Mode Adaptor Helper Functions Reference273=========================================================274 275.. kernel-doc:: drivers/gpu/drm/display/drm_dp_dual_mode_helper.c276 :doc: dp dual mode helpers277 278.. kernel-doc:: include/drm/display/drm_dp_dual_mode_helper.h279 :internal:280 281.. kernel-doc:: drivers/gpu/drm/display/drm_dp_dual_mode_helper.c282 :export:283 284Display Port MST Helpers285========================286 287Overview288--------289 290.. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c291 :doc: dp mst helper292 293.. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c294 :doc: Branch device and port refcounting295 296Functions Reference297-------------------298 299.. kernel-doc:: include/drm/display/drm_dp_mst_helper.h300 :internal:301 302.. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c303 :export:304 305Topology Lifetime Internals306---------------------------307 308These functions aren't exported to drivers, but are documented here to help make309the MST topology helpers easier to understand310 311.. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c312 :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb313 drm_dp_mst_topology_put_mstb314 drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port315 drm_dp_mst_topology_put_port316 drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc317 318MIPI DBI Helper Functions Reference319===================================320 321.. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c322 :doc: overview323 324.. kernel-doc:: include/drm/drm_mipi_dbi.h325 :internal:326 327.. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c328 :export:329 330MIPI DSI Helper Functions Reference331===================================332 333.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c334 :doc: dsi helpers335 336.. kernel-doc:: include/drm/drm_mipi_dsi.h337 :internal:338 339.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c340 :export:341 342Display Stream Compression Helper Functions Reference343=====================================================344 345.. kernel-doc:: drivers/gpu/drm/display/drm_dsc_helper.c346 :doc: dsc helpers347 348.. kernel-doc:: include/drm/display/drm_dsc.h349 :internal:350 351.. kernel-doc:: drivers/gpu/drm/display/drm_dsc_helper.c352 :export:353 354Output Probing Helper Functions Reference355=========================================356 357.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c358 :doc: output probing helper overview359 360.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c361 :export:362 363EDID Helper Functions Reference364===============================365 366.. kernel-doc:: include/drm/drm_edid.h367 :internal:368 369.. kernel-doc:: drivers/gpu/drm/drm_edid.c370 :export:371 372.. kernel-doc:: include/drm/drm_eld.h373 :internal:374 375.. kernel-doc:: drivers/gpu/drm/drm_eld.c376 :export:377 378SCDC Helper Functions Reference379===============================380 381.. kernel-doc:: drivers/gpu/drm/display/drm_scdc_helper.c382 :doc: scdc helpers383 384.. kernel-doc:: include/drm/display/drm_scdc_helper.h385 :internal:386 387.. kernel-doc:: drivers/gpu/drm/display/drm_scdc_helper.c388 :export:389 390HDMI Infoframes Helper Reference391================================392 393Strictly speaking this is not a DRM helper library but generally usable394by any driver interfacing with HDMI outputs like v4l or alsa drivers.395But it nicely fits into the overall topic of mode setting helper396libraries and hence is also included here.397 398.. kernel-doc:: include/linux/hdmi.h399 :internal:400 401.. kernel-doc:: drivers/video/hdmi.c402 :export:403 404Rectangle Utilities Reference405=============================406 407.. kernel-doc:: include/drm/drm_rect.h408 :doc: rect utils409 410.. kernel-doc:: include/drm/drm_rect.h411 :internal:412 413.. kernel-doc:: drivers/gpu/drm/drm_rect.c414 :export:415 416Flip-work Helper Reference417==========================418 419.. kernel-doc:: include/drm/drm_flip_work.h420 :doc: flip utils421 422.. kernel-doc:: include/drm/drm_flip_work.h423 :internal:424 425.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c426 :export:427 428Auxiliary Modeset Helpers429=========================430 431.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c432 :doc: aux kms helpers433 434.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c435 :export:436 437OF/DT Helpers438=============439 440.. kernel-doc:: drivers/gpu/drm/drm_of.c441 :doc: overview442 443.. kernel-doc:: drivers/gpu/drm/drm_of.c444 :export:445 446Legacy Plane Helper Reference447=============================448 449.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c450 :doc: overview451 452.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c453 :export:454 455Legacy CRTC/Modeset Helper Functions Reference456==============================================457 458.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c459 :doc: overview460 461.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c462 :export:463 464Privacy-screen class465====================466 467.. kernel-doc:: drivers/gpu/drm/drm_privacy_screen.c468 :doc: overview469 470.. kernel-doc:: include/drm/drm_privacy_screen_driver.h471 :internal:472 473.. kernel-doc:: include/drm/drm_privacy_screen_machine.h474 :internal:475 476.. kernel-doc:: drivers/gpu/drm/drm_privacy_screen.c477 :export:478