git.gag.com Git - fw/altos/blob - altoslib/AltosDebug.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 org.altusmetrum.altoslib_2;
  19
  20 import java.io.*;
  21
  22 public class AltosDebug {
  23
  24         public static final byte WR_CONFIG =            0x1d;
  25         public static final byte RD_CONFIG =            0x24;
  26         public static final byte CONFIG_TIMERS_OFF =            (1 << 3);
  27         public static final byte CONFIG_DMA_PAUSE =             (1 << 2);
  28         public static final byte CONFIG_TIMER_SUSPEND =         (1 << 1);
  29         public static final byte SET_FLASH_INFO_PAGE =          (1 << 0);
  30
  31         public static final byte GET_PC =               0x28;
  32         public static final byte READ_STATUS =          0x34;
  33         public static final byte STATUS_CHIP_ERASE_DONE =       (byte) (1 << 7);
  34         public static final byte STATUS_PCON_IDLE =             (1 << 6);
  35         public static final byte STATUS_CPU_HALTED =            (1 << 5);
  36         public static final byte STATUS_POWER_MODE_0 =          (1 << 4);
  37         public static final byte STATUS_HALT_STATUS =           (1 << 3);
  38         public static final byte STATUS_DEBUG_LOCKED =          (1 << 2);
  39         public static final byte STATUS_OSCILLATOR_STABLE =     (1 << 1);
  40         public static final byte STATUS_STACK_OVERFLOW =        (1 << 0);
  41
  42         public static final byte SET_HW_BRKPNT =        0x3b;
  43         public static byte       HW_BRKPNT_N(byte n)    { return (byte) ((n) << 3); }
  44         public static final byte HW_BRKPNT_N_MASK =             (0x3 << 3);
  45         public static final byte HW_BRKPNT_ENABLE =             (1 << 2);
  46
  47         public static final byte HALT =                 0x44;
  48         public static final byte RESUME =               0x4c;
  49         public static       byte DEBUG_INSTR(byte n)    { return (byte) (0x54|(n)); }
  50         public static final byte STEP_INSTR =           0x5c;
  51         public static        byte STEP_REPLACE(byte n)  { return  (byte) (0x64|(n)); }
  52         public static final byte GET_CHIP_ID =          0x68;
  53
  54
  55         AltosLink       link;
  56
  57         boolean debug_mode;
  58
  59         void ensure_debug_mode() {
  60                 if (!debug_mode) {
  61                         link.printf("D\n");
  62                         try {
  63                                 link.flush_input();
  64                         } catch (InterruptedException ie) {
  65                         }
  66                         debug_mode = true;
  67                 }
  68         }
  69
  70         void dump_memory(String header, int address, byte[] bytes, int start, int len) {
  71                 System.out.printf("%s\n", header);
  72                 for (int j = 0; j < len; j++) {
  73                         if ((j & 15) == 0) {
  74                                 if (j != 0)
  75                                         System.out.printf("\n");
  76                                 System.out.printf ("%04x:", address + j);
  77                         }
  78                         System.out.printf(" %02x", bytes[start + j]);
  79                 }
  80                 System.out.printf("\n");
  81         }
  82
  83         public void close() {
  84                 link.close();
  85         }
  86
  87         /*
  88          * Write target memory
  89          */
  90         public void write_memory(int address, byte[] bytes, int start, int len) {
  91                 ensure_debug_mode();
  92 //              dump_memory("write_memory", address, bytes, start, len);
  93                 link.printf("O %x %x\n", len, address);
  94                 for (int i = 0; i < len; i++)
  95                         link.printf("%02x", bytes[start + i]);
  96         }
  97
  98         public void write_memory(int address, byte[] bytes) {
  99                 write_memory(address, bytes, 0, bytes.length);
 100         }
 101
 102         /*
 103          * Read target memory
 104          */
 105         public byte[] read_memory(int address, int length)
 106                 throws IOException, InterruptedException {
 107                 byte[]  data = new byte[length];
 108
 109                 link.flush_input();
 110                 ensure_debug_mode();
 111                 link.printf("I %x %x\n", length, address);
 112                 int i = 0;
 113                 int start = 0;
 114                 while (i < length) {
 115                         String  line = link.get_reply().trim();
 116                         if (!AltosLib.ishex(line) || line.length() % 2 != 0)
 117                                 throw new IOException(
 118                                         String.format
 119                                         ("Invalid reply \"%s\"", line));
 120                         int this_time = line.length() / 2;
 121                         for (int j = 0; j < this_time; j++)
 122                                 data[start + j] = (byte) ((AltosLib.fromhex(line.charAt(j*2)) << 4) +
 123                                                   AltosLib.fromhex(line.charAt(j*2+1)));
 124                         start += this_time;
 125                         i += this_time;
 126                 }
 127 //              dump_memory("read_memory", address, data, 0, length);
 128
 129                 return data;
 130         }
 131
 132         /*
 133          * Write raw bytes to the debug link using the 'P' command
 134          */
 135         public void write_bytes(byte[] bytes) throws IOException {
 136                 int i = 0;
 137                 ensure_debug_mode();
 138                 while (i < bytes.length) {
 139                         int this_time = bytes.length - i;
 140                         if (this_time > 8)
 141                                 this_time = 0;
 142                         link.printf("P");
 143                         for (int j = 0; j < this_time; j++)
 144                                 link.printf(" %02x", bytes[i+j]);
 145                         link.printf("\n");
 146                         i += this_time;
 147                 }
 148         }
 149
 150         public void write_byte(byte b) throws IOException {
 151                 byte[] bytes = { b };
 152                 write_bytes(bytes);
 153         }
 154
 155         /*
 156          * Read raw bytes from the debug link using the 'G' command
 157          */
 158         public byte[] read_bytes(int length)
 159                 throws IOException, InterruptedException {
 160
 161                 link.flush_input();
 162                 ensure_debug_mode();
 163                 link.printf("G %x\n", length);
 164                 int i = 0;
 165                 byte[] data = new byte[length];
 166                 while (i < length) {
 167                         String line = link.get_reply();
 168
 169                         if (line == null)
 170                                 throw new IOException("Timeout in read_bytes");
 171                         line = line.trim();
 172                         String tokens[] = line.split("\\s+");
 173                         for (int j = 0; j < tokens.length; j++) {
 174                                 if (!AltosLib.ishex(tokens[j]) ||
 175                                     tokens[j].length() != 2)
 176                                         throw new IOException(
 177                                                 String.format
 178                                                 ("Invalid read_bytes reply \"%s\"", line));
 179                                 try {
 180                                         if (i + j >= length)
 181                                                 throw new IOException(
 182                                                         String.format
 183                                                         ("Invalid read_bytes reply \"%s\"", line));
 184                                         else
 185                                                 data[i + j] = (byte) Integer.parseInt(tokens[j], 16);
 186                                 } catch (NumberFormatException ne) {
 187                                         throw new IOException(
 188                                                 String.format
 189                                                 ("Invalid read_bytes reply \"%s\"", line));
 190                                 }
 191                         }
 192                         i += tokens.length;
 193                 }
 194                 return data;
 195         }
 196
 197         public byte read_byte() throws IOException, InterruptedException {
 198                 return read_bytes(1)[0];
 199         }
 200
 201         public byte debug_instr(byte[] instruction) throws IOException, InterruptedException {
 202                 byte[] command = new byte[1 + instruction.length];
 203                 command[0] = DEBUG_INSTR((byte) instruction.length);
 204                 for (int i = 0; i < instruction.length; i++)
 205                         command[i+1] = instruction[i];
 206                 write_bytes(command);
 207                 return read_byte();
 208         }
 209
 210         public byte resume() throws IOException, InterruptedException {
 211                 write_byte(RESUME);
 212                 return read_byte();
 213         }
 214
 215         public int read_uint16() throws IOException, InterruptedException {
 216                 byte[] d = read_bytes(2);
 217                 return ((int) (d[0] & 0xff) << 8) | (d[1] & 0xff);
 218         }
 219
 220         public int read_uint8()  throws IOException, InterruptedException {
 221                 byte[] d = read_bytes(1);
 222                 return (int) (d[0] & 0xff);
 223         }
 224
 225         public int get_chip_id() throws IOException, InterruptedException {
 226                 write_byte(GET_CHIP_ID);
 227                 return read_uint16();
 228         }
 229
 230         public int get_pc() throws IOException, InterruptedException {
 231                 write_byte(GET_PC);
 232                 return read_uint16();
 233         }
 234
 235         public byte read_status() throws IOException, InterruptedException {
 236                 write_byte(READ_STATUS);
 237                 return read_byte();
 238         }
 239
 240         static final byte LJMP                  = 0x02;
 241
 242         public void set_pc(int pc) throws IOException, InterruptedException {
 243                 byte high = (byte) (pc >> 8);
 244                 byte low = (byte) pc;
 245                 byte[] jump_mem = { LJMP, high, low };
 246                 debug_instr(jump_mem);
 247         }
 248
 249         public boolean check_connection() throws IOException, InterruptedException {
 250                 byte reply = read_status();
 251                 if ((reply & STATUS_CHIP_ERASE_DONE) == 0)
 252                         return false;
 253                 if ((reply & STATUS_PCON_IDLE) != 0)
 254                         return false;
 255                 if ((reply & STATUS_POWER_MODE_0) == 0)
 256                         return false;
 257                 return true;
 258         }
 259
 260         public AltosRomconfig romconfig() {
 261                 try {
 262                         byte[] bytes = read_memory(0xa0, 10);
 263                         AltosHexfile hexfile = new AltosHexfile (bytes, 0xa0);
 264                         return new AltosRomconfig(hexfile);
 265                 } catch (IOException ie) {
 266                 } catch (InterruptedException ie) {
 267                 }
 268                 return new AltosRomconfig();
 269         }
 270
 271         /*
 272          * Reset target
 273          */
 274         public void reset() {
 275                 link.printf ("R\n");
 276         }
 277
 278         public AltosDebug (AltosLink link) {
 279                 this.link = link;
 280         }
 281 }