MdePkg/Include/Protocol/TapeIo.h File Reference
Detailed Description
EFI_TAPE_IO_PROTOCOL as defined in the UEFI 2.0. Provide services to control and access a tape device.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Define Documentation
#define EFI_TAPE_IO_PROTOCOL_GUID |
Value:
{ \
0x1e93e633, 0xd65a, 0x459e, {0xab, 0x84, 0x93, 0xd9, 0xec, 0x26, 0x6d, 0x18 } \
}
Typedef Documentation
Reads from the tape.
- Parameters:
-
| This | A pointer to the EFI_TAPE_IO_PROTOCOL instance. |
| BufferSize | The size of the buffer in bytes pointed to by Buffer. |
| Buffer | The pointer to the buffer for data to be read into. |
- Return values:
-
| EFI_SUCCESS | Data was successfully transferred from the media. |
| EFI_END_OF_FILE | A filemark was encountered which limited the data transferred by the read operation or the head is positioned just after a filemark. |
| EFI_NO_MEDIA | No media is loaded in the device. |
| EFI_NOT_READY | The transfer failed since the device was not ready (e.g. not online). The transfer may be retried at a later time. |
| EFI_UNSUPPORTED | The device does not support this type of transfer. |
| EFI_TIMEOUT | The transfer failed to complete within the timeout specified. |
| EFI_MEDIA_CHANGED | The media in the device was changed since the last access. The transfer was aborted since the current position of the media may be incorrect. |
| EFI_INVALID_PARAMETER | A NULL Buffer was specified with a non-zero BufferSize, or the device is operating in fixed block size mode and the BufferSize was not a multiple of device's fixed block size |
| EFI_DEVICE_ERROR | A device error occurred while attempting to transfer data from the media. |
Resets the tape device.
- Parameters:
-
| This | A pointer to the EFI_TAPE_IO_PROTOCOL instance. |
| ExtendedVerification | Indicates whether the parent bus should also be reset. |
- Return values:
-
| EFI_SUCCESS | The bus and/or device were successfully reset. |
| EFI_NO_MEDIA | No media is loaded in the device. |
| EFI_NOT_READY | The reset failed since the device and/or bus was not ready. The reset may be retried at a later time. |
| EFI_UNSUPPORTED | The device does not support this type of reset. |
| EFI_TIMEOUT | The reset did not complete within the timeout allowed. |
| EFI_DEVICE_ERROR | A device error occurred while attempting to reset the bus and/or device. |
Rewinds the tape.
- Parameters:
-
| This | A pointer to the EFI_TAPE_IO_PROTOCOL instance. |
- Return values:
-
| EFI_SUCCESS | The media was successfully repositioned. |
| EFI_NO_MEDIA | No media is loaded in the device. |
| EFI_NOT_READY | Repositioning the media failed since the device was not ready (e.g. not online). The transfer may be retried at a later time. |
| EFI_UNSUPPORTED | The device does not support this type of media repositioning. |
| EFI_TIMEOUT | Repositioning of the media did not complete within the timeout specified. |
| EFI_DEVICE_ERROR | A device error occurred while attempting to reposition the media. |
Positions the tape.
- Parameters:
-
| This | A pointer to the EFI_TAPE_IO_PROTOCOL instance. |
| Direction | Direction and number of data blocks or filemarks to space over on media. |
| Type | Type of mark to space over on media. The following Type marks are mandatory: BLOCK type : 0 FILEMARK type : 1 |
- Return values:
-
| EFI_SUCCESS | The media was successfully repositioned. |
| EFI_END_OF_MEDIA | Beginning or end of media was reached before the indicated number of data blocks or filemarks were found. |
| EFI_NO_MEDIA | No media is loaded in the device. |
| EFI_NOT_READY | The reposition failed since the device was not ready (e.g. not online). The reposition may be retried at a later time. |
| EFI_UNSUPPORTED | The device does not support this type of repositioning. |
| EFI_TIMEOUT | The repositioning failed to complete within the timeout specified. |
| EFI_MEDIA_CHANGED | The media in the device was changed since the last access. Repositioning the media was aborted since the current position of the media may be incorrect. |
| EFI_DEVICE_ERROR | A device error occurred while attempting to reposition the media. |
Writes to the tape.
- Parameters:
-
| This | A pointer to the EFI_TAPE_IO_PROTOCOL instance. |
| BufferSize | Size of the buffer in bytes pointed to by Buffer. |
| Buffer | The pointer to the buffer for data to be written from. |
- Return values:
-
| EFI_SUCCESS | Data was successfully transferred to the media. |
| EFI_END_OF_MEDIA | The logical end of media has been reached. Data may have been successfully transferred to the media. |
| EFI_NO_MEDIA | No media is loaded in the device. |
| EFI_NOT_READY | The transfer failed since the device was not ready (e.g. not online). The transfer may be retried at a later time. |
| EFI_UNSUPPORTED | The device does not support this type of transfer. |
| EFI_TIMEOUT | The transfer failed to complete within the timeout specified. |
| EFI_MEDIA_CHANGED | The media in the device was changed since the last access. The transfer was aborted since the current position of the media may be incorrect. |
| EFI_WRITE_PROTECTED | The media in the device is write-protected. The transfer was aborted since a write cannot be completed. |
| EFI_INVALID_PARAMETER | A NULL Buffer was specified with a non-zero BufferSize, or the device is operating in fixed block size mode and the BufferSize was not a multiple of device's fixed block size |
| EFI_DEVICE_ERROR | A device error occurred while attempting to transfer data from the media. |
Writes filemarks to the media.
- Parameters:
-
| This | A pointer to the EFI_TAPE_IO_PROTOCOL instance. |
| Count | Number of filemarks to write to the media. |
- Return values:
-
| EFI_SUCCESS | Data was successfully transferred from the media. |
| EFI_NO_MEDIA | No media is loaded in the device. |
| EFI_NOT_READY | The transfer failed since the device was not ready (e.g. not online). The transfer may be retried at a later time. |
| EFI_UNSUPPORTED | The device does not support this type of repositioning. |
| EFI_TIMEOUT | The transfer failed to complete within the timeout specified. |
| EFI_MEDIA_CHANGED | The media in the device was changed since the last access. The transfer was aborted since the current position of the media may be incorrect. |
| EFI_DEVICE_ERROR | A device error occurred while attempting to transfer data from the media. |
Variable Documentation