OvmfPkg: Add public headers from Xen Project.

This patch imports publics headers in order to use features from Xen
like XenStore, PV Block... There is only the necessary header files and
there are only a few modifications in order to facilitate future merge of
more recent header (that would be necessary to access new features).

There is little modification compared to the original files:
- Removed most of the unused part of the headers
- Use of ZeroMem() instead of memset()
- using #pragma pack(4) for IA32 compilation.
- Replace types to be more UEFI compliant using a script.

OVMF, when built for IA32 arch, uses the gcc switch -malign-double. This
change the alignment of fields in some struct compare to what is
espected by Xen and any backends. To fix the alignment, the #pragma pack(4)
directive is used around the struct that need it.

Command to run to change types:
find OvmfPkg/Include/IndustryStandard/Xen -type f -name '*.h' -exec sed
  --regexp-extended --file=fix_type_in_xen_includes.sed --in-place {} \;

Avoid changing the 'long' that is not a type (with the first line).
$ cat fix_type_in_xen_includes.sed
/as long as/b

s/([^a-zA-Z0-9_]|^)uint8_t([^a-zA-Z0-9_]|$)/\1UINT8\2/g
s/([^a-zA-Z0-9_]|^)uint16_t([^a-zA-Z0-9_]|$)/\1UINT16\2/g
s/([^a-zA-Z0-9_]|^)uint32_t([^a-zA-Z0-9_]|$)/\1UINT32\2/g
s/([^a-zA-Z0-9_]|^)uint64_t([^a-zA-Z0-9_]|$)/\1UINT64\2/g

s/([^a-zA-Z0-9_]|^)int8_t([^a-zA-Z0-9_]|$)/\1INT8\2/g
s/([^a-zA-Z0-9_]|^)int16_t([^a-zA-Z0-9_]|$)/\1INT16\2/g
s/([^a-zA-Z0-9_]|^)int32_t([^a-zA-Z0-9_]|$)/\1INT32\2/g
s/([^a-zA-Z0-9_]|^)int64_t([^a-zA-Z0-9_]|$)/\1INT64\2/g

s/([^a-zA-Z0-9_]|^)void([^a-zA-Z0-9_]|$)/\1VOID\2/g
s/([^a-zA-Z0-9_]|^)unsigned int([^a-zA-Z0-9_]|$)/\1UINT32\2/g
s/([^a-zA-Z0-9_]|^)int([^a-zA-Z0-9_]|$)/\1INT32\2/g
s/([^a-zA-Z0-9_]|^)unsigned char([^a-zA-Z0-9_]|$)/\1UINT8\2/g
s/([^a-zA-Z0-9_]|^)char([^a-zA-Z0-9_]|$)/\1CHAR8\2/g
s/([^a-zA-Z0-9_]|^)unsigned long([^a-zA-Z0-9_]|$)/\1UINTN\2/g
s/([^a-zA-Z0-9_]|^)long([^a-zA-Z0-9_]|$)/\1INTN\2/g

Change in V4:
- Add a README in Xen headers directory to explain what have been done
  to it. It is mostly a copy/past from the commit description with some
  rewording.
- replace unsigned char by UINT8 as there is no unsigned char in UEFI
  types.

Change in V3:
- Remove unused header sched.h
- moving xs_wire.h in a later patch, where it's first needed
- moving io/blkif.h in a later patch (XenPvBlkDxe: Add BlockFront client)
- moving event_channel.h in a later patch (XenBusDxe: Add Event Channel Notify)
- using #pragma pack(4) for IA32
- headers trimed down, removed most of the unused struct/define/...

License: This patch adds many files under the MIT licence.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Acked-by: Jordan Justen <jordan.l.justen@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16257 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 150 insertions, 0 deletions

diff --git a/OvmfPkg/Include/IndustryStandard/Xen/hvm/params.h b/OvmfPkg/Include/IndustryStandard/Xen/hvm/params.h
new file mode 100644
index 0000000000..9646b9b145
--- /dev/null
+++ b/OvmfPkg/Include/IndustryStandard/Xen/hvm/params.h
@@ -0,0 +1,150 @@
+/*

+ * 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 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 __XEN_PUBLIC_HVM_PARAMS_H__

+#define __XEN_PUBLIC_HVM_PARAMS_H__

+

+#include "hvm_op.h"

+

+/*

+ * Parameter space for HVMOP_{set,get}_param.

+ */

+

+/*

+ * How should CPU0 event-channel notifications be delivered?

+ * val[63:56] == 0: val[55:0] is a delivery GSI (Global System Interrupt).

+ * val[63:56] == 1: val[55:0] is a delivery PCI INTx line, as follows:

+ *                  Domain = val[47:32], Bus  = val[31:16],

+ *                  DevFn  = val[15: 8], IntX = val[ 1: 0]

+ * val[63:56] == 2: val[7:0] is a vector number, check for

+ *                  XENFEAT_hvm_callback_vector to know if this delivery

+ *                  method is available.

+ * If val == 0 then CPU0 event-channel notifications are not delivered.

+ */

+#define HVM_PARAM_CALLBACK_IRQ 0

+

+/*

+ * These are not used by Xen. They are here for convenience of HVM-guest

+ * xenbus implementations.

+ */

+#define HVM_PARAM_STORE_PFN    1

+#define HVM_PARAM_STORE_EVTCHN 2

+

+#define HVM_PARAM_PAE_ENABLED  4

+

+#define HVM_PARAM_IOREQ_PFN    5

+

+#define HVM_PARAM_BUFIOREQ_PFN 6

+#define HVM_PARAM_BUFIOREQ_EVTCHN 26

+

+#if defined(__i386__) || defined(__x86_64__)

+

+/* Expose Viridian interfaces to this HVM guest? */

+#define HVM_PARAM_VIRIDIAN     9

+

+#endif

+

+/*

+ * Set mode for virtual timers (currently x86 only):

+ *  delay_for_missed_ticks (default):

+ *   Do not advance a vcpu's time beyond the correct delivery time for

+ *   interrupts that have been missed due to preemption. Deliver missed

+ *   interrupts when the vcpu is rescheduled and advance the vcpu's virtual

+ *   time stepwise for each one.

+ *  no_delay_for_missed_ticks:

+ *   As above, missed interrupts are delivered, but guest time always tracks

+ *   wallclock (i.e., real) time while doing so.

+ *  no_missed_ticks_pending:

+ *   No missed interrupts are held pending. Instead, to ensure ticks are

+ *   delivered at some non-zero rate, if we detect missed ticks then the

+ *   internal tick alarm is not disabled if the VCPU is preempted during the

+ *   next tick period.

+ *  one_missed_tick_pending:

+ *   Missed interrupts are collapsed together and delivered as one 'late tick'.

+ *   Guest time always tracks wallclock (i.e., real) time.

+ */

+#define HVM_PARAM_TIMER_MODE   10

+#define HVMPTM_delay_for_missed_ticks    0

+#define HVMPTM_no_delay_for_missed_ticks 1

+#define HVMPTM_no_missed_ticks_pending   2

+#define HVMPTM_one_missed_tick_pending   3

+

+/* Boolean: Enable virtual HPET (high-precision event timer)? (x86-only) */

+#define HVM_PARAM_HPET_ENABLED 11

+

+/* Identity-map page directory used by Intel EPT when CR0.PG=0. */

+#define HVM_PARAM_IDENT_PT     12

+

+/* Device Model domain, defaults to 0. */

+#define HVM_PARAM_DM_DOMAIN    13

+

+/* ACPI S state: currently support S0 and S3 on x86. */

+#define HVM_PARAM_ACPI_S_STATE 14

+

+/* TSS used on Intel when CR0.PE=0. */

+#define HVM_PARAM_VM86_TSS     15

+

+/* Boolean: Enable aligning all periodic vpts to reduce interrupts */

+#define HVM_PARAM_VPT_ALIGN    16

+

+/* Console debug shared memory ring and event channel */

+#define HVM_PARAM_CONSOLE_PFN    17

+#define HVM_PARAM_CONSOLE_EVTCHN 18

+

+/*

+ * Select location of ACPI PM1a and TMR control blocks. Currently two locations

+ * are supported, specified by version 0 or 1 in this parameter:

+ *   - 0: default, use the old addresses

+ *        PM1A_EVT == 0x1f40; PM1A_CNT == 0x1f44; PM_TMR == 0x1f48

+ *   - 1: use the new default qemu addresses

+ *        PM1A_EVT == 0xb000; PM1A_CNT == 0xb004; PM_TMR == 0xb008

+ * You can find these address definitions in <hvm/ioreq.h>

+ */

+#define HVM_PARAM_ACPI_IOPORTS_LOCATION 19

+

+/* Enable blocking memory events, async or sync (pause vcpu until response) 

+ * onchangeonly indicates messages only on a change of value */

+#define HVM_PARAM_MEMORY_EVENT_CR0          20

+#define HVM_PARAM_MEMORY_EVENT_CR3          21

+#define HVM_PARAM_MEMORY_EVENT_CR4          22

+#define HVM_PARAM_MEMORY_EVENT_INT3         23

+#define HVM_PARAM_MEMORY_EVENT_SINGLE_STEP  25

+#define HVM_PARAM_MEMORY_EVENT_MSR          30

+

+#define HVMPME_MODE_MASK       (3 << 0)

+#define HVMPME_mode_disabled   0

+#define HVMPME_mode_async      1

+#define HVMPME_mode_sync       2

+#define HVMPME_onchangeonly    (1 << 2)

+

+/* Boolean: Enable nestedhvm (hvm only) */

+#define HVM_PARAM_NESTEDHVM    24

+

+/* Params for the mem event rings */

+#define HVM_PARAM_PAGING_RING_PFN   27

+#define HVM_PARAM_ACCESS_RING_PFN   28

+#define HVM_PARAM_SHARING_RING_PFN  29

+

+/* SHUTDOWN_* action in case of a triple fault */

+#define HVM_PARAM_TRIPLE_FAULT_REASON 31

+

+#define HVM_NR_PARAMS          32

+

+#endif /* __XEN_PUBLIC_HVM_PARAMS_H__ */