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