get_protocol/
dps_json.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! The schema defined in this file must match the one defined in
5//! `onecore/vm/schema/mars/Config/Config.Devices.Chipset.mars`.
6
7use bitfield_struct::bitfield;
8use guid::Guid;
9use open_enum::open_enum;
10use serde::Deserialize;
11use serde::Serialize;
12
13/// A type-alias to mark fields as _temporarily_ optional to preserve
14/// build-to-compat compatibility during internal testing.
15///
16/// i.e: a newly added field should be marked as `DevLoopCompatOption` until
17/// we're sure that all hosts that we expect this new underhill version to run
18/// on are updated to send the new field.
19///
20/// It would be **very bad form** to ship a library/binary that includes
21/// `DevLoopCompatOption` fields!
22pub type DevLoopCompatOption<T> = Option<T>;
23
24#[derive(Debug, Default, Deserialize, Serialize)]
25#[serde(rename_all = "PascalCase")]
26pub struct DevicePlatformSettingsV2Json {
27    pub v1: HclDevicePlatformSettings,
28    pub v2: HclDevicePlatformSettingsV2,
29}
30
31// The legacy DPS response's mars schema specifies all fields as [OmitEmpty],
32// which we handle by setting `serde(default)` at the struct level.
33//
34// This is _not_ the case in the newer DPS packet, whereby all fields must be
35// present, specifying "empty values" if the data is not set.
36#[derive(Debug, Default, Deserialize, Serialize)]
37#[serde(default, rename_all = "PascalCase")]
38pub struct HclDevicePlatformSettings {
39    pub secure_boot_enabled: bool,
40    pub secure_boot_template_id: HclSecureBootTemplateId,
41    pub enable_battery: bool,
42    pub enable_processor_idle: bool,
43    pub enable_tpm: bool,
44    pub com1: HclUartSettings,
45    pub com2: HclUartSettings,
46    #[serde(with = "serde_helpers::as_string")]
47    pub bios_guid: Guid,
48    pub console_mode: u8,
49    pub enable_firmware_debugging: bool,
50    pub enable_hibernation: bool,
51    pub serial_number: String,
52    pub base_board_serial_number: String,
53    pub chassis_serial_number: String,
54    pub chassis_asset_tag: String,
55}
56
57// requires a `Default` derive, due to [OmitEmpty] used in parent struct
58#[derive(Debug, Default, Deserialize, Serialize)]
59#[serde(rename_all = "PascalCase")]
60pub enum HclSecureBootTemplateId {
61    #[serde(rename = "None")]
62    #[default]
63    None,
64    #[serde(rename = "MicrosoftWindows")]
65    MicrosoftWindows,
66    #[serde(rename = "MicrosoftUEFICertificateAuthority")]
67    MicrosoftUEFICertificateAuthority,
68}
69
70// requires a `Default` derive, due to [OmitEmpty] used in parent struct
71#[derive(Debug, Default, Deserialize, Serialize)]
72#[serde(default, rename_all = "PascalCase")]
73pub struct HclUartSettings {
74    pub enable_port: bool,
75    pub debugger_mode: bool,
76    pub enable_vmbus_redirector: bool,
77}
78
79#[derive(Debug, Default, Deserialize, Serialize)]
80#[serde(rename_all = "PascalCase")]
81pub struct HclDevicePlatformSettingsV2 {
82    pub r#static: HclDevicePlatformSettingsV2Static,
83    pub dynamic: HclDevicePlatformSettingsV2Dynamic,
84}
85
86/// Boot device order entry used by the PCAT Bios.
87#[derive(Debug, Copy, Clone, Deserialize, Serialize)]
88pub enum PcatBootDevice {
89    Floppy,
90    Optical,
91    HardDrive,
92    Network,
93}
94
95/// Guest state lifetime
96#[derive(Debug, Copy, Clone, Deserialize, Serialize, Default)]
97pub enum GuestStateLifetime {
98    #[default]
99    Default,
100    ReprovisionOnFailure,
101    Reprovision,
102    Ephemeral,
103}
104
105/// Guest state encryption policy
106#[derive(Debug, Copy, Clone, Deserialize, Serialize, Default)]
107pub enum GuestStateEncryptionPolicy {
108    /// Use the best encryption available, allowing fallback.
109    ///
110    /// VMs will be created using the best encryption available,
111    /// attempting GspKey, then GspById, and finally leaving the data
112    /// unencrypted if neither are available. VMs will not be migrated
113    /// to a different encryption method.
114    #[default]
115    Auto,
116    /// Prefer (or require, if strict) no encryption.
117    ///
118    /// Do not encrypt the guest state unless it is already encrypted and
119    /// strict encryption policy is disabled.
120    None,
121    /// Prefer (or require, if strict) GspById.
122    ///
123    /// This prevents a VM from being created as or migrated to GspKey even
124    /// if it is available. Exisiting GspKey encryption will be used unless
125    /// strict encryption policy is enabled. Fails if the data cannot be
126    /// encrypted.
127    GspById,
128    /// Prefer (or require, if strict) GspKey.
129    ///
130    /// VMs will be created as or migrated to GspKey. GspById encryption will
131    /// be used if GspKey is unavailable unless strict encryption policy is
132    /// enabled. Fails if the data cannot be encrypted.
133    GspKey,
134    /// Use hardware sealing
135    // TODO: update this doc comment once hardware sealing is implemented
136    HardwareSealing,
137}
138
139open_enum! {
140    /// EFI Diagnostics Log Level Filter
141    #[derive(Default, Deserialize, Serialize)]
142    pub enum EfiDiagnosticsLogLevelType: u32 {
143        /// Default log level
144        DEFAULT = 0,
145        /// Include INFO logs
146        INFO = 1,
147        /// All logs
148        FULL = 2,
149    }
150}
151
152/// Management VTL Feature Flags
153#[bitfield(u64)]
154#[derive(Deserialize, Serialize)]
155#[serde(transparent)]
156pub struct ManagementVtlFeatures {
157    pub strict_encryption_policy: bool,
158    pub _reserved1: bool,
159    pub control_ak_cert_provisioning: bool,
160    pub attempt_ak_cert_callback: bool,
161    pub tx_only_serial_port: bool,
162    #[bits(59)]
163    pub _reserved2: u64,
164}
165
166#[derive(Debug, Default, Deserialize, Serialize)]
167#[serde(rename_all = "PascalCase")]
168pub struct HclDevicePlatformSettingsV2Static {
169    //UEFI flags
170    pub legacy_memory_map: bool,
171    pub pause_after_boot_failure: bool,
172    pub pxe_ip_v6: bool,
173    pub measure_additional_pcrs: bool,
174    pub disable_frontpage: bool,
175    pub disable_sha384_pcr: bool,
176    pub media_present_enabled_by_default: bool,
177    pub memory_protection_mode: u8,
178    #[serde(default)]
179    pub default_boot_always_attempt: bool,
180
181    // UEFI info
182    pub vpci_boot_enabled: bool,
183    #[serde(default)]
184    #[serde(with = "serde_helpers::opt_guid_str")]
185    pub vpci_instance_filter: Option<Guid>,
186
187    // PCAT info
188    pub num_lock_enabled: bool,
189    pub pcat_boot_device_order: Option<[PcatBootDevice; 4]>,
190
191    pub smbios: HclDevicePlatformSettingsV2StaticSmbios,
192
193    // Per field serde(default) is required here because that
194    // we can't reply on serde's normal behavior for optional
195    // fields (put None if not present in json) because we're
196    // using custom serialize/deserialize methods
197    #[serde(default)]
198    #[serde(with = "serde_helpers::opt_base64_vec")]
199    pub vtl2_settings: Option<Vec<u8>>,
200
201    pub vmbus_redirection_enabled: bool,
202    pub no_persistent_secrets: bool,
203    pub watchdog_enabled: bool,
204    // this `#[serde(default)]` shouldn't have been necessary, but we let a
205    // `[OmitEmpty]` marker slip past in code review...
206    #[serde(default)]
207    pub firmware_mode_is_pcat: bool,
208    #[serde(default)]
209    pub always_relay_host_mmio: bool,
210    #[serde(default)]
211    pub imc_enabled: bool,
212    #[serde(default)]
213    pub cxl_memory_enabled: bool,
214    #[serde(default)]
215    pub guest_state_lifetime: GuestStateLifetime,
216    #[serde(default)]
217    pub guest_state_encryption_policy: GuestStateEncryptionPolicy,
218    #[serde(default)]
219    pub efi_diagnostics_log_level: EfiDiagnosticsLogLevelType,
220    #[serde(default)]
221    pub management_vtl_features: ManagementVtlFeatures,
222    #[serde(default)]
223    pub hv_sint_enabled: bool,
224}
225
226#[derive(Debug, Default, Deserialize, Serialize)]
227#[serde(rename_all = "PascalCase")]
228pub struct HclDevicePlatformSettingsV2StaticSmbios {
229    pub system_manufacturer: String,
230    pub system_product_name: String,
231    pub system_version: String,
232    #[serde(rename = "SystemSKUNumber")]
233    pub system_sku_number: String,
234    pub system_family: String,
235    pub bios_lock_string: String,
236    pub memory_device_serial_number: String,
237}
238
239#[derive(Debug, Default, Deserialize, Serialize)]
240#[serde(rename_all = "PascalCase")]
241pub struct HclDevicePlatformSettingsV2Dynamic {
242    pub nvdimm_count: u16,
243    pub enable_psp: bool,
244    pub generation_id_low: u64,
245    pub generation_id_high: u64,
246    pub smbios: HclDevicePlatformSettingsV2DynamicSmbios,
247    pub is_servicing_scenario: bool,
248
249    #[serde(default)]
250    #[serde(with = "serde_helpers::vec_base64_vec")]
251    pub acpi_tables: Vec<Vec<u8>>,
252}
253
254#[derive(Debug, Default, Deserialize, Serialize)]
255#[serde(rename_all = "PascalCase")]
256pub struct HclDevicePlatformSettingsV2DynamicSmbios {
257    #[serde(with = "serde_helpers::base64_vec")]
258    pub processor_manufacturer: Vec<u8>,
259    #[serde(with = "serde_helpers::base64_vec")]
260    pub processor_version: Vec<u8>,
261
262    #[serde(rename = "ProcessorID")]
263    pub processor_id: u64,
264    pub external_clock: u16,
265    pub max_speed: u16,
266    pub current_speed: u16,
267    pub processor_characteristics: u16,
268    pub processor_family2: u16,
269    pub processor_type: u8,
270    pub voltage: u8,
271    pub status: u8,
272    pub processor_upgrade: u8,
273}
274
275#[cfg(test)]
276mod test {
277    use super::*;
278
279    #[test]
280    fn smoke_test_sample() {
281        serde_json::from_slice::<DevicePlatformSettingsV2Json>(include_bytes!(
282            "dps_test_json.json"
283        ))
284        .unwrap();
285    }
286
287    #[test]
288    fn smoke_test_sample_with_vtl2settings() {
289        serde_json::from_slice::<DevicePlatformSettingsV2Json>(include_bytes!(
290            "dps_test_json_with_vtl2settings.json"
291        ))
292        .unwrap();
293    }
294}
get_protocol/dps_json.rs

get_protocol/
dps_json.rs
