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