1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Copyright (C) 2017 Icenowy Zheng <icenowy@aosc.io> 4 */ 5 6 #ifndef _SUNXI_ENGINE_H_ 7 #define _SUNXI_ENGINE_H_ 8 9 struct drm_plane; 10 struct drm_crtc; 11 struct drm_device; 12 struct drm_crtc_state; 13 struct drm_display_mode; 14 15 struct sunxi_engine; 16 17 /** 18 * struct sunxi_engine_ops - helper operations for sunXi engines 19 * 20 * These hooks are used by the common part of the DRM driver to 21 * implement the proper behaviour. 22 */ 23 struct sunxi_engine_ops { 24 /** 25 * @atomic_begin: 26 * 27 * This callback allows to prepare our engine for an atomic 28 * update. This is mirroring the 29 * &drm_crtc_helper_funcs.atomic_begin callback, so any 30 * documentation there applies. 31 * 32 * This function is optional. 33 */ 34 void (*atomic_begin)(struct sunxi_engine *engine, 35 struct drm_crtc_state *old_state); 36 37 /** 38 * @atomic_check: 39 * 40 * This callback allows to validate plane-update related CRTC 41 * constraints specific to engines. This is mirroring the 42 * &drm_crtc_helper_funcs.atomic_check callback, so any 43 * documentation there applies. 44 * 45 * This function is optional. 46 * 47 * RETURNS: 48 * 49 * 0 on success or a negative error code. 50 */ 51 int (*atomic_check)(struct sunxi_engine *engine, 52 struct drm_crtc_state *state); 53 54 /** 55 * @commit: 56 * 57 * This callback will trigger the hardware switch to commit 58 * the new configuration that has been setup during the next 59 * vblank period. 60 * 61 * This function is optional. 62 */ 63 void (*commit)(struct sunxi_engine *engine, 64 struct drm_crtc *crtc, 65 struct drm_atomic_state *state); 66 67 /** 68 * @layers_init: 69 * 70 * This callback is used to allocate, initialize and register 71 * the layers supported by that engine. 72 * 73 * This function is mandatory. 74 * 75 * RETURNS: 76 * 77 * The array of struct drm_plane backing the layers, or an 78 * error pointer on failure. 79 */ 80 struct drm_plane **(*layers_init)(struct drm_device *drm, 81 struct sunxi_engine *engine); 82 83 /** 84 * @apply_color_correction: 85 * 86 * This callback will enable the color correction in the 87 * engine. This is useful only for the composite output. 88 * 89 * This function is optional. 90 */ 91 void (*apply_color_correction)(struct sunxi_engine *engine); 92 93 /** 94 * @disable_color_correction: 95 * 96 * This callback will stop the color correction in the 97 * engine. This is useful only for the composite output. 98 * 99 * This function is optional. 100 */ 101 void (*disable_color_correction)(struct sunxi_engine *engine); 102 103 /** 104 * @vblank_quirk: 105 * 106 * This callback is used to implement engine-specific 107 * behaviour part of the VBLANK event. It is run with all the 108 * constraints of an interrupt (can't sleep, all local 109 * interrupts disabled) and therefore should be as fast as 110 * possible. 111 * 112 * This function is optional. 113 */ 114 void (*vblank_quirk)(struct sunxi_engine *engine); 115 116 /** 117 * @mode_set: 118 * 119 * This callback is used to set mode related parameters 120 * like interlacing, screen size, etc. once per mode set. 121 * 122 * This function is optional. 123 */ 124 void (*mode_set)(struct sunxi_engine *engine, 125 const struct drm_display_mode *mode); 126 }; 127 128 /** 129 * struct sunxi_engine - the common parts of an engine for sun4i-drm driver 130 * @ops: the operations of the engine 131 * @node: the of device node of the engine 132 * @regs: the regmap of the engine 133 * @id: the id of the engine (-1 if not used) 134 * @list: engine list management 135 */ 136 struct sunxi_engine { 137 const struct sunxi_engine_ops *ops; 138 139 struct device_node *node; 140 struct regmap *regs; 141 142 int id; 143 144 struct list_head list; 145 }; 146 147 /** 148 * sunxi_engine_commit() - commit all changes of the engine 149 * @engine: pointer to the engine 150 * @crtc: pointer to crtc the engine is associated with 151 * @state: atomic state 152 */ 153 static inline void 154 sunxi_engine_commit(struct sunxi_engine *engine, 155 struct drm_crtc *crtc, 156 struct drm_atomic_state *state) 157 { 158 if (engine->ops && engine->ops->commit) 159 engine->ops->commit(engine, crtc, state); 160 } 161 162 /** 163 * sunxi_engine_layers_init() - Create planes (layers) for the engine 164 * @drm: pointer to the drm_device for which planes will be created 165 * @engine: pointer to the engine 166 * 167 * Returns: The array of struct drm_plane backing the layers, or an 168 * error pointer on failure. 169 */ 170 static inline struct drm_plane ** 171 sunxi_engine_layers_init(struct drm_device *drm, struct sunxi_engine *engine) 172 { 173 if (engine->ops && engine->ops->layers_init) 174 return engine->ops->layers_init(drm, engine); 175 return ERR_PTR(-ENOSYS); 176 } 177 178 /** 179 * sunxi_engine_apply_color_correction - Apply the RGB2YUV color correction 180 * @engine: pointer to the engine 181 * 182 * This functionality is optional for an engine, however, if the engine is 183 * intended to be used with TV Encoder, the output will be incorrect 184 * without the color correction, due to TV Encoder expects the engine to 185 * output directly YUV signal. 186 */ 187 static inline void 188 sunxi_engine_apply_color_correction(struct sunxi_engine *engine) 189 { 190 if (engine->ops && engine->ops->apply_color_correction) 191 engine->ops->apply_color_correction(engine); 192 } 193 194 /** 195 * sunxi_engine_disable_color_correction - Disable the color space correction 196 * @engine: pointer to the engine 197 * 198 * This function is paired with apply_color_correction(). 199 */ 200 static inline void 201 sunxi_engine_disable_color_correction(struct sunxi_engine *engine) 202 { 203 if (engine->ops && engine->ops->disable_color_correction) 204 engine->ops->disable_color_correction(engine); 205 } 206 207 /** 208 * sunxi_engine_mode_set - Inform engine of a new mode 209 * @engine: pointer to the engine 210 * @mode: new mode 211 * 212 * Engine can use this functionality to set specifics once per mode change. 213 */ 214 static inline void 215 sunxi_engine_mode_set(struct sunxi_engine *engine, 216 const struct drm_display_mode *mode) 217 { 218 if (engine->ops && engine->ops->mode_set) 219 engine->ops->mode_set(engine, mode); 220 } 221 #endif /* _SUNXI_ENGINE_H_ */ 222