Adding structures for core data collection

RTC: 140186
Change-Id: I2bca70ddae4204ba2d5103e5afc0773e2d482f9f
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/22103
Reviewed-by: Wael Elessawy <welessa@us.ibm.com>
Reviewed-by: Fadi Kassem <fmkassem@us.ibm.com>
Reviewed-by: William A. Bryan <wilbryan@us.ibm.com>
Tested-by: William A. Bryan <wilbryan@us.ibm.com>
Tested-by: Fadi Kassem <fmkassem@us.ibm.com>

1 files changed, 161 insertions, 0 deletions

diff --git a/src/include/core_data.h b/src/include/core_data.h
new file mode 100644
index 0000000..1c10d60
--- /dev/null
+++ b/src/include/core_data.h
@@ -0,0 +1,161 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/include/core_data.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 core_data.h
+/// \brief Data structures for the GPE programs that collect raw data defined
+/// in core_data.C.  The data structure layouts are also documented in the
+/// spreadsheet \todo (RTC 137031) location.
+///
+//  *HWP HWP Owner: Doug Gilbert <dgilbert@us.ibm.com>
+//  *HWP FW Owner: Martha Broyles <mbroyles@us.ibm.com>
+//  *HWP Team: PM
+//  *HWP Level: 1
+//  *HWP Consumed by: OCC
+
+
+#ifndef __GPE_CORE_DATA_H__
+#define __GPE_CORE_DATA_H__
+
+#include <stdint.h>
+
+// TODO RTC 141391 Define this in sensor_register_addresses.h
+#define THERM_DTS_RESULT    0x00050000
+
+
+// TODO RTC 141391 This probably needs to be in firmware regs
+typedef union dts_sensor_result_reg
+{
+    uint64_t value;
+    struct
+    {
+        uint16_t  reading[2];
+        uint16_t  unused_hw2;
+        uint16_t  unused_hw3;
+    } half_words;
+} dts_sensor_result_reg_t;
+
+
+typedef struct   //40 bytes
+{
+    uint32_t unused;
+    uint32_t tod_2mhz;
+    uint32_t dispatch;
+    uint32_t completion;
+    uint32_t freq_sens_busy;
+    uint32_t freq_sens_finish;
+    uint32_t run_cycles;
+    uint32_t raw_cycles;
+    uint32_t mem_a;         // not used in P8
+    uint32_t mem_b;         // not used in P8
+} CoreDataEmpath;
+
+
+// \todo (RTC 137031) :  should seriously question the need for this
+typedef struct          //24 bytes
+{
+    uint32_t raw_cycles;
+    uint32_t tod_2mhz;
+    uint32_t count[4];          // research prototype use
+} CoreDataPerPartitionMemory;
+
+typedef struct
+{
+    uint32_t raw_cycles;
+    uint32_t tod_2mhz;
+    uint32_t ifu_throttle;
+    uint32_t isu_throttle;
+    uint32_t ifu_active;
+    uint32_t undefined;
+} CoreDataThrottle;         // not used in P8
+
+typedef struct
+{
+    uint32_t raw_cycles;    // used in P8
+    uint32_t tod_2mhz;
+    uint32_t run_cycles;    // used in P8
+    uint32_t completion;
+    uint32_t mem_a;
+    uint32_t mem_b;
+} CoreDataPerThread;
+
+typedef union sensor_result
+{
+    uint16_t result;
+    struct
+    {
+        uint16_t reading : 12;
+        uint16_t thermal_trip : 2;
+        uint16_t spare : 1;
+        uint16_t valid : 1;
+    } fields;
+
+} sensor_result_t;
+
+typedef struct
+{
+    uint32_t unused;
+    uint32_t tod_2mhz;
+    sensor_result_t core[2];
+    sensor_result_t cache;
+    sensor_result_t reserved;
+} CoreDataDts;
+
+// TODO can this section be removed?
+typedef struct
+{
+    uint32_t unused;
+    uint32_t tod_2mhz;
+    //power_management_control_reg_t pmcr;    // not used in P8
+
+    //pmsr not needed in P9 as info available from PGPE
+    //power_management_status_reg_t pmsr;
+
+    // pm_history moved to STOP HISTORY in P9
+    //ppm_pmstatehistocc_reg_t pm_history;
+} CoreDataPcbSlave;
+
+
+//
+// The instance of this data object must be 8 byte aligned
+//
+typedef struct
+{
+    CoreDataEmpath             empath;                  //40
+    CoreDataPerPartitionMemory per_partition_memory;    //24
+    CoreDataThrottle           throttle;                //24
+    CoreDataPerThread          per_thread[8];           //24 * 8
+    CoreDataDts                dts;                     //16
+    CoreDataPcbSlave           pcb_slave;               //16
+} CoreData;
+
+/**
+ * Get core data
+ * @param[in] The system core number [0-23]
+ * @param[out] Data pointer for the result
+ * @return result of scom operation
+ */
+uint32_t  get_core_data(uint32_t i_core, CoreData* o_data);
+
+#endif  /* __GPE_CORE_DATA_H__ */