1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 /***************************************************************************
4 * Copyright (C) 2011 by Broadcom Corporation *
5 * Evan Hunter - ehunter@broadcom.com *
6 ***************************************************************************/
12 #include <helper/time_support.h>
13 #include <jtag/jtag.h>
14 #include "target/target.h"
15 #include "target/target_type.h"
17 #include "helper/log.h"
18 #include "helper/types.h"
19 #include "rtos_standard_stackings.h"
20 #include "target/armv7m.h"
21 #include "target/cortex_m.h"
23 #define FREERTOS_MAX_PRIORITIES 63
25 /* FIXME: none of the _width parameters are actually observed properly!
26 * you WILL need to edit more if you actually attempt to target a 8/16/64
30 struct freertos_params {
31 const char *target_name;
32 const unsigned char thread_count_width;
33 const unsigned char pointer_width;
34 const unsigned char list_next_offset;
35 const unsigned char list_width;
36 const unsigned char list_elem_next_offset;
37 const unsigned char list_elem_content_offset;
38 const unsigned char thread_stack_offset;
39 const unsigned char thread_name_offset;
40 const struct rtos_register_stacking *stacking_info_cm3;
41 const struct rtos_register_stacking *stacking_info_cm4f;
42 const struct rtos_register_stacking *stacking_info_cm4f_fpu;
45 static const struct freertos_params freertos_params_list[] = {
47 "cortex_m", /* target_name */
48 4, /* thread_count_width; */
49 4, /* pointer_width; */
50 16, /* list_next_offset; */
52 8, /* list_elem_next_offset; */
53 12, /* list_elem_content_offset */
54 0, /* thread_stack_offset; */
55 52, /* thread_name_offset; */
56 &rtos_standard_cortex_m3_stacking, /* stacking_info */
57 &rtos_standard_cortex_m4f_stacking,
58 &rtos_standard_cortex_m4f_fpu_stacking,
61 "hla_target", /* target_name */
62 4, /* thread_count_width; */
63 4, /* pointer_width; */
64 16, /* list_next_offset; */
66 8, /* list_elem_next_offset; */
67 12, /* list_elem_content_offset */
68 0, /* thread_stack_offset; */
69 52, /* thread_name_offset; */
70 &rtos_standard_cortex_m3_stacking, /* stacking_info */
71 &rtos_standard_cortex_m4f_stacking,
72 &rtos_standard_cortex_m4f_fpu_stacking,
75 "nds32_v3", /* target_name */
76 4, /* thread_count_width; */
77 4, /* pointer_width; */
78 16, /* list_next_offset; */
80 8, /* list_elem_next_offset; */
81 12, /* list_elem_content_offset */
82 0, /* thread_stack_offset; */
83 52, /* thread_name_offset; */
84 &rtos_standard_nds32_n1068_stacking, /* stacking_info */
85 &rtos_standard_cortex_m4f_stacking,
86 &rtos_standard_cortex_m4f_fpu_stacking,
90 static bool freertos_detect_rtos(struct target *target);
91 static int freertos_create(struct target *target);
92 static int freertos_update_threads(struct rtos *rtos);
93 static int freertos_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
94 struct rtos_reg **reg_list, int *num_regs);
95 static int freertos_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[]);
97 struct rtos_type freertos_rtos = {
100 .detect_rtos = freertos_detect_rtos,
101 .create = freertos_create,
102 .update_threads = freertos_update_threads,
103 .get_thread_reg_list = freertos_get_thread_reg_list,
104 .get_symbol_list_to_lookup = freertos_get_symbol_list_to_lookup,
107 enum freertos_symbol_values {
108 FREERTOS_VAL_PX_CURRENT_TCB = 0,
109 FREERTOS_VAL_PX_READY_TASKS_LISTS = 1,
110 FREERTOS_VAL_X_DELAYED_TASK_LIST1 = 2,
111 FREERTOS_VAL_X_DELAYED_TASK_LIST2 = 3,
112 FREERTOS_VAL_PX_DELAYED_TASK_LIST = 4,
113 FREERTOS_VAL_PX_OVERFLOW_DELAYED_TASK_LIST = 5,
114 FREERTOS_VAL_X_PENDING_READY_LIST = 6,
115 FREERTOS_VAL_X_TASKS_WAITING_TERMINATION = 7,
116 FREERTOS_VAL_X_SUSPENDED_TASK_LIST = 8,
117 FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS = 9,
118 FREERTOS_VAL_UX_TOP_USED_PRIORITY = 10,
126 static const struct symbols freertos_symbol_list[] = {
127 { "pxCurrentTCB", false },
128 { "pxReadyTasksLists", false },
129 { "xDelayedTaskList1", false },
130 { "xDelayedTaskList2", false },
131 { "pxDelayedTaskList", false },
132 { "pxOverflowDelayedTaskList", false },
133 { "xPendingReadyList", false },
134 { "xTasksWaitingTermination", true }, /* Only if INCLUDE_vTaskDelete */
135 { "xSuspendedTaskList", true }, /* Only if INCLUDE_vTaskSuspend */
136 { "uxCurrentNumberOfTasks", false },
137 { "uxTopUsedPriority", true }, /* Unavailable since v7.5.3 */
142 /* this is not safe for little endian yet */
143 /* may be problems reading if sizes are not 32 bit long integers. */
144 /* test mallocs for failure */
146 static int freertos_update_threads(struct rtos *rtos)
149 unsigned int tasks_found = 0;
150 const struct freertos_params *param;
152 if (!rtos->rtos_specific_params)
155 param = (const struct freertos_params *) rtos->rtos_specific_params;
157 if (!rtos->symbols) {
158 LOG_ERROR("No symbols for FreeRTOS");
162 if (rtos->symbols[FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS].address == 0) {
163 LOG_ERROR("Don't have the number of threads in FreeRTOS");
167 uint32_t thread_list_size = 0;
168 retval = target_read_u32(rtos->target,
169 rtos->symbols[FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS].address,
171 LOG_DEBUG("FreeRTOS: Read uxCurrentNumberOfTasks at 0x%" PRIx64 ", value %" PRIu32,
172 rtos->symbols[FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS].address,
175 if (retval != ERROR_OK) {
176 LOG_ERROR("Could not read FreeRTOS thread count from target");
180 /* wipe out previous thread details if any */
181 rtos_free_threadlist(rtos);
183 /* read the current thread */
184 uint32_t pointer_casts_are_bad;
185 retval = target_read_u32(rtos->target,
186 rtos->symbols[FREERTOS_VAL_PX_CURRENT_TCB].address,
187 &pointer_casts_are_bad);
188 if (retval != ERROR_OK) {
189 LOG_ERROR("Error reading current thread in FreeRTOS thread list");
192 rtos->current_thread = pointer_casts_are_bad;
193 LOG_DEBUG("FreeRTOS: Read pxCurrentTCB at 0x%" PRIx64 ", value 0x%" PRIx64,
194 rtos->symbols[FREERTOS_VAL_PX_CURRENT_TCB].address,
195 rtos->current_thread);
197 if ((thread_list_size == 0) || (rtos->current_thread == 0)) {
198 /* Either : No RTOS threads - there is always at least the current execution though */
199 /* OR : No current thread - all threads suspended - show the current execution
201 char tmp_str[] = "Current Execution";
204 rtos->thread_details = malloc(
205 sizeof(struct thread_detail) * thread_list_size);
206 if (!rtos->thread_details) {
207 LOG_ERROR("Error allocating memory for %d threads", thread_list_size);
210 rtos->thread_details->threadid = 1;
211 rtos->thread_details->exists = true;
212 rtos->thread_details->extra_info_str = NULL;
213 rtos->thread_details->thread_name_str = malloc(sizeof(tmp_str));
214 strcpy(rtos->thread_details->thread_name_str, tmp_str);
216 if (thread_list_size == 1) {
217 rtos->thread_count = 1;
221 /* create space for new thread details */
222 rtos->thread_details = malloc(
223 sizeof(struct thread_detail) * thread_list_size);
224 if (!rtos->thread_details) {
225 LOG_ERROR("Error allocating memory for %d threads", thread_list_size);
230 /* Find out how many lists are needed to be read from pxReadyTasksLists, */
231 if (rtos->symbols[FREERTOS_VAL_UX_TOP_USED_PRIORITY].address == 0) {
232 LOG_ERROR("FreeRTOS: uxTopUsedPriority is not defined, consult the OpenOCD manual for a work-around");
235 uint32_t top_used_priority = 0;
236 retval = target_read_u32(rtos->target,
237 rtos->symbols[FREERTOS_VAL_UX_TOP_USED_PRIORITY].address,
239 if (retval != ERROR_OK)
241 LOG_DEBUG("FreeRTOS: Read uxTopUsedPriority at 0x%" PRIx64 ", value %" PRIu32,
242 rtos->symbols[FREERTOS_VAL_UX_TOP_USED_PRIORITY].address,
244 if (top_used_priority > FREERTOS_MAX_PRIORITIES) {
245 LOG_ERROR("FreeRTOS top used priority is unreasonably big, not proceeding: %" PRIu32,
250 /* uxTopUsedPriority was defined as configMAX_PRIORITIES - 1
251 * in old FreeRTOS versions (before V7.5.3)
252 * Use contrib/rtos-helpers/FreeRTOS-openocd.c to get compatible symbol
253 * in newer FreeRTOS versions.
254 * Here we restore the original configMAX_PRIORITIES value */
255 unsigned int config_max_priorities = top_used_priority + 1;
257 symbol_address_t *list_of_lists =
258 malloc(sizeof(symbol_address_t) * (config_max_priorities + 5));
259 if (!list_of_lists) {
260 LOG_ERROR("Error allocating memory for %u priorities", config_max_priorities);
264 unsigned int num_lists;
265 for (num_lists = 0; num_lists < config_max_priorities; num_lists++)
266 list_of_lists[num_lists] = rtos->symbols[FREERTOS_VAL_PX_READY_TASKS_LISTS].address +
267 num_lists * param->list_width;
269 list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_DELAYED_TASK_LIST1].address;
270 list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_DELAYED_TASK_LIST2].address;
271 list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_PENDING_READY_LIST].address;
272 list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_SUSPENDED_TASK_LIST].address;
273 list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_TASKS_WAITING_TERMINATION].address;
275 for (unsigned int i = 0; i < num_lists; i++) {
276 if (list_of_lists[i] == 0)
279 /* Read the number of threads in this list */
280 uint32_t list_thread_count = 0;
281 retval = target_read_u32(rtos->target,
284 if (retval != ERROR_OK) {
285 LOG_ERROR("Error reading number of threads in FreeRTOS thread list");
289 LOG_DEBUG("FreeRTOS: Read thread count for list %u at 0x%" PRIx64 ", value %" PRIu32,
290 i, list_of_lists[i], list_thread_count);
292 if (list_thread_count == 0)
295 /* Read the location of first list item */
296 uint32_t prev_list_elem_ptr = -1;
297 uint32_t list_elem_ptr = 0;
298 retval = target_read_u32(rtos->target,
299 list_of_lists[i] + param->list_next_offset,
301 if (retval != ERROR_OK) {
302 LOG_ERROR("Error reading first thread item location in FreeRTOS thread list");
306 LOG_DEBUG("FreeRTOS: Read first item for list %u at 0x%" PRIx64 ", value 0x%" PRIx32,
307 i, list_of_lists[i] + param->list_next_offset, list_elem_ptr);
309 while ((list_thread_count > 0) && (list_elem_ptr != 0) &&
310 (list_elem_ptr != prev_list_elem_ptr) &&
311 (tasks_found < thread_list_size)) {
312 /* Get the location of the thread structure. */
313 rtos->thread_details[tasks_found].threadid = 0;
314 retval = target_read_u32(rtos->target,
315 list_elem_ptr + param->list_elem_content_offset,
316 &pointer_casts_are_bad);
317 if (retval != ERROR_OK) {
318 LOG_ERROR("Error reading thread list item object in FreeRTOS thread list");
322 rtos->thread_details[tasks_found].threadid = pointer_casts_are_bad;
323 LOG_DEBUG("FreeRTOS: Read Thread ID at 0x%" PRIx32 ", value 0x%" PRIx64,
324 list_elem_ptr + param->list_elem_content_offset,
325 rtos->thread_details[tasks_found].threadid);
327 /* get thread name */
329 #define FREERTOS_THREAD_NAME_STR_SIZE (200)
330 char tmp_str[FREERTOS_THREAD_NAME_STR_SIZE];
332 /* Read the thread name */
333 retval = target_read_buffer(rtos->target,
334 rtos->thread_details[tasks_found].threadid + param->thread_name_offset,
335 FREERTOS_THREAD_NAME_STR_SIZE,
336 (uint8_t *)&tmp_str);
337 if (retval != ERROR_OK) {
338 LOG_ERROR("Error reading first thread item location in FreeRTOS thread list");
342 tmp_str[FREERTOS_THREAD_NAME_STR_SIZE-1] = '\x00';
343 LOG_DEBUG("FreeRTOS: Read Thread Name at 0x%" PRIx64 ", value '%s'",
344 rtos->thread_details[tasks_found].threadid + param->thread_name_offset,
347 if (tmp_str[0] == '\x00')
348 strcpy(tmp_str, "No Name");
350 rtos->thread_details[tasks_found].thread_name_str =
351 malloc(strlen(tmp_str)+1);
352 strcpy(rtos->thread_details[tasks_found].thread_name_str, tmp_str);
353 rtos->thread_details[tasks_found].exists = true;
355 if (rtos->thread_details[tasks_found].threadid == rtos->current_thread) {
356 char running_str[] = "State: Running";
357 rtos->thread_details[tasks_found].extra_info_str = malloc(
358 sizeof(running_str));
359 strcpy(rtos->thread_details[tasks_found].extra_info_str,
362 rtos->thread_details[tasks_found].extra_info_str = NULL;
367 prev_list_elem_ptr = list_elem_ptr;
369 retval = target_read_u32(rtos->target,
370 prev_list_elem_ptr + param->list_elem_next_offset,
372 if (retval != ERROR_OK) {
373 LOG_ERROR("Error reading next thread item location in FreeRTOS thread list");
377 LOG_DEBUG("FreeRTOS: Read next thread location at 0x%" PRIx32 ", value 0x%" PRIx32,
378 prev_list_elem_ptr + param->list_elem_next_offset,
384 rtos->thread_count = tasks_found;
388 static int freertos_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
389 struct rtos_reg **reg_list, int *num_regs)
392 const struct freertos_params *param;
393 int64_t stack_ptr = 0;
401 if (!rtos->rtos_specific_params)
404 param = (const struct freertos_params *) rtos->rtos_specific_params;
406 /* Read the stack pointer */
407 uint32_t pointer_casts_are_bad;
408 retval = target_read_u32(rtos->target,
409 thread_id + param->thread_stack_offset,
410 &pointer_casts_are_bad);
411 if (retval != ERROR_OK) {
412 LOG_ERROR("Error reading stack frame from FreeRTOS thread");
415 stack_ptr = pointer_casts_are_bad;
416 LOG_DEBUG("FreeRTOS: Read stack pointer at 0x%" PRIx64 ", value 0x%" PRIx64,
417 thread_id + param->thread_stack_offset,
420 /* Check for armv7m with *enabled* FPU, i.e. a Cortex-M4F */
421 int cm4_fpu_enabled = 0;
422 struct armv7m_common *armv7m_target = target_to_armv7m(rtos->target);
423 if (is_armv7m(armv7m_target)) {
424 if (armv7m_target->fp_feature == FPV4_SP) {
425 /* Found ARM v7m target which includes a FPU */
428 retval = target_read_u32(rtos->target, FPU_CPACR, &cpacr);
429 if (retval != ERROR_OK) {
430 LOG_ERROR("Could not read CPACR register to check FPU state");
434 /* Check if CP10 and CP11 are set to full access. */
435 if (cpacr & 0x00F00000) {
436 /* Found target with enabled FPU */
442 if (cm4_fpu_enabled == 1) {
443 /* Read the LR to decide between stacking with or without FPU */
445 retval = target_read_u32(rtos->target,
448 if (retval != ERROR_OK) {
449 LOG_OUTPUT("Error reading stack frame from FreeRTOS thread");
452 if ((lr_svc & 0x10) == 0)
453 return rtos_generic_stack_read(rtos->target, param->stacking_info_cm4f_fpu, stack_ptr, reg_list, num_regs);
455 return rtos_generic_stack_read(rtos->target, param->stacking_info_cm4f, stack_ptr, reg_list, num_regs);
457 return rtos_generic_stack_read(rtos->target, param->stacking_info_cm3, stack_ptr, reg_list, num_regs);
460 static int freertos_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[])
463 *symbol_list = calloc(
464 ARRAY_SIZE(freertos_symbol_list), sizeof(struct symbol_table_elem));
466 for (i = 0; i < ARRAY_SIZE(freertos_symbol_list); i++) {
467 (*symbol_list)[i].symbol_name = freertos_symbol_list[i].name;
468 (*symbol_list)[i].optional = freertos_symbol_list[i].optional;
476 static int freertos_set_current_thread(struct rtos *rtos, threadid_t thread_id)
481 static int freertos_get_thread_ascii_info(struct rtos *rtos, threadid_t thread_id, char **info)
484 const struct freertos_params *param;
492 if (!rtos->rtos_specific_params)
495 param = (const struct freertos_params *) rtos->rtos_specific_params;
497 #define FREERTOS_THREAD_NAME_STR_SIZE (200)
498 char tmp_str[FREERTOS_THREAD_NAME_STR_SIZE];
500 /* Read the thread name */
501 retval = target_read_buffer(rtos->target,
502 thread_id + param->thread_name_offset,
503 FREERTOS_THREAD_NAME_STR_SIZE,
504 (uint8_t *)&tmp_str);
505 if (retval != ERROR_OK) {
506 LOG_ERROR("Error reading first thread item location in FreeRTOS thread list");
509 tmp_str[FREERTOS_THREAD_NAME_STR_SIZE-1] = '\x00';
511 if (tmp_str[0] == '\x00')
512 strcpy(tmp_str, "No Name");
514 *info = malloc(strlen(tmp_str)+1);
515 strcpy(*info, tmp_str);
521 static bool freertos_detect_rtos(struct target *target)
523 if ((target->rtos->symbols) &&
524 (target->rtos->symbols[FREERTOS_VAL_PX_READY_TASKS_LISTS].address != 0)) {
525 /* looks like FreeRTOS */
531 static int freertos_create(struct target *target)
533 for (unsigned int i = 0; i < ARRAY_SIZE(freertos_params_list); i++)
534 if (strcmp(freertos_params_list[i].target_name, target->type->name) == 0) {
535 target->rtos->rtos_specific_params = (void *)&freertos_params_list[i];
539 LOG_ERROR("Could not find target in FreeRTOS compatibility list");