843e19887f64dde75055cf8842fc4db2171eff45johnlev/******************************************************************************
843e19887f64dde75055cf8842fc4db2171eff45johnlev * callback.h
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Register guest OS callbacks with Xen.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Permission is hereby granted, free of charge, to any person obtaining a copy
843e19887f64dde75055cf8842fc4db2171eff45johnlev * of this software and associated documentation files (the "Software"), to
843e19887f64dde75055cf8842fc4db2171eff45johnlev * deal in the Software without restriction, including without limitation the
843e19887f64dde75055cf8842fc4db2171eff45johnlev * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
843e19887f64dde75055cf8842fc4db2171eff45johnlev * sell copies of the Software, and to permit persons to whom the Software is
843e19887f64dde75055cf8842fc4db2171eff45johnlev * furnished to do so, subject to the following conditions:
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * The above copyright notice and this permission notice shall be included in
843e19887f64dde75055cf8842fc4db2171eff45johnlev * all copies or substantial portions of the Software.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
843e19887f64dde75055cf8842fc4db2171eff45johnlev * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
843e19887f64dde75055cf8842fc4db2171eff45johnlev * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
843e19887f64dde75055cf8842fc4db2171eff45johnlev * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
843e19887f64dde75055cf8842fc4db2171eff45johnlev * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
843e19887f64dde75055cf8842fc4db2171eff45johnlev * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
843e19887f64dde75055cf8842fc4db2171eff45johnlev * DEALINGS IN THE SOFTWARE.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Copyright (c) 2006, Ian Campbell
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#ifndef __XEN_PUBLIC_CALLBACK_H__
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define __XEN_PUBLIC_CALLBACK_H__
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#include "xen.h"
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Prototype for this hypercall is:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * long callback_op(int cmd, void *extra_args)
843e19887f64dde75055cf8842fc4db2171eff45johnlev * @cmd == CALLBACKOP_??? (callback operation).
843e19887f64dde75055cf8842fc4db2171eff45johnlev * @extra_args == Operation-specific extra arguments (NULL if none).
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/* ia64, x86: Callback for event delivery. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define CALLBACKTYPE_event 0
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/* x86: Failsafe callback when guest state cannot be restored by Xen. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define CALLBACKTYPE_failsafe 1
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/* x86/64 hypervisor: Syscall by 64-bit guest app ('64-on-64-on-64'). */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define CALLBACKTYPE_syscall 2
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * x86/32 hypervisor: Only available on x86/32 when supervisor_mode_kernel
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * feature is enabled. Do not use this callback type in new code.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define CALLBACKTYPE_sysenter_deprecated 3
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/* x86: Callback for NMI delivery. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define CALLBACKTYPE_nmi 4
843e19887f64dde75055cf8842fc4db2171eff45johnlev
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/*
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * x86: sysenter is only available as follows:
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * - 32-bit hypervisor: with the supervisor_mode_kernel feature enabled
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * - 64-bit hypervisor: 32-bit guest applications on Intel CPUs
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * ('32-on-32-on-64', '32-on-64-on-64')
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * [nb. also 64-bit guest applications on Intel CPUs
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * ('64-on-64-on-64'), but syscall is preferred]
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define CALLBACKTYPE_sysenter 5
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/*
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * x86/64 hypervisor: Syscall by 32-bit guest app on AMD CPUs
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * ('32-on-32-on-64', '32-on-64-on-64')
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define CALLBACKTYPE_syscall32 7
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Disable event deliver during callback? This flag is ignored for event and
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NMI callbacks: event delivery is unconditionally disabled.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _CALLBACKF_mask_events 0
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define CALLBACKF_mask_events (1U << _CALLBACKF_mask_events)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Register a callback.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define CALLBACKOP_register 0
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct callback_register {
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t type;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t flags;
843e19887f64dde75055cf8842fc4db2171eff45johnlev xen_callback_t address;
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct callback_register callback_register_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(callback_register_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Unregister a callback.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Not all callbacks can be unregistered. -EINVAL will be returned if
843e19887f64dde75055cf8842fc4db2171eff45johnlev * you attempt to unregister such a callback.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define CALLBACKOP_unregister 1
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct callback_unregister {
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t type;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t _unused;
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct callback_unregister callback_unregister_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(callback_unregister_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#if __XEN_INTERFACE_VERSION__ < 0x00030207
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#undef CALLBACKTYPE_sysenter
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define CALLBACKTYPE_sysenter CALLBACKTYPE_sysenter_deprecated
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#endif
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
843e19887f64dde75055cf8842fc4db2171eff45johnlev#endif /* __XEN_PUBLIC_CALLBACK_H__ */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Local variables:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * mode: C
843e19887f64dde75055cf8842fc4db2171eff45johnlev * c-set-style: "BSD"
843e19887f64dde75055cf8842fc4db2171eff45johnlev * c-basic-offset: 4
843e19887f64dde75055cf8842fc4db2171eff45johnlev * tab-width: 4
843e19887f64dde75055cf8842fc4db2171eff45johnlev * indent-tabs-mode: nil
843e19887f64dde75055cf8842fc4db2171eff45johnlev * End:
843e19887f64dde75055cf8842fc4db2171eff45johnlev */