1 // SPDX-License-Identifier: GPL-2.0-or-later
5 * This file implements support for the ARM CoreSight components Trace Port
6 * Interface Unit (TPIU) and Serial Wire Output (SWO). It also supports the
7 * CoreSight TPIU-Lite and the special TPIU version present with Cortex-M3
8 * and Cortex-M4 (that includes SWO).
12 * Relevant specifications from ARM include:
14 * CoreSight(tm) Components Technical Reference Manual ARM DDI 0314H
15 * CoreSight(tm) TPIU-Lite Technical Reference Manual ARM DDI 0317A
16 * Cortex(tm)-M3 Technical Reference Manual ARM DDI 0337G
17 * Cortex(tm)-M4 Technical Reference Manual ARM DDI 0439B
18 * CoreSight(tm) SoC-400 Technical Reference Manual ARM DDI 0480F
28 #include <helper/bits.h>
29 #include <helper/command.h>
30 #include <helper/jim-nvp.h>
31 #include <helper/list.h>
32 #include <helper/log.h>
33 #include <helper/types.h>
34 #include <jtag/interface.h>
35 #include <server/server.h>
36 #include <target/arm_adi_v5.h>
37 #include <target/target.h>
38 #include <transport/transport.h>
39 #include "arm_tpiu_swo.h"
41 /* START_DEPRECATED_TPIU */
42 #include <target/cortex_m.h>
43 #include <target/target_type.h>
44 #define MSG "DEPRECATED \'tpiu config\' command: "
45 /* END_DEPRECATED_TPIU */
47 #define TCP_SERVICE_NAME "tpiu_swo_trace"
49 /* default for Cortex-M3 and Cortex-M4 specific TPIU */
50 #define TPIU_SWO_DEFAULT_BASE 0xE0040000
52 #define TPIU_SSPSR_OFFSET 0x000
53 #define TPIU_CSPSR_OFFSET 0x004
54 #define TPIU_ACPR_OFFSET 0x010
55 #define TPIU_SPPR_OFFSET 0x0F0
56 #define TPIU_FFSR_OFFSET 0x300
57 #define TPIU_FFCR_OFFSET 0x304
58 #define TPIU_FSCR_OFFSET 0x308
59 #define TPIU_DEVID_OFFSET 0xfc8
61 #define TPIU_ACPR_MAX_PRESCALER 0x1fff
62 #define TPIU_SPPR_PROTOCOL_SYNC (TPIU_PIN_PROTOCOL_SYNC)
63 #define TPIU_SPPR_PROTOCOL_MANCHESTER (TPIU_PIN_PROTOCOL_ASYNC_MANCHESTER)
64 #define TPIU_SPPR_PROTOCOL_UART (TPIU_PIN_PROTOCOL_ASYNC_UART)
65 #define TPIU_DEVID_NOSUPPORT_SYNC BIT(9)
66 #define TPIU_DEVID_SUPPORT_MANCHESTER BIT(10)
67 #define TPIU_DEVID_SUPPORT_UART BIT(11)
69 enum arm_tpiu_swo_event {
70 TPIU_SWO_EVENT_PRE_ENABLE,
71 TPIU_SWO_EVENT_POST_ENABLE,
72 TPIU_SWO_EVENT_PRE_DISABLE,
73 TPIU_SWO_EVENT_POST_DISABLE,
76 static const struct jim_nvp nvp_arm_tpiu_swo_event[] = {
77 { .value = TPIU_SWO_EVENT_PRE_ENABLE, .name = "pre-enable" },
78 { .value = TPIU_SWO_EVENT_POST_ENABLE, .name = "post-enable" },
79 { .value = TPIU_SWO_EVENT_PRE_DISABLE, .name = "pre-disable" },
80 { .value = TPIU_SWO_EVENT_POST_DISABLE, .name = "post-disable" },
83 struct arm_tpiu_swo_event_action {
84 enum arm_tpiu_swo_event event;
87 struct arm_tpiu_swo_event_action *next;
90 struct arm_tpiu_swo_object {
92 struct adiv5_mem_ap_spot spot;
95 struct arm_tpiu_swo_event_action *event_action;
96 /* record enable before init */
100 /** Handle to output trace data in INTERNAL capture mode */
101 /** Synchronous output port width */
105 unsigned int pin_protocol;
106 /** Enable formatter */
108 /** frequency of TRACECLKIN (usually matches HCLK) */
109 unsigned int traceclkin_freq;
110 /** SWO pin frequency */
111 unsigned int swo_pin_freq;
112 /** where to dump the captured output trace data */
114 /** track TCP connections */
115 struct list_head connections;
116 /* START_DEPRECATED_TPIU */
117 bool recheck_ap_cur_target;
118 /* END_DEPRECATED_TPIU */
121 struct arm_tpiu_swo_connection {
123 struct connection *connection;
126 struct arm_tpiu_swo_priv_connection {
127 struct arm_tpiu_swo_object *obj;
130 static LIST_HEAD(all_tpiu_swo);
132 #define ARM_TPIU_SWO_TRACE_BUF_SIZE 4096
134 static int arm_tpiu_swo_poll_trace(void *priv)
136 struct arm_tpiu_swo_object *obj = priv;
137 uint8_t buf[ARM_TPIU_SWO_TRACE_BUF_SIZE];
138 size_t size = sizeof(buf);
139 struct arm_tpiu_swo_connection *c;
141 int retval = adapter_poll_trace(buf, &size);
142 if (retval != ERROR_OK || !size)
145 target_call_trace_callbacks(/*target*/NULL, size, buf);
148 if (fwrite(buf, 1, size, obj->file) == size) {
151 LOG_ERROR("Error writing to the SWO trace destination file");
156 if (obj->out_filename && obj->out_filename[0] == ':')
157 list_for_each_entry(c, &obj->connections, lh)
158 if (connection_write(c->connection, buf, size) != (int)size)
159 LOG_ERROR("Error writing to connection"); /* FIXME: which connection? */
164 static void arm_tpiu_swo_handle_event(struct arm_tpiu_swo_object *obj, enum arm_tpiu_swo_event event)
166 for (struct arm_tpiu_swo_event_action *ea = obj->event_action; ea; ea = ea->next) {
167 if (ea->event != event)
170 LOG_DEBUG("TPIU/SWO: %s event: %s (%d) action : %s",
172 jim_nvp_value2name_simple(nvp_arm_tpiu_swo_event, event)->name,
174 Jim_GetString(ea->body, NULL));
176 /* prevent event execution to change current target */
177 struct command_context *cmd_ctx = current_command_context(ea->interp);
178 struct target *saved_target = cmd_ctx->current_target;
179 int retval = Jim_EvalObj(ea->interp, ea->body);
180 cmd_ctx->current_target = saved_target;
182 if (retval == JIM_RETURN)
183 retval = ea->interp->returnCode;
184 if (retval == JIM_OK || retval == ERROR_COMMAND_CLOSE_CONNECTION)
187 Jim_MakeErrorMessage(ea->interp);
188 LOG_USER("Error executing event %s on TPIU/SWO %s:\n%s",
189 jim_nvp_value2name_simple(nvp_arm_tpiu_swo_event, event)->name,
191 Jim_GetString(Jim_GetResult(ea->interp), NULL));
192 /* clean both error code and stacktrace before return */
193 Jim_Eval(ea->interp, "error \"\" \"\"");
198 static void arm_tpiu_swo_close_output(struct arm_tpiu_swo_object *obj)
204 if (obj->out_filename && obj->out_filename[0] == ':')
205 remove_service(TCP_SERVICE_NAME, &obj->out_filename[1]);
208 int arm_tpiu_swo_cleanup_all(void)
210 struct arm_tpiu_swo_object *obj, *tmp;
212 list_for_each_entry_safe(obj, tmp, &all_tpiu_swo, lh) {
214 arm_tpiu_swo_handle_event(obj, TPIU_SWO_EVENT_PRE_DISABLE);
216 arm_tpiu_swo_close_output(obj);
218 if (obj->en_capture) {
219 target_unregister_timer_callback(arm_tpiu_swo_poll_trace, obj);
221 int retval = adapter_config_trace(false, 0, 0, NULL, 0, NULL);
222 if (retval != ERROR_OK)
223 LOG_ERROR("Failed to stop adapter's trace");
227 arm_tpiu_swo_handle_event(obj, TPIU_SWO_EVENT_POST_DISABLE);
229 struct arm_tpiu_swo_event_action *ea = obj->event_action;
231 struct arm_tpiu_swo_event_action *next = ea->next;
232 Jim_DecrRefCount(ea->interp, ea->body);
241 free(obj->out_filename);
248 static int arm_tpiu_swo_service_new_connection(struct connection *connection)
250 struct arm_tpiu_swo_priv_connection *priv = connection->service->priv;
251 struct arm_tpiu_swo_object *obj = priv->obj;
252 struct arm_tpiu_swo_connection *c = malloc(sizeof(*c));
254 LOG_ERROR("Out of memory");
257 c->connection = connection;
258 list_add(&c->lh, &obj->connections);
262 static int arm_tpiu_swo_service_input(struct connection *connection)
264 /* read a dummy buffer to check if the connection is still active */
266 int bytes_read = connection_read(connection, &dummy, sizeof(dummy));
268 if (bytes_read == 0) {
269 return ERROR_SERVER_REMOTE_CLOSED;
270 } else if (bytes_read == -1) {
271 LOG_ERROR("error during read: %s", strerror(errno));
272 return ERROR_SERVER_REMOTE_CLOSED;
278 static int arm_tpiu_swo_service_connection_closed(struct connection *connection)
280 struct arm_tpiu_swo_priv_connection *priv = connection->service->priv;
281 struct arm_tpiu_swo_object *obj = priv->obj;
282 struct arm_tpiu_swo_connection *c, *tmp;
284 list_for_each_entry_safe(c, tmp, &obj->connections, lh)
285 if (c->connection == connection) {
290 LOG_ERROR("Failed to find connection to close!");
294 COMMAND_HANDLER(handle_arm_tpiu_swo_event_list)
296 struct arm_tpiu_swo_object *obj = CMD_DATA;
298 command_print(CMD, "Event actions for TPIU/SWO %s\n", obj->name);
299 command_print(CMD, "%-25s | Body", "Event");
300 command_print(CMD, "------------------------- | "
301 "----------------------------------------");
303 for (struct arm_tpiu_swo_event_action *ea = obj->event_action; ea; ea = ea->next) {
304 struct jim_nvp *opt = jim_nvp_value2name_simple(nvp_arm_tpiu_swo_event, ea->event);
305 command_print(CMD, "%-25s | %s",
306 opt->name, Jim_GetString(ea->body, NULL));
308 command_print(CMD, "***END***");
312 enum arm_tpiu_swo_cfg_param {
322 static const struct jim_nvp nvp_arm_tpiu_swo_config_opts[] = {
323 { .name = "-port-width", .value = CFG_PORT_WIDTH },
324 { .name = "-protocol", .value = CFG_PROTOCOL },
325 { .name = "-formatter", .value = CFG_FORMATTER },
326 { .name = "-traceclk", .value = CFG_TRACECLKIN },
327 { .name = "-pin-freq", .value = CFG_BITRATE },
328 { .name = "-output", .value = CFG_OUTFILE },
329 { .name = "-event", .value = CFG_EVENT },
330 /* handled by mem_ap_spot, added for jim_getopt_nvp_unknown() */
331 { .name = "-dap", .value = -1 },
332 { .name = "-ap-num", .value = -1 },
333 { .name = "-baseaddr", .value = -1 },
334 { .name = NULL, .value = -1 },
337 static const struct jim_nvp nvp_arm_tpiu_swo_protocol_opts[] = {
338 { .name = "sync", .value = TPIU_SPPR_PROTOCOL_SYNC },
339 { .name = "uart", .value = TPIU_SPPR_PROTOCOL_UART },
340 { .name = "manchester", .value = TPIU_SPPR_PROTOCOL_MANCHESTER },
341 { .name = NULL, .value = -1 },
344 static const struct jim_nvp nvp_arm_tpiu_swo_bool_opts[] = {
345 { .name = "on", .value = 1 },
346 { .name = "yes", .value = 1 },
347 { .name = "1", .value = 1 },
348 { .name = "true", .value = 1 },
349 { .name = "off", .value = 0 },
350 { .name = "no", .value = 0 },
351 { .name = "0", .value = 0 },
352 { .name = "false", .value = 0 },
353 { .name = NULL, .value = -1 },
356 static int arm_tpiu_swo_configure(struct jim_getopt_info *goi, struct arm_tpiu_swo_object *obj)
360 if (goi->isconfigure && obj->enabled) {
361 Jim_SetResultFormatted(goi->interp, "Cannot configure TPIU/SWO; %s is enabled!", obj->name);
365 /* parse config or cget options ... */
366 while (goi->argc > 0) {
367 Jim_SetEmptyResult(goi->interp);
369 int e = adiv5_jim_mem_ap_spot_configure(&obj->spot, goi);
376 e = jim_getopt_nvp(goi, nvp_arm_tpiu_swo_config_opts, &n);
378 jim_getopt_nvp_unknown(goi, nvp_arm_tpiu_swo_config_opts, 0);
384 if (goi->isconfigure) {
386 e = jim_getopt_wide(goi, &port_width);
389 if (port_width < 1 || port_width > 32) {
390 Jim_SetResultString(goi->interp, "Invalid port width!", -1);
393 obj->port_width = (uint32_t)port_width;
397 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, obj->port_width));
401 if (goi->isconfigure) {
403 e = jim_getopt_nvp(goi, nvp_arm_tpiu_swo_protocol_opts, &p);
406 obj->pin_protocol = p->value;
411 e = jim_nvp_value2name(goi->interp, nvp_arm_tpiu_swo_protocol_opts, obj->pin_protocol, &p);
413 Jim_SetResultString(goi->interp, "protocol error", -1);
416 Jim_SetResult(goi->interp, Jim_NewStringObj(goi->interp, p->name, -1));
420 if (goi->isconfigure) {
422 e = jim_getopt_nvp(goi, nvp_arm_tpiu_swo_bool_opts, &p);
425 obj->en_formatter = p->value;
430 e = jim_nvp_value2name(goi->interp, nvp_arm_tpiu_swo_bool_opts, obj->en_formatter, &p);
432 Jim_SetResultString(goi->interp, "formatter error", -1);
435 Jim_SetResult(goi->interp, Jim_NewStringObj(goi->interp, p->name, -1));
439 if (goi->isconfigure) {
441 e = jim_getopt_wide(goi, &clk);
444 obj->traceclkin_freq = clk;
448 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, obj->traceclkin_freq));
452 if (goi->isconfigure) {
454 e = jim_getopt_wide(goi, &clk);
457 obj->swo_pin_freq = clk;
461 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, obj->swo_pin_freq));
465 if (goi->isconfigure) {
467 e = jim_getopt_string(goi, &s, NULL);
472 long port = strtol(s + 1, &end, 0);
473 if (port <= 0 || port > UINT16_MAX || *end != '\0') {
474 Jim_SetResultFormatted(goi->interp, "Invalid TCP port \'%s\'", s + 1);
478 free(obj->out_filename);
479 obj->out_filename = strdup(s);
480 if (!obj->out_filename) {
481 LOG_ERROR("Out of memory");
487 if (obj->out_filename)
488 Jim_SetResult(goi->interp, Jim_NewStringObj(goi->interp, obj->out_filename, -1));
492 if (goi->isconfigure) {
494 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
498 if (goi->argc != 1) {
499 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
507 struct arm_tpiu_swo_event_action *ea = obj->event_action;
509 e = jim_getopt_nvp(goi, nvp_arm_tpiu_swo_event, &p);
511 jim_getopt_nvp_unknown(goi, nvp_arm_tpiu_swo_event, 1);
516 /* replace existing? */
517 if (ea->event == (enum arm_tpiu_swo_event)p->value)
522 if (goi->isconfigure) {
524 ea = calloc(1, sizeof(*ea));
526 LOG_ERROR("Out of memory");
529 ea->next = obj->event_action;
530 obj->event_action = ea;
533 Jim_DecrRefCount(ea->interp, ea->body);
534 ea->event = p->value;
535 ea->interp = goi->interp;
536 jim_getopt_obj(goi, &o);
537 ea->body = Jim_DuplicateObj(goi->interp, o);
538 Jim_IncrRefCount(ea->body);
541 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, ea->body));
551 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "NO PARAMS");
555 static int jim_arm_tpiu_swo_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
557 struct command *c = jim_to_command(interp);
558 struct jim_getopt_info goi;
560 jim_getopt_setup(&goi, interp, argc - 1, argv + 1);
561 goi.isconfigure = !strcmp(c->name, "configure");
563 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
564 "missing: -option ...");
567 struct arm_tpiu_swo_object *obj = c->jim_handler_data;
568 return arm_tpiu_swo_configure(&goi, obj);
571 static int wrap_write_u32(struct target *target, struct adiv5_ap *tpiu_ap,
572 target_addr_t address, uint32_t value)
574 if (transport_is_hla())
575 return target_write_u32(target, address, value);
577 return mem_ap_write_atomic_u32(tpiu_ap, address, value);
580 static int wrap_read_u32(struct target *target, struct adiv5_ap *tpiu_ap,
581 target_addr_t address, uint32_t *value)
583 if (transport_is_hla())
584 return target_read_u32(target, address, value);
586 return mem_ap_read_atomic_u32(tpiu_ap, address, value);
589 static const struct service_driver arm_tpiu_swo_service_driver = {
590 .name = "tpiu_swo_trace",
591 .new_connection_during_keep_alive_handler = NULL,
592 .new_connection_handler = arm_tpiu_swo_service_new_connection,
593 .input_handler = arm_tpiu_swo_service_input,
594 .connection_closed_handler = arm_tpiu_swo_service_connection_closed,
595 .keep_client_alive_handler = NULL,
598 static int jim_arm_tpiu_swo_enable(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
600 struct command *c = jim_to_command(interp);
601 struct arm_tpiu_swo_object *obj = c->jim_handler_data;
602 struct command_context *cmd_ctx = current_command_context(interp);
607 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
611 if (cmd_ctx->mode == COMMAND_CONFIG) {
612 LOG_DEBUG("%s: enable deferred", obj->name);
613 obj->deferred_enable = true;
620 if (transport_is_hla() && obj->spot.ap_num != 0) {
621 LOG_ERROR("Invalid access port 0x%" PRIx64 ". Only AP#0 allowed with hla transport", obj->spot.ap_num);
625 if (!obj->traceclkin_freq) {
626 LOG_ERROR("Trace clock-in frequency not set");
630 if (obj->pin_protocol == TPIU_SPPR_PROTOCOL_MANCHESTER || obj->pin_protocol == TPIU_SPPR_PROTOCOL_UART)
631 if (!obj->swo_pin_freq)
632 LOG_DEBUG("SWO pin frequency not set, will be autodetected by the adapter");
634 struct target *target = get_current_target(cmd_ctx);
636 /* START_DEPRECATED_TPIU */
637 if (obj->recheck_ap_cur_target) {
638 if (strcmp(target->type->name, "cortex_m") &&
639 strcmp(target->type->name, "hla_target")) {
640 LOG_ERROR(MSG "Current target is not a Cortex-M nor a HLA");
643 if (!target_was_examined(target)) {
644 LOG_ERROR(MSG "Current target not examined yet");
647 struct cortex_m_common *cm = target_to_cm(target);
648 obj->recheck_ap_cur_target = false;
649 obj->spot.ap_num = cm->armv7m.debug_ap->ap_num;
650 if (obj->spot.ap_num == 0)
651 LOG_INFO(MSG "Confirmed TPIU %s is on AP 0", obj->name);
653 LOG_INFO(MSG "Target %s is on AP#0x%" PRIx64 ". Revised command is "
654 "\'tpiu create %s -dap %s -ap-num 0x%" PRIx64 "\'",
655 target_name(target), obj->spot.ap_num,
656 obj->name, adiv5_dap_name(obj->spot.dap), obj->spot.ap_num);
658 /* END_DEPRECATED_TPIU */
661 obj->ap = dap_get_ap(obj->spot.dap, obj->spot.ap_num);
663 LOG_ERROR("Cannot get AP");
668 /* trigger the event before any attempt to R/W in the TPIU/SWO */
669 arm_tpiu_swo_handle_event(obj, TPIU_SWO_EVENT_PRE_ENABLE);
671 retval = wrap_read_u32(target, obj->ap, obj->spot.base + TPIU_DEVID_OFFSET, &value);
672 if (retval != ERROR_OK) {
673 LOG_ERROR("Unable to read %s", obj->name);
676 switch (obj->pin_protocol) {
677 case TPIU_SPPR_PROTOCOL_SYNC:
678 value = !(value & TPIU_DEVID_NOSUPPORT_SYNC);
680 case TPIU_SPPR_PROTOCOL_UART:
681 value &= TPIU_DEVID_SUPPORT_UART;
683 case TPIU_SPPR_PROTOCOL_MANCHESTER:
684 value &= TPIU_DEVID_SUPPORT_MANCHESTER;
691 jim_nvp_value2name(interp, nvp_arm_tpiu_swo_protocol_opts, obj->pin_protocol, &p);
692 LOG_ERROR("%s does not support protocol %s", obj->name, p->name);
696 if (obj->pin_protocol == TPIU_SPPR_PROTOCOL_SYNC) {
697 retval = wrap_read_u32(target, obj->ap, obj->spot.base + TPIU_SSPSR_OFFSET, &value);
698 if (retval != ERROR_OK) {
699 LOG_ERROR("Cannot read TPIU register SSPSR");
702 if (!(value & BIT(obj->port_width - 1))) {
703 LOG_ERROR("TPIU does not support port-width of %d bits", obj->port_width);
708 uint16_t prescaler = 1; /* dummy value */
709 unsigned int swo_pin_freq = obj->swo_pin_freq; /* could be replaced */
711 if (obj->out_filename && strcmp(obj->out_filename, "external") && obj->out_filename[0]) {
712 if (obj->out_filename[0] == ':') {
713 struct arm_tpiu_swo_priv_connection *priv = malloc(sizeof(*priv));
715 LOG_ERROR("Out of memory");
719 LOG_INFO("starting trace server for %s on %s", obj->name, &obj->out_filename[1]);
720 retval = add_service(&arm_tpiu_swo_service_driver, &obj->out_filename[1],
721 CONNECTION_LIMIT_UNLIMITED, priv);
722 if (retval != ERROR_OK) {
723 LOG_ERROR("Can't configure trace TCP port %s", &obj->out_filename[1]);
726 } else if (strcmp(obj->out_filename, "-")) {
727 obj->file = fopen(obj->out_filename, "ab");
729 LOG_ERROR("Can't open trace destination file \"%s\"", obj->out_filename);
734 retval = adapter_config_trace(true, obj->pin_protocol, obj->port_width,
735 &swo_pin_freq, obj->traceclkin_freq, &prescaler);
736 if (retval != ERROR_OK) {
737 LOG_ERROR("Failed to start adapter's trace");
738 arm_tpiu_swo_close_output(obj);
742 if (obj->pin_protocol == TPIU_SPPR_PROTOCOL_MANCHESTER || obj->pin_protocol == TPIU_SPPR_PROTOCOL_UART)
744 if (obj->swo_pin_freq)
745 LOG_ERROR("Adapter rejected SWO pin frequency %d Hz", obj->swo_pin_freq);
747 LOG_ERROR("Adapter does not support auto-detection of SWO pin frequency nor a default value");
749 arm_tpiu_swo_close_output(obj);
753 if (obj->swo_pin_freq != swo_pin_freq)
754 LOG_INFO("SWO pin data rate adjusted by adapter to %d Hz", swo_pin_freq);
755 obj->swo_pin_freq = swo_pin_freq;
757 target_register_timer_callback(arm_tpiu_swo_poll_trace, 1,
758 TARGET_TIMER_TYPE_PERIODIC, obj);
760 obj->en_capture = true;
761 } else if (obj->pin_protocol == TPIU_SPPR_PROTOCOL_MANCHESTER || obj->pin_protocol == TPIU_SPPR_PROTOCOL_UART) {
762 prescaler = (obj->traceclkin_freq + obj->swo_pin_freq / 2) / obj->swo_pin_freq;
763 if (prescaler > TPIU_ACPR_MAX_PRESCALER)
764 prescaler = TPIU_ACPR_MAX_PRESCALER;
765 swo_pin_freq = obj->traceclkin_freq / prescaler;
767 if (obj->swo_pin_freq != swo_pin_freq)
768 LOG_INFO("SWO pin data rate adjusted to %d Hz", swo_pin_freq);
769 obj->swo_pin_freq = swo_pin_freq;
772 retval = wrap_write_u32(target, obj->ap, obj->spot.base + TPIU_CSPSR_OFFSET, BIT(obj->port_width - 1));
773 if (retval != ERROR_OK)
776 retval = wrap_write_u32(target, obj->ap, obj->spot.base + TPIU_ACPR_OFFSET, prescaler - 1);
777 if (retval != ERROR_OK)
780 retval = wrap_write_u32(target, obj->ap, obj->spot.base + TPIU_SPPR_OFFSET, obj->pin_protocol);
781 if (retval != ERROR_OK)
784 retval = wrap_read_u32(target, obj->ap, obj->spot.base + TPIU_FFCR_OFFSET, &value);
785 if (retval != ERROR_OK)
787 if (obj->en_formatter)
791 retval = wrap_write_u32(target, obj->ap, obj->spot.base + TPIU_FFCR_OFFSET, value);
792 if (retval != ERROR_OK)
795 arm_tpiu_swo_handle_event(obj, TPIU_SWO_EVENT_POST_ENABLE);
797 /* START_DEPRECATED_TPIU */
798 target_handle_event(target, TARGET_EVENT_TRACE_CONFIG);
799 /* END_DEPRECATED_TPIU */
807 if (obj->en_capture) {
808 obj->en_capture = false;
810 arm_tpiu_swo_close_output(obj);
812 target_unregister_timer_callback(arm_tpiu_swo_poll_trace, obj);
814 retval = adapter_config_trace(false, 0, 0, NULL, 0, NULL);
815 if (retval != ERROR_OK) {
816 LOG_ERROR("Failed to stop adapter's trace");
823 static int jim_arm_tpiu_swo_disable(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
825 struct command *c = jim_to_command(interp);
826 struct arm_tpiu_swo_object *obj = c->jim_handler_data;
829 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
835 obj->enabled = false;
837 arm_tpiu_swo_handle_event(obj, TPIU_SWO_EVENT_PRE_DISABLE);
839 if (obj->en_capture) {
840 obj->en_capture = false;
842 arm_tpiu_swo_close_output(obj);
844 target_unregister_timer_callback(arm_tpiu_swo_poll_trace, obj);
846 int retval = adapter_config_trace(false, 0, 0, NULL, 0, NULL);
847 if (retval != ERROR_OK) {
848 LOG_ERROR("Failed to stop adapter's trace");
853 arm_tpiu_swo_handle_event(obj, TPIU_SWO_EVENT_POST_DISABLE);
855 /* START_DEPRECATED_TPIU */
856 struct command_context *cmd_ctx = current_command_context(interp);
857 struct target *target = get_current_target(cmd_ctx);
858 target_handle_event(target, TARGET_EVENT_TRACE_CONFIG);
859 /* END_DEPRECATED_TPIU */
864 static const struct command_registration arm_tpiu_swo_instance_command_handlers[] = {
868 .jim_handler = jim_arm_tpiu_swo_configure,
869 .help = "configure a new TPIU/SWO for use",
870 .usage = "[attribute value ...]",
875 .jim_handler = jim_arm_tpiu_swo_configure,
876 .help = "returns the specified TPIU/SWO attribute",
877 .usage = "attribute",
882 .handler = handle_arm_tpiu_swo_event_list,
883 .help = "displays a table of events defined for this TPIU/SWO",
889 .jim_handler = jim_arm_tpiu_swo_enable,
891 .help = "Enables the TPIU/SWO output",
895 .mode = COMMAND_EXEC,
896 .jim_handler = jim_arm_tpiu_swo_disable,
898 .help = "Disables the TPIU/SWO output",
900 COMMAND_REGISTRATION_DONE
903 static int arm_tpiu_swo_create(Jim_Interp *interp, struct arm_tpiu_swo_object *obj)
905 struct command_context *cmd_ctx;
909 cmd_ctx = current_command_context(interp);
912 /* does this command exist? */
913 cmd = Jim_GetCommand(interp, Jim_NewStringObj(interp, obj->name, -1), JIM_NONE);
915 Jim_SetResultFormatted(interp, "cannot create TPIU object because a command with name '%s' already exists",
920 /* now - create the new tpiu/swo name command */
921 const struct command_registration obj_commands[] = {
925 .help = "tpiu/swo instance command group",
927 .chain = arm_tpiu_swo_instance_command_handlers,
929 COMMAND_REGISTRATION_DONE
931 e = register_commands_with_data(cmd_ctx, NULL, obj_commands, obj);
935 list_add_tail(&obj->lh, &all_tpiu_swo);
940 static int jim_arm_tpiu_swo_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
942 struct jim_getopt_info goi;
943 jim_getopt_setup(&goi, interp, argc - 1, argv + 1);
945 Jim_WrongNumArgs(interp, 1, argv, "name ?option option ...?");
949 struct arm_tpiu_swo_object *obj = calloc(1, sizeof(struct arm_tpiu_swo_object));
951 LOG_ERROR("Out of memory");
954 INIT_LIST_HEAD(&obj->connections);
955 adiv5_mem_ap_spot_init(&obj->spot);
956 obj->spot.base = TPIU_SWO_DEFAULT_BASE;
960 jim_getopt_obj(&goi, &n);
961 obj->name = strdup(Jim_GetString(n, NULL));
963 LOG_ERROR("Out of memory");
968 /* Do the rest as "configure" options */
970 int e = arm_tpiu_swo_configure(&goi, obj);
974 if (!obj->spot.dap || obj->spot.ap_num == DP_APSEL_INVALID) {
975 Jim_SetResultString(goi.interp, "-dap and -ap-num required when creating TPIU", -1);
979 e = arm_tpiu_swo_create(goi.interp, obj);
987 free(obj->out_filename);
992 static int jim_arm_tpiu_swo_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
994 struct arm_tpiu_swo_object *obj;
997 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
1000 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
1001 list_for_each_entry(obj, &all_tpiu_swo, lh) {
1002 Jim_ListAppendElement(interp, Jim_GetResult(interp),
1003 Jim_NewStringObj(interp, obj->name, -1));
1008 static int jim_arm_tpiu_swo_init(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1010 struct command_context *cmd_ctx = current_command_context(interp);
1011 struct arm_tpiu_swo_object *obj;
1012 int retval = JIM_OK;
1015 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
1018 list_for_each_entry(obj, &all_tpiu_swo, lh) {
1019 if (!obj->deferred_enable)
1021 LOG_DEBUG("%s: running enable during init", obj->name);
1022 int retval2 = command_run_linef(cmd_ctx, "%s enable", obj->name);
1023 if (retval2 != ERROR_OK)
1029 /* START_DEPRECATED_TPIU */
1030 /* DEPRECATED: emulation of old command 'tpiu config' */
1031 COMMAND_HANDLER(handle_tpiu_deprecated_config_command)
1033 struct target *target = get_current_target(CMD_CTX);
1034 struct arm_tpiu_swo_object *obj = NULL;
1037 if (strcmp(target->type->name, "cortex_m") &&
1038 strcmp(target->type->name, "hla_target")) {
1039 LOG_ERROR(MSG "Current target is not a Cortex-M nor a HLA");
1043 if (!list_empty(&all_tpiu_swo)) {
1044 obj = list_first_entry(&all_tpiu_swo, typeof(*obj), lh);
1045 LOG_INFO(MSG "Using %s", obj->name);
1047 struct cortex_m_common *cm = target_to_cm(target);
1048 struct adiv5_private_config *pc = target->private_config;
1049 struct adiv5_dap *dap = pc->dap;
1050 uint64_t ap_num = pc->ap_num;
1051 bool set_recheck_ap_cur_target = false;
1053 LOG_INFO(MSG "Adding a TPIU \'%s.tpiu\' in the configuration", target_name(target));
1055 if (ap_num == DP_APSEL_INVALID && transport_is_hla())
1056 ap_num = 0; /* HLA should only support AP 0 */
1058 if (ap_num == DP_APSEL_INVALID && target_was_examined(target))
1059 ap_num = cm->armv7m.debug_ap->ap_num;
1061 if (ap_num == DP_APSEL_INVALID) {
1062 LOG_INFO(MSG "Target %s uses AP autodetection. Adding TPIU on AP 0; can be revised later",
1063 target_name(target));
1065 set_recheck_ap_cur_target = true;
1068 LOG_INFO(MSG "Running: \'tpiu create %s.tpiu -dap %s -ap-num 0x%" PRIx64 "\'",
1069 target_name(target), adiv5_dap_name(dap), ap_num);
1071 retval = command_run_linef(CMD_CTX, "tpiu create %s.tpiu -dap %s -ap-num 0x%" PRIx64,
1072 target_name(target), adiv5_dap_name(dap), ap_num);
1073 if (retval != ERROR_OK)
1076 obj = list_first_entry(&all_tpiu_swo, typeof(*obj), lh);
1077 if (set_recheck_ap_cur_target)
1078 obj->recheck_ap_cur_target = true;
1081 unsigned int cmd_idx = 0;
1082 if (cmd_idx == CMD_ARGC)
1083 return ERROR_COMMAND_SYNTAX_ERROR;
1085 if (!strcmp(CMD_ARGV[cmd_idx], "disable")) {
1086 if (CMD_ARGC != cmd_idx + 1)
1087 return ERROR_COMMAND_SYNTAX_ERROR;
1088 LOG_INFO(MSG "Running: \'%s disable\'", obj->name);
1089 return command_run_linef(CMD_CTX, "%s disable", obj->name);
1092 const char *output = NULL;
1093 const char *protocol;
1094 const char *formatter = NULL;
1095 const char *port_width = NULL;
1096 const char *trace_clk;
1097 const char *pin_clk = NULL;
1098 if (!strcmp(CMD_ARGV[cmd_idx], "internal")) {
1100 if (cmd_idx == CMD_ARGC)
1101 return ERROR_COMMAND_SYNTAX_ERROR;
1102 output = CMD_ARGV[cmd_idx];
1103 } else if (strcmp(CMD_ARGV[cmd_idx], "external"))
1104 return ERROR_COMMAND_SYNTAX_ERROR;
1106 if (cmd_idx == CMD_ARGC)
1107 return ERROR_COMMAND_SYNTAX_ERROR;
1108 if (!strcmp(CMD_ARGV[cmd_idx], "sync")) {
1109 protocol = CMD_ARGV[cmd_idx];
1111 if (cmd_idx == CMD_ARGC)
1112 return ERROR_COMMAND_SYNTAX_ERROR;
1113 port_width = CMD_ARGV[cmd_idx];
1115 if (strcmp(CMD_ARGV[cmd_idx], "manchester") && strcmp(CMD_ARGV[cmd_idx], "uart"))
1116 return ERROR_COMMAND_SYNTAX_ERROR;
1117 protocol = CMD_ARGV[cmd_idx];
1119 if (cmd_idx == CMD_ARGC)
1120 return ERROR_COMMAND_SYNTAX_ERROR;
1121 formatter = CMD_ARGV[cmd_idx];
1124 if (cmd_idx == CMD_ARGC)
1125 return ERROR_COMMAND_SYNTAX_ERROR;
1126 trace_clk = CMD_ARGV[cmd_idx];
1128 if (cmd_idx != CMD_ARGC) {
1129 pin_clk = CMD_ARGV[cmd_idx];
1132 if (cmd_idx != CMD_ARGC)
1133 return ERROR_COMMAND_SYNTAX_ERROR;
1135 LOG_INFO(MSG "Running: \'%s configure -protocol %s -traceclk %s" "%s%s" "%s%s" "%s%s" "%s%s\'",
1136 obj->name, protocol, trace_clk,
1137 pin_clk ? " -pin-freq " : "", pin_clk ? pin_clk : "",
1138 output ? " -output " : "", output ? output : "",
1139 formatter ? " -formatter " : "", formatter ? formatter : "",
1140 port_width ? " -port-width " : "", port_width ? port_width : "");
1142 retval = command_run_linef(CMD_CTX,
1143 "%s configure -protocol %s -traceclk %s" "%s%s" "%s%s" "%s%s" "%s%s",
1144 obj->name, protocol, trace_clk,
1145 pin_clk ? " -pin-freq " : "", pin_clk ? pin_clk : "",
1146 output ? " -output " : "", output ? output : "",
1147 formatter ? " -formatter " : "", formatter ? formatter : "",
1148 port_width ? " -port-width " : "", port_width ? port_width : "");
1149 if (retval != ERROR_OK)
1152 LOG_INFO(MSG "Running: \'%s enable\'", obj->name);
1153 retval = command_run_linef(CMD_CTX, "%s enable", obj->name);
1154 if (retval != ERROR_OK)
1160 static const struct command_registration arm_tpiu_deprecated_subcommand_handlers[] = {
1163 .handler = handle_tpiu_deprecated_config_command,
1164 .mode = COMMAND_ANY,
1165 .help = "Configure TPIU features, DEPRECATED, use \'tpiu create\'",
1166 .usage = "(disable | "
1167 "((external | internal (<filename> | <:port> | -)) "
1168 "(sync <port width> | ((manchester | uart) <formatter enable>)) "
1169 "<TRACECLKIN freq> [<trace freq>]))",
1171 COMMAND_REGISTRATION_DONE
1174 const struct command_registration arm_tpiu_deprecated_command_handlers[] = {
1177 .chain = arm_tpiu_deprecated_subcommand_handlers,
1179 .help = "tpiu command group",
1181 COMMAND_REGISTRATION_DONE
1183 /* END_DEPRECATED_TPIU */
1185 static const struct command_registration arm_tpiu_swo_subcommand_handlers[] = {
1188 .mode = COMMAND_ANY,
1189 .jim_handler = jim_arm_tpiu_swo_create,
1190 .usage = "name [-dap dap] [-ap-num num] [-baseaddr baseaddr]",
1191 .help = "Creates a new TPIU or SWO object",
1195 .mode = COMMAND_ANY,
1196 .jim_handler = jim_arm_tpiu_swo_names,
1198 .help = "Lists all registered TPIU and SWO objects by name",
1202 .mode = COMMAND_EXEC,
1203 .jim_handler = jim_arm_tpiu_swo_init,
1205 .help = "Initialize TPIU and SWO",
1207 COMMAND_REGISTRATION_DONE
1210 static const struct command_registration arm_tpiu_swo_command_handlers[] = {
1213 .chain = arm_tpiu_swo_subcommand_handlers,
1215 .help = "tpiu command group",
1219 .chain = arm_tpiu_swo_subcommand_handlers,
1221 .help = "swo command group",
1223 COMMAND_REGISTRATION_DONE
1226 int arm_tpiu_swo_register_commands(struct command_context *cmd_ctx)
1228 return register_commands(cmd_ctx, NULL, arm_tpiu_swo_command_handlers);