Mode Setting Helper Functions¶
The DRM subsystem aims for a strong separation between core code and helper libraries. Core code takes care of general setup and teardown and decoding userspace requests to kernel internal objects. Everything else is handled by a large set of helper libraries, which can be combined freely to pick and choose for each driver what fits, and avoid shared code where special behaviour is needed.
This distinction between core code and helpers is especially strong in the modesetting code, where there's a shared userspace ABI for all drivers. This is in contrast to the render side, where pretty much everything (with very few exceptions) can be considered optional helper code.
There are a few areas these helpers can grouped into:
Helpers to implement modesetting. The important ones here are the atomic helpers. Old drivers still often use the legacy CRTC helpers. They both share the same set of common helper vtables. For really simple drivers (anything that would have been a great fit in the deprecated fbdev subsystem) there's also the simple display pipe helpers.
There's a big pile of helpers for handling outputs. First the generic bridge helpers for handling encoder and transcoder IP blocks. Second the panel helpers for handling panel-related information and logic. Plus then a big set of helpers for the various sink standards (DisplayPort, HDMI, MIPI DSI). Finally there's also generic helpers for handling output probing, and for dealing with EDIDs.
The last group of helpers concerns itself with the frontend side of a display pipeline: Planes, handling rectangles for visibility checking and scissoring, flip queues and assorted bits.
Modeset Helper Reference for Common Vtables¶
Error
kernel-doc missing
Error
kernel-doc missing
Atomic Modeset Helper Functions Reference¶
Overview¶
Error
kernel-doc missing
Implementing Asynchronous Atomic Commit¶
Error
kernel-doc missing
Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Atomic State Reset and Initialization¶
Error
kernel-doc missing
Atomic State Helper Reference¶
Error
kernel-doc missing
GEM Atomic Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Simple KMS Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
fbdev Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
format Helper Functions Reference¶
Error
kernel-doc missing
Framebuffer DMA Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Framebuffer GEM Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Bridges¶
Overview¶
Error
kernel-doc missing
Display Driver Integration¶
Error
kernel-doc missing
Special Care with MIPI-DSI bridges¶
Error
kernel-doc missing
Bridge Operations¶
Error
kernel-doc missing
Bridge Connector Helper¶
Error
kernel-doc missing
Bridge Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
MIPI-DSI bridge operation¶
Error
kernel-doc missing
Bridge Connector Helper Reference¶
Error
kernel-doc missing
Panel-Bridge Helper Reference¶
Error
kernel-doc missing
Panel Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Panel Self Refresh Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
HDCP Helper Functions Reference¶
Error
kernel-doc missing
Display Port Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Display Port CEC Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Display Port Dual Mode Adaptor Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Display Port MST Helpers¶
Overview¶
Error
kernel-doc missing
Error
kernel-doc missing
Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Topology Lifetime Internals¶
These functions aren't exported to drivers, but are documented here to help make the MST topology helpers easier to understand
Error
kernel-doc missing
MIPI DBI Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
MIPI DSI Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Display Stream Compression Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Output Probing Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
EDID Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
SCDC Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
HDMI Infoframes Helper Reference¶
Strictly speaking this is not a DRM helper library but generally useable by any driver interfacing with HDMI outputs like v4l or alsa drivers. But it nicely fits into the overall topic of mode setting helper libraries and hence is also included here.
Error
kernel-doc missing
Error
kernel-doc missing
Rectangle Utilities Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Flip-work Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Auxiliary Modeset Helpers¶
Error
kernel-doc missing
Error
kernel-doc missing
OF/DT Helpers¶
Error
kernel-doc missing
Error
kernel-doc missing
Legacy Plane Helper Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Legacy CRTC/Modeset Helper Functions Reference¶
Error
kernel-doc missing
Error
kernel-doc missing
Privacy-screen class¶
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing
Error
kernel-doc missing