rtc-fm3130: add missing braces
[linux/fpc-iii.git] / Documentation / dvb / get_dvb_firmware
blob3d1b0ab70c8ef3ed498eb00da7c68b5371d55ce6
1 #!/usr/bin/perl
2 # DVB firmware extractor
4 # (c) 2004 Andrew de Quincey
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 use File::Temp qw/ tempdir /;
22 use IO::Handle;
24 @components = ( "sp8870", "sp887x", "tda10045", "tda10046",
25 "tda10046lifeview", "av7110", "dec2000t", "dec2540t",
26 "dec3000s", "vp7041", "dibusb", "nxt2002", "nxt2004",
27 "or51211", "or51132_qam", "or51132_vsb", "bluebird",
28 "opera1", "cx231xx", "cx18", "cx23885", "pvrusb2", "mpc718" );
30 # Check args
31 syntax() if (scalar(@ARGV) != 1);
32 $cid = $ARGV[0];
34 # Do it!
35 for ($i=0; $i < scalar(@components); $i++) {
36 if ($cid eq $components[$i]) {
37 $outfile = eval($cid);
38 die $@ if $@;
39 print STDERR <<EOF;
40 Firmware(s) $outfile extracted successfully.
41 Now copy it(they) to either /usr/lib/hotplug/firmware or /lib/firmware
42 (depending on configuration of firmware hotplug).
43 EOF
44 exit(0);
48 # If we get here, it wasn't found
49 print STDERR "Unknown component \"$cid\"\n";
50 syntax();
55 # ---------------------------------------------------------------
56 # Firmware-specific extraction subroutines
58 sub sp8870 {
59 my $sourcefile = "tt_Premium_217g.zip";
60 my $url = "http://www.softwarepatch.pl/9999ccd06a4813cb827dbb0005071c71/$sourcefile";
61 my $hash = "53970ec17a538945a6d8cb608a7b3899";
62 my $outfile = "dvb-fe-sp8870.fw";
63 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
65 checkstandard();
67 wgetfile($sourcefile, $url);
68 unzip($sourcefile, $tmpdir);
69 verify("$tmpdir/software/OEM/HE/App/boot/SC_MAIN.MC", $hash);
70 copy("$tmpdir/software/OEM/HE/App/boot/SC_MAIN.MC", $outfile);
72 $outfile;
75 sub sp887x {
76 my $sourcefile = "Dvbt1.3.57.6.zip";
77 my $url = "http://www.avermedia.com/software/$sourcefile";
78 my $cabfile = "DVBT Net Ver1.3.57.6/disk1/data1.cab";
79 my $hash = "237938d53a7f834c05c42b894ca68ac3";
80 my $outfile = "dvb-fe-sp887x.fw";
81 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
83 checkstandard();
84 checkunshield();
86 wgetfile($sourcefile, $url);
87 unzip($sourcefile, $tmpdir);
88 unshield("$tmpdir/$cabfile", $tmpdir);
89 verify("$tmpdir/ZEnglish/sc_main.mc", $hash);
90 copy("$tmpdir/ZEnglish/sc_main.mc", $outfile);
92 $outfile;
95 sub tda10045 {
96 my $sourcefile = "tt_budget_217g.zip";
97 my $url = "http://www.technotrend.de/new/217g/$sourcefile";
98 my $hash = "2105fd5bf37842fbcdfa4bfd58f3594a";
99 my $outfile = "dvb-fe-tda10045.fw";
100 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
102 checkstandard();
104 wgetfile($sourcefile, $url);
105 unzip($sourcefile, $tmpdir);
106 extract("$tmpdir/software/OEM/PCI/App/ttlcdacc.dll", 0x37ef9, 30555, "$tmpdir/fwtmp");
107 verify("$tmpdir/fwtmp", $hash);
108 copy("$tmpdir/fwtmp", $outfile);
110 $outfile;
113 sub tda10046 {
114 my $sourcefile = "TT_PCI_2.19h_28_11_2006.zip";
115 my $url = "http://www.tt-download.com/download/updates/219/$sourcefile";
116 my $hash = "6a7e1e2f2644b162ff0502367553c72d";
117 my $outfile = "dvb-fe-tda10046.fw";
118 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
120 checkstandard();
122 wgetfile($sourcefile, $url);
123 unzip($sourcefile, $tmpdir);
124 extract("$tmpdir/TT_PCI_2.19h_28_11_2006/software/OEM/PCI/App/ttlcdacc.dll", 0x65389, 24478, "$tmpdir/fwtmp");
125 verify("$tmpdir/fwtmp", $hash);
126 copy("$tmpdir/fwtmp", $outfile);
128 $outfile;
131 sub tda10046lifeview {
132 my $sourcefile = "7%5Cdrv_2.11.02.zip";
133 my $url = "http://www.lifeview.hk/dbimages/document/$sourcefile";
134 my $hash = "1ea24dee4eea8fe971686981f34fd2e0";
135 my $outfile = "dvb-fe-tda10046.fw";
136 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
138 checkstandard();
140 wgetfile($sourcefile, $url);
141 unzip($sourcefile, $tmpdir);
142 extract("$tmpdir/LVHybrid.sys", 0x8b088, 24602, "$tmpdir/fwtmp");
143 verify("$tmpdir/fwtmp", $hash);
144 copy("$tmpdir/fwtmp", $outfile);
146 $outfile;
149 sub av7110 {
150 my $sourcefile = "dvb-ttpci-01.fw-261d";
151 my $url = "http://www.linuxtv.org/downloads/firmware/$sourcefile";
152 my $hash = "603431b6259715a8e88f376a53b64e2f";
153 my $outfile = "dvb-ttpci-01.fw";
155 checkstandard();
157 wgetfile($sourcefile, $url);
158 verify($sourcefile, $hash);
159 copy($sourcefile, $outfile);
161 $outfile;
164 sub dec2000t {
165 my $sourcefile = "dec217g.exe";
166 my $url = "http://hauppauge.lightpath.net/de/$sourcefile";
167 my $hash = "bd86f458cee4a8f0a8ce2d20c66215a9";
168 my $outfile = "dvb-ttusb-dec-2000t.fw";
169 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
171 checkstandard();
173 wgetfile($sourcefile, $url);
174 unzip($sourcefile, $tmpdir);
175 verify("$tmpdir/software/OEM/STB/App/Boot/STB_PC_T.bin", $hash);
176 copy("$tmpdir/software/OEM/STB/App/Boot/STB_PC_T.bin", $outfile);
178 $outfile;
181 sub dec2540t {
182 my $sourcefile = "dec217g.exe";
183 my $url = "http://hauppauge.lightpath.net/de/$sourcefile";
184 my $hash = "53e58f4f5b5c2930beee74a7681fed92";
185 my $outfile = "dvb-ttusb-dec-2540t.fw";
186 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
188 checkstandard();
190 wgetfile($sourcefile, $url);
191 unzip($sourcefile, $tmpdir);
192 verify("$tmpdir/software/OEM/STB/App/Boot/STB_PC_X.bin", $hash);
193 copy("$tmpdir/software/OEM/STB/App/Boot/STB_PC_X.bin", $outfile);
195 $outfile;
198 sub dec3000s {
199 my $sourcefile = "dec217g.exe";
200 my $url = "http://hauppauge.lightpath.net/de/$sourcefile";
201 my $hash = "b013ececea83f4d6d8d2a29ac7c1b448";
202 my $outfile = "dvb-ttusb-dec-3000s.fw";
203 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
205 checkstandard();
207 wgetfile($sourcefile, $url);
208 unzip($sourcefile, $tmpdir);
209 verify("$tmpdir/software/OEM/STB/App/Boot/STB_PC_S.bin", $hash);
210 copy("$tmpdir/software/OEM/STB/App/Boot/STB_PC_S.bin", $outfile);
212 $outfile;
214 sub opera1{
215 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 0);
217 checkstandard();
218 my $fwfile1="dvb-usb-opera1-fpga-01.fw";
219 my $fwfile2="dvb-usb-opera-01.fw";
220 extract("2830SCap2.sys", 0x62e8, 55024, "$tmpdir/opera1-fpga.fw");
221 extract("2830SLoad2.sys",0x3178,0x3685-0x3178,"$tmpdir/fw1part1");
222 extract("2830SLoad2.sys",0x0980,0x3150-0x0980,"$tmpdir/fw1part2");
223 delzero("$tmpdir/fw1part1","$tmpdir/fw1part1-1");
224 delzero("$tmpdir/fw1part2","$tmpdir/fw1part2-1");
225 verify("$tmpdir/fw1part1-1","5e0909858fdf0b5b09ad48b9fe622e70");
226 verify("$tmpdir/fw1part2-1","d6e146f321427e931df2c6fcadac37a1");
227 verify("$tmpdir/opera1-fpga.fw","0f8133f5e9051f5f3c1928f7e5a1b07d");
229 my $RES1="\x01\x92\x7f\x00\x01\x00";
230 my $RES0="\x01\x92\x7f\x00\x00\x00";
231 my $DAT1="\x01\x00\xe6\x00\x01\x00";
232 my $DAT0="\x01\x00\xe6\x00\x00\x00";
233 open FW,">$tmpdir/opera.fw";
234 print FW "$RES1";
235 print FW "$DAT1";
236 print FW "$RES1";
237 print FW "$DAT1";
238 appendfile(FW,"$tmpdir/fw1part1-1");
239 print FW "$RES0";
240 print FW "$DAT0";
241 print FW "$RES1";
242 print FW "$DAT1";
243 appendfile(FW,"$tmpdir/fw1part2-1");
244 print FW "$RES1";
245 print FW "$DAT1";
246 print FW "$RES0";
247 print FW "$DAT0";
248 copy ("$tmpdir/opera1-fpga.fw",$fwfile1);
249 copy ("$tmpdir/opera.fw",$fwfile2);
251 $fwfile1.",".$fwfile2;
254 sub vp7041 {
255 my $sourcefile = "2.422.zip";
256 my $url = "http://www.twinhan.com/files/driver/USB-Ter/$sourcefile";
257 my $hash = "e88c9372d1f66609a3e7b072c53fbcfe";
258 my $outfile = "dvb-vp7041-2.422.fw";
259 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
261 checkstandard();
263 wgetfile($sourcefile, $url);
264 unzip($sourcefile, $tmpdir);
265 extract("$tmpdir/VisionDTV/Drivers/Win2K&XP/UDTTload.sys", 12503, 3036, "$tmpdir/fwtmp1");
266 extract("$tmpdir/VisionDTV/Drivers/Win2K&XP/UDTTload.sys", 2207, 10274, "$tmpdir/fwtmp2");
268 my $CMD = "\000\001\000\222\177\000";
269 my $PAD = "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000";
270 my ($FW);
271 open $FW, ">$tmpdir/fwtmp3";
272 print $FW "$CMD\001$PAD";
273 print $FW "$CMD\001$PAD";
274 appendfile($FW, "$tmpdir/fwtmp1");
275 print $FW "$CMD\000$PAD";
276 print $FW "$CMD\001$PAD";
277 appendfile($FW, "$tmpdir/fwtmp2");
278 print $FW "$CMD\001$PAD";
279 print $FW "$CMD\000$PAD";
280 close($FW);
282 verify("$tmpdir/fwtmp3", $hash);
283 copy("$tmpdir/fwtmp3", $outfile);
285 $outfile;
288 sub dibusb {
289 my $url = "http://www.linuxtv.org/downloads/firmware/dvb-usb-dibusb-5.0.0.11.fw";
290 my $outfile = "dvb-dibusb-5.0.0.11.fw";
291 my $hash = "fa490295a527360ca16dcdf3224ca243";
293 checkstandard();
295 wgetfile($outfile, $url);
296 verify($outfile,$hash);
298 $outfile;
301 sub nxt2002 {
302 my $sourcefile = "Technisat_DVB-PC_4_4_COMPACT.zip";
303 my $url = "http://www.bbti.us/download/windows/$sourcefile";
304 my $hash = "476befae8c7c1bb9648954060b1eec1f";
305 my $outfile = "dvb-fe-nxt2002.fw";
306 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
308 checkstandard();
310 wgetfile($sourcefile, $url);
311 unzip($sourcefile, $tmpdir);
312 verify("$tmpdir/SkyNET.sys", $hash);
313 extract("$tmpdir/SkyNET.sys", 331624, 5908, $outfile);
315 $outfile;
318 sub nxt2004 {
319 my $sourcefile = "AVerTVHD_MCE_A180_Drv_v1.2.2.16.zip";
320 my $url = "http://www.avermedia-usa.com/support/Drivers/$sourcefile";
321 my $hash = "111cb885b1e009188346d72acfed024c";
322 my $outfile = "dvb-fe-nxt2004.fw";
323 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
325 checkstandard();
327 wgetfile($sourcefile, $url);
328 unzip($sourcefile, $tmpdir);
329 verify("$tmpdir/3xHybrid.sys", $hash);
330 extract("$tmpdir/3xHybrid.sys", 465304, 9584, $outfile);
332 $outfile;
335 sub or51211 {
336 my $fwfile = "dvb-fe-or51211.fw";
337 my $url = "http://linuxtv.org/downloads/firmware/$fwfile";
338 my $hash = "d830949c771a289505bf9eafc225d491";
340 checkstandard();
342 wgetfile($fwfile, $url);
343 verify($fwfile, $hash);
345 $fwfile;
348 sub cx231xx {
349 my $fwfile = "v4l-cx231xx-avcore-01.fw";
350 my $url = "http://linuxtv.org/downloads/firmware/$fwfile";
351 my $hash = "7d3bb956dc9df0eafded2b56ba57cc42";
353 checkstandard();
355 wgetfile($fwfile, $url);
356 verify($fwfile, $hash);
358 $fwfile;
361 sub cx18 {
362 my $url = "http://linuxtv.org/downloads/firmware/";
364 my %files = (
365 'v4l-cx23418-apu.fw' => '588f081b562f5c653a3db1ad8f65939a',
366 'v4l-cx23418-cpu.fw' => 'b6c7ed64bc44b1a6e0840adaeac39d79',
367 'v4l-cx23418-dig.fw' => '95bc688d3e7599fd5800161e9971cc55',
370 checkstandard();
372 my $allfiles;
373 foreach my $fwfile (keys %files) {
374 wgetfile($fwfile, "$url/$fwfile");
375 verify($fwfile, $files{$fwfile});
376 $allfiles .= " $fwfile";
379 $allfiles =~ s/^\s//;
381 $allfiles;
384 sub mpc718 {
385 my $archive = 'Yuan MPC718 TV Tuner Card 2.13.10.1016.zip';
386 my $url = "ftp://ftp.work.acer-euro.com/desktop/aspire_idea510/vista/Drivers/$archive";
387 my $fwfile = "dvb-cx18-mpc718-mt352.fw";
388 my $tmpdir = tempdir(DIR => "/tmp", CLEANUP => 1);
390 checkstandard();
391 wgetfile($archive, $url);
392 unzip($archive, $tmpdir);
394 my $sourcefile = "$tmpdir/Yuan MPC718 TV Tuner Card 2.13.10.1016/mpc718_32bit/yuanrap.sys";
395 my $found = 0;
397 open IN, '<', $sourcefile or die "Couldn't open $sourcefile to extract $fwfile data\n";
398 binmode IN;
399 open OUT, '>', $fwfile;
400 binmode OUT;
402 # Block scope because we change the line terminator variable $/
403 my $prevlen = 0;
404 my $currlen;
406 # Buried in the data segment are 3 runs of almost identical
407 # register-value pairs that end in 0x5d 0x01 which is a "TUNER GO"
408 # command for the MT352.
409 # Pull out the middle run (because it's easy) of register-value
410 # pairs to make the "firmware" file.
412 local $/ = "\x5d\x01"; # MT352 "TUNER GO"
414 while (<IN>) {
415 $currlen = length($_);
416 if ($prevlen == $currlen && $currlen <= 64) {
417 chop; chop; # Get rid of "TUNER GO"
418 s/^\0\0//; # get rid of leading 00 00 if it's there
419 printf OUT "$_";
420 $found = 1;
421 last;
423 $prevlen = $currlen;
426 close OUT;
427 close IN;
428 if (!$found) {
429 unlink $fwfile;
430 die "Couldn't find valid register-value sequence in $sourcefile for $fwfile\n";
432 $fwfile;
435 sub cx23885 {
436 my $url = "http://linuxtv.org/downloads/firmware/";
438 my %files = (
439 'v4l-cx23885-avcore-01.fw' => 'a9f8f5d901a7fb42f552e1ee6384f3bb',
440 'v4l-cx23885-enc.fw' => 'a9f8f5d901a7fb42f552e1ee6384f3bb',
443 checkstandard();
445 my $allfiles;
446 foreach my $fwfile (keys %files) {
447 wgetfile($fwfile, "$url/$fwfile");
448 verify($fwfile, $files{$fwfile});
449 $allfiles .= " $fwfile";
452 $allfiles =~ s/^\s//;
454 $allfiles;
457 sub pvrusb2 {
458 my $url = "http://linuxtv.org/downloads/firmware/";
460 my %files = (
461 'v4l-cx25840.fw' => 'dadb79e9904fc8af96e8111d9cb59320',
464 checkstandard();
466 my $allfiles;
467 foreach my $fwfile (keys %files) {
468 wgetfile($fwfile, "$url/$fwfile");
469 verify($fwfile, $files{$fwfile});
470 $allfiles .= " $fwfile";
473 $allfiles =~ s/^\s//;
475 $allfiles;
478 sub or51132_qam {
479 my $fwfile = "dvb-fe-or51132-qam.fw";
480 my $url = "http://linuxtv.org/downloads/firmware/$fwfile";
481 my $hash = "7702e8938612de46ccadfe9b413cb3b5";
483 checkstandard();
485 wgetfile($fwfile, $url);
486 verify($fwfile, $hash);
488 $fwfile;
491 sub or51132_vsb {
492 my $fwfile = "dvb-fe-or51132-vsb.fw";
493 my $url = "http://linuxtv.org/downloads/firmware/$fwfile";
494 my $hash = "c16208e02f36fc439a557ad4c613364a";
496 checkstandard();
498 wgetfile($fwfile, $url);
499 verify($fwfile, $hash);
501 $fwfile;
504 sub bluebird {
505 my $url = "http://www.linuxtv.org/download/dvb/firmware/dvb-usb-bluebird-01.fw";
506 my $outfile = "dvb-usb-bluebird-01.fw";
507 my $hash = "658397cb9eba9101af9031302671f49d";
509 checkstandard();
511 wgetfile($outfile, $url);
512 verify($outfile,$hash);
514 $outfile;
517 # ---------------------------------------------------------------
518 # Utilities
520 sub checkstandard {
521 if (system("which unzip > /dev/null 2>&1")) {
522 die "This firmware requires the unzip command - see ftp://ftp.info-zip.org/pub/infozip/UnZip.html\n";
524 if (system("which md5sum > /dev/null 2>&1")) {
525 die "This firmware requires the md5sum command - see http://www.gnu.org/software/coreutils/\n";
527 if (system("which wget > /dev/null 2>&1")) {
528 die "This firmware requires the wget command - see http://wget.sunsite.dk/\n";
532 sub checkunshield {
533 if (system("which unshield > /dev/null 2>&1")) {
534 die "This firmware requires the unshield command - see http://sourceforge.net/projects/synce/\n";
538 sub wgetfile {
539 my ($sourcefile, $url) = @_;
541 if (! -f $sourcefile) {
542 system("wget -O \"$sourcefile\" \"$url\"") and die "wget failed - unable to download firmware";
546 sub unzip {
547 my ($sourcefile, $todir) = @_;
549 $status = system("unzip -q -o -d \"$todir\" \"$sourcefile\" 2>/dev/null" );
550 if ((($status >> 8) > 2) || (($status & 0xff) != 0)) {
551 die ("unzip failed - unable to extract firmware");
555 sub unshield {
556 my ($sourcefile, $todir) = @_;
558 system("unshield x -d \"$todir\" \"$sourcefile\" > /dev/null" ) and die ("unshield failed - unable to extract firmware");
561 sub verify {
562 my ($filename, $hash) = @_;
563 my ($testhash);
565 open(CMD, "md5sum \"$filename\"|");
566 $testhash = <CMD>;
567 $testhash =~ /([a-zA-Z0-9]*)/;
568 $testhash = $1;
569 close CMD;
570 die "Hash of extracted file does not match!\n" if ($testhash ne $hash);
573 sub copy {
574 my ($from, $to) = @_;
576 system("cp -f \"$from\" \"$to\"") and die ("cp failed");
579 sub extract {
580 my ($infile, $offset, $length, $outfile) = @_;
581 my ($chunklength, $buf, $rcount);
583 open INFILE, "<$infile";
584 open OUTFILE, ">$outfile";
585 sysseek(INFILE, $offset, SEEK_SET);
586 while($length > 0) {
587 # Calc chunk size
588 $chunklength = 2048;
589 $chunklength = $length if ($chunklength > $length);
591 $rcount = sysread(INFILE, $buf, $chunklength);
592 die "Ran out of data\n" if ($rcount != $chunklength);
593 syswrite(OUTFILE, $buf);
594 $length -= $rcount;
596 close INFILE;
597 close OUTFILE;
600 sub appendfile {
601 my ($FH, $infile) = @_;
602 my ($buf);
604 open INFILE, "<$infile";
605 while(1) {
606 $rcount = sysread(INFILE, $buf, 2048);
607 last if ($rcount == 0);
608 print $FH $buf;
610 close(INFILE);
613 sub delzero{
614 my ($infile,$outfile) =@_;
616 open INFILE,"<$infile";
617 open OUTFILE,">$outfile";
618 while (1){
619 $rcount=sysread(INFILE,$buf,22);
620 $len=ord(substr($buf,0,1));
621 print OUTFILE substr($buf,0,1);
622 print OUTFILE substr($buf,2,$len+3);
623 last if ($rcount<1);
624 printf OUTFILE "%c",0;
625 #print $len." ".length($buf)."\n";
628 close(INFILE);
629 close(OUTFILE);
632 sub syntax() {
633 print STDERR "syntax: get_dvb_firmware <component>\n";
634 print STDERR "Supported components:\n";
635 for($i=0; $i < scalar(@components); $i++) {
636 print STDERR "\t" . $components[$i] . "\n";
638 exit(1);