c426f87a1e37d105f500879179b7f61cc4c638bc
[openocd.git] / src / jtag / hla / hla_interface.c
1 /***************************************************************************
2 * Copyright (C) 2011 by Mathias Kuester *
3 * Mathias Kuester <kesmtp@freenet.de> *
4 * *
5 * Copyright (C) 2012 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
22 ***************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 #include "config.h"
26 #endif
27
28 /* project specific includes */
29 #include <jtag/interface.h>
30 #include <transport/transport.h>
31 #include <helper/time_support.h>
32
33 #include <jtag/hla/hla_tcl.h>
34 #include <jtag/hla/hla_layout.h>
35 #include <jtag/hla/hla_transport.h>
36 #include <jtag/hla/hla_interface.h>
37
38 #include <target/target.h>
39
40 static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, HL_TRANSPORT_UNKNOWN, false, NULL, 0, -1}, 0, 0 };
41
42 int hl_interface_open(enum hl_transports tr)
43 {
44 LOG_DEBUG("hl_interface_open");
45
46 enum reset_types jtag_reset_config = jtag_get_reset_config();
47
48 if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
49 if (jtag_reset_config & RESET_SRST_NO_GATING)
50 hl_if.param.connect_under_reset = true;
51 else
52 LOG_WARNING("\'srst_nogate\' reset_config option is required");
53 }
54
55 /* set transport mode */
56 hl_if.param.transport = tr;
57
58 int result = hl_if.layout->open(&hl_if);
59 if (result != ERROR_OK)
60 return result;
61
62 return hl_interface_init_reset();
63 }
64
65 int hl_interface_init_target(struct target *t)
66 {
67 int res;
68
69 LOG_DEBUG("hl_interface_init_target");
70
71 /* this is the interface for the current target and we
72 * can setup the private pointer in the tap structure
73 * if the interface match the tap idcode
74 */
75 res = hl_if.layout->api->idcode(hl_if.handle, &t->tap->idcode);
76
77 if (res != ERROR_OK)
78 return res;
79
80 unsigned ii, limit = t->tap->expected_ids_cnt;
81 int found = 0;
82
83 for (ii = 0; ii < limit; ii++) {
84 uint32_t expected = t->tap->expected_ids[ii];
85
86 /* treat "-expected-id 0" as a "don't-warn" wildcard */
87 if (!expected || !t->tap->idcode ||
88 (t->tap->idcode == expected)) {
89 found = 1;
90 break;
91 }
92 }
93
94 if (found == 0) {
95 LOG_WARNING("UNEXPECTED idcode: 0x%08" PRIx32, t->tap->idcode);
96 for (ii = 0; ii < limit; ii++)
97 LOG_ERROR("expected %u of %u: 0x%08" PRIx32, ii + 1, limit,
98 t->tap->expected_ids[ii]);
99
100 return ERROR_FAIL;
101 }
102
103 t->tap->priv = &hl_if;
104 t->tap->hasidcode = 1;
105
106 return ERROR_OK;
107 }
108
109 static int hl_interface_init(void)
110 {
111 LOG_DEBUG("hl_interface_init");
112
113 /* here we can initialize the layout */
114 return hl_layout_init(&hl_if);
115 }
116
117 static int hl_interface_quit(void)
118 {
119 LOG_DEBUG("hl_interface_quit");
120
121 if (hl_if.param.trace_f) {
122 fclose(hl_if.param.trace_f);
123 hl_if.param.trace_f = NULL;
124 }
125 hl_if.param.trace_source_hz = 0;
126
127 return ERROR_OK;
128 }
129
130 static int hl_interface_execute_queue(void)
131 {
132 LOG_DEBUG("hl_interface_execute_queue: ignored");
133
134 return ERROR_OK;
135 }
136
137 int hl_interface_init_reset(void)
138 {
139 /* incase the adapter has not already handled asserting srst
140 * we will attempt it again */
141 if (hl_if.param.connect_under_reset) {
142 jtag_add_reset(0, 1);
143 hl_if.layout->api->assert_srst(hl_if.handle, 0);
144 } else {
145 jtag_add_reset(0, 0);
146 }
147
148 return ERROR_OK;
149 }
150
151 static int hl_interface_khz(int khz, int *jtag_speed)
152 {
153 *jtag_speed = hl_if.layout->api->speed(hl_if.handle, khz, true);
154 return ERROR_OK;
155 }
156
157 static int hl_interface_speed_div(int speed, int *khz)
158 {
159 *khz = speed;
160 return ERROR_OK;
161 }
162
163 static int hl_interface_speed(int speed)
164 {
165 if (hl_if.layout->api->speed == NULL)
166 return ERROR_OK;
167
168 if (hl_if.handle == NULL) {
169 /* pass speed as initial param as interface not open yet */
170 hl_if.param.initial_interface_speed = speed;
171 return ERROR_OK;
172 }
173
174 hl_if.layout->api->speed(hl_if.handle, speed, false);
175
176 return ERROR_OK;
177 }
178
179 int hl_interface_override_target(const char **targetname)
180 {
181 if (hl_if.layout->api->override_target) {
182 if (hl_if.layout->api->override_target(*targetname)) {
183 *targetname = "hla_target";
184 return ERROR_OK;
185 } else
186 return ERROR_FAIL;
187 }
188 return ERROR_FAIL;
189 }
190
191 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
192 {
193 LOG_DEBUG("hl_interface_handle_device_desc_command");
194
195 if (CMD_ARGC == 1) {
196 hl_if.param.device_desc = strdup(CMD_ARGV[0]);
197 } else {
198 LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
199 }
200
201 return ERROR_OK;
202 }
203
204 COMMAND_HANDLER(hl_interface_handle_serial_command)
205 {
206 LOG_DEBUG("hl_interface_handle_serial_command");
207
208 if (CMD_ARGC == 1) {
209 hl_if.param.serial = strdup(CMD_ARGV[0]);
210 } else {
211 LOG_ERROR("expected exactly one argument to hl_serial <serial-number>");
212 }
213
214 return ERROR_OK;
215 }
216
217 COMMAND_HANDLER(hl_interface_handle_layout_command)
218 {
219 LOG_DEBUG("hl_interface_handle_layout_command");
220
221 if (CMD_ARGC != 1) {
222 LOG_ERROR("Need exactly one argument to stlink_layout");
223 return ERROR_COMMAND_SYNTAX_ERROR;
224 }
225
226 if (hl_if.layout) {
227 LOG_ERROR("already specified hl_layout %s",
228 hl_if.layout->name);
229 return (strcmp(hl_if.layout->name, CMD_ARGV[0]) != 0)
230 ? ERROR_FAIL : ERROR_OK;
231 }
232
233 for (const struct hl_layout *l = hl_layout_get_list(); l->name;
234 l++) {
235 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
236 hl_if.layout = l;
237 return ERROR_OK;
238 }
239 }
240
241 LOG_ERROR("No adapter layout '%s' found", CMD_ARGV[0]);
242 return ERROR_FAIL;
243 }
244
245 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
246 {
247 LOG_DEBUG("hl_interface_handle_vid_pid_command");
248
249 if (CMD_ARGC != 2) {
250 LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
251 return ERROR_COMMAND_SYNTAX_ERROR;
252 }
253
254 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
255 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
256
257 return ERROR_OK;
258 }
259
260 COMMAND_HANDLER(interface_handle_trace_command)
261 {
262 FILE *f = NULL;
263 unsigned source_hz;
264
265 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
266 return ERROR_COMMAND_SYNTAX_ERROR;
267
268 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], source_hz);
269 if (source_hz == 0) {
270 return ERROR_COMMAND_SYNTAX_ERROR;
271 }
272
273 if (CMD_ARGC == 2) {
274 f = fopen(CMD_ARGV[1], "a");
275 if (!f)
276 return ERROR_COMMAND_SYNTAX_ERROR;
277 }
278
279 hl_if.param.trace_f = f;
280 hl_if.param.trace_source_hz = source_hz;
281
282 return ERROR_OK;
283 }
284
285 COMMAND_HANDLER(interface_handle_hla_command)
286 {
287 if (CMD_ARGC != 1)
288 return ERROR_COMMAND_SYNTAX_ERROR;
289
290 if (!hl_if.layout->api->custom_command) {
291 LOG_ERROR("The selected adapter doesn't support custom commands");
292 return ERROR_FAIL;
293 }
294
295 hl_if.layout->api->custom_command(hl_if.handle, CMD_ARGV[0]);
296
297 return ERROR_OK;
298 }
299
300 static const struct command_registration hl_interface_command_handlers[] = {
301 {
302 .name = "hla_device_desc",
303 .handler = &hl_interface_handle_device_desc_command,
304 .mode = COMMAND_CONFIG,
305 .help = "set the a device description of the adapter",
306 .usage = "description_string",
307 },
308 {
309 .name = "hla_serial",
310 .handler = &hl_interface_handle_serial_command,
311 .mode = COMMAND_CONFIG,
312 .help = "set the serial number of the adapter",
313 .usage = "serial_string",
314 },
315 {
316 .name = "hla_layout",
317 .handler = &hl_interface_handle_layout_command,
318 .mode = COMMAND_CONFIG,
319 .help = "set the layout of the adapter",
320 .usage = "layout_name",
321 },
322 {
323 .name = "hla_vid_pid",
324 .handler = &hl_interface_handle_vid_pid_command,
325 .mode = COMMAND_CONFIG,
326 .help = "the vendor and product ID of the adapter",
327 .usage = "(vid pid)* ",
328 },
329 {
330 .name = "trace",
331 .handler = &interface_handle_trace_command,
332 .mode = COMMAND_CONFIG,
333 .help = "configure trace reception",
334 .usage = "source_lock_hz [destination_path]",
335 },
336 {
337 .name = "hla_command",
338 .handler = &interface_handle_hla_command,
339 .mode = COMMAND_EXEC,
340 .help = "execute a custom adapter-specific command",
341 .usage = "hla_command <command>",
342 },
343 COMMAND_REGISTRATION_DONE
344 };
345
346 struct jtag_interface hl_interface = {
347 .name = "hla",
348 .supported = 0,
349 .commands = hl_interface_command_handlers,
350 .transports = hl_transports,
351 .init = hl_interface_init,
352 .quit = hl_interface_quit,
353 .execute_queue = hl_interface_execute_queue,
354 .speed = &hl_interface_speed,
355 .khz = &hl_interface_khz,
356 .speed_div = &hl_interface_speed_div,
357 };

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)