1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 - 2007 by Björn Stenberg
12 * All files in this archive are subject to the GNU General Public License.
13 * See the file COPYING in the source tree root for full license agreement.
15 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
16 * KIND, either express or implied.
18 ****************************************************************************/
26 #include "gigabeats.h"
28 #include "telechips.h"
30 int iaudio_encode(char *iname
, char *oname
, char *idstring
);
31 int ipod_encode(char *iname
, char *oname
, int fw_ver
, bool fake_rsrc
);
35 ARCHOS_PLAYER
, /* and V1 recorder */
44 0x32000, /* ARCHOS_PLAYER */
45 0x64000, /* ARCHOS_V2RECORDER */
46 0x64000, /* ARCHOS_FMRECORDER */
47 0x64000, /* ARCHOS_ONDIO_SP */
48 0x64000 /* ARCHOS_ONDIO_FM */
51 void short2le(unsigned short val
, unsigned char* addr
)
54 addr
[1] = (val
>> 8) & 0xff;
57 unsigned int le2int(unsigned char* buf
)
59 unsigned int res
= (buf
[3] << 24) | (buf
[2] << 16) | (buf
[1] << 8) | buf
[0];
64 void int2le(unsigned int val
, unsigned char* addr
)
67 addr
[1] = (val
>> 8) & 0xff;
68 addr
[2] = (val
>> 16) & 0xff;
69 addr
[3] = (val
>> 24) & 0xff;
72 void int2be(unsigned int val
, unsigned char* addr
)
74 addr
[0] = (val
>> 24) & 0xff;
75 addr
[1] = (val
>> 16) & 0xff;
76 addr
[2] = (val
>> 8) & 0xff;
82 printf("usage: scramble [options] <input file> <output file> [xor string]\n");
84 "\t-fm Archos FM recorder format\n"
85 "\t-v2 Archos V2 recorder format\n"
86 "\t-ofm Archos Ondio FM recorder format\n"
87 "\t-osp Archos Ondio SP format\n"
88 "\t-neo SSI Neo format\n"
89 "\t-mm=X Archos Multimedia format (X values: A=JBMM, B=AV1xx, C=AV3xx)\n"
90 "\t-iriver iRiver format\n"
91 "\t-iaudiox5 iAudio X5 format\n"
92 "\t-iaudiox5v iAudio X5V format\n"
93 "\t-iaudiom5 iAudio M5 format\n"
94 "\t-ipod3g ipod firmware partition format (3rd Gen)\n"
95 "\t-ipod4g ipod firmware partition format (4th Gen, Mini, Nano, Photo/Color)\n"
96 "\t-ipod5g ipod firmware partition format (5th Gen - aka Video)\n"
97 "\t-gigabeat Toshiba Gigabeat F/X format\n"
98 "\t-gigabeats Toshiba Gigabeat S format\n"
99 "\t-mi4v2 PortalPlayer .mi4 format (revision 010201)\n"
100 "\t-mi4v3 PortalPlayer .mi4 format (revision 010301)\n"
101 "\t-mi4r Sandisk Rhapsody .mi4 format\n"
102 "\t All mi4 options take two optional arguments:\n"
103 "\t -model=XXXX where XXXX is the model id string\n"
104 "\t -type=XXXX where XXXX is a string indicating the \n"
105 "\t type of binary, eg. RBOS, RBBL\n"
106 "\t-tcc=X Telechips generic firmware format (X values: sum, crc)\n"
107 "\t-add=X Rockbox generic \"add-up\" checksum format\n"
108 "\t (X values: h100, h120, h140, h300, ipco, nano, ipvd, mn2g\n"
109 "\t ip3g, ip4g, mini, iax5, h10, h10_5gb, tpj2,\n"
110 "\t c200, e200, giga, m100, m500)\n"
111 "\nNo option results in Archos standard player/recorder format.\n");
116 int main (int argc
, char** argv
)
118 unsigned long length
,i
,slen
;
119 unsigned char *inbuf
,*outbuf
;
120 unsigned short crc
=0;
121 unsigned long chksum
=0; /* 32 bit checksum */
122 unsigned char header
[24];
123 char *iname
= argv
[1];
124 char *oname
= argv
[2];
129 unsigned long modelnum
;
132 enum { none
, scramble
, xor, tcc_sum
, tcc_crc
, add
} method
= scramble
;
134 model_id
= ARCHOS_PLAYER
;
140 if(!strcmp(argv
[1], "-fm")) {
145 model_id
= ARCHOS_FMRECORDER
;
148 else if(!strcmp(argv
[1], "-v2")) {
153 model_id
= ARCHOS_V2RECORDER
;
156 else if(!strcmp(argv
[1], "-ofm")) {
161 model_id
= ARCHOS_ONDIO_FM
;
164 else if(!strcmp(argv
[1], "-osp")) {
169 model_id
= ARCHOS_ONDIO_SP
;
172 else if(!strcmp(argv
[1], "-neo")) {
178 else if(!strncmp(argv
[1], "-mm=", 4)) {
183 version
= argv
[1][4];
187 printf("Multimedia needs an xor string\n");
191 else if(!strncmp(argv
[1], "-tcc=", 4)) {
196 if(!strcmp(&argv
[1][5], "sum"))
198 else if(!strcmp(&argv
[1][5], "crc"))
201 fprintf(stderr
, "unsupported TCC method: %s\n", &argv
[1][5]);
205 else if(!strncmp(argv
[1], "-add=", 5)) {
210 if(!strcmp(&argv
[1][5], "h120"))
212 else if(!strcmp(&argv
[1][5], "h140"))
213 modelnum
= 0; /* the same as the h120 */
214 else if(!strcmp(&argv
[1][5], "h100"))
216 else if(!strcmp(&argv
[1][5], "h300"))
218 else if(!strcmp(&argv
[1][5], "ipco"))
220 else if(!strcmp(&argv
[1][5], "nano"))
222 else if(!strcmp(&argv
[1][5], "ipvd"))
224 else if(!strcmp(&argv
[1][5], "fp7x"))
226 else if(!strcmp(&argv
[1][5], "ip3g"))
228 else if(!strcmp(&argv
[1][5], "ip4g"))
230 else if(!strcmp(&argv
[1][5], "mini"))
232 else if(!strcmp(&argv
[1][5], "iax5"))
234 else if(!strcmp(&argv
[1][5], "mn2g"))
236 else if(!strcmp(&argv
[1][5], "h10"))
238 else if(!strcmp(&argv
[1][5], "h10_5gb"))
240 else if(!strcmp(&argv
[1][5], "tpj2"))
242 else if(!strcmp(&argv
[1][5], "e200"))
244 else if(!strcmp(&argv
[1][5], "iam5"))
246 else if(!strcmp(&argv
[1][5], "giga"))
248 else if(!strcmp(&argv
[1][5], "1g2g"))
250 else if(!strcmp(&argv
[1][5], "c200"))
252 else if(!strcmp(&argv
[1][5], "gigs"))
254 else if(!strcmp(&argv
[1][5], "m500"))
256 else if(!strcmp(&argv
[1][5], "m100"))
259 fprintf(stderr
, "unsupported model: %s\n", &argv
[1][5]);
262 /* we store a 4-letter model name too, for humans */
263 strcpy(modelname
, &argv
[1][5]);
264 chksum
= modelnum
; /* start checksum calcs with this */
267 else if(!strcmp(argv
[1], "-iriver")) {
268 /* iRiver code dealt with in the iriver.c code */
271 iriver_encode(iname
, oname
, FALSE
);
274 else if(!strcmp(argv
[1], "-gigabeat")) {
275 /* iRiver code dealt with in the iriver.c code */
278 gigabeat_code(iname
, oname
);
281 else if(!strcmp(argv
[1], "-gigabeats")) {
284 gigabeat_s_code(iname
, oname
);
287 else if(!strcmp(argv
[1], "-iaudiox5")) {
290 return iaudio_encode(iname
, oname
, "COWON_X5_FW");
292 else if(!strcmp(argv
[1], "-iaudiox5v")) {
295 return iaudio_encode(iname
, oname
, "COWON_X5V_FW");
297 else if(!strcmp(argv
[1], "-iaudiom5")) {
300 return iaudio_encode(iname
, oname
, "COWON_M5_FW");
302 else if(!strcmp(argv
[1], "-ipod3g")) {
305 return ipod_encode(iname
, oname
, 2, false); /* Firmware image v2 */
307 else if(!strcmp(argv
[1], "-ipod4g")) {
310 return ipod_encode(iname
, oname
, 3, false); /* Firmware image v3 */
312 else if(!strcmp(argv
[1], "-ipod5g")) {
315 return ipod_encode(iname
, oname
, 3, true); /* Firmware image v3 */
317 else if(!strncmp(argv
[1], "-mi4", 4)) {
323 if(!strcmp(&argv
[1][4], "v2")) {
324 mi4magic
= MI4_MAGIC_DEFAULT
;
325 version
= 0x00010201;
327 else if(!strcmp(&argv
[1][4], "v3")) {
328 mi4magic
= MI4_MAGIC_DEFAULT
;
329 version
= 0x00010301;
331 else if(!strcmp(&argv
[1][4], "r")) {
332 mi4magic
= MI4_MAGIC_R
;
333 version
= 0x00010301;
336 printf( "Invalid mi4 version: %s\n", &argv
[1][4]);
343 if(!strncmp(argv
[2], "-model=", 7)) {
346 strncpy(model
, &argv
[2][7], 4);
348 if(!strncmp(argv
[3], "-type=", 6)) {
351 strncpy(type
, &argv
[3][6], 4);
355 return mi4_encode(iname
, oname
, version
, mi4magic
, model
, type
);
359 file
= fopen(iname
,"rb");
364 fseek(file
,0,SEEK_END
);
365 length
= ftell(file
);
366 length
= (length
+ 3) & ~3; /* Round up to nearest 4 byte boundary */
368 if ((method
== scramble
) &&
369 ((length
+ headerlen
) >= size_limit
[model_id
])) {
370 printf("error: firmware image is %d bytes while max size is %d!\n",
372 size_limit
[model_id
]);
377 fseek(file
,0,SEEK_SET
);
378 inbuf
= malloc(length
);
380 outbuf
= malloc(length
*2);
381 else if(method
== add
)
382 outbuf
= malloc(length
+ 8);
384 outbuf
= malloc(length
);
385 if ( !inbuf
|| !outbuf
) {
386 printf("out of memory!\n");
390 /* zero-fill the last 4 bytes to make sure there's no rubbish there
391 when we write the size-aligned file later */
392 memset(outbuf
+length
-4, 0, 4);
396 i
=fread(inbuf
,1,length
,file
);
406 for (i
= 0; i
< length
; i
++) {
407 /* add 8 unsigned bits but keep a 32 bit sum */
413 for (i
= 0; i
< length
; i
++) {
414 unsigned long addr
= (i
>> 2) + ((i
% 4) * slen
);
415 unsigned char data
= inbuf
[i
];
416 data
= ~((data
<< 1) | ((data
>> 7) & 1)); /* poor man's ROL */
424 for (i
=0; i
<length
; i
++) {
426 outbuf
[slen
++] = 0xff; /* all data is uncompressed */
427 outbuf
[slen
++] = inbuf
[i
];
432 if((method
== none
) || (method
== scramble
) || (method
== xor)) {
433 /* calculate checksum */
434 for (i
=0;i
<length
;i
++)
438 memset(header
, 0, sizeof header
);
443 int2be(chksum
, header
); /* checksum, big-endian */
444 memcpy(&header
[4], modelname
, 4); /* 4 bytes model name */
445 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
451 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
452 telechips_encode_sum(outbuf
, length
);
456 memcpy(outbuf
, inbuf
, length
); /* the input buffer to output*/
457 telechips_encode_crc(outbuf
, length
);
461 if (headerlen
== 6) {
462 int2be(length
, header
);
463 header
[4] = (crc
>> 8) & 0xff;
464 header
[5] = crc
& 0xff;
470 header
[3] = 0xff; /* ??? */
472 header
[6] = (crc
>> 8) & 0xff;
473 header
[7] = crc
& 0xff;
475 header
[11] = version
;
477 header
[15] = headerlen
; /* really? */
479 int2be(length
, &header
[20]);
485 int xorlen
= strlen(xorstring
);
488 for (i
=0; i
<slen
; i
++)
489 outbuf
[i
] ^= xorstring
[i
& (xorlen
-1)];
491 /* calculate checksum */
492 for (i
=0; i
<slen
; i
++)
495 header
[0] = header
[2] = 'Z';
496 header
[1] = header
[3] = version
;
497 int2le(length
, &header
[4]);
498 int2le(slen
, &header
[8]);
499 int2le(crc
, &header
[12]);
504 #define MY_FIRMWARE_TYPE "Rockbox"
505 #define MY_HEADER_VERSION 1
507 strncpy((char *)header
, MY_FIRMWARE_TYPE
,9);
508 header
[9]='\0'; /*shouldn't have to, but to be SURE */
509 header
[10]=MY_HEADER_VERSION
&0xFF;
510 header
[11]=(crc
>>8)&0xFF;
512 int2be(sizeof(header
), &header
[12]);
517 file
= fopen(oname
,"wb");
523 if ( !fwrite(header
,headerlen
,1,file
) ) {
528 if ( !fwrite(outbuf
,length
,1,file
) ) {
540 int iaudio_encode(char *iname
, char *oname
, char *idstring
)
545 unsigned char *outbuf
;
547 unsigned char sum
= 0;
549 file
= fopen(iname
, "rb");
554 fseek(file
,0,SEEK_END
);
555 length
= ftell(file
);
557 fseek(file
,0,SEEK_SET
);
558 outbuf
= malloc(length
+0x1030);
561 printf("out of memory!\n");
565 len
= fread(outbuf
+0x1030, 1, length
, file
);
571 memset(outbuf
, 0, 0x1030);
572 strcpy((char *)outbuf
, idstring
);
574 for(i
= 0; i
< length
;i
++)
575 sum
+= outbuf
[0x1030 + i
];
577 int2be(length
, &outbuf
[0x1024]);
578 outbuf
[0x102b] = sum
;
582 file
= fopen(oname
, "wb");
588 len
= fwrite(outbuf
, 1, length
+0x1030, file
);
598 /* Create an ipod firmware partition image
600 fw_ver = 2 for 3rd Gen ipods, 3 for all later ipods including 5g.
602 This function doesn't yet handle the Broadcom resource image for the 5g,
603 so the resulting images won't be usable.
605 This has also only been tested on an ipod Photo
608 int ipod_encode(char *iname
, char *oname
, int fw_ver
, bool fake_rsrc
)
610 static const char *apple_stop_sign
= "{{~~ /-----\\ "\
631 unsigned int sum
= 0;
632 unsigned int rsrcsum
= 0;
633 unsigned char *outbuf
;
637 file
= fopen(iname
, "rb");
642 fseek(file
,0,SEEK_END
);
643 length
= ftell(file
);
645 fseek(file
,0,SEEK_SET
);
647 bufsize
=(length
+0x4600);
649 bufsize
= (bufsize
+ 0x400) & ~0x200;
652 outbuf
= malloc(bufsize
);
655 printf("out of memory!\n");
659 len
= fread(outbuf
+0x4600, 1, length
, file
);
666 /* Calculate checksum for later use in header */
667 for(i
= 0x4600; i
< 0x4600+length
;i
++)
670 /* Clear the header area to zero */
671 memset(outbuf
, 0, 0x4600);
673 /* APPLE STOP SIGN */
674 strcpy((char *)outbuf
, apple_stop_sign
);
677 memcpy(&outbuf
[0x100],"]ih[",4); /* Magic */
678 int2le(0x4000, &outbuf
[0x104]); /* Firmware offset relative to 0x200 */
679 short2le(0x10c, &outbuf
[0x108]); /* Location of extended header */
680 short2le(fw_ver
, &outbuf
[0x10a]);
682 /* Firmware Directory - "osos" entry */
683 memcpy(&outbuf
[0x4200],"!ATAsoso",8); /* dev and type */
684 int2le(0, &outbuf
[0x4208]); /* id */
685 int2le(0x4400, &outbuf
[0x420c]); /* devOffset */
686 int2le(length
, &outbuf
[0x4210]); /* Length of firmware */
687 int2le(0x10000000, &outbuf
[0x4214]); /* Addr */
688 int2le(0, &outbuf
[0x4218]); /* Entry Offset */
689 int2le(sum
, &outbuf
[0x421c]); /* Checksum */
690 int2le(0x00006012, &outbuf
[0x4220]); /* vers - 0x6012 is a guess */
691 int2le(0xffffffff, &outbuf
[0x4224]); /* LoadAddr - for flash images */
693 /* "rsrc" entry (if applicable) */
695 rsrcoffset
=(length
+0x4600+0x200) & ~0x200;
699 memcpy(&outbuf
[0x4228],"!ATAcrsr",8); /* dev and type */
700 int2le(0, &outbuf
[0x4230]); /* id */
701 int2le(rsrcoffset
, &outbuf
[0x4234]); /* devOffset */
702 int2le(rsrclength
, &outbuf
[0x4238]); /* Length of firmware */
703 int2le(0x10000000, &outbuf
[0x423c]); /* Addr */
704 int2le(0, &outbuf
[0x4240]); /* Entry Offset */
705 int2le(rsrcsum
, &outbuf
[0x4244]); /* Checksum */
706 int2le(0x0000b000, &outbuf
[0x4248]); /* vers */
707 int2le(0xffffffff, &outbuf
[0x424c]); /* LoadAddr - for flash images */
710 file
= fopen(oname
, "wb");
716 len
= fwrite(outbuf
, 1, length
+0x4600, file
);