IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaFloppyDxe / IsaFloppy.h

/** @file\r
  Include file for ISA Floppy Driver\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ISA_FLOPPY_H_\r
#define _ISA_FLOPPY_H_\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/IsaIo.h>\r
#include <Protocol/DevicePath.h>\r
#include <Guid/StatusCodeDataTypeId.h>\r
\r
#include <Library/TimerLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/PcdLib.h>\r
\r
extern EFI_DRIVER_BINDING_PROTOCOL  gFdcControllerDriver;\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
//\r
// Internal Data Structures\r
//\r
#define FDC_BLK_IO_DEV_SIGNATURE            SIGNATURE_32 ('F', 'B', 'I', 'O')\r
#define FLOPPY_CONTROLLER_CONTEXT_SIGNATURE SIGNATURE_32 ('F', 'D', 'C', 'C')\r
\r
typedef enum {\r
  FdcDisk0   = 0,\r
  FdcDisk1   = 1,\r
  FdcMaxDisk = 2\r
} EFI_FDC_DISK;\r
\r
typedef struct {\r
  UINT32          Signature;\r
  LIST_ENTRY      Link;\r
  BOOLEAN         FddResetPerformed;\r
  EFI_STATUS      FddResetStatus;\r
  BOOLEAN         NeedRecalibrate;\r
  UINT8           NumberOfDrive;\r
  UINT16          BaseAddress;\r
} FLOPPY_CONTROLLER_CONTEXT;\r
\r
typedef struct {\r
  UINTN                                     Signature;\r
  EFI_HANDLE                                Handle;\r
  EFI_BLOCK_IO_PROTOCOL                     BlkIo;\r
  EFI_BLOCK_IO_MEDIA                        BlkMedia;\r
\r
  EFI_ISA_IO_PROTOCOL                       *IsaIo;\r
\r
  UINT16                                    BaseAddress;\r
\r
  EFI_FDC_DISK                              Disk;\r
  UINT8                                     PresentCylinderNumber;\r
  UINT8                                     *Cache;\r
\r
  EFI_EVENT                                 Event;\r
  EFI_UNICODE_STRING_TABLE                  *ControllerNameTable;\r
  FLOPPY_CONTROLLER_CONTEXT                 *ControllerState;\r
\r
  EFI_DEVICE_PATH_PROTOCOL                  *DevicePath;\r
} FDC_BLK_IO_DEV;\r
\r
#include "ComponentName.h"\r
\r
#define FDD_BLK_IO_FROM_THIS(a) CR (a, FDC_BLK_IO_DEV, BlkIo, FDC_BLK_IO_DEV_SIGNATURE)\r
#define FLOPPY_CONTROLLER_FROM_LIST_ENTRY(a) \\r
          CR (a, \\r
              FLOPPY_CONTROLLER_CONTEXT, \\r
              Link, \\r
              FLOPPY_CONTROLLER_CONTEXT_SIGNATURE \\r
              )\r
\r
#define DISK_1440K_EOT            0x12\r
#define DISK_1440K_GPL            0x1b\r
#define DISK_1440K_DTL            0xff\r
#define DISK_1440K_NUMBER         0x02\r
#define DISK_1440K_MAXTRACKNUM    0x4f\r
#define DISK_1440K_BYTEPERSECTOR  512\r
\r
typedef struct {\r
  UINT8 CommandCode;\r
  UINT8 DiskHeadSel;\r
  UINT8 Cylinder;\r
  UINT8 Head;\r
  UINT8 Sector;\r
  UINT8 Number;\r
  UINT8 EndOfTrack;\r
  UINT8 GapLength;\r
  UINT8 DataLength;\r
} FDD_COMMAND_PACKET1;\r
\r
typedef struct {\r
  UINT8 CommandCode;\r
  UINT8 DiskHeadSel;\r
} FDD_COMMAND_PACKET2;\r
\r
typedef struct {\r
  UINT8 CommandCode;\r
  UINT8 SrtHut;\r
  UINT8 HltNd;\r
} FDD_SPECIFY_CMD;\r
\r
typedef struct {\r
  UINT8 CommandCode;\r
  UINT8 DiskHeadSel;\r
  UINT8 NewCylinder;\r
} FDD_SEEK_CMD;\r
\r
typedef struct {\r
  UINT8 CommandCode;\r
  UINT8 DiskHeadSel;\r
  UINT8 Cylinder;\r
  UINT8 Head;\r
  UINT8 Sector;\r
  UINT8 EndOfTrack;\r
  UINT8 GapLength;\r
  UINT8 ScanTestPause;\r
} FDD_SCAN_CMD;\r
\r
typedef struct {\r
  UINT8 Status0;\r
  UINT8 Status1;\r
  UINT8 Status2;\r
  UINT8 Cylinder;\r
  UINT8 Head;\r
  UINT8 Sector;\r
  UINT8 Number;\r
} FDD_RESULT_PACKET;\r
\r
//\r
// FDC Registers\r
//\r
//\r
// Digital Output Register address offset\r
//\r
#define FDC_REGISTER_DOR  2\r
\r
//\r
// Main Status Register address offset\r
//\r
#define FDC_REGISTER_MSR  4\r
\r
//\r
// Data Register address offset\r
//\r
#define FDC_REGISTER_DTR  5\r
\r
//\r
// Configuration Control Register(data rate select) address offset\r
//\r
#define FDC_REGISTER_CCR  7\r
\r
//\r
// Digital Input Register(diskchange) address offset\r
//\r
#define FDC_REGISTER_DIR  7\r
\r
\r
//\r
// FDC Register Bit Definitions\r
//\r
//\r
// Digital Out Register(WO)\r
//\r
//\r
// Select Drive: 0=A 1=B\r
//\r
#define SELECT_DRV  BIT0\r
\r
//\r
// Reset FDC\r
//\r
#define RESET_FDC BIT2\r
\r
//\r
// Enable Int & DMA\r
//\r
#define INT_DMA_ENABLE  BIT3\r
\r
//\r
// Turn On Drive A Motor\r
//\r
#define DRVA_MOTOR_ON BIT4\r
\r
//\r
// Turn On Drive B Motor\r
//\r
#define DRVB_MOTOR_ON BIT5\r
\r
//\r
// Main Status Register(RO)\r
//\r
//\r
// Drive A Busy\r
//\r
#define MSR_DAB BIT0\r
\r
//\r
// Drive B Busy\r
//\r
#define MSR_DBB BIT1\r
\r
//\r
// FDC Busy\r
//\r
#define MSR_CB  BIT4\r
\r
//\r
// Non-DMA Mode\r
//\r
#define MSR_NDM BIT5\r
\r
//\r
// Data Input/Output\r
//\r
#define MSR_DIO BIT6\r
\r
//\r
// Request For Master\r
//\r
#define MSR_RQM BIT7\r
\r
//\r
// Configuration Control Register(WO)\r
//\r
//\r
// Data Rate select\r
//\r
#define CCR_DRC (BIT0 | BIT1)\r
\r
//\r
// Digital Input Register(RO)\r
//\r
//\r
// Disk change line\r
//\r
#define DIR_DCL BIT7\r
//\r
// #define CCR_DCL         BIT7      // Diskette change\r
//\r
// 500K\r
//\r
#define DRC_500KBS  0x0\r
\r
//\r
// 300K\r
//\r
#define DRC_300KBS  0x01\r
\r
//\r
// 250K\r
//\r
#define DRC_250KBS  0x02\r
\r
//\r
// FDC Command Code\r
//\r
#define READ_DATA_CMD         0x06\r
#define WRITE_DATA_CMD        0x05\r
#define WRITE_DEL_DATA_CMD    0x09\r
#define READ_DEL_DATA_CMD     0x0C\r
#define READ_TRACK_CMD        0x02\r
#define READ_ID_CMD           0x0A\r
#define FORMAT_TRACK_CMD      0x0D\r
#define SCAN_EQU_CMD          0x11\r
#define SCAN_LOW_EQU_CMD      0x19\r
#define SCAN_HIGH_EQU_CMD     0x1D\r
#define SEEK_CMD              0x0F\r
#define RECALIBRATE_CMD       0x07\r
#define SENSE_INT_STATUS_CMD  0x08\r
#define SPECIFY_CMD           0x03\r
#define SENSE_DRV_STATUS_CMD  0x04\r
\r
//\r
// CMD_MT: Multi_Track Selector\r
// when set , this flag selects the multi-track operating mode.\r
// In this mode, the FDC treats a complete cylinder under head0 and 1\r
// as a single track\r
//\r
#define CMD_MT  BIT7\r
\r
//\r
// CMD_MFM: MFM/FM Mode Selector\r
// A one selects the double density(MFM) mode\r
// A zero selects single density (FM) mode\r
//\r
#define CMD_MFM BIT6\r
\r
//\r
// CMD_SK: Skip Flag\r
// When set to 1, sectors containing a deleted data address mark will\r
// automatically be skipped during the execution of Read Data.\r
// When set to 0, the sector is read or written the same as the read and\r
// write commands.\r
//\r
#define CMD_SK  BIT5\r
\r
//\r
// FDC Status Register Bit Definitions\r
//\r
//\r
// Status Register 0\r
//\r
//\r
// Interrupt Code\r
//\r
#define STS0_IC (BIT7 | BIT6)\r
\r
//\r
// Seek End: the FDC completed a seek or recalibrate command\r
//\r
#define STS0_SE BIT5\r
\r
//\r
// Equipment Check\r
//\r
#define STS0_EC BIT4\r
\r
//\r
// Not Ready(unused), this bit is always 0\r
//\r
#define STS0_NR BIT3\r
\r
//\r
// Head Address: the current head address\r
//\r
#define STS0_HA BIT2\r
\r
//\r
// STS0_US1 & STS0_US0: Drive Select(the current selected drive)\r
//\r
//\r
// Unit Select1\r
//\r
#define STS0_US1  BIT1\r
\r
//\r
// Unit Select0\r
//\r
#define STS0_US0  BIT0\r
\r
//\r
// Status Register 1\r
//\r
//\r
// End of Cylinder\r
//\r
#define STS1_EN BIT7\r
\r
//\r
// BIT6 is unused\r
//\r
//\r
// Data Error: The FDC detected a CRC error in either the ID field or\r
// data field of a sector\r
//\r
#define STS1_DE BIT5\r
\r
//\r
// Overrun/Underrun: Becomes set if FDC does not receive CPU or DMA service\r
// within the required time interval\r
//\r
#define STS1_OR BIT4\r
\r
//\r
// BIT3 is unused\r
//\r
//\r
// No data\r
//\r
#define STS1_ND BIT2\r
\r
//\r
// Not Writable\r
//\r
#define STS1_NW BIT1\r
\r
//\r
// Missing Address Mark\r
//\r
#define STS1_MA BIT0\r
\r
//\r
// Control Mark\r
//\r
#define STS2_CM BIT6\r
\r
//\r
// Data Error in Data Field: The FDC detected a CRC error in the data field\r
//\r
#define STS2_DD BIT5\r
\r
//\r
// Wrong Cylinder: The track address from sector ID field is different from\r
// the track address maintained inside FDC\r
//\r
#define STS2_WC BIT4\r
\r
//\r
// Bad Cylinder\r
//\r
#define STS2_BC BIT1\r
\r
//\r
// Missing Address Mark in Data Field\r
//\r
#define STS2_MD BIT0\r
\r
//\r
// Write Protected\r
//\r
#define STS3_WP BIT6\r
\r
//\r
// Track 0\r
//\r
#define STS3_T0 BIT4\r
\r
//\r
// Head Address\r
//\r
#define STS3_HD BIT2\r
\r
//\r
// STS3_US1 & STS3_US0 : Drive Select\r
//\r
#define STS3_US1  BIT1\r
#define STS3_US0  BIT0\r
\r
//\r
// Status Register 0 Interrupt Code Description\r
//\r
//\r
// Normal Termination of Command\r
//\r
#define IC_NT 0x0\r
\r
//\r
// Abnormal Termination of Command\r
//\r
#define IC_AT 0x40\r
\r
//\r
// Invalid Command\r
//\r
#define IC_IC 0x80\r
\r
//\r
// Abnormal Termination caused by Polling\r
//\r
#define IC_ATRC 0xC0\r
\r
//\r
// EFI Driver Binding Protocol Functions\r
//\r
\r
/**\r
  Test controller is a floppy disk drive device\r
\r
  @param[in] This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in] Controller           The handle of the controller to test.\r
  @param[in] RemainingDevicePath  A pointer to the remaining portion of a device path.\r
\r
  @retval EFI_SUCCESS             The device is supported by this driver.\r
  @retval EFI_ALREADY_STARTED     The device is already being managed by this driver.\r
  @retval EFI_ACCESS_DENIED       The device is already being managed by a different driver\r
                                  or an application that requires exclusive access.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Start this driver on Controller.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.\r
                                   This parameter is ignored by device drivers, and is optional for bus drivers.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.\r
                                   Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  );\r
\r
//\r
// EFI Block I/O Protocol Functions\r
//\r
\r
/**\r
  Reset the Floppy Logic Drive, call the FddReset function.\r
\r
  @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
  @param ExtendedVerification BOOLEAN: Indicate that the driver may perform a more\r
                    exhaustive verification operation of the device during\r
                    reset, now this par is ignored in this driver\r
  @retval  EFI_SUCCESS:      The Floppy Logic Drive is reset\r
  @retval  EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly\r
                      and can not be reset\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FdcReset (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN BOOLEAN                ExtendedVerification\r
  );\r
\r
/**\r
  Flush block via fdd controller.\r
\r
  @param  This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
  @return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FddFlushBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This\r
  );\r
\r
/**\r
  Read the requested number of blocks from the device.\r
\r
  @param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
  @param MediaId UINT32:    The media id that the read request is for\r
  @param  Lba EFI_LBA:     The starting logic block address to read from on the device\r
  @param  BufferSize UINTN:  The size of the Buffer in bytes\r
  @param  Buffer VOID *:     A pointer to the destination buffer for the data\r
\r
  @retval  EFI_SUCCESS:     The data was read correctly from the device\r
  @retval  EFI_DEVICE_ERROR:The device reported an error while attempting to perform\r
                     the read operation\r
  @retval  EFI_NO_MEDIA:    There is no media in the device\r
  @retval  EFI_MEDIA_CHANGED:   The MediaId is not for the current media\r
  @retval  EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the\r
                         intrinsic block size of the device\r
  @retval  EFI_INVALID_PARAMETER:The read request contains LBAs that are not valid,\r
                          or the buffer is not on proper alignment\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FddReadBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN  UINT32                 MediaId,\r
  IN  EFI_LBA                Lba,\r
  IN  UINTN                  BufferSize,\r
  OUT VOID                   *Buffer\r
  );\r
\r
/**\r
  Write a specified number of blocks to the device.\r
\r
  @param  This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
  @param  MediaId UINT32:    The media id that the write request is for\r
  @param  Lba EFI_LBA:     The starting logic block address to be written\r
  @param  BufferSize UINTN:  The size in bytes in Buffer\r
  @param  Buffer VOID *:     A pointer to the source buffer for the data\r
\r
  @retval  EFI_SUCCESS:     The data were written correctly to the device\r
  @retval  EFI_WRITE_PROTECTED: The device can not be written to\r
  @retval  EFI_NO_MEDIA:    There is no media in the device\r
  @retval  EFI_MEDIA_CHANGED:   The MediaId is not for the current media\r
  @retval  EFI_DEVICE_ERROR:  The device reported an error while attempting to perform\r
                       the write operation\r
  @retval  EFI_BAD_BUFFER_SIZE: The BufferSize parameter is not a multiple of the\r
                         intrinsic block size of the device\r
  @retval  EFI_INVALID_PARAMETER:The write request contains LBAs that are not valid,\r
                          or the buffer is not on proper alignment\r
**/\r
EFI_STATUS\r
EFIAPI\r
FddWriteBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN UINT32                 MediaId,\r
  IN EFI_LBA                Lba,\r
  IN UINTN                  BufferSize,\r
  IN VOID                   *Buffer\r
  );\r
\r
//\r
// Prototypes of internal functions\r
//\r
/**\r
\r
  Detect the floppy drive is presented or not.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
  @retval EFI_SUCCESS    Drive is presented\r
  @retval EFI_NOT_FOUND  Drive is not presented\r
\r
**/\r
EFI_STATUS\r
DiscoverFddDevice (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
\r
  Do recalibrate  and see the drive is presented or not.\r
  Set the media parameters.\r
\r
  @param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
  @return the drive is presented or not\r
\r
**/\r
EFI_STATUS\r
FddIdentify (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
\r
  Reset the Floppy Logic Drive.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
\r
  @retval EFI_SUCCESS:    The Floppy Logic Drive is reset\r
  @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly and\r
                      can not be reset\r
\r
**/\r
EFI_STATUS\r
FddReset (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
\r
  Turn the drive's motor on.\r
  The drive's motor must be on before any command can be executed.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
\r
  @retval  EFI_SUCCESS:       Turn the drive's motor on successfully\r
  @retval  EFI_DEVICE_ERROR:    The drive is busy, so can not turn motor on\r
  @retval  EFI_INVALID_PARAMETER: Fail to Set timer(Cancel timer)\r
\r
**/\r
EFI_STATUS\r
MotorOn (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
\r
  Set a Timer and when Timer goes off, turn the motor off.\r
\r
\r
  @param  FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
\r
  @retval  EFI_SUCCESS:       Set the Timer successfully\r
  @retval  EFI_INVALID_PARAMETER: Fail to Set the timer\r
\r
**/\r
EFI_STATUS\r
MotorOff (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
  Detect the disk in the drive is changed or not.\r
\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
\r
  @retval  EFI_SUCCESS:    No disk media change\r
  @retval  EFI_DEVICE_ERROR: Fail to do the recalibrate or seek operation\r
  @retval  EFI_NO_MEDIA:   No disk in the drive\r
  @retval  EFI_MEDIA_CHANGED:  There is a new disk in the drive\r
**/\r
EFI_STATUS\r
DisketChanged (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
  Do the Specify command, this command sets DMA operation\r
  and the initial values for each of the three internal\r
  times: HUT, SRT and HLT.\r
\r
  @param FdcDev    Pointer to instance of FDC_BLK_IO_DEV\r
\r
  @retval  EFI_SUCCESS:    Execute the Specify command successfully\r
  @retval  EFI_DEVICE_ERROR: Fail to execute the command\r
\r
**/\r
EFI_STATUS\r
Specify (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
  Set the head of floppy drive to track 0.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @retval EFI_SUCCESS:    Execute the Recalibrate operation successfully\r
  @retval EFI_DEVICE_ERROR: Fail to execute the Recalibrate operation\r
\r
**/\r
EFI_STATUS\r
Recalibrate (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
  Set the head of floppy drive to the new cylinder.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param  Lba EFI_LBA     : The logic block address want to seek\r
\r
  @retval  EFI_SUCCESS:    Execute the Seek operation successfully\r
  @retval  EFI_DEVICE_ERROR: Fail to execute the Seek operation\r
\r
**/\r
EFI_STATUS\r
Seek (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN EFI_LBA         Lba\r
  );\r
\r
/**\r
  Do the Sense Interrupt Status command, this command resets the interrupt signal.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param  StatusRegister0 UINT8 *: Be used to save Status Register 0 read from FDC\r
  @param  PresentCylinderNumber  UINT8 *: Be used to save present cylinder number\r
                                    read from FDC\r
\r
  @retval  EFI_SUCCESS:    Execute the Sense Interrupt Status command successfully\r
  @retval  EFI_DEVICE_ERROR: Fail to execute the command\r
\r
**/\r
EFI_STATUS\r
SenseIntStatus (\r
  IN     FDC_BLK_IO_DEV  *FdcDev,\r
  IN OUT UINT8           *StatusRegister0,\r
  IN OUT UINT8           *PresentCylinderNumber\r
  );\r
\r
/**\r
  Do the Sense Drive Status command.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param  Lba EFI_LBA     : Logic block address\r
\r
  @retval  EFI_SUCCESS:    Execute the Sense Drive Status command successfully\r
  @retval  EFI_DEVICE_ERROR: Fail to execute the command\r
  @retval  EFI_WRITE_PROTECTED:The disk is write protected\r
\r
**/\r
EFI_STATUS\r
SenseDrvStatus (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN EFI_LBA         Lba\r
  );\r
\r
/**\r
  Update the disk media properties and if necessary reinstall Block I/O interface.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
\r
  @retval  EFI_SUCCESS:    Do the operation successfully\r
  @retval  EFI_DEVICE_ERROR: Fail to the operation\r
\r
**/\r
EFI_STATUS\r
DetectMedia (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
  Set the data rate and so on.\r
\r
  @param  FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
\r
  @retval EFI_SUCCESS success to set the data rate\r
**/\r
EFI_STATUS\r
Setup (\r
  IN FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
/**\r
  Read or Write a number of blocks in the same cylinder.\r
\r
  @param  FdcDev      A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param  HostAddress device address\r
  @param  Lba         The starting logic block address to read from on the device\r
  @param  NumberOfBlocks The number of block wanted to be read or write\r
  @param  Read        Operation type: read or write\r
\r
  @retval EFI_SUCCESS Success operate\r
\r
**/\r
EFI_STATUS\r
ReadWriteDataSector (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN VOID            *HostAddress,\r
  IN EFI_LBA         Lba,\r
  IN UINTN           NumberOfBlocks,\r
  IN BOOLEAN         Read\r
  );\r
\r
/**\r
  Fill in FDD command's parameter.\r
\r
  @param FdcDev   Pointer to instance of FDC_BLK_IO_DEV\r
  @param Lba      The starting logic block address to read from on the device\r
  @param Command  FDD command\r
\r
**/\r
VOID\r
FillPara (\r
  IN FDC_BLK_IO_DEV       *FdcDev,\r
  IN EFI_LBA              Lba,\r
  IN FDD_COMMAND_PACKET1  *Command\r
  );\r
\r
/**\r
  Read result byte from Data Register of FDC.\r
\r
  @param FdcDev   Pointer to instance of FDC_BLK_IO_DEV\r
  @param Pointer  Buffer to store the byte read from FDC\r
\r
  @retval EFI_SUCCESS       Read result byte from FDC successfully\r
  @retval EFI_DEVICE_ERROR  The FDC is not ready to be read\r
\r
**/\r
EFI_STATUS\r
DataInByte (\r
  IN  FDC_BLK_IO_DEV  *FdcDev,\r
  OUT UINT8           *Pointer\r
  );\r
\r
/**\r
  Write command byte to Data Register of FDC.\r
\r
  @param FdcDev  Pointer to instance of FDC_BLK_IO_DEV\r
  @param Pointer Be used to save command byte written to FDC\r
\r
  @retval  EFI_SUCCESS:    Write command byte to FDC successfully\r
  @retval  EFI_DEVICE_ERROR: The FDC is not ready to be written\r
\r
**/\r
EFI_STATUS\r
DataOutByte (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN UINT8           *Pointer\r
  );\r
\r
/**\r
  Detect the specified floppy logic drive is busy or not within a period of time.\r
\r
  @param FdcDev           Indicate it is drive A or drive B\r
  @param Timeout          The time period for waiting\r
\r
  @retval EFI_SUCCESS:  The drive and command are not busy\r
  @retval EFI_TIMEOUT:  The drive or command is still busy after a period time that\r
                        set by Timeout\r
\r
**/\r
EFI_STATUS\r
FddWaitForBSYClear (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN UINTN           Timeout\r
  );\r
\r
/**\r
  Determine whether FDC is ready to write or read.\r
\r
  @param  FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
  @param  Dio BOOLEAN:      Indicate the FDC is waiting to write or read\r
  @param  Timeout           The time period for waiting\r
\r
  @retval EFI_SUCCESS:  FDC is ready to write or read\r
  @retval EFI_NOT_READY:  FDC is not ready within the specified time period\r
\r
**/\r
EFI_STATUS\r
FddDRQReady (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN BOOLEAN         Dio,\r
  IN UINTN           Timeout\r
  );\r
\r
/**\r
  Set FDC control structure's attribute according to result.\r
\r
  @param Result  Point to result structure\r
  @param FdcDev  FDC control structure\r
\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
**/\r
EFI_STATUS\r
CheckResult (\r
  IN     FDD_RESULT_PACKET  *Result,\r
  IN OUT FDC_BLK_IO_DEV     *FdcDev\r
  );\r
\r
/**\r
  Check the drive status information.\r
\r
  @param StatusRegister3  the value of Status Register 3\r
\r
  @retval EFI_SUCCESS           The disk is not write protected\r
  @retval EFI_WRITE_PROTECTED:  The disk is write protected\r
\r
**/\r
EFI_STATUS\r
CheckStatus3 (\r
  IN UINT8 StatusRegister3\r
  );\r
\r
/**\r
  Calculate the number of block in the same cylinder according to Lba.\r
\r
  @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param Lba EFI_LBA:      The starting logic block address\r
  @param NumberOfBlocks UINTN: The number of blocks\r
\r
  @return The number of blocks in the same cylinder which the starting\r
        logic block address is Lba\r
\r
**/\r
UINTN\r
GetTransferBlockCount (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN EFI_LBA         Lba,\r
  IN UINTN           NumberOfBlocks\r
  );\r
\r
/**\r
  When the Timer(2s) off, turn the drive's motor off.\r
\r
  @param Event EFI_EVENT: Event(the timer) whose notification function is being\r
                     invoked\r
  @param Context VOID *:  Pointer to the notification function's context\r
\r
**/\r
VOID\r
EFIAPI\r
FddTimerProc (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
/**\r
  Read I/O port for FDC.\r
\r
  @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param Offset The offset address of port\r
\r
**/\r
UINT8\r
FdcReadPort (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN UINT32          Offset\r
  );\r
\r
/**\r
  Write I/O port for FDC.\r
\r
  @param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
  @param Offset The offset address of port\r
  @param Data   Value written to port\r
\r
**/\r
VOID\r
FdcWritePort (\r
  IN FDC_BLK_IO_DEV  *FdcDev,\r
  IN UINT32          Offset,\r
  IN UINT8           Data\r
  );\r
\r
/**\r
  Read or Write a number of blocks to floppy device.\r
\r
  @param This     Pointer to instance of EFI_BLOCK_IO_PROTOCOL\r
  @param MediaId  The media id of read/write request\r
  @param Lba      The starting logic block address to read from on the device\r
  @param BufferSize The size of the Buffer in bytes\r
  @param Operation   - GC_TODO: add argument description\r
  @param Buffer      - GC_TODO: add argument description\r
\r
  @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
  @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_NO_MEDIA - GC_TODO: Add description for return value\r
  @retval EFI_MEDIA_CHANGED - GC_TODO: Add description for return value\r
  @retval EFI_WRITE_PROTECTED - GC_TODO: Add description for return value\r
  @retval EFI_BAD_BUFFER_SIZE - GC_TODO: Add description for return value\r
  @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
  @retval EFI_INVALID_PARAMETER - GC_TODO: Add description for return value\r
  @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
  @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
\r
**/\r
EFI_STATUS\r
FddReadWriteBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN  UINT32                 MediaId,\r
  IN  EFI_LBA                Lba,\r
  IN  UINTN                  BufferSize,\r
  IN  BOOLEAN                Operation,\r
  OUT VOID                   *Buffer\r
  );\r
\r
/**\r
  Common interface for free cache.\r
\r
  @param FdcDev  Pointer of FDC_BLK_IO_DEV instance\r
\r
**/\r
VOID\r
FdcFreeCache (\r
  IN    FDC_BLK_IO_DEV  *FdcDev\r
  );\r
\r
#endif\r
\r