Update Copyright header of IsaFloppyPei.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaFloppy / Pei / FloppyPeim.h

/*++\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation<BR>\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
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
Module Name:\r
\r
    FloppyPeim.h\r
    \r
Abstract: \r
    \r
\r
Revision History\r
--*/\r
\r
#ifndef _RECOVERY_FLOPPY_H\r
#define _RECOVERY_FLOPPY_H\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <PiPei.h>\r
#include <FrameworkPei.h>\r
\r
#include <Ppi/BlockIo.h>\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/IoLib.h>\r
\r
#include "Fdc.h"\r
//\r
// define some macro\r
//\r
#define STALL_1_SECOND  1000000\r
#define STALL_1_MSECOND 1000\r
\r
#define DATA_IN         1\r
#define DATA_OUT        0\r
#define READ            0\r
#define WRITE           1\r
\r
typedef enum {\r
  _360K_360K  = 0,\r
  _360K_1200K,\r
  _1200K_1200K,\r
  _720K_720K,\r
  _720K_1440K,\r
  _1440K_1440K,\r
  _720K_2880K,\r
  _1440K_2880K,\r
  _2880K_2880K\r
} FDC_DISKET_TYPE;\r
\r
typedef struct {\r
  UINT8                      DevPos;\r
  UINT8                      Pcn;\r
  BOOLEAN                    MotorOn;\r
  BOOLEAN                    NeedRecalibrate;\r
  FDC_DISKET_TYPE            Type;\r
  EFI_PEI_BLOCK_IO_MEDIA     MediaInfo;\r
} PEI_FLOPPY_DEVICE_INFO;\r
\r
#define FDC_BLK_IO_DEV_SIGNATURE  EFI_SIGNATURE_32 ('F', 'b', 'i', 'o')\r
\r
typedef struct {\r
  UINTN                           Signature;\r
  EFI_PEI_RECOVERY_BLOCK_IO_PPI   FdcBlkIo;\r
  EFI_PEI_PPI_DESCRIPTOR          PpiDescriptor;\r
  UINTN                           DeviceCount;\r
  PEI_FLOPPY_DEVICE_INFO          DeviceInfo[2];\r
} FDC_BLK_IO_DEV;\r
\r
#define PEI_RECOVERY_FDC_FROM_BLKIO_THIS(a) CR (a, FDC_BLK_IO_DEV, FdcBlkIo, FDC_BLK_IO_DEV_SIGNATURE)\r
\r
//\r
// PEI Recovery Block I/O PPI\r
//\r
EFI_STATUS\r
EFIAPI\r
FdcGetNumberOfBlockDevices (\r
  IN   EFI_PEI_SERVICES                  **PeiServices,\r
  IN   EFI_PEI_RECOVERY_BLOCK_IO_PPI     *This,\r
  OUT  UINTN                             *NumberBlockDevices\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FdcGetBlockDeviceMediaInfo (\r
  IN   EFI_PEI_SERVICES                     **PeiServices,\r
  IN   EFI_PEI_RECOVERY_BLOCK_IO_PPI        *This,\r
  IN   UINTN                                DeviceIndex,\r
  OUT  EFI_PEI_BLOCK_IO_MEDIA               *MediaInfo\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FdcReadBlocks (\r
  IN   EFI_PEI_SERVICES                  **PeiServices,\r
  IN   EFI_PEI_RECOVERY_BLOCK_IO_PPI     *This,\r
  IN   UINTN                             DeviceIndex,\r
  IN   EFI_PEI_LBA                       StartLba,\r
  IN   UINTN                             BufferSize,\r
  OUT  VOID                              *Buffer\r
  );\r
\r
//\r
// Internal function declare\r
//\r
UINT8\r
FdcEnumeration (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev\r
  );\r
\r
EFI_STATUS\r
FdcReset (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN UINT8            DevPos\r
  );\r
\r
BOOLEAN\r
DiscoverFdcDevice (\r
  IN  FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN  OUT PEI_FLOPPY_DEVICE_INFO *Info,\r
  OUT EFI_PEI_BLOCK_IO_MEDIA     *MediaInfo\r
  );\r
\r
EFI_STATUS\r
Recalibrate (\r
  IN FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info\r
  );\r
\r
EFI_STATUS\r
Seek (\r
  IN FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info,\r
  IN EFI_PEI_LBA                Lba\r
  );\r
\r
EFI_STATUS\r
MotorOn (\r
  IN FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info\r
  );\r
\r
EFI_STATUS\r
MotorOff (\r
  IN FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info\r
  );\r
\r
EFI_STATUS\r
FdcWaitForBSYClear (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN  UINT8           DevPos,\r
  IN  UINTN           TimeoutInSeconds\r
  );\r
\r
EFI_STATUS\r
SenseIntStatus (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN OUT UINT8        *sts0,\r
  IN OUT UINT8        *pcn\r
  );\r
\r
EFI_STATUS\r
Specify (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev\r
  );\r
\r
EFI_STATUS\r
DisketChanged (\r
  IN FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info\r
  );\r
\r
EFI_STATUS\r
DataInByte (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN OUT UINT8        *pt\r
  );\r
\r
EFI_STATUS\r
DataOutByte (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN UINT8            *pt\r
  );\r
\r
EFI_STATUS\r
FdcDRQReady (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN BOOLEAN          Dio,\r
  IN UINTN            TimeoutInSeconds\r
  );\r
\r
UINTN\r
GetTransferBlockCount (\r
  IN PEI_FLOPPY_DEVICE_INFO *Info,\r
  IN EFI_PEI_LBA            LBA,\r
  IN UINTN                  NumberOfBlocks\r
  );\r
\r
EFI_STATUS\r
ReadWriteDataSector (\r
  IN FDC_BLK_IO_DEV             *FdcBlkIoDev,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info,\r
  IN VOID                       *Buffer,\r
  IN EFI_PEI_LBA                Lba,\r
  IN UINTN                      NumberOfBlocks,\r
  IN BOOLEAN                    Read\r
  );\r
\r
EFI_STATUS\r
SetDMA (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN VOID             *Buffer,\r
  IN UINTN            NumberOfBlocks,\r
  IN BOOLEAN          Read\r
  );\r
\r
VOID\r
FillPara (\r
  IN  PEI_FLOPPY_DEVICE_INFO *Info,\r
  IN  EFI_PEI_LBA            Lba,\r
  IN  FDC_COMMAND_PACKET1    *Command\r
  );\r
\r
EFI_STATUS\r
Setup (\r
  IN FDC_BLK_IO_DEV   *FdcBlkIoDev,\r
  IN UINT8            DevPos\r
  );\r
\r
EFI_STATUS\r
CheckResult (\r
  IN FDC_RESULT_PACKET          *Result,\r
  IN OUT PEI_FLOPPY_DEVICE_INFO *Info\r
  );\r
\r
#endif\r