1. Updated function headers in all assembly files.

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

diff --git a/MdePkg/Library/BaseLib/X64/Thunk16.asm b/MdePkg/Library/BaseLib/X64/Thunk16.asm
index b120434efb0c7ac3211ce433a89b21fa27adbc93..2c35c72a57713c78774211b06d9e8b25053df31f 100644 (file)
--- a/MdePkg/Library/BaseLib/X64/Thunk16.asm
+++ b/MdePkg/Library/BaseLib/X64/Thunk16.asm
@@ -61,6 +61,10 @@ SavedGdt    LABEL   FWORD
             DW      ?\r
             DQ      ?\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
     DB      16h                         ; push ss\r
     DB      0eh                         ; push cs\r
@@ -125,6 +129,10 @@ _16Gdtr     LABEL   FWORD
 _16GdtrBase DQ      _NullSegDesc\r
 _16Idtr     FWORD   (1 SHL 10) - 1\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     edi, ss\r
     mov     ss, edx                     ; set new segment selectors\r
@@ -184,11 +192,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    rbp rbx rsi rdi\r
     mov     r10d, ds\r
     mov     r11d, es\r