0176a4823820229be5bf75d1c1945094f4c43176
[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}, 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.fd, &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 == expected)) {
88 found = 1;
89 break;
90 }
91 }
92
93 if (found == 0) {
94 LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08x",
95 t->tap->idcode);
96 return ERROR_FAIL;
97 }
98
99 t->tap->priv = &hl_if;
100 t->tap->hasidcode = 1;
101
102 return ERROR_OK;
103 }
104
105 static int hl_interface_init(void)
106 {
107 LOG_DEBUG("hl_interface_init");
108
109 /* here we can initialize the layout */
110 return hl_layout_init(&hl_if);
111 }
112
113 static int hl_interface_quit(void)
114 {
115 LOG_DEBUG("hl_interface_quit");
116
117 if (hl_if.param.trace_f) {
118 fclose(hl_if.param.trace_f);
119 hl_if.param.trace_f = NULL;
120 }
121
122 return ERROR_OK;
123 }
124
125 static int hl_interface_execute_queue(void)
126 {
127 LOG_DEBUG("hl_interface_execute_queue: ignored");
128
129 return ERROR_OK;
130 }
131
132 int hl_interface_init_reset(void)
133 {
134 /* incase the adapter has not already handled asserting srst
135 * we will attempt it again */
136 if (hl_if.param.connect_under_reset) {
137 jtag_add_reset(0, 1);
138 hl_if.layout->api->assert_srst(hl_if.fd, 0);
139 }
140
141 return ERROR_OK;
142 }
143
144 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
145 {
146 LOG_DEBUG("hl_interface_handle_device_desc_command");
147
148 if (CMD_ARGC == 1) {
149 hl_if.param.device_desc = strdup(CMD_ARGV[0]);
150 } else {
151 LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
152 }
153
154 return ERROR_OK;
155 }
156
157 COMMAND_HANDLER(hl_interface_handle_serial_command)
158 {
159 LOG_DEBUG("hl_interface_handle_serial_command");
160
161 if (CMD_ARGC == 1) {
162 hl_if.param.serial = strdup(CMD_ARGV[0]);
163 } else {
164 LOG_ERROR("expected exactly one argument to hl_serial <serial-number>");
165 }
166
167 return ERROR_OK;
168 }
169
170 COMMAND_HANDLER(hl_interface_handle_layout_command)
171 {
172 LOG_DEBUG("hl_interface_handle_layout_command");
173
174 if (CMD_ARGC != 1) {
175 LOG_ERROR("Need exactly one argument to stlink_layout");
176 return ERROR_COMMAND_SYNTAX_ERROR;
177 }
178
179 if (hl_if.layout) {
180 LOG_ERROR("already specified hl_layout %s",
181 hl_if.layout->name);
182 return (strcmp(hl_if.layout->name, CMD_ARGV[0]) != 0)
183 ? ERROR_FAIL : ERROR_OK;
184 }
185
186 for (const struct hl_layout *l = hl_layout_get_list(); l->name;
187 l++) {
188 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
189 hl_if.layout = l;
190 return ERROR_OK;
191 }
192 }
193
194 LOG_ERROR("No adapter layout '%s' found", CMD_ARGV[0]);
195 return ERROR_FAIL;
196 }
197
198 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
199 {
200 LOG_DEBUG("hl_interface_handle_vid_pid_command");
201
202 if (CMD_ARGC != 2) {
203 LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
204 return ERROR_COMMAND_SYNTAX_ERROR;
205 }
206
207 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
208 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
209
210 return ERROR_OK;
211 }
212
213 COMMAND_HANDLER(stlink_interface_handle_api_command)
214 {
215 if (CMD_ARGC != 1)
216 return ERROR_COMMAND_SYNTAX_ERROR;
217
218 unsigned new_api;
219 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
220 if ((new_api == 0) || (new_api > 2))
221 return ERROR_COMMAND_SYNTAX_ERROR;
222
223 hl_if.param.api = new_api;
224
225 return ERROR_OK;
226 }
227
228 COMMAND_HANDLER(interface_handle_trace_command)
229 {
230 FILE *f;
231 unsigned source_hz;
232
233 if (CMD_ARGC != 2)
234 return ERROR_COMMAND_SYNTAX_ERROR;
235
236 f = fopen(CMD_ARGV[0], "a");
237 if (!f)
238 return ERROR_COMMAND_SYNTAX_ERROR;
239
240 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], source_hz);
241 if (source_hz == 0) {
242 fclose(f);
243 return ERROR_COMMAND_SYNTAX_ERROR;
244 }
245
246 hl_if.param.trace_f = f;
247 hl_if.param.trace_source_hz = source_hz;
248
249 return ERROR_OK;
250 }
251
252 static const struct command_registration hl_interface_command_handlers[] = {
253 {
254 .name = "hla_device_desc",
255 .handler = &hl_interface_handle_device_desc_command,
256 .mode = COMMAND_CONFIG,
257 .help = "set the a device description of the adapter",
258 .usage = "description_string",
259 },
260 {
261 .name = "hla_serial",
262 .handler = &hl_interface_handle_serial_command,
263 .mode = COMMAND_CONFIG,
264 .help = "set the serial number of the adapter",
265 .usage = "serial_string",
266 },
267 {
268 .name = "hla_layout",
269 .handler = &hl_interface_handle_layout_command,
270 .mode = COMMAND_CONFIG,
271 .help = "set the layout of the adapter",
272 .usage = "layout_name",
273 },
274 {
275 .name = "hla_vid_pid",
276 .handler = &hl_interface_handle_vid_pid_command,
277 .mode = COMMAND_CONFIG,
278 .help = "the vendor and product ID of the adapter",
279 .usage = "(vid pid)* ",
280 },
281 {
282 .name = "stlink_api",
283 .handler = &stlink_interface_handle_api_command,
284 .mode = COMMAND_CONFIG,
285 .help = "set the desired stlink api level",
286 .usage = "api version 1 or 2",
287 },
288 {
289 .name = "trace",
290 .handler = &interface_handle_trace_command,
291 .mode = COMMAND_CONFIG,
292 .help = "configure trace reception",
293 .usage = "destination_path source_lock_hz",
294 },
295 COMMAND_REGISTRATION_DONE
296 };
297
298 struct jtag_interface hl_interface = {
299 .name = "hla",
300 .supported = 0,
301 .commands = hl_interface_command_handlers,
302 .transports = hl_transports,
303 .init = hl_interface_init,
304 .quit = hl_interface_quit,
305 .execute_queue = hl_interface_execute_queue,
306 };