12fa91d15SJani Nikula============================= 22fa91d15SJani NikulaMode Setting Helper Functions 32fa91d15SJani Nikula============================= 42fa91d15SJani Nikula 5bcb32b69SDaniel VetterThe DRM subsystem aims for a strong separation between core code and helper 6bcb32b69SDaniel Vetterlibraries. Core code takes care of general setup and teardown and decoding 7bcb32b69SDaniel Vetteruserspace requests to kernel internal objects. Everything else is handled by a 8bcb32b69SDaniel Vetterlarge set of helper libraries, which can be combined freely to pick and choose 9bcb32b69SDaniel Vetterfor each driver what fits, and avoid shared code where special behaviour is 10bcb32b69SDaniel Vetterneeded. 112fa91d15SJani Nikula 12bcb32b69SDaniel VetterThis distinction between core code and helpers is especially strong in the 13bcb32b69SDaniel Vettermodesetting code, where there's a shared userspace ABI for all drivers. This is 14bcb32b69SDaniel Vetterin contrast to the render side, where pretty much everything (with very few 15bcb32b69SDaniel Vetterexceptions) can be considered optional helper code. 162fa91d15SJani Nikula 17bcb32b69SDaniel VetterThere are a few areas these helpers can grouped into: 182fa91d15SJani Nikula 19bcb32b69SDaniel Vetter* Helpers to implement modesetting. The important ones here are the atomic 20bcb32b69SDaniel Vetter helpers. Old drivers still often use the legacy CRTC helpers. They both share 21bcb32b69SDaniel Vetter the same set of common helper vtables. For really simple drivers (anything 22bcb32b69SDaniel Vetter that would have been a great fit in the deprecated fbdev subsystem) there's 23bcb32b69SDaniel Vetter also the simple display pipe helpers. 24bcb32b69SDaniel Vetter 25bcb32b69SDaniel Vetter* There's a big pile of helpers for handling outputs. First the generic bridge 26bcb32b69SDaniel Vetter helpers for handling encoder and transcoder IP blocks. Second the panel helpers 27bcb32b69SDaniel Vetter for handling panel-related information and logic. Plus then a big set of 28bcb32b69SDaniel Vetter helpers for the various sink standards (DisplayPort, HDMI, MIPI DSI). Finally 29bcb32b69SDaniel Vetter there's also generic helpers for handling output probing, and for dealing with 30bcb32b69SDaniel Vetter EDIDs. 31bcb32b69SDaniel Vetter 32bcb32b69SDaniel Vetter* The last group of helpers concerns itself with the frontend side of a display 33bcb32b69SDaniel Vetter pipeline: Planes, handling rectangles for visibility checking and scissoring, 34bcb32b69SDaniel Vetter flip queues and assorted bits. 35bcb32b69SDaniel Vetter 36bcb32b69SDaniel VetterModeset Helper Reference for Common Vtables 37bcb32b69SDaniel Vetter=========================================== 38bcb32b69SDaniel Vetter 39bcb32b69SDaniel Vetter.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h 401ea35768SDaniel Vetter :doc: overview 41bcb32b69SDaniel Vetter 42bcb32b69SDaniel Vetter.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h 431ea35768SDaniel Vetter :internal: 442fa91d15SJani Nikula 454a8e2292SDaniel Vetter.. _drm_atomic_helper: 464a8e2292SDaniel Vetter 472fa91d15SJani NikulaAtomic Modeset Helper Functions Reference 482fa91d15SJani Nikula========================================= 492fa91d15SJani Nikula 502fa91d15SJani NikulaOverview 512fa91d15SJani Nikula-------- 522fa91d15SJani Nikula 532fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 542fa91d15SJani Nikula :doc: overview 552fa91d15SJani Nikula 562fa91d15SJani NikulaImplementing Asynchronous Atomic Commit 572fa91d15SJani Nikula--------------------------------------- 582fa91d15SJani Nikula 592fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 602fa91d15SJani Nikula :doc: implementing nonblocking commit 612fa91d15SJani Nikula 622fa91d15SJani NikulaAtomic State Reset and Initialization 632fa91d15SJani Nikula------------------------------------- 642fa91d15SJani Nikula 652fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 662fa91d15SJani Nikula :doc: atomic state reset and initialization 672fa91d15SJani Nikula 681ea0c02eSDaniel VetterHelper Functions Reference 691ea0c02eSDaniel Vetter-------------------------- 701ea0c02eSDaniel Vetter 712fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_atomic_helper.h 722fa91d15SJani Nikula :internal: 732fa91d15SJani Nikula 742fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 752fa91d15SJani Nikula :export: 762fa91d15SJani Nikula 772fa91d15SJani NikulaLegacy CRTC/Modeset Helper Functions Reference 782fa91d15SJani Nikula============================================== 792fa91d15SJani Nikula 802fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c 812fa91d15SJani Nikula :doc: overview 822fa91d15SJani Nikula 83bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c 842fa91d15SJani Nikula :export: 852fa91d15SJani Nikula 86bcb32b69SDaniel VetterSimple KMS Helper Reference 87bcb32b69SDaniel Vetter=========================== 88bcb32b69SDaniel Vetter 891ea35768SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c 901ea35768SDaniel Vetter :doc: overview 911ea35768SDaniel Vetter 92bcb32b69SDaniel Vetter.. kernel-doc:: include/drm/drm_simple_kms_helper.h 93bcb32b69SDaniel Vetter :internal: 94bcb32b69SDaniel Vetter 95bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c 96bcb32b69SDaniel Vetter :export: 97bcb32b69SDaniel Vetter 982fa91d15SJani Nikulafbdev Helper Functions Reference 992fa91d15SJani Nikula================================ 1002fa91d15SJani Nikula 1012fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c 1022fa91d15SJani Nikula :doc: fbdev helpers 1032fa91d15SJani Nikula 1042fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_fb_helper.h 1052fa91d15SJani Nikula :internal: 1062fa91d15SJani Nikula 1071ea35768SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c 1081ea35768SDaniel Vetter :export: 1091ea35768SDaniel Vetter 1102fa91d15SJani NikulaFramebuffer CMA Helper Functions Reference 1112fa91d15SJani Nikula========================================== 1122fa91d15SJani Nikula 1132fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c 1142fa91d15SJani Nikula :doc: framebuffer cma helper functions 1152fa91d15SJani Nikula 1162fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c 1172fa91d15SJani Nikula :export: 1182fa91d15SJani Nikula 1192564d0b0SDaniel Vetter.. _drm_bridges: 1202564d0b0SDaniel Vetter 121bcb32b69SDaniel VetterBridges 122bcb32b69SDaniel Vetter======= 123bcb32b69SDaniel Vetter 124bcb32b69SDaniel VetterOverview 125bcb32b69SDaniel Vetter-------- 126bcb32b69SDaniel Vetter 127bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_bridge.c 128bcb32b69SDaniel Vetter :doc: overview 129bcb32b69SDaniel Vetter 130bcb32b69SDaniel VetterDefault bridge callback sequence 131bcb32b69SDaniel Vetter-------------------------------- 132bcb32b69SDaniel Vetter 133bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_bridge.c 134bcb32b69SDaniel Vetter :doc: bridge callbacks 135bcb32b69SDaniel Vetter 136199e4e96SDaniel Vetter 137199e4e96SDaniel VetterBridge Helper Reference 138199e4e96SDaniel Vetter------------------------- 139199e4e96SDaniel Vetter 140199e4e96SDaniel Vetter.. kernel-doc:: include/drm/drm_bridge.h 141199e4e96SDaniel Vetter :internal: 142199e4e96SDaniel Vetter 143bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_bridge.c 144bcb32b69SDaniel Vetter :export: 145bcb32b69SDaniel Vetter 1462564d0b0SDaniel Vetter.. _drm_panel_helper: 1472564d0b0SDaniel Vetter 148bcb32b69SDaniel VetterPanel Helper Reference 149bcb32b69SDaniel Vetter====================== 150bcb32b69SDaniel Vetter 1511ea35768SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_panel.c 1521ea35768SDaniel Vetter :doc: drm panel 1531ea35768SDaniel Vetter 154bcb32b69SDaniel Vetter.. kernel-doc:: include/drm/drm_panel.h 155bcb32b69SDaniel Vetter :internal: 156bcb32b69SDaniel Vetter 157bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_panel.c 158bcb32b69SDaniel Vetter :export: 159bcb32b69SDaniel Vetter 1602fa91d15SJani NikulaDisplay Port Helper Functions Reference 1612fa91d15SJani Nikula======================================= 1622fa91d15SJani Nikula 1632fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c 1642fa91d15SJani Nikula :doc: dp helpers 1652fa91d15SJani Nikula 1662fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_dp_helper.h 1672fa91d15SJani Nikula :internal: 1682fa91d15SJani Nikula 1692fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c 1702fa91d15SJani Nikula :export: 1712fa91d15SJani Nikula 1722fa91d15SJani NikulaDisplay Port Dual Mode Adaptor Helper Functions Reference 1732fa91d15SJani Nikula========================================================= 1742fa91d15SJani Nikula 1752fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c 1762fa91d15SJani Nikula :doc: dp dual mode helpers 1772fa91d15SJani Nikula 1782fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h 1792fa91d15SJani Nikula :internal: 1802fa91d15SJani Nikula 1812fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c 1822fa91d15SJani Nikula :export: 1832fa91d15SJani Nikula 1842fa91d15SJani NikulaDisplay Port MST Helper Functions Reference 1852fa91d15SJani Nikula=========================================== 1862fa91d15SJani Nikula 1872fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c 1882fa91d15SJani Nikula :doc: dp mst helper 1892fa91d15SJani Nikula 1902fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_dp_mst_helper.h 1912fa91d15SJani Nikula :internal: 1922fa91d15SJani Nikula 1932fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c 1942fa91d15SJani Nikula :export: 1952fa91d15SJani Nikula 1962fa91d15SJani NikulaMIPI DSI Helper Functions Reference 1972fa91d15SJani Nikula=================================== 1982fa91d15SJani Nikula 1992fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c 2002fa91d15SJani Nikula :doc: dsi helpers 2012fa91d15SJani Nikula 2022fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_mipi_dsi.h 2032fa91d15SJani Nikula :internal: 2042fa91d15SJani Nikula 2052fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c 2062fa91d15SJani Nikula :export: 2072fa91d15SJani Nikula 208bcb32b69SDaniel VetterOutput Probing Helper Functions Reference 209bcb32b69SDaniel Vetter========================================= 210bcb32b69SDaniel Vetter 211bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c 212bcb32b69SDaniel Vetter :doc: output probing helper overview 213bcb32b69SDaniel Vetter 214bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c 215bcb32b69SDaniel Vetter :export: 216bcb32b69SDaniel Vetter 2172fa91d15SJani NikulaEDID Helper Functions Reference 2182fa91d15SJani Nikula=============================== 2192fa91d15SJani Nikula 220cdc3d09fSDaniel Vetter.. kernel-doc:: include/drm/drm_edid.h 221cdc3d09fSDaniel Vetter :internal: 222cdc3d09fSDaniel Vetter 2232fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_edid.c 2242fa91d15SJani Nikula :export: 2252fa91d15SJani Nikula 2262fa91d15SJani NikulaRectangle Utilities Reference 2272fa91d15SJani Nikula============================= 2282fa91d15SJani Nikula 2292fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_rect.h 2302fa91d15SJani Nikula :doc: rect utils 2312fa91d15SJani Nikula 2322fa91d15SJani Nikula.. kernel-doc:: include/drm/drm_rect.h 2332fa91d15SJani Nikula :internal: 2342fa91d15SJani Nikula 2352fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_rect.c 2362fa91d15SJani Nikula :export: 2372fa91d15SJani Nikula 2382fa91d15SJani NikulaHDMI Infoframes Helper Reference 2392fa91d15SJani Nikula================================ 2402fa91d15SJani Nikula 2412fa91d15SJani NikulaStrictly speaking this is not a DRM helper library but generally useable 2422fa91d15SJani Nikulaby any driver interfacing with HDMI outputs like v4l or alsa drivers. 2432fa91d15SJani NikulaBut it nicely fits into the overall topic of mode setting helper 2442fa91d15SJani Nikulalibraries and hence is also included here. 2452fa91d15SJani Nikula 2462fa91d15SJani Nikula.. kernel-doc:: include/linux/hdmi.h 2472fa91d15SJani Nikula :internal: 2482fa91d15SJani Nikula 2492fa91d15SJani Nikula.. kernel-doc:: drivers/video/hdmi.c 2502fa91d15SJani Nikula :export: 2512fa91d15SJani Nikula 252bcb32b69SDaniel VetterFlip-work Helper Reference 253bcb32b69SDaniel Vetter========================== 254bcb32b69SDaniel Vetter 255bcb32b69SDaniel Vetter.. kernel-doc:: include/drm/drm_flip_work.h 256bcb32b69SDaniel Vetter :doc: flip utils 257bcb32b69SDaniel Vetter 258bcb32b69SDaniel Vetter.. kernel-doc:: include/drm/drm_flip_work.h 259bcb32b69SDaniel Vetter :internal: 260bcb32b69SDaniel Vetter 261bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c 262bcb32b69SDaniel Vetter :export: 263bcb32b69SDaniel Vetter 2642fa91d15SJani NikulaPlane Helper Reference 2652fa91d15SJani Nikula====================== 2662fa91d15SJani Nikula 2672fa91d15SJani Nikula.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c 2682fa91d15SJani Nikula :doc: overview 2692fa91d15SJani Nikula 270bcb32b69SDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c 271bcb32b69SDaniel Vetter :export: 272bcb32b69SDaniel Vetter 2731de72fafSDaniel VetterAuxiliary Modeset Helpers 2741de72fafSDaniel Vetter========================= 2751de72fafSDaniel Vetter 2761de72fafSDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c 2771de72fafSDaniel Vetter :doc: aux kms helpers 2781de72fafSDaniel Vetter 2791de72fafSDaniel Vetter.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c 2801de72fafSDaniel Vetter :export: 281