target_request: add target_got_message() that can be used to improve DCC performance
[openocd.git] / src / target / target_request.c
1 /***************************************************************************
2 * Copyright (C) 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include <helper/log.h>
31 #include <helper/binarybuffer.h>
32
33 #include "target.h"
34 #include "target_request.h"
35 #include "target_type.h"
36 #include "trace.h"
37
38
39 static bool got_message = false;
40
41 bool target_got_message(void)
42 {
43 bool t = got_message;
44 got_message = false;
45 return t;
46 }
47
48 static int charmsg_mode = 0;
49
50 static int target_asciimsg(struct target *target, uint32_t length)
51 {
52 char *msg = malloc(DIV_ROUND_UP(length + 1, 4) * 4);
53 struct debug_msg_receiver *c = target->dbgmsg;
54
55 target->type->target_request_data(target, DIV_ROUND_UP(length, 4), (uint8_t*)msg);
56 msg[length] = 0;
57
58 LOG_DEBUG("%s", msg);
59
60 while (c)
61 {
62 command_print(c->cmd_ctx, "%s", msg);
63 c = c->next;
64 }
65
66 return ERROR_OK;
67 }
68
69 static int target_charmsg(struct target *target, uint8_t msg)
70 {
71 LOG_USER_N("%c", msg);
72
73 return ERROR_OK;
74 }
75
76 static int target_hexmsg(struct target *target, int size, uint32_t length)
77 {
78 uint8_t *data = malloc(DIV_ROUND_UP(length * size, 4) * 4);
79 char line[128];
80 int line_len;
81 struct debug_msg_receiver *c = target->dbgmsg;
82 uint32_t i;
83
84 LOG_DEBUG("size: %i, length: %i", (int)size, (int)length);
85
86 target->type->target_request_data(target, DIV_ROUND_UP(length * size, 4), (uint8_t*)data);
87
88 line_len = 0;
89 for (i = 0; i < length; i++)
90 {
91 switch (size)
92 {
93 case 4:
94 line_len += snprintf(line + line_len, 128 - line_len, "%8.8" PRIx32 " ", le_to_h_u32(data + (4*i)));
95 break;
96 case 2:
97 line_len += snprintf(line + line_len, 128 - line_len, "%4.4x ", le_to_h_u16(data + (2*i)));
98 break;
99 case 1:
100 line_len += snprintf(line + line_len, 128 - line_len, "%2.2x ", data[i]);
101 break;
102 }
103
104 if ((i%8 == 7) || (i == length - 1))
105 {
106 LOG_DEBUG("%s", line);
107
108 while (c)
109 {
110 command_print(c->cmd_ctx, "%s", line);
111 c = c->next;
112 }
113 c = target->dbgmsg;
114 line_len = 0;
115 }
116 }
117
118 free(data);
119
120 return ERROR_OK;
121 }
122
123 /* handle requests from the target received by a target specific
124 * side-band channel (e.g. ARM7/9 DCC)
125 */
126 int target_request(struct target *target, uint32_t request)
127 {
128 target_req_cmd_t target_req_cmd = request & 0xff;
129
130 /* Record that we got a target message for back-off algorithm */
131 got_message = true;
132
133 if (charmsg_mode) {
134 target_charmsg(target, target_req_cmd);
135 return ERROR_OK;
136 }
137 switch (target_req_cmd)
138 {
139 case TARGET_REQ_TRACEMSG:
140 trace_point(target, (request & 0xffffff00) >> 8);
141 break;
142 case TARGET_REQ_DEBUGMSG:
143 if (((request & 0xff00) >> 8) == 0)
144 {
145 target_asciimsg(target, (request & 0xffff0000) >> 16);
146 }
147 else
148 {
149 target_hexmsg(target, (request & 0xff00) >> 8, (request & 0xffff0000) >> 16);
150 }
151 break;
152 case TARGET_REQ_DEBUGCHAR:
153 target_charmsg(target, (request & 0x00ff0000) >> 16);
154 break;
155 /* case TARGET_REQ_SEMIHOSTING:
156 * break;
157 */
158 default:
159 LOG_ERROR("unknown target request: %2.2x", target_req_cmd);
160 break;
161 }
162
163 return ERROR_OK;
164 }
165
166 static int add_debug_msg_receiver(struct command_context *cmd_ctx, struct target *target)
167 {
168 struct debug_msg_receiver **p = &target->dbgmsg;
169
170 if (target == NULL)
171 return ERROR_INVALID_ARGUMENTS;
172
173 /* see if there's already a list */
174 if (*p)
175 {
176 /* find end of linked list */
177 p = &target->dbgmsg;
178 while ((*p)->next)
179 p = &((*p)->next);
180 p = &((*p)->next);
181 }
182
183 /* add new debug message receiver */
184 (*p) = malloc(sizeof(struct debug_msg_receiver));
185 (*p)->cmd_ctx = cmd_ctx;
186 (*p)->next = NULL;
187
188 /* enable callback */
189 target->dbg_msg_enabled = 1;
190
191 return ERROR_OK;
192 }
193
194 static struct debug_msg_receiver* find_debug_msg_receiver(struct command_context *cmd_ctx, struct target *target)
195 {
196 int do_all_targets = 0;
197 struct debug_msg_receiver **p = &target->dbgmsg;
198
199 /* if no target has been specified search all of them */
200 if (target == NULL)
201 {
202 /* if no targets haven been specified */
203 if (all_targets == NULL)
204 return NULL;
205
206 target = all_targets;
207 do_all_targets = 1;
208 }
209
210 do
211 {
212 while (*p)
213 {
214 if ((*p)->cmd_ctx == cmd_ctx)
215 {
216 return *p;
217 }
218 p = &((*p)->next);
219 }
220
221 target = target->next;
222 } while (target && do_all_targets);
223
224 return NULL;
225 }
226
227 int delete_debug_msg_receiver(struct command_context *cmd_ctx, struct target *target)
228 {
229 struct debug_msg_receiver **p;
230 struct debug_msg_receiver *c;
231 int do_all_targets = 0;
232
233 /* if no target has been specified search all of them */
234 if (target == NULL)
235 {
236 /* if no targets haven been specified */
237 if (all_targets == NULL)
238 return ERROR_OK;
239
240 target = all_targets;
241 do_all_targets = 1;
242 }
243
244 do
245 {
246 p = &target->dbgmsg;
247 c = *p;
248 while (c)
249 {
250 struct debug_msg_receiver *next = c->next;
251 if (c->cmd_ctx == cmd_ctx)
252 {
253 *p = next;
254 free(c);
255 if (*p == NULL)
256 {
257 /* disable callback */
258 target->dbg_msg_enabled = 0;
259 }
260 return ERROR_OK;
261 }
262 else
263 p = &(c->next);
264 c = next;
265 }
266
267 target = target->next;
268 } while (target && do_all_targets);
269
270 return ERROR_OK;
271 }
272
273 COMMAND_HANDLER(handle_target_request_debugmsgs_command)
274 {
275 struct target *target = get_current_target(CMD_CTX);
276
277 int receiving = 0;
278
279 /* see if reciever is already registered */
280 if (find_debug_msg_receiver(CMD_CTX, target) != NULL)
281 receiving = 1;
282
283 if (CMD_ARGC > 0)
284 {
285 if (!strcmp(CMD_ARGV[0], "enable") || !strcmp(CMD_ARGV[0], "charmsg"))
286 {
287 /* don't register if this command context is already receiving */
288 if (!receiving)
289 {
290 receiving = 1;
291 add_debug_msg_receiver(CMD_CTX, target);
292 }
293 charmsg_mode = !strcmp(CMD_ARGV[0], "charmsg");
294 }
295 else if (!strcmp(CMD_ARGV[0], "disable"))
296 {
297 /* no need to delete a receiver if none is registered */
298 if (receiving)
299 {
300 receiving = 0;
301 delete_debug_msg_receiver(CMD_CTX, target);
302 }
303 }
304 else
305 {
306 command_print(CMD_CTX, "usage: target_request debugmsgs ['enable'|'disable'|'charmsg']");
307 }
308 }
309
310 command_print(CMD_CTX, "receiving debug messages from current target %s",
311 (receiving) ? (charmsg_mode?"charmsg":"enabled") : "disabled");
312 return ERROR_OK;
313 }
314
315 static const struct command_registration target_req_exec_command_handlers[] = {
316 {
317 .name = "debugmsgs",
318 .handler = handle_target_request_debugmsgs_command,
319 .mode = COMMAND_EXEC,
320 .help = "display and/or modify reception of debug messages from target",
321 .usage = "['enable'|'charmsg'|'disable']",
322 },
323 COMMAND_REGISTRATION_DONE
324 };
325 static const struct command_registration target_req_command_handlers[] = {
326 {
327 .name = "target_request",
328 .mode = COMMAND_ANY,
329 .help = "target request command group",
330 .chain = target_req_exec_command_handlers,
331 },
332 COMMAND_REGISTRATION_DONE
333 };
334
335 int target_request_register_commands(struct command_context *cmd_ctx)
336 {
337 return register_commands(cmd_ctx, NULL, target_req_command_handlers);
338 }

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)