xref: /freebsd/sys/dev/vmgenc/vmgenc_acpi.h (revision ffac39de)
1ffac39deSConrad Meyer /*-
2ffac39deSConrad Meyer  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3ffac39deSConrad Meyer  *
4ffac39deSConrad Meyer  * Copyright (c) 2019 Conrad Meyer <cem@FreeBSD.org>.  All rights reserved.
5ffac39deSConrad Meyer  *
6ffac39deSConrad Meyer  * Redistribution and use in source and binary forms, with or without
7ffac39deSConrad Meyer  * modification, are permitted provided that the following conditions
8ffac39deSConrad Meyer  * are met:
9ffac39deSConrad Meyer  * 1. Redistributions of source code must retain the above copyright
10ffac39deSConrad Meyer  *    notice, this list of conditions and the following disclaimer.
11ffac39deSConrad Meyer  * 2. Redistributions in binary form must reproduce the above copyright
12ffac39deSConrad Meyer  *    notice, this list of conditions and the following disclaimer in the
13ffac39deSConrad Meyer  *    documentation and/or other materials provided with the distribution.
14ffac39deSConrad Meyer  *
15ffac39deSConrad Meyer  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16ffac39deSConrad Meyer  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17ffac39deSConrad Meyer  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18ffac39deSConrad Meyer  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19ffac39deSConrad Meyer  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20ffac39deSConrad Meyer  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21ffac39deSConrad Meyer  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22ffac39deSConrad Meyer  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23ffac39deSConrad Meyer  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24ffac39deSConrad Meyer  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25ffac39deSConrad Meyer  * SUCH DAMAGE.
26ffac39deSConrad Meyer  *
27ffac39deSConrad Meyer  * $FreeBSD$
28ffac39deSConrad Meyer  */
29ffac39deSConrad Meyer #include <sys/_eventhandler.h>
30ffac39deSConrad Meyer 
31ffac39deSConrad Meyer /*
32ffac39deSConrad Meyer  * VM Generation Counter driver
33ffac39deSConrad Meyer  *
34ffac39deSConrad Meyer  * This driver has two functions: first, it provides a system event (both in
35ffac39deSConrad Meyer  * the kernel EVENTHANDLER framework as well as a userspace devctl event)
36ffac39deSConrad Meyer  * whenever a VM has been (HyperV doc, for example):
37ffac39deSConrad Meyer  * - Snapped and the snapshot is executing
38ffac39deSConrad Meyer  * - Recovered from backup
39ffac39deSConrad Meyer  * - Failed over in a HA setup
40ffac39deSConrad Meyer  * - Imported, copied, or cloned
41ffac39deSConrad Meyer  * - And unspecified if VM configuration changes might cause a changed
42ffac39deSConrad Meyer  *   generation counter
43ffac39deSConrad Meyer  *
44ffac39deSConrad Meyer  * Second, it can read the current VM generation counter, a 128-bit GUID.
45ffac39deSConrad Meyer  */
46ffac39deSConrad Meyer typedef void (*vmgenc_handler)(void *);
47ffac39deSConrad Meyer EVENTHANDLER_DECLARE(acpi_vmgenc_event, vmgenc_handler);
48