git.gag.com Git - fw/altos/blob - 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 #undef USE_KERNEL
  34 #ifdef USE_KERNEL
  35 #include <cp2101.h>
  36 #define CC_CLOCK        CP2101_GPIO_MASK(0)
  37 #define CC_DATA         CP2101_GPIO_MASK(1)
  38 #define CC_RESET_N      CP2101_GPIO_MASK(2)
  39 #else
  40 #define CC_CLOCK        0x1
  41 #define CC_DATA         0x2
  42 #define CC_RESET_N      0x4
  43 #include <usb.h>
  44 #endif
  45
  46
  47 /* painfully slow for now */
  48 #define CC_CLOCK_US     (50)
  49
  50 struct ccdbg {
  51         usb_dev_handle  *usb_dev;
  52         uint8_t gpio;
  53 #ifdef USE_KERNEL
  54         int     fd;
  55 #endif
  56         uint8_t debug_data;
  57         int     clock;
  58 };
  59
  60 #include "cccp.h"
  61
  62 #define CC_CHIP_ERASE           0x14
  63
  64 #define CC_WR_CONFIG            0x1d
  65 #define CC_RD_CONFIG            0x24
  66 # define CC_CONFIG_TIMERS_OFF           (1 << 3)
  67 # define CC_CONFIG_DMA_PAUSE            (1 << 2)
  68 # define CC_CONFIG_TIMER_SUSPEND        (1 << 1)
  69 # define CC_SET_FLASH_INFO_PAGE         (1 << 0)
  70
  71 #define CC_GET_PC               0x28
  72 #define CC_READ_STATUS          0x34
  73 # define CC_STATUS_CHIP_ERASE_DONE      (1 << 7)
  74 # define CC_STATUS_PCON_IDLE            (1 << 6)
  75 # define CC_STATUS_CPU_HALTED           (1 << 5)
  76 # define CC_STATUS_POWER_MODE_0         (1 << 4)
  77 # define CC_STATUS_HALT_STATUS          (1 << 3)
  78 # define CC_STATUS_DEBUG_LOCKED         (1 << 2)
  79 # define CC_STATUS_OSCILLATOR_STABLE    (1 << 1)
  80 # define CC_STATUS_STACK_OVERFLOW       (1 << 0)
  81
  82 #define CC_SET_HW_BRKPNT        0x3b
  83 # define CC_HW_BRKPNT_N(n)      ((n) << 3)
  84 # define CC_HW_BRKPNT_N_MASK    (0x3 << 3)
  85 # define CC_HW_BRKPNT_ENABLE    (1 << 2)
  86
  87 #define CC_HALT                 0x44
  88 #define CC_RESUME               0x4c
  89 #define CC_DEBUG_INSTR(n)       (0x54|(n))
  90 #define CC_STEP_INSTR           0x5c
  91 #define CC_STEP_REPLACE(n)      (0x64|(n))
  92 #define CC_GET_CHIP_ID          0x68
  93
  94 #define CC_DEBUG_BITBANG        0x00000001
  95 #define CC_DEBUG_COMMAND        0x00000002
  96 #define CC_DEBUG_INSTRUCTIONS   0x00000004
  97
  98 /* ccdbg-command.c */
  99 void
 100 ccdbg_debug_mode(struct ccdbg *dbg);
 101
 102 void
 103 ccdbg_reset(struct ccdbg *dbg);
 104
 105 uint8_t
 106 ccdbg_chip_erase(struct ccdbg *dbg);
 107
 108 uint8_t
 109 ccdbg_wr_config(struct ccdbg *dbg, uint8_t config);
 110
 111 uint8_t
 112 ccdbg_rd_config(struct ccdbg *dbg);
 113
 114 uint8_t
 115 ccdbg_get_pc(struct ccdbg *dbg);
 116
 117 uint8_t
 118 ccdbg_read_status(struct ccdbg *dbg);
 119
 120 uint8_t
 121 ccdbg_set_hw_brkpnt(struct ccdbg *dbg, uint8_t number, uint8_t enable, uint16_t addr);
 122
 123 uint8_t
 124 ccdbg_halt(struct ccdbg *dbg);
 125
 126 uint8_t
 127 ccdbg_resume(struct ccdbg *dbg);
 128
 129 uint8_t
 130 ccdbg_debug_instr(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 131
 132 uint8_t
 133 ccdbg_step_instr(struct ccdbg *dbg);
 134
 135 uint8_t
 136 ccdbg_step_replace(struct ccdbg *dbg, uint8_t *instr, int nbytes);
 137
 138 uint16_t
 139 ccdbg_get_chip_id(struct ccdbg *dbg);
 140
 141 uint8_t
 142 ccdbg_execute(struct ccdbg *dbg, uint8_t *inst);
 143
 144 /* ccdbg-debug.c */
 145 void
 146 ccdbg_debug(int level, char *format, ...);
 147
 148 void
 149 ccdbg_add_debug(int level);
 150
 151 void
 152 ccdbg_clear_debug(int level);
 153
 154 /* ccdbg-hex.c */
 155 struct hex_record {
 156         uint8_t length;
 157         uint16_t address;
 158         uint8_t type;
 159         uint8_t checksum;
 160         uint8_t data[0];
 161 };
 162
 163 struct hex_file {
 164         int                     nrecord;
 165         struct hex_record       *records[0];
 166 };
 167
 168 #define HEX_RECORD_NORMAL               0x00
 169 #define HEX_RECORD_EOF                  0x01
 170 #define HEX_RECORD_EXTENDED_ADDRESS     0x02
 171
 172 struct hex_file *
 173 ccdbg_hex_file_read(FILE *file, char *name);
 174
 175 void
 176 ccdbg_hex_file_free(struct hex_file *hex);
 177
 178 /* ccdbg-io.c */
 179 void
 180 ccdbg_half_clock(struct ccdbg *dbg);
 181
 182 int
 183 ccdbg_write(struct ccdbg *dbg, uint8_t mask, uint8_t value);
 184
 185 uint8_t
 186 ccdbg_read(struct ccdbg *dbg);
 187
 188 struct ccdbg *
 189 ccdbg_open(char *file);
 190
 191 void
 192 ccdbg_close(struct ccdbg *dbg);
 193
 194 void
 195 ccdbg_clock_1_0(struct ccdbg *dbg);
 196
 197 void
 198 ccdbg_clock_0_1(struct ccdbg *dbg);
 199
 200 void
 201 ccdbg_write_bit(struct ccdbg *dbg, uint8_t bit);
 202
 203 void
 204 ccdbg_write_byte(struct ccdbg *dbg, uint8_t byte);
 205
 206 uint8_t
 207 ccdbg_read_bit(struct ccdbg *dbg);
 208
 209 uint8_t
 210 ccdbg_read_byte(struct ccdbg *dbg);
 211
 212 void
 213 ccdbg_cmd_write(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 214
 215 uint8_t
 216 ccdbg_cmd_write_read8(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 217
 218 uint16_t
 219 ccdbg_cmd_write_read16(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
 220
 221 void
 222 ccdbg_send(struct ccdbg *dbg, uint8_t mask, uint8_t set);
 223
 224 void
 225 ccdbg_send_bit(struct ccdbg *dbg, uint8_t bit);
 226
 227 void
 228 ccdbg_send_byte(struct ccdbg *dbg, uint8_t byte);
 229
 230 void
 231 ccdbg_send_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
 232
 233 uint8_t
 234 ccdbg_recv_bit(struct ccdbg *dbg, int first);
 235
 236 uint8_t
 237 ccdbg_recv_byte(struct ccdbg *dbg, int first);
 238
 239 void
 240 ccdbg_recv_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
 241
 242 void
 243 ccdbg_print(char *format, uint8_t mask, uint8_t set);
 244
 245 /* ccdbg-manual.c */
 246
 247 void
 248 ccdbg_manual(struct ccdbg *dbg, FILE *input);
 249
 250 /* ccdbg-memory.c */
 251 uint8_t
 252 ccdbg_write_memory(struct ccdbg *dbg, uint16_t addr, uint8_t *bytes, int nbytes);
 253
 254 uint8_t
 255 ccdbg_read_memory(struct ccdbg *dbg, uint16_t addr, uint8_t *bytes, int nbytes);
 256
 257 uint8_t
 258 ccdbg_write_hex(struct ccdbg *dbg, struct hex_file *hex);
 259
 260 /* cp-usb.c */
 261 void
 262 cp_usb_init(struct ccdbg *dbg);
 263
 264 void
 265 cp_usb_fini(struct ccdbg *dbg);
 266
 267 void
 268 cp_usb_write(struct ccdbg *dbg, uint8_t mask, uint8_t value);
 269
 270 uint8_t
 271 cp_usb_read(struct ccdbg *dbg);
 272
 273 #endif /* _CCDBG_H_ */