From 382aeac2c83dc7fb0c88b7a5ade1038820b3beab Mon Sep 17 00:00:00 2001 From: Dandan Bi Date: Thu, 19 Oct 2017 15:42:27 +0800 Subject: [PATCH] MdeModulePkg/DxeIplPeim: Refine coding style in function comments Make the comments align with the function. And add some missing function comments. Cc: Jian J Wang Cc: Eric Dong Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Dandan Bi Reviewed-by: Jian J Wang --- MdeModulePkg/Core/DxeIplPeim/DxeIpl.h | 14 +++++++------- MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c | 15 +++++++++++---- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h index ecf186667a..f3aabdb7e0 100644 --- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h +++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h @@ -241,12 +241,12 @@ Decompress ( ); /** - Clear legacy memory located at the first 4K-page. + Clear legacy memory located at the first 4K-page. - This function traverses the whole HOB list to check if memory from 0 to 4095 - exists and has not been allocated, and then clear it if so. + This function traverses the whole HOB list to check if memory from 0 to 4095 + exists and has not been allocated, and then clear it if so. - @param HoStart The start of HobList passed to DxeCore. + @param HobStart The start of HobList passed to DxeCore. **/ VOID @@ -255,10 +255,10 @@ ClearFirst4KPage ( ); /** - Return configure status of NULL pointer detection feature + Return configure status of NULL pointer detection feature. - @return TRUE NULL pointer detection feature is enabled - @return FALSE NULL pointer detection feature is disabled + @return TRUE NULL pointer detection feature is enabled + @return FALSE NULL pointer detection feature is disabled **/ BOOLEAN IsNullDetectionEnabled ( diff --git a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c index a10dea25fd..29b6205e88 100644 --- a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c +++ b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c @@ -32,12 +32,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "VirtualMemory.h" /** - Clear legacy memory located at the first 4K-page, if available. + Clear legacy memory located at the first 4K-page, if available. - This function traverses the whole HOB list to check if memory from 0 to 4095 - exists and has not been allocated, and then clear it if so. + This function traverses the whole HOB list to check if memory from 0 to 4095 + exists and has not been allocated, and then clear it if so. - @param HoStart The start of HobList passed to DxeCore. + @param HobStart The start of HobList passed to DxeCore. **/ VOID @@ -86,6 +86,13 @@ ClearFirst4KPage ( return; } +/** + Return configure status of NULL pointer detection feature. + + @return TRUE NULL pointer detection feature is enabled + @return FALSE NULL pointer detection feature is disabled + +**/ BOOLEAN IsNullDetectionEnabled ( VOID