From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by mx.groups.io with SMTP id smtpd.web11.252.1573102523211165360 for ; Wed, 06 Nov 2019 20:55:23 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.43, mailfrom: ray.ni@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 06 Nov 2019 20:55:22 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.68,276,1569308400"; d="scan'208";a="227713497" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by fmsmga004.fm.intel.com with ESMTP; 06 Nov 2019 20:55:22 -0800 Received: from fmsmsx114.amr.corp.intel.com (10.18.116.8) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.439.0; Wed, 6 Nov 2019 20:55:22 -0800 Received: from shsmsx153.ccr.corp.intel.com (10.239.6.53) by FMSMSX114.amr.corp.intel.com (10.18.116.8) with Microsoft SMTP Server (TLS) id 14.3.439.0; Wed, 6 Nov 2019 20:55:21 -0800 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.127]) by SHSMSX153.ccr.corp.intel.com ([169.254.12.215]) with mapi id 14.03.0439.000; Thu, 7 Nov 2019 12:55:19 +0800 From: "Ni, Ray" To: "Yao, Jiewen" , "devel@edk2.groups.io" CC: "Chaganty, Rangasai V" , "Lou, Yun" Subject: Re: [PATCH V2 2/6] IntelSiliconPkg/Include: Add Platform Device Security Policy protocol Thread-Topic: [PATCH V2 2/6] IntelSiliconPkg/Include: Add Platform Device Security Policy protocol Thread-Index: AQHVj+csTxqLUFmSTUOcbhrpbbFam6d/LWxw Date: Thu, 7 Nov 2019 04:55:19 +0000 Message-ID: <734D49CCEBEEF84792F5B80ED585239D5C352D95@SHSMSX104.ccr.corp.intel.com> References: <20191031123127.10900-1-jiewen.yao@intel.com> <20191031123127.10900-3-jiewen.yao@intel.com> In-Reply-To: <20191031123127.10900-3-jiewen.yao@intel.com> Accept-Language: en-US, zh-CN X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: ray.ni@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Jiewen, I am fine with the 1/6 patch that doesn't contain enough comments to descri= be the meaning of each field in each structure because I can reach out to the referenced s= pec to understand them. This 2/6 patch introduces a new protocol but contains very few comments (al= most none) for each structure each field and I cannot reach out to any spec to understand them. So can you please add comments to each field of structures like EDKII_DEVIC= E_SECURITY_POLICY and EDKII_DEVICE_SECURITY_STATE? Also can you please add comments to all the macros defined in this patch to= explain the meaning and more important how they are going to impact the logic. In general, can you please add enough comments so that a PCI/USB BUS driver= developer can understand the whole flow how this protocol supports the device security? Thanks, Ray > -----Original Message----- > From: Yao, Jiewen > Sent: Thursday, October 31, 2019 8:31 PM > To: devel@edk2.groups.io > Cc: Ni, Ray ; Chaganty, Rangasai V > ; Lou, Yun > Subject: [PATCH V2 2/6] IntelSiliconPkg/Include: Add Platform Device > Security Policy protocol >=20 > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D2303 >=20 > Cc: Ray Ni > Cc: Rangasai V Chaganty > Cc: Yun Lou > Signed-off-by: Jiewen Yao > --- >=20 > Silicon/Intel/IntelSiliconPkg/Include/Protocol/PlatformDeviceSecurityPoli= cy.h > | 84 ++++++++++++++++++++ > 1 file changed, 84 insertions(+) >=20 > diff --git > a/Silicon/Intel/IntelSiliconPkg/Include/Protocol/PlatformDeviceSecurityPo= lic > y.h > b/Silicon/Intel/IntelSiliconPkg/Include/Protocol/PlatformDeviceSecurityPo= lic > y.h > new file mode 100644 > index 0000000000..cb5a71ad41 > --- /dev/null > +++ > b/Silicon/Intel/IntelSiliconPkg/Include/Protocol/PlatformDeviceSecurityPo= lic > y.h > @@ -0,0 +1,84 @@ > +/** @file > + Device Security Policy Protocol definition > + > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > + > +#ifndef __EDKII_DEVICE_SECURITY_POLICY_PROTOCOL_H__ > +#define __EDKII_DEVICE_SECURITY_POLICY_PROTOCOL_H__ > + > +#include > +#include > + > +typedef struct _EDKII_DEVICE_SECURITY_POLICY_PROTOCOL > EDKII_DEVICE_SECURITY_POLICY_PROTOCOL; > + > +typedef struct { > + UINT32 Version; // 0x1 > + UINT32 MeasurementPolicy; > + UINT32 AuthenticationPolicy; > +} EDKII_DEVICE_SECURITY_POLICY; > + > +// BIT0 means if the action is needed or NOT > +#define EDKII_DEVICE_MEASUREMENT_POLICY_REQUIRED BIT0 > +#define EDKII_DEVICE_AUTHENTICATION_POLICY_REQUIRED BIT0 > + > +typedef struct { > + UINT32 Version; // 0x1 > + UINT32 MeasurementState; > + UINT32 AuthenticationState; > +} EDKII_DEVICE_SECURITY_STATE; > + > +// All zero means success > +#define EDKII_DEVICE_SECURITY_STATE_SUCCESS 0 > +#define EDKII_DEVICE_SECURITY_STATE_ERROR BIT= 31 > +#define EDKII_DEVICE_SECURITY_STATE_ERROR_UEFI_UNSUPPORTED > (EDKII_DEVICE_SECURITY_STATE_ERROR + 0x0) > +#define > EDKII_DEVICE_SECURITY_STATE_ERROR_UEFI_GET_POLICY_PROTOCOL > (EDKII_DEVICE_SECURITY_STATE_ERROR + 0x1) > +#define EDKII_DEVICE_SECURITY_STATE_ERROR_PCI_NO_CAPABILITIES > (EDKII_DEVICE_SECURITY_STATE_ERROR + 0x10) > +#define EDKII_DEVICE_SECURITY_STATE_ERROR_TCG_EXTEND_TPM_PCR > (EDKII_DEVICE_SECURITY_STATE_ERROR + 0x20) > + > +/** > + This function returns the device security policy associated with the d= evice. > + > + @param[in] This The protocol instance pointer. > + @param[in] DeviceId The Identifier for the device. > + @param[out] DeviceSecurityPolicy The Device Security Policy associat= ed > with the device. > + > + @retval EFI_SUCCESS The device security policy is retur= ned > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_DEVICE_SECURITY_GET_DEVICE_POLICY) ( > + IN EDKII_DEVICE_SECURITY_POLICY_PROTOCOL *This, > + IN EDKII_DEVICE_IDENTIFIER *DeviceId, > + OUT EDKII_DEVICE_SECURITY_POLICY **DeviceSecurityPolicy > + ); > + > +/** > + This function sets the device state based upon the authentication resu= lt. > + > + @param[in] This The protocol instance pointer. > + @param[in] DeviceId The Identifier for the device. > + @param[in] DeviceSecurityState The Device Security state associate= d > with the device. > + > + @retval EFI_SUCCESS The device state is set > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_DEVICE_SECURITY_SET_DEVICE_STATE) ( > + IN EDKII_DEVICE_SECURITY_POLICY_PROTOCOL *This, > + IN EDKII_DEVICE_IDENTIFIER *DeviceId, > + IN EDKII_DEVICE_SECURITY_STATE *DeviceSecurityState > + ); > + > +struct _EDKII_DEVICE_SECURITY_POLICY_PROTOCOL { > + UINT32 Version; // 0x1 > + EDKII_DEVICE_SECURITY_GET_DEVICE_POLICY GetDevicePolicy; > + EDKII_DEVICE_SECURITY_SET_DEVICE_STATE SetDeviceState; > +}; > + > +extern EFI_GUID gEdkiiDeviceSecurityPolicyProtocolGuid; > + > +#endif > -- > 2.19.2.windows.1