1 /***************************************************************************
2 * Copyright (C) 2012 by Matthias Blaicher *
3 * Matthias Blaicher - matthias@blaicher.com *
5 * Copyright (C) 2011 by Broadcom Corporation *
6 * Evan Hunter - ehunter@broadcom.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
22 ***************************************************************************/
28 #include <helper/time_support.h>
29 #include <jtag/jtag.h>
30 #include "target/target.h"
31 #include "target/target_type.h"
32 #include "target/armv7m.h"
33 #include "target/cortex_m.h"
35 #include "helper/log.h"
36 #include "helper/types.h"
37 #include "rtos_chibios_stackings.h"
41 * @brief ChibiOS/RT memory signature record.
43 * @details Definition copied from os/kernel/include/chregistry.h of ChibiOS/RT.
45 struct ChibiOS_chdebug
{
46 char ch_identifier
[4]; /**< @brief Always set to "main". */
47 uint8_t ch_zero
; /**< @brief Must be zero. */
48 uint8_t ch_size
; /**< @brief Size of this structure. */
49 uint16_t ch_version
; /**< @brief Encoded ChibiOS/RT version. */
50 uint8_t ch_ptrsize
; /**< @brief Size of a pointer. */
51 uint8_t ch_timesize
; /**< @brief Size of a @p systime_t. */
52 uint8_t ch_threadsize
; /**< @brief Size of a @p Thread struct. */
53 uint8_t cf_off_prio
; /**< @brief Offset of @p p_prio field. */
54 uint8_t cf_off_ctx
; /**< @brief Offset of @p p_ctx field. */
55 uint8_t cf_off_newer
; /**< @brief Offset of @p p_newer field. */
56 uint8_t cf_off_older
; /**< @brief Offset of @p p_older field. */
57 uint8_t cf_off_name
; /**< @brief Offset of @p p_name field. */
58 uint8_t cf_off_stklimit
; /**< @brief Offset of @p p_stklimit
60 uint8_t cf_off_state
; /**< @brief Offset of @p p_state field. */
61 uint8_t cf_off_flags
; /**< @brief Offset of @p p_flags field. */
62 uint8_t cf_off_refs
; /**< @brief Offset of @p p_refs field. */
63 uint8_t cf_off_preempt
; /**< @brief Offset of @p p_preempt
65 uint8_t cf_off_time
; /**< @brief Offset of @p p_time field. */
68 #define GET_CH_KERNEL_MAJOR(codedVersion) ((codedVersion >> 11) & 0x1f)
69 #define GET_CH_KERNEL_MINOR(codedVersion) ((codedVersion >> 6) & 0x1f)
70 #define GET_CH_KERNEL_PATCH(codedVersion) ((codedVersion >> 0) & 0x3f)
73 * @brief ChibiOS thread states.
75 const char *ChibiOS_thread_states
[] = {
76 "READY", "CURRENT", "SUSPENDED", "WTSEM", "WTMTX", "WTCOND", "SLEEPING",
77 "WTEXIT", "WTOREVT", "WTANDEVT", "SNDMSGQ", "SNDMSG", "WTMSG", "WTQUEUE",
81 #define CHIBIOS_NUM_STATES (sizeof(ChibiOS_thread_states)/sizeof(char *))
83 /* Maximum ChibiOS thread name. There is no real limit set by ChibiOS but 64
84 * chars ought to be enough.
86 #define CHIBIOS_THREAD_NAME_STR_SIZE (64)
88 struct ChibiOS_params
{
89 const char *target_name
;
91 struct ChibiOS_chdebug
*signature
;
92 const struct rtos_register_stacking
*stacking_info
;
95 struct ChibiOS_params ChibiOS_params_list
[] = {
97 "cortex_m", /* target_name */
99 NULL
, /* stacking_info */
102 "hla_target", /* target_name */
104 NULL
, /* stacking_info */
107 #define CHIBIOS_NUM_PARAMS ((int)(sizeof(ChibiOS_params_list)/sizeof(struct ChibiOS_params)))
109 static int ChibiOS_detect_rtos(struct target
*target
);
110 static int ChibiOS_create(struct target
*target
);
111 static int ChibiOS_update_threads(struct rtos
*rtos
);
112 static int ChibiOS_get_thread_reg_list(struct rtos
*rtos
, int64_t thread_id
, char **hex_reg_list
);
113 static int ChibiOS_get_symbol_list_to_lookup(symbol_table_elem_t
*symbol_list
[]);
115 struct rtos_type ChibiOS_rtos
= {
118 .detect_rtos
= ChibiOS_detect_rtos
,
119 .create
= ChibiOS_create
,
120 .update_threads
= ChibiOS_update_threads
,
121 .get_thread_reg_list
= ChibiOS_get_thread_reg_list
,
122 .get_symbol_list_to_lookup
= ChibiOS_get_symbol_list_to_lookup
,
125 enum ChibiOS_symbol_values
{
126 ChibiOS_VAL_rlist
= 0,
127 ChibiOS_VAL_ch_debug
= 1,
128 ChibiOS_VAL_chSysInit
= 2
131 static char *ChibiOS_symbol_list
[] = {
132 "rlist", /* Thread ready list*/
133 "ch_debug", /* Memory Signatur containing offsets of fields in rlist*/
134 "chSysInit", /* Necessary part of API, used for ChibiOS detection*/
138 static int ChibiOS_update_memory_signature(struct rtos
*rtos
)
141 struct ChibiOS_params
*param
;
142 struct ChibiOS_chdebug
*signature
;
144 param
= (struct ChibiOS_params
*) rtos
->rtos_specific_params
;
146 /* Free existing memory description.*/
147 if (param
->signature
) {
148 free(param
->signature
);
149 param
->signature
= 0;
152 signature
= malloc(sizeof(*signature
));
154 LOG_ERROR("Could not allocate space for ChibiOS/RT memory signature");
158 retval
= target_read_buffer(rtos
->target
,
159 rtos
->symbols
[ChibiOS_VAL_ch_debug
].address
,
161 (uint8_t *) signature
);
162 if (retval
!= ERROR_OK
) {
163 LOG_ERROR("Could not read ChibiOS/RT memory signature from target");
167 if (strncmp(signature
->ch_identifier
, "main", 4) != 0) {
168 LOG_ERROR("Memory signature identifier does not contain magic bytes.");
172 if (signature
->ch_size
< sizeof(*signature
)) {
173 LOG_ERROR("ChibiOS/RT memory signature claims to be smaller "
178 if (signature
->ch_size
> sizeof(*signature
)) {
179 LOG_WARNING("ChibiOS/RT memory signature claims to be bigger than"
180 " expected. Assuming compatibility...");
183 /* Convert endianness of version field */
184 const uint8_t *versionTarget
= (const uint8_t *)
185 &signature
->ch_version
;
186 signature
->ch_version
= rtos
->target
->endianness
== TARGET_LITTLE_ENDIAN
?
187 le_to_h_u32(versionTarget
) : be_to_h_u32(versionTarget
);
189 const uint16_t ch_version
= signature
->ch_version
;
190 LOG_INFO("Successfully loaded memory map of ChibiOS/RT target "
191 "running version %i.%i.%i", GET_CH_KERNEL_MAJOR(ch_version
),
192 GET_CH_KERNEL_MINOR(ch_version
), GET_CH_KERNEL_PATCH(ch_version
));
194 /* Currently, we have the inherent assumption that all address pointers
195 * are 32 bit wide. */
196 if (signature
->ch_ptrsize
!= sizeof(uint32_t)) {
197 LOG_ERROR("ChibiOS/RT target memory signature claims an address"
198 "width unequal to 32 bits!");
203 param
->signature
= signature
;
207 /* Error reading the ChibiOS memory structure */
209 param
->signature
= 0;
214 static int ChibiOS_update_stacking(struct rtos
*rtos
)
216 /* Sometimes the stacking can not be determined only by looking at the
217 * target name but only a runtime.
219 * For example, this is the case for cortex-m4 targets and ChibiOS which
220 * only stack the FPU registers if it is enabled during ChibiOS build.
222 * Terminating which stacking is used is target depending.
225 * - Once ChibiOS is actually initialized, the stacking is fixed.
226 * - During startup code, the FPU might not be initialized and the
227 * detection might fail.
228 * - Since no threads are running during startup, the problem is solved
229 * by delaying stacking detection until there are more threads
230 * available than the current execution. In which case
231 * ChibiOS_get_thread_reg_list is called.
235 if (!rtos
->rtos_specific_params
)
238 struct ChibiOS_params
*param
;
239 param
= (struct ChibiOS_params
*) rtos
->rtos_specific_params
;
241 /* Check for armv7m with *enabled* FPU, i.e. a Cortex M4 */
242 struct armv7m_common
*armv7m_target
= target_to_armv7m(rtos
->target
);
243 if (is_armv7m(armv7m_target
)) {
244 if (armv7m_target
->fp_feature
== FPv4_SP
) {
245 /* Found ARM v7m target which includes a FPU */
248 retval
= target_read_u32(rtos
->target
, FPU_CPACR
, &cpacr
);
249 if (retval
!= ERROR_OK
) {
250 LOG_ERROR("Could not read CPACR register to check FPU state");
254 /* Check if CP10 and CP11 are set to full access.
255 * In ChibiOS this is done in ResetHandler() in crt0.c */
256 if (cpacr
& 0x00F00000) {
257 /* Found target with enabled FPU */
258 /* FIXME: Need to figure out how to specify the FPU registers */
259 LOG_ERROR("ChibiOS ARM v7m targets with enabled FPU "
260 " are NOT supported");
265 /* Found ARM v7m target with no or disabled FPU */
266 param
->stacking_info
= &rtos_chibios_arm_v7m_stacking
;
273 static int ChibiOS_update_threads(struct rtos
*rtos
)
276 const struct ChibiOS_params
*param
;
280 if (!rtos
->rtos_specific_params
)
283 if (!rtos
->symbols
) {
284 LOG_ERROR("No symbols for ChibiOS");
288 param
= (const struct ChibiOS_params
*) rtos
->rtos_specific_params
;
289 /* Update the memory signature saved in the target memory */
290 if (!param
->signature
) {
291 retval
= ChibiOS_update_memory_signature(rtos
);
292 if (retval
!= ERROR_OK
) {
293 LOG_ERROR("Reading the memory signature of ChibiOS/RT failed");
298 /* wipe out previous thread details if any */
299 rtos_free_threadlist(rtos
);
301 /* ChibiOS does not save the current thread count. We have to first
302 * parse the double linked thread list to check for errors and the number of
304 const uint32_t rlist
= rtos
->symbols
[ChibiOS_VAL_rlist
].address
;
305 const struct ChibiOS_chdebug
*signature
= param
->signature
;
313 retval
= target_read_u32(rtos
->target
,
314 current
+ signature
->cf_off_newer
, ¤t
);
315 if (retval
!= ERROR_OK
) {
316 LOG_ERROR("Could not read next ChibiOS thread");
319 /* Could be NULL if the kernel is not initialized yet or if the
320 * registry is corrupted. */
322 LOG_ERROR("ChibiOS registry integrity check failed, NULL pointer");
327 /* Fetch previous thread in the list as a integrity check. */
328 retval
= target_read_u32(rtos
->target
,
329 current
+ signature
->cf_off_older
, &older
);
330 if ((retval
!= ERROR_OK
) || (older
== 0) || (older
!= previous
)) {
331 LOG_ERROR("ChibiOS registry integrity check failed, "
332 "double linked list violation");
336 /* Check for full iteration of the linked list. */
337 if (current
== rlist
)
343 /* No RTOS, there is always at least the current execution, though */
344 LOG_INFO("Only showing current execution because of a broken "
345 "ChibiOS thread registry.");
347 const char tmp_thread_name
[] = "Current Execution";
348 const char tmp_thread_extra_info
[] = "No RTOS thread";
350 rtos
->thread_details
= malloc(
351 sizeof(struct thread_detail
));
352 rtos
->thread_details
->threadid
= 1;
353 rtos
->thread_details
->exists
= true;
354 rtos
->thread_details
->display_str
= NULL
;
356 rtos
->thread_details
->extra_info_str
= malloc(
357 sizeof(tmp_thread_extra_info
));
358 strcpy(rtos
->thread_details
->extra_info_str
, tmp_thread_extra_info
);
360 rtos
->thread_details
->thread_name_str
= malloc(
361 sizeof(tmp_thread_name
));
362 strcpy(rtos
->thread_details
->thread_name_str
, tmp_thread_name
);
364 rtos
->current_thread
= 1;
365 rtos
->thread_count
= 1;
369 /* create space for new thread details */
370 rtos
->thread_details
= malloc(
371 sizeof(struct thread_detail
) * tasks_found
);
372 if (!rtos
->thread_details
) {
373 LOG_ERROR("Could not allocate space for thread details");
377 rtos
->thread_count
= tasks_found
;
378 /* Loop through linked list. */
379 struct thread_detail
*curr_thrd_details
= rtos
->thread_details
;
380 while (curr_thrd_details
< rtos
->thread_details
+ tasks_found
) {
381 uint32_t name_ptr
= 0;
382 char tmp_str
[CHIBIOS_THREAD_NAME_STR_SIZE
];
384 retval
= target_read_u32(rtos
->target
,
385 current
+ signature
->cf_off_newer
, ¤t
);
386 if (retval
!= ERROR_OK
) {
387 LOG_ERROR("Could not read next ChibiOS thread");
391 /* Check for full iteration of the linked list. */
392 if (current
== rlist
)
395 /* Save the thread pointer */
396 curr_thrd_details
->threadid
= current
;
398 /* read the name pointer */
399 retval
= target_read_u32(rtos
->target
,
400 current
+ signature
->cf_off_name
, &name_ptr
);
401 if (retval
!= ERROR_OK
) {
402 LOG_ERROR("Could not read ChibiOS thread name pointer from target");
406 /* Read the thread name */
407 retval
= target_read_buffer(rtos
->target
, name_ptr
,
408 CHIBIOS_THREAD_NAME_STR_SIZE
,
409 (uint8_t *)&tmp_str
);
410 if (retval
!= ERROR_OK
) {
411 LOG_ERROR("Error reading thread name from ChibiOS target");
414 tmp_str
[CHIBIOS_THREAD_NAME_STR_SIZE
- 1] = '\x00';
416 if (tmp_str
[0] == '\x00')
417 strcpy(tmp_str
, "No Name");
419 curr_thrd_details
->thread_name_str
= malloc(
420 strlen(tmp_str
) + 1);
421 strcpy(curr_thrd_details
->thread_name_str
, tmp_str
);
425 const char *state_desc
;
427 retval
= target_read_u8(rtos
->target
,
428 current
+ signature
->cf_off_state
, &threadState
);
429 if (retval
!= ERROR_OK
) {
430 LOG_ERROR("Error reading thread state from ChibiOS target");
435 if (threadState
< CHIBIOS_NUM_STATES
)
436 state_desc
= ChibiOS_thread_states
[threadState
];
438 state_desc
= "Unknown state";
440 curr_thrd_details
->extra_info_str
= malloc(strlen(
442 strcpy(curr_thrd_details
->extra_info_str
, state_desc
);
444 curr_thrd_details
->exists
= true;
445 curr_thrd_details
->display_str
= NULL
;
450 uint32_t current_thrd
;
451 /* NOTE: By design, cf_off_name equals readylist_current_offset */
452 retval
= target_read_u32(rtos
->target
,
453 rlist
+ signature
->cf_off_name
,
455 if (retval
!= ERROR_OK
) {
456 LOG_ERROR("Could not read current Thread from ChibiOS target");
459 rtos
->current_thread
= current_thrd
;
464 static int ChibiOS_get_thread_reg_list(struct rtos
*rtos
, int64_t thread_id
, char **hex_reg_list
)
467 const struct ChibiOS_params
*param
;
468 uint32_t stack_ptr
= 0;
470 *hex_reg_list
= NULL
;
471 if ((rtos
== NULL
) || (thread_id
== 0) ||
472 (rtos
->rtos_specific_params
== NULL
))
475 param
= (const struct ChibiOS_params
*) rtos
->rtos_specific_params
;
477 if (!param
->signature
)
480 /* Update stacking if it can only be determined from runtime information */
481 if ((param
->stacking_info
== 0) &&
482 (ChibiOS_update_stacking(rtos
) != ERROR_OK
)) {
483 LOG_ERROR("Failed to determine exact stacking for the target type %s", rtos
->target
->type
->name
);
487 /* Read the stack pointer */
488 retval
= target_read_u32(rtos
->target
,
489 thread_id
+ param
->signature
->cf_off_ctx
, &stack_ptr
);
490 if (retval
!= ERROR_OK
) {
491 LOG_ERROR("Error reading stack frame from ChibiOS thread");
495 return rtos_generic_stack_read(rtos
->target
, param
->stacking_info
, stack_ptr
, hex_reg_list
);
498 static int ChibiOS_get_symbol_list_to_lookup(symbol_table_elem_t
*symbol_list
[])
501 *symbol_list
= malloc(
502 sizeof(symbol_table_elem_t
) * ARRAY_SIZE(ChibiOS_symbol_list
));
504 for (i
= 0; i
< ARRAY_SIZE(ChibiOS_symbol_list
); i
++)
505 (*symbol_list
)[i
].symbol_name
= ChibiOS_symbol_list
[i
];
510 static int ChibiOS_detect_rtos(struct target
*target
)
512 if ((target
->rtos
->symbols
!= NULL
) &&
513 (target
->rtos
->symbols
[ChibiOS_VAL_rlist
].address
!= 0) &&
514 (target
->rtos
->symbols
[ChibiOS_VAL_chSysInit
].address
!= 0)) {
516 if (target
->rtos
->symbols
[ChibiOS_VAL_ch_debug
].address
== 0) {
517 LOG_INFO("It looks like the target is running ChibiOS without "
522 /* looks like ChibiOS with memory map enabled.*/
529 static int ChibiOS_create(struct target
*target
)
532 while ((i
< CHIBIOS_NUM_PARAMS
) &&
533 (0 != strcmp(ChibiOS_params_list
[i
].target_name
, target
->type
->name
))) {
536 if (i
>= CHIBIOS_NUM_PARAMS
) {
537 LOG_WARNING("Could not find target \"%s\" in ChibiOS compatibility "
538 "list", target
->type
->name
);
542 target
->rtos
->rtos_specific_params
= &ChibiOS_params_list
[i
];