xen-devel.lists.xenproject.org archive mirror
 help / color / mirror / Atom feed
From: Ian Campbell <ian.campbell@citrix.com>
To: xen-devel@lists.xen.org
Cc: Ian Campbell <ian.campbell@citrix.com>
Subject: [DOCDAY PATCH] docs: update xenstore-paths.markdown with HVM paths.
Date: Mon, 30 Jul 2012 17:11:21 +0100	[thread overview]
Message-ID: <1343664681-13450-1-git-send-email-ian.campbell@citrix.com> (raw)
In-Reply-To: <1343657037-28495-1-git-send-email-ian.campbell@citrix.com>

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
---
 docs/misc/xenstore-paths.markdown |   47 +++++++++++++++++++++++++++++++++++-
 1 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/docs/misc/xenstore-paths.markdown b/docs/misc/xenstore-paths.markdown
index 967ed7b..193e592 100644
--- a/docs/misc/xenstore-paths.markdown
+++ b/docs/misc/xenstore-paths.markdown
@@ -41,7 +41,8 @@ VALUES are strings and can take the following forms:
 
 * PATH -- a XenStore path.
 * STRING -- an arbitrary string.
-* INTEGER -- the decimal representation of an integer.
+* INTEGER -- An integer, in decimal representation unless otherwise
+  noted.
  * MEMKB -- the decimal representation of a number of kilobytes.
  * EVTCHN -- the decimal representation of an event channel.
  * GNTREF -- the decimal representation of a grant reference.
@@ -60,6 +61,9 @@ tags enclosed in square brackets.
 * HVM -- Path is valid for HVM domains only
 * PV --  Path is valid for PV domains only
 * BACKEND -- Path is valid for a backend domain (AKA driver domain)
+* INTERNAL -- Although a path is visible to the domain its use is
+  reserved for the virtual firmware or Xen platform code. Guest
+  Operating Systems should not read this key.
 
 Owning domain means the domain whose home path this tag is found
 under.
@@ -139,6 +143,25 @@ The domain's suspend event channel. The use of a suspend event channel
 is optional at the domain's discression. If it is not used then this
 path will be left blank.
 
+#### ~/hvmloader/generation-id-address = ADDRESS [r,HVM,INTERNAL]
+
+The hexadecimal representation of the address of the domain's
+"generation id".
+
+XXX Where is this specified.
+
+#### ~/hvmloader/bios = ("rombios"|"seabios"|"OVMF") [HVM,INTERNAL]
+
+The BIOS used by this domain.
+
+#### ~/platform/* [HVM,INTERNAL]
+
+Various platform properties. 
+
+* acpi -- is ACPI enabled for this domain
+* acpi_s3 -- is ACPI S3 support enabled for this domain
+* acpi_s4 -- is ACPI S4 support enabled for this domain
+
 ### Frontend device paths
 
 Paravirtual device frontends are generally specified by their own
@@ -201,6 +224,22 @@ directory within the XenStore hierarchy. Usually this is under
 A virtual block device backend. Described by
 [xen/include/public/io/blkif.h][BLKIF]
 
+Uses the in-kernel blkback driver.
+
+#### ~/backend/qdisk/$DOMID/$DEVID/* []
+
+A virtual block device backend. Described by
+[xen/include/public/io/blkif.h][BLKIF]
+
+Uses the qemu based disk backend.
+
+#### ~/backend/tap/$DOMID/$DEVID/* []
+
+A virtual block device backend. Described by
+[xen/include/public/io/blkif.h][BLKIF]
+
+Uses the in-kernel blktap (v1) disk backend (deprecated).
+
 #### ~/backend/vfb/$DOMID/$DEVID/* []
 
 A virtual framebuffer backend. Described by
@@ -274,12 +313,16 @@ The domains name.
 
 ### /vm/$UUID/image/* []
 
-Various information relating to the domain builder.
+Various information relating to the domain builder used for this guest.
 
 ### /vm/$UUID/start_time = INTEGER "." INTEGER []
 
 The time which the guest was started in SECONDS.MICROSECONDS format
 
+### /vm/$UUID/rtc/timeoffset = ""|INTEGER [HVM,INTERNAL]
+
+The guest's virtual time offset from UTC in seconds.
+
 ## Platform-Level paths
 
 ### libxl Specific Paths
-- 
1.7.2.5

  reply	other threads:[~2012-07-30 16:11 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-30 14:03 [DOCDAY PATCH] docs: initial documentation for xenstore paths Ian Campbell
2012-07-30 16:11 ` Ian Campbell [this message]
2012-08-09 10:01 ` Ian Campbell
2012-08-09 13:38   ` Ian Jackson
2012-08-17 14:35     ` Ian Campbell
2012-08-09 14:02   ` Ian Jackson
2012-08-17 15:05     ` Ian Campbell
2012-08-25  8:54       ` Joseph Glanville
2012-09-24 11:35       ` Ian Jackson
2012-09-24 15:07         ` Ian Campbell
2012-08-09 21:02 ` Guest knowledge of own domid [was: docs: initial documentation for xenstore paths] Daniel De Graaf
2012-08-09 21:26   ` Jean Guyader
2012-08-16 11:28     ` Ian Campbell
2012-08-16 14:33       ` Daniel De Graaf
2012-08-16 14:36         ` Ian Campbell
2012-08-16 14:52           ` Daniel De Graaf
2012-08-17  8:05             ` Ian Campbell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1343664681-13450-1-git-send-email-ian.campbell@citrix.com \
    --to=ian.campbell@citrix.com \
    --cc=xen-devel@lists.xen.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).