jtag: fix support for really long scans
[openocd.git] / src / jtag / commands.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2009 SoftPLC Corporation *
9 * http://softplc.com *
10 * dick@softplc.com *
11 * *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
14 * *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
19 * *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
24 * *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
29 ***************************************************************************/
30
31 #ifdef HAVE_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #include <jtag/jtag.h>
36 #include "commands.h"
37
38 struct cmd_queue_page {
39 void *address;
40 size_t used;
41 struct cmd_queue_page *next;
42 };
43
44 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
45 static struct cmd_queue_page *cmd_queue_pages;
46
47 struct jtag_command *jtag_command_queue;
48 static struct jtag_command **next_command_pointer = &jtag_command_queue;
49
50 void jtag_queue_command(struct jtag_command *cmd)
51 {
52 /* this command goes on the end, so ensure the queue terminates */
53 cmd->next = NULL;
54
55 struct jtag_command **last_cmd = next_command_pointer;
56 assert(NULL != last_cmd);
57 assert(NULL == *last_cmd);
58 *last_cmd = cmd;
59
60 /* store location where the next command pointer will be stored */
61 next_command_pointer = &cmd->next;
62 }
63
64 void *cmd_queue_alloc(size_t size)
65 {
66 struct cmd_queue_page **p_page = &cmd_queue_pages;
67 int offset;
68 uint8_t *t;
69
70 /*
71 * WARNING:
72 * We align/round the *SIZE* per below
73 * so that all pointers returned by
74 * this function are reasonably well
75 * aligned.
76 *
77 * If we did not, then an "odd-length" request would cause the
78 * *next* allocation to be at an *odd* address, and because
79 * this function has the same type of api as malloc() - we
80 * must also return pointers that have the same type of
81 * alignment.
82 *
83 * What I do not/have is a reasonable portable means
84 * to align by...
85 *
86 * The solution here, is based on these suggestions.
87 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
88 *
89 */
90 union worse_case_align {
91 int i;
92 long l;
93 float f;
94 void *v;
95 };
96 #define ALIGN_SIZE (sizeof(union worse_case_align))
97
98 /* The alignment process. */
99 size = (size + ALIGN_SIZE - 1) & (~(ALIGN_SIZE - 1));
100 /* Done... */
101
102 if (*p_page) {
103 while ((*p_page)->next)
104 p_page = &((*p_page)->next);
105 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
106 p_page = &((*p_page)->next);
107 }
108
109 if (!*p_page) {
110 *p_page = malloc(sizeof(struct cmd_queue_page));
111 (*p_page)->used = 0;
112 size_t alloc_size = (size < CMD_QUEUE_PAGE_SIZE) ?
113 CMD_QUEUE_PAGE_SIZE : size;
114 (*p_page)->address = malloc(alloc_size);
115 (*p_page)->next = NULL;
116 }
117
118 offset = (*p_page)->used;
119 (*p_page)->used += size;
120
121 t = (*p_page)->address;
122 return t + offset;
123 }
124
125 static void cmd_queue_free(void)
126 {
127 struct cmd_queue_page *page = cmd_queue_pages;
128
129 while (page) {
130 struct cmd_queue_page *last = page;
131 free(page->address);
132 page = page->next;
133 free(last);
134 }
135
136 cmd_queue_pages = NULL;
137 }
138
139 void jtag_command_queue_reset(void)
140 {
141 cmd_queue_free();
142
143 jtag_command_queue = NULL;
144 next_command_pointer = &jtag_command_queue;
145 }
146
147 enum scan_type jtag_scan_type(const struct scan_command *cmd)
148 {
149 int i;
150 int type = 0;
151
152 for (i = 0; i < cmd->num_fields; i++) {
153 if (cmd->fields[i].in_value)
154 type |= SCAN_IN;
155 if (cmd->fields[i].out_value)
156 type |= SCAN_OUT;
157 }
158
159 return type;
160 }
161
162 int jtag_scan_size(const struct scan_command *cmd)
163 {
164 int bit_count = 0;
165 int i;
166
167 /* count bits in scan command */
168 for (i = 0; i < cmd->num_fields; i++)
169 bit_count += cmd->fields[i].num_bits;
170
171 return bit_count;
172 }
173
174 int jtag_build_buffer(const struct scan_command *cmd, uint8_t **buffer)
175 {
176 int bit_count = 0;
177 int i;
178
179 bit_count = jtag_scan_size(cmd);
180 *buffer = calloc(1, DIV_ROUND_UP(bit_count, 8));
181
182 bit_count = 0;
183
184 DEBUG_JTAG_IO("%s num_fields: %i",
185 cmd->ir_scan ? "IRSCAN" : "DRSCAN",
186 cmd->num_fields);
187
188 for (i = 0; i < cmd->num_fields; i++) {
189 if (cmd->fields[i].out_value) {
190 #ifdef _DEBUG_JTAG_IO_
191 char *char_buf = buf_to_str(cmd->fields[i].out_value,
192 (cmd->fields[i].num_bits > DEBUG_JTAG_IOZ)
193 ? DEBUG_JTAG_IOZ
194 : cmd->fields[i].num_bits, 16);
195
196 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i,
197 cmd->fields[i].num_bits, char_buf);
198 free(char_buf);
199 #endif
200 buf_set_buf(cmd->fields[i].out_value, 0, *buffer,
201 bit_count, cmd->fields[i].num_bits);
202 } else {
203 DEBUG_JTAG_IO("fields[%i].out_value[%i]: NULL",
204 i, cmd->fields[i].num_bits);
205 }
206
207 bit_count += cmd->fields[i].num_bits;
208 }
209
210 /*DEBUG_JTAG_IO("bit_count totalling: %i", bit_count); */
211
212 return bit_count;
213 }
214
215 int jtag_read_buffer(uint8_t *buffer, const struct scan_command *cmd)
216 {
217 int i;
218 int bit_count = 0;
219 int retval;
220
221 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
222 retval = ERROR_OK;
223
224 for (i = 0; i < cmd->num_fields; i++) {
225 /* if neither in_value nor in_handler
226 * are specified we don't have to examine this field
227 */
228 if (cmd->fields[i].in_value) {
229 int num_bits = cmd->fields[i].num_bits;
230 uint8_t *captured = buf_set_buf(buffer, bit_count,
231 malloc(DIV_ROUND_UP(num_bits, 8)), 0, num_bits);
232
233 #ifdef _DEBUG_JTAG_IO_
234 char *char_buf = buf_to_str(captured,
235 (num_bits > DEBUG_JTAG_IOZ)
236 ? DEBUG_JTAG_IOZ
237 : num_bits, 16);
238
239 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s",
240 i, num_bits, char_buf);
241 free(char_buf);
242 #endif
243
244 if (cmd->fields[i].in_value)
245 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
246
247 free(captured);
248 }
249 bit_count += cmd->fields[i].num_bits;
250 }
251
252 return retval;
253 }