From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.31; helo=mga06.intel.com; envelope-from=dandan.bi@intel.com; receiver=edk2-devel@lists.01.org Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id AFD6120347149 for ; Thu, 19 Oct 2017 17:56:51 -0700 (PDT) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga104.jf.intel.com with ESMTP; 19 Oct 2017 18:00:23 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.43,404,1503385200"; d="scan'208";a="911740738" Received: from shwdeopenpsi114.ccr.corp.intel.com ([10.239.157.135]) by FMSMGA003.fm.intel.com with ESMTP; 19 Oct 2017 18:00:21 -0700 From: Dandan Bi To: edk2-devel@lists.01.org Cc: Jian J Wang , Eric Dong Date: Fri, 20 Oct 2017 08:59:52 +0800 Message-Id: <1508461193-5204-4-git-send-email-dandan.bi@intel.com> X-Mailer: git-send-email 1.9.5.msysgit.1 In-Reply-To: <1508461193-5204-1-git-send-email-dandan.bi@intel.com> References: <1508461193-5204-1-git-send-email-dandan.bi@intel.com> Subject: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 20 Oct 2017 00:56:51 -0000 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 --- 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 ecf1866..f3aabdb 100644 --- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h +++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h @@ -239,28 +239,28 @@ Decompress ( OUT VOID **OutputBuffer, OUT UINTN *OutputSize ); /** - 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 ClearFirst4KPage ( IN VOID *HobStart ); /** - 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 ( VOID ); diff --git a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c index a10dea2..29b6205 100644 --- a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c +++ b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c @@ -30,16 +30,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "DxeIpl.h" #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 ClearFirst4KPage ( IN VOID *HobStart @@ -84,10 +84,17 @@ 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 ) { -- 1.9.5.msysgit.1