Merge tag 'tty-6.0-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty
[platform/kernel/linux-rpi.git] / drivers / gpu / drm / amd / include / mes_v11_api_def.h
1 /*
2  * Copyright 2022 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  */
23
24 #ifndef __MES_API_DEF_H__
25 #define __MES_API_DEF_H__
26
27 #pragma pack(push, 4)
28
29 #define MES_API_VERSION 1
30
31 /* Driver submits one API(cmd) as a single Frame and this command size is same
32  * for all API to ease the debugging and parsing of ring buffer.
33  */
34 enum { API_FRAME_SIZE_IN_DWORDS = 64 };
35
36 /* To avoid command in scheduler context to be overwritten whenenver mutilple
37  * interrupts come in, this creates another queue.
38  */
39 enum { API_NUMBER_OF_COMMAND_MAX = 32 };
40
41 enum MES_API_TYPE {
42         MES_API_TYPE_SCHEDULER = 1,
43         MES_API_TYPE_MAX
44 };
45
46 enum MES_SCH_API_OPCODE {
47         MES_SCH_API_SET_HW_RSRC                 = 0,
48         MES_SCH_API_SET_SCHEDULING_CONFIG       = 1, /* agreegated db, quantums, etc */
49         MES_SCH_API_ADD_QUEUE                   = 2,
50         MES_SCH_API_REMOVE_QUEUE                = 3,
51         MES_SCH_API_PERFORM_YIELD               = 4,
52         MES_SCH_API_SET_GANG_PRIORITY_LEVEL     = 5,
53         MES_SCH_API_SUSPEND                     = 6,
54         MES_SCH_API_RESUME                      = 7,
55         MES_SCH_API_RESET                       = 8,
56         MES_SCH_API_SET_LOG_BUFFER              = 9,
57         MES_SCH_API_CHANGE_GANG_PRORITY         = 10,
58         MES_SCH_API_QUERY_SCHEDULER_STATUS      = 11,
59         MES_SCH_API_PROGRAM_GDS                 = 12,
60         MES_SCH_API_SET_DEBUG_VMID              = 13,
61         MES_SCH_API_MISC                        = 14,
62         MES_SCH_API_UPDATE_ROOT_PAGE_TABLE      = 15,
63         MES_SCH_API_AMD_LOG                     = 16,
64         MES_SCH_API_MAX                         = 0xFF
65 };
66
67 union MES_API_HEADER {
68         struct {
69                 uint32_t type           : 4; /* 0 - Invalid; 1 - Scheduling; 2 - TBD */
70                 uint32_t opcode         : 8;
71                 uint32_t dwsize         : 8; /* including header */
72                 uint32_t reserved       : 12;
73         };
74
75         uint32_t        u32All;
76 };
77
78 enum MES_AMD_PRIORITY_LEVEL {
79         AMD_PRIORITY_LEVEL_LOW          = 0,
80         AMD_PRIORITY_LEVEL_NORMAL       = 1,
81         AMD_PRIORITY_LEVEL_MEDIUM       = 2,
82         AMD_PRIORITY_LEVEL_HIGH         = 3,
83         AMD_PRIORITY_LEVEL_REALTIME     = 4,
84         AMD_PRIORITY_NUM_LEVELS
85 };
86
87 enum MES_QUEUE_TYPE {
88         MES_QUEUE_TYPE_GFX,
89         MES_QUEUE_TYPE_COMPUTE,
90         MES_QUEUE_TYPE_SDMA,
91         MES_QUEUE_TYPE_MAX,
92 };
93
94 struct MES_API_STATUS {
95         uint64_t        api_completion_fence_addr;
96         uint64_t        api_completion_fence_value;
97 };
98
99 enum { MAX_COMPUTE_PIPES = 8 };
100 enum { MAX_GFX_PIPES = 2 };
101 enum { MAX_SDMA_PIPES = 2 };
102
103 enum { MAX_COMPUTE_HQD_PER_PIPE = 8 };
104 enum { MAX_GFX_HQD_PER_PIPE = 8 };
105 enum { MAX_SDMA_HQD_PER_PIPE = 10 };
106 enum { MAX_SDMA_HQD_PER_PIPE_11_0   = 8 };
107
108 enum { MAX_QUEUES_IN_A_GANG = 8 };
109
110 enum VM_HUB_TYPE {
111         VM_HUB_TYPE_GC = 0,
112         VM_HUB_TYPE_MM = 1,
113         VM_HUB_TYPE_MAX,
114 };
115
116 enum { VMID_INVALID = 0xffff };
117
118 enum { MAX_VMID_GCHUB = 16 };
119 enum { MAX_VMID_MMHUB = 16 };
120
121 enum SET_DEBUG_VMID_OPERATIONS {
122         DEBUG_VMID_OP_PROGRAM = 0,
123         DEBUG_VMID_OP_ALLOCATE = 1,
124         DEBUG_VMID_OP_RELEASE = 2
125 };
126
127 enum MES_LOG_OPERATION {
128         MES_LOG_OPERATION_CONTEXT_STATE_CHANGE = 0,
129         MES_LOG_OPERATION_QUEUE_NEW_WORK = 1,
130         MES_LOG_OPERATION_QUEUE_UNWAIT_SYNC_OBJECT = 2,
131         MES_LOG_OPERATION_QUEUE_NO_MORE_WORK = 3,
132         MES_LOG_OPERATION_QUEUE_WAIT_SYNC_OBJECT = 4,
133         MES_LOG_OPERATION_QUEUE_INVALID = 0xF,
134 };
135
136 enum MES_LOG_CONTEXT_STATE {
137         MES_LOG_CONTEXT_STATE_IDLE              = 0,
138         MES_LOG_CONTEXT_STATE_RUNNING           = 1,
139         MES_LOG_CONTEXT_STATE_READY             = 2,
140         MES_LOG_CONTEXT_STATE_READY_STANDBY     = 3,
141         MES_LOG_CONTEXT_STATE_INVALID           = 0xF,
142 };
143
144 struct MES_LOG_CONTEXT_STATE_CHANGE {
145         void                            *h_context;
146         enum MES_LOG_CONTEXT_STATE      new_context_state;
147 };
148
149 struct MES_LOG_QUEUE_NEW_WORK {
150         uint64_t                   h_queue;
151         uint64_t                   reserved;
152 };
153
154 struct MES_LOG_QUEUE_UNWAIT_SYNC_OBJECT {
155         uint64_t                   h_queue;
156         uint64_t                   h_sync_object;
157 };
158
159 struct MES_LOG_QUEUE_NO_MORE_WORK {
160         uint64_t                   h_queue;
161         uint64_t                   reserved;
162 };
163
164 struct MES_LOG_QUEUE_WAIT_SYNC_OBJECT {
165         uint64_t                   h_queue;
166         uint64_t                   h_sync_object;
167 };
168
169 struct MES_LOG_ENTRY_HEADER {
170         uint32_t        first_free_entry_index;
171         uint32_t        wraparound_count;
172         uint64_t        number_of_entries;
173         uint64_t        reserved[2];
174 };
175
176 struct MES_LOG_ENTRY_DATA {
177         uint64_t        gpu_time_stamp;
178         uint32_t        operation_type; /* operation_type is of MES_LOG_OPERATION type */
179         uint32_t        reserved_operation_type_bits;
180         union {
181                 struct MES_LOG_CONTEXT_STATE_CHANGE     context_state_change;
182                 struct MES_LOG_QUEUE_NEW_WORK           queue_new_work;
183                 struct MES_LOG_QUEUE_UNWAIT_SYNC_OBJECT queue_unwait_sync_object;
184                 struct MES_LOG_QUEUE_NO_MORE_WORK       queue_no_more_work;
185                 struct MES_LOG_QUEUE_WAIT_SYNC_OBJECT   queue_wait_sync_object;
186                 uint64_t                                all[2];
187         };
188 };
189
190 struct MES_LOG_BUFFER {
191         struct MES_LOG_ENTRY_HEADER     header;
192         struct MES_LOG_ENTRY_DATA       entries[1];
193 };
194
195 enum MES_SWIP_TO_HWIP_DEF {
196         MES_MAX_HWIP_SEGMENT = 8,
197 };
198
199 union MESAPI_SET_HW_RESOURCES {
200         struct {
201                 union MES_API_HEADER    header;
202                 uint32_t                vmid_mask_mmhub;
203                 uint32_t                vmid_mask_gfxhub;
204                 uint32_t                gds_size;
205                 uint32_t                paging_vmid;
206                 uint32_t                compute_hqd_mask[MAX_COMPUTE_PIPES];
207                 uint32_t                gfx_hqd_mask[MAX_GFX_PIPES];
208                 uint32_t                sdma_hqd_mask[MAX_SDMA_PIPES];
209                 uint32_t                aggregated_doorbells[AMD_PRIORITY_NUM_LEVELS];
210                 uint64_t                g_sch_ctx_gpu_mc_ptr;
211                 uint64_t                query_status_fence_gpu_mc_ptr;
212                 uint32_t                gc_base[MES_MAX_HWIP_SEGMENT];
213                 uint32_t                mmhub_base[MES_MAX_HWIP_SEGMENT];
214                 uint32_t                osssys_base[MES_MAX_HWIP_SEGMENT];
215                 struct MES_API_STATUS   api_status;
216                 union {
217                         struct {
218                                 uint32_t disable_reset  : 1;
219                                 uint32_t use_different_vmid_compute : 1;
220                                 uint32_t disable_mes_log   : 1;
221                                 uint32_t apply_mmhub_pgvm_invalidate_ack_loss_wa : 1;
222                                 uint32_t apply_grbm_remote_register_dummy_read_wa : 1;
223                                 uint32_t second_gfx_pipe_enabled : 1;
224                                 uint32_t enable_level_process_quantum_check : 1;
225                                 uint32_t reserved       : 25;
226                         };
227                         uint32_t        uint32_t_all;
228                 };
229                 uint32_t        oversubscription_timer;
230                 uint64_t        doorbell_info;
231         };
232
233         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
234 };
235
236 union MESAPI__ADD_QUEUE {
237         struct {
238                 union MES_API_HEADER            header;
239                 uint32_t                        process_id;
240                 uint64_t                        page_table_base_addr;
241                 uint64_t                        process_va_start;
242                 uint64_t                        process_va_end;
243                 uint64_t                        process_quantum;
244                 uint64_t                        process_context_addr;
245                 uint64_t                        gang_quantum;
246                 uint64_t                        gang_context_addr;
247                 uint32_t                        inprocess_gang_priority;
248                 enum MES_AMD_PRIORITY_LEVEL     gang_global_priority_level;
249                 uint32_t                        doorbell_offset;
250                 uint64_t                        mqd_addr;
251                 uint64_t                        wptr_addr;
252                 uint64_t                        h_context;
253                 uint64_t                        h_queue;
254                 enum MES_QUEUE_TYPE             queue_type;
255                 uint32_t                        gds_base;
256                 uint32_t                        gds_size;
257                 uint32_t                        gws_base;
258                 uint32_t                        gws_size;
259                 uint32_t                        oa_mask;
260                 uint64_t                        trap_handler_addr;
261                 uint32_t                        vm_context_cntl;
262
263                 struct {
264                         uint32_t paging                 : 1;
265                         uint32_t debug_vmid             : 4;
266                         uint32_t program_gds            : 1;
267                         uint32_t is_gang_suspended      : 1;
268                         uint32_t is_tmz_queue           : 1;
269                         uint32_t map_kiq_utility_queue  : 1;
270                         uint32_t is_kfd_process         : 1;
271                         uint32_t trap_en                : 1;
272                         uint32_t reserved               : 21;
273                 };
274                 struct MES_API_STATUS           api_status;
275                 uint64_t                        tma_addr;
276         };
277
278         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
279 };
280
281 union MESAPI__REMOVE_QUEUE {
282         struct {
283                 union MES_API_HEADER    header;
284                 uint32_t                doorbell_offset;
285                 uint64_t                gang_context_addr;
286
287                 struct {
288                         uint32_t unmap_legacy_gfx_queue   : 1;
289                         uint32_t unmap_kiq_utility_queue  : 1;
290                         uint32_t preempt_legacy_gfx_queue : 1;
291                         uint32_t unmap_legacy_queue       : 1;
292                         uint32_t reserved                 : 28;
293                 };
294                 struct MES_API_STATUS       api_status;
295
296                 uint32_t                    pipe_id;
297                 uint32_t                    queue_id;
298
299                 uint64_t                    tf_addr;
300                 uint32_t                    tf_data;
301
302                 enum MES_QUEUE_TYPE         queue_type;
303         };
304
305         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
306 };
307
308 union MESAPI__SET_SCHEDULING_CONFIG {
309         struct {
310                 union MES_API_HEADER    header;
311                 /* Grace period when preempting another priority band for this
312                  * priority band. The value for idle priority band is ignored,
313                  * as it never preempts other bands.
314                  */
315                 uint64_t                grace_period_other_levels[AMD_PRIORITY_NUM_LEVELS];
316                 /* Default quantum for scheduling across processes within
317                  * a priority band.
318                  */
319                 uint64_t                process_quantum_for_level[AMD_PRIORITY_NUM_LEVELS];
320                 /* Default grace period for processes that preempt each other
321                  * within a priority band.
322                  */
323                 uint64_t                process_grace_period_same_level[AMD_PRIORITY_NUM_LEVELS];
324                 /* For normal level this field specifies the target GPU
325                  * percentage in situations when it's starved by the high level.
326                  * Valid values are between 0 and 50, with the default being 10.
327                  */
328                 uint32_t                normal_yield_percent;
329                 struct MES_API_STATUS   api_status;
330         };
331
332         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
333 };
334
335 union MESAPI__PERFORM_YIELD {
336         struct {
337                 union MES_API_HEADER    header;
338                 uint32_t                dummy;
339                 struct MES_API_STATUS   api_status;
340         };
341
342         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
343 };
344
345 union MESAPI__CHANGE_GANG_PRIORITY_LEVEL {
346         struct {
347                 union MES_API_HEADER            header;
348                 uint32_t                        inprocess_gang_priority;
349                 enum MES_AMD_PRIORITY_LEVEL     gang_global_priority_level;
350                 uint64_t                        gang_quantum;
351                 uint64_t                        gang_context_addr;
352                 struct MES_API_STATUS           api_status;
353         };
354
355         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
356 };
357
358 union MESAPI__SUSPEND {
359         struct {
360                 union MES_API_HEADER    header;
361                 /* false - suspend all gangs; true - specific gang */
362                 struct {
363                         uint32_t suspend_all_gangs      : 1;
364                         uint32_t reserved               : 31;
365                 };
366                 /* gang_context_addr is valid only if suspend_all = false */
367                 uint64_t                gang_context_addr;
368
369                 uint64_t                suspend_fence_addr;
370                 uint32_t                suspend_fence_value;
371
372                 struct MES_API_STATUS   api_status;
373         };
374
375         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
376 };
377
378 union MESAPI__RESUME {
379         struct {
380                 union MES_API_HEADER    header;
381                 /* false - resume all gangs; true - specified gang */
382                 struct {
383                         uint32_t resume_all_gangs       : 1;
384                         uint32_t reserved               : 31;
385                 };
386                 /* valid only if resume_all_gangs = false */
387                 uint64_t                gang_context_addr;
388
389                 struct MES_API_STATUS   api_status;
390         };
391
392         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
393 };
394
395 union MESAPI__RESET {
396         struct {
397                 union MES_API_HEADER            header;
398
399                 struct {
400                         /* Only reset the queue given by doorbell_offset (not entire gang) */
401                         uint32_t                reset_queue_only : 1;
402                         /* Hang detection first then reset any queues that are hung */
403                         uint32_t                hang_detect_then_reset : 1;
404                         /* Only do hang detection (no reset) */
405                         uint32_t                hang_detect_only : 1;
406                         /* Rest HP and LP kernel queues not managed by MES */
407                         uint32_t                reset_legacy_gfx : 1;
408                         uint32_t                reserved : 28;
409                 };
410
411                 uint64_t                        gang_context_addr;
412
413                 /* valid only if reset_queue_only = true */
414                 uint32_t                        doorbell_offset;
415
416                 /* valid only if hang_detect_then_reset = true */
417                 uint64_t                        doorbell_offset_addr;
418                 enum MES_QUEUE_TYPE             queue_type;
419
420                 /* valid only if reset_legacy_gfx = true */
421                 uint32_t                        pipe_id_lp;
422                 uint32_t                        queue_id_lp;
423                 uint32_t                        vmid_id_lp;
424                 uint64_t                        mqd_mc_addr_lp;
425                 uint32_t                        doorbell_offset_lp;
426                 uint64_t                        wptr_addr_lp;
427
428                 uint32_t                        pipe_id_hp;
429                 uint32_t                        queue_id_hp;
430                 uint32_t                        vmid_id_hp;
431                 uint64_t                        mqd_mc_addr_hp;
432                 uint32_t                        doorbell_offset_hp;
433                 uint64_t                        wptr_addr_hp;
434
435                 struct MES_API_STATUS           api_status;
436         };
437
438         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
439 };
440
441 union MESAPI__SET_LOGGING_BUFFER {
442         struct {
443                 union MES_API_HEADER    header;
444                 /* There are separate log buffers for each queue type */
445                 enum MES_QUEUE_TYPE     log_type;
446                 /* Log buffer GPU Address */
447                 uint64_t                logging_buffer_addr;
448                 /* number of entries in the log buffer */
449                 uint32_t                number_of_entries;
450                 /* Entry index at which CPU interrupt needs to be signalled */
451                 uint32_t                interrupt_entry;
452
453                 struct MES_API_STATUS   api_status;
454         };
455
456         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
457 };
458
459 union MESAPI__QUERY_MES_STATUS {
460         struct {
461                 union MES_API_HEADER    header;
462                 bool                    mes_healthy; /* 0 - not healthy, 1 - healthy */
463                 struct MES_API_STATUS   api_status;
464         };
465
466         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
467 };
468
469 union MESAPI__PROGRAM_GDS {
470         struct {
471                 union MES_API_HEADER    header;
472                 uint64_t                process_context_addr;
473                 uint32_t                gds_base;
474                 uint32_t                gds_size;
475                 uint32_t                gws_base;
476                 uint32_t                gws_size;
477                 uint32_t                oa_mask;
478                 struct MES_API_STATUS   api_status;
479         };
480
481         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
482 };
483
484 union MESAPI__SET_DEBUG_VMID {
485         struct {
486                 union MES_API_HEADER    header;
487                 struct MES_API_STATUS   api_status;
488                 union {
489                         struct {
490                                 uint32_t use_gds        : 1;
491                                 uint32_t operation      : 2;
492                                 uint32_t reserved       : 29;
493                         } flags;
494                         uint32_t        u32All;
495                 };
496                 uint32_t                reserved;
497                 uint32_t                debug_vmid;
498                 uint64_t                process_context_addr;
499                 uint64_t                page_table_base_addr;
500                 uint64_t                process_va_start;
501                 uint64_t                process_va_end;
502                 uint32_t                gds_base;
503                 uint32_t                gds_size;
504                 uint32_t                gws_base;
505                 uint32_t                gws_size;
506                 uint32_t                oa_mask;
507
508                 /* output addr of the acquired vmid value */
509                 uint64_t                output_addr;
510         };
511
512         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
513 };
514
515 enum MESAPI_MISC_OPCODE {
516         MESAPI_MISC__WRITE_REG,
517         MESAPI_MISC__INV_GART,
518         MESAPI_MISC__QUERY_STATUS,
519         MESAPI_MISC__READ_REG,
520         MESAPI_MISC__WAIT_REG_MEM,
521         MESAPI_MISC__MAX,
522 };
523
524 enum { MISC_DATA_MAX_SIZE_IN_DWORDS = 20 };
525
526 struct WRITE_REG {
527         uint32_t                  reg_offset;
528         uint32_t                  reg_value;
529 };
530
531 struct READ_REG {
532         uint32_t                  reg_offset;
533         uint64_t                  buffer_addr;
534 };
535
536 enum WRM_OPERATION {
537         WRM_OPERATION__WAIT_REG_MEM,
538         WRM_OPERATION__WR_WAIT_WR_REG,
539         WRM_OPERATION__MAX,
540 };
541
542 struct WAIT_REG_MEM {
543         enum WRM_OPERATION         op;
544         uint32_t                   reference;
545         uint32_t                   mask;
546         uint32_t                   reg_offset1;
547         uint32_t                   reg_offset2;
548 };
549
550 struct INV_GART {
551         uint64_t                  inv_range_va_start;
552         uint64_t                  inv_range_size;
553 };
554
555 struct QUERY_STATUS {
556         uint32_t context_id;
557 };
558
559 union MESAPI__MISC {
560         struct {
561                 union MES_API_HEADER    header;
562                 enum MESAPI_MISC_OPCODE opcode;
563                 struct MES_API_STATUS   api_status;
564
565                 union {
566                         struct          WRITE_REG write_reg;
567                         struct          INV_GART inv_gart;
568                         struct          QUERY_STATUS query_status;
569                         struct          READ_REG read_reg;
570                         struct          WAIT_REG_MEM wait_reg_mem;
571                         uint32_t        data[MISC_DATA_MAX_SIZE_IN_DWORDS];
572                 };
573         };
574
575         uint32_t        max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
576 };
577
578 union MESAPI__UPDATE_ROOT_PAGE_TABLE {
579         struct {
580                 union MES_API_HEADER        header;
581                 uint64_t                    page_table_base_addr;
582                 uint64_t                    process_context_addr;
583                 struct MES_API_STATUS       api_status;
584         };
585
586         uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
587 };
588
589 union MESAPI_AMD_LOG {
590         struct {
591                 union MES_API_HEADER        header;
592                 uint64_t                    p_buffer_memory;
593                 uint64_t                    p_buffer_size_used;
594                 struct MES_API_STATUS       api_status;
595         };
596
597         uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
598 };
599
600 #pragma pack(pop)
601 #endif