+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
/***************************************************************************
* Copyright (C) 2011 by Broadcom Corporation *
* Evan Hunter - ehunter@broadcom.com *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program. If not, see <http://www.gnu.org/licenses/>. *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "target/armv7m.h"
#include "target/cortex_m.h"
-
-
#define FREERTOS_MAX_PRIORITIES 63
-#define FreeRTOS_STRUCT(int_type, ptr_type, list_prev_offset)
-
/* FIXME: none of the _width parameters are actually observed properly!
* you WILL need to edit more if you actually attempt to target a 8/16/64
* bit target!
*/
-struct FreeRTOS_params {
+struct freertos_params {
const char *target_name;
const unsigned char thread_count_width;
const unsigned char pointer_width;
const struct rtos_register_stacking *stacking_info_cm4f_fpu;
};
-static const struct FreeRTOS_params FreeRTOS_params_list[] = {
+static const struct freertos_params freertos_params_list[] = {
{
"cortex_m", /* target_name */
4, /* thread_count_width; */
12, /* list_elem_content_offset */
0, /* thread_stack_offset; */
52, /* thread_name_offset; */
- &rtos_standard_Cortex_M3_stacking, /* stacking_info */
- &rtos_standard_Cortex_M4F_stacking,
- &rtos_standard_Cortex_M4F_FPU_stacking,
+ &rtos_standard_cortex_m3_stacking, /* stacking_info */
+ &rtos_standard_cortex_m4f_stacking,
+ &rtos_standard_cortex_m4f_fpu_stacking,
},
{
"hla_target", /* target_name */
12, /* list_elem_content_offset */
0, /* thread_stack_offset; */
52, /* thread_name_offset; */
- &rtos_standard_Cortex_M3_stacking, /* stacking_info */
- &rtos_standard_Cortex_M4F_stacking,
- &rtos_standard_Cortex_M4F_FPU_stacking,
+ &rtos_standard_cortex_m3_stacking, /* stacking_info */
+ &rtos_standard_cortex_m4f_stacking,
+ &rtos_standard_cortex_m4f_fpu_stacking,
},
{
"nds32_v3", /* target_name */
12, /* list_elem_content_offset */
0, /* thread_stack_offset; */
52, /* thread_name_offset; */
- &rtos_standard_NDS32_N1068_stacking, /* stacking_info */
- &rtos_standard_Cortex_M4F_stacking,
- &rtos_standard_Cortex_M4F_FPU_stacking,
+ &rtos_standard_nds32_n1068_stacking, /* stacking_info */
+ &rtos_standard_cortex_m4f_stacking,
+ &rtos_standard_cortex_m4f_fpu_stacking,
},
};
-#define FREERTOS_NUM_PARAMS ((int)(sizeof(FreeRTOS_params_list)/sizeof(struct FreeRTOS_params)))
-
-static bool FreeRTOS_detect_rtos(struct target *target);
-static int FreeRTOS_create(struct target *target);
-static int FreeRTOS_update_threads(struct rtos *rtos);
-static int FreeRTOS_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
+static bool freertos_detect_rtos(struct target *target);
+static int freertos_create(struct target *target);
+static int freertos_update_threads(struct rtos *rtos);
+static int freertos_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
struct rtos_reg **reg_list, int *num_regs);
-static int FreeRTOS_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[]);
+static int freertos_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[]);
-struct rtos_type FreeRTOS_rtos = {
+struct rtos_type freertos_rtos = {
.name = "FreeRTOS",
- .detect_rtos = FreeRTOS_detect_rtos,
- .create = FreeRTOS_create,
- .update_threads = FreeRTOS_update_threads,
- .get_thread_reg_list = FreeRTOS_get_thread_reg_list,
- .get_symbol_list_to_lookup = FreeRTOS_get_symbol_list_to_lookup,
+ .detect_rtos = freertos_detect_rtos,
+ .create = freertos_create,
+ .update_threads = freertos_update_threads,
+ .get_thread_reg_list = freertos_get_thread_reg_list,
+ .get_symbol_list_to_lookup = freertos_get_symbol_list_to_lookup,
};
-enum FreeRTOS_symbol_values {
- FreeRTOS_VAL_pxCurrentTCB = 0,
- FreeRTOS_VAL_pxReadyTasksLists = 1,
- FreeRTOS_VAL_xDelayedTaskList1 = 2,
- FreeRTOS_VAL_xDelayedTaskList2 = 3,
- FreeRTOS_VAL_pxDelayedTaskList = 4,
- FreeRTOS_VAL_pxOverflowDelayedTaskList = 5,
- FreeRTOS_VAL_xPendingReadyList = 6,
- FreeRTOS_VAL_xTasksWaitingTermination = 7,
- FreeRTOS_VAL_xSuspendedTaskList = 8,
- FreeRTOS_VAL_uxCurrentNumberOfTasks = 9,
- FreeRTOS_VAL_uxTopUsedPriority = 10,
+enum freertos_symbol_values {
+ FREERTOS_VAL_PX_CURRENT_TCB = 0,
+ FREERTOS_VAL_PX_READY_TASKS_LISTS = 1,
+ FREERTOS_VAL_X_DELAYED_TASK_LIST1 = 2,
+ FREERTOS_VAL_X_DELAYED_TASK_LIST2 = 3,
+ FREERTOS_VAL_PX_DELAYED_TASK_LIST = 4,
+ FREERTOS_VAL_PX_OVERFLOW_DELAYED_TASK_LIST = 5,
+ FREERTOS_VAL_X_PENDING_READY_LIST = 6,
+ FREERTOS_VAL_X_TASKS_WAITING_TERMINATION = 7,
+ FREERTOS_VAL_X_SUSPENDED_TASK_LIST = 8,
+ FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS = 9,
+ FREERTOS_VAL_UX_TOP_USED_PRIORITY = 10,
};
struct symbols {
bool optional;
};
-static const struct symbols FreeRTOS_symbol_list[] = {
+static const struct symbols freertos_symbol_list[] = {
{ "pxCurrentTCB", false },
{ "pxReadyTasksLists", false },
{ "xDelayedTaskList1", false },
/* may be problems reading if sizes are not 32 bit long integers. */
/* test mallocs for failure */
-static int FreeRTOS_update_threads(struct rtos *rtos)
+static int freertos_update_threads(struct rtos *rtos)
{
int retval;
unsigned int tasks_found = 0;
- const struct FreeRTOS_params *param;
+ const struct freertos_params *param;
- if (rtos->rtos_specific_params == NULL)
+ if (!rtos->rtos_specific_params)
return -1;
- param = (const struct FreeRTOS_params *) rtos->rtos_specific_params;
+ param = (const struct freertos_params *) rtos->rtos_specific_params;
- if (rtos->symbols == NULL) {
+ if (!rtos->symbols) {
LOG_ERROR("No symbols for FreeRTOS");
return -3;
}
- if (rtos->symbols[FreeRTOS_VAL_uxCurrentNumberOfTasks].address == 0) {
+ if (rtos->symbols[FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS].address == 0) {
LOG_ERROR("Don't have the number of threads in FreeRTOS");
return -2;
}
uint32_t thread_list_size = 0;
retval = target_read_u32(rtos->target,
- rtos->symbols[FreeRTOS_VAL_uxCurrentNumberOfTasks].address,
+ rtos->symbols[FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS].address,
&thread_list_size);
LOG_DEBUG("FreeRTOS: Read uxCurrentNumberOfTasks at 0x%" PRIx64 ", value %" PRIu32,
- rtos->symbols[FreeRTOS_VAL_uxCurrentNumberOfTasks].address,
+ rtos->symbols[FREERTOS_VAL_UX_CURRENT_NUMBER_OF_TASKS].address,
thread_list_size);
if (retval != ERROR_OK) {
/* read the current thread */
uint32_t pointer_casts_are_bad;
retval = target_read_u32(rtos->target,
- rtos->symbols[FreeRTOS_VAL_pxCurrentTCB].address,
+ rtos->symbols[FREERTOS_VAL_PX_CURRENT_TCB].address,
&pointer_casts_are_bad);
if (retval != ERROR_OK) {
LOG_ERROR("Error reading current thread in FreeRTOS thread list");
}
rtos->current_thread = pointer_casts_are_bad;
LOG_DEBUG("FreeRTOS: Read pxCurrentTCB at 0x%" PRIx64 ", value 0x%" PRIx64,
- rtos->symbols[FreeRTOS_VAL_pxCurrentTCB].address,
+ rtos->symbols[FREERTOS_VAL_PX_CURRENT_TCB].address,
rtos->current_thread);
if ((thread_list_size == 0) || (rtos->current_thread == 0)) {
}
/* Find out how many lists are needed to be read from pxReadyTasksLists, */
- if (rtos->symbols[FreeRTOS_VAL_uxTopUsedPriority].address == 0) {
+ if (rtos->symbols[FREERTOS_VAL_UX_TOP_USED_PRIORITY].address == 0) {
LOG_ERROR("FreeRTOS: uxTopUsedPriority is not defined, consult the OpenOCD manual for a work-around");
return ERROR_FAIL;
}
uint32_t top_used_priority = 0;
retval = target_read_u32(rtos->target,
- rtos->symbols[FreeRTOS_VAL_uxTopUsedPriority].address,
+ rtos->symbols[FREERTOS_VAL_UX_TOP_USED_PRIORITY].address,
&top_used_priority);
if (retval != ERROR_OK)
return retval;
LOG_DEBUG("FreeRTOS: Read uxTopUsedPriority at 0x%" PRIx64 ", value %" PRIu32,
- rtos->symbols[FreeRTOS_VAL_uxTopUsedPriority].address,
+ rtos->symbols[FREERTOS_VAL_UX_TOP_USED_PRIORITY].address,
top_used_priority);
if (top_used_priority > FREERTOS_MAX_PRIORITIES) {
LOG_ERROR("FreeRTOS top used priority is unreasonably big, not proceeding: %" PRIu32,
unsigned int num_lists;
for (num_lists = 0; num_lists < config_max_priorities; num_lists++)
- list_of_lists[num_lists] = rtos->symbols[FreeRTOS_VAL_pxReadyTasksLists].address +
+ list_of_lists[num_lists] = rtos->symbols[FREERTOS_VAL_PX_READY_TASKS_LISTS].address +
num_lists * param->list_width;
- list_of_lists[num_lists++] = rtos->symbols[FreeRTOS_VAL_xDelayedTaskList1].address;
- list_of_lists[num_lists++] = rtos->symbols[FreeRTOS_VAL_xDelayedTaskList2].address;
- list_of_lists[num_lists++] = rtos->symbols[FreeRTOS_VAL_xPendingReadyList].address;
- list_of_lists[num_lists++] = rtos->symbols[FreeRTOS_VAL_xSuspendedTaskList].address;
- list_of_lists[num_lists++] = rtos->symbols[FreeRTOS_VAL_xTasksWaitingTermination].address;
+ list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_DELAYED_TASK_LIST1].address;
+ list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_DELAYED_TASK_LIST2].address;
+ list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_PENDING_READY_LIST].address;
+ list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_SUSPENDED_TASK_LIST].address;
+ list_of_lists[num_lists++] = rtos->symbols[FREERTOS_VAL_X_TASKS_WAITING_TERMINATION].address;
for (unsigned int i = 0; i < num_lists; i++) {
if (list_of_lists[i] == 0)
return 0;
}
-static int FreeRTOS_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
+static int freertos_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
struct rtos_reg **reg_list, int *num_regs)
{
int retval;
- const struct FreeRTOS_params *param;
+ const struct freertos_params *param;
int64_t stack_ptr = 0;
- if (rtos == NULL)
+ if (!rtos)
return -1;
if (thread_id == 0)
return -2;
- if (rtos->rtos_specific_params == NULL)
+ if (!rtos->rtos_specific_params)
return -1;
- param = (const struct FreeRTOS_params *) rtos->rtos_specific_params;
+ param = (const struct freertos_params *) rtos->rtos_specific_params;
/* Read the stack pointer */
uint32_t pointer_casts_are_bad;
int cm4_fpu_enabled = 0;
struct armv7m_common *armv7m_target = target_to_armv7m(rtos->target);
if (is_armv7m(armv7m_target)) {
- if (armv7m_target->fp_feature == FPv4_SP) {
+ if (armv7m_target->fp_feature == FPV4_SP) {
/* Found ARM v7m target which includes a FPU */
uint32_t cpacr;
if (cm4_fpu_enabled == 1) {
/* Read the LR to decide between stacking with or without FPU */
- uint32_t LR_svc = 0;
+ uint32_t lr_svc = 0;
retval = target_read_u32(rtos->target,
stack_ptr + 0x20,
- &LR_svc);
+ &lr_svc);
if (retval != ERROR_OK) {
LOG_OUTPUT("Error reading stack frame from FreeRTOS thread");
return retval;
}
- if ((LR_svc & 0x10) == 0)
+ if ((lr_svc & 0x10) == 0)
return rtos_generic_stack_read(rtos->target, param->stacking_info_cm4f_fpu, stack_ptr, reg_list, num_regs);
else
return rtos_generic_stack_read(rtos->target, param->stacking_info_cm4f, stack_ptr, reg_list, num_regs);
return rtos_generic_stack_read(rtos->target, param->stacking_info_cm3, stack_ptr, reg_list, num_regs);
}
-static int FreeRTOS_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[])
+static int freertos_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[])
{
unsigned int i;
*symbol_list = calloc(
- ARRAY_SIZE(FreeRTOS_symbol_list), sizeof(symbol_table_elem_t));
+ ARRAY_SIZE(freertos_symbol_list), sizeof(struct symbol_table_elem));
- for (i = 0; i < ARRAY_SIZE(FreeRTOS_symbol_list); i++) {
- (*symbol_list)[i].symbol_name = FreeRTOS_symbol_list[i].name;
- (*symbol_list)[i].optional = FreeRTOS_symbol_list[i].optional;
+ for (i = 0; i < ARRAY_SIZE(freertos_symbol_list); i++) {
+ (*symbol_list)[i].symbol_name = freertos_symbol_list[i].name;
+ (*symbol_list)[i].optional = freertos_symbol_list[i].optional;
}
return 0;
#if 0
-static int FreeRTOS_set_current_thread(struct rtos *rtos, threadid_t thread_id)
+static int freertos_set_current_thread(struct rtos *rtos, threadid_t thread_id)
{
return 0;
}
-static int FreeRTOS_get_thread_ascii_info(struct rtos *rtos, threadid_t thread_id, char **info)
+static int freertos_get_thread_ascii_info(struct rtos *rtos, threadid_t thread_id, char **info)
{
int retval;
- const struct FreeRTOS_params *param;
+ const struct freertos_params *param;
- if (rtos == NULL)
+ if (!rtos)
return -1;
if (thread_id == 0)
return -2;
- if (rtos->rtos_specific_params == NULL)
+ if (!rtos->rtos_specific_params)
return -3;
- param = (const struct FreeRTOS_params *) rtos->rtos_specific_params;
+ param = (const struct freertos_params *) rtos->rtos_specific_params;
#define FREERTOS_THREAD_NAME_STR_SIZE (200)
char tmp_str[FREERTOS_THREAD_NAME_STR_SIZE];
#endif
-static bool FreeRTOS_detect_rtos(struct target *target)
+static bool freertos_detect_rtos(struct target *target)
{
- if ((target->rtos->symbols != NULL) &&
- (target->rtos->symbols[FreeRTOS_VAL_pxReadyTasksLists].address != 0)) {
+ if ((target->rtos->symbols) &&
+ (target->rtos->symbols[FREERTOS_VAL_PX_READY_TASKS_LISTS].address != 0)) {
/* looks like FreeRTOS */
return true;
}
return false;
}
-static int FreeRTOS_create(struct target *target)
+static int freertos_create(struct target *target)
{
- int i = 0;
- while ((i < FREERTOS_NUM_PARAMS) &&
- (0 != strcmp(FreeRTOS_params_list[i].target_name, target->type->name))) {
- i++;
- }
- if (i >= FREERTOS_NUM_PARAMS) {
- LOG_ERROR("Could not find target in FreeRTOS compatibility list");
- return -1;
- }
+ for (unsigned int i = 0; i < ARRAY_SIZE(freertos_params_list); i++)
+ if (strcmp(freertos_params_list[i].target_name, target->type->name) == 0) {
+ target->rtos->rtos_specific_params = (void *)&freertos_params_list[i];
+ return 0;
+ }
- target->rtos->rtos_specific_params = (void *) &FreeRTOS_params_list[i];
- return 0;
+ LOG_ERROR("Could not find target in FreeRTOS compatibility list");
+ return -1;
}