Annotation of dvb-kernel/README, revision 1.23

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

LinuxTV legacy CVS <linuxtv.org/cvs>