1 /***************************************************************************
2 * Copyright (C) 2011 by Broadcom Corporation *
3 * Evan Hunter - ehunter@broadcom.com *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
19 #ifndef OPENOCD_RTOS_RTOS_H
20 #define OPENOCD_RTOS_RTOS_H
22 #include "server/server.h"
25 typedef int64_t threadid_t
;
26 typedef int64_t symbol_address_t
;
31 * Table should be terminated by an element with NULL in symbol_name
33 typedef struct symbol_table_elem_struct
{
34 const char *symbol_name
;
35 symbol_address_t address
;
37 } symbol_table_elem_t
;
39 struct thread_detail
{
42 char *thread_name_str
;
47 const struct rtos_type
*type
;
49 symbol_table_elem_t
*symbols
;
50 struct target
*target
;
51 /* add a context variable instead of global variable */
52 int64_t current_threadid
;
53 threadid_t current_thread
;
54 struct thread_detail
*thread_details
;
56 int (*gdb_thread_packet
)(struct connection
*connection
, char const *packet
, int packet_size
);
57 void *rtos_specific_params
;
62 int (*detect_rtos
)(struct target
*target
);
63 int (*create
)(struct target
*target
);
64 int (*smp_init
)(struct target
*target
);
65 int (*update_threads
)(struct rtos
*rtos
);
66 int (*get_thread_reg_list
)(struct rtos
*rtos
, int64_t thread_id
, char **hex_reg_list
);
67 int (*get_symbol_list_to_lookup
)(symbol_table_elem_t
*symbol_list
[]);
68 int (*clean
)(struct target
*target
);
69 char * (*ps_command
)(struct target
*target
);
72 struct stack_register_offset
{
73 signed short offset
; /* offset in bytes from stack head, or -1 to indicate
74 * register is not stacked, or -2 to indicate this is the
75 * stack pointer register */
76 unsigned short width_bits
;
79 struct rtos_register_stacking
{
80 unsigned char stack_registers_size
;
81 signed char stack_growth_direction
;
82 unsigned char num_output_registers
;
83 /* Some targets require evaluating the stack to determine the
84 * actual stack pointer for a process. If this field is NULL,
85 * just use stacking->stack_registers_size * stack_growth_direction
86 * to calculate adjustment.
88 int64_t (*calculate_process_stack
)(struct target
*target
,
89 const uint8_t *stack_data
,
90 const struct rtos_register_stacking
*stacking
,
92 const struct stack_register_offset
*register_offsets
;
95 #define GDB_THREAD_PACKET_NOT_CONSUMED (-40)
97 int rtos_create(Jim_GetOptInfo
*goi
, struct target
*target
);
98 int rtos_generic_stack_read(struct target
*target
,
99 const struct rtos_register_stacking
*stacking
,
101 char **hex_reg_list
);
102 int rtos_try_next(struct target
*target
);
103 int gdb_thread_packet(struct connection
*connection
, char const *packet
, int packet_size
);
104 int rtos_get_gdb_reg_list(struct connection
*connection
);
105 int rtos_update_threads(struct target
*target
);
106 void rtos_free_threadlist(struct rtos
*rtos
);
107 int rtos_smp_init(struct target
*target
);
108 /* function for handling symbol access */
109 int rtos_qsymbol(struct connection
*connection
, char const *packet
, int packet_size
);
111 #endif /* OPENOCD_RTOS_RTOS_H */