xref: /haiku/src/add-ons/kernel/drivers/graphics/nvidia/README.html (revision 39241fe22890fb958b6ba32d6ab9526da98be187)
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!</h3>
12<hr>
13<h2>Supported cards (as far as is known):</h2>
14<ul>
15	<li>TNT 1/2;
16	<li>TNT 2-M64;
17	<li>Vanta/Aladdin TNT2;
18	<li>GeForce 256;
19	<li>GeForce 2 MX/Ti/GTS/Go;
20	<li>GeForce 2 Integrated GPU (Nforce);
21	<li>GeForce 3 (Ti);
22	<li>GeForce 4 MX/Ti/Go;
23	<li>GeForce 4 Integrated GPU (Nforce 2);
24	<li>GeForce FX 5200/5600/5700/5800/5900/5950/Go;
25	<li>Quadro (2/4/FX/Go);
26	<li>Some GeForce PCIe cards.
27</ul>
28<br>
29<hr>
30<h2>Features:</h2>
31<ul>
32	<li>Hardware cursor support (on both heads on dualhead cards);
33	<li>Full 2D acceleration;
34	<li>Full BWindowScreen support (used for hardware pageflipping, scrolling/panning and acceleration in applications/games);
35	<li>DPMS support for analog connected screens (on both heads on dualhead cards);
36	<li>B_YCbCr422 hardware overlay support on both TNT and GeForce series cards (overlay follows head in dualhead stretch/switch modes);
37	<li>Dualhead support on GeForce dualhead cards (use Mark Watson's 'Dualhead Setup' from BeBits for now);
38	<li>DVI and laptop panel (widescreen) support;
39	<li>Basic AGP mode support on AGP cards, using the new (seperate) (open)BeOS AGP busmanager;
40	<li>Coldstart support for analog connected screens on most cards except TNT1, GeForce 6600 and GeForce 6800.
41</ul>
42<strong>Known limitations:</strong>
43<ul>
44	<li>If the driver does not load make sure you enabled 'assign IRQ to VGA card' in your system BIOS;
45	<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!
46	<li>If on a laptop the internal panel doesn't work when you connect an external monitor, make sure you set 'output device selection' to 'internal' (instead of 'auto') in the system BIOS if it has such an option. If you have this symptom on a normal card, or on a laptop without that BIOS option then you are probably out of luck for dualhead support.
47</ul>
48<br>
49<hr>
50<h2>Installation:</h2>
51If 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:info.be-hold@inter.nl.net">Email</a>. Make sure you are as precise as possible because that will make things easier to trackdown and fix...<br>
52<br>
53<br>
54OK, now that's all said let's get to it ;-)<br>
55<br>
56In 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>
57BeOS 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>
58<br>
59<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>
60<br><br>
61<strong>actual INSTALLATION:</strong><br>
62<br>
63Doubleclick 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>
64<br>
65<br>
66<strong>alternate INSTALLATION method:</strong><br>
67<br>
68Unzip the zip file that contains the driver to the root folder. Now reboot and you should be using the new driver.<br>
69<br>
70<br>
71<strong>DE-INSTALLATION:</strong><br>
72<br>
73Currently there's no uninstall script included. Just do it manually:<br>
74<br>
75Delete the <strong>nv.accelerant</strong> file in <strong>home/config/add-ons/accelerants/</strong><br>
76Delete the <strong>nv.driver</strong> file in <strong>home/config/add-ons/kernel/drivers/bin/</strong><br>
77Delete the <strong>nv.settings</strong> file in <strong>home/config/settings/kernel/drivers/</strong><br>
78Delete 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>
79<br>
80You have to reboot in order to apply the original configuration.<br>
81<br>
82<br>
83<hr>
84<a name="settings"></a><h2>Settings:</h2><br>
85Please read this information carefully *before* installing and using the (open)BeOS Nvidia TNT/GeForce graphics driver. It might spare you some trouble afterwards..<br>
86<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>
87<br>
88<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>
89<br>
90<br>
91<br>
92<strong>nv.settings driver configuration:</strong><br>
93<ul>
94	<li><strong>usebios:</strong><br>
95The name of this item may be somewhat misleading, it might be changed in the future. It actually tells the driver if it should coldstart the card or not. The driver will rely on the VGA BIOS to have coldstarted the card before BeOS booted if you specify 'true'.<br>
96To make things look even more complex the driver might actually use the BIOS to determine your cards specifications on *both* possible settings.
97	<ul>
98		<li><strong>false:</strong><br>
99		If you specify <strong>usebios false</strong> the driver will attempt to coldstart the card, which is the preferred way of doing it because of the better tuned setup if all is right. Unfortunately there's not enough info available to make this work reliably, so it's not used by default. This setting would enable you to use your nVidia card as a secondary card in your system. Be advised though that BeOS officially does not (yet) support multiple VGA cards, so you need special software in order to be able to actually use it (a video consumer node for instance).
100		<li><strong>true:</strong> (default setting)<br>
101		Specify <strong>usebios true</strong> unless you want to try to use a nVidia card as a secondary card in your system.
102	</ul>
103	<strong>Notes:</strong>
104 	<ul>
105 		<li>On driverversion 0.23 and before usebios had no effect at all. The cards were never coldstarted;
106		<li>Coldstarting should work on most cards except TNT1, GeForce 6600 and GeForce 6800;
107		<li>Coldstarting will not yet work with laptop- and DVI panels;
108		<li>Coldstarting should fix the 'bandwidth trouble' existing on some GeForce2 cards.
109 	</ul>
110	<li><strong>memory:</strong> (disabled by default)<br>
111		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>
112This option is disabled by default (preceded by a '#').<br>
113<li><strong>hardcursor:</strong><br>
114	A hardcursor is nessesary for DirectWindow windowed mode support.
115	<ul>
116		<li><strong>false:</strong><br>
117		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!
118		<li><strong>true:</strong> (default setting)<br>
119		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).
120	</ul>
121<li><strong>logmask:</strong> (set to minimal by default)<br>
122The 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>
123<strong>Note:</strong>
124<ul>
125<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').
126</ul>
127<li><strong>dumprom:</strong><br>
128Dumprom is another 'tool' for bug-tracking purposes.
129	<ul>
130		<li><strong>false:</strong> (default setting)<br>
131		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.
132		<li><strong>true:</strong><br>
133		<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.
134	</ul>
135<li><strong>switchhead:</strong><br>
136The driver always autodetects which output should be used as primary one, but you can let the driver 'invert' the outcome of that detection with this option (only for dualhead cards).
137	<ul>
138		<li><strong>false:</strong> (default setting)<br>
139		Keep it set to <strong>switchhead false</strong>, unless you feel you want the card's other output to be used as primary one. Note that if a single connected screen is found, that screen will be the driver's primary output with this setting.
140		<li><strong>true:</strong><br>
141		<strong>switchhead true</strong> lets the driver 'invert' the output assignments for all modes. Use only when you have two screens connected, otherwise the one connected screen will remain black as the other (not connected) output is being used.<br>
142	</ul>
143<strong>Note:</strong>
144<ul>
145	<li>If the driver determines it cannot use a digital panel <strong>despite</strong> it being physically connected and powered on, using the switchhead option will not fix this. This is no fault in your card or the panel, but happens only because the driver relies on certain functions inside your cards BIOS to behave in a certain way.
146</ul>
147	<li><strong>force_pci:</strong><br>
148On AGP cards you can block the use of AGP mode transfers.
149	<ul>
150		<li><strong>false:</strong> (default setting)<br>
151Keep this option set to <strong>force_pci false</strong>, unless the graphics card or motherboard has trouble using AGP.
152		<li><strong>true:</strong><br>
153<strong>force_pci true</strong> prevents the graphicsdriver from activating AGP mode, so it will be using PCI mode like it has always been in the past. The downside of this is that this comes at a performance penalty if your motherboard supports the AGP 'fastwrite' (FW) option, which won't be utilized with this setting.
154	</ul>
155<strong>Note:</strong>
156<ul>
157	<li>If you have trouble using AGP mode, you should prefer tweaking the AGP busmanager settings file as it might well enable you to use a 'lesser' AGP mode instead of falling back to PCI mode alltogether.
158</ul>
159	<li><strong>unhide_fw:</strong><br>
160This option is only used if your card is running in AGP mode. It's a real <strong>tweak</strong> option. It's officially unsupported, and it's unknown if it can do harm to your card or system. It exists because using it <strong>can</strong> speedup unaccelerated graphics <strong>a lot</strong>. Think about video playback or playing quake2 in software rendering mode...
161	<ul>
162		<li><strong>false:</strong> (default setting)<br>
163Keep this option set to <strong>unhide_fw false</strong> unless you are certain you want to try the 'unsupported' graphics speedup. NV15, NV18, NV28 and NV34 cards for example probably don't need it as they officially support the AGP FW (fastwrites) feature already. On cards supporting FW by default the unhide_fw option has no effect.
164		<li><strong>true:</strong><br>
165If you have an older card that officially doesn't support the AGP FW feature, you could possibly get this feature anyway by setting <strong>unhide_fw true</strong>. For instance (some) NV11 cards work nicely with AGP FW enabled this way and unaccelerated graphics speedup considerably. Please <strong>make sure</strong> that at the first sign of trouble (system hanging, displaying artifacts, etc) you disable this feature here again, or you might risk <strong>destroying</strong> your card and/or AGP slot.
166	</ul>
167	<li><strong>pgm_panel:</strong><br>
168This option only has an effect if you have a laptop panel or DVI panel connected. It's existing because it's currently impossible to setup the driver in a way every single panel outthere is happy about it.
169	<ul>
170		<li><strong>false:</strong><br>
171If you select <strong>pgm_panel false</strong> the driver will not program the panel's pixelclock (refreshrate). Instead it relies on your cardBIOS to have done that correctly. While this is probably the case, it might introduce some displaying errors every now and then.
172		<li><strong>true:</strong> (default setting)<br>
173With the <strong>pgm_panel true</strong> setting, the driver will fix your panel's refreshrate to 60Hz. While this should be working on all panels outthere, some panels are particular picky about refreshrates below 60.0Hz (they shut off), and some other panels are particular picky about refreshrates above 60.0Hz (they shut off). While the driver requests the hardware to set 60.0Hz, this isn't exactly possible, so the actual setting is <strong>bound</strong> to be a tiny bit below or above 60.0Hz.
174	</ul>
175</ul>
176
177<hr>
178<br>
179<a href="mailto:info.be-hold@inter.nl.net">Rudolf Cornelissen.</a>
180<p>(Page last updated on November 1, 2004)</p>
181</body>
182</html>
183