From 13627efca35d5049af0bafc72982deb4ac21bd5e Mon Sep 17 00:00:00 2001
From: Christian Geddes <crgeddes@us.ibm.com>
Date: Wed, 24 Oct 2018 10:47:24 -0500
Subject: Add exp_i2c_scom driver that will be consumed by HB/SBE platforms

This commit adds a new exp_i2c_scom.H file which contains two
functions, i2c_get_scom and i2c_put_scom. These functions will
take in a fapi2 OCMB target, an address and a buffer that either
contains scom data to write or space for scom data to be written
to. The functions use the fapi2::puti2c / fapi2::geti2c interfaces
to perform the scoms.

Change-Id: I92ac697e9ec4d392e1f382e057fbbf8915b78212
Original-Change-Id: I4de680e187258cbfc57dd71f698dc1fc8760cefb
RTC:196806
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/67949
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Hostboot CI <hostboot-ci+hostboot@us.ibm.com>
Reviewed-by: Louis Stermole <stermole@us.ibm.com>
Reviewed-by: STEPHEN GLANCY <sglancy@us.ibm.com>
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/86610
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: RAJA DAS <rajadas2@in.ibm.com>
---
 .../xml/error_info/exp_i2c_scom_errors.xml         | 62 ++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_i2c_scom_errors.xml

diff --git a/src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_i2c_scom_errors.xml b/src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_i2c_scom_errors.xml
new file mode 100644
index 00000000..0f90f2b8
--- /dev/null
+++ b/src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_i2c_scom_errors.xml
@@ -0,0 +1,62 @@
+<!-- IBM_PROLOG_BEGIN_TAG                                                   -->
+<!-- This is an automatically generated prolog.                             -->
+<!--                                                                        -->
+<!-- $Source: src/import/chips/ocmb/explorer/procedures/xml/error_info/exp_i2c_scom_errors.xml $ -->
+<!--                                                                        -->
+<!-- OpenPOWER sbe Project                                                  -->
+<!--                                                                        -->
+<!-- Contributors Listed Below - COPYRIGHT 2018,2019                        -->
+<!-- [+] International Business Machines Corp.                              -->
+<!--                                                                        -->
+<!--                                                                        -->
+<!-- Licensed under the Apache License, Version 2.0 (the "License");        -->
+<!-- you may not use this file except in compliance with the License.       -->
+<!-- You may obtain a copy of the License at                                -->
+<!--                                                                        -->
+<!--     http://www.apache.org/licenses/LICENSE-2.0                         -->
+<!--                                                                        -->
+<!-- Unless required by applicable law or agreed to in writing, software    -->
+<!-- distributed under the License is distributed on an "AS IS" BASIS,      -->
+<!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        -->
+<!-- implied. See the License for the specific language governing           -->
+<!-- permissions and limitations under the License.                         -->
+<!--                                                                        -->
+<!-- IBM_PROLOG_END_TAG                                                     -->
+<hwpErrors>
+  <hwpError>
+    <rc>RC_I2C_GET_SCOM_INVALID_READ_SIZE</rc>
+    <description>
+       First Byte data returned from the i2c register read contains
+       the size of the remaining bytes returned. This should match
+       the number of bytes we requested.
+    </description>
+    <ffdc>TARGET</ffdc>
+    <ffdc>ADDRESS</ffdc>
+    <ffdc>SIZE_RETURNED</ffdc>
+    <ffdc>SIZE_REQUESTED</ffdc>
+  </hwpError>
+
+  <hwpError>
+    <rc>RC_I2C_SCOM_EXPECTED_IBM_INDICATOR</rc>
+    <description>
+       First Byte of the address passed to i2c_scom operation did not match
+       what was required for IBM scom. I2c scoms associated with 64 bits of
+       are assumed to be IBM scoms and must have 0x08 set in the first byte
+       of the address.
+    </description>
+    <ffdc>TARGET</ffdc>
+    <ffdc>ADDRESS</ffdc>
+  </hwpError>
+
+  <hwpError>
+    <rc>RC_I2C_SCOM_UNEXPECTED_IBM_INDICATOR</rc>
+    <description>
+       First Byte of the address passed to i2c_scom operation had 0x08 set which
+       indicates IBM scom. But the data associated with the address does not
+       match IBM scom data size.
+    </description>
+    <ffdc>TARGET</ffdc>
+    <ffdc>ADDRESS</ffdc>
+  </hwpError>
+
+  </hwpErrors>
-- 
cgit v1.2.1