Annotation of dvb-kernel/README, revision 1.17

1.17    ! js          1: linuxtv-dvb-1.1.0
        !             2: =================
        !             3: 
        !             4: Digital Video Broadcast drivers for Linux 2.4.19+ and Linux 2.6.x.
        !             5: 
        !             6: Note: Unlike in previous releases, the test/utility programs have
        !             7: been unbundled and are released seperately as linuxtv-dvb-apps-1.1.0.
        !             8: 
        !             9: 
        !            10: Linux 2.6.x:
        !            11:   The DVB drivers are already included in Linux 2.6.x, so you usually
        !            12:   don't need this package. What you will need, hwoever, is firmware.
        !            13:   see below.
        !            14: 
        !            15: Linux 2.4.19+:
        !            16:   Due to changes in the video2linux layer we don't support kernels
        !            17:   older than 2.4.19. If you need to use an older kernel you must
        !            18:   apply video4linux patches to the kernel first.
        !            19: 
        !            20: 
        !            21: Quick start:
        !            22: ------------
        !            23: 
        !            24: 1. Get firmware:
        !            25:   Some DVB cards need firmware to operate. Due to licensing problems
        !            26:   we won't distribute the firmware binaries with the driver source,
        !            27:   you must get them seperately. See below for details about where
        !            28:   to get and where to put.
        !            29:   For Linux 2.6.x and 2.4.24+ also see linux/Documentation/dvb/firmware.txt.
        !            30: 
        !            31: 2. cd build-2.4 or build-2.6
        !            32: 
        !            33: 3. make
        !            34: 
        !            35: 4. ./insmod.sh load
        !            36: 
        !            37: 
        !            38: Detailed instructions for building:
        !            39: -----------------------------------
1.1       hunold     40: 
1.10      holger     41: If you encounter any problems while executing the follwing steps please read
                     42: the TROUBLESHOOTING file.
1.8       holger     43: 
1.10      holger     44: Simply type 'make' to build the driver. The compiled modules will be located
1.11      holger     45: in directory ./build-2.4/ or ./build-2.6/, depening on the kernel version you
1.8       holger     46: are running. There you will also find scripts to load and unload the modules.
                     47: 
1.15      hunold     48: For some cards or frontends you need to download additional firmware
                     49: binaries:
                     50: 
                     51: - dvb-ttpci: http://www.linuxtv.org/download/dvb/
                     52:   => wget http://www.linuxtv.org/download/dvb/dvb-ttpci-01.fw
                     53:   Place the "dvb-ttpci-01.fw" file in the build-2.4 and/or build-2.6
                     54:   directory. The firmware will be compiled into the driver at it used to
                     55:   be.
                     56: 
                     57: - alps_tdlb7: 
                     58:   This driver needs a copy of the firmware file 'Sc_main.mc' from the
                     59:   Haupauge windows driver in the '/usr/lib/hotplug/firmware' directory.
                     60:   Alternatively, you can also pass the complete filename with the module
                     61:   parameter 'firmware_file'.
                     62: 
                     63: - tda1004x:
                     64:   This driver needs a copy of the DLL "ttlcdacc.dll" from the Haupauge or
                     65:   Technotrend windows driver saved as
                     66:   '/usr/lib/hotplug/firmware/tda1004x.mc'. You can also pass the complete
                     67:   file name with the module parameter 'tda1004x_firmware'.
1.16      hunold     68:   Currently the DLL from v2.15a of the technotrend driver is supported.
                     69:   Other versions can be added reasonably painlessly.
1.15      hunold     70:   Windows driver URL: http://www.technotrend.de/
                     71: 
                     72: - ttusb-dec:
                     73:   see "ttusb-dec.txt" in linux/Documentation for details
                     74: 
                     75: If something is missing, you get notified in the build process or when
                     76: loading the modules.
1.8       holger     77: 
1.16      hunold     78: Just in case you are wondering: the "alps_bsrv2" driver is gone, please use
                     79: the new "ves1x93" driver instead.
                     80: 
1.10      holger     81: In ./build-2.4/ or ./build-2.6/ you find the insmod script.
                     82: 
1.9       holger     83: Use './insmod.sh load' to load the driver modules, './insmod.sh unload' to 
                     84: remove them. './insmod debug' loads the drivers with debugging enabled. 
1.13      holger     85: These scripts load all drivers for all cards but the ones based on the bt8xx.
                     86: For bt8xx based cards please use the insmod-bt8xx.sh script instead.
1.10      holger     87: 
1.12      holger     88: Now check the klog and syslog (in doubt type 'dmesg') for error messages.
1.9       holger     89: 
1.8       holger     90: When you reached this point successfully you probably want to start some
                     91: test applications, download the linuxtv-dvb-apps-1.1.tar.gz package, unpack
                     92: it and compile it. This package contains some tools to test and debug the
                     93: driver:
                     94: 
1.9       holger     95: linuxtv-dvb-apps-1.1/apps/szap/ contains three simple applications called 
                     96: szap, czap and tzap for zapping with DVB-S, DVB-C or DVB-T cards.
                     97: Read linuxtv-dvb-apps-1.1/apps/szap/ README for usage instructions.
1.8       holger     98: 
                     99: Note 1: tuning succeeded if you see the FE_HAS_LOCK flag and "status 1f"; a
                    100: good signal has a low bit error rate (ber) and zero uncorrectable packets (unc).
                    101: 
                    102: Note 2: you must keep ?zap running, or the frontend will go to sleep (unless
                    103: you load dvb-core.o with dvb_shutdown_timeout=0)
                    104: 
                    105: If your card has a hardware MPEG decoder you can watch TV with xawtv (together
                    106: with e.g. szap for DVB tuning); Note: xawtv cannot control the DVB tuner, you
                    107: must use ?zap
                    108: 
                    109: For cards without hardware MPEG decoder you need a software MPEG decoder, 
                    110: e.g. mplayer or xine (you need *very* recent versions which understand MPEG2 
                    111: transport streams; xine v0.9.21 and mplayer dev-CVS-030723-16:39-3.3.1 seem to 
                    112: work); Note: You must run ?zap with the -r flag to enable stream output to the 
                    113: dvr device, and keep it running while watching tv.  
                    114: 
                    115: Examples: 
                    116:        mplayer - < /dev/dvb/adapter0/dvr0 
                    117:        xine stdin://mpeg2 < /dev/dvb/adapter0/dvr0
                    118:        
                    119: Note: Newest mplayer and xine versions are reported to have builtin DVB support
1.9       holger    120: (see ./linux/Documentation/dvb/faq.txt for more info).
1.8       holger    121: 
                    122: For 'real' everyday use you probably don't want to use these test applications 
1.9       holger    123: but install a program like VDR or MythTV.
                    124: (Read ./linux/Documentation/dvb/faq.txt for some links)
1.8       holger    125: 
1.10      holger    126: When everything is working you probably want to install the driver on your 
                    127: system by typing 'make install'. If you want to load the modules automatically
                    128: when an application tries to open the device you need to add lines like these 
                    129: to your modules.conf:
                    130: 
                    131:        probeall /dev/dvb dvb-ttpci
                    132:        alias /dev/dvb/* /dev/dvb
                    133:        below dvb-ttpci alps_bsrv2 alps_tdmb7 alps_tdlb7
                    134:        add below dvb-ttpci grundig_29504-401 grundig_29504-491
                    135:        add below dvb-ttpci stv0299 ves1820
                    136: 
                    137: Note: this example is for people with Technotrend-based PCI cards, they must 
                    138: load the dvb-ttpci driver and a matching frontend drivers that are potentially
                    139: used on these cards. In order to find out which ones are required for your
                    140: setup check the lsmod output after loading the driver like described above.
                    141: Those DVB modules that have a usecount greater zero are required in your 
                    142: setup - edit the modules.conf file appropriatly]
                    143: 
                    144: Debian users don't edit modules.conf manually but add the lines above to a new
                    145: file in /etc/modutils/ (e.g. /etc/modutils/dvb) and call 'update-modules' then.
                    146: 
1.8       holger    147: --------------------------------------------------------------------------------
                    148: 
                    149: The build system has been tested down to 2.4.20, if you run an older kernel
                    150: either update your kernel or just try - maybe you need to add some tweaks in
                    151: the dvb_compat.[hc] files. Please report your modifications on the linux-dvb 
                    152: mailing list.
                    153: 
                    154: If you want to build a not-standalone driver but want to patch your 2.6 kernel
                    155: source tree with this driver please read README-2.6.
                    156: 
                    157: More documentation is located in ./linux/Documentation/dvb/.
                    158: 
                    159: good luck,
                    160: 
                    161: Holger

LinuxTV legacy CVS <linuxtv.org/cvs>