Return to README CVS log

Up to [DVB] / kfir

Annotation of kfir/README, revision 1.4

1.2       rjkm        1: Attention!
                      2: 
                      3: This driver comes without the firmware, because the copyright situation
                      4: is still unclear. So it's not working. We're trying to work this out
                      5: with Visiontech, and hope to provide a working driver soon.
                      6: 
                      7: Visiontech makes the microcode available for free download on their own
                      8: ftp site ftp.visiontech-dml.com. They offered their own user-space (and not really 
                      9: working without many system locks) Linux driver including firmware there.
                     10: They removed it for unknown reasons but you can download versions for some 
                     11: of those other operating systems which some people use.
1.4     ! rjkm       12: Install the Win9x/Kfir1 version available at:
        !            13: ftp://ftp.visiontech-dml.com/pub/Win9x%5CME/KFir/KFirAppVersion4.23/KFirApp4-23_9x.zip
        !            14: on your system, cd to driver/micro, adjust the paths 
1.2       rjkm       15: in the first two lines of Makefile and do "make" to extract the microcodes.
                     16: Afterwards you should be able to compile and use the driver.
                     17: 
1.3       rjkm       18: The files resulting from the extraction process should have the following md5
                     19: cheksums:
                     20: 
                     21: 05269813b418d4ce733e69b13db8dc03  MPEG1_6.HLD
                     22: 4e3e3088a1f5ad1e480ef1aa0456cdf5  altera_keb_plx_5e.rbf
                     23: 40ce0f03215ff51d4a8aaaf846389c5e  kfir_micro.h
                     24: 
                     25: 
1.2       rjkm       26: There is no license agreement in the installation file of those drivers but 
                     27: some microcode files contain a copyright header. 
1.3       rjkm       28: IANAL, so please figure out for yourself how they apply in the
1.2       rjkm       29: situtation in which you are using the driver.
                     30: 
                     31: --------------------------------------------------------------------------
                     32: 
1.1       cvs        33: This is an evaluation release of a Linux device driver module for the Kfir
                     34: encoder card.
                     35: 
                     36: Most of the files in kfir/driver/ are part of all newer Linux kernels.
                     37: If you are using a 2.4.x kernel you can also use the i2c and videodev files
                     38: from your kernel. They are included here for compatibility with 2.2.x kernels
                     39: which use an older I2C interface.
                     40: 
1.2       rjkm       41: All files are released under the GNU General Public License.
                     42: 
                     43: The actual new files for the Kfir driver are: 
                     44: 
1.4     ! rjkm       45: kfir.c kfir.h Kfir.h plx9054.h 
1.1       cvs        46: 
                     47: This driver is provided for evaluation purposes only.
                     48: 
                     49: Known problems: see http://linuxtv.org/mpeg2
                     50: 
                     51: INSTALLATION:
                     52: 
                     53: Change into the driver directory.
                     54: The Makefile expects the configured sources of the currently used kernel to be 
                     55: in /usr/src/linux. Otherwise, change the setting of KERNEL_LOCATION in the Makefile.
                     56: 
                     57: Do a "make"
                     58: 
                     59: If everything compiled without problems try "make insmod".
                     60: 
1.2       rjkm       61: Now (if your PC did not crash :-) plug in a PAL composite signal and sound and 
1.1       cvs        62: try: "cat /dev/video > test.mpg"
                     63: 
                     64: Stop the encoding process by pressing CNTRL-C.
                     65: 
                     66: 
                     67: Right now you can only change the recording parameters via module arguments.
                     68: Possible options for the kfir module:
                     69: 
                     70: loaded       - Altera is already loaded with microcode, so donīt do it again
                     71:                (reloading takes time and can lock your machine!)
                     72: 
                     73: vidinmode    - vidimode=0  for PAL, 1 for NTSC, 2 for SECAM (default PAL)
                     74: 
                     75: vidoutmode   - vidoutmode=0 for NTSC, 1 for PAL (default PAL)
                     76:                (yaeh, I know, KFIR and Video4Linux defines are different for PAL/NTSC)
                     77: 
1.4     ! rjkm       78: vidsize      - vidsize=(vertical_mode<<4)|horizontal_mode,  cf. Kfir.h
1.1       cvs        79:                e.g. vidsize=0x12 (=(KFIR_V_288<<4)|KFIR_H_352)
                     80: 
1.4     ! rjkm       81: vidrate      - video bitrate in bits/s
1.1       cvs        82: 
                     83: mpeg1mode    - mpeg1mode=1 for MPEG1 
                     84: 
1.4     ! rjkm       85: streamtype   - streamtype=0, ..., 7 (cf. Kfir.h, default VT_KFIR_PROGRAM) 
1.1       cvs        86: 
1.4     ! rjkm       87: sndfreq      - sndfreq=5,6,7 (cf. Kfir.h, default VT_KFIR_AUDIO_FREQ_48_000) 
1.2       rjkm       88:                only 32, 44.1 and 48 KHz seem to work with the Visiontech microcode
1.1       cvs        89: 
1.2       rjkm       90: vidinput     - 0=Composite, 1=S-Video
1.1       cvs        91: 
                     92: 
1.2       rjkm       93: Ralph Metzler <ralph@convergence.de>