drivers/gpu/drm/amd/amdgpu/amdgpu_ring.h

   1 /*
   2  * Copyright 2016 Advanced Micro Devices, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Authors: Christian König
  23  */
  24 #ifndef __AMDGPU_RING_H__
  25 #define __AMDGPU_RING_H__
  26
  27 #include <drm/amdgpu_drm.h>
  28 #include <drm/gpu_scheduler.h>
  29 #include <drm/drm_print.h>
  30
  31 struct amdgpu_device;
  32 struct amdgpu_ring;
  33 struct amdgpu_ib;
  34 struct amdgpu_cs_parser;
  35 struct amdgpu_job;
  36 struct amdgpu_vm;
  37
  38 /* max number of rings */
  39 #define AMDGPU_MAX_RINGS                28
  40 #define AMDGPU_MAX_HWIP_RINGS           8
  41 #define AMDGPU_MAX_GFX_RINGS            2
  42 #define AMDGPU_MAX_SW_GFX_RINGS         2
  43 #define AMDGPU_MAX_COMPUTE_RINGS        8
  44 #define AMDGPU_MAX_VCE_RINGS            3
  45 #define AMDGPU_MAX_UVD_ENC_RINGS        2
  46
  47 enum amdgpu_ring_priority_level {
  48         AMDGPU_RING_PRIO_0,
  49         AMDGPU_RING_PRIO_1,
  50         AMDGPU_RING_PRIO_DEFAULT = 1,
  51         AMDGPU_RING_PRIO_2,
  52         AMDGPU_RING_PRIO_MAX
  53 };
  54
  55 /* some special values for the owner field */
  56 #define AMDGPU_FENCE_OWNER_UNDEFINED    ((void *)0ul)
  57 #define AMDGPU_FENCE_OWNER_VM           ((void *)1ul)
  58 #define AMDGPU_FENCE_OWNER_KFD          ((void *)2ul)
  59
  60 #define AMDGPU_FENCE_FLAG_64BIT         (1 << 0)
  61 #define AMDGPU_FENCE_FLAG_INT           (1 << 1)
  62 #define AMDGPU_FENCE_FLAG_TC_WB_ONLY    (1 << 2)
  63 #define AMDGPU_FENCE_FLAG_EXEC          (1 << 3)
  64
  65 #define to_amdgpu_ring(s) container_of((s), struct amdgpu_ring, sched)
  66
  67 #define AMDGPU_IB_POOL_SIZE     (1024 * 1024)
  68
  69 enum amdgpu_ring_type {
  70         AMDGPU_RING_TYPE_GFX            = AMDGPU_HW_IP_GFX,
  71         AMDGPU_RING_TYPE_COMPUTE        = AMDGPU_HW_IP_COMPUTE,
  72         AMDGPU_RING_TYPE_SDMA           = AMDGPU_HW_IP_DMA,
  73         AMDGPU_RING_TYPE_UVD            = AMDGPU_HW_IP_UVD,
  74         AMDGPU_RING_TYPE_VCE            = AMDGPU_HW_IP_VCE,
  75         AMDGPU_RING_TYPE_UVD_ENC        = AMDGPU_HW_IP_UVD_ENC,
  76         AMDGPU_RING_TYPE_VCN_DEC        = AMDGPU_HW_IP_VCN_DEC,
  77         AMDGPU_RING_TYPE_VCN_ENC        = AMDGPU_HW_IP_VCN_ENC,
  78         AMDGPU_RING_TYPE_VCN_JPEG       = AMDGPU_HW_IP_VCN_JPEG,
  79         AMDGPU_RING_TYPE_KIQ,
  80         AMDGPU_RING_TYPE_MES
  81 };
  82
  83 enum amdgpu_ib_pool_type {
  84         /* Normal submissions to the top of the pipeline. */
  85         AMDGPU_IB_POOL_DELAYED,
  86         /* Immediate submissions to the bottom of the pipeline. */
  87         AMDGPU_IB_POOL_IMMEDIATE,
  88         /* Direct submission to the ring buffer during init and reset. */
  89         AMDGPU_IB_POOL_DIRECT,
  90
  91         AMDGPU_IB_POOL_MAX
  92 };
  93
  94 struct amdgpu_ib {
  95         struct amdgpu_sa_bo             *sa_bo;
  96         uint32_t                        length_dw;
  97         uint64_t                        gpu_addr;
  98         uint32_t                        *ptr;
  99         uint32_t                        flags;
 100 };
 101
 102 struct amdgpu_sched {
 103         u32                             num_scheds;
 104         struct drm_gpu_scheduler        *sched[AMDGPU_MAX_HWIP_RINGS];
 105 };
 106
 107 /*
 108  * Fences.
 109  */
 110 struct amdgpu_fence_driver {
 111         uint64_t                        gpu_addr;
 112         volatile uint32_t               *cpu_addr;
 113         /* sync_seq is protected by ring emission lock */
 114         uint32_t                        sync_seq;
 115         atomic_t                        last_seq;
 116         bool                            initialized;
 117         struct amdgpu_irq_src           *irq_src;
 118         unsigned                        irq_type;
 119         struct timer_list               fallback_timer;
 120         unsigned                        num_fences_mask;
 121         spinlock_t                      lock;
 122         struct dma_fence                **fences;
 123 };
 124
 125 extern const struct drm_sched_backend_ops amdgpu_sched_ops;
 126
 127 void amdgpu_fence_driver_clear_job_fences(struct amdgpu_ring *ring);
 128 void amdgpu_fence_driver_force_completion(struct amdgpu_ring *ring);
 129
 130 int amdgpu_fence_driver_init_ring(struct amdgpu_ring *ring);
 131 int amdgpu_fence_driver_start_ring(struct amdgpu_ring *ring,
 132                                    struct amdgpu_irq_src *irq_src,
 133                                    unsigned irq_type);
 134 void amdgpu_fence_driver_hw_init(struct amdgpu_device *adev);
 135 void amdgpu_fence_driver_hw_fini(struct amdgpu_device *adev);
 136 int amdgpu_fence_driver_sw_init(struct amdgpu_device *adev);
 137 void amdgpu_fence_driver_sw_fini(struct amdgpu_device *adev);
 138 int amdgpu_fence_emit(struct amdgpu_ring *ring, struct dma_fence **fence, struct amdgpu_job *job,
 139                       unsigned flags);
 140 int amdgpu_fence_emit_polling(struct amdgpu_ring *ring, uint32_t *s,
 141                               uint32_t timeout);
 142 bool amdgpu_fence_process(struct amdgpu_ring *ring);
 143 int amdgpu_fence_wait_empty(struct amdgpu_ring *ring);
 144 signed long amdgpu_fence_wait_polling(struct amdgpu_ring *ring,
 145                                       uint32_t wait_seq,
 146                                       signed long timeout);
 147 unsigned amdgpu_fence_count_emitted(struct amdgpu_ring *ring);
 148
 149 void amdgpu_fence_driver_isr_toggle(struct amdgpu_device *adev, bool stop);
 150
 151 u64 amdgpu_fence_last_unsignaled_time_us(struct amdgpu_ring *ring);
 152 void amdgpu_fence_update_start_timestamp(struct amdgpu_ring *ring, uint32_t seq,
 153                                          ktime_t timestamp);
 154
 155 /*
 156  * Rings.
 157  */
 158
 159 /* provided by hw blocks that expose a ring buffer for commands */
 160 struct amdgpu_ring_funcs {
 161         enum amdgpu_ring_type   type;
 162         uint32_t                align_mask;
 163         u32                     nop;
 164         bool                    support_64bit_ptrs;
 165         bool                    no_user_fence;
 166         bool                    secure_submission_supported;
 167         unsigned                vmhub;
 168         unsigned                extra_dw;
 169
 170         /* ring read/write ptr handling */
 171         u64 (*get_rptr)(struct amdgpu_ring *ring);
 172         u64 (*get_wptr)(struct amdgpu_ring *ring);
 173         void (*set_wptr)(struct amdgpu_ring *ring);
 174         /* validating and patching of IBs */
 175         int (*parse_cs)(struct amdgpu_cs_parser *p,
 176                         struct amdgpu_job *job,
 177                         struct amdgpu_ib *ib);
 178         int (*patch_cs_in_place)(struct amdgpu_cs_parser *p,
 179                                  struct amdgpu_job *job,
 180                                  struct amdgpu_ib *ib);
 181         /* constants to calculate how many DW are needed for an emit */
 182         unsigned emit_frame_size;
 183         unsigned emit_ib_size;
 184         /* command emit functions */
 185         void (*emit_ib)(struct amdgpu_ring *ring,
 186                         struct amdgpu_job *job,
 187                         struct amdgpu_ib *ib,
 188                         uint32_t flags);
 189         void (*emit_fence)(struct amdgpu_ring *ring, uint64_t addr,
 190                            uint64_t seq, unsigned flags);
 191         void (*emit_pipeline_sync)(struct amdgpu_ring *ring);
 192         void (*emit_vm_flush)(struct amdgpu_ring *ring, unsigned vmid,
 193                               uint64_t pd_addr);
 194         void (*emit_hdp_flush)(struct amdgpu_ring *ring);
 195         void (*emit_gds_switch)(struct amdgpu_ring *ring, uint32_t vmid,
 196                                 uint32_t gds_base, uint32_t gds_size,
 197                                 uint32_t gws_base, uint32_t gws_size,
 198                                 uint32_t oa_base, uint32_t oa_size);
 199         /* testing functions */
 200         int (*test_ring)(struct amdgpu_ring *ring);
 201         int (*test_ib)(struct amdgpu_ring *ring, long timeout);
 202         /* insert NOP packets */
 203         void (*insert_nop)(struct amdgpu_ring *ring, uint32_t count);
 204         void (*insert_start)(struct amdgpu_ring *ring);
 205         void (*insert_end)(struct amdgpu_ring *ring);
 206         /* pad the indirect buffer to the necessary number of dw */
 207         void (*pad_ib)(struct amdgpu_ring *ring, struct amdgpu_ib *ib);
 208         unsigned (*init_cond_exec)(struct amdgpu_ring *ring);
 209         void (*patch_cond_exec)(struct amdgpu_ring *ring, unsigned offset);
 210         /* note usage for clock and power gating */
 211         void (*begin_use)(struct amdgpu_ring *ring);
 212         void (*end_use)(struct amdgpu_ring *ring);
 213         void (*emit_switch_buffer) (struct amdgpu_ring *ring);
 214         void (*emit_cntxcntl) (struct amdgpu_ring *ring, uint32_t flags);
 215         void (*emit_rreg)(struct amdgpu_ring *ring, uint32_t reg,
 216                           uint32_t reg_val_offs);
 217         void (*emit_wreg)(struct amdgpu_ring *ring, uint32_t reg, uint32_t val);
 218         void (*emit_reg_wait)(struct amdgpu_ring *ring, uint32_t reg,
 219                               uint32_t val, uint32_t mask);
 220         void (*emit_reg_write_reg_wait)(struct amdgpu_ring *ring,
 221                                         uint32_t reg0, uint32_t reg1,
 222                                         uint32_t ref, uint32_t mask);
 223         void (*emit_frame_cntl)(struct amdgpu_ring *ring, bool start,
 224                                 bool secure);
 225         /* Try to soft recover the ring to make the fence signal */
 226         void (*soft_recovery)(struct amdgpu_ring *ring, unsigned vmid);
 227         int (*preempt_ib)(struct amdgpu_ring *ring);
 228         void (*emit_mem_sync)(struct amdgpu_ring *ring);
 229         void (*emit_wave_limit)(struct amdgpu_ring *ring, bool enable);
 230 };
 231
 232 struct amdgpu_ring {
 233         struct amdgpu_device            *adev;
 234         const struct amdgpu_ring_funcs  *funcs;
 235         struct amdgpu_fence_driver      fence_drv;
 236         struct drm_gpu_scheduler        sched;
 237
 238         struct amdgpu_bo        *ring_obj;
 239         volatile uint32_t       *ring;
 240         unsigned                rptr_offs;
 241         u64                     rptr_gpu_addr;
 242         volatile u32            *rptr_cpu_addr;
 243         u64                     wptr;
 244         u64                     wptr_old;
 245         unsigned                ring_size;
 246         unsigned                max_dw;
 247         int                     count_dw;
 248         uint64_t                gpu_addr;
 249         uint64_t                ptr_mask;
 250         uint32_t                buf_mask;
 251         u32                     idx;
 252         u32                     me;
 253         u32                     pipe;
 254         u32                     queue;
 255         struct amdgpu_bo        *mqd_obj;
 256         uint64_t                mqd_gpu_addr;
 257         void                    *mqd_ptr;
 258         uint64_t                eop_gpu_addr;
 259         u32                     doorbell_index;
 260         bool                    use_doorbell;
 261         bool                    use_pollmem;
 262         unsigned                wptr_offs;
 263         u64                     wptr_gpu_addr;
 264         volatile u32            *wptr_cpu_addr;
 265         unsigned                fence_offs;
 266         u64                     fence_gpu_addr;
 267         volatile u32            *fence_cpu_addr;
 268         uint64_t                current_ctx;
 269         char                    name[16];
 270         u32                     trail_seq;
 271         unsigned                trail_fence_offs;
 272         u64                     trail_fence_gpu_addr;
 273         volatile u32            *trail_fence_cpu_addr;
 274         unsigned                cond_exe_offs;
 275         u64                     cond_exe_gpu_addr;
 276         volatile u32            *cond_exe_cpu_addr;
 277         unsigned                vm_inv_eng;
 278         struct dma_fence        *vmid_wait;
 279         bool                    has_compute_vm_bug;
 280         bool                    no_scheduler;
 281         int                     hw_prio;
 282         unsigned                num_hw_submission;
 283         atomic_t                *sched_score;
 284
 285         /* used for mes */
 286         bool                    is_mes_queue;
 287         uint32_t                hw_queue_id;
 288         struct amdgpu_mes_ctx_data *mes_ctx;
 289
 290         bool            is_sw_ring;
 291         unsigned int    entry_index;
 292
 293 };
 294
 295 #define amdgpu_ring_parse_cs(r, p, job, ib) ((r)->funcs->parse_cs((p), (job), (ib)))
 296 #define amdgpu_ring_patch_cs_in_place(r, p, job, ib) ((r)->funcs->patch_cs_in_place((p), (job), (ib)))
 297 #define amdgpu_ring_test_ring(r) (r)->funcs->test_ring((r))
 298 #define amdgpu_ring_test_ib(r, t) ((r)->funcs->test_ib ? (r)->funcs->test_ib((r), (t)) : 0)
 299 #define amdgpu_ring_get_rptr(r) (r)->funcs->get_rptr((r))
 300 #define amdgpu_ring_get_wptr(r) (r)->funcs->get_wptr((r))
 301 #define amdgpu_ring_set_wptr(r) (r)->funcs->set_wptr((r))
 302 #define amdgpu_ring_emit_ib(r, job, ib, flags) ((r)->funcs->emit_ib((r), (job), (ib), (flags)))
 303 #define amdgpu_ring_emit_pipeline_sync(r) (r)->funcs->emit_pipeline_sync((r))
 304 #define amdgpu_ring_emit_vm_flush(r, vmid, addr) (r)->funcs->emit_vm_flush((r), (vmid), (addr))
 305 #define amdgpu_ring_emit_fence(r, addr, seq, flags) (r)->funcs->emit_fence((r), (addr), (seq), (flags))
 306 #define amdgpu_ring_emit_gds_switch(r, v, db, ds, wb, ws, ab, as) (r)->funcs->emit_gds_switch((r), (v), (db), (ds), (wb), (ws), (ab), (as))
 307 #define amdgpu_ring_emit_hdp_flush(r) (r)->funcs->emit_hdp_flush((r))
 308 #define amdgpu_ring_emit_switch_buffer(r) (r)->funcs->emit_switch_buffer((r))
 309 #define amdgpu_ring_emit_cntxcntl(r, d) (r)->funcs->emit_cntxcntl((r), (d))
 310 #define amdgpu_ring_emit_rreg(r, d, o) (r)->funcs->emit_rreg((r), (d), (o))
 311 #define amdgpu_ring_emit_wreg(r, d, v) (r)->funcs->emit_wreg((r), (d), (v))
 312 #define amdgpu_ring_emit_reg_wait(r, d, v, m) (r)->funcs->emit_reg_wait((r), (d), (v), (m))
 313 #define amdgpu_ring_emit_reg_write_reg_wait(r, d0, d1, v, m) (r)->funcs->emit_reg_write_reg_wait((r), (d0), (d1), (v), (m))
 314 #define amdgpu_ring_emit_frame_cntl(r, b, s) (r)->funcs->emit_frame_cntl((r), (b), (s))
 315 #define amdgpu_ring_pad_ib(r, ib) ((r)->funcs->pad_ib((r), (ib)))
 316 #define amdgpu_ring_init_cond_exec(r) (r)->funcs->init_cond_exec((r))
 317 #define amdgpu_ring_patch_cond_exec(r,o) (r)->funcs->patch_cond_exec((r),(o))
 318 #define amdgpu_ring_preempt_ib(r) (r)->funcs->preempt_ib(r)
 319
 320 int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned ndw);
 321 void amdgpu_ring_ib_begin(struct amdgpu_ring *ring);
 322 void amdgpu_ring_ib_end(struct amdgpu_ring *ring);
 323
 324 void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count);
 325 void amdgpu_ring_generic_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib);
 326 void amdgpu_ring_commit(struct amdgpu_ring *ring);
 327 void amdgpu_ring_undo(struct amdgpu_ring *ring);
 328 int amdgpu_ring_init(struct amdgpu_device *adev, struct amdgpu_ring *ring,
 329                      unsigned int max_dw, struct amdgpu_irq_src *irq_src,
 330                      unsigned int irq_type, unsigned int hw_prio,
 331                      atomic_t *sched_score);
 332 void amdgpu_ring_fini(struct amdgpu_ring *ring);
 333 void amdgpu_ring_emit_reg_write_reg_wait_helper(struct amdgpu_ring *ring,
 334                                                 uint32_t reg0, uint32_t val0,
 335                                                 uint32_t reg1, uint32_t val1);
 336 bool amdgpu_ring_soft_recovery(struct amdgpu_ring *ring, unsigned int vmid,
 337                                struct dma_fence *fence);
 338
 339 static inline void amdgpu_ring_set_preempt_cond_exec(struct amdgpu_ring *ring,
 340                                                         bool cond_exec)
 341 {
 342         *ring->cond_exe_cpu_addr = cond_exec;
 343 }
 344
 345 static inline void amdgpu_ring_clear_ring(struct amdgpu_ring *ring)
 346 {
 347         int i = 0;
 348         while (i <= ring->buf_mask)
 349                 ring->ring[i++] = ring->funcs->nop;
 350
 351 }
 352
 353 static inline void amdgpu_ring_write(struct amdgpu_ring *ring, uint32_t v)
 354 {
 355         if (ring->count_dw <= 0)
 356                 DRM_ERROR("amdgpu: writing more dwords to the ring than expected!\n");
 357         ring->ring[ring->wptr++ & ring->buf_mask] = v;
 358         ring->wptr &= ring->ptr_mask;
 359         ring->count_dw--;
 360 }
 361
 362 static inline void amdgpu_ring_write_multiple(struct amdgpu_ring *ring,
 363                                               void *src, int count_dw)
 364 {
 365         unsigned occupied, chunk1, chunk2;
 366         void *dst;
 367
 368         if (unlikely(ring->count_dw < count_dw))
 369                 DRM_ERROR("amdgpu: writing more dwords to the ring than expected!\n");
 370
 371         occupied = ring->wptr & ring->buf_mask;
 372         dst = (void *)&ring->ring[occupied];
 373         chunk1 = ring->buf_mask + 1 - occupied;
 374         chunk1 = (chunk1 >= count_dw) ? count_dw: chunk1;
 375         chunk2 = count_dw - chunk1;
 376         chunk1 <<= 2;
 377         chunk2 <<= 2;
 378
 379         if (chunk1)
 380                 memcpy(dst, src, chunk1);
 381
 382         if (chunk2) {
 383                 src += chunk1;
 384                 dst = (void *)ring->ring;
 385                 memcpy(dst, src, chunk2);
 386         }
 387
 388         ring->wptr += count_dw;
 389         ring->wptr &= ring->ptr_mask;
 390         ring->count_dw -= count_dw;
 391 }
 392
 393 #define amdgpu_mes_ctx_get_offs_gpu_addr(ring, offset)                  \
 394         (ring->is_mes_queue && ring->mes_ctx ?                          \
 395          (ring->mes_ctx->meta_data_gpu_addr + offset) : 0)
 396
 397 #define amdgpu_mes_ctx_get_offs_cpu_addr(ring, offset)                  \
 398         (ring->is_mes_queue && ring->mes_ctx ?                          \
 399          (void *)((uint8_t *)(ring->mes_ctx->meta_data_ptr) + offset) : \
 400          NULL)
 401
 402 int amdgpu_ring_test_helper(struct amdgpu_ring *ring);
 403
 404 void amdgpu_debugfs_ring_init(struct amdgpu_device *adev,
 405                               struct amdgpu_ring *ring);
 406
 407 int amdgpu_ring_init_mqd(struct amdgpu_ring *ring);
 408
 409 static inline u32 amdgpu_ib_get_value(struct amdgpu_ib *ib, int idx)
 410 {
 411         return ib->ptr[idx];
 412 }
 413
 414 static inline void amdgpu_ib_set_value(struct amdgpu_ib *ib, int idx,
 415                                        uint32_t value)
 416 {
 417         ib->ptr[idx] = value;
 418 }
 419
 420 int amdgpu_ib_get(struct amdgpu_device *adev, struct amdgpu_vm *vm,
 421                   unsigned size,
 422                   enum amdgpu_ib_pool_type pool,
 423                   struct amdgpu_ib *ib);
 424 void amdgpu_ib_free(struct amdgpu_device *adev, struct amdgpu_ib *ib,
 425                     struct dma_fence *f);
 426 int amdgpu_ib_schedule(struct amdgpu_ring *ring, unsigned num_ibs,
 427                        struct amdgpu_ib *ibs, struct amdgpu_job *job,
 428                        struct dma_fence **f);
 429 int amdgpu_ib_pool_init(struct amdgpu_device *adev);
 430 void amdgpu_ib_pool_fini(struct amdgpu_device *adev);
 431 int amdgpu_ib_ring_tests(struct amdgpu_device *adev);
 432
 433 #endif