Initial XSCOM delivery

Change-Id: I80278bf2e03b4e6403d9a36b8782b225dba29fe3
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/144
Tested-by: Jenkins Server
Reviewed-by: MIKE J. JONES <mjjones@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 41 insertions, 0 deletions

diff --git a/src/usr/scom/scom.H b/src/usr/scom/scom.H
new file mode 100644
index 000000000..332883d00
--- /dev/null
+++ b/src/usr/scom/scom.H
@@ -0,0 +1,41 @@
+#ifndef __SCOM_H
+#define __SCOM_H
+
+/** @file  scom.H
+ *  @brief Provides the interfaces to perform a SCom
+ */
+
+namespace SCOM
+{
+
+/**
+ * @brief Performs an SCom operation
+ * This function performs an SCom Read/Write operation. It follows a
+ * pre-defined prototype functions in order to be registered with the
+ * device-driver framework.
+ *
+ * @param[in]   i_opType        Operation type, see DeviceFW::OperationType
+ *                              in driverif.H
+ * @param[in]   i_target        SCom target
+ * @param[in/out] io_buffer     Read: pointer to output data storage
+ *                              Write: pointer to data to be written
+ * @param[in/out] io_buflen     Input: size of io_buffer (in bytes)
+ *                              Output: Read: size of output data
+ *                                      Write: size of data written
+ * @param[in]   i_accessType    Select from DeviceFW::AccessType enum
+ *                              (usrif.H)
+ * @param[in]   i_args          This is an argument list for DD framework.
+ *                              In this function, there's only one argument,
+ *                              which is the SCom address value.
+ *
+ * @return  errlHndl_t
+ */
+errlHndl_t scomPerformOp(DeviceFW::OperationType i_opType,
+                         DeviceFW::TargetHandle_t i_target,
+                         void* io_buffer,
+                         size_t& io_buflen,
+                         int64_t i_accessType,
+                         va_list i_args);
+}; // End namespace
+
+#endif