Add prototypes, add stub mainline, add .gitignore
[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 #include <cp2101.h>
34
35 #define CC_DATA         CP2101_GPIO_MASK(0)
36 #define CC_CLOCK        CP2101_GPIO_MASK(1)
37 #define CC_RESET_N      CP2101_GPIO_MASK(2)
38
39 /* painfully slow for now */
40 #define CC_CLOCK_US     (1000 * 1000)
41
42 struct ccdbg {
43         int     fd;
44         uint8_t debug_data;
45         int     clock;
46 };
47
48 #include "cccp.h"
49
50 #define CC_CHIP_ERASE           0x14
51
52 #define CC_WR_CONFIG            0x1d
53 #define CC_RD_CONFIG            0x24
54 # define CC_CONFIG_TIMERS_OFF           (1 << 3)
55 # define CC_CONFIG_DMA_PAUSE            (1 << 2)
56 # define CC_CONFIG_TIMER_SUSPEND        (1 << 1)
57 # define CC_SET_FLASH_INFO_PAGE         (1 << 0)
58
59 #define CC_GET_PC               0x28
60 #define CC_READ_STATUS          0x34
61 # define CC_STATUS_CHIP_ERASE_DONE      (1 << 7)
62 # define CC_STATUS_PCON_IDLE            (1 << 6)
63 # define CC_STATUS_CPU_HALTED           (1 << 5)
64 # define CC_STATUS_POWER_MODE_0         (1 << 4)
65 # define CC_STATUS_HALT_STATUS          (1 << 3)
66 # define CC_STATUS_DEBUG_LOCKED         (1 << 2)
67 # define CC_STATUS_OSCILLATOR_STABLE    (1 << 1)
68 # define CC_STATUS_STACK_OVERFLOW       (1 << 0)
69
70 #define CC_SET_HW_BRKPNT        0x3b
71 # define CC_HW_BRKPNT_N(n)      ((n) << 3)
72 # define CC_HW_BRKPNT_N_MASK    (0x3 << 3)
73 # define CC_HW_BRKPNT_ENABLE    (1 << 2)
74
75 #define CC_HALT                 0x44
76 #define CC_RESUME               0x4c
77 #define CC_DEBUG_INSTR(n)       (0x54|(n))
78 #define CC_STEP_INSTR           0x5c
79 #define CC_STEP_REPLACE         (0x64|(n))
80 #define CC_GET_CHIP_ID          0x68
81
82 /* ccdbg-command.c */
83 void
84 ccdbg_reset(struct ccdbg *dbg);
85
86 uint8_t
87 ccdbg_read_status(struct ccdbg *dbg);
88
89 uint8_t
90 ccdbg_rd_config(struct ccdbg *dbg);
91
92 /* ccdbg-io.c */
93 void
94 ccdbg_quarter_clock(struct ccdbg *dbg);
95
96 struct ccdbg *
97 ccdbg_open(char *file);
98
99 void
100 ccdbg_close(struct ccdbg *dbg);
101
102 void
103 ccdbg_clock_1_0(struct ccdbg *dbg);
104
105 void
106 ccdbg_clock_0_1(struct ccdbg *dbg);
107
108 void
109 ccdbg_write_bit(struct ccdbg *dbg, uint8_t bit);
110
111 void
112 ccdbg_write_byte(struct ccdbg *dbg, uint8_t byte);
113
114 uint8_t
115 ccdbg_read_bit(struct ccdbg *dbg);
116
117 uint8_t
118 ccdbg_read_byte(struct ccdbg *dbg);
119
120 void
121 ccdbg_cmd_write(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
122
123 uint8_t
124 ccdbg_cmd_write_read8(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
125
126 uint16_t
127 ccdbg_cmd_write_read16(struct ccdbg *dbg, uint8_t cmd, uint8_t *data, int len);
128
129 #endif /* _CCDBG_H_ */