From f7cb7caef631de57f609688d47674f1af627cd8e Mon Sep 17 00:00:00 2001
From: Jiewen Yao <jiewen.yao@intel.com>
Date: Mon, 17 Jul 2017 10:45:33 +0800
Subject: Update comment for FspPolicyInit/Update.

Suggested-by: Pai-chingX Chen <pai-chingx.chen@intel.com>
Reviewed-by: Chasel Chiu <chasel.chiu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
---
 .../PeiFspPolicyUpdateLib/PeiFspPolicyUpdateLib.c      | 18 ++++++++++++++++++
 .../MinPlatformPkg/Include/Library/FspPolicyInitLib.h  | 16 ++++++++++++++++
 .../Include/Library/FspPolicyUpdateLib.h               | 18 ++++++++++++++++++
 3 files changed, 52 insertions(+)

(limited to 'Platform/Intel')

diff --git a/Platform/Intel/KabylakeOpenBoardPkg/FspWrapper/Library/PeiFspPolicyUpdateLib/PeiFspPolicyUpdateLib.c b/Platform/Intel/KabylakeOpenBoardPkg/FspWrapper/Library/PeiFspPolicyUpdateLib/PeiFspPolicyUpdateLib.c
index 52d84c17d6..3f29f736fb 100644
--- a/Platform/Intel/KabylakeOpenBoardPkg/FspWrapper/Library/PeiFspPolicyUpdateLib/PeiFspPolicyUpdateLib.c
+++ b/Platform/Intel/KabylakeOpenBoardPkg/FspWrapper/Library/PeiFspPolicyUpdateLib/PeiFspPolicyUpdateLib.c
@@ -114,6 +114,15 @@ InternalPrintVariableData (
   DEBUG ((DEBUG_INFO, "\n"));
 }
 
+/**
+  Performs FSPM UPD Policy update.
+
+  A platform may use this API to update the FSPM UPD policy initialized
+  by the silicon module or the default UPD data.
+  The output of FSPM UPD data from this API is the final UPD data.
+
+  @param[in, out] FspmUpd       Pointer to FSPM UPD data.
+**/
 VOID
 EFIAPI
 FspmPolicyUpdate (
@@ -130,6 +139,15 @@ FspmPolicyUpdate (
   InternalPrintVariableData ((VOID *)FspmUpdDataPtr, sizeof(FSPM_UPD));
 }
 
+/**
+  Performs FSPS UPD Policy update.
+
+  A platform may use this API to update the FSPS UPD policy initialized
+  by the silicon module or the default UPD data.
+  The output of FSPS UPD data from this API is the final UPD data.
+
+  @param[in, out] FspsUpd       Pointer to FSPS UPD data.
+**/
 VOID
 EFIAPI
 FspsPolicyUpdate (
diff --git a/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyInitLib.h b/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyInitLib.h
index 40330e0113..ba95a32c85 100644
--- a/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyInitLib.h
+++ b/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyInitLib.h
@@ -15,12 +15,28 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _FSP_POLICY_INIT_LIB_H_
 #define _FSP_POLICY_INIT_LIB_H_
 
+/**
+  Performs FSPM UPD Policy initialization.
+
+  Value of FspmUpd has been initialized by FSP binary default value.
+  Only a subset of FspmUpd needs to be updated for different silicon sku.
+
+  @param[in, out] FspmUpd       Pointer to FSPM UPD data.
+**/
 VOID
 EFIAPI
 FspmPolicyInit (
   IN OUT VOID    *FspmUpd
   );
 
+/**
+  Performs FSPS UPD Policy initialization.
+
+  Value of FspsUpd has been initialized by FSP binary default value.
+  Only a subset of FspsUpd needs to be updated for different silicon sku.
+
+  @param[in, out] FspsUpd       Pointer to FSPS UPD data.
+**/
 VOID
 EFIAPI
 FspsPolicyInit (
diff --git a/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyUpdateLib.h b/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyUpdateLib.h
index 977c4b2052..8726d21ebc 100644
--- a/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyUpdateLib.h
+++ b/Platform/Intel/MinPlatformPkg/Include/Library/FspPolicyUpdateLib.h
@@ -15,12 +15,30 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _FSP_POLICY_UPDATE_LIB_H_
 #define _FSP_POLICY_UPDATE_LIB_H_
 
+/**
+  Performs FSPM UPD Policy update.
+
+  A platform may use this API to update the FSPM UPD policy initialized
+  by the silicon module or the default UPD data.
+  The output of FSPM UPD data from this API is the final UPD data.
+
+  @param[in, out] FspmUpd       Pointer to FSPM UPD data.
+**/
 VOID
 EFIAPI
 FspmPolicyUpdate (
   IN OUT VOID    *FspmUpd
   );
 
+/**
+  Performs FSPS UPD Policy update.
+
+  A platform may use this API to update the FSPS UPD policy initialized
+  by the silicon module or the default UPD data.
+  The output of FSPS UPD data from this API is the final UPD data.
+
+  @param[in, out] FspsUpd       Pointer to FSPS UPD data.
+**/
 VOID
 EFIAPI
 FspsPolicyUpdate (
-- 
cgit v1.2.3