Update definition aligned to UEFI2.3

[mirror_edk2.git] / MdePkg / Include / Protocol / TapeIo.h

diff --git a/MdePkg/Include/Protocol/TapeIo.h b/MdePkg/Include/Protocol/TapeIo.h
index 919c95bc7072bffa6c130d4286cafef75ed881e8..00a046081eefc1d23a65b7a0c64b5134aef926f8 100644 (file)
--- a/MdePkg/Include/Protocol/TapeIo.h
+++ b/MdePkg/Include/Protocol/TapeIo.h
@@ -2,7 +2,7 @@
   EFI_TAPE_IO_PROTOCOL as defined in the UEFI 2.0.\r
   Provide services to control and access a tape device.\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
@@ -11,8 +11,6 @@
   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:  TapeIo.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_TAPE_IO_PROTOCOL_H__\r
@@ -25,7 +23,7 @@
 \r
 typedef struct _EFI_TAPE_IO_PROTOCOL EFI_TAPE_IO_PROTOCOL;\r
 \r
-typedef struct {\r
+typedef struct _EFI_TAPE_HEADER {\r
   UINT64     Signature;\r
   UINT32     Revision;\r
   UINT32     BootDescSize;\r
@@ -43,7 +41,7 @@ typedef struct {
   CHAR8      SystemName[256];  // UTF-8\r
   CHAR8      TapeTitle[120];   // UTF-8\r
   CHAR8      pad[468];         // pad to 1024\r
-} TAPE_HEADER;\r
+} EFI_TAPE_HEADER;\r
 \r
 /**\r
   Reads from the tape.\r
@@ -74,12 +72,11 @@ typedef struct {
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_TAPE_READ) (\r
+(EFIAPI *EFI_TAPE_READ)(\r
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   IN OUT UINTN            *BufferSize,\r
   OUT VOID                *Buffer\r
-  )\r
-;    \r
+  );    \r
 \r
 /**\r
   Writes to the tape.\r
@@ -111,12 +108,11 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_TAPE_WRITE) (\r
+(EFIAPI *EFI_TAPE_WRITE)(\r
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   IN UINTN                *BufferSize,\r
   IN VOID                 *Buffer\r
-  )\r
-; \r
+  ); \r
   \r
 \r
 /**\r
@@ -135,10 +131,9 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_TAPE_REWIND) (\r
+(EFIAPI *EFI_TAPE_REWIND)(\r
   IN EFI_TAPE_IO_PROTOCOL *This\r
-  )\r
-;   \r
+  );   \r
 \r
 \r
 /**\r
@@ -147,6 +142,9 @@ EFI_STATUS
   @param  This      A pointer to the EFI_TAPE_IO_PROTOCOL instance.\r
   @param  Direction Direction and number of data blocks or filemarks to space over on media.\r
   @param  Type      Type of mark to space over on media.\r
+                    The following Type marks are mandatory:\r
+                    BLOCK type    : 0 \r
+                    FILEMARK type : 1\r
 \r
   @retval EFI_SUCCESS       The media was successfully repositioned.\r
   @retval EFI_END_OF_MEDIA  Beginning or end of media was reached before the\r
@@ -164,12 +162,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TAPE_SPACE) (\r
+(EFIAPI *EFI_TAPE_SPACE)(\r
   IN EFI_TAPE_IO_PROTOCOL *This,\r
-  INTN                    Direction,\r
-  UINTN                   Type\r
-  )\r
-;   \r
+  IN INTN                 Direction,\r
+  IN UINTN                Type\r
+  );   \r
 \r
 \r
 /**\r
@@ -192,11 +189,10 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_TAPE_WRITEFM) (\r
+(EFIAPI *EFI_TAPE_WRITEFM)(\r
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   IN UINTN                Count\r
-  )\r
-;   \r
+  );   \r
 \r
 \r
 /**\r
@@ -216,12 +212,17 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_TAPE_RESET) (\r
+(EFIAPI *EFI_TAPE_RESET)(\r
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   IN BOOLEAN              ExtendedVerification\r
-  )\r
-;    \r
-\r
+  );    \r
+\r
+///\r
+/// The EFI_TAPE_IO_PROTOCOL provides basic sequential operations for tape devices. \r
+/// These include read, write, rewind, space, write filemarks and reset functions. \r
+/// Per this specification, a boot application uses the services of this protocol \r
+/// to load the bootloader image from tape.\r
+///\r
 struct _EFI_TAPE_IO_PROTOCOL {\r
   EFI_TAPE_READ           TapeRead;\r
   EFI_TAPE_WRITE          TapeWrite;\r