//\r
// EFI Driver Binding Protocol Functions\r
//\r
+/**\r
+ Test controller is a Floppy Disk Controller\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver's controller\r
+ @param RemainingDevicePath children device path\r
+ \r
+ @retval EFI_UNSUPPORTED controller is not floppy disk\r
+ @retval EFI_SUCCESS controller is floppy disk\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverSupported (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- Controller - GC_TODO: add argument description\r
- RemainingDevicePath - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Create floppy control instance on controller.\r
+ \r
+ @param This Pointer of EFI_DRIVER_BINDING_PROTOCOL\r
+ @param Controller driver controller handle\r
+ @param RemainingDevicePath Children's device path\r
+ \r
+ @retval whether success to create floppy control instance.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverStart (\r
IN EFI_HANDLE Controller,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- Controller - GC_TODO: add argument description\r
- RemainingDevicePath - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Stop this driver on ControllerHandle. Support stoping any child handles\r
+ created by this driver.\r
\r
- GC_TODO: add return values\r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to stop driver on\r
+ @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param ChildHandleBuffer List of Child Handles to Stop.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle\r
+ @retval other This driver was not removed from this device\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FdcControllerDriverStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- Controller - GC_TODO: add argument description\r
- NumberOfChildren - GC_TODO: add argument description\r
- ChildHandleBuffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
//\r
// EFI Block I/O Protocol Functions\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- ExtendedVerification - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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 UINTN BufferSize,\r
OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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 UINTN BufferSize,\r
IN VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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 This 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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Do the Sense Interrupt Status command, this command\r
+ resets the interrupt signal\r
+ \r
+ \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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- StatusRegister0 - GC_TODO: add argument description\r
- PresentCylinderNumber - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Update the disk media properties and if necessary\r
+ 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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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 UINTN NumberOfBlocks,\r
IN BOOLEAN Read\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- HostAddress - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
- NumberOfBlocks - GC_TODO: add argument description\r
- Read - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Lba - GC_TODO: add argument description\r
- Command - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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 UINT8 *: Be used to save result 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
EFI_STATUS\r
DataInByte (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT8 *Pointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Pointer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Pointer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Detect the specified floppy logic drive is busy or\r
+ not within a period of time\r
+ \r
+ @param Disk Indicate it is drive A or drive B\r
+ @param TimeoutInSeconds 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 TimeoutInSeconds\r
+\r
+**/\r
EFI_STATUS\r
FddWaitForBSYClear (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINTN TimeoutInSeconds\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- TimeoutInSeconds - GC_TODO: add argument description\r
-\r
-Returns:\r
+;\r
\r
- GC_TODO: add return values\r
+/**\r
\r
---*/\r
-;\r
+ Routine Description: 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 TimeoutInSeconds UINTN: 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 TimeoutInSeconds\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Dio - GC_TODO: add argument description\r
- TimeoutInSeconds - GC_TODO: add argument description\r
+;\r
\r
-Returns:\r
+/**\r
+ Set FDC control structure's attribute according to\r
+ result \r
\r
- GC_TODO: add return values\r
+ @param Result Point to result structure\r
+ @param FdcDev FDC control structure\r
\r
---*/\r
-;\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param EFI_DEVICE_ERROR - GC_TODO: Add description for return value\r
+ @param 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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Result - GC_TODO: add argument description\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- StatusRegister3 - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Calculate the number of block in the same cylinder\r
+ 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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- NumberOfBlocks - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- Event - GC_TODO: add argument description\r
- Context - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
- Offset - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\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
+\r
+**/\r
VOID\r
FdcWritePort (\r
IN FDC_BLK_IO_DEV *FdcDev,\r
IN UINT32 Offset,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
+;\r
\r
- FdcDev - GC_TODO: add argument description\r
- Offset - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
+/**\r
+ Read or Write a number of blocks to floppy device\r
\r
-Returns:\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
+ Buffer - GC_TODO: add argument description\r
\r
- GC_TODO: add return values\r
-\r
---*/\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 BOOLEAN Operation,\r
OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- This - GC_TODO: add argument description\r
- MediaId - GC_TODO: add argument description\r
- LBA - GC_TODO: add argument description\r
- BufferSize - GC_TODO: add argument description\r
- Operation - GC_TODO: add argument description\r
- Buffer - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
+/**\r
+ Common interface for free cache \r
+ \r
+ @param FdcDec Pointer of FDC_BLK_IO_DEV instance\r
+ \r
+**/\r
VOID\r
FdcFreeCache (\r
IN FDC_BLK_IO_DEV *FdcDev\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
;\r
\r
#endif\r
+\r
projects / mirror_edk2.git / blobdiff