• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2015 Broadcom
4  */
5 #ifndef _VC4_DRV_H_
6 #define _VC4_DRV_H_
7 
8 #include <linux/delay.h>
9 #include <linux/refcount.h>
10 #include <linux/uaccess.h>
11 
12 #include <drm/drm_atomic.h>
13 #include <drm/drm_debugfs.h>
14 #include <drm/drm_device.h>
15 #include <drm/drm_encoder.h>
16 #include <drm/drm_gem_cma_helper.h>
17 #include <drm/drm_managed.h>
18 #include <drm/drm_mm.h>
19 #include <drm/drm_modeset_lock.h>
20 
21 #include "uapi/drm/vc4_drm.h"
22 
23 struct drm_device;
24 struct drm_gem_object;
25 
26 /* Don't forget to update vc4_bo.c: bo_type_names[] when adding to
27  * this.
28  */
29 enum vc4_kernel_bo_type {
30 	/* Any kernel allocation (gem_create_object hook) before it
31 	 * gets another type set.
32 	 */
33 	VC4_BO_TYPE_KERNEL,
34 	VC4_BO_TYPE_V3D,
35 	VC4_BO_TYPE_V3D_SHADER,
36 	VC4_BO_TYPE_DUMB,
37 	VC4_BO_TYPE_BIN,
38 	VC4_BO_TYPE_RCL,
39 	VC4_BO_TYPE_BCL,
40 	VC4_BO_TYPE_KERNEL_CACHE,
41 	VC4_BO_TYPE_COUNT
42 };
43 
44 /* Performance monitor object. The perform lifetime is controlled by userspace
45  * using perfmon related ioctls. A perfmon can be attached to a submit_cl
46  * request, and when this is the case, HW perf counters will be activated just
47  * before the submit_cl is submitted to the GPU and disabled when the job is
48  * done. This way, only events related to a specific job will be counted.
49  */
50 struct vc4_perfmon {
51 	/* Tracks the number of users of the perfmon, when this counter reaches
52 	 * zero the perfmon is destroyed.
53 	 */
54 	refcount_t refcnt;
55 
56 	/* Number of counters activated in this perfmon instance
57 	 * (should be less than DRM_VC4_MAX_PERF_COUNTERS).
58 	 */
59 	u8 ncounters;
60 
61 	/* Events counted by the HW perf counters. */
62 	u8 events[DRM_VC4_MAX_PERF_COUNTERS];
63 
64 	/* Storage for counter values. Counters are incremented by the HW
65 	 * perf counter values every time the perfmon is attached to a GPU job.
66 	 * This way, perfmon users don't have to retrieve the results after
67 	 * each job if they want to track events covering several submissions.
68 	 * Note that counter values can't be reset, but you can fake a reset by
69 	 * destroying the perfmon and creating a new one.
70 	 */
71 	u64 counters[];
72 };
73 
74 struct vc4_dev {
75 	struct drm_device base;
76 
77 	unsigned int irq;
78 
79 	struct vc4_hvs *hvs;
80 	struct vc4_v3d *v3d;
81 	struct vc4_dpi *dpi;
82 	struct vc4_vec *vec;
83 	struct vc4_txp *txp;
84 
85 	struct vc4_hang_state *hang_state;
86 
87 	/* The kernel-space BO cache.  Tracks buffers that have been
88 	 * unreferenced by all other users (refcounts of 0!) but not
89 	 * yet freed, so we can do cheap allocations.
90 	 */
91 	struct vc4_bo_cache {
92 		/* Array of list heads for entries in the BO cache,
93 		 * based on number of pages, so we can do O(1) lookups
94 		 * in the cache when allocating.
95 		 */
96 		struct list_head *size_list;
97 		uint32_t size_list_size;
98 
99 		/* List of all BOs in the cache, ordered by age, so we
100 		 * can do O(1) lookups when trying to free old
101 		 * buffers.
102 		 */
103 		struct list_head time_list;
104 		struct work_struct time_work;
105 		struct timer_list time_timer;
106 	} bo_cache;
107 
108 	u32 num_labels;
109 	struct vc4_label {
110 		const char *name;
111 		u32 num_allocated;
112 		u32 size_allocated;
113 	} *bo_labels;
114 
115 	/* Protects bo_cache and bo_labels. */
116 	struct mutex bo_lock;
117 
118 	/* Purgeable BO pool. All BOs in this pool can have their memory
119 	 * reclaimed if the driver is unable to allocate new BOs. We also
120 	 * keep stats related to the purge mechanism here.
121 	 */
122 	struct {
123 		struct list_head list;
124 		unsigned int num;
125 		size_t size;
126 		unsigned int purged_num;
127 		size_t purged_size;
128 		struct mutex lock;
129 	} purgeable;
130 
131 	uint64_t dma_fence_context;
132 
133 	/* Sequence number for the last job queued in bin_job_list.
134 	 * Starts at 0 (no jobs emitted).
135 	 */
136 	uint64_t emit_seqno;
137 
138 	/* Sequence number for the last completed job on the GPU.
139 	 * Starts at 0 (no jobs completed).
140 	 */
141 	uint64_t finished_seqno;
142 
143 	/* List of all struct vc4_exec_info for jobs to be executed in
144 	 * the binner.  The first job in the list is the one currently
145 	 * programmed into ct0ca for execution.
146 	 */
147 	struct list_head bin_job_list;
148 
149 	/* List of all struct vc4_exec_info for jobs that have
150 	 * completed binning and are ready for rendering.  The first
151 	 * job in the list is the one currently programmed into ct1ca
152 	 * for execution.
153 	 */
154 	struct list_head render_job_list;
155 
156 	/* List of the finished vc4_exec_infos waiting to be freed by
157 	 * job_done_work.
158 	 */
159 	struct list_head job_done_list;
160 	/* Spinlock used to synchronize the job_list and seqno
161 	 * accesses between the IRQ handler and GEM ioctls.
162 	 */
163 	spinlock_t job_lock;
164 	wait_queue_head_t job_wait_queue;
165 	struct work_struct job_done_work;
166 
167 	/* Used to track the active perfmon if any. Access to this field is
168 	 * protected by job_lock.
169 	 */
170 	struct vc4_perfmon *active_perfmon;
171 
172 	/* List of struct vc4_seqno_cb for callbacks to be made from a
173 	 * workqueue when the given seqno is passed.
174 	 */
175 	struct list_head seqno_cb_list;
176 
177 	/* The memory used for storing binner tile alloc, tile state,
178 	 * and overflow memory allocations.  This is freed when V3D
179 	 * powers down.
180 	 */
181 	struct vc4_bo *bin_bo;
182 
183 	/* Size of blocks allocated within bin_bo. */
184 	uint32_t bin_alloc_size;
185 
186 	/* Bitmask of the bin_alloc_size chunks in bin_bo that are
187 	 * used.
188 	 */
189 	uint32_t bin_alloc_used;
190 
191 	/* Bitmask of the current bin_alloc used for overflow memory. */
192 	uint32_t bin_alloc_overflow;
193 
194 	/* Incremented when an underrun error happened after an atomic commit.
195 	 * This is particularly useful to detect when a specific modeset is too
196 	 * demanding in term of memory or HVS bandwidth which is hard to guess
197 	 * at atomic check time.
198 	 */
199 	atomic_t underrun;
200 
201 	struct work_struct overflow_mem_work;
202 
203 	int power_refcount;
204 
205 	/* Set to true when the load tracker is supported. */
206 	bool load_tracker_available;
207 
208 	/* Set to true when the load tracker is active. */
209 	bool load_tracker_enabled;
210 
211 	/* Mutex controlling the power refcount. */
212 	struct mutex power_lock;
213 
214 	struct {
215 		struct timer_list timer;
216 		struct work_struct reset_work;
217 	} hangcheck;
218 
219 	struct drm_modeset_lock ctm_state_lock;
220 	struct drm_private_obj ctm_manager;
221 	struct drm_private_obj hvs_channels;
222 	struct drm_private_obj load_tracker;
223 
224 	/* List of vc4_debugfs_info_entry for adding to debugfs once
225 	 * the minor is available (after drm_dev_register()).
226 	 */
227 	struct list_head debugfs_list;
228 
229 	/* Mutex for binner bo allocation. */
230 	struct mutex bin_bo_lock;
231 	/* Reference count for our binner bo. */
232 	struct kref bin_bo_kref;
233 };
234 
235 static inline struct vc4_dev *
to_vc4_dev(struct drm_device * dev)236 to_vc4_dev(struct drm_device *dev)
237 {
238 	return container_of(dev, struct vc4_dev, base);
239 }
240 
241 struct vc4_bo {
242 	struct drm_gem_cma_object base;
243 
244 	/* seqno of the last job to render using this BO. */
245 	uint64_t seqno;
246 
247 	/* seqno of the last job to use the RCL to write to this BO.
248 	 *
249 	 * Note that this doesn't include binner overflow memory
250 	 * writes.
251 	 */
252 	uint64_t write_seqno;
253 
254 	bool t_format;
255 
256 	/* List entry for the BO's position in either
257 	 * vc4_exec_info->unref_list or vc4_dev->bo_cache.time_list
258 	 */
259 	struct list_head unref_head;
260 
261 	/* Time in jiffies when the BO was put in vc4->bo_cache. */
262 	unsigned long free_time;
263 
264 	/* List entry for the BO's position in vc4_dev->bo_cache.size_list */
265 	struct list_head size_head;
266 
267 	/* Struct for shader validation state, if created by
268 	 * DRM_IOCTL_VC4_CREATE_SHADER_BO.
269 	 */
270 	struct vc4_validated_shader_info *validated_shader;
271 
272 	/* One of enum vc4_kernel_bo_type, or VC4_BO_TYPE_COUNT + i
273 	 * for user-allocated labels.
274 	 */
275 	int label;
276 
277 	/* Count the number of active users. This is needed to determine
278 	 * whether we can move the BO to the purgeable list or not (when the BO
279 	 * is used by the GPU or the display engine we can't purge it).
280 	 */
281 	refcount_t usecnt;
282 
283 	/* Store purgeable/purged state here */
284 	u32 madv;
285 	struct mutex madv_lock;
286 };
287 
288 static inline struct vc4_bo *
to_vc4_bo(struct drm_gem_object * bo)289 to_vc4_bo(struct drm_gem_object *bo)
290 {
291 	return container_of(to_drm_gem_cma_obj(bo), struct vc4_bo, base);
292 }
293 
294 struct vc4_fence {
295 	struct dma_fence base;
296 	struct drm_device *dev;
297 	/* vc4 seqno for signaled() test */
298 	uint64_t seqno;
299 };
300 
301 static inline struct vc4_fence *
to_vc4_fence(struct dma_fence * fence)302 to_vc4_fence(struct dma_fence *fence)
303 {
304 	return container_of(fence, struct vc4_fence, base);
305 }
306 
307 struct vc4_seqno_cb {
308 	struct work_struct work;
309 	uint64_t seqno;
310 	void (*func)(struct vc4_seqno_cb *cb);
311 };
312 
313 struct vc4_v3d {
314 	struct vc4_dev *vc4;
315 	struct platform_device *pdev;
316 	void __iomem *regs;
317 	struct clk *clk;
318 	struct debugfs_regset32 regset;
319 };
320 
321 struct vc4_hvs {
322 	struct platform_device *pdev;
323 	void __iomem *regs;
324 	u32 __iomem *dlist;
325 
326 	struct clk *core_clk;
327 
328 	/* Memory manager for CRTCs to allocate space in the display
329 	 * list.  Units are dwords.
330 	 */
331 	struct drm_mm dlist_mm;
332 	/* Memory manager for the LBM memory used by HVS scaling. */
333 	struct drm_mm lbm_mm;
334 	spinlock_t mm_lock;
335 
336 	struct drm_mm_node mitchell_netravali_filter;
337 
338 	struct debugfs_regset32 regset;
339 
340 	/* HVS version 5 flag, therefore requires updated dlist structures */
341 	bool hvs5;
342 };
343 
344 struct vc4_plane {
345 	struct drm_plane base;
346 };
347 
348 static inline struct vc4_plane *
to_vc4_plane(struct drm_plane * plane)349 to_vc4_plane(struct drm_plane *plane)
350 {
351 	return container_of(plane, struct vc4_plane, base);
352 }
353 
354 enum vc4_scaling_mode {
355 	VC4_SCALING_NONE,
356 	VC4_SCALING_TPZ,
357 	VC4_SCALING_PPF,
358 };
359 
360 struct vc4_plane_state {
361 	struct drm_plane_state base;
362 	/* System memory copy of the display list for this element, computed
363 	 * at atomic_check time.
364 	 */
365 	u32 *dlist;
366 	u32 dlist_size; /* Number of dwords allocated for the display list */
367 	u32 dlist_count; /* Number of used dwords in the display list. */
368 
369 	/* Offset in the dlist to various words, for pageflip or
370 	 * cursor updates.
371 	 */
372 	u32 pos0_offset;
373 	u32 pos2_offset;
374 	u32 ptr0_offset;
375 	u32 lbm_offset;
376 
377 	/* Offset where the plane's dlist was last stored in the
378 	 * hardware at vc4_crtc_atomic_flush() time.
379 	 */
380 	u32 __iomem *hw_dlist;
381 
382 	/* Clipped coordinates of the plane on the display. */
383 	int crtc_x, crtc_y, crtc_w, crtc_h;
384 	/* Clipped area being scanned from in the FB. */
385 	u32 src_x, src_y;
386 
387 	u32 src_w[2], src_h[2];
388 
389 	/* Scaling selection for the RGB/Y plane and the Cb/Cr planes. */
390 	enum vc4_scaling_mode x_scaling[2], y_scaling[2];
391 	bool is_unity;
392 	bool is_yuv;
393 
394 	/* Offset to start scanning out from the start of the plane's
395 	 * BO.
396 	 */
397 	u32 offsets[3];
398 
399 	/* Our allocation in LBM for temporary storage during scaling. */
400 	struct drm_mm_node lbm;
401 
402 	/* Set when the plane has per-pixel alpha content or does not cover
403 	 * the entire screen. This is a hint to the CRTC that it might need
404 	 * to enable background color fill.
405 	 */
406 	bool needs_bg_fill;
407 
408 	/* Mark the dlist as initialized. Useful to avoid initializing it twice
409 	 * when async update is not possible.
410 	 */
411 	bool dlist_initialized;
412 
413 	/* Load of this plane on the HVS block. The load is expressed in HVS
414 	 * cycles/sec.
415 	 */
416 	u64 hvs_load;
417 
418 	/* Memory bandwidth needed for this plane. This is expressed in
419 	 * bytes/sec.
420 	 */
421 	u64 membus_load;
422 };
423 
424 static inline struct vc4_plane_state *
to_vc4_plane_state(struct drm_plane_state * state)425 to_vc4_plane_state(struct drm_plane_state *state)
426 {
427 	return container_of(state, struct vc4_plane_state, base);
428 }
429 
430 enum vc4_encoder_type {
431 	VC4_ENCODER_TYPE_NONE,
432 	VC4_ENCODER_TYPE_HDMI0,
433 	VC4_ENCODER_TYPE_HDMI1,
434 	VC4_ENCODER_TYPE_VEC,
435 	VC4_ENCODER_TYPE_DSI0,
436 	VC4_ENCODER_TYPE_DSI1,
437 	VC4_ENCODER_TYPE_SMI,
438 	VC4_ENCODER_TYPE_DPI,
439 };
440 
441 struct vc4_encoder {
442 	struct drm_encoder base;
443 	enum vc4_encoder_type type;
444 	u32 clock_select;
445 
446 	void (*pre_crtc_configure)(struct drm_encoder *encoder, struct drm_atomic_state *state);
447 	void (*pre_crtc_enable)(struct drm_encoder *encoder, struct drm_atomic_state *state);
448 	void (*post_crtc_enable)(struct drm_encoder *encoder, struct drm_atomic_state *state);
449 
450 	void (*post_crtc_disable)(struct drm_encoder *encoder, struct drm_atomic_state *state);
451 	void (*post_crtc_powerdown)(struct drm_encoder *encoder, struct drm_atomic_state *state);
452 };
453 
454 static inline struct vc4_encoder *
to_vc4_encoder(struct drm_encoder * encoder)455 to_vc4_encoder(struct drm_encoder *encoder)
456 {
457 	return container_of(encoder, struct vc4_encoder, base);
458 }
459 
460 struct vc4_crtc_data {
461 	/* Bitmask of channels (FIFOs) of the HVS that the output can source from */
462 	unsigned int hvs_available_channels;
463 
464 	/* Which output of the HVS this pixelvalve sources from. */
465 	int hvs_output;
466 };
467 
468 struct vc4_pv_data {
469 	struct vc4_crtc_data	base;
470 
471 	/* Depth of the PixelValve FIFO in bytes */
472 	unsigned int fifo_depth;
473 
474 	/* Number of pixels output per clock period */
475 	u8 pixels_per_clock;
476 
477 	enum vc4_encoder_type encoder_types[4];
478 	const char *debugfs_name;
479 
480 };
481 
482 struct vc4_crtc {
483 	struct drm_crtc base;
484 	struct platform_device *pdev;
485 	const struct vc4_crtc_data *data;
486 	void __iomem *regs;
487 
488 	/* Timestamp at start of vblank irq - unaffected by lock delays. */
489 	ktime_t t_vblank;
490 
491 	u8 lut_r[256];
492 	u8 lut_g[256];
493 	u8 lut_b[256];
494 
495 	struct drm_pending_vblank_event *event;
496 
497 	struct debugfs_regset32 regset;
498 
499 	/**
500 	 * @feeds_txp: True if the CRTC feeds our writeback controller.
501 	 */
502 	bool feeds_txp;
503 
504 	/**
505 	 * @irq_lock: Spinlock protecting the resources shared between
506 	 * the atomic code and our vblank handler.
507 	 */
508 	spinlock_t irq_lock;
509 
510 	/**
511 	 * @current_dlist: Start offset of the display list currently
512 	 * set in the HVS for that CRTC. Protected by @irq_lock, and
513 	 * copied in vc4_hvs_update_dlist() for the CRTC interrupt
514 	 * handler to have access to that value.
515 	 */
516 	unsigned int current_dlist;
517 
518 	/**
519 	 * @current_hvs_channel: HVS channel currently assigned to the
520 	 * CRTC. Protected by @irq_lock, and copied in
521 	 * vc4_hvs_atomic_begin() for the CRTC interrupt handler to have
522 	 * access to that value.
523 	 */
524 	unsigned int current_hvs_channel;
525 };
526 
527 static inline struct vc4_crtc *
to_vc4_crtc(struct drm_crtc * crtc)528 to_vc4_crtc(struct drm_crtc *crtc)
529 {
530 	return container_of(crtc, struct vc4_crtc, base);
531 }
532 
533 static inline const struct vc4_crtc_data *
vc4_crtc_to_vc4_crtc_data(const struct vc4_crtc * crtc)534 vc4_crtc_to_vc4_crtc_data(const struct vc4_crtc *crtc)
535 {
536 	return crtc->data;
537 }
538 
539 static inline const struct vc4_pv_data *
vc4_crtc_to_vc4_pv_data(const struct vc4_crtc * crtc)540 vc4_crtc_to_vc4_pv_data(const struct vc4_crtc *crtc)
541 {
542 	const struct vc4_crtc_data *data = vc4_crtc_to_vc4_crtc_data(crtc);
543 
544 	return container_of(data, struct vc4_pv_data, base);
545 }
546 
547 struct vc4_crtc_state {
548 	struct drm_crtc_state base;
549 	/* Dlist area for this CRTC configuration. */
550 	struct drm_mm_node mm;
551 	bool txp_armed;
552 	unsigned int assigned_channel;
553 
554 	struct {
555 		unsigned int left;
556 		unsigned int right;
557 		unsigned int top;
558 		unsigned int bottom;
559 	} margins;
560 
561 	/* Transitional state below, only valid during atomic commits */
562 	bool update_muxing;
563 };
564 
565 #define VC4_HVS_CHANNEL_DISABLED ((unsigned int)-1)
566 
567 static inline struct vc4_crtc_state *
to_vc4_crtc_state(struct drm_crtc_state * crtc_state)568 to_vc4_crtc_state(struct drm_crtc_state *crtc_state)
569 {
570 	return container_of(crtc_state, struct vc4_crtc_state, base);
571 }
572 
573 #define V3D_READ(offset) readl(vc4->v3d->regs + offset)
574 #define V3D_WRITE(offset, val) writel(val, vc4->v3d->regs + offset)
575 #define HVS_READ(offset) readl(vc4->hvs->regs + offset)
576 #define HVS_WRITE(offset, val) writel(val, vc4->hvs->regs + offset)
577 
578 #define VC4_REG32(reg) { .name = #reg, .offset = reg }
579 
580 struct vc4_exec_info {
581 	/* Sequence number for this bin/render job. */
582 	uint64_t seqno;
583 
584 	/* Latest write_seqno of any BO that binning depends on. */
585 	uint64_t bin_dep_seqno;
586 
587 	struct dma_fence *fence;
588 
589 	/* Last current addresses the hardware was processing when the
590 	 * hangcheck timer checked on us.
591 	 */
592 	uint32_t last_ct0ca, last_ct1ca;
593 
594 	/* Kernel-space copy of the ioctl arguments */
595 	struct drm_vc4_submit_cl *args;
596 
597 	/* This is the array of BOs that were looked up at the start of exec.
598 	 * Command validation will use indices into this array.
599 	 */
600 	struct drm_gem_cma_object **bo;
601 	uint32_t bo_count;
602 
603 	/* List of BOs that are being written by the RCL.  Other than
604 	 * the binner temporary storage, this is all the BOs written
605 	 * by the job.
606 	 */
607 	struct drm_gem_cma_object *rcl_write_bo[4];
608 	uint32_t rcl_write_bo_count;
609 
610 	/* Pointers for our position in vc4->job_list */
611 	struct list_head head;
612 
613 	/* List of other BOs used in the job that need to be released
614 	 * once the job is complete.
615 	 */
616 	struct list_head unref_list;
617 
618 	/* Current unvalidated indices into @bo loaded by the non-hardware
619 	 * VC4_PACKET_GEM_HANDLES.
620 	 */
621 	uint32_t bo_index[2];
622 
623 	/* This is the BO where we store the validated command lists, shader
624 	 * records, and uniforms.
625 	 */
626 	struct drm_gem_cma_object *exec_bo;
627 
628 	/**
629 	 * This tracks the per-shader-record state (packet 64) that
630 	 * determines the length of the shader record and the offset
631 	 * it's expected to be found at.  It gets read in from the
632 	 * command lists.
633 	 */
634 	struct vc4_shader_state {
635 		uint32_t addr;
636 		/* Maximum vertex index referenced by any primitive using this
637 		 * shader state.
638 		 */
639 		uint32_t max_index;
640 	} *shader_state;
641 
642 	/** How many shader states the user declared they were using. */
643 	uint32_t shader_state_size;
644 	/** How many shader state records the validator has seen. */
645 	uint32_t shader_state_count;
646 
647 	bool found_tile_binning_mode_config_packet;
648 	bool found_start_tile_binning_packet;
649 	bool found_increment_semaphore_packet;
650 	bool found_flush;
651 	uint8_t bin_tiles_x, bin_tiles_y;
652 	/* Physical address of the start of the tile alloc array
653 	 * (where each tile's binned CL will start)
654 	 */
655 	uint32_t tile_alloc_offset;
656 	/* Bitmask of which binner slots are freed when this job completes. */
657 	uint32_t bin_slots;
658 
659 	/**
660 	 * Computed addresses pointing into exec_bo where we start the
661 	 * bin thread (ct0) and render thread (ct1).
662 	 */
663 	uint32_t ct0ca, ct0ea;
664 	uint32_t ct1ca, ct1ea;
665 
666 	/* Pointer to the unvalidated bin CL (if present). */
667 	void *bin_u;
668 
669 	/* Pointers to the shader recs.  These paddr gets incremented as CL
670 	 * packets are relocated in validate_gl_shader_state, and the vaddrs
671 	 * (u and v) get incremented and size decremented as the shader recs
672 	 * themselves are validated.
673 	 */
674 	void *shader_rec_u;
675 	void *shader_rec_v;
676 	uint32_t shader_rec_p;
677 	uint32_t shader_rec_size;
678 
679 	/* Pointers to the uniform data.  These pointers are incremented, and
680 	 * size decremented, as each batch of uniforms is uploaded.
681 	 */
682 	void *uniforms_u;
683 	void *uniforms_v;
684 	uint32_t uniforms_p;
685 	uint32_t uniforms_size;
686 
687 	/* Pointer to a performance monitor object if the user requested it,
688 	 * NULL otherwise.
689 	 */
690 	struct vc4_perfmon *perfmon;
691 
692 	/* Whether the exec has taken a reference to the binner BO, which should
693 	 * happen with a VC4_PACKET_TILE_BINNING_MODE_CONFIG packet.
694 	 */
695 	bool bin_bo_used;
696 };
697 
698 /* Per-open file private data. Any driver-specific resource that has to be
699  * released when the DRM file is closed should be placed here.
700  */
701 struct vc4_file {
702 	struct {
703 		struct idr idr;
704 		struct mutex lock;
705 	} perfmon;
706 
707 	bool bin_bo_used;
708 };
709 
710 static inline struct vc4_exec_info *
vc4_first_bin_job(struct vc4_dev * vc4)711 vc4_first_bin_job(struct vc4_dev *vc4)
712 {
713 	return list_first_entry_or_null(&vc4->bin_job_list,
714 					struct vc4_exec_info, head);
715 }
716 
717 static inline struct vc4_exec_info *
vc4_first_render_job(struct vc4_dev * vc4)718 vc4_first_render_job(struct vc4_dev *vc4)
719 {
720 	return list_first_entry_or_null(&vc4->render_job_list,
721 					struct vc4_exec_info, head);
722 }
723 
724 static inline struct vc4_exec_info *
vc4_last_render_job(struct vc4_dev * vc4)725 vc4_last_render_job(struct vc4_dev *vc4)
726 {
727 	if (list_empty(&vc4->render_job_list))
728 		return NULL;
729 	return list_last_entry(&vc4->render_job_list,
730 			       struct vc4_exec_info, head);
731 }
732 
733 /**
734  * struct vc4_texture_sample_info - saves the offsets into the UBO for texture
735  * setup parameters.
736  *
737  * This will be used at draw time to relocate the reference to the texture
738  * contents in p0, and validate that the offset combined with
739  * width/height/stride/etc. from p1 and p2/p3 doesn't sample outside the BO.
740  * Note that the hardware treats unprovided config parameters as 0, so not all
741  * of them need to be set up for every texure sample, and we'll store ~0 as
742  * the offset to mark the unused ones.
743  *
744  * See the VC4 3D architecture guide page 41 ("Texture and Memory Lookup Unit
745  * Setup") for definitions of the texture parameters.
746  */
747 struct vc4_texture_sample_info {
748 	bool is_direct;
749 	uint32_t p_offset[4];
750 };
751 
752 /**
753  * struct vc4_validated_shader_info - information about validated shaders that
754  * needs to be used from command list validation.
755  *
756  * For a given shader, each time a shader state record references it, we need
757  * to verify that the shader doesn't read more uniforms than the shader state
758  * record's uniform BO pointer can provide, and we need to apply relocations
759  * and validate the shader state record's uniforms that define the texture
760  * samples.
761  */
762 struct vc4_validated_shader_info {
763 	uint32_t uniforms_size;
764 	uint32_t uniforms_src_size;
765 	uint32_t num_texture_samples;
766 	struct vc4_texture_sample_info *texture_samples;
767 
768 	uint32_t num_uniform_addr_offsets;
769 	uint32_t *uniform_addr_offsets;
770 
771 	bool is_threaded;
772 };
773 
774 /**
775  * __wait_for - magic wait macro
776  *
777  * Macro to help avoid open coding check/wait/timeout patterns. Note that it's
778  * important that we check the condition again after having timed out, since the
779  * timeout could be due to preemption or similar and we've never had a chance to
780  * check the condition before the timeout.
781  */
782 #define __wait_for(OP, COND, US, Wmin, Wmax) ({ \
783 	const ktime_t end__ = ktime_add_ns(ktime_get_raw(), 1000ll * (US)); \
784 	long wait__ = (Wmin); /* recommended min for usleep is 10 us */	\
785 	int ret__;							\
786 	might_sleep();							\
787 	for (;;) {							\
788 		const bool expired__ = ktime_after(ktime_get_raw(), end__); \
789 		OP;							\
790 		/* Guarantee COND check prior to timeout */		\
791 		barrier();						\
792 		if (COND) {						\
793 			ret__ = 0;					\
794 			break;						\
795 		}							\
796 		if (expired__) {					\
797 			ret__ = -ETIMEDOUT;				\
798 			break;						\
799 		}							\
800 		usleep_range(wait__, wait__ * 2);			\
801 		if (wait__ < (Wmax))					\
802 			wait__ <<= 1;					\
803 	}								\
804 	ret__;								\
805 })
806 
807 #define _wait_for(COND, US, Wmin, Wmax)	__wait_for(, (COND), (US), (Wmin), \
808 						   (Wmax))
809 #define wait_for(COND, MS)		_wait_for((COND), (MS) * 1000, 10, 1000)
810 
811 /* vc4_bo.c */
812 struct drm_gem_object *vc4_create_object(struct drm_device *dev, size_t size);
813 struct vc4_bo *vc4_bo_create(struct drm_device *dev, size_t size,
814 			     bool from_cache, enum vc4_kernel_bo_type type);
815 int vc4_dumb_create(struct drm_file *file_priv,
816 		    struct drm_device *dev,
817 		    struct drm_mode_create_dumb *args);
818 int vc4_create_bo_ioctl(struct drm_device *dev, void *data,
819 			struct drm_file *file_priv);
820 int vc4_create_shader_bo_ioctl(struct drm_device *dev, void *data,
821 			       struct drm_file *file_priv);
822 int vc4_mmap_bo_ioctl(struct drm_device *dev, void *data,
823 		      struct drm_file *file_priv);
824 int vc4_set_tiling_ioctl(struct drm_device *dev, void *data,
825 			 struct drm_file *file_priv);
826 int vc4_get_tiling_ioctl(struct drm_device *dev, void *data,
827 			 struct drm_file *file_priv);
828 int vc4_get_hang_state_ioctl(struct drm_device *dev, void *data,
829 			     struct drm_file *file_priv);
830 int vc4_label_bo_ioctl(struct drm_device *dev, void *data,
831 		       struct drm_file *file_priv);
832 int vc4_bo_cache_init(struct drm_device *dev);
833 int vc4_bo_inc_usecnt(struct vc4_bo *bo);
834 void vc4_bo_dec_usecnt(struct vc4_bo *bo);
835 void vc4_bo_add_to_purgeable_pool(struct vc4_bo *bo);
836 void vc4_bo_remove_from_purgeable_pool(struct vc4_bo *bo);
837 
838 /* vc4_crtc.c */
839 extern struct platform_driver vc4_crtc_driver;
840 int vc4_crtc_disable_at_boot(struct drm_crtc *crtc);
841 int vc4_crtc_init(struct drm_device *drm, struct vc4_crtc *vc4_crtc,
842 		  const struct drm_crtc_funcs *crtc_funcs,
843 		  const struct drm_crtc_helper_funcs *crtc_helper_funcs);
844 void vc4_crtc_destroy(struct drm_crtc *crtc);
845 int vc4_page_flip(struct drm_crtc *crtc,
846 		  struct drm_framebuffer *fb,
847 		  struct drm_pending_vblank_event *event,
848 		  uint32_t flags,
849 		  struct drm_modeset_acquire_ctx *ctx);
850 struct drm_crtc_state *vc4_crtc_duplicate_state(struct drm_crtc *crtc);
851 void vc4_crtc_destroy_state(struct drm_crtc *crtc,
852 			    struct drm_crtc_state *state);
853 void vc4_crtc_reset(struct drm_crtc *crtc);
854 void vc4_crtc_handle_vblank(struct vc4_crtc *crtc);
855 void vc4_crtc_get_margins(struct drm_crtc_state *state,
856 			  unsigned int *left, unsigned int *right,
857 			  unsigned int *top, unsigned int *bottom);
858 
859 /* vc4_debugfs.c */
860 void vc4_debugfs_init(struct drm_minor *minor);
861 #ifdef CONFIG_DEBUG_FS
862 void vc4_debugfs_add_file(struct drm_device *drm,
863 			  const char *filename,
864 			  int (*show)(struct seq_file*, void*),
865 			  void *data);
866 void vc4_debugfs_add_regset32(struct drm_device *drm,
867 			      const char *filename,
868 			      struct debugfs_regset32 *regset);
869 #else
vc4_debugfs_add_file(struct drm_device * drm,const char * filename,int (* show)(struct seq_file *,void *),void * data)870 static inline void vc4_debugfs_add_file(struct drm_device *drm,
871 					const char *filename,
872 					int (*show)(struct seq_file*, void*),
873 					void *data)
874 {
875 }
876 
vc4_debugfs_add_regset32(struct drm_device * drm,const char * filename,struct debugfs_regset32 * regset)877 static inline void vc4_debugfs_add_regset32(struct drm_device *drm,
878 					    const char *filename,
879 					    struct debugfs_regset32 *regset)
880 {
881 }
882 #endif
883 
884 /* vc4_drv.c */
885 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index);
886 
887 /* vc4_dpi.c */
888 extern struct platform_driver vc4_dpi_driver;
889 
890 /* vc4_dsi.c */
891 extern struct platform_driver vc4_dsi_driver;
892 
893 /* vc4_fence.c */
894 extern const struct dma_fence_ops vc4_fence_ops;
895 
896 /* vc4_gem.c */
897 int vc4_gem_init(struct drm_device *dev);
898 int vc4_submit_cl_ioctl(struct drm_device *dev, void *data,
899 			struct drm_file *file_priv);
900 int vc4_wait_seqno_ioctl(struct drm_device *dev, void *data,
901 			 struct drm_file *file_priv);
902 int vc4_wait_bo_ioctl(struct drm_device *dev, void *data,
903 		      struct drm_file *file_priv);
904 void vc4_submit_next_bin_job(struct drm_device *dev);
905 void vc4_submit_next_render_job(struct drm_device *dev);
906 void vc4_move_job_to_render(struct drm_device *dev, struct vc4_exec_info *exec);
907 int vc4_wait_for_seqno(struct drm_device *dev, uint64_t seqno,
908 		       uint64_t timeout_ns, bool interruptible);
909 void vc4_job_handle_completed(struct vc4_dev *vc4);
910 int vc4_queue_seqno_cb(struct drm_device *dev,
911 		       struct vc4_seqno_cb *cb, uint64_t seqno,
912 		       void (*func)(struct vc4_seqno_cb *cb));
913 int vc4_gem_madvise_ioctl(struct drm_device *dev, void *data,
914 			  struct drm_file *file_priv);
915 
916 /* vc4_hdmi.c */
917 extern struct platform_driver vc4_hdmi_driver;
918 
919 /* vc4_vec.c */
920 extern struct platform_driver vc4_vec_driver;
921 
922 /* vc4_txp.c */
923 extern struct platform_driver vc4_txp_driver;
924 
925 /* vc4_irq.c */
926 void vc4_irq_enable(struct drm_device *dev);
927 void vc4_irq_disable(struct drm_device *dev);
928 int vc4_irq_install(struct drm_device *dev, int irq);
929 void vc4_irq_uninstall(struct drm_device *dev);
930 void vc4_irq_reset(struct drm_device *dev);
931 
932 /* vc4_hvs.c */
933 extern struct platform_driver vc4_hvs_driver;
934 void vc4_hvs_stop_channel(struct drm_device *dev, unsigned int output);
935 int vc4_hvs_get_fifo_from_output(struct drm_device *dev, unsigned int output);
936 u8 vc4_hvs_get_fifo_frame_count(struct drm_device *dev, unsigned int fifo);
937 int vc4_hvs_atomic_check(struct drm_crtc *crtc, struct drm_atomic_state *state);
938 void vc4_hvs_atomic_begin(struct drm_crtc *crtc, struct drm_atomic_state *state);
939 void vc4_hvs_atomic_enable(struct drm_crtc *crtc, struct drm_atomic_state *state);
940 void vc4_hvs_atomic_disable(struct drm_crtc *crtc, struct drm_atomic_state *state);
941 void vc4_hvs_atomic_flush(struct drm_crtc *crtc, struct drm_atomic_state *state);
942 void vc4_hvs_dump_state(struct drm_device *dev);
943 void vc4_hvs_unmask_underrun(struct drm_device *dev, int channel);
944 void vc4_hvs_mask_underrun(struct drm_device *dev, int channel);
945 
946 /* vc4_kms.c */
947 int vc4_kms_load(struct drm_device *dev);
948 
949 /* vc4_plane.c */
950 struct drm_plane *vc4_plane_init(struct drm_device *dev,
951 				 enum drm_plane_type type);
952 int vc4_plane_create_additional_planes(struct drm_device *dev);
953 u32 vc4_plane_write_dlist(struct drm_plane *plane, u32 __iomem *dlist);
954 u32 vc4_plane_dlist_size(const struct drm_plane_state *state);
955 void vc4_plane_async_set_fb(struct drm_plane *plane,
956 			    struct drm_framebuffer *fb);
957 
958 /* vc4_v3d.c */
959 extern struct platform_driver vc4_v3d_driver;
960 extern const struct of_device_id vc4_v3d_dt_match[];
961 int vc4_v3d_get_bin_slot(struct vc4_dev *vc4);
962 int vc4_v3d_bin_bo_get(struct vc4_dev *vc4, bool *used);
963 void vc4_v3d_bin_bo_put(struct vc4_dev *vc4);
964 int vc4_v3d_pm_get(struct vc4_dev *vc4);
965 void vc4_v3d_pm_put(struct vc4_dev *vc4);
966 
967 /* vc4_validate.c */
968 int
969 vc4_validate_bin_cl(struct drm_device *dev,
970 		    void *validated,
971 		    void *unvalidated,
972 		    struct vc4_exec_info *exec);
973 
974 int
975 vc4_validate_shader_recs(struct drm_device *dev, struct vc4_exec_info *exec);
976 
977 struct drm_gem_cma_object *vc4_use_bo(struct vc4_exec_info *exec,
978 				      uint32_t hindex);
979 
980 int vc4_get_rcl(struct drm_device *dev, struct vc4_exec_info *exec);
981 
982 bool vc4_check_tex_size(struct vc4_exec_info *exec,
983 			struct drm_gem_cma_object *fbo,
984 			uint32_t offset, uint8_t tiling_format,
985 			uint32_t width, uint32_t height, uint8_t cpp);
986 
987 /* vc4_validate_shader.c */
988 struct vc4_validated_shader_info *
989 vc4_validate_shader(struct drm_gem_cma_object *shader_obj);
990 
991 /* vc4_perfmon.c */
992 void vc4_perfmon_get(struct vc4_perfmon *perfmon);
993 void vc4_perfmon_put(struct vc4_perfmon *perfmon);
994 void vc4_perfmon_start(struct vc4_dev *vc4, struct vc4_perfmon *perfmon);
995 void vc4_perfmon_stop(struct vc4_dev *vc4, struct vc4_perfmon *perfmon,
996 		      bool capture);
997 struct vc4_perfmon *vc4_perfmon_find(struct vc4_file *vc4file, int id);
998 void vc4_perfmon_open_file(struct vc4_file *vc4file);
999 void vc4_perfmon_close_file(struct vc4_file *vc4file);
1000 int vc4_perfmon_create_ioctl(struct drm_device *dev, void *data,
1001 			     struct drm_file *file_priv);
1002 int vc4_perfmon_destroy_ioctl(struct drm_device *dev, void *data,
1003 			      struct drm_file *file_priv);
1004 int vc4_perfmon_get_values_ioctl(struct drm_device *dev, void *data,
1005 				 struct drm_file *file_priv);
1006 
1007 #endif /* _VC4_DRV_H_ */
1008