| 1 |
/** @file |
| 2 |
SHELL_INTERFACE_PROTOCOL from EDK shell (no spec). |
| 3 |
|
| 4 |
Shell Interface - additional information (over image_info) provided |
| 5 |
to an application started by the shell. |
| 6 |
|
| 7 |
ConIo provides a file-style interface to the console. |
| 8 |
|
| 9 |
The shell interface's and data (including ConIo) are only valid during |
| 10 |
the applications Entry Point. Once the application returns from it's |
| 11 |
entry point the data is freed by the invoking shell. |
| 12 |
|
| 13 |
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> |
| 14 |
This program and the accompanying materials |
| 15 |
are licensed and made available under the terms and conditions of the BSD License |
| 16 |
which accompanies this distribution. The full text of the license may be found at |
| 17 |
http://opensource.org/licenses/bsd-license.php |
| 18 |
|
| 19 |
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, |
| 20 |
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. |
| 21 |
|
| 22 |
**/ |
| 23 |
/* |
| 24 |
* This is based on ShellPkg/Include/Protocol/EfiShellInterface.h from EDK II. |
| 25 |
*/ |
| 26 |
|
| 27 |
#ifndef _SHELLINTERFACE_H_ |
| 28 |
#define _SHELLINTERFACE_H_ |
| 29 |
|
| 30 |
|
| 31 |
#define SHELL_INTERFACE_PROTOCOL_GUID \ |
| 32 |
{ \ |
| 33 |
0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \ |
| 34 |
} |
| 35 |
|
| 36 |
/// |
| 37 |
/// Bit definitions for EFI_SHELL_ARG_INFO |
| 38 |
/// |
| 39 |
typedef enum { |
| 40 |
ARG_NO_ATTRIB = 0x0, |
| 41 |
ARG_IS_QUOTED = 1<<0, |
| 42 |
ARG_PARTIALLY_QUOTED = 1<<1, |
| 43 |
ARG_FIRST_HALF_QUOTED = 1<<2, |
| 44 |
ARG_FIRST_CHAR_IS_ESC = 1<<3 |
| 45 |
} EFI_SHELL_ARG_INFO_TYPES; |
| 46 |
|
| 47 |
/// |
| 48 |
/// Attributes for an argument. |
| 49 |
/// |
| 50 |
typedef struct _EFI_SHELL_ARG_INFO { |
| 51 |
UINT32 Attributes; |
| 52 |
} EFI_SHELL_ARG_INFO; |
| 53 |
|
| 54 |
/// |
| 55 |
/// This protocol provides access to additional information about a shell application. |
| 56 |
/// |
| 57 |
typedef struct { |
| 58 |
/// |
| 59 |
/// Handle back to original image handle & image information. |
| 60 |
/// |
| 61 |
EFI_HANDLE ImageHandle; |
| 62 |
EFI_LOADED_IMAGE *Info; |
| 63 |
|
| 64 |
/// |
| 65 |
/// Parsed arg list converted more C-like format. |
| 66 |
/// |
| 67 |
CHAR16 **Argv; |
| 68 |
UINTN Argc; |
| 69 |
|
| 70 |
/// |
| 71 |
/// Storage for file redirection args after parsing. |
| 72 |
/// |
| 73 |
CHAR16 **RedirArgv; |
| 74 |
UINTN RedirArgc; |
| 75 |
|
| 76 |
/// |
| 77 |
/// A file style handle for console io. |
| 78 |
/// |
| 79 |
EFI_FILE *StdIn; |
| 80 |
EFI_FILE *StdOut; |
| 81 |
EFI_FILE *StdErr; |
| 82 |
|
| 83 |
/// |
| 84 |
/// List of attributes for each argument. |
| 85 |
/// |
| 86 |
EFI_SHELL_ARG_INFO *ArgInfo; |
| 87 |
|
| 88 |
/// |
| 89 |
/// Whether we are echoing. |
| 90 |
/// |
| 91 |
BOOLEAN EchoOn; |
| 92 |
} EFI_SHELL_INTERFACE; |
| 93 |
|
| 94 |
#endif |