[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-changelog] [xen master] docs: move pci-device-reservations from misc to man



commit 8a8ff95bbf4bad299772296b664dadda911d7639
Author:     Cédric Bosdonnat <cbosdonnat@xxxxxxxx>
AuthorDate: Fri Dec 9 16:49:31 2016 +0100
Commit:     Wei Liu <wei.liu2@xxxxxxxxxx>
CommitDate: Mon Jan 9 11:05:44 2017 +0000

    docs: move pci-device-reservations from misc to man
    
    pci-device-reservations is references in xl.cfg(5), convert it as a man
    page in pod format. The name is now prefixed with 'xen-' to avoid
    possible name conflicts.
    
    Signed-off-by: Cédric Bosdonnat <cbosdonnat@xxxxxxxx>
    Acked-by: Wei Liu <wei.liu2@xxxxxxxxxx>
---
 docs/man/xen-pci-device-reservations.pod.7 | 84 ++++++++++++++++++++++++++++++
 docs/man/xl.cfg.pod.5.in                   |  2 +-
 docs/misc/pci-device-reservations.txt      | 58 ---------------------
 3 files changed, 85 insertions(+), 59 deletions(-)

diff --git a/docs/man/xen-pci-device-reservations.pod.7 
b/docs/man/xen-pci-device-reservations.pod.7
new file mode 100644
index 0000000..dac9276
--- /dev/null
+++ b/docs/man/xen-pci-device-reservations.pod.7
@@ -0,0 +1,84 @@
+=head1 Description
+
+PCI vendor ID 0x5853 has been reserved for use by Xen systems in order to
+advertise certain virtual hardware to guest virtual machines. The primary
+use of this is with device ID 0x0001 to advertise the Xen Platform PCI
+device - the presence of this virtual device enables a guest Operating
+System (subject to the availability of suitable drivers) to make use of
+paravirtualisation features such as disk and network devices etc.
+
+Some Xen vendors wish to provide alternative and/or additional guest drivers
+that can bind to virtual devices[1]. This may be done using the Xen PCI
+vendor ID of 0x5853 and Xen-vendor/device specific PCI device IDs. This file
+records reservations made within the device ID range in order to avoid
+multiple Xen vendors using conflicting IDs.
+
+=head1 Guidelines
+
+=over 4
+
+=item 1. A vendor may request a range of device IDs by submitting a patch to
+         this file.
+
+=item 2. Vendor allocations should be in the range 0xc000-0xfffe to reduce the
+         possibility of clashes with community IDs assigned from the bottom up.
+
+=item 3. The vendor is responsible for allocations within the range and should
+         try to record specific device IDs in PCI ID databases such as
+         http://pciids.sourceforge.net and http//www.pcidatabase.com
+
+=back
+
+=head1 Reservations
+
+        range     | vendor/product
+    
--------------+--------------------------------------------------------------
+    0x0001        | (Xen Platform PCI device)
+    0x0002        | Citrix XenServer (grandfathered allocation for XenServer 
6.1)
+    0xc000-0xc0ff | Citrix XenServer
+    0xc100-0xc1ff | Citrix XenClient
+
+=head1 Notes
+
+=over 4
+
+=item 1.
+
+Upstream QEMU provides a parameterized device called xen-pvdevice that
+can be used to host guest drivers. Execute:
+
+    qemu-system-i386 -device xen-pvdevice,help
+
+for a list of all parameters. The following parameters are relevant to
+driver binding:
+
+=over 4
+
+=item  vendor-id (default 0x5853)
+
+The PCI vendor ID and subsystem vendor ID of the device.
+
+=item  device-id (must be specified)
+
+The PCI device ID and subsystem device ID of the device.
+
+=item  revision (default 0x01)
+
+The PCI revision of the device
+
+=back
+
+Also the size parameter (default 0x400000) can be used to specify the
+size of the single MMIO BAR that the device exposes. This area may be
+used by drivers for mapping grant tables, etc.
+
+Note that the presence of the Xen Platform PCI device is generally a
+pre-requisite for an additional xen-pvdevice as it is the platform
+device that provides that IO ports necessary for unplugging emulated
+devices. See hvm-emulated-unplug.markdown for details of the IO ports
+and unplug protocol.
+
+libxl provides support for creation of a single additional xen-pvdevice.
+See the vendor_device parameter in xl.cfg(5).
+
+=back
diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index cc2009e..64dd5c7 100644
--- a/docs/man/xl.cfg.pod.5.in
+++ b/docs/man/xl.cfg.pod.5.in
@@ -1894,7 +1894,7 @@ specified, enabling the use of XenServer PV drivers in 
the guest.
 =back
 
 This parameter only takes effect when device_model_version=qemu-xen.
-See F<docs/misc/pci-device-reservations.txt> for more information.
+See L<xen-pci-device-reservations(7)> for more information.
 
 =back
 
diff --git a/docs/misc/pci-device-reservations.txt 
b/docs/misc/pci-device-reservations.txt
deleted file mode 100644
index 9d6d780..0000000
--- a/docs/misc/pci-device-reservations.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-PCI vendor ID 0x5853 has been reserved for use by Xen systems in order to
-advertise certain virtual hardware to guest virtual machines. The primary
-use of this is with device ID 0x0001 to advertise the Xen Platform PCI
-device - the presence of this virtual device enables a guest Operating
-System (subject to the availability of suitable drivers) to make use of
-paravirtualisation features such as disk and network devices etc.
-
-Some Xen vendors wish to provide alternative and/or additional guest drivers
-that can bind to virtual devices[1]. This may be done using the Xen PCI
-vendor ID of 0x5853 and Xen-vendor/device specific PCI device IDs. This file
-records reservations made within the device ID range in order to avoid
-multiple Xen vendors using conflicting IDs.
-
-Guidelines
- 1. A vendor may request a range of device IDs by submitting a patch to
-    this file.
- 2. Vendor allocations should be in the range 0xc000-0xfffe to reduce the
-    possibility of clashes with community IDs assigned from the bottom up.
- 3. The vendor is responsible for allocations within the range and should
-    try to record specific device IDs in PCI ID databases such as
-    http://pciids.sourceforge.net and http//www.pcidatabase.com
-
-Reservations
-============
-
-    range     | vendor/product
---------------+--------------------------------------------------------------
-0x0001        | (Xen Platform PCI device)
-0x0002        | Citrix XenServer (grandfathered allocation for XenServer 6.1)
-0xc000-0xc0ff | Citrix XenServer
-0xc100-0xc1ff | Citrix XenClient
-
-[1] Upstream QEMU provides a parameterized device called xen-pvdevice that
-    can be used to host guest drivers. Execute:
-
-    qemu-system-i386 -device xen-pvdevice,help
-
-    for a list of all parameters. The following parameters are relevant to
-    driver binding:
-
-    vendor-id (default 0x5853):     The PCI vendor ID and subsystem vendor
-                                    ID of the device.
-    device-id (must be specified):  The PCI device ID and subsystem device
-                                    ID of the device.
-    revision (default 0x01):        The PCI revision of the device
-
-    Also the size parameter (default 0x400000) can be used to specify the
-    size of the single MMIO BAR that the device exposes. This area may be
-    used by drivers for mapping grant tables, etc.
-
-    Note that the presence of the Xen Platform PCI device is generally a
-    pre-requisite for an additional xen-pvdevice as it is the platform
-    device that provides that IO ports necessary for unplugging emulated
-    devices. See hvm-emulated-unplug.markdown for details of the IO ports
-    and unplug protocol.
-
-    libxl provides support for creation of a single additional xen-pvdevice.
-    See the vendor_device parameter in xl.cfg(5).
--
generated by git-patchbot for /home/xen/git/xen.git#master

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxx
https://lists.xenproject.org/xen-changelog

 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.