/** @file\r
- SimpleFileSystem protocol as defined in the EFI 1.0 specification.\r
+ SimpleFileSystem protocol as defined in the UEFI 2.0 specification.\r
\r
The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r
- file system specified in EFI 1.0. It can also be used to abstract a file \r
+ file system specified in UEFI 2.0. It can also be used to abstract a file \r
system other than FAT.\r
\r
- EFI 1.0 can boot from any valid EFI image contained in a SimpleFileSystem\r
+ UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
- Module Name: SimpleFileSystem.h\r
-\r
**/\r
\r
#ifndef __SIMPLE_FILE_SYSTEM_H__\r
}\r
\r
typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL;\r
-typedef struct _EFI_FILE EFI_FILE;\r
-typedef struct _EFI_FILE *EFI_FILE_HANDLE;\r
-typedef struct _EFI_FILE EFI_FILE_PROTOCOL;\r
+\r
+typedef struct _EFI_FILE_PROTOCOL EFI_FILE_PROTOCOL;\r
+typedef struct _EFI_FILE_PROTOCOL *EFI_FILE_HANDLE;\r
+\r
+\r
+//\r
+// Protocol GUID defined in EFI1.1.\r
+// \r
+#define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r
+\r
+//\r
+// Protocol defined in EFI1.1.\r
+// \r
+typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE;\r
+typedef struct _EFI_FILE_PROTOCOL EFI_FILE;\r
\r
/**\r
Open the root directory on a volume.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME) (\r
+(EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME)(\r
IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r
- OUT EFI_FILE **Root\r
+ OUT EFI_FILE_PROTOCOL **Root\r
)\r
;\r
\r
#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000\r
+//\r
+// Revision defined in EFI1.1\r
+// \r
+#define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r
\r
struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r
UINT64 Revision;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_OPEN) (\r
- IN EFI_FILE *This,\r
- OUT EFI_FILE **NewHandle,\r
+(EFIAPI *EFI_FILE_OPEN)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
+ OUT EFI_FILE_PROTOCOL **NewHandle,\r
IN CHAR16 *FileName,\r
IN UINT64 OpenMode,\r
IN UINT64 Attributes\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_CLOSE) (\r
+(EFIAPI *EFI_FILE_CLOSE)(\r
IN EFI_FILE *This\r
)\r
;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_DELETE) (\r
+(EFIAPI *EFI_FILE_DELETE)(\r
IN EFI_FILE *This\r
)\r
;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_READ) (\r
- IN EFI_FILE *This,\r
+(EFIAPI *EFI_FILE_READ)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
IN OUT UINTN *BufferSize,\r
OUT VOID *Buffer\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_WRITE) (\r
- IN EFI_FILE *This,\r
+(EFIAPI *EFI_FILE_WRITE)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
IN OUT UINTN *BufferSize,\r
IN VOID *Buffer\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_SET_POSITION) (\r
- IN EFI_FILE *This,\r
+(EFIAPI *EFI_FILE_SET_POSITION)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
IN UINT64 Position\r
)\r
;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_GET_POSITION) (\r
- IN EFI_FILE *This,\r
+(EFIAPI *EFI_FILE_GET_POSITION)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
OUT UINT64 *Position\r
)\r
;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_GET_INFO) (\r
- IN EFI_FILE *This,\r
+(EFIAPI *EFI_FILE_GET_INFO)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
IN EFI_GUID *InformationType,\r
IN OUT UINTN *BufferSize,\r
OUT VOID *Buffer\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_SET_INFO) (\r
- IN EFI_FILE *This,\r
+(EFIAPI *EFI_FILE_SET_INFO)(\r
+ IN EFI_FILE_PROTOCOL *This,\r
IN EFI_GUID *InformationType,\r
IN UINTN BufferSize,\r
IN VOID *Buffer\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FILE_FLUSH) (\r
+(EFIAPI *EFI_FILE_FLUSH)(\r
IN EFI_FILE *This\r
)\r
;\r
\r
-#define EFI_FILE_HANDLE_REVISION 0x00010000\r
-#define EFI_FILE_PROTOCOL_REVISION EFI_FILE_HANDLE_REVISION\r
+#define EFI_FILE_PROTOCOL_REVISION 0x00010000\r
+//\r
+// Revision defined in EFI1.1.\r
+// \r
+#define EFI_FILE_REVISION EFI_FILE_PROTOCOL_REVISION\r
+\r
+/** \r
+ @par Protocol Description:\r
+ The EFI_FILE_PROTOCOL provides file IO access to supported file systems.\r
+ An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, \r
+ and is also a reference to a location in the directory tree of the file system \r
+ in which the file resides. With any given file handle, other files may be opened \r
+ relative to this file's location, yielding new file handles.\r
+\r
+ @param Revision\r
+ The version of the EFI_FILE_PROTOCOL interface. The version specified \r
+ by this specification is 0x00010000. Future versions are required \r
+ to be backward compatible to version 1.0.\r
\r
-struct _EFI_FILE {\r
+ @param Open\r
+ Opens or creates a new file. \r
+\r
+ @param Close\r
+ Closes the current file handle. \r
+\r
+ @param Delete\r
+ Deletes a file. \r
+\r
+ @param Read\r
+ Reads bytes from a file. \r
+\r
+ @param Write\r
+ Writes bytes to a file. \r
+\r
+ @param GetPosition\r
+ Returns the current file position. \r
+\r
+ @param SetPosition\r
+ Sets the current file position. \r
+\r
+ @param GetInfo\r
+ Gets the requested file or volume information. \r
+\r
+ @param SetInfo\r
+ Sets the requested file information. \r
+\r
+ @param Flush\r
+ Flushes all modified data associated with the file to the device. \r
+**/\r
+struct _EFI_FILE_PROTOCOL {\r
UINT64 Revision;\r
EFI_FILE_OPEN Open;\r
EFI_FILE_CLOSE Close;\r
projects / mirror_edk2.git / blobdiff