drivers/gpu/drm/v3d/v3d_drv.h

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /* Copyright (C) 2015-2018 Broadcom */
   3
   4 #include <linux/delay.h>
   5 #include <linux/mutex.h>
   6 #include <linux/spinlock_types.h>
   7 #include <linux/workqueue.h>
   8
   9 #include <drm/drm_encoder.h>
  10 #include <drm/drm_gem.h>
  11 #include <drm/drm_gem_shmem_helper.h>
  12 #include <drm/gpu_scheduler.h>
  13
  14 #include "uapi/drm/v3d_drm.h"
  15
  16 struct clk;
  17 struct platform_device;
  18 struct reset_control;
  19
  20 #define GMP_GRANULARITY (128 * 1024)
  21
  22 /* Enum for each of the V3D queues. */
  23 enum v3d_queue {
  24         V3D_BIN,
  25         V3D_RENDER,
  26         V3D_TFU,
  27         V3D_CSD,
  28         V3D_CACHE_CLEAN,
  29 };
  30
  31 #define V3D_MAX_QUEUES (V3D_CACHE_CLEAN + 1)
  32
  33 struct v3d_queue_state {
  34         struct drm_gpu_scheduler sched;
  35
  36         u64 fence_context;
  37         u64 emit_seqno;
  38 };
  39
  40 /* Performance monitor object. The perform lifetime is controlled by userspace
  41  * using perfmon related ioctls. A perfmon can be attached to a submit_cl
  42  * request, and when this is the case, HW perf counters will be activated just
  43  * before the submit_cl is submitted to the GPU and disabled when the job is
  44  * done. This way, only events related to a specific job will be counted.
  45  */
  46 struct v3d_perfmon {
  47         /* Tracks the number of users of the perfmon, when this counter reaches
  48          * zero the perfmon is destroyed.
  49          */
  50         refcount_t refcnt;
  51
  52         /* Protects perfmon stop, as it can be invoked from multiple places. */
  53         struct mutex lock;
  54
  55         /* Number of counters activated in this perfmon instance
  56          * (should be less than DRM_V3D_MAX_PERF_COUNTERS).
  57          */
  58         u8 ncounters;
  59
  60         /* Events counted by the HW perf counters. */
  61         u8 counters[DRM_V3D_MAX_PERF_COUNTERS];
  62
  63         /* Storage for counter values. Counters are incremented by the
  64          * HW perf counter values every time the perfmon is attached
  65          * to a GPU job.  This way, perfmon users don't have to
  66          * retrieve the results after each job if they want to track
  67          * events covering several submissions.  Note that counter
  68          * values can't be reset, but you can fake a reset by
  69          * destroying the perfmon and creating a new one.
  70          */
  71         u64 values[];
  72 };
  73
  74 struct v3d_dev {
  75         struct drm_device drm;
  76
  77         /* Short representation (e.g. 33, 41) of the V3D tech version
  78          * and revision.
  79          */
  80         int ver;
  81         bool single_irq_line;
  82
  83         void __iomem *hub_regs;
  84         void __iomem *core_regs[3];
  85         void __iomem *bridge_regs;
  86         void __iomem *gca_regs;
  87         struct clk *clk;
  88         struct delayed_work clk_down_work;
  89         unsigned long clk_up_rate, clk_down_rate;
  90         struct mutex clk_lock;
  91         u32 clk_refcount;
  92         bool clk_up;
  93
  94         struct reset_control *reset;
  95
  96         /* Virtual and DMA addresses of the single shared page table. */
  97         volatile u32 *pt;
  98         dma_addr_t pt_paddr;
  99
 100         /* Virtual and DMA addresses of the MMU's scratch page.  When
 101          * a read or write is invalid in the MMU, it will be
 102          * redirected here.
 103          */
 104         void *mmu_scratch;
 105         dma_addr_t mmu_scratch_paddr;
 106         /* virtual address bits from V3D to the MMU. */
 107         int va_width;
 108
 109         /* Number of V3D cores. */
 110         u32 cores;
 111
 112         /* Allocator managing the address space.  All units are in
 113          * number of pages.
 114          */
 115         struct drm_mm mm;
 116         spinlock_t mm_lock;
 117
 118         struct work_struct overflow_mem_work;
 119
 120         struct v3d_bin_job *bin_job;
 121         struct v3d_render_job *render_job;
 122         struct v3d_tfu_job *tfu_job;
 123         struct v3d_csd_job *csd_job;
 124
 125         struct v3d_queue_state queue[V3D_MAX_QUEUES];
 126
 127         /* Spinlock used to synchronize the overflow memory
 128          * management against bin job submission.
 129          */
 130         spinlock_t job_lock;
 131
 132         /* Used to track the active perfmon if any. */
 133         struct v3d_perfmon *active_perfmon;
 134
 135         /* Protects bo_stats */
 136         struct mutex bo_lock;
 137
 138         /* Lock taken when resetting the GPU, to keep multiple
 139          * processes from trying to park the scheduler threads and
 140          * reset at once.
 141          */
 142         struct mutex reset_lock;
 143
 144         /* Lock taken when creating and pushing the GPU scheduler
 145          * jobs, to keep the sched-fence seqnos in order.
 146          */
 147         struct mutex sched_lock;
 148
 149         /* Lock taken during a cache clean and when initiating an L2
 150          * flush, to keep L2 flushes from interfering with the
 151          * synchronous L2 cleans.
 152          */
 153         struct mutex cache_clean_lock;
 154
 155         struct {
 156                 u32 num_allocated;
 157                 u32 pages_allocated;
 158         } bo_stats;
 159 };
 160
 161 static inline struct v3d_dev *
 162 to_v3d_dev(struct drm_device *dev)
 163 {
 164         return container_of(dev, struct v3d_dev, drm);
 165 }
 166
 167 static inline bool
 168 v3d_has_csd(struct v3d_dev *v3d)
 169 {
 170         return v3d->ver >= 41;
 171 }
 172
 173 #define v3d_to_pdev(v3d) to_platform_device((v3d)->drm.dev)
 174
 175 /* The per-fd struct, which tracks the MMU mappings. */
 176 struct v3d_file_priv {
 177         struct v3d_dev *v3d;
 178
 179         struct {
 180                 struct idr idr;
 181                 struct mutex lock;
 182         } perfmon;
 183
 184         struct drm_sched_entity sched_entity[V3D_MAX_QUEUES];
 185 };
 186
 187 struct v3d_bo {
 188         struct drm_gem_shmem_object base;
 189
 190         struct drm_mm_node node;
 191
 192         /* List entry for the BO's position in
 193          * v3d_render_job->unref_list
 194          */
 195         struct list_head unref_head;
 196 };
 197
 198 static inline struct v3d_bo *
 199 to_v3d_bo(struct drm_gem_object *bo)
 200 {
 201         return (struct v3d_bo *)bo;
 202 }
 203
 204 struct v3d_fence {
 205         struct dma_fence base;
 206         struct drm_device *dev;
 207         /* v3d seqno for signaled() test */
 208         u64 seqno;
 209         enum v3d_queue queue;
 210 };
 211
 212 static inline struct v3d_fence *
 213 to_v3d_fence(struct dma_fence *fence)
 214 {
 215         return (struct v3d_fence *)fence;
 216 }
 217
 218 #define V3D_READ(offset) readl(v3d->hub_regs + offset)
 219 #define V3D_WRITE(offset, val) writel(val, v3d->hub_regs + offset)
 220
 221 #define V3D_BRIDGE_READ(offset) readl(v3d->bridge_regs + offset)
 222 #define V3D_BRIDGE_WRITE(offset, val) writel(val, v3d->bridge_regs + offset)
 223
 224 #define V3D_GCA_READ(offset) readl(v3d->gca_regs + offset)
 225 #define V3D_GCA_WRITE(offset, val) writel(val, v3d->gca_regs + offset)
 226
 227 #define V3D_CORE_READ(core, offset) readl(v3d->core_regs[core] + offset)
 228 #define V3D_CORE_WRITE(core, offset, val) writel(val, v3d->core_regs[core] + offset)
 229
 230 struct v3d_job {
 231         struct drm_sched_job base;
 232
 233         struct kref refcount;
 234
 235         struct v3d_dev *v3d;
 236
 237         /* This is the array of BOs that were looked up at the start
 238          * of submission.
 239          */
 240         struct drm_gem_object **bo;
 241         u32 bo_count;
 242
 243         /* Array of struct dma_fence * to block on before submitting this job.
 244          */
 245         struct xarray deps;
 246         unsigned long last_dep;
 247
 248         /* v3d fence to be signaled by IRQ handler when the job is complete. */
 249         struct dma_fence *irq_fence;
 250
 251         /* scheduler fence for when the job is considered complete and
 252          * the BO reservations can be released.
 253          */
 254         struct dma_fence *done_fence;
 255
 256         /* Pointer to a performance monitor object if the user requested it,
 257          * NULL otherwise.
 258          */
 259         struct v3d_perfmon *perfmon;
 260
 261         /* Callback for the freeing of the job on refcount going to 0. */
 262         void (*free)(struct kref *ref);
 263 };
 264
 265 struct v3d_bin_job {
 266         struct v3d_job base;
 267
 268         /* GPU virtual addresses of the start/end of the CL job. */
 269         u32 start, end;
 270
 271         u32 timedout_ctca, timedout_ctra;
 272
 273         /* Corresponding render job, for attaching our overflow memory. */
 274         struct v3d_render_job *render;
 275
 276         /* Submitted tile memory allocation start/size, tile state. */
 277         u32 qma, qms, qts;
 278 };
 279
 280 struct v3d_render_job {
 281         struct v3d_job base;
 282
 283         /* GPU virtual addresses of the start/end of the CL job. */
 284         u32 start, end;
 285
 286         u32 timedout_ctca, timedout_ctra;
 287
 288         /* List of overflow BOs used in the job that need to be
 289          * released once the job is complete.
 290          */
 291         struct list_head unref_list;
 292 };
 293
 294 struct v3d_tfu_job {
 295         struct v3d_job base;
 296
 297         struct drm_v3d_submit_tfu args;
 298 };
 299
 300 struct v3d_csd_job {
 301         struct v3d_job base;
 302
 303         u32 timedout_batches;
 304
 305         struct drm_v3d_submit_csd args;
 306 };
 307
 308 /**
 309  * __wait_for - magic wait macro
 310  *
 311  * Macro to help avoid open coding check/wait/timeout patterns. Note that it's
 312  * important that we check the condition again after having timed out, since the
 313  * timeout could be due to preemption or similar and we've never had a chance to
 314  * check the condition before the timeout.
 315  */
 316 #define __wait_for(OP, COND, US, Wmin, Wmax) ({ \
 317         const ktime_t end__ = ktime_add_ns(ktime_get_raw(), 1000ll * (US)); \
 318         long wait__ = (Wmin); /* recommended min for usleep is 10 us */ \
 319         int ret__;                                                      \
 320         might_sleep();                                                  \
 321         for (;;) {                                                      \
 322                 const bool expired__ = ktime_after(ktime_get_raw(), end__); \
 323                 OP;                                                     \
 324                 /* Guarantee COND check prior to timeout */             \
 325                 barrier();                                              \
 326                 if (COND) {                                             \
 327                         ret__ = 0;                                      \
 328                         break;                                          \
 329                 }                                                       \
 330                 if (expired__) {                                        \
 331                         ret__ = -ETIMEDOUT;                             \
 332                         break;                                          \
 333                 }                                                       \
 334                 usleep_range(wait__, wait__ * 2);                       \
 335                 if (wait__ < (Wmax))                                    \
 336                         wait__ <<= 1;                                   \
 337         }                                                               \
 338         ret__;                                                          \
 339 })
 340
 341 #define _wait_for(COND, US, Wmin, Wmax) __wait_for(, (COND), (US), (Wmin), \
 342                                                    (Wmax))
 343 #define wait_for(COND, MS)              _wait_for((COND), (MS) * 1000, 10, 1000)
 344
 345 static inline unsigned long nsecs_to_jiffies_timeout(const u64 n)
 346 {
 347         /* nsecs_to_jiffies64() does not guard against overflow */
 348         if (NSEC_PER_SEC % HZ &&
 349             div_u64(n, NSEC_PER_SEC) >= MAX_JIFFY_OFFSET / HZ)
 350                 return MAX_JIFFY_OFFSET;
 351
 352         return min_t(u64, MAX_JIFFY_OFFSET, nsecs_to_jiffies64(n) + 1);
 353 }
 354
 355 /* v3d_bo.c */
 356 struct drm_gem_object *v3d_create_object(struct drm_device *dev, size_t size);
 357 void v3d_free_object(struct drm_gem_object *gem_obj);
 358 struct v3d_bo *v3d_bo_create(struct drm_device *dev, struct drm_file *file_priv,
 359                              size_t size);
 360 int v3d_create_bo_ioctl(struct drm_device *dev, void *data,
 361                         struct drm_file *file_priv);
 362 int v3d_mmap_bo_ioctl(struct drm_device *dev, void *data,
 363                       struct drm_file *file_priv);
 364 int v3d_get_bo_offset_ioctl(struct drm_device *dev, void *data,
 365                             struct drm_file *file_priv);
 366 struct drm_gem_object *v3d_prime_import_sg_table(struct drm_device *dev,
 367                                                  struct dma_buf_attachment *attach,
 368                                                  struct sg_table *sgt);
 369
 370 /* v3d_debugfs.c */
 371 void v3d_debugfs_init(struct drm_minor *minor);
 372
 373 /* v3d_fence.c */
 374 extern const struct dma_fence_ops v3d_fence_ops;
 375 struct dma_fence *v3d_fence_create(struct v3d_dev *v3d, enum v3d_queue queue);
 376
 377 /* v3d_gem.c */
 378 int v3d_gem_init(struct drm_device *dev);
 379 void v3d_gem_destroy(struct drm_device *dev);
 380 int v3d_submit_cl_ioctl(struct drm_device *dev, void *data,
 381                         struct drm_file *file_priv);
 382 int v3d_submit_tfu_ioctl(struct drm_device *dev, void *data,
 383                          struct drm_file *file_priv);
 384 int v3d_submit_csd_ioctl(struct drm_device *dev, void *data,
 385                          struct drm_file *file_priv);
 386 int v3d_wait_bo_ioctl(struct drm_device *dev, void *data,
 387                       struct drm_file *file_priv);
 388 void v3d_job_put(struct v3d_job *job);
 389 void v3d_reset(struct v3d_dev *v3d);
 390 void v3d_invalidate_caches(struct v3d_dev *v3d);
 391 void v3d_clean_caches(struct v3d_dev *v3d);
 392
 393 /* v3d_irq.c */
 394 int v3d_irq_init(struct v3d_dev *v3d);
 395 void v3d_irq_enable(struct v3d_dev *v3d);
 396 void v3d_irq_disable(struct v3d_dev *v3d);
 397 void v3d_irq_reset(struct v3d_dev *v3d);
 398
 399 /* v3d_mmu.c */
 400 int v3d_mmu_get_offset(struct drm_file *file_priv, struct v3d_bo *bo,
 401                        u32 *offset);
 402 int v3d_mmu_set_page_table(struct v3d_dev *v3d);
 403 void v3d_mmu_insert_ptes(struct v3d_bo *bo);
 404 void v3d_mmu_remove_ptes(struct v3d_bo *bo);
 405
 406 /* v3d_sched.c */
 407 int v3d_sched_init(struct v3d_dev *v3d);
 408 void v3d_sched_fini(struct v3d_dev *v3d);
 409
 410 /* v3d_perfmon.c */
 411 void v3d_perfmon_get(struct v3d_perfmon *perfmon);
 412 void v3d_perfmon_put(struct v3d_perfmon *perfmon);
 413 void v3d_perfmon_start(struct v3d_dev *v3d, struct v3d_perfmon *perfmon);
 414 void v3d_perfmon_stop(struct v3d_dev *v3d, struct v3d_perfmon *perfmon,
 415                       bool capture);
 416 struct v3d_perfmon *v3d_perfmon_find(struct v3d_file_priv *v3d_priv, int id);
 417 void v3d_perfmon_open_file(struct v3d_file_priv *v3d_priv);
 418 void v3d_perfmon_close_file(struct v3d_file_priv *v3d_priv);
 419 int v3d_perfmon_create_ioctl(struct drm_device *dev, void *data,
 420                              struct drm_file *file_priv);
 421 int v3d_perfmon_destroy_ioctl(struct drm_device *dev, void *data,
 422                               struct drm_file *file_priv);
 423 int v3d_perfmon_get_values_ioctl(struct drm_device *dev, void *data,
 424                                  struct drm_file *file_priv);