From 1dbb91e5eeb4078d8eba2a4afa5a88ee147ceddb Mon Sep 17 00:00:00 2001
From: Mike Baiocchi <mbaiocch@us.ibm.com>
Date: Fri, 1 Nov 2019 14:39:13 -0500
Subject: Add new Key Clear Request Attribute

This commit adds a new Key Clear Request Attribute and Enumeration
to be shared by the FSP and Hostboot code for future Key Clear
support.

Change-Id: I74bb9c12ed1d3fdcf8f55c77c76d4001b15e3b0f
RTC:210301
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/86409
Reviewed-by: Christopher J Engel <cjengel@us.ibm.com>
Reviewed-by: Ilya Smirnov <ismirno@us.ibm.com>
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Reviewed-by: Nicholas E Bofferding <bofferdn@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M Crowell <dcrowell@us.ibm.com>
---
 .../targeting/common/xmltohb/attribute_types.xml   | 75 ++++++++++++++++++++++
 src/usr/targeting/common/xmltohb/target_types.xml  |  3 +
 2 files changed, 78 insertions(+)

(limited to 'src/usr/targeting/common')

diff --git a/src/usr/targeting/common/xmltohb/attribute_types.xml b/src/usr/targeting/common/xmltohb/attribute_types.xml
index 72842c83d..0fb3ff9aa 100644
--- a/src/usr/targeting/common/xmltohb/attribute_types.xml
+++ b/src/usr/targeting/common/xmltohb/attribute_types.xml
@@ -2970,6 +2970,81 @@
     <writeable/>
   </attribute>
 
+  <attribute>
+    <id>KEY_CLEAR_REQUEST</id>
+    <description>
+        Indicates types of Key Clear Requests are being made
+    </description>
+    <persistency>volatile-zeroed</persistency>
+    <readable/>
+    <simpleType>
+      <enumeration>
+        <id>KEY_CLEAR_REQUEST</id>
+        <default>NONE</default>
+      </enumeration>
+    </simpleType>
+    <writeable/>
+  </attribute>
+
+  <enumerationType>
+    <id>KEY_CLEAR_REQUEST</id>
+    <description>
+        Enum indicating the different possible Key Clear Request values
+    </description>
+    <enumerator>
+      <description>
+          (Default) Key clear not requested
+      </description>
+      <name>NONE</name>
+      <value>0x0000</value>
+    </enumerator>
+    <enumerator>
+      <description>
+          Clear/reset all sensitive data controlled by platform firmware
+          from the system
+      </description>
+      <name>ALL</name>
+      <value>0x8000</value>
+    </enumerator>
+    <enumerator>
+      <description>
+          This indicates OPAL to clear the OS platform key
+      </description>
+      <name>OS_PK</name>
+      <value>0x4000</value>
+    </enumerator>
+    <enumerator>
+      <description>
+          This indicates to OPAL/PEF to clear the System Security Officer
+          certificate
+      </description>
+      <name>PEF_SSO</name>
+      <value>0x2000</value>
+    </enumerator>
+    <enumerator>
+      <description>
+          This indicates to PowerVM to clear the system key to the default state
+      </description>
+      <name>POWERVM_SYSKEY</name>
+      <value>0x1000</value>
+    </enumerator>
+    <enumerator>
+      <description>
+          Clear all sensitive data for MFG processing
+          Only valid on development drivers
+      </description>
+      <name>MFG</name>
+      <value>0x0100</value>
+    </enumerator>
+    <enumerator>
+      <description>
+          Reserved bits
+      </description>
+      <name>RESERVED</name>
+      <value>0x00FF</value>
+    </enumerator>
+  </enumerationType>
+
   <enumerationType>
     <id>KEY_TRANSITION_STATE</id>
     <description>
diff --git a/src/usr/targeting/common/xmltohb/target_types.xml b/src/usr/targeting/common/xmltohb/target_types.xml
index 737929ab9..e5e04f9dd 100644
--- a/src/usr/targeting/common/xmltohb/target_types.xml
+++ b/src/usr/targeting/common/xmltohb/target_types.xml
@@ -1225,6 +1225,9 @@
       <default>0x00000039</default>
       <id>HWAS_STATE_CHANGED_SUBSCRIPTION_MASK</id>
     </attribute>
+    <attribute>
+      <id>KEY_CLEAR_REQUEST</id>
+    </attribute>
     <attribute>
       <id>KEY_TRANSITION_STATE</id>
     </attribute>
-- 
cgit v1.2.1