git.gag.com Git - fw/altos/blob - 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
  35 #define CC_CLOCK        0x1
  36 #define CC_DATA         0x2
  37 #define CC_RESET_N      0x4
  38 #define CC_CLOCK_US     (0)
  39
  40 /* 8051 instructions
  41  */
  42 #define NOP                     0x00
  43 #define MOV_direct_data         0x75
  44 #define LJMP                    0x02
  45 #define MOV_Rn_data(n)          (0x78 | (n))
  46 #define DJNZ_Rn_rel(n)          (0xd8 | (n))
  47 #define MOV_A_direct            0xe5
  48 #define MOV_direct1_direct2     0x85
  49 #define MOV_direct_A            0xf5
  50 #define MOV_DPTR_data16         0x90
  51 #define MOV_A_data              0x74
  52 #define MOVX_atDPTR_A           0xf0
  53 #define MOVX_A_atDPTR           0xe0
  54 #define INC_DPTR                0xa3
  55 #define TRAP                    0xa5
  56 #define SJMP                    0x80
  57 #define JB                      0x20
  58
  59 /* 8051 special function registers
  60  */
  61
  62 #define SFR_P0                  0x80
  63 #define SFR_SP                  0x81
  64 #define SFR_DPL0                0x82
  65 #define SFR_DPH0                0x83
  66 #define SFR_DPL1                0x84
  67 #define SFR_DPH1                0x85
  68
  69 /* flash controller */
  70 #define FWT                     0xAB
  71 #define FADDRL                  0xAC
  72 #define FADDRH                  0xAD
  73 #define FCTL                    0xAE
  74 # define FCTL_BUSY              0x80
  75 # define FCTL_BUSY_BIT          7
  76 # define FCTL_SWBSY             0x40
  77 # define FCTL_SWBSY_BIT         6
  78 # define FCTL_CONTRD            0x10
  79 # define FCTL_WRITE             0x02
  80 # define FCTL_ERASE             0x01
  81 #define FWDATA                  0xAF
  82
  83 #define SLEEP                   0xBE
  84
  85 /* clock controller */
  86 #define CLKCON                  0xC6
  87 #define  CLKCON_OSC32K          0x80
  88 #define  CLKCON_OSC             0x40
  89 #define  CLKCON_TICKSPD         0x38
  90 #define  CLKCON_CLKSPD          0x07
  91
  92 /* I/O pins */
  93 #define P0                      0x80
  94 #define P1                      0x90
  95 #define P2                      0xA0
  96 #define P0DIR                   0xFD
  97 #define P1DIR                   0xFE
  98 #define P2DIR                   0xFF
  99
 100 /* Bit-addressable accumulator */
 101 #define ACC(bit)                (0xE0 | (bit))
 102
 103 /* Bit-addressable status word */
 104 #define PSW(bit)                (0xD0 | (bit))
 105
 106 #define CP_USB_ASYNC
 107
 108 struct ccdbg {
 109 #ifdef CP_USB_ASYNC
 110         struct cp_usb_async *cp_async;
 111 #else
 112         struct cp_usb *cp;
 113 #endif
 114         struct hex_image *rom;
 115 };
 116
 117 /* Intel hex file format data
 118  */
 119 struct hex_record {
 120         uint8_t length;
 121         uint16_t address;
 122         uint8_t type;
 123         uint8_t checksum;
 124         uint8_t data[0];
 125 };
 126
 127 struct hex_file {
 128         int                     nrecord;
 129         struct hex_record       *records[0];
 130 };
 131
 132 struct hex_image {
 133         uint16_t        address;
 134         uint16_t        length;
 135         uint8_t         data[0];
 136 };
 137
 138 #define CC_STATE_ACC    0x1
 139 #define CC_STATE_PSW    0x2
 140 #define CC_STATE_DP     0x4
 141
 142 #define CC_STATE_NSFR   5
 143
 144 struct ccstate {
 145         uint16_t        mask;
 146         uint8_t         acc;
 147         uint8_t         sfr[CC_STATE_NSFR];
 148 };
 149
 150 #define HEX_RECORD_NORMAL               0x00
 151 #define HEX_RECORD_EOF                  0x01
 152 #define HEX_RECORD_EXTENDED_ADDRESS     0x02
 153
 154 /* CC1111 debug port commands
 155  */
 156 #define CC_CHIP_ERASE           0x14
 157
 158 #define CC_WR_CONFIG            0x1d
 159 #define CC_RD_CONFIG            0x24
 160 # define CC_CONFIG_TIMERS_OFF           (1 << 3)
 161 # define CC_CONFIG_DMA_PAUSE            (1 << 2)
 162 # define CC_CONFIG_TIMER_SUSPEND        (1 << 1)
 163 # define CC_SET_FLASH_INFO_PAGE         (1 << 0)
 164
 165 #define CC_GET_PC               0x28
 166 #define CC_READ_STATUS          0x34
 167 # define CC_STATUS_CHIP_ERASE_DONE      (1 << 7)
 168 # define CC_STATUS_PCON_IDLE            (1 << 6)
 169 # define CC_STATUS_CPU_HALTED           (1 << 5)
 170 # define CC_STATUS_POWER_MODE_0         (1 << 4)
 171 # define CC_STATUS_HALT_STATUS          (1 << 3)
 172 # define CC_STATUS_DEBUG_LOCKED         (1 << 2)
 173 # define CC_STATUS_OSCILLATOR_STABLE    (1 << 1)
 174 # define CC_STATUS_STACK_OVERFLOW       (1 << 0)
 175
 176 #define CC_SET_HW_BRKPNT        0x3b
 177 # define CC_HW_BRKPNT_N(n)      ((n) << 3)
 178 # define CC_HW_BRKPNT_N_MASK    (0x3 << 3)
 179 # define CC_HW_BRKPNT_ENABLE    (1 << 2)
 180
 181 #define CC_HALT                 0x44
 182 #define CC_RESUME               0x4c
 183 #define CC_DEBUG_INSTR(n)       (0x54|(n))
 184 #define CC_STEP_INSTR           0x5c
 185 #define CC_STEP_REPLACE(n)      (0x64|(n))
 186 #define CC_GET_CHIP_ID          0x68
 187
 188 /* ccdbg-command.c */
 189 void
 190 ccdbg_debug_mode(struct ccdbg *dbg);
 191
 192 void
 193 ccdbg_reset(struct ccdbg *dbg);
 194
 195 uint8_t
 196 ccdbg_chip_erase(struct ccdbg *dbg);
 197
 198 uint8_t
 199 ccdbg_wr_config(struct ccdbg *dbg, uint8_t config);
 200
 201 uint8_t
 202 ccdbg_rd_config(struct ccdbg *dbg);
 203
 204 uint16_t
 205 ccdbg_get_pc(struct ccdbg *dbg);
 206
 207 uint8_t
 208 ccdbg_read_status(struct ccdbg *dbg);
 209
 210 uint8_t
 211 ccdbg_set_hw_brkpnt(struct ccdbg *dbg, uint8_t number, uint8_t enable, uint16_t addr);
 212
 213 uint8_t
 214 ccdbg_halt(struct ccdbg *dbg);
 215
 216 uint8_t
 217 ccdbg_resume(struct ccdbg *dbg);
 218
 219 uint8_t
 220 ccdbg_debug_instr(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 221
 222 uint8_t
 223 ccdbg_step_instr(struct ccdbg *dbg);
 224
 225 uint8_t
 226 ccdbg_step_replace(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 227
 228 uint16_t
 229 ccdbg_get_chip_id(struct ccdbg *dbg);
 230
 231 uint8_t
 232 ccdbg_execute(struct ccdbg *dbg, uint8_t *inst);
 233
 234 uint8_t
 235 ccdbg_set_pc(struct ccdbg *dbg, uint16_t pc);
 236
 237 uint8_t
 238 ccdbg_execute_hex_image(struct ccdbg *dbg, struct hex_image *image);
 239
 240 /* ccdbg-flash.c */
 241 uint8_t
 242 ccdbg_flash_hex_image(struct ccdbg *dbg, struct hex_image *image);
 243
 244 /* ccdbg-hex.c */
 245 struct hex_file *
 246 ccdbg_hex_file_read(FILE *file, char *name);
 247
 248 void
 249 ccdbg_hex_file_free(struct hex_file *hex);
 250
 251 struct hex_image *
 252 ccdbg_hex_image_create(struct hex_file *hex);
 253
 254 void
 255 ccdbg_hex_image_free(struct hex_image *image);
 256
 257 int
 258 ccdbg_hex_image_equal(struct hex_image *a, struct hex_image *b);
 259
 260 /* ccdbg-io.c */
 261 void
 262 ccdbg_half_clock(struct ccdbg *dbg);
 263
 264 int
 265 ccdbg_write(struct ccdbg *dbg, uint8_t mask, uint8_t value);
 266
 267 void
 268 ccdbg_read(struct ccdbg *dbg, uint8_t *valuep);
 269
 270 struct ccdbg *
 271 ccdbg_open(void);
 272
 273 void
 274 ccdbg_close(struct ccdbg *dbg);
 275
 276 void
 277 ccdbg_clock_1_0(struct ccdbg *dbg);
 278
 279 void
 280 ccdbg_clock_0_1(struct ccdbg *dbg);
 281
 282 void
 283 ccdbg_write_bit(struct ccdbg *dbg, uint8_t bit);
 284
 285 void
 286 ccdbg_write_byte(struct ccdbg *dbg, uint8_t byte);
 287
 288 uint8_t
 289 ccdbg_read_bit(struct ccdbg *dbg);
 290
 291 uint8_t
 292 ccdbg_read_byte(struct ccdbg *dbg);
 293
 294 void
 295 ccdbg_cmd_write(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 296
 297 uint8_t
 298 ccdbg_cmd_write_read8(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 299
 300 uint16_t
 301 ccdbg_cmd_write_read16(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 302
 303 void
 304 ccdbg_send(struct ccdbg *dbg, uint8_t mask, uint8_t set);
 305
 306 void
 307 ccdbg_send_bit(struct ccdbg *dbg, uint8_t bit);
 308
 309 void
 310 ccdbg_send_byte(struct ccdbg *dbg, uint8_t byte);
 311
 312 void
 313 ccdbg_send_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
 314
 315 void
 316 ccdbg_recv_bit(struct ccdbg *dbg, int first, uint8_t *bit);
 317
 318 void
 319 ccdbg_recv_byte(struct ccdbg *dbg, int first, uint8_t *byte);
 320
 321 void
 322 ccdbg_recv_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
 323
 324 void
 325 ccdbg_sync_io(struct ccdbg *dbg);
 326
 327 void
 328 ccdbg_print(char *format, uint8_t mask, uint8_t set);
 329
 330 /* ccdbg-manual.c */
 331
 332 void
 333 ccdbg_manual(struct ccdbg *dbg, FILE *input);
 334
 335 /* ccdbg-memory.c */
 336 uint8_t
 337 ccdbg_write_memory(struct ccdbg *dbg, uint16_t addr, uint8_t *bytes, int nbytes);
 338
 339 uint8_t
 340 ccdbg_read_memory(struct ccdbg *dbg, uint16_t addr, uint8_t *bytes, int nbytes);
 341
 342 uint8_t
 343 ccdbg_write_uint8(struct ccdbg *dbg, uint16_t addr, uint8_t byte);
 344
 345 uint8_t
 346 ccdbg_write_hex_image(struct ccdbg *dbg, struct hex_image *image, uint16_t offset);
 347
 348 struct hex_image *
 349 ccdbg_read_hex_image(struct ccdbg *dbg, uint16_t address, uint16_t length);
 350
 351 uint8_t
 352 ccdbg_read_sfr(struct ccdbg *dbg, uint8_t addr, uint8_t *bytes, int nbytes);
 353
 354 uint8_t
 355 ccdbg_write_sfr(struct ccdbg *dbg, uint8_t addr, uint8_t *bytes, int nbytes);
 356
 357 /* ccdbg-rom.c */
 358 uint8_t
 359 ccdbg_set_rom(struct ccdbg *dbg, struct hex_image *rom);
 360
 361 uint8_t
 362 ccdbg_rom_contains(struct ccdbg *dbg, uint16_t addr, int nbytes);
 363
 364 uint8_t
 365 ccdbg_rom_replace_xmem(struct ccdbg *dbg,
 366                        uint16_t addrp, uint8_t *bytesp, int nbytes);
 367
 368 /* ccdbg-state.c */
 369 uint8_t
 370 ccdbg_state_save(struct ccdbg *dbg, struct ccstate *state, unsigned int mask);
 371
 372 uint8_t
 373 ccdbg_state_restore(struct ccdbg *dbg, struct ccstate *state);
 374
 375 void
 376 ccdbg_state_replace_xmem(struct ccdbg *dbg, struct ccstate *state,
 377                          uint16_t addr, uint8_t *bytes, int nbytes);
 378
 379 void
 380 ccdbg_state_replace_sfr(struct ccdbg *dbg, struct ccstate *state,
 381                         uint8_t addr, uint8_t *bytes, int nbytes);
 382
 383 #endif /* _CCDBG_H_ */