drm/amdgpu: move debugfs functions to their own file
[platform/kernel/linux-starfive.git] / drivers / gpu / drm / amd / amdgpu / amdgpu.h
1 /*
2  * Copyright 2008 Advanced Micro Devices, Inc.
3  * Copyright 2008 Red Hat Inc.
4  * Copyright 2009 Jerome Glisse.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: Dave Airlie
25  *          Alex Deucher
26  *          Jerome Glisse
27  */
28 #ifndef __AMDGPU_H__
29 #define __AMDGPU_H__
30
31 #include <linux/atomic.h>
32 #include <linux/wait.h>
33 #include <linux/list.h>
34 #include <linux/kref.h>
35 #include <linux/rbtree.h>
36 #include <linux/hashtable.h>
37 #include <linux/dma-fence.h>
38
39 #include <drm/ttm/ttm_bo_api.h>
40 #include <drm/ttm/ttm_bo_driver.h>
41 #include <drm/ttm/ttm_placement.h>
42 #include <drm/ttm/ttm_module.h>
43 #include <drm/ttm/ttm_execbuf_util.h>
44
45 #include <drm/drmP.h>
46 #include <drm/drm_gem.h>
47 #include <drm/amdgpu_drm.h>
48 #include <drm/gpu_scheduler.h>
49
50 #include <kgd_kfd_interface.h>
51 #include "dm_pp_interface.h"
52 #include "kgd_pp_interface.h"
53
54 #include "amd_shared.h"
55 #include "amdgpu_mode.h"
56 #include "amdgpu_ih.h"
57 #include "amdgpu_irq.h"
58 #include "amdgpu_ucode.h"
59 #include "amdgpu_ttm.h"
60 #include "amdgpu_psp.h"
61 #include "amdgpu_gds.h"
62 #include "amdgpu_sync.h"
63 #include "amdgpu_ring.h"
64 #include "amdgpu_vm.h"
65 #include "amdgpu_dpm.h"
66 #include "amdgpu_acp.h"
67 #include "amdgpu_uvd.h"
68 #include "amdgpu_vce.h"
69 #include "amdgpu_vcn.h"
70 #include "amdgpu_mn.h"
71 #include "amdgpu_dm.h"
72 #include "amdgpu_virt.h"
73 #include "amdgpu_gart.h"
74 #include "amdgpu_debugfs.h"
75
76 /*
77  * Modules parameters.
78  */
79 extern int amdgpu_modeset;
80 extern int amdgpu_vram_limit;
81 extern int amdgpu_vis_vram_limit;
82 extern int amdgpu_gart_size;
83 extern int amdgpu_gtt_size;
84 extern int amdgpu_moverate;
85 extern int amdgpu_benchmarking;
86 extern int amdgpu_testing;
87 extern int amdgpu_audio;
88 extern int amdgpu_disp_priority;
89 extern int amdgpu_hw_i2c;
90 extern int amdgpu_pcie_gen2;
91 extern int amdgpu_msi;
92 extern int amdgpu_lockup_timeout;
93 extern int amdgpu_dpm;
94 extern int amdgpu_fw_load_type;
95 extern int amdgpu_aspm;
96 extern int amdgpu_runtime_pm;
97 extern uint amdgpu_ip_block_mask;
98 extern int amdgpu_bapm;
99 extern int amdgpu_deep_color;
100 extern int amdgpu_vm_size;
101 extern int amdgpu_vm_block_size;
102 extern int amdgpu_vm_fragment_size;
103 extern int amdgpu_vm_fault_stop;
104 extern int amdgpu_vm_debug;
105 extern int amdgpu_vm_update_mode;
106 extern int amdgpu_dc;
107 extern int amdgpu_dc_log;
108 extern int amdgpu_sched_jobs;
109 extern int amdgpu_sched_hw_submission;
110 extern int amdgpu_no_evict;
111 extern int amdgpu_direct_gma_size;
112 extern uint amdgpu_pcie_gen_cap;
113 extern uint amdgpu_pcie_lane_cap;
114 extern uint amdgpu_cg_mask;
115 extern uint amdgpu_pg_mask;
116 extern uint amdgpu_sdma_phase_quantum;
117 extern char *amdgpu_disable_cu;
118 extern char *amdgpu_virtual_display;
119 extern uint amdgpu_pp_feature_mask;
120 extern int amdgpu_vram_page_split;
121 extern int amdgpu_ngg;
122 extern int amdgpu_prim_buf_per_se;
123 extern int amdgpu_pos_buf_per_se;
124 extern int amdgpu_cntl_sb_buf_per_se;
125 extern int amdgpu_param_buf_per_se;
126 extern int amdgpu_job_hang_limit;
127 extern int amdgpu_lbpw;
128 extern int amdgpu_compute_multipipe;
129 extern int amdgpu_gpu_recovery;
130
131 #ifdef CONFIG_DRM_AMDGPU_SI
132 extern int amdgpu_si_support;
133 #endif
134 #ifdef CONFIG_DRM_AMDGPU_CIK
135 extern int amdgpu_cik_support;
136 #endif
137
138 #define AMDGPU_DEFAULT_GTT_SIZE_MB              3072ULL /* 3GB by default */
139 #define AMDGPU_WAIT_IDLE_TIMEOUT_IN_MS          3000
140 #define AMDGPU_MAX_USEC_TIMEOUT                 100000  /* 100 ms */
141 #define AMDGPU_FENCE_JIFFIES_TIMEOUT            (HZ / 2)
142 /* AMDGPU_IB_POOL_SIZE must be a power of 2 */
143 #define AMDGPU_IB_POOL_SIZE                     16
144 #define AMDGPU_DEBUGFS_MAX_COMPONENTS           32
145 #define AMDGPUFB_CONN_LIMIT                     4
146 #define AMDGPU_BIOS_NUM_SCRATCH                 16
147
148 /* max number of IP instances */
149 #define AMDGPU_MAX_SDMA_INSTANCES               2
150
151 /* hard reset data */
152 #define AMDGPU_ASIC_RESET_DATA                  0x39d5e86b
153
154 /* reset flags */
155 #define AMDGPU_RESET_GFX                        (1 << 0)
156 #define AMDGPU_RESET_COMPUTE                    (1 << 1)
157 #define AMDGPU_RESET_DMA                        (1 << 2)
158 #define AMDGPU_RESET_CP                         (1 << 3)
159 #define AMDGPU_RESET_GRBM                       (1 << 4)
160 #define AMDGPU_RESET_DMA1                       (1 << 5)
161 #define AMDGPU_RESET_RLC                        (1 << 6)
162 #define AMDGPU_RESET_SEM                        (1 << 7)
163 #define AMDGPU_RESET_IH                         (1 << 8)
164 #define AMDGPU_RESET_VMC                        (1 << 9)
165 #define AMDGPU_RESET_MC                         (1 << 10)
166 #define AMDGPU_RESET_DISPLAY                    (1 << 11)
167 #define AMDGPU_RESET_UVD                        (1 << 12)
168 #define AMDGPU_RESET_VCE                        (1 << 13)
169 #define AMDGPU_RESET_VCE1                       (1 << 14)
170
171 /* GFX current status */
172 #define AMDGPU_GFX_NORMAL_MODE                  0x00000000L
173 #define AMDGPU_GFX_SAFE_MODE                    0x00000001L
174 #define AMDGPU_GFX_PG_DISABLED_MODE             0x00000002L
175 #define AMDGPU_GFX_CG_DISABLED_MODE             0x00000004L
176 #define AMDGPU_GFX_LBPW_DISABLED_MODE           0x00000008L
177
178 /* max cursor sizes (in pixels) */
179 #define CIK_CURSOR_WIDTH 128
180 #define CIK_CURSOR_HEIGHT 128
181
182 /* GPU RESET flags */
183 #define AMDGPU_RESET_INFO_VRAM_LOST  (1 << 0)
184 #define AMDGPU_RESET_INFO_FULLRESET  (1 << 1)
185
186 struct amdgpu_device;
187 struct amdgpu_ib;
188 struct amdgpu_cs_parser;
189 struct amdgpu_job;
190 struct amdgpu_irq_src;
191 struct amdgpu_fpriv;
192 struct amdgpu_bo_va_mapping;
193
194 enum amdgpu_cp_irq {
195         AMDGPU_CP_IRQ_GFX_EOP = 0,
196         AMDGPU_CP_IRQ_COMPUTE_MEC1_PIPE0_EOP,
197         AMDGPU_CP_IRQ_COMPUTE_MEC1_PIPE1_EOP,
198         AMDGPU_CP_IRQ_COMPUTE_MEC1_PIPE2_EOP,
199         AMDGPU_CP_IRQ_COMPUTE_MEC1_PIPE3_EOP,
200         AMDGPU_CP_IRQ_COMPUTE_MEC2_PIPE0_EOP,
201         AMDGPU_CP_IRQ_COMPUTE_MEC2_PIPE1_EOP,
202         AMDGPU_CP_IRQ_COMPUTE_MEC2_PIPE2_EOP,
203         AMDGPU_CP_IRQ_COMPUTE_MEC2_PIPE3_EOP,
204
205         AMDGPU_CP_IRQ_LAST
206 };
207
208 enum amdgpu_sdma_irq {
209         AMDGPU_SDMA_IRQ_TRAP0 = 0,
210         AMDGPU_SDMA_IRQ_TRAP1,
211
212         AMDGPU_SDMA_IRQ_LAST
213 };
214
215 enum amdgpu_thermal_irq {
216         AMDGPU_THERMAL_IRQ_LOW_TO_HIGH = 0,
217         AMDGPU_THERMAL_IRQ_HIGH_TO_LOW,
218
219         AMDGPU_THERMAL_IRQ_LAST
220 };
221
222 enum amdgpu_kiq_irq {
223         AMDGPU_CP_KIQ_IRQ_DRIVER0 = 0,
224         AMDGPU_CP_KIQ_IRQ_LAST
225 };
226
227 int amdgpu_set_clockgating_state(struct amdgpu_device *adev,
228                                   enum amd_ip_block_type block_type,
229                                   enum amd_clockgating_state state);
230 int amdgpu_set_powergating_state(struct amdgpu_device *adev,
231                                   enum amd_ip_block_type block_type,
232                                   enum amd_powergating_state state);
233 void amdgpu_get_clockgating_state(struct amdgpu_device *adev, u32 *flags);
234 int amdgpu_wait_for_idle(struct amdgpu_device *adev,
235                          enum amd_ip_block_type block_type);
236 bool amdgpu_is_idle(struct amdgpu_device *adev,
237                     enum amd_ip_block_type block_type);
238
239 #define AMDGPU_MAX_IP_NUM 16
240
241 struct amdgpu_ip_block_status {
242         bool valid;
243         bool sw;
244         bool hw;
245         bool late_initialized;
246         bool hang;
247 };
248
249 struct amdgpu_ip_block_version {
250         const enum amd_ip_block_type type;
251         const u32 major;
252         const u32 minor;
253         const u32 rev;
254         const struct amd_ip_funcs *funcs;
255 };
256
257 struct amdgpu_ip_block {
258         struct amdgpu_ip_block_status status;
259         const struct amdgpu_ip_block_version *version;
260 };
261
262 int amdgpu_ip_block_version_cmp(struct amdgpu_device *adev,
263                                 enum amd_ip_block_type type,
264                                 u32 major, u32 minor);
265
266 struct amdgpu_ip_block * amdgpu_get_ip_block(struct amdgpu_device *adev,
267                                              enum amd_ip_block_type type);
268
269 int amdgpu_ip_block_add(struct amdgpu_device *adev,
270                         const struct amdgpu_ip_block_version *ip_block_version);
271
272 /* provided by hw blocks that can move/clear data.  e.g., gfx or sdma */
273 struct amdgpu_buffer_funcs {
274         /* maximum bytes in a single operation */
275         uint32_t        copy_max_bytes;
276
277         /* number of dw to reserve per operation */
278         unsigned        copy_num_dw;
279
280         /* used for buffer migration */
281         void (*emit_copy_buffer)(struct amdgpu_ib *ib,
282                                  /* src addr in bytes */
283                                  uint64_t src_offset,
284                                  /* dst addr in bytes */
285                                  uint64_t dst_offset,
286                                  /* number of byte to transfer */
287                                  uint32_t byte_count);
288
289         /* maximum bytes in a single operation */
290         uint32_t        fill_max_bytes;
291
292         /* number of dw to reserve per operation */
293         unsigned        fill_num_dw;
294
295         /* used for buffer clearing */
296         void (*emit_fill_buffer)(struct amdgpu_ib *ib,
297                                  /* value to write to memory */
298                                  uint32_t src_data,
299                                  /* dst addr in bytes */
300                                  uint64_t dst_offset,
301                                  /* number of byte to fill */
302                                  uint32_t byte_count);
303 };
304
305 /* provided by hw blocks that can write ptes, e.g., sdma */
306 struct amdgpu_vm_pte_funcs {
307         /* number of dw to reserve per operation */
308         unsigned        copy_pte_num_dw;
309
310         /* copy pte entries from GART */
311         void (*copy_pte)(struct amdgpu_ib *ib,
312                          uint64_t pe, uint64_t src,
313                          unsigned count);
314
315         /* write pte one entry at a time with addr mapping */
316         void (*write_pte)(struct amdgpu_ib *ib, uint64_t pe,
317                           uint64_t value, unsigned count,
318                           uint32_t incr);
319
320         /* maximum nums of PTEs/PDEs in a single operation */
321         uint32_t        set_max_nums_pte_pde;
322
323         /* number of dw to reserve per operation */
324         unsigned        set_pte_pde_num_dw;
325
326         /* for linear pte/pde updates without addr mapping */
327         void (*set_pte_pde)(struct amdgpu_ib *ib,
328                             uint64_t pe,
329                             uint64_t addr, unsigned count,
330                             uint32_t incr, uint64_t flags);
331 };
332
333 /* provided by the gmc block */
334 struct amdgpu_gart_funcs {
335         /* flush the vm tlb via mmio */
336         void (*flush_gpu_tlb)(struct amdgpu_device *adev,
337                               uint32_t vmid);
338         /* write pte/pde updates using the cpu */
339         int (*set_pte_pde)(struct amdgpu_device *adev,
340                            void *cpu_pt_addr, /* cpu addr of page table */
341                            uint32_t gpu_page_idx, /* pte/pde to update */
342                            uint64_t addr, /* addr to write into pte/pde */
343                            uint64_t flags); /* access flags */
344         /* enable/disable PRT support */
345         void (*set_prt)(struct amdgpu_device *adev, bool enable);
346         /* set pte flags based per asic */
347         uint64_t (*get_vm_pte_flags)(struct amdgpu_device *adev,
348                                      uint32_t flags);
349         /* get the pde for a given mc addr */
350         void (*get_vm_pde)(struct amdgpu_device *adev, int level,
351                            u64 *dst, u64 *flags);
352         uint32_t (*get_invalidate_req)(unsigned int vm_id);
353 };
354
355 /* provided by the ih block */
356 struct amdgpu_ih_funcs {
357         /* ring read/write ptr handling, called from interrupt context */
358         u32 (*get_wptr)(struct amdgpu_device *adev);
359         bool (*prescreen_iv)(struct amdgpu_device *adev);
360         void (*decode_iv)(struct amdgpu_device *adev,
361                           struct amdgpu_iv_entry *entry);
362         void (*set_rptr)(struct amdgpu_device *adev);
363 };
364
365 /*
366  * BIOS.
367  */
368 bool amdgpu_get_bios(struct amdgpu_device *adev);
369 bool amdgpu_read_bios(struct amdgpu_device *adev);
370
371 /*
372  * Dummy page
373  */
374 struct amdgpu_dummy_page {
375         struct page     *page;
376         dma_addr_t      addr;
377 };
378 int amdgpu_dummy_page_init(struct amdgpu_device *adev);
379 void amdgpu_dummy_page_fini(struct amdgpu_device *adev);
380
381
382 /*
383  * Clocks
384  */
385
386 #define AMDGPU_MAX_PPLL 3
387
388 struct amdgpu_clock {
389         struct amdgpu_pll ppll[AMDGPU_MAX_PPLL];
390         struct amdgpu_pll spll;
391         struct amdgpu_pll mpll;
392         /* 10 Khz units */
393         uint32_t default_mclk;
394         uint32_t default_sclk;
395         uint32_t default_dispclk;
396         uint32_t current_dispclk;
397         uint32_t dp_extclk;
398         uint32_t max_pixel_clock;
399 };
400
401 /*
402  * GEM.
403  */
404
405 #define AMDGPU_GEM_DOMAIN_MAX           0x3
406 #define gem_to_amdgpu_bo(gobj) container_of((gobj), struct amdgpu_bo, gem_base)
407
408 void amdgpu_gem_object_free(struct drm_gem_object *obj);
409 int amdgpu_gem_object_open(struct drm_gem_object *obj,
410                                 struct drm_file *file_priv);
411 void amdgpu_gem_object_close(struct drm_gem_object *obj,
412                                 struct drm_file *file_priv);
413 unsigned long amdgpu_gem_timeout(uint64_t timeout_ns);
414 struct sg_table *amdgpu_gem_prime_get_sg_table(struct drm_gem_object *obj);
415 struct drm_gem_object *
416 amdgpu_gem_prime_import_sg_table(struct drm_device *dev,
417                                  struct dma_buf_attachment *attach,
418                                  struct sg_table *sg);
419 struct dma_buf *amdgpu_gem_prime_export(struct drm_device *dev,
420                                         struct drm_gem_object *gobj,
421                                         int flags);
422 int amdgpu_gem_prime_pin(struct drm_gem_object *obj);
423 void amdgpu_gem_prime_unpin(struct drm_gem_object *obj);
424 struct reservation_object *amdgpu_gem_prime_res_obj(struct drm_gem_object *);
425 void *amdgpu_gem_prime_vmap(struct drm_gem_object *obj);
426 void amdgpu_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
427 int amdgpu_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
428
429 /* sub-allocation manager, it has to be protected by another lock.
430  * By conception this is an helper for other part of the driver
431  * like the indirect buffer or semaphore, which both have their
432  * locking.
433  *
434  * Principe is simple, we keep a list of sub allocation in offset
435  * order (first entry has offset == 0, last entry has the highest
436  * offset).
437  *
438  * When allocating new object we first check if there is room at
439  * the end total_size - (last_object_offset + last_object_size) >=
440  * alloc_size. If so we allocate new object there.
441  *
442  * When there is not enough room at the end, we start waiting for
443  * each sub object until we reach object_offset+object_size >=
444  * alloc_size, this object then become the sub object we return.
445  *
446  * Alignment can't be bigger than page size.
447  *
448  * Hole are not considered for allocation to keep things simple.
449  * Assumption is that there won't be hole (all object on same
450  * alignment).
451  */
452
453 #define AMDGPU_SA_NUM_FENCE_LISTS       32
454
455 struct amdgpu_sa_manager {
456         wait_queue_head_t       wq;
457         struct amdgpu_bo        *bo;
458         struct list_head        *hole;
459         struct list_head        flist[AMDGPU_SA_NUM_FENCE_LISTS];
460         struct list_head        olist;
461         unsigned                size;
462         uint64_t                gpu_addr;
463         void                    *cpu_ptr;
464         uint32_t                domain;
465         uint32_t                align;
466 };
467
468 /* sub-allocation buffer */
469 struct amdgpu_sa_bo {
470         struct list_head                olist;
471         struct list_head                flist;
472         struct amdgpu_sa_manager        *manager;
473         unsigned                        soffset;
474         unsigned                        eoffset;
475         struct dma_fence                *fence;
476 };
477
478 /*
479  * GEM objects.
480  */
481 void amdgpu_gem_force_release(struct amdgpu_device *adev);
482 int amdgpu_gem_object_create(struct amdgpu_device *adev, unsigned long size,
483                              int alignment, u32 initial_domain,
484                              u64 flags, bool kernel,
485                              struct reservation_object *resv,
486                              struct drm_gem_object **obj);
487
488 int amdgpu_mode_dumb_create(struct drm_file *file_priv,
489                             struct drm_device *dev,
490                             struct drm_mode_create_dumb *args);
491 int amdgpu_mode_dumb_mmap(struct drm_file *filp,
492                           struct drm_device *dev,
493                           uint32_t handle, uint64_t *offset_p);
494 int amdgpu_fence_slab_init(void);
495 void amdgpu_fence_slab_fini(void);
496
497 /*
498  * VMHUB structures, functions & helpers
499  */
500 struct amdgpu_vmhub {
501         uint32_t        ctx0_ptb_addr_lo32;
502         uint32_t        ctx0_ptb_addr_hi32;
503         uint32_t        vm_inv_eng0_req;
504         uint32_t        vm_inv_eng0_ack;
505         uint32_t        vm_context0_cntl;
506         uint32_t        vm_l2_pro_fault_status;
507         uint32_t        vm_l2_pro_fault_cntl;
508 };
509
510 /*
511  * GPU MC structures, functions & helpers
512  */
513 struct amdgpu_mc {
514         resource_size_t         aper_size;
515         resource_size_t         aper_base;
516         resource_size_t         agp_base;
517         /* for some chips with <= 32MB we need to lie
518          * about vram size near mc fb location */
519         u64                     mc_vram_size;
520         u64                     visible_vram_size;
521         u64                     gart_size;
522         u64                     gart_start;
523         u64                     gart_end;
524         u64                     vram_start;
525         u64                     vram_end;
526         unsigned                vram_width;
527         u64                     real_vram_size;
528         int                     vram_mtrr;
529         u64                     mc_mask;
530         const struct firmware   *fw;    /* MC firmware */
531         uint32_t                fw_version;
532         struct amdgpu_irq_src   vm_fault;
533         uint32_t                vram_type;
534         uint32_t                srbm_soft_reset;
535         bool                    prt_warning;
536         uint64_t                stolen_size;
537         /* apertures */
538         u64                                     shared_aperture_start;
539         u64                                     shared_aperture_end;
540         u64                                     private_aperture_start;
541         u64                                     private_aperture_end;
542         /* protects concurrent invalidation */
543         spinlock_t              invalidate_lock;
544 };
545
546 /*
547  * GPU doorbell structures, functions & helpers
548  */
549 typedef enum _AMDGPU_DOORBELL_ASSIGNMENT
550 {
551         AMDGPU_DOORBELL_KIQ                     = 0x000,
552         AMDGPU_DOORBELL_HIQ                     = 0x001,
553         AMDGPU_DOORBELL_DIQ                     = 0x002,
554         AMDGPU_DOORBELL_MEC_RING0               = 0x010,
555         AMDGPU_DOORBELL_MEC_RING1               = 0x011,
556         AMDGPU_DOORBELL_MEC_RING2               = 0x012,
557         AMDGPU_DOORBELL_MEC_RING3               = 0x013,
558         AMDGPU_DOORBELL_MEC_RING4               = 0x014,
559         AMDGPU_DOORBELL_MEC_RING5               = 0x015,
560         AMDGPU_DOORBELL_MEC_RING6               = 0x016,
561         AMDGPU_DOORBELL_MEC_RING7               = 0x017,
562         AMDGPU_DOORBELL_GFX_RING0               = 0x020,
563         AMDGPU_DOORBELL_sDMA_ENGINE0            = 0x1E0,
564         AMDGPU_DOORBELL_sDMA_ENGINE1            = 0x1E1,
565         AMDGPU_DOORBELL_IH                      = 0x1E8,
566         AMDGPU_DOORBELL_MAX_ASSIGNMENT          = 0x3FF,
567         AMDGPU_DOORBELL_INVALID                 = 0xFFFF
568 } AMDGPU_DOORBELL_ASSIGNMENT;
569
570 struct amdgpu_doorbell {
571         /* doorbell mmio */
572         resource_size_t         base;
573         resource_size_t         size;
574         u32 __iomem             *ptr;
575         u32                     num_doorbells;  /* Number of doorbells actually reserved for amdgpu. */
576 };
577
578 /*
579  * 64bit doorbell, offset are in QWORD, occupy 2KB doorbell space
580  */
581 typedef enum _AMDGPU_DOORBELL64_ASSIGNMENT
582 {
583         /*
584          * All compute related doorbells: kiq, hiq, diq, traditional compute queue, user queue, should locate in
585          * a continues range so that programming CP_MEC_DOORBELL_RANGE_LOWER/UPPER can cover this range.
586          *  Compute related doorbells are allocated from 0x00 to 0x8a
587          */
588
589
590         /* kernel scheduling */
591         AMDGPU_DOORBELL64_KIQ                     = 0x00,
592
593         /* HSA interface queue and debug queue */
594         AMDGPU_DOORBELL64_HIQ                     = 0x01,
595         AMDGPU_DOORBELL64_DIQ                     = 0x02,
596
597         /* Compute engines */
598         AMDGPU_DOORBELL64_MEC_RING0               = 0x03,
599         AMDGPU_DOORBELL64_MEC_RING1               = 0x04,
600         AMDGPU_DOORBELL64_MEC_RING2               = 0x05,
601         AMDGPU_DOORBELL64_MEC_RING3               = 0x06,
602         AMDGPU_DOORBELL64_MEC_RING4               = 0x07,
603         AMDGPU_DOORBELL64_MEC_RING5               = 0x08,
604         AMDGPU_DOORBELL64_MEC_RING6               = 0x09,
605         AMDGPU_DOORBELL64_MEC_RING7               = 0x0a,
606
607         /* User queue doorbell range (128 doorbells) */
608         AMDGPU_DOORBELL64_USERQUEUE_START         = 0x0b,
609         AMDGPU_DOORBELL64_USERQUEUE_END           = 0x8a,
610
611         /* Graphics engine */
612         AMDGPU_DOORBELL64_GFX_RING0               = 0x8b,
613
614         /*
615          * Other graphics doorbells can be allocated here: from 0x8c to 0xef
616          * Graphics voltage island aperture 1
617          * default non-graphics QWORD index is 0xF0 - 0xFF inclusive
618          */
619
620         /* sDMA engines */
621         AMDGPU_DOORBELL64_sDMA_ENGINE0            = 0xF0,
622         AMDGPU_DOORBELL64_sDMA_HI_PRI_ENGINE0     = 0xF1,
623         AMDGPU_DOORBELL64_sDMA_ENGINE1            = 0xF2,
624         AMDGPU_DOORBELL64_sDMA_HI_PRI_ENGINE1     = 0xF3,
625
626         /* Interrupt handler */
627         AMDGPU_DOORBELL64_IH                      = 0xF4,  /* For legacy interrupt ring buffer */
628         AMDGPU_DOORBELL64_IH_RING1                = 0xF5,  /* For page migration request log */
629         AMDGPU_DOORBELL64_IH_RING2                = 0xF6,  /* For page migration translation/invalidation log */
630
631         /* VCN engine use 32 bits doorbell  */
632         AMDGPU_DOORBELL64_VCN0_1                  = 0xF8, /* lower 32 bits for VNC0 and upper 32 bits for VNC1 */
633         AMDGPU_DOORBELL64_VCN2_3                  = 0xF9,
634         AMDGPU_DOORBELL64_VCN4_5                  = 0xFA,
635         AMDGPU_DOORBELL64_VCN6_7                  = 0xFB,
636
637         /* overlap the doorbell assignment with VCN as they are  mutually exclusive
638          * VCE engine's doorbell is 32 bit and two VCE ring share one QWORD
639          */
640         AMDGPU_DOORBELL64_UVD_RING0_1             = 0xF8,
641         AMDGPU_DOORBELL64_UVD_RING2_3             = 0xF9,
642         AMDGPU_DOORBELL64_UVD_RING4_5             = 0xFA,
643         AMDGPU_DOORBELL64_UVD_RING6_7             = 0xFB,
644
645         AMDGPU_DOORBELL64_VCE_RING0_1             = 0xFC,
646         AMDGPU_DOORBELL64_VCE_RING2_3             = 0xFD,
647         AMDGPU_DOORBELL64_VCE_RING4_5             = 0xFE,
648         AMDGPU_DOORBELL64_VCE_RING6_7             = 0xFF,
649
650         AMDGPU_DOORBELL64_MAX_ASSIGNMENT          = 0xFF,
651         AMDGPU_DOORBELL64_INVALID                 = 0xFFFF
652 } AMDGPU_DOORBELL64_ASSIGNMENT;
653
654
655 void amdgpu_doorbell_get_kfd_info(struct amdgpu_device *adev,
656                                 phys_addr_t *aperture_base,
657                                 size_t *aperture_size,
658                                 size_t *start_offset);
659
660 /*
661  * IRQS.
662  */
663
664 struct amdgpu_flip_work {
665         struct delayed_work             flip_work;
666         struct work_struct              unpin_work;
667         struct amdgpu_device            *adev;
668         int                             crtc_id;
669         u32                             target_vblank;
670         uint64_t                        base;
671         struct drm_pending_vblank_event *event;
672         struct amdgpu_bo                *old_abo;
673         struct dma_fence                *excl;
674         unsigned                        shared_count;
675         struct dma_fence                **shared;
676         struct dma_fence_cb             cb;
677         bool                            async;
678 };
679
680
681 /*
682  * CP & rings.
683  */
684
685 struct amdgpu_ib {
686         struct amdgpu_sa_bo             *sa_bo;
687         uint32_t                        length_dw;
688         uint64_t                        gpu_addr;
689         uint32_t                        *ptr;
690         uint32_t                        flags;
691 };
692
693 extern const struct drm_sched_backend_ops amdgpu_sched_ops;
694
695 int amdgpu_job_alloc(struct amdgpu_device *adev, unsigned num_ibs,
696                      struct amdgpu_job **job, struct amdgpu_vm *vm);
697 int amdgpu_job_alloc_with_ib(struct amdgpu_device *adev, unsigned size,
698                              struct amdgpu_job **job);
699
700 void amdgpu_job_free_resources(struct amdgpu_job *job);
701 void amdgpu_job_free(struct amdgpu_job *job);
702 int amdgpu_job_submit(struct amdgpu_job *job, struct amdgpu_ring *ring,
703                       struct drm_sched_entity *entity, void *owner,
704                       struct dma_fence **f);
705
706 /*
707  * Queue manager
708  */
709 struct amdgpu_queue_mapper {
710         int             hw_ip;
711         struct mutex    lock;
712         /* protected by lock */
713         struct amdgpu_ring *queue_map[AMDGPU_MAX_RINGS];
714 };
715
716 struct amdgpu_queue_mgr {
717         struct amdgpu_queue_mapper mapper[AMDGPU_MAX_IP_NUM];
718 };
719
720 int amdgpu_queue_mgr_init(struct amdgpu_device *adev,
721                           struct amdgpu_queue_mgr *mgr);
722 int amdgpu_queue_mgr_fini(struct amdgpu_device *adev,
723                           struct amdgpu_queue_mgr *mgr);
724 int amdgpu_queue_mgr_map(struct amdgpu_device *adev,
725                          struct amdgpu_queue_mgr *mgr,
726                          u32 hw_ip, u32 instance, u32 ring,
727                          struct amdgpu_ring **out_ring);
728
729 /*
730  * context related structures
731  */
732
733 struct amdgpu_ctx_ring {
734         uint64_t                sequence;
735         struct dma_fence        **fences;
736         struct drm_sched_entity entity;
737 };
738
739 struct amdgpu_ctx {
740         struct kref             refcount;
741         struct amdgpu_device    *adev;
742         struct amdgpu_queue_mgr queue_mgr;
743         unsigned                reset_counter;
744         unsigned        reset_counter_query;
745         uint32_t                vram_lost_counter;
746         spinlock_t              ring_lock;
747         struct dma_fence        **fences;
748         struct amdgpu_ctx_ring  rings[AMDGPU_MAX_RINGS];
749         bool                    preamble_presented;
750         enum drm_sched_priority init_priority;
751         enum drm_sched_priority override_priority;
752         struct mutex            lock;
753         atomic_t        guilty;
754 };
755
756 struct amdgpu_ctx_mgr {
757         struct amdgpu_device    *adev;
758         struct mutex            lock;
759         /* protected by lock */
760         struct idr              ctx_handles;
761 };
762
763 struct amdgpu_ctx *amdgpu_ctx_get(struct amdgpu_fpriv *fpriv, uint32_t id);
764 int amdgpu_ctx_put(struct amdgpu_ctx *ctx);
765
766 int amdgpu_ctx_add_fence(struct amdgpu_ctx *ctx, struct amdgpu_ring *ring,
767                               struct dma_fence *fence, uint64_t *seq);
768 struct dma_fence *amdgpu_ctx_get_fence(struct amdgpu_ctx *ctx,
769                                    struct amdgpu_ring *ring, uint64_t seq);
770 void amdgpu_ctx_priority_override(struct amdgpu_ctx *ctx,
771                                   enum drm_sched_priority priority);
772
773 int amdgpu_ctx_ioctl(struct drm_device *dev, void *data,
774                      struct drm_file *filp);
775
776 int amdgpu_ctx_wait_prev_fence(struct amdgpu_ctx *ctx, unsigned ring_id);
777
778 void amdgpu_ctx_mgr_init(struct amdgpu_ctx_mgr *mgr);
779 void amdgpu_ctx_mgr_fini(struct amdgpu_ctx_mgr *mgr);
780
781
782 /*
783  * file private structure
784  */
785
786 struct amdgpu_fpriv {
787         struct amdgpu_vm        vm;
788         struct amdgpu_bo_va     *prt_va;
789         struct amdgpu_bo_va     *csa_va;
790         struct mutex            bo_list_lock;
791         struct idr              bo_list_handles;
792         struct amdgpu_ctx_mgr   ctx_mgr;
793 };
794
795 /*
796  * residency list
797  */
798 struct amdgpu_bo_list_entry {
799         struct amdgpu_bo                *robj;
800         struct ttm_validate_buffer      tv;
801         struct amdgpu_bo_va             *bo_va;
802         uint32_t                        priority;
803         struct page                     **user_pages;
804         int                             user_invalidated;
805 };
806
807 struct amdgpu_bo_list {
808         struct mutex lock;
809         struct rcu_head rhead;
810         struct kref refcount;
811         struct amdgpu_bo *gds_obj;
812         struct amdgpu_bo *gws_obj;
813         struct amdgpu_bo *oa_obj;
814         unsigned first_userptr;
815         unsigned num_entries;
816         struct amdgpu_bo_list_entry *array;
817 };
818
819 struct amdgpu_bo_list *
820 amdgpu_bo_list_get(struct amdgpu_fpriv *fpriv, int id);
821 void amdgpu_bo_list_get_list(struct amdgpu_bo_list *list,
822                              struct list_head *validated);
823 void amdgpu_bo_list_put(struct amdgpu_bo_list *list);
824 void amdgpu_bo_list_free(struct amdgpu_bo_list *list);
825
826 /*
827  * GFX stuff
828  */
829 #include "clearstate_defs.h"
830
831 struct amdgpu_rlc_funcs {
832         void (*enter_safe_mode)(struct amdgpu_device *adev);
833         void (*exit_safe_mode)(struct amdgpu_device *adev);
834 };
835
836 struct amdgpu_rlc {
837         /* for power gating */
838         struct amdgpu_bo        *save_restore_obj;
839         uint64_t                save_restore_gpu_addr;
840         volatile uint32_t       *sr_ptr;
841         const u32               *reg_list;
842         u32                     reg_list_size;
843         /* for clear state */
844         struct amdgpu_bo        *clear_state_obj;
845         uint64_t                clear_state_gpu_addr;
846         volatile uint32_t       *cs_ptr;
847         const struct cs_section_def   *cs_data;
848         u32                     clear_state_size;
849         /* for cp tables */
850         struct amdgpu_bo        *cp_table_obj;
851         uint64_t                cp_table_gpu_addr;
852         volatile uint32_t       *cp_table_ptr;
853         u32                     cp_table_size;
854
855         /* safe mode for updating CG/PG state */
856         bool in_safe_mode;
857         const struct amdgpu_rlc_funcs *funcs;
858
859         /* for firmware data */
860         u32 save_and_restore_offset;
861         u32 clear_state_descriptor_offset;
862         u32 avail_scratch_ram_locations;
863         u32 reg_restore_list_size;
864         u32 reg_list_format_start;
865         u32 reg_list_format_separate_start;
866         u32 starting_offsets_start;
867         u32 reg_list_format_size_bytes;
868         u32 reg_list_size_bytes;
869
870         u32 *register_list_format;
871         u32 *register_restore;
872 };
873
874 #define AMDGPU_MAX_COMPUTE_QUEUES KGD_MAX_QUEUES
875
876 struct amdgpu_mec {
877         struct amdgpu_bo        *hpd_eop_obj;
878         u64                     hpd_eop_gpu_addr;
879         struct amdgpu_bo        *mec_fw_obj;
880         u64                     mec_fw_gpu_addr;
881         u32 num_mec;
882         u32 num_pipe_per_mec;
883         u32 num_queue_per_pipe;
884         void                    *mqd_backup[AMDGPU_MAX_COMPUTE_RINGS + 1];
885
886         /* These are the resources for which amdgpu takes ownership */
887         DECLARE_BITMAP(queue_bitmap, AMDGPU_MAX_COMPUTE_QUEUES);
888 };
889
890 struct amdgpu_kiq {
891         u64                     eop_gpu_addr;
892         struct amdgpu_bo        *eop_obj;
893         spinlock_t              ring_lock;
894         struct amdgpu_ring      ring;
895         struct amdgpu_irq_src   irq;
896 };
897
898 /*
899  * GPU scratch registers structures, functions & helpers
900  */
901 struct amdgpu_scratch {
902         unsigned                num_reg;
903         uint32_t                reg_base;
904         uint32_t                free_mask;
905 };
906
907 /*
908  * GFX configurations
909  */
910 #define AMDGPU_GFX_MAX_SE 4
911 #define AMDGPU_GFX_MAX_SH_PER_SE 2
912
913 struct amdgpu_rb_config {
914         uint32_t rb_backend_disable;
915         uint32_t user_rb_backend_disable;
916         uint32_t raster_config;
917         uint32_t raster_config_1;
918 };
919
920 struct gb_addr_config {
921         uint16_t pipe_interleave_size;
922         uint8_t num_pipes;
923         uint8_t max_compress_frags;
924         uint8_t num_banks;
925         uint8_t num_se;
926         uint8_t num_rb_per_se;
927 };
928
929 struct amdgpu_gfx_config {
930         unsigned max_shader_engines;
931         unsigned max_tile_pipes;
932         unsigned max_cu_per_sh;
933         unsigned max_sh_per_se;
934         unsigned max_backends_per_se;
935         unsigned max_texture_channel_caches;
936         unsigned max_gprs;
937         unsigned max_gs_threads;
938         unsigned max_hw_contexts;
939         unsigned sc_prim_fifo_size_frontend;
940         unsigned sc_prim_fifo_size_backend;
941         unsigned sc_hiz_tile_fifo_size;
942         unsigned sc_earlyz_tile_fifo_size;
943
944         unsigned num_tile_pipes;
945         unsigned backend_enable_mask;
946         unsigned mem_max_burst_length_bytes;
947         unsigned mem_row_size_in_kb;
948         unsigned shader_engine_tile_size;
949         unsigned num_gpus;
950         unsigned multi_gpu_tile_size;
951         unsigned mc_arb_ramcfg;
952         unsigned gb_addr_config;
953         unsigned num_rbs;
954         unsigned gs_vgt_table_depth;
955         unsigned gs_prim_buffer_depth;
956
957         uint32_t tile_mode_array[32];
958         uint32_t macrotile_mode_array[16];
959
960         struct gb_addr_config gb_addr_config_fields;
961         struct amdgpu_rb_config rb_config[AMDGPU_GFX_MAX_SE][AMDGPU_GFX_MAX_SH_PER_SE];
962
963         /* gfx configure feature */
964         uint32_t double_offchip_lds_buf;
965 };
966
967 struct amdgpu_cu_info {
968         uint32_t max_waves_per_simd;
969         uint32_t wave_front_size;
970         uint32_t max_scratch_slots_per_cu;
971         uint32_t lds_size;
972
973         /* total active CU number */
974         uint32_t number;
975         uint32_t ao_cu_mask;
976         uint32_t ao_cu_bitmap[4][4];
977         uint32_t bitmap[4][4];
978 };
979
980 struct amdgpu_gfx_funcs {
981         /* get the gpu clock counter */
982         uint64_t (*get_gpu_clock_counter)(struct amdgpu_device *adev);
983         void (*select_se_sh)(struct amdgpu_device *adev, u32 se_num, u32 sh_num, u32 instance);
984         void (*read_wave_data)(struct amdgpu_device *adev, uint32_t simd, uint32_t wave, uint32_t *dst, int *no_fields);
985         void (*read_wave_vgprs)(struct amdgpu_device *adev, uint32_t simd, uint32_t wave, uint32_t thread, uint32_t start, uint32_t size, uint32_t *dst);
986         void (*read_wave_sgprs)(struct amdgpu_device *adev, uint32_t simd, uint32_t wave, uint32_t start, uint32_t size, uint32_t *dst);
987 };
988
989 struct amdgpu_ngg_buf {
990         struct amdgpu_bo        *bo;
991         uint64_t                gpu_addr;
992         uint32_t                size;
993         uint32_t                bo_size;
994 };
995
996 enum {
997         NGG_PRIM = 0,
998         NGG_POS,
999         NGG_CNTL,
1000         NGG_PARAM,
1001         NGG_BUF_MAX
1002 };
1003
1004 struct amdgpu_ngg {
1005         struct amdgpu_ngg_buf   buf[NGG_BUF_MAX];
1006         uint32_t                gds_reserve_addr;
1007         uint32_t                gds_reserve_size;
1008         bool                    init;
1009 };
1010
1011 struct amdgpu_gfx {
1012         struct mutex                    gpu_clock_mutex;
1013         struct amdgpu_gfx_config        config;
1014         struct amdgpu_rlc               rlc;
1015         struct amdgpu_mec               mec;
1016         struct amdgpu_kiq               kiq;
1017         struct amdgpu_scratch           scratch;
1018         const struct firmware           *me_fw; /* ME firmware */
1019         uint32_t                        me_fw_version;
1020         const struct firmware           *pfp_fw; /* PFP firmware */
1021         uint32_t                        pfp_fw_version;
1022         const struct firmware           *ce_fw; /* CE firmware */
1023         uint32_t                        ce_fw_version;
1024         const struct firmware           *rlc_fw; /* RLC firmware */
1025         uint32_t                        rlc_fw_version;
1026         const struct firmware           *mec_fw; /* MEC firmware */
1027         uint32_t                        mec_fw_version;
1028         const struct firmware           *mec2_fw; /* MEC2 firmware */
1029         uint32_t                        mec2_fw_version;
1030         uint32_t                        me_feature_version;
1031         uint32_t                        ce_feature_version;
1032         uint32_t                        pfp_feature_version;
1033         uint32_t                        rlc_feature_version;
1034         uint32_t                        mec_feature_version;
1035         uint32_t                        mec2_feature_version;
1036         struct amdgpu_ring              gfx_ring[AMDGPU_MAX_GFX_RINGS];
1037         unsigned                        num_gfx_rings;
1038         struct amdgpu_ring              compute_ring[AMDGPU_MAX_COMPUTE_RINGS];
1039         unsigned                        num_compute_rings;
1040         struct amdgpu_irq_src           eop_irq;
1041         struct amdgpu_irq_src           priv_reg_irq;
1042         struct amdgpu_irq_src           priv_inst_irq;
1043         /* gfx status */
1044         uint32_t                        gfx_current_status;
1045         /* ce ram size*/
1046         unsigned                        ce_ram_size;
1047         struct amdgpu_cu_info           cu_info;
1048         const struct amdgpu_gfx_funcs   *funcs;
1049
1050         /* reset mask */
1051         uint32_t                        grbm_soft_reset;
1052         uint32_t                        srbm_soft_reset;
1053         /* s3/s4 mask */
1054         bool                            in_suspend;
1055         /* NGG */
1056         struct amdgpu_ngg               ngg;
1057
1058         /* pipe reservation */
1059         struct mutex                    pipe_reserve_mutex;
1060         DECLARE_BITMAP                  (pipe_reserve_bitmap, AMDGPU_MAX_COMPUTE_QUEUES);
1061 };
1062
1063 int amdgpu_ib_get(struct amdgpu_device *adev, struct amdgpu_vm *vm,
1064                   unsigned size, struct amdgpu_ib *ib);
1065 void amdgpu_ib_free(struct amdgpu_device *adev, struct amdgpu_ib *ib,
1066                     struct dma_fence *f);
1067 int amdgpu_ib_schedule(struct amdgpu_ring *ring, unsigned num_ibs,
1068                        struct amdgpu_ib *ibs, struct amdgpu_job *job,
1069                        struct dma_fence **f);
1070 int amdgpu_ib_pool_init(struct amdgpu_device *adev);
1071 void amdgpu_ib_pool_fini(struct amdgpu_device *adev);
1072 int amdgpu_ib_ring_tests(struct amdgpu_device *adev);
1073
1074 /*
1075  * CS.
1076  */
1077 struct amdgpu_cs_chunk {
1078         uint32_t                chunk_id;
1079         uint32_t                length_dw;
1080         void                    *kdata;
1081 };
1082
1083 struct amdgpu_cs_parser {
1084         struct amdgpu_device    *adev;
1085         struct drm_file         *filp;
1086         struct amdgpu_ctx       *ctx;
1087
1088         /* chunks */
1089         unsigned                nchunks;
1090         struct amdgpu_cs_chunk  *chunks;
1091
1092         /* scheduler job object */
1093         struct amdgpu_job       *job;
1094
1095         /* buffer objects */
1096         struct ww_acquire_ctx           ticket;
1097         struct amdgpu_bo_list           *bo_list;
1098         struct amdgpu_mn                *mn;
1099         struct amdgpu_bo_list_entry     vm_pd;
1100         struct list_head                validated;
1101         struct dma_fence                *fence;
1102         uint64_t                        bytes_moved_threshold;
1103         uint64_t                        bytes_moved_vis_threshold;
1104         uint64_t                        bytes_moved;
1105         uint64_t                        bytes_moved_vis;
1106         struct amdgpu_bo_list_entry     *evictable;
1107
1108         /* user fence */
1109         struct amdgpu_bo_list_entry     uf_entry;
1110
1111         unsigned num_post_dep_syncobjs;
1112         struct drm_syncobj **post_dep_syncobjs;
1113 };
1114
1115 #define AMDGPU_PREAMBLE_IB_PRESENT          (1 << 0) /* bit set means command submit involves a preamble IB */
1116 #define AMDGPU_PREAMBLE_IB_PRESENT_FIRST    (1 << 1) /* bit set means preamble IB is first presented in belonging context */
1117 #define AMDGPU_HAVE_CTX_SWITCH              (1 << 2) /* bit set means context switch occured */
1118
1119 struct amdgpu_job {
1120         struct drm_sched_job    base;
1121         struct amdgpu_device    *adev;
1122         struct amdgpu_vm        *vm;
1123         struct amdgpu_ring      *ring;
1124         struct amdgpu_sync      sync;
1125         struct amdgpu_sync      sched_sync;
1126         struct amdgpu_ib        *ibs;
1127         struct dma_fence        *fence; /* the hw fence */
1128         uint32_t                preamble_status;
1129         uint32_t                num_ibs;
1130         void                    *owner;
1131         uint64_t                fence_ctx; /* the fence_context this job uses */
1132         bool                    vm_needs_flush;
1133         unsigned                vm_id;
1134         uint64_t                vm_pd_addr;
1135         uint32_t                gds_base, gds_size;
1136         uint32_t                gws_base, gws_size;
1137         uint32_t                oa_base, oa_size;
1138         uint32_t                vram_lost_counter;
1139
1140         /* user fence handling */
1141         uint64_t                uf_addr;
1142         uint64_t                uf_sequence;
1143
1144 };
1145 #define to_amdgpu_job(sched_job)                \
1146                 container_of((sched_job), struct amdgpu_job, base)
1147
1148 static inline u32 amdgpu_get_ib_value(struct amdgpu_cs_parser *p,
1149                                       uint32_t ib_idx, int idx)
1150 {
1151         return p->job->ibs[ib_idx].ptr[idx];
1152 }
1153
1154 static inline void amdgpu_set_ib_value(struct amdgpu_cs_parser *p,
1155                                        uint32_t ib_idx, int idx,
1156                                        uint32_t value)
1157 {
1158         p->job->ibs[ib_idx].ptr[idx] = value;
1159 }
1160
1161 /*
1162  * Writeback
1163  */
1164 #define AMDGPU_MAX_WB 512       /* Reserve at most 512 WB slots for amdgpu-owned rings. */
1165
1166 struct amdgpu_wb {
1167         struct amdgpu_bo        *wb_obj;
1168         volatile uint32_t       *wb;
1169         uint64_t                gpu_addr;
1170         u32                     num_wb; /* Number of wb slots actually reserved for amdgpu. */
1171         unsigned long           used[DIV_ROUND_UP(AMDGPU_MAX_WB, BITS_PER_LONG)];
1172 };
1173
1174 int amdgpu_wb_get(struct amdgpu_device *adev, u32 *wb);
1175 void amdgpu_wb_free(struct amdgpu_device *adev, u32 wb);
1176
1177 void amdgpu_get_pcie_info(struct amdgpu_device *adev);
1178
1179 /*
1180  * SDMA
1181  */
1182 struct amdgpu_sdma_instance {
1183         /* SDMA firmware */
1184         const struct firmware   *fw;
1185         uint32_t                fw_version;
1186         uint32_t                feature_version;
1187
1188         struct amdgpu_ring      ring;
1189         bool                    burst_nop;
1190 };
1191
1192 struct amdgpu_sdma {
1193         struct amdgpu_sdma_instance instance[AMDGPU_MAX_SDMA_INSTANCES];
1194 #ifdef CONFIG_DRM_AMDGPU_SI
1195         //SI DMA has a difference trap irq number for the second engine
1196         struct amdgpu_irq_src   trap_irq_1;
1197 #endif
1198         struct amdgpu_irq_src   trap_irq;
1199         struct amdgpu_irq_src   illegal_inst_irq;
1200         int                     num_instances;
1201         uint32_t                    srbm_soft_reset;
1202 };
1203
1204 /*
1205  * Firmware
1206  */
1207 enum amdgpu_firmware_load_type {
1208         AMDGPU_FW_LOAD_DIRECT = 0,
1209         AMDGPU_FW_LOAD_SMU,
1210         AMDGPU_FW_LOAD_PSP,
1211 };
1212
1213 struct amdgpu_firmware {
1214         struct amdgpu_firmware_info ucode[AMDGPU_UCODE_ID_MAXIMUM];
1215         enum amdgpu_firmware_load_type load_type;
1216         struct amdgpu_bo *fw_buf;
1217         unsigned int fw_size;
1218         unsigned int max_ucodes;
1219         /* firmwares are loaded by psp instead of smu from vega10 */
1220         const struct amdgpu_psp_funcs *funcs;
1221         struct amdgpu_bo *rbuf;
1222         struct mutex mutex;
1223
1224         /* gpu info firmware data pointer */
1225         const struct firmware *gpu_info_fw;
1226
1227         void *fw_buf_ptr;
1228         uint64_t fw_buf_mc;
1229 };
1230
1231 /*
1232  * Benchmarking
1233  */
1234 void amdgpu_benchmark(struct amdgpu_device *adev, int test_number);
1235
1236
1237 /*
1238  * Testing
1239  */
1240 void amdgpu_test_moves(struct amdgpu_device *adev);
1241
1242
1243 /*
1244  * amdgpu smumgr functions
1245  */
1246 struct amdgpu_smumgr_funcs {
1247         int (*check_fw_load_finish)(struct amdgpu_device *adev, uint32_t fwtype);
1248         int (*request_smu_load_fw)(struct amdgpu_device *adev);
1249         int (*request_smu_specific_fw)(struct amdgpu_device *adev, uint32_t fwtype);
1250 };
1251
1252 /*
1253  * amdgpu smumgr
1254  */
1255 struct amdgpu_smumgr {
1256         struct amdgpu_bo *toc_buf;
1257         struct amdgpu_bo *smu_buf;
1258         /* asic priv smu data */
1259         void *priv;
1260         spinlock_t smu_lock;
1261         /* smumgr functions */
1262         const struct amdgpu_smumgr_funcs *smumgr_funcs;
1263         /* ucode loading complete flag */
1264         uint32_t fw_flags;
1265 };
1266
1267 /*
1268  * ASIC specific register table accessible by UMD
1269  */
1270 struct amdgpu_allowed_register_entry {
1271         uint32_t reg_offset;
1272         bool grbm_indexed;
1273 };
1274
1275 /*
1276  * ASIC specific functions.
1277  */
1278 struct amdgpu_asic_funcs {
1279         bool (*read_disabled_bios)(struct amdgpu_device *adev);
1280         bool (*read_bios_from_rom)(struct amdgpu_device *adev,
1281                                    u8 *bios, u32 length_bytes);
1282         int (*read_register)(struct amdgpu_device *adev, u32 se_num,
1283                              u32 sh_num, u32 reg_offset, u32 *value);
1284         void (*set_vga_state)(struct amdgpu_device *adev, bool state);
1285         int (*reset)(struct amdgpu_device *adev);
1286         /* get the reference clock */
1287         u32 (*get_xclk)(struct amdgpu_device *adev);
1288         /* MM block clocks */
1289         int (*set_uvd_clocks)(struct amdgpu_device *adev, u32 vclk, u32 dclk);
1290         int (*set_vce_clocks)(struct amdgpu_device *adev, u32 evclk, u32 ecclk);
1291         /* static power management */
1292         int (*get_pcie_lanes)(struct amdgpu_device *adev);
1293         void (*set_pcie_lanes)(struct amdgpu_device *adev, int lanes);
1294         /* get config memsize register */
1295         u32 (*get_config_memsize)(struct amdgpu_device *adev);
1296 };
1297
1298 /*
1299  * IOCTL.
1300  */
1301 int amdgpu_gem_create_ioctl(struct drm_device *dev, void *data,
1302                             struct drm_file *filp);
1303 int amdgpu_bo_list_ioctl(struct drm_device *dev, void *data,
1304                                 struct drm_file *filp);
1305
1306 int amdgpu_gem_info_ioctl(struct drm_device *dev, void *data,
1307                           struct drm_file *filp);
1308 int amdgpu_gem_userptr_ioctl(struct drm_device *dev, void *data,
1309                         struct drm_file *filp);
1310 int amdgpu_gem_mmap_ioctl(struct drm_device *dev, void *data,
1311                           struct drm_file *filp);
1312 int amdgpu_gem_wait_idle_ioctl(struct drm_device *dev, void *data,
1313                               struct drm_file *filp);
1314 int amdgpu_gem_va_ioctl(struct drm_device *dev, void *data,
1315                           struct drm_file *filp);
1316 int amdgpu_gem_op_ioctl(struct drm_device *dev, void *data,
1317                         struct drm_file *filp);
1318 int amdgpu_cs_ioctl(struct drm_device *dev, void *data, struct drm_file *filp);
1319 int amdgpu_cs_fence_to_handle_ioctl(struct drm_device *dev, void *data,
1320                                     struct drm_file *filp);
1321 int amdgpu_cs_wait_ioctl(struct drm_device *dev, void *data, struct drm_file *filp);
1322 int amdgpu_cs_wait_fences_ioctl(struct drm_device *dev, void *data,
1323                                 struct drm_file *filp);
1324
1325 int amdgpu_gem_metadata_ioctl(struct drm_device *dev, void *data,
1326                                 struct drm_file *filp);
1327
1328 /* VRAM scratch page for HDP bug, default vram page */
1329 struct amdgpu_vram_scratch {
1330         struct amdgpu_bo                *robj;
1331         volatile uint32_t               *ptr;
1332         u64                             gpu_addr;
1333 };
1334
1335 /*
1336  * ACPI
1337  */
1338 struct amdgpu_atif_notification_cfg {
1339         bool enabled;
1340         int command_code;
1341 };
1342
1343 struct amdgpu_atif_notifications {
1344         bool display_switch;
1345         bool expansion_mode_change;
1346         bool thermal_state;
1347         bool forced_power_state;
1348         bool system_power_state;
1349         bool display_conf_change;
1350         bool px_gfx_switch;
1351         bool brightness_change;
1352         bool dgpu_display_event;
1353 };
1354
1355 struct amdgpu_atif_functions {
1356         bool system_params;
1357         bool sbios_requests;
1358         bool select_active_disp;
1359         bool lid_state;
1360         bool get_tv_standard;
1361         bool set_tv_standard;
1362         bool get_panel_expansion_mode;
1363         bool set_panel_expansion_mode;
1364         bool temperature_change;
1365         bool graphics_device_types;
1366 };
1367
1368 struct amdgpu_atif {
1369         struct amdgpu_atif_notifications notifications;
1370         struct amdgpu_atif_functions functions;
1371         struct amdgpu_atif_notification_cfg notification_cfg;
1372         struct amdgpu_encoder *encoder_for_bl;
1373 };
1374
1375 struct amdgpu_atcs_functions {
1376         bool get_ext_state;
1377         bool pcie_perf_req;
1378         bool pcie_dev_rdy;
1379         bool pcie_bus_width;
1380 };
1381
1382 struct amdgpu_atcs {
1383         struct amdgpu_atcs_functions functions;
1384 };
1385
1386 /*
1387  * Firmware VRAM reservation
1388  */
1389 struct amdgpu_fw_vram_usage {
1390         u64 start_offset;
1391         u64 size;
1392         struct amdgpu_bo *reserved_bo;
1393         void *va;
1394 };
1395
1396 int amdgpu_fw_reserve_vram_init(struct amdgpu_device *adev);
1397 void amdgpu_fw_reserve_vram_fini(struct amdgpu_device *adev);
1398
1399 /*
1400  * CGS
1401  */
1402 struct cgs_device *amdgpu_cgs_create_device(struct amdgpu_device *adev);
1403 void amdgpu_cgs_destroy_device(struct cgs_device *cgs_device);
1404
1405 /*
1406  * Core structure, functions and helpers.
1407  */
1408 typedef uint32_t (*amdgpu_rreg_t)(struct amdgpu_device*, uint32_t);
1409 typedef void (*amdgpu_wreg_t)(struct amdgpu_device*, uint32_t, uint32_t);
1410
1411 typedef uint32_t (*amdgpu_block_rreg_t)(struct amdgpu_device*, uint32_t, uint32_t);
1412 typedef void (*amdgpu_block_wreg_t)(struct amdgpu_device*, uint32_t, uint32_t, uint32_t);
1413
1414
1415 /*
1416  * amdgpu nbio functions
1417  *
1418  */
1419 struct nbio_hdp_flush_reg {
1420         u32 ref_and_mask_cp0;
1421         u32 ref_and_mask_cp1;
1422         u32 ref_and_mask_cp2;
1423         u32 ref_and_mask_cp3;
1424         u32 ref_and_mask_cp4;
1425         u32 ref_and_mask_cp5;
1426         u32 ref_and_mask_cp6;
1427         u32 ref_and_mask_cp7;
1428         u32 ref_and_mask_cp8;
1429         u32 ref_and_mask_cp9;
1430         u32 ref_and_mask_sdma0;
1431         u32 ref_and_mask_sdma1;
1432 };
1433
1434 struct amdgpu_nbio_funcs {
1435         const struct nbio_hdp_flush_reg *hdp_flush_reg;
1436         u32 (*get_hdp_flush_req_offset)(struct amdgpu_device *adev);
1437         u32 (*get_hdp_flush_done_offset)(struct amdgpu_device *adev);
1438         u32 (*get_pcie_index_offset)(struct amdgpu_device *adev);
1439         u32 (*get_pcie_data_offset)(struct amdgpu_device *adev);
1440         u32 (*get_rev_id)(struct amdgpu_device *adev);
1441         void (*mc_access_enable)(struct amdgpu_device *adev, bool enable);
1442         void (*hdp_flush)(struct amdgpu_device *adev);
1443         u32 (*get_memsize)(struct amdgpu_device *adev);
1444         void (*sdma_doorbell_range)(struct amdgpu_device *adev, int instance,
1445                                     bool use_doorbell, int doorbell_index);
1446         void (*enable_doorbell_aperture)(struct amdgpu_device *adev,
1447                                          bool enable);
1448         void (*enable_doorbell_selfring_aperture)(struct amdgpu_device *adev,
1449                                                   bool enable);
1450         void (*ih_doorbell_range)(struct amdgpu_device *adev,
1451                                   bool use_doorbell, int doorbell_index);
1452         void (*update_medium_grain_clock_gating)(struct amdgpu_device *adev,
1453                                                  bool enable);
1454         void (*update_medium_grain_light_sleep)(struct amdgpu_device *adev,
1455                                                 bool enable);
1456         void (*get_clockgating_state)(struct amdgpu_device *adev,
1457                                       u32 *flags);
1458         void (*ih_control)(struct amdgpu_device *adev);
1459         void (*init_registers)(struct amdgpu_device *adev);
1460         void (*detect_hw_virt)(struct amdgpu_device *adev);
1461 };
1462
1463
1464 /* Define the HW IP blocks will be used in driver , add more if necessary */
1465 enum amd_hw_ip_block_type {
1466         GC_HWIP = 1,
1467         HDP_HWIP,
1468         SDMA0_HWIP,
1469         SDMA1_HWIP,
1470         MMHUB_HWIP,
1471         ATHUB_HWIP,
1472         NBIO_HWIP,
1473         MP0_HWIP,
1474         UVD_HWIP,
1475         VCN_HWIP = UVD_HWIP,
1476         VCE_HWIP,
1477         DF_HWIP,
1478         DCE_HWIP,
1479         OSSSYS_HWIP,
1480         SMUIO_HWIP,
1481         PWR_HWIP,
1482         NBIF_HWIP,
1483         MAX_HWIP
1484 };
1485
1486 #define HWIP_MAX_INSTANCE       6
1487
1488 struct amd_powerplay {
1489         struct cgs_device *cgs_device;
1490         void *pp_handle;
1491         const struct amd_ip_funcs *ip_funcs;
1492         const struct amd_pm_funcs *pp_funcs;
1493 };
1494
1495 #define AMDGPU_RESET_MAGIC_NUM 64
1496 struct amdgpu_device {
1497         struct device                   *dev;
1498         struct drm_device               *ddev;
1499         struct pci_dev                  *pdev;
1500
1501 #ifdef CONFIG_DRM_AMD_ACP
1502         struct amdgpu_acp               acp;
1503 #endif
1504
1505         /* ASIC */
1506         enum amd_asic_type              asic_type;
1507         uint32_t                        family;
1508         uint32_t                        rev_id;
1509         uint32_t                        external_rev_id;
1510         unsigned long                   flags;
1511         int                             usec_timeout;
1512         const struct amdgpu_asic_funcs  *asic_funcs;
1513         bool                            shutdown;
1514         bool                            need_dma32;
1515         bool                            accel_working;
1516         struct work_struct              reset_work;
1517         struct notifier_block           acpi_nb;
1518         struct amdgpu_i2c_chan          *i2c_bus[AMDGPU_MAX_I2C_BUS];
1519         struct amdgpu_debugfs           debugfs[AMDGPU_DEBUGFS_MAX_COMPONENTS];
1520         unsigned                        debugfs_count;
1521 #if defined(CONFIG_DEBUG_FS)
1522         struct dentry                   *debugfs_regs[AMDGPU_DEBUGFS_MAX_COMPONENTS];
1523 #endif
1524         struct amdgpu_atif              atif;
1525         struct amdgpu_atcs              atcs;
1526         struct mutex                    srbm_mutex;
1527         /* GRBM index mutex. Protects concurrent access to GRBM index */
1528         struct mutex                    grbm_idx_mutex;
1529         struct dev_pm_domain            vga_pm_domain;
1530         bool                            have_disp_power_ref;
1531
1532         /* BIOS */
1533         bool                            is_atom_fw;
1534         uint8_t                         *bios;
1535         uint32_t                        bios_size;
1536         struct amdgpu_bo                *stolen_vga_memory;
1537         uint32_t                        bios_scratch_reg_offset;
1538         uint32_t                        bios_scratch[AMDGPU_BIOS_NUM_SCRATCH];
1539
1540         /* Register/doorbell mmio */
1541         resource_size_t                 rmmio_base;
1542         resource_size_t                 rmmio_size;
1543         void __iomem                    *rmmio;
1544         /* protects concurrent MM_INDEX/DATA based register access */
1545         spinlock_t mmio_idx_lock;
1546         /* protects concurrent SMC based register access */
1547         spinlock_t smc_idx_lock;
1548         amdgpu_rreg_t                   smc_rreg;
1549         amdgpu_wreg_t                   smc_wreg;
1550         /* protects concurrent PCIE register access */
1551         spinlock_t pcie_idx_lock;
1552         amdgpu_rreg_t                   pcie_rreg;
1553         amdgpu_wreg_t                   pcie_wreg;
1554         amdgpu_rreg_t                   pciep_rreg;
1555         amdgpu_wreg_t                   pciep_wreg;
1556         /* protects concurrent UVD register access */
1557         spinlock_t uvd_ctx_idx_lock;
1558         amdgpu_rreg_t                   uvd_ctx_rreg;
1559         amdgpu_wreg_t                   uvd_ctx_wreg;
1560         /* protects concurrent DIDT register access */
1561         spinlock_t didt_idx_lock;
1562         amdgpu_rreg_t                   didt_rreg;
1563         amdgpu_wreg_t                   didt_wreg;
1564         /* protects concurrent gc_cac register access */
1565         spinlock_t gc_cac_idx_lock;
1566         amdgpu_rreg_t                   gc_cac_rreg;
1567         amdgpu_wreg_t                   gc_cac_wreg;
1568         /* protects concurrent se_cac register access */
1569         spinlock_t se_cac_idx_lock;
1570         amdgpu_rreg_t                   se_cac_rreg;
1571         amdgpu_wreg_t                   se_cac_wreg;
1572         /* protects concurrent ENDPOINT (audio) register access */
1573         spinlock_t audio_endpt_idx_lock;
1574         amdgpu_block_rreg_t             audio_endpt_rreg;
1575         amdgpu_block_wreg_t             audio_endpt_wreg;
1576         void __iomem                    *rio_mem;
1577         resource_size_t                 rio_mem_size;
1578         struct amdgpu_doorbell          doorbell;
1579
1580         /* clock/pll info */
1581         struct amdgpu_clock            clock;
1582
1583         /* MC */
1584         struct amdgpu_mc                mc;
1585         struct amdgpu_gart              gart;
1586         struct amdgpu_dummy_page        dummy_page;
1587         struct amdgpu_vm_manager        vm_manager;
1588         struct amdgpu_vmhub             vmhub[AMDGPU_MAX_VMHUBS];
1589
1590         /* memory management */
1591         struct amdgpu_mman              mman;
1592         struct amdgpu_vram_scratch      vram_scratch;
1593         struct amdgpu_wb                wb;
1594         atomic64_t                      num_bytes_moved;
1595         atomic64_t                      num_evictions;
1596         atomic64_t                      num_vram_cpu_page_faults;
1597         atomic_t                        gpu_reset_counter;
1598         atomic_t                        vram_lost_counter;
1599
1600         /* data for buffer migration throttling */
1601         struct {
1602                 spinlock_t              lock;
1603                 s64                     last_update_us;
1604                 s64                     accum_us; /* accumulated microseconds */
1605                 s64                     accum_us_vis; /* for visible VRAM */
1606                 u32                     log2_max_MBps;
1607         } mm_stats;
1608
1609         /* display */
1610         bool                            enable_virtual_display;
1611         struct amdgpu_mode_info         mode_info;
1612         /* For pre-DCE11. DCE11 and later are in "struct amdgpu_device->dm" */
1613         struct work_struct              hotplug_work;
1614         struct amdgpu_irq_src           crtc_irq;
1615         struct amdgpu_irq_src           pageflip_irq;
1616         struct amdgpu_irq_src           hpd_irq;
1617
1618         /* rings */
1619         u64                             fence_context;
1620         unsigned                        num_rings;
1621         struct amdgpu_ring              *rings[AMDGPU_MAX_RINGS];
1622         bool                            ib_pool_ready;
1623         struct amdgpu_sa_manager        ring_tmp_bo;
1624
1625         /* interrupts */
1626         struct amdgpu_irq               irq;
1627
1628         /* powerplay */
1629         struct amd_powerplay            powerplay;
1630         bool                            pp_force_state_enabled;
1631
1632         /* dpm */
1633         struct amdgpu_pm                pm;
1634         u32                             cg_flags;
1635         u32                             pg_flags;
1636
1637         /* amdgpu smumgr */
1638         struct amdgpu_smumgr smu;
1639
1640         /* gfx */
1641         struct amdgpu_gfx               gfx;
1642
1643         /* sdma */
1644         struct amdgpu_sdma              sdma;
1645
1646         /* uvd */
1647         struct amdgpu_uvd               uvd;
1648
1649         /* vce */
1650         struct amdgpu_vce               vce;
1651
1652         /* vcn */
1653         struct amdgpu_vcn               vcn;
1654
1655         /* firmwares */
1656         struct amdgpu_firmware          firmware;
1657
1658         /* PSP */
1659         struct psp_context              psp;
1660
1661         /* GDS */
1662         struct amdgpu_gds               gds;
1663
1664         /* display related functionality */
1665         struct amdgpu_display_manager dm;
1666
1667         struct amdgpu_ip_block          ip_blocks[AMDGPU_MAX_IP_NUM];
1668         int                             num_ip_blocks;
1669         struct mutex    mn_lock;
1670         DECLARE_HASHTABLE(mn_hash, 7);
1671
1672         /* tracking pinned memory */
1673         u64 vram_pin_size;
1674         u64 invisible_pin_size;
1675         u64 gart_pin_size;
1676
1677         /* amdkfd interface */
1678         struct kfd_dev          *kfd;
1679
1680         /* soc15 register offset based on ip, instance and  segment */
1681         uint32_t                *reg_offset[MAX_HWIP][HWIP_MAX_INSTANCE];
1682
1683         const struct amdgpu_nbio_funcs  *nbio_funcs;
1684
1685         /* delayed work_func for deferring clockgating during resume */
1686         struct delayed_work     late_init_work;
1687
1688         struct amdgpu_virt      virt;
1689         /* firmware VRAM reservation */
1690         struct amdgpu_fw_vram_usage fw_vram_usage;
1691
1692         /* link all shadow bo */
1693         struct list_head                shadow_list;
1694         struct mutex                    shadow_list_lock;
1695         /* keep an lru list of rings by HW IP */
1696         struct list_head                ring_lru_list;
1697         spinlock_t                      ring_lru_list_lock;
1698
1699         /* record hw reset is performed */
1700         bool has_hw_reset;
1701         u8                              reset_magic[AMDGPU_RESET_MAGIC_NUM];
1702
1703         /* record last mm index being written through WREG32*/
1704         unsigned long last_mm_index;
1705         bool                            in_gpu_reset;
1706         struct mutex  lock_reset;
1707 };
1708
1709 static inline struct amdgpu_device *amdgpu_ttm_adev(struct ttm_bo_device *bdev)
1710 {
1711         return container_of(bdev, struct amdgpu_device, mman.bdev);
1712 }
1713
1714 int amdgpu_device_init(struct amdgpu_device *adev,
1715                        struct drm_device *ddev,
1716                        struct pci_dev *pdev,
1717                        uint32_t flags);
1718 void amdgpu_device_fini(struct amdgpu_device *adev);
1719 int amdgpu_gpu_wait_for_idle(struct amdgpu_device *adev);
1720
1721 uint32_t amdgpu_mm_rreg(struct amdgpu_device *adev, uint32_t reg,
1722                         uint32_t acc_flags);
1723 void amdgpu_mm_wreg(struct amdgpu_device *adev, uint32_t reg, uint32_t v,
1724                     uint32_t acc_flags);
1725 u32 amdgpu_io_rreg(struct amdgpu_device *adev, u32 reg);
1726 void amdgpu_io_wreg(struct amdgpu_device *adev, u32 reg, u32 v);
1727
1728 u32 amdgpu_mm_rdoorbell(struct amdgpu_device *adev, u32 index);
1729 void amdgpu_mm_wdoorbell(struct amdgpu_device *adev, u32 index, u32 v);
1730 u64 amdgpu_mm_rdoorbell64(struct amdgpu_device *adev, u32 index);
1731 void amdgpu_mm_wdoorbell64(struct amdgpu_device *adev, u32 index, u64 v);
1732
1733 bool amdgpu_device_asic_has_dc_support(enum amd_asic_type asic_type);
1734 bool amdgpu_device_has_dc_support(struct amdgpu_device *adev);
1735
1736 /*
1737  * Registers read & write functions.
1738  */
1739
1740 #define AMDGPU_REGS_IDX       (1<<0)
1741 #define AMDGPU_REGS_NO_KIQ    (1<<1)
1742
1743 #define RREG32_NO_KIQ(reg) amdgpu_mm_rreg(adev, (reg), AMDGPU_REGS_NO_KIQ)
1744 #define WREG32_NO_KIQ(reg, v) amdgpu_mm_wreg(adev, (reg), (v), AMDGPU_REGS_NO_KIQ)
1745
1746 #define RREG32(reg) amdgpu_mm_rreg(adev, (reg), 0)
1747 #define RREG32_IDX(reg) amdgpu_mm_rreg(adev, (reg), AMDGPU_REGS_IDX)
1748 #define DREG32(reg) printk(KERN_INFO "REGISTER: " #reg " : 0x%08X\n", amdgpu_mm_rreg(adev, (reg), 0))
1749 #define WREG32(reg, v) amdgpu_mm_wreg(adev, (reg), (v), 0)
1750 #define WREG32_IDX(reg, v) amdgpu_mm_wreg(adev, (reg), (v), AMDGPU_REGS_IDX)
1751 #define REG_SET(FIELD, v) (((v) << FIELD##_SHIFT) & FIELD##_MASK)
1752 #define REG_GET(FIELD, v) (((v) << FIELD##_SHIFT) & FIELD##_MASK)
1753 #define RREG32_PCIE(reg) adev->pcie_rreg(adev, (reg))
1754 #define WREG32_PCIE(reg, v) adev->pcie_wreg(adev, (reg), (v))
1755 #define RREG32_PCIE_PORT(reg) adev->pciep_rreg(adev, (reg))
1756 #define WREG32_PCIE_PORT(reg, v) adev->pciep_wreg(adev, (reg), (v))
1757 #define RREG32_SMC(reg) adev->smc_rreg(adev, (reg))
1758 #define WREG32_SMC(reg, v) adev->smc_wreg(adev, (reg), (v))
1759 #define RREG32_UVD_CTX(reg) adev->uvd_ctx_rreg(adev, (reg))
1760 #define WREG32_UVD_CTX(reg, v) adev->uvd_ctx_wreg(adev, (reg), (v))
1761 #define RREG32_DIDT(reg) adev->didt_rreg(adev, (reg))
1762 #define WREG32_DIDT(reg, v) adev->didt_wreg(adev, (reg), (v))
1763 #define RREG32_GC_CAC(reg) adev->gc_cac_rreg(adev, (reg))
1764 #define WREG32_GC_CAC(reg, v) adev->gc_cac_wreg(adev, (reg), (v))
1765 #define RREG32_SE_CAC(reg) adev->se_cac_rreg(adev, (reg))
1766 #define WREG32_SE_CAC(reg, v) adev->se_cac_wreg(adev, (reg), (v))
1767 #define RREG32_AUDIO_ENDPT(block, reg) adev->audio_endpt_rreg(adev, (block), (reg))
1768 #define WREG32_AUDIO_ENDPT(block, reg, v) adev->audio_endpt_wreg(adev, (block), (reg), (v))
1769 #define WREG32_P(reg, val, mask)                                \
1770         do {                                                    \
1771                 uint32_t tmp_ = RREG32(reg);                    \
1772                 tmp_ &= (mask);                                 \
1773                 tmp_ |= ((val) & ~(mask));                      \
1774                 WREG32(reg, tmp_);                              \
1775         } while (0)
1776 #define WREG32_AND(reg, and) WREG32_P(reg, 0, and)
1777 #define WREG32_OR(reg, or) WREG32_P(reg, or, ~(or))
1778 #define WREG32_PLL_P(reg, val, mask)                            \
1779         do {                                                    \
1780                 uint32_t tmp_ = RREG32_PLL(reg);                \
1781                 tmp_ &= (mask);                                 \
1782                 tmp_ |= ((val) & ~(mask));                      \
1783                 WREG32_PLL(reg, tmp_);                          \
1784         } while (0)
1785 #define DREG32_SYS(sqf, adev, reg) seq_printf((sqf), #reg " : 0x%08X\n", amdgpu_mm_rreg((adev), (reg), false))
1786 #define RREG32_IO(reg) amdgpu_io_rreg(adev, (reg))
1787 #define WREG32_IO(reg, v) amdgpu_io_wreg(adev, (reg), (v))
1788
1789 #define RDOORBELL32(index) amdgpu_mm_rdoorbell(adev, (index))
1790 #define WDOORBELL32(index, v) amdgpu_mm_wdoorbell(adev, (index), (v))
1791 #define RDOORBELL64(index) amdgpu_mm_rdoorbell64(adev, (index))
1792 #define WDOORBELL64(index, v) amdgpu_mm_wdoorbell64(adev, (index), (v))
1793
1794 #define REG_FIELD_SHIFT(reg, field) reg##__##field##__SHIFT
1795 #define REG_FIELD_MASK(reg, field) reg##__##field##_MASK
1796
1797 #define REG_SET_FIELD(orig_val, reg, field, field_val)                  \
1798         (((orig_val) & ~REG_FIELD_MASK(reg, field)) |                   \
1799          (REG_FIELD_MASK(reg, field) & ((field_val) << REG_FIELD_SHIFT(reg, field))))
1800
1801 #define REG_GET_FIELD(value, reg, field)                                \
1802         (((value) & REG_FIELD_MASK(reg, field)) >> REG_FIELD_SHIFT(reg, field))
1803
1804 #define WREG32_FIELD(reg, field, val)   \
1805         WREG32(mm##reg, (RREG32(mm##reg) & ~REG_FIELD_MASK(reg, field)) | (val) << REG_FIELD_SHIFT(reg, field))
1806
1807 #define WREG32_FIELD_OFFSET(reg, offset, field, val)    \
1808         WREG32(mm##reg + offset, (RREG32(mm##reg + offset) & ~REG_FIELD_MASK(reg, field)) | (val) << REG_FIELD_SHIFT(reg, field))
1809
1810 /*
1811  * BIOS helpers.
1812  */
1813 #define RBIOS8(i) (adev->bios[i])
1814 #define RBIOS16(i) (RBIOS8(i) | (RBIOS8((i)+1) << 8))
1815 #define RBIOS32(i) ((RBIOS16(i)) | (RBIOS16((i)+2) << 16))
1816
1817 static inline struct amdgpu_sdma_instance *
1818 amdgpu_get_sdma_instance(struct amdgpu_ring *ring)
1819 {
1820         struct amdgpu_device *adev = ring->adev;
1821         int i;
1822
1823         for (i = 0; i < adev->sdma.num_instances; i++)
1824                 if (&adev->sdma.instance[i].ring == ring)
1825                         break;
1826
1827         if (i < AMDGPU_MAX_SDMA_INSTANCES)
1828                 return &adev->sdma.instance[i];
1829         else
1830                 return NULL;
1831 }
1832
1833 /*
1834  * ASICs macro.
1835  */
1836 #define amdgpu_asic_set_vga_state(adev, state) (adev)->asic_funcs->set_vga_state((adev), (state))
1837 #define amdgpu_asic_reset(adev) (adev)->asic_funcs->reset((adev))
1838 #define amdgpu_asic_get_xclk(adev) (adev)->asic_funcs->get_xclk((adev))
1839 #define amdgpu_asic_set_uvd_clocks(adev, v, d) (adev)->asic_funcs->set_uvd_clocks((adev), (v), (d))
1840 #define amdgpu_asic_set_vce_clocks(adev, ev, ec) (adev)->asic_funcs->set_vce_clocks((adev), (ev), (ec))
1841 #define amdgpu_get_pcie_lanes(adev) (adev)->asic_funcs->get_pcie_lanes((adev))
1842 #define amdgpu_set_pcie_lanes(adev, l) (adev)->asic_funcs->set_pcie_lanes((adev), (l))
1843 #define amdgpu_asic_get_gpu_clock_counter(adev) (adev)->asic_funcs->get_gpu_clock_counter((adev))
1844 #define amdgpu_asic_read_disabled_bios(adev) (adev)->asic_funcs->read_disabled_bios((adev))
1845 #define amdgpu_asic_read_bios_from_rom(adev, b, l) (adev)->asic_funcs->read_bios_from_rom((adev), (b), (l))
1846 #define amdgpu_asic_read_register(adev, se, sh, offset, v)((adev)->asic_funcs->read_register((adev), (se), (sh), (offset), (v)))
1847 #define amdgpu_asic_get_config_memsize(adev) (adev)->asic_funcs->get_config_memsize((adev))
1848 #define amdgpu_gart_flush_gpu_tlb(adev, vmid) (adev)->gart.gart_funcs->flush_gpu_tlb((adev), (vmid))
1849 #define amdgpu_gart_set_pte_pde(adev, pt, idx, addr, flags) (adev)->gart.gart_funcs->set_pte_pde((adev), (pt), (idx), (addr), (flags))
1850 #define amdgpu_gart_get_vm_pde(adev, level, dst, flags) (adev)->gart.gart_funcs->get_vm_pde((adev), (level), (dst), (flags))
1851 #define amdgpu_vm_copy_pte(adev, ib, pe, src, count) ((adev)->vm_manager.vm_pte_funcs->copy_pte((ib), (pe), (src), (count)))
1852 #define amdgpu_vm_write_pte(adev, ib, pe, value, count, incr) ((adev)->vm_manager.vm_pte_funcs->write_pte((ib), (pe), (value), (count), (incr)))
1853 #define amdgpu_vm_set_pte_pde(adev, ib, pe, addr, count, incr, flags) ((adev)->vm_manager.vm_pte_funcs->set_pte_pde((ib), (pe), (addr), (count), (incr), (flags)))
1854 #define amdgpu_vm_get_pte_flags(adev, flags) (adev)->gart.gart_funcs->get_vm_pte_flags((adev),(flags))
1855 #define amdgpu_ring_parse_cs(r, p, ib) ((r)->funcs->parse_cs((p), (ib)))
1856 #define amdgpu_ring_test_ring(r) (r)->funcs->test_ring((r))
1857 #define amdgpu_ring_test_ib(r, t) (r)->funcs->test_ib((r), (t))
1858 #define amdgpu_ring_get_rptr(r) (r)->funcs->get_rptr((r))
1859 #define amdgpu_ring_get_wptr(r) (r)->funcs->get_wptr((r))
1860 #define amdgpu_ring_set_wptr(r) (r)->funcs->set_wptr((r))
1861 #define amdgpu_ring_emit_ib(r, ib, vm_id, c) (r)->funcs->emit_ib((r), (ib), (vm_id), (c))
1862 #define amdgpu_ring_emit_pipeline_sync(r) (r)->funcs->emit_pipeline_sync((r))
1863 #define amdgpu_ring_emit_vm_flush(r, vmid, addr) (r)->funcs->emit_vm_flush((r), (vmid), (addr))
1864 #define amdgpu_ring_emit_fence(r, addr, seq, flags) (r)->funcs->emit_fence((r), (addr), (seq), (flags))
1865 #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))
1866 #define amdgpu_ring_emit_hdp_flush(r) (r)->funcs->emit_hdp_flush((r))
1867 #define amdgpu_ring_emit_hdp_invalidate(r) (r)->funcs->emit_hdp_invalidate((r))
1868 #define amdgpu_ring_emit_switch_buffer(r) (r)->funcs->emit_switch_buffer((r))
1869 #define amdgpu_ring_emit_cntxcntl(r, d) (r)->funcs->emit_cntxcntl((r), (d))
1870 #define amdgpu_ring_emit_rreg(r, d) (r)->funcs->emit_rreg((r), (d))
1871 #define amdgpu_ring_emit_wreg(r, d, v) (r)->funcs->emit_wreg((r), (d), (v))
1872 #define amdgpu_ring_emit_tmz(r, b) (r)->funcs->emit_tmz((r), (b))
1873 #define amdgpu_ring_pad_ib(r, ib) ((r)->funcs->pad_ib((r), (ib)))
1874 #define amdgpu_ring_init_cond_exec(r) (r)->funcs->init_cond_exec((r))
1875 #define amdgpu_ring_patch_cond_exec(r,o) (r)->funcs->patch_cond_exec((r),(o))
1876 #define amdgpu_ih_get_wptr(adev) (adev)->irq.ih_funcs->get_wptr((adev))
1877 #define amdgpu_ih_prescreen_iv(adev) (adev)->irq.ih_funcs->prescreen_iv((adev))
1878 #define amdgpu_ih_decode_iv(adev, iv) (adev)->irq.ih_funcs->decode_iv((adev), (iv))
1879 #define amdgpu_ih_set_rptr(adev) (adev)->irq.ih_funcs->set_rptr((adev))
1880 #define amdgpu_display_vblank_get_counter(adev, crtc) (adev)->mode_info.funcs->vblank_get_counter((adev), (crtc))
1881 #define amdgpu_display_vblank_wait(adev, crtc) (adev)->mode_info.funcs->vblank_wait((adev), (crtc))
1882 #define amdgpu_display_backlight_set_level(adev, e, l) (adev)->mode_info.funcs->backlight_set_level((e), (l))
1883 #define amdgpu_display_backlight_get_level(adev, e) (adev)->mode_info.funcs->backlight_get_level((e))
1884 #define amdgpu_display_hpd_sense(adev, h) (adev)->mode_info.funcs->hpd_sense((adev), (h))
1885 #define amdgpu_display_hpd_set_polarity(adev, h) (adev)->mode_info.funcs->hpd_set_polarity((adev), (h))
1886 #define amdgpu_display_hpd_get_gpio_reg(adev) (adev)->mode_info.funcs->hpd_get_gpio_reg((adev))
1887 #define amdgpu_display_bandwidth_update(adev) (adev)->mode_info.funcs->bandwidth_update((adev))
1888 #define amdgpu_display_page_flip(adev, crtc, base, async) (adev)->mode_info.funcs->page_flip((adev), (crtc), (base), (async))
1889 #define amdgpu_display_page_flip_get_scanoutpos(adev, crtc, vbl, pos) (adev)->mode_info.funcs->page_flip_get_scanoutpos((adev), (crtc), (vbl), (pos))
1890 #define amdgpu_display_add_encoder(adev, e, s, c) (adev)->mode_info.funcs->add_encoder((adev), (e), (s), (c))
1891 #define amdgpu_display_add_connector(adev, ci, sd, ct, ib, coi, h, r) (adev)->mode_info.funcs->add_connector((adev), (ci), (sd), (ct), (ib), (coi), (h), (r))
1892 #define amdgpu_emit_copy_buffer(adev, ib, s, d, b) (adev)->mman.buffer_funcs->emit_copy_buffer((ib),  (s), (d), (b))
1893 #define amdgpu_emit_fill_buffer(adev, ib, s, d, b) (adev)->mman.buffer_funcs->emit_fill_buffer((ib), (s), (d), (b))
1894 #define amdgpu_gfx_get_gpu_clock_counter(adev) (adev)->gfx.funcs->get_gpu_clock_counter((adev))
1895 #define amdgpu_gfx_select_se_sh(adev, se, sh, instance) (adev)->gfx.funcs->select_se_sh((adev), (se), (sh), (instance))
1896 #define amdgpu_gds_switch(adev, r, v, d, w, a) (adev)->gds.funcs->patch_gds_switch((r), (v), (d), (w), (a))
1897 #define amdgpu_psp_check_fw_loading_status(adev, i) (adev)->firmware.funcs->check_fw_loading_status((adev), (i))
1898
1899 /* Common functions */
1900 int amdgpu_gpu_recover(struct amdgpu_device *adev, struct amdgpu_job* job, bool force);
1901 bool amdgpu_need_backup(struct amdgpu_device *adev);
1902 void amdgpu_pci_config_reset(struct amdgpu_device *adev);
1903 bool amdgpu_need_post(struct amdgpu_device *adev);
1904 void amdgpu_update_display_priority(struct amdgpu_device *adev);
1905
1906 void amdgpu_cs_report_moved_bytes(struct amdgpu_device *adev, u64 num_bytes,
1907                                   u64 num_vis_bytes);
1908 void amdgpu_ttm_placement_from_domain(struct amdgpu_bo *abo, u32 domain);
1909 bool amdgpu_ttm_bo_is_amdgpu_bo(struct ttm_buffer_object *bo);
1910 void amdgpu_vram_location(struct amdgpu_device *adev, struct amdgpu_mc *mc, u64 base);
1911 void amdgpu_gart_location(struct amdgpu_device *adev, struct amdgpu_mc *mc);
1912 int amdgpu_device_resize_fb_bar(struct amdgpu_device *adev);
1913 void amdgpu_ttm_set_active_vram_size(struct amdgpu_device *adev, u64 size);
1914 int amdgpu_ttm_init(struct amdgpu_device *adev);
1915 void amdgpu_ttm_fini(struct amdgpu_device *adev);
1916 void amdgpu_program_register_sequence(struct amdgpu_device *adev,
1917                                              const u32 *registers,
1918                                              const u32 array_size);
1919
1920 bool amdgpu_device_is_px(struct drm_device *dev);
1921 /* atpx handler */
1922 #if defined(CONFIG_VGA_SWITCHEROO)
1923 void amdgpu_register_atpx_handler(void);
1924 void amdgpu_unregister_atpx_handler(void);
1925 bool amdgpu_has_atpx_dgpu_power_cntl(void);
1926 bool amdgpu_is_atpx_hybrid(void);
1927 bool amdgpu_atpx_dgpu_req_power_for_displays(void);
1928 bool amdgpu_has_atpx(void);
1929 #else
1930 static inline void amdgpu_register_atpx_handler(void) {}
1931 static inline void amdgpu_unregister_atpx_handler(void) {}
1932 static inline bool amdgpu_has_atpx_dgpu_power_cntl(void) { return false; }
1933 static inline bool amdgpu_is_atpx_hybrid(void) { return false; }
1934 static inline bool amdgpu_atpx_dgpu_req_power_for_displays(void) { return false; }
1935 static inline bool amdgpu_has_atpx(void) { return false; }
1936 #endif
1937
1938 /*
1939  * KMS
1940  */
1941 extern const struct drm_ioctl_desc amdgpu_ioctls_kms[];
1942 extern const int amdgpu_max_kms_ioctl;
1943
1944 int amdgpu_driver_load_kms(struct drm_device *dev, unsigned long flags);
1945 void amdgpu_driver_unload_kms(struct drm_device *dev);
1946 void amdgpu_driver_lastclose_kms(struct drm_device *dev);
1947 int amdgpu_driver_open_kms(struct drm_device *dev, struct drm_file *file_priv);
1948 void amdgpu_driver_postclose_kms(struct drm_device *dev,
1949                                  struct drm_file *file_priv);
1950 int amdgpu_device_ip_suspend(struct amdgpu_device *adev);
1951 int amdgpu_device_suspend(struct drm_device *dev, bool suspend, bool fbcon);
1952 int amdgpu_device_resume(struct drm_device *dev, bool resume, bool fbcon);
1953 u32 amdgpu_get_vblank_counter_kms(struct drm_device *dev, unsigned int pipe);
1954 int amdgpu_enable_vblank_kms(struct drm_device *dev, unsigned int pipe);
1955 void amdgpu_disable_vblank_kms(struct drm_device *dev, unsigned int pipe);
1956 long amdgpu_kms_compat_ioctl(struct file *filp, unsigned int cmd,
1957                              unsigned long arg);
1958
1959 /*
1960  * functions used by amdgpu_encoder.c
1961  */
1962 struct amdgpu_afmt_acr {
1963         u32 clock;
1964
1965         int n_32khz;
1966         int cts_32khz;
1967
1968         int n_44_1khz;
1969         int cts_44_1khz;
1970
1971         int n_48khz;
1972         int cts_48khz;
1973
1974 };
1975
1976 struct amdgpu_afmt_acr amdgpu_afmt_acr(uint32_t clock);
1977
1978 /* amdgpu_acpi.c */
1979 #if defined(CONFIG_ACPI)
1980 int amdgpu_acpi_init(struct amdgpu_device *adev);
1981 void amdgpu_acpi_fini(struct amdgpu_device *adev);
1982 bool amdgpu_acpi_is_pcie_performance_request_supported(struct amdgpu_device *adev);
1983 int amdgpu_acpi_pcie_performance_request(struct amdgpu_device *adev,
1984                                                 u8 perf_req, bool advertise);
1985 int amdgpu_acpi_pcie_notify_device_ready(struct amdgpu_device *adev);
1986 #else
1987 static inline int amdgpu_acpi_init(struct amdgpu_device *adev) { return 0; }
1988 static inline void amdgpu_acpi_fini(struct amdgpu_device *adev) { }
1989 #endif
1990
1991 int amdgpu_cs_find_mapping(struct amdgpu_cs_parser *parser,
1992                            uint64_t addr, struct amdgpu_bo **bo,
1993                            struct amdgpu_bo_va_mapping **mapping);
1994
1995 #if defined(CONFIG_DRM_AMD_DC)
1996 int amdgpu_dm_display_resume(struct amdgpu_device *adev );
1997 #else
1998 static inline int amdgpu_dm_display_resume(struct amdgpu_device *adev) { return 0; }
1999 #endif
2000
2001 #include "amdgpu_object.h"
2002 #endif