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