A major refactor of the GoodFET firmware build system and apps to give better
[goodfet] / firmware / apps / chipcon / chipcon.c
index 135d2a6..89f12b9 100644 (file)
 #include <io.h>
 #include <iomacros.h>
 
+//! Handles a chipcon command.
+void cc_handle_fn( uint8_t const app,
+                                  uint8_t const verb,
+                                  uint32_t const len);
+
+// define the jtag app's app_t
+app_t const chipcon_app = {
+
+       /* app number */
+       CHIPCON,
+
+       /* handle fn */
+       cc_handle_fn,
+
+       /* name */
+       "CHIPCON",
+
+       /* desc */
+       "\tThe CHIPCON app adds support for debugging the chipcon\n"
+       "\t8051 processor.\n"
+};
 
 /* Concerning clock rates, the maximimum clock rates are defined on
    page 4 of the spec.  They vary, but are roughly 30MHz.  Raising
 #define MISO BIT2
 #define SCK  BIT3
 
+
 //This could be more accurate.
 //Does it ever need to be?
 #define CCSPEED 3
 #define CCDELAY(x) delay(x)
+//#define CCDELAY(x) 
 
 #define SETMOSI P5OUT|=MOSI
 #define CLRMOSI P5OUT&=~MOSI
 void ccsetup(){
   P5OUT|=MOSI+SCK+RST;
   P5DIR|=MOSI+SCK+RST;
-  //P5DIR&=~MISO;  //MOSI is MISO
+  //P5REN=0xFF;
 }
 
+
+/* 33 cycle critical region
+0000000e <ccdebuginit>:
+   e:  f2 d0 0d 00     bis.b   #13,    &0x0031 ;5 cycles
+  12:  31 00 
+  14:  f2 c2 31 00     bic.b   #8,     &0x0031 ;4 cycles
+  18:  d2 c3 31 00     bic.b   #1,     &0x0031 ;4
+  1c:  f2 e2 31 00     xor.b   #8,     &0x0031 ;4
+  20:  f2 e2 31 00     xor.b   #8,     &0x0031 ;4
+  24:  f2 e2 31 00     xor.b   #8,     &0x0031 ;4
+  28:  f2 e2 31 00     xor.b   #8,     &0x0031 ;4
+  2c:  d2 d3 31 00     bis.b   #1,     &0x0031 ;4
+  30:  30 41           ret                     
+*/
+
+
 //! Initialize the debugger
 void ccdebuginit(){
+  //Port output BUT NOT DIRECTION is set at start.
+  P5OUT|=MOSI+SCK+RST;
+  
+  //delay(30); //So the beginning is ready for glitching.
+  
   //Two positive debug clock pulses while !RST is low.
   //Take RST low, pulse twice, then high.
   P5OUT&=~SCK;
+  delay(10);
   P5OUT&=~RST;
   
-  //pulse twice
-  CCDELAY(CCSPEED);
-  P5OUT|=SCK;  //up
-  CCDELAY(CCSPEED);
-  P5OUT&=~SCK; //down
-  CCDELAY(CCSPEED);
-  P5OUT|=SCK;  //up
-  CCDELAY(CCSPEED);
-  P5OUT&=~SCK; //down
+  delay(10);
+  
+  //Two rising edges.
+  P5OUT^=SCK; //up
+  delay(1);
+  P5OUT^=SCK; //down
+  delay(1);
+  P5OUT^=SCK; //up
+  delay(1);
+  P5OUT^=SCK; //Unnecessary.
+  delay(1);
+  //delay(0);
   
   //Raise !RST.
   P5OUT|=RST;
@@ -121,14 +169,16 @@ void ccread(unsigned char len){
     cmddata[i]=cctrans8(0);
 }
 
-//! Handles a monitor command.
-void cchandle(unsigned char app,
-              unsigned char verb,
-              unsigned long len){
+//! Handles a chipcon command.
+void cc_handle_fn( uint8_t const app,
+                                  uint8_t const verb,
+                                  uint32_t const len)
+{
   //Always init.  Might help with buggy lines.
   //Might hurt too.
   //ccdebuginit();
   long i;
+  int blocklen, blockadr;
   
   switch(verb){
     //CC_PEEK and CC_POKE will come later.
@@ -142,7 +192,8 @@ void cchandle(unsigned char app,
     break;
   case READ:  //Write a command and return 1-byte reply.
     cccmd(len);
-    ccread(1);
+    if(cmddata[0]&0x4)
+      ccread(1);
     txdata(app,verb,1);
     break;
   case WRITE: //Write a command with no reply.
@@ -150,7 +201,6 @@ void cchandle(unsigned char app,
     txdata(app,verb,0);
     break;
   case START://enter debugger
-    ccsetup();
     ccdebuginit();
     txdata(app,verb,0);
     break;
@@ -168,6 +218,7 @@ void cchandle(unsigned char app,
     
   //Micro commands!
   case CC_CHIP_ERASE:
+  case CC_MASS_ERASE_FLASH:
     cc_chip_erase();
     txdata(app,verb,1);
     break;
@@ -214,7 +265,7 @@ void cchandle(unsigned char app,
     txdata(app,NOK,0);//TODO add me
     break;
   case CC_GET_CHIP_ID:
-    cc_get_chip_id();
+    cmddataword[0]=cc_get_chip_id();
     txdata(app,verb,2);
     break;
 
@@ -225,9 +276,18 @@ void cchandle(unsigned char app,
     txdata(app,verb,1);
     break;
   case CC_READ_XDATA_MEMORY:
-    cmddata[0]=cc_peekdatabyte(cmddataword[0]);
-    txdata(app,verb,1);
+    //Read the length.
+    blocklen=1;
+    if(len>2)
+      blocklen=cmddataword[1];
+    blockadr=cmddataword[0];
+    
+    //Return that many bytes.
+    for(i=0;i<blocklen;i++)
+      cmddata[i]=cc_peekdatabyte(blockadr+i);
+    txdata(app,verb,blocklen);
     break;
+    
   case CC_WRITE_XDATA_MEMORY:
     cmddata[0]=cc_pokedatabyte(cmddataword[0], cmddata[2]);
     txdata(app,verb,1);
@@ -245,9 +305,10 @@ void cchandle(unsigned char app,
       cc_pokedatabyte(i,0xFF);
     txdata(app,verb,0);
     break;
-  case CC_MASS_ERASE_FLASH:
+  
   case CC_CLOCK_INIT:
   case CC_PROGRAM_FLASH:
+  default:
     debugstr("This Chipcon command is not yet implemented.");
     txdata(app,NOK,0);//TODO implement me.
     break;
@@ -281,7 +342,7 @@ void cc_wr_config(unsigned char config){
 void cc_lockchip(){
   register int i;
   
-  debugstr("Locking chip.");
+  //debugstr("Locking chip.");
   cc_wr_config(1);//Select Info Flash 
   if(!(cc_rd_config()&1))
     debugstr("Config forgotten!");
@@ -317,15 +378,33 @@ unsigned char cc_read_status(){
 
 //! Read the CHIP ID bytes.
 unsigned short cc_get_chip_id(){
-  unsigned short toret;
   cmddata[0]=CCCMD_GET_CHIP_ID; //0x68
   cccmd(1);
   ccread(2);
+
+  
+  //Find the flash word size.
+  switch(cmddata[0]){
+  case 0x01://CC1110
+  case 0x11://CC1111
+  case 0x81://CC2510
+  case 0x91://CC2511
+    //debugstr("2 bytes/flash word");
+    flash_word_size=0x02;
+    break;
+  default:
+    //debugstr("Warning: Guessing flash word size.");
+    //flash_word_size=0;
+    break;
+  case 0x85://CC2430
+  case 0x89://CC2431
+    //debugstr("4 bytes/flash word");
+    flash_word_size=0x04;
+    break;
+  }
   
   //Return the word.
-  toret=cmddata[1];
-  toret=(toret<<8)+cmddata[1];
-  return toret;
+  return cmddataword[0];
 }
 
 //! Populates flash buffer in xdata.
@@ -343,24 +422,50 @@ void cc_write_xdata(u16 adr, u8 *data, u16 len){
 
 
 //32-bit words, 2KB pages
+//0x20 0x00 for CC2430, CC1110
 #define HIBYTE_WORDS_PER_FLASH_PAGE 0x02
 #define LOBYTE_WORDS_PER_FLASH_PAGE 0x00
-#define FLASHPAGE_SIZE 0x800
 
-//32 bit words
-#define FLASH_WORD_SIZE 0x4
+/** Ugh, this varies by chip.
+    0x800 for CC2430
+    0x400 for CC1110
+*/
+//#define FLASHPAGE_SIZE 0x400
+#define MAXFLASHPAGE_SIZE 0x800
+#define MINFLASHPAGE_SIZE 0x400
+
+
+//32 bit words on CC2430
+//16 bit words on CC1110
+//#define FLASH_WORD_SIZE 0x2
+u8 flash_word_size = 0; //0x02;
+
+
+/* Flash Write Timing
+   MHZ | FWT (0xAB)
+   12  | 0x10
+   13  | 0x11
+   16  | 0x15
+   24  | 0x20
+   26  | 0x23  (IM ME)
+   32  | 0x2A  (Modula.si)
+*/
+//#define FWT 0x23
 
 const u8 flash_routine[] = {
+  //0:
   //MOV FADDRH, #imm; 
   0x75, 0xAD,
   0x00,//#imm=((address >> 8) / FLASH_WORD_SIZE) & 0x7E,
   
+  //0x75, 0xAB, 0x23, //Set FWT per clock
   0x75, 0xAC, 0x00,                                          //                 MOV FADDRL, #00; 
   /* Erase page. */
   0x75, 0xAE, 0x01,                                          //                 MOV FLC, #01H; // ERASE 
                                                              //                 ; Wait for flash erase to complete 
   0xE5, 0xAE,                                                // eraseWaitLoop:  MOV A, FLC; 
   0x20, 0xE7, 0xFB,                                          //                 JB ACC_BUSY, eraseWaitLoop; 
+  
   /* End erase page. */
                                                              //                 ; Initialize the data pointer 
   0x90, 0xF0, 0x00,                                          //                 MOV DPTR, #0F000H; 
@@ -369,7 +474,8 @@ const u8 flash_routine[] = {
   0x7E, LOBYTE_WORDS_PER_FLASH_PAGE,                         //                 MOV R6, #imm; 
   0x75, 0xAE, 0x02,                                          //                 MOV FLC, #02H; // WRITE 
                                                              //                     ; Inner loops 
-  0x7D, FLASH_WORD_SIZE,                                     // writeLoop:          MOV R5, #imm; 
+  //24:
+  0x7D, 0xde /*FLASH_WORD_SIZE*/,                                     // writeLoop:          MOV R5, #imm; 
   0xE0,                                                      // writeWordLoop:          MOVX A, @DPTR; 
   0xA3,                                                      //                         INC DPTR; 
   0xF5, 0xAF,                                                //                         MOV FWDATA, A;  
@@ -381,7 +487,7 @@ const u8 flash_routine[] = {
   0xDF, 0xEF,                                                //                 DJNZ R7, writeLoop; 
                                                              //                 ; Done, fake a breakpoint 
   0xA5                                                       //                 DB 0xA5; 
-}; 
+};
 
 
 //! Copies flash buffer to flash.
@@ -389,43 +495,54 @@ void cc_write_flash_page(u32 adr){
   //Assumes that page has already been written to XDATA 0xF000
   //debugstr("Flashing 2kb at 0xF000 to given adr.");
   
-  if(adr&(FLASHPAGE_SIZE-1)){
-    debugstr("Flash page address is not on a multiple of 2kB.  Aborting.");
+  if(adr&(MINFLASHPAGE_SIZE-1)){
+    debugstr("Flash page address is not on a page boundary.  Aborting.");
     return;
   }
   
+  if(flash_word_size!=2 && flash_word_size!=4){
+    debugstr("Flash word size is wrong, aborting write to");
+    debughex(adr);
+    while(1);
+  }
+  
   //Routine comes next
   //WRITE_XDATA_MEMORY(IN: 0xF000 + FLASH_PAGE_SIZE, sizeof(routine), routine);
-  cc_write_xdata(0xF000+FLASHPAGE_SIZE,
+  cc_write_xdata(0xF000+MAXFLASHPAGE_SIZE,
                 (u8*) flash_routine, sizeof(flash_routine));
   //Patch routine's third byte with
   //((address >> 8) / FLASH_WORD_SIZE) & 0x7E
-  cc_pokedatabyte(0xF000+FLASHPAGE_SIZE+2,
-                 ((adr>>8)/FLASH_WORD_SIZE)&0x7E);
-  //debugstr("Wrote flash routine.");
-  
+  cc_pokedatabyte(0xF000+MAXFLASHPAGE_SIZE+2,
+                 ((adr>>8)/flash_word_size)&0x7E);
+  //Patch routine to define FLASH_WORD_SIZE
+  if(flash_routine[25]!=0xde)
+    debugstr("Ugly patching code failing in chipcon.c");
+  cc_pokedatabyte(0xF000+MAXFLASHPAGE_SIZE+25,
+                 flash_word_size);
   
+  //debugstr("Wrote flash routine.");
+    
   //MOV MEMCTR, (bank * 16) + 1;
   cmddata[0]=0x75;
   cmddata[1]=0xc7;
   cmddata[2]=0x51;
   cc_debug_instr(3);
-  debugstr("Loaded bank info.");
+  //debugstr("Loaded bank info.");
   
-  cc_set_pc(0xf000+FLASHPAGE_SIZE);//execute code fragment
+  cc_set_pc(0xf000+MAXFLASHPAGE_SIZE);//execute code fragment
   cc_resume();
   
-  debugstr("Executing.");
+  //debugstr("Executing.");
   
   
   while(!(cc_read_status()&CC_STATUS_CPUHALTED)){
-    P1OUT^=1;//blink LED while flashing
+    PLEDOUT^=PLEDPIN;//blink LED while flashing    
   }
   
   
-  debugstr("Done flashing.");
+  //debugstr("Done flashing.");
   
-  P1OUT&=~1;//clear LED
+  PLEDOUT&=~PLEDPIN;//clear LED
 }
 
 //! Read the PC