/*
 * Copyright(c) 2011-2016 Intel Corporation. All rights reserved.
 *
 * 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 (including the next
 * paragraph) 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 AUTHORS OR COPYRIGHT HOLDERS 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.
 *
 * Authors:
 *    Kevin Tian <kevin.tian@intel.com>
 *    Eddie Dong <eddie.dong@intel.com>
 *
 * Contributors:
 *    Niu Bing <bing.niu@intel.com>
 *    Zhi Wang <zhi.a.wang@intel.com>
 *
 */

#ifndef _GVT_H_
#define _GVT_H_

#include <uapi/linux/pci_regs.h>
#include <linux/mdev.h>
#include <linux/vfio.h>
#include <asm/kvm_page_track.h>

#include "display/intel_display_limits.h"

#include "gt/intel_gt.h"

#include "cmd_parser.h"
#include "debug.h"
#include "display.h"
#include "dmabuf.h"
#include "edid.h"
#include "execlist.h"
#include "fb_decoder.h"
#include "gtt.h"
#include "intel_gvt.h"
#include "interrupt.h"
#include "mmio.h"
#include "mmio_context.h"
#include "page_track.h"
#include "reg.h"
#include "scheduler.h"

#define GVT_MAX_VGPU 8

struct engine_mmio;

/* Describe per-platform limitations. */
struct intel_gvt_device_info {
        u32 max_support_vgpus;
        u32 cfg_space_size;
        u32 mmio_size;
        u32 mmio_bar;
        unsigned long msi_cap_offset;
        u32 gtt_start_offset;
        u32 gtt_entry_size;
        u32 gtt_entry_size_shift;
        int gmadr_bytes_in_cmd;
        u32 max_surface_size;
};

/* GM resources owned by a vGPU */
struct intel_vgpu_gm {
        u64 aperture_sz;
        u64 hidden_sz;
        struct drm_mm_node low_gm_node;
        struct drm_mm_node high_gm_node;
};

#define INTEL_GVT_MAX_NUM_FENCES 32

/* Fences owned by a vGPU */
struct intel_vgpu_fence {
        struct i915_fence_reg *regs[INTEL_GVT_MAX_NUM_FENCES];
        u32 size;
};

struct intel_vgpu_mmio {
        void *vreg;
};

#define INTEL_GVT_MAX_BAR_NUM 4

struct intel_vgpu_pci_bar {
        u64 size;
        bool tracked;
};

struct intel_vgpu_cfg_space {
        unsigned char virtual_cfg_space[PCI_CFG_SPACE_EXP_SIZE];
        struct intel_vgpu_pci_bar bar[INTEL_GVT_MAX_BAR_NUM];
        u32 pmcsr_off;
};

#define vgpu_cfg_space(vgpu) ((vgpu)->cfg_space.virtual_cfg_space)

struct intel_vgpu_irq {
        bool irq_warn_once[INTEL_GVT_EVENT_MAX];
        DECLARE_BITMAP(flip_done_event[I915_MAX_PIPES],
                       INTEL_GVT_EVENT_MAX);
};

struct intel_vgpu_opregion {
        void *va;
        u32 gfn[INTEL_GVT_OPREGION_PAGES];
};

#define vgpu_opregion(vgpu) (&(vgpu->opregion))

struct intel_vgpu_display {
        struct intel_vgpu_i2c_edid i2c_edid;
        struct intel_vgpu_port ports[I915_MAX_PORTS];
        struct intel_vgpu_sbi sbi;
        enum port port_num;
};

struct vgpu_sched_ctl {
        int weight;
};

enum {
        INTEL_VGPU_EXECLIST_SUBMISSION = 1,
        INTEL_VGPU_GUC_SUBMISSION,
};

struct intel_vgpu_submission_ops {
        const char *name;
        int (*init)(struct intel_vgpu *vgpu, intel_engine_mask_t engine_mask);
        void (*clean)(struct intel_vgpu *vgpu, intel_engine_mask_t engine_mask);
        void (*reset)(struct intel_vgpu *vgpu, intel_engine_mask_t engine_mask);
};

struct intel_vgpu_submission {
        struct intel_vgpu_execlist execlist[I915_NUM_ENGINES];
        struct list_head workload_q_head[I915_NUM_ENGINES];
        struct intel_context *shadow[I915_NUM_ENGINES];
        struct kmem_cache *workloads;
        atomic_t running_workload_num;
        union {
                u64 i915_context_pml4;
                u64 i915_context_pdps[GEN8_3LVL_PDPES];
        };
        DECLARE_BITMAP(shadow_ctx_desc_updated, I915_NUM_ENGINES);
        DECLARE_BITMAP(tlb_handle_pending, I915_NUM_ENGINES);
        void *ring_scan_buffer[I915_NUM_ENGINES];
        int ring_scan_buffer_size[I915_NUM_ENGINES];
        const struct intel_vgpu_submission_ops *ops;
        int virtual_submission_interface;
        bool active;
        struct {
                u32 lrca;
                bool valid;
                u64 ring_context_gpa;
        } last_ctx[I915_NUM_ENGINES];
};

#define KVMGT_DEBUGFS_FILENAME          "kvmgt_nr_cache_entries"

enum {
        INTEL_VGPU_STATUS_ATTACHED = 0,
        INTEL_VGPU_STATUS_ACTIVE,
        INTEL_VGPU_STATUS_NR_BITS,
};

struct intel_vgpu {
        struct vfio_device vfio_device;
        struct intel_gvt *gvt;
        struct mutex vgpu_lock;
        int id;
        DECLARE_BITMAP(status, INTEL_VGPU_STATUS_NR_BITS);
        bool pv_notified;
        bool failsafe;
        unsigned int resetting_eng;

        /* Both sched_data and sched_ctl can be seen a part of the global gvt
         * scheduler structure. So below 2 vgpu data are protected
         * by sched_lock, not vgpu_lock.
         */
        void *sched_data;
        struct vgpu_sched_ctl sched_ctl;

        struct intel_vgpu_fence fence;
        struct intel_vgpu_gm gm;
        struct intel_vgpu_cfg_space cfg_space;
        struct intel_vgpu_mmio mmio;
        struct intel_vgpu_irq irq;
        struct intel_vgpu_gtt gtt;
        struct intel_vgpu_opregion opregion;
        struct intel_vgpu_display display;
        struct intel_vgpu_submission submission;
        struct radix_tree_root page_track_tree;
        u32 hws_pga[I915_NUM_ENGINES];
        /* Set on PCI_D3, reset on DMLR, not reflecting the actual PM state */
        bool d3_entered;

        struct dentry *debugfs;

        struct list_head dmabuf_obj_list_head;
        struct mutex dmabuf_lock;
        struct idr object_idr;
        struct intel_vgpu_vblank_timer vblank_timer;

        u32 scan_nonprivbb;

        struct vfio_region *region;
        int num_regions;
        struct eventfd_ctx *msi_trigger;

        /*
         * Two caches are used to avoid mapping duplicated pages (eg.
         * scratch pages). This help to reduce dma setup overhead.
         */
        struct rb_root gfn_cache;
        struct rb_root dma_addr_cache;
        unsigned long nr_cache_entries;
        struct mutex cache_lock;

        struct kvm_page_track_notifier_node track_node;
#define NR_BKT (1 << 18)
        struct hlist_head ptable[NR_BKT];
#undef NR_BKT
};

/* validating GM healthy status*/
#define vgpu_is_vm_unhealthy(ret_val) \
        (((ret_val) == -EBADRQC) || ((ret_val) == -EFAULT))

struct intel_gvt_gm {
        unsigned long vgpu_allocated_low_gm_size;
        unsigned long vgpu_allocated_high_gm_size;
};

struct intel_gvt_fence {
        unsigned long vgpu_allocated_fence_num;
};

/* Special MMIO blocks. */
struct gvt_mmio_block {
        i915_reg_t   offset;
        unsigned int size;
        gvt_mmio_func read;
        gvt_mmio_func write;
};

#define INTEL_GVT_MMIO_HASH_BITS 11

struct intel_gvt_mmio {
        u16 *mmio_attribute;
/* Register contains RO bits */
#define F_RO            (1 << 0)
/* Register contains graphics address */
#define F_GMADR         (1 << 1)
/* Mode mask registers with high 16 bits as the mask bits */
#define F_MODE_MASK     (1 << 2)
/* This reg can be accessed by GPU commands */
#define F_CMD_ACCESS    (1 << 3)
/* This reg has been accessed by a VM */
#define F_ACCESSED      (1 << 4)
/* This reg requires save & restore during host PM suspend/resume */
#define F_PM_SAVE       (1 << 5)
/* This reg could be accessed by unaligned address */
#define F_UNALIGN       (1 << 6)
/* This reg is in GVT's mmio save-restor list and in hardware
 * logical context image
 */
#define F_SR_IN_CTX     (1 << 7)
/* Value of command write of this reg needs to be patched */
#define F_CMD_WRITE_PATCH       (1 << 8)

        struct gvt_mmio_block *mmio_block;
        unsigned int num_mmio_block;

        DECLARE_HASHTABLE(mmio_info_table, INTEL_GVT_MMIO_HASH_BITS);
        unsigned long num_tracked_mmio;
};

struct intel_gvt_firmware {
        void *cfg_space;
        void *mmio;
        bool firmware_loaded;
};

struct intel_vgpu_config {
        unsigned int low_mm;
        unsigned int high_mm;
        unsigned int fence;

        /*
         * A vGPU with a weight of 8 will get twice as much GPU as a vGPU with
         * a weight of 4 on a contended host, different vGPU type has different
         * weight set. Legal weights range from 1 to 16.
         */
        unsigned int weight;
        enum intel_vgpu_edid edid;
        const char *name;
};

struct intel_vgpu_type {
        struct mdev_type type;
        char name[16];
        const struct intel_vgpu_config *conf;
};

struct intel_gvt {
        /* GVT scope lock, protect GVT itself, and all resource currently
         * not yet protected by special locks(vgpu and scheduler lock).
         */
        struct mutex lock;
        /* scheduler scope lock, protect gvt and vgpu schedule related data */
        struct mutex sched_lock;

        struct intel_gt *gt;
        struct idr vgpu_idr;    /* vGPU IDR pool */

        struct intel_gvt_device_info device_info;
        struct intel_gvt_gm gm;
        struct intel_gvt_fence fence;
        struct intel_gvt_mmio mmio;
        struct intel_gvt_firmware firmware;
        struct intel_gvt_irq irq;
        struct intel_gvt_gtt gtt;
        struct intel_gvt_workload_scheduler scheduler;
        struct notifier_block shadow_ctx_notifier_block[I915_NUM_ENGINES];
        DECLARE_HASHTABLE(cmd_table, GVT_CMD_HASH_BITS);
        struct mdev_parent parent;
        struct mdev_type **mdev_types;
        struct intel_vgpu_type *types;
        unsigned int num_types;
        struct intel_vgpu *idle_vgpu;

        struct task_struct *service_thread;
        wait_queue_head_t service_thread_wq;

        /* service_request is always used in bit operation, we should always
         * use it with atomic bit ops so that no need to use gvt big lock.
         */
        unsigned long service_request;

        struct {
                struct engine_mmio *mmio;
                int ctx_mmio_count[I915_NUM_ENGINES];
                u32 *tlb_mmio_offset_list;
                u32 tlb_mmio_offset_list_cnt;
                u32 *mocs_mmio_offset_list;
                u32 mocs_mmio_offset_list_cnt;
        } engine_mmio_list;
        bool is_reg_whitelist_updated;

        struct dentry *debugfs_root;
};

enum {
        /* Scheduling trigger by timer */
        INTEL_GVT_REQUEST_SCHED = 0,

        /* Scheduling trigger by event */
        INTEL_GVT_REQUEST_EVENT_SCHED = 1,

        /* per-vGPU vblank emulation request */
        INTEL_GVT_REQUEST_EMULATE_VBLANK = 2,
        INTEL_GVT_REQUEST_EMULATE_VBLANK_MAX = INTEL_GVT_REQUEST_EMULATE_VBLANK
                + GVT_MAX_VGPU,
};

static inline void intel_gvt_request_service(struct intel_gvt *gvt,
                int service)
{
        set_bit(service, (void *)&gvt->service_request);
        wake_up(&gvt->service_thread_wq);
}

void intel_gvt_free_firmware(struct intel_gvt *gvt);
int intel_gvt_load_firmware(struct intel_gvt *gvt);

/* Aperture/GM space definitions for GVT device */
#define MB_TO_BYTES(mb) ((mb) << 20ULL)
#define BYTES_TO_MB(b) ((b) >> 20ULL)

#define HOST_LOW_GM_SIZE MB_TO_BYTES(128)
#define HOST_HIGH_GM_SIZE MB_TO_BYTES(384)
#define HOST_FENCE 4

#define gvt_to_ggtt(gvt)        ((gvt)->gt->ggtt)

/* Aperture/GM space definitions for GVT device */
#define gvt_aperture_sz(gvt)      gvt_to_ggtt(gvt)->mappable_end
#define gvt_aperture_pa_base(gvt) gvt_to_ggtt(gvt)->gmadr.start

#define gvt_ggtt_gm_sz(gvt)     gvt_to_ggtt(gvt)->vm.total
#define gvt_ggtt_sz(gvt)        (gvt_to_ggtt(gvt)->vm.total >> PAGE_SHIFT << 3)
#define gvt_hidden_sz(gvt)      (gvt_ggtt_gm_sz(gvt) - gvt_aperture_sz(gvt))

#define gvt_aperture_gmadr_base(gvt) (0)
#define gvt_aperture_gmadr_end(gvt) (gvt_aperture_gmadr_base(gvt) \
                                     + gvt_aperture_sz(gvt) - 1)

#define gvt_hidden_gmadr_base(gvt) (gvt_aperture_gmadr_base(gvt) \
                                    + gvt_aperture_sz(gvt))
#define gvt_hidden_gmadr_end(gvt) (gvt_hidden_gmadr_base(gvt) \
                                   + gvt_hidden_sz(gvt) - 1)

#define gvt_fence_sz(gvt) (gvt_to_ggtt(gvt)->num_fences)

/* Aperture/GM space definitions for vGPU */
#define vgpu_aperture_offset(vgpu)      ((vgpu)->gm.low_gm_node.start)
#define vgpu_hidden_offset(vgpu)        ((vgpu)->gm.high_gm_node.start)
#define vgpu_aperture_sz(vgpu)          ((vgpu)->gm.aperture_sz)
#define vgpu_hidden_sz(vgpu)            ((vgpu)->gm.hidden_sz)

#define vgpu_aperture_pa_base(vgpu) \
        (gvt_aperture_pa_base(vgpu->gvt) + vgpu_aperture_offset(vgpu))

#define vgpu_ggtt_gm_sz(vgpu) ((vgpu)->gm.aperture_sz + (vgpu)->gm.hidden_sz)

#define vgpu_aperture_pa_end(vgpu) \
        (vgpu_aperture_pa_base(vgpu) + vgpu_aperture_sz(vgpu) - 1)

#define vgpu_aperture_gmadr_base(vgpu) (vgpu_aperture_offset(vgpu))
#define vgpu_aperture_gmadr_end(vgpu) \
        (vgpu_aperture_gmadr_base(vgpu) + vgpu_aperture_sz(vgpu) - 1)

#define vgpu_hidden_gmadr_base(vgpu) (vgpu_hidden_offset(vgpu))
#define vgpu_hidden_gmadr_end(vgpu) \
        (vgpu_hidden_gmadr_base(vgpu) + vgpu_hidden_sz(vgpu) - 1)

#define vgpu_fence_sz(vgpu) (vgpu->fence.size)

/* ring context size i.e. the first 0x50 dwords*/
#define RING_CTX_SIZE 320

int intel_vgpu_alloc_resource(struct intel_vgpu *vgpu,
                              const struct intel_vgpu_config *conf);
void intel_vgpu_reset_resource(struct intel_vgpu *vgpu);
void intel_vgpu_free_resource(struct intel_vgpu *vgpu);
void intel_vgpu_write_fence(struct intel_vgpu *vgpu,
        u32 fence, u64 value);

/*
 * Macros for easily accessing vGPU virtual/shadow register.
 * Explicitly separate use for typed MMIO reg or real offset.
 */
#define vgpu_vreg_t(vgpu, reg) \
        (*(u32 *)(vgpu->mmio.vreg + i915_mmio_reg_offset(reg)))
#define vgpu_vreg(vgpu, offset) \
        (*(u32 *)(vgpu->mmio.vreg + (offset)))
#define vgpu_vreg64_t(vgpu, reg) \
        (*(u64 *)(vgpu->mmio.vreg + i915_mmio_reg_offset(reg)))
#define vgpu_vreg64(vgpu, offset) \
        (*(u64 *)(vgpu->mmio.vreg + (offset)))

#define for_each_active_vgpu(gvt, vgpu, id) \
        idr_for_each_entry((&(gvt)->vgpu_idr), (vgpu), (id)) \
                for_each_if(test_bit(INTEL_VGPU_STATUS_ACTIVE, vgpu->status))

static inline void intel_vgpu_write_pci_bar(struct intel_vgpu *vgpu,
                                            u32 offset, u32 val, bool low)
{
        u32 *pval;

        /* BAR offset should be 32 bits algiend */
        offset = rounddown(offset, 4);
        pval = (u32 *)(vgpu_cfg_space(vgpu) + offset);

        if (low) {
                /*
                 * only update bit 31 - bit 4,
                 * leave the bit 3 - bit 0 unchanged.
                 */
                *pval = (val & GENMASK(31, 4)) | (*pval & GENMASK(3, 0));
        } else {
                *pval = val;
        }
}

int intel_gvt_init_vgpu_types(struct intel_gvt *gvt);
void intel_gvt_clean_vgpu_types(struct intel_gvt *gvt);

struct intel_vgpu *intel_gvt_create_idle_vgpu(struct intel_gvt *gvt);
void intel_gvt_destroy_idle_vgpu(struct intel_vgpu *vgpu);
int intel_gvt_create_vgpu(struct intel_vgpu *vgpu,
                          const struct intel_vgpu_config *conf);
void intel_gvt_destroy_vgpu(struct intel_vgpu *vgpu);
void intel_gvt_release_vgpu(struct intel_vgpu *vgpu);
void intel_gvt_reset_vgpu_locked(struct intel_vgpu *vgpu, bool dmlr,
                                 intel_engine_mask_t engine_mask);
void intel_gvt_reset_vgpu(struct intel_vgpu *vgpu);
void intel_gvt_activate_vgpu(struct intel_vgpu *vgpu);
void intel_gvt_deactivate_vgpu(struct intel_vgpu *vgpu);

int intel_gvt_set_opregion(struct intel_vgpu *vgpu);
int intel_gvt_set_edid(struct intel_vgpu *vgpu, int port_num);

/* validating GM functions */
#define vgpu_gmadr_is_aperture(vgpu, gmadr) \
        ((gmadr >= vgpu_aperture_gmadr_base(vgpu)) && \
         (gmadr <= vgpu_aperture_gmadr_end(vgpu)))

#define vgpu_gmadr_is_hidden(vgpu, gmadr) \
        ((gmadr >= vgpu_hidden_gmadr_base(vgpu)) && \
         (gmadr <= vgpu_hidden_gmadr_end(vgpu)))

#define vgpu_gmadr_is_valid(vgpu, gmadr) \
         ((vgpu_gmadr_is_aperture(vgpu, gmadr) || \
          (vgpu_gmadr_is_hidden(vgpu, gmadr))))

#define gvt_gmadr_is_aperture(gvt, gmadr) \
         ((gmadr >= gvt_aperture_gmadr_base(gvt)) && \
          (gmadr <= gvt_aperture_gmadr_end(gvt)))

#define gvt_gmadr_is_hidden(gvt, gmadr) \
          ((gmadr >= gvt_hidden_gmadr_base(gvt)) && \
           (gmadr <= gvt_hidden_gmadr_end(gvt)))

#define gvt_gmadr_is_valid(gvt, gmadr) \
          (gvt_gmadr_is_aperture(gvt, gmadr) || \
            gvt_gmadr_is_hidden(gvt, gmadr))

bool intel_gvt_ggtt_validate_range(struct intel_vgpu *vgpu, u64 addr, u32 size);

void intel_vgpu_init_cfg_space(struct intel_vgpu *vgpu,
                bool primary);
void intel_vgpu_reset_cfg_space(struct intel_vgpu *vgpu);

int intel_vgpu_emulate_cfg_read(struct intel_vgpu *vgpu, unsigned int offset,
                void *p_data, unsigned int bytes);

int intel_vgpu_emulate_cfg_write(struct intel_vgpu *vgpu, unsigned int offset,
                void *p_data, unsigned int bytes);

void intel_vgpu_emulate_hotplug(struct intel_vgpu *vgpu, bool connected);

static inline u64 intel_vgpu_get_bar_gpa(struct intel_vgpu *vgpu, int bar)
{
        /* We are 64bit bar. */
        return (*(u64 *)(vgpu->cfg_space.virtual_cfg_space + bar)) &
                        PCI_BASE_ADDRESS_MEM_MASK;
}

void intel_vgpu_clean_opregion(struct intel_vgpu *vgpu);
int intel_vgpu_init_opregion(struct intel_vgpu *vgpu);
int intel_vgpu_opregion_base_write_handler(struct intel_vgpu *vgpu, u32 gpa);

int intel_vgpu_emulate_opregion_request(struct intel_vgpu *vgpu, u32 swsci);
void populate_pvinfo_page(struct intel_vgpu *vgpu);

int intel_gvt_scan_and_shadow_workload(struct intel_vgpu_workload *workload);
void enter_failsafe_mode(struct intel_vgpu *vgpu, int reason);
void intel_vgpu_detach_regions(struct intel_vgpu *vgpu);

enum {
        GVT_FAILSAFE_UNSUPPORTED_GUEST,
        GVT_FAILSAFE_INSUFFICIENT_RESOURCE,
        GVT_FAILSAFE_GUEST_ERR,
};

static inline intel_wakeref_t mmio_hw_access_pre(struct intel_gt *gt)
{
        return intel_runtime_pm_get(gt->uncore->rpm);
}

static inline void mmio_hw_access_post(struct intel_gt *gt,
                                       intel_wakeref_t wakeref)
{
        intel_runtime_pm_put(gt->uncore->rpm, wakeref);
}

/**
 * intel_gvt_mmio_set_accessed - mark a MMIO has been accessed
 * @gvt: a GVT device
 * @offset: register offset
 *
 */
static inline void intel_gvt_mmio_set_accessed(
                        struct intel_gvt *gvt, unsigned int offset)
{
        gvt->mmio.mmio_attribute[offset >> 2] |= F_ACCESSED;
}

/**
 * intel_gvt_mmio_is_cmd_accessible - if a MMIO could be accessed by command
 * @gvt: a GVT device
 * @offset: register offset
 *
 * Returns:
 * True if an MMIO is able to be accessed by GPU commands
 */
static inline bool intel_gvt_mmio_is_cmd_accessible(
                        struct intel_gvt *gvt, unsigned int offset)
{
        return gvt->mmio.mmio_attribute[offset >> 2] & F_CMD_ACCESS;
}

/**
 * intel_gvt_mmio_set_cmd_accessible -
 *                              mark a MMIO could be accessible by command
 * @gvt: a GVT device
 * @offset: register offset
 *
 */
static inline void intel_gvt_mmio_set_cmd_accessible(
                        struct intel_gvt *gvt, unsigned int offset)
{
        gvt->mmio.mmio_attribute[offset >> 2] |= F_CMD_ACCESS;
}

/**
 * intel_gvt_mmio_is_unalign - mark a MMIO could be accessed unaligned
 * @gvt: a GVT device
 * @offset: register offset
 *
 */
static inline bool intel_gvt_mmio_is_unalign(
                        struct intel_gvt *gvt, unsigned int offset)
{
        return gvt->mmio.mmio_attribute[offset >> 2] & F_UNALIGN;
}

/**
 * intel_gvt_mmio_has_mode_mask - if a MMIO has a mode mask
 * @gvt: a GVT device
 * @offset: register offset
 *
 * Returns:
 * True if a MMIO has a mode mask in its higher 16 bits, false if it isn't.
 *
 */
static inline bool intel_gvt_mmio_has_mode_mask(
                        struct intel_gvt *gvt, unsigned int offset)
{
        return gvt->mmio.mmio_attribute[offset >> 2] & F_MODE_MASK;
}

/**
 * intel_gvt_mmio_is_sr_in_ctx -
 *              check if an MMIO has F_SR_IN_CTX mask
 * @gvt: a GVT device
 * @offset: register offset
 *
 * Returns:
 * True if an MMIO has an F_SR_IN_CTX  mask, false if it isn't.
 *
 */
static inline bool intel_gvt_mmio_is_sr_in_ctx(
                        struct intel_gvt *gvt, unsigned int offset)
{
        return gvt->mmio.mmio_attribute[offset >> 2] & F_SR_IN_CTX;
}

/**
 * intel_gvt_mmio_set_sr_in_ctx -
 *              mask an MMIO in GVT's mmio save-restore list and also
 *              in hardware logical context image
 * @gvt: a GVT device
 * @offset: register offset
 *
 */
static inline void intel_gvt_mmio_set_sr_in_ctx(
                        struct intel_gvt *gvt, unsigned int offset)
{
        gvt->mmio.mmio_attribute[offset >> 2] |= F_SR_IN_CTX;
}

void intel_gvt_debugfs_add_vgpu(struct intel_vgpu *vgpu);
/**
 * intel_gvt_mmio_set_cmd_write_patch -
 *                              mark an MMIO if its cmd write needs to be
 *                              patched
 * @gvt: a GVT device
 * @offset: register offset
 *
 */
static inline void intel_gvt_mmio_set_cmd_write_patch(
                        struct intel_gvt *gvt, unsigned int offset)
{
        gvt->mmio.mmio_attribute[offset >> 2] |= F_CMD_WRITE_PATCH;
}

/**
 * intel_gvt_mmio_is_cmd_write_patch - check if an mmio's cmd access needs to
 * be patched
 * @gvt: a GVT device
 * @offset: register offset
 *
 * Returns:
 * True if GPU command write to an MMIO should be patched.
 */
static inline bool intel_gvt_mmio_is_cmd_write_patch(
                        struct intel_gvt *gvt, unsigned int offset)
{
        return gvt->mmio.mmio_attribute[offset >> 2] & F_CMD_WRITE_PATCH;
}

/**
 * intel_gvt_read_gpa - copy data from GPA to host data buffer
 * @vgpu: a vGPU
 * @gpa: guest physical address
 * @buf: host data buffer
 * @len: data length
 *
 * Returns:
 * Zero on success, negative error code if failed.
 */
static inline int intel_gvt_read_gpa(struct intel_vgpu *vgpu, unsigned long gpa,
                void *buf, unsigned long len)
{
        if (!test_bit(INTEL_VGPU_STATUS_ATTACHED, vgpu->status))
                return -ESRCH;
        return vfio_dma_rw(&vgpu->vfio_device, gpa, buf, len, false);
}

/**
 * intel_gvt_write_gpa - copy data from host data buffer to GPA
 * @vgpu: a vGPU
 * @gpa: guest physical address
 * @buf: host data buffer
 * @len: data length
 *
 * Returns:
 * Zero on success, negative error code if failed.
 */
static inline int intel_gvt_write_gpa(struct intel_vgpu *vgpu,
                unsigned long gpa, void *buf, unsigned long len)
{
        if (!test_bit(INTEL_VGPU_STATUS_ATTACHED, vgpu->status))
                return -ESRCH;
        return vfio_dma_rw(&vgpu->vfio_device, gpa, buf, len, true);
}

void intel_gvt_debugfs_remove_vgpu(struct intel_vgpu *vgpu);
void intel_gvt_debugfs_init(struct intel_gvt *gvt);
void intel_gvt_debugfs_clean(struct intel_gvt *gvt);

int intel_gvt_page_track_add(struct intel_vgpu *info, u64 gfn);
int intel_gvt_page_track_remove(struct intel_vgpu *info, u64 gfn);
int intel_gvt_dma_pin_guest_page(struct intel_vgpu *vgpu, dma_addr_t dma_addr);
int intel_gvt_dma_map_guest_page(struct intel_vgpu *vgpu, unsigned long gfn,
                unsigned long size, dma_addr_t *dma_addr);
void intel_gvt_dma_unmap_guest_page(struct intel_vgpu *vgpu,
                dma_addr_t dma_addr);

#include "trace.h"

#endif