Cleaning MSP430X2 client.
[goodfet] / firmware / apps / jtag / jtag430x2.c
index 0de9a44..16eeb94 100644 (file)
 /*! \file jtag430x2.c
   \author Travis Goodspeed <travis at radiantmachines.com>
-  
-  This is an implementation of the MSP430X2 JTAG protocol
-  for the GoodFET project at http://goodfet.sf.net/
-  
-  See the license file for details of proper use.
+  \brief MSP430X2 JTAG (20-bit)
 */
 
 #include "platform.h"
 #include "command.h"
-#include "jtag.h"
+#include "jtag430.h"
+#include "jtag430x2.h"
 
-unsigned char jtagid;
+void jtag430x2_handle_fn( uint8_t const app,
+                         uint8_t const verb,
+                         uint32_t const len);
 
-//! Get the JTAG ID
-unsigned char jtag430x2_jtagid(){
-  jtag430_resettap();
-  return jtagid=jtag_ir_shift8(IR_BYPASS);
+
+// define the jtag430x2 app's app_t
+app_t const jtag430x2_app = {
+  /* app number */
+  JTAG430X2,
+  
+  /* handle fn */
+  jtag430x2_handle_fn,
+  
+  /* name */
+  "JTAG430X2",
+  
+  /* desc */
+  "\tThe JTAG430X2 app extends the basic JTAG app with support\n"
+  "\tfor 20-bit MSP430X2 devices, such as the MSP430F5xx Family.\n"
+};
+
+
+//! Grab the core ID.
+unsigned int jtag430_coreid(){
+  jtag_ir_shift8(IR_COREIP_ID);
+  return jtag_dr_shift16(0);
+}
+
+//! Grab the device ID.
+unsigned long jtag430_deviceid(){
+  jtag_ir_shift8(IR_DEVICE_ID);
+  return jtag_dr_shift20(0);
+}
+
+
+//! Write data to address
+void jtag430x2_writemem(unsigned long adr,
+                       unsigned int data){
+  jtag_ir_shift8(IR_CNTRL_SIG_CAPTURE);
+  if(jtag_dr_shift16(0) & 0x0301){
+    CLRTCLK;
+    jtag_ir_shift8(IR_CNTRL_SIG_16BIT);
+    if(adr>=0x100)
+      jtag_dr_shift16(0x0500);//word mode
+    else
+      jtag_dr_shift16(0x0510);//byte mode
+    jtag_ir_shift8(IR_ADDR_16BIT);
+    jtag_dr_shift20(adr);
+    
+    SETTCLK;
+    
+    jtag_ir_shift8(IR_DATA_TO_ADDR);
+    jtag_dr_shift16(data);//16 word
+
+    CLRTCLK;
+    jtag_ir_shift8(IR_CNTRL_SIG_16BIT);
+    jtag_dr_shift16(0x0501);
+    SETTCLK;
+
+    CLRTCLK;
+    SETTCLK;
+    //init state
+  }else{
+    while(1) PLEDOUT^=PLEDPIN; //loop if locked up
+  }
+}
+
+//! Read data from address
+unsigned int jtag430x2_readmem(unsigned long adr){
+  unsigned int toret=0;
+  //unsigned int tries=5;
+  
+  while(1){
+    do{
+      jtag_ir_shift8(IR_CNTRL_SIG_CAPTURE);
+    }while(!(jtag_dr_shift16(0) & 0x0301));
+    
+    if(jtag_dr_shift16(0) & 0x0301){
+      // Read Memory
+      CLRTCLK;
+      jtag_ir_shift8(IR_CNTRL_SIG_16BIT);
+      
+      jtag_dr_shift16(0x0501);//word read
+      
+      jtag_ir_shift8(IR_ADDR_16BIT);
+      jtag_dr_shift20(adr); //20
+      
+      jtag_ir_shift8(IR_DATA_TO_ADDR);
+      SETTCLK;
+      CLRTCLK;
+      toret = jtag_dr_shift16(0x0000);
+      
+      SETTCLK;
+      
+      //Cycle a bit.
+      CLRTCLK;
+      SETTCLK;
+      return toret;
+    }
+    
+    return 0xdead;
+  }
+  //return toret;
+}
+
+//! Syncs a POR.
+unsigned int jtag430x2_syncpor(){
+  jtag_ir_shift8(IR_CNTRL_SIG_16BIT);
+  jtag_dr_shift16(0x1501); //JTAG mode
+  while(!(jtag_dr_shift16(0) & 0x200));  //0x100 or 0x200?
+  return jtag430x2_por();
+}
+
+//! Executes an MSP430X2 POR
+unsigned int jtag430x2_por(){
+  unsigned int i = 0;
+  
+  // tick
+  CLRTCLK;
+  SETTCLK;
+
+  jtag_ir_shift8(IR_CNTRL_SIG_16BIT);
+  jtag_dr_shift16(0x0C01);
+  jtag_dr_shift16(0x0401);
+  
+  //cycle
+  for (i = 0; i < 10; i++){
+    CLRTCLK;
+    SETTCLK;
+  }
+  
+  jtag_dr_shift16(0x0501);
+  
+  // tick
+  CLRTCLK;
+  SETTCLK;
+  
+  
+  // Disable WDT
+  jtag430x2_writemem(0x015C, 0x5A80);
+  
+  // check state
+  jtag_ir_shift8(IR_CNTRL_SIG_CAPTURE);
+  if(jtag_dr_shift16(0) & 0x0301)
+    return(1);//ok
+  
+  return 0;//error
 }
-//! Start JTAG, take pins
-unsigned char jtag430x2_start(){
-  jtagsetup();
-  P1OUT^=1;
-  
-  //Known-good starting position.
-  //Might be unnecessary.
-  SETTST;
-  SETRST;
-  
-  delay(0xFFFF);
-  
-  //Entry sequence from Page 67 of SLAU265A for 4-wire MSP430 JTAG
-  CLRRST;
-  delay(10);
-  CLRTST;
-  delay(5);
-  SETTST;
-  msdelay(5);
-  SETRST;
-  P5DIR&=~RST;
-  
-  delay(0xFFFF);
-  
-  //Perform a reset and disable watchdog.
-  return jtag430x2_jtagid();
+
+
+//! Check the fuse.
+unsigned int jtag430x2_fusecheck(){
+  int i;
+  for(i=0;i<3;i++){
+    jtag_ir_shift8(IR_CNTRL_SIG_CAPTURE);
+    if(jtag_dr_shift16(0xAAAA)==0x5555)
+      return 1;//blown
+  }
+  return 0;//unblown
 }
 
 
-//! Handles classic MSP430 JTAG commands.  Forwards others to JTAG.
-void jtag430x2handle(unsigned char app,
-                  unsigned char verb,
-                  unsigned char len){
+//! Handles MSP430X2 JTAG commands.  Forwards others to JTAG.
+void jtag430x2_handle_fn( uint8_t const app,
+                                                 uint8_t const verb,
+                                                 uint32_t const len)
+{
+  register char blocks;
+  
+  unsigned int i,val;
+  unsigned long at, l;
+  
+  //jtag430_resettap();
+  
+  if(verb!=START && jtag430mode==MSP430MODE){
+    (*(jtag430_app.handle))(app,verb,len);
+    return;
+  }
   
   switch(verb){
   case START:
     //Enter JTAG mode.
-    do cmddata[0]=jtag430x2_start();
-    while(cmddata[0]==00 || cmddata[0]==0xFF);
+    //do 
+    cmddata[0]=jtag430x2_start();
+    //while(cmddata[0]==00 || cmddata[0]==0xFF);
+    
+    //MSP430 or MSP430X
+    if(jtagid==MSP430JTAGID){ 
+      //debugstr("ERROR, using JTAG430X2 instead of JTAG430!");
+      jtag430mode=MSP430MODE;
+      
+      /* So the way this works is that a width of 20 does some
+        backward-compatibility finagling, causing the correct value
+        to be exchanged for addresses on 16-bit chips as well as the
+        new MSP430X chips.  (This has only been verified on the
+        MSP430F2xx family.  TODO verify for others.)
+      */
+      
+      drwidth=20;
+      
+      //Perform a reset and disable watchdog.
+      jtag430_por();
+      jtag430_writemem(0x120,0x5a80);//disable watchdog
+      
+      jtag430_haltcpu();
+      
+      jtag430_resettap();
+      txdata(app,verb,1);
+      
+      return;
+    }else if(jtagid==MSP430X2JTAGID){
+      jtag430mode=MSP430X2MODE;
+      drwidth=20;
+    }else{
+      debugstr("JTAG version unknown.");
+      txdata(app,NOK,1);
+      return;
+    }
+    
+    
+    
+    jtag430x2_fusecheck();
+        
+    jtag430x2_syncpor();
+    
+    jtag430_resettap();
     
-    //TAP setup, fuse check
-    //jtag430_resettap();
     txdata(app,verb,1);
     break;
-  case JTAG430_HALTCPU:
-  case JTAG430_RELEASECPU:
-  case JTAG430_SETINSTRFETCH:
   case JTAG430_READMEM:
   case PEEK:
+    at=cmddatalong[0];
+    
+    //Fetch large blocks for bulk fetches,
+    //small blocks for individual peeks.
+    if(len>5)
+      l=(cmddataword[2]);//always even.
+    else
+      l=2;
+    l&=~1;//clear lsbit
+    
+    if(l<2) l=2;
+    
+    txhead(app,verb,l);
+    for(i=0;i<l;i+=2){
+      //jtag430_resettap();
+      //delay(10);
+      
+      val=jtag430x2_readmem(at);
+      
+      at+=2;
+      serial_tx(val&0xFF);
+      serial_tx((val&0xFF00)>>8);
+    }
+    
+    break;
+  case JTAG430_COREIP_ID:
+    cmddataword[0]=jtag430_coreid();
+    txdata(app,verb,2);
+    break;
+  case JTAG430_DEVICE_ID:
+    cmddatalong[0]=jtag430_deviceid();
+    txdata(app,verb,4);
+    break;
+  case JTAG430_WRITEFLASH:
   case JTAG430_WRITEMEM:
   case POKE:
-  case JTAG430_WRITEFLASH:
+    jtag430x2_writemem(cmddatalong[0],
+                      cmddataword[2]);
+    cmddataword[0]=jtag430x2_readmem(cmddatalong[0]);
+    txdata(app,verb,2);
+    break;
+
+    //unimplemented functions
+  case JTAG430_HALTCPU:
+    //jtag430x2_haltcpu();
+    debugstr("Warning, not trying to halt for lack of code.");
+    txdata(app,verb,0);
+    break;
+  case JTAG430_RELEASECPU:
+  case JTAG430_SETINSTRFETCH:
+
   case JTAG430_ERASEFLASH:
   case JTAG430_SETPC:
+    debugstr("This function is not yet implemented for MSP430X2.");
+    debughex(verb);
+    txdata(app,NOK,0);
+    break;
   default:
-    jtaghandle(app,verb,len);
+    (*(jtag_app.handle))(app,verb,len);
   }
   jtag430_resettap();
 }
+