docs/misc/hvmlite: Point to the canonical definition of hvm_start_info
authorAnthony PERARD <anthony.perard@citrix.com>
Mon, 18 Jul 2016 16:08:44 +0000 (17:08 +0100)
committerWei Liu <wei.liu2@citrix.com>
Thu, 18 Aug 2016 16:24:39 +0000 (17:24 +0100)
The C struct in the document is no more in sync with the actual
definition of the PVHv2 boot start info.

Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Acked-by: Jan Beulich <jbeulich@suse.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
docs/misc/hvmlite.markdown

index c1b75c61ccc209b1a89d34f3fe2a212e37bf90e0..69d90fed1ab2313c3489b3a2f9f334807297668c 100644 (file)
@@ -37,24 +37,8 @@ following machine state:
 All other processor registers and flag bits are unspecified. The OS is in
 charge of setting up it's own stack, GDT and IDT.
 
-The format of the boot start info structure is the following (pointed to
-be %ebx):
-
-    struct hvm_start_info {
-    #define HVM_START_MAGIC_VALUE 0x336ec578
-        uint32_t magic;             /* Contains the magic value 0x336ec578       */
-                                    /* ("xEn3" with the 0x80 bit of the "E" set).*/
-        uint32_t flags;             /* SIF_xxx flags.                            */
-        uint32_t cmdline_paddr;     /* Physical address of the command line.     */
-        uint32_t nr_modules;        /* Number of modules passed to the kernel.   */
-        uint32_t modlist_paddr;     /* Physical address of an array of           */
-                                    /* hvm_modlist_entry.                        */
-    };
-
-    struct hvm_modlist_entry {
-        uint32_t paddr;             /* Physical address of the module.           */
-        uint32_t size;              /* Size of the module in bytes.              */
-    };
+The format of the boot start info structure (pointed to by %ebx) can be found
+in xen/include/public/arch-x86/hvm/start_info.h
 
 Other relevant information needed in order to boot a guest kernel
 (console page address, xenstore event channel...) can be obtained