Annotation of dvb-kernel/README, revision 1.19

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

LinuxTV legacy CVS <linuxtv.org/cvs>