bytes/flash warning no longer needed.
[goodfet] / 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     cmddataword[0]=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   
328   //Find the flash word size.
329   switch(cmddata[0]){
330   case 0x01://CC1110
331   case 0x81://CC2510
332   case 0x91://CC2511
333     flash_word_size=0x02;
334     //debugstr("2 bytes/flash word");
335     break;
336   default:
337     debugstr("Warning: Guessing flash word size.");
338   case 0x85://CC2430
339   case 0x89://CC2431
340     //debugstr("4 bytes/flash word");
341     flash_word_size=0x04;
342     break;
343   }
344   
345   //Return the word.
346   return cmddataword[0];
347 }
348
349 //! Populates flash buffer in xdata.
350 void cc_write_flash_buffer(u8 *data, u16 len){
351   cc_write_xdata(0xf000, data, len);
352 }
353 //! Populates flash buffer in xdata.
354 void cc_write_xdata(u16 adr, u8 *data, u16 len){
355   u16 i;
356   for(i=0; i<len; i++){
357     cc_pokedatabyte(adr+i,
358                     data[i]);
359   }
360 }
361
362
363 //32-bit words, 2KB pages
364 //0x20 0x00 for CC2430, CC1110
365 #define HIBYTE_WORDS_PER_FLASH_PAGE 0x02
366 #define LOBYTE_WORDS_PER_FLASH_PAGE 0x00
367
368 /** Ugh, this varies by chip.
369     0x800 for CC2430
370     0x400 for CC1110
371 */
372 //#define FLASHPAGE_SIZE 0x400
373 #define MAXFLASHPAGE_SIZE 0x800
374 #define MINFLASHPAGE_SIZE 0x400
375
376
377 //32 bit words on CC2430
378 //16 bit words on CC1110
379 //#define FLASH_WORD_SIZE 0x2
380 u8 flash_word_size = 0; //0x02;
381
382
383 /* Flash Write Timing
384    MHZ | FWT (0xAB)
385    12  | 0x10
386    13  | 0x11
387    16  | 0x15
388    24  | 0x20
389    26  | 0x23  (IM ME)
390    32  | 0x2A  (Modula.si)
391 */
392 //#define FWT 0x23
393
394 const u8 flash_routine[] = {
395   //0:
396   //MOV FADDRH, #imm; 
397   0x75, 0xAD,
398   0x00,//#imm=((address >> 8) / FLASH_WORD_SIZE) & 0x7E,
399   
400   //0x75, 0xAB, 0x23, //Set FWT per clock
401   0x75, 0xAC, 0x00,                                          //                 MOV FADDRL, #00; 
402   /* Erase page. */
403   0x75, 0xAE, 0x01,                                          //                 MOV FLC, #01H; // ERASE 
404                                                              //                 ; Wait for flash erase to complete 
405   0xE5, 0xAE,                                                // eraseWaitLoop:  MOV A, FLC; 
406   0x20, 0xE7, 0xFB,                                          //                 JB ACC_BUSY, eraseWaitLoop; 
407   
408   /* End erase page. */
409                                                              //                 ; Initialize the data pointer 
410   0x90, 0xF0, 0x00,                                          //                 MOV DPTR, #0F000H; 
411                                                              //                 ; Outer loops 
412   0x7F, HIBYTE_WORDS_PER_FLASH_PAGE,                         //                 MOV R7, #imm; 
413   0x7E, LOBYTE_WORDS_PER_FLASH_PAGE,                         //                 MOV R6, #imm; 
414   0x75, 0xAE, 0x02,                                          //                 MOV FLC, #02H; // WRITE 
415                                                              //                     ; Inner loops 
416   //24:
417   0x7D, 0xde /*FLASH_WORD_SIZE*/,                                     // writeLoop:          MOV R5, #imm; 
418   0xE0,                                                      // writeWordLoop:          MOVX A, @DPTR; 
419   0xA3,                                                      //                         INC DPTR; 
420   0xF5, 0xAF,                                                //                         MOV FWDATA, A;  
421   0xDD, 0xFA,                                                //                     DJNZ R5, writeWordLoop; 
422                                                              //                     ; Wait for completion 
423   0xE5, 0xAE,                                                // writeWaitLoop:      MOV A, FLC; 
424   0x20, 0xE6, 0xFB,                                          //                     JB ACC_SWBSY, writeWaitLoop; 
425   0xDE, 0xF1,                                                //                 DJNZ R6, writeLoop; 
426   0xDF, 0xEF,                                                //                 DJNZ R7, writeLoop; 
427                                                              //                 ; Done, fake a breakpoint 
428   0xA5                                                       //                 DB 0xA5; 
429 };
430
431
432 //! Copies flash buffer to flash.
433 void cc_write_flash_page(u32 adr){
434   //Assumes that page has already been written to XDATA 0xF000
435   //debugstr("Flashing 2kb at 0xF000 to given adr.");
436   
437   if(adr&(MINFLASHPAGE_SIZE-1)){
438     debugstr("Flash page address is not on a page boundary.  Aborting.");
439     return;
440   }
441   
442   if(flash_word_size==0){
443     debugstr("Flash word size is wrong.");
444     while(1);
445   }
446   
447   //Routine comes next
448   //WRITE_XDATA_MEMORY(IN: 0xF000 + FLASH_PAGE_SIZE, sizeof(routine), routine);
449   cc_write_xdata(0xF000+MAXFLASHPAGE_SIZE,
450                  (u8*) flash_routine, sizeof(flash_routine));
451   //Patch routine's third byte with
452   //((address >> 8) / FLASH_WORD_SIZE) & 0x7E
453   cc_pokedatabyte(0xF000+MAXFLASHPAGE_SIZE+2,
454                   ((adr>>8)/flash_word_size)&0x7E);
455   //Patch routine to define FLASH_WORD_SIZE
456   if(flash_routine[25]!=0xde)
457     debugstr("Ugly patching code failing in chipcon.c");
458   cc_pokedatabyte(0xF000+MAXFLASHPAGE_SIZE+25,
459                   flash_word_size);
460   
461   //debugstr("Wrote flash routine.");
462   
463   
464   //MOV MEMCTR, (bank * 16) + 1;
465   cmddata[0]=0x75;
466   cmddata[1]=0xc7;
467   cmddata[2]=0x51;
468   cc_debug_instr(3);
469   debugstr("Loaded bank info.");
470   
471   cc_set_pc(0xf000+MAXFLASHPAGE_SIZE);//execute code fragment
472   cc_resume();
473   
474   debugstr("Executing.");
475   
476   
477   while(!(cc_read_status()&CC_STATUS_CPUHALTED)){
478     P1OUT^=1;//blink LED while flashing
479   }
480   
481   
482   debugstr("Done flashing.");
483   
484   P1OUT&=~1;//clear LED
485 }
486
487 //! Read the PC
488 unsigned short cc_get_pc(){
489   cmddata[0]=CCCMD_GET_PC; //0x28
490   cccmd(1);
491   ccread(2);
492   
493   //Return the word.
494   return cmddataword[0];
495 }
496
497 //! Set a hardware breakpoint.
498 void cc_set_hw_brkpnt(unsigned short adr){
499   debugstr("FIXME: This certainly won't work.");
500   cmddataword[0]=adr;
501   cccmd(2);
502   ccread(1);
503   return;
504 }
505
506
507 //! Halt the CPU.
508 void cc_halt(){
509   cmddata[0]=CCCMD_HALT; //0x44
510   cccmd(1);
511   ccread(1);
512   return;
513 }
514 //! Resume the CPU.
515 void cc_resume(){
516   cmddata[0]=CCCMD_RESUME; //0x4C
517   cccmd(1);
518   ccread(1);
519   return;
520 }
521
522
523 //! Step an instruction
524 void cc_step_instr(){
525   cmddata[0]=CCCMD_STEP_INSTR; //0x5C
526   cccmd(1);
527   ccread(1);
528   return;
529 }
530
531 //! Debug an instruction.
532 void cc_debug_instr(unsigned char len){
533   //Bottom two bits of command indicate length.
534   unsigned char cmd=CCCMD_DEBUG_INSTR+(len&0x3); //0x54+len
535   CCWRITE;
536   cctrans8(cmd);  //Second command code
537   cccmd(len&0x3); //Command itself.
538   ccread(1);
539   return;
540 }
541
542 //! Debug an instruction, for local use.
543 unsigned char cc_debug(unsigned char len,
544               unsigned char a,
545               unsigned char b,
546               unsigned char c){
547   unsigned char cmd=CCCMD_DEBUG_INSTR+(len&0x3);//0x54+len
548   CCWRITE;
549   cctrans8(cmd);
550   if(len>0)
551     cctrans8(a);
552   if(len>1)
553     cctrans8(b);
554   if(len>2)
555     cctrans8(c);
556   CCREAD;
557   return cctrans8(0x00);
558 }
559
560 //! Fetch a byte of code memory.
561 unsigned char cc_peekcodebyte(unsigned long adr){
562   /** See page 9 of SWRA124 */
563   unsigned char bank=adr>>15,
564     lb=adr&0xFF,
565     hb=(adr>>8)&0x7F,
566     toret=0;
567   adr&=0x7FFF;
568   
569   //MOV MEMCTR, (bank*16)+1
570   cc_debug(3, 0x75, 0xC7, (bank<<4) + 1);
571   //MOV DPTR, address
572   cc_debug(3, 0x90, hb, lb);
573   
574   //for each byte
575   //CLR A
576   cc_debug(2, 0xE4, 0, 0);
577   //MOVC A, @A+DPTR;
578   toret=cc_debug(3, 0x93, 0, 0);
579   //INC DPTR
580   //cc_debug(1, 0xA3, 0, 0);
581   
582   return toret;
583 }
584
585
586 //! Set a byte of data memory.
587 unsigned char cc_pokedatabyte(unsigned int adr,
588                            unsigned char val){
589   unsigned char
590     hb=(adr&0xFF00)>>8,
591     lb=adr&0xFF;
592   
593   //MOV DPTR, adr
594   cc_debug(3, 0x90, hb, lb);
595   //MOV A, val
596   cc_debug(2, 0x74, val, 0);
597   //MOVX @DPTR, A
598   cc_debug(1, 0xF0, 0, 0);
599   
600   return 0;
601   /*
602 DEBUG_INSTR(IN: 0x90, HIBYTE(address), LOBYTE(address), OUT: Discard);
603 for (n = 0; n < count; n++) {
604     DEBUG_INSTR(IN: 0x74, inputArray[n], OUT: Discard);
605     DEBUG_INSTR(IN: 0xF0, OUT: Discard);
606     DEBUG_INSTR(IN: 0xA3, OUT: Discard);
607 }
608    */
609 }
610
611 //! Fetch a byte of data memory.
612 unsigned char cc_peekdatabyte(unsigned int adr){
613   unsigned char
614     hb=(adr&0xFF00)>>8,
615     lb=adr&0xFF;
616   
617   //MOV DPTR, adr
618   cc_debug(3, 0x90, hb, lb);
619   //MOVX A, @DPTR
620   //Must be 2, perhaps for clocking?
621   return cc_debug(3, 0xE0, 0, 0);
622 }
623
624
625 //! Fetch a byte of IRAM.
626 u8 cc_peekirambyte(u8 adr){
627   //CLR A
628   cc_debug(2, 0xE4, 0, 0);
629   //MOV A, #iram
630   return cc_debug(3, 0xE5, adr, 0);
631 }
632
633 //! Write a byte of IRAM.
634 u8 cc_pokeirambyte(u8 adr, u8 val){
635   //CLR A
636   cc_debug(2, 0xE4, 0, 0);
637   //MOV #iram, #val
638   return cc_debug(3, 0x75, adr, val);
639   //return cc_debug(3, 0x75, val, adr);
640 }
641
642