| Noralf Trønnes | 5b80907 | 2016-06-10 16:55:59 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 Noralf Trønnes |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU General Public License as published by |
| 6 | * the Free Software Foundation; either version 2 of the License, or |
| 7 | * (at your option) any later version. |
| 8 | */ |
| 9 | |
| 10 | #ifndef __LINUX_DRM_SIMPLE_KMS_HELPER_H |
| 11 | #define __LINUX_DRM_SIMPLE_KMS_HELPER_H |
| 12 | |
| 13 | struct drm_simple_display_pipe; |
| 14 | |
| 15 | /** |
| 16 | * struct drm_simple_display_pipe_funcs - helper operations for a simple |
| 17 | * display pipeline |
| 18 | */ |
| 19 | struct drm_simple_display_pipe_funcs { |
| 20 | /** |
| 21 | * @enable: |
| 22 | * |
| 23 | * This function should be used to enable the pipeline. |
| 24 | * It is called when the underlying crtc is enabled. |
| 25 | * This hook is optional. |
| 26 | */ |
| 27 | void (*enable)(struct drm_simple_display_pipe *pipe, |
| 28 | struct drm_crtc_state *crtc_state); |
| 29 | /** |
| 30 | * @disable: |
| 31 | * |
| 32 | * This function should be used to disable the pipeline. |
| 33 | * It is called when the underlying crtc is disabled. |
| 34 | * This hook is optional. |
| 35 | */ |
| 36 | void (*disable)(struct drm_simple_display_pipe *pipe); |
| 37 | |
| 38 | /** |
| 39 | * @check: |
| 40 | * |
| 41 | * This function is called in the check phase of an atomic update, |
| 42 | * specifically when the underlying plane is checked. |
| 43 | * The simple display pipeline helpers already check that the plane is |
| 44 | * not scaled, fills the entire visible area and is always enabled |
| 45 | * when the crtc is also enabled. |
| 46 | * This hook is optional. |
| 47 | * |
| 48 | * RETURNS: |
| 49 | * |
| 50 | * 0 on success, -EINVAL if the state or the transition can't be |
| 51 | * supported, -ENOMEM on memory allocation failure and -EDEADLK if an |
| 52 | * attempt to obtain another state object ran into a &drm_modeset_lock |
| 53 | * deadlock. |
| 54 | */ |
| 55 | int (*check)(struct drm_simple_display_pipe *pipe, |
| 56 | struct drm_plane_state *plane_state, |
| 57 | struct drm_crtc_state *crtc_state); |
| 58 | /** |
| 59 | * @update: |
| 60 | * |
| 61 | * This function is called when the underlying plane state is updated. |
| 62 | * This hook is optional. |
| 63 | */ |
| 64 | void (*update)(struct drm_simple_display_pipe *pipe, |
| 65 | struct drm_plane_state *plane_state); |
| 66 | }; |
| 67 | |
| 68 | /** |
| 69 | * struct drm_simple_display_pipe - simple display pipeline |
| 70 | * @crtc: CRTC control structure |
| 71 | * @plane: Plane control structure |
| 72 | * @encoder: Encoder control structure |
| 73 | * @connector: Connector control structure |
| 74 | * @funcs: Pipeline control functions (optional) |
| 75 | * |
| 76 | * Simple display pipeline with plane, crtc and encoder collapsed into one |
| 77 | * entity. It should be initialized by calling drm_simple_display_pipe_init(). |
| 78 | */ |
| 79 | struct drm_simple_display_pipe { |
| 80 | struct drm_crtc crtc; |
| 81 | struct drm_plane plane; |
| 82 | struct drm_encoder encoder; |
| 83 | struct drm_connector *connector; |
| 84 | |
| 85 | const struct drm_simple_display_pipe_funcs *funcs; |
| 86 | }; |
| 87 | |
| 88 | int drm_simple_display_pipe_init(struct drm_device *dev, |
| 89 | struct drm_simple_display_pipe *pipe, |
| 90 | const struct drm_simple_display_pipe_funcs *funcs, |
| 91 | const uint32_t *formats, unsigned int format_count, |
| 92 | struct drm_connector *connector); |
| 93 | |
| 94 | #endif /* __LINUX_DRM_SIMPLE_KMS_HELPER_H */ |