Update new PPE HW code

Change-Id: I8e0f107fc08c857b00102fa67f35516a04ee6c78
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/20731
Reviewed-by: Martha Broyles <mbroyles@us.ibm.com>
Reviewed-by: William A. Bryan <wilbryan@us.ibm.com>
Tested-by: William A. Bryan <wilbryan@us.ibm.com>

1 files changed, 116 insertions, 0 deletions

diff --git a/src/ppe/sbe/sbefw/sbecmdparser.H b/src/ppe/sbe/sbefw/sbecmdparser.H
new file mode 100644
index 0000000..921637a
--- /dev/null
+++ b/src/ppe/sbe/sbefw/sbecmdparser.H
@@ -0,0 +1,116 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/ppe/sbe/sbefw/sbecmdparser.H $                            */
+/*                                                                        */
+/* OpenPOWER OnChipController Project                                     */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015                             */
+/* [+] 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                                                     */
+/*
+ * @file: ppe/sbe/sbefw/sbecmdparser.H
+ *
+ * @brief This file contains the SBE command details
+ *
+ */
+
+#ifndef __SBEFW_SBECMDPARSER_H
+#define __SBEFW_SBECMDPARSER_H
+
+#include <stdint.h>
+
+
+/**
+ *  @brief SBE Command structure associating an opcode of a command
+ *         to the processing function as well as the allowed states
+ *
+ */
+typedef uint32_t (*sbeChipOpFunc_t) (uint8_t *i_pArg);
+
+typedef struct {
+    sbeChipOpFunc_t   cmd_func;   /* Command function pointer */
+    uint8_t           cmd_opcode; /* Command opcode */
+    uint8_t  cmd_state_fence;     /* Command fencing based on SBE state */
+} sbeCmdStruct_t;
+
+
+/**
+ *  @brief SBE Command Fence attributes
+ *
+ */
+enum sbe_command_fence_attrs
+{
+    SBE_FENCE_AT_ISTEP          = 0x80, ///< Fence off the cmd at istep state
+    SBE_FENCE_AT_CONTINUOUS_IPL = 0x40, ///< Fence off the cmd at cont IPL
+    SBE_FENCE_AT_RUNTIME        = 0x20, ///< Fence off the cmd at Runtime state
+    SBE_FENCE_AT_MPIPL          = 0x10, ///< Fence off the cmd at MPIPL state
+};
+
+
+/**
+  * @brief sbeValidateCmdClass  Validates the command class and opcode
+  *
+  * @param[in]     i_cmdClass    Command class code
+  * @param[in]     i_cmdOpcode   Command opcode
+  *
+  * @return uint8_t  return code
+  *               SBE_SEC_OPERATION_SUCCESSFUL - Command found
+  *               SBE_SEC_COMMAND_CLASS_NOT_SUPPORTED
+  *               SBE_SEC_COMMAND_NOT_SUPPORTED
+  */
+uint8_t sbeValidateCmdClass (const uint8_t i_cmdClass,
+                             const uint8_t i_cmdOpcode);
+
+/**
+  * @brief sbeIsCmdAllowedAtState  Validates if the command is allowed
+  *        at the current SBE state
+  *
+  * @param[in]    i_cmdClass    Command class code
+  * @param[in]    i_cmdOpcode   Command opcode
+  *
+  * @return       true  command is allowed at the current state
+  *               false command is not allowed at the current state
+  */
+bool sbeIsCmdAllowedAtState (const uint8_t i_cmdClass,
+                             const uint8_t i_cmdOpcode);
+
+
+/**
+  * @brief sbeCmdFunc_t Typical signature for any SBE ChipOp back-end function
+  *
+  * @param[in]  uint8_t *i_pArg  Pointer to the argument to be passed to
+  *                              the chipOp function
+  *
+  * @return     uint32_t Return code from the chipOp function
+  */
+typedef uint32_t ( *sbeCmdFunc_t ) (uint8_t *i_pArg);
+
+
+/**
+  * @brief sbeFindCmdFunc  Finds the function corresponding to the command
+  *
+  * @param[in]     i_cmdClass    Command class code
+  * @param[in]     i_cmdOpcode   Command opcode
+  *
+  * @return  sbeCmdFunc_t A pointer to the corresponding ChipOps function
+  */
+sbeCmdFunc_t sbeFindCmdFunc (const uint8_t i_cmdClass,
+                             const uint8_t i_cmdOpcode);
+
+
+#endif // __SBEFW_SBECMDPARSER_H