annotate drivers/README @ 22658:6d257bd87fce

Merge README.linux.2.6 into general README.
author diego
date Sat, 17 Mar 2007 09:07:21 +0000
parents 3b5f5d1c5041
children 57cf28cd0285
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22658
6d257bd87fce Merge README.linux.2.6 into general README.
diego
parents: 1
diff changeset
1 The code in this directory is the old mga_vid driver for Linux kernels
6d257bd87fce Merge README.linux.2.6 into general README.
diego
parents: 1
diff changeset
2 prior to 2.6. It does _not_ compile for version 2.6.x.
6d257bd87fce Merge README.linux.2.6 into general README.
diego
parents: 1
diff changeset
3
6d257bd87fce Merge README.linux.2.6 into general README.
diego
parents: 1
diff changeset
4 For Linux kernel 2.6.x please get the newest version of the 2.6 port from
6d257bd87fce Merge README.linux.2.6 into general README.
diego
parents: 1
diff changeset
5 http://attila.kinali.ch/mga/
1
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
6
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
7 mga_vid - MGA G200/G400 YUV Overlay kernel module
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
8
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
9 Author:
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
10 Aaron Holtzman <aholtzma@ess.engr.uvic.ca>, Oct 1999
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
11
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
12 Contributions by:
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
13 Fredrik Vraalsen <vraalsen@cs.uiuc.edu>
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
14 Alan Cox <alan@lxorguk.ukuu.org.uk>
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
15
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
16 WARNING ----- WARNING
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
17
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
18 This code messes with your video card and your xserver. It will probably
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
19 lock up your box, format your hard drive, and cause your brand new g400
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
20 MAX to spout 6 inch flames. You have been warned.
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
21
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
22 WARNING ----- WARNING
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
23
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
24 What does this code do?
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
25
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
26 mga_vid is a kernel module that utilitizes the Matrox g200/g400 video
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
27 scaler/overlay unit to perform YUV->RGB colorspace conversion and
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
28 arbitrary video scaling.
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
29
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
30 mga_vid is also a monster hack.
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
31
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
32 How does mga_vid work?
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
33
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
34 This kernel module sets up the BES (backend scaler) with approriate values
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
35 based on parameters supplied via ioctl. It also maps a chunk of video
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
36 memory into userspace via mmap. This memory is stolen from X (which may
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
37 decide to write to it later). The application can then write image data
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
38 directly to the frame buffer (if it knows the right padding, etc).
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
39
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
40
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
41 How do I know if mga_vid works on my system?
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
42
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
43 There are test applications called mga_vid_test_g400 and mga_vid_test_g200.
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
44 Use the appropriate one for your card. This test code should draw some
3b5f5d1c5041 Initial revision
arpi_esp
parents:
diff changeset
45 nice 256x256 images for you if all is working well.