xref: /haiku/src/add-ons/kernel/drivers/graphics/nvidia/README.html (revision 9eb55bc1d104b8fda80898f8b25c94d8000c8255)
1<html>
2<head>
3	<meta http-equiv="Content-Type"	content="text/html; charset=iso-8859-1">
4	<meta name="GENERATOR" content="The DarkSite">
5	<title>Readme for (open)BeOS Unified Nvidia graphics driver</title>
6</head>
7<body>
8<h2 align="center">Unified Nvidia graphics driver for (open)BeOS</h2></align><br><br>
9<hr>
10<h3><strong>NOTE PLEASE:</strong><br>
11You use this software at your own risk! Although I don't expect it to damage your PC, videocard or Monitor, I cannot guarantee this!<br>
12<br>
13Especially owners of laptops are encouraged to be extra carefull with their internal panels. A refresh setting higher than 60Hz might destroy the panel!</h3>
14<hr>
15<h2>Supported cards (as far as is known):</h2>
16<ul>
17	<li>TNT 1/2;
18	<li>TNT 2-M64;
19	<li>Vanta/Aladdin TNT2;
20	<li>GeForce 256;
21	<li>GeForce 2 MX/Ti/GTS/Go (Go only with external monitor);
22	<li>GeForce 2 Integrated GPU (Nforce) (setup RAM amount manually for now);
23	<li>GeForce 3 (Ti);
24	<li>GeForce 4 MX/Ti/Go (Go only with external monitor);
25	<li>GeForce 4 Integrated GPU (Nforce 2) (setup RAM amount manually for now);
26	<li>GeForce FX 5200/5600/5700/5800/5900/5950/Go (Go only with external monitor);
27	<li>Quadro (2/4/FX/Go) (Go only with external monitor).
28</ul>
29<br>
30<hr>
31<h2>Features:</h2>
32<ul>
33	<li>Hardware cursor support (on both heads on dualhead cards);
34	<li>Full 2D acceleration;
35	<li>Full BWindowScreen support (used for hardware pageflipping, scrolling/panning and acceleration in applications/games);
36	<li>DPMS support (on both heads on dualhead cards);
37	<li>B_YCbCr422 hardware overlay support on both TNT and GeForce series cards (overlay follows head in dualhead stretch/switch modes);
38	<li>Dualhead support on GeForce dualhead cards (use Mark Watson's 'Dualhead Setup' from BeBits for now).
39</ul>
40<strong>Known limitations:</strong>
41<ul>
42	<li>If the driver does not load make sure you enabled 'assign IRQ to VGA card' in your system BIOS;
43	<li>Flatpanel protection for laptops is not yet in place: be carefull! External only output has been reported functional though.
44	<li>No DVI support: you have to use a standard VGA cable to connect external flatpanels;
45	<li>Embedded GeForce RAM detection is non-functional: please set amount manually for now via the nv.settings file (driver probably defaults to 1Mb if you don't). If you have overlay trouble, set a slightly smaller amount of RAM than you actually specified in the system BIOS (1Mb less or so);
46	<li>A few cards still might have hardcursor trouble. If you encounter this use the softcursor: select this via the nv.settings file. Make sure you mail me if you still have trouble but also if this version fixed that!;
47	<li>If the driver still seems to create 'random' trouble make sure you have a fully functional VGA BIOS, or system BIOS for embedded cards (check for updates on the manufacturor's site). Make sure you mail me if you still have trouble but also if this version fixed that!
48</ul>
49<br>
50<hr>
51<h2>Installation:</h2>
52If you encounter bugs, please checkout the driver's <a href="http://web.inter.nl.net/users/be-hold/BeOS/NVdriver/index.html">website</a> to see if it's already on the todo list. You can also checkout the <a href="UPDATE.html">UPDATE</a> file included with this driver to see if it should have been fixed. If you think it's prudent, or if you are unsure, then please fill out the <a href="http://web.inter.nl.net/users/be-hold/BeOS/NVdriver/bugreport.html">bugreport form</a> on the site or send me an <a href="mailto:rag.cornelissen@inter.nl.net">Email</a>. Make sure you are as precise as possible because that will make things easier to trackdown and fix...<br>
53<br>
54<br>
55OK, now that's all said let's get to it ;-)<br>
56<br>
57In contrary to what I have said before you don't need to de-install official Be drivers for this driver to work correctly. This driver will install in the user part of the BeOS, so not in the system part where the official drivers are.<br>
58BeOS first checks (during boot) if there are 'user-addons' that should be loaded for a device. If not, it loads it's own drivers (if any). You can select which driver should be loaded by hitting the spacebar as soon as the BeOS 'icons' screen appears. If you select <strong>disable user addons</strong> the system will load it's own drivers. If you don't do anything, the system will load the (open)BeOS Nvidia TNT/GeForce graphics driver.<br>
59<br>
60<strong>Note:</strong> This might turn out to be handy if you run into trouble upon testing the driver, or if you are 'tweaking' the nv.settings file...<br>
61<br><br>
62<strong>actual INSTALLATION:</strong><br>
63<br>
64Doubleclick on the install.sh file and follow the instructions. You have to reboot in order to load the driver. Make sure you read the <strong>Settings</strong> information below before you do that...<br>
65<br>
66<br>
67<strong>alternate INSTALLATION method:</strong><br>
68<br>
69Unzip the zip file that contains the driver to the root folder. Now reboot and you should be using the new driver.<br>
70<br>
71<br>
72<strong>DE-INSTALLATION:</strong><br>
73<br>
74Currently there's no uninstall script included. Just do it manually:<br>
75<br>
76Delete the <strong>nv.accelerant</strong> file in <strong>home/config/add-ons/accelerants/</strong><br>
77Delete the <strong>nv.driver</strong> file in <strong>home/config/add-ons/kernel/drivers/bin/</strong><br>
78Delete the <strong>nv.settings</strong> file in <strong>home/config/settings/kernel/drivers/</strong><br>
79Delete the <strong>nv.driver shortcut</strong> in <strong>home/config/add-ons/kernel/drivers/dev/graphics/</strong> which pointed to the file <strong>nv.driver</strong>.<br>
80<br>
81You have to reboot in order to apply the original configuration.<br>
82<br>
83<br>
84<hr>
85<a name="settings"></a><h2>Settings:</h2><br>
86Please read this information carefully *before* installing and using the (open)BeOS Nvidia TNT/GeForce graphics driver. It might spare you some trouble afterwards..<br>
87<p>The driver uses a file named <strong>nv.settings</strong> to determine how to use your card. After installation this file will be located at <strong>home/config/settings/kernel/drivers/</strong>. How you should setup this file depends on what you want to do with the driver. While it has a 'failsave' default configuration, you might be able to do better than that... Anyway, read the nifty details below.<br>
88<br>
89<strong>Note:</strong> The driver only reads this file during it's initialisation. This means that you have to reboot in order to let changes take effect.<br>
90<br>
91<br>
92<br>
93<strong>nv.settings driver configuration:</strong><br>
94<ul>
95	<li><strong>memory:</strong> (disabled by default)<br>
96		This option enables you to override the 'memory amount autodetection' of the driver. If autodetection is working incorrect, you can manually set the amount this way. You could also lower the amount of RAM to a lower value than actually there to test with for instance overlay use in applications. So this option is probably mostly of interest to developers. Specify the RAM amount in Mb (use only 'whole' numbers!).<br>
97This option is disabled by default (preceded by a '#').<br>
98<li><strong>hardcursor:</strong><br>
99	A hardcursor is nessesary for DirectWindow windowed mode support.
100	<ul>
101		<li><strong>false:</strong><br>
102		If you have trouble with the hardcursor (on one or both of the heads), select <strong>hardcursor false</strong>. Make sure you let me know about the hardcursor trouble also: this should not happen!
103		<li><strong>true:</strong> (default setting)<br>
104		A software cursor 'flickers' a bit sometimes because it has to be redrawn constantly. So <strong>hardcursor true</strong> is the preferred setting. For DirectWindow windowed mode functionality you need to use this setting also (Chart demo app for instance).
105	</ul>
106<li><strong>logmask:</strong> (set to minimal by default)<br>
107The logmask option is very handy to track down trouble in the driver. You should only enable this if you are doing so, otherwise keep it turned off because it slows down your system. (All lines have a '#' preceding 'logmask' by default.) Logging creates a logfile called <strong>nv.accelerant.0.log</strong> in your <strong>~ (home)</strong> folder. A second logfile may get created depending on how the driver is used (on cloning; for BWindowScreen for example). The second file is called <strong>nv.accelerant.1.log</strong>, and it will also be in your home folder.<br>
108<strong>Note:</strong>
109<ul>
110<li>You may only enable *one* logmask-line. The value you place after it (hexadecimal 32bit) determines what will be logged. The first 7 digits determine the part of the driver that will be logging, the last single digit determines the level of logging (like 'all messages', or only 'error messages').
111</ul>
112<li><strong>dumprom:</strong><br>
113Dumprom is another 'tool' for bug-tracking purposes.
114	<ul>
115		<li><strong>false:</strong> (default setting)<br>
116		Keep it set to <strong>dumprom false</strong>, unless you want the driver to dump the contents of your VGA BIOS ROM in a file.
117		<li><strong>true:</strong><br>
118		<strong>dumprom true</strong> lets the driver dump a copy of your VGA BIOS in a file called <strong>nv.rom</strong> in your <strong>~ (home)</strong> folder.
119	</ul>
120</ul>
121
122<hr>
123<br>
124<a href="mailto:rag.cornelissen@inter.nl.net">Rudolf Cornelissen.</a>
125<p>(Page last updated on February 2, 2004)</p>
126</body>
127</html>
128