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