1 /***************************************************************************
2 * Copyright (C) 2016 by Matthias Welwarsky *
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. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
18 ***************************************************************************/
26 #include "target/arm_adi_v5.h"
27 #include "target/arm.h"
28 #include "helper/list.h"
29 #include "helper/command.h"
30 #include "transport/transport.h"
31 #include "jtag/interface.h"
33 static LIST_HEAD(all_dap);
35 extern const struct dap_ops swd_dap_ops;
36 extern const struct dap_ops jtag_dp_ops;
37 extern struct adapter_driver *adapter_driver;
39 /* DAP command support */
40 struct arm_dap_object {
44 const struct swd_driver *swd;
47 static void dap_instance_init(struct adiv5_dap *dap)
50 /* Set up with safe defaults */
51 for (i = 0; i <= DP_APSEL_MAX; i++) {
53 dap->ap[i].ap_num = DP_APSEL_INVALID;
54 /* memaccess_tck max is 255 */
55 dap->ap[i].memaccess_tck = 255;
56 /* Number of bits for tar autoincrement, impl. dep. at least 10 */
57 dap->ap[i].tar_autoincr_block = (1<<10);
58 /* default CSW value */
59 dap->ap[i].csw_default = CSW_AHB_DEFAULT;
60 dap->ap[i].cfg_reg = MEM_AP_REG_CFG_INVALID; /* mem_ap configuration reg (large physical addr, etc.) */
61 dap->ap[i].refcount = 0;
62 dap->ap[i].config_ap_never_release = false;
64 INIT_LIST_HEAD(&dap->cmd_journal);
65 INIT_LIST_HEAD(&dap->cmd_pool);
68 const char *adiv5_dap_name(struct adiv5_dap *self)
70 struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
74 const struct swd_driver *adiv5_dap_swd_driver(struct adiv5_dap *self)
76 struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
80 struct adiv5_dap *adiv5_get_dap(struct arm_dap_object *obj)
84 struct adiv5_dap *dap_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
86 struct arm_dap_object *obj = NULL;
90 name = Jim_GetString(o, NULL);
92 list_for_each_entry(obj, &all_dap, lh) {
93 if (!strcmp(name, obj->name)) {
104 static int dap_init_all(void)
106 struct arm_dap_object *obj;
109 LOG_DEBUG("Initializing all DAPs ...");
111 list_for_each_entry(obj, &all_dap, lh) {
112 struct adiv5_dap *dap = &obj->dap;
114 /* with hla, dap is just a dummy */
115 if (transport_is_hla())
118 /* skip taps that are disabled */
119 if (!dap->tap->enabled)
122 if (transport_is_swd()) {
123 dap->ops = &swd_dap_ops;
124 obj->swd = adapter_driver->swd_ops;
125 } else if (transport_is_dapdirect_swd()) {
126 dap->ops = adapter_driver->dap_swd_ops;
127 } else if (transport_is_dapdirect_jtag()) {
128 dap->ops = adapter_driver->dap_jtag_ops;
130 dap->ops = &jtag_dp_ops;
132 if (dap->adi_version == 0) {
133 LOG_DEBUG("DAP %s configured by default to use ADIv5 protocol", jtag_tap_name(dap->tap));
134 dap->adi_version = 5;
136 LOG_DEBUG("DAP %s configured to use %s protocol by user cfg file", jtag_tap_name(dap->tap),
137 is_adiv6(dap) ? "ADIv6" : "ADIv5");
140 retval = dap->ops->connect(dap);
141 if (retval != ERROR_OK)
144 /* see if address size of ROM Table is greater than 32-bits */
148 retval = dap->ops->queue_dp_read(dap, DP_DPIDR1, &dpidr1);
149 if (retval != ERROR_OK) {
150 LOG_ERROR("DAP read of DPIDR1 failed...");
153 retval = dap_run(dap);
154 if (retval != ERROR_OK) {
155 LOG_ERROR("DAP read of DPIDR1 failed...");
158 dap->asize = dpidr1 & DP_DPIDR1_ASIZE_MASK;
165 int dap_cleanup_all(void)
167 struct arm_dap_object *obj, *tmp;
168 struct adiv5_dap *dap;
170 list_for_each_entry_safe(obj, tmp, &all_dap, lh) {
172 for (unsigned int i = 0; i <= DP_APSEL_MAX; i++) {
173 if (dap->ap[i].refcount != 0)
174 LOG_ERROR("BUG: refcount AP#%u still %u at exit", i, dap->ap[i].refcount);
176 if (dap->ops && dap->ops->quit)
188 CFG_IGNORE_SYSPWRUPACK,
195 static const struct jim_nvp nvp_config_opts[] = {
196 { .name = "-chain-position", .value = CFG_CHAIN_POSITION },
197 { .name = "-ignore-syspwrupack", .value = CFG_IGNORE_SYSPWRUPACK },
198 { .name = "-dp-id", .value = CFG_DP_ID },
199 { .name = "-instance-id", .value = CFG_INSTANCE_ID },
200 { .name = "-adiv6", .value = CFG_ADIV6 },
201 { .name = "-adiv5", .value = CFG_ADIV5 },
202 { .name = NULL, .value = -1 }
205 static int dap_configure(struct jim_getopt_info *goi, struct arm_dap_object *dap)
210 /* parse config ... */
211 while (goi->argc > 0) {
212 Jim_SetEmptyResult(goi->interp);
214 e = jim_getopt_nvp(goi, nvp_config_opts, &n);
216 jim_getopt_nvp_unknown(goi, nvp_config_opts, 0);
220 case CFG_CHAIN_POSITION: {
222 e = jim_getopt_obj(goi, &o_t);
226 struct jtag_tap *tap;
227 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
229 Jim_SetResultString(goi->interp, "-chain-position is invalid", -1);
236 case CFG_IGNORE_SYSPWRUPACK:
237 dap->dap.ignore_syspwrupack = true;
241 e = jim_getopt_wide(goi, &w);
243 Jim_SetResultFormatted(goi->interp,
244 "create %s: bad parameter %s",
248 if (w < 0 || w > DP_TARGETSEL_DPID_MASK) {
249 Jim_SetResultFormatted(goi->interp,
250 "create %s: %s out of range",
254 dap->dap.multidrop_targetsel =
255 (dap->dap.multidrop_targetsel & DP_TARGETSEL_INSTANCEID_MASK)
256 | (w & DP_TARGETSEL_DPID_MASK);
257 dap->dap.multidrop_dp_id_valid = true;
260 case CFG_INSTANCE_ID: {
262 e = jim_getopt_wide(goi, &w);
264 Jim_SetResultFormatted(goi->interp,
265 "create %s: bad parameter %s",
269 if (w < 0 || w > 15) {
270 Jim_SetResultFormatted(goi->interp,
271 "create %s: %s out of range",
275 dap->dap.multidrop_targetsel =
276 (dap->dap.multidrop_targetsel & DP_TARGETSEL_DPID_MASK)
277 | ((w << DP_TARGETSEL_INSTANCEID_SHIFT) & DP_TARGETSEL_INSTANCEID_MASK);
278 dap->dap.multidrop_instance_id_valid = true;
282 dap->dap.adi_version = 6;
285 dap->dap.adi_version = 5;
295 static int dap_check_config(struct adiv5_dap *dap)
297 if (transport_is_jtag() || transport_is_dapdirect_jtag() || transport_is_hla())
300 struct arm_dap_object *obj;
301 bool new_multidrop = dap_is_multidrop(dap);
302 bool had_multidrop = new_multidrop;
303 uint32_t targetsel = dap->multidrop_targetsel;
304 unsigned int non_multidrop_count = had_multidrop ? 0 : 1;
306 list_for_each_entry(obj, &all_dap, lh) {
307 struct adiv5_dap *dap_it = &obj->dap;
309 if (transport_is_swd()) {
310 if (dap_is_multidrop(dap_it)) {
311 had_multidrop = true;
312 if (new_multidrop && dap_it->multidrop_targetsel == targetsel) {
313 uint32_t dp_id = targetsel & DP_TARGETSEL_DPID_MASK;
314 uint32_t instance_id = targetsel >> DP_TARGETSEL_INSTANCEID_SHIFT;
315 LOG_ERROR("%s and %s have the same multidrop selectors -dp-id 0x%08"
316 PRIx32 " and -instance-id 0x%" PRIx32,
317 obj->name, adiv5_dap_name(dap),
322 non_multidrop_count++;
324 } else if (transport_is_dapdirect_swd()) {
325 non_multidrop_count++;
329 if (non_multidrop_count > 1) {
330 LOG_ERROR("Two or more SWD non multidrop DAPs are not supported");
333 if (had_multidrop && non_multidrop_count) {
334 LOG_ERROR("Mixing of SWD multidrop DAPs and non multidrop DAPs is not supported");
341 static int dap_create(struct jim_getopt_info *goi)
343 struct command_context *cmd_ctx;
344 static struct arm_dap_object *dap;
350 cmd_ctx = current_command_context(goi->interp);
354 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ..options...");
358 jim_getopt_obj(goi, &new_cmd);
359 /* does this command exist? */
360 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_NONE);
362 cp = Jim_GetString(new_cmd, NULL);
363 Jim_SetResultFormatted(goi->interp, "Command: %s Exists", cp);
368 dap = calloc(1, sizeof(struct arm_dap_object));
372 dap_instance_init(&dap->dap);
374 cp = Jim_GetString(new_cmd, NULL);
375 dap->name = strdup(cp);
377 e = dap_configure(goi, dap);
382 Jim_SetResultString(goi->interp, "-chain-position required when creating DAP", -1);
387 e = dap_check_config(&dap->dap);
393 struct command_registration dap_create_commands[] = {
397 .help = "dap instance command group",
399 .chain = dap_instance_commands,
401 COMMAND_REGISTRATION_DONE
404 /* don't expose the instance commands when using hla */
405 if (transport_is_hla())
406 dap_create_commands[0].chain = NULL;
408 e = register_commands_with_data(cmd_ctx, NULL, dap_create_commands, dap);
414 list_add_tail(&dap->lh, &all_dap);
424 static int jim_dap_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
426 struct jim_getopt_info goi;
427 jim_getopt_setup(&goi, interp, argc - 1, argv + 1);
429 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
430 "<name> [<dap_options> ...]");
433 return dap_create(&goi);
436 static int jim_dap_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
438 struct arm_dap_object *obj;
441 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
444 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
445 list_for_each_entry(obj, &all_dap, lh) {
446 Jim_ListAppendElement(interp, Jim_GetResult(interp),
447 Jim_NewStringObj(interp, obj->name, -1));
452 COMMAND_HANDLER(handle_dap_init)
454 return dap_init_all();
457 COMMAND_HANDLER(handle_dap_info_command)
459 struct target *target = get_current_target(CMD_CTX);
460 struct arm *arm = target_to_arm(target);
461 struct adiv5_dap *dap = arm->dap;
465 LOG_ERROR("DAP instance not available. Probably a HLA target...");
466 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
474 if (!strcmp(CMD_ARGV[0], "root")) {
475 if (!is_adiv6(dap)) {
476 command_print(CMD, "Option \"root\" not allowed with ADIv5 DAP");
477 return ERROR_COMMAND_ARGUMENT_INVALID;
479 int retval = adiv6_dap_read_baseptr(CMD, dap, &apsel);
480 if (retval != ERROR_OK) {
481 command_print(CMD, "Failed reading DAP baseptr");
486 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
487 if (!is_ap_num_valid(dap, apsel))
488 return ERROR_COMMAND_SYNTAX_ERROR;
491 return ERROR_COMMAND_SYNTAX_ERROR;
494 struct adiv5_ap *ap = dap_get_ap(dap, apsel);
496 command_print(CMD, "Cannot get AP");
499 int retval = dap_info_command(CMD, ap);
504 static const struct command_registration dap_subcommand_handlers[] = {
508 .jim_handler = jim_dap_create,
509 .usage = "name '-chain-position' name",
510 .help = "Creates a new DAP instance",
515 .jim_handler = jim_dap_names,
517 .help = "Lists all registered DAP instances by name",
522 .handler = handle_dap_init,
524 .help = "Initialize all registered DAP instances"
528 .handler = handle_dap_info_command,
529 .mode = COMMAND_EXEC,
530 .help = "display ROM table for specified MEM-AP (default MEM-AP of current target) "
531 "or the ADIv6 root ROM table of current target's DAP",
532 .usage = "[ap_num | 'root']",
534 COMMAND_REGISTRATION_DONE
537 static const struct command_registration dap_commands[] = {
540 .mode = COMMAND_CONFIG,
541 .help = "DAP commands",
542 .chain = dap_subcommand_handlers,
545 COMMAND_REGISTRATION_DONE
548 int dap_register_commands(struct command_context *cmd_ctx)
550 return register_commands(cmd_ctx, NULL, dap_commands);