1, Add @par section in file header comment

2, Rollback the member name changing in last modification to keep backward compatible. Although add more comment to declaration the these inconsistent issue.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8867 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkPkg/Include/Framework/Legacy16.h b/IntelFrameworkPkg/Include/Framework/Legacy16.h
index a4ce8a054db38f23eebff0bca29bf95b63882a23..533782c7fd1455cbe5e0a3ada62b5559fc1d2c38 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/Legacy16.h
+++ b/IntelFrameworkPkg/Include/Framework/Legacy16.h
@@ -16,6 +16,10 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

+  @par Revision Reference:
+  These definitions are from Compatibility Support Module Spec
+  Version 0.97.
+

 **/
 
 #ifndef _FRAMEWORK_LEGACY_16_H_
 **/
 
 #ifndef _FRAMEWORK_LEGACY_16_H_


@@ -222,8 +226,12 @@ typedef struct {
 
 ///
 /// Functions provided by the CSM binary which communicate between the EfiCompatibility \r
 
 ///
 /// Functions provided by the CSM binary which communicate between the EfiCompatibility \r

-/// and Compatability16 code.
-///
+/// and Compatability16 code.\r
+///\r
+/// Inconsistent with specification here: \r
+/// The member's name started with "Compatibility16" [defined in Intel Framework Compatibility Support Module Specification / 0.97 version] \r
+/// has been changed to "Legacy16" since keeping backward compatible.\r
+///\r

 typedef enum {
   ///\r
   /// Causes the Compatibility16 code to do any internal initialization required.\r
 typedef enum {
   ///\r
   /// Causes the Compatibility16 code to do any internal initialization required.\r


@@ -232,8 +240,8 @@ typedef enum {
   ///   ES:BX = Pointer to EFI_TO_COMPATIBILITY16_INIT_TABLE\r
   /// Return:\r
   ///   AX = Return Status codes\r
   ///   ES:BX = Pointer to EFI_TO_COMPATIBILITY16_INIT_TABLE\r
   /// Return:\r
   ///   AX = Return Status codes\r

-  ///
-  Compatibility16InitializeYourself    = 0x0000,
+  ///\r
+  Legacy16InitializeYourself    = 0x0000,

   \r
   ///\r
   /// Causes the Compatibility16 BIOS to perform any drive number translations to match the boot sequence.\r
   \r
   ///\r
   /// Causes the Compatibility16 BIOS to perform any drive number translations to match the boot sequence.\r


@@ -243,7 +251,7 @@ typedef enum {
   /// Return:\r
   ///   AX = Returned status codes\r
   ///
   /// Return:\r
   ///   AX = Returned status codes\r
   ///

-  Compatibility16UpdateBbs             = 0x0001,
+  Legacy16UpdateBbs             = 0x0001,

   \r
   ///\r
   /// Allows the Compatibility16 code to perform any final actions before booting. The Compatibility16\r
   \r
   ///\r
   /// Allows the Compatibility16 code to perform any final actions before booting. The Compatibility16\r


@@ -254,7 +262,7 @@ typedef enum {
   /// Return:\r
   ///   AX = Returned status codes\r
   ///
   /// Return:\r
   ///   AX = Returned status codes\r
   ///

-  Compatibility16PrepareToBoot         = 0x0002,
+  Legacy16PrepareToBoot         = 0x0002,

   \r
   ///\r
   /// Causes the Compatibility16 BIOS to boot. The Compatibility16 code is Read/Only.\r
   \r
   ///\r
   /// Causes the Compatibility16 BIOS to boot. The Compatibility16 code is Read/Only.\r


@@ -263,7 +271,7 @@ typedef enum {
   /// Output:\r
   ///   AX = Returned status codes\r
   ///
   /// Output:\r
   ///   AX = Returned status codes\r
   ///

-  Compatibility16Boot                  = 0x0003,
+  Legacy16Boot                  = 0x0003,

   \r
   ///\r
   /// Allows the Compatibility16 code to get the last device from which a boot was attempted. This is\r
   \r
   ///\r
   /// Allows the Compatibility16 code to get the last device from which a boot was attempted. This is\r


@@ -274,7 +282,7 @@ typedef enum {
   ///   AX = Returned status codes\r
   ///   BX = Priority number of the boot device.\r
   ///
   ///   AX = Returned status codes\r
   ///   BX = Priority number of the boot device.\r
   ///

-  Compatibility16RetrieveLastBootDevice= 0x0004,
+  Legacy16RetrieveLastBootDevice = 0x0004,

   \r
   ///\r
   /// Allows the Compatibility16 code rehook INT13, INT18, and/or INT19 after dispatching a legacy OpROM.\r
   \r
   ///\r
   /// Allows the Compatibility16 code rehook INT13, INT18, and/or INT19 after dispatching a legacy OpROM.\r


@@ -285,7 +293,7 @@ typedef enum {
   ///   AX = Returned status codes\r
   ///   BX = Number of non-BBS-compliant devices found. Equals 0 if BBS compliant.\r
   ///
   ///   AX = Returned status codes\r
   ///   BX = Number of non-BBS-compliant devices found. Equals 0 if BBS compliant.\r
   ///

-  Compatibility16DispatchOprom         = 0x0005,
+  Legacy16DispatchOprom         = 0x0005,

   \r
   ///\r
   /// Finds a free area in the 0xFxxxx or 0xExxxx region of the specified length and returns the address\r
   \r
   ///\r
   /// Finds a free area in the 0xFxxxx or 0xExxxx region of the specified length and returns the address\r


@@ -302,7 +310,7 @@ typedef enum {
   ///   AX = Returned status codes\r
   ///   DS:BX = Address of the region\r
   ///
   ///   AX = Returned status codes\r
   ///   DS:BX = Address of the region\r
   ///

-  Compatibility16GetTableAddress       = 0x0006,
+  Legacy16GetTableAddress       = 0x0006,

   \r
   ///\r
   /// Enables the EfiCompatibility module to do any nonstandard processing of keyboard LEDs or state.\r
   \r
   ///\r
   /// Enables the EfiCompatibility module to do any nonstandard processing of keyboard LEDs or state.\r


@@ -315,7 +323,7 @@ typedef enum {
   /// Output:\r
   ///     AX = Returned status codes\r
   ///
   /// Output:\r
   ///     AX = Returned status codes\r
   ///

-  Compatibility16SetKeyboardLeds       = 0x0007,
+  Legacy16SetKeyboardLeds       = 0x0007,

   \r
   ///\r
   /// Enables the EfiCompatibility module to install an interrupt handler for PCI mass media devices that\r
   \r
   ///\r
   /// Enables the EfiCompatibility module to install an interrupt handler for PCI mass media devices that\r


@@ -326,7 +334,7 @@ typedef enum {
   /// Output:\r
   ///   AX = Returned status codes\r
   ///
   /// Output:\r
   ///   AX = Returned status codes\r
   ///

-  Compatibility16InstallPciHandler     = 0x0008
+  Legacy16InstallPciHandler     = 0x0008

 } EFI_COMPATIBILITY_FUNCTIONS;
 
 
 } EFI_COMPATIBILITY_FUNCTIONS;
 
 


@@ -343,8 +351,12 @@ typedef struct {
                                         ///< increase this number, if BBS-compliant devices also hook INTs in order to force the
                                         ///< OpROM BIOS Setup to be executed.
   VOID    *BbsTablePointer;             ///< Pointer to the BBS table.
                                         ///< increase this number, if BBS-compliant devices also hook INTs in order to force the
                                         ///< OpROM BIOS Setup to be executed.
   VOID    *BbsTablePointer;             ///< Pointer to the BBS table.

-  UINT16  OpromDestinationSegment;      ///< The segment where the OpROM can be relocated to. If this value is 0x0000, this
-                                        ///< means that the relocation of this run time code is not supported.
+  UINT16  RuntimeSegment;               ///< The segment where the OpROM can be relocated to. If this value is 0x0000, this
+                                        ///< means that the relocation of this run time code is not supported.\r
+                                        ///< Inconsistent with specification here: \r
+                                        ///< The member's name "OpromDestinationSegment" [defined in Intel Framework Compatibility Support Module Specification / 0.97 version] \r
+                                        ///< has been changed to "RuntimeSegment" since keeping backward compatible.\r
+

 } EFI_DISPATCH_OPROM_TABLE;
 
 ///
 } EFI_DISPATCH_OPROM_TABLE;
 
 ///