]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/LegacyBios.h
Remove BugBug in comments and adjust function header according to code style doc.
[mirror_edk2.git] / MdePkg / Include / Protocol / LegacyBios.h
index aa94cfb74fa2f0b77372c930e322bf35a3059f59..c508009b9b89cacbd21fde5933e7ec28eeb7474d 100644 (file)
@@ -343,14 +343,14 @@ typedef struct {
   of BiosInt. Regs will contain the 16-bit register context on entry and \r
   exit.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  BiosInt Processor interrupt vector to invoke\r
-  @param  Reg Register contexted passed into (and returned) from thunk to\r
-  16-bit mode\r
+  @param  This                  Protocol instance pointer.\r
+  @param  BiosInt               Processor interrupt vector to invoke\r
+  @param  Reg                   Register contexted passed into (and returned) from thunk to\r
+                                16-bit mode\r
 \r
-  @retval  FALSE Thunk completed, and there were no BIOS errors in the target code.\r
-  See Regs for status.\r
-  @retval  TRUE There was a BIOS erro in the target code.\r
+  @retval FALSE                 Thunk completed, and there were no BIOS errors in the target code.\r
+                                See Regs for status.\r
+  @retval TRUE                  There was a BIOS erro in the target code.\r
 \r
 **/\r
 typedef\r
@@ -367,17 +367,17 @@ BOOLEAN
   16-bit register context on entry and exit. Arguments can be passed on \r
   the Stack argument\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Segment Segemnt of 16-bit mode call\r
-  @param  Offset Offset of 16-bit mdoe call\r
-  @param  Reg Register contexted passed into (and returned) from thunk to\r
-  16-bit mode\r
-  @param  Stack Caller allocated stack used to pass arguments\r
-  @param  StackSize Size of Stack in bytes\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Segment               Segemnt of 16-bit mode call\r
+  @param  Offset                Offset of 16-bit mdoe call\r
+  @param  Reg                   Register contexted passed into (and returned) from thunk to\r
+                                16-bit mode\r
+  @param  Stack                 Caller allocated stack used to pass arguments\r
+  @param  StackSize             Size of Stack in bytes\r
 \r
-  @retval  FALSE Thunk completed, and there were no BIOS errors in the target code.\r
-  See Regs for status.\r
-  @retval  TRUE There was a BIOS erro in the target code.\r
+  @retval FALSE                 Thunk completed, and there were no BIOS errors in the target code.\r
+                                See Regs for status.\r
+  @retval TRUE                  There was a BIOS erro in the target code.\r
 \r
 **/\r
 typedef\r
@@ -405,14 +405,14 @@ EFI_STATUS
   Test to see if a legacy PCI ROM exists for this device. Optionally return\r
   the Legacy ROM instance for this PCI device.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
-  @param  RomImage Return the legacy PCI ROM for this device\r
-  @param  RomSize Size of ROM Image\r
-  @param  Flags Indicates if ROM found and if PC-AT.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PciHandle             The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
+  @param  RomImage              Return the legacy PCI ROM for this device\r
+  @param  RomSize               Size of ROM Image\r
+  @param  Flags                 Indicates if ROM found and if PC-AT.\r
 \r
-  @retval  EFI_SUCCESS Legacy Option ROM availible for this device\r
-  @retval  EFI_UNSUPPORTED Legacy Option ROM not supported.\r
+  @retval EFI_SUCCESS           Legacy Option ROM availible for this device\r
+  @retval EFI_UNSUPPORTED       Legacy Option ROM not supported.\r
 \r
 **/\r
   )\r
@@ -423,23 +423,23 @@ EFI_STATUS
   about how many disks were added by the OPROM and the shadow address and\r
   size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r
-  This value is NULL if RomImage is non-NULL. This is the normal\r
-  case.\r
-  @param  RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is\r
-  no hardware associated with the ROM and thus no PciHandle,\r
-  otherwise is must be NULL.\r
-  Example is PXE base code.\r
-  @param  Flags Return Status if ROM was found and if was Legacy OPROM.\r
-  @param  DiskStart Disk number of first device hooked by the ROM. If DiskStart\r
-  is the same as DiskEnd no disked were hooked.\r
-  @param  DiskEnd Disk number of the last device hooked by the ROM.\r
-  @param  RomShadowAddress Shadow address of PC-AT ROM\r
-  @param  RomShadowSize Size of RomShadowAddress in bytes\r
-\r
-  @retval  EFI_SUCCESS Thunk completed, see Regs for status.\r
-  @retval  EFI_INVALID_PARAMETER PciHandle not found\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PciHandle             The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r
+                                This value is NULL if RomImage is non-NULL. This is the normal\r
+                                case.\r
+  @param  RomImage              A PCI PC-AT ROM image. This argument is non-NULL if there is\r
+                                no hardware associated with the ROM and thus no PciHandle,\r
+                                otherwise is must be NULL.\r
+                                Example is PXE base code.\r
+  @param  Flags                 Return Status if ROM was found and if was Legacy OPROM.\r
+  @param  DiskStart             Disk number of first device hooked by the ROM. If DiskStart\r
+                                is the same as DiskEnd no disked were hooked.\r
+  @param  DiskEnd               Disk number of the last device hooked by the ROM.\r
+  @param  RomShadowAddress      Shadow address of PC-AT ROM\r
+  @param  RomShadowSize         Size of RomShadowAddress in bytes\r
+\r
+  @retval EFI_SUCCESS           Thunk completed, see Regs for status.\r
+  @retval EFI_INVALID_PARAMETER PciHandle not found\r
 \r
 **/\r
 typedef\r
@@ -460,24 +460,24 @@ EFI_STATUS
   Attempt to legacy boot the BootOption. If the EFI contexted has been \r
   compromised this function will not return.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  BootOption EFI Device Path from BootXXXX variable.\r
-  @param  LoadOptionSize Size of LoadOption in size.\r
-  @param  LoadOption LoadOption from BootXXXX variable\r
+  @param  This                  Protocol instance pointer.\r
+  @param  BootOption            EFI Device Path from BootXXXX variable.\r
+  @param  LoadOptionSize        Size of LoadOption in size.\r
+  @param  LoadOption            LoadOption from BootXXXX variable\r
 \r
-  @retval  EFI_SUCCESS Removable media not present\r
+  @retval EFI_SUCCESS           Removable media not present\r
 \r
 **/\r
 /**\r
   Update BDA with current Scroll, Num & Cap lock LEDS\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Leds Status of current Scroll, Num & Cap lock LEDS\r
-  Bit 0 is Scroll Lock  0 = Not locked\r
-  Bit 1 is Num Lock\r
-  Bit 2 is Caps Lock\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Leds                  Status of current Scroll, Num & Cap lock LEDS\r
+                                Bit 0 is Scroll Lock 0 = Not locked\r
+                                Bit 1 is Num Lock\r
+                                Bit 2 is Caps Lock\r
 \r
-  @retval  EFI_SUCCESS Removable media not present\r
+  @retval EFI_SUCCESS           Removable media not present\r
 \r
 **/\r
 typedef\r
@@ -500,13 +500,13 @@ EFI_STATUS
 /**\r
   Retrieve legacy BBS info and assign boot priority.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  HddCount Number of HDD_INFO structures\r
-  @param  HddInfo Onboard IDE controller information\r
-  @param  BbsCount Number of BBS_TABLE structures\r
-  @param  BbsTable List BBS entries\r
+  @param  This                  Protocol instance pointer.\r
+  @param  HddCount              Number of HDD_INFO structures\r
+  @param  HddInfo               Onboard IDE controller information\r
+  @param  BbsCount              Number of BBS_TABLE structures\r
+  @param  BbsTable              List BBS entries\r
 \r
-  @retval  EFI_SUCCESS Tables returned\r
+  @retval EFI_SUCCESS           Tables returned\r
 \r
 **/\r
 typedef\r
@@ -524,11 +524,11 @@ EFI_STATUS
   Assign drive number to legacy HDD drives prior to booting an EFI\r
   aware OS so the OS can access drives without an EFI driver.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  BbsCount Number of BBS_TABLE structures\r
-  @param  BbsTable List BBS entries\r
+  @param  This                  Protocol instance pointer.\r
+  @param  BbsCount              Number of BBS_TABLE structures\r
+  @param  BbsTable              List BBS entries\r
 \r
-  @retval  EFI_SUCCESS Drive numbers assigned\r
+  @retval EFI_SUCCESS           Drive numbers assigned\r
 \r
 **/\r
 typedef\r
@@ -544,14 +544,14 @@ EFI_STATUS
   To boot from an unconventional device like parties and/or execute\r
   HDD diagnostics.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Attributes How to interpret the other input parameters\r
-  @param  BbsEntry The 0-based index into the BbsTable for the parent\r
-  device.\r
-  @param  BeerData Pointer to the 128 bytes of ram BEER data.\r
-  @param  ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The\r
-  caller must provide a pointer to the specific Service\r
-  Area and not the start all Service Areas.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Attributes            How to interpret the other input parameters\r
+  @param  BbsEntry              The 0-based index into the BbsTable for the parent\r
+                                device.\r
+  @param  BeerData              Pointer to the 128 bytes of ram BEER data.\r
+  @param  ServiceAreaData       Pointer to the 64 bytes of raw Service Area data. The\r
+                                caller must provide a pointer to the specific Service\r
+                                Area and not the start all Service Areas.\r
 \r
   EFI_INVALID_PARAMETER if error. Does NOT return if no error.\r
 \r
@@ -573,7 +573,7 @@ EFI_STATUS
   drivers. If used externally then caller must re-connect EFI\r
   drivers.\r
 \r
-  @retval  EFI_SUCCESS OPROMs shadowed\r
+  @retval EFI_SUCCESS           OPROMs shadowed\r
 \r
 **/\r
 typedef\r
@@ -586,19 +586,18 @@ EFI_STATUS
 /**\r
   Get a region from the LegacyBios for S3 usage.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMemorySize Size of required region\r
-  @param  Region Region to use.\r
-  00 = Either 0xE0000 or 0xF0000 block\r
-  Bit0 = 1 0xF0000 block\r
-  Bit1 = 1 0xE0000 block\r
-  @param  Alignment Address alignment. Bit mapped. First non-zero\r
-  bit from right is alignment.\r
-  @param  LegacyMemoryAddress Region Assigned\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMemorySize      Size of required region\r
+  @param  Region                Region to use.\r
+                                00 = Either 0xE0000 or 0xF0000 block\r
+                                Bit0 = 1 0xF0000 block\r
+                                Bit1 = 1 0xE0000 block\r
+  @param  Alignment             Address alignment. Bit mapped. First non-zero\r
+                                bit from right is alignment.\r
+  @param  LegacyMemoryAddress   Region Assigned\r
 \r
-  @retval  EFI_SUCCESS Region assigned\r
-  \r
-  @retval  Other Region not assigned\r
+  @retval EFI_SUCCESS           Region assigned\r
+  @retval Other                 Region not assigned\r
 \r
 **/\r
 typedef\r
@@ -615,15 +614,16 @@ EFI_STATUS
 /**\r
   Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  LegacyMemorySize Size of data to copy\r
-  @param  LegacyMemoryAddress Legacy Region destination address\r
-  Note: must be in region assigned by\r
-  LegacyBiosGetLegacyRegion\r
-  @param  LegacyMemorySourceAddress Source of data\r
+  @param  This                  Protocol instance pointer.\r
+  @param  LegacyMemorySize      Size of data to copy\r
+  @param  LegacyMemoryAddress   Legacy Region destination address\r
+                                Note: must be in region assigned by\r
+                                LegacyBiosGetLegacyRegion\r
+  @param  LegacyMemorySourceAddress \r
+                                Source of data\r
 \r
-  @retval  EFI_SUCCESS Region assigned\r
-  @retval  EFI_ACCESS_DENIED Destination outside assigned region\r
+  @retval EFI_SUCCESS           Region assigned\r
+  @retval EFI_ACCESS_DENIED     Destination outside assigned region\r
 \r
 **/\r
 typedef\r