From nobody Fri Apr 26 13:28:48 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+46969+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+46969+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1567759634; cv=none; d=zoho.com; s=zohoarc; b=Z6mhgu5yWLJSKLcP1ScSdHYwwCoBWMWE/oCP9SjDytpJ3XsSQ+KmeTwmAb0wxMaCB/TaGhvzJD4sCBLkoKqefxKI8JkQovJFNmqTi4yVtHIvc1gfpHrqPvibuyrq2Ydt/hhm+L+aPClAmE+iAXFJqE7ZLjntKOSX3YVlIwvwJU8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1567759634; h=Cc:Date:From:List-Id:List-Unsubscribe:Message-ID:Reply-To:Sender:Subject:To:ARC-Authentication-Results; bh=WY+Kf8O0MR0vuzx/ZYahCv7MHn9BCiHhNljqFzmwfO4=; b=iP+w/fGH02FZx4Pz+Cg+8pPjp+KxlyLevKThZhlIDZM5cthWzxSkccwaAzf1qjf5P6JkXtIYSzqC4ojfhPKl8undFRKDoF39bqTwRHckaQrSIpattPSGbqfGQlZgmTRyqQl4kJTJZsitPs4O7GEZFKoq6UgJuqxOZ5QmRktxGEY= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+46969+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1567759633926151.0013981356126; Fri, 6 Sep 2019 01:47:13 -0700 (PDT) Return-Path: X-Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by groups.io with SMTP; Fri, 06 Sep 2019 01:47:12 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 06 Sep 2019 01:47:12 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,472,1559545200"; d="scan'208";a="358728926" X-Received: from shenglei-dev.ccr.corp.intel.com ([10.239.158.52]) by orsmga005.jf.intel.com with ESMTP; 06 Sep 2019 01:47:11 -0700 From: "Zhang, Shenglei" To: devel@edk2.groups.io Cc: Ray Ni , Rangasai V Chaganty Subject: [edk2-devel] [PATCH] Silicon/IntelSiliconPkg: Update the comment format Date: Fri, 6 Sep 2019 16:47:05 +0800 Message-Id: <20190906084709.20192-1-shenglei.zhang@intel.com> Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,shenglei.zhang@intel.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1567759633; bh=t3C77RqgifoQAmwblyOuvn5/8I52ob2oQZikzSkT/UE=; h=Cc:Date:From:Reply-To:Subject:To; b=LbQdBiRxjxTiozwZ+eb8u1TKULiH0ktTCzOCL2amlBvX5oAOvAWvjI3SxknCkrhuEJ7 3DD0GmanD6SaEbMuf++Go3cIhO7BwzpDFArQRjhShIob41mGGHjjqMGXIqYtUIK2E0ySU fubIFHECjaMgU/F1o7tzYxNalmg58AfLibs= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" To make the comments in IntelSiliconPkg consistent with those in other packages, update "@exception" to "@retval" and remove "@result" Cc: Ray Ni Cc: Rangasai V Chaganty Signed-off-by: Shenglei Zhang --- .../SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c | 6 ++---- .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c | 2 +- .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h | 6 ++---- .../Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h | 6 ++---- 4 files changed, 7 insertions(+), 13 deletions(-) diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmm= AccessLib/PeiSmmAccessLib.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAcce= ss/Library/PeiSmmAccessLib/PeiSmmAccessLib.c index da141cfa..2310e611 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessL= ib/PeiSmmAccessLib.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessL= ib/PeiSmmAccessLib.c @@ -234,10 +234,8 @@ GetCapabilities ( /** This function is to install an SMM Access PPI - Introduction \n - A module to install a PPI for controlling SMM mode memory access basic= ally for S3 resume usage. - - - @result - Publish _EFI_PEI_MM_ACCESS_PPI. + A module to install a PPI for controlling SMM mode memory access basic= ally for S3 resume usage + and publish _EFI_PEI_MM_ACCESS_PPI. =20 @retval EFI_SUCCESS - Ppi successfully started and installed. @retval EFI_NOT_FOUND - Ppi can't be found. diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/S= mmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAcces= sDxe/SmmAccessDriver.c index 3d3c4ab2..bdcacac5 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.c @@ -18,7 +18,7 @@ static SMM_ACCESS_PRIVATE_DATA mSmmAccess; @param[in] SystemTable - Pointer to the EFI System Table =20 @retval EFI_SUCCESS - Protocol was installed successfully - @exception EFI_UNSUPPORTED - Protocol was not installed + @retval EFI_UNSUPPORTED - Protocol was not installed @retval EFI_NOT_FOUND - Protocol can't be found. @retval EFI_OUT_OF_RESOURCES - Protocol does not have enough resources = to initialize the driver. **/ diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/S= mmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAcces= sDxe/SmmAccessDriver.h index c0ff3a25..647b3a07 100644 --- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h +++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces= sDriver.h @@ -58,9 +58,7 @@ typedef struct { Finally, the SMM access protocol provides services to "Lock" the SMRAM= region. Please refer the SMM Protocols section in the attached SMM CIS Specifi= cation version 0.9 for further details. This driver is required if SMM is supported. Proper configuration of S= MM registers is recommended even if SMM is not supported. - - - @result - Publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the System Manag= ement Mode Core Interface Specification, available at the URL: http://www.i= ntel.com/technology/framework/spec.htm + This driver publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the = System Management Mode Core Interface Specification, available at the URL: = http://www.intel.com/technology/framework/spec.htm =20 - Porting Recommendations \n No modification of this module is recommended. Any modification shoul= d be done in compliance with the _EFI_SMM_ACCESS_PROTOCOL protocol definiti= on. @@ -69,7 +67,7 @@ typedef struct { @param[in] SystemTable - Pointer to the EFI System Table =20 @retval EFI_SUCCESS - Protocol was installed successfully - @exception EFI_UNSUPPORTED - Protocol was not installed + @retval EFI_UNSUPPORTED - Protocol was not installed **/ EFI_STATUS EFIAPI diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h b= /Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h index f658bac6..cf99df56 100644 --- a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h +++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h @@ -11,10 +11,8 @@ /** This function is to install an SMM Access PPI - Introduction \n - A module to install a PPI for controlling SMM mode memory access basic= ally for S3 resume usage. - - - @result - Publish _PEI_MM_ACCESS_PPI. + A module to install a PPI for controlling SMM mode memory access basic= ally for S3 resume usage + and publish _PEI_MM_ACCESS_PPI. =20 @retval EFI_SUCCESS - Ppi successfully started and installed. @retval EFI_NOT_FOUND - Ppi can't be found. --=20 2.18.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46969): https://edk2.groups.io/g/devel/message/46969 Mute This Topic: https://groups.io/mt/33164365/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-