Add MD5 checksumming of the original firmware images - for extra safety, and also because some Fuze firmwares have the same ID (or what we thought was the ID) as the M200 firmwares. Plus a few minor cleanups.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18927 a1c6a512-1295-4272-9138-f99709370657

4 files changed, 368 insertions, 20 deletions

diff --git a/rbutil/mkamsboot/Makefile b/rbutil/mkamsboot/Makefile
index d643930915..ea8ca274c3 100644
--- a/rbutil/mkamsboot/Makefile
+++ b/rbutil/mkamsboot/Makefile
@@ -20,18 +20,21 @@ E200V2FILES = dualboot-e200v2.o dualboot-e200v2.elf dualboot-e200v2.o \
               dualboot-e200v2.bin bootimg_e200v2.c bootimg_e200v2.h
 
 M200V2FILES = dualboot-m200v2.o dualboot-m200v2.elf dualboot-m200v2.o \
-              dualboot-m200v2.bin bootimg_m200v2.c bootimg_m200v2.h              
-              
+              dualboot-m200v2.bin bootimg_m200v2.c bootimg_m200v2.h
+
 all: mkamsboot
 
 $(LIBUCL):
 	make -C ../../tools/ucl/src libucl.a
 
-mkamsboot.o: mkamsboot.c $(BOOTHEADERS) uclimg.h
+md5.o: md5.c md5.h
+	gcc $(CFLAGS) -c -o md5.o -W -Wall md5.c
+
+mkamsboot.o: mkamsboot.c $(BOOTHEADERS) uclimg.h md5.h
 	gcc $(CFLAGS) -c -o mkamsboot.o -W -Wall mkamsboot.c
 
-mkamsboot: mkamsboot.o $(BOOTIMAGES) uclimg.o $(LIBUCL)
-	gcc -o mkamsboot mkamsboot.o $(BOOTIMAGES) uclimg.o $(LIBUCL)
+mkamsboot: mkamsboot.o $(BOOTIMAGES) uclimg.o md5.o $(LIBUCL)
+	gcc -o mkamsboot mkamsboot.o $(BOOTIMAGES) uclimg.o md5.o $(LIBUCL)
 
 # Rules for our test ARM application - assemble, link, then extract
 # the binary code
@@ -110,5 +113,5 @@ bin2c: bin2c.c
 
 clean:
 	rm -f mkamsboot mkamsboot.o nrv2e_d8.o nrv2e_d8.elf nrv2e_d8.bin *~ \
-	bin2c uclimg.c uclimg.h uclimg.o \
+	bin2c uclimg.c uclimg.h uclimg.o md5.o \
 	$(BOOTIMAGES) $(CLIPFILES) $(E200V2FILES) $(M200V2FILES)
diff --git a/rbutil/mkamsboot/md5.c b/rbutil/mkamsboot/md5.c
new file mode 100644
index 0000000000..6c5e8127f9
--- /dev/null
+++ b/rbutil/mkamsboot/md5.c
@@ -0,0 +1,246 @@
+/*
+ *  RFC 1321 compliant MD5 implementation
+ *
+ *  Copyright (C) 2001-2003  Christophe Devine
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <string.h>
+
+#include "md5.h"
+
+#define GET_UINT32(n,b,i)                       \
+{                                               \
+    (n) = ( (uint32) (b)[(i)    ]       )       \
+        | ( (uint32) (b)[(i) + 1] <<  8 )       \
+        | ( (uint32) (b)[(i) + 2] << 16 )       \
+        | ( (uint32) (b)[(i) + 3] << 24 );      \
+}
+
+#define PUT_UINT32(n,b,i)                       \
+{                                               \
+    (b)[(i)    ] = (uint8) ( (n)       );       \
+    (b)[(i) + 1] = (uint8) ( (n) >>  8 );       \
+    (b)[(i) + 2] = (uint8) ( (n) >> 16 );       \
+    (b)[(i) + 3] = (uint8) ( (n) >> 24 );       \
+}
+
+void md5_starts( md5_context *ctx )
+{
+    ctx->total[0] = 0;
+    ctx->total[1] = 0;
+
+    ctx->state[0] = 0x67452301;
+    ctx->state[1] = 0xEFCDAB89;
+    ctx->state[2] = 0x98BADCFE;
+    ctx->state[3] = 0x10325476;
+}
+
+void md5_process( md5_context *ctx, uint8 data[64] )
+{
+    uint32 X[16], A, B, C, D;
+
+    GET_UINT32( X[0],  data,  0 );
+    GET_UINT32( X[1],  data,  4 );
+    GET_UINT32( X[2],  data,  8 );
+    GET_UINT32( X[3],  data, 12 );
+    GET_UINT32( X[4],  data, 16 );
+    GET_UINT32( X[5],  data, 20 );
+    GET_UINT32( X[6],  data, 24 );
+    GET_UINT32( X[7],  data, 28 );
+    GET_UINT32( X[8],  data, 32 );
+    GET_UINT32( X[9],  data, 36 );
+    GET_UINT32( X[10], data, 40 );
+    GET_UINT32( X[11], data, 44 );
+    GET_UINT32( X[12], data, 48 );
+    GET_UINT32( X[13], data, 52 );
+    GET_UINT32( X[14], data, 56 );
+    GET_UINT32( X[15], data, 60 );
+
+#define S(x,n) ((x << n) | ((x & 0xFFFFFFFF) >> (32 - n)))
+
+#define P(a,b,c,d,k,s,t)                                \
+{                                                       \
+    a += F(b,c,d) + X[k] + t; a = S(a,s) + b;           \
+}
+
+    A = ctx->state[0];
+    B = ctx->state[1];
+    C = ctx->state[2];
+    D = ctx->state[3];
+
+#define F(x,y,z) (z ^ (x & (y ^ z)))
+
+    P( A, B, C, D,  0,  7, 0xD76AA478 );
+    P( D, A, B, C,  1, 12, 0xE8C7B756 );
+    P( C, D, A, B,  2, 17, 0x242070DB );
+    P( B, C, D, A,  3, 22, 0xC1BDCEEE );
+    P( A, B, C, D,  4,  7, 0xF57C0FAF );
+    P( D, A, B, C,  5, 12, 0x4787C62A );
+    P( C, D, A, B,  6, 17, 0xA8304613 );
+    P( B, C, D, A,  7, 22, 0xFD469501 );
+    P( A, B, C, D,  8,  7, 0x698098D8 );
+    P( D, A, B, C,  9, 12, 0x8B44F7AF );
+    P( C, D, A, B, 10, 17, 0xFFFF5BB1 );
+    P( B, C, D, A, 11, 22, 0x895CD7BE );
+    P( A, B, C, D, 12,  7, 0x6B901122 );
+    P( D, A, B, C, 13, 12, 0xFD987193 );
+    P( C, D, A, B, 14, 17, 0xA679438E );
+    P( B, C, D, A, 15, 22, 0x49B40821 );
+
+#undef F
+
+#define F(x,y,z) (y ^ (z & (x ^ y)))
+
+    P( A, B, C, D,  1,  5, 0xF61E2562 );
+    P( D, A, B, C,  6,  9, 0xC040B340 );
+    P( C, D, A, B, 11, 14, 0x265E5A51 );
+    P( B, C, D, A,  0, 20, 0xE9B6C7AA );
+    P( A, B, C, D,  5,  5, 0xD62F105D );
+    P( D, A, B, C, 10,  9, 0x02441453 );
+    P( C, D, A, B, 15, 14, 0xD8A1E681 );
+    P( B, C, D, A,  4, 20, 0xE7D3FBC8 );
+    P( A, B, C, D,  9,  5, 0x21E1CDE6 );
+    P( D, A, B, C, 14,  9, 0xC33707D6 );
+    P( C, D, A, B,  3, 14, 0xF4D50D87 );
+    P( B, C, D, A,  8, 20, 0x455A14ED );
+    P( A, B, C, D, 13,  5, 0xA9E3E905 );
+    P( D, A, B, C,  2,  9, 0xFCEFA3F8 );
+    P( C, D, A, B,  7, 14, 0x676F02D9 );
+    P( B, C, D, A, 12, 20, 0x8D2A4C8A );
+
+#undef F
+    
+#define F(x,y,z) (x ^ y ^ z)
+
+    P( A, B, C, D,  5,  4, 0xFFFA3942 );
+    P( D, A, B, C,  8, 11, 0x8771F681 );
+    P( C, D, A, B, 11, 16, 0x6D9D6122 );
+    P( B, C, D, A, 14, 23, 0xFDE5380C );
+    P( A, B, C, D,  1,  4, 0xA4BEEA44 );
+    P( D, A, B, C,  4, 11, 0x4BDECFA9 );
+    P( C, D, A, B,  7, 16, 0xF6BB4B60 );
+    P( B, C, D, A, 10, 23, 0xBEBFBC70 );
+    P( A, B, C, D, 13,  4, 0x289B7EC6 );
+    P( D, A, B, C,  0, 11, 0xEAA127FA );
+    P( C, D, A, B,  3, 16, 0xD4EF3085 );
+    P( B, C, D, A,  6, 23, 0x04881D05 );
+    P( A, B, C, D,  9,  4, 0xD9D4D039 );
+    P( D, A, B, C, 12, 11, 0xE6DB99E5 );
+    P( C, D, A, B, 15, 16, 0x1FA27CF8 );
+    P( B, C, D, A,  2, 23, 0xC4AC5665 );
+
+#undef F
+
+#define F(x,y,z) (y ^ (x | ~z))
+
+    P( A, B, C, D,  0,  6, 0xF4292244 );
+    P( D, A, B, C,  7, 10, 0x432AFF97 );
+    P( C, D, A, B, 14, 15, 0xAB9423A7 );
+    P( B, C, D, A,  5, 21, 0xFC93A039 );
+    P( A, B, C, D, 12,  6, 0x655B59C3 );
+    P( D, A, B, C,  3, 10, 0x8F0CCC92 );
+    P( C, D, A, B, 10, 15, 0xFFEFF47D );
+    P( B, C, D, A,  1, 21, 0x85845DD1 );
+    P( A, B, C, D,  8,  6, 0x6FA87E4F );
+    P( D, A, B, C, 15, 10, 0xFE2CE6E0 );
+    P( C, D, A, B,  6, 15, 0xA3014314 );
+    P( B, C, D, A, 13, 21, 0x4E0811A1 );
+    P( A, B, C, D,  4,  6, 0xF7537E82 );
+    P( D, A, B, C, 11, 10, 0xBD3AF235 );
+    P( C, D, A, B,  2, 15, 0x2AD7D2BB );
+    P( B, C, D, A,  9, 21, 0xEB86D391 );
+
+#undef F
+
+    ctx->state[0] += A;
+    ctx->state[1] += B;
+    ctx->state[2] += C;
+    ctx->state[3] += D;
+}
+
+void md5_update( md5_context *ctx, uint8 *input, uint32 length )
+{
+    uint32 left, fill;
+
+    if( ! length ) return;
+
+    left = ctx->total[0] & 0x3F;
+    fill = 64 - left;
+
+    ctx->total[0] += length;
+    ctx->total[0] &= 0xFFFFFFFF;
+
+    if( ctx->total[0] < length )
+        ctx->total[1]++;
+
+    if( left && length >= fill )
+    {
+        memcpy( (void *) (ctx->buffer + left),
+                (void *) input, fill );
+        md5_process( ctx, ctx->buffer );
+        length -= fill;
+        input  += fill;
+        left = 0;
+    }
+
+    while( length >= 64 )
+    {
+        md5_process( ctx, input );
+        length -= 64;
+        input  += 64;
+    }
+
+    if( length )
+    {
+        memcpy( (void *) (ctx->buffer + left),
+                (void *) input, length );
+    }
+}
+
+static uint8 md5_padding[64] =
+{
+ 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
+};
+
+void md5_finish( md5_context *ctx, uint8 digest[16] )
+{
+    uint32 last, padn;
+    uint32 high, low;
+    uint8 msglen[8];
+
+    high = ( ctx->total[0] >> 29 )
+         | ( ctx->total[1] <<  3 );
+    low  = ( ctx->total[0] <<  3 );
+
+    PUT_UINT32( low,  msglen, 0 );
+    PUT_UINT32( high, msglen, 4 );
+
+    last = ctx->total[0] & 0x3F;
+    padn = ( last < 56 ) ? ( 56 - last ) : ( 120 - last );
+
+    md5_update( ctx, md5_padding, padn );
+    md5_update( ctx, msglen, 8 );
+
+    PUT_UINT32( ctx->state[0], digest,  0 );
+    PUT_UINT32( ctx->state[1], digest,  4 );
+    PUT_UINT32( ctx->state[2], digest,  8 );
+    PUT_UINT32( ctx->state[3], digest, 12 );
+}
+
diff --git a/rbutil/mkamsboot/md5.h b/rbutil/mkamsboot/md5.h
new file mode 100644
index 0000000000..71fa395548
--- /dev/null
+++ b/rbutil/mkamsboot/md5.h
@@ -0,0 +1,25 @@
+#ifndef _MD5_H
+#define _MD5_H
+
+#ifndef uint8
+#define uint8  unsigned char
+#endif
+
+#ifndef uint32
+#define uint32 unsigned long int
+#endif
+
+typedef struct
+{
+    uint32 total[2];
+    uint32 state[4];
+    uint8 buffer[64];
+}
+md5_context;
+
+void md5_starts( md5_context *ctx );
+void md5_update( md5_context *ctx, uint8 *input, uint32 length );
+void md5_finish( md5_context *ctx, uint8 digest[16] );
+
+#endif /* md5.h */
+
diff --git a/rbutil/mkamsboot/mkamsboot.c b/rbutil/mkamsboot/mkamsboot.c
index e4b6e09782..5733db5f2a 100644
--- a/rbutil/mkamsboot/mkamsboot.c
+++ b/rbutil/mkamsboot/mkamsboot.c
@@ -87,6 +87,8 @@ execution to the uncompressed firmware.
 
 /* Headers for ARM code binaries */
 #include "uclimg.h"
+#include "md5.h"
+
 #include "bootimg_clip.h"
 #include "bootimg_e200v2.h"
 #include "bootimg_m200v2.h"
@@ -165,6 +167,39 @@ static const int rb_model_num[] =
     0
 };
 
+struct md5sums {
+    int model;
+    char *version;
+    int fw_version;
+    char *md5;
+};
+
+/* Checksums of unmodified original firmwares - for safety, and device
+   detection */
+static struct md5sums sansasums[] = {
+    /* NOTE: Different regional versions of the firmware normally only
+             differ in the filename - the md5sums are identical */
+    { MODEL_E200, "3.01.11",   1, "e622ca8cb6df423f54b8b39628a1f0a3" },
+    { MODEL_E200, "3.01.14",   1, "2c1d0383fc3584b2cc83ba8cc2243af6" },
+    { MODEL_E200, "3.01.16",   1, "12563ad71b25a1034cf2092d1e0218c4" },
+
+    { MODEL_FUZE, "1.01.11",   1, "cac8ffa03c599330ac02c4d41de66166" },
+    { MODEL_FUZE, "1.01.15",   1, "df0e2c1612727f722c19a3c764cff7f2" },
+
+    { MODEL_C200, "3.02.05",   1, "b6378ebd720b0ade3fad4dc7ab61c1a5" },
+
+    { MODEL_M200, "4.00.45",   1, "82e3194310d1514e3bbcd06e84c4add3" },
+    { MODEL_M200, "4.01.08-A", 1, "fc9dd6116001b3e6a150b898f1b091f0" },
+    { MODEL_M200, "4.01.08-E", 1, "d3fb7d8ec8624ee65bc99f8dab0e2369" },
+
+    { MODEL_CLIP, "1.01.17",   1, "12caad785d506219d73f538772afd99e" },
+    { MODEL_CLIP, "1.01.18",   1, "d720b266bd5afa38a198986ef0508a45" },
+    { MODEL_CLIP, "1.01.20",   1, "236d8f75189f468462c03f6d292cf2ac" },
+    { MODEL_CLIP, "1.01.29",   1, "b07fe36b338241944c241de21fb1e490" },
+    { MODEL_CLIP, "1.01.30",   1, "f2974d47c536549c9d8259170f1dbe4d" },
+};
+
+#define NUM_MD5S (sizeof(sansasums)/sizeof(sansasums[0]))
 
 static off_t filesize(int fd) {
     struct stat buf;
@@ -195,6 +230,21 @@ static void put_uint32le(unsigned char* p, uint32_t x)
     p[3] = (x >> 24) & 0xff;
 }
 
+void calc_MD5(unsigned char* buf, int len, char *md5str)
+{
+    int i;
+    md5_context ctx;
+    unsigned char md5sum[16];
+    
+    md5_starts(&ctx);
+    md5_update(&ctx, buf, len);
+    md5_finish(&ctx, md5sum);
+
+    for (i = 0; i < 16; ++i)
+        sprintf(md5str + 2*i, "%02x", md5sum[i]);
+}
+
+
 static uint32_t calc_checksum(unsigned char* buf, uint32_t n)
 {
     uint32_t sum = 0;
@@ -375,6 +425,7 @@ int main(int argc, char* argv[])
     int totalsize;
     unsigned char* p;
     uint32_t checksum;
+    char md5sum[33]; /* 32 hex digits, plus terminating zero */
 
     fprintf(stderr,"mkamsboot v" VERSION " - (C) Dave Chapman and Rafaël Carré 2008\n");
     fprintf(stderr,"This is free software; see the source for copying conditions.  There is NO\n");
@@ -397,26 +448,48 @@ int main(int argc, char* argv[])
         return 1;
     }
 
-    /* TODO: Do some more sanity checks on the OF image. Some images (like m200v2) dont have a checksum at the end, only padding (0xdeadbeef). */
-    checksum = get_uint32le(buf + len - 4); 
-    if (checksum != 0xefbeadde && checksum != calc_checksum(buf, len - 4)) {
+    /* Calculate MD5 checksum of OF */
+    calc_MD5(buf, len, md5sum);
 
-        fprintf(stderr,"[ERR]  Whole file checksum failed - %s\n",infile);
-        return 1;
-    }
+    fprintf(stderr,"[INFO] MD5 sum - %s\n",md5sum);
+
+    i = 0;
+    while ((i < NUM_MD5S) && (strcmp(sansasums[i].md5, md5sum) != 0))
+        i++;
 
-    if (get_uint32le(&buf[0x204])==0x0000f000) {
-        fw_version = 2;
-        model_id = buf[0x219];
+    if (i < NUM_MD5S) {
+        model = sansasums[i].model;
+        fw_version = sansasums[i].fw_version;
+        fprintf(stderr,"[INFO] Original firmware MD5 checksum match - %s %s\n",
+                       model_names[model], sansasums[i].version);
     } else {
-        fw_version = 1;
-        model_id = buf[0x215];
+        fprintf(stderr,"[WARN] ****** Original firmware unknown ******\n");
+        
+        if (get_uint32le(&buf[0x204])==0x0000f000) {
+            fw_version = 2;
+            model_id = buf[0x219];
+        } else {
+            fw_version = 1;
+            model_id = buf[0x215];
+        }
+
+        model = get_model(model_id);
+
+        if (model == MODEL_UNKNOWN) {
+            fprintf(stderr,"[ERR]  Unknown firmware - model id 0x%02x\n",
+                           model_id);
+            free(buf);
+            return 1;
+        }
     }
+    
 
-    model = get_model(model_id);
+    /* TODO: Do some more sanity checks on the OF image. Some images (like m200v2) dont have a checksum at the end, only padding (0xdeadbeef). */
+    checksum = get_uint32le(buf + len - 4); 
+    if (checksum != 0xefbeadde && checksum != calc_checksum(buf, len - 4)) {
 
-    if (model == MODEL_UNKNOWN) {
-        fprintf(stderr,"[ERR]  Unknown firmware - model id 0x%02x\n",model_id);
+        fprintf(stderr,"[ERR]  Whole file checksum failed - %s\n",infile);
+        free(buf);
         return 1;
     }
 
@@ -430,6 +503,7 @@ int main(int argc, char* argv[])
     rb_unpacked = load_rockbox_file(bootfile, model, &bootloader_size);
     if (rb_unpacked == NULL) {
         fprintf(stderr,"[ERR]  Could not load %s\n",bootfile);
+        free(buf);
         return 1;
     }