New flash tool, needs to be ported to Windows.

[proxmark3-svn] / linux / flasher.c

diff --git a/linux/flasher.c b/linux/flasher.c
index 05f312494364c4996fda43ac103fa5975326f766..8797becf8ee25b89f9c16504b946193827153158 100644 (file)
--- a/linux/flasher.c
+++ b/linux/flasher.c
@@ -14,8 +14,24 @@
 static DWORD ExpectedAddr;
 static BYTE QueuedToSend[256];
 static BOOL AllWritten;
 static DWORD ExpectedAddr;
 static BYTE QueuedToSend[256];
 static BOOL AllWritten;

+#define PHYSICAL_FLASH_START 0x100000

 
 

-static void FlushPrevious(void)
+struct partition {
+       int start;
+       int end;
+       int precious;
+       const char *name;
+};
+struct partition partitions[] = {
+               {0x100000, 0x102000, 1, "bootrom"},
+               {0x102000, 0x110000, 0, "fpga"},
+               {0x110000, 0x140000, 0, "os"},
+};
+
+/* If translate is set, subtract PHYSICAL_FLASH_START to translate for old
+ * bootroms.
+ */
+static void FlushPrevious(int translate)

 {
        UsbCommand c;
        memset(&c, 0, sizeof(c));
 {
        UsbCommand c;
        memset(&c, 0, sizeof(c));


@@ -32,6 +48,9 @@ static void FlushPrevious(void)
 
        c.cmd = CMD_FINISH_WRITE;
        c.ext1 = (ExpectedAddr-1) & (~255);
 
        c.cmd = CMD_FINISH_WRITE;
        c.ext1 = (ExpectedAddr-1) & (~255);

+       if(translate) {
+               c.ext1 -= PHYSICAL_FLASH_START;
+       }

        printf("c.ext1 = %08x\r", c.ext1);
        memcpy(c.d.asBytes, QueuedToSend+240, 16);
        SendCommand(&c, TRUE);
        printf("c.ext1 = %08x\r", c.ext1);
        memcpy(c.d.asBytes, QueuedToSend+240, 16);
        SendCommand(&c, TRUE);


@@ -39,9 +58,16 @@ static void FlushPrevious(void)
        AllWritten = TRUE;
 }
 
        AllWritten = TRUE;
 }
 

-static void GotByte(DWORD where, BYTE which)
+/* Where must be between start_addr (inclusive) and end_addr (exclusive).
+ */
+static void GotByte(DWORD where, BYTE which, int start_addr, int end_addr, int translate)

 {
        AllWritten = FALSE;
 {
        AllWritten = FALSE;

+       
+       if(where < start_addr || where >= end_addr) {
+               printf("bad: got byte at %08x, outside of range %08x-%08x\n", where, start_addr, end_addr);
+               exit(-1);
+       }

 
        if(where != ExpectedAddr) {
                printf("bad: got at %08x, expected at %08x\n", where, ExpectedAddr);
 
        if(where != ExpectedAddr) {
                printf("bad: got at %08x, expected at %08x\n", where, ExpectedAddr);


@@ -52,7 +78,7 @@ static void GotByte(DWORD where, BYTE which)
 
        if((where & 255) == 255) {
                // we have completed a full page
 
        if((where & 255) == 255) {
                // we have completed a full page

-               FlushPrevious();
+               FlushPrevious(translate);

        }
 }
 
        }
 }
 


@@ -74,10 +100,10 @@ static BYTE HexByte(char *s)
        return (HexVal(s[0]) << 4) | HexVal(s[1]);
 }
 
        return (HexVal(s[0]) << 4) | HexVal(s[1]);
 }
 

-static void LoadFlashFromSRecords(char *file, int addr)
+static void LoadFlashFromSRecords(const char *file, int start_addr, int end_addr, int translate)

 {
 {

-       ExpectedAddr = addr;
-
+       ExpectedAddr = start_addr;
+       

        FILE *f = fopen(file, "r");
        if(!f) {
                printf("couldn't open file\n");
        FILE *f = fopen(file, "r");
        if(!f) {
                printf("couldn't open file\n");


@@ -97,63 +123,226 @@ static void LoadFlashFromSRecords(char *file, int addr)
                        DWORD addr;
                        sscanf(addrStr, "%x", &addr);
                        s += 8;
                        DWORD addr;
                        sscanf(addrStr, "%x", &addr);
                        s += 8;

+                       
+                       /* Accept files that are located at PHYSICAL_FLASH_START, and files that are located at 0 */
+                       if(addr < PHYSICAL_FLASH_START) 
+                               addr += PHYSICAL_FLASH_START;

 
                        int i;
                        for(i = 0; i < len; i++) {
                                while((addr+i) > ExpectedAddr) {
 
                        int i;
                        for(i = 0; i < len; i++) {
                                while((addr+i) > ExpectedAddr) {

-                                       GotByte(ExpectedAddr, 0xff);
+                                       GotByte(ExpectedAddr, 0xff, start_addr, end_addr, translate);

                                }
                                }

-                               GotByte(addr+i, HexByte(s));
+                               GotByte(addr+i, HexByte(s), start_addr, end_addr, translate);

                                s += 2;
                        }
                }
        }
 
                                s += 2;
                        }
                }
        }
 

-       if(!AllWritten) FlushPrevious();
+       if(!AllWritten) FlushPrevious(translate);

 
        fclose(f);
        printf("\ndone.\n");
 }
 
 
        fclose(f);
        printf("\ndone.\n");
 }
 

-int main(int argc, char **argv) {
-       unsigned int addr = 0;
-       UsbCommand c;
+static int PrepareFlash(struct partition *p, const char *filename, unsigned int state)
+{
+       int translate = 0;
+       if(state & DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH) {
+               UsbCommand c;
+               c.cmd = CMD_START_FLASH;
+               c.ext1 = p->start;
+               c.ext2 = p->end;
+               
+               /* Only send magic when flashing bootrom */
+               if(p->precious) {
+                       c.ext3 = START_FLASH_MAGIC;
+               } else {
+                       c.ext3 = 0;
+               }
+               SendCommand(&c, TRUE);
+               translate = 0;
+       } else {
+               fprintf(stderr, "Warning: Your bootloader does not understand the new START_FLASH command\n");
+               fprintf(stderr, "         It is recommended that you update your bootloader\n\n");
+               translate = 1;
+       }
+       
+       LoadFlashFromSRecords(filename, p->start, p->end, translate);
+       return 1;
+}

 
 

-       if (argc != 3) {
-               fprintf(stderr,"Usage: %s {bootrom|os|fpga} image.s19\n", argv[0]);
-               exit(EXIT_FAILURE);
+static unsigned int GetProxmarkState(void)
+{
+       unsigned int state = 0;
+       
+       UsbCommand c;
+       c.cmd = CMD_DEVICE_INFO;
+       SendCommand(&c, FALSE);
+       
+       UsbCommand resp;
+       ReceiveCommand(&resp);
+       /* Three cases: 
+        * 1. The old bootrom code will ignore CMD_DEVICE_INFO, but respond with an ACK
+        * 2. The old os code will respond with CMD_DEBUG_PRINT_STRING and "unknown command"
+        * 3. The new bootrom and os codes will respond with CMD_DEVICE_INFO and flags
+        */
+       
+       switch(resp.cmd) {
+       case CMD_ACK:
+               state = DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM;
+               break;
+       case CMD_DEBUG_PRINT_STRING:
+               state = DEVICE_INFO_FLAG_CURRENT_MODE_OS;
+               break;
+       case CMD_DEVICE_INFO:
+               state = resp.ext1;
+               break;
+       default:
+               fprintf(stderr, "Couldn't get proxmark state, bad response type: 0x%04X\n", resp.cmd);
+               exit(-1);
+               break;

        }
        }

+       
+#if 0
+       if(state & DEVICE_INFO_FLAG_BOOTROM_PRESENT) printf("New bootrom present\n");
+       if(state & DEVICE_INFO_FLAG_OSIMAGE_PRESENT) printf("New osimage present\n");
+       if(state & DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM) printf("Currently in bootrom\n");
+       if(state & DEVICE_INFO_FLAG_CURRENT_MODE_OS) printf("Currently in OS\n");
+#endif
+       
+       return state;
+}

 
 

-       if (!strcmp(argv[1],"bootrom")) {
-               addr = 0;
-       } else if (!strcmp(argv[1],"os")) {
-               addr = 0x10000;
-       } else if (!strcmp(argv[1],"fpga")) {
-               addr = 0x2000;
-       } else {
-               fprintf(stderr,"Unknown action '%s'!\n", argv[1]);
-               exit(EXIT_FAILURE);
+static unsigned int EnterFlashState(void)
+{
+       unsigned int state = GetProxmarkState();
+       
+       if(state & DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM) {
+               /* Already in flash state, we're done. */
+               return state;

        }
        }

+       
+       if(state & DEVICE_INFO_FLAG_CURRENT_MODE_OS) {
+               fprintf(stderr,"Entering flash-mode...\n");
+               UsbCommand c;
+               bzero(&c, sizeof(c));
+               
+               if( (state & DEVICE_INFO_FLAG_BOOTROM_PRESENT) && (state & DEVICE_INFO_FLAG_OSIMAGE_PRESENT) ) {
+                       /* New style handover: Send CMD_START_FLASH, which will reset the board and
+                        * enter the bootrom on the next boot.
+                        */
+                       c.cmd = CMD_START_FLASH;
+                       SendCommand(&c, FALSE);
+                       fprintf(stderr,"(You don't have to do anything. Press and release the button only if you want to abort)\n");
+                       fprintf(stderr,"Waiting for Proxmark to reappear on USB... ");
+               } else {
+                       /* Old style handover: Ask the user to press the button, then reset the board */
+                       c.cmd = CMD_HARDWARE_RESET;
+                       SendCommand(&c, FALSE);
+                       fprintf(stderr,"(Press and hold down button NOW if your bootloader requires it)\n");
+                       fprintf(stderr,"Waiting for Proxmark to reappear on USB... ");
+               }
+               
+               CloseProxmark();
+               sleep(1);

 
 

-       usb_init();
+               while(!(devh=OpenProxmark(0))) { sleep(1); }
+               fprintf(stderr,"Found.\n");

 
 

-       fprintf(stderr,"Waiting for Proxmark to appear on USB...\n");
-       while(!(devh=OpenProxmark(0))) { sleep(1); }
-       fprintf(stderr,"Found...\n");
+               return GetProxmarkState();
+       }
+       
+       return 0;
+}

 
 

-       fprintf(stderr,"Entering flash-mode...\n");
-       bzero(&c, sizeof(c));
-       c.cmd = CMD_START_FLASH;
-       SendCommand(&c, FALSE);
-       CloseProxmark();
-       sleep(1);
+static void usage(char **argv)
+{
+       int i;
+       fprintf(stderr, "Usage:   %s areas image [image [image]]\n", argv[0]);
+       fprintf(stderr, "         areas is a comma-separated list of areas to flash, with no spaces\n");
+       fprintf(stderr, "               Known areas are:");
+       for(i=0; i<(sizeof(partitions)/sizeof(partitions[0])); i++) {
+               fprintf(stderr, " %s", partitions[i].name);
+       }
+       fprintf(stderr, "\n");
+       fprintf(stderr, "         image is the path to the corresponding image\n\n");
+       fprintf(stderr, "Example: %s os,fpga path/to/osimage.s19 path/to/fpgaimage.s19\n", argv[0]);
+}

 
 

-       fprintf(stderr,"Waiting for Proxmark to reappear on USB...\n");
-       while(!(devh=OpenProxmark(0))) { sleep(1); }
-       fprintf(stderr,"Found...\n");
+/* On first call, have *offset = -1, *length = 0; */
+static int find_next_area(const char *str, int *offset, int *length)
+{
+       if(*str == '\0') return 0;
+       if((*offset >= 0) && str[*offset + *length] == '\0') return 0;
+       *offset += 1 + *length;
+       
+       char *next_comma = strchr(str + *offset, ',');
+       if(next_comma == NULL) {
+               *length = strlen(str) - *offset;
+       } else {
+               *length = next_comma-(str+*offset);
+       }
+       return 1;
+}

 
 

-       LoadFlashFromSRecords(argv[2], addr);
+int main(int argc, char **argv) {
+       if(argc < 2) {
+               usage(argv);
+               exit(-1);
+       }
+       
+       /* Count area arguments */
+       int areas = 0, offset=-1, length=0;
+       while(find_next_area(argv[1], &offset, &length)) areas++;
+       
+       if(areas != argc - 2) {
+               usage(argv);
+               exit(-1);
+       }
+       
+       usb_init();

 
 

+       fprintf(stderr,"Waiting for Proxmark to appear on USB... ");
+       while(!(devh=OpenProxmark(0))) { sleep(1); }
+       fprintf(stderr,"Found.\n");
+       
+       unsigned int state = EnterFlashState();
+       
+       if( !(state & DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM) ) {
+               fprintf(stderr, "Proxmark would not enter flash state, abort\n");
+               exit(-1);
+       }
+       
+       offset=-1; length=0;
+       int current_area = 0;
+       while(find_next_area(argv[1], &offset, &length)) {
+               int i;
+               struct partition *p = NULL;
+               for(i=0; i<sizeof(partitions)/sizeof(partitions[0]); i++) {
+                       if(strncmp(partitions[i].name, argv[1] + offset, length) == 0) {
+                               /* Check if the name matches the bootrom partition, and if so, require "bootrom" to
+                                * be written in full. The other names may be abbreviated.
+                                */
+                               if(!partitions[i].precious || (strlen(partitions[i].name) == length)) {
+                                       p = &partitions[i];
+                               }
+                               break;
+                       }
+               }
+               
+               if(p == NULL) {
+                       fprintf(stderr, "Warning: area name '");
+                       fwrite(argv[1]+offset, length, 1, stderr);
+                       fprintf(stderr, "' unknown, ignored\n");
+               } else {
+                       fprintf(stderr, "Flashing %s from %s\n", p->name, argv[2+current_area]);
+                       PrepareFlash(p, argv[2+current_area], state);
+               }
+               current_area++;
+       }
+       
+       UsbCommand c;

        bzero(&c, sizeof(c));
        c.cmd = CMD_HARDWARE_RESET;
        SendCommand(&c, FALSE);
        bzero(&c, sizeof(c));
        c.cmd = CMD_HARDWARE_RESET;
        SendCommand(&c, FALSE);