EfiShell.h@ 58459

Last change on this file since 58459 was 58459, checked in by vboxsync, 9 years ago
EFI/Firmware: 'svn merge ^{/vendor/edk2/UDK2010.SR1}/vendor/edk2/current .', reverting and removing files+dirs listed in ReadMe.vbox, resolving conflicts with help from ../UDK2014.SP1/. This is a raw untested merge.
Property svn:eol-style set to `native`
File size: 44.6 KB

Line
1	/** @file
2	EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.
3
4	(C) Copyright 2014, Hewlett-Packard Development Company, L.P.
5	Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
6	This program and the accompanying materials
7	are licensed and made available under the terms and conditions of the BSD License
8	which accompanies this distribution. The full text of the license may be found at
9	http://opensource.org/licenses/bsd-license.php
10
11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14	**/
15
16	#ifndef __EFI_SHELL_PROTOCOL__
17	#define __EFI_SHELL_PROTOCOL__
18
19	#include <ShellBase.h>
20	#include <Guid/FileInfo.h>
21
22	#define EFI_SHELL_PROTOCOL_GUID \
23	{ \
24	0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \
25	}
26
27	// replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.
28	// they are identical outside of the name.
29	typedef struct {
30	LIST_ENTRY Link; ///< Linked list members.
31	EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.
32	CONST CHAR16 *FullName; ///< Fully qualified filename.
33	CONST CHAR16 *FileName; ///< name of this file.
34	SHELL_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.
35	EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.
36	} EFI_SHELL_FILE_INFO;
37
38	/**
39	Returns whether any script files are currently being processed.
40
41	@retval TRUE There is at least one script file active.
42	@retval FALSE No script files are active now.
43
44	**/
45	typedef
46	BOOLEAN
47	(EFIAPI *EFI_SHELL_BATCH_IS_ACTIVE) (
48	VOID
49	);
50
51	/**
52	Closes the file handle.
53
54	This function closes a specified file handle. All 'dirty' cached file data is
55	flushed to the device, and the file is closed. In all cases, the handle is
56	closed.
57
58	@param[in] FileHandle The file handle to be closed.
59
60	@retval EFI_SUCCESS The file closed sucessfully.
61	**/
62	typedef
63	EFI_STATUS
64	(EFIAPI *EFI_SHELL_CLOSE_FILE)(
65	IN SHELL_FILE_HANDLE FileHandle
66	);
67
68	/**
69	Creates a file or directory by name.
70
71	This function creates an empty new file or directory with the specified attributes and
72	returns the new file's handle. If the file already exists and is read-only, then
73	EFI_INVALID_PARAMETER will be returned.
74
75	If the file already existed, it is truncated and its attributes updated. If the file is
76	created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
77
78	If the file name begins with >v, then the file handle which is returned refers to the
79	shell environment variable with the specified name. If the shell environment variable
80	already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
81
82	@param[in] FileName Pointer to NULL-terminated file path.
83	@param[in] FileAttribs The new file's attrbiutes. The different attributes are
84	described in EFI_FILE_PROTOCOL.Open().
85	@param[out] FileHandle On return, points to the created file handle or directory's handle.
86
87	@retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
88	@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
89	@retval EFI_UNSUPPORTED The file path could not be opened.
90	@retval EFI_NOT_FOUND The specified file could not be found on the device, or could not
91	file the file system on the device.
92	@retval EFI_NO_MEDIA The device has no medium.
93	@retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
94	longer supported.
95	@retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
96	the DirName.
97	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
98	@retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
99	when the media is write-protected.
100	@retval EFI_ACCESS_DENIED The service denied access to the file.
101	@retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
102	@retval EFI_VOLUME_FULL The volume is full.
103	**/
104	typedef
105	EFI_STATUS
106	(EFIAPI *EFI_SHELL_CREATE_FILE)(
107	IN CONST CHAR16 *FileName,
108	IN UINT64 FileAttribs,
109	OUT SHELL_FILE_HANDLE *FileHandle
110	);
111
112	/**
113	Deletes the file specified by the file handle.
114
115	This function closes and deletes a file. In all cases, the file handle is closed. If the file
116	cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is returned, but the
117	handle is still closed.
118
119	@param[in] FileHandle The file handle to delete.
120
121	@retval EFI_SUCCESS The file was closed and deleted and the handle was closed.
122	@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
123	**/
124	typedef
125	EFI_STATUS
126	(EFIAPI *EFI_SHELL_DELETE_FILE)(
127	IN SHELL_FILE_HANDLE FileHandle
128	);
129
130	/**
131	Deletes the file specified by the file name.
132
133	This function deletes a file.
134
135	@param[in] FileName Points to the NULL-terminated file name.
136
137	@retval EFI_SUCCESS The file was deleted.
138	@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
139	**/
140	typedef
141	EFI_STATUS
142	(EFIAPI *EFI_SHELL_DELETE_FILE_BY_NAME)(
143	IN CONST CHAR16 *FileName
144	);
145
146	/**
147	Disables the page break output mode.
148	**/
149	typedef
150	VOID
151	(EFIAPI *EFI_SHELL_DISABLE_PAGE_BREAK) (
152	VOID
153	);
154
155	/**
156	Enables the page break output mode.
157	**/
158	typedef
159	VOID
160	(EFIAPI *EFI_SHELL_ENABLE_PAGE_BREAK) (
161	VOID
162	);
163
164	/**
165	Execute the command line.
166
167	This function creates a nested instance of the shell and executes the specified
168	command (CommandLine) with the specified environment (Environment). Upon return,
169	the status code returned by the specified command is placed in StatusCode.
170
171	If Environment is NULL, then the current environment is used and all changes made
172	by the commands executed will be reflected in the current environment. If the
173	Environment is non-NULL, then the changes made will be discarded.
174
175	The CommandLine is executed from the current working directory on the current
176	device.
177
178	@param[in] ParentImageHandle A handle of the image that is executing the specified
179	command line.
180	@param[in] CommandLine Points to the NULL-terminated UCS-2 encoded string
181	containing the command line. If NULL then the command-
182	line will be empty.
183	@param[in] Environment Points to a NULL-terminated array of environment
184	variables with the format 'x=y', where x is the
185	environment variable name and y is the value. If this
186	is NULL, then the current shell environment is used.
187	@param[out] ErrorCode Points to the status code returned by the command.
188
189	@retval EFI_SUCCESS The command executed successfully. The status code
190	returned by the command is pointed to by StatusCode.
191	@retval EFI_INVALID_PARAMETER The parameters are invalid.
192	@retval EFI_OUT_OF_RESOURCES Out of resources.
193	@retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
194	**/
195	typedef
196	EFI_STATUS
197	(EFIAPI *EFI_SHELL_EXECUTE) (
198	IN EFI_HANDLE *ParentImageHandle,
199	IN CHAR16 *CommandLine OPTIONAL,
200	IN CHAR16 **Environment OPTIONAL,
201	OUT EFI_STATUS *StatusCode OPTIONAL
202	);
203
204	/**
205	Find files that match a specified pattern.
206
207	This function searches for all files and directories that match the specified
208	FilePattern. The FilePattern can contain wild-card characters. The resulting file
209	information is placed in the file list FileList.
210
211	The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
212	field is set to NULL.
213
214	@param[in] FilePattern Points to a NULL-terminated shell file path, including wildcards.
215	@param[out] FileList On return, points to the start of a file list containing the names
216	of all matching files or else points to NULL if no matching files
217	were found.
218
219	@retval EFI_SUCCESS Files found.
220	@retval EFI_NOT_FOUND No files found.
221	@retval EFI_NO_MEDIA The device has no media.
222	@retval EFI_DEVICE_ERROR The device reported an error.
223	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
224	**/
225	typedef
226	EFI_STATUS
227	(EFIAPI *EFI_SHELL_FIND_FILES)(
228	IN CONST CHAR16 *FilePattern,
229	OUT EFI_SHELL_FILE_INFO **FileList
230	);
231
232	/**
233	Find all files in a specified directory.
234
235	@param[in] FileDirHandle Handle of the directory to search.
236	@param[out] FileList On return, points to the list of files in the directory
237	or NULL if there are no files in the directory.
238
239	@retval EFI_SUCCESS File information was returned successfully.
240	@retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
241	@retval EFI_DEVICE_ERROR The device reported an error.
242	@retval EFI_NO_MEDIA The device media is not present.
243	**/
244	typedef
245	EFI_STATUS
246	(EFIAPI *EFI_SHELL_FIND_FILES_IN_DIR)(
247	IN SHELL_FILE_HANDLE FileDirHandle,
248	OUT EFI_SHELL_FILE_INFO **FileList
249	);
250
251	/**
252	Flushes data back to a device.
253
254	This function flushes all modified data associated with a file to a device.
255
256	@param[in] FileHandle The handle of the file to flush.
257
258	@retval EFI_SUCCESS The data was flushed.
259	@retval EFI_NO_MEDIA The device has no medium.
260	@retval EFI_DEVICE_ERROR The device reported an error.
261	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
262	@retval EFI_WRITE_PROTECTED The file or medium is write-protected.
263	@retval EFI_ACCESS_DENIED The file was opened read-only.
264	@retval EFI_VOLUME_FULL The volume is full.
265	**/
266	typedef
267	EFI_STATUS
268	(EFIAPI *EFI_SHELL_FLUSH_FILE)(
269	IN SHELL_FILE_HANDLE FileHandle
270	);
271
272	/**
273	Frees the file list.
274
275	This function cleans up the file list and any related data structures. It has no
276	impact on the files themselves.
277
278	@param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is
279	defined in OpenFileList().
280
281	@retval EFI_SUCCESS Free the file list successfully.
282	**/
283	typedef
284	EFI_STATUS
285	(EFIAPI *EFI_SHELL_FREE_FILE_LIST) (
286	IN EFI_SHELL_FILE_INFO **FileList
287	);
288
289	/**
290	Returns the current directory on the specified device.
291
292	If FileSystemMapping is NULL, it returns the current working directory. If the
293	FileSystemMapping is not NULL, it returns the current directory associated with the
294	FileSystemMapping. In both cases, the returned name includes the file system
295	mapping (i.e. fs0:\current-dir).
296
297	@param[in] FileSystemMapping A pointer to the file system mapping. If NULL,
298	then the current working directory is returned.
299
300	@retval !=NULL The current directory.
301	@retval NULL Current directory does not exist.
302	**/
303	typedef
304	CONST CHAR16 *
305	(EFIAPI *EFI_SHELL_GET_CUR_DIR) (
306	IN CONST CHAR16 *FileSystemMapping OPTIONAL
307	);
308
309	typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;
310	#define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001
311	#define EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002
312
313	/**
314	Gets the name of the device specified by the device handle.
315
316	This function gets the user-readable name of the device specified by the device
317	handle. If no user-readable name could be generated, then *BestDeviceName will be
318	NULL and EFI_NOT_FOUND will be returned.
319
320	If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
321	device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
322	DeviceHandle.
323
324	If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
325	device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
326	If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
327	EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
328	EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
329
330	@param[in] DeviceHandle The handle of the device.
331	@param[in] Flags Determines the possible sources of component names.
332	@param[in] Language A pointer to the language specified for the device
333	name, in the same format as described in the UEFI
334	specification, Appendix M.
335	@param[out] BestDeviceName On return, points to the callee-allocated NULL-
336	terminated name of the device. If no device name
337	could be found, points to NULL. The name must be
338	freed by the caller...
339
340	@retval EFI_SUCCESS Get the name successfully.
341	@retval EFI_NOT_FOUND Fail to get the device name.
342	**/
343	typedef
344	EFI_STATUS
345	(EFIAPI *EFI_SHELL_GET_DEVICE_NAME) (
346	IN EFI_HANDLE DeviceHandle,
347	IN EFI_SHELL_DEVICE_NAME_FLAGS Flags,
348	IN CHAR8 *Language,
349	OUT CHAR16 **BestDeviceName
350	);
351
352	/**
353	Gets the device path from the mapping.
354
355	This function gets the device path associated with a mapping.
356
357	@param[in] Mapping A pointer to the mapping
358
359	@retval !=NULL Pointer to the device path that corresponds to the
360	device mapping. The returned pointer does not need
361	to be freed.
362	@retval NULL There is no device path associated with the
363	specified mapping.
364	**/
365	typedef
366	CONST EFI_DEVICE_PATH_PROTOCOL *
367	(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_MAP) (
368	IN CONST CHAR16 *Mapping
369	);
370
371	/**
372	Converts a file system style name to a device path.
373
374	This function converts a file system style name to a device path, by replacing any
375	mapping references to the associated device path.
376
377	@param[in] Path The pointer to the path.
378
379	@return The pointer of the file path. The file path is callee
380	allocated and should be freed by the caller.
381	**/
382	typedef
383	EFI_DEVICE_PATH_PROTOCOL *
384	(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (
385	IN CONST CHAR16 *Path
386	);
387
388	/**
389	Gets either a single or list of environment variables.
390
391	If name is not NULL then this function returns the current value of the specified
392	environment variable.
393
394	If Name is NULL than a list of all environment variable names is returned. Each a
395	NULL terminated string with a double NULL terminating the list.
396
397	@param[in] Name A pointer to the environment variable name. If
398	Name is NULL, then the function will return all
399	of the defined shell environment variables. In
400	the case where multiple environment variables are
401	being returned, each variable will be terminated by
402	a NULL, and the list will be terminated by a double
403	NULL.
404
405	@return A pointer to the returned string.
406	The returned pointer does not need to be freed by the caller.
407
408	@retval NULL The environment variable doesn't exist or there are
409	no environment variables.
410	**/
411	typedef
412	CONST CHAR16 *
413	(EFIAPI *EFI_SHELL_GET_ENV) (
414	IN CONST CHAR16 *Name OPTIONAL
415	);
416
417	/**
418	Gets the environment variable and Attributes, or list of environment variables. Can be
419	used instead of GetEnv().
420
421	This function returns the current value of the specified environment variable and
422	the Attributes. If no variable name was specified, then all of the known
423	variables will be returned.
424
425	@param[in] Name A pointer to the environment variable name. If Name is NULL,
426	then the function will return all of the defined shell
427	environment variables. In the case where multiple environment
428	variables are being returned, each variable will be terminated
429	by a NULL, and the list will be terminated by a double NULL.
430	@param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
431	the environment variable. In the case where Name is NULL, and
432	multiple environment variables are being returned, Attributes
433	is undefined.
434
435	@retval NULL The environment variable doesn't exist.
436	@return The environment variable's value. The returned pointer does not
437	need to be freed by the caller.
438	**/
439	typedef
440	CONST CHAR16 *
441	(EFIAPI *EFI_SHELL_GET_ENV_EX) (
442	IN CONST CHAR16 *Name,
443	OUT UINT32 *Attributes OPTIONAL
444	);
445
446	/**
447	Gets the file information from an open file handle.
448
449	This function allocates a buffer to store the file's information. It's the caller's
450	responsibility to free the buffer.
451
452	@param[in] FileHandle A File Handle.
453
454	@retval NULL Cannot get the file info.
455	@return A pointer to a buffer with file information.
456	**/
457	typedef
458	EFI_FILE_INFO *
459	(EFIAPI *EFI_SHELL_GET_FILE_INFO)(
460	IN SHELL_FILE_HANDLE FileHandle
461	);
462
463	/**
464	Converts a device path to a file system-style path.
465
466	This function converts a device path to a file system path by replacing part, or all, of
467	the device path with the file-system mapping. If there are more than one application
468	file system mappings, the one that most closely matches Path will be used.
469
470	@param[in] Path The pointer to the device path.
471
472	@return The pointer of the NULL-terminated file path. The path
473	is callee-allocated and should be freed by the caller.
474	**/
475	typedef
476	CHAR16 *
477	(EFIAPI *EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (
478	IN CONST EFI_DEVICE_PATH_PROTOCOL *Path
479	);
480
481	/**
482	Gets a file's current position.
483
484	This function returns the current file position for the file handle. For directories, the
485	current file position has no meaning outside of the file system driver and as such, the
486	operation is not supported.
487
488	@param[in] FileHandle The file handle on which to get the current position.
489	@param[out] Position Byte position from the start of the file.
490
491	@retval EFI_SUCCESS Data was accessed.
492	@retval EFI_UNSUPPORTED The request is not valid on open directories.
493	**/
494	typedef
495	EFI_STATUS
496	(EFIAPI *EFI_SHELL_GET_FILE_POSITION)(
497	IN SHELL_FILE_HANDLE FileHandle,
498	OUT UINT64 *Position
499	);
500
501	/**
502	Gets the size of a file.
503
504	This function returns the size of the file specified by FileHandle.
505
506	@param[in] FileHandle The handle of the file.
507	@param[out] Size The size of this file.
508
509	@retval EFI_SUCCESS Get the file's size.
510	@retval EFI_DEVICE_ERROR Can't access the file.
511	**/
512	typedef
513	EFI_STATUS
514	(EFIAPI *EFI_SHELL_GET_FILE_SIZE)(
515	IN SHELL_FILE_HANDLE FileHandle,
516	OUT UINT64 *Size
517	);
518
519	/**
520	Get the GUID value from a human readable name.
521
522	If GuidName is a known GUID name, then update Guid to have the correct value for
523	that GUID.
524
525	This function is only available when the major and minor versions in the
526	EfiShellProtocol are greater than or equal to 2 and 1, respectively.
527
528	@param[in] GuidName A pointer to the localized name for the GUID being queried.
529	@param[out] Guid A pointer to the GUID structure to be filled in.
530
531	@retval EFI_SUCCESS The operation was successful.
532	@retval EFI_INVALID_PARAMETER Guid was NULL.
533	@retval EFI_INVALID_PARAMETER GuidName was NULL.
534	@retval EFI_NOT_FOUND GuidName is not a known GUID Name.
535	**/
536	typedef
537	EFI_STATUS
538	(EFIAPI *EFI_SHELL_GET_GUID_FROM_NAME)(
539	IN CONST CHAR16 *GuidName,
540	OUT EFI_GUID *Guid
541	);
542
543	/**
544	Get the human readable name for a GUID from the value.
545
546	If Guid is assigned a name, then update *GuidName to point to the name. The callee
547	should not modify the value.
548
549	This function is only available when the major and minor versions in the
550	EfiShellProtocol are greater than or equal to 2 and 1, respectively.
551
552	@param[in] Guid A pointer to the GUID being queried.
553	@param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
554
555	@retval EFI_SUCCESS The operation was successful.
556	@retval EFI_INVALID_PARAMETER Guid was NULL.
557	@retval EFI_INVALID_PARAMETER GuidName was NULL.
558	@retval EFI_NOT_FOUND Guid is not assigned a name.
559	**/
560	typedef
561	EFI_STATUS
562	(EFIAPI *EFI_SHELL_GET_GUID_NAME)(
563	IN CONST EFI_GUID *Guid,
564	OUT CONST CHAR16 **GuidName
565	);
566
567	/**
568	Return help information about a specific command.
569
570	This function returns the help information for the specified command. The help text
571	can be internal to the shell or can be from a UEFI Shell manual page.
572
573	If Sections is specified, then each section name listed will be compared in a casesensitive
574	manner, to the section names described in Appendix B. If the section exists,
575	it will be appended to the returned help text. If the section does not exist, no
576	information will be returned. If Sections is NULL, then all help text information
577	available will be returned.
578
579	@param[in] Command Points to the NULL-terminated UEFI Shell command name.
580	@param[in] Sections Points to the NULL-terminated comma-delimited
581	section names to return. If NULL, then all
582	sections will be returned.
583	@param[out] HelpText On return, points to a callee-allocated buffer
584	containing all specified help text.
585
586	@retval EFI_SUCCESS The help text was returned.
587	@retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
588	returned help text.
589	@retval EFI_INVALID_PARAMETER HelpText is NULL.
590	@retval EFI_NOT_FOUND There is no help text available for Command.
591	**/
592	typedef
593	EFI_STATUS
594	(EFIAPI *EFI_SHELL_GET_HELP_TEXT) (
595	IN CONST CHAR16 *Command,
596	IN CONST CHAR16 *Sections OPTIONAL,
597	OUT CHAR16 **HelpText
598	);
599
600	/**
601	Gets the mapping(s) that most closely matches the device path.
602
603	This function gets the mapping which corresponds to the device path *DevicePath. If
604	there is no exact match, then the mapping which most closely matches *DevicePath
605	is returned, and *DevicePath is updated to point to the remaining portion of the
606	device path. If there is an exact match, the mapping is returned and *DevicePath
607	points to the end-of-device-path node.
608
609	If there are multiple map names they will be semi-colon seperated in the
610	NULL-terminated string.
611
612	@param[in, out] DevicePath On entry, points to a device path pointer. On
613	exit, updates the pointer to point to the
614	portion of the device path after the mapping.
615
616	@retval NULL No mapping was found.
617	@retval !=NULL Pointer to NULL-terminated mapping. The buffer
618	is callee allocated and should be freed by the caller.
619	**/
620	typedef
621	CONST CHAR16 *
622	(EFIAPI *EFI_SHELL_GET_MAP_FROM_DEVICE_PATH) (
623	IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
624	);
625
626	/**
627	Gets the enable status of the page break output mode.
628
629	User can use this function to determine current page break mode.
630
631	@retval TRUE The page break output mode is enabled.
632	@retval FALSE The page break output mode is disabled.
633	**/
634	typedef
635	BOOLEAN
636	(EFIAPI *EFI_SHELL_GET_PAGE_BREAK) (
637	VOID
638	);
639
640	/**
641	Judges whether the active shell is the root shell.
642
643	This function makes the user to know that whether the active Shell is the root shell.
644
645	@retval TRUE The active Shell is the root Shell.
646	@retval FALSE The active Shell is NOT the root Shell.
647	**/
648	typedef
649	BOOLEAN
650	(EFIAPI *EFI_SHELL_IS_ROOT_SHELL) (
651	VOID
652	);
653
654	/**
655	Opens a file or a directory by file name.
656
657	This function opens the specified file in the specified OpenMode and returns a file
658	handle.
659	If the file name begins with '>v', then the file handle which is returned refers to the
660	shell environment variable with the specified name. If the shell environment variable
661	exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
662	EFI_INVALID_PARAMETER is returned.
663
664	If the file name is '>i', then the file handle which is returned refers to the standard
665	input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
666	is returned.
667
668	If the file name is '>o', then the file handle which is returned refers to the standard
669	output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
670	is returned.
671
672	If the file name is '>e', then the file handle which is returned refers to the standard
673	error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
674	is returned.
675
676	If the file name is 'NUL', then the file handle that is returned refers to the standard NUL
677	file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
678	returned.
679
680	If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
681	FileHandle is NULL.
682
683	@param[in] FileName Points to the NULL-terminated UCS-2 encoded file name.
684	@param[out] FileHandle On return, points to the file handle.
685	@param[in] OpenMode File open mode. Either EFI_FILE_MODE_READ or
686	EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
687	Specification.
688	@retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
689	@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
690	@retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
691	@retval EFI_NOT_FOUND The specified file could not be found on the device or the file
692	system could not be found on the device. FileHandle is NULL.
693	@retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
694	@retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
695	longer supported. FileHandle is NULL.
696	@retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
697	the FileName. FileHandle is NULL.
698	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
699	@retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
700	when the media is write-protected. FileHandle is NULL.
701	@retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
702	@retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
703	is NULL.
704	@retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
705	**/
706	typedef
707	EFI_STATUS
708	(EFIAPI *EFI_SHELL_OPEN_FILE_BY_NAME) (
709	IN CONST CHAR16 *FileName,
710	OUT SHELL_FILE_HANDLE *FileHandle,
711	IN UINT64 OpenMode
712	);
713
714	/**
715	Opens the files that match the path specified.
716
717	This function opens all of the files specified by Path. Wildcards are processed
718	according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
719	matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
720
721	@param[in] Path A pointer to the path string.
722	@param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
723	EFI_FILE_MODE_WRITE.
724	@param[in, out] FileList Points to the start of a list of files opened.
725
726	@retval EFI_SUCCESS Create the file list successfully.
727	@return Can't create the file list.
728	**/
729	typedef
730	EFI_STATUS
731	(EFIAPI *EFI_SHELL_OPEN_FILE_LIST) (
732	IN CHAR16 *Path,
733	IN UINT64 OpenMode,
734	IN OUT EFI_SHELL_FILE_INFO **FileList
735	);
736
737	/**
738	Opens the root directory of a device.
739
740	This function opens the root directory of a device and returns a file handle to it.
741
742	@param[in] DevicePath Points to the device path corresponding to the device where the
743	EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
744	@param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the
745	device.
746
747	@retval EFI_SUCCESS Root opened successfully.
748	@retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
749	could not be opened.
750	@retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
751	@retval EFI_DEVICE_ERROR The device had an error.
752	**/
753	typedef
754	EFI_STATUS
755	(EFIAPI *EFI_SHELL_OPEN_ROOT)(
756	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
757	OUT SHELL_FILE_HANDLE *FileHandle
758	);
759
760	/**
761	Opens the root directory of a device on a handle.
762
763	This function opens the root directory of a device and returns a file handle to it.
764
765	@param[in] DeviceHandle The handle of the device that contains the volume.
766	@param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the
767	device.
768
769	@retval EFI_SUCCESS Root opened successfully.
770	@retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
771	could not be opened.
772	@retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
773	@retval EFI_DEVICE_ERROR The device had an error.
774	**/
775	typedef
776	EFI_STATUS
777	(EFIAPI *EFI_SHELL_OPEN_ROOT_BY_HANDLE)(
778	IN EFI_HANDLE DeviceHandle,
779	OUT SHELL_FILE_HANDLE *FileHandle
780	);
781
782	/**
783	Reads data from the file.
784
785	If FileHandle is not a directory, the function reads the requested number of bytes
786	from the file at the file's current position and returns them in Buffer. If the read goes
787	beyond the end of the file, the read length is truncated to the end of the file. The file's
788	current position is increased by the number of bytes returned.
789	If FileHandle is a directory, then an error is returned.
790
791	@param[in] FileHandle The opened file handle for read.
792	@param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.
793	@param[in, out] Buffer The buffer in which data is read.
794
795	@retval EFI_SUCCESS Data was read.
796	@retval EFI_NO_MEDIA The device has no media.
797	@retval EFI_DEVICE_ERROR The device reported an error.
798	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
799	@retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size.
800	**/
801	typedef
802	EFI_STATUS
803	(EFIAPI *EFI_SHELL_READ_FILE) (
804	IN SHELL_FILE_HANDLE FileHandle,
805	IN OUT UINTN *ReadSize,
806	IN OUT VOID *Buffer
807	);
808
809	/**
810	Register a GUID and a localized human readable name for it.
811
812	If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
813	names must be used whenever a shell command outputs GUID information.
814
815	This function is only available when the major and minor versions in the
816	EfiShellProtocol are greater than or equal to 2 and 1, respectively.
817
818	@param[in] Guid A pointer to the GUID being registered.
819	@param[in] GuidName A pointer to the localized name for the GUID being registered.
820
821	@retval EFI_SUCCESS The operation was successful.
822	@retval EFI_INVALID_PARAMETER Guid was NULL.
823	@retval EFI_INVALID_PARAMETER GuidName was NULL.
824	@retval EFI_ACCESS_DENIED Guid already is assigned a name.
825	**/
826	typedef
827	EFI_STATUS
828	(EFIAPI *EFI_SHELL_REGISTER_GUID_NAME)(
829	IN CONST EFI_GUID *Guid,
830	IN CONST CHAR16 *GuidName
831	);
832
833	/**
834	Deletes the duplicate file names files in the given file list.
835
836	@param[in] FileList A pointer to the first entry in the file list.
837
838	@retval EFI_SUCCESS Always success.
839	**/
840	typedef
841	EFI_STATUS
842	(EFIAPI *EFI_SHELL_REMOVE_DUP_IN_FILE_LIST) (
843	IN EFI_SHELL_FILE_INFO **FileList
844	);
845
846	/**
847	Changes a shell command alias.
848
849	This function creates an alias for a shell command.
850
851	@param[in] Command Points to the NULL-terminated shell command or existing alias.
852	@param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
853	Command refers to an alias, that alias will be deleted.
854	@param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
855	FALSE and the alias already exists, then the existing alias is unchanged and
856	EFI_ACCESS_DENIED is returned.
857	@param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
858	Alias being set will be stored in a non-volatile fashion.
859
860	@retval EFI_SUCCESS Alias created or deleted successfully.
861	@retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
862	FALSE.
863	**/
864	typedef
865	EFI_STATUS
866	(EFIAPI *EFI_SHELL_SET_ALIAS)(
867	IN CONST CHAR16 *Command,
868	IN CONST CHAR16 *Alias,
869	IN BOOLEAN Replace,
870	IN BOOLEAN Volatile
871	);
872
873	/**
874	This function returns the command associated with a alias or a list of all
875	alias'.
876
877	@param[in] Alias Points to the NULL-terminated shell alias.
878	If this parameter is NULL, then all
879	aliases will be returned in ReturnedData.
880	@param[out] Volatile Upon return of a single command if TRUE indicates
881	this is stored in a volatile fashion. FALSE otherwise.
882	@return If Alias is not NULL, it will return a pointer to
883	the NULL-terminated command for that alias.
884	If Alias is NULL, ReturnedData points to a ';'
885	delimited list of alias (e.g.
886	ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
887	@retval NULL An error ocurred.
888	@retval NULL Alias was not a valid Alias.
889	**/
890	typedef
891	CONST CHAR16 *
892	(EFIAPI *EFI_SHELL_GET_ALIAS)(
893	IN CONST CHAR16 *Alias,
894	OUT BOOLEAN *Volatile OPTIONAL
895	);
896
897	/**
898	Changes the current directory on the specified device.
899
900	If the FileSystem is NULL, and the directory Dir does not contain a file system's
901	mapped name, this function changes the current working directory. If FileSystem is
902	NULL and the directory Dir contains a mapped name, then the current file system and
903	the current directory on that file system are changed.
904
905	If FileSystem is not NULL, and Dir is NULL, then this changes the current working file
906	system.
907
908	If FileSystem is not NULL and Dir is not NULL, then this function changes the current
909	directory on the specified file system.
910
911	If the current working directory or the current working file system is changed then the
912	%cwd% environment variable will be updated.
913
914	@param[in] FileSystem A pointer to the file system's mapped name. If NULL, then the current working
915	directory is changed.
916	@param[in] Dir Points to the NULL-terminated directory on the device specified by FileSystem.
917
918	@retval NULL Current directory does not exist.
919	@return The current directory.
920	**/
921	typedef
922	EFI_STATUS
923	(EFIAPI *EFI_SHELL_SET_CUR_DIR) (
924	IN CONST CHAR16 *FileSystem OPTIONAL,
925	IN CONST CHAR16 *Dir
926	);
927
928	/**
929	Sets the environment variable.
930
931	This function changes the current value of the specified environment variable. If the
932	environment variable exists and the Value is an empty string, then the environment
933	variable is deleted. If the environment variable exists and the Value is not an empty
934	string, then the value of the environment variable is changed. If the environment
935	variable does not exist and the Value is an empty string, there is no action. If the
936	environment variable does not exist and the Value is a non-empty string, then the
937	environment variable is created and assigned the specified value.
938
939	For a description of volatile and non-volatile environment variables, see UEFI Shell
940	2.0 specification section 3.6.1.
941
942	@param[in] Name Points to the NULL-terminated environment variable name.
943	@param[in] Value Points to the NULL-terminated environment variable value. If the value is an
944	empty string then the environment variable is deleted.
945	@param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
946
947	@retval EFI_SUCCESS The environment variable was successfully updated.
948	**/
949	typedef
950	EFI_STATUS
951	(EFIAPI *EFI_SHELL_SET_ENV) (
952	IN CONST CHAR16 *Name,
953	IN CONST CHAR16 *Value,
954	IN BOOLEAN Volatile
955	);
956
957	/**
958	Sets the file information to an opened file handle.
959
960	This function changes file information. All file information in the EFI_FILE_INFO
961	struct will be updated to the passed in data.
962
963	@param[in] FileHandle A file handle.
964	@param[in] FileInfo Points to new file information.
965
966	@retval EFI_SUCCESS The information was set.
967	@retval EFI_NO_MEDIA The device has no medium.
968	@retval EFI_DEVICE_ERROR The device reported an error.
969	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
970	@retval EFI_WRITE_PROTECTED The file or medium is write-protected.
971	@retval EFI_ACCESS_DENIED The file was opened read-only.
972	@retval EFI_VOLUME_FULL The volume is full.
973	@retval EFI_BAD_BUFFER_SIZE BufferSize is smaller than the size of EFI_FILE_INFO.
974	**/
975	typedef
976	EFI_STATUS
977	(EFIAPI *EFI_SHELL_SET_FILE_INFO)(
978	IN SHELL_FILE_HANDLE FileHandle,
979	IN CONST EFI_FILE_INFO *FileInfo
980	);
981
982	/**
983	Sets a file's current position.
984
985	This function sets the current file position for the handle to the position supplied. With
986	the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only absolute positioning is
987	supported, and seeking past the end of the file is allowed (a subsequent write would
988	grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position
989	to be set to the end of the file.
990
991	@param[in] FileHandle The file handle on which requested position will be set.
992	@param[in] Position Byte position from the start of the file.
993
994	@retval EFI_SUCCESS Data was written.
995	@retval EFI_UNSUPPORTED The seek request for nonzero is not valid on open directories.
996	**/
997	typedef
998	EFI_STATUS
999	(EFIAPI *EFI_SHELL_SET_FILE_POSITION)(
1000	IN SHELL_FILE_HANDLE FileHandle,
1001	IN UINT64 Position
1002	);
1003
1004	/**
1005	This function creates a mapping for a device path.
1006
1007	@param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
1008	then the mapping will be deleted.
1009	@param[in] Mapping Points to the NULL-terminated mapping for the device path.
1010
1011	@retval EFI_SUCCESS Mapping created or deleted successfully.
1012	@retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
1013	boot service function LocateDevicePath().
1014	@retval EFI_ACCESS_DENIED The mapping is a built-in alias.
1015	**/
1016	typedef
1017	EFI_STATUS
1018	(EFIAPI *EFI_SHELL_SET_MAP)(
1019	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
1020	IN CONST CHAR16 *Mapping
1021	);
1022
1023	/**
1024	Writes data to the file.
1025
1026	This function writes the specified number of bytes to the file at the current file position.
1027	The current file position is advanced the actual number of bytes written, which is
1028	returned in BufferSize. Partial writes only occur when there has been a data error
1029	during the write attempt (such as "volume space full"). The file automatically grows to
1030	hold the data, if required.
1031
1032	Direct writes to opened directories are not supported.
1033
1034	@param[in] FileHandle The opened file handle for writing.
1035	@param[in, out] BufferSize On input, size of Buffer.
1036	@param[in] Buffer The buffer in which data to write.
1037
1038	@retval EFI_SUCCESS Data was written.
1039	@retval EFI_UNSUPPORTED Writes to open directory are not supported.
1040	@retval EFI_NO_MEDIA The device has no media.
1041	@retval EFI_DEVICE_ERROR The device reported an error.
1042	@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1043	@retval EFI_WRITE_PROTECTED The device is write-protected.
1044	@retval EFI_ACCESS_DENIED The file was open for read only.
1045	@retval EFI_VOLUME_FULL The volume is full.
1046	**/
1047	typedef
1048	EFI_STATUS
1049	(EFIAPI *EFI_SHELL_WRITE_FILE)(
1050	IN SHELL_FILE_HANDLE FileHandle,
1051	IN OUT UINTN *BufferSize,
1052	IN VOID *Buffer
1053	);
1054
1055	//
1056	// EFI_SHELL_PROTOCOL has been updated since UEFI Shell Spec 2.0
1057	// Usage of this protocol will require version checking before attempting
1058	// to use any new members. There is no need to check the version for
1059	// members that existed in UEFI Shell Spec 2.0.
1060	//
1061	// Update below for any future UEFI Shell spec changes to this protocol.
1062	//
1063	// Check EFI_SHELL_PROTOCOL MajorVersion and MinorVersion:
1064	// if ((2 == gEfiShellProtocol->MajorVersion) &&
1065	// (0 == gEfiShellProtocol->MinorVersion)) {
1066	// //
1067	// // Cannot call:
1068	// // RegisterGuidName - UEFI Shell 2.1
1069	// // GetGuidName - UEFI Shell 2.1
1070	// // GetGuidFromName - UEFI Shell 2.1
1071	// // GetEnvEx - UEFI Shell 2.1
1072	// //
1073	// } else {
1074	// //
1075	// // Can use all members
1076	// //
1077	// }
1078	//
1079	typedef struct _EFI_SHELL_PROTOCOL {
1080	EFI_SHELL_EXECUTE Execute;
1081	EFI_SHELL_GET_ENV GetEnv;
1082	EFI_SHELL_SET_ENV SetEnv;
1083	EFI_SHELL_GET_ALIAS GetAlias;
1084	EFI_SHELL_SET_ALIAS SetAlias;
1085	EFI_SHELL_GET_HELP_TEXT GetHelpText;
1086	EFI_SHELL_GET_DEVICE_PATH_FROM_MAP GetDevicePathFromMap;
1087	EFI_SHELL_GET_MAP_FROM_DEVICE_PATH GetMapFromDevicePath;
1088	EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH GetDevicePathFromFilePath;
1089	EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH GetFilePathFromDevicePath;
1090	EFI_SHELL_SET_MAP SetMap;
1091	EFI_SHELL_GET_CUR_DIR GetCurDir;
1092	EFI_SHELL_SET_CUR_DIR SetCurDir;
1093	EFI_SHELL_OPEN_FILE_LIST OpenFileList;
1094	EFI_SHELL_FREE_FILE_LIST FreeFileList;
1095	EFI_SHELL_REMOVE_DUP_IN_FILE_LIST RemoveDupInFileList;
1096	EFI_SHELL_BATCH_IS_ACTIVE BatchIsActive;
1097	EFI_SHELL_IS_ROOT_SHELL IsRootShell;
1098	EFI_SHELL_ENABLE_PAGE_BREAK EnablePageBreak;
1099	EFI_SHELL_DISABLE_PAGE_BREAK DisablePageBreak;
1100	EFI_SHELL_GET_PAGE_BREAK GetPageBreak;
1101	EFI_SHELL_GET_DEVICE_NAME GetDeviceName;
1102	EFI_SHELL_GET_FILE_INFO GetFileInfo;
1103	EFI_SHELL_SET_FILE_INFO SetFileInfo;
1104	EFI_SHELL_OPEN_FILE_BY_NAME OpenFileByName;
1105	EFI_SHELL_CLOSE_FILE CloseFile;
1106	EFI_SHELL_CREATE_FILE CreateFile;
1107	EFI_SHELL_READ_FILE ReadFile;
1108	EFI_SHELL_WRITE_FILE WriteFile;
1109	EFI_SHELL_DELETE_FILE DeleteFile;
1110	EFI_SHELL_DELETE_FILE_BY_NAME DeleteFileByName;
1111	EFI_SHELL_GET_FILE_POSITION GetFilePosition;
1112	EFI_SHELL_SET_FILE_POSITION SetFilePosition;
1113	EFI_SHELL_FLUSH_FILE FlushFile;
1114	EFI_SHELL_FIND_FILES FindFiles;
1115	EFI_SHELL_FIND_FILES_IN_DIR FindFilesInDir;
1116	EFI_SHELL_GET_FILE_SIZE GetFileSize;
1117	EFI_SHELL_OPEN_ROOT OpenRoot;
1118	EFI_SHELL_OPEN_ROOT_BY_HANDLE OpenRootByHandle;
1119	EFI_EVENT ExecutionBreak;
1120	UINT32 MajorVersion;
1121	UINT32 MinorVersion;
1122	// Added for Shell 2.1
1123	EFI_SHELL_REGISTER_GUID_NAME RegisterGuidName;
1124	EFI_SHELL_GET_GUID_NAME GetGuidName;
1125	EFI_SHELL_GET_GUID_FROM_NAME GetGuidFromName;
1126	EFI_SHELL_GET_ENV_EX GetEnvEx;
1127	} EFI_SHELL_PROTOCOL;
1128
1129	extern EFI_GUID gEfiShellProtocolGuid;
1130
1131	enum ShellVersion {
1132	SHELL_MAJOR_VERSION = 2,
1133	SHELL_MINOR_VERSION = 1
1134	};
1135
1136	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/ShellPkg/Include/Protocol/EfiShell.h@ 58459

Download in other formats: