fix openapi

oxidecomputer · Oct 8, 2024 · f5e339c · f5e339c
1 parent 3a5752a
commit f5e339c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/crates/propolis-api-types/src/instance_spec/components/board.rs b/crates/propolis-api-types/src/instance_spec/components/board.rs
@@ -42,10 +42,13 @@ pub enum Chipset {
 pub struct Cpuid {
     /// A list of CPUID leaves/subleaves and their associated values.
     ///
-    /// The `leaf` and `subleaf` fields of each entry in the template must
-    /// be unique. The leaf must also be in the standard or extended ranges
-    /// (0 to 0xFFFF or 0x8000_0000 to 0x8000_FFFF) defined in the `cpuid_utils`
-    /// crate.
+    /// Propolis servers require that each entry's `leaf` be unique and that it
+    /// falls in either the "standard" (0 to 0xFFFF) or "extended" (0x8000_0000
+    /// to 0x8000_FFFF) function ranges, since these are the only valid input
+    /// ranges currently defined by Intel and AMD. See the Intel 64 and IA-32
+    /// Architectures Software Developer's Manual (June 2024) Table 3-17 and the
+    /// AMD64 Architecture Programmer's Manual (March 2024) Volume 3's
+    /// documentation of the CPUID instruction.
     //
     // It would be nice if this were an associative collection type.
     // Unfortunately, the most natural keys for such a collection are

diff --git a/openapi/propolis-server.json b/openapi/propolis-server.json
@@ -885,7 +885,7 @@
         "type": "object",
         "properties": {
           "entries": {
-            "description": "A list of CPUID leaves/subleaves and their associated values.\n\nThe `leaf` and `subleaf` fields of each entry in the template must be unique. The leaf must also be in the standard or extended ranges (0 to 0xFFFF or 0x8000_0000 to 0x8000_FFFF).",
+            "description": "A list of CPUID leaves/subleaves and their associated values.\n\nPropolis servers require that each entry's `leaf` be unique and that it falls in either the \"standard\" (0 to 0xFFFF) or \"extended\" (0x8000_0000 to 0x8000_FFFF) function ranges, since these are the only valid input ranges currently defined by Intel and AMD. See the Intel 64 and IA-32 Architectures Software Developer's Manual (June 2024) Table 3-17 and the AMD64 Architecture Programmer's Manual (March 2024) Volume 3's documentation of the CPUID instruction.",
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/CpuidEntry"