]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/TianoTools/Include/Protocol/TapeIo.h
1. Removed the unnecessary #include statements and include files
[mirror_edk2.git] / Tools / Source / TianoTools / Include / Protocol / TapeIo.h
CommitLineData
21b50a27 1/** @file\r
2 EFI_TAPE_IO_PROTOCOL as defined in the UEFI 2.0.\r
3 Provide services to control and access a tape device.\r
4\r
5 Copyright (c) 2006, Intel Corporation \r
6 All rights reserved. This program and the accompanying materials \r
7 are licensed and made available under the terms and conditions of the BSD License \r
8 which accompanies this distribution. The full text of the license may be found at \r
9 http://opensource.org/licenses/bsd-license.php \r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
13\r
14 Module Name: TapeIo.h\r
15\r
16**/\r
17\r
18#ifndef __EFI_TAPE_IO_PROTOCOL_H__\r
19#define __EFI_TAPE_IO_PROTOCOL_H__\r
20\r
21#define EFI_TAPE_IO_PROTOCOL_GUID \\r
22 { \\r
23 0x1e93e633, 0xd65a, 0x459e, {0xab, 0x84, 0x93, 0xd9, 0xec, 0x26, 0x6d, 0x18 } \\r
24 }\r
25\r
26typedef struct _EFI_TAPE_IO_PROTOCOL EFI_TAPE_IO_PROTOCOL;\r
27\r
28typedef struct {\r
29 UINT64 Signature;\r
30 UINT32 Revision;\r
31 UINT32 BootDescSize;\r
32 UINT32 BootDescCRC;\r
33 EFI_GUID TapeGUID;\r
34 EFI_GUID TapeType;\r
35 EFI_GUID TapeUnique;\r
36 UINT32 BLLocation;\r
37 UINT32 BLBlocksize;\r
38 UINT32 BLFilesize;\r
39 CHAR8 OSVersion[40];\r
40 CHAR8 AppVersion[40];\r
41 CHAR8 CreationDate[10];\r
42 CHAR8 CreationTime[10];\r
43 CHAR8 SystemName[256]; // UTF-8\r
44 CHAR8 TapeTitle[120]; // UTF-8\r
45 CHAR8 pad[468]; // pad to 1024\r
46} TAPE_HEADER;\r
47\r
48/**\r
49 Reads from the tape.\r
50\r
51 @param This A pointer to the EFI_TAPE_IO_PROTOCOL instance.\r
52 @param BufferSize Size of the buffer in bytes pointed to by Buffer.\r
53 @param Buffer Pointer to the buffer for data to be read into.\r
54\r
55 @retval EFI_SUCCESS Data was successfully transferred from the media.\r
56 @retval EFI_END_OF_FILE A filemark was encountered which limited the data\r
57 transferred by the read operation or the head is positioned\r
58 just after a filemark.\r
59 @retval EFI_NO_MEDIA No media is loaded in the device.\r
60 @retval EFI_NOT_READY The transfer failed since the device was not ready (e.g. not\r
61 online). The transfer may be retried at a later time.\r
62 @retval EFI_UNSUPPORTED The device does not support this type of transfer.\r
63 @retval EFI_TIMEOUT The transfer failed to complete within the timeout specified.\r
64 @retval EFI_MEDIA_CHANGED The media in the device was changed since the last access.\r
65 The transfer was aborted since the current position of the\r
66 media may be incorrect.\r
67 @retval EFI_INVALID_PARAMETER A NULL Buffer was specified with a non-zero\r
68 BufferSize or the device is operating in fixed block\r
69 size mode and the BufferSize was not a multiple of\r
70