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
  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         struct vc4_hvs *hvs;
  78         struct vc4_v3d *v3d;
  79         struct vc4_dpi *dpi;
  80         struct vc4_dsi *dsi1;
  81         struct vc4_vec *vec;
  82         struct vc4_txp *txp;
  83
  84         struct vc4_hang_state *hang_state;
  85
  86         /* The kernel-space BO cache.  Tracks buffers that have been
  87          * unreferenced by all other users (refcounts of 0!) but not
  88          * yet freed, so we can do cheap allocations.
  89          */
  90         struct vc4_bo_cache {
  91                 /* Array of list heads for entries in the BO cache,
  92                  * based on number of pages, so we can do O(1) lookups
  93                  * in the cache when allocating.
  94                  */
  95                 struct list_head *size_list;
  96                 uint32_t size_list_size;
  97
  98                 /* List of all BOs in the cache, ordered by age, so we
  99                  * can do O(1) lookups when trying to free old
 100                  * buffers.
 101                  */
 102                 struct list_head time_list;
 103                 struct work_struct time_work;
 104                 struct timer_list time_timer;
 105         } bo_cache;
 106
 107         u32 num_labels;
 108         struct vc4_label {
 109                 const char *name;
 110                 u32 num_allocated;
 111                 u32 size_allocated;
 112         } *bo_labels;
 113
 114         /* Protects bo_cache and bo_labels. */
 115         struct mutex bo_lock;
 116
 117         /* Purgeable BO pool. All BOs in this pool can have their memory
 118          * reclaimed if the driver is unable to allocate new BOs. We also
 119          * keep stats related to the purge mechanism here.
 120          */
 121         struct {
 122                 struct list_head list;
 123                 unsigned int num;
 124                 size_t size;
 125                 unsigned int purged_num;
 126                 size_t purged_size;
 127                 struct mutex lock;
 128         } purgeable;
 129
 130         uint64_t dma_fence_context;
 131
 132         /* Sequence number for the last job queued in bin_job_list.
 133          * Starts at 0 (no jobs emitted).
 134          */
 135         uint64_t emit_seqno;
 136
 137         /* Sequence number for the last completed job on the GPU.
 138          * Starts at 0 (no jobs completed).
 139          */
 140         uint64_t finished_seqno;
 141
 142         /* List of all struct vc4_exec_info for jobs to be executed in
 143          * the binner.  The first job in the list is the one currently
 144          * programmed into ct0ca for execution.
 145          */
 146         struct list_head bin_job_list;
 147
 148         /* List of all struct vc4_exec_info for jobs that have
 149          * completed binning and are ready for rendering.  The first
 150          * job in the list is the one currently programmed into ct1ca
 151          * for execution.
 152          */
 153         struct list_head render_job_list;
 154
 155         /* List of the finished vc4_exec_infos waiting to be freed by
 156          * job_done_work.
 157          */
 158         struct list_head job_done_list;
 159         /* Spinlock used to synchronize the job_list and seqno
 160          * accesses between the IRQ handler and GEM ioctls.
 161          */
 162         spinlock_t job_lock;
 163         wait_queue_head_t job_wait_queue;
 164         struct work_struct job_done_work;
 165
 166         /* Used to track the active perfmon if any. Access to this field is
 167          * protected by job_lock.
 168          */
 169         struct vc4_perfmon *active_perfmon;
 170
 171         /* List of struct vc4_seqno_cb for callbacks to be made from a
 172          * workqueue when the given seqno is passed.
 173          */
 174         struct list_head seqno_cb_list;
 175
 176         /* The memory used for storing binner tile alloc, tile state,
 177          * and overflow memory allocations.  This is freed when V3D
 178          * powers down.
 179          */
 180         struct vc4_bo *bin_bo;
 181
 182         /* Size of blocks allocated within bin_bo. */
 183         uint32_t bin_alloc_size;
 184
 185         /* Bitmask of the bin_alloc_size chunks in bin_bo that are
 186          * used.
 187          */
 188         uint32_t bin_alloc_used;
 189
 190         /* Bitmask of the current bin_alloc used for overflow memory. */
 191         uint32_t bin_alloc_overflow;
 192
 193         /* Incremented when an underrun error happened after an atomic commit.
 194          * This is particularly useful to detect when a specific modeset is too
 195          * demanding in term of memory or HVS bandwidth which is hard to guess
 196          * at atomic check time.
 197          */
 198         atomic_t underrun;
 199
 200         struct work_struct overflow_mem_work;
 201
 202         int power_refcount;
 203
 204         /* Set to true when the load tracker is supported. */
 205         bool load_tracker_available;
 206
 207         /* Set to true when the load tracker is active. */
 208         bool load_tracker_enabled;
 209
 210         /* Mutex controlling the power refcount. */
 211         struct mutex power_lock;
 212
 213         struct {
 214                 struct timer_list timer;
 215                 struct work_struct reset_work;
 216         } hangcheck;
 217
 218         struct semaphore async_modeset;
 219
 220         struct drm_modeset_lock ctm_state_lock;
 221         struct drm_private_obj ctm_manager;
 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 *
 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 *
 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 *
 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 *
 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 *
 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);
 447         void (*pre_crtc_enable)(struct drm_encoder *encoder);
 448         void (*post_crtc_enable)(struct drm_encoder *encoder);
 449
 450         void (*post_crtc_disable)(struct drm_encoder *encoder);
 451         void (*post_crtc_powerdown)(struct drm_encoder *encoder);
 452 };
 453
 454 static inline struct vc4_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 static inline struct vc4_crtc *
 501 to_vc4_crtc(struct drm_crtc *crtc)
 502 {
 503         return container_of(crtc, struct vc4_crtc, base);
 504 }
 505
 506 static inline const struct vc4_crtc_data *
 507 vc4_crtc_to_vc4_crtc_data(const struct vc4_crtc *crtc)
 508 {
 509         return crtc->data;
 510 }
 511
 512 static inline const struct vc4_pv_data *
 513 vc4_crtc_to_vc4_pv_data(const struct vc4_crtc *crtc)
 514 {
 515         const struct vc4_crtc_data *data = vc4_crtc_to_vc4_crtc_data(crtc);
 516
 517         return container_of(data, struct vc4_pv_data, base);
 518 }
 519
 520 struct vc4_crtc_state {
 521         struct drm_crtc_state base;
 522         /* Dlist area for this CRTC configuration. */
 523         struct drm_mm_node mm;
 524         bool feed_txp;
 525         bool txp_armed;
 526         unsigned int assigned_channel;
 527
 528         struct {
 529                 unsigned int left;
 530                 unsigned int right;
 531                 unsigned int top;
 532                 unsigned int bottom;
 533         } margins;
 534 };
 535
 536 #define VC4_HVS_CHANNEL_DISABLED ((unsigned int)-1)
 537
 538 static inline struct vc4_crtc_state *
 539 to_vc4_crtc_state(struct drm_crtc_state *crtc_state)
 540 {
 541         return container_of(crtc_state, struct vc4_crtc_state, base);
 542 }
 543
 544 #define V3D_READ(offset) readl(vc4->v3d->regs + offset)
 545 #define V3D_WRITE(offset, val) writel(val, vc4->v3d->regs + offset)
 546 #define HVS_READ(offset) readl(vc4->hvs->regs + offset)
 547 #define HVS_WRITE(offset, val) writel(val, vc4->hvs->regs + offset)
 548
 549 #define VC4_REG32(reg) { .name = #reg, .offset = reg }
 550
 551 struct vc4_exec_info {
 552         /* Sequence number for this bin/render job. */
 553         uint64_t seqno;
 554
 555         /* Latest write_seqno of any BO that binning depends on. */
 556         uint64_t bin_dep_seqno;
 557
 558         struct dma_fence *fence;
 559
 560         /* Last current addresses the hardware was processing when the
 561          * hangcheck timer checked on us.
 562          */
 563         uint32_t last_ct0ca, last_ct1ca;
 564
 565         /* Kernel-space copy of the ioctl arguments */
 566         struct drm_vc4_submit_cl *args;
 567
 568         /* This is the array of BOs that were looked up at the start of exec.
 569          * Command validation will use indices into this array.
 570          */
 571         struct drm_gem_cma_object **bo;
 572         uint32_t bo_count;
 573
 574         /* List of BOs that are being written by the RCL.  Other than
 575          * the binner temporary storage, this is all the BOs written
 576          * by the job.
 577          */
 578         struct drm_gem_cma_object *rcl_write_bo[4];
 579         uint32_t rcl_write_bo_count;
 580
 581         /* Pointers for our position in vc4->job_list */
 582         struct list_head head;
 583
 584         /* List of other BOs used in the job that need to be released
 585          * once the job is complete.
 586          */
 587         struct list_head unref_list;
 588
 589         /* Current unvalidated indices into @bo loaded by the non-hardware
 590          * VC4_PACKET_GEM_HANDLES.
 591          */
 592         uint32_t bo_index[2];
 593
 594         /* This is the BO where we store the validated command lists, shader
 595          * records, and uniforms.
 596          */
 597         struct drm_gem_cma_object *exec_bo;
 598
 599         /**
 600          * This tracks the per-shader-record state (packet 64) that
 601          * determines the length of the shader record and the offset
 602          * it's expected to be found at.  It gets read in from the
 603          * command lists.
 604          */
 605         struct vc4_shader_state {
 606                 uint32_t addr;
 607                 /* Maximum vertex index referenced by any primitive using this
 608                  * shader state.
 609                  */
 610                 uint32_t max_index;
 611         } *shader_state;
 612
 613         /** How many shader states the user declared they were using. */
 614         uint32_t shader_state_size;
 615         /** How many shader state records the validator has seen. */
 616         uint32_t shader_state_count;
 617
 618         bool found_tile_binning_mode_config_packet;
 619         bool found_start_tile_binning_packet;
 620         bool found_increment_semaphore_packet;
 621         bool found_flush;
 622         uint8_t bin_tiles_x, bin_tiles_y;
 623         /* Physical address of the start of the tile alloc array
 624          * (where each tile's binned CL will start)
 625          */
 626         uint32_t tile_alloc_offset;
 627         /* Bitmask of which binner slots are freed when this job completes. */
 628         uint32_t bin_slots;
 629
 630         /**
 631          * Computed addresses pointing into exec_bo where we start the
 632          * bin thread (ct0) and render thread (ct1).
 633          */
 634         uint32_t ct0ca, ct0ea;
 635         uint32_t ct1ca, ct1ea;
 636
 637         /* Pointer to the unvalidated bin CL (if present). */
 638         void *bin_u;
 639
 640         /* Pointers to the shader recs.  These paddr gets incremented as CL
 641          * packets are relocated in validate_gl_shader_state, and the vaddrs
 642          * (u and v) get incremented and size decremented as the shader recs
 643          * themselves are validated.
 644          */
 645         void *shader_rec_u;
 646         void *shader_rec_v;
 647         uint32_t shader_rec_p;
 648         uint32_t shader_rec_size;
 649
 650         /* Pointers to the uniform data.  These pointers are incremented, and
 651          * size decremented, as each batch of uniforms is uploaded.
 652          */
 653         void *uniforms_u;
 654         void *uniforms_v;
 655         uint32_t uniforms_p;
 656         uint32_t uniforms_size;
 657
 658         /* Pointer to a performance monitor object if the user requested it,
 659          * NULL otherwise.
 660          */
 661         struct vc4_perfmon *perfmon;
 662
 663         /* Whether the exec has taken a reference to the binner BO, which should
 664          * happen with a VC4_PACKET_TILE_BINNING_MODE_CONFIG packet.
 665          */
 666         bool bin_bo_used;
 667 };
 668
 669 /* Per-open file private data. Any driver-specific resource that has to be
 670  * released when the DRM file is closed should be placed here.
 671  */
 672 struct vc4_file {
 673         struct {
 674                 struct idr idr;
 675                 struct mutex lock;
 676         } perfmon;
 677
 678         bool bin_bo_used;
 679 };
 680
 681 static inline struct vc4_exec_info *
 682 vc4_first_bin_job(struct vc4_dev *vc4)
 683 {
 684         return list_first_entry_or_null(&vc4->bin_job_list,
 685                                         struct vc4_exec_info, head);
 686 }
 687
 688 static inline struct vc4_exec_info *
 689 vc4_first_render_job(struct vc4_dev *vc4)
 690 {
 691         return list_first_entry_or_null(&vc4->render_job_list,
 692                                         struct vc4_exec_info, head);
 693 }
 694
 695 static inline struct vc4_exec_info *
 696 vc4_last_render_job(struct vc4_dev *vc4)
 697 {
 698         if (list_empty(&vc4->render_job_list))
 699                 return NULL;
 700         return list_last_entry(&vc4->render_job_list,
 701                                struct vc4_exec_info, head);
 702 }
 703
 704 /**
 705  * struct vc4_texture_sample_info - saves the offsets into the UBO for texture
 706  * setup parameters.
 707  *
 708  * This will be used at draw time to relocate the reference to the texture
 709  * contents in p0, and validate that the offset combined with
 710  * width/height/stride/etc. from p1 and p2/p3 doesn't sample outside the BO.
 711  * Note that the hardware treats unprovided config parameters as 0, so not all
 712  * of them need to be set up for every texure sample, and we'll store ~0 as
 713  * the offset to mark the unused ones.
 714  *
 715  * See the VC4 3D architecture guide page 41 ("Texture and Memory Lookup Unit
 716  * Setup") for definitions of the texture parameters.
 717  */
 718 struct vc4_texture_sample_info {
 719         bool is_direct;
 720         uint32_t p_offset[4];
 721 };
 722
 723 /**
 724  * struct vc4_validated_shader_info - information about validated shaders that
 725  * needs to be used from command list validation.
 726  *
 727  * For a given shader, each time a shader state record references it, we need
 728  * to verify that the shader doesn't read more uniforms than the shader state
 729  * record's uniform BO pointer can provide, and we need to apply relocations
 730  * and validate the shader state record's uniforms that define the texture
 731  * samples.
 732  */
 733 struct vc4_validated_shader_info {
 734         uint32_t uniforms_size;
 735         uint32_t uniforms_src_size;
 736         uint32_t num_texture_samples;
 737         struct vc4_texture_sample_info *texture_samples;
 738
 739         uint32_t num_uniform_addr_offsets;
 740         uint32_t *uniform_addr_offsets;
 741
 742         bool is_threaded;
 743 };
 744
 745 /**
 746  * __wait_for - magic wait macro
 747  *
 748  * Macro to help avoid open coding check/wait/timeout patterns. Note that it's
 749  * important that we check the condition again after having timed out, since the
 750  * timeout could be due to preemption or similar and we've never had a chance to
 751  * check the condition before the timeout.
 752  */
 753 #define __wait_for(OP, COND, US, Wmin, Wmax) ({ \
 754         const ktime_t end__ = ktime_add_ns(ktime_get_raw(), 1000ll * (US)); \
 755         long wait__ = (Wmin); /* recommended min for usleep is 10 us */ \
 756         int ret__;                                                      \
 757         might_sleep();                                                  \
 758         for (;;) {                                                      \
 759                 const bool expired__ = ktime_after(ktime_get_raw(), end__); \
 760                 OP;                                                     \
 761                 /* Guarantee COND check prior to timeout */             \
 762                 barrier();                                              \
 763                 if (COND) {                                             \
 764                         ret__ = 0;                                      \
 765                         break;                                          \
 766                 }                                                       \
 767                 if (expired__) {                                        \
 768                         ret__ = -ETIMEDOUT;                             \
 769                         break;                                          \
 770                 }                                                       \
 771                 usleep_range(wait__, wait__ * 2);                       \
 772                 if (wait__ < (Wmax))                                    \
 773                         wait__ <<= 1;                                   \
 774         }                                                               \
 775         ret__;                                                          \
 776 })
 777
 778 #define _wait_for(COND, US, Wmin, Wmax) __wait_for(, (COND), (US), (Wmin), \
 779                                                    (Wmax))
 780 #define wait_for(COND, MS)              _wait_for((COND), (MS) * 1000, 10, 1000)
 781
 782 /* vc4_bo.c */
 783 struct drm_gem_object *vc4_create_object(struct drm_device *dev, size_t size);
 784 void vc4_free_object(struct drm_gem_object *gem_obj);
 785 struct vc4_bo *vc4_bo_create(struct drm_device *dev, size_t size,
 786                              bool from_cache, enum vc4_kernel_bo_type type);
 787 int vc4_dumb_create(struct drm_file *file_priv,
 788                     struct drm_device *dev,
 789                     struct drm_mode_create_dumb *args);
 790 struct dma_buf *vc4_prime_export(struct drm_gem_object *obj, int flags);
 791 int vc4_create_bo_ioctl(struct drm_device *dev, void *data,
 792                         struct drm_file *file_priv);
 793 int vc4_create_shader_bo_ioctl(struct drm_device *dev, void *data,
 794                                struct drm_file *file_priv);
 795 int vc4_mmap_bo_ioctl(struct drm_device *dev, void *data,
 796                       struct drm_file *file_priv);
 797 int vc4_set_tiling_ioctl(struct drm_device *dev, void *data,
 798                          struct drm_file *file_priv);
 799 int vc4_get_tiling_ioctl(struct drm_device *dev, void *data,
 800                          struct drm_file *file_priv);
 801 int vc4_get_hang_state_ioctl(struct drm_device *dev, void *data,
 802                              struct drm_file *file_priv);
 803 int vc4_label_bo_ioctl(struct drm_device *dev, void *data,
 804                        struct drm_file *file_priv);
 805 vm_fault_t vc4_fault(struct vm_fault *vmf);
 806 int vc4_mmap(struct file *filp, struct vm_area_struct *vma);
 807 int vc4_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
 808 struct drm_gem_object *vc4_prime_import_sg_table(struct drm_device *dev,
 809                                                  struct dma_buf_attachment *attach,
 810                                                  struct sg_table *sgt);
 811 void *vc4_prime_vmap(struct drm_gem_object *obj);
 812 int vc4_bo_cache_init(struct drm_device *dev);
 813 int vc4_bo_inc_usecnt(struct vc4_bo *bo);
 814 void vc4_bo_dec_usecnt(struct vc4_bo *bo);
 815 void vc4_bo_add_to_purgeable_pool(struct vc4_bo *bo);
 816 void vc4_bo_remove_from_purgeable_pool(struct vc4_bo *bo);
 817
 818 /* vc4_crtc.c */
 819 extern struct platform_driver vc4_crtc_driver;
 820 int vc4_crtc_disable_at_boot(struct drm_crtc *crtc);
 821 int vc4_crtc_init(struct drm_device *drm, struct vc4_crtc *vc4_crtc,
 822                   const struct drm_crtc_funcs *crtc_funcs,
 823                   const struct drm_crtc_helper_funcs *crtc_helper_funcs);
 824 void vc4_crtc_destroy(struct drm_crtc *crtc);
 825 int vc4_page_flip(struct drm_crtc *crtc,
 826                   struct drm_framebuffer *fb,
 827                   struct drm_pending_vblank_event *event,
 828                   uint32_t flags,
 829                   struct drm_modeset_acquire_ctx *ctx);
 830 struct drm_crtc_state *vc4_crtc_duplicate_state(struct drm_crtc *crtc);
 831 void vc4_crtc_destroy_state(struct drm_crtc *crtc,
 832                             struct drm_crtc_state *state);
 833 void vc4_crtc_reset(struct drm_crtc *crtc);
 834 void vc4_crtc_handle_vblank(struct vc4_crtc *crtc);
 835 void vc4_crtc_get_margins(struct drm_crtc_state *state,
 836                           unsigned int *right, unsigned int *left,
 837                           unsigned int *top, unsigned int *bottom);
 838
 839 /* vc4_debugfs.c */
 840 void vc4_debugfs_init(struct drm_minor *minor);
 841 #ifdef CONFIG_DEBUG_FS
 842 void vc4_debugfs_add_file(struct drm_device *drm,
 843                           const char *filename,
 844                           int (*show)(struct seq_file*, void*),
 845                           void *data);
 846 void vc4_debugfs_add_regset32(struct drm_device *drm,
 847                               const char *filename,
 848                               struct debugfs_regset32 *regset);
 849 #else
 850 static inline void vc4_debugfs_add_file(struct drm_device *drm,
 851                                         const char *filename,
 852                                         int (*show)(struct seq_file*, void*),
 853                                         void *data)
 854 {
 855 }
 856
 857 static inline void vc4_debugfs_add_regset32(struct drm_device *drm,
 858                                             const char *filename,
 859                                             struct debugfs_regset32 *regset)
 860 {
 861 }
 862 #endif
 863
 864 /* vc4_drv.c */
 865 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index);
 866
 867 /* vc4_dpi.c */
 868 extern struct platform_driver vc4_dpi_driver;
 869
 870 /* vc4_dsi.c */
 871 extern struct platform_driver vc4_dsi_driver;
 872
 873 /* vc4_fence.c */
 874 extern const struct dma_fence_ops vc4_fence_ops;
 875
 876 /* vc4_gem.c */
 877 int vc4_gem_init(struct drm_device *dev);
 878 int vc4_submit_cl_ioctl(struct drm_device *dev, void *data,
 879                         struct drm_file *file_priv);
 880 int vc4_wait_seqno_ioctl(struct drm_device *dev, void *data,
 881                          struct drm_file *file_priv);
 882 int vc4_wait_bo_ioctl(struct drm_device *dev, void *data,
 883                       struct drm_file *file_priv);
 884 void vc4_submit_next_bin_job(struct drm_device *dev);
 885 void vc4_submit_next_render_job(struct drm_device *dev);
 886 void vc4_move_job_to_render(struct drm_device *dev, struct vc4_exec_info *exec);
 887 int vc4_wait_for_seqno(struct drm_device *dev, uint64_t seqno,
 888                        uint64_t timeout_ns, bool interruptible);
 889 void vc4_job_handle_completed(struct vc4_dev *vc4);
 890 int vc4_queue_seqno_cb(struct drm_device *dev,
 891                        struct vc4_seqno_cb *cb, uint64_t seqno,
 892                        void (*func)(struct vc4_seqno_cb *cb));
 893 int vc4_gem_madvise_ioctl(struct drm_device *dev, void *data,
 894                           struct drm_file *file_priv);
 895
 896 /* vc4_hdmi.c */
 897 extern struct platform_driver vc4_hdmi_driver;
 898
 899 /* vc4_vec.c */
 900 extern struct platform_driver vc4_vec_driver;
 901
 902 /* vc4_txp.c */
 903 extern struct platform_driver vc4_txp_driver;
 904
 905 /* vc4_irq.c */
 906 irqreturn_t vc4_irq(int irq, void *arg);
 907 void vc4_irq_preinstall(struct drm_device *dev);
 908 int vc4_irq_postinstall(struct drm_device *dev);
 909 void vc4_irq_uninstall(struct drm_device *dev);
 910 void vc4_irq_reset(struct drm_device *dev);
 911
 912 /* vc4_hvs.c */
 913 extern struct platform_driver vc4_hvs_driver;
 914 void vc4_hvs_stop_channel(struct drm_device *dev, unsigned int output);
 915 int vc4_hvs_get_fifo_from_output(struct drm_device *dev, unsigned int output);
 916 int vc4_hvs_atomic_check(struct drm_crtc *crtc, struct drm_crtc_state *state);
 917 void vc4_hvs_atomic_enable(struct drm_crtc *crtc, struct drm_crtc_state *old_state);
 918 void vc4_hvs_atomic_disable(struct drm_crtc *crtc, struct drm_crtc_state *old_state);
 919 void vc4_hvs_atomic_flush(struct drm_crtc *crtc, struct drm_crtc_state *state);
 920 void vc4_hvs_dump_state(struct drm_device *dev);
 921 void vc4_hvs_unmask_underrun(struct drm_device *dev, int channel);
 922 void vc4_hvs_mask_underrun(struct drm_device *dev, int channel);
 923
 924 /* vc4_kms.c */
 925 int vc4_kms_load(struct drm_device *dev);
 926
 927 /* vc4_plane.c */
 928 struct drm_plane *vc4_plane_init(struct drm_device *dev,
 929                                  enum drm_plane_type type);
 930 int vc4_plane_create_additional_planes(struct drm_device *dev);
 931 u32 vc4_plane_write_dlist(struct drm_plane *plane, u32 __iomem *dlist);
 932 u32 vc4_plane_dlist_size(const struct drm_plane_state *state);
 933 void vc4_plane_async_set_fb(struct drm_plane *plane,
 934                             struct drm_framebuffer *fb);
 935
 936 /* vc4_v3d.c */
 937 extern struct platform_driver vc4_v3d_driver;
 938 extern const struct of_device_id vc4_v3d_dt_match[];
 939 int vc4_v3d_get_bin_slot(struct vc4_dev *vc4);
 940 int vc4_v3d_bin_bo_get(struct vc4_dev *vc4, bool *used);
 941 void vc4_v3d_bin_bo_put(struct vc4_dev *vc4);
 942 int vc4_v3d_pm_get(struct vc4_dev *vc4);
 943 void vc4_v3d_pm_put(struct vc4_dev *vc4);
 944
 945 /* vc4_validate.c */
 946 int
 947 vc4_validate_bin_cl(struct drm_device *dev,
 948                     void *validated,
 949                     void *unvalidated,
 950                     struct vc4_exec_info *exec);
 951
 952 int
 953 vc4_validate_shader_recs(struct drm_device *dev, struct vc4_exec_info *exec);
 954
 955 struct drm_gem_cma_object *vc4_use_bo(struct vc4_exec_info *exec,
 956                                       uint32_t hindex);
 957
 958 int vc4_get_rcl(struct drm_device *dev, struct vc4_exec_info *exec);
 959
 960 bool vc4_check_tex_size(struct vc4_exec_info *exec,
 961                         struct drm_gem_cma_object *fbo,
 962                         uint32_t offset, uint8_t tiling_format,
 963                         uint32_t width, uint32_t height, uint8_t cpp);
 964
 965 /* vc4_validate_shader.c */
 966 struct vc4_validated_shader_info *
 967 vc4_validate_shader(struct drm_gem_cma_object *shader_obj);
 968
 969 /* vc4_perfmon.c */
 970 void vc4_perfmon_get(struct vc4_perfmon *perfmon);
 971 void vc4_perfmon_put(struct vc4_perfmon *perfmon);
 972 void vc4_perfmon_start(struct vc4_dev *vc4, struct vc4_perfmon *perfmon);
 973 void vc4_perfmon_stop(struct vc4_dev *vc4, struct vc4_perfmon *perfmon,
 974                       bool capture);
 975 struct vc4_perfmon *vc4_perfmon_find(struct vc4_file *vc4file, int id);
 976 void vc4_perfmon_open_file(struct vc4_file *vc4file);
 977 void vc4_perfmon_close_file(struct vc4_file *vc4file);
 978 int vc4_perfmon_create_ioctl(struct drm_device *dev, void *data,
 979                              struct drm_file *file_priv);
 980 int vc4_perfmon_destroy_ioctl(struct drm_device *dev, void *data,
 981                               struct drm_file *file_priv);
 982 int vc4_perfmon_get_values_ioctl(struct drm_device *dev, void *data,
 983                                  struct drm_file *file_priv);
 984
 985 #endif /* _VC4_DRV_H_ */