Clean up bitbanging layer. Add debug printfs.
[fw/altos] / 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     (1000)
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         (0x64|(n))
92 #define CC_GET_CHIP_ID          0x68
93
94 #define CC_DEBUG_BITBANG        0x00000001
95 #define CC_DEBUG_COMMAND        0x00000002
96
97 /* ccdbg-command.c */
98 void
99 ccdbg_debug_mode(struct ccdbg *dbg);
100
101 void
102 ccdbg_reset(struct ccdbg *dbg);
103
104 uint8_t
105 ccdbg_read_status(struct ccdbg *dbg);
106
107 uint8_t
108 ccdbg_rd_config(struct ccdbg *dbg);
109
110 uint16_t
111 ccdbg_get_chip_id(struct ccdbg *dbg);
112
113 /* ccdbg-debug.c */
114 void
115 ccdbg_debug(int level, char *format, ...);
116
117 void
118 ccdbg_add_debug(int level);
119
120 void
121 ccdbg_clear_debug(int level);
122
123 /* ccdbg-io.c */
124 void
125 ccdbg_quarter_clock(struct ccdbg *dbg);
126
127 void
128 ccdbg_half_clock(struct ccdbg *dbg);
129
130 int
131 ccdbg_write(struct ccdbg *dbg, uint8_t mask, uint8_t value);
132
133 uint8_t
134 ccdbg_read(struct ccdbg *dbg);
135
136 struct ccdbg *
137 ccdbg_open(char *file);
138
139 void
140 ccdbg_close(struct ccdbg *dbg);
141
142 void
143 ccdbg_clock_1_0(struct ccdbg *dbg);
144
145 void
146 ccdbg_clock_0_1(struct ccdbg *dbg);
147
148 void
149 ccdbg_write_bit(struct ccdbg *dbg, uint8_t bit);
150
151 void
152 ccdbg_write_byte(struct ccdbg *dbg, uint8_t byte);
153
154 uint8_t
155 ccdbg_read_bit(struct ccdbg *dbg);
156
157 uint8_t
158 ccdbg_read_byte(struct ccdbg *dbg);
159
160 void
161 ccdbg_cmd_write(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
162
163 uint8_t
164 ccdbg_cmd_write_read8(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
165
166 uint16_t
167 ccdbg_cmd_write_read16(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
168
169 void
170 ccdbg_send(struct ccdbg *dbg, uint8_t mask, uint8_t set);
171
172 void
173 ccdbg_send_bit(struct ccdbg *dbg, uint8_t bit);
174
175 void
176 ccdbg_send_byte(struct ccdbg *dbg, uint8_t byte);
177
178 void
179 ccdbg_send_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
180
181 uint8_t
182 ccdbg_recv_bit(struct ccdbg *dbg, int first);
183
184 uint8_t
185 ccdbg_recv_byte(struct ccdbg *dbg, int first);
186
187 void
188 ccdbg_recv_bytes(struct ccdbg *dbg, uint8_t *bytes, int nbytes);
189
190 void
191 ccdbg_print(char *format, uint8_t mask, uint8_t set);
192
193 /* ccdbg-manual.c */
194
195 void
196 ccdbg_manual(struct ccdbg *dbg, FILE *input);
197
198 /* cp-usb.c */
199 void
200 cp_usb_init(struct ccdbg *dbg);
201
202 void
203 cp_usb_fini(struct ccdbg *dbg);
204
205 void
206 cp_usb_write(struct ccdbg *dbg, uint8_t mask, uint8_t value);
207
208 uint8_t
209 cp_usb_read(struct ccdbg *dbg);
210
211 #endif /* _CCDBG_H_ */