openocd: fix SPDX tag format for files .c
[fw/openocd] / src / rtos / embKernel.c
index 620d16baa72958d0df3d918af7e4695487c796c4..c1b5723fcee1e500abe0578f49abf604688faffb 100644 (file)
@@ -1,19 +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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 
 #define EMBKERNEL_MAX_THREAD_NAME_STR_SIZE (64)
 
-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,
+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[]);
+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 {
@@ -57,7 +46,7 @@ enum {
        SYMBOL_ID_S_CURRENT_TASK_COUNT = 5,
 };
 
-static const char * const embKernel_symbol_list[] = {
+static const char * const embkernel_symbol_list[] = {
                "Rtos::sCurrentTask",
                "Rtos::sListReady",
                "Rtos::sListSleep",
@@ -66,7 +55,7 @@ static const char * const 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;
@@ -80,7 +69,7 @@ struct embKernel_params {
        const struct rtos_register_stacking *stacking_info;
 };
 
-static const struct embKernel_params embKernel_params_list[] = {
+static const struct embkernel_params embkernel_params_list[] = {
                {
                        "cortex_m", /* target_name */
                        4, /* pointer_width */
@@ -92,7 +81,7 @@ static const struct embKernel_params embKernel_params_list[] = {
                        4, /*thread_priority_width */
                        4, /*iterable_next_offset */
                        12, /*iterable_task_owner_offset */
-                       &rtos_embkernel_Cortex_M_stacking, /* stacking_info*/
+                       &rtos_embkernel_cortex_m_stacking, /* stacking_info*/
                },
                { "hla_target", /* target_name */
                        4, /* pointer_width */
@@ -104,37 +93,37 @@ static const struct embKernel_params embKernel_params_list[] = {
                        4, /*thread_priority_width */
                        4, /*iterable_next_offset */
                        12, /*iterable_task_owner_offset */
-                       &rtos_embkernel_Cortex_M_stacking, /* stacking_info */
+                       &rtos_embkernel_cortex_m_stacking, /* stacking_info */
                }
 };
 
-static bool embKernel_detect_rtos(struct target *target)
+static bool embkernel_detect_rtos(struct target *target)
 {
-       if (target->rtos->symbols != NULL) {
+       if (target->rtos->symbols) {
                if (target->rtos->symbols[SYMBOL_ID_S_CURRENT_TASK].address != 0)
                        return true;
        }
        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,
+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;
@@ -181,19 +170,19 @@ 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;
        }
@@ -206,7 +195,7 @@ static int embKernel_update_threads(struct rtos *rtos)
        /* wipe out previous thread details if any */
        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_S_CURRENT_TASK].address, param->pointer_width,
                        (uint8_t *) &rtos->current_thread);
@@ -237,7 +226,7 @@ static int embKernel_update_threads(struct rtos *rtos)
                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 */
@@ -247,9 +236,9 @@ static int embKernel_update_threads(struct rtos *rtos)
                                (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 */
@@ -265,9 +254,9 @@ static int embKernel_update_threads(struct rtos *rtos)
                        (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 */
@@ -283,9 +272,9 @@ static int embKernel_update_threads(struct rtos *rtos)
                        (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 */
@@ -296,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,
+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;
 
-       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,
@@ -330,13 +319,13 @@ static int embKernel_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
        return rtos_generic_stack_read(rtos->target, param->stacking_info, stack_ptr, reg_list, num_regs);
 }
 
-static int embKernel_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[])
+static int embkernel_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[])
 {
        unsigned int i;
-       *symbol_list = calloc(ARRAY_SIZE(embKernel_symbol_list), sizeof(struct symbol_table_elem));
+       *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;
 }