]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
Function AtaEnableLongPhysicalSector () added for Long physical sector process.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / IdeBusDxe / Ide.h
index 9fd43f551a37f16a03c509d0c95056ca9ed08579..bb2a4a75c3f536fb95ea4b048a1b684227ad287c 100644 (file)
@@ -18,8 +18,8 @@
 \r
 **/\r
 \r
-#ifndef _IDE_H\r
-#define _IDE_H\r
+#ifndef _IDE_H_\r
+#define _IDE_H_\r
 \r
 //\r
 // Helper functions Prototype\r
@@ -31,7 +31,7 @@
   @param  Controller TODO: add argument description\r
   @param  Handle TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -49,7 +49,7 @@ DeRegisterIdeDevice (
   @param  ParentDevicePath TODO: add argument description\r
   @param  RemainingDevicePath TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -66,7 +66,7 @@ EnableIdeDevice (
   @param  PciIo TODO: add argument description\r
   @param  Port TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 UINT8\r
@@ -83,7 +83,7 @@ IDEReadPortB (
   @param  Count TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -101,7 +101,7 @@ IDEReadPortWMultiple (
   @param  Port TODO: add argument description\r
   @param  Data TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -118,7 +118,7 @@ IDEWritePortB (
   @param  Port TODO: add argument description\r
   @param  Data TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -136,7 +136,7 @@ IDEWritePortW (
   @param  Count TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -153,7 +153,7 @@ IDEWritePortWMultiple (
   @param  PciIo TODO: add argument description\r
   @param  IdeRegsBaseAddr TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -167,7 +167,7 @@ GetIdeRegistersBaseAddr (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -180,7 +180,7 @@ ReassignIdeResources (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -205,7 +205,7 @@ InitializeIDEChannelData (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -219,7 +219,7 @@ DetectIDEController (
   @param  IdeDev TODO: add argument description\r
   @param  TimeoutInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -234,7 +234,7 @@ DRQClear (
   @param  IdeDev TODO: add argument description\r
   @param  TimeoutInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -249,7 +249,7 @@ DRQClear2 (
   @param  IdeDev TODO: add argument description\r
   @param  TimeoutInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -264,7 +264,7 @@ DRQReady (
   @param  IdeDev TODO: add argument description\r
   @param  TimeoutInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -279,7 +279,7 @@ DRQReady2 (
   @param  IdeDev TODO: add argument description\r
   @param  TimeoutInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -294,7 +294,7 @@ WaitForBSYClear (
   @param  IdeDev TODO: add argument description\r
   @param  TimeoutInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -309,7 +309,7 @@ WaitForBSYClear2 (
   @param  IdeDev TODO: add argument description\r
   @param  DelayInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -324,7 +324,7 @@ DRDYReady (
   @param  IdeDev TODO: add argument description\r
   @param  DelayInMilliSeconds TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -340,7 +340,7 @@ DRDYReady2 (
   @param  Source TODO: add argument description\r
   @param  Size TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -358,7 +358,7 @@ SwapStringChars (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -371,7 +371,7 @@ ATAIdentify (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -392,7 +392,7 @@ PrintAtaModuleName (
   @param  CylinderLsb TODO: add argument description\r
   @param  CylinderMsb TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -421,7 +421,7 @@ AtaPioDataIn (
   @param  CylinderLsb TODO: add argument description\r
   @param  CylinderMsb TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -442,7 +442,7 @@ AtaPioDataOut (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -458,7 +458,7 @@ CheckErrorStatus (
   @param  Lba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -477,7 +477,7 @@ AtaReadSectors (
   @param  Lba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -493,7 +493,7 @@ AtaWriteSectors (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -510,7 +510,7 @@ AtaSoftReset (
   @param  BufferSize TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -531,7 +531,7 @@ AtaBlkIoReadBlocks (
   @param  BufferSize TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -551,7 +551,7 @@ AtaBlkIoWriteBlocks (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -564,7 +564,7 @@ ATAPIIdentify (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -581,7 +581,7 @@ AtapiInquiry (
   @param  ByteCount TODO: add argument description\r
   @param  TimeOut TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -602,7 +602,7 @@ AtapiPacketCommandIn (
   @param  ByteCount TODO: add argument description\r
   @param  TimeOut TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -623,7 +623,7 @@ AtapiPacketCommandOut (
   @param  Read TODO: add argument description\r
   @param  TimeOut TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -638,10 +638,10 @@ PioReadWriteData (
 /**\r
   TODO: Add function description\r
 \r
-  @param  IdeDev TODO: add argument description\r
-  @param  IdeDev TODO: add argument description\r
+  @param  IdeDev  TODO: add argument description\r
+  @param  SResult TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -656,7 +656,7 @@ AtapiTestUnitReady (
   @param  IdeDev TODO: add argument description\r
   @param  SenseCounts TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -668,10 +668,10 @@ AtapiRequestSense (
 /**\r
   TODO: Add function description\r
 \r
-  @param  IdeDev TODO: add argument description\r
-  @param  IdeDev TODO: add argument description\r
+  @param  IdeDev  TODO: add argument description\r
+  @param  SResult TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -686,7 +686,7 @@ AtapiReadCapacity (
   @param  IdeDev TODO: add argument description\r
   @param  MediaChange TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -703,7 +703,7 @@ AtapiDetectMedia (
   @param  Lba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -722,7 +722,7 @@ AtapiReadSectors (
   @param  Lba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -738,7 +738,7 @@ AtapiWriteSectors (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -755,7 +755,7 @@ AtapiSoftReset (
   @param  BufferSize TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -776,7 +776,7 @@ AtapiBlkIoReadBlocks (
   @param  BufferSize TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -795,7 +795,7 @@ AtapiBlkIoWriteBlocks (
   @param  SenseCount TODO: add argument description\r
   @param  Result TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -810,7 +810,7 @@ ParseSenseData (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -824,7 +824,7 @@ AtapiReadPendingData (
   @param  IdeDev TODO: add argument description\r
   @param  WriteProtected TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -838,7 +838,7 @@ IsLS120orZipWriteProtected (
 \r
   @param  IdeBlkIoDevice TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -852,7 +852,7 @@ ReleaseIdeResources (
   @param  IdeDev TODO: add argument description\r
   @param  TransferMode TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -867,7 +867,7 @@ SetDeviceTransferMode (
   @param  IdeDev TODO: add argument description\r
   @param  NativeMaxAddress TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -883,7 +883,7 @@ ReadNativeMaxAddress (
   @param  MaxAddress TODO: add argument description\r
   @param  bVolatile TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -905,7 +905,7 @@ SetMaxAddress (
   @param  LbaMiddle TODO: add argument description\r
   @param  LbaHigh TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -930,7 +930,7 @@ AtaNonDataCommandIn (
   @param  SectorCount TODO: add argument description\r
   @param  LbaAddress TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -951,7 +951,7 @@ AtaNonDataCommandInExt (
   @param  StartLba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -970,7 +970,7 @@ AtaReadSectorsExt (
   @param  StartLba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -989,7 +989,7 @@ AtaWriteSectorsExt (
   @param  StartLba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1008,7 +1008,7 @@ AtaUdmaReadExt (
   @param  StartLba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1027,7 +1027,7 @@ AtaUdmaRead (
   @param  StartLba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1081,7 +1081,7 @@ DoAtaUdma (
   @param  StartLba TODO: add argument description\r
   @param  NumberOfBlocks TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1102,7 +1102,7 @@ AtaUdmaWrite (
   @param  SectorCount TODO: add argument description\r
   @param  LbaAddress TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1125,7 +1125,7 @@ AtaCommandIssueExt (
   @param  SectorCount TODO: add argument description\r
   @param  LbaAddress TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1143,7 +1143,7 @@ AtaCommandIssue (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1157,7 +1157,7 @@ AtaAtapi6Identify (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 VOID\r
@@ -1165,6 +1165,22 @@ AtaSMARTSupport (
   IN  IDE_BLK_IO_DEV  *IdeDev\r
   );\r
 \r
+\r
+/**\r
+  Enable Long Physical Sector Feature for ATA device.\r
+\r
+  @param   IdeDev  The IDE device data\r
+\r
+  @retval  EFI_SUCCESS      The ATA device supports Long Physical Sector feature\r
+                            and corresponding fields in BlockIo structure is updated.\r
+  @retval  EFI_UNSUPPORTED  The device is not ATA device or Long Physical Sector\r
+                            feature is not supported.\r
+**/\r
+EFI_STATUS\r
+AtaEnableLongPhysicalSector (\r
+  IN  IDE_BLK_IO_DEV  *IdeDev\r
+  );\r
+\r
 /**\r
   TODO: Add function description\r
 \r
@@ -1175,7 +1191,7 @@ AtaSMARTSupport (
   @param  StartLba TODO: add argument description\r
   @param  SectorCount TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1198,7 +1214,7 @@ AtaPioDataInExt (
   @param  StartLba TODO: add argument description\r
   @param  SectorCount TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1217,7 +1233,7 @@ AtaPioDataOutExt (
   @param  IdeDev TODO: add argument description\r
   @param  DriveParameters TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1231,7 +1247,7 @@ SetDriveParameters (
 \r
   @param  IdeDev TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1242,10 +1258,8 @@ EnableInterrupt (
 /**\r
   Clear pending IDE interrupt before OS loader/kernel take control of the IDE device.\r
 \r
-  @param[in]  Event   Pointer to this event\r
-  @param[in]  Context Event hanlder private data\r
-\r
-  @retval  EFI_SUCCESS - Interrupt cleared\r
+  @param[in]  Event   Pointer to this event.\r
+  @param[in]  Context Event hanlder private data.\r
 \r
 **/\r
 VOID\r