Correct Minor Comments in M3 to M4 review.

[mirror_edk2.git] / MdePkg / Include / Ipf / ProcessorBind.h

diff --git a/MdePkg/Include/Ipf/ProcessorBind.h b/MdePkg/Include/Ipf/ProcessorBind.h
index 3dbeceb585cfd396d8d45eb9486999f88f42c860..31940a578854d89591c89f5817aec6f08987c78f 100644 (file)
--- a/MdePkg/Include/Ipf/ProcessorBind.h
+++ b/MdePkg/Include/Ipf/ProcessorBind.h
@@ -237,6 +237,18 @@ typedef struct {
   UINT64                    r11;\r
 } PAL_CALL_RETURN;\r
 \r
+/**\r
+  Return the pointer to the first instruction of a function given a function pointer.\r
+  For Itanium CPUs, all function calls are made through a PLABEL, so a pointer to a function \r
+  is actually a pointer to a PLABEL.  The pointer to the first instruction of the function \r
+  is contained within the PLABEL.  This macro may be used to retrieve a pointer to the first \r
+  instruction of a function independent of the CPU architecture being used.  This is very \r
+  useful when printing function addresses through DEBUG() macros.\r
+  \r
+  @param  p A pointer to a function\r
+\r
+  @return The pointer to the first instruction of a function given a function pointer.\r
+**/\r
 #define FUNCTION_ENTRY_POINT(p) (((EFI_PLABEL *)(p))->EntryPoint)\r
 \r
 #endif\r