1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2015-2018 The Linux Foundation. All rights reserved. 4 */ 5 6 #ifndef __DPU_ENCODER_PHYS_H__ 7 #define __DPU_ENCODER_PHYS_H__ 8 9 #include <linux/jiffies.h> 10 11 #include "dpu_kms.h" 12 #include "dpu_hw_intf.h" 13 #include "dpu_hw_pingpong.h" 14 #include "dpu_hw_ctl.h" 15 #include "dpu_hw_top.h" 16 #include "dpu_encoder.h" 17 #include "dpu_crtc.h" 18 19 #define DPU_ENCODER_NAME_MAX 16 20 21 /* wait for at most 2 vsync for lowest refresh rate (24hz) */ 22 #define KICKOFF_TIMEOUT_MS 84 23 #define KICKOFF_TIMEOUT_JIFFIES msecs_to_jiffies(KICKOFF_TIMEOUT_MS) 24 25 /** 26 * enum dpu_enc_split_role - Role this physical encoder will play in a 27 * split-panel configuration, where one panel is master, and others slaves. 28 * Masters have extra responsibilities, like managing the VBLANK IRQ. 29 * @ENC_ROLE_SOLO: This is the one and only panel. This encoder is master. 30 * @ENC_ROLE_MASTER: This encoder is the master of a split panel config. 31 * @ENC_ROLE_SLAVE: This encoder is not the master of a split panel config. 32 */ 33 enum dpu_enc_split_role { 34 ENC_ROLE_SOLO, 35 ENC_ROLE_MASTER, 36 ENC_ROLE_SLAVE, 37 }; 38 39 /** 40 * enum dpu_enc_enable_state - current enabled state of the physical encoder 41 * @DPU_ENC_DISABLING: Encoder transitioning to disable state 42 * Events bounding transition are encoder type specific 43 * @DPU_ENC_DISABLED: Encoder is disabled 44 * @DPU_ENC_ENABLING: Encoder transitioning to enabled 45 * Events bounding transition are encoder type specific 46 * @DPU_ENC_ENABLED: Encoder is enabled 47 * @DPU_ENC_ERR_NEEDS_HW_RESET: Encoder is enabled, but requires a hw_reset 48 * to recover from a previous error 49 */ 50 enum dpu_enc_enable_state { 51 DPU_ENC_DISABLING, 52 DPU_ENC_DISABLED, 53 DPU_ENC_ENABLING, 54 DPU_ENC_ENABLED, 55 DPU_ENC_ERR_NEEDS_HW_RESET 56 }; 57 58 struct dpu_encoder_phys; 59 60 /** 61 * struct dpu_encoder_virt_ops - Interface the containing virtual encoder 62 * provides for the physical encoders to use to callback. 63 * @handle_vblank_virt: Notify virtual encoder of vblank IRQ reception 64 * Note: This is called from IRQ handler context. 65 * @handle_underrun_virt: Notify virtual encoder of underrun IRQ reception 66 * Note: This is called from IRQ handler context. 67 * @handle_frame_done: Notify virtual encoder that this phys encoder 68 * completes last request frame. 69 */ 70 struct dpu_encoder_virt_ops { 71 void (*handle_vblank_virt)(struct drm_encoder *, 72 struct dpu_encoder_phys *phys); 73 void (*handle_underrun_virt)(struct drm_encoder *, 74 struct dpu_encoder_phys *phys); 75 void (*handle_frame_done)(struct drm_encoder *, 76 struct dpu_encoder_phys *phys, u32 event); 77 }; 78 79 /** 80 * struct dpu_encoder_phys_ops - Interface the physical encoders provide to 81 * the containing virtual encoder. 82 * @late_register: DRM Call. Add Userspace interfaces, debugfs. 83 * @prepare_commit: MSM Atomic Call, start of atomic commit sequence 84 * @is_master: Whether this phys_enc is the current master 85 * encoder. Can be switched at enable time. Based 86 * on split_role and current mode (CMD/VID). 87 * @mode_fixup: DRM Call. Fixup a DRM mode. 88 * @mode_set: DRM Call. Set a DRM mode. 89 * This likely caches the mode, for use at enable. 90 * @enable: DRM Call. Enable a DRM mode. 91 * @disable: DRM Call. Disable mode. 92 * @atomic_check: DRM Call. Atomic check new DRM state. 93 * @destroy: DRM Call. Destroy and release resources. 94 * @get_hw_resources: Populate the structure with the hardware 95 * resources that this phys_enc is using. 96 * Expect no overlap between phys_encs. 97 * @control_vblank_irq Register/Deregister for VBLANK IRQ 98 * @wait_for_commit_done: Wait for hardware to have flushed the 99 * current pending frames to hardware 100 * @wait_for_tx_complete: Wait for hardware to transfer the pixels 101 * to the panel 102 * @wait_for_vblank: Wait for VBLANK, for sub-driver internal use 103 * @prepare_for_kickoff: Do any work necessary prior to a kickoff 104 * For CMD encoder, may wait for previous tx done 105 * @handle_post_kickoff: Do any work necessary post-kickoff work 106 * @trigger_start: Process start event on physical encoder 107 * @needs_single_flush: Whether encoder slaves need to be flushed 108 * @irq_control: Handler to enable/disable all the encoder IRQs 109 * @prepare_idle_pc: phys encoder can update the vsync_enable status 110 * on idle power collapse prepare 111 * @restore: Restore all the encoder configs. 112 * @get_line_count: Obtain current vertical line count 113 */ 114 115 struct dpu_encoder_phys_ops { 116 int (*late_register)(struct dpu_encoder_phys *encoder, 117 struct dentry *debugfs_root); 118 void (*prepare_commit)(struct dpu_encoder_phys *encoder); 119 bool (*is_master)(struct dpu_encoder_phys *encoder); 120 bool (*mode_fixup)(struct dpu_encoder_phys *encoder, 121 const struct drm_display_mode *mode, 122 struct drm_display_mode *adjusted_mode); 123 void (*mode_set)(struct dpu_encoder_phys *encoder, 124 struct drm_display_mode *mode, 125 struct drm_display_mode *adjusted_mode); 126 void (*enable)(struct dpu_encoder_phys *encoder); 127 void (*disable)(struct dpu_encoder_phys *encoder); 128 int (*atomic_check)(struct dpu_encoder_phys *encoder, 129 struct drm_crtc_state *crtc_state, 130 struct drm_connector_state *conn_state); 131 void (*destroy)(struct dpu_encoder_phys *encoder); 132 void (*get_hw_resources)(struct dpu_encoder_phys *encoder, 133 struct dpu_encoder_hw_resources *hw_res); 134 int (*control_vblank_irq)(struct dpu_encoder_phys *enc, bool enable); 135 int (*wait_for_commit_done)(struct dpu_encoder_phys *phys_enc); 136 int (*wait_for_tx_complete)(struct dpu_encoder_phys *phys_enc); 137 int (*wait_for_vblank)(struct dpu_encoder_phys *phys_enc); 138 void (*prepare_for_kickoff)(struct dpu_encoder_phys *phys_enc); 139 void (*handle_post_kickoff)(struct dpu_encoder_phys *phys_enc); 140 void (*trigger_start)(struct dpu_encoder_phys *phys_enc); 141 bool (*needs_single_flush)(struct dpu_encoder_phys *phys_enc); 142 void (*irq_control)(struct dpu_encoder_phys *phys, bool enable); 143 void (*prepare_idle_pc)(struct dpu_encoder_phys *phys_enc); 144 void (*restore)(struct dpu_encoder_phys *phys); 145 int (*get_line_count)(struct dpu_encoder_phys *phys); 146 int (*get_frame_count)(struct dpu_encoder_phys *phys); 147 }; 148 149 /** 150 * enum dpu_intr_idx - dpu encoder interrupt index 151 * @INTR_IDX_VSYNC: Vsync interrupt for video mode panel 152 * @INTR_IDX_PINGPONG: Pingpong done unterrupt for cmd mode panel 153 * @INTR_IDX_UNDERRUN: Underrun unterrupt for video and cmd mode panel 154 * @INTR_IDX_RDPTR: Readpointer done unterrupt for cmd mode panel 155 */ 156 enum dpu_intr_idx { 157 INTR_IDX_VSYNC, 158 INTR_IDX_PINGPONG, 159 INTR_IDX_UNDERRUN, 160 INTR_IDX_CTL_START, 161 INTR_IDX_RDPTR, 162 INTR_IDX_MAX, 163 }; 164 165 /** 166 * dpu_encoder_irq - tracking structure for interrupts 167 * @name: string name of interrupt 168 * @intr_idx: Encoder interrupt enumeration 169 * @irq_idx: IRQ interface lookup index from DPU IRQ framework 170 * will be -EINVAL if IRQ is not registered 171 * @irq_cb: interrupt callback 172 */ 173 struct dpu_encoder_irq { 174 const char *name; 175 enum dpu_intr_idx intr_idx; 176 int irq_idx; 177 struct dpu_irq_callback cb; 178 }; 179 180 /** 181 * struct dpu_encoder_phys - physical encoder that drives a single INTF block 182 * tied to a specific panel / sub-panel. Abstract type, sub-classed by 183 * phys_vid or phys_cmd for video mode or command mode encs respectively. 184 * @parent: Pointer to the containing virtual encoder 185 * @connector: If a mode is set, cached pointer to the active connector 186 * @ops: Operations exposed to the virtual encoder 187 * @parent_ops: Callbacks exposed by the parent to the phys_enc 188 * @hw_mdptop: Hardware interface to the top registers 189 * @hw_ctl: Hardware interface to the ctl registers 190 * @hw_pp: Hardware interface to the ping pong registers 191 * @hw_intf: Hardware interface to the intf registers 192 * @dpu_kms: Pointer to the dpu_kms top level 193 * @cached_mode: DRM mode cached at mode_set time, acted on in enable 194 * @enabled: Whether the encoder has enabled and running a mode 195 * @split_role: Role to play in a split-panel configuration 196 * @intf_mode: Interface mode 197 * @intf_idx: Interface index on dpu hardware 198 * @enc_spinlock: Virtual-Encoder-Wide Spin Lock for IRQ purposes 199 * @enable_state: Enable state tracking 200 * @vblank_refcount: Reference count of vblank request 201 * @vsync_cnt: Vsync count for the physical encoder 202 * @underrun_cnt: Underrun count for the physical encoder 203 * @pending_kickoff_cnt: Atomic counter tracking the number of kickoffs 204 * vs. the number of done/vblank irqs. Should hover 205 * between 0-2 Incremented when a new kickoff is 206 * scheduled. Decremented in irq handler 207 * @pending_ctlstart_cnt: Atomic counter tracking the number of ctl start 208 * pending. 209 * @pending_kickoff_wq: Wait queue for blocking until kickoff completes 210 * @irq: IRQ tracking structures 211 */ 212 struct dpu_encoder_phys { 213 struct drm_encoder *parent; 214 struct drm_connector *connector; 215 struct dpu_encoder_phys_ops ops; 216 const struct dpu_encoder_virt_ops *parent_ops; 217 struct dpu_hw_mdp *hw_mdptop; 218 struct dpu_hw_ctl *hw_ctl; 219 struct dpu_hw_pingpong *hw_pp; 220 struct dpu_hw_intf *hw_intf; 221 struct dpu_kms *dpu_kms; 222 struct drm_display_mode cached_mode; 223 enum dpu_enc_split_role split_role; 224 enum dpu_intf_mode intf_mode; 225 enum dpu_intf intf_idx; 226 spinlock_t *enc_spinlock; 227 enum dpu_enc_enable_state enable_state; 228 atomic_t vblank_refcount; 229 atomic_t vsync_cnt; 230 atomic_t underrun_cnt; 231 atomic_t pending_ctlstart_cnt; 232 atomic_t pending_kickoff_cnt; 233 wait_queue_head_t pending_kickoff_wq; 234 struct dpu_encoder_irq irq[INTR_IDX_MAX]; 235 }; 236 237 static inline int dpu_encoder_phys_inc_pending(struct dpu_encoder_phys *phys) 238 { 239 atomic_inc_return(&phys->pending_ctlstart_cnt); 240 return atomic_inc_return(&phys->pending_kickoff_cnt); 241 } 242 243 /** 244 * struct dpu_encoder_phys_cmd - sub-class of dpu_encoder_phys to handle command 245 * mode specific operations 246 * @base: Baseclass physical encoder structure 247 * @intf_idx: Intf Block index used by this phys encoder 248 * @stream_sel: Stream selection for multi-stream interfaces 249 * @serialize_wait4pp: serialize wait4pp feature waits for pp_done interrupt 250 * after ctl_start instead of before next frame kickoff 251 * @pp_timeout_report_cnt: number of pingpong done irq timeout errors 252 * @pending_vblank_cnt: Atomic counter tracking pending wait for VBLANK 253 * @pending_vblank_wq: Wait queue for blocking until VBLANK received 254 */ 255 struct dpu_encoder_phys_cmd { 256 struct dpu_encoder_phys base; 257 int stream_sel; 258 bool serialize_wait4pp; 259 int pp_timeout_report_cnt; 260 atomic_t pending_vblank_cnt; 261 wait_queue_head_t pending_vblank_wq; 262 }; 263 264 /** 265 * struct dpu_enc_phys_init_params - initialization parameters for phys encs 266 * @dpu_kms: Pointer to the dpu_kms top level 267 * @parent: Pointer to the containing virtual encoder 268 * @parent_ops: Callbacks exposed by the parent to the phys_enc 269 * @split_role: Role to play in a split-panel configuration 270 * @intf_idx: Interface index this phys_enc will control 271 * @enc_spinlock: Virtual-Encoder-Wide Spin Lock for IRQ purposes 272 */ 273 struct dpu_enc_phys_init_params { 274 struct dpu_kms *dpu_kms; 275 struct drm_encoder *parent; 276 const struct dpu_encoder_virt_ops *parent_ops; 277 enum dpu_enc_split_role split_role; 278 enum dpu_intf intf_idx; 279 spinlock_t *enc_spinlock; 280 }; 281 282 /** 283 * dpu_encoder_wait_info - container for passing arguments to irq wait functions 284 * @wq: wait queue structure 285 * @atomic_cnt: wait until atomic_cnt equals zero 286 * @timeout_ms: timeout value in milliseconds 287 */ 288 struct dpu_encoder_wait_info { 289 wait_queue_head_t *wq; 290 atomic_t *atomic_cnt; 291 s64 timeout_ms; 292 }; 293 294 /** 295 * dpu_encoder_phys_vid_init - Construct a new video mode physical encoder 296 * @p: Pointer to init params structure 297 * Return: Error code or newly allocated encoder 298 */ 299 struct dpu_encoder_phys *dpu_encoder_phys_vid_init( 300 struct dpu_enc_phys_init_params *p); 301 302 /** 303 * dpu_encoder_phys_cmd_init - Construct a new command mode physical encoder 304 * @p: Pointer to init params structure 305 * Return: Error code or newly allocated encoder 306 */ 307 struct dpu_encoder_phys *dpu_encoder_phys_cmd_init( 308 struct dpu_enc_phys_init_params *p); 309 310 /** 311 * dpu_encoder_helper_trigger_start - control start helper function 312 * This helper function may be optionally specified by physical 313 * encoders if they require ctl_start triggering. 314 * @phys_enc: Pointer to physical encoder structure 315 */ 316 void dpu_encoder_helper_trigger_start(struct dpu_encoder_phys *phys_enc); 317 318 static inline enum dpu_3d_blend_mode dpu_encoder_helper_get_3d_blend_mode( 319 struct dpu_encoder_phys *phys_enc) 320 { 321 struct dpu_crtc_state *dpu_cstate; 322 323 if (!phys_enc || phys_enc->enable_state == DPU_ENC_DISABLING) 324 return BLEND_3D_NONE; 325 326 dpu_cstate = to_dpu_crtc_state(phys_enc->parent->crtc->state); 327 328 if (phys_enc->split_role == ENC_ROLE_SOLO && 329 dpu_cstate->num_mixers == CRTC_DUAL_MIXERS) 330 return BLEND_3D_H_ROW_INT; 331 332 return BLEND_3D_NONE; 333 } 334 335 /** 336 * dpu_encoder_helper_split_config - split display configuration helper function 337 * This helper function may be used by physical encoders to configure 338 * the split display related registers. 339 * @phys_enc: Pointer to physical encoder structure 340 * @interface: enum dpu_intf setting 341 */ 342 void dpu_encoder_helper_split_config( 343 struct dpu_encoder_phys *phys_enc, 344 enum dpu_intf interface); 345 346 /** 347 * dpu_encoder_helper_report_irq_timeout - utility to report error that irq has 348 * timed out, including reporting frame error event to crtc and debug dump 349 * @phys_enc: Pointer to physical encoder structure 350 * @intr_idx: Failing interrupt index 351 */ 352 void dpu_encoder_helper_report_irq_timeout(struct dpu_encoder_phys *phys_enc, 353 enum dpu_intr_idx intr_idx); 354 355 /** 356 * dpu_encoder_helper_wait_for_irq - utility to wait on an irq. 357 * note: will call dpu_encoder_helper_wait_for_irq on timeout 358 * @phys_enc: Pointer to physical encoder structure 359 * @intr_idx: encoder interrupt index 360 * @wait_info: wait info struct 361 * @Return: 0 or -ERROR 362 */ 363 int dpu_encoder_helper_wait_for_irq(struct dpu_encoder_phys *phys_enc, 364 enum dpu_intr_idx intr_idx, 365 struct dpu_encoder_wait_info *wait_info); 366 367 /** 368 * dpu_encoder_helper_register_irq - register and enable an irq 369 * @phys_enc: Pointer to physical encoder structure 370 * @intr_idx: encoder interrupt index 371 * @Return: 0 or -ERROR 372 */ 373 int dpu_encoder_helper_register_irq(struct dpu_encoder_phys *phys_enc, 374 enum dpu_intr_idx intr_idx); 375 376 /** 377 * dpu_encoder_helper_unregister_irq - unregister and disable an irq 378 * @phys_enc: Pointer to physical encoder structure 379 * @intr_idx: encoder interrupt index 380 * @Return: 0 or -ERROR 381 */ 382 int dpu_encoder_helper_unregister_irq(struct dpu_encoder_phys *phys_enc, 383 enum dpu_intr_idx intr_idx); 384 385 #endif /* __dpu_encoder_phys_H__ */ 386