1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 - 2007 by Björn Stenberg
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
28 #include "gigabeats.h"
30 #include "telechips.h"
32 #include "iaudio_bl_flash.h"
34 static int iaudio_encode(char *iname
, char *oname
, char *idstring
);
35 static int ipod_encode(char *iname
, char *oname
, int fw_ver
, bool fake_rsrc
);
36 static int ccpmp_encode(char *iname
, char *oname
);
40 ARCHOS_PLAYER
, /* and V1 recorder */
47 static unsigned int size_limit
[] =
49 0x32000, /* ARCHOS_PLAYER */
50 0x64000, /* ARCHOS_V2RECORDER */
51 0x64000, /* ARCHOS_FMRECORDER */
52 0x64000, /* ARCHOS_ONDIO_SP */
53 0x64000 /* ARCHOS_ONDIO_FM */
56 void short2le(unsigned short val
, unsigned char* addr
)
59 addr
[1] = (val
>> 8) & 0xff;
62 unsigned int le2int(unsigned char* buf
)
64 unsigned int res
= (buf
[3] << 24) | (buf
[2] << 16) | (buf
[1] << 8) | buf
[0];
69 void int2le(unsigned int val
, unsigned char* addr
)
72 addr
[1] = (val
>> 8) & 0xff;
73 addr
[2] = (val
>> 16) & 0xff;
74 addr
[3] = (val
>> 24) & 0xff;
77 void int2be(unsigned int val
, unsigned char* addr
)
79 addr
[0] = (val
>> 24) & 0xff;
80 addr
[1] = (val
>> 16) & 0xff;
81 addr
[2] = (val
>> 8) & 0xff;
85 void short2be(unsigned short val
, unsigned char* addr
)
87 addr
[0] = (val
>> 8) & 0xff;
93 printf("usage: scramble [options] <input file> <output file> [xor string]\n");
95 "\t-fm Archos FM recorder format\n"
96 "\t-v2 Archos V2 recorder format\n"
97 "\t-ofm Archos Ondio FM recorder format\n"
98 "\t-osp Archos Ondio SP format\n"
99 "\t-neo SSI Neo format\n"
100 "\t-mm=X Archos Multimedia format (X values: A=JBMM, B=AV1xx, C=AV3xx)\n"
101 "\t-iriver iRiver format\n"
102 "\t-iaudiox5 iAudio X5 format\n"
103 "\t-iaudiox5v iAudio X5V format\n"
104 "\t-iaudiom5 iAudio M5 format\n"
105 "\t-iaudiom3 iAudio M3 format\n");
106 printf("\t-ipod3g ipod firmware partition format (3rd Gen)\n"
107 "\t-ipod4g ipod firmware partition format (4th Gen, Mini, Nano, Photo/Color)\n"
108 "\t-ipod5g ipod firmware partition format (5th Gen - aka Video)\n"
109 "\t-creative=X Creative firmware structure format\n"
110 "\t (X values: zvm, zvm60, zenvision\n"
112 printf("\t-gigabeat Toshiba Gigabeat F/X format\n"
113 "\t-gigabeats Toshiba Gigabeat S format\n"
114 "\t-mi4v2 PortalPlayer .mi4 format (revision 010201)\n"
115 "\t-mi4v3 PortalPlayer .mi4 format (revision 010301)\n"
116 "\t-mi4r Sandisk Rhapsody .mi4 format\n"
117 "\t All mi4 options take two optional arguments:\n");
118 printf("\t -model=XXXX where XXXX is the model id string\n"
119 "\t -type=XXXX where XXXX is a string indicating the \n"
120 "\t type of binary, eg. RBOS, RBBL\n"
121 "\t-tcc=X Telechips generic firmware format (X values: sum, crc)\n"
122 "\t-add=X Rockbox generic \"add-up\" checksum format\n"
123 "\t (X values: h100, h120, h140, h300, ipco, nano, ipvd, mn2g\n"
124 "\t ip3g, ip4g, mini, iax5, iam5, iam3, h10, h10_5gb,\n"
125 "\t tpj2, c200, e200, giga, gigs, m100, m500, d2,\n");
126 printf("\t 9200, 1630, 6330, ldax, m200, c100, clip, e2v2,\n"
127 "\t m2v4, fuze, c2v2, clv2, y820, y920, y925, x747,\n"
128 "\t 747p, x777, nn2g, m244, cli+, fuz2, hd20, hd30)\n");
129 printf("\nNo option results in Archos standard player/recorder format.\n");
134 int main (int argc
, char** argv
)
136 unsigned long length
,i
,slen
=0;
137 unsigned char *inbuf
,*outbuf
;
138 unsigned short crc
=0;
139 unsigned long chksum
=0; /* 32 bit checksum */
140 unsigned char header
[24];
141 char *iname
= argv
[1];
142 char *oname
= argv
[2];
143 char *xorstring
=NULL
;
147 unsigned long modelnum
;
150 enum { none
, scramble
, xor, tcc_sum
, tcc_crc
, add
} method
= scramble
;
151 bool creative_enable_ciff
;
153 model_id
= ARCHOS_PLAYER
;
159 if(!strcmp(argv
[1], "-fm")) {
164 model_id
= ARCHOS_FMRECORDER
;
167 else if(!strcmp(argv
[1], "-v2")) {
172 model_id
= ARCHOS_V2RECORDER
;
175 else if(!strcmp(argv
[1], "-ofm")) {
180 model_id
= ARCHOS_ONDIO_FM
;
183 else if(!strcmp(argv
[1], "-osp")) {
188 model_id
= ARCHOS_ONDIO_SP
;
191 else if(!strcmp(argv
[1], "-neo")) {
197 else if(!strncmp(argv
[1], "-mm=", 4)) {
202 version
= argv
[1][4];
206 printf("Multimedia needs an xor string\n");
210 else if(!strncmp(argv
[1], "-tcc=", 4)) {
215 if(!strcmp(&argv
[1][5], "sum"))
217 else if(!strcmp(&argv
[1][5], "crc"))
220 fprintf(stderr
, "unsupported TCC method: %s\n", &argv
[1][5]);
224 else if(!strncmp(argv
[1], "-add=", 5)) {
229 if(!strcmp(&argv
[1][5], "h120"))
231 else if(!strcmp(&argv
[1][5], "h140"))
232 modelnum
= 0; /* the same as the h120 */
233 else if(!strcmp(&argv
[1][5], "h100"))
235 else if(!strcmp(&argv
[1][5], "h300"))
237 else if(!strcmp(&argv
[1][5], "ipco"))
239 else if(!strcmp(&argv
[1][5], "nano"))
241 else if(!strcmp(&argv
[1][5], "ipvd"))
243 else if(!strcmp(&argv
[1][5], "fp7x"))
245 else if(!strcmp(&argv
[1][5], "ip3g"))
247 else if(!strcmp(&argv
[1][5], "ip4g"))
249 else if(!strcmp(&argv
[1][5], "mini"))
251 else if(!strcmp(&argv
[1][5], "iax5"))
253 else if(!strcmp(&argv
[1][5], "mn2g"))
255 else if(!strcmp(&argv
[1][5], "h10"))
257 else if(!strcmp(&argv
[1][5], "h10_5gb"))
259 else if(!strcmp(&argv
[1][5], "tpj2"))
261 else if(!strcmp(&argv
[1][5], "e200"))
263 else if(!strcmp(&argv
[1][5], "iam5"))
265 else if(!strcmp(&argv
[1][5], "giga"))
267 else if(!strcmp(&argv
[1][5], "1g2g"))
269 else if(!strcmp(&argv
[1][5], "c200"))
271 else if(!strcmp(&argv
[1][5], "gigs"))
273 else if(!strcmp(&argv
[1][5], "m500"))
275 else if(!strcmp(&argv
[1][5], "m100"))
277 else if(!strcmp(&argv
[1][5], "d2"))
279 else if(!strcmp(&argv
[1][5], "iam3"))
281 else if (!strcmp(&argv
[1][5], "m200"))
283 else if(!strcmp(&argv
[1][5], "c100"))
285 else if(!strcmp(&argv
[1][5], "1630")) /* Philips HDD1630 */
287 else if (!strcmp(&argv
[1][5], "i7"))
289 else if (!strcmp(&argv
[1][5], "ldax"))
291 else if(!strcmp(&argv
[1][5], "9200")) /* Philips SA9200 */
293 else if (!strcmp(&argv
[1][5], "clip"))
295 else if (!strcmp(&argv
[1][5], "e2v2"))
297 else if (!strcmp(&argv
[1][5], "m2v4"))
299 else if (!strcmp(&argv
[1][5], "fuze"))
301 else if (!strcmp(&argv
[1][5], "c2v2"))
303 else if (!strcmp(&argv
[1][5], "x747"))
305 else if (!strcmp(&argv
[1][5], "747p"))
307 else if (!strcmp(&argv
[1][5], "y820")) /* Samsung YH-820 */
309 else if (!strcmp(&argv
[1][5], "y920")) /* Samsung YH-920 */
311 else if (!strcmp(&argv
[1][5], "y925")) /* Samsung YH-925 */
313 else if (!strcmp(&argv
[1][5], "clv2")) /* Sansa Clipv2 */
315 else if (!strcmp(&argv
[1][5], "x777"))
317 else if (!strcmp(&argv
[1][5], "nn2g")) /* iPod Nano 2nd Gen */
319 else if (!strcmp(&argv
[1][5], "x767"))
321 else if (!strcmp(&argv
[1][5], "6330")) /* Philips HDD6330 */
323 else if (!strcmp(&argv
[1][5], "cli+")) /* Sansa Clip+ */
325 else if (!strcmp(&argv
[1][5], "v500")) /* Packard Bell Vibe 500 */
327 else if (!strcmp(&argv
[1][5], "fuz2")) /* Sansa Fuze v2 */
329 else if (!strcmp(&argv
[1][5], "m244"))
331 else if (!strcmp(&argv
[1][5], "hd20")) /* MPIO HD200 */
333 else if (!strcmp(&argv
[1][5], "hd30")) /* MPIO HD300 */
336 fprintf(stderr
, "unsupported model: %s\n", &argv
[1][5]);
339 /* we store a 4-letter model name too, for humans */
340 strncpy(modelname
, &argv
[1][5],4);
341 modelname
[4] = '\0'; /* to be sure we are null terminated */
342 chksum
= modelnum
; /* start checksum calcs with this */
345 else if(!strcmp(argv
[1], "-iriver")) {
346 /* iRiver code dealt with in the iriver.c code */
349 return (iriver_encode(iname
, oname
, FALSE
) != 0) ? -1 : 0;
351 else if(!strcmp(argv
[1], "-gigabeat")) {
352 /* iRiver code dealt with in the iriver.c code */
355 gigabeat_code(iname
, oname
);
358 else if(!strcmp(argv
[1], "-gigabeats")) {
361 return gigabeat_s_code(iname
, oname
);
363 else if(!strcmp(argv
[1], "-iaudiox5")) {
366 return iaudio_encode(iname
, oname
, "COWON_X5_FW");
368 else if(!strcmp(argv
[1], "-iaudiox5v")) {
371 return iaudio_encode(iname
, oname
, "COWON_X5V_FW");
373 else if(!strcmp(argv
[1], "-iaudiom5")) {
376 return iaudio_encode(iname
, oname
, "COWON_M5_FW");
378 else if(!strcmp(argv
[1], "-iaudiom3")) {
381 return iaudio_encode(iname
, oname
, "COWON_M3_FW");
383 else if(!strcmp(argv
[1], "-ipod3g")) {
386 return ipod_encode(iname
, oname
, 2, false); /* Firmware image v2 */
388 else if(!strcmp(argv
[1], "-ipod4g")) {
391 return ipod_encode(iname
, oname
, 3, false); /* Firmware image v3 */
393 else if(!strcmp(argv
[1], "-ipod5g")) {
396 return ipod_encode(iname
, oname
, 3, true); /* Firmware image v3 */
398 else if(!strncmp(argv
[1], "-creative=", 10)) {
399 if(!strcmp(argv
[2], "-no-ciff"))
401 creative_enable_ciff
= false;
407 creative_enable_ciff
= true;
411 if(!strcmp(&argv
[1][10], "zvm"))
412 return zvm_encode(iname
, oname
, ZENVISIONM
, creative_enable_ciff
);
413 else if(!strcmp(&argv
[1][10], "zvm60"))
414 return zvm_encode(iname
, oname
, ZENVISIONM60
, creative_enable_ciff
);
415 else if(!strcmp(&argv
[1][10], "zenvision"))
416 return zvm_encode(iname
, oname
, ZENVISION
, creative_enable_ciff
);
417 else if(!strcmp(&argv
[1][10], "zenv"))
418 return zvm_encode(iname
, oname
, ZENV
, creative_enable_ciff
);
419 else if(!strcmp(&argv
[1][10], "zen"))
420 return zvm_encode(iname
, oname
, ZEN
, creative_enable_ciff
);
423 fprintf(stderr
, "unsupported Creative device: %s\n", &argv
[1][10]);
427 else if(!strcmp(argv
[1], "-ccpmp")) {
430 return ccpmp_encode(iname
, oname
);
432 else if(!strncmp(argv
[1], "-mi4", 4)) {
437 if(!strcmp(&argv
[1][4], "v2")) {
438 mi4magic
= MI4_MAGIC_DEFAULT
;
439 version
= 0x00010201;
441 else if(!strcmp(&argv
[1][4], "v3")) {
442 mi4magic
= MI4_MAGIC_DEFAULT
;
443 version
= 0x00010301;
445 else if(!strcmp(&argv
[1][4], "r")) {
446 mi4magic
= MI4_MAGIC_R
;
447 version
= 0x00010301;
450 printf( "Invalid mi4 version: %s\n", &argv
[1][4]);
457 if(!strncmp(argv
[2], "-model=", 7)) {
460 strncpy(model
, &argv
[2][7], 4);
462 if(!strncmp(argv
[3], "-type=", 6)) {
465 strncpy(type
, &argv
[3][6], 4);
469 return mi4_encode(iname
, oname
, version
, mi4magic
, model
, type
);
473 file
= fopen(iname
,"rb");
478 fseek(file
,0,SEEK_END
);
479 length
= ftell(file
);
480 length
= (length
+ 3) & ~3; /* Round up to nearest 4 byte boundary */
482 if ((method
== scramble
) &&
483 ((length
+ headerlen
) >= size_limit
[model_id
])) {
484 printf("error: firmware image is %ld bytes while max size is %u!\n",
486 size_limit
[model_id
]);
491 fseek(file
,0,SEEK_SET
);
492 inbuf
= malloc(length
);
494 outbuf
= malloc(length
*2);
495 else if(method
== add
)
496 outbuf
= malloc(length
+ 8);
498 outbuf
= malloc(length
);
499 if ( !inbuf
|| !outbuf
) {
500 printf("out of memory!\n");
504 /* zero-fill the last 4 bytes to make sure there's no rubbish there
505 when we write the size-aligned file later */
506 memset(outbuf
+length
-4, 0, 4);
510 i
=fread(inbuf
,1,length
,file
);
520 for (i
= 0; i
< length
; i
++) {
521 /* add 8 unsigned bits but keep a 32 bit sum */
527 for (i
= 0; i
< length
; i
++) {
528 unsigned long addr
= (i
>> 2) + ((i
% 4) * slen
);
529 unsigned char data
= inbuf
[i
];
530 data
= ~((data
<< 1) | ((data
>> 7) & 1)); /* poor man's ROL */
538 for (i
=0; i
<length
; i
++) {
540 outbuf
[slen
++] = 0xff; /* all data is uncompressed */
541 outbuf
[slen
++] = inbuf
[i
];
546 /* dummy case just to silence picky compilers */
550 if((method
== none
) || (method
== scramble
) || (method
== xor)) {
551 /* calculate checksum */
552 for (i
=0;i
<length
;i
++)
556 memset(header
, 0, sizeof header
);
561 int2be(chksum
, header
); /* checksum, big-endian */
562 memcpy(&header
[4], modelname
, 4); /* 4 bytes model name */
563 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
569 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
570 telechips_encode_sum(outbuf
, length
);
574 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
575 telechips_encode_crc(outbuf
, length
);
579 if (headerlen
== 6) {
580 int2be(length
, header
);
581 header
[4] = (crc
>> 8) & 0xff;
582 header
[5] = crc
& 0xff;
588 header
[3] = 0xff; /* ??? */
590 header
[6] = (crc
>> 8) & 0xff;
591 header
[7] = crc
& 0xff;
593 header
[11] = version
;
595 header
[15] = headerlen
; /* really? */
597 int2be(length
, &header
[20]);
603 int xorlen
= strlen(xorstring
);
606 for (i
=0; i
<slen
; i
++)
607 outbuf
[i
] ^= xorstring
[i
& (xorlen
-1)];
609 /* calculate checksum */
610 for (i
=0; i
<slen
; i
++)
613 header
[0] = header
[2] = 'Z';
614 header
[1] = header
[3] = version
;
615 int2le(length
, &header
[4]);
616 int2le(slen
, &header
[8]);
617 int2le(crc
, &header
[12]);
622 #define MY_FIRMWARE_TYPE "Rockbox"
623 #define MY_HEADER_VERSION 1
625 strncpy((char *)header
, MY_FIRMWARE_TYPE
,9);
626 header
[9]='\0'; /*shouldn't have to, but to be SURE */
627 header
[10]=MY_HEADER_VERSION
&0xFF;
628 header
[11]=(crc
>>8)&0xFF;
630 int2be(sizeof(header
), &header
[12]);
635 file
= fopen(oname
,"wb");
641 if ( !fwrite(header
,headerlen
,1,file
) ) {
646 if ( !fwrite(outbuf
,length
,1,file
) ) {
658 static int iaudio_encode(char *iname
, char *oname
, char *idstring
)
663 unsigned char *outbuf
;
665 unsigned char sum
= 0;
667 file
= fopen(iname
, "rb");
672 fseek(file
,0,SEEK_END
);
673 length
= ftell(file
);
675 fseek(file
,0,SEEK_SET
);
676 outbuf
= malloc(length
+0x1030);
679 printf("out of memory!\n");
683 len
= fread(outbuf
+0x1030, 1, length
, file
);
684 if(len
< (size_t) length
) {
689 memset(outbuf
, 0, 0x1030);
690 strcpy((char *)outbuf
, idstring
);
691 memcpy(outbuf
+0x20, iaudio_bl_flash
,
692 BMPWIDTH_iaudio_bl_flash
* (BMPHEIGHT_iaudio_bl_flash
/8) * 2);
693 short2be(BMPWIDTH_iaudio_bl_flash
, &outbuf
[0x10]);
694 short2be((BMPHEIGHT_iaudio_bl_flash
/8), &outbuf
[0x12]);
697 for(i
= 0; i
< length
;i
++)
698 sum
+= outbuf
[0x1030 + i
];
700 int2be(length
, &outbuf
[0x1024]);
701 outbuf
[0x102b] = sum
;
705 file
= fopen(oname
, "wb");
711 len
= fwrite(outbuf
, 1, length
+0x1030, file
);
712 if(len
< (size_t)length
) {
722 /* Create an ipod firmware partition image
724 fw_ver = 2 for 3rd Gen ipods, 3 for all later ipods including 5g.
726 This function doesn't yet handle the Broadcom resource image for the 5g,
727 so the resulting images won't be usable.
729 This has also only been tested on an ipod Photo
732 static int ipod_encode(char *iname
, char *oname
, int fw_ver
, bool fake_rsrc
)
734 static const char *apple_stop_sign
= "{{~~ /-----\\ "\
755 unsigned int sum
= 0;
756 unsigned int rsrcsum
= 0;
757 unsigned char *outbuf
;
761 file
= fopen(iname
, "rb");
766 fseek(file
,0,SEEK_END
);
767 length
= ftell(file
);
769 fseek(file
,0,SEEK_SET
);
771 bufsize
=(length
+0x4600);
773 bufsize
= (bufsize
+ 0x400) & ~0x200;
776 outbuf
= malloc(bufsize
);
779 printf("out of memory!\n");
783 len
= fread(outbuf
+0x4600, 1, length
, file
);
784 if(len
< (size_t)length
) {
790 /* Calculate checksum for later use in header */
791 for(i
= 0x4600; i
< 0x4600+length
;i
++)
794 /* Clear the header area to zero */
795 memset(outbuf
, 0, 0x4600);
797 /* APPLE STOP SIGN */
798 strcpy((char *)outbuf
, apple_stop_sign
);
801 memcpy(&outbuf
[0x100],"]ih[",4); /* Magic */
802 int2le(0x4000, &outbuf
[0x104]); /* Firmware offset relative to 0x200 */
803 short2le(0x10c, &outbuf
[0x108]); /* Location of extended header */
804 short2le(fw_ver
, &outbuf
[0x10a]);
806 /* Firmware Directory - "osos" entry */
807 memcpy(&outbuf
[0x4200],"!ATAsoso",8); /* dev and type */
808 int2le(0, &outbuf
[0x4208]); /* id */
809 int2le(0x4400, &outbuf
[0x420c]); /* devOffset */
810 int2le(length
, &outbuf
[0x4210]); /* Length of firmware */
811 int2le(0x10000000, &outbuf
[0x4214]); /* Addr */
812 int2le(0, &outbuf
[0x4218]); /* Entry Offset */
813 int2le(sum
, &outbuf
[0x421c]); /* Checksum */
814 int2le(0x00006012, &outbuf
[0x4220]); /* vers - 0x6012 is a guess */
815 int2le(0xffffffff, &outbuf
[0x4224]); /* LoadAddr - for flash images */
817 /* "rsrc" entry (if applicable) */
819 rsrcoffset
=(length
+0x4600+0x200) & ~0x200;
823 memcpy(&outbuf
[0x4228],"!ATAcrsr",8); /* dev and type */
824 int2le(0, &outbuf
[0x4230]); /* id */
825 int2le(rsrcoffset
, &outbuf
[0x4234]); /* devOffset */
826 int2le(rsrclength
, &outbuf
[0x4238]); /* Length of firmware */
827 int2le(0x10000000, &outbuf
[0x423c]); /* Addr */
828 int2le(0, &outbuf
[0x4240]); /* Entry Offset */
829 int2le(rsrcsum
, &outbuf
[0x4244]); /* Checksum */
830 int2le(0x0000b000, &outbuf
[0x4248]); /* vers */
831 int2le(0xffffffff, &outbuf
[0x424c]); /* LoadAddr - for flash images */
834 file
= fopen(oname
, "wb");
840 len
= fwrite(outbuf
, 1, length
+0x4600, file
);
841 if(len
< (size_t)length
) {
851 #define CCPMP_SIZE 0x500000
852 static int ccpmp_encode(char *iname
, char *oname
)
857 unsigned char *outbuf
;
859 file
= fopen(iname
, "rb");
864 fseek(file
,0,SEEK_END
);
865 length
= ftell(file
);
867 fseek(file
,0,SEEK_SET
);
869 outbuf
= malloc(CCPMP_SIZE
);
872 printf("out of memory!\n");
876 len
= fread(outbuf
, 1, length
, file
);
877 if(len
< (size_t)length
) {
883 /* Clear the tail area to 0xFF */
884 memset(&outbuf
[length
], 0xFF, CCPMP_SIZE
- length
);
887 int2le(length
, &outbuf
[0x4]);
889 file
= fopen(oname
, "wb");
895 len
= fwrite(outbuf
, 1, CCPMP_SIZE
, file
);
896 if(len
< (size_t)length
) {