openocd: fix SPDX tag format for files .c
[fw/openocd] / src / rtos / embKernel.c
index fe1883fe45c0c5f8674d0e9a79feb5afc198715b..c1b5723fcee1e500abe0578f49abf604688faffb 100644 (file)
@@ -1,21 +1,8 @@
+// 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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 
 #define EMBKERNEL_MAX_THREAD_NAME_STR_SIZE (64)
 
-static int embKernel_detect_rtos(struct target *target);
-static int embKernel_create(struct target *target);
-static int embKernel_update_threads(struct rtos *rtos);
-static int embKernel_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, char **hex_reg_list);
-static int embKernel_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[]);
+static bool embkernel_detect_rtos(struct target *target);
+static int embkernel_create(struct target *target);
+static int embkernel_update_threads(struct rtos *rtos);
+static int embkernel_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
+               struct rtos_reg **reg_list, int *num_regs);
+static int embkernel_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[]);
 
-struct rtos_type embKernel_rtos = {
+struct rtos_type embkernel_rtos = {
                .name = "embKernel",
-               .detect_rtos = embKernel_detect_rtos,
-               .create = embKernel_create,
-               .update_threads = embKernel_update_threads,
+               .detect_rtos = embkernel_detect_rtos,
+               .create = embkernel_create,
+               .update_threads = embkernel_update_threads,
                .get_thread_reg_list =
-               embKernel_get_thread_reg_list,
-               .get_symbol_list_to_lookup = embKernel_get_symbol_list_to_lookup,
+               embkernel_get_thread_reg_list,
+               .get_symbol_list_to_lookup = embkernel_get_symbol_list_to_lookup,
 };
 
 enum {
-       SYMBOL_ID_sCurrentTask = 0,
-       SYMBOL_ID_sListReady = 1,
-       SYMBOL_ID_sListSleep = 2,
-       SYMBOL_ID_sListSuspended = 3,
-       SYMBOL_ID_sMaxPriorities = 4,
-       SYMBOL_ID_sCurrentTaskCount = 5,
+       SYMBOL_ID_S_CURRENT_TASK = 0,
+       SYMBOL_ID_S_LIST_READY = 1,
+       SYMBOL_ID_S_LIST_SLEEP = 2,
+       SYMBOL_ID_S_LIST_SUSPENDED = 3,
+       SYMBOL_ID_S_MAX_PRIORITIES = 4,
+       SYMBOL_ID_S_CURRENT_TASK_COUNT = 5,
 };
 
-static char *embKernel_symbol_list[] = {
+static const char * const embkernel_symbol_list[] = {
                "Rtos::sCurrentTask",
                "Rtos::sListReady",
                "Rtos::sListSleep",
@@ -67,7 +55,7 @@ static char *embKernel_symbol_list[] = {
                "Rtos::sCurrentTaskCount",
                NULL };
 
-struct embKernel_params {
+struct embkernel_params {
        const char *target_name;
        const unsigned char pointer_width;
        const unsigned char thread_count_width;
@@ -81,9 +69,9 @@ struct embKernel_params {
        const struct rtos_register_stacking *stacking_info;
 };
 
-struct embKernel_params embKernel_params_list[] = {
+static const struct embkernel_params embkernel_params_list[] = {
                {
-                       "cortex_m3", /* target_name */
+                       "cortex_m", /* target_name */
                        4, /* pointer_width */
                        4, /* thread_count_width */
                        8, /*rtos_list_size */
@@ -93,7 +81,7 @@ struct embKernel_params embKernel_params_list[] = {
                        4, /*thread_priority_width */
                        4, /*iterable_next_offset */
                        12, /*iterable_task_owner_offset */
-                       &rtos_embkernel_Cortex_M3_stacking, /* stacking_info*/
+                       &rtos_embkernel_cortex_m_stacking, /* stacking_info*/
                },
                { "hla_target", /* target_name */
                        4, /* pointer_width */
@@ -105,38 +93,38 @@ struct embKernel_params embKernel_params_list[] = {
                        4, /*thread_priority_width */
                        4, /*iterable_next_offset */
                        12, /*iterable_task_owner_offset */
-                       &rtos_embkernel_Cortex_M3_stacking, /* stacking_info */
+                       &rtos_embkernel_cortex_m_stacking, /* stacking_info */
                }
 };
 
-static int embKernel_detect_rtos(struct target *target)
+static bool embkernel_detect_rtos(struct target *target)
 {
-       if (target->rtos->symbols != NULL) {
-               if (target->rtos->symbols[SYMBOL_ID_sCurrentTask].address != 0)
-                       return 1;
+       if (target->rtos->symbols) {
+               if (target->rtos->symbols[SYMBOL_ID_S_CURRENT_TASK].address != 0)
+                       return true;
        }
-       return 0;
+       return false;
 }
 
-static int embKernel_create(struct target *target)
+static int embkernel_create(struct target *target)
 {
        size_t i = 0;
-       while ((i < ARRAY_SIZE(embKernel_params_list)) &&
-                       (0 != strcmp(embKernel_params_list[i].target_name, target->type->name)))
+       while ((i < ARRAY_SIZE(embkernel_params_list)) &&
+                       (strcmp(embkernel_params_list[i].target_name, target->type->name) != 0))
                i++;
 
-       if (i >= ARRAY_SIZE(embKernel_params_list)) {
+       if (i >= ARRAY_SIZE(embkernel_params_list)) {
                LOG_WARNING("Could not find target \"%s\" in embKernel compatibility "
                                "list", target->type->name);
                return -1;
        }
 
-       target->rtos->rtos_specific_params = (void *) &embKernel_params_list[i];
+       target->rtos->rtos_specific_params = (void *) &embkernel_params_list[i];
        return 0;
 }
 
-static int embKernel_get_tasks_details(struct rtos *rtos, int64_t iterable, const struct embKernel_params *param,
-               struct thread_detail *details, const charstate_str)
+static int embkernel_get_tasks_details(struct rtos *rtos, int64_t iterable, const struct embkernel_params *param,
+               struct thread_detail *details, const char *state_str)
 {
        int64_t task = 0;
        int retval = target_read_buffer(rtos->target, iterable + param->iterable_task_owner_offset, param->pointer_width,
@@ -145,7 +133,6 @@ static int embKernel_get_tasks_details(struct rtos *rtos, int64_t iterable, cons
                return retval;
        details->threadid = (threadid_t) task;
        details->exists = true;
-       details->display_str = NULL;
 
        int64_t name_ptr = 0;
        retval = target_read_buffer(rtos->target, task + param->thread_name_offset, param->pointer_width,
@@ -169,13 +156,13 @@ static int embKernel_get_tasks_details(struct rtos *rtos, int64_t iterable, cons
                        (uint8_t *) &priority);
        if (retval != ERROR_OK)
                return retval;
-       details->extra_info_str = (char *) malloc(EMBKERNEL_MAX_THREAD_NAME_STR_SIZE);
+       details->extra_info_str = malloc(EMBKERNEL_MAX_THREAD_NAME_STR_SIZE);
        if (task == rtos->current_thread) {
-               snprintf(details->extra_info_str, EMBKERNEL_MAX_THREAD_NAME_STR_SIZE, "Pri=%u, Running",
+               snprintf(details->extra_info_str, EMBKERNEL_MAX_THREAD_NAME_STR_SIZE, "State: Running, Priority: %u",
                                (unsigned int) priority);
        } else {
-               snprintf(details->extra_info_str, EMBKERNEL_MAX_THREAD_NAME_STR_SIZE, "Pri=%u, %s", (unsigned int) priority,
-                               state_str);
+               snprintf(details->extra_info_str, EMBKERNEL_MAX_THREAD_NAME_STR_SIZE, "State: %s, Priority: %u",
+                               state_str, (unsigned int) priority);
        }
 
        LOG_OUTPUT("Getting task details: iterable=0x%08X, task=0x%08X, name=%s\n", (unsigned int)iterable,
@@ -183,52 +170,34 @@ static int embKernel_get_tasks_details(struct rtos *rtos, int64_t iterable, cons
        return 0;
 }
 
-static int embKernel_update_threads(struct rtos *rtos)
+static int embkernel_update_threads(struct rtos *rtos)
 {
        /* int i = 0; */
        int retval;
-       const struct embKernel_params *param;
+       const struct embkernel_params *param;
 
-       if (rtos == NULL)
+       if (!rtos)
                return -1;
 
-       if (rtos->rtos_specific_params == NULL)
+       if (!rtos->rtos_specific_params)
                return -3;
 
-       if (rtos->symbols == NULL) {
+       if (!rtos->symbols) {
                LOG_ERROR("No symbols for embKernel");
                return -4;
        }
 
-       if (rtos->symbols[SYMBOL_ID_sCurrentTask].address == 0) {
+       if (rtos->symbols[SYMBOL_ID_S_CURRENT_TASK].address == 0) {
                LOG_ERROR("Don't have the thread list head");
                return -2;
        }
 
        /* wipe out previous thread details if any */
-       if (rtos->thread_details != NULL) {
-               int j;
-               for (j = 0; j < rtos->thread_count; j++) {
-                       if (rtos->thread_details[j].display_str != NULL) {
-                               free(rtos->thread_details[j].display_str);
-                               rtos->thread_details[j].display_str = NULL;
-                       }
-                       if (rtos->thread_details[j].thread_name_str != NULL) {
-                               free(rtos->thread_details[j].thread_name_str);
-                               rtos->thread_details[j].thread_name_str = NULL;
-                       }
-                       if (rtos->thread_details[j].extra_info_str != NULL) {
-                               free(rtos->thread_details[j].extra_info_str);
-                               rtos->thread_details[j].extra_info_str = NULL;
-                       }
-               }
-               free(rtos->thread_details);
-               rtos->thread_details = NULL;
-       }
+       rtos_free_threadlist(rtos);
 
-       param = (const struct embKernel_params *) rtos->rtos_specific_params;
+       param = (const struct embkernel_params *) rtos->rtos_specific_params;
 
-       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_sCurrentTask].address, param->pointer_width,
+       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_S_CURRENT_TASK].address, param->pointer_width,
                        (uint8_t *) &rtos->current_thread);
        if (retval != ERROR_OK) {
                LOG_ERROR("Error reading current thread in embKernel thread list");
@@ -236,13 +205,13 @@ static int embKernel_update_threads(struct rtos *rtos)
        }
 
        int64_t max_used_priority = 0;
-       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_sMaxPriorities].address, param->pointer_width,
+       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_S_MAX_PRIORITIES].address, param->pointer_width,
                        (uint8_t *) &max_used_priority);
        if (retval != ERROR_OK)
                return retval;
 
        int thread_list_size = 0;
-       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_sCurrentTaskCount].address,
+       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_S_CURRENT_TASK_COUNT].address,
                        param->thread_count_width, (uint8_t *) &thread_list_size);
 
        if (retval != ERROR_OK) {
@@ -251,25 +220,25 @@ static int embKernel_update_threads(struct rtos *rtos)
        }
 
        /* create space for new thread details */
-       rtos->thread_details = (struct thread_detail *) malloc(sizeof(struct thread_detail) * thread_list_size);
+       rtos->thread_details = malloc(sizeof(struct thread_detail) * thread_list_size);
        if (!rtos->thread_details) {
                LOG_ERROR("Error allocating memory for %d threads", thread_list_size);
                return ERROR_FAIL;
        }
 
-       int threadIdx = 0;
+       int thread_idx = 0;
        /* Look for ready tasks */
        for (int pri = 0; pri < max_used_priority; pri++) {
                /* Get first item in queue */
                int64_t iterable = 0;
                retval = target_read_buffer(rtos->target,
-                               rtos->symbols[SYMBOL_ID_sListReady].address + (pri * param->rtos_list_size), param->pointer_width,
+                               rtos->symbols[SYMBOL_ID_S_LIST_READY].address + (pri * param->rtos_list_size), param->pointer_width,
                                (uint8_t *) &iterable);
                if (retval != ERROR_OK)
                        return retval;
-               for (; iterable && threadIdx < thread_list_size; threadIdx++) {
+               for (; iterable && thread_idx < thread_list_size; thread_idx++) {
                        /* Get info from this iterable item */
-                       retval = embKernel_get_tasks_details(rtos, iterable, param, &rtos->thread_details[threadIdx], "Ready");
+                       retval = embkernel_get_tasks_details(rtos, iterable, param, &rtos->thread_details[thread_idx], "Ready");
                        if (retval != ERROR_OK)
                                return retval;
                        /* Get next iterable item */
@@ -281,13 +250,13 @@ static int embKernel_update_threads(struct rtos *rtos)
        }
        /* Look for sleeping tasks */
        int64_t iterable = 0;
-       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_sListSleep].address, param->pointer_width,
+       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_S_LIST_SLEEP].address, param->pointer_width,
                        (uint8_t *) &iterable);
        if (retval != ERROR_OK)
                return retval;
-       for (; iterable && threadIdx < thread_list_size; threadIdx++) {
+       for (; iterable && thread_idx < thread_list_size; thread_idx++) {
                /*Get info from this iterable item */
-               retval = embKernel_get_tasks_details(rtos, iterable, param, &rtos->thread_details[threadIdx], "Sleeping");
+               retval = embkernel_get_tasks_details(rtos, iterable, param, &rtos->thread_details[thread_idx], "Sleeping");
                if (retval != ERROR_OK)
                        return retval;
                /*Get next iterable item */
@@ -299,13 +268,13 @@ static int embKernel_update_threads(struct rtos *rtos)
 
        /* Look for suspended tasks  */
        iterable = 0;
-       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_sListSuspended].address, param->pointer_width,
+       retval = target_read_buffer(rtos->target, rtos->symbols[SYMBOL_ID_S_LIST_SUSPENDED].address, param->pointer_width,
                        (uint8_t *) &iterable);
        if (retval != ERROR_OK)
                return retval;
-       for (; iterable && threadIdx < thread_list_size; threadIdx++) {
+       for (; iterable && thread_idx < thread_list_size; thread_idx++) {
                /* Get info from this iterable item */
-               retval = embKernel_get_tasks_details(rtos, iterable, param, &rtos->thread_details[threadIdx], "Suspended");
+               retval = embkernel_get_tasks_details(rtos, iterable, param, &rtos->thread_details[thread_idx], "Suspended");
                if (retval != ERROR_OK)
                        return retval;
                /*Get next iterable item */
@@ -316,28 +285,28 @@ static int embKernel_update_threads(struct rtos *rtos)
        }
 
        rtos->thread_count = 0;
-       rtos->thread_count = threadIdx;
-       LOG_OUTPUT("Found %u tasks\n", (unsigned int)threadIdx);
+       rtos->thread_count = thread_idx;
+       LOG_OUTPUT("Found %u tasks\n", (unsigned int)thread_idx);
        return 0;
 }
 
-static int embKernel_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, char **hex_reg_list)
+static int embkernel_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
+               struct rtos_reg **reg_list, int *num_regs)
 {
        int retval;
-       const struct embKernel_params *param;
+       const struct embkernel_params *param;
        int64_t stack_ptr = 0;
 
-       *hex_reg_list = NULL;
-       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 embKernel_params *) rtos->rtos_specific_params;
+       param = (const struct embkernel_params *) rtos->rtos_specific_params;
 
        /* Read the stack pointer */
        retval = target_read_buffer(rtos->target, thread_id + param->thread_stack_offset, param->pointer_width,
@@ -347,17 +316,16 @@ static int embKernel_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, c
                return retval;
        }
 
-       return rtos_generic_stack_read(rtos->target, param->stacking_info, stack_ptr, hex_reg_list);
+       return rtos_generic_stack_read(rtos->target, param->stacking_info, stack_ptr, reg_list, num_regs);
 }
 
-static int embKernel_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[])
+static int embkernel_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[])
 {
        unsigned int i;
-       *symbol_list = (symbol_table_elem_t *) malloc(sizeof(symbol_table_elem_t) * ARRAY_SIZE(embKernel_symbol_list));
+       *symbol_list = calloc(ARRAY_SIZE(embkernel_symbol_list), sizeof(struct symbol_table_elem));
 
-       for (i = 0; i < ARRAY_SIZE(embKernel_symbol_list); i++)
-               (*symbol_list)[i].symbol_name = embKernel_symbol_list[i];
+       for (i = 0; i < ARRAY_SIZE(embkernel_symbol_list); i++)
+               (*symbol_list)[i].symbol_name = embkernel_symbol_list[i];
 
        return 0;
 }
-