2 * Copyright (C) 2015 Broadcom
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
9 #include <linux/reservation.h>
11 #include <drm/drm_encoder.h>
12 #include <drm/drm_gem_cma_helper.h>
14 /* Don't forget to update vc4_bo.c: bo_type_names[] when adding to
17 enum vc4_kernel_bo_type {
18 /* Any kernel allocation (gem_create_object hook) before it
19 * gets another type set.
23 VC4_BO_TYPE_V3D_SHADER,
28 VC4_BO_TYPE_KERNEL_CACHE,
33 struct drm_device *dev;
35 struct vc4_hdmi *hdmi;
42 struct drm_fbdev_cma *fbdev;
44 struct vc4_hang_state *hang_state;
46 /* The kernel-space BO cache. Tracks buffers that have been
47 * unreferenced by all other users (refcounts of 0!) but not
48 * yet freed, so we can do cheap allocations.
51 /* Array of list heads for entries in the BO cache,
52 * based on number of pages, so we can do O(1) lookups
53 * in the cache when allocating.
55 struct list_head *size_list;
56 uint32_t size_list_size;
58 /* List of all BOs in the cache, ordered by age, so we
59 * can do O(1) lookups when trying to free old
62 struct list_head time_list;
63 struct work_struct time_work;
64 struct timer_list time_timer;
74 /* Protects bo_cache and bo_labels. */
77 /* Purgeable BO pool. All BOs in this pool can have their memory
78 * reclaimed if the driver is unable to allocate new BOs. We also
79 * keep stats related to the purge mechanism here.
82 struct list_head list;
85 unsigned int purged_num;
90 uint64_t dma_fence_context;
92 /* Sequence number for the last job queued in bin_job_list.
93 * Starts at 0 (no jobs emitted).
97 /* Sequence number for the last completed job on the GPU.
98 * Starts at 0 (no jobs completed).
100 uint64_t finished_seqno;
102 /* List of all struct vc4_exec_info for jobs to be executed in
103 * the binner. The first job in the list is the one currently
104 * programmed into ct0ca for execution.
106 struct list_head bin_job_list;
108 /* List of all struct vc4_exec_info for jobs that have
109 * completed binning and are ready for rendering. The first
110 * job in the list is the one currently programmed into ct1ca
113 struct list_head render_job_list;
115 /* List of the finished vc4_exec_infos waiting to be freed by
118 struct list_head job_done_list;
119 /* Spinlock used to synchronize the job_list and seqno
120 * accesses between the IRQ handler and GEM ioctls.
123 wait_queue_head_t job_wait_queue;
124 struct work_struct job_done_work;
126 /* List of struct vc4_seqno_cb for callbacks to be made from a
127 * workqueue when the given seqno is passed.
129 struct list_head seqno_cb_list;
131 /* The memory used for storing binner tile alloc, tile state,
132 * and overflow memory allocations. This is freed when V3D
135 struct vc4_bo *bin_bo;
137 /* Size of blocks allocated within bin_bo. */
138 uint32_t bin_alloc_size;
140 /* Bitmask of the bin_alloc_size chunks in bin_bo that are
143 uint32_t bin_alloc_used;
145 /* Bitmask of the current bin_alloc used for overflow memory. */
146 uint32_t bin_alloc_overflow;
148 struct work_struct overflow_mem_work;
152 /* Mutex controlling the power refcount. */
153 struct mutex power_lock;
156 struct timer_list timer;
157 struct work_struct reset_work;
160 struct semaphore async_modeset;
163 static inline struct vc4_dev *
164 to_vc4_dev(struct drm_device *dev)
166 return (struct vc4_dev *)dev->dev_private;
170 struct drm_gem_cma_object base;
172 /* seqno of the last job to render using this BO. */
175 /* seqno of the last job to use the RCL to write to this BO.
177 * Note that this doesn't include binner overflow memory
180 uint64_t write_seqno;
184 /* List entry for the BO's position in either
185 * vc4_exec_info->unref_list or vc4_dev->bo_cache.time_list
187 struct list_head unref_head;
189 /* Time in jiffies when the BO was put in vc4->bo_cache. */
190 unsigned long free_time;
192 /* List entry for the BO's position in vc4_dev->bo_cache.size_list */
193 struct list_head size_head;
195 /* Struct for shader validation state, if created by
196 * DRM_IOCTL_VC4_CREATE_SHADER_BO.
198 struct vc4_validated_shader_info *validated_shader;
200 /* normally (resv == &_resv) except for imported bo's */
201 struct reservation_object *resv;
202 struct reservation_object _resv;
204 /* One of enum vc4_kernel_bo_type, or VC4_BO_TYPE_COUNT + i
205 * for user-allocated labels.
209 /* Count the number of active users. This is needed to determine
210 * whether we can move the BO to the purgeable list or not (when the BO
211 * is used by the GPU or the display engine we can't purge it).
215 /* Store purgeable/purged state here */
217 struct mutex madv_lock;
220 static inline struct vc4_bo *
221 to_vc4_bo(struct drm_gem_object *bo)
223 return (struct vc4_bo *)bo;
227 struct dma_fence base;
228 struct drm_device *dev;
229 /* vc4 seqno for signaled() test */
233 static inline struct vc4_fence *
234 to_vc4_fence(struct dma_fence *fence)
236 return (struct vc4_fence *)fence;
239 struct vc4_seqno_cb {
240 struct work_struct work;
242 void (*func)(struct vc4_seqno_cb *cb);
247 struct platform_device *pdev;
253 struct platform_device *pdev;
257 /* Memory manager for CRTCs to allocate space in the display
258 * list. Units are dwords.
260 struct drm_mm dlist_mm;
261 /* Memory manager for the LBM memory used by HVS scaling. */
262 struct drm_mm lbm_mm;
265 struct drm_mm_node mitchell_netravali_filter;
269 struct drm_plane base;
272 static inline struct vc4_plane *
273 to_vc4_plane(struct drm_plane *plane)
275 return (struct vc4_plane *)plane;
278 enum vc4_encoder_type {
279 VC4_ENCODER_TYPE_NONE,
280 VC4_ENCODER_TYPE_HDMI,
281 VC4_ENCODER_TYPE_VEC,
282 VC4_ENCODER_TYPE_DSI0,
283 VC4_ENCODER_TYPE_DSI1,
284 VC4_ENCODER_TYPE_SMI,
285 VC4_ENCODER_TYPE_DPI,
289 struct drm_encoder base;
290 enum vc4_encoder_type type;
294 static inline struct vc4_encoder *
295 to_vc4_encoder(struct drm_encoder *encoder)
297 return container_of(encoder, struct vc4_encoder, base);
300 #define V3D_READ(offset) readl(vc4->v3d->regs + offset)
301 #define V3D_WRITE(offset, val) writel(val, vc4->v3d->regs + offset)
302 #define HVS_READ(offset) readl(vc4->hvs->regs + offset)
303 #define HVS_WRITE(offset, val) writel(val, vc4->hvs->regs + offset)
305 struct vc4_exec_info {
306 /* Sequence number for this bin/render job. */
309 /* Latest write_seqno of any BO that binning depends on. */
310 uint64_t bin_dep_seqno;
312 struct dma_fence *fence;
314 /* Last current addresses the hardware was processing when the
315 * hangcheck timer checked on us.
317 uint32_t last_ct0ca, last_ct1ca;
319 /* Kernel-space copy of the ioctl arguments */
320 struct drm_vc4_submit_cl *args;
322 /* This is the array of BOs that were looked up at the start of exec.
323 * Command validation will use indices into this array.
325 struct drm_gem_cma_object **bo;
328 /* List of BOs that are being written by the RCL. Other than
329 * the binner temporary storage, this is all the BOs written
332 struct drm_gem_cma_object *rcl_write_bo[4];
333 uint32_t rcl_write_bo_count;
335 /* Pointers for our position in vc4->job_list */
336 struct list_head head;
338 /* List of other BOs used in the job that need to be released
339 * once the job is complete.
341 struct list_head unref_list;
343 /* Current unvalidated indices into @bo loaded by the non-hardware
344 * VC4_PACKET_GEM_HANDLES.
346 uint32_t bo_index[2];
348 /* This is the BO where we store the validated command lists, shader
349 * records, and uniforms.
351 struct drm_gem_cma_object *exec_bo;
354 * This tracks the per-shader-record state (packet 64) that
355 * determines the length of the shader record and the offset
356 * it's expected to be found at. It gets read in from the
359 struct vc4_shader_state {
361 /* Maximum vertex index referenced by any primitive using this
367 /** How many shader states the user declared they were using. */
368 uint32_t shader_state_size;
369 /** How many shader state records the validator has seen. */
370 uint32_t shader_state_count;
372 bool found_tile_binning_mode_config_packet;
373 bool found_start_tile_binning_packet;
374 bool found_increment_semaphore_packet;
376 uint8_t bin_tiles_x, bin_tiles_y;
377 /* Physical address of the start of the tile alloc array
378 * (where each tile's binned CL will start)
380 uint32_t tile_alloc_offset;
381 /* Bitmask of which binner slots are freed when this job completes. */
385 * Computed addresses pointing into exec_bo where we start the
386 * bin thread (ct0) and render thread (ct1).
388 uint32_t ct0ca, ct0ea;
389 uint32_t ct1ca, ct1ea;
391 /* Pointer to the unvalidated bin CL (if present). */
394 /* Pointers to the shader recs. These paddr gets incremented as CL
395 * packets are relocated in validate_gl_shader_state, and the vaddrs
396 * (u and v) get incremented and size decremented as the shader recs
397 * themselves are validated.
401 uint32_t shader_rec_p;
402 uint32_t shader_rec_size;
404 /* Pointers to the uniform data. These pointers are incremented, and
405 * size decremented, as each batch of uniforms is uploaded.
410 uint32_t uniforms_size;
413 static inline struct vc4_exec_info *
414 vc4_first_bin_job(struct vc4_dev *vc4)
416 return list_first_entry_or_null(&vc4->bin_job_list,
417 struct vc4_exec_info, head);
420 static inline struct vc4_exec_info *
421 vc4_first_render_job(struct vc4_dev *vc4)
423 return list_first_entry_or_null(&vc4->render_job_list,
424 struct vc4_exec_info, head);
427 static inline struct vc4_exec_info *
428 vc4_last_render_job(struct vc4_dev *vc4)
430 if (list_empty(&vc4->render_job_list))
432 return list_last_entry(&vc4->render_job_list,
433 struct vc4_exec_info, head);
437 * struct vc4_texture_sample_info - saves the offsets into the UBO for texture
440 * This will be used at draw time to relocate the reference to the texture
441 * contents in p0, and validate that the offset combined with
442 * width/height/stride/etc. from p1 and p2/p3 doesn't sample outside the BO.
443 * Note that the hardware treats unprovided config parameters as 0, so not all
444 * of them need to be set up for every texure sample, and we'll store ~0 as
445 * the offset to mark the unused ones.
447 * See the VC4 3D architecture guide page 41 ("Texture and Memory Lookup Unit
448 * Setup") for definitions of the texture parameters.
450 struct vc4_texture_sample_info {
452 uint32_t p_offset[4];
456 * struct vc4_validated_shader_info - information about validated shaders that
457 * needs to be used from command list validation.
459 * For a given shader, each time a shader state record references it, we need
460 * to verify that the shader doesn't read more uniforms than the shader state
461 * record's uniform BO pointer can provide, and we need to apply relocations
462 * and validate the shader state record's uniforms that define the texture
465 struct vc4_validated_shader_info {
466 uint32_t uniforms_size;
467 uint32_t uniforms_src_size;
468 uint32_t num_texture_samples;
469 struct vc4_texture_sample_info *texture_samples;
471 uint32_t num_uniform_addr_offsets;
472 uint32_t *uniform_addr_offsets;
478 * _wait_for - magic (register) wait macro
480 * Does the right thing for modeset paths when run under kdgb or similar atomic
481 * contexts. Note that it's important that we check the condition again after
482 * having timed out, since the timeout could be due to preemption or similar and
483 * we've never had a chance to check the condition before the timeout.
485 #define _wait_for(COND, MS, W) ({ \
486 unsigned long timeout__ = jiffies + msecs_to_jiffies(MS) + 1; \
489 if (time_after(jiffies, timeout__)) { \
491 ret__ = -ETIMEDOUT; \
494 if (W && drm_can_sleep()) { \
503 #define wait_for(COND, MS) _wait_for(COND, MS, 1)
506 struct drm_gem_object *vc4_create_object(struct drm_device *dev, size_t size);
507 void vc4_free_object(struct drm_gem_object *gem_obj);
508 struct vc4_bo *vc4_bo_create(struct drm_device *dev, size_t size,
509 bool from_cache, enum vc4_kernel_bo_type type);
510 int vc4_dumb_create(struct drm_file *file_priv,
511 struct drm_device *dev,
512 struct drm_mode_create_dumb *args);
513 struct dma_buf *vc4_prime_export(struct drm_device *dev,
514 struct drm_gem_object *obj, int flags);
515 int vc4_create_bo_ioctl(struct drm_device *dev, void *data,
516 struct drm_file *file_priv);
517 int vc4_create_shader_bo_ioctl(struct drm_device *dev, void *data,
518 struct drm_file *file_priv);
519 int vc4_mmap_bo_ioctl(struct drm_device *dev, void *data,
520 struct drm_file *file_priv);
521 int vc4_set_tiling_ioctl(struct drm_device *dev, void *data,
522 struct drm_file *file_priv);
523 int vc4_get_tiling_ioctl(struct drm_device *dev, void *data,
524 struct drm_file *file_priv);
525 int vc4_get_hang_state_ioctl(struct drm_device *dev, void *data,
526 struct drm_file *file_priv);
527 int vc4_label_bo_ioctl(struct drm_device *dev, void *data,
528 struct drm_file *file_priv);
529 int vc4_fault(struct vm_fault *vmf);
530 int vc4_mmap(struct file *filp, struct vm_area_struct *vma);
531 struct reservation_object *vc4_prime_res_obj(struct drm_gem_object *obj);
532 int vc4_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
533 struct drm_gem_object *vc4_prime_import_sg_table(struct drm_device *dev,
534 struct dma_buf_attachment *attach,
535 struct sg_table *sgt);
536 void *vc4_prime_vmap(struct drm_gem_object *obj);
537 int vc4_bo_cache_init(struct drm_device *dev);
538 void vc4_bo_cache_destroy(struct drm_device *dev);
539 int vc4_bo_stats_debugfs(struct seq_file *m, void *arg);
540 int vc4_bo_inc_usecnt(struct vc4_bo *bo);
541 void vc4_bo_dec_usecnt(struct vc4_bo *bo);
542 void vc4_bo_add_to_purgeable_pool(struct vc4_bo *bo);
543 void vc4_bo_remove_from_purgeable_pool(struct vc4_bo *bo);
546 extern struct platform_driver vc4_crtc_driver;
547 int vc4_crtc_debugfs_regs(struct seq_file *m, void *arg);
548 bool vc4_crtc_get_scanoutpos(struct drm_device *dev, unsigned int crtc_id,
549 bool in_vblank_irq, int *vpos, int *hpos,
550 ktime_t *stime, ktime_t *etime,
551 const struct drm_display_mode *mode);
554 int vc4_debugfs_init(struct drm_minor *minor);
557 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index);
560 extern struct platform_driver vc4_dpi_driver;
561 int vc4_dpi_debugfs_regs(struct seq_file *m, void *unused);
564 extern struct platform_driver vc4_dsi_driver;
565 int vc4_dsi_debugfs_regs(struct seq_file *m, void *unused);
568 extern const struct dma_fence_ops vc4_fence_ops;
571 void vc4_gem_init(struct drm_device *dev);
572 void vc4_gem_destroy(struct drm_device *dev);
573 int vc4_submit_cl_ioctl(struct drm_device *dev, void *data,
574 struct drm_file *file_priv);
575 int vc4_wait_seqno_ioctl(struct drm_device *dev, void *data,
576 struct drm_file *file_priv);
577 int vc4_wait_bo_ioctl(struct drm_device *dev, void *data,
578 struct drm_file *file_priv);
579 void vc4_submit_next_bin_job(struct drm_device *dev);
580 void vc4_submit_next_render_job(struct drm_device *dev);
581 void vc4_move_job_to_render(struct drm_device *dev, struct vc4_exec_info *exec);
582 int vc4_wait_for_seqno(struct drm_device *dev, uint64_t seqno,
583 uint64_t timeout_ns, bool interruptible);
584 void vc4_job_handle_completed(struct vc4_dev *vc4);
585 int vc4_queue_seqno_cb(struct drm_device *dev,
586 struct vc4_seqno_cb *cb, uint64_t seqno,
587 void (*func)(struct vc4_seqno_cb *cb));
588 int vc4_gem_madvise_ioctl(struct drm_device *dev, void *data,
589 struct drm_file *file_priv);
592 extern struct platform_driver vc4_hdmi_driver;
593 int vc4_hdmi_debugfs_regs(struct seq_file *m, void *unused);
596 extern struct platform_driver vc4_vec_driver;
597 int vc4_vec_debugfs_regs(struct seq_file *m, void *unused);
600 irqreturn_t vc4_irq(int irq, void *arg);
601 void vc4_irq_preinstall(struct drm_device *dev);
602 int vc4_irq_postinstall(struct drm_device *dev);
603 void vc4_irq_uninstall(struct drm_device *dev);
604 void vc4_irq_reset(struct drm_device *dev);
607 extern struct platform_driver vc4_hvs_driver;
608 void vc4_hvs_dump_state(struct drm_device *dev);
609 int vc4_hvs_debugfs_regs(struct seq_file *m, void *unused);
612 int vc4_kms_load(struct drm_device *dev);
615 struct drm_plane *vc4_plane_init(struct drm_device *dev,
616 enum drm_plane_type type);
617 u32 vc4_plane_write_dlist(struct drm_plane *plane, u32 __iomem *dlist);
618 u32 vc4_plane_dlist_size(const struct drm_plane_state *state);
619 void vc4_plane_async_set_fb(struct drm_plane *plane,
620 struct drm_framebuffer *fb);
623 extern struct platform_driver vc4_v3d_driver;
624 int vc4_v3d_debugfs_ident(struct seq_file *m, void *unused);
625 int vc4_v3d_debugfs_regs(struct seq_file *m, void *unused);
626 int vc4_v3d_get_bin_slot(struct vc4_dev *vc4);
630 vc4_validate_bin_cl(struct drm_device *dev,
633 struct vc4_exec_info *exec);
636 vc4_validate_shader_recs(struct drm_device *dev, struct vc4_exec_info *exec);
638 struct drm_gem_cma_object *vc4_use_bo(struct vc4_exec_info *exec,
641 int vc4_get_rcl(struct drm_device *dev, struct vc4_exec_info *exec);
643 bool vc4_check_tex_size(struct vc4_exec_info *exec,
644 struct drm_gem_cma_object *fbo,
645 uint32_t offset, uint8_t tiling_format,
646 uint32_t width, uint32_t height, uint8_t cpp);
648 /* vc4_validate_shader.c */
649 struct vc4_validated_shader_info *
650 vc4_validate_shader(struct drm_gem_cma_object *shader_obj);