rtos: use ARRAY_SIZE() and simplify rtos_type.create()
[fw/openocd] / src / rtos / ThreadX.c
index 88470b62ff198c6a83ace509a08286bbc41edb23..53a74f8076ec9bc63ca7a2d756e303870ab04652 100644 (file)
@@ -13,9 +13,7 @@
  *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "helper/types.h"
 #include "rtos_standard_stackings.h"
 
-static int ThreadX_detect_rtos(struct target *target);
+static const struct rtos_register_stacking *get_stacking_info(const struct rtos *rtos, int64_t stack_ptr);
+static const struct rtos_register_stacking *get_stacking_info_arm926ejs(const struct rtos *rtos, int64_t stack_ptr);
+
+static int is_thread_id_valid(const struct rtos *rtos, int64_t thread_id);
+static int is_thread_id_valid_arm926ejs(const struct rtos *rtos, int64_t thread_id);
+
+static bool ThreadX_detect_rtos(struct target *target);
 static int ThreadX_create(struct target *target);
 static int ThreadX_update_threads(struct rtos *rtos);
-static int ThreadX_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, char **hex_reg_list);
-static int ThreadX_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[]);
+static int ThreadX_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, struct rtos_reg **reg_list, int *num_regs);
+static int ThreadX_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[]);
+
+
 
 struct ThreadX_thread_state {
        int value;
@@ -59,7 +65,67 @@ static const struct ThreadX_thread_state ThreadX_thread_states[] = {
        { 13, "Waiting - Mutex" },
 };
 
-#define THREADX_NUM_STATES (sizeof(ThreadX_thread_states)/sizeof(struct ThreadX_thread_state))
+#define THREADX_NUM_STATES ARRAY_SIZE(ThreadX_thread_states)
+
+#define ARM926EJS_REGISTERS_SIZE_SOLICITED (11 * 4)
+static const struct stack_register_offset rtos_threadx_arm926ejs_stack_offsets_solicited[] = {
+       { 0,  -1,   32 },               /* r0        */
+       { 1,  -1,   32 },               /* r1        */
+       { 2,  -1,   32 },               /* r2        */
+       { 3,  -1,   32 },               /* r3        */
+       { 4,  0x08, 32 },               /* r4        */
+       { 5,  0x0C, 32 },               /* r5        */
+       { 6,  0x10, 32 },               /* r6        */
+       { 7,  0x14, 32 },               /* r7        */
+       { 8,  0x18, 32 },               /* r8        */
+       { 9,  0x1C, 32 },               /* r9        */
+       { 10, 0x20, 32 },               /* r10       */
+       { 11, 0x24, 32 },               /* r11       */
+       { 12, -1,   32 },               /* r12       */
+       { 13, -2,   32 },               /* sp (r13)  */
+       { 14, 0x28, 32 },               /* lr (r14)  */
+       { 15, -1,   32 },               /* pc (r15)  */
+       /*{ 16, -1,   32 },*/           /* lr (r14)  */
+       /*{ 17, 0x28, 32 },*/           /* pc (r15)  */
+       { 16, 0x04, 32 },               /* xPSR      */
+};
+#define ARM926EJS_REGISTERS_SIZE_INTERRUPT (17 * 4)
+static const struct stack_register_offset rtos_threadx_arm926ejs_stack_offsets_interrupt[] = {
+       { 0,  0x08, 32 },               /* r0        */
+       { 1,  0x0C, 32 },               /* r1        */
+       { 2,  0x10, 32 },               /* r2        */
+       { 3,  0x14, 32 },               /* r3        */
+       { 4,  0x18, 32 },               /* r4        */
+       { 5,  0x1C, 32 },               /* r5        */
+       { 6,  0x20, 32 },               /* r6        */
+       { 7,  0x24, 32 },               /* r7        */
+       { 8,  0x28, 32 },               /* r8        */
+       { 9,  0x2C, 32 },               /* r9        */
+       { 10, 0x30, 32 },               /* r10       */
+       { 11, 0x34, 32 },               /* r11       */
+       { 12, 0x38, 32 },               /* r12       */
+       { 13, -2,   32 },               /* sp (r13)  */
+       { 14, 0x3C, 32 },               /* lr (r14)  */
+       { 15, 0x40, 32 },               /* pc (r15)  */
+       { 16, 0x04, 32 },               /* xPSR      */
+};
+
+static const struct rtos_register_stacking rtos_threadx_arm926ejs_stacking[] = {
+{
+       ARM926EJS_REGISTERS_SIZE_SOLICITED,     /* stack_registers_size */
+       -1,                                                                     /* stack_growth_direction */
+       17,                                                                     /* num_output_registers */
+       NULL,                                                           /* stack_alignment */
+       rtos_threadx_arm926ejs_stack_offsets_solicited  /* register_offsets */
+},
+{
+       ARM926EJS_REGISTERS_SIZE_INTERRUPT,     /* stack_registers_size */
+       -1,                                                                     /* stack_growth_direction */
+       17,                                                                     /* num_output_registers */
+       NULL,                                                           /* stack_alignment */
+       rtos_threadx_arm926ejs_stack_offsets_interrupt  /* register_offsets */
+},
+};
 
 struct ThreadX_params {
        const char *target_name;
@@ -69,6 +135,9 @@ struct ThreadX_params {
        unsigned char thread_state_offset;
        unsigned char thread_next_offset;
        const struct rtos_register_stacking *stacking_info;
+       size_t stacking_info_nb;
+       const struct rtos_register_stacking* (*fn_get_stacking_info)(const struct rtos *rtos, int64_t stack_ptr);
+       int (*fn_is_thread_id_valid)(const struct rtos *rtos, int64_t thread_id);
 };
 
 static const struct ThreadX_params ThreadX_params_list[] = {
@@ -80,6 +149,9 @@ static const struct ThreadX_params ThreadX_params_list[] = {
        48,                                                     /* thread_state_offset; */
        136,                                            /* thread_next_offset */
        &rtos_standard_Cortex_M3_stacking,      /* stacking_info */
+       1,                                                      /* stacking_info_nb */
+       NULL,                                           /* fn_get_stacking_info */
+       NULL,                                           /* fn_is_thread_id_valid */
        },
        {
        "cortex_r4",                            /* target_name */
@@ -89,11 +161,24 @@ static const struct ThreadX_params ThreadX_params_list[] = {
        48,                                                     /* thread_state_offset; */
        136,                                            /* thread_next_offset */
        &rtos_standard_Cortex_R4_stacking,      /* stacking_info */
+       1,                                                      /* stacking_info_nb */
+       NULL,                                           /* fn_get_stacking_info */
+       NULL,                                           /* fn_is_thread_id_valid */
+       },
+       {
+       "arm926ejs",                            /* target_name */
+       4,                                                      /* pointer_width; */
+       8,                                                      /* thread_stack_offset; */
+       40,                                                     /* thread_name_offset; */
+       48,                                                     /* thread_state_offset; */
+       136,                                            /* thread_next_offset */
+       rtos_threadx_arm926ejs_stacking,        /* stacking_info */
+       2,                                                                      /* stacking_info_nb */
+       get_stacking_info_arm926ejs,            /* fn_get_stacking_info */
+       is_thread_id_valid_arm926ejs,           /* fn_is_thread_id_valid */
        },
 };
 
-#define THREADX_NUM_PARAMS ((int)(sizeof(ThreadX_params_list)/sizeof(struct ThreadX_params)))
-
 enum ThreadX_symbol_values {
        ThreadX_VAL_tx_thread_current_ptr = 0,
        ThreadX_VAL_tx_thread_created_ptr = 1,
@@ -117,6 +202,60 @@ const struct rtos_type ThreadX_rtos = {
        .get_symbol_list_to_lookup = ThreadX_get_symbol_list_to_lookup,
 };
 
+static const struct rtos_register_stacking *get_stacking_info(const struct rtos *rtos, int64_t stack_ptr)
+{
+       const struct ThreadX_params *param = (const struct ThreadX_params *) rtos->rtos_specific_params;
+
+       if (param->fn_get_stacking_info != NULL)
+               return param->fn_get_stacking_info(rtos, stack_ptr);
+
+       return param->stacking_info + 0;
+}
+
+static int is_thread_id_valid(const struct rtos *rtos, int64_t thread_id)
+{
+       const struct ThreadX_params *param;
+
+       if (rtos->rtos_specific_params == NULL)
+               return 0; /* invalid */
+
+       param = (const struct ThreadX_params *) rtos->rtos_specific_params;
+
+       if (param->fn_is_thread_id_valid != NULL)
+               return param->fn_is_thread_id_valid(rtos, thread_id);
+
+       return (thread_id != 0);
+}
+
+static const struct rtos_register_stacking *get_stacking_info_arm926ejs(const struct rtos *rtos, int64_t stack_ptr)
+{
+       const struct ThreadX_params *param = (const struct ThreadX_params *) rtos->rtos_specific_params;
+       int     retval;
+       uint32_t flag;
+
+       retval = target_read_buffer(rtos->target,
+                       stack_ptr,
+                       sizeof(flag),
+                       (uint8_t *)&flag);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Error reading stack data from ThreadX thread: stack_ptr=0x%" PRIx64, stack_ptr);
+               return NULL;
+       }
+
+       if (flag == 0) {
+               LOG_DEBUG("  solicited stack");
+               return param->stacking_info + 0;
+       } else {
+               LOG_DEBUG("  interrupt stack: %" PRIu32, flag);
+               return param->stacking_info + 1;
+       }
+}
+
+static int is_thread_id_valid_arm926ejs(const struct rtos *rtos, int64_t thread_id)
+{
+       return (thread_id != 0 && thread_id != 1);
+}
+
 static int ThreadX_update_threads(struct rtos *rtos)
 {
        int retval;
@@ -178,7 +317,6 @@ static int ThreadX_update_threads(struct rtos *rtos)
                                sizeof(struct thread_detail) * thread_list_size);
                rtos->thread_details->threadid = 1;
                rtos->thread_details->exists = true;
-               rtos->thread_details->display_str = NULL;
                rtos->thread_details->extra_info_str = NULL;
                rtos->thread_details->thread_name_str = malloc(sizeof(tmp_str));
                strcpy(rtos->thread_details->thread_name_str, tmp_str);
@@ -268,13 +406,11 @@ static int ThreadX_update_threads(struct rtos *rtos)
                        state_desc = "Unknown state";
 
                rtos->thread_details[tasks_found].extra_info_str = malloc(strlen(
-                                       state_desc)+1);
-               strcpy(rtos->thread_details[tasks_found].extra_info_str, state_desc);
+                                       state_desc)+8);
+               sprintf(rtos->thread_details[tasks_found].extra_info_str, "State: %s", state_desc);
 
                rtos->thread_details[tasks_found].exists = true;
 
-               rtos->thread_details[tasks_found].display_str = NULL;
-
                tasks_found++;
                prev_thread_ptr = thread_ptr;
 
@@ -295,17 +431,16 @@ static int ThreadX_update_threads(struct rtos *rtos)
        return 0;
 }
 
-static int ThreadX_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, char **hex_reg_list)
+static int ThreadX_get_thread_reg_list(struct rtos *rtos, int64_t thread_id,
+               struct rtos_reg **reg_list, int *num_regs)
 {
        int retval;
        const struct ThreadX_params *param;
 
-       *hex_reg_list = NULL;
-
        if (rtos == NULL)
                return -1;
 
-       if (thread_id == 0)
+       if (!is_thread_id_valid(rtos, thread_id))
                return -2;
 
        if (rtos->rtos_specific_params == NULL)
@@ -324,14 +459,29 @@ static int ThreadX_get_thread_reg_list(struct rtos *rtos, int64_t thread_id, cha
                return retval;
        }
 
-       return rtos_generic_stack_read(rtos->target, param->stacking_info, stack_ptr, hex_reg_list);
+       LOG_INFO("thread: 0x%" PRIx64 ", stack_ptr=0x%" PRIx64, (uint64_t)thread_id, (uint64_t)stack_ptr);
+
+       if (stack_ptr == 0) {
+               LOG_ERROR("null stack pointer in thread");
+               return -5;
+       }
+
+       const struct rtos_register_stacking *stacking_info =
+                       get_stacking_info(rtos, stack_ptr);
+
+       if (stacking_info == NULL) {
+               LOG_ERROR("Unknown stacking info for thread id=0x%" PRIx64, (uint64_t)thread_id);
+               return -6;
+       }
+
+       return rtos_generic_stack_read(rtos->target, stacking_info, stack_ptr, reg_list, num_regs);
 }
 
-static int ThreadX_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[])
+static int ThreadX_get_symbol_list_to_lookup(struct symbol_table_elem *symbol_list[])
 {
        unsigned int i;
-       *symbol_list = malloc(
-                       sizeof(symbol_table_elem_t) * ARRAY_SIZE(ThreadX_symbol_list));
+       *symbol_list = calloc(
+                       ARRAY_SIZE(ThreadX_symbol_list), sizeof(struct symbol_table_elem));
 
        for (i = 0; i < ARRAY_SIZE(ThreadX_symbol_list); i++)
                (*symbol_list)[i].symbol_name = ThreadX_symbol_list[i];
@@ -339,14 +489,14 @@ static int ThreadX_get_symbol_list_to_lookup(symbol_table_elem_t *symbol_list[])
        return 0;
 }
 
-static int ThreadX_detect_rtos(struct target *target)
+static bool ThreadX_detect_rtos(struct target *target)
 {
        if ((target->rtos->symbols != NULL) &&
                        (target->rtos->symbols[ThreadX_VAL_tx_thread_created_ptr].address != 0)) {
                /* looks like ThreadX */
-               return 1;
+               return true;
        }
-       return 0;
+       return false;
 }
 
 #if 0
@@ -440,8 +590,6 @@ static int ThreadX_get_thread_detail(struct rtos *rtos,
 
        detail->exists = true;
 
-       detail->display_str = NULL;
-
        return 0;
 }
 
@@ -449,18 +597,14 @@ static int ThreadX_get_thread_detail(struct rtos *rtos,
 
 static int ThreadX_create(struct target *target)
 {
-       int i = 0;
-       while ((i < THREADX_NUM_PARAMS) &&
-                       (0 != strcmp(ThreadX_params_list[i].target_name, target->type->name))) {
-               i++;
-       }
-       if (i >= THREADX_NUM_PARAMS) {
-               LOG_ERROR("Could not find target in ThreadX compatibility list");
-               return -1;
-       }
+       for (unsigned int i = 0; i < ARRAY_SIZE(ThreadX_params_list); i++)
+               if (strcmp(ThreadX_params_list[i].target_name, target->type->name) == 0) {
+                       target->rtos->rtos_specific_params = (void *)&ThreadX_params_list[i];
+                       target->rtos->current_thread = 0;
+                       target->rtos->thread_details = NULL;
+                       return 0;
+               }
 
-       target->rtos->rtos_specific_params = (void *) &ThreadX_params_list[i];
-       target->rtos->current_thread = 0;
-       target->rtos->thread_details = NULL;
-       return 0;
+       LOG_ERROR("Could not find target in ThreadX compatibility list");
+       return -1;
 }