Annotation of dvb-kernel/README, revision 1.18

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

LinuxTV legacy CVS <linuxtv.org/cvs>