]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Shell.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / Shell.h
index cfb7878228c5e3b93c55c34b994bf8ac3a39d65f..5efee49e197a9ecaaa6869ae4e64757c7417e087 100644 (file)
@@ -22,110 +22,110 @@ typedef enum {
   ///\r
   /// The operation completed successfully.\r
   ///\r
-  SHELL_SUCCESS               = 0,\r
+  SHELL_SUCCESS = 0,\r
 \r
   ///\r
   /// The image failed to load.\r
   ///\r
-  SHELL_LOAD_ERROR            = 1,\r
+  SHELL_LOAD_ERROR = 1,\r
 \r
   ///\r
   /// The parameter was incorrect.\r
   ///\r
-  SHELL_INVALID_PARAMETER     = 2,\r
+  SHELL_INVALID_PARAMETER = 2,\r
 \r
   ///\r
   /// The operation is not supported.\r
   ///\r
-  SHELL_UNSUPPORTED           = 3,\r
+  SHELL_UNSUPPORTED = 3,\r
 \r
   ///\r
   /// The buffer was not the proper size for the request.\r
   ///\r
-  SHELL_BAD_BUFFER_SIZE       = 4,\r
+  SHELL_BAD_BUFFER_SIZE = 4,\r
 \r
   ///\r
   /// The buffer was not large enough to hold the requested data.\r
   /// The required buffer size is returned in the appropriate\r
   /// parameter when this error occurs.\r
   ///\r
-  SHELL_BUFFER_TOO_SMALL      = 5,\r
+  SHELL_BUFFER_TOO_SMALL = 5,\r
 \r
   ///\r
   /// There is no data pending upon return.\r
   ///\r
-  SHELL_NOT_READY             = 6,\r
+  SHELL_NOT_READY = 6,\r
 \r
   ///\r
   /// The physical device reported an error while attempting the\r
   /// operation.\r
   ///\r
-  SHELL_DEVICE_ERROR          = 7,\r
+  SHELL_DEVICE_ERROR = 7,\r
 \r
   ///\r
   /// The device cannot be written to.\r
   ///\r
-  SHELL_WRITE_PROTECTED       = 8,\r
+  SHELL_WRITE_PROTECTED = 8,\r
 \r
   ///\r
   /// The resource has run out.\r
   ///\r
-  SHELL_OUT_OF_RESOURCES      = 9,\r
+  SHELL_OUT_OF_RESOURCES = 9,\r
 \r
   ///\r
   /// An inconsistency was detected on the file system causing the\r
   /// operation to fail.\r
   ///\r
-  SHELL_VOLUME_CORRUPTED      = 10,\r
+  SHELL_VOLUME_CORRUPTED = 10,\r
 \r
   ///\r
   /// There is no more space on the file system.\r
   ///\r
-  SHELL_VOLUME_FULL           = 11,\r
+  SHELL_VOLUME_FULL = 11,\r
 \r
   ///\r
   /// The device does not contain any medium to perform the\r
   /// operation.\r
   ///\r
-  SHELL_NO_MEDIA              = 12,\r
+  SHELL_NO_MEDIA = 12,\r
 \r
   ///\r
   /// The medium in the device has changed since the last\r
   /// access.\r
   ///\r
-  SHELL_MEDIA_CHANGED         = 13,\r
+  SHELL_MEDIA_CHANGED = 13,\r
 \r
   ///\r
   /// The item was not found.\r
   ///\r
-  SHELL_NOT_FOUND             = 14,\r
+  SHELL_NOT_FOUND = 14,\r
 \r
   ///\r
   /// Access was denied.\r
   ///\r
-  SHELL_ACCESS_DENIED         = 15,\r
+  SHELL_ACCESS_DENIED = 15,\r
 \r
   // note the skipping of 16 and 17\r
 \r
   ///\r
   /// A timeout time expired.\r
   ///\r
-  SHELL_TIMEOUT               = 18,\r
+  SHELL_TIMEOUT = 18,\r
 \r
   ///\r
   /// The protocol has not been started.\r
   ///\r
-  SHELL_NOT_STARTED           = 19,\r
+  SHELL_NOT_STARTED = 19,\r
 \r
   ///\r
   /// The protocol has already been started.\r
   ///\r
-  SHELL_ALREADY_STARTED       = 20,\r
+  SHELL_ALREADY_STARTED = 20,\r
 \r
   ///\r
   /// The operation was aborted.\r
   ///\r
-  SHELL_ABORTED               = 21,\r
+  SHELL_ABORTED = 21,\r
 \r
   // note the skipping of 22, 23, and 24\r
 \r
@@ -133,30 +133,29 @@ typedef enum {
   /// A function encountered an internal version that was\r
   /// incompatible with a version requested by the caller.\r
   ///\r
-  SHELL_INCOMPATIBLE_VERSION  = 25,\r
+  SHELL_INCOMPATIBLE_VERSION = 25,\r
 \r
   ///\r
   /// The function was not performed due to a security violation.\r
   ///\r
-  SHELL_SECURITY_VIOLATION    = 26,\r
+  SHELL_SECURITY_VIOLATION = 26,\r
 \r
   ///\r
   /// The function was performed and resulted in an unequal\r
   /// comparison..\r
   ///\r
-  SHELL_NOT_EQUAL             = 27\r
+  SHELL_NOT_EQUAL = 27\r
 } SHELL_STATUS;\r
 \r
-\r
 // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.\r
 // they are identical outside of the name.\r
 typedef struct {\r
-  LIST_ENTRY        Link;       ///< Linked list members.\r
-  EFI_STATUS        Status;     ///< Status of opening the file.  Valid only if Handle != NULL.\r
-  CONST CHAR16      *FullName;  ///< Fully qualified filename.\r
-  CONST CHAR16      *FileName;  ///< name of this file.\r
-  SHELL_FILE_HANDLE Handle;     ///< Handle for interacting with the opened file or NULL if closed.\r
-  EFI_FILE_INFO     *Info;      ///< Pointer to the FileInfo struct for this file or NULL.\r
+  LIST_ENTRY           Link;      ///< Linked list members.\r
+  EFI_STATUS           Status;    ///< Status of opening the file.  Valid only if Handle != NULL.\r
+  CONST CHAR16         *FullName; ///< Fully qualified filename.\r
+  CONST CHAR16         *FileName; ///< name of this file.\r
+  SHELL_FILE_HANDLE    Handle;    ///< Handle for interacting with the opened file or NULL if closed.\r
+  EFI_FILE_INFO        *Info;     ///< Pointer to the FileInfo struct for this file or NULL.\r
 } EFI_SHELL_FILE_INFO;\r
 \r
 /**\r
@@ -168,7 +167,7 @@ typedef struct {
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_SHELL_BATCH_IS_ACTIVE) (\r
+(EFIAPI *EFI_SHELL_BATCH_IS_ACTIVE)(\r
   VOID\r
   );\r
 \r
@@ -272,7 +271,7 @@ EFI_STATUS
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_SHELL_DISABLE_PAGE_BREAK) (\r
+(EFIAPI *EFI_SHELL_DISABLE_PAGE_BREAK)(\r
   VOID\r
   );\r
 \r
@@ -281,7 +280,7 @@ VOID
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_SHELL_ENABLE_PAGE_BREAK) (\r
+(EFIAPI *EFI_SHELL_ENABLE_PAGE_BREAK)(\r
   VOID\r
   );\r
 \r
@@ -318,7 +317,7 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_EXECUTE) (\r
+(EFIAPI *EFI_SHELL_EXECUTE)(\r
   IN EFI_HANDLE                 *ParentImageHandle,\r
   IN CHAR16                     *CommandLine OPTIONAL,\r
   IN CHAR16                     **Environment OPTIONAL,\r
@@ -368,9 +367,9 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SHELL_FIND_FILES_IN_DIR)(\r
-IN SHELL_FILE_HANDLE            FileDirHandle,\r
-OUT EFI_SHELL_FILE_INFO         **FileList\r
-);\r
+  IN SHELL_FILE_HANDLE            FileDirHandle,\r
+  OUT EFI_SHELL_FILE_INFO         **FileList\r
+  );\r
 \r
 /**\r
   Flushes data back to a device.\r
@@ -406,7 +405,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_FREE_FILE_LIST) (\r
+(EFIAPI *EFI_SHELL_FREE_FILE_LIST)(\r
   IN EFI_SHELL_FILE_INFO **FileList\r
   );\r
 \r
@@ -428,7 +427,7 @@ EFI_STATUS
 **/\r
 typedef\r
 CONST CHAR16 *\r
-(EFIAPI *EFI_SHELL_GET_CUR_DIR) (\r
+(EFIAPI *EFI_SHELL_GET_CUR_DIR)(\r
   IN CONST CHAR16 *FileSystemMapping OPTIONAL\r
   );\r
 \r
@@ -468,7 +467,7 @@ typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_GET_DEVICE_NAME) (\r
+(EFIAPI *EFI_SHELL_GET_DEVICE_NAME)(\r
   IN EFI_HANDLE                   DeviceHandle,\r
   IN EFI_SHELL_DEVICE_NAME_FLAGS  Flags,\r
   IN CHAR8                        *Language,\r
@@ -490,7 +489,7 @@ EFI_STATUS
 **/\r
 typedef\r
 CONST EFI_DEVICE_PATH_PROTOCOL *\r
-(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_MAP) (\r
+(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_MAP)(\r
   IN CONST CHAR16 *Mapping\r
   );\r
 \r
@@ -507,7 +506,7 @@ CONST EFI_DEVICE_PATH_PROTOCOL *
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL *\r
-(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (\r
+(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH)(\r
   IN CONST CHAR16 *Path\r
   );\r
 \r
@@ -536,7 +535,7 @@ EFI_DEVICE_PATH_PROTOCOL *
 **/\r
 typedef\r
 CONST CHAR16 *\r
-(EFIAPI *EFI_SHELL_GET_ENV) (\r
+(EFIAPI *EFI_SHELL_GET_ENV)(\r
   IN CONST CHAR16 *Name OPTIONAL\r
   );\r
 \r
@@ -564,7 +563,7 @@ CONST CHAR16 *
 **/\r
 typedef\r
 CONST CHAR16 *\r
-(EFIAPI *EFI_SHELL_GET_ENV_EX) (\r
+(EFIAPI *EFI_SHELL_GET_ENV_EX)(\r
   IN  CONST CHAR16 *Name,\r
   OUT       UINT32 *Attributes OPTIONAL\r
   );\r
@@ -600,7 +599,7 @@ EFI_FILE_INFO *
 **/\r
 typedef\r
 CHAR16 *\r
-(EFIAPI *EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (\r
+(EFIAPI *EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *Path\r
   );\r
 \r
@@ -717,7 +716,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_GET_HELP_TEXT) (\r
+(EFIAPI *EFI_SHELL_GET_HELP_TEXT)(\r
   IN CONST CHAR16 *Command,\r
   IN CONST CHAR16 *Sections OPTIONAL,\r
   OUT CHAR16 **HelpText\r
@@ -745,7 +744,7 @@ EFI_STATUS
 **/\r
 typedef\r
 CONST CHAR16 *\r
-(EFIAPI *EFI_SHELL_GET_MAP_FROM_DEVICE_PATH) (\r
+(EFIAPI *EFI_SHELL_GET_MAP_FROM_DEVICE_PATH)(\r
   IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r
   );\r
 \r
@@ -759,7 +758,7 @@ CONST CHAR16 *
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_SHELL_GET_PAGE_BREAK) (\r
+(EFIAPI *EFI_SHELL_GET_PAGE_BREAK)(\r
   VOID\r
   );\r
 \r
@@ -773,9 +772,9 @@ BOOLEAN
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_SHELL_IS_ROOT_SHELL) (\r
-VOID\r
-);\r
+(EFIAPI *EFI_SHELL_IS_ROOT_SHELL)(\r
+  VOID\r
+  );\r
 \r
 /**\r
   Opens a file or a directory by file name.\r
@@ -831,7 +830,7 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_OPEN_FILE_BY_NAME) (\r
+(EFIAPI *EFI_SHELL_OPEN_FILE_BY_NAME)(\r
   IN CONST CHAR16 *FileName,\r
   OUT SHELL_FILE_HANDLE *FileHandle,\r
   IN UINT64 OpenMode\r
@@ -854,7 +853,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_OPEN_FILE_LIST) (\r
+(EFIAPI *EFI_SHELL_OPEN_FILE_LIST)(\r
   IN CHAR16 *Path,\r
   IN UINT64 OpenMode,\r
   IN OUT EFI_SHELL_FILE_INFO **FileList\r
@@ -926,7 +925,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_READ_FILE) (\r
+(EFIAPI *EFI_SHELL_READ_FILE)(\r
   IN SHELL_FILE_HANDLE FileHandle,\r
   IN OUT UINTN *ReadSize,\r
   IN OUT VOID *Buffer\r
@@ -965,7 +964,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_REMOVE_DUP_IN_FILE_LIST) (\r
+(EFIAPI *EFI_SHELL_REMOVE_DUP_IN_FILE_LIST)(\r
   IN EFI_SHELL_FILE_INFO **FileList\r
   );\r
 \r
@@ -1046,7 +1045,7 @@ CONST CHAR16 *
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_SET_CUR_DIR) (\r
+(EFIAPI *EFI_SHELL_SET_CUR_DIR)(\r
   IN CONST CHAR16 *FileSystem OPTIONAL,\r
   IN CONST CHAR16 *Dir\r
   );\r
@@ -1074,7 +1073,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SHELL_SET_ENV) (\r
+(EFIAPI *EFI_SHELL_SET_ENV)(\r
   IN CONST CHAR16 *Name,\r
   IN CONST CHAR16 *Value,\r
   IN BOOLEAN Volatile\r
@@ -1203,56 +1202,56 @@ EFI_STATUS
 // }\r
 //\r
 typedef struct _EFI_SHELL_PROTOCOL {\r
-  EFI_SHELL_EXECUTE                         Execute;\r
-  EFI_SHELL_GET_ENV                         GetEnv;\r
-  EFI_SHELL_SET_ENV                         SetEnv;\r
-  EFI_SHELL_GET_ALIAS                       GetAlias;\r
-  EFI_SHELL_SET_ALIAS                       SetAlias;\r
-  EFI_SHELL_GET_HELP_TEXT                   GetHelpText;\r
-  EFI_SHELL_GET_DEVICE_PATH_FROM_MAP        GetDevicePathFromMap;\r
-  EFI_SHELL_GET_MAP_FROM_DEVICE_PATH        GetMapFromDevicePath;\r
-  EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH  GetDevicePathFromFilePath;\r
-  EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH  GetFilePathFromDevicePath;\r
-  EFI_SHELL_SET_MAP                         SetMap;\r
-  EFI_SHELL_GET_CUR_DIR                     GetCurDir;\r
-  EFI_SHELL_SET_CUR_DIR                     SetCurDir;\r
-  EFI_SHELL_OPEN_FILE_LIST                  OpenFileList;\r
-  EFI_SHELL_FREE_FILE_LIST                  FreeFileList;\r
-  EFI_SHELL_REMOVE_DUP_IN_FILE_LIST         RemoveDupInFileList;\r
-  EFI_SHELL_BATCH_IS_ACTIVE                 BatchIsActive;\r
-  EFI_SHELL_IS_ROOT_SHELL                   IsRootShell;\r
-  EFI_SHELL_ENABLE_PAGE_BREAK               EnablePageBreak;\r
-  EFI_SHELL_DISABLE_PAGE_BREAK              DisablePageBreak;\r
-  EFI_SHELL_GET_PAGE_BREAK                  GetPageBreak;\r
-  EFI_SHELL_GET_DEVICE_NAME                 GetDeviceName;\r
-  EFI_SHELL_GET_FILE_INFO                   GetFileInfo;\r
-  EFI_SHELL_SET_FILE_INFO                   SetFileInfo;\r
-  EFI_SHELL_OPEN_FILE_BY_NAME               OpenFileByName;\r
-  EFI_SHELL_CLOSE_FILE                      CloseFile;\r
-  EFI_SHELL_CREATE_FILE                     CreateFile;\r
-  EFI_SHELL_READ_FILE                       ReadFile;\r
-  EFI_SHELL_WRITE_FILE                      WriteFile;\r
-  EFI_SHELL_DELETE_FILE                     DeleteFile;\r
-  EFI_SHELL_DELETE_FILE_BY_NAME             DeleteFileByName;\r
-  EFI_SHELL_GET_FILE_POSITION               GetFilePosition;\r
-  EFI_SHELL_SET_FILE_POSITION               SetFilePosition;\r
-  EFI_SHELL_FLUSH_FILE                      FlushFile;\r
-  EFI_SHELL_FIND_FILES                      FindFiles;\r
-  EFI_SHELL_FIND_FILES_IN_DIR               FindFilesInDir;\r
-  EFI_SHELL_GET_FILE_SIZE                   GetFileSize;\r
-  EFI_SHELL_OPEN_ROOT                       OpenRoot;\r
-  EFI_SHELL_OPEN_ROOT_BY_HANDLE             OpenRootByHandle;\r
-  EFI_EVENT                                 ExecutionBreak;\r
-  UINT32                                    MajorVersion;\r
-  UINT32                                    MinorVersion;\r
+  EFI_SHELL_EXECUTE                           Execute;\r
+  EFI_SHELL_GET_ENV                           GetEnv;\r
+  EFI_SHELL_SET_ENV                           SetEnv;\r
+  EFI_SHELL_GET_ALIAS                         GetAlias;\r
+  EFI_SHELL_SET_ALIAS                         SetAlias;\r
+  EFI_SHELL_GET_HELP_TEXT                     GetHelpText;\r
+  EFI_SHELL_GET_DEVICE_PATH_FROM_MAP          GetDevicePathFromMap;\r
+  EFI_SHELL_GET_MAP_FROM_DEVICE_PATH          GetMapFromDevicePath;\r
+  EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH    GetDevicePathFromFilePath;\r
+  EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH    GetFilePathFromDevicePath;\r
+  EFI_SHELL_SET_MAP                           SetMap;\r
+  EFI_SHELL_GET_CUR_DIR                       GetCurDir;\r
+  EFI_SHELL_SET_CUR_DIR                       SetCurDir;\r
+  EFI_SHELL_OPEN_FILE_LIST                    OpenFileList;\r
+  EFI_SHELL_FREE_FILE_LIST                    FreeFileList;\r
+  EFI_SHELL_REMOVE_DUP_IN_FILE_LIST           RemoveDupInFileList;\r
+  EFI_SHELL_BATCH_IS_ACTIVE                   BatchIsActive;\r
+  EFI_SHELL_IS_ROOT_SHELL                     IsRootShell;\r
+  EFI_SHELL_ENABLE_PAGE_BREAK                 EnablePageBreak;\r
+  EFI_SHELL_DISABLE_PAGE_BREAK                DisablePageBreak;\r
+  EFI_SHELL_GET_PAGE_BREAK                    GetPageBreak;\r
+  EFI_SHELL_GET_DEVICE_NAME                   GetDeviceName;\r
+  EFI_SHELL_GET_FILE_INFO                     GetFileInfo;\r
+  EFI_SHELL_SET_FILE_INFO                     SetFileInfo;\r
+  EFI_SHELL_OPEN_FILE_BY_NAME                 OpenFileByName;\r
+  EFI_SHELL_CLOSE_FILE                        CloseFile;\r
+  EFI_SHELL_CREATE_FILE                       CreateFile;\r
+  EFI_SHELL_READ_FILE                         ReadFile;\r
+  EFI_SHELL_WRITE_FILE                        WriteFile;\r
+  EFI_SHELL_DELETE_FILE                       DeleteFile;\r
+  EFI_SHELL_DELETE_FILE_BY_NAME               DeleteFileByName;\r
+  EFI_SHELL_GET_FILE_POSITION                 GetFilePosition;\r
+  EFI_SHELL_SET_FILE_POSITION                 SetFilePosition;\r
+  EFI_SHELL_FLUSH_FILE                        FlushFile;\r
+  EFI_SHELL_FIND_FILES                        FindFiles;\r
+  EFI_SHELL_FIND_FILES_IN_DIR                 FindFilesInDir;\r
+  EFI_SHELL_GET_FILE_SIZE                     GetFileSize;\r
+  EFI_SHELL_OPEN_ROOT                         OpenRoot;\r
+  EFI_SHELL_OPEN_ROOT_BY_HANDLE               OpenRootByHandle;\r
+  EFI_EVENT                                   ExecutionBreak;\r
+  UINT32                                      MajorVersion;\r
+  UINT32                                      MinorVersion;\r
   // Added for Shell 2.1\r
-  EFI_SHELL_REGISTER_GUID_NAME              RegisterGuidName;\r
-  EFI_SHELL_GET_GUID_NAME                   GetGuidName;\r
-  EFI_SHELL_GET_GUID_FROM_NAME              GetGuidFromName;\r
-  EFI_SHELL_GET_ENV_EX                      GetEnvEx;\r
+  EFI_SHELL_REGISTER_GUID_NAME                RegisterGuidName;\r
+  EFI_SHELL_GET_GUID_NAME                     GetGuidName;\r
+  EFI_SHELL_GET_GUID_FROM_NAME                GetGuidFromName;\r
+  EFI_SHELL_GET_ENV_EX                        GetEnvEx;\r
 } EFI_SHELL_PROTOCOL;\r
 \r
-extern EFI_GUID gEfiShellProtocolGuid;\r
+extern EFI_GUID  gEfiShellProtocolGuid;\r
 \r
 enum ShellVersion {\r
   SHELL_MAJOR_VERSION = 2,\r