Quelle  mes_v12_api_def.h   Sprache: C

/*
 * Copyright 2023 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#ifndef __MES_API_DEF_H__
#define __MES_API_DEF_H__

#pragma pack(push, 8)

#define MES_API_VERSION 0x14

/* Maximum log buffer size for MES. Needs to be updated if MES expands MES_EVT_INTR_HIST_LOG_12 */
#define  AMDGPU_MES_LOG_BUFFER_SIZE  0xC000

/* Driver submits one API(cmd) as a single Frame and this command size is same for all API
 * to ease the debugging and parsing of ring buffer.
 */
enum {API_FRAME_SIZE_IN_DWORDS = 64};

/* To avoid command in scheduler context to be overwritten whenenver mutilple interrupts come in,
 * this creates another queue
 */
enum {API_NUMBER_OF_COMMAND_MAX   = 32};

enum MES_API_TYPE {
 MES_API_TYPE_SCHEDULER = 1,
 MES_API_TYPE_MAX
};

enum MES_SCH_API_OPCODE {
 MES_SCH_API_SET_HW_RSRC   = 0,
 MES_SCH_API_SET_SCHEDULING_CONFIG = 1, /* agreegated db, quantums, etc */
 MES_SCH_API_ADD_QUEUE   = 2,
 MES_SCH_API_REMOVE_QUEUE  = 3,
 MES_SCH_API_PERFORM_YIELD  = 4,
 MES_SCH_API_SET_GANG_PRIORITY_LEVEL = 5, /* For windows GANG = Context */
 MES_SCH_API_SUSPEND   = 6,
 MES_SCH_API_RESUME   = 7,
 MES_SCH_API_RESET   = 8,
 MES_SCH_API_SET_LOG_BUFFER  = 9,
 MES_SCH_API_CHANGE_GANG_PRORITY  = 10,
 MES_SCH_API_QUERY_SCHEDULER_STATUS = 11,
 MES_SCH_API_SET_DEBUG_VMID  = 13,
 MES_SCH_API_MISC   = 14,
 MES_SCH_API_UPDATE_ROOT_PAGE_TABLE = 15,
 MES_SCH_API_AMD_LOG   = 16,
 MES_SCH_API_SET_SE_MODE   = 17,
 MES_SCH_API_SET_GANG_SUBMIT  = 18,
 MES_SCH_API_SET_HW_RSRC_1               = 19,

 MES_SCH_API_MAX = 0xFF
};

union MES_API_HEADER {
 struct {
  uint32_t type   : 4; /* 0 - Invalid; 1 - Scheduling; 2 - TBD */
  uint32_t opcode   : 8;
  uint32_t dwsize   : 8; /* including header */
  uint32_t reserved : 12;
 };

 uint32_t u32All;
};

enum MES_AMD_PRIORITY_LEVEL {
 AMD_PRIORITY_LEVEL_LOW  = 0,
 AMD_PRIORITY_LEVEL_NORMAL = 1,
 AMD_PRIORITY_LEVEL_MEDIUM = 2,
 AMD_PRIORITY_LEVEL_HIGH  = 3,
 AMD_PRIORITY_LEVEL_REALTIME = 4,

 AMD_PRIORITY_NUM_LEVELS
};

enum MES_QUEUE_TYPE {
 MES_QUEUE_TYPE_GFX,
 MES_QUEUE_TYPE_COMPUTE,
 MES_QUEUE_TYPE_SDMA,

 MES_QUEUE_TYPE_MAX,
 MES_QUEUE_TYPE_SCHQ = MES_QUEUE_TYPE_MAX,
};

struct MES_API_STATUS {
 uint64_t api_completion_fence_addr;
 uint64_t api_completion_fence_value;
};

/*
 * MES will set api_completion_fence_value in api_completion_fence_addr
 * when it can successflly process the API. MES will also trigger
 * following interrupt when it finish process the API no matter success
 * or failed.
 *     Interrupt source id 181 (EOP) with context ID (DW 6 in the int
 *     cookie) set to 0xb1 and context type set to 8. Driver side need
 *     to enable TIME_STAMP_INT_ENABLE in CPC_INT_CNTL for MES pipe to
 *     catch this interrupt.
 *     Driver side also need to set enable_mes_fence_int = 1 in
 *     set_HW_resource package to enable this fence interrupt.
 * when the API process failed.
 *     lowre 32 bits set to 0.
 *     higher 32 bits set as follows (bit shift within high 32)
 *         bit 0  -  7    API specific error code.
 *         bit 8  - 15    API OPCODE.
 *         bit 16 - 23    MISC OPCODE if any
 *         bit 24 - 30    ERROR category (API_ERROR_XXX)
 *         bit 31         Set to 1 to indicate error status
 *
 */
enum { MES_SCH_ERROR_CODE_HEADER_SHIFT_12 = 8 };
enum { MES_SCH_ERROR_CODE_MISC_OP_SHIFT_12 = 16 };
enum { MES_ERROR_CATEGORY_SHIFT_12 = 24 };
enum { MES_API_STATUS_ERROR_SHIFT_12 = 31 };

enum MES_ERROR_CATEGORY_CODE_12 {
 MES_ERROR_API                = 1,
 MES_ERROR_SCHEDULING         = 2,
 MES_ERROR_UNKNOWN            = 3,
};

#define MES_ERR_CODE(api_err, opcode, misc_op, category) \
   ((uint64) (api_err | opcode << MES_SCH_ERROR_CODE_HEADER_SHIFT_12 | \
   misc_op << MES_SCH_ERROR_CODE_MISC_OP_SHIFT_12 | \
   category << MES_ERROR_CATEGORY_SHIFT_12 | \
   1 << MES_API_STATUS_ERROR_SHIFT_12) << 32)

enum { MAX_COMPUTE_PIPES = 8 };
enum { MAX_GFX_PIPES  = 2 };
enum { MAX_SDMA_PIPES  = 2 };

enum { MAX_COMPUTE_HQD_PER_PIPE  = 8 };
enum { MAX_GFX_HQD_PER_PIPE  = 8 };
enum { MAX_SDMA_HQD_PER_PIPE  = 10 };
enum { MAX_SDMA_HQD_PER_PIPE_11_0 = 8 };


enum { MAX_QUEUES_IN_A_GANG = 8 };

enum VM_HUB_TYPE {
 VM_HUB_TYPE_GC = 0,
 VM_HUB_TYPE_MM = 1,

 VM_HUB_TYPE_MAX,
};

enum { VMID_INVALID = 0xffff };

enum { MAX_VMID_GCHUB = 16 };
enum { MAX_VMID_MMHUB = 16 };

enum SET_DEBUG_VMID_OPERATIONS {
 DEBUG_VMID_OP_PROGRAM = 0,
 DEBUG_VMID_OP_ALLOCATE = 1,
 DEBUG_VMID_OP_RELEASE = 2,
 DEBUG_VMID_OP_VM_SETUP = 3 // used to set up the debug vmid page table in the kernel queue case (mode 1)
};

enum MES_MS_LOG_CONTEXT_STATE {
 MES_LOG_CONTEXT_STATE_IDLE  = 0,
 MES_LOG_CONTEXT_STATE_RUNNING  = 1,
 MES_LOG_CONTEXT_STATE_READY  = 2,
 MES_LOG_CONTEXT_STATE_READY_STANDBY = 3,
 MES_LOG_CONTEXT_STATE_INVALID  = 0xF,
};

enum MES_MS_LOG_OPERATION {
 MES_LOG_OPERATION_CONTEXT_STATE_CHANGE  = 0,
 MES_LOG_OPERATION_QUEUE_NEW_WORK  = 1,
 MES_LOG_OPERATION_QUEUE_UNWAIT_SYNC_OBJECT = 2,
 MES_LOG_OPERATION_QUEUE_NO_MORE_WORK  = 3,
 MES_LOG_OPERATION_QUEUE_WAIT_SYNC_OBJECT = 4,
 MES_LOG_OPERATION_QUEUE_INVALID   = 0xF,
};

struct MES_LOG_CONTEXT_STATE_CHANGE {
 uint64_t   h_context;
 enum MES_MS_LOG_CONTEXT_STATE new_context_state;
};

struct MES_LOG_QUEUE_NEW_WORK {
 uint64_t h_queue;
 uint64_t reserved;
};

struct MES_LOG_QUEUE_UNWAIT_SYNC_OBJECT {
 uint64_t h_queue;
 uint64_t h_sync_object;
};

struct MES_LOG_QUEUE_NO_MORE_WORK {
 uint64_t h_queue;
 uint64_t reserved;
};

struct MES_LOG_QUEUE_WAIT_SYNC_OBJECT {
 uint64_t h_queue;
 uint64_t h_sync_object;
};

struct MES_LOG_ENTRY_HEADER {
 uint32_t first_free_entry_index;
 uint32_t wraparound_count;
 uint64_t number_of_entries;
 uint64_t reserved[2];
};

struct MES_LOG_ENTRY_DATA {
 uint64_t gpu_time_stamp;
 uint32_t operation_type; /* operation_type is of MES_LOG_OPERATION type */
 uint32_t reserved_operation_type_bits;
 union {
  struct MES_LOG_CONTEXT_STATE_CHANGE context_state_change;
  struct MES_LOG_QUEUE_NEW_WORK queue_new_work;
  struct MES_LOG_QUEUE_UNWAIT_SYNC_OBJECT queue_unwait_sync_object;
  struct MES_LOG_QUEUE_NO_MORE_WORK queue_no_more_work;
  struct MES_LOG_QUEUE_WAIT_SYNC_OBJECT queue_wait_sync_object;
  uint64_t all[2];
 };
};

struct MES_LOG_BUFFER {
 struct MES_LOG_ENTRY_HEADER header;
 struct MES_LOG_ENTRY_DATA entries[];
};

enum MES_SWIP_TO_HWIP_DEF {
 MES_MAX_HWIP_SEGMENT = 8,
};

union MESAPI_SET_HW_RESOURCES {
 struct {
  union MES_API_HEADER header;
  uint32_t  vmid_mask_mmhub;
  uint32_t  vmid_mask_gfxhub;
  uint32_t  gds_size;
  uint32_t  paging_vmid;
  uint32_t  compute_hqd_mask[MAX_COMPUTE_PIPES];
  uint32_t  gfx_hqd_mask[MAX_GFX_PIPES];
  uint32_t  sdma_hqd_mask[MAX_SDMA_PIPES];
  uint32_t  aggregated_doorbells[AMD_PRIORITY_NUM_LEVELS];
  uint64_t  g_sch_ctx_gpu_mc_ptr;
  uint64_t  query_status_fence_gpu_mc_ptr;
  uint32_t  gc_base[MES_MAX_HWIP_SEGMENT];
  uint32_t  mmhub_base[MES_MAX_HWIP_SEGMENT];
  uint32_t  osssys_base[MES_MAX_HWIP_SEGMENT];
  struct MES_API_STATUS api_status;
  union {
   struct {
    uint32_t disable_reset : 1;
    uint32_t use_different_vmid_compute : 1;
    uint32_t disable_mes_log   : 1;
    uint32_t apply_mmhub_pgvm_invalidate_ack_loss_wa : 1;
    uint32_t apply_grbm_remote_register_dummy_read_wa : 1;
    uint32_t second_gfx_pipe_enabled : 1;
    uint32_t enable_level_process_quantum_check : 1;
    uint32_t legacy_sch_mode : 1;
    uint32_t disable_add_queue_wptr_mc_addr : 1;
    uint32_t enable_mes_event_int_logging : 1;
    uint32_t enable_reg_active_poll : 1;
    uint32_t use_disable_queue_in_legacy_uq_preemption : 1;
    uint32_t send_write_data : 1;
    uint32_t os_tdr_timeout_override : 1;
    uint32_t use_rs64mem_for_proc_gang_ctx : 1;
    uint32_t halt_on_misaligned_access : 1;
    uint32_t use_add_queue_unmap_flag_addr : 1;
    uint32_t enable_mes_sch_stb_log : 1;
    uint32_t limit_single_process : 1;
    uint32_t unmapped_doorbell_handling: 2;
    uint32_t enable_mes_fence_int: 1;
    uint32_t enable_lr_compute_wa : 1;
    uint32_t reserved : 9;
   };
   uint32_t uint32_all;
  };
 uint32_t oversubscription_timer;
 uint64_t doorbell_info;
 uint64_t event_intr_history_gpu_mc_ptr;
 uint64_t timestamp;
 uint32_t os_tdr_timeout_in_sec;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI_SET_HW_RESOURCES_1 {
 struct {
  union MES_API_HEADER                header;
  struct MES_API_STATUS               api_status;
  uint64_t                            timestamp;
  union {
   struct {
    uint32_t enable_mes_debug_ctx : 1;
    uint32_t reserved : 31;
   };
   uint32_t uint32_all;
  };
  uint64_t                            mes_debug_ctx_mc_addr;
  uint32_t                            mes_debug_ctx_size;
  /* unit is 100ms */
  uint32_t                            mes_kiq_unmap_timeout;
  uint64_t                            reserved1;
  uint64_t                            cleaner_shader_fence_mc_addr;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__ADD_QUEUE {
 struct {
  union MES_API_HEADER header;
  uint32_t  process_id;
  uint64_t  page_table_base_addr;
  uint64_t  process_va_start;
  uint64_t  process_va_end;
  uint64_t  process_quantum;
  uint64_t  process_context_addr;
  uint64_t  gang_quantum;
  uint64_t  gang_context_addr;
  uint32_t  inprocess_gang_priority;
  enum MES_AMD_PRIORITY_LEVEL gang_global_priority_level;
  uint32_t  doorbell_offset;
  uint64_t  mqd_addr;
  /* From MES_API_VERSION 2, mc addr is expected for wptr_addr */
  uint64_t  wptr_addr;
  uint64_t  h_context;
  uint64_t  h_queue;
  enum MES_QUEUE_TYPE queue_type;
  uint32_t  gds_base;
  union {
   /* backwards compatibility with Linux, remove union once they use kfd_queue_size */
   uint32_t gds_size;
   uint32_t kfd_queue_size;
  };
  uint32_t  gws_base;
  uint32_t  gws_size;
  uint32_t  oa_mask;
  uint64_t  trap_handler_addr;
  uint32_t  vm_context_cntl;

  struct {
   uint32_t paging  : 1;
   uint32_t debug_vmid  : 4;
   uint32_t program_gds : 1;
   uint32_t is_gang_suspended : 1;
   uint32_t is_tmz_queue : 1;
   uint32_t map_kiq_utility_queue : 1;
   uint32_t is_kfd_process : 1;
   uint32_t trap_en : 1;
   uint32_t is_aql_queue : 1;
   uint32_t skip_process_ctx_clear : 1;
   uint32_t map_legacy_kq : 1;
   uint32_t exclusively_scheduled : 1;
   uint32_t is_long_running : 1;
   uint32_t is_dwm_queue : 1;
   uint32_t reserved  : 15;
  };
  struct MES_API_STATUS api_status;
  uint64_t  tma_addr;
  uint32_t  sch_id;
  uint64_t  timestamp;
  uint32_t  process_context_array_index;
  uint32_t  gang_context_array_index;
  uint32_t  pipe_id; //used for mapping legacy kernel queue
  uint32_t  queue_id;
  uint32_t  alignment_mode_setting;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__REMOVE_QUEUE {
 struct {
  union MES_API_HEADER header;
  uint32_t  doorbell_offset;
  uint64_t  gang_context_addr;

  struct {
   uint32_t reserved01    : 1;
   uint32_t unmap_kiq_utility_queue  : 1;
   uint32_t preempt_legacy_gfx_queue : 1;
   uint32_t unmap_legacy_queue   : 1;
   uint32_t reserved    : 28;
  };
  struct MES_API_STATUS  api_status;

  uint32_t   pipe_id;
  uint32_t   queue_id;

  uint64_t   tf_addr;
  uint32_t   tf_data;

  enum MES_QUEUE_TYPE  queue_type;
  uint64_t   timestamp;
  uint32_t   gang_context_array_index;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__SET_SCHEDULING_CONFIG {
 struct {
  union MES_API_HEADER header;
  /* Grace period when preempting another priority band for this priority band.
 * The value for idle priority band is ignored, as it never preempts other bands.
 */
  uint64_t  grace_period_other_levels[AMD_PRIORITY_NUM_LEVELS];

  /* Default quantum for scheduling across processes within a priority band. */
  uint64_t  process_quantum_for_level[AMD_PRIORITY_NUM_LEVELS];

  /* Default grace period for processes that preempt each other within a priority band.*/
  uint64_t  process_grace_period_same_level[AMD_PRIORITY_NUM_LEVELS];

  /* For normal level this field specifies the target GPU percentage in situations when it's starved by the high level.
 * Valid values are between 0 and 50, with the default being 10.
 */
  uint32_t  normal_yield_percent;

  struct MES_API_STATUS api_status;
  uint64_t  timestamp;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__PERFORM_YIELD {
 struct {
  union MES_API_HEADER header;
  uint32_t  dummy;
  struct MES_API_STATUS api_status;
  uint64_t  timestamp;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__CHANGE_GANG_PRIORITY_LEVEL {
 struct {
  union MES_API_HEADER  header;
  uint32_t   inprocess_gang_priority;
  enum MES_AMD_PRIORITY_LEVEL gang_global_priority_level;
  uint64_t   gang_quantum;
  uint64_t   gang_context_addr;
  struct MES_API_STATUS  api_status;
  uint32_t   doorbell_offset;
  uint64_t   timestamp;
  uint32_t   gang_context_array_index;
  struct {
   uint32_t  queue_quantum_scale : 2;
   uint32_t  queue_quantum_duration : 8;
   uint32_t  apply_quantum_all_processes : 1;
   uint32_t  reserved  : 21;
  };
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__SUSPEND {
 struct {
  union MES_API_HEADER header;
  /* false - suspend all gangs; true - specific gang */
  struct {
   uint32_t suspend_all_gangs : 1;
   uint32_t reserved : 31;
  };
  /* gang_context_addr is valid only if suspend_all = false */

  uint64_t  gang_context_addr;

  uint64_t  suspend_fence_addr;
  uint32_t  suspend_fence_value;

  struct MES_API_STATUS api_status;

  union {
   uint32_t return_value; // to be removed
   uint32_t sch_id;       //keep the old return_value temporarily for compatibility
  };
  uint32_t  doorbell_offset;
  uint64_t  timestamp;
  enum MES_QUEUE_TYPE legacy_uq_type;
  enum MES_AMD_PRIORITY_LEVEL legacy_uq_priority_level;
  uint32_t  gang_context_array_index;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__RESUME {
 struct {
  union MES_API_HEADER header;
  /* false - resume all gangs; true - specified gang */
  struct {
   uint32_t resume_all_gangs : 1;
   uint32_t reserved : 31;
  };
  /* valid only if resume_all_gangs = false */
  uint64_t  gang_context_addr;

  struct MES_API_STATUS api_status;
  uint32_t  doorbell_offset;
  uint64_t  timestamp;
  uint32_t  gang_context_array_index;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__RESET {
 struct {
  union MES_API_HEADER  header;

  struct {
   /* Only reset the queue given by doorbell_offset (not entire gang) */
   uint32_t  reset_queue_only : 1;
   /* Hang detection first then reset any queues that are hung */
   uint32_t  hang_detect_then_reset : 1;
   /* Only do hang detection (no reset) */
   uint32_t  hang_detect_only : 1;
   /* Reset HP and LP kernel queues not managed by MES */
   uint32_t  reset_legacy_gfx : 1;
   /* Fallback to use conneceted queue index when CP_CNTX_STAT method fails (gfx pipe 0) */
   uint32_t  use_connected_queue_index : 1;
   /* For gfx pipe 1 */
   uint32_t  use_connected_queue_index_p1 : 1;
   uint32_t  reserved : 26;
  };

  uint64_t   gang_context_addr;

  /* valid only if reset_queue_only = true */
  uint32_t   doorbell_offset;

  /* valid only if hang_detect_then_reset = true */
  uint64_t   doorbell_offset_addr;
  enum MES_QUEUE_TYPE  queue_type;

  /* valid only if reset_legacy_gfx = true */
  uint32_t   pipe_id_lp;
  uint32_t   queue_id_lp;
  uint32_t   vmid_id_lp;
  uint64_t   mqd_mc_addr_lp;
  uint32_t   doorbell_offset_lp;
  uint64_t   wptr_addr_lp;

  uint32_t   pipe_id_hp;
  uint32_t   queue_id_hp;
  uint32_t   vmid_id_hp;
  uint64_t   mqd_mc_addr_hp;
  uint32_t   doorbell_offset_hp;
  uint64_t   wptr_addr_hp;

  struct MES_API_STATUS  api_status;
  uint32_t   active_vmids;
  uint64_t   timestamp;

  uint32_t   gang_context_array_index;

  uint32_t   connected_queue_index;
  uint32_t   connected_queue_index_p1;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__SET_LOGGING_BUFFER {
 struct {
  union MES_API_HEADER  header;
  /* There are separate log buffers for each queue type */
  enum MES_QUEUE_TYPE  log_type;
  /* Log buffer GPU Address */
  uint64_t   logging_buffer_addr;
  /* number of entries in the log buffer */
  uint32_t   number_of_entries;
  /* Entry index at which CPU interrupt needs to be signalled */
  uint32_t   interrupt_entry;

  struct MES_API_STATUS  api_status;
  uint64_t   timestamp;
  uint32_t   vmid;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

enum MES_API_QUERY_MES_OPCODE {
 MES_API_QUERY_MES__GET_CTX_ARRAY_SIZE,
 MES_API_QUERY_MES__CHECK_HEALTHY,
 MES_API_QUERY_MES__MAX,
};

enum { QUERY_MES_MAX_SIZE_IN_DWORDS = 20 };

struct MES_API_QUERY_MES__CTX_ARRAY_SIZE {
 uint64_t proc_ctx_array_size_addr;
 uint64_t gang_ctx_array_size_addr;
};

struct MES_API_QUERY_MES__HEALTHY_CHECK {
 uint64_t healthy_addr;
};

union MESAPI__QUERY_MES_STATUS {
 struct {
  union MES_API_HEADER  header;
  enum MES_API_QUERY_MES_OPCODE subopcode;
  struct MES_API_STATUS  api_status;
  uint64_t   timestamp;
  union {
   struct MES_API_QUERY_MES__CTX_ARRAY_SIZE ctx_array_size;
   struct MES_API_QUERY_MES__HEALTHY_CHECK healthy_check;
   uint32_t data[QUERY_MES_MAX_SIZE_IN_DWORDS];
  };
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__SET_DEBUG_VMID {
 struct {
  union MES_API_HEADER header;
  struct MES_API_STATUS api_status;
  union {
   struct {
   uint32_t use_gds   : 1;
   uint32_t operation : 2;
   uint32_t reserved  : 29;
   } flags;
   uint32_t u32All;
  };
  uint32_t  reserved;
  uint32_t  debug_vmid;
  uint64_t  process_context_addr;
  uint64_t  page_table_base_addr;
  uint64_t  process_va_start;
  uint64_t  process_va_end;
  uint32_t  gds_base;
  uint32_t  gds_size;
  uint32_t  gws_base;
  uint32_t  gws_size;
  uint32_t  oa_mask;

  uint64_t  output_addr; // output addr of the acquired vmid value

  uint64_t  timestamp;

  uint32_t  process_vm_cntl;
  enum MES_QUEUE_TYPE queue_type;

  uint32_t  process_context_array_index;

  uint32_t  alignment_mode_setting;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

enum MESAPI_MISC_OPCODE {
 MESAPI_MISC__WRITE_REG,
 MESAPI_MISC__INV_GART,
 MESAPI_MISC__QUERY_STATUS,
 MESAPI_MISC__READ_REG,
 MESAPI_MISC__WAIT_REG_MEM,
 MESAPI_MISC__SET_SHADER_DEBUGGER,
 MESAPI_MISC__NOTIFY_WORK_ON_UNMAPPED_QUEUE,
 MESAPI_MISC__NOTIFY_TO_UNMAP_PROCESSES,
 MESAPI_MISC__QUERY_HUNG_ENGINE_ID,
 MESAPI_MISC__CHANGE_CONFIG,
 MESAPI_MISC__LAUNCH_CLEANER_SHADER,
 MESAPI_MISC__SETUP_MES_DBGEXT,

 MESAPI_MISC__MAX,
};

enum {MISC_DATA_MAX_SIZE_IN_DWORDS = 20};

struct WRITE_REG {
 uint32_t reg_offset;
 uint32_t reg_value;
};

struct READ_REG {
 uint32_t reg_offset;
 uint64_t buffer_addr;
 union {
  struct {
   uint32_t read64Bits : 1;
   uint32_t reserved : 31;
  } bits;
  uint32_t all;
 } option;
};

struct INV_GART {
 uint64_t inv_range_va_start;
 uint64_t inv_range_size;
};

struct QUERY_STATUS {
 uint32_t context_id;
};

enum WRM_OPERATION {
 WRM_OPERATION__WAIT_REG_MEM,
 WRM_OPERATION__WR_WAIT_WR_REG,

 WRM_OPERATION__MAX,
};

struct WAIT_REG_MEM {
 enum WRM_OPERATION op;
 /* only function = equal_to_the_reference_value and mem_space = register_space supported for now */
 uint32_t reference;
 uint32_t mask;
 uint32_t reg_offset1;
 uint32_t reg_offset2;
};

struct SET_SHADER_DEBUGGER {
 uint64_t process_context_addr;
 union {
  struct {
   uint32_t single_memop : 1; // SQ_DEBUG.single_memop
   uint32_t single_alu_op : 1; // SQ_DEBUG.single_alu_op
   uint32_t reserved : 30;
  };
  uint32_t u32all;
 } flags;
 uint32_t spi_gdbg_per_vmid_cntl;
 uint32_t tcp_watch_cntl[4]; // TCP_WATCHx_CNTL
 uint32_t trap_en;
};

struct SET_GANG_SUBMIT {
 uint64_t gang_context_addr;
 uint64_t slave_gang_context_addr;
 uint32_t gang_context_array_index;
 uint32_t slave_gang_context_array_index;
};

enum MESAPI_MISC__CHANGE_CONFIG_OPTION {
 MESAPI_MISC__CHANGE_CONFIG_OPTION_LIMIT_SINGLE_PROCESS = 0,
 MESAPI_MISC__CHANGE_CONFIG_OPTION_ENABLE_HWS_LOGGING_BUFFER = 1,
 MESAPI_MISC__CHANGE_CONFIG_OPTION_CHANGE_TDR_CONFIG    = 2,

 MESAPI_MISC__CHANGE_CONFIG_OPTION_MAX = 0x1F
};

struct CHANGE_CONFIG {
 enum MESAPI_MISC__CHANGE_CONFIG_OPTION opcode;
 union {
  struct  {
   uint32_t limit_single_process : 1;
   uint32_t enable_hws_logging_buffer : 1;
   uint32_t reserved : 30;
  } bits;
  uint32_t all;
 } option;

 struct {
  uint32_t tdr_level;
  uint32_t tdr_delay;
 } tdr_config;
};

union MESAPI__MISC {
 struct {
  union MES_API_HEADER header;
  enum MESAPI_MISC_OPCODE opcode;
  struct MES_API_STATUS api_status;
  union {
   struct WRITE_REG write_reg;
   struct INV_GART inv_gart;
   struct QUERY_STATUS query_status;
   struct READ_REG read_reg;
   struct WAIT_REG_MEM wait_reg_mem;
   struct SET_SHADER_DEBUGGER set_shader_debugger;
   enum MES_AMD_PRIORITY_LEVEL queue_sch_level;
   struct CHANGE_CONFIG change_config;
   uint32_t data[MISC_DATA_MAX_SIZE_IN_DWORDS];
  };
  uint64_t  timestamp;
  uint32_t  doorbell_offset;
  uint32_t  os_fence;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__UPDATE_ROOT_PAGE_TABLE {
 struct {
  union MES_API_HEADER  header;
  uint64_t   page_table_base_addr;
  uint64_t   process_context_addr;
  struct MES_API_STATUS  api_status;
  uint64_t   timestamp;
  uint32_t   process_context_array_index;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI_AMD_LOG {
 struct {
  union MES_API_HEADER  header;
  uint64_t   p_buffer_memory;
  uint64_t   p_buffer_size_used;
  struct MES_API_STATUS  api_status;
  uint64_t   timestamp;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

enum MES_SE_MODE {
 MES_SE_MODE_INVALID = 0,
 MES_SE_MODE_SINGLE_SE = 1,
 MES_SE_MODE_DUAL_SE = 2,
 MES_SE_MODE_LOWER_POWER = 3,
};

union MESAPI__SET_SE_MODE {
 struct {
  union MES_API_HEADER header;
  /* the new SE mode to apply*/
  enum MES_SE_MODE new_se_mode;
  /* the fence to make sure the ItCpgCtxtSync packet is completed */
  uint64_t cpg_ctxt_sync_fence_addr;
  uint32_t cpg_ctxt_sync_fence_value;
  /* log_seq_time - Scheduler logs the switch seq start/end ts in the IH cookies */
  union {
   struct {
    uint32_t log_seq_time : 1;
    uint32_t reserved : 31;
   };
   uint32_t uint32_all;
  };
  struct MES_API_STATUS api_status;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

union MESAPI__SET_GANG_SUBMIT {
 struct {
  union MES_API_HEADER header;
  struct MES_API_STATUS api_status;
  struct SET_GANG_SUBMIT set_gang_submit;
 };

 uint32_t max_dwords_in_api[API_FRAME_SIZE_IN_DWORDS];
};

#pragma pack(pop)

#endif