Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/TapeIo.h b/MdePkg/Include/Protocol/TapeIo.h
index 22f090b71eaad8ece3339bca68b6f6bd410245e7..6183a2083c61d4e19b97919c6a133dc8f58c61b2 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
@@ -76,8 +76,7 @@ EFI_STATUS
   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
@@ -113,8 +112,7 @@ EFI_STATUS
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   IN UINTN                *BufferSize,\r
   IN VOID                 *Buffer\r
-  )\r
-; \r
+  ); \r
   \r
 \r
 /**\r
@@ -135,8 +133,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_TAPE_REWIND)(\r
   IN EFI_TAPE_IO_PROTOCOL *This\r
-  )\r
-;   \r
+  );   \r
 \r
 \r
 /**\r
@@ -145,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
@@ -166,8 +166,7 @@ EFI_STATUS
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   INTN                    Direction,\r
   UINTN                   Type\r
-  )\r
-;   \r
+  );   \r
 \r
 \r
 /**\r
@@ -193,8 +192,7 @@ EFI_STATUS
 (EFIAPI *EFI_TAPE_WRITEFM)(\r
   IN EFI_TAPE_IO_PROTOCOL *This,\r
   IN UINTN                Count\r
-  )\r
-;   \r
+  );   \r
 \r
 \r
 /**\r
@@ -217,9 +215,14 @@ EFI_STATUS
 (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