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