/** @file\r
Include file for ISA Floppy Driver\r
- \r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
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
\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
+\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
+\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
+ @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
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
+ @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
+ @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
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
+ @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
+ @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
//\r
\r
/**\r
- Reset the Floppy Logic Drive, call the FddReset function. \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
+ @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
+ @retval EFI_DEVICE_ERROR: The Floppy Logic Drive is not functioning correctly\r
and can not be reset\r
\r
**/\r
\r
/**\r
Flush block via fdd controller.\r
- \r
+\r
@param This EFI_BLOCK_IO *: A pointer to the Block I/O protocol interface\r
@return EFI_SUCCESS\r
\r
);\r
\r
/**\r
- Read the requested number of blocks from the device. \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 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
+\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
+ @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
+ @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
);\r
\r
/**\r
- Write a specified number of blocks to the device. \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 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
+\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_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
+ @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
+ @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
/**\r
\r
Detect the floppy drive is presented or not.\r
- \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
Do recalibrate and see the drive is presented or not.\r
Set the media parameters.\r
- \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
\r
Reset the Floppy Logic Drive.\r
- \r
+\r
@param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- \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
Turn the drive's motor on.\r
The drive's motor must be on before any command can be executed.\r
- \r
+\r
@param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- \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
Set a Timer and when Timer goes off, turn the motor off.\r
- \r
- \r
+\r
+\r
@param FdcDev FDC_BLK_IO_DEV * : A pointer to the Data Structure FDC_BLK_IO_DEV\r
- \r
+\r
@retval EFI_SUCCESS: Set the Timer successfully\r
@retval EFI_INVALID_PARAMETER: Fail to Set the timer\r
\r
\r
/**\r
Detect the disk in the drive is changed or not.\r
- \r
- \r
+\r
+\r
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- \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
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
+\r
@param FdcDev Pointer to instance of FDC_BLK_IO_DEV\r
- \r
+\r
@retval EFI_SUCCESS: Execute the Specify command successfully\r
@retval EFI_DEVICE_ERROR: Fail to execute the command\r
\r
\r
/**\r
Set the head of floppy drive to track 0.\r
- \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
Set the head of floppy drive to the new cylinder.\r
- \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
+\r
@retval EFI_SUCCESS: Execute the Seek operation successfully\r
@retval EFI_DEVICE_ERROR: Fail to execute the Seek operation\r
\r
\r
/**\r
Do the Sense Interrupt Status command, this command resets the interrupt signal.\r
- \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
+\r
@retval EFI_SUCCESS: Execute the Sense Interrupt Status command successfully\r
@retval EFI_DEVICE_ERROR: Fail to execute the command\r
\r
\r
/**\r
Do the Sense Drive Status command.\r
- \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
+\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
Update the disk media properties and if necessary reinstall Block I/O interface.\r
- \r
+\r
@param FdcDev FDC_BLK_IO_DEV *: A pointer to Data Structure FDC_BLK_IO_DEV\r
- \r
+\r
@retval EFI_SUCCESS: Do the operation successfully\r
@retval EFI_DEVICE_ERROR: Fail to the operation\r
\r
\r
/**\r
Set the data rate and so on.\r
- \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
/**\r
Read or Write a number of blocks in the same cylinder.\r
- \r
+\r
@param FdcDev A pointer to Data Structure FDC_BLK_IO_DEV\r
- @param HostAddress device address \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
+\r
@retval EFI_SUCCESS Success operate\r
\r
**/\r
\r
/**\r
Fill in FDD command's parameter.\r
- \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
Read result byte from Data Register of FDC.\r
- \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
+\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
/**\r
Write command byte to Data Register of FDC.\r
- \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
+\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
/**\r
Detect the specified floppy logic drive is busy or not within a period of time.\r
- \r
+\r
@param FdcDev Indicate it is drive A or drive B\r
@param Timeout The time period for waiting\r
- \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
Determine whether FDC is ready to write or read.\r
- \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
+\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
/**\r
Check the drive status information.\r
- \r
+\r
@param StatusRegister3 the value of Status Register 3\r
- \r
+\r
@retval EFI_SUCCESS The disk is not write protected\r
@retval EFI_WRITE_PROTECTED: The disk is write protected\r
\r
\r
/**\r
Calculate the number of block in the same cylinder according to Lba.\r
- \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
+\r
@return The number of blocks in the same cylinder which the starting\r
logic block address is Lba\r
\r
\r
/**\r
When the Timer(2s) off, turn the drive's motor off.\r
- \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
Read I/O port for FDC.\r
- \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
/**\r
Write I/O port for FDC.\r
- \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
**/\r
VOID\r
FdcWritePort (\r
);\r
\r
/**\r
- Common interface for free cache. \r
- \r
+ Common interface for free cache.\r
+\r
@param FdcDev Pointer of FDC_BLK_IO_DEV instance\r
- \r
+\r
**/\r
VOID\r
FdcFreeCache (\r
projects / mirror_edk2.git / blobdiff