/******************************************************************************
 * SPDX-License-Identifier: MIT OR GPL-2.0-only
 *
 * hypercall.h
 *
 * FreeBSD-specific hypervisor handling.
 *
 * Copyright (c) 2002-2004, K A Fraser
 *
 * 64-bit updates:
 *   Benjamin Liu <benjamin.liu@intel.com>
 *   Jun Nakajima <jun.nakajima@intel.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation; or, when distributed
 * separately from the Linux kernel or incorporated into other
 * software packages, subject to the following license:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this source file (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
 * 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.
 */

#ifndef __MACHINE_XEN_HYPERCALL_H__
#define __MACHINE_XEN_HYPERCALL_H__

#include <sys/systm.h>

#ifndef __XEN_HYPERVISOR_H__
# error "please don't include this file directly"
#endif

extern char *hypercall_page;

#define __STR(x) #x
#define STR(x) __STR(x)
#define __must_check

#define HYPERCALL_STR(name)                                     \
        "call hypercall_page + ("STR(__HYPERVISOR_##name)" * 32)"

#define _hypercall0(type, name)                                 \
({                                                              \
        type __res;                                             \
        __asm__ volatile (                                      \
                HYPERCALL_STR(name)                             \
                : "=a" (__res)                                  \
                :                                               \
                : "memory" );                                   \
        __res;                                                  \
})

#define _hypercall1(type, name, a1)                             \
({                                                              \
        type __res;                                             \
        long __ign1;                                            \
        __asm__ volatile (                                      \
                HYPERCALL_STR(name)                             \
                : "=a" (__res), "=D" (__ign1)                   \
                : "1" ((long)(a1))                              \
                : "memory" );                                   \
        __res;                                                  \
})

#define _hypercall2(type, name, a1, a2)                         \
({                                                              \
        type __res;                                             \
        long __ign1, __ign2;                                    \
        __asm__ volatile (                                      \
                HYPERCALL_STR(name)                             \
                : "=a" (__res), "=D" (__ign1), "=S" (__ign2)    \
                : "1" ((long)(a1)), "2" ((long)(a2))            \
                : "memory" );                                   \
        __res;                                                  \
})

#define _hypercall3(type, name, a1, a2, a3)                     \
({                                                              \
        type __res;                                             \
        long __ign1, __ign2, __ign3;                            \
        __asm__ volatile (                                      \
                HYPERCALL_STR(name)                             \
                : "=a" (__res), "=D" (__ign1), "=S" (__ign2),   \
                "=d" (__ign3)                                   \
                : "1" ((long)(a1)), "2" ((long)(a2)),           \
                "3" ((long)(a3))                                \
                : "memory" );                                   \
        __res;                                                  \
})

#define _hypercall4(type, name, a1, a2, a3, a4)                 \
({                                                              \
        type __res;                                             \
        long __ign1, __ign2, __ign3;                            \
        register long __arg4 __asm__("r10") = (long)(a4);       \
        __asm__ volatile (                                      \
                HYPERCALL_STR(name)                             \
                : "=a" (__res), "=D" (__ign1), "=S" (__ign2),   \
                  "=d" (__ign3), "+r" (__arg4)                  \
                : "1" ((long)(a1)), "2" ((long)(a2)),           \
                  "3" ((long)(a3))                              \
                : "memory" );                                   \
        __res;                                                  \
})

#define _hypercall5(type, name, a1, a2, a3, a4, a5)             \
({                                                              \
        type __res;                                             \
        long __ign1, __ign2, __ign3;                            \
        register long __arg4 __asm__("r10") = (long)(a4);       \
        register long __arg5 __asm__("r8") = (long)(a5);        \
        __asm__ volatile (                                      \
                HYPERCALL_STR(name)                             \
                : "=a" (__res), "=D" (__ign1), "=S" (__ign2),   \
                  "=d" (__ign3), "+r" (__arg4), "+r" (__arg5)   \
                : "1" ((long)(a1)), "2" ((long)(a2)),           \
                  "3" ((long)(a3))                              \
                : "memory" );                                   \
        __res;                                                  \
})

static inline int
privcmd_hypercall(long op, long a1, long a2, long a3, long a4, long a5)
{
        int __res;
        long __ign1, __ign2, __ign3;
        register long __arg4 __asm__("r10") = (long)(a4);
        register long __arg5 __asm__("r8") = (long)(a5);
        long __call = (long)&hypercall_page + (op * 32);

        if (op >= PAGE_SIZE / 32)
                return -EINVAL;

        __asm__ volatile (
                "call *%[call]"
                : "=a" (__res), "=D" (__ign1), "=S" (__ign2),
                  "=d" (__ign3), "+r" (__arg4), "+r" (__arg5)
                : "1" ((long)(a1)), "2" ((long)(a2)),
                  "3" ((long)(a3)), [call] "a" (__call)
                : "memory" );

        return (__res);
}

static inline int __must_check
HYPERVISOR_set_trap_table(
        const trap_info_t *table)
{
        return _hypercall1(int, set_trap_table, table);
}

static inline int __must_check
HYPERVISOR_mmu_update(
        mmu_update_t *req, unsigned int count, unsigned int *success_count,
        domid_t domid)
{
        return _hypercall4(int, mmu_update, req, count, success_count, domid);
}

static inline int __must_check
HYPERVISOR_mmuext_op(
        struct mmuext_op *op, unsigned int count, unsigned int *success_count,
        domid_t domid)
{
        return _hypercall4(int, mmuext_op, op, count, success_count, domid);
}

static inline int __must_check
HYPERVISOR_set_gdt(
        unsigned long *frame_list, unsigned int entries)
{
        return _hypercall2(int, set_gdt, frame_list, entries);
}

static inline int __must_check
HYPERVISOR_stack_switch(
        unsigned long ss, unsigned long esp)
{
        return _hypercall2(int, stack_switch, ss, esp);
}

static inline int __must_check
HYPERVISOR_set_callbacks(
        unsigned long event_address, unsigned long failsafe_address,
        unsigned long syscall_address)
{
        return _hypercall3(int, set_callbacks,
                           event_address, failsafe_address, syscall_address);
}

static inline int
HYPERVISOR_fpu_taskswitch(
        int set)
{
        return _hypercall1(int, fpu_taskswitch, set);
}

static inline int __must_check
HYPERVISOR_sched_op(
        int cmd, void *arg)
{
        return _hypercall2(int, sched_op, cmd, arg);
}

static inline long __must_check
HYPERVISOR_set_timer_op(
        uint64_t timeout)
{
        return _hypercall1(long, set_timer_op, timeout);
}

static inline int __must_check
HYPERVISOR_platform_op(
        struct xen_platform_op *platform_op)
{
        platform_op->interface_version = XENPF_INTERFACE_VERSION;
        return _hypercall1(int, platform_op, platform_op);
}

static inline int __must_check
HYPERVISOR_set_debugreg(
        unsigned int reg, unsigned long value)
{
        return _hypercall2(int, set_debugreg, reg, value);
}

static inline unsigned long __must_check
HYPERVISOR_get_debugreg(
        unsigned int reg)
{
        return _hypercall1(unsigned long, get_debugreg, reg);
}

static inline int __must_check
HYPERVISOR_update_descriptor(
        unsigned long ma, unsigned long word)
{
        return _hypercall2(int, update_descriptor, ma, word);
}

static inline int __must_check
HYPERVISOR_memory_op(
        unsigned int cmd, void *arg)
{
        return _hypercall2(int, memory_op, cmd, arg);
}

static inline int __must_check
HYPERVISOR_multicall(
        multicall_entry_t *call_list, unsigned int nr_calls)
{
        return _hypercall2(int, multicall, call_list, nr_calls);
}

static inline int __must_check
HYPERVISOR_update_va_mapping(
        unsigned long va, uint64_t new_val, unsigned long flags)
{
        return _hypercall3(int, update_va_mapping, va, new_val, flags);
}

static inline int __must_check
HYPERVISOR_event_channel_op(
        int cmd, void *arg)
{
        return _hypercall2(int, event_channel_op, cmd, arg);
}

static inline int __must_check
HYPERVISOR_xen_version(
        int cmd, void *arg)
{
        return _hypercall2(int, xen_version, cmd, arg);
}

static inline int __must_check
HYPERVISOR_console_io(
        int cmd, unsigned int count, const char *str)
{
        return _hypercall3(int, console_io, cmd, count, str);
}

static inline int __must_check
HYPERVISOR_physdev_op(
        int cmd, void *arg)
{
        return _hypercall2(int, physdev_op, cmd, arg);
}

static inline int __must_check
HYPERVISOR_grant_table_op(
        unsigned int cmd, void *uop, unsigned int count)
{
        return _hypercall3(int, grant_table_op, cmd, uop, count);
}

static inline int __must_check
HYPERVISOR_update_va_mapping_otherdomain(
        unsigned long va, uint64_t new_val, unsigned long flags, domid_t domid)
{
        return _hypercall4(int, update_va_mapping_otherdomain, va,
                           new_val, flags, domid);
}

static inline int __must_check
HYPERVISOR_vm_assist(
        unsigned int cmd, unsigned int type)
{
        return _hypercall2(int, vm_assist, cmd, type);
}

static inline int __must_check
HYPERVISOR_vcpu_op(
        int cmd, unsigned int vcpuid, void *extra_args)
{
        return _hypercall3(int, vcpu_op, cmd, vcpuid, extra_args);
}

static inline int __must_check
HYPERVISOR_set_segment_base(
        int reg, unsigned long value)
{
        return _hypercall2(int, set_segment_base, reg, value);
}

static inline int __must_check
HYPERVISOR_suspend(
        unsigned long srec)
{
        struct sched_shutdown sched_shutdown = {
                .reason = SHUTDOWN_suspend
        };

        return _hypercall3(int, sched_op, SCHEDOP_shutdown,
                             &sched_shutdown, srec);
}

static inline unsigned long __must_check
HYPERVISOR_hvm_op(
        int op, void *arg)
{
        return _hypercall2(unsigned long, hvm_op, op, arg);
}

static inline int __must_check
HYPERVISOR_callback_op(
        int cmd, const void *arg)
{
        return _hypercall2(int, callback_op, cmd, arg);
}

static inline int __must_check
HYPERVISOR_xenoprof_op(
        int op, void *arg)
{
        return _hypercall2(int, xenoprof_op, op, arg);
}

static inline int __must_check
HYPERVISOR_kexec_op(
        unsigned long op, void *args)
{
        return _hypercall2(int, kexec_op, op, args);
}

static inline int __must_check
HYPERVISOR_dm_op(
        domid_t domid, unsigned int nr_bufs, const void *bufs)
{
        return _hypercall3(int, dm_op, domid, nr_bufs, bufs);
}

#undef __must_check

#endif /* __MACHINE_XEN_HYPERCALL_H__ */