2 \author Travis Goodspeed
3 \brief Chipcon 8051 debugging.
7 //This is like SPI, except that you read or write, not both.
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
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
31 //MISO and MOSI are the same pin, direction changes.
37 //This could be more accurate.
38 //Does it ever need to be?
40 #define CCDELAY(x) delay(x)
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)
48 #define CCWRITE P5DIR|=MOSI
49 #define CCREAD P5DIR&=~MISO
51 //! Set up the pins for CC mode. Does not init debugger.
55 //P5DIR&=~MISO; //MOSI is MISO
58 //! Initialize the debugger
60 //Two positive debug clock pulses while !RST is low.
61 //Take RST low, pulse twice, then high.
79 //! Read and write a CC bit.
80 unsigned char cctrans8(unsigned char byte){
82 //This function came from the SPI Wikipedia article.
85 for (bit = 0; bit < 8; bit++) {
86 /* write MOSI on trailing edge of previous clock */
93 /* half a clock cycle before leading/rising edge */
97 /* half a clock cycle before trailing/falling edge */
100 /* read MISO on trailing edge */
108 //! Send a command from txbytes.
109 void cccmd(unsigned char len){
113 cctrans8(cmddata[i]);
116 //! Fetch a reply, usually 1 byte.
117 void ccread(unsigned char len){
121 cmddata[i]=cctrans8(0);
124 //! Handles a monitor command.
125 void cchandle(unsigned char app,
128 //Always init. Might help with buggy lines.
134 //CC_PEEK and CC_POKE will come later.
135 case READ: //Write a command and return 1-byte reply.
140 case WRITE: //Write a command with no reply.
144 case START://enter debugger
148 case STOP://exit debugger
149 //Take RST low, then high.
166 cc_wr_config(cmddata[0]);
179 //no break, return status
184 case CC_SET_HW_BRKPNT:
185 cc_set_hw_brkpnt(cmddataword[0]);
204 case CC_STEP_REPLACE:
205 txdata(app,NOK,0);//TODO add me
214 case CC_READ_CODE_MEMORY:
215 cmddata[0]=cc_peekcodebyte(cmddataword[0]);
218 case CC_READ_XDATA_MEMORY:
219 cmddata[0]=cc_peekdatabyte(cmddataword[0]);
222 case CC_WRITE_XDATA_MEMORY:
223 cmddata[0]=cc_pokedatabyte(cmddataword[0], cmddata[2]);
227 cc_set_pc(cmddatalong[0]);
230 case CC_WRITE_FLASH_PAGE:
231 cc_write_flash_page(cmddatalong[0]);
234 case CC_WIPEFLASHBUFFER:
235 for(i=0xf000;i<0xf800;i++)
236 cc_pokedatabyte(i,0xFF);
239 case CC_MASS_ERASE_FLASH:
241 case CC_PROGRAM_FLASH:
242 debugstr("This Chipcon command is not yet implemented.");
243 txdata(app,NOK,0);//TODO implement me.
248 //! Set the Chipcon's Program Counter
249 void cc_set_pc(u32 adr){
250 cmddata[0]=0x02; //SetPC
251 cmddata[1]=((adr>>8)&0xff); //HIBYTE
252 cmddata[2]=adr&0xff; //LOBYTE
257 //! Erase all of a Chipcon's memory.
258 void cc_chip_erase(){
259 cmddata[0]=CCCMD_CHIP_ERASE; //0x14
263 //! Write the configuration byte.
264 void cc_wr_config(unsigned char config){
265 cmddata[0]=CCCMD_WR_CONFIG; //0x1D
270 //! Read the configuration byte.
271 unsigned char cc_rd_config(){
272 cmddata[0]=CCCMD_RD_CONFIG; //0x24
279 //! Read the status register
280 unsigned char cc_read_status(){
281 cmddata[0]=CCCMD_READ_STATUS; //0x3f
287 //! Read the CHIP ID bytes.
288 unsigned short cc_get_chip_id(){
289 unsigned short toret;
290 cmddata[0]=CCCMD_GET_CHIP_ID; //0x68
296 toret=(toret<<8)+cmddata[1];
300 //! Populates flash buffer in xdata.
301 void cc_write_flash_buffer(u8 *data, u16 len){
302 cc_write_xdata(0xf000, data, len);
304 //! Populates flash buffer in xdata.
305 void cc_write_xdata(u16 adr, u8 *data, u16 len){
307 for(i=0; i<len; i++){
308 cc_pokedatabyte(adr+i,
314 //32-bit words, 2KB pages
315 #define HIBYTE_WORDS_PER_FLASH_PAGE 0x02
316 #define LOBYTE_WORDS_PER_FLASH_PAGE 0x00
317 #define FLASHPAGE_SIZE 0x800
320 #define FLASH_WORD_SIZE 0x4
322 const u8 flash_routine[] = {
325 0x00,//#imm=((address >> 8) / FLASH_WORD_SIZE) & 0x7E,
327 0x75, 0xAC, 0x00, // MOV FADDRL, #00;
329 0x75, 0xAE, 0x01, // MOV FLC, #01H; // ERASE
330 // ; Wait for flash erase to complete
331 0xE5, 0xAE, // eraseWaitLoop: MOV A, FLC;
332 0x20, 0xE7, 0xFB, // JB ACC_BUSY, eraseWaitLoop;
333 /* End erase page. */
334 // ; Initialize the data pointer
335 0x90, 0xF0, 0x00, // MOV DPTR, #0F000H;
337 0x7F, HIBYTE_WORDS_PER_FLASH_PAGE, // MOV R7, #imm;
338 0x7E, LOBYTE_WORDS_PER_FLASH_PAGE, // MOV R6, #imm;
339 0x75, 0xAE, 0x02, // MOV FLC, #02H; // WRITE
341 0x7D, FLASH_WORD_SIZE, // writeLoop: MOV R5, #imm;
342 0xE0, // writeWordLoop: MOVX A, @DPTR;
344 0xF5, 0xAF, // MOV FWDATA, A;
345 0xDD, 0xFA, // DJNZ R5, writeWordLoop;
346 // ; Wait for completion
347 0xE5, 0xAE, // writeWaitLoop: MOV A, FLC;
348 0x20, 0xE6, 0xFB, // JB ACC_SWBSY, writeWaitLoop;
349 0xDE, 0xF1, // DJNZ R6, writeLoop;
350 0xDF, 0xEF, // DJNZ R7, writeLoop;
351 // ; Done, fake a breakpoint
358 debugstr("Locking chip.");
359 cc_wr_config(1);//Select Info Flash
360 cc_debug(3, 0x75, 0xAF, 0x00);//MOV FWDATA, #00H
361 //cc_debug(2, 0xF5, 0xAF, 0); //MOV FWDATA, A
365 //! Copies flash buffer to flash.
366 void cc_write_flash_page(u32 adr){
367 //Assumes that page has already been written to XDATA 0xF000
368 //debugstr("Flashing 2kb at 0xF000 to given adr.");
370 if(adr&(FLASHPAGE_SIZE-1)){
371 debugstr("Flash page address is not on a multiple of 2kB. Aborting.");
376 //WRITE_XDATA_MEMORY(IN: 0xF000 + FLASH_PAGE_SIZE, sizeof(routine), routine);
377 cc_write_xdata(0xF000+FLASHPAGE_SIZE,
378 (u8*) flash_routine, sizeof(flash_routine));
379 //Patch routine's third byte with
380 //((address >> 8) / FLASH_WORD_SIZE) & 0x7E
381 cc_pokedatabyte(0xF000+FLASHPAGE_SIZE+2,
382 ((adr>>8)/FLASH_WORD_SIZE)&0x7E);
383 //debugstr("Wrote flash routine.");
386 //MOV MEMCTR, (bank * 16) + 1;
391 //debugstr("Loaded bank info.");
393 cc_set_pc(0xf000+FLASHPAGE_SIZE);//execute code fragment
395 //debugstr("Executing.");
398 while(!(cc_read_status()&CC_STATUS_CPUHALTED)){
399 P1OUT^=1;//blink LED while flashing
402 //debugstr("Done flashing.");
404 P1OUT&=~1;//clear LED
408 unsigned short cc_get_pc(){
409 cmddata[0]=CCCMD_GET_PC; //0x28
414 return cmddataword[0];
417 //! Set a hardware breakpoint.
418 void cc_set_hw_brkpnt(unsigned short adr){
419 debugstr("FIXME: This certainly won't work.");
429 cmddata[0]=CCCMD_HALT; //0x44
436 cmddata[0]=CCCMD_RESUME; //0x4C
443 //! Step an instruction
444 void cc_step_instr(){
445 cmddata[0]=CCCMD_STEP_INSTR; //0x5C
451 //! Debug an instruction.
452 void cc_debug_instr(unsigned char len){
453 //Bottom two bits of command indicate length.
454 unsigned char cmd=CCCMD_DEBUG_INSTR+(len&0x3); //0x54+len
456 cctrans8(cmd); //Second command code
457 cccmd(len&0x3); //Command itself.
462 //! Debug an instruction, for local use.
463 unsigned char cc_debug(unsigned char len,
467 unsigned char cmd=CCCMD_DEBUG_INSTR+(len&0x3);//0x54+len
477 return cctrans8(0x00);
480 //! Fetch a byte of code memory.
481 unsigned char cc_peekcodebyte(unsigned long adr){
482 /** See page 9 of SWRA124 */
483 unsigned char bank=adr>>15,
489 //MOV MEMCTR, (bank*16)+1
490 cc_debug(3, 0x75, 0xC7, (bank<<4) + 1);
492 cc_debug(3, 0x90, hb, lb);
496 cc_debug(2, 0xE4, 0, 0);
498 toret=cc_debug(3, 0x93, 0, 0);
500 //cc_debug(1, 0xA3, 0, 0);
506 //! Set a byte of data memory.
507 unsigned char cc_pokedatabyte(unsigned int adr,
514 cc_debug(3, 0x90, hb, lb);
516 cc_debug(2, 0x74, val, 0);
518 cc_debug(1, 0xF0, 0, 0);
522 DEBUG_INSTR(IN: 0x90, HIBYTE(address), LOBYTE(address), OUT: Discard);
523 for (n = 0; n < count; n++) {
524 DEBUG_INSTR(IN: 0x74, inputArray[n], OUT: Discard);
525 DEBUG_INSTR(IN: 0xF0, OUT: Discard);
526 DEBUG_INSTR(IN: 0xA3, OUT: Discard);
531 //! Fetch a byte of data memory.
532 unsigned char cc_peekdatabyte(unsigned int adr){
539 cc_debug(3, 0x90, hb, lb);
541 //Must be 2, perhaps for clocking?
542 toret=cc_debug(3, 0xE0, 0, 0);
546 DEBUG_INSTR(IN: 0x90, HIBYTE(address), LOBYTE(address), OUT: Discard);
547 for (n = 0; n < count; n++) {
548 DEBUG_INSTR(IN: 0xE0, OUT: outputArray[n]);
549 DEBUG_INSTR(IN: 0xA3, OUT: Discard);