README

______ _   _   _     _                   ______      _                         
| ___ \ | | | | |   (_)                  |  _  \    (_)                        
| |_/ / | | | | |    _ _ __  _   ___  __ | | | |_ __ ___   ______ _ __ ___ 
|  __/| | | | | |   | | '_ \| | | \ \/ / | | | | '__| \ \ / // _ \ '__/ __|
| |   \ \_/ / | |___| | | | | |_| |>  <  | |/ /| |  | |\ V /|  __/ |  \__ \
\_|    \___/  \_____/_|_| |_|\__,_/_/\_\ |___/ |_|  |_| \_/  \___|_|  |___/

-------------------------------------------------------------------------------

This repository contains the custom OpenXT PV Linux drivers. Each of these
drivers is a separate DKMS package. The OpenXT build places these packages in
the installers (debs/rpms) on the tools ISO. The driver projects are:

openxt-xenmou:

PV mouse and multi-touch front end driver that uses a device model back end in
QEMU. It uses emulated registers to communicate with the device model and a
logical ring of input events read off a shared page.

openxt-vusb:

PV USB virtual host controller and root hub front end driver that works with
an OpenXT version of the PV USB back end driver. This is a standard ring, grant
tables and even channel front/back type of driver.


For more information on doing development work on the PV Linux drivers, see
the following wikis:

https://github.com/OpenXT/openxt/wiki/PV-Linux-Drivers
https://github.com/OpenXT/openxt/wiki/Linux-VM-Kernel-Debugging