1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
/** @file
Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _EFI_EDB_SUPPORT_H_
#define _EFI_EDB_SUPPORT_H_
#include <Uefi.h>
#define EFI_DEBUG_PROMPT_STRING L"EDB > "
#define EFI_DEBUG_PROMPT_COLUMN 5
#define EFI_DEBUG_INPUS_BUFFER_SIZE 64
#define EFI_DEBUGGER_LINE_NUMBER_IN_PAGE 0x10
#define EFI_DEBUG_MAX_PRINT_BUFFER (80 * 4)
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
Xtoi (
CHAR16 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINT64
EFIAPI
LXtoi (
CHAR16 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
Atoi (
CHAR16 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
AsciiXtoi (
CHAR8 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
AsciiAtoi (
CHAR8 *Str
);
/**
Compare the Unicode and Ascii string pointed by String to the string pointed by String2.
@param String - Unicode String to process
@param String2 - Ascii string to process
@return Return a positive integer if String is lexicall greater than String2; Zero if
the two strings are identical; and a negative interger if String is lexically
less than String2.
**/
INTN
EFIAPI
StrCmpUnicodeAndAscii (
IN CHAR16 *String,
IN CHAR8 *String2
);
/**
Compare the Unicode string pointed by String to the string pointed by String2.
@param String - Unicode String to process
@param String2 - Unicode string to process
@return Return a positive integer if String is lexically greater than String2; Zero if
the two strings are identical; and a negative integer if String is lexically
less than String2.
**/
INTN
EFIAPI
StriCmp (
IN CHAR16 *String,
IN CHAR16 *String2
);
/**
Compare the Unicode and Ascii string pointed by String to the string pointed by String2.
@param String - Unicode String to process
@param String2 - Ascii string to process
@return Return a positive integer if String is lexically greater than String2; Zero if
the two strings are identical; and a negative integer if String is lexically
less than String2.
**/
INTN
EFIAPI
StriCmpUnicodeAndAscii (
IN CHAR16 *String,
IN CHAR8 *String2
);
/**
Verify if the string is end with the sub string.
@param Str - The string where to search the sub string
@param SubStr - The substring.
**/
BOOLEAN
EFIAPI
StrEndWith (
IN CHAR16 *Str,
IN CHAR16 *SubStr
);
/**
Duplicate a string.
@param Src The string to be duplicated.
**/
CHAR16 *
EFIAPI
StrDuplicate (
IN CHAR16 *Src
);
/**
Find the next token after one or more specified characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNewTokenLine (
IN CHAR16 *String,
IN CHAR16 *CharSet
);
/**
Find the next token after one or more specified characters.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNextTokenLine (
IN CHAR16 *CharSet
);
/**
Find the next token after one specificed characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNewTokenField (
IN CHAR16 *String,
IN CHAR16 *CharSet
);
/**
Find the next token after one specificed characters.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNextTokenField (
IN CHAR16 *CharSet
);
/**
Patch a character to the end of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForStrTokenAfter (
IN CHAR16 *Buffer,
IN CHAR16 Patch
);
/**
Patch a character at the beginning of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForStrTokenBefore (
IN CHAR16 *Buffer,
IN CHAR16 Patch
);
/**
Find the next token after one or more specified characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNewTokenLine (
IN CHAR8 *String,
IN CHAR8 *CharSet
);
/**
Find the next token after one or more specified characters.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNextTokenLine (
IN CHAR8 *CharSet
);
/**
Find the next token after one specificed characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNewTokenField (
IN CHAR8 *String,
IN CHAR8 *CharSet
);
/**
Find the next token after one specificed characters.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNextTokenField (
IN CHAR8 *CharSet
);
/**
Patch a character to the end of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForAsciiStrTokenAfter (
IN CHAR8 *Buffer,
IN CHAR8 Patch
);
/**
Patch a character at the beginning of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForAsciiStrTokenBefore (
IN CHAR8 *Buffer,
IN CHAR8 Patch
);
/**
Shell Library.
Get user input.
@param Prompt The prompt string.
@param InStr Point to the input string.
@param StrLen The max length of string user can input.
**/
VOID
EFIAPI
Input (
IN CHAR16 *Prompt OPTIONAL,
OUT CHAR16 *InStr,
IN UINTN StrLen
);
/**
SetPageBreak.
**/
BOOLEAN
EFIAPI
SetPageBreak (
VOID
);
/**
Print a Unicode string to the output device.
@param Format A Null-terminated Unicode format string.
@param ... The variable argument list that contains pointers to Null-
terminated Unicode strings to be printed
**/
UINTN
EFIAPI
EDBPrint (
IN CONST CHAR16 *Format,
...
);
/**
Print a Unicode string to the output buffer.
@param Buffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param Format A Null-terminated Unicode format string.
@param ... The variable argument list that contains pointers to Null-
terminated Unicode strings to be printed
**/
UINTN
EFIAPI
EDBSPrint (
OUT CHAR16 *Buffer,
IN INTN BufferSize,
IN CONST CHAR16 *Format,
...
);
/**
Print a Unicode string to the output buffer with specified offset..
@param Buffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param Offset The offset of the buffer.
@param Format A Null-terminated Unicode format string.
@param ... The variable argument list that contains pointers to Null-
terminated Unicode strings to be printed
**/
UINTN
EFIAPI
EDBSPrintWithOffset (
OUT CHAR16 *Buffer,
IN INTN BufferSize,
IN UINTN Offset,
IN CONST CHAR16 *Format,
...
);
/**
Read a file.
If ScanFs is FLASE, it will use DebuggerPrivate->Vol as default Fs.
If ScanFs is TRUE, it will scan all FS and check the file.
If there is only one file match the name, it will be read.
If there is more than one file match the name, it will return Error.
@param DebuggerPrivate - EBC Debugger private data structure
@param FileName - The file to be read.
@param BufferSize - The file buffer size
@param Buffer - The file buffer
@param ScanFs - Need Scan all FS
@retval EFI_SUCCESS - read file successfully
@retval EFI_NOT_FOUND - file not found
@retval EFI_NO_MAPPING - there is duplicated files found
**/
EFI_STATUS
EFIAPI
ReadFileToBuffer (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN CHAR16 *FileName,
OUT UINTN *BufferSize,
OUT VOID **Buffer,
IN BOOLEAN ScanFs
);
/**
Get file name under this dir with index
@param DebuggerPrivate - EBC Debugger private data structure
@param DirName - The dir to be read.
@param FileName - The file name pattern under this dir
@param Index - The file index under this dir
@return File Name which match the pattern and index.
**/
CHAR16 *
EFIAPI
GetFileNameUnderDir (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN CHAR16 *DirName,
IN CHAR16 *FileName,
IN OUT UINTN *Index
);
#endif
|
