IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkModulePkg / Csm / BiosThunk / BlockIoDxe / Edd.h

/** @file\r
  Include file to suport EDD 3.0.\r
  This file is coded to T13 D1386 Revision 3\r
  Availible on http://www.t13.org/#Project drafts\r
  Currently at ftp://fission.dt.wdc.com/pub/standards/x3t13/project/d1386r3.pdf\r
\r
Copyright (c) 1999 - 2010, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EDD_H_\r
#define _EDD_H_\r
\r
//\r
// packing with no compiler padding, so that the fields\r
// of the following architected structures can be\r
// properly accessed from C code.\r
//\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT8   Bus;\r
  UINT8   Device;\r
  UINT8   Function;\r
  UINT8   Controller;\r
  UINT32  Reserved;\r
} EDD_PCI;\r
\r
typedef struct {\r
  UINT16  Base;\r
  UINT16  Reserved;\r
  UINT32  Reserved2;\r
} EDD_LEGACY;\r
\r
typedef union {\r
  EDD_PCI     Pci;\r
  EDD_LEGACY  Legacy;\r
} EDD_INTERFACE_PATH;\r
\r
typedef struct {\r
  UINT8 Master;\r
  UINT8 Reserved[15];\r
} EDD_ATA;\r
\r
typedef struct {\r
  UINT8 Master;\r
  UINT8 Lun;\r
  UINT8 Reserved[14];\r
} EDD_ATAPI;\r
\r
typedef struct {\r
  UINT16  Pun;\r
  UINT64  Lun;\r
  UINT8   Reserved[6];\r
} EDD_SCSI;\r
\r
typedef struct {\r
  UINT64  SerialNumber;\r
  UINT64  Reserved;\r
} EDD_USB;\r
\r
typedef struct {\r
  UINT64  Guid;\r
  UINT64  Reserved;\r
} EDD_1394;\r
\r
typedef struct {\r
  UINT64  Wwn;\r
  UINT64  Lun;\r
} EDD_FIBRE;\r
\r
typedef union {\r
  EDD_ATA   Ata;\r
  EDD_ATAPI Atapi;\r
  EDD_SCSI  Scsi;\r
  EDD_USB   Usb;\r
  EDD_1394  FireWire;\r
  EDD_FIBRE FibreChannel;\r
} EDD_DEVICE_PATH;\r
\r
typedef struct {\r
  UINT16              StructureSize;\r
  UINT16              Flags;\r
  UINT32              MaxCylinders;\r
  UINT32              MaxHeads;\r
  UINT32              SectorsPerTrack;\r
  UINT64              PhysicalSectors;\r
  UINT16              BytesPerSector;\r
  UINT32              Fdpt;\r
  UINT16              Key;\r
  UINT8               DevicePathLength;\r
  UINT8               Reserved1;\r
  UINT16              Reserved2;\r
  CHAR8               HostBusType[4];\r
  CHAR8               InterfaceType[8];\r
  EDD_INTERFACE_PATH  InterfacePath;\r
  EDD_DEVICE_PATH     DevicePath;\r
  UINT8               Reserved3;\r
  UINT8               Checksum;\r
} EDD_DRIVE_PARAMETERS;\r
\r
//\r
// EDD_DRIVE_PARAMETERS.Flags defines\r
//\r
#define EDD_GEOMETRY_VALID          0x02\r
#define EDD_DEVICE_REMOVABLE        0x04\r
#define EDD_WRITE_VERIFY_SUPPORTED  0x08\r
#define EDD_DEVICE_CHANGE           0x10\r
#define EDD_DEVICE_LOCKABLE         0x20\r
\r
//\r
// BUGBUG: This bit does not follow the spec. It tends to be always set\r
//  to work properly with Win98.\r
//\r
#define EDD_DEVICE_GEOMETRY_MAX 0x40\r
\r
typedef struct {\r
  UINT8   PacketSizeInBytes;  // 0x18\r
  UINT8   Zero;\r
  UINT8   NumberOfBlocks;     // Max 0x7f\r
  UINT8   Zero2;\r
  UINT32  SegOffset;\r
  UINT64  Lba;\r
  UINT64  TransferBuffer;\r
  UINT32  ExtendedBlockCount; // Max 0xffffffff\r
  UINT32  Zero3;\r
} EDD_DEVICE_ADDRESS_PACKET;\r
\r
#define EDD_VERSION_30  0x30\r
\r
//\r
// Int 13 BIOS Errors\r
//\r
#define BIOS_PASS                   0x00\r
#define BIOS_WRITE_PROTECTED        0x03\r
#define BIOS_SECTOR_NOT_FOUND       0x04\r
#define BIOS_RESET_FAILED           0x05\r
#define BIOS_DISK_CHANGED           0x06\r
#define BIOS_DRIVE_DOES_NOT_EXIST   0x07\r
#define BIOS_DMA_ERROR              0x08\r
#define BIOS_DATA_BOUNDRY_ERROR     0x09\r
#define BIOS_BAD_SECTOR             0x0a\r
#define BIOS_BAD_TRACK              0x0b\r
#define BIOS_MEADIA_TYPE_NOT_FOUND  0x0c\r
#define BIOS_INVALED_FORMAT         0x0d\r
#define BIOS_ECC_ERROR              0x10\r
#define BIOS_ECC_CORRECTED_ERROR    0x11\r
#define BIOS_HARD_DRIVE_FAILURE     0x20\r
#define BIOS_SEEK_FAILED            0x40\r
#define BIOS_DRIVE_TIMEOUT          0x80\r
#define BIOS_DRIVE_NOT_READY        0xaa\r
#define BIOS_UNDEFINED_ERROR        0xbb\r
#define BIOS_WRITE_FAULT            0xcc\r
#define BIOS_SENSE_FAILED           0xff\r
\r
#define MAX_EDD11_XFER              0xfe00\r
\r
#pragma pack()\r
//\r
// Internal Data Structures\r
//\r
typedef struct {\r
  CHAR8                 Letter;\r
  UINT8                 Number;\r
  UINT8                 EddVersion;\r
  BOOLEAN               ExtendedInt13;\r
  BOOLEAN               DriveLockingAndEjecting;\r
  BOOLEAN               Edd;\r
  BOOLEAN               Extensions64Bit;\r
  BOOLEAN               ParametersValid;\r
  UINT8                 ErrorCode;\r
  VOID                  *FdptPointer;\r
  BOOLEAN               Floppy;\r
  BOOLEAN               AtapiFloppy;\r
  UINT8                 MaxHead;\r
  UINT8                 MaxSector;\r
  UINT16                MaxCylinder;\r
  UINT16                Pad;\r
  EDD_DRIVE_PARAMETERS  Parameters;\r
} BIOS_LEGACY_DRIVE;\r
\r
#define BIOS_CONSOLE_BLOCK_IO_DEV_SIGNATURE SIGNATURE_32 ('b', 'b', 'i', 'o')\r
typedef struct {\r
  UINTN                     Signature;\r
\r
  EFI_HANDLE                Handle;\r
  EFI_HANDLE                ControllerHandle;\r
  EFI_BLOCK_IO_PROTOCOL     BlockIo;\r
  EFI_BLOCK_IO_MEDIA        BlockMedia;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  EFI_PCI_IO_PROTOCOL       *PciIo;\r
  EFI_LEGACY_BIOS_PROTOCOL  *LegacyBios;\r
\r
  BIOS_LEGACY_DRIVE         Bios;\r
\r
} BIOS_BLOCK_IO_DEV;\r
\r
#define BIOS_BLOCK_IO_FROM_THIS(a)  CR (a, BIOS_BLOCK_IO_DEV, BlockIo, BIOS_CONSOLE_BLOCK_IO_DEV_SIGNATURE)\r
\r
#endif\r