1. Updated function headers in all assembly files.

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / Thunk16.asm

diff --git a/MdePkg/Library/BaseLib/Ia32/Thunk16.asm b/MdePkg/Library/BaseLib/Ia32/Thunk16.asm
index 9fba03ac05072d7540ef95f7188d2726356fc931..5e357991271d07efb15e95075027833d4075512a 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/Thunk16.asm
+++ b/MdePkg/Library/BaseLib/Ia32/Thunk16.asm
@@ -29,6 +29,10 @@ EXTERNDEF   C   m16Gdt:WORD
 EXTERNDEF   C   m16GdtrBase:WORD\r
 EXTERNDEF   C   mTransition:WORD\r
 \r
+;\r
+; Here is the layout of the real mode stack. _ToUserCode() is responsible for\r
+; loading all these registers from real mode stack.\r
+;\r
 IA32_REGS   STRUC   4t\r
 _EDI        DD      ?\r
 _ESI        DD      ?\r
@@ -50,6 +54,9 @@ IA32_REGS   ENDS
 \r
     .const\r
 \r
+;\r
+; These are global constant to convey information to C code.\r
+;\r
 m16Size         DW      InternalAsmThunk16 - m16Start\r
 mThunk16Attr    DW      _ThunkAttr - m16Start\r
 m16Gdt          DW      _NullSegDesc - m16Start\r
@@ -63,7 +70,10 @@ m16Start    LABEL   BYTE
 SavedGdt    LABEL   FWORD\r
             DW      ?\r
             DD      ?\r
-\r
+;------------------------------------------------------------------------------\r
+; _BackFromUserCode() takes control in real mode after 'retf' has been executed\r
+; by user code. It will be shadowed to somewhere in memory below 1MB.\r
+;------------------------------------------------------------------------------\r
 _BackFromUserCode   PROC\r
     push    ss\r
     push    cs\r
@@ -122,6 +132,10 @@ _16Gdtr     LABEL   FWORD
             DW      GdtEnd - _NullSegDesc - 1\r
 _16GdtrBase DD      _NullSegDesc\r
 \r
+;------------------------------------------------------------------------------\r
+; _ToUserCode() takes control in real mode before passing control to user code.\r
+; It will be shadowed to somewhere in memory below 1MB.\r
+;------------------------------------------------------------------------------\r
 _ToUserCode PROC\r
     mov     edx, ss\r
     mov     ss, ecx                     ; set new segment selectors\r
@@ -174,11 +188,14 @@ _16DsDesc       LABEL   QWORD
                 DB      0\r
 GdtEnd          LABEL   QWORD\r
 \r
-;\r
-;   @param  RegSet  Pointer to a IA32_DWORD_REGS structure\r
-;   @param  Transition  Pointer to the transition code\r
-;   @return The address of the 16-bit stack after returning from user code\r
-;\r
+;------------------------------------------------------------------------------\r
+; IA32_REGISTER_SET *\r
+; EFIAPI\r
+; InternalAsmThunk16 (\r
+;   IN      IA32_REGISTER_SET         *RegisterSet,\r
+;   IN OUT  VOID                      *Transition\r
+;   );\r
+;------------------------------------------------------------------------------\r
 InternalAsmThunk16  PROC    USES    ebp ebx esi edi ds  es  fs  gs\r
     mov     esi, [esp + 36]             ; esi <- RegSet\r
     movzx   edx, (IA32_REGS ptr [esi])._SS\r