/*
 * Copyright (c) 2018-2021 Maxime Villard, m00nbsd.net
 * All rights reserved.
 *
 * This code is part of the NVMM hypervisor.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _NVMM_H_
#define _NVMM_H_

#include <sys/cdefs.h>
#include <sys/types.h>

#ifndef _KERNEL
#include <stdbool.h>
#endif

typedef uint64_t        gpaddr_t;
typedef uint64_t        gvaddr_t;

typedef uint32_t        nvmm_machid_t;
typedef uint32_t        nvmm_cpuid_t;

#undef CTASSERT
#define CTASSERT(x)             NVMM_CTASSERT(x, __LINE__)
#define NVMM_CTASSERT(x, y)     NVMM__CTASSERT(x, y)
#define NVMM__CTASSERT(x, y)    typedef char __assert ## y[(x) ? 1 : -1] __unused

#if defined(__x86_64__)
#if defined(__NetBSD__)
#include <dev/nvmm/x86/nvmm_x86.h>
#elif defined(__DragonFly__)
#include <dev/virtual/nvmm/x86/nvmm_x86.h>
#endif
#endif /* __x86_64__ */

/*
 * v1: Initial version
 * v2: Create VCPU comm page in nvmm_vcpu_create() in kernel
 * v3: Add 'nvmm_capability.comm_size' for unmapping the comm page
 */
#define NVMM_KERN_VERSION               3

struct nvmm_capability {
        uint32_t version;
        uint32_t state_size;
        uint32_t comm_size;
        uint32_t max_machines;
        uint32_t max_vcpus;
        uint64_t max_ram;
        struct nvmm_cap_md arch;
};

/* Machine configuration slots. */
#define NVMM_MACH_CONF_LIBNVMM_BEGIN    0
#define NVMM_MACH_CONF_MI_BEGIN         100
#define NVMM_MACH_CONF_MD_BEGIN         200
#define NVMM_MACH_CONF_MD(op)           (op - NVMM_MACH_CONF_MD_BEGIN)

/* VCPU configuration slots. */
#define NVMM_VCPU_CONF_LIBNVMM_BEGIN    0
#define NVMM_VCPU_CONF_MI_BEGIN         100
#define NVMM_VCPU_CONF_MD_BEGIN         200
#define NVMM_VCPU_CONF_MD(op)           (op - NVMM_VCPU_CONF_MD_BEGIN)

struct nvmm_comm_page {
        /* State. */
        uint64_t state_wanted;
        uint64_t state_cached;
        uint64_t state_commit;
        struct nvmm_vcpu_state state;

        /* Event. */
        bool event_commit;
        struct nvmm_vcpu_event event;
};

#endif