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