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 jtag_interface *jtag_interface;
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 <= 255; i++) {
53 dap->ap[i].ap_num = i;
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);
59 INIT_LIST_HEAD(&dap->cmd_journal);
62 const char *adiv5_dap_name(struct adiv5_dap *self)
64 struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
68 const struct swd_driver *adiv5_dap_swd_driver(struct adiv5_dap *self)
70 struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
74 struct adiv5_dap *adiv5_get_dap(struct arm_dap_object *obj)
78 struct adiv5_dap *dap_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
80 struct arm_dap_object *obj = NULL;
84 name = Jim_GetString(o, NULL);
86 list_for_each_entry(obj, &all_dap, lh) {
87 if (!strcmp(name, obj->name)) {
98 static int dap_init_all(void)
100 struct arm_dap_object *obj;
103 LOG_DEBUG("Initializing all DAPs ...");
105 list_for_each_entry(obj, &all_dap, lh) {
106 struct adiv5_dap *dap = &obj->dap;
108 /* with hla, dap is just a dummy */
109 if (transport_is_hla())
112 /* skip taps that are disabled */
113 if (!dap->tap->enabled)
116 if (transport_is_swd()) {
117 dap->ops = &swd_dap_ops;
118 obj->swd = jtag_interface->swd;
120 dap->ops = &jtag_dp_ops;
122 retval = dap->ops->connect(dap);
123 if (retval != ERROR_OK)
130 int dap_cleanup_all(void)
132 struct arm_dap_object *obj, *tmp;
134 list_for_each_entry_safe(obj, tmp, &all_dap, lh) {
144 CFG_IGNORE_SYSPWRUPACK,
147 static const Jim_Nvp nvp_config_opts[] = {
148 { .name = "-chain-position", .value = CFG_CHAIN_POSITION },
149 { .name = "-ignore-syspwrupack", .value = CFG_IGNORE_SYSPWRUPACK },
150 { .name = NULL, .value = -1 }
153 static int dap_configure(Jim_GetOptInfo *goi, struct arm_dap_object *dap)
155 struct jtag_tap *tap = NULL;
159 /* parse config or cget options ... */
160 while (goi->argc > 0) {
161 Jim_SetEmptyResult(goi->interp);
163 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
165 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
169 case CFG_CHAIN_POSITION: {
171 e = Jim_GetOpt_Obj(goi, &o_t);
174 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
176 Jim_SetResultString(goi->interp, "-chain-position is invalid", -1);
182 case CFG_IGNORE_SYSPWRUPACK:
183 dap->dap.ignore_syspwrupack = true;
191 Jim_SetResultString(goi->interp, "-chain-position required when creating DAP", -1);
195 dap_instance_init(&dap->dap);
201 static int dap_create(Jim_GetOptInfo *goi)
203 struct command_context *cmd_ctx;
204 static struct arm_dap_object *dap;
210 cmd_ctx = current_command_context(goi->interp);
211 assert(cmd_ctx != NULL);
214 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ..options...");
218 Jim_GetOpt_Obj(goi, &new_cmd);
219 /* does this command exist? */
220 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
222 cp = Jim_GetString(new_cmd, NULL);
223 Jim_SetResultFormatted(goi->interp, "Command: %s Exists", cp);
228 dap = calloc(1, sizeof(struct arm_dap_object));
232 e = dap_configure(goi, dap);
238 cp = Jim_GetString(new_cmd, NULL);
239 dap->name = strdup(cp);
241 struct command_registration dap_commands[] = {
245 .help = "dap instance command group",
247 .chain = dap_instance_commands,
249 COMMAND_REGISTRATION_DONE
252 /* don't expose the instance commands when using hla */
253 if (transport_is_hla())
254 dap_commands[0].chain = NULL;
256 e = register_commands(cmd_ctx, NULL, dap_commands);
260 struct command *c = command_find_in_context(cmd_ctx, cp);
262 command_set_handler_data(c, dap);
264 list_add_tail(&dap->lh, &all_dap);
266 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
269 static int jim_dap_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
272 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
274 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
275 "<name> [<dap_options> ...]");
278 return dap_create(&goi);
281 static int jim_dap_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
283 struct arm_dap_object *obj;
286 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
289 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
290 list_for_each_entry(obj, &all_dap, lh) {
291 Jim_ListAppendElement(interp, Jim_GetResult(interp),
292 Jim_NewStringObj(interp, obj->name, -1));
297 COMMAND_HANDLER(handle_dap_init)
299 return dap_init_all();
302 COMMAND_HANDLER(handle_dap_info_command)
304 struct target *target = get_current_target(CMD_CTX);
305 struct arm *arm = target_to_arm(target);
306 struct adiv5_dap *dap = arm->dap;
314 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
316 return ERROR_COMMAND_SYNTAX_ERROR;
319 return ERROR_COMMAND_SYNTAX_ERROR;
322 return dap_info_command(CMD_CTX, &dap->ap[apsel]);
325 static const struct command_registration dap_subcommand_handlers[] = {
329 .jim_handler = jim_dap_create,
330 .usage = "name '-chain-position' name",
331 .help = "Creates a new DAP instance",
336 .jim_handler = jim_dap_names,
338 .help = "Lists all registered DAP instances by name",
343 .handler = handle_dap_init,
345 .help = "Initialize all registered DAP instances"
349 .handler = handle_dap_info_command,
350 .mode = COMMAND_EXEC,
351 .help = "display ROM table for MEM-AP of current target "
352 "(default currently selected AP)",
355 COMMAND_REGISTRATION_DONE
358 static const struct command_registration dap_commands[] = {
361 .mode = COMMAND_CONFIG,
362 .help = "DAP commands",
363 .chain = dap_subcommand_handlers,
365 COMMAND_REGISTRATION_DONE
368 int dap_register_commands(struct command_context *cmd_ctx)
370 return register_commands(cmd_ctx, NULL, dap_commands);