Skip to content

Commit 2718085

Browse files
author
Ross Philipson
committed
[docs] Updated README with build instructions etc.
OXT-181 Signed-off-by: Ross Philipson <[email protected]>
1 parent 0537dae commit 2718085

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

README

+56-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,61 @@ __ _____ ________ ___ _ ___| |__ __ _ _| |_
1111

1212
Overview:
1313

14-
A repository to contain the XenClient virtual USB
15-
Windows front-end (generation 2) driver.
14+
A repository to contain the OpenXT Para-virtual USB Windows front end driver.
15+
This driver along with the Linux front and back end drivers are currently
16+
only in the OpenXT project. Ideally they would supplant the existing version
17+
that lives in the 2.6.x kernels (and is not yet in the 3.x/4.x lines).
1618

1719

20+
Getting:
21+
22+
There are various git tools for Windows. One good choice is Cygwin for a nice
23+
Unixy environment. A simple choice is GIT-SCM:
24+
25+
http://git-scm.com/download/win
26+
27+
Regardless of the tool used, to be able to build the project, two repositories
28+
need to be cloned. First clone:
29+
30+
git://github.com/OpenXT/xc-windows.git
31+
32+
The xc-vusb project depends on header files and libraries in this repo. Then
33+
clone the xc-vusb repo inside the xc-windows.git repo:
34+
35+
git://github.com/OpenXT/xc-vusb.git
36+
37+
38+
Building:
39+
40+
First the xc-windows.git code must be built. This requires installing the
41+
Windows 7 WDK. Once installed use one of the "Longhorn/Vista" build
42+
environments - this opens a command prompt. Choose x86 or x64 (or both)
43+
depending on what sort of xc-vusb driver is to be built. Within
44+
xc-windows.git, run something like:
45+
46+
build -cbgz
47+
48+
Microsoft Visual Studio 2012 (or later) and the Windows 8 (or later) WDK are
49+
required to build the xc-vusb driver. The main project file lives here:
50+
51+
Drivers/xenvusb/xenvusb.sln
52+
53+
There are a number of different build targets to choose from. The binaries end
54+
up here:
55+
56+
Drivers/xenvusb/Win7Release or Win7Debug for 32b
57+
Drivers/xenvusb/x64/Win7Release or Win7Debug for 64b
58+
59+
Manual driver signing can be done using the xc-windows/do_sign.ps1 script but
60+
it is probably easier and saner to follow the build instructions here to get
61+
a proper signed build of the driver:
62+
63+
https://github.com/OpenXT/openxt/wiki/Windows-Build-Machine
64+
https://github.com/OpenXT/openxt/wiki/Windows-Build-Process
65+
66+
67+
Debugging:
68+
69+
There are up to date Windows HVM debugging instruction here:
70+
71+
http://github.com/OpenXT/openxt/wiki/Windows-HVM-Debugging

0 commit comments

Comments
 (0)