git.gag.com Git - fw/altos/blob - ao-tools/lib/ccdbg.h

   1 /*
   2  * Copyright © 2008 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; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17  */
  18
  19 #ifndef _CCDBG_H_
  20 #define _CCDBG_H_
  21
  22 #include <stdint.h>
  23 #include <stdlib.h>
  24 #include <unistd.h>
  25 #include <string.h>
  26 #include <stdio.h>
  27 #include <stdint.h>
  28 #include <assert.h>
  29 #include <fcntl.h>
  30 #include <sys/types.h>
  31 #include <sys/ioctl.h>
  32 #include <sys/stat.h>
  33 #include "ccdbg-debug.h"
  34 #include "cc-bitbang.h"
  35 #include "cc-usb.h"
  36 #include "ao-hex.h"
  37
  38 /* 8051 instructions
  39  */
  40 #define NOP                     0x00
  41 #define MOV_direct_data         0x75
  42 #define LJMP                    0x02
  43 #define MOV_Rn_data(n)          (0x78 | (n))
  44 #define DJNZ_Rn_rel(n)          (0xd8 | (n))
  45 #define MOV_A_direct            0xe5
  46 #define MOV_direct1_direct2     0x85
  47 #define MOV_direct_A            0xf5
  48 #define MOV_DPTR_data16         0x90
  49 #define MOV_A_data              0x74
  50 #define MOVX_atDPTR_A           0xf0
  51 #define MOVX_A_atDPTR           0xe0
  52 #define INC_DPTR                0xa3
  53 #define TRAP                    0xa5
  54 #define SJMP                    0x80
  55 #define JB                      0x20
  56
  57 /* 8051 special function registers
  58  */
  59
  60 #define SFR_P0                  0x80
  61 #define SFR_SP                  0x81
  62 #define SFR_DPL0                0x82
  63 #define SFR_DPH0                0x83
  64 #define SFR_DPL1                0x84
  65 #define SFR_DPH1                0x85
  66
  67 /* flash controller */
  68 #define FWT                     0xAB
  69 #define FADDRL                  0xAC
  70 #define FADDRH                  0xAD
  71 #define FCTL                    0xAE
  72 # define FCTL_BUSY              0x80
  73 # define FCTL_BUSY_BIT          7
  74 # define FCTL_SWBSY             0x40
  75 # define FCTL_SWBSY_BIT         6
  76 # define FCTL_CONTRD            0x10
  77 # define FCTL_WRITE             0x02
  78 # define FCTL_ERASE             0x01
  79 #define FWDATA                  0xAF
  80
  81 #define SLEEP                   0xBE
  82
  83 /* clock controller */
  84 #define CLKCON                  0xC6
  85 #define  CLKCON_OSC32K          0x80
  86 #define  CLKCON_OSC             0x40
  87 #define  CLKCON_TICKSPD         0x38
  88 #define  CLKCON_CLKSPD          0x07
  89
  90 /* I/O pins */
  91 #define P0                      0x80
  92 #define P1                      0x90
  93 #define P2                      0xA0
  94 #define P0DIR                   0xFD
  95 #define P1DIR                   0xFE
  96 #define P2DIR                   0xFF
  97
  98 /* Bit-addressable accumulator */
  99 #define ACC(bit)                (0xE0 | (bit))
 100
 101 /* Bit-addressable status word */
 102 #define PSW(bit)                (0xD0 | (bit))
 103
 104 struct ccdbg {
 105         struct cc_bitbang       *bb;
 106         struct cc_usb           *usb;
 107         struct ao_hex_image     *rom;
 108 };
 109
 110
 111 #define CC_STATE_ACC    0x1
 112 #define CC_STATE_PSW    0x2
 113 #define CC_STATE_DP     0x4
 114
 115 #define CC_STATE_NSFR   5
 116
 117 struct ccstate {
 118         uint16_t        mask;
 119         uint8_t         acc;
 120         uint8_t         sfr[CC_STATE_NSFR];
 121 };
 122
 123 /* CC1111 debug port commands
 124  */
 125 #define CC_CHIP_ERASE           0x14
 126
 127 #define CC_WR_CONFIG            0x1d
 128 #define CC_RD_CONFIG            0x24
 129 # define CC_CONFIG_TIMERS_OFF           (1 << 3)
 130 # define CC_CONFIG_DMA_PAUSE            (1 << 2)
 131 # define CC_CONFIG_TIMER_SUSPEND        (1 << 1)
 132 # define CC_SET_FLASH_INFO_PAGE         (1 << 0)
 133
 134 #define CC_GET_PC               0x28
 135 #define CC_READ_STATUS          0x34
 136 # define CC_STATUS_CHIP_ERASE_DONE      (1 << 7)
 137 # define CC_STATUS_PCON_IDLE            (1 << 6)
 138 # define CC_STATUS_CPU_HALTED           (1 << 5)
 139 # define CC_STATUS_POWER_MODE_0         (1 << 4)
 140 # define CC_STATUS_HALT_STATUS          (1 << 3)
 141 # define CC_STATUS_DEBUG_LOCKED         (1 << 2)
 142 # define CC_STATUS_OSCILLATOR_STABLE    (1 << 1)
 143 # define CC_STATUS_STACK_OVERFLOW       (1 << 0)
 144
 145 #define CC_SET_HW_BRKPNT        0x3b
 146 # define CC_HW_BRKPNT_N(n)      ((n) << 3)
 147 # define CC_HW_BRKPNT_N_MASK    (0x3 << 3)
 148 # define CC_HW_BRKPNT_ENABLE    (1 << 2)
 149
 150 #define CC_HALT                 0x44
 151 #define CC_RESUME               0x4c
 152 #define CC_DEBUG_INSTR(n)       (0x54|(n))
 153 #define CC_STEP_INSTR           0x5c
 154 #define CC_STEP_REPLACE(n)      (0x64|(n))
 155 #define CC_GET_CHIP_ID          0x68
 156
 157 /* ccdbg-command.c */
 158 void
 159 ccdbg_debug_mode(struct ccdbg *dbg);
 160
 161 void
 162 ccdbg_reset(struct ccdbg *dbg);
 163
 164 uint8_t
 165 ccdbg_chip_erase(struct ccdbg *dbg);
 166
 167 uint8_t
 168 ccdbg_wr_config(struct ccdbg *dbg, uint8_t config);
 169
 170 uint8_t
 171 ccdbg_rd_config(struct ccdbg *dbg);
 172
 173 uint16_t
 174 ccdbg_get_pc(struct ccdbg *dbg);
 175
 176 uint8_t
 177 ccdbg_read_status(struct ccdbg *dbg);
 178
 179 uint8_t
 180 ccdbg_set_hw_brkpnt(struct ccdbg *dbg, uint8_t number, uint8_t enable, uint16_t addr);
 181
 182 uint8_t
 183 ccdbg_halt(struct ccdbg *dbg);
 184
 185 uint8_t
 186 ccdbg_resume(struct ccdbg *dbg);
 187
 188 uint8_t
 189 ccdbg_debug_instr(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 190
 191 void
 192 ccdbg_debug_instr_discard(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 193
 194 void
 195 ccdbg_debug_instr_queue(struct ccdbg *dbg, uint8_t *instr, int nbytes,
 196                         uint8_t *reply);
 197
 198 uint8_t
 199 ccdbg_step_instr(struct ccdbg *dbg);
 200
 201 uint8_t
 202 ccdbg_step_replace(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 203
 204 uint16_t
 205 ccdbg_get_chip_id(struct ccdbg *dbg);
 206
 207 uint8_t
 208 ccdbg_execute(struct ccdbg *dbg, uint8_t *inst);
 209
 210 uint8_t
 211 ccdbg_set_pc(struct ccdbg *dbg, uint16_t pc);
 212
 213 uint8_t
 214 ccdbg_execute_hex_image(struct ccdbg *dbg, struct ao_hex_image *image);
 215
 216 /* ccdbg-flash.c */
 217 uint8_t
 218 ccdbg_flash_hex_image(struct ccdbg *dbg, struct ao_hex_image *image);
 219
 220 /* ccdbg-io.c */
 221 struct ccdbg *
 222 ccdbg_open(char *tty);
 223
 224 void
 225 ccdbg_close(struct ccdbg *dbg);
 226
 227 void
 228 ccdbg_cmd_write(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 229
 230 uint8_t
 231 ccdbg_cmd_write_read8(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 232
 233 void
 234 ccdbg_cmd_write_queue8(struct ccdbg *dbg, uint8_t cmd,
 235                        uint8_t *data, int len, uint8_t *reply);
 236
 237 uint16_t
 238 ccdbg_cmd_write_read16(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 239
 240 void
 241 ccdbg_send_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
 242
 243 void
 244 ccdbg_recv_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
 245
 246 void
 247 ccdbg_sync(struct ccdbg *dbg);
 248
 249 /* ccdbg-manual.c */
 250
 251 void
 252 ccdbg_manual(struct ccdbg *dbg, FILE *input);
 253
 254 /* ccdbg-memory.c */
 255 uint8_t
 256 ccdbg_write_memory(struct ccdbg *dbg, uint16_t addr, uint8_t *bytes, int nbytes);
 257
 258 uint8_t
 259 ccdbg_read_memory(struct ccdbg *dbg, uint16_t addr, uint8_t *bytes, int nbytes);
 260
 261 uint8_t
 262 ccdbg_write_uint8(struct ccdbg *dbg, uint16_t addr, uint8_t byte);
 263
 264 uint8_t
 265 ccdbg_write_hex_image(struct ccdbg *dbg, struct ao_hex_image *image, uint16_t offset);
 266
 267 struct ao_hex_image *
 268 ccdbg_read_hex_image(struct ccdbg *dbg, uint16_t address, uint16_t length);
 269
 270 uint8_t
 271 ccdbg_read_sfr(struct ccdbg *dbg, uint8_t addr, uint8_t *bytes, int nbytes);
 272
 273 uint8_t
 274 ccdbg_write_sfr(struct ccdbg *dbg, uint8_t addr, uint8_t *bytes, int nbytes);
 275
 276 /* ccdbg-rom.c */
 277 uint8_t
 278 ccdbg_set_rom(struct ccdbg *dbg, struct ao_hex_image *rom);
 279
 280 uint8_t
 281 ccdbg_rom_contains(struct ccdbg *dbg, uint16_t addr, int nbytes);
 282
 283 uint8_t
 284 ccdbg_rom_replace_xmem(struct ccdbg *dbg,
 285                        uint16_t addrp, uint8_t *bytesp, int nbytes);
 286
 287 /* ccdbg-state.c */
 288 uint8_t
 289 ccdbg_state_save(struct ccdbg *dbg, struct ccstate *state, unsigned int mask);
 290
 291 uint8_t
 292 ccdbg_state_restore(struct ccdbg *dbg, struct ccstate *state);
 293
 294 void
 295 ccdbg_state_replace_xmem(struct ccdbg *dbg, struct ccstate *state,
 296                          uint16_t addr, uint8_t *bytes, int nbytes);
 297
 298 void
 299 ccdbg_state_replace_sfr(struct ccdbg *dbg, struct ccstate *state,
 300                         uint8_t addr, uint8_t *bytes, int nbytes);
 301
 302 #endif /* _CCDBG_H_ */