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+)\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], "m244"))
328 fprintf(stderr
, "unsupported model: %s\n", &argv
[1][5]);
331 /* we store a 4-letter model name too, for humans */
332 strcpy(modelname
, &argv
[1][5]);
333 chksum
= modelnum
; /* start checksum calcs with this */
336 else if(!strcmp(argv
[1], "-iriver")) {
337 /* iRiver code dealt with in the iriver.c code */
340 return (iriver_encode(iname
, oname
, FALSE
) != 0) ? -1 : 0;
342 else if(!strcmp(argv
[1], "-gigabeat")) {
343 /* iRiver code dealt with in the iriver.c code */
346 gigabeat_code(iname
, oname
);
349 else if(!strcmp(argv
[1], "-gigabeats")) {
352 return gigabeat_s_code(iname
, oname
);
354 else if(!strcmp(argv
[1], "-iaudiox5")) {
357 return iaudio_encode(iname
, oname
, "COWON_X5_FW");
359 else if(!strcmp(argv
[1], "-iaudiox5v")) {
362 return iaudio_encode(iname
, oname
, "COWON_X5V_FW");
364 else if(!strcmp(argv
[1], "-iaudiom5")) {
367 return iaudio_encode(iname
, oname
, "COWON_M5_FW");
369 else if(!strcmp(argv
[1], "-iaudiom3")) {
372 return iaudio_encode(iname
, oname
, "COWON_M3_FW");
374 else if(!strcmp(argv
[1], "-ipod3g")) {
377 return ipod_encode(iname
, oname
, 2, false); /* Firmware image v2 */
379 else if(!strcmp(argv
[1], "-ipod4g")) {
382 return ipod_encode(iname
, oname
, 3, false); /* Firmware image v3 */
384 else if(!strcmp(argv
[1], "-ipod5g")) {
387 return ipod_encode(iname
, oname
, 3, true); /* Firmware image v3 */
389 else if(!strncmp(argv
[1], "-creative=", 10)) {
390 if(!strcmp(argv
[2], "-no-ciff"))
392 creative_enable_ciff
= false;
398 creative_enable_ciff
= true;
402 if(!strcmp(&argv
[1][10], "zvm"))
403 return zvm_encode(iname
, oname
, ZENVISIONM
, creative_enable_ciff
);
404 else if(!strcmp(&argv
[1][10], "zvm60"))
405 return zvm_encode(iname
, oname
, ZENVISIONM60
, creative_enable_ciff
);
406 else if(!strcmp(&argv
[1][10], "zenvision"))
407 return zvm_encode(iname
, oname
, ZENVISION
, creative_enable_ciff
);
408 else if(!strcmp(&argv
[1][10], "zenv"))
409 return zvm_encode(iname
, oname
, ZENV
, creative_enable_ciff
);
410 else if(!strcmp(&argv
[1][10], "zen"))
411 return zvm_encode(iname
, oname
, ZEN
, creative_enable_ciff
);
414 fprintf(stderr
, "unsupported Creative device: %s\n", &argv
[1][10]);
418 else if(!strcmp(argv
[1], "-ccpmp")) {
421 return ccpmp_encode(iname
, oname
);
423 else if(!strncmp(argv
[1], "-mi4", 4)) {
428 if(!strcmp(&argv
[1][4], "v2")) {
429 mi4magic
= MI4_MAGIC_DEFAULT
;
430 version
= 0x00010201;
432 else if(!strcmp(&argv
[1][4], "v3")) {
433 mi4magic
= MI4_MAGIC_DEFAULT
;
434 version
= 0x00010301;
436 else if(!strcmp(&argv
[1][4], "r")) {
437 mi4magic
= MI4_MAGIC_R
;
438 version
= 0x00010301;
441 printf( "Invalid mi4 version: %s\n", &argv
[1][4]);
448 if(!strncmp(argv
[2], "-model=", 7)) {
451 strncpy(model
, &argv
[2][7], 4);
453 if(!strncmp(argv
[3], "-type=", 6)) {
456 strncpy(type
, &argv
[3][6], 4);
460 return mi4_encode(iname
, oname
, version
, mi4magic
, model
, type
);
464 file
= fopen(iname
,"rb");
469 fseek(file
,0,SEEK_END
);
470 length
= ftell(file
);
471 length
= (length
+ 3) & ~3; /* Round up to nearest 4 byte boundary */
473 if ((method
== scramble
) &&
474 ((length
+ headerlen
) >= size_limit
[model_id
])) {
475 printf("error: firmware image is %ld bytes while max size is %u!\n",
477 size_limit
[model_id
]);
482 fseek(file
,0,SEEK_SET
);
483 inbuf
= malloc(length
);
485 outbuf
= malloc(length
*2);
486 else if(method
== add
)
487 outbuf
= malloc(length
+ 8);
489 outbuf
= malloc(length
);
490 if ( !inbuf
|| !outbuf
) {
491 printf("out of memory!\n");
495 /* zero-fill the last 4 bytes to make sure there's no rubbish there
496 when we write the size-aligned file later */
497 memset(outbuf
+length
-4, 0, 4);
501 i
=fread(inbuf
,1,length
,file
);
511 for (i
= 0; i
< length
; i
++) {
512 /* add 8 unsigned bits but keep a 32 bit sum */
518 for (i
= 0; i
< length
; i
++) {
519 unsigned long addr
= (i
>> 2) + ((i
% 4) * slen
);
520 unsigned char data
= inbuf
[i
];
521 data
= ~((data
<< 1) | ((data
>> 7) & 1)); /* poor man's ROL */
529 for (i
=0; i
<length
; i
++) {
531 outbuf
[slen
++] = 0xff; /* all data is uncompressed */
532 outbuf
[slen
++] = inbuf
[i
];
537 /* dummy case just to silence picky compilers */
541 if((method
== none
) || (method
== scramble
) || (method
== xor)) {
542 /* calculate checksum */
543 for (i
=0;i
<length
;i
++)
547 memset(header
, 0, sizeof header
);
552 int2be(chksum
, header
); /* checksum, big-endian */
553 memcpy(&header
[4], modelname
, 4); /* 4 bytes model name */
554 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
560 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
561 telechips_encode_sum(outbuf
, length
);
565 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
566 telechips_encode_crc(outbuf
, length
);
570 if (headerlen
== 6) {
571 int2be(length
, header
);
572 header
[4] = (crc
>> 8) & 0xff;
573 header
[5] = crc
& 0xff;
579 header
[3] = 0xff; /* ??? */
581 header
[6] = (crc
>> 8) & 0xff;
582 header
[7] = crc
& 0xff;
584 header
[11] = version
;
586 header
[15] = headerlen
; /* really? */
588 int2be(length
, &header
[20]);
594 int xorlen
= strlen(xorstring
);
597 for (i
=0; i
<slen
; i
++)
598 outbuf
[i
] ^= xorstring
[i
& (xorlen
-1)];
600 /* calculate checksum */
601 for (i
=0; i
<slen
; i
++)
604 header
[0] = header
[2] = 'Z';
605 header
[1] = header
[3] = version
;
606 int2le(length
, &header
[4]);
607 int2le(slen
, &header
[8]);
608 int2le(crc
, &header
[12]);
613 #define MY_FIRMWARE_TYPE "Rockbox"
614 #define MY_HEADER_VERSION 1
616 strncpy((char *)header
, MY_FIRMWARE_TYPE
,9);
617 header
[9]='\0'; /*shouldn't have to, but to be SURE */
618 header
[10]=MY_HEADER_VERSION
&0xFF;
619 header
[11]=(crc
>>8)&0xFF;
621 int2be(sizeof(header
), &header
[12]);
626 file
= fopen(oname
,"wb");
632 if ( !fwrite(header
,headerlen
,1,file
) ) {
637 if ( !fwrite(outbuf
,length
,1,file
) ) {
649 static int iaudio_encode(char *iname
, char *oname
, char *idstring
)
654 unsigned char *outbuf
;
656 unsigned char sum
= 0;
658 file
= fopen(iname
, "rb");
663 fseek(file
,0,SEEK_END
);
664 length
= ftell(file
);
666 fseek(file
,0,SEEK_SET
);
667 outbuf
= malloc(length
+0x1030);
670 printf("out of memory!\n");
674 len
= fread(outbuf
+0x1030, 1, length
, file
);
675 if(len
< (size_t) length
) {
680 memset(outbuf
, 0, 0x1030);
681 strcpy((char *)outbuf
, idstring
);
682 memcpy(outbuf
+0x20, iaudio_bl_flash
,
683 BMPWIDTH_iaudio_bl_flash
* (BMPHEIGHT_iaudio_bl_flash
/8) * 2);
684 short2be(BMPWIDTH_iaudio_bl_flash
, &outbuf
[0x10]);
685 short2be((BMPHEIGHT_iaudio_bl_flash
/8), &outbuf
[0x12]);
688 for(i
= 0; i
< length
;i
++)
689 sum
+= outbuf
[0x1030 + i
];
691 int2be(length
, &outbuf
[0x1024]);
692 outbuf
[0x102b] = sum
;
696 file
= fopen(oname
, "wb");
702 len
= fwrite(outbuf
, 1, length
+0x1030, file
);
703 if(len
< (size_t)length
) {
713 /* Create an ipod firmware partition image
715 fw_ver = 2 for 3rd Gen ipods, 3 for all later ipods including 5g.
717 This function doesn't yet handle the Broadcom resource image for the 5g,
718 so the resulting images won't be usable.
720 This has also only been tested on an ipod Photo
723 static int ipod_encode(char *iname
, char *oname
, int fw_ver
, bool fake_rsrc
)
725 static const char *apple_stop_sign
= "{{~~ /-----\\ "\
746 unsigned int sum
= 0;
747 unsigned int rsrcsum
= 0;
748 unsigned char *outbuf
;
752 file
= fopen(iname
, "rb");
757 fseek(file
,0,SEEK_END
);
758 length
= ftell(file
);
760 fseek(file
,0,SEEK_SET
);
762 bufsize
=(length
+0x4600);
764 bufsize
= (bufsize
+ 0x400) & ~0x200;
767 outbuf
= malloc(bufsize
);
770 printf("out of memory!\n");
774 len
= fread(outbuf
+0x4600, 1, length
, file
);
775 if(len
< (size_t)length
) {
781 /* Calculate checksum for later use in header */
782 for(i
= 0x4600; i
< 0x4600+length
;i
++)
785 /* Clear the header area to zero */
786 memset(outbuf
, 0, 0x4600);
788 /* APPLE STOP SIGN */
789 strcpy((char *)outbuf
, apple_stop_sign
);
792 memcpy(&outbuf
[0x100],"]ih[",4); /* Magic */
793 int2le(0x4000, &outbuf
[0x104]); /* Firmware offset relative to 0x200 */
794 short2le(0x10c, &outbuf
[0x108]); /* Location of extended header */
795 short2le(fw_ver
, &outbuf
[0x10a]);
797 /* Firmware Directory - "osos" entry */
798 memcpy(&outbuf
[0x4200],"!ATAsoso",8); /* dev and type */
799 int2le(0, &outbuf
[0x4208]); /* id */
800 int2le(0x4400, &outbuf
[0x420c]); /* devOffset */
801 int2le(length
, &outbuf
[0x4210]); /* Length of firmware */
802 int2le(0x10000000, &outbuf
[0x4214]); /* Addr */
803 int2le(0, &outbuf
[0x4218]); /* Entry Offset */
804 int2le(sum
, &outbuf
[0x421c]); /* Checksum */
805 int2le(0x00006012, &outbuf
[0x4220]); /* vers - 0x6012 is a guess */
806 int2le(0xffffffff, &outbuf
[0x4224]); /* LoadAddr - for flash images */
808 /* "rsrc" entry (if applicable) */
810 rsrcoffset
=(length
+0x4600+0x200) & ~0x200;
814 memcpy(&outbuf
[0x4228],"!ATAcrsr",8); /* dev and type */
815 int2le(0, &outbuf
[0x4230]); /* id */
816 int2le(rsrcoffset
, &outbuf
[0x4234]); /* devOffset */
817 int2le(rsrclength
, &outbuf
[0x4238]); /* Length of firmware */
818 int2le(0x10000000, &outbuf
[0x423c]); /* Addr */
819 int2le(0, &outbuf
[0x4240]); /* Entry Offset */
820 int2le(rsrcsum
, &outbuf
[0x4244]); /* Checksum */
821 int2le(0x0000b000, &outbuf
[0x4248]); /* vers */
822 int2le(0xffffffff, &outbuf
[0x424c]); /* LoadAddr - for flash images */
825 file
= fopen(oname
, "wb");
831 len
= fwrite(outbuf
, 1, length
+0x4600, file
);
832 if(len
< (size_t)length
) {
842 #define CCPMP_SIZE 0x500000
843 static int ccpmp_encode(char *iname
, char *oname
)
848 unsigned char *outbuf
;
850 file
= fopen(iname
, "rb");
855 fseek(file
,0,SEEK_END
);
856 length
= ftell(file
);
858 fseek(file
,0,SEEK_SET
);
860 outbuf
= malloc(CCPMP_SIZE
);
863 printf("out of memory!\n");
867 len
= fread(outbuf
, 1, length
, file
);
868 if(len
< (size_t)length
) {
874 /* Clear the tail area to 0xFF */
875 memset(&outbuf
[length
], 0xFF, CCPMP_SIZE
- length
);
878 int2le(length
, &outbuf
[0x4]);
880 file
= fopen(oname
, "wb");
886 len
= fwrite(outbuf
, 1, CCPMP_SIZE
, file
);
887 if(len
< (size_t)length
) {