drivers/gpu/drm/vc4/vc4_drv.h

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