]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | \r | |
3 | Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r | |
4 | Copyright (c) 2013 - 2021, Arm Limited. All rights reserved.<BR>\r | |
5 | \r | |
6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
7 | \r | |
8 | **/\r | |
9 | #include <Base.h>\r | |
10 | \r | |
11 | #include <Library/BaseLib.h>\r | |
12 | #include <Library/SemihostLib.h>\r | |
13 | \r | |
14 | #include "SemihostPrivate.h"\r | |
15 | \r | |
16 | BOOLEAN\r | |
17 | SemihostConnectionSupported (\r | |
18 | VOID\r | |
19 | )\r | |
20 | {\r | |
21 | return SEMIHOST_SUPPORTED;\r | |
22 | }\r | |
23 | \r | |
24 | RETURN_STATUS\r | |
25 | SemihostFileOpen (\r | |
26 | IN CHAR8 *FileName,\r | |
27 | IN UINT32 Mode,\r | |
28 | OUT UINTN *FileHandle\r | |
29 | )\r | |
30 | {\r | |
31 | SEMIHOST_FILE_OPEN_BLOCK OpenBlock;\r | |
32 | INT32 Result;\r | |
33 | \r | |
34 | if (FileHandle == NULL) {\r | |
35 | return RETURN_INVALID_PARAMETER;\r | |
36 | }\r | |
37 | \r | |
38 | // Remove any leading separator (e.g.: '\'). EFI Shell adds one.\r | |
39 | if (*FileName == '\\') {\r | |
40 | FileName++;\r | |
41 | }\r | |
42 | \r | |
43 | OpenBlock.FileName = FileName;\r | |
44 | OpenBlock.Mode = Mode;\r | |
45 | OpenBlock.NameLength = AsciiStrLen (FileName);\r | |
46 | \r | |
47 | Result = SEMIHOST_SYS_OPEN (&OpenBlock);\r | |
48 | \r | |
49 | if (Result == -1) {\r | |
50 | return RETURN_NOT_FOUND;\r | |
51 | } else {\r | |
52 | *FileHandle = Result;\r | |
53 | return RETURN_SUCCESS;\r | |
54 | }\r | |
55 | }\r | |
56 | \r | |
57 | RETURN_STATUS\r | |
58 | SemihostFileSeek (\r | |
59 | IN UINTN FileHandle,\r | |
60 | IN UINTN Offset\r | |
61 | )\r | |
62 | {\r | |
63 | SEMIHOST_FILE_SEEK_BLOCK SeekBlock;\r | |
64 | INT32 Result;\r | |
65 | \r | |
66 | SeekBlock.Handle = FileHandle;\r | |
67 | SeekBlock.Location = Offset;\r | |
68 | \r | |
69 | Result = SEMIHOST_SYS_SEEK (&SeekBlock);\r | |
70 | \r | |
71 | // Semihosting does not behave as documented. It returns the offset on\r | |
72 | // success.\r | |
73 | if (Result < 0) {\r | |
74 | return RETURN_ABORTED;\r | |
75 | } else {\r | |
76 | return RETURN_SUCCESS;\r | |
77 | }\r | |
78 | }\r | |
79 | \r | |
80 | RETURN_STATUS\r | |
81 | SemihostFileRead (\r | |
82 | IN UINTN FileHandle,\r | |
83 | IN OUT UINTN *Length,\r | |
84 | OUT VOID *Buffer\r | |
85 | )\r | |
86 | {\r | |
87 | SEMIHOST_FILE_READ_WRITE_BLOCK ReadBlock;\r | |
88 | UINT32 Result;\r | |
89 | \r | |
90 | if ((Length == NULL) || (Buffer == NULL)) {\r | |
91 | return RETURN_INVALID_PARAMETER;\r | |
92 | }\r | |
93 | \r | |
94 | ReadBlock.Handle = FileHandle;\r | |
95 | ReadBlock.Buffer = Buffer;\r | |
96 | ReadBlock.Length = *Length;\r | |
97 | \r | |
98 | Result = SEMIHOST_SYS_READ (&ReadBlock);\r | |
99 | \r | |
100 | if ((*Length != 0) && (Result == *Length)) {\r | |
101 | return RETURN_ABORTED;\r | |
102 | } else {\r | |
103 | *Length -= Result;\r | |
104 | return RETURN_SUCCESS;\r | |
105 | }\r | |
106 | }\r | |
107 | \r | |
108 | RETURN_STATUS\r | |
109 | SemihostFileWrite (\r | |
110 | IN UINTN FileHandle,\r | |
111 | IN OUT UINTN *Length,\r | |
112 | IN VOID *Buffer\r | |
113 | )\r | |
114 | {\r | |
115 | SEMIHOST_FILE_READ_WRITE_BLOCK WriteBlock;\r | |
116 | \r | |
117 | if ((Length == NULL) || (Buffer == NULL)) {\r | |
118 | return RETURN_INVALID_PARAMETER;\r | |
119 | }\r | |
120 | \r | |
121 | WriteBlock.Handle = FileHandle;\r | |
122 | WriteBlock.Buffer = Buffer;\r | |
123 | WriteBlock.Length = *Length;\r | |
124 | \r | |
125 | *Length = SEMIHOST_SYS_WRITE (&WriteBlock);\r | |
126 | \r | |
127 | if (*Length != 0) {\r | |
128 | return RETURN_ABORTED;\r | |
129 | } else {\r | |
130 | return RETURN_SUCCESS;\r | |
131 | }\r | |
132 | }\r | |
133 | \r | |
134 | RETURN_STATUS\r | |
135 | SemihostFileClose (\r | |
136 | IN UINTN FileHandle\r | |
137 | )\r | |
138 | {\r | |
139 | if (SEMIHOST_SYS_CLOSE (&FileHandle) == -1) {\r | |
140 | return RETURN_INVALID_PARAMETER;\r | |
141 | } else {\r | |
142 | return RETURN_SUCCESS;\r | |
143 | }\r | |
144 | }\r | |
145 | \r | |
146 | RETURN_STATUS\r | |
147 | SemihostFileLength (\r | |
148 | IN UINTN FileHandle,\r | |
149 | OUT UINTN *Length\r | |
150 | )\r | |
151 | {\r | |
152 | INT32 Result;\r | |
153 | \r | |
154 | if (Length == NULL) {\r | |
155 | return RETURN_INVALID_PARAMETER;\r | |
156 | }\r | |
157 | \r | |
158 | Result = SEMIHOST_SYS_FLEN (&FileHandle);\r | |
159 | \r | |
160 | if (Result == -1) {\r | |
161 | return RETURN_ABORTED;\r | |
162 | } else {\r | |
163 | *Length = Result;\r | |
164 | return RETURN_SUCCESS;\r | |
165 | }\r | |
166 | }\r | |
167 | \r | |
168 | /**\r | |
169 | Get a temporary name for a file from the host running the debug agent.\r | |
170 | \r | |
171 | @param[out] Buffer Pointer to the buffer where the temporary name has to\r | |
172 | be stored\r | |
173 | @param[in] Identifier File name identifier (integer in the range 0 to 255)\r | |
174 | @param[in] Length Length of the buffer to store the temporary name\r | |
175 | \r | |
176 | @retval RETURN_SUCCESS Temporary name returned\r | |
177 | @retval RETURN_INVALID_PARAMETER Invalid buffer address\r | |
178 | @retval RETURN_ABORTED Temporary name not returned\r | |
179 | \r | |
180 | **/\r | |
181 | RETURN_STATUS\r | |
182 | SemihostFileTmpName (\r | |
183 | OUT VOID *Buffer,\r | |
184 | IN UINT8 Identifier,\r | |
185 | IN UINTN Length\r | |
186 | )\r | |
187 | {\r | |
188 | SEMIHOST_FILE_TMPNAME_BLOCK TmpNameBlock;\r | |
189 | INT32 Result;\r | |
190 | \r | |
191 | if (Buffer == NULL) {\r | |
192 | return RETURN_INVALID_PARAMETER;\r | |
193 | }\r | |
194 | \r | |
195 | TmpNameBlock.Buffer = Buffer;\r | |
196 | TmpNameBlock.Identifier = Identifier;\r | |
197 | TmpNameBlock.Length = Length;\r | |
198 | \r | |
199 | Result = SEMIHOST_SYS_TMPNAME (&TmpNameBlock);\r | |
200 | \r | |
201 | if (Result != 0) {\r | |
202 | return RETURN_ABORTED;\r | |
203 | } else {\r | |
204 | return RETURN_SUCCESS;\r | |
205 | }\r | |
206 | }\r | |
207 | \r | |
208 | RETURN_STATUS\r | |
209 | SemihostFileRemove (\r | |
210 | IN CHAR8 *FileName\r | |
211 | )\r | |
212 | {\r | |
213 | SEMIHOST_FILE_REMOVE_BLOCK RemoveBlock;\r | |
214 | UINT32 Result;\r | |
215 | \r | |
216 | // Remove any leading separator (e.g.: '\'). EFI Shell adds one.\r | |
217 | if (*FileName == '\\') {\r | |
218 | FileName++;\r | |
219 | }\r | |
220 | \r | |
221 | RemoveBlock.FileName = FileName;\r | |
222 | RemoveBlock.NameLength = AsciiStrLen (FileName);\r | |
223 | \r | |
224 | Result = SEMIHOST_SYS_REMOVE (&RemoveBlock);\r | |
225 | \r | |
226 | if (Result == 0) {\r | |
227 | return RETURN_SUCCESS;\r | |
228 | } else {\r | |
229 | return RETURN_ABORTED;\r | |
230 | }\r | |
231 | }\r | |
232 | \r | |
233 | /**\r | |
234 | Rename a specified file.\r | |
235 | \r | |
236 | @param[in] FileName Name of the file to rename.\r | |
237 | @param[in] NewFileName The new name of the file.\r | |
238 | \r | |
239 | @retval RETURN_SUCCESS File Renamed\r | |
240 | @retval RETURN_INVALID_PARAMETER Either the current or the new name is not specified\r | |
241 | @retval RETURN_ABORTED Rename failed\r | |
242 | \r | |
243 | **/\r | |
244 | RETURN_STATUS\r | |
245 | SemihostFileRename (\r | |
246 | IN CHAR8 *FileName,\r | |
247 | IN CHAR8 *NewFileName\r | |
248 | )\r | |
249 | {\r | |
250 | SEMIHOST_FILE_RENAME_BLOCK RenameBlock;\r | |
251 | INT32 Result;\r | |
252 | \r | |
253 | if ((FileName == NULL) || (NewFileName == NULL)) {\r | |
254 | return RETURN_INVALID_PARAMETER;\r | |
255 | }\r | |
256 | \r | |
257 | RenameBlock.FileName = FileName;\r | |
258 | RenameBlock.FileNameLength = AsciiStrLen (FileName);\r | |
259 | RenameBlock.NewFileName = NewFileName;\r | |
260 | RenameBlock.NewFileNameLength = AsciiStrLen (NewFileName);\r | |
261 | \r | |
262 | Result = SEMIHOST_SYS_RENAME (&RenameBlock);\r | |
263 | \r | |
264 | if (Result != 0) {\r | |
265 | return RETURN_ABORTED;\r | |
266 | } else {\r | |
267 | return RETURN_SUCCESS;\r | |
268 | }\r | |
269 | }\r | |
270 | \r | |
271 | CHAR8\r | |
272 | SemihostReadCharacter (\r | |
273 | VOID\r | |
274 | )\r | |
275 | {\r | |
276 | return SEMIHOST_SYS_READC ();\r | |
277 | }\r | |
278 | \r | |
279 | VOID\r | |
280 | SemihostWriteCharacter (\r | |
281 | IN CHAR8 Character\r | |
282 | )\r | |
283 | {\r | |
284 | SEMIHOST_SYS_WRITEC (&Character);\r | |
285 | }\r | |
286 | \r | |
287 | VOID\r | |
288 | SemihostWriteString (\r | |
289 | IN CHAR8 *String\r | |
290 | )\r | |
291 | {\r | |
292 | SEMIHOST_SYS_WRITE0 (String);\r | |
293 | }\r | |
294 | \r | |
295 | UINT32\r | |
296 | SemihostSystem (\r | |
297 | IN CHAR8 *CommandLine\r | |
298 | )\r | |
299 | {\r | |
300 | SEMIHOST_SYSTEM_BLOCK SystemBlock;\r | |
301 | \r | |
302 | SystemBlock.CommandLine = CommandLine;\r | |
303 | SystemBlock.CommandLength = AsciiStrLen (CommandLine);\r | |
304 | \r | |
305 | return SEMIHOST_SYS_SYSTEM (&SystemBlock);\r | |
306 | }\r |