X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FBase.h;h=031faa7eff7643ee1d2f287ea4faef8db7a081f1;hp=d1b6c82f6ddaeb1c0609ae58c42be309a1bfe4df;hb=8a3f79bf36de99a8bba7266a5adfa6bad203328d;hpb=f4ec40abd6533850edb914de59b7ef5f1c1c1bb6 diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h index d1b6c82f6d..031faa7eff 100644 --- a/MdePkg/Include/Base.h +++ b/MdePkg/Include/Base.h @@ -70,7 +70,7 @@ struct _LIST_ENTRY { #define STATIC static /// -/// Undclared type +/// Undeclared type /// #define VOID void @@ -223,6 +223,13 @@ struct _LIST_ENTRY { // } // +/** + Return the size of argument that has been aligned to sizeof (UINTN). + + @param n The parameter size is to be aligned. + + @return The aligned size +**/ #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1)) /// @@ -398,7 +405,7 @@ typedef INTN RETURN_STATUS; /** Produces a RETURN_STATUS code with the highest bit set. - @param StatusCode The status code value to convert into a warning code. + @param StatusCode The status code value to convert into a warning code. StatusCode must be in the range 0x00000000..0x7FFFFFFF. @return The value specified by StatusCode with the highest bit set. @@ -409,7 +416,7 @@ typedef INTN RETURN_STATUS; /** Produces a RETURN_STATUS code with the highest bit clear. - @param StatusCode The status code value to convert into a warning code. + @param StatusCode The status code value to convert into a warning code. StatusCode must be in the range 0x00000000..0x7FFFFFFF. @return The value specified by StatusCode with the highest bit clear. @@ -422,7 +429,7 @@ typedef INTN RETURN_STATUS; This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. - @param StatusCode The status code value to evaluate. + @param StatusCode The status code value to evaluate. @retval TRUE The high bit of StatusCode is set. @retval FALSE The high bit of StatusCode is clear. @@ -463,7 +470,7 @@ typedef INTN RETURN_STATUS; #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5) /// -/// There is no data oending upon return. +/// There is no data pending upon return. /// #define RETURN_NOT_READY ENCODE_ERROR (6) @@ -484,7 +491,7 @@ typedef INTN RETURN_STATUS; #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9) /// -/// An inconsistancy was detected on the file system causing the +/// An inconsistency was detected on the file system causing the /// operation to fail. /// #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10) @@ -547,23 +554,23 @@ typedef INTN RETURN_STATUS; #define RETURN_ABORTED ENCODE_ERROR (21) /// -/// An ICMP error occurred during the nrtwork operation. +/// An ICMP error occurred during the network operation. /// #define RETURN_ICMP_ERROR ENCODE_ERROR (22) /// -/// A TFTP error occurred during the nrtwork operation. +/// A TFTP error occurred during the network operation. /// #define RETURN_TFTP_ERROR ENCODE_ERROR (23) /// -/// A protocol error occurred during the nrtwork operation. +/// A protocol error occurred during the network operation. /// #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24) /// /// A function encountered an internal version that was -/// iuncomptible with a version requested by the caller. +/// incompatible with a version requested by the caller. /// #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)