rtos: add support for ChibiOS/RT 3.0
[openocd.git] / src / rtos / ChibiOS.c
index be5fe8472d29f0ce339ec9b96efcfa4b4ecc1cf1..da5dc9fc22b0d5d5acbaa0e89740c29608a73140 100644 (file)
@@ -18,7 +18,7 @@
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include <jtag/jtag.h>
 #include "target/target.h"
 #include "target/target_type.h"
+#include "target/armv7m.h"
+#include "target/cortex_m.h"
 #include "rtos.h"
 #include "helper/log.h"
 #include "helper/types.h"
 #include "rtos_chibios_stackings.h"
 
-
 /**
  * @brief   ChibiOS/RT memory signature record.
  *
@@ -70,7 +71,7 @@ struct ChibiOS_chdebug {
 /**
  * @brief ChibiOS thread states.
  */
-const char *ChibiOS_thread_states[] = {
+static const char * const ChibiOS_thread_states[] = {
        "READY", "CURRENT", "SUSPENDED", "WTSEM", "WTMTX", "WTCOND", "SLEEPING",
        "WTEXIT", "WTOREVT", "WTANDEVT", "SNDMSGQ", "SNDMSG", "WTMSG", "WTQUEUE",
        "FINAL"
@@ -90,16 +91,16 @@ struct ChibiOS_params {
        const struct rtos_register_stacking *stacking_info;
 };
 
-struct ChibiOS_params ChibiOS_params_list[] = {
+static const struct ChibiOS_params ChibiOS_params_list[] = {
        {
-       "cortex_m3",                                                    /* target_name */
+       "cortex_m",                                                     /* target_name */
        0,
-       &rtos_chibios_arm_v7m_stacking,         /* stacking_info */
+       NULL,                                                                   /* stacking_info */
        },
        {
-       "stm32_stlink",                                                 /* target_name */
+       "hla_target",                                                   /* target_name */
        0,
-       &rtos_chibios_arm_v7m_stacking,         /* stacking_info */
+       NULL,                                                                   /* stacking_info */
        }
 };
 #define CHIBIOS_NUM_PARAMS ((int)(sizeof(ChibiOS_params_list)/sizeof(struct ChibiOS_params)))
@@ -120,19 +121,30 @@ struct rtos_type ChibiOS_rtos = {
        .get_symbol_list_to_lookup = ChibiOS_get_symbol_list_to_lookup,
 };
 
+
+/* In ChibiOS/RT 3.0 the rlist structure has become part of a system
+ * data structure ch. We declare both symbols as optional and later
+ * use whatever is available.
+ */
+
 enum ChibiOS_symbol_values {
        ChibiOS_VAL_rlist = 0,
-       ChibiOS_VAL_ch_debug = 1,
-       ChibiOS_VAL_chSysInit = 2
+       ChibiOS_VAL_ch = 1,
+       ChibiOS_VAL_ch_debug = 2,
+       ChibiOS_VAL_chSysInit = 3
 };
 
-static char *ChibiOS_symbol_list[] = {
-       "rlist",                /* Thread ready list*/
-       "ch_debug",             /* Memory Signatur containing offsets of fields in rlist*/
-       "chSysInit",    /* Necessary part of API, used for ChibiOS detection*/
-       NULL
+static symbol_table_elem_t ChibiOS_symbol_list[] = {
+       { "rlist", 0, true},            /* Thread ready list */
+       { "ch", 0, true},                       /* System data structure */
+       { "ch_debug", 0, false},        /* Memory Signature containing offsets of fields in rlist */
+       { "chSysInit", 0, false},       /* Necessary part of API, used for ChibiOS detection */
+       { NULL, 0, false}
 };
 
+/* Offset of the rlist structure within the system data structure (ch) */
+#define CH_RLIST_OFFSET 0x00
+
 static int ChibiOS_update_memory_signature(struct rtos *rtos)
 {
        int retval;
@@ -189,6 +201,15 @@ static int ChibiOS_update_memory_signature(struct rtos *rtos)
                        "running version %i.%i.%i", GET_CH_KERNEL_MAJOR(ch_version),
                        GET_CH_KERNEL_MINOR(ch_version), GET_CH_KERNEL_PATCH(ch_version));
 
+       /* Currently, we have the inherent assumption that all address pointers
+        * are 32 bit wide. */
+       if (signature->ch_ptrsize != sizeof(uint32_t)) {
+               LOG_ERROR("ChibiOS/RT target memory signature claims an address"
+                                 "width unequal to 32 bits!");
+               free(signature);
+               return -1;
+       }
+
        param->signature = signature;
        return 0;
 
@@ -219,8 +240,43 @@ static int ChibiOS_update_stacking(struct rtos *rtos)
         *    available than the current execution. In which case
         *    ChibiOS_get_thread_reg_list is called.
         */
+       int retval;
+
+       if (!rtos->rtos_specific_params)
+               return -1;
+
+       struct ChibiOS_params *param;
+       param = (struct ChibiOS_params *) rtos->rtos_specific_params;
+
+       /* Check for armv7m with *enabled* FPU, i.e. a Cortex M4  */
+       struct armv7m_common *armv7m_target = target_to_armv7m(rtos->target);
+       if (is_armv7m(armv7m_target)) {
+               if (armv7m_target->fp_feature == FPv4_SP) {
+                       /* Found ARM v7m target which includes a FPU */
+                       uint32_t cpacr;
+
+                       retval = target_read_u32(rtos->target, FPU_CPACR, &cpacr);
+                       if (retval != ERROR_OK) {
+                               LOG_ERROR("Could not read CPACR register to check FPU state");
+                               return -1;
+                       }
+
+                       /* Check if CP10 and CP11 are set to full access.
+                        * In ChibiOS this is done in ResetHandler() in crt0.c */
+                       if (cpacr & 0x00F00000) {
+                               /* Found target with enabled FPU */
+                               /* FIXME: Need to figure out how to specify the FPU registers */
+                               LOG_ERROR("ChibiOS ARM v7m targets with enabled FPU "
+                                                 " are NOT supported");
+                               return -1;
+                       }
+               }
+
+               /* Found ARM v7m target with no or disabled FPU */
+               param->stacking_info = &rtos_chibios_arm_v7m_stacking;
+               return 0;
+       }
 
-       /* TODO: Add actual detection, currently it will not work  with FPU enabled.*/
        return -1;
 }
 
@@ -250,25 +306,15 @@ static int ChibiOS_update_threads(struct rtos *rtos)
        }
 
        /* wipe out previous thread details if any */
-       int j;
-       if (rtos->thread_details) {
-               for (j = 0; j < rtos->thread_count; j++) {
-                       struct thread_detail *current_thread = &rtos->thread_details[j];
-                       if (current_thread->display_str != NULL)
-                               free(current_thread->display_str);
-                       if (current_thread->thread_name_str != NULL)
-                               free(current_thread->thread_name_str);
-                       if (current_thread->extra_info_str != NULL)
-                               free(current_thread->extra_info_str);
-               }
-               free(rtos->thread_details);
-               rtos->thread_details = NULL;
-               rtos->thread_count = 0;
-       }
+       rtos_free_threadlist(rtos);
+
        /* ChibiOS does not save the current thread count. We have to first
         * parse the double linked thread list to check for errors and the number of
         * threads. */
-       const uint32_t rlist = rtos->symbols[ChibiOS_VAL_rlist].address;
+       const uint32_t rlist = rtos->symbols[ChibiOS_VAL_rlist].address ?
+               rtos->symbols[ChibiOS_VAL_rlist].address :
+               rtos->symbols[ChibiOS_VAL_ch].address + CH_RLIST_OFFSET /* ChibiOS3 */;
+       const struct ChibiOS_chdebug *signature = param->signature;
        uint32_t current;
        uint32_t previous;
        uint32_t older;
@@ -276,10 +322,8 @@ static int ChibiOS_update_threads(struct rtos *rtos)
        current = rlist;
        previous = rlist;
        while (1) {
-               retval = target_read_buffer(rtos->target,
-                       current + param->signature->cf_off_newer,
-                       param->signature->ch_ptrsize,
-                       (uint8_t *)&current);
+               retval = target_read_u32(rtos->target,
+                                                                current + signature->cf_off_newer, &current);
                if (retval != ERROR_OK) {
                        LOG_ERROR("Could not read next ChibiOS thread");
                        return retval;
@@ -293,10 +337,8 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                        break;
                }
                /* Fetch previous thread in the list as a integrity check. */
-               retval = target_read_buffer(rtos->target,
-                 current + param->signature->cf_off_older,
-                 param->signature->ch_ptrsize,
-                 (uint8_t *)&older);
+               retval = target_read_u32(rtos->target,
+                                                                current + signature->cf_off_older, &older);
                if ((retval != ERROR_OK) || (older == 0) || (older != previous)) {
                        LOG_ERROR("ChibiOS registry integrity check failed, "
                                                "double linked list violation");
@@ -317,17 +359,17 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                const char tmp_thread_name[] = "Current Execution";
                const char tmp_thread_extra_info[] = "No RTOS thread";
 
-               rtos->thread_details = (struct thread_detail *) malloc(
+               rtos->thread_details = malloc(
                                sizeof(struct thread_detail));
                rtos->thread_details->threadid = 1;
                rtos->thread_details->exists = true;
                rtos->thread_details->display_str = NULL;
 
-               rtos->thread_details->extra_info_str = (char *) malloc(
+               rtos->thread_details->extra_info_str = malloc(
                                sizeof(tmp_thread_extra_info));
                strcpy(rtos->thread_details->extra_info_str, tmp_thread_extra_info);
 
-               rtos->thread_details->thread_name_str = (char *) malloc(
+               rtos->thread_details->thread_name_str = malloc(
                                sizeof(tmp_thread_name));
                strcpy(rtos->thread_details->thread_name_str, tmp_thread_name);
 
@@ -337,7 +379,7 @@ static int ChibiOS_update_threads(struct rtos *rtos)
        }
 
        /* create space for new thread details */
-       rtos->thread_details = (struct thread_detail *) malloc(
+       rtos->thread_details = malloc(
                        sizeof(struct thread_detail) * tasks_found);
        if (!rtos->thread_details) {
                LOG_ERROR("Could not allocate space for thread details");
@@ -351,10 +393,8 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                uint32_t name_ptr = 0;
                char tmp_str[CHIBIOS_THREAD_NAME_STR_SIZE];
 
-               retval = target_read_buffer(rtos->target,
-                                                                       current + param->signature->cf_off_newer,
-                                                                       param->signature->ch_ptrsize,
-                                                                       (uint8_t *)&current);
+               retval = target_read_u32(rtos->target,
+                                                                current + signature->cf_off_newer, &current);
                if (retval != ERROR_OK) {
                        LOG_ERROR("Could not read next ChibiOS thread");
                        return -6;
@@ -368,10 +408,8 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                curr_thrd_details->threadid = current;
 
                /* read the name pointer */
-               retval = target_read_buffer(rtos->target,
-                                                                       current + param->signature->cf_off_name,
-                                                                       param->signature->ch_ptrsize,
-                                                                       (uint8_t *)&name_ptr);
+               retval = target_read_u32(rtos->target,
+                                                                current + signature->cf_off_name, &name_ptr);
                if (retval != ERROR_OK) {
                        LOG_ERROR("Could not read ChibiOS thread name pointer from target");
                        return retval;
@@ -390,7 +428,7 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                if (tmp_str[0] == '\x00')
                        strcpy(tmp_str, "No Name");
 
-               curr_thrd_details->thread_name_str = (char *)malloc(
+               curr_thrd_details->thread_name_str = malloc(
                                strlen(tmp_str) + 1);
                strcpy(curr_thrd_details->thread_name_str, tmp_str);
 
@@ -398,9 +436,8 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                uint8_t threadState;
                const char *state_desc;
 
-               retval = target_read_buffer(rtos->target,
-                                                                       current + param->signature->cf_off_state,
-                                                                       1, &threadState);
+               retval = target_read_u8(rtos->target,
+                                                               current + signature->cf_off_state, &threadState);
                if (retval != ERROR_OK) {
                        LOG_ERROR("Error reading thread state from ChibiOS target");
                        return retval;
@@ -412,7 +449,7 @@ static int ChibiOS_update_threads(struct rtos *rtos)
                else
                        state_desc = "Unknown state";
 
-               curr_thrd_details->extra_info_str = (char *)malloc(strlen(
+               curr_thrd_details->extra_info_str = malloc(strlen(
                                        state_desc)+1);
                strcpy(curr_thrd_details->extra_info_str, state_desc);
 
@@ -421,15 +458,17 @@ static int ChibiOS_update_threads(struct rtos *rtos)
 
                curr_thrd_details++;
        }
+
+       uint32_t current_thrd;
        /* NOTE: By design, cf_off_name equals readylist_current_offset */
-       retval = target_read_buffer(rtos->target,
-                                                               rlist + param->signature->cf_off_name,
-                                                               param->signature->ch_ptrsize,
-                                                               (uint8_t *)&rtos->current_thread);
+       retval = target_read_u32(rtos->target,
+                                                        rlist + signature->cf_off_name,
+                                                        &current_thrd);
        if (retval != ERROR_OK) {
                LOG_ERROR("Could not read current Thread from ChibiOS target");
                return retval;
        }
+       rtos->current_thread = current_thrd;
 
        return 0;
 }
@@ -438,7 +477,7 @@ static int ChibiOS_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, cha
 {
        int retval;
        const struct ChibiOS_params *param;
-       int64_t stack_ptr = 0;
+       uint32_t stack_ptr = 0;
 
        *hex_reg_list = NULL;
        if ((rtos == NULL) || (thread_id == 0) ||
@@ -458,10 +497,8 @@ static int ChibiOS_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, cha
        }
 
        /* Read the stack pointer */
-       retval = target_read_buffer(rtos->target,
-                       thread_id + param->signature->cf_off_ctx,
-                       param->signature->ch_ptrsize,
-                       (uint8_t *)&stack_ptr);
+       retval = target_read_u32(rtos->target,
+                                                        thread_id + param->signature->cf_off_ctx, &stack_ptr);
        if (retval != ERROR_OK) {
                LOG_ERROR("Error reading stack frame from ChibiOS thread");
                return retval;
@@ -472,20 +509,15 @@ static int ChibiOS_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, cha
 
 static int ChibiOS_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[])
 {
-       unsigned int i;
-       *symbol_list = (symbol_table_elem_t *) malloc(
-                       sizeof(symbol_table_elem_t) * ARRAY_SIZE(ChibiOS_symbol_list));
-
-       for (i = 0; i < ARRAY_SIZE(ChibiOS_symbol_list); i++)
-               (*symbol_list)[i].symbol_name = ChibiOS_symbol_list[i];
-
+       *symbol_list = ChibiOS_symbol_list;
        return 0;
 }
 
 static int ChibiOS_detect_rtos(struct target *target)
 {
        if ((target->rtos->symbols != NULL) &&
-                       (target->rtos->symbols[ChibiOS_VAL_rlist].address != 0) &&
+                       ((target->rtos->symbols[ChibiOS_VAL_rlist].address != 0) ||
+                        (target->rtos->symbols[ChibiOS_VAL_ch].address != 0)) &&
                        (target->rtos->symbols[ChibiOS_VAL_chSysInit].address != 0)) {
 
                if (target->rtos->symbols[ChibiOS_VAL_ch_debug].address == 0) {

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)