AtapiPeim.h

Go to the documentation of this file.

 
#ifndef _RECOVERY_ATAPI_H_
#define _RECOVERY_ATAPI_H_
 
#include <PiPei.h>
 
#include <Ppi/BlockIo.h>
#include <Ppi/BlockIo2.h>
#include <Ppi/AtaController.h>
 
#include <Library/DebugLib.h>
#include <Library/TimerLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/PeiServicesLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/IoLib.h>
#include <Library/PeiServicesTablePointerLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PcdLib.h>
 
#include <IndustryStandard/Atapi.h>
 
#define MAX_SENSE_KEY_COUNT  6
#define MAX_IDE_CHANNELS     4 // Ide and Sata Primary, Secondary Channel.
#define MAX_IDE_DEVICES      8 // Ide, Sata Primary, Secondary and Master, Slave device.
 
typedef enum {
  IdePrimary    = 0,
  IdeSecondary  = 1,
  IdeMaxChannel = 2
} EFI_IDE_CHANNEL;
 
typedef enum {
  IdeMaster    = 0,
  IdeSlave     = 1,
  IdeMaxDevice = 2
} EFI_IDE_DEVICE;
 
//
// IDE Registers
//
typedef union {
  UINT16    Command;      /* when write */
  UINT16    Status;       /* when read */
} IDE_CMD_OR_STATUS;
 
typedef union {
  UINT16    Error;        /* when read */
  UINT16    Feature;      /* when write */
} IDE_ERROR_OR_FEATURE;
 
typedef union {
  UINT16    AltStatus;     /* when read */
  UINT16    DeviceControl; /* when write */
} IDE_ALTSTATUS_OR_DEVICECONTROL;
 
//
// IDE registers set
//
typedef struct {
  UINT16                            Data;
  IDE_ERROR_OR_FEATURE              Reg1;
  UINT16                            SectorCount;
  UINT16                            SectorNumber;
  UINT16                            CylinderLsb;
  UINT16                            CylinderMsb;
  UINT16                            Head;
  IDE_CMD_OR_STATUS                 Reg;
 
  IDE_ALTSTATUS_OR_DEVICECONTROL    Alt;
  UINT16                            DriveAddress;
} IDE_BASE_REGISTERS;
 
typedef struct {
  UINTN                      DevicePosition;
  EFI_PEI_BLOCK_IO_MEDIA     MediaInfo;
  EFI_PEI_BLOCK_IO2_MEDIA    MediaInfo2;
} PEI_ATAPI_DEVICE_INFO;
 
#define ATAPI_BLK_IO_DEV_SIGNATURE  SIGNATURE_32 ('a', 'b', 'i', 'o')
typedef struct {
  UINTN                             Signature;
 
  EFI_PEI_RECOVERY_BLOCK_IO_PPI     AtapiBlkIo;
  EFI_PEI_RECOVERY_BLOCK_IO2_PPI    AtapiBlkIo2;
  EFI_PEI_PPI_DESCRIPTOR            PpiDescriptor;
  EFI_PEI_PPI_DESCRIPTOR            PpiDescriptor2;
  PEI_ATA_CONTROLLER_PPI            *AtaControllerPpi;
 
  UINTN                             DeviceCount;
  PEI_ATAPI_DEVICE_INFO             DeviceInfo[MAX_IDE_DEVICES];    // for max 8 device
  IDE_BASE_REGISTERS                IdeIoPortReg[MAX_IDE_CHANNELS]; // for max 4 channel.
} ATAPI_BLK_IO_DEV;
 
#define PEI_RECOVERY_ATAPI_FROM_BLKIO_THIS(a)   CR (a, ATAPI_BLK_IO_DEV, AtapiBlkIo, ATAPI_BLK_IO_DEV_SIGNATURE)
#define PEI_RECOVERY_ATAPI_FROM_BLKIO2_THIS(a)  CR (a, ATAPI_BLK_IO_DEV, AtapiBlkIo2, ATAPI_BLK_IO_DEV_SIGNATURE)
 
#define STALL_1_MILLI_SECOND  1000  // stall 1 ms
#define STALL_1_SECONDS       1000 * STALL_1_MILLI_SECOND
 
//
// Time Out Value For IDE Device Polling
//
// ATATIMEOUT is used for waiting time out for ATA device
//
#define ATATIMEOUT  1000  // 1 second
// ATAPITIMEOUT is used for waiting operation
// except read and write time out for ATAPI device
//
#define ATAPITIMEOUT  1000  // 1 second
// ATAPILONGTIMEOUT is used for waiting read and
// write operation timeout for ATAPI device
//
#define CDROMLONGTIMEOUT  2000  // 2 seconds
#define ATAPILONGTIMEOUT  5000  // 5 seconds
 
//
// PEI Recovery Block I/O PPI
//
 
EFI_STATUS
EFIAPI
AtapiGetNumberOfBlockDevices (
  IN   EFI_PEI_SERVICES               **PeiServices,
  IN   EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,
  OUT  UINTN                          *NumberBlockDevices
  );
 
EFI_STATUS
EFIAPI
AtapiGetBlockDeviceMediaInfo (
  IN   EFI_PEI_SERVICES               **PeiServices,
  IN   EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,
  IN   UINTN                          DeviceIndex,
  OUT  EFI_PEI_BLOCK_IO_MEDIA         *MediaInfo
  );
 
EFI_STATUS
EFIAPI
AtapiReadBlocks (
  IN   EFI_PEI_SERVICES               **PeiServices,
  IN   EFI_PEI_RECOVERY_BLOCK_IO_PPI  *This,
  IN   UINTN                          DeviceIndex,
  IN   EFI_PEI_LBA                    StartLBA,
  IN   UINTN                          BufferSize,
  OUT  VOID                           *Buffer
  );
 
EFI_STATUS
EFIAPI
AtapiGetNumberOfBlockDevices2 (
  IN   EFI_PEI_SERVICES                **PeiServices,
  IN   EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,
  OUT  UINTN                           *NumberBlockDevices
  );
 
EFI_STATUS
EFIAPI
AtapiGetBlockDeviceMediaInfo2 (
  IN   EFI_PEI_SERVICES                **PeiServices,
  IN   EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,
  IN   UINTN                           DeviceIndex,
  OUT  EFI_PEI_BLOCK_IO2_MEDIA         *MediaInfo
  );
 
EFI_STATUS
EFIAPI
AtapiReadBlocks2 (
  IN   EFI_PEI_SERVICES                **PeiServices,
  IN   EFI_PEI_RECOVERY_BLOCK_IO2_PPI  *This,
  IN   UINTN                           DeviceIndex,
  IN   EFI_PEI_LBA                     StartLBA,
  IN   UINTN                           BufferSize,
  OUT  VOID                            *Buffer
  );
 
//
// Internal functions
//
 
VOID
AtapiEnumerateDevices (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev
  );
 
BOOLEAN
DiscoverAtapiDevice (
  IN  ATAPI_BLK_IO_DEV         *AtapiBlkIoDev,
  IN  UINTN                    DevicePosition,
  OUT EFI_PEI_BLOCK_IO_MEDIA   *MediaInfo,
  OUT EFI_PEI_BLOCK_IO2_MEDIA  *MediaInfo2
  );
 
BOOLEAN
DetectIDEController (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev,
  IN  UINTN             DevicePosition
  );
 
EFI_STATUS
WaitForBSYClear (
  IN  ATAPI_BLK_IO_DEV    *AtapiBlkIoDev,
  IN  IDE_BASE_REGISTERS  *IdeIoRegisters,
  IN  UINTN               TimeoutInMilliSeconds
  );
 
EFI_STATUS
DRDYReady (
  IN  ATAPI_BLK_IO_DEV    *AtapiBlkIoDev,
  IN  IDE_BASE_REGISTERS  *IdeIoRegisters,
  IN  UINTN               TimeoutInMilliSeconds
  );
 
EFI_STATUS
DRQClear (
  IN  ATAPI_BLK_IO_DEV    *AtapiBlkIoDev,
  IN  IDE_BASE_REGISTERS  *IdeIoRegisters,
  IN  UINTN               TimeoutInMilliSeconds
  );
 
EFI_STATUS
DRQClear2 (
  IN  ATAPI_BLK_IO_DEV    *AtapiBlkIoDev,
  IN  IDE_BASE_REGISTERS  *IdeIoRegisters,
  IN  UINTN               TimeoutInMilliSeconds
  );
 
EFI_STATUS
DRQReady (
  IN  ATAPI_BLK_IO_DEV    *AtapiBlkIoDev,
  IN  IDE_BASE_REGISTERS  *IdeIoRegisters,
  IN  UINTN               TimeoutInMilliSeconds
  );
 
EFI_STATUS
DRQReady2 (
  IN  ATAPI_BLK_IO_DEV    *AtapiBlkIoDev,
  IN  IDE_BASE_REGISTERS  *IdeIoRegisters,
  IN  UINTN               TimeoutInMilliSeconds
  );
 
EFI_STATUS
CheckErrorStatus (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev,
  IN  UINT16            StatusReg
  );
 
EFI_STATUS
ATAPIIdentify (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev,
  IN  UINTN             DevicePosition
  );
 
EFI_STATUS
TestUnitReady (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev,
  IN  UINTN             DevicePosition
  );
 
EFI_STATUS
AtapiPacketCommandIn (
  IN  ATAPI_BLK_IO_DEV      *AtapiBlkIoDev,
  IN  UINTN                 DevicePosition,
  IN  ATAPI_PACKET_COMMAND  *Packet,
  IN  UINT16                *Buffer,
  IN  UINT32                ByteCount,
  IN  UINTN                 TimeoutInMilliSeconds
  );
 
EFI_STATUS
Inquiry (
  IN  ATAPI_BLK_IO_DEV         *AtapiBlkIoDev,
  IN  UINTN                    DevicePosition,
  OUT EFI_PEI_BLOCK_IO_MEDIA   *MediaInfo,
  OUT EFI_PEI_BLOCK_IO2_MEDIA  *MediaInfo2
  );
 
EFI_STATUS
DetectMedia (
  IN  ATAPI_BLK_IO_DEV            *AtapiBlkIoDev,
  IN  UINTN                       DevicePosition,
  IN OUT EFI_PEI_BLOCK_IO_MEDIA   *MediaInfo,
  IN OUT EFI_PEI_BLOCK_IO2_MEDIA  *MediaInfo2
  );
 
EFI_STATUS
ResetDevice (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev,
  IN  UINTN             DevicePosition,
  IN  BOOLEAN           Extensive
  );
 
EFI_STATUS
RequestSense (
  IN  ATAPI_BLK_IO_DEV          *AtapiBlkIoDev,
  IN  UINTN                     DevicePosition,
  IN  ATAPI_REQUEST_SENSE_DATA  *SenseBuffers,
  IN OUT  UINT8                 *SenseCounts
  );
 
EFI_STATUS
ReadCapacity (
  IN  ATAPI_BLK_IO_DEV            *AtapiBlkIoDev,
  IN  UINTN                       DevicePosition,
  IN OUT EFI_PEI_BLOCK_IO_MEDIA   *MediaInfo,
  IN OUT EFI_PEI_BLOCK_IO2_MEDIA  *MediaInfo2
  );
 
EFI_STATUS
ReadSectors (
  IN  ATAPI_BLK_IO_DEV  *AtapiBlkIoDev,
  IN  UINTN             DevicePosition,
  IN  VOID              *Buffer,
  IN  EFI_PEI_LBA       StartLba,
  IN  UINTN             NumberOfBlocks,
  IN  UINTN             BlockSize
  );
 
BOOLEAN
IsNoMedia (
  IN  ATAPI_REQUEST_SENSE_DATA  *SenseData,
  IN  UINTN                     SenseCounts
  );
 
BOOLEAN
IsDeviceStateUnclear (
  IN  ATAPI_REQUEST_SENSE_DATA  *SenseData,
  IN  UINTN                     SenseCounts
  );
 
BOOLEAN
IsMediaError (
  IN  ATAPI_REQUEST_SENSE_DATA  *SenseData,
  IN  UINTN                     SenseCounts
  );
 
BOOLEAN
IsDriveReady (
  IN  ATAPI_REQUEST_SENSE_DATA  *SenseData,
  IN  UINTN                     SenseCounts,
  OUT BOOLEAN                   *NeedRetry
  );
 
#endif