git.gag.com Git - fw/altos/blob - ao-tools/altosui/AltosFlash.java

   1 /*
   2  * Copyright © 2010 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; version 2 of the License.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  16  */
  17
  18 package altosui;
  19
  20 import java.awt.*;
  21 import java.awt.event.*;
  22 import javax.swing.*;
  23 import javax.swing.filechooser.FileNameExtensionFilter;
  24 import javax.swing.table.*;
  25 import java.io.*;
  26 import java.util.*;
  27 import java.text.*;
  28 import java.util.prefs.*;
  29 import java.util.concurrent.LinkedBlockingQueue;
  30
  31 public class AltosFlash {
  32         File            file;
  33         FileInputStream input;
  34         AltosHexfile    image;
  35         JFrame          frame;
  36         AltosDevice     debug_dongle;
  37         AltosDebug      debug;
  38         AltosRomconfig  rom_config;
  39         ActionListener  listener;
  40         boolean         aborted;
  41
  42         static final byte MOV_direct_data       = (byte) 0x75;
  43         static final byte MOV_DPTR_data16       = (byte) 0x90;
  44         static final byte MOV_A_data            = (byte) 0x74;
  45         static final byte MOVX_atDPTR_A         = (byte) 0xf0;
  46         static final byte MOVX_A_atDPTR         = (byte) 0xe0;
  47         static final byte INC_DPTR              = (byte) 0xa3;
  48         static final byte TRAP                  = (byte) 0xa5;
  49
  50         static final byte JB                    = (byte) 0x20;
  51
  52         static final byte MOV_A_direct          = (byte) 0xe5;
  53         static final byte MOV_direct1_direct2   = (byte) 0x85;
  54         static final byte MOV_direct_A          = (byte) 0xf5;
  55         static final byte MOV_R0_data           = (byte) (0x78 | 0);
  56         static final byte MOV_R1_data           = (byte) (0x78 | 1);
  57         static final byte MOV_R2_data           = (byte) (0x78 | 2);
  58         static final byte MOV_R3_data           = (byte) (0x78 | 3);
  59         static final byte MOV_R4_data           = (byte) (0x78 | 4);
  60         static final byte MOV_R5_data           = (byte) (0x78 | 5);
  61         static final byte MOV_R6_data           = (byte) (0x78 | 6);
  62         static final byte MOV_R7_data           = (byte) (0x78 | 7);
  63         static final byte DJNZ_R0_rel           = (byte) (0xd8 | 0);
  64         static final byte DJNZ_R1_rel           = (byte) (0xd8 | 1);
  65         static final byte DJNZ_R2_rel           = (byte) (0xd8 | 2);
  66         static final byte DJNZ_R3_rel           = (byte) (0xd8 | 3);
  67         static final byte DJNZ_R4_rel           = (byte) (0xd8 | 4);
  68         static final byte DJNZ_R5_rel           = (byte) (0xd8 | 5);
  69         static final byte DJNZ_R6_rel           = (byte) (0xd8 | 6);
  70         static final byte DJNZ_R7_rel           = (byte) (0xd8 | 7);
  71
  72         static final byte P1DIR                 = (byte) 0xFE;
  73         static final byte P1                    = (byte) 0x90;
  74
  75         /* flash controller */
  76         static final byte FWT                   = (byte) 0xAB;
  77         static final byte FADDRL                = (byte) 0xAC;
  78         static final byte FADDRH                = (byte) 0xAD;
  79         static final byte FCTL                  = (byte) 0xAE;
  80         static final byte FCTL_BUSY             = (byte) 0x80;
  81         static final byte FCTL_BUSY_BIT         = (byte) 7;
  82         static final byte FCTL_SWBSY            = (byte) 0x40;
  83         static final byte FCTL_SWBSY_BIT        = (byte) 6;
  84         static final byte FCTL_CONTRD           = (byte) 0x10;
  85         static final byte FCTL_WRITE            = (byte) 0x02;
  86         static final byte FCTL_ERASE            = (byte) 0x01;
  87         static final byte FWDATA                = (byte) 0xAF;
  88
  89         static final byte ACC                   = (byte) 0xE0;
  90
  91         /* offsets within the flash_page program */
  92         static final int FLASH_ADDR_HIGH        = 8;
  93         static final int FLASH_ADDR_LOW         = 11;
  94         static final int RAM_ADDR_HIGH          = 13;
  95         static final int RAM_ADDR_LOW           = 14;
  96         static final int FLASH_WORDS_HIGH       = 16;
  97         static final int FLASH_WORDS_LOW        = 18;
  98         static final int FLASH_TIMING           = 21;
  99
 100         /* sleep mode control */
 101         static final int SLEEP                  = (byte) 0xbe;
 102         static final int  SLEEP_USB_EN          = (byte) 0x80;
 103         static final int  SLEEP_XOSC_STB        = (byte) 0x40;
 104         static final int  SLEEP_HFRC_STB        = (byte) 0x20;
 105         static final int  SLEEP_RST_MASK        = (byte) 0x18;
 106         static final int   SLEEP_RST_POWERON    = (byte) 0x00;
 107         static final int   SLEEP_RST_EXTERNAL   = (byte) 0x10;
 108         static final int   SLEEP_RST_WATCHDOG   = (byte) 0x08;
 109         static final int  SLEEP_OSC_PD          = (byte) 0x04;
 110         static final int  SLEEP_MODE_MASK       = (byte) 0x03;
 111         static final int   SLEEP_MODE_PM0       = (byte) 0x00;
 112         static final int   SLEEP_MODE_PM1       = (byte) 0x01;
 113         static final int   SLEEP_MODE_PM2       = (byte) 0x02;
 114         static final int   SLEEP_MODE_PM3       = (byte) 0x03;
 115
 116         /* clock controller */
 117         static final byte CLKCON                = (byte) 0xC6;
 118         static final byte  CLKCON_OSC32K        = (byte) 0x80;
 119         static final byte  CLKCON_OSC           = (byte) 0x40;
 120         static final byte  CLKCON_TICKSPD       = (byte) 0x38;
 121         static final byte  CLKCON_CLKSPD        = (byte) 0x07;
 122
 123         static final byte[] flash_page_proto = {
 124
 125                 MOV_direct_data, P1DIR, (byte) 0x02,
 126                 MOV_direct_data, P1,    (byte) 0xFF,
 127
 128                 MOV_direct_data, FADDRH, 0,     /* FLASH_ADDR_HIGH */
 129
 130                 MOV_direct_data, FADDRL, 0,     /* FLASH_ADDR_LOW */
 131
 132                 MOV_DPTR_data16, 0, 0,          /* RAM_ADDR_HIGH, RAM_ADDR_LOW */
 133
 134                 MOV_R7_data, 0,                 /* FLASH_WORDS_HIGH */
 135
 136                 MOV_R6_data, 0,                 /* FLASH_WORDS_LOW */
 137
 138
 139                 MOV_direct_data, FWT, 0x20,     /* FLASH_TIMING */
 140
 141                 MOV_direct_data, FCTL, FCTL_ERASE,
 142 /* eraseWaitLoop: */
 143                 MOV_A_direct,           FCTL,
 144                 JB, ACC|FCTL_BUSY_BIT, (byte) 0xfb,
 145
 146                 MOV_direct_data, P1, (byte) 0xfd,
 147
 148                 MOV_direct_data, FCTL, FCTL_WRITE,
 149 /* writeLoop: */
 150                 MOV_R5_data, 2,
 151 /* writeWordLoop: */
 152                 MOVX_A_atDPTR,
 153                 INC_DPTR,
 154                 MOV_direct_A, FWDATA,
 155                 DJNZ_R5_rel, (byte) 0xfa,               /* writeWordLoop */
 156 /* writeWaitLoop: */
 157                 MOV_A_direct, FCTL,
 158                 JB, ACC|FCTL_SWBSY_BIT, (byte) 0xfb,    /* writeWaitLoop */
 159                 DJNZ_R6_rel, (byte) 0xf1,               /* writeLoop */
 160                 DJNZ_R7_rel, (byte) 0xef,                       /* writeLoop */
 161
 162                 MOV_direct_data, P1DIR, (byte) 0x00,
 163                 MOV_direct_data, P1,    (byte) 0xFF,
 164                 TRAP,
 165         };
 166
 167         public byte[] make_flash_page(int flash_addr, int ram_addr, int byte_count) {
 168                 int flash_word_addr = flash_addr >> 1;
 169                 int flash_word_count = ((byte_count + 1) >> 1);
 170
 171                 byte[] flash_page = new byte[flash_page_proto.length];
 172                 for (int i = 0; i < flash_page.length; i++)
 173                         flash_page[i] = flash_page_proto[i];
 174
 175                 flash_page[FLASH_ADDR_HIGH]  = (byte) (flash_word_addr >> 8);
 176                 flash_page[FLASH_ADDR_LOW]   = (byte) (flash_word_addr);
 177                 flash_page[RAM_ADDR_HIGH]    = (byte) (ram_addr >> 8);
 178                 flash_page[RAM_ADDR_LOW]     = (byte) (ram_addr);
 179
 180                 byte flash_words_low = (byte) (flash_word_count);
 181                 byte flash_words_high = (byte) (flash_word_count >> 8);
 182                 /* the flashing code has a minor 'bug' */
 183                 if (flash_words_low != 0)
 184                         flash_words_high++;
 185
 186                 flash_page[FLASH_WORDS_HIGH] = (byte) flash_words_high;
 187                 flash_page[FLASH_WORDS_LOW]  = (byte) flash_words_low;
 188                 return flash_page;
 189         }
 190
 191         static byte[] set_clkcon_fast = {
 192                 MOV_direct_data, CLKCON, 0x00
 193         };
 194
 195         static byte[] get_sleep = {
 196                 MOV_A_direct, SLEEP
 197         };
 198
 199         public void clock_init() throws IOException, InterruptedException {
 200                 debug.debug_instr(set_clkcon_fast);
 201
 202                 byte    status;
 203                 for (int times = 0; times < 20; times++) {
 204                         Thread.sleep(1);
 205                         status = debug.debug_instr(get_sleep);
 206                         if ((status & SLEEP_XOSC_STB) != 0)
 207                                 return;
 208                 }
 209                 throw new IOException("Failed to initialize target clock");
 210         }
 211
 212         void action(String s, int percent) {
 213                 if (listener != null && !aborted)
 214                         listener.actionPerformed(new ActionEvent(this,
 215                                                                  percent,
 216                                                                  s));
 217         }
 218
 219         void action(int part, int total) {
 220                 int percent = 100 * part / total;
 221                 action(String.format("%d/%d (%d%%)",
 222                                      part, total, percent),
 223                        percent);
 224         }
 225
 226         void run(int pc) throws IOException, InterruptedException {
 227                 debug.set_pc(pc);
 228                 int set_pc = debug.get_pc();
 229                 if (pc != set_pc)
 230                         throw new IOException("Failed to set target program counter");
 231                 debug.resume();
 232
 233                 for (int times = 0; times < 20; times++) {
 234                         byte status = debug.read_status();
 235                         if ((status & AltosDebug.STATUS_CPU_HALTED) != 0)
 236                                 return;
 237                 }
 238
 239                 throw new IOException("Failed to execute program on target");
 240         }
 241
 242         public void flash() throws IOException, FileNotFoundException, InterruptedException {
 243                 if (!check_rom_config())
 244                         throw new IOException("Invalid rom config settings");
 245                 if (image.address + image.data.length > 0x8000)
 246                         throw new IOException(String.format("Flash image too long %d",
 247                                                             image.address +
 248                                                             image.data.length));
 249                 if ((image.address & 0x3ff) != 0)
 250                         throw new IOException(String.format("Flash image must start on page boundary (is 0x%x)",
 251                                                             image.address));
 252                 int ram_address = 0xf000;
 253                 int flash_prog = 0xf400;
 254
 255                 /*
 256                  * Store desired config values into image
 257                  */
 258                 rom_config.write(image);
 259                 /*
 260                  * Bring up the clock
 261                  */
 262                 clock_init();
 263
 264                 int remain = image.data.length;
 265                 int flash_addr = image.address;
 266                 int image_start = 0;
 267
 268                 action("start", 0);
 269                 action(0, image.data.length);
 270                 while (remain > 0 && !aborted) {
 271                         int this_time = remain;
 272                         if (this_time > 0x400)
 273                                 this_time = 0x400;
 274
 275                         /* write the data */
 276                         debug.write_memory(ram_address, image.data,
 277                                            image_start, this_time);
 278
 279                         /* write the flash program */
 280                         byte[] flash_page = make_flash_page(flash_addr,
 281                                                             ram_address,
 282                                                             this_time);
 283                         debug.write_memory(flash_prog, flash_page);
 284
 285                         run(flash_prog);
 286
 287                         byte[] check = debug.read_memory(flash_addr, this_time);
 288                         for (int i = 0; i < this_time; i++)
 289                                 if (check[i] != image.data[image_start + i])
 290                                         throw new IOException(String.format("Flash write failed at 0x%x (%02x != %02x)",
 291                                                                             image.address + image_start + i,
 292                                                                             check[i], image.data[image_start + i]));
 293                         remain -= this_time;
 294                         flash_addr += this_time;
 295                         image_start += this_time;
 296
 297                         action(image.data.length - remain, image.data.length);
 298                 }
 299                 if (!aborted) {
 300                         action("done", 100);
 301                         debug.set_pc(image.address);
 302                         debug.resume();
 303                 }
 304                 debug.close();
 305         }
 306
 307         public void abort() {
 308                 aborted = true;
 309                 debug.close();
 310         }
 311
 312         public void addActionListener(ActionListener l) {
 313                 listener = l;
 314         }
 315
 316         public boolean check_rom_config() {
 317                 if (rom_config == null)
 318                         rom_config = debug.romconfig();
 319                 return rom_config != null && rom_config.valid();
 320         }
 321
 322         public void set_romconfig (AltosRomconfig romconfig) {
 323                 rom_config = romconfig;
 324         }
 325
 326         public AltosRomconfig romconfig() {
 327                 if (!check_rom_config())
 328                         return null;
 329                 return rom_config;
 330         }
 331
 332         public AltosFlash(File in_file, AltosDevice in_debug_dongle)
 333                 throws IOException, FileNotFoundException, AltosSerialInUseException, InterruptedException {
 334                 file = in_file;
 335                 debug_dongle = in_debug_dongle;
 336                 debug = new AltosDebug(in_debug_dongle);
 337                 input = new FileInputStream(file);
 338                 image = new AltosHexfile(input);
 339                 if (!debug.check_connection())
 340                         throw new IOException("Debug port not connected");
 341         }
 342 }