1 /* 2 * Copyright (c) 2015-2018 The Linux Foundation. All rights reserved. 3 * Copyright (C) 2013 Red Hat 4 * Author: Rob Clark <robdclark@gmail.com> 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License version 2 as published by 8 * the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 13 * more details. 14 * 15 * You should have received a copy of the GNU General Public License along with 16 * this program. If not, see <http://www.gnu.org/licenses/>. 17 */ 18 19 #ifndef _DPU_CRTC_H_ 20 #define _DPU_CRTC_H_ 21 22 #include <linux/kthread.h> 23 #include <drm/drm_crtc.h> 24 #include "dpu_kms.h" 25 #include "dpu_core_perf.h" 26 #include "dpu_hw_blk.h" 27 28 #define DPU_CRTC_NAME_SIZE 12 29 30 /* define the maximum number of in-flight frame events */ 31 #define DPU_CRTC_FRAME_EVENT_SIZE 4 32 33 /** 34 * enum dpu_crtc_client_type: crtc client type 35 * @RT_CLIENT: RealTime client like video/cmd mode display 36 * voting through apps rsc 37 * @NRT_CLIENT: Non-RealTime client like WB display 38 * voting through apps rsc 39 */ 40 enum dpu_crtc_client_type { 41 RT_CLIENT, 42 NRT_CLIENT, 43 }; 44 45 /** 46 * enum dpu_crtc_smmu_state: smmu state 47 * @ATTACHED: all the context banks are attached. 48 * @DETACHED: all the context banks are detached. 49 * @ATTACH_ALL_REQ: transient state of attaching context banks. 50 * @DETACH_ALL_REQ: transient state of detaching context banks. 51 */ 52 enum dpu_crtc_smmu_state { 53 ATTACHED = 0, 54 DETACHED, 55 ATTACH_ALL_REQ, 56 DETACH_ALL_REQ, 57 }; 58 59 /** 60 * enum dpu_crtc_smmu_state_transition_type: state transition type 61 * @NONE: no pending state transitions 62 * @PRE_COMMIT: state transitions should be done before processing the commit 63 * @POST_COMMIT: state transitions to be done after processing the commit. 64 */ 65 enum dpu_crtc_smmu_state_transition_type { 66 NONE, 67 PRE_COMMIT, 68 POST_COMMIT 69 }; 70 71 /** 72 * struct dpu_crtc_smmu_state_data: stores the smmu state and transition type 73 * @state: current state of smmu context banks 74 * @transition_type: transition request type 75 * @transition_error: whether there is error while transitioning the state 76 */ 77 struct dpu_crtc_smmu_state_data { 78 uint32_t state; 79 uint32_t transition_type; 80 uint32_t transition_error; 81 }; 82 83 /** 84 * struct dpu_crtc_mixer: stores the map for each virtual pipeline in the CRTC 85 * @hw_lm: LM HW Driver context 86 * @lm_ctl: CTL Path HW driver context 87 * @mixer_op_mode: mixer blending operation mode 88 * @flush_mask: mixer flush mask for ctl, mixer and pipe 89 */ 90 struct dpu_crtc_mixer { 91 struct dpu_hw_mixer *hw_lm; 92 struct dpu_hw_ctl *lm_ctl; 93 u32 mixer_op_mode; 94 u32 flush_mask; 95 }; 96 97 /** 98 * struct dpu_crtc_frame_event: stores crtc frame event for crtc processing 99 * @work: base work structure 100 * @crtc: Pointer to crtc handling this event 101 * @list: event list 102 * @ts: timestamp at queue entry 103 * @event: event identifier 104 */ 105 struct dpu_crtc_frame_event { 106 struct kthread_work work; 107 struct drm_crtc *crtc; 108 struct list_head list; 109 ktime_t ts; 110 u32 event; 111 }; 112 113 /* 114 * Maximum number of free event structures to cache 115 */ 116 #define DPU_CRTC_MAX_EVENT_COUNT 16 117 118 /** 119 * struct dpu_crtc - virtualized CRTC data structure 120 * @base : Base drm crtc structure 121 * @name : ASCII description of this crtc 122 * @event : Pointer to last received drm vblank event. If there is a 123 * pending vblank event, this will be non-null. 124 * @vsync_count : Running count of received vsync events 125 * @drm_requested_vblank : Whether vblanks have been enabled in the encoder 126 * @property_info : Opaque structure for generic property support 127 * @property_defaults : Array of default values for generic property support 128 * @stage_cfg : H/w mixer stage configuration 129 * @debugfs_root : Parent of debugfs node 130 * @vblank_cb_count : count of vblank callback since last reset 131 * @play_count : frame count between crtc enable and disable 132 * @vblank_cb_time : ktime at vblank count reset 133 * @enabled : whether the DPU CRTC is currently enabled. updated in the 134 * commit-thread, not state-swap time which is earlier, so 135 * safe to make decisions on during VBLANK on/off work 136 * @feature_list : list of color processing features supported on a crtc 137 * @active_list : list of color processing features are active 138 * @dirty_list : list of color processing features are dirty 139 * @ad_dirty: list containing ad properties that are dirty 140 * @ad_active: list containing ad properties that are active 141 * @frame_pending : Whether or not an update is pending 142 * @frame_events : static allocation of in-flight frame events 143 * @frame_event_list : available frame event list 144 * @spin_lock : spin lock for frame event, transaction status, etc... 145 * @frame_done_comp : for frame_event_done synchronization 146 * @event_thread : Pointer to event handler thread 147 * @event_worker : Event worker queue 148 * @event_lock : Spinlock around event handling code 149 * @phandle: Pointer to power handler 150 * @cur_perf : current performance committed to clock/bandwidth driver 151 */ 152 struct dpu_crtc { 153 struct drm_crtc base; 154 char name[DPU_CRTC_NAME_SIZE]; 155 156 struct drm_pending_vblank_event *event; 157 u32 vsync_count; 158 159 struct dpu_hw_stage_cfg stage_cfg; 160 struct dentry *debugfs_root; 161 162 u32 vblank_cb_count; 163 u64 play_count; 164 ktime_t vblank_cb_time; 165 bool enabled; 166 167 struct list_head feature_list; 168 struct list_head active_list; 169 struct list_head dirty_list; 170 struct list_head ad_dirty; 171 struct list_head ad_active; 172 173 atomic_t frame_pending; 174 struct dpu_crtc_frame_event frame_events[DPU_CRTC_FRAME_EVENT_SIZE]; 175 struct list_head frame_event_list; 176 spinlock_t spin_lock; 177 struct completion frame_done_comp; 178 179 /* for handling internal event thread */ 180 spinlock_t event_lock; 181 182 struct dpu_core_perf_params cur_perf; 183 184 struct dpu_crtc_smmu_state_data smmu_state; 185 }; 186 187 #define to_dpu_crtc(x) container_of(x, struct dpu_crtc, base) 188 189 /** 190 * struct dpu_crtc_state - dpu container for atomic crtc state 191 * @base: Base drm crtc state structure 192 * @bw_control : true if bw/clk controlled by core bw/clk properties 193 * @bw_split_vote : true if bw controlled by llcc/dram bw properties 194 * @lm_bounds : LM boundaries based on current mode full resolution, no ROI. 195 * Origin top left of CRTC. 196 * @property_state: Local storage for msm_prop properties 197 * @property_values: Current crtc property values 198 * @input_fence_timeout_ns : Cached input fence timeout, in ns 199 * @new_perf: new performance state being requested 200 * @num_mixers : Number of mixers in use 201 * @mixers : List of active mixers 202 * @num_ctls : Number of ctl paths in use 203 * @hw_ctls : List of active ctl paths 204 */ 205 struct dpu_crtc_state { 206 struct drm_crtc_state base; 207 208 bool bw_control; 209 bool bw_split_vote; 210 struct drm_rect lm_bounds[CRTC_DUAL_MIXERS]; 211 212 uint64_t input_fence_timeout_ns; 213 214 struct dpu_core_perf_params new_perf; 215 216 /* HW Resources reserved for the crtc */ 217 u32 num_mixers; 218 struct dpu_crtc_mixer mixers[CRTC_DUAL_MIXERS]; 219 220 u32 num_ctls; 221 struct dpu_hw_ctl *hw_ctls[CRTC_DUAL_MIXERS]; 222 }; 223 224 #define to_dpu_crtc_state(x) \ 225 container_of(x, struct dpu_crtc_state, base) 226 227 /** 228 * dpu_crtc_frame_pending - retun the number of pending frames 229 * @crtc: Pointer to drm crtc object 230 */ 231 static inline int dpu_crtc_frame_pending(struct drm_crtc *crtc) 232 { 233 return crtc ? atomic_read(&to_dpu_crtc(crtc)->frame_pending) : -EINVAL; 234 } 235 236 /** 237 * dpu_crtc_vblank - enable or disable vblanks for this crtc 238 * @crtc: Pointer to drm crtc object 239 * @en: true to enable vblanks, false to disable 240 */ 241 int dpu_crtc_vblank(struct drm_crtc *crtc, bool en); 242 243 /** 244 * dpu_crtc_vblank_callback - called on vblank irq, issues completion events 245 * @crtc: Pointer to drm crtc object 246 */ 247 void dpu_crtc_vblank_callback(struct drm_crtc *crtc); 248 249 /** 250 * dpu_crtc_commit_kickoff - trigger kickoff of the commit for this crtc 251 * @crtc: Pointer to drm crtc object 252 * @async: true if the commit is asynchronous, false otherwise 253 */ 254 void dpu_crtc_commit_kickoff(struct drm_crtc *crtc, bool async); 255 256 /** 257 * dpu_crtc_complete_commit - callback signalling completion of current commit 258 * @crtc: Pointer to drm crtc object 259 * @old_state: Pointer to drm crtc old state object 260 */ 261 void dpu_crtc_complete_commit(struct drm_crtc *crtc, 262 struct drm_crtc_state *old_state); 263 264 /** 265 * dpu_crtc_init - create a new crtc object 266 * @dev: dpu device 267 * @plane: base plane 268 * @cursor: cursor plane 269 * @Return: new crtc object or error 270 */ 271 struct drm_crtc *dpu_crtc_init(struct drm_device *dev, struct drm_plane *plane, 272 struct drm_plane *cursor); 273 274 /** 275 * dpu_crtc_register_custom_event - api for enabling/disabling crtc event 276 * @kms: Pointer to dpu_kms 277 * @crtc_drm: Pointer to crtc object 278 * @event: Event that client is interested 279 * @en: Flag to enable/disable the event 280 */ 281 int dpu_crtc_register_custom_event(struct dpu_kms *kms, 282 struct drm_crtc *crtc_drm, u32 event, bool en); 283 284 /** 285 * dpu_crtc_get_intf_mode - get interface mode of the given crtc 286 * @crtc: Pointert to crtc 287 */ 288 enum dpu_intf_mode dpu_crtc_get_intf_mode(struct drm_crtc *crtc); 289 290 /** 291 * dpu_crtc_get_client_type - check the crtc type- rt, nrt etc. 292 * @crtc: Pointer to crtc 293 */ 294 static inline enum dpu_crtc_client_type dpu_crtc_get_client_type( 295 struct drm_crtc *crtc) 296 { 297 return crtc && crtc->state ? RT_CLIENT : NRT_CLIENT; 298 } 299 300 #endif /* _DPU_CRTC_H_ */ 301