git.rot13.org Git - goodfet/blob - firmware/apps/chipcon/chipcon.c

   1 /*! \file chipcon.c
   2   \author Travis Goodspeed
   3   \brief Chipcon 8051 debugging.
   4 */
   5
   6
   7 //This is like SPI, except that you read or write, not both.
   8
   9 /* N.B. The READ verb performs a write of all (any) supplied data,
  10    then reads a single byte reply from the target.  The WRITE verb
  11    only writes.
  12 */
  13
  14 #include "platform.h"
  15 #include "command.h"
  16 #include "chipcon.h"
  17
  18 #include <signal.h>
  19 #include <io.h>
  20 #include <iomacros.h>
  21
  22
  23 /* Concerning clock rates, the maximimum clock rates are defined on
  24    page 4 of the spec.  They vary, but are roughly 30MHz.  Raising
  25    this clock rate might allow for clock glitching, but the GoodFET
  26    isn't sufficient fast for that.  Perhaps a 200MHz ARM or an FPGA in
  27    the BadassFET?
  28 */
  29
  30 //Pins and I/O
  31 //MISO and MOSI are the same pin, direction changes.
  32 #define RST  BIT0
  33 #define MOSI BIT2
  34 #define MISO BIT2
  35 #define SCK  BIT3
  36
  37 //This could be more accurate.
  38 //Does it ever need to be?
  39 #define CCSPEED 3
  40 #define CCDELAY(x) delay(x)
  41
  42 #define SETMOSI P5OUT|=MOSI
  43 #define CLRMOSI P5OUT&=~MOSI
  44 #define SETCLK P5OUT|=SCK
  45 #define CLRCLK P5OUT&=~SCK
  46 #define READMISO (P5IN&MISO?1:0)
  47
  48 #define CCWRITE P5DIR|=MOSI
  49 #define CCREAD P5DIR&=~MISO
  50
  51 //! Set up the pins for CC mode.  Does not init debugger.
  52 void ccsetup(){
  53   P5OUT|=MOSI+SCK+RST;
  54   P5DIR|=MOSI+SCK+RST;
  55   //P5DIR&=~MISO;  //MOSI is MISO
  56 }
  57
  58 //! Initialize the debugger
  59 void ccdebuginit(){
  60   //Two positive debug clock pulses while !RST is low.
  61   //Take RST low, pulse twice, then high.
  62   P5OUT&=~SCK;
  63   P5OUT&=~RST;
  64
  65   //pulse twice
  66   CCDELAY(CCSPEED);
  67   P5OUT|=SCK;  //up
  68   CCDELAY(CCSPEED);
  69   P5OUT&=~SCK; //down
  70   CCDELAY(CCSPEED);
  71   P5OUT|=SCK;  //up
  72   CCDELAY(CCSPEED);
  73   P5OUT&=~SCK; //down
  74
  75   //Raise !RST.
  76   P5OUT|=RST;
  77 }
  78
  79 //! Read and write a CC bit.
  80 unsigned char cctrans8(unsigned char byte){
  81   unsigned int bit;
  82   //This function came from the SPI Wikipedia article.
  83   //Minor alterations.
  84
  85   for (bit = 0; bit < 8; bit++) {
  86     /* write MOSI on trailing edge of previous clock */
  87     if (byte & 0x80)
  88       SETMOSI;
  89     else
  90       CLRMOSI;
  91     byte <<= 1;
  92
  93     /* half a clock cycle before leading/rising edge */
  94     CCDELAY(CCSPEED/2);
  95     SETCLK;
  96
  97     /* half a clock cycle before trailing/falling edge */
  98     CCDELAY(CCSPEED/2);
  99
 100     /* read MISO on trailing edge */
 101     byte |= READMISO;
 102     CLRCLK;
 103   }
 104
 105   return byte;
 106 }
 107
 108 //! Send a command from txbytes.
 109 void cccmd(unsigned char len){
 110   unsigned char i;
 111   CCWRITE;
 112   for(i=0;i<len;i++)
 113     cctrans8(cmddata[i]);
 114 }
 115
 116 //! Fetch a reply, usually 1 byte.
 117 void ccread(unsigned char len){
 118   unsigned char i;
 119   CCREAD;
 120   for(i=0;i<len;i++)
 121     cmddata[i]=cctrans8(0);
 122 }
 123
 124 //! Handles a monitor command.
 125 void cchandle(unsigned char app,
 126                unsigned char verb,
 127                unsigned long len){
 128   //Always init.  Might help with buggy lines.
 129   //Might hurt too.
 130   //ccdebuginit();
 131   long i;
 132
 133   switch(verb){
 134     //CC_PEEK and CC_POKE will come later.
 135   case PEEK:
 136     cmddata[0]=cc_peekirambyte(cmddata[0]);
 137     txdata(app,verb,1);
 138     break;
 139   case POKE:
 140     cmddata[0]=cc_pokeirambyte(cmddata[0],cmddata[1]);
 141     txdata(app,verb,0);
 142     break;
 143   case READ:  //Write a command and return 1-byte reply.
 144     cccmd(len);
 145     if(cmddata[0]&0x4)
 146       ccread(1);
 147     txdata(app,verb,1);
 148
 149     break;
 150   case WRITE: //Write a command with no reply.
 151     cccmd(len);
 152     txdata(app,verb,0);
 153     break;
 154   case START://enter debugger
 155     ccsetup();
 156     ccdebuginit();
 157     txdata(app,verb,0);
 158     break;
 159   case STOP://exit debugger
 160     //Take RST low, then high.
 161     P5OUT&=~RST;
 162     CCDELAY(CCSPEED);
 163     P5OUT|=RST;
 164     txdata(app,verb,0);
 165     break;
 166   case SETUP:
 167     ccsetup();
 168     txdata(app,verb,0);
 169     break;
 170
 171   //Micro commands!
 172   case CC_CHIP_ERASE:
 173     cc_chip_erase();
 174     txdata(app,verb,1);
 175     break;
 176   case CC_WR_CONFIG:
 177     cc_wr_config(cmddata[0]);
 178     txdata(app,verb,1);
 179     break;
 180   case CC_RD_CONFIG:
 181     cc_rd_config();
 182     txdata(app,verb,1);
 183     break;
 184   case CC_GET_PC:
 185     cc_get_pc();
 186     txdata(app,verb,2);
 187     break;
 188   case CC_LOCKCHIP:
 189     cc_lockchip();
 190     //no break, return status
 191   case CC_READ_STATUS:
 192     cc_read_status();
 193     txdata(app,verb,1);
 194     break;
 195   case CC_SET_HW_BRKPNT:
 196     cc_set_hw_brkpnt(cmddataword[0]);
 197     txdata(app,verb,1);
 198     break;
 199   case CC_HALT:
 200     cc_halt();
 201     txdata(app,verb,1);
 202     break;
 203   case CC_RESUME:
 204     cc_resume();
 205     txdata(app,verb,1);
 206     break;
 207   case CC_DEBUG_INSTR:
 208     cc_debug_instr(len);
 209     txdata(app,verb,1);
 210     break;
 211   case CC_STEP_INSTR:
 212     cc_step_instr();
 213     txdata(app,verb,1);
 214     break;
 215   case CC_STEP_REPLACE:
 216     txdata(app,NOK,0);//TODO add me
 217     break;
 218   case CC_GET_CHIP_ID:
 219     cc_get_chip_id();
 220     txdata(app,verb,2);
 221     break;
 222
 223
 224   //Macro commands
 225   case CC_READ_CODE_MEMORY:
 226     cmddata[0]=cc_peekcodebyte(cmddataword[0]);
 227     txdata(app,verb,1);
 228     break;
 229   case CC_READ_XDATA_MEMORY:
 230     cmddata[0]=cc_peekdatabyte(cmddataword[0]);
 231     txdata(app,verb,1);
 232     break;
 233   case CC_WRITE_XDATA_MEMORY:
 234     cmddata[0]=cc_pokedatabyte(cmddataword[0], cmddata[2]);
 235     txdata(app,verb,1);
 236     break;
 237   case CC_SET_PC:
 238     cc_set_pc(cmddatalong[0]);
 239     txdata(app,verb,0);
 240     break;
 241   case CC_WRITE_FLASH_PAGE:
 242     cc_write_flash_page(cmddatalong[0]);
 243     txdata(app,verb,0);
 244     break;
 245   case CC_WIPEFLASHBUFFER:
 246     for(i=0xf000;i<0xf800;i++)
 247       cc_pokedatabyte(i,0xFF);
 248     txdata(app,verb,0);
 249     break;
 250   case CC_MASS_ERASE_FLASH:
 251   case CC_CLOCK_INIT:
 252   case CC_PROGRAM_FLASH:
 253     debugstr("This Chipcon command is not yet implemented.");
 254     txdata(app,NOK,0);//TODO implement me.
 255     break;
 256   }
 257 }
 258
 259 //! Set the Chipcon's Program Counter
 260 void cc_set_pc(u32 adr){
 261   cmddata[0]=0x02;             //SetPC
 262   cmddata[1]=((adr>>8)&0xff);  //HIBYTE
 263   cmddata[2]=adr&0xff;         //LOBYTE
 264   cc_debug_instr(3);
 265   return;
 266 }
 267
 268 //! Erase all of a Chipcon's memory.
 269 void cc_chip_erase(){
 270   cmddata[0]=CCCMD_CHIP_ERASE; //0x14
 271   cccmd(1);
 272   ccread(1);
 273 }
 274 //! Write the configuration byte.
 275 void cc_wr_config(unsigned char config){
 276   cmddata[0]=CCCMD_WR_CONFIG; //0x1D
 277   cmddata[1]=config;
 278   cccmd(2);
 279   ccread(1);
 280 }
 281
 282 //! Locks the chip.
 283 void cc_lockchip(){
 284   register int i;
 285
 286   debugstr("Locking chip.");
 287   cc_wr_config(1);//Select Info Flash
 288   if(!(cc_rd_config()&1))
 289     debugstr("Config forgotten!");
 290
 291   //Clear config page.
 292   for(i=0;i<2048;i++)
 293     cc_pokedatabyte(0xf000+i,0);
 294   cc_write_flash_page(0);
 295   if(cc_peekcodebyte(0))
 296     debugstr("Failed to clear info flash byte.");
 297
 298   cc_wr_config(0);
 299   if(cc_rd_config()&1)
 300     debugstr("Stuck in info flash mode!");
 301 }
 302
 303 //! Read the configuration byte.
 304 unsigned char cc_rd_config(){
 305   cmddata[0]=CCCMD_RD_CONFIG; //0x24
 306   cccmd(1);
 307   ccread(1);
 308   return cmddata[0];
 309 }
 310
 311
 312 //! Read the status register
 313 unsigned char cc_read_status(){
 314   cmddata[0]=CCCMD_READ_STATUS; //0x3f
 315   cccmd(1);
 316   ccread(1);
 317   return cmddata[0];
 318 }
 319
 320 //! Read the CHIP ID bytes.
 321 unsigned short cc_get_chip_id(){
 322   unsigned short toret;
 323   cmddata[0]=CCCMD_GET_CHIP_ID; //0x68
 324   cccmd(1);
 325   ccread(2);
 326
 327   //Return the word.
 328   toret=cmddata[1];
 329   toret=(toret<<8)+cmddata[1];
 330   return toret;
 331 }
 332
 333 //! Populates flash buffer in xdata.
 334 void cc_write_flash_buffer(u8 *data, u16 len){
 335   cc_write_xdata(0xf000, data, len);
 336 }
 337 //! Populates flash buffer in xdata.
 338 void cc_write_xdata(u16 adr, u8 *data, u16 len){
 339   u16 i;
 340   for(i=0; i<len; i++){
 341     cc_pokedatabyte(adr+i,
 342                     data[i]);
 343   }
 344 }
 345
 346
 347 //32-bit words, 2KB pages
 348 #define HIBYTE_WORDS_PER_FLASH_PAGE 0x02
 349 #define LOBYTE_WORDS_PER_FLASH_PAGE 0x00
 350 #define FLASHPAGE_SIZE 0x800
 351
 352 //32 bit words
 353 #define FLASH_WORD_SIZE 0x4
 354
 355 const u8 flash_routine[] = {
 356   //MOV FADDRH, #imm;
 357   0x75, 0xAD,
 358   0x00,//#imm=((address >> 8) / FLASH_WORD_SIZE) & 0x7E,
 359
 360   0x75, 0xAC, 0x00,                                          //                 MOV FADDRL, #00;
 361   /* Erase page. */
 362   0x75, 0xAE, 0x01,                                          //                 MOV FLC, #01H; // ERASE
 363                                                              //                 ; Wait for flash erase to complete
 364   0xE5, 0xAE,                                                // eraseWaitLoop:  MOV A, FLC;
 365   0x20, 0xE7, 0xFB,                                          //                 JB ACC_BUSY, eraseWaitLoop;
 366   /* End erase page. */
 367                                                              //                 ; Initialize the data pointer
 368   0x90, 0xF0, 0x00,                                          //                 MOV DPTR, #0F000H;
 369                                                              //                 ; Outer loops
 370   0x7F, HIBYTE_WORDS_PER_FLASH_PAGE,                         //                 MOV R7, #imm;
 371   0x7E, LOBYTE_WORDS_PER_FLASH_PAGE,                         //                 MOV R6, #imm;
 372   0x75, 0xAE, 0x02,                                          //                 MOV FLC, #02H; // WRITE
 373                                                              //                     ; Inner loops
 374   0x7D, FLASH_WORD_SIZE,                                     // writeLoop:          MOV R5, #imm;
 375   0xE0,                                                      // writeWordLoop:          MOVX A, @DPTR;
 376   0xA3,                                                      //                         INC DPTR;
 377   0xF5, 0xAF,                                                //                         MOV FWDATA, A;
 378   0xDD, 0xFA,                                                //                     DJNZ R5, writeWordLoop;
 379                                                              //                     ; Wait for completion
 380   0xE5, 0xAE,                                                // writeWaitLoop:      MOV A, FLC;
 381   0x20, 0xE6, 0xFB,                                          //                     JB ACC_SWBSY, writeWaitLoop;
 382   0xDE, 0xF1,                                                //                 DJNZ R6, writeLoop;
 383   0xDF, 0xEF,                                                //                 DJNZ R7, writeLoop;
 384                                                              //                 ; Done, fake a breakpoint
 385   0xA5                                                       //                 DB 0xA5;
 386 };
 387
 388
 389 //! Copies flash buffer to flash.
 390 void cc_write_flash_page(u32 adr){
 391   //Assumes that page has already been written to XDATA 0xF000
 392   //debugstr("Flashing 2kb at 0xF000 to given adr.");
 393
 394   if(adr&(FLASHPAGE_SIZE-1)){
 395     debugstr("Flash page address is not on a multiple of 2kB.  Aborting.");
 396     return;
 397   }
 398
 399   //Routine comes next
 400   //WRITE_XDATA_MEMORY(IN: 0xF000 + FLASH_PAGE_SIZE, sizeof(routine), routine);
 401   cc_write_xdata(0xF000+FLASHPAGE_SIZE,
 402                  (u8*) flash_routine, sizeof(flash_routine));
 403   //Patch routine's third byte with
 404   //((address >> 8) / FLASH_WORD_SIZE) & 0x7E
 405   cc_pokedatabyte(0xF000+FLASHPAGE_SIZE+2,
 406                   ((adr>>8)/FLASH_WORD_SIZE)&0x7E);
 407   //debugstr("Wrote flash routine.");
 408
 409
 410   //MOV MEMCTR, (bank * 16) + 1;
 411   cmddata[0]=0x75;
 412   cmddata[1]=0xc7;
 413   cmddata[2]=0x51;
 414   cc_debug_instr(3);
 415   debugstr("Loaded bank info.");
 416
 417   cc_set_pc(0xf000+FLASHPAGE_SIZE);//execute code fragment
 418   cc_resume();
 419
 420   debugstr("Executing.");
 421
 422
 423   while(!(cc_read_status()&CC_STATUS_CPUHALTED)){
 424     P1OUT^=1;//blink LED while flashing
 425   }
 426
 427
 428   debugstr("Done flashing.");
 429
 430   P1OUT&=~1;//clear LED
 431 }
 432
 433 //! Read the PC
 434 unsigned short cc_get_pc(){
 435   cmddata[0]=CCCMD_GET_PC; //0x28
 436   cccmd(1);
 437   ccread(2);
 438
 439   //Return the word.
 440   return cmddataword[0];
 441 }
 442
 443 //! Set a hardware breakpoint.
 444 void cc_set_hw_brkpnt(unsigned short adr){
 445   debugstr("FIXME: This certainly won't work.");
 446   cmddataword[0]=adr;
 447   cccmd(2);
 448   ccread(1);
 449   return;
 450 }
 451
 452
 453 //! Halt the CPU.
 454 void cc_halt(){
 455   cmddata[0]=CCCMD_HALT; //0x44
 456   cccmd(1);
 457   ccread(1);
 458   return;
 459 }
 460 //! Resume the CPU.
 461 void cc_resume(){
 462   cmddata[0]=CCCMD_RESUME; //0x4C
 463   cccmd(1);
 464   ccread(1);
 465   return;
 466 }
 467
 468
 469 //! Step an instruction
 470 void cc_step_instr(){
 471   cmddata[0]=CCCMD_STEP_INSTR; //0x5C
 472   cccmd(1);
 473   ccread(1);
 474   return;
 475 }
 476
 477 //! Debug an instruction.
 478 void cc_debug_instr(unsigned char len){
 479   //Bottom two bits of command indicate length.
 480   unsigned char cmd=CCCMD_DEBUG_INSTR+(len&0x3); //0x54+len
 481   CCWRITE;
 482   cctrans8(cmd);  //Second command code
 483   cccmd(len&0x3); //Command itself.
 484   ccread(1);
 485   return;
 486 }
 487
 488 //! Debug an instruction, for local use.
 489 unsigned char cc_debug(unsigned char len,
 490               unsigned char a,
 491               unsigned char b,
 492               unsigned char c){
 493   unsigned char cmd=CCCMD_DEBUG_INSTR+(len&0x3);//0x54+len
 494   CCWRITE;
 495   cctrans8(cmd);
 496   if(len>0)
 497     cctrans8(a);
 498   if(len>1)
 499     cctrans8(b);
 500   if(len>2)
 501     cctrans8(c);
 502   CCREAD;
 503   return cctrans8(0x00);
 504 }
 505
 506 //! Fetch a byte of code memory.
 507 unsigned char cc_peekcodebyte(unsigned long adr){
 508   /** See page 9 of SWRA124 */
 509   unsigned char bank=adr>>15,
 510     lb=adr&0xFF,
 511     hb=(adr>>8)&0x7F,
 512     toret=0;
 513   adr&=0x7FFF;
 514
 515   //MOV MEMCTR, (bank*16)+1
 516   cc_debug(3, 0x75, 0xC7, (bank<<4) + 1);
 517   //MOV DPTR, address
 518   cc_debug(3, 0x90, hb, lb);
 519
 520   //for each byte
 521   //CLR A
 522   cc_debug(2, 0xE4, 0, 0);
 523   //MOVC A, @A+DPTR;
 524   toret=cc_debug(3, 0x93, 0, 0);
 525   //INC DPTR
 526   //cc_debug(1, 0xA3, 0, 0);
 527
 528   return toret;
 529 }
 530
 531
 532 //! Set a byte of data memory.
 533 unsigned char cc_pokedatabyte(unsigned int adr,
 534                            unsigned char val){
 535   unsigned char
 536     hb=(adr&0xFF00)>>8,
 537     lb=adr&0xFF;
 538
 539   //MOV DPTR, adr
 540   cc_debug(3, 0x90, hb, lb);
 541   //MOV A, val
 542   cc_debug(2, 0x74, val, 0);
 543   //MOVX @DPTR, A
 544   cc_debug(1, 0xF0, 0, 0);
 545
 546   return 0;
 547   /*
 548 DEBUG_INSTR(IN: 0x90, HIBYTE(address), LOBYTE(address), OUT: Discard);
 549 for (n = 0; n < count; n++) {
 550     DEBUG_INSTR(IN: 0x74, inputArray[n], OUT: Discard);
 551     DEBUG_INSTR(IN: 0xF0, OUT: Discard);
 552     DEBUG_INSTR(IN: 0xA3, OUT: Discard);
 553 }
 554    */
 555 }
 556
 557 //! Fetch a byte of data memory.
 558 unsigned char cc_peekdatabyte(unsigned int adr){
 559   unsigned char
 560     hb=(adr&0xFF00)>>8,
 561     lb=adr&0xFF;
 562
 563   //MOV DPTR, adr
 564   cc_debug(3, 0x90, hb, lb);
 565   //MOVX A, @DPTR
 566   //Must be 2, perhaps for clocking?
 567   return cc_debug(3, 0xE0, 0, 0);
 568 }
 569
 570
 571 //! Fetch a byte of IRAM.
 572 u8 cc_peekirambyte(u8 adr){
 573   //CLR A
 574   cc_debug(2, 0xE4, 0, 0);
 575   //MOV A, #iram
 576   return cc_debug(3, 0xE5, adr, 0);
 577 }
 578
 579 //! Write a byte of IRAM.
 580 u8 cc_pokeirambyte(u8 adr, u8 val){
 581   //CLR A
 582   cc_debug(2, 0xE4, 0, 0);
 583   //MOV #iram, #val
 584   return cc_debug(3, 0x75, adr, val);
 585   //return cc_debug(3, 0x75, val, adr);
 586 }
 587
 588