/* SPDX-License-Identifier: GPL-2.0 OR MIT */
/*
 * Copyright 2014-2022 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 KFD_MQD_MANAGER_H_
#define KFD_MQD_MANAGER_H_

#include "kfd_priv.h"

#define KFD_MAX_NUM_SE 8
#define KFD_MAX_NUM_SH_PER_SE 2

/**
 * struct mqd_manager
 *
 * @init_mqd: Allocates the mqd buffer on local gpu memory and initialize it.
 *
 * @load_mqd: Loads the mqd to a concrete hqd slot. Used only for no cp
 * scheduling mode.
 *
 * @update_mqd: Handles a update call for the MQD
 *
 * @destroy_mqd: Destroys the HQD slot and by that preempt the relevant queue.
 * Used only for no cp scheduling.
 *
 * @free_mqd: Releases the mqd buffer from local gpu memory.
 *
 * @is_occupied: Checks if the relevant HQD slot is occupied.
 *
 * @get_wave_state: Retrieves context save state and optionally copies the
 * control stack, if kept in the MQD, to the given userspace address.
 *
 * @mqd_mutex: Mqd manager mutex.
 *
 * @dev: The kfd device structure coupled with this module.
 *
 * MQD stands for Memory Queue Descriptor which represents the current queue
 * state in the memory and initiate the HQD (Hardware Queue Descriptor) state.
 * This structure is actually a base class for the different types of MQDs
 * structures for the variant ASICs that should be supported in the future.
 * This base class is also contains all the MQD specific operations.
 * Another important thing to mention is that each queue has a MQD that keeps
 * his state (or context) after each preemption or reassignment.
 * Basically there are a instances of the mqd manager class per MQD type per
 * ASIC. Currently the kfd driver supports only Kaveri so there are instances
 * per KFD_MQD_TYPE for each device.
 *
 */
extern int pipe_priority_map[];
struct mqd_manager {
        struct kfd_mem_obj*     (*allocate_mqd)(struct kfd_node *kfd,
                struct queue_properties *q);

        void    (*init_mqd)(struct mqd_manager *mm, void **mqd,
                        struct kfd_mem_obj *mqd_mem_obj, uint64_t *gart_addr,
                        struct queue_properties *q);

        int     (*load_mqd)(struct mqd_manager *mm, void *mqd,
                                uint32_t pipe_id, uint32_t queue_id,
                                struct queue_properties *p,
                                struct mm_struct *mms);

        void    (*update_mqd)(struct mqd_manager *mm, void *mqd,
                                struct queue_properties *q,
                                struct mqd_update_info *minfo);

        int     (*destroy_mqd)(struct mqd_manager *mm, void *mqd,
                                enum kfd_preempt_type type,
                                unsigned int timeout, uint32_t pipe_id,
                                uint32_t queue_id);

        void    (*free_mqd)(struct mqd_manager *mm, void *mqd,
                                struct kfd_mem_obj *mqd_mem_obj);

        bool    (*is_occupied)(struct mqd_manager *mm, void *mqd,
                                uint64_t queue_address, uint32_t pipe_id,
                                uint32_t queue_id);

        int     (*get_wave_state)(struct mqd_manager *mm, void *mqd,
                                  struct queue_properties *q,
                                  void __user *ctl_stack,
                                  u32 *ctl_stack_used_size,
                                  u32 *save_area_used_size);

        void    (*get_checkpoint_info)(struct mqd_manager *mm, void *mqd, uint32_t *ctl_stack_size);

        void    (*checkpoint_mqd)(struct mqd_manager *mm,
                                  void *mqd,
                                  void *mqd_dst,
                                  void *ctl_stack_dst);

        void    (*restore_mqd)(struct mqd_manager *mm, void **mqd,
                                struct kfd_mem_obj *mqd_mem_obj, uint64_t *gart_addr,
                                struct queue_properties *p,
                                const void *mqd_src,
                                const void *ctl_stack_src,
                                const u32 ctl_stack_size);

#if defined(CONFIG_DEBUG_FS)
        int     (*debugfs_show_mqd)(struct seq_file *m, void *data);
#endif
        bool (*check_preemption_failed)(struct mqd_manager *mm, void *mqd);
        uint64_t (*mqd_stride)(struct mqd_manager *mm,
                                struct queue_properties *p);

        struct mutex    mqd_mutex;
        struct kfd_node *dev;
        uint32_t mqd_size;
};

struct mqd_user_context_save_area_header {
        /* Byte offset from start of user context
         * save area to the last saved top (lowest
         * address) of control stack data. Must be
         * 4 byte aligned.
         */
        uint32_t control_stack_offset;

        /* Byte size of the last saved control stack
         * data. Must be 4 byte aligned.
         */
        uint32_t control_stack_size;

        /* Byte offset from start of user context save
         * area to the last saved base (lowest address)
         * of wave state data. Must be 4 byte aligned.
         */
        uint32_t wave_state_offset;

        /* Byte size of the last saved wave state data.
         * Must be 4 byte aligned.
         */
        uint32_t wave_state_size;
};

struct kfd_mem_obj *allocate_hiq_mqd(struct kfd_node *dev,
                                struct queue_properties *q);

struct kfd_mem_obj *allocate_sdma_mqd(struct kfd_node *dev,
                                        struct queue_properties *q);
void free_mqd_hiq_sdma(struct mqd_manager *mm, void *mqd,
                                struct kfd_mem_obj *mqd_mem_obj);

void mqd_symmetrically_map_cu_mask(struct mqd_manager *mm,
                const uint32_t *cu_mask, uint32_t cu_mask_count,
                uint32_t *se_mask, uint32_t inst);

int kfd_hiq_load_mqd_kiq(struct mqd_manager *mm, void *mqd,
                uint32_t pipe_id, uint32_t queue_id,
                struct queue_properties *p, struct mm_struct *mms);

int kfd_destroy_mqd_cp(struct mqd_manager *mm, void *mqd,
                enum kfd_preempt_type type, unsigned int timeout,
                uint32_t pipe_id, uint32_t queue_id);

void kfd_free_mqd_cp(struct mqd_manager *mm, void *mqd,
                struct kfd_mem_obj *mqd_mem_obj);

bool kfd_is_occupied_cp(struct mqd_manager *mm, void *mqd,
                 uint64_t queue_address, uint32_t pipe_id,
                 uint32_t queue_id);

int kfd_load_mqd_sdma(struct mqd_manager *mm, void *mqd,
                uint32_t pipe_id, uint32_t queue_id,
                struct queue_properties *p, struct mm_struct *mms);

int kfd_destroy_mqd_sdma(struct mqd_manager *mm, void *mqd,
                enum kfd_preempt_type type, unsigned int timeout,
                uint32_t pipe_id, uint32_t queue_id);

bool kfd_is_occupied_sdma(struct mqd_manager *mm, void *mqd,
                uint64_t queue_address, uint32_t pipe_id,
                uint32_t queue_id);

void kfd_get_hiq_xcc_mqd(struct kfd_node *dev,
                struct kfd_mem_obj *mqd_mem_obj, uint32_t virtual_xcc_id);

uint64_t kfd_hiq_mqd_stride(struct kfd_node *dev);
uint64_t kfd_mqd_stride(struct mqd_manager *mm,
                        struct queue_properties *q);
bool kfd_check_hiq_mqd_doorbell_id(struct kfd_node *node, uint32_t doorbell_id,
                                   uint32_t inst);
#endif /* KFD_MQD_MANAGER_H_ */