drm: Document caveats around atomic event handling
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Fri, 30 Sep 2016 10:04:56 +0000 (12:04 +0200)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Tue, 4 Oct 2016 06:23:15 +0000 (08:23 +0200)
commit61802130d85fdaf9646340bf1cc64b3e06d0b19c
tree85202da72b57a058e2708c7314e3f66b4fb523a3
parent58f0f9f75c1b94dabbfc3daa333a4e68536b0a42
drm: Document caveats around atomic event handling

It's not that obvious how a driver can all race the atomic commit with
handling the completion event. And there's unfortunately a pile of
drivers with rather bad event handling which misdirect people into the
wrong direction.

Try to remedy this by documenting everything better.

v2: Type fixes Alex spotted.

v3: More typos Alex spotted.

Cc: Andrzej Hajda <a.hajda@samsung.com>
Cc: Alex Deucher <alexdeucher@gmail.com>
Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1475229896-6047-1-git-send-email-daniel.vetter@ffwll.ch
drivers/gpu/drm/drm_irq.c
include/drm/drm_crtc.h