linux/Documentation/gpu
Sean Paul 1452c25b0e drm: Add helpers to kick off self refresh mode in drivers
This patch adds a new drm helper library to help drivers implement
self refresh. Drivers choosing to use it will register crtcs and
will receive callbacks when it's time to enter or exit self refresh
mode.

In its current form, it has a timer which will trigger after a
driver-specified amount of inactivity. When the timer triggers, the
helpers will submit a new atomic commit to shut the refreshing pipe
off. On the next atomic commit, the drm core will revert the self
refresh state and bring everything back up to be actively driven.

From the driver's perspective, this works like a regular disable/enable
cycle. The driver need only check the 'self_refresh_active' state in
crtc_state. It should initiate self refresh mode on the panel and enter
an off or low-power state.

Changes in v2:
- s/psr/self_refresh/ (Daniel)
- integrated the psr exit into the commit that wakes it up (Jose/Daniel)
- made the psr state per-crtc (Jose/Daniel)
Changes in v3:
- Remove the self_refresh_(active|changed) from connector state (Daniel)
- Simplify loop in drm_self_refresh_helper_alter_state (Daniel)
- Improve self_refresh_aware comment (Daniel)
- s/self_refresh_state/self_refresh_data/ (Daniel)
Changes in v4:
- Move docbook location below panel (Daniel)
- Improve docbook with references and more detailed explanation (Daniel)
- Instead of register/unregister, use init/cleanup (Daniel)
Changes in v5:
- Resolved conflict in drm_atomic_helper.c #include block
- Resolved conflict in rst with HDCP helper docs
Changes in v6:
- Fix include ordering, clean up forward declarations (Sam)

Link to v1: https://patchwork.freedesktop.org/patch/msgid/20190228210939.83386-2-sean@poorly.run
Link to v2: https://patchwork.freedesktop.org/patch/msgid/20190326204509.96515-1-sean@poorly.run
Link to v3: https://patchwork.freedesktop.org/patch/msgid/20190502194956.218441-6-sean@poorly.run
Link to v4: https://patchwork.freedesktop.org/patch/msgid/20190508160920.144739-6-sean@poorly.run
Link to v5: https://patchwork.freedesktop.org/patch/msgid/20190611160844.257498-6-sean@poorly.run

Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Jose Souza <jose.souza@intel.com>
Cc: Zain Wang <wzz@rock-chips.com>
Cc: Tomasz Figa <tfiga@chromium.org>
Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Cc: Sam Ravnborg <sam@ravnborg.org>
Tested-by: Heiko Stuebner <heiko@sntech.de>
Reviewed-by: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: Sean Paul <seanpaul@chromium.org>
Link: https://patchwork.freedesktop.org/patch/msgid/20190612145026.191846-1-sean@poorly.run
2019-06-13 14:31:10 -04:00
..
bridge drm: bridge: dw-hdmi: Add Documentation on supported input formats 2017-04-04 17:48:21 +02:00
dp-mst drm/dp_mst: Introduce new refcounting scheme for mstbs and ports 2019-01-10 20:12:19 -05:00
afbc.rst drm/afbc: Add AFBC modifier usage documentation 2019-01-11 17:52:06 +00:00
amdgpu-dc.rst drm/amd/display: Initial documentation for AMDgpu DC 2018-11-05 14:21:37 -05:00
amdgpu.rst drm/amdgpu: update documentation for amdgpu_drv.c 2018-07-05 16:40:04 -05:00
conf.py doc-rst: build PDF of 80211 and gpu sub-project 2016-10-26 17:25:17 -06:00
drivers.rst drm/mcde: Add new driver for ST-Ericsson MCDE 2019-05-24 17:00:13 +02:00
drm-client.rst drm/fb-helper: Remove drm_fb_helper_crtc 2019-06-04 12:13:47 +02:00
drm-internals.rst drm/doc: document recommended component helper usage 2019-02-19 12:22:24 +01:00
drm-kms-helpers.rst drm: Add helpers to kick off self refresh mode in drivers 2019-06-13 14:31:10 -04:00
drm-kms.rst drm/doc: Drop chapter "KMS Initialization and Cleanup" 2019-01-30 22:16:18 +01:00
drm-mm.rst drm: Integrate VRAM MM into struct drm_device 2019-05-15 16:17:06 +02:00
drm-uapi.rst drm: ADD UAPI structure definition section in kernel doc 2019-06-04 13:00:23 +02:00
i915.rst drm/i915: Move a bunch of workaround-related code to its own file 2018-04-11 22:47:01 +01:00
index.rst drm: Begin an API for in-kernel clients 2018-07-10 14:51:37 +02:00
introduction.rst drm: Document code of conduct 2017-05-05 11:48:17 +10:00
kms-properties.csv drm/doc: Drop "content type" from the legacy kms property table 2019-03-26 14:18:51 +01:00
komeda-kms.rst drm/doc: Add initial komeda driver documentation 2019-01-14 11:20:11 +00:00
mcde.rst drm/mcde: Add new driver for ST-Ericsson MCDE 2019-05-24 17:00:13 +02:00
meson.rst Documentation/gpu/meson: Remove link to meson_canvas.c 2019-04-05 08:35:05 -04:00
msm-crash-dump.rst drm/msm/gpu: Add the buffer objects from the submit to the crash dump 2018-07-30 08:50:10 -04:00
pl111.rst drm/pl111: Initial drm/kms driver for pl111 2017-05-08 12:24:06 -07:00
tegra.rst drm/tegra: Add driver documentation 2017-06-15 13:58:56 +02:00
tinydrm.rst drm/tinydrm: Remove tinydrm_device 2019-03-04 15:31:27 +01:00
todo.rst drm/todo: Add bootsplash entry 2019-06-11 14:48:44 +02:00
tve200.rst drm/tve200: fix kernel-doc documentation comment include 2018-02-21 09:26:38 +02:00
v3d.rst drm/v3d: Add missing v3d documentation structure. 2018-07-05 11:42:50 -07:00
vc4.rst drm/vc4: Add a paragraph at the top of vc4 docs introducing what it is. 2017-02-28 12:51:49 -08:00
vga-switcheroo.rst drm/doc: Fix vga_switcheroo xref 2016-08-24 13:11:08 +02:00
vgaarbiter.rst vgaarbiter: rst-ifiy and polish kerneldoc 2016-08-16 18:49:56 +02:00
vkms.rst drm/doc: Remove solved "VBlank issues" 2019-02-06 21:40:56 +01:00
xen-front.rst drm/xen-front: Remove CMA support 2018-04-18 10:18:27 +03:00