1============================= 2Mode Setting Helper Functions 3============================= 4 5The DRM subsystem aims for a strong separation between core code and helper 6libraries. Core code takes care of general setup and teardown and decoding 7userspace requests to kernel internal objects. Everything else is handled by a 8large set of helper libraries, which can be combined freely to pick and choose 9for each driver what fits, and avoid shared code where special behaviour is 10needed. 11 12This distinction between core code and helpers is especially strong in the 13modesetting code, where there's a shared userspace ABI for all drivers. This is 14in contrast to the render side, where pretty much everything (with very few 15exceptions) 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 atomic 20 helpers. Old drivers still often use the legacy CRTC helpers. They both share 21 the same set of common helper vtables. For really simple drivers (anything 22 that would have been a great fit in the deprecated fbdev subsystem) there's 23 also the simple display pipe helpers. 24 25* There's a big pile of helpers for handling outputs. First the generic bridge 26 helpers for handling encoder and transcoder IP blocks. Second the panel helpers 27 for handling panel-related information and logic. Plus then a big set of 28 helpers for the various sink standards (DisplayPort, HDMI, MIPI DSI). Finally 29 there's also generic helpers for handling output probing, and for dealing with 30 EDIDs. 31 32* The last group of helpers concerns itself with the frontend side of a display 33 pipeline: Planes, handling rectangles for visibility checking and scissoring, 34 flip queues and assorted bits. 35 36Modeset Helper Reference for Common Vtables 37=========================================== 38 39.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h 40 :doc: overview 41 42.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h 43 :internal: 44 45.. _drm_atomic_helper: 46 47Atomic Modeset Helper Functions Reference 48========================================= 49 50Overview 51-------- 52 53.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 54 :doc: overview 55 56Implementing Asynchronous Atomic Commit 57--------------------------------------- 58 59.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 60 :doc: implementing nonblocking commit 61 62Atomic State Reset and Initialization 63------------------------------------- 64 65.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 66 :doc: atomic state reset and initialization 67 68Helper Functions Reference 69-------------------------- 70 71.. kernel-doc:: include/drm/drm_atomic_helper.h 72 :internal: 73 74.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c 75 :export: 76 77Legacy CRTC/Modeset Helper Functions Reference 78============================================== 79 80.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c 81 :doc: overview 82 83.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c 84 :export: 85 86Simple KMS Helper Reference 87=========================== 88 89.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c 90 :doc: overview 91 92.. kernel-doc:: include/drm/drm_simple_kms_helper.h 93 :internal: 94 95.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c 96 :export: 97 98fbdev Helper Functions Reference 99================================ 100 101.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c 102 :doc: fbdev helpers 103 104.. kernel-doc:: include/drm/drm_fb_helper.h 105 :internal: 106 107.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c 108 :export: 109 110Framebuffer CMA Helper Functions Reference 111========================================== 112 113.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c 114 :doc: framebuffer cma helper functions 115 116.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c 117 :export: 118 119.. _drm_bridges: 120 121Bridges 122======= 123 124Overview 125-------- 126 127.. kernel-doc:: drivers/gpu/drm/drm_bridge.c 128 :doc: overview 129 130Default bridge callback sequence 131-------------------------------- 132 133.. kernel-doc:: drivers/gpu/drm/drm_bridge.c 134 :doc: bridge callbacks 135 136 137Bridge Helper Reference 138------------------------- 139 140.. kernel-doc:: include/drm/drm_bridge.h 141 :internal: 142 143.. kernel-doc:: drivers/gpu/drm/drm_bridge.c 144 :export: 145 146Panel-Bridge Helper Reference 147----------------------------- 148 149.. kernel-doc:: drivers/gpu/drm/bridge/panel.c 150 :export: 151 152.. _drm_panel_helper: 153 154Panel Helper Reference 155====================== 156 157.. kernel-doc:: drivers/gpu/drm/drm_panel.c 158 :doc: drm panel 159 160.. kernel-doc:: include/drm/drm_panel.h 161 :internal: 162 163.. kernel-doc:: drivers/gpu/drm/drm_panel.c 164 :export: 165 166.. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c 167 :export: 168 169Display Port Helper Functions Reference 170======================================= 171 172.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c 173 :doc: dp helpers 174 175.. kernel-doc:: include/drm/drm_dp_helper.h 176 :internal: 177 178.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c 179 :export: 180 181Display Port Dual Mode Adaptor Helper Functions Reference 182========================================================= 183 184.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c 185 :doc: dp dual mode helpers 186 187.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h 188 :internal: 189 190.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c 191 :export: 192 193Display Port MST Helper Functions Reference 194=========================================== 195 196.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c 197 :doc: dp mst helper 198 199.. kernel-doc:: include/drm/drm_dp_mst_helper.h 200 :internal: 201 202.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c 203 :export: 204 205MIPI DSI Helper Functions Reference 206=================================== 207 208.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c 209 :doc: dsi helpers 210 211.. kernel-doc:: include/drm/drm_mipi_dsi.h 212 :internal: 213 214.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c 215 :export: 216 217Output Probing Helper Functions Reference 218========================================= 219 220.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c 221 :doc: output probing helper overview 222 223.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c 224 :export: 225 226EDID Helper Functions Reference 227=============================== 228 229.. kernel-doc:: include/drm/drm_edid.h 230 :internal: 231 232.. kernel-doc:: drivers/gpu/drm/drm_edid.c 233 :export: 234 235SCDC Helper Functions Reference 236=============================== 237 238.. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c 239 :doc: scdc helpers 240 241.. kernel-doc:: include/drm/drm_scdc_helper.h 242 :internal: 243 244.. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c 245 :export: 246 247Rectangle Utilities Reference 248============================= 249 250.. kernel-doc:: include/drm/drm_rect.h 251 :doc: rect utils 252 253.. kernel-doc:: include/drm/drm_rect.h 254 :internal: 255 256.. kernel-doc:: drivers/gpu/drm/drm_rect.c 257 :export: 258 259HDMI Infoframes Helper Reference 260================================ 261 262Strictly speaking this is not a DRM helper library but generally useable 263by any driver interfacing with HDMI outputs like v4l or alsa drivers. 264But it nicely fits into the overall topic of mode setting helper 265libraries and hence is also included here. 266 267.. kernel-doc:: include/linux/hdmi.h 268 :internal: 269 270.. kernel-doc:: drivers/video/hdmi.c 271 :export: 272 273Flip-work Helper Reference 274========================== 275 276.. kernel-doc:: include/drm/drm_flip_work.h 277 :doc: flip utils 278 279.. kernel-doc:: include/drm/drm_flip_work.h 280 :internal: 281 282.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c 283 :export: 284 285Plane Helper Reference 286====================== 287 288.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c 289 :doc: overview 290 291.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c 292 :export: 293 294Auxiliary Modeset Helpers 295========================= 296 297.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c 298 :doc: aux kms helpers 299 300.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c 301 :export: 302 303Framebuffer GEM Helper Reference 304================================ 305 306.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c 307 :doc: overview 308 309.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c 310 :export: 311