X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=EdkModulePkg%2FBus%2FPci%2FIdeBus%2FDxe%2Fide.h;h=177e842714b6f24b196818aec97c7dd0481d5b96;hp=4c43ab94cd6c85424f5f070976a9ae3ec3c82e32;hb=c757cb321ce138fdb499dcb40770e341b9afb136;hpb=878ddf1fc3540a715f63594ed22b6929e881afb4 diff --git a/EdkModulePkg/Bus/Pci/IdeBus/Dxe/ide.h b/EdkModulePkg/Bus/Pci/IdeBus/Dxe/ide.h index 4c43ab94cd..177e842714 100644 --- a/EdkModulePkg/Bus/Pci/IdeBus/Dxe/ide.h +++ b/EdkModulePkg/Bus/Pci/IdeBus/Dxe/ide.h @@ -1,62 +1,58 @@ -/*++ -Copyright (c) 2006, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +/** @file + Header file for IDE Bus Driver, containing the helper functions' + entire prototype. -Module Name: + Copyright (c) 2006, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - ide.h + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Abstract: + @par Revision Reference: + 2002-6: Add Atapi6 enhancement, support >120GB hard disk, including + Add - IDEBlkIoReadBlocksExt() func definition + Add - IDEBlkIoWriteBlocksExt() func definition - Header file for IDE Bus Driver, containing the helper functions' - entire prototype. +**/ -Revision History - - 2002-6: Add Atapi6 enhancement, support >120GB hard disk, including - Add - IDEBlkIoReadBlocksExt() func definition - Add - IDEBlkIoWriteBlocksExt() func definition - -++*/ - -// TODO: fix comment to end with --*/ #ifndef _IDE_H #define _IDE_H // // Helper functions Prototype // +/** + TODO: Add function description + + @param This TODO: add argument description + @param Controller TODO: add argument description + @param Handle TODO: add argument description + + TODO: add return values + +**/ EFI_STATUS DeRegisterIdeDevice ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_HANDLE Handle ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - This - TODO: add argument description - Controller - TODO: add argument description - Handle - TODO: add argument description - -Returns: + @param Controller TODO: add argument description + @param PciIo TODO: add argument description + @param ParentDevicePath TODO: add argument description + @param RemainingDevicePath TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS EnableIdeDevice ( IN EFI_HANDLE Controller, @@ -64,49 +60,35 @@ EnableIdeDevice ( IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - Controller - TODO: add argument description - PciIo - TODO: add argument description - ParentDevicePath - TODO: add argument description - RemainingDevicePath - TODO: add argument description - -Returns: + @param PciIo TODO: add argument description + @param Port TODO: add argument description TODO: add return values ---*/ -; - +**/ UINT8 IDEReadPortB ( IN EFI_PCI_IO_PROTOCOL *PciIo, IN UINT16 Port ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - PciIo - TODO: add argument description - Port - TODO: add argument description - -Returns: + @param PciIo TODO: add argument description + @param Port TODO: add argument description + @param Count TODO: add argument description + @param Buffer TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID IDEReadPortWMultiple ( IN EFI_PCI_IO_PROTOCOL *PciIo, @@ -114,76 +96,55 @@ IDEReadPortWMultiple ( IN UINTN Count, OUT VOID *Buffer ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - PciIo - TODO: add argument description - Port - TODO: add argument description - Count - TODO: add argument description - Buffer - TODO: add argument description - -Returns: + @param PciIo TODO: add argument description + @param Port TODO: add argument description + @param Data TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID IDEWritePortB ( IN EFI_PCI_IO_PROTOCOL *PciIo, IN UINT16 Port, IN UINT8 Data ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - PciIo - TODO: add argument description - Port - TODO: add argument description - Data - TODO: add argument description - -Returns: + @param PciIo TODO: add argument description + @param Port TODO: add argument description + @param Data TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID IDEWritePortW ( IN EFI_PCI_IO_PROTOCOL *PciIo, IN UINT16 Port, IN UINT16 Data ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - PciIo - TODO: add argument description - Port - TODO: add argument description - Data - TODO: add argument description - -Returns: + @param PciIo TODO: add argument description + @param Port TODO: add argument description + @param Count TODO: add argument description + @param Buffer TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID IDEWritePortWMultiple ( IN EFI_PCI_IO_PROTOCOL *PciIo, @@ -191,366 +152,259 @@ IDEWritePortWMultiple ( IN UINTN Count, IN VOID *Buffer ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - PciIo - TODO: add argument description - Port - TODO: add argument description - Count - TODO: add argument description - Buffer - TODO: add argument description - -Returns: + @param PciIo TODO: add argument description + @param IdeRegsBaseAddr TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS GetIdeRegistersBaseAddr ( IN EFI_PCI_IO_PROTOCOL *PciIo, OUT IDE_REGISTERS_BASE_ADDR *IdeRegsBaseAddr ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - PciIo - TODO: add argument description - IdeRegsBaseAddr - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS ReassignIdeResources ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DiscoverIdeDevice ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DetectIDEController ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TimeoutInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DRQClear ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN TimeoutInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TimeoutInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TimeoutInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DRQClear2 ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN TimeoutInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TimeoutInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TimeoutInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DRQReady ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN TimeoutInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TimeoutInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TimeoutInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DRQReady2 ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN TimeoutInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TimeoutInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TimeoutInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS WaitForBSYClear ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN TimeoutInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TimeoutInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TimeoutInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS WaitForBSYClear2 ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN TimeoutInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TimeoutInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DelayInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DRDYReady ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN DelayInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DelayInMilliSeconds - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DelayInMilliSeconds TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS DRDYReady2 ( IN IDE_BLK_IO_DEV *IdeDev, IN UINTN DelayInMilliSeconds ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DelayInMilliSeconds - TODO: add argument description - -Returns: + @param Destination TODO: add argument description + @param Source TODO: add argument description + @param Size TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID SwapStringChars ( IN CHAR8 *Destination, IN CHAR8 *Source, IN UINT32 Size ) -/*++ - -Routine Description: +; +// +// ATA device functions' prototype +// +/** TODO: Add function description -Arguments: - - Destination - TODO: add argument description - Source - TODO: add argument description - Size - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - -// -// ATA device functions' prototype -// +**/ EFI_STATUS ATAIdentify ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID PrintAtaModuleName ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param AtaCommand TODO: add argument description + @param Head TODO: add argument description + @param SectorCount TODO: add argument description + @param SectorNumber TODO: add argument description + @param CylinderLsb TODO: add argument description + @param CylinderMsb TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaPioDataIn ( IN IDE_BLK_IO_DEV *IdeDev, @@ -563,31 +417,24 @@ AtaPioDataIn ( IN UINT8 CylinderLsb, IN UINT8 CylinderMsb ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - AtaCommand - TODO: add argument description - Head - TODO: add argument description - SectorCount - TODO: add argument description - SectorNumber - TODO: add argument description - CylinderLsb - TODO: add argument description - CylinderMsb - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param AtaCommand TODO: add argument description + @param Head TODO: add argument description + @param SectorCount TODO: add argument description + @param SectorNumber TODO: add argument description + @param CylinderLsb TODO: add argument description + @param CylinderMsb TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaPioDataOut ( IN IDE_BLK_IO_DEV *IdeDev, @@ -600,52 +447,33 @@ AtaPioDataOut ( IN UINT8 CylinderLsb, IN UINT8 CylinderMsb ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - AtaCommand - TODO: add argument description - Head - TODO: add argument description - SectorCount - TODO: add argument description - SectorNumber - TODO: add argument description - CylinderLsb - TODO: add argument description - CylinderMsb - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS CheckErrorStatus ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param Lba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaReadSectors ( IN IDE_BLK_IO_DEV *IdeDev, @@ -653,26 +481,19 @@ AtaReadSectors ( IN EFI_LBA Lba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - Lba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param BufferData TODO: add argument description + @param Lba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaWriteSectors ( IN IDE_BLK_IO_DEV *IdeDev, @@ -680,47 +501,34 @@ AtaWriteSectors ( IN EFI_LBA Lba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - BufferData - TODO: add argument description - Lba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaSoftReset ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeBlkIoDevice TODO: add argument description + @param MediaId TODO: add argument description + @param LBA TODO: add argument description + @param BufferSize TODO: add argument description + @param Buffer TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaBlkIoReadBlocks ( IN IDE_BLK_IO_DEV *IdeBlkIoDevice, @@ -729,27 +537,20 @@ AtaBlkIoReadBlocks ( IN UINTN BufferSize, OUT VOID *Buffer ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeBlkIoDevice - TODO: add argument description - MediaId - TODO: add argument description - LBA - TODO: add argument description - BufferSize - TODO: add argument description - Buffer - TODO: add argument description - -Returns: + @param IdeBlkIoDevice TODO: add argument description + @param MediaId TODO: add argument description + @param LBA TODO: add argument description + @param BufferSize TODO: add argument description + @param Buffer TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaBlkIoWriteBlocks ( IN IDE_BLK_IO_DEV *IdeBlkIoDevice, @@ -758,72 +559,51 @@ AtaBlkIoWriteBlocks ( IN UINTN BufferSize, OUT VOID *Buffer ) -/*++ - -Routine Description: +; +// +// ATAPI device functions' prototype +// +/** TODO: Add function description -Arguments: - - IdeBlkIoDevice - TODO: add argument description - MediaId - TODO: add argument description - LBA - TODO: add argument description - BufferSize - TODO: add argument description - Buffer - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - -// -// ATAPI device functions' prototype -// +**/ EFI_STATUS ATAPIIdentify ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiInquiry ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Packet TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param TimeOut TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiPacketCommandIn ( IN IDE_BLK_IO_DEV *IdeDev, @@ -832,27 +612,20 @@ AtapiPacketCommandIn ( IN UINT32 ByteCount, IN UINTN TimeOut ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Packet - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - TimeOut - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Packet TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param TimeOut TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiPacketCommandOut ( IN IDE_BLK_IO_DEV *IdeDev, @@ -861,27 +634,20 @@ AtapiPacketCommandOut ( IN UINT32 ByteCount, IN UINTN TimeOut ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Packet - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - TimeOut - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param Read TODO: add argument description + @param TimeOut TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS PioReadWriteData ( IN IDE_BLK_IO_DEV *IdeDev, @@ -890,115 +656,79 @@ PioReadWriteData ( IN BOOLEAN Read, IN UINTN TimeOut ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - Read - TODO: add argument description - TimeOut - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiTestUnitReady ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param SenseCounts TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiRequestSense ( IN IDE_BLK_IO_DEV *IdeDev, OUT UINTN *SenseCounts ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - SenseCounts - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiReadCapacity ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param MediaChange TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiDetectMedia ( IN IDE_BLK_IO_DEV *IdeDev, OUT BOOLEAN *MediaChange ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - MediaChange - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param Lba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiReadSectors ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1006,26 +736,19 @@ AtapiReadSectors ( IN EFI_LBA Lba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - Lba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param Lba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiWriteSectors ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1033,47 +756,34 @@ AtapiWriteSectors ( IN EFI_LBA Lba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - Lba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiSoftReset ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeBlkIoDevice TODO: add argument description + @param MediaId TODO: add argument description + @param LBA TODO: add argument description + @param BufferSize TODO: add argument description + @param Buffer TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiBlkIoReadBlocks ( IN IDE_BLK_IO_DEV *IdeBlkIoDevice, @@ -1082,27 +792,20 @@ AtapiBlkIoReadBlocks ( IN UINTN BufferSize, OUT VOID *Buffer ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeBlkIoDevice - TODO: add argument description - MediaId - TODO: add argument description - LBA - TODO: add argument description - BufferSize - TODO: add argument description - Buffer - TODO: add argument description - -Returns: + @param IdeBlkIoDevice TODO: add argument description + @param MediaId TODO: add argument description + @param LBA TODO: add argument description + @param BufferSize TODO: add argument description + @param Buffer TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtapiBlkIoWriteBlocks ( IN IDE_BLK_IO_DEV *IdeBlkIoDevice, @@ -1111,259 +814,185 @@ AtapiBlkIoWriteBlocks ( IN UINTN BufferSize, OUT VOID *Buffer ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeBlkIoDevice - TODO: add argument description - MediaId - TODO: add argument description - LBA - TODO: add argument description - BufferSize - TODO: add argument description - Buffer - TODO: add argument description - -Returns: + @param SenseData TODO: add argument description + @param SenseCounts TODO: add argument description TODO: add return values ---*/ -; - +**/ BOOLEAN IsNoMedia ( IN REQUEST_SENSE_DATA *SenseData, IN UINTN SenseCounts ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - SenseData - TODO: add argument description - SenseCounts - TODO: add argument description - -Returns: + @param SenseData TODO: add argument description + @param SenseCounts TODO: add argument description TODO: add return values ---*/ -; - +**/ BOOLEAN IsMediaError ( IN REQUEST_SENSE_DATA *SenseData, IN UINTN SenseCounts ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - SenseData - TODO: add argument description - SenseCounts - TODO: add argument description - -Returns: + @param SenseData TODO: add argument description + @param SenseCounts TODO: add argument description TODO: add return values ---*/ -; - +**/ BOOLEAN IsMediaChange ( IN REQUEST_SENSE_DATA *SenseData, IN UINTN SenseCounts ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - SenseData - TODO: add argument description - SenseCounts - TODO: add argument description - -Returns: + @param SenseData TODO: add argument description + @param SenseCounts TODO: add argument description + @param NeedRetry TODO: add argument description TODO: add return values ---*/ -; - +**/ BOOLEAN IsDriveReady ( IN REQUEST_SENSE_DATA *SenseData, IN UINTN SenseCounts, OUT BOOLEAN *NeedRetry ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - SenseData - TODO: add argument description - SenseCounts - TODO: add argument description - NeedRetry - TODO: add argument description - -Returns: + @param SenseData TODO: add argument description + @param SenseCounts TODO: add argument description TODO: add return values ---*/ -; - +**/ BOOLEAN HaveSenseKey ( IN REQUEST_SENSE_DATA *SenseData, IN UINTN SenseCounts ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - SenseData - TODO: add argument description - SenseCounts - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param WriteProtected TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS IsLS120orZipWriteProtected ( IN IDE_BLK_IO_DEV *IdeDev, OUT BOOLEAN *WriteProtected ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - WriteProtected - TODO: add argument description - -Returns: + @param IdeBlkIoDevice TODO: add argument description TODO: add return values ---*/ -; - +**/ VOID ReleaseIdeResources ( IN IDE_BLK_IO_DEV *IdeBlkIoDevice ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeBlkIoDevice - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param TransferMode TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS SetDeviceTransferMode ( IN IDE_BLK_IO_DEV *IdeDev, IN ATA_TRANSFER_MODE *TransferMode ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - TransferMode - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param NativeMaxAddress TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS ReadNativeMaxAddress ( IN IDE_BLK_IO_DEV *IdeDev, OUT EFI_LBA *NativeMaxAddress ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - NativeMaxAddress - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param MaxAddress TODO: add argument description + @param bVolatile TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS SetMaxAddress ( IN IDE_BLK_IO_DEV *IdeDev, IN EFI_LBA MaxAddress, IN BOOLEAN bVolatile ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - MaxAddress - TODO: add argument description - bVolatile - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param AtaCommand TODO: add argument description + @param Device TODO: add argument description + @param Feature TODO: add argument description + @param SectorCount TODO: add argument description + @param LbaLow TODO: add argument description + @param LbaMiddle TODO: add argument description + @param LbaHigh TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaNonDataCommandIn ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1375,30 +1004,21 @@ AtaNonDataCommandIn ( IN UINT8 LbaMiddle, IN UINT8 LbaHigh ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - AtaCommand - TODO: add argument description - Device - TODO: add argument description - Feature - TODO: add argument description - SectorCount - TODO: add argument description - LbaLow - TODO: add argument description - LbaMiddle - TODO: add argument description - LbaHigh - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param AtaCommand TODO: add argument description + @param Device TODO: add argument description + @param Feature TODO: add argument description + @param SectorCount TODO: add argument description + @param LbaAddress TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaNonDataCommandInExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1408,28 +1028,19 @@ AtaNonDataCommandInExt ( IN UINT16 SectorCount, IN EFI_LBA LbaAddress ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - AtaCommand - TODO: add argument description - Device - TODO: add argument description - Feature - TODO: add argument description - SectorCount - TODO: add argument description - LbaAddress - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param StartLba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaReadSectorsExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1437,26 +1048,19 @@ AtaReadSectorsExt ( IN EFI_LBA StartLba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - StartLba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param StartLba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaWriteSectorsExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1464,26 +1068,19 @@ AtaWriteSectorsExt ( IN EFI_LBA StartLba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - StartLba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param StartLba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaUdmaReadExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1491,26 +1088,19 @@ AtaUdmaReadExt ( IN EFI_LBA StartLba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - StartLba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param StartLba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaUdmaRead ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1518,26 +1108,19 @@ AtaUdmaRead ( IN EFI_LBA StartLba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - StartLba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param StartLba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaUdmaWriteExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1545,26 +1128,19 @@ AtaUdmaWriteExt ( IN EFI_LBA StartLba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - StartLba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DataBuffer TODO: add argument description + @param StartLba TODO: add argument description + @param NumberOfBlocks TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaUdmaWrite ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1572,26 +1148,21 @@ AtaUdmaWrite ( IN EFI_LBA StartLba, IN UINTN NumberOfBlocks ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DataBuffer - TODO: add argument description - StartLba - TODO: add argument description - NumberOfBlocks - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param AtaCommand TODO: add argument description + @param Device TODO: add argument description + @param Feature TODO: add argument description + @param SectorCount TODO: add argument description + @param LbaAddress TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaCommandIssueExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1601,28 +1172,21 @@ AtaCommandIssueExt ( IN UINT16 SectorCount, IN EFI_LBA LbaAddress ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - AtaCommand - TODO: add argument description - Device - TODO: add argument description - Feature - TODO: add argument description - SectorCount - TODO: add argument description - LbaAddress - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param AtaCommand TODO: add argument description + @param Device TODO: add argument description + @param Feature TODO: add argument description + @param SectorCount TODO: add argument description + @param LbaAddress TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaCommandIssue ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1632,71 +1196,50 @@ AtaCommandIssue ( IN UINT16 SectorCount, IN EFI_LBA LbaAddress ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - AtaCommand - TODO: add argument description - Device - TODO: add argument description - Feature - TODO: add argument description - SectorCount - TODO: add argument description - LbaAddress - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaAtapi6Identify ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ +; -Routine Description: +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - - +**/ VOID AtaSMARTSupport ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param AtaCommand TODO: add argument description + @param StartLba TODO: add argument description + @param SectorCount TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaPioDataInExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1706,28 +1249,21 @@ AtaPioDataInExt ( IN EFI_LBA StartLba, IN UINT16 SectorCount ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - AtaCommand - TODO: add argument description - StartLba - TODO: add argument description - SectorCount - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param Buffer TODO: add argument description + @param ByteCount TODO: add argument description + @param AtaCommand TODO: add argument description + @param StartLba TODO: add argument description + @param SectorCount TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS AtaPioDataOutExt ( IN IDE_BLK_IO_DEV *IdeDev, @@ -1737,70 +1273,36 @@ AtaPioDataOutExt ( IN EFI_LBA StartLba, IN UINT16 SectorCount ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - Buffer - TODO: add argument description - ByteCount - TODO: add argument description - AtaCommand - TODO: add argument description - StartLba - TODO: add argument description - SectorCount - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description + @param DriveParameters TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS SetDriveParameters ( IN IDE_BLK_IO_DEV *IdeDev, IN ATA_DRIVE_PARMS *DriveParameters ) -/*++ - -Routine Description: +; +/** TODO: Add function description -Arguments: - - IdeDev - TODO: add argument description - DriveParameters - TODO: add argument description - -Returns: + @param IdeDev TODO: add argument description TODO: add return values ---*/ -; - +**/ EFI_STATUS EnableInterrupt ( IN IDE_BLK_IO_DEV *IdeDev ) -/*++ - -Routine Description: - - TODO: Add function description - -Arguments: - - IdeDev - TODO: add argument description - -Returns: - - TODO: add return values - ---*/ ; #endif