1 /***************************************************************************
2 * Copyright (C) 2018 by Liviu Ionescu *
5 * Copyright (C) 2009 by Marvell Technology Group Ltd. *
6 * Written by Nicolas Pitre <nico@marvell.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, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
22 #ifndef OPENOCD_TARGET_SEMIHOSTING_COMMON_H
23 #define OPENOCD_TARGET_SEMIHOSTING_COMMON_H
28 #include "helper/replacements.h"
32 * "Semihosting for AArch32 and AArch64, Release 2.0"
33 * https://static.docs.arm.com/100863/0200/semihosting.pdf
36 * The available semihosting operation numbers passed in R0 are allocated
38 * - 0x00-0x31 Used by ARM.
39 * - 0x32-0xFF Reserved for future use by ARM.
40 * - 0x100-0x1FF Reserved for user applications. These are not used by ARM.
41 * However, if you are writing your own SVC operations, you are advised
42 * to use a different SVC number rather than using the semihosted
43 * SVC number and these operation type numbers.
44 * - 0x200-0xFFFFFFFF Undefined and currently unused. It is recommended
45 * that you do not use these.
48 enum semihosting_operation_numbers {
50 * ARM semihosting operations, in lexicographic order.
52 SEMIHOSTING_ENTER_SVC = 0x17, /* DEPRECATED */
54 SEMIHOSTING_SYS_CLOSE = 0x02,
55 SEMIHOSTING_SYS_CLOCK = 0x10,
56 SEMIHOSTING_SYS_ELAPSED = 0x30,
57 SEMIHOSTING_SYS_ERRNO = 0x13,
58 SEMIHOSTING_SYS_EXIT = 0x18,
59 SEMIHOSTING_SYS_EXIT_EXTENDED = 0x20,
60 SEMIHOSTING_SYS_FLEN = 0x0C,
61 SEMIHOSTING_SYS_GET_CMDLINE = 0x15,
62 SEMIHOSTING_SYS_HEAPINFO = 0x16,
63 SEMIHOSTING_SYS_ISERROR = 0x08,
64 SEMIHOSTING_SYS_ISTTY = 0x09,
65 SEMIHOSTING_SYS_OPEN = 0x01,
66 SEMIHOSTING_SYS_READ = 0x06,
67 SEMIHOSTING_SYS_READC = 0x07,
68 SEMIHOSTING_SYS_REMOVE = 0x0E,
69 SEMIHOSTING_SYS_RENAME = 0x0F,
70 SEMIHOSTING_SYS_SEEK = 0x0A,
71 SEMIHOSTING_SYS_SYSTEM = 0x12,
72 SEMIHOSTING_SYS_TICKFREQ = 0x31,
73 SEMIHOSTING_SYS_TIME = 0x11,
74 SEMIHOSTING_SYS_TMPNAM = 0x0D,
75 SEMIHOSTING_SYS_WRITE = 0x05,
76 SEMIHOSTING_SYS_WRITEC = 0x03,
77 SEMIHOSTING_SYS_WRITE0 = 0x04,
81 * Codes used by SEMIHOSTING_SYS_EXIT (formerly
82 * SEMIHOSTING_REPORT_EXCEPTION).
83 * On 64-bits, the exit code is passed explicitly.
85 enum semihosting_reported_exceptions {
86 /* On 32 bits, use it for exit(0) */
87 ADP_STOPPED_APPLICATION_EXIT = ((2 << 16) + 38),
88 /* On 32 bits, use it for exit(1) */
89 ADP_STOPPED_RUN_TIME_ERROR = ((2 << 16) + 35),
95 * A pointer to this structure was added to the target structure.
99 /** A flag reporting whether semihosting is active. */
102 /** A flag reporting whether semihosting fileio is active. */
105 /** A flag reporting whether semihosting fileio operation is active. */
108 /** Most are resumable, except the two exit calls. */
112 * When SEMIHOSTING_SYS_EXIT is called outside a debug session,
113 * things are simple, the openocd process calls exit() and passes
114 * the value returned by the target.
115 * When SEMIHOSTING_SYS_EXIT is called during a debug session,
116 * by default execution returns to the debugger, leaving the
117 * debugger in a HALT state, similar to the state entered when
118 * encountering a break.
119 * In some use cases, it is useful to have SEMIHOSTING_SYS_EXIT
120 * return normally, as any semihosting call, and do not break
122 * The standard allows this to happen, but the condition
123 * to trigger it is a bit obscure ("by performing an RDI_Execute
124 * request or equivalent").
126 * To make the SEMIHOSTING_SYS_EXIT call return normally, enable
127 * this variable via the dedicated command (default: disabled).
129 bool has_resumable_exit;
131 /** The Target (hart) word size; 8 for 64-bits targets. */
132 size_t word_size_bytes;
134 /** The current semihosting operation (R0 on ARM). */
137 /** The current semihosting parameter (R1 or ARM). */
141 * The current semihosting result to be returned to the application.
142 * Usually 0 for success, -1 for error,
143 * but sometimes a useful value, even a pointer.
147 /** The value to be returned by semihosting SYS_ERRNO request. */
150 /** The semihosting command line to be passed to the target. */
153 /** The current time when 'execution starts' */
156 int (*setup)(struct target *target, int enable);
157 int (*post_result)(struct target *target);
160 int semihosting_common_init(struct target *target, void *setup,
162 int semihosting_common(struct target *target);
164 #endif /* OPENOCD_TARGET_SEMIHOSTING_COMMON_H */