/** @file\r
Internal floppy disk controller programming functions for the 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
Detect whether a floppy drive is present or not.\r
- \r
+\r
@param[in] FdcDev A pointer to the FDC_BLK_IO_DEV\r
\r
@retval EFI_SUCCESS The floppy disk drive is present\r
/**\r
Do recalibrate and check if the drive is present or not\r
and set the media parameters if the driver is present.\r
- \r
+\r
@param[in] FdcDev A pointer to the FDC_BLK_IO_DEV\r
\r
@retval EFI_SUCCESS The floppy disk drive is present\r
\r
/**\r
Reset the Floppy Logic Drive.\r
- \r
+\r
@param FdcDev FDC_BLK_IO_DEV * : A pointer to the 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 floppy disk drive's motor on.\r
The drive's motor must be on before any command can be executed.\r
- \r
+\r
@param[in] FdcDev A pointer to the FDC_BLK_IO_DEV\r
- \r
+\r
@retval EFI_SUCCESS The drive's motor was turned on successfully\r
@retval EFI_DEVICE_ERROR The drive is busy, so can not turn motor on\r
**/\r
\r
/**\r
Set a Timer and when Timer goes off, turn the motor off.\r
- \r
+\r
@param[in] FdcDev A pointer to the 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 whether the disk in the drive is changed or not.\r
- \r
+\r
@param[in] FdcDev A pointer to 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[in] 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 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 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
Do the Sense Interrupt Status command, this command\r
resets the interrupt signal.\r
- \r
+\r
@param FdcDev FDC_BLK_IO_DEV *: A pointer to 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 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 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 A pointer to 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 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
/**\r
- Set FDC control structure's attribute according to result. \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
/**\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 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 an I/O port of FDC.\r
- \r
+\r
@param[in] FdcDev A pointer to FDC_BLK_IO_DEV.\r
@param[in] Offset The address offset of the I/O port.\r
\r
\r
/**\r
Write an I/O port of FDC.\r
- \r
+\r
@param[in] FdcDev A pointer to FDC_BLK_IO_DEV\r
@param[in] Offset The address offset of the I/O port\r
@param[in] Data 8-bit Value written to the I/O port\r
projects / mirror_edk2.git / blobdiff