xref: /freebsd/sys/contrib/xen/hvm/hvm_xs_strings.h (revision fe75646a0234a261c0013bf1840fdac4acaf0cec)
1 /******************************************************************************
2  * hvm/hvm_xs_strings.h
3  *
4  * HVM xenstore strings used in HVMLOADER.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  *
24  * Copyright (c) 2013, Citrix Systems
25  */
26 
27 #ifndef __XEN_PUBLIC_HVM_HVM_XS_STRINGS_H__
28 #define __XEN_PUBLIC_HVM_HVM_XS_STRINGS_H__
29 
30 #define HVM_XS_HVMLOADER               "hvmloader"
31 #define HVM_XS_BIOS                    "hvmloader/bios"
32 #define HVM_XS_GENERATION_ID_ADDRESS   "hvmloader/generation-id-address"
33 #define HVM_XS_ALLOW_MEMORY_RELOCATE   "hvmloader/allow-memory-relocate"
34 
35 /* The following values allow additional ACPI tables to be added to the
36  * virtual ACPI BIOS that hvmloader constructs. The values specify the guest
37  * physical address and length of a block of ACPI tables to add. The format of
38  * the block is simply concatenated raw tables (which specify their own length
39  * in the ACPI header).
40  */
41 #define HVM_XS_ACPI_PT_ADDRESS         "hvmloader/acpi/address"
42 #define HVM_XS_ACPI_PT_LENGTH          "hvmloader/acpi/length"
43 
44 /* Any number of SMBIOS types can be passed through to an HVM guest using
45  * the following xenstore values. The values specify the guest physical
46  * address and length of a block of SMBIOS structures for hvmloader to use.
47  * The block is formatted in the following way:
48  *
49  * <length><struct><length><struct>...
50  *
51  * Each length separator is a 32b integer indicating the length of the next
52  * SMBIOS structure. For DMTF defined types (0 - 121), the passed in struct
53  * will replace the default structure in hvmloader. In addition, any
54  * OEM/vendortypes (128 - 255) will all be added.
55  */
56 #define HVM_XS_SMBIOS_PT_ADDRESS       "hvmloader/smbios/address"
57 #define HVM_XS_SMBIOS_PT_LENGTH        "hvmloader/smbios/length"
58 
59 /* Set to 1 to enable SMBIOS default portable battery (type 22) values. */
60 #define HVM_XS_SMBIOS_DEFAULT_BATTERY  "hvmloader/smbios/default_battery"
61 
62 /* The following xenstore values are used to override some of the default
63  * string values in the SMBIOS table constructed in hvmloader.
64  */
65 #define HVM_XS_BIOS_STRINGS            "bios-strings"
66 #define HVM_XS_BIOS_VENDOR             "bios-strings/bios-vendor"
67 #define HVM_XS_BIOS_VERSION            "bios-strings/bios-version"
68 #define HVM_XS_SYSTEM_MANUFACTURER     "bios-strings/system-manufacturer"
69 #define HVM_XS_SYSTEM_PRODUCT_NAME     "bios-strings/system-product-name"
70 #define HVM_XS_SYSTEM_VERSION          "bios-strings/system-version"
71 #define HVM_XS_SYSTEM_SERIAL_NUMBER    "bios-strings/system-serial-number"
72 #define HVM_XS_BASEBOARD_MANUFACTURER  "bios-strings/baseboard-manufacturer"
73 #define HVM_XS_BASEBOARD_PRODUCT_NAME  "bios-strings/baseboard-product-name"
74 #define HVM_XS_BASEBOARD_VERSION       "bios-strings/baseboard-version"
75 #define HVM_XS_BASEBOARD_SERIAL_NUMBER "bios-strings/baseboard-serial-number"
76 #define HVM_XS_BASEBOARD_ASSET_TAG     "bios-strings/baseboard-asset-tag"
77 #define HVM_XS_BASEBOARD_LOCATION_IN_CHASSIS "bios-strings/baseboard-location-in-chassis"
78 #define HVM_XS_ENCLOSURE_MANUFACTURER  "bios-strings/enclosure-manufacturer"
79 #define HVM_XS_ENCLOSURE_SERIAL_NUMBER "bios-strings/enclosure-serial-number"
80 #define HVM_XS_ENCLOSURE_ASSET_TAG     "bios-strings/enclosure-asset-tag"
81 #define HVM_XS_BATTERY_MANUFACTURER    "bios-strings/battery-manufacturer"
82 #define HVM_XS_BATTERY_DEVICE_NAME     "bios-strings/battery-device-name"
83 
84 /* 1 to 99 OEM strings can be set in xenstore using values of the form
85  * below. These strings will be loaded into the SMBIOS type 11 structure.
86  */
87 #define HVM_XS_OEM_STRINGS             "bios-strings/oem-%d"
88 
89 #endif /* __XEN_PUBLIC_HVM_HVM_XS_STRINGS_H__ */
90