mirror of
https://github.com/Fishwaldo/linux-bl808.git
synced 2025-06-17 20:25:19 +00:00
drm/sun4i: backend: Document the engine operations
Our operations were missing some documentation to explain what was expected from them. Let's make that clearer. Reviewed-by: Chen-Yu Tsai <wens@csie.org> Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com> Link: https://patchwork.freedesktop.org/patch/msgid/fdcd8ec3ae9ecd73ef089ede5218d3a41b49be05.1516613040.git-series.maxime.ripard@free-electrons.com
This commit is contained in:
parent
f5870879e9
commit
c4c7c72e5c
1 changed files with 46 additions and 0 deletions
|
@ -15,12 +15,58 @@ struct drm_device;
|
||||||
|
|
||||||
struct sunxi_engine;
|
struct sunxi_engine;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* struct sunxi_engine_ops - helper operations for sunXi engines
|
||||||
|
*
|
||||||
|
* These hooks are used by the common part of the DRM driver to
|
||||||
|
* implement the proper behaviour.
|
||||||
|
*/
|
||||||
struct sunxi_engine_ops {
|
struct sunxi_engine_ops {
|
||||||
|
/**
|
||||||
|
* @commit:
|
||||||
|
*
|
||||||
|
* This callback will trigger the hardware switch to commit
|
||||||
|
* the new configuration that has been setup during the next
|
||||||
|
* vblank period.
|
||||||
|
*
|
||||||
|
* This function is optional.
|
||||||
|
*/
|
||||||
void (*commit)(struct sunxi_engine *engine);
|
void (*commit)(struct sunxi_engine *engine);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @layers_init:
|
||||||
|
*
|
||||||
|
* This callback is used to allocate, initialize and register
|
||||||
|
* the layers supported by that engine.
|
||||||
|
*
|
||||||
|
* This function is mandatory.
|
||||||
|
*
|
||||||
|
* RETURNS:
|
||||||
|
*
|
||||||
|
* The array of struct drm_plane backing the layers, or an
|
||||||
|
* error pointer on failure.
|
||||||
|
*/
|
||||||
struct drm_plane **(*layers_init)(struct drm_device *drm,
|
struct drm_plane **(*layers_init)(struct drm_device *drm,
|
||||||
struct sunxi_engine *engine);
|
struct sunxi_engine *engine);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @apply_color_correction:
|
||||||
|
*
|
||||||
|
* This callback will enable the color correction in the
|
||||||
|
* engine. This is useful only for the composite output.
|
||||||
|
*
|
||||||
|
* This function is optional.
|
||||||
|
*/
|
||||||
void (*apply_color_correction)(struct sunxi_engine *engine);
|
void (*apply_color_correction)(struct sunxi_engine *engine);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @disable_color_correction:
|
||||||
|
*
|
||||||
|
* This callback will stop the color correction in the
|
||||||
|
* engine. This is useful only for the composite output.
|
||||||
|
*
|
||||||
|
* This function is optional.
|
||||||
|
*/
|
||||||
void (*disable_color_correction)(struct sunxi_engine *engine);
|
void (*disable_color_correction)(struct sunxi_engine *engine);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue