Annotation of dvb-kernel/README, revision 1.9

1.8       holger      1: Instructions for building the standalone driver:
                      2: ------------------------------------------------
1.1       hunold      3: 
1.9     ! holger      4: You must have the kernel sources for the kernel you are currently using
1.8       holger      5: installed, and symlinked to /lib/modules/$(KERNEL_VERSION)/build. This should
                      6: be the default in proper installations with installed kernel source package.
1.1       hunold      7: 
1.8       holger      8: If you are in doubt please get a fresh and clean kernel source tarball from 
                      9: http://www.kernel.org/, unpack, configure, install and boot this one before
                     10: building the DVB driver. 80% of the bug reports on the linux-dvb mailing list
1.9     ! holger     11: have been related to not properly installed kernel source trees in the past.
1.8       holger     12: 
                     13: For cards with MPEG decoder onboard make sure that CONFIG_VIDEO_DEV is enabled
                     14: in the config of your running kernel. If you get unresolved symbols named
1.9     ! holger     15: video_XXXX when loading the driver then you missed this option.
1.8       holger     16: 
                     17: For some cards you need Input and Event Device Support enabled to get the
                     18: IR receiver on the card running. Be sure to enable CONFIG_INPUT and 
                     19: CONFIG_INPUT_EVDEV if you get unresolved symbols named input_XXX.
                     20: 
                     21: Now Type 'make' to build the driver. The compiled modules will be located
                     22: in directory ./build-2.4/ or ./build-2.6, depening on the kernel version you
                     23: are running. There you will also find scripts to load and unload the modules.
                     24: 
                     25: For some cards you need to download additional firmware binaries.  You get
                     26: notified in the build process or when loading the modules, please follow the
                     27: instructions there if you own one of the cards that need a firmware to run.
                     28: 
                     29: Now execute the ./MAKEDEV-DVB.sh script to create the DVB API device nodes.
1.9     ! holger     30: In ./build-2.4/ or ./build-2.6/ you find the insmod script.  
        !            31: Use './insmod.sh load' to load the driver modules, './insmod.sh unload' to 
        !            32: remove them. './insmod debug' loads the drivers with debugging enabled. 
        !            33: These scripts load all drivers for all cards, if you check what hardware you 
        !            34: actually own you can accelerate the initialisation by loading only the driver 
        !            35: modules you need.
        !            36: 
1.8       holger     37: When you reached this point successfully you probably want to start some
                     38: test applications, download the linuxtv-dvb-apps-1.1.tar.gz package, unpack
                     39: it and compile it. This package contains some tools to test and debug the
                     40: driver:
                     41: 
1.9     ! holger     42: linuxtv-dvb-apps-1.1/apps/szap/ contains three simple applications called 
        !            43: szap, czap and tzap for zapping with DVB-S, DVB-C or DVB-T cards.
        !            44: Read linuxtv-dvb-apps-1.1/apps/szap/ README for usage instructions.
1.8       holger     45: 
                     46: Note 1: tuning succeeded if you see the FE_HAS_LOCK flag and "status 1f"; a
                     47: good signal has a low bit error rate (ber) and zero uncorrectable packets (unc).
                     48: 
                     49: Note 2: you must keep ?zap running, or the frontend will go to sleep (unless
                     50: you load dvb-core.o with dvb_shutdown_timeout=0)
                     51: 
                     52: If your card has a hardware MPEG decoder you can watch TV with xawtv (together
                     53: with e.g. szap for DVB tuning); Note: xawtv cannot control the DVB tuner, you
                     54: must use ?zap
                     55: 
                     56: For cards without hardware MPEG decoder you need a software MPEG decoder, 
                     57: e.g. mplayer or xine (you need *very* recent versions which understand MPEG2 
                     58: transport streams; xine v0.9.21 and mplayer dev-CVS-030723-16:39-3.3.1 seem to 
                     59: work); Note: You must run ?zap with the -r flag to enable stream output to the 
                     60: dvr device, and keep it running while watching tv.  
                     61: 
                     62: Examples: 
                     63:        mplayer - < /dev/dvb/adapter0/dvr0 
                     64:        xine stdin://mpeg2 < /dev/dvb/adapter0/dvr0
                     65:        
                     66: Note: Newest mplayer and xine versions are reported to have builtin DVB support
1.9     ! holger     67: (see ./linux/Documentation/dvb/faq.txt for more info).
1.8       holger     68: 
                     69: For 'real' everyday use you probably don't want to use these test applications 
1.9     ! holger     70: but install a program like VDR or MythTV.
        !            71: (Read ./linux/Documentation/dvb/faq.txt for some links)
1.8       holger     72: 
                     73: --------------------------------------------------------------------------------
                     74: 
                     75: The build system has been tested down to 2.4.20, if you run an older kernel
                     76: either update your kernel or just try - maybe you need to add some tweaks in
                     77: the dvb_compat.[hc] files. Please report your modifications on the linux-dvb 
                     78: mailing list.
                     79: 
                     80: If you want to build a not-standalone driver but want to patch your 2.6 kernel
                     81: source tree with this driver please read README-2.6.
                     82: 
                     83: More documentation is located in ./linux/Documentation/dvb/.
                     84: 
                     85: good luck,
                     86: 
                     87: Holger
1.7       hunold     88: 

LinuxTV legacy CVS <linuxtv.org/cvs>