Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
rtos: style corrections for uCOS-III
[openocd.git] / src / rtos / uCOS-III.c
1 /***************************************************************************
2 * Copyright (C) 2017 by Square, Inc. *
3 * Steven Stallion <stallion@squareup.com> *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
18
19 #ifdef HAVE_CONFIG_H
20 #include "config.h"
21 #endif
22
23 #include <helper/log.h>
24 #include <helper/time_support.h>
25 #include <helper/types.h>
26 #include <rtos/rtos.h>
27 #include <target/target.h>
28 #include <target/target_type.h>
29
30 #include "rtos_ucos_iii_stackings.h"
31
32 #ifndef UCOS_III_MAX_STRLEN
33 #define UCOS_III_MAX_STRLEN 64
34 #endif
35
36 #ifndef UCOS_III_MAX_THREADS
37 #define UCOS_III_MAX_THREADS 256
38 #endif
39
40 struct uCOS_III_params {
41 const char *target_name;
42 const unsigned char pointer_width;
43 symbol_address_t thread_stack_offset;
44 symbol_address_t thread_name_offset;
45 symbol_address_t thread_state_offset;
46 symbol_address_t thread_priority_offset;
47 symbol_address_t thread_prev_offset;
48 symbol_address_t thread_next_offset;
49 bool thread_offsets_updated;
50 size_t threadid_start;
51 const struct rtos_register_stacking *stacking_info;
52 size_t num_threads;
53 symbol_address_t threads[];
54 };
55
56 static const struct uCOS_III_params uCOS_III_params_list[] = {
57 {
58 "cortex_m", /* target_name */
59 sizeof(uint32_t), /* pointer_width */
60 0, /* thread_stack_offset */
61 0, /* thread_name_offset */
62 0, /* thread_state_offset */
63 0, /* thread_priority_offset */
64 0, /* thread_prev_offset */
65 0, /* thread_next_offset */
66 false, /* thread_offsets_updated */
67 1, /* threadid_start */
68 &rtos_uCOS_III_Cortex_M_stacking, /* stacking_info */
69 0, /* num_threads */
70 },
71 };
72
73 static const char * const uCOS_III_symbol_list[] = {
74 "OSRunning",
75 "OSTCBCurPtr",
76 "OSTaskDbgListPtr",
77 "OSTaskQty",
78
79 /* also see: contrib/rtos-helpers/uCOS-III-openocd.c */
80 "openocd_OS_TCB_StkPtr_offset",
81 "openocd_OS_TCB_NamePtr_offset",
82 "openocd_OS_TCB_TaskState_offset",
83 "openocd_OS_TCB_Prio_offset",
84 "openocd_OS_TCB_DbgPrevPtr_offset",
85 "openocd_OS_TCB_DbgNextPtr_offset",
86 NULL
87 };
88
89 enum uCOS_III_symbol_values {
90 uCOS_III_VAL_OSRunning,
91 uCOS_III_VAL_OSTCBCurPtr,
92 uCOS_III_VAL_OSTaskDbgListPtr,
93 uCOS_III_VAL_OSTaskQty,
94
95 /* also see: contrib/rtos-helpers/uCOS-III-openocd.c */
96 uCOS_III_VAL_OS_TCB_StkPtr_offset,
97 uCOS_III_VAL_OS_TCB_NamePtr_offset,
98 uCOS_III_VAL_OS_TCB_TaskState_offset,
99 uCOS_III_VAL_OS_TCB_Prio_offset,
100 uCOS_III_VAL_OS_TCB_DbgPrevPtr_offset,
101 uCOS_III_VAL_OS_TCB_DbgNextPtr_offset,
102 };
103
104 static const char * const uCOS_III_thread_state_list[] = {
105 "Ready",
106 "Delay",
107 "Pend",
108 "Pend Timeout",
109 "Suspended",
110 "Delay Suspended",
111 "Pend Suspended",
112 "Pend Timeout Suspended",
113 };
114
115 static int uCOS_III_find_or_create_thread(struct rtos *rtos, symbol_address_t thread_address,
116 threadid_t *threadid)
117 {
118 struct uCOS_III_params *params = rtos->rtos_specific_params;
119 size_t thread_index;
120
121 for (thread_index = 0; thread_index < params->num_threads; thread_index++)
122 if (params->threads[thread_index] == thread_address)
123 goto found;
124
125 if (params->num_threads == UCOS_III_MAX_THREADS) {
126 LOG_WARNING("uCOS-III: too many threads; increase UCOS_III_MAX_THREADS");
127 return ERROR_FAIL;
128 }
129
130 params->threads[thread_index] = thread_address;
131 params->num_threads++;
132 found:
133 *threadid = thread_index + params->threadid_start;
134 return ERROR_OK;
135 }
136
137 static int uCOS_III_find_thread_address(struct rtos *rtos, threadid_t threadid,
138 symbol_address_t *thread_address)
139 {
140 struct uCOS_III_params *params = rtos->rtos_specific_params;
141 size_t thread_index;
142
143 thread_index = threadid - params->threadid_start;
144 if (thread_index >= params->num_threads) {
145 LOG_ERROR("uCOS-III: failed to find thread address");
146 return ERROR_FAIL;
147 }
148
149 *thread_address = params->threads[thread_index];
150 return ERROR_OK;
151 }
152
153 static int uCOS_III_find_last_thread_address(struct rtos *rtos, symbol_address_t *thread_address)
154 {
155 struct uCOS_III_params *params = rtos->rtos_specific_params;
156 int retval;
157
158 /* read the thread list head */
159 symbol_address_t thread_list_address = 0;
160
161 retval = target_read_memory(rtos->target,
162 rtos->symbols[uCOS_III_VAL_OSTaskDbgListPtr].address,
163 params->pointer_width,
164 1,
165 (void *)&thread_list_address);
166 if (retval != ERROR_OK) {
167 LOG_ERROR("uCOS-III: failed to read thread list address");
168 return retval;
169 }
170
171 /* advance to end of thread list */
172 do {
173 *thread_address = thread_list_address;
174
175 retval = target_read_memory(rtos->target,
176 thread_list_address + params->thread_next_offset,
177 params->pointer_width,
178 1,
179 (void *)&thread_list_address);
180 if (retval != ERROR_OK) {
181 LOG_ERROR("uCOS-III: failed to read next thread address");
182 return retval;
183 }
184 } while (thread_list_address != 0);
185
186 return ERROR_OK;
187 }
188
189 static int uCOS_III_update_thread_offsets(struct rtos *rtos)
190 {
191 struct uCOS_III_params *params = rtos->rtos_specific_params;
192
193 if (params->thread_offsets_updated)
194 return ERROR_OK;
195
196 const struct thread_offset_map {
197 enum uCOS_III_symbol_values symbol_value;
198 symbol_address_t *thread_offset;
199 } thread_offset_maps[] = {
200 {
201 uCOS_III_VAL_OS_TCB_StkPtr_offset,
202 &params->thread_stack_offset,
203 },
204 {
205 uCOS_III_VAL_OS_TCB_NamePtr_offset,
206 &params->thread_name_offset,
207 },
208 {
209 uCOS_III_VAL_OS_TCB_TaskState_offset,
210 &params->thread_state_offset,
211 },
212 {
213 uCOS_III_VAL_OS_TCB_Prio_offset,
214 &params->thread_priority_offset,
215 },
216 {
217 uCOS_III_VAL_OS_TCB_DbgPrevPtr_offset,
218 &params->thread_prev_offset,
219 },
220 {
221 uCOS_III_VAL_OS_TCB_DbgNextPtr_offset,
222 &params->thread_next_offset,
223 },
224 };
225
226 for (size_t i = 0; i < ARRAY_SIZE(thread_offset_maps); i++) {
227 const struct thread_offset_map *thread_offset_map = &thread_offset_maps[i];
228
229 int retval = target_read_memory(rtos->target,
230 rtos->symbols[thread_offset_map->symbol_value].address,
231 params->pointer_width,
232 1,
233 (void *)thread_offset_map->thread_offset);
234 if (retval != ERROR_OK) {
235 LOG_ERROR("uCOS-III: failed to read thread offset");
236 return retval;
237 }
238 }
239
240 params->thread_offsets_updated = true;
241 return ERROR_OK;
242 }
243
244 static int uCOS_III_detect_rtos(struct target *target)
245 {
246 return target->rtos->symbols != NULL &&
247 target->rtos->symbols[uCOS_III_VAL_OSRunning].address != 0;
248 }
249
250 static int uCOS_III_reset_handler(struct target *target, enum target_reset_mode reset_mode, void *priv)
251 {
252 struct uCOS_III_params *params = target->rtos->rtos_specific_params;
253
254 params->thread_offsets_updated = false;
255 params->num_threads = 0;
256
257 return ERROR_OK;
258 }
259
260 static int uCOS_III_create(struct target *target)
261 {
262 struct uCOS_III_params *params;
263
264 for (size_t i = 0; i < ARRAY_SIZE(uCOS_III_params_list); i++)
265 if (strcmp(uCOS_III_params_list[i].target_name, target->type->name) == 0) {
266 params = malloc(sizeof(*params) + (UCOS_III_MAX_THREADS * sizeof(*params->threads)));
267 if (params == NULL) {
268 LOG_ERROR("uCOS-III: out of memory");
269 return ERROR_FAIL;
270 }
271
272 memcpy(params, &uCOS_III_params_list[i], sizeof(uCOS_III_params_list[i]));
273 target->rtos->rtos_specific_params = (void *)params;
274
275 target_register_reset_callback(uCOS_III_reset_handler, NULL);
276
277 return ERROR_OK;
278 }
279
280 LOG_ERROR("uCOS-III: target not supported: %s", target->type->name);
281 return ERROR_FAIL;
282 }
283
284 static int uCOS_III_update_threads(struct rtos *rtos)
285 {
286 struct uCOS_III_params *params = rtos->rtos_specific_params;
287 int retval;
288
289 /* free previous thread details */
290 rtos_free_threadlist(rtos);
291
292 /* verify RTOS is running */
293 uint8_t rtos_running;
294
295 retval = target_read_u8(rtos->target,
296 rtos->symbols[uCOS_III_VAL_OSRunning].address,
297 &rtos_running);
298 if (retval != ERROR_OK) {
299 LOG_ERROR("uCOS-III: failed to read RTOS running");
300 return retval;
301 }
302
303 if (!rtos_running) {
304 rtos->thread_details = calloc(1, sizeof(struct thread_detail));
305 if (rtos->thread_details == NULL) {
306 LOG_ERROR("uCOS-III: out of memory");
307 return ERROR_FAIL;
308 }
309
310 rtos->thread_count = 1;
311 rtos->thread_details->threadid = 0;
312 rtos->thread_details->exists = true;
313 rtos->current_thread = 0;
314
315 return ERROR_OK;
316 }
317
318 /* update thread offsets */
319 retval = uCOS_III_update_thread_offsets(rtos);
320 if (retval != ERROR_OK) {
321 LOG_ERROR("uCOS-III: failed to update thread offsets");
322 return retval;
323 }
324
325 /* read current thread address */
326 symbol_address_t current_thread_address = 0;
327
328 retval = target_read_memory(rtos->target,
329 rtos->symbols[uCOS_III_VAL_OSTCBCurPtr].address,
330 params->pointer_width,
331 1,
332 (void *)&current_thread_address);
333 if (retval != ERROR_OK) {
334 LOG_ERROR("uCOS-III: failed to read current thread address");
335 return retval;
336 }
337
338 /* read number of tasks */
339 retval = target_read_u16(rtos->target,
340 rtos->symbols[uCOS_III_VAL_OSTaskQty].address,
341 (void *)&rtos->thread_count);
342 if (retval != ERROR_OK) {
343 LOG_ERROR("uCOS-III: failed to read thread count");
344 return retval;
345 }
346
347 rtos->thread_details = calloc(rtos->thread_count, sizeof(struct thread_detail));
348 if (rtos->thread_details == NULL) {
349 LOG_ERROR("uCOS-III: out of memory");
350 return ERROR_FAIL;
351 }
352
353 /*
354 * uC/OS-III adds tasks in LIFO order; advance to the end of the
355 * list and work backwards to preserve the intended order.
356 */
357 symbol_address_t thread_address = 0;
358
359 retval = uCOS_III_find_last_thread_address(rtos, &thread_address);
360 if (retval != ERROR_OK) {
361 LOG_ERROR("uCOS-III: failed to find last thread address");
362 return retval;
363 }
364
365 for (int i = 0; i < rtos->thread_count; i++) {
366 struct thread_detail *thread_detail = &rtos->thread_details[i];
367 char thread_str_buffer[UCOS_III_MAX_STRLEN + 1];
368
369 /* find or create new threadid */
370 retval = uCOS_III_find_or_create_thread(rtos, thread_address, &thread_detail->threadid);
371 if (retval != ERROR_OK) {
372 LOG_ERROR("uCOS-III: failed to find or create thread");
373 return retval;
374 }
375
376 if (thread_address == current_thread_address)
377 rtos->current_thread = thread_detail->threadid;
378
379 thread_detail->exists = true;
380
381 /* read thread name */
382 symbol_address_t thread_name_address = 0;
383
384 retval = target_read_memory(rtos->target,
385 thread_address + params->thread_name_offset,
386 params->pointer_width,
387 1,
388 (void *)&thread_name_address);
389 if (retval != ERROR_OK) {
390 LOG_ERROR("uCOS-III: failed to name address");
391 return retval;
392 }
393
394 retval = target_read_buffer(rtos->target,
395 thread_name_address,
396 sizeof(thread_str_buffer),
397 (void *)thread_str_buffer);
398 if (retval != ERROR_OK) {
399 LOG_ERROR("uCOS-III: failed to read thread name");
400 return retval;
401 }
402
403 thread_str_buffer[sizeof(thread_str_buffer) - 1] = '\0';
404 thread_detail->thread_name_str = strdup(thread_str_buffer);
405
406 /* read thread extra info */
407 uint8_t thread_state;
408 uint8_t thread_priority;
409
410 retval = target_read_u8(rtos->target,
411 thread_address + params->thread_state_offset,
412 &thread_state);
413 if (retval != ERROR_OK) {
414 LOG_ERROR("uCOS-III: failed to read thread state");
415 return retval;
416 }
417
418 retval = target_read_u8(rtos->target,
419 thread_address + params->thread_priority_offset,
420 &thread_priority);
421 if (retval != ERROR_OK) {
422 LOG_ERROR("uCOS-III: failed to read thread priority");
423 return retval;
424 }
425
426 const char *thread_state_str;
427
428 if (thread_state < ARRAY_SIZE(uCOS_III_thread_state_list))
429 thread_state_str = uCOS_III_thread_state_list[thread_state];
430 else
431 thread_state_str = "Unknown";
432
433 snprintf(thread_str_buffer, sizeof(thread_str_buffer), "State: %s, Priority: %d",
434 thread_state_str, thread_priority);
435 thread_detail->extra_info_str = strdup(thread_str_buffer);
436
437 /* read previous thread address */
438 retval = target_read_memory(rtos->target,
439 thread_address + params->thread_prev_offset,
440 params->pointer_width,
441 1,
442 (void *)&thread_address);
443 if (retval != ERROR_OK) {
444 LOG_ERROR("uCOS-III: failed to read previous thread address");
445 return retval;
446 }
447 }
448
449 return ERROR_OK;
450 }
451
452 static int uCOS_III_get_thread_reg_list(struct rtos *rtos, threadid_t threadid, char **hex_reg_list)
453 {
454 struct uCOS_III_params *params = rtos->rtos_specific_params;
455 int retval;
456
457 /* find thread address for threadid */
458 symbol_address_t thread_address = 0;
459
460 retval = uCOS_III_find_thread_address(rtos, threadid, &thread_address);
461 if (retval != ERROR_OK) {
462 LOG_ERROR("uCOS-III: failed to find thread address");
463 return retval;
464 }
465
466 /* read thread stack address */
467 symbol_address_t stack_address = 0;
468
469 retval = target_read_memory(rtos->target,
470 thread_address + params->thread_stack_offset,
471 params->pointer_width,
472 1,
473 (void *)&stack_address);
474 if (retval != ERROR_OK) {
475 LOG_ERROR("uCOS-III: failed to read stack address");
476 return retval;
477 }
478
479 return rtos_generic_stack_read(rtos->target,
480 params->stacking_info,
481 stack_address,
482 hex_reg_list);
483 }
484
485 static int uCOS_III_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[])
486 {
487 *symbol_list = calloc(ARRAY_SIZE(uCOS_III_symbol_list), sizeof(symbol_table_elem_t));
488 if (*symbol_list == NULL) {
489 LOG_ERROR("uCOS-III: out of memory");
490 return ERROR_FAIL;
491 }
492
493 for (size_t i = 0; i < ARRAY_SIZE(uCOS_III_symbol_list); i++)
494 (*symbol_list)[i].symbol_name = uCOS_III_symbol_list[i];
495
496 return ERROR_OK;
497 }
498
499 const struct rtos_type uCOS_III_rtos = {
500 .name = "uCOS-III",
501 .detect_rtos = uCOS_III_detect_rtos,
502 .create = uCOS_III_create,
503 .update_threads = uCOS_III_update_threads,
504 .get_thread_reg_list = uCOS_III_get_thread_reg_list,
505 .get_symbol_list_to_lookup = uCOS_III_get_symbol_list_to_lookup,
506 };
Open On-Chip Debugger

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)