Return to README CVS log

Up to [DVB] / kfir

Annotation of kfir/README, revision 1.2

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.
        !            12: Install the Win9x/Kfir1 version on your system, cd to driver/micro, adjust the paths 
        !            13: in the first two lines of Makefile and do "make" to extract the microcodes.
        !            14: Afterwards you should be able to compile and use the driver.
        !            15: 
        !            16: There is no license agreement in the installation file of those drivers but 
        !            17: some microcode files contain a copyright header. 
        !            18: I am not a lawyer, so please figure out for yourself how they apply in the
        !            19: situtation in which you are using the driver.
        !            20: 
        !            21: --------------------------------------------------------------------------
        !            22: 
1.1       cvs        23: This is an evaluation release of a Linux device driver module for the Kfir
                     24: encoder card.
                     25: 
                     26: Most of the files in kfir/driver/ are part of all newer Linux kernels.
                     27: If you are using a 2.4.x kernel you can also use the i2c and videodev files
                     28: from your kernel. They are included here for compatibility with 2.2.x kernels
                     29: which use an older I2C interface.
                     30: 
1.2     ! rjkm       31: All files are released under the GNU General Public License.
        !            32: 
        !            33: The actual new files for the Kfir driver are: 
        !            34: 
        !            35: kfir.c kfir.h KfirCMD.h KfirDef.h plx9054.h 
1.1       cvs        36: 
                     37: This driver is provided for evaluation purposes only.
                     38: 
                     39: Known problems: see http://linuxtv.org/mpeg2
                     40: 
                     41: INSTALLATION:
                     42: 
                     43: Change into the driver directory.
                     44: The Makefile expects the configured sources of the currently used kernel to be 
                     45: in /usr/src/linux. Otherwise, change the setting of KERNEL_LOCATION in the Makefile.
                     46: 
                     47: Do a "make"
                     48: 
                     49: If everything compiled without problems try "make insmod".
                     50: 
1.2     ! rjkm       51: Now (if your PC did not crash :-) plug in a PAL composite signal and sound and 
1.1       cvs        52: try: "cat /dev/video > test.mpg"
                     53: 
                     54: Stop the encoding process by pressing CNTRL-C.
                     55: 
                     56: 
                     57: Right now you can only change the recording parameters via module arguments.
                     58: Possible options for the kfir module:
                     59: 
                     60: loaded       - Altera is already loaded with microcode, so donīt do it again
                     61:                (reloading takes time and can lock your machine!)
                     62: 
                     63: vidinmode    - vidimode=0  for PAL, 1 for NTSC, 2 for SECAM (default PAL)
                     64: 
                     65: vidoutmode   - vidoutmode=0 for NTSC, 1 for PAL (default PAL)
                     66:                (yaeh, I know, KFIR and Video4Linux defines are different for PAL/NTSC)
                     67: 
                     68: vidsize      - vidsize=(vertical_mode<<4)|horizontal_mode,  cf. KfirCMD.h
                     69:                e.g. vidsize=0x12 (=(KFIR_V_288<<4)|KFIR_H_352)
                     70: 
                     71: vidrate      - video bitrate
                     72: 
                     73: mpeg1mode    - mpeg1mode=1 for MPEG1 
                     74: 
                     75: streamtype   - streamtype=0, ..., 7 (cf. KfirCMD.h, default VT_KFIR_PROGRAM) 
                     76: 
1.2     ! rjkm       77: sndfreq      - sndfreq=5,6,7 (cf. KfirCMD.h, default VT_KFIR_AUDIO_FREQ_48_000) 
        !            78:                only 32, 44.1 and 48 KHz seem to work with the Visiontech microcode
1.1       cvs        79: 
1.2     ! rjkm       80: vidinput     - 0=Composite, 1=S-Video
1.1       cvs        81: 
                     82: 
1.2     ! rjkm       83: Ralph Metzler <ralph@convergence.de>