[Okvm-cvs] okvm README,1.3,1.4

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/okvm/okvm
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18107

Modified Files:
	README 
Log Message:

Add a status section to highlight working/non-working parts of the project.

More spelling fixes ;-)

Index: README
===================================================================
RCS file: /cvsroot/okvm/okvm/README,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** README	10 Jan 2006 11:07:40 -0000	1.3
--- README	10 Jan 2006 11:29:27 -0000	1.4
***************
*** 7,19 ****

  Contents:
! 1) What you need
! 2) Compiling and Installing
! 3) Running
! 4) Adjusting Video modes
! 5) Tested Hardware
! 6) Finding more Information

! 1) What you need
  ----------------

--- 7,46 ----

  Contents:
! 1) Project Status
! 2) What you need
! 3) Compiling and Installing
! 4) Running
! 5) Adjusting Video modes
! 6) Tested Hardware
! 7) Finding more Information

! 1) Project Status
! -----------------
! 
! The current state of the OKVM Project is still early development.
! Here is a rough list of what works and what doesn't.
! 
!   * There is only a very limited set of video modes. Generally it is enough
!     to get sync and see most of the screen for basic resolutions up to 1024x768.
!     It is fairly easy to add new modes (see below).
! 
!   * DMA is not working on the okvm hardware at this point.  This means the
!     frame rate is low and the cpu usage is rather high.  At present about
!     3 frames/second is expected.  Though this is reasonably usable for
!     console mode VGA and low resolution graphics.
! 
!     The slow frame rate also limits the keyboard/mouse response,  though
!     type ahead,  mouse ahead and click ahead help a lot, it still prevents
!     some mouse operations (ie., double click) from working as expected.
! 
!   * There appears to be a lockup after some time when using 2.6 kernels.
!     2.4 kernels appear to be quite stable.
! 
!   * The sampling phase usually needs to be adjusted for each installation
!     to reduce the bandwidth requirements,  however,  it still seems to be
!     producing more changes per frame than expected.
! 
! 2) What you need
  ----------------

***************
*** 21,57 ****
  things.

! 	a) A recent 2.4 or 2.6 linux system.  You will need a working C++
! 	   devsystem.  You will also need to be build modules for your running
! 	   kernel.

! 	   On a Debian system,  installing the appropriate kernel-headers
! 	   package should provide this for you.

! 	b) You need the "libevent" development headers and libraries installed.
! 	   
! 	   On a Debian system "apt-get install libevent-dev" will get you the
! 	   correct files.

! 	c) You will need the ssl development libraries and headers.

! 	   On a Debian system "apt-get install libssl-dev" will get you the
! 	   correct files.

! 	d) You will need the zlib development libraries and headers.

! 	   On a Debian system "apt-get install zlib1g-dev" will get you the
! 	   correct files.

! 	   On a Mandrake system "urpmi --fuzzy zlib-devel" will get you the 
! 	   correct files.

! 	e) Lastly, you need the "videodev" module for your kernel.  This should
! 	   come with most modern linux kernel configurations.

! 	   On a debian system the latest kernel packages include this module.

! 	   Run "modinfo videodev" to see if you have the driver available.

! 2) Compiling and Installing
  ---------------------------

--- 48,84 ----
  things.

!     a) A recent 2.4 or 2.6 Linux system.  You will need a working C++
!        devsystem.  You will also need to be build modules for your running
!        kernel.

!        On a Debian system,  installing the appropriate kernel-headers
!        package should provide this for you.

!     b) You need the "libevent" development headers and libraries installed.
!        
!        On a Debian system "apt-get install libevent-dev" will get you the
!        correct files.

!     c) You will need the ssl development libraries and headers.

!        On a Debian system "apt-get install libssl-dev" will get you the
!        correct files.

!     d) You will need the zlib development libraries and headers.

!        On a Debian system "apt-get install zlib1g-dev" will get you the
!        correct files.

!        On a Mandrake system "urpmi --fuzzy zlib-devel" will get you the 
!        correct files.

!     e) Lastly, you need the "videodev" module for your kernel.  This should
!        come with most modern Linux kernel configurations.

!        On a Debian system the latest kernel packages include this module.

!        Run "modinfo videodev" to see if you have the driver available.

! 3) Compiling and Installing
  ---------------------------

***************
*** 66,70 ****
  top level Makefile and change the PREFIX value.

! 3) Running
  ----------

--- 93,97 ----
  top level Makefile and change the PREFIX value.

! 4) Running
  ----------

***************
*** 74,100 ****
  as root to run these commands.

! 	# okvm-vncpasswd /etc/okvm-passwd
! 	Password:
! 	Verify:
! 	#

  Once you have a password,  load the drivers and start the server:

! 	modprobe videodev
! 	modprobe okvm

! 	okvm-server -passwordfile=/etc/okvm-passwd &

  You should now be able to connect to the server with most VNC clients.
  The experience will be much better if your VNC client can handle Window
! resizes appropriately.  For example the debian "xvncviewer" does not handle
  resizes and will exit,  but "xvnc4viewer" will handle them just fine.

! 	On Debian system "apt-get install xvnc4viewer" will get the appropriate
! 	version.

  Then you can run:

! 	xvnc4viewer <ip-address-of-machine-running-okvm-server>

  You should be prompted for the password,  and after entering it a screen
--- 101,127 ----
  as root to run these commands.

!     # okvm-vncpasswd /etc/okvm-passwd
!     Password:
!     Verify:
!     #

  Once you have a password,  load the drivers and start the server:

!     modprobe videodev
!     modprobe okvm

!     okvm-server -passwordfile=/etc/okvm-passwd &

  You should now be able to connect to the server with most VNC clients.
  The experience will be much better if your VNC client can handle Window
! resizes appropriately.  For example the Debian "xvncviewer" does not handle
  resizes and will exit,  but "xvnc4viewer" will handle them just fine.

!     On Debian system "apt-get install xvnc4viewer" will get the appropriate
!     version.

  Then you can run:

!     xvnc4viewer <ip-address-of-machine-running-okvm-server>

  You should be prompted for the password,  and after entering it a screen
***************
*** 104,108 ****
  mode.

! 4) Adjusting Video modes
  ------------------------

--- 131,135 ----
  mode.

! 5) Adjusting Video modes
  ------------------------

***************
*** 112,116 ****
  the best possible video quality.

! This is currently a fairly manualy process.

  First run okvm-vidtune and note the ifh/vfh settings.
--- 139,143 ----
  the best possible video quality.

! This is currently a fairly manually process.

  First run okvm-vidtune and note the ifh/vfh settings.
***************
*** 119,137 ****
  what you want and then fill out the fields as best you can.  Here is a guide:

! 	width		display width in pixels ie., the 800 in 800x600
! 	height		display height in pixels ie., the 600 in 800x600
! 	pixclk		pixel clock (MHz), you monitor or video settings may provide
! 	            these.  If running xfree86 (or derivative),  xvidtune should
! 				give you these values.
! 	full_width	full width (pixels) including front/back porch etc
! 	            this should be 20-30% more than the width.
! 	left_margin	offset of first real pixel from left
! 	top_margin	offset of first real line from top
! 	hpol		hsync polarity, 0=-ve 1=positive
! 	vpol		vsync polarity, 0=-ve 1=positive
! 	ifh			value of ifh detection register
! 	ifv			value of ifv detection register
! 	phase		pixel phase sampling (16 is a good starting point)
! 	name		mode name

  Once you have you mode in and compiled, restart and run okvm-vidtune and
--- 146,164 ----
  what you want and then fill out the fields as best you can.  Here is a guide:

!     width       display width in pixels ie., the 800 in 800x600
!     height      display height in pixels ie., the 600 in 800x600
!     pixclk      pixel clock (MHz), you monitor or video settings may provide
!                 these.  If running xfree86 (or derivative),  xvidtune should
!                 give you these values.
!     full_width  full width (pixels) including front/back porch etc
!                 this should be 20-30% more than the width.
!     left_margin offset of first real pixel from left
!     top_margin  offset of first real line from top
!     hpol        hsync polarity, 0=-ve 1=positive
!     vpol        vsync polarity, 0=-ve 1=positive
!     ifh         value of ifh detection register
!     ifv         value of ifv detection register
!     phase       pixel phase sampling (16 is a good starting point)
!     name        mode name

  Once you have you mode in and compiled, restart and run okvm-vidtune and
***************
*** 147,175 ****

! 5) Tested Hardware
  ------------------

  The OKVM PCI card and driver is known to work on the following configurations:

! - DELL Dimension XPS T500 / Mandriva Limited Edition 2005 / 2.6.11-6mdk
! - DELL Simension L466c / Ubuntu 5.10 "Breezy Badger" / 2.6.12-9-386
! - Celeron 2.66GHz 512M RAM / Fedora Core 4 / 2.6.11-1.1369_FC4
! - Soekris Geode 266MHz, 2.4 - uClinux
! - AMD Athlon 3000+ / Debian Testing / 2.4

  The OKVM PCI card has been successfully tested with the following KVM switches:

! - Belkin OmniView PRO2 8 port switch

! 6) Finding more Information
  ---------------------------

  For more information on the okvm project,  visit these links.

! 	Web:          http://okvm.sourceforge.net/
! 	SourceForge:  http://sourceforge.net/projects/okvm/
! 	Email:        da...@us...
! 	Mailing List: okv...@li...

  For more information on the components that make up the OKVM PCI card,
--- 174,202 ----

! 6) Tested Hardware
  ------------------

  The OKVM PCI card and driver is known to work on the following configurations:

!     - DELL Dimension XPS T500 / Mandriva Limited Edition 2005 / 2.6.11-6mdk
!     - DELL Simension L466c / Ubuntu 5.10 "Breezy Badger" / 2.6.12-9-386
!     - Celeron 2.66GHz 512M RAM / Fedora Core 4 / 2.6.11-1.1369_FC4
!     - Soekris Geode 266MHz, 2.4 - uClinux
!     - AMD Athlon 3000+ / Debian Testing / 2.4

  The OKVM PCI card has been successfully tested with the following KVM switches:

!     - Belkin OmniView PRO2 8 port switch

! 7) Finding more Information
  ---------------------------

  For more information on the okvm project,  visit these links.

!     Web:          http://okvm.sourceforge.net/
!     SourceForge:  http://sourceforge.net/projects/okvm/
!     Email:        da...@us...
!     Mailing List: okv...@li...

  For more information on the components that make up the OKVM PCI card,
***************
*** 178,210 ****
  can also download the hardware design info (okvm-internal-doc*.zip).

! 	AD9884A
! 		http://www.analog.com/en/prod/0%2C2877%2CAD9884A%2C00.html
! 	PCI9054
! 		http://www.plxtech.com/products/io_accelerators/PCI9054/default.htm
! 	XC9536XL
! 		http://www.xilinx.com/bvdocs/publications/ds058.pdf
! 	XILINX ISE SW
! 		http://www.xilinx.com/ise/logic_design_prod/webpack.htm
! 	IDT71V30
! 		http://www1.idt.com/pcms/products.taf?catID=58642&genID=71V30#Datasheet
! 	AT89LS52
! 		http://www.atmel.com/dyn/products/product_card.asp?family_id=604&family_name=8051+Architecture&part_id=1922
! 	93LC46B
! 		http://ww1.microchip.com/downloads/en/DeviceDoc/21794b.pdf
! 	LM1117DT-ADJ & LM1117MPX-ADJ
! 		http://www.national.com/pf/LM/LM1117.html
! 	CRYSTAL
! 		http://www.hy-q.com.au/pdf/10120069.pdf
! 	OSCILLATOR
! 		http://www.hy-q.com.au/pdf/10120058.pdf
! 	SDRAM
! 		http://www.hynix.com/datasheet/eng/dram/details/dram_01_HY57V283220T(P).jsp
! 	74LCX573
! 		http://www.onsemi.com/PowerSolutions/product.do?id=MC74LCX573
! 	PCA9564D
! 		http://www.onsemi.com/PowerSolutions/product.do?id=MC74LCX573
! 	j-L201 PRODUCT BROCHURE
! 		http://www.jepico.co.jp/product/ap/english/index.html
! 

  Copyright (C) 2005, David McCullough <da...@us...>
--- 205,236 ----
  can also download the hardware design info (okvm-internal-doc*.zip).

!     AD9884A
!         http://www.analog.com/en/prod/0%2C2877%2CAD9884A%2C00.html
!     PCI9054
!         http://www.plxtech.com/products/io_accelerators/PCI9054/default.htm
!     XC9536XL
!         http://www.xilinx.com/bvdocs/publications/ds058.pdf
!     XILINX ISE SW
!         http://www.xilinx.com/ise/logic_design_prod/webpack.htm
!     IDT71V30
!         http://www1.idt.com/pcms/products.taf?catID=58642&genID=71V30#Datasheet
!     AT89LS52
!         http://www.atmel.com/dyn/products/product_card.asp?family_id=604&family_name=8051+Architecture&part_id=1922
!     93LC46B
!         http://ww1.microchip.com/downloads/en/DeviceDoc/21794b.pdf
!     LM1117DT-ADJ & LM1117MPX-ADJ
!         http://www.national.com/pf/LM/LM1117.html
!     CRYSTAL
!         http://www.hy-q.com.au/pdf/10120069.pdf
!     OSCILLATOR
!         http://www.hy-q.com.au/pdf/10120058.pdf
!     SDRAM
!         http://www.hynix.com/datasheet/eng/dram/details/dram_01_HY57V283220T(P).jsp
!     74LCX573
!         http://www.onsemi.com/PowerSolutions/product.do?id=MC74LCX573
!     PCA9564D
!         http://www.onsemi.com/PowerSolutions/product.do?id=MC74LCX573
!     j-L201 PRODUCT BROCHURE
!         http://www.jepico.co.jp/product/ap/english/index.html

  Copyright (C) 2005, David McCullough <da...@us...>