aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJames Bulpin <James.Bulpin@eu.citrix.com>2013-07-03 17:52:09 +0000
committerIan Campbell <ian.campbell@citrix.com>2013-07-04 11:13:37 +0100
commit767423f20561f45795c61ef66b7526f9a567335e (patch)
tree151f783941aa267cd540132aefa26d1f5fc5e282 /docs
parentb9fa02b9011f8baf753e1539c921804a32b228a8 (diff)
downloadxen-767423f20561f45795c61ef66b7526f9a567335e.tar.gz
xen-767423f20561f45795c61ef66b7526f9a567335e.tar.bz2
xen-767423f20561f45795c61ef66b7526f9a567335e.zip
docs: record reservations of device IDs under the Xen vendor ID
This patch introduces a documentation file to record reservations of ranges of PCI device IDs within the Xen vendor ID 0x5853. Signed-off-by: James Bulpin <james.bulpin@citrix.com> Acked-by: Keir Fraser <keir@xen.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/misc/pci-device-reservations.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/misc/pci-device-reservations.txt b/docs/misc/pci-device-reservations.txt
new file mode 100644
index 0000000000..19bd9d5f81
--- /dev/null
+++ b/docs/misc/pci-device-reservations.txt
@@ -0,0 +1,31 @@
+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. 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