blob: 63081ca5038848f637b7aeea4bfa51e1ed9bffa0 [file] [log] [blame]
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/hwpf/hwp/build_winkle_images/p8_slw_build/p8_pore_table_gen_api.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,2014 */
/* [+] 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 */
// $Id: p8_pore_table_gen_api.H,v 1.27 2014/06/02 18:21:55 cmolsen Exp $
/*------------------------------------------------------------------------------*/
/* *! (C) Copyright International Business Machines Corp. 2012 */
/* *! All Rights Reserved -- Property of IBM */
/* *! *** *** */
/*------------------------------------------------------------------------------*/
/* *! TITLE : p8_pore_table_gen_api.H */
/* *! DESCRIPTION : Contains all external APIs used by firmware (PHYP) to */
// generate/modify the P8 PORE SLW image with Ramming and
// Scomming specific instructions to be executed on exit from
// Sleep/Winkle. Also contains definitions for the ramming
// PORE code.
/* *! OWNER NAME : Michael Olsen Email: cmolsen@us.ibm.com */
//
/* *! COMMENTS : *** VERY IMPORTANT *** */
// The "Shared RAM section", the "Pore RAM section" and the
// "C-code RAM section" must closely match eachother.
//
/*------------------------------------------------------------------------------*/
#ifndef _P8_PORE_TABLE_GEN_API_H
#define _P8_PORE_TABLE_GEN_API_H
/********************************************************************/
/* Shared RAM section - begin */
/* This section MUST perfectly match the "Pore/C-code RAM section". */
/********************************************************************/
// Header defs (P8&PORE 64-bit notation where bits are numbered from left-to-right).
// (Some of these defs are used in the c-specific section further down.)
// -----------------------------------------------------------------------------
// Note: SPR register numbers have a swizzle about them per PPC architecture
// spr(instruction) <- spr5:9 || spr0:4
//
// For the PGAS routine, it is assumed that the API does the swizzling upon
// building the instruction held in this structure
//
// Header configuration: CPU Register Operation Header
// 0 - End: 1=End; 0=More
// 1 - Reserved
// 2:3 - Type
// 00: MTSPR
// 01: MTMSRD
// 10: Reserved
// 11: Reserved
// 4:13 - SPR number in non-swizzled form (0:9)
// 14:15 - Reserved for SPR nunmber expansion
// 16:18 - Thread ID
// 19:31 - Reserved
#define RAM_HEADER_END_START 0
#define RAM_HEADER_END_MASK BITS(RAM_HEADER_END_START,1)
#define RAM_HEADER_TYPE_START 2
#define RAM_HEADER_TYPE_MASK BITS(RAM_HEADER_TYPE_START,2)
#define RAM_HEADER_SPRN_START 4
#define RAM_HEADER_SPRN_MASK BITS(RAM_HEADER_SPRN_START,10)
#define RAM_HEADER_THREAD_START 16
#define RAM_HEADER_THREAD_MASK BITS(RAM_HEADER_THREAD_START,3)
#define RAM_INSTR_START 32
#define RAM_INSTR_MASK BITS(RAM_INSTR_START,32)
// MTSPR instr defs
#define RAM_MTSPR_INSTR_TEMPL ( ( (uint64_t)31<<(63-5) | (uint64_t)467<<(63-30) ) )
#define RAM_MTSPR_SPR_START 11
#define RAM_MTSPR_SPR_MASK BITS(RAM_MTSPR_SPR_START,10)
// Thread align defs
#define RAM_HEADER_THREAD_RALIGN ( 61-16 ) // 3 Bit shift right amount
#define RAM_HEADER_THREAD_LALIGN ( 61-16 ) // 3 Bit shift left amount
/********************************************************************/
/* Shared RAM section - end */
/********************************************************************/
#ifdef FOR_PORE_RAMMING
// Thread status
CONST_UINT64_T( PROC_RAS_STAT_10013002 , ULL(0x10013002) );
// TCTL RAS Status (for each thread)
// Note: the address is not included in the name to ease PGAS indexing
// of these registers
CONST_UINT64_T( EX_PERV_TCTL0_R_STAT , ULL(0x10013002) );
CONST_UINT64_T( EX_PERV_TCTL1_R_STAT , ULL(0x10013012) );
CONST_UINT64_T( EX_PERV_TCTL2_R_STAT , ULL(0x10013022) );
CONST_UINT64_T( EX_PERV_TCTL3_R_STAT , ULL(0x10013032) );
CONST_UINT64_T( EX_PERV_TCTL4_R_STAT , ULL(0x10013042) );
CONST_UINT64_T( EX_PERV_TCTL5_R_STAT , ULL(0x10013052) );
CONST_UINT64_T( EX_PERV_TCTL6_R_STAT , ULL(0x10013062) );
CONST_UINT64_T( EX_PERV_TCTL7_R_STAT , ULL(0x10013072) );
// Thread scratch registers
// Note: the address is not included in the name to ease PGAS indexing
// of these registers
CONST_UINT64_T( EX_PERV_SCRATCH0 , ULL(0x10013283) );
CONST_UINT64_T( EX_PERV_SCRATCH1 , ULL(0x10013284) );
CONST_UINT64_T( EX_PERV_SCRATCH2 , ULL(0x10013285) );
CONST_UINT64_T( EX_PERV_SCRATCH3 , ULL(0x10013286) );
CONST_UINT64_T( EX_PERV_SCRATCH4 , ULL(0x10013287) );
CONST_UINT64_T( EX_PERV_SCRATCH5 , ULL(0x10013288) );
CONST_UINT64_T( EX_PERV_SCRATCH6 , ULL(0x10013289) );
CONST_UINT64_T( EX_PERV_SCRATCH7 , ULL(0x1001328A) );
// Ramming settings.
CONST_UINT64_T( RAM_STATUS_REG_AFTER_RAM, 0x5000000000000000);
CONST_UINT64_T( RAM_COMPLETE_POLLS, 0x0000000000000040);
// mfspr gpr0, scratch0 opcode left-shifted 29 bits, ready for ramming.
CONST_UINT64_T( MTSPR_SCRATCH0_GPR0_RAM_READY, (0x000000007C1543A6<<29));
CONST_UINT64_T( MFSPR_GPR0_SCRATCH0_RAM_READY, (0x000000007C1542A6<<29));
CONST_UINT64_T( MTMSRD_GPR0_RAM_READY, (0x000000007C000164<<29));
CONST_UINT64_T( MFMSR_GPR0_RAM_READY, (0x000000007C0000A6<<29));
// Predefined MSR content during Ramming
CONST_UINT64_T( P8_PORE_MSR_DURING_RAM, (0x9000000002802000) );
// "reset" value of SCRATCH0 to ensure it gets updated from GPR0
CONST_UINT64_T( SCRATCH0_RESET_VALUE, (0xABBA99EBBA33DADA) );
#ifdef __ASSEMBLER__
/***********************************************************************/
/* Pore RAM section - begin */
/* This section MUST perfectly match the "Shared/C-code RAM section". */
/***********************************************************************/
.set RAM_HEADER, 0
.set RAM_INSTR, 4
.set RAM_DATA, 8
.set RAM_ENTRY_LENGTH, 16
/***********************************************************************/
/* Pore RAM section - end */
/***********************************************************************/
#endif // __ASSEMBLER__
#else // Not FOR_PORE_RAMMING
//#include <stdio.h>
#ifndef PPC_HYP
#include <stdlib.h>
#endif // PPC_HYP
#ifndef __P8_PORE_TABLE_GEN_API_C
#include <p8_pore_api_custom.h>
#endif
//#include <stdint.h>
//#include <pore_bitmanip.H>
// Defining local versions of BITS and BIT
// Create a multi-bit mask of \a n bits starting at bit \a b
#define BITS(b, n) ((ULL(0xffffffffffffffff) << (64 - (n))) >> (b))
#define BITS32(b,n) (uint32_t)((ULL(0xffffffff) << (32 - (n))) >> (b))
// Create a single bit mask at bit \a b
#define BIT(b) BITS((b), 1)
// Header defs (C notation where bits are numbered from right-to-left, and reducing to 32-bit)
#define RAM_HEADER_END_START_C ( 31-RAM_HEADER_END_START+1-1 )
#define RAM_HEADER_END_MASK_C (uint32_t)(RAM_HEADER_END_MASK>>32)
#define RAM_HEADER_TYPE_START_C ( 31-RAM_HEADER_TYPE_START+1-2 )
#define RAM_HEADER_TYPE_MASK_C (uint32_t)(RAM_HEADER_TYPE_MASK>>32)
#define RAM_HEADER_SPRN_START_C ( 31-RAM_HEADER_SPRN_START+1-10 )
#define RAM_HEADER_SPRN_MASK_C (uint32_t)(RAM_HEADER_SPRN_MASK>>32)
#define RAM_HEADER_THREAD_START_C ( 31-RAM_HEADER_THREAD_START+1-3 )
#define RAM_HEADER_THREAD_MASK_C (uint32_t)(RAM_HEADER_THREAD_MASK>>32)
// MTSPR instr defs
#define RAM_MTSPR_INSTR_TEMPL_C ( ( (uint32_t)31<<(31-5) | (uint32_t)467<<(31-30) ) )
#define RAM_MTSPR_SPR_START_C ( 31-RAM_MTSPR_SPR_START+1-10 )
//#define RAM_MTSPR_SPR_MASK_C (uint32_t)(BITS(RAM_MTSPR_SPR_START,10)>>32)
#define RAM_MTSPR_SPR_MASK_C (uint32_t)(RAM_MTSPR_SPR_MASK>>32)
// MTMSR innstr def
#define RAM_MTMSRD_INSTR_TEMPL_C ( ( (uint32_t)31<<(31-5) | (uint32_t)178<<(31-30) ) )
/* Other defs needed for ramming and scomming */
// TOC names
#define SLW_HOST_REG_VECTOR_TOC_NAME "slw_host_reg_vector"
#define SLW_HOST_SCOM_NC_VECTOR_TOC_NAME "slw_host_scom_nc_vector"
#define SLW_HOST_SCOM_L2_VECTOR_TOC_NAME "slw_host_scom_l2_vector"
#define SLW_HOST_SCOM_L3_VECTOR_TOC_NAME "slw_host_scom_l3_vector"
// Defines for slw_build() to update "runtime_scom" pointers w/pointer to
// "sub_slw_runtime_scom" subroutines at SLW image build time.
#define HOST_RUNTIME_SCOM_TOC_NAME "host_runtime_scom" // Null 1st, then fill w/addr of SLW_RUNTIME_SCOM_TOC_NAME
#define SLW_RUNTIME_SCOM_TOC_NAME "sub_slw_runtime_scom"
// The following two provide TRANSITIONAL SUPPORT only. TO BE REMOVED ASAP.
#define EX_ENABLE_RUNTIME_SCOM_TOC_NAME "ex_enable_runtime_scom"
#define SLW_EX_ENABLE_RUNTIME_SCOM_TOC_NAME "sub_slw_ex_enable_runtime_scom"
#define SCAN_MAX_ROTATE_38XXX_NAME "scan_max_rotate_38xxx"
#define SCAN_ROTATE_DEFAULT 110 // Limit suggested by Tilman.
#define SCAN_MAX_ROTATE 0x00000FE0
#define SCAN_MAX_ROTATE_LONG 0x000FFFFF // All 1s in BITS 12->31.
//#define SCAN_MAX_ROTATE_LONG 0x000000D0 // Experimental max val
#define OVER_SAMPLING_POLL 10
#define WAITS_POLL_MIN 32
// RAM table defines
#define XIPSIZE_RAM_ENTRY ( (sizeof(RamTableEntry)+7)/8*8 )
#define SLW_MAX_CORES 16
#define SLW_MAX_CPUREGS_CORE 10
#define SLW_MAX_CPUREGS_THREADS 5
#define SLW_CORE_THREADS 8
#define SLW_MAX_CPUREGS_OPS ( SLW_MAX_CPUREGS_CORE + \
SLW_CORE_THREADS*SLW_MAX_CPUREGS_THREADS )
#define SLW_RAM_TABLE_SPACE_PER_CORE ( SLW_MAX_CPUREGS_OPS * XIPSIZE_RAM_ENTRY )
#define SLW_RAM_TABLE_SIZE ( SLW_MAX_CORES * SLW_RAM_TABLE_SPACE_PER_CORE )
// SPR and MSR values for i_regName
enum {
P8_SPR_HRMOR = 313,
P8_SPR_HMEER = 337,
P8_SPR_PMICR = 852,
P8_SPR_PMCR = 884,
P8_SPR_HID0 = 1008,
P8_SPR_HID1 = 1009,
P8_SPR_HID4 = 1012,
P8_SPR_HID5 = 1014,
P8_CORE_XTRA8 =10008,
P8_CORE_XTRA9 =10009,
P8_SPR_HSPRG0 = 304,
P8_SPR_LPCR = 318,
P8_MSR_MSR = 2000,
P8_THRD_XTRA3 =20003,
P8_THRD_XTRA4 =20004
};
// SCOM table defines - Common
#define XIPSIZE_SCOM_ENTRY 16
// SCOM table defines - Non-cache section
#define SLW_MAX_SCOMS_NC 32
#define SLW_SCOM_TABLE_SPACE_PER_CORE_NC ( (SLW_MAX_SCOMS_NC+1)*XIPSIZE_SCOM_ENTRY ) // Add 1 for RNNN IIS
#define SLW_SCOM_TABLE_SIZE_NC ( SLW_MAX_CORES * SLW_SCOM_TABLE_SPACE_PER_CORE_NC )
// SCOM table defines - L2 section
#define SLW_MAX_SCOMS_L2 16
#define SLW_SCOM_TABLE_SPACE_PER_CORE_L2 ( (SLW_MAX_SCOMS_L2+1)*XIPSIZE_SCOM_ENTRY ) // Add 1 for RNNN IIS
#define SLW_SCOM_TABLE_SIZE_L2 ( SLW_MAX_CORES * SLW_SCOM_TABLE_SPACE_PER_CORE_L2 )
// SCOM table defines - L3 section
#define SLW_MAX_SCOMS_L3 16
#define SLW_SCOM_TABLE_SPACE_PER_CORE_L3 ( (SLW_MAX_SCOMS_L3+1)*XIPSIZE_SCOM_ENTRY ) // Add 1 for RNNN IIS
#define SLW_SCOM_TABLE_SIZE_L3 ( SLW_MAX_CORES * SLW_SCOM_TABLE_SPACE_PER_CORE_L3 )
#define SLW_SCOM_TABLE_SIZE_ALL ( SLW_SCOM_TABLE_SIZE_NC + SLW_SCOM_TABLE_SIZE_L2 + SLW_SCOM_TABLE_SIZE_L3)
// RAM and SCOM sub-section offsets from beginning of .slw section.
#define SLW_RAM_TABLE_OFFSET 0
#define SLW_SCOM_TABLE_OFFSET_NC (SLW_RAM_TABLE_OFFSET + SLW_RAM_TABLE_SIZE)
#define SLW_SCOM_TABLE_OFFSET_L2 (SLW_SCOM_TABLE_OFFSET_NC + SLW_SCOM_TABLE_SIZE_NC)
#define SLW_SCOM_TABLE_OFFSET_L3 (SLW_SCOM_TABLE_OFFSET_L2 + SLW_SCOM_TABLE_SIZE_L2)
#define SLW_TABLE_SIZE_ALL (SLW_RAM_TABLE_SIZE + SLW_SCOM_TABLE_SIZE_ALL)
// Enumeration of Scom sections in .slw section.
enum {
P8_SCOM_SECTION_NC = 0,
P8_SCOM_SECTION_L2 = 1,
P8_SCOM_SECTION_L3 = 2,
P8_SCOM_SECTION_MAX_VALUE = 2
};
// SLW section size (Ensure 128-byte alignment.)
#define FIXED_SLW_SECTION_SIZE (SLW_TABLE_SIZE_ALL/128+(SLW_TABLE_SIZE_ALL%128+127)/128)*128
// FFDC section size (Ensure 128-byte alignment.)
#define FIXED_FFDC_SECTION_SIZE 640*(SLW_MAX_CORES+1)
// SCOM/CID masks and ranges
#define P8_CID_EX_LOW 0x10 // Lowest EX chiplet addr
#define P8_CID_EX_HIGH 0x1f // Highest EX chiplet addr
// SCOM Operators
#define P8_PORE_SCOM_FIRST_OP 0 // First supported Scom operation.
#define P8_PORE_SCOM_APPEND 0 // Add Scom to end of table or at first PORE NOP
// instruction, whichever comes first.
#define P8_PORE_SCOM_REPLACE 1 // Repl 1st matching Scom addr or treat as APPEND
// if Scom entry is not found.
#define P8_PORE_SCOM_OR 2 // Overlay data onto existing Scom by bitwise OR.
#define P8_PORE_SCOM_AND 3 // Overlay data onto existing Scom by bitwise AND.
#define P8_PORE_SCOM_NOOP 4 // Replace existing Scom with a PORE NOP instruction,
// NNNN.
#define P8_PORE_SCOM_RESET 5 // Delete all entries for given coreID. Replace with
// PORE RET instructions, RNNN.
#define P8_PORE_SCOM_OR_APPEND 6 // Same as OR but treat as APPEND if Scom entry is
// not found.
#define P8_PORE_SCOM_AND_APPEND 7 // Same as AND but treat as APPEND if Scom entry is
// not found.
#define P8_PORE_SCOM_LAST_OP 7 // Last supported Scom operation.
// Enumeration of SLW image build modes.
enum {
P8_SLW_MODEBUILD_IPL = 0,
P8_SLW_MODEBUILD_REBUILD = 1,
P8_SLW_MODEBUILD_SRAM = 2,
P8_SLW_MODEBUILD_MAX_VALUE = 2
};
// Return codes
#define SLW_RAM_SUCCESS 0
#define SLW_RAM_HEADERS_NOT_SYNCED 1
#define SLW_RAM_IMAGE_SIZE_MISMATCH 2
#define SLW_RAM_TABLE_ENTRY_OVERFLOW 3
#define SLW_RAM_CODE_ERROR 4
#define SLW_RAM_INVALID_PARAMETER 5
#define SLW_RAM_WARNING_TABLE_CONTAMINATION 6
#ifndef PPC_HYP
#ifdef __cplusplus
extern "C" {
#endif
#endif // PPC_HYP
/********************************************************************/
/* C-code RAM section - begin */
/* This section MUST perfectly match the "Shared/Pore RAM section". */
/********************************************************************/
typedef struct ram_instr_t {
uint32_t header;
uint32_t instr;
uint64_t data;
} RamTableEntry;
/********************************************************************/
/* C-code RAM section - end */
/********************************************************************/
// SLW supported SPR registers
typedef struct {
const char *name;
uint32_t value;
uint32_t swizzled;
} SlwSprRegs;
extern const SlwSprRegs SLW_SPR_REGS[];
extern const int SLW_SPR_REGS_SIZE;
/* Name: p8_pore_gen_cpureg()
* Description: Populates ramming entries in the .slw section
* Parameter list: i_image - pointer to SLW mainstore image
* i_sizeImage - size of SLW mainstore image
* i_regName - unswizzled SPR register value
* i_regData - data to write to SPR register
* i_coreId - the core ID to operate on
* i_threadId - the thread ID to operate on
*/
uint32_t p8_pore_gen_cpureg(void *io_image,
uint32_t i_sizeImage,
uint32_t i_regName,
uint64_t i_regData,
uint32_t i_coreId,
uint32_t i_threadId);
/* Name: p8_pore_gen_scom()
* Description: Populates scom entries in the .slw section
* Parameter list: i_image - pointer to SLW mainstore image
* i_sizeImage - size of SLW mainstore image
* i_scomAddr - scom register address
* i_coreId - the core ID [0:15]
* i_scomData - 64-bit data to put in scom register
* i_operation - what to do with the scom data [0:5]
* i_section - SCOM section [0,2,3]
*/
uint32_t p8_pore_gen_scom(void *io_image,
uint32_t i_sizeImage,
uint32_t i_scomAddr,
uint32_t i_coreId,
uint64_t i_scomData,
uint32_t i_operation,
uint32_t i_section);
/* Name: p8_pore_gen_cpureg_fixed()
* Description: Populates ramming entries in the .slw section
* Parameter list: i_image - pointer to SLW mainstore image
* i_modeBuild - 0: HB/IPL mode, 1: PHYP/Rebuild mode, 2: SRAM mode.
* i_sizeImage - size of SLW mainstore image
* i_regName - unswizzled SPR register value
* i_regData - data to write to SPR register
* i_coreId - the core ID to operate on
* i_threadId - the thread ID to operate on
*/
uint32_t p8_pore_gen_cpureg_fixed(void *io_image,
uint8_t i_modeBuild,
uint32_t i_regName,
uint64_t i_regData,
uint32_t i_coreId,
uint32_t i_threadId);
/* Name: p8_pore_gen_scom_fixed()
* Description: Populates scom entries in the .slw section
* Parameter list: i_image - pointer to SLW mainstore image
* i_modeBuild - 0: HB/IPL mode, 1: PHYP/Rebuild mode, 2: SRAM mode.
* i_scomAddr - scom register address
* i_coreId - the core ID [0:15]
* i_scomData - 64-bit data to put in scom register
* i_operation - what to do with the scom data [0:5]
* i_section - 0: General Scoms, 1: L2 cache, 2: L3 cache
*/
uint32_t p8_pore_gen_scom_fixed(void *io_image,
uint8_t i_modeBuild,
uint32_t i_scomAddr,
uint32_t i_coreId,
uint64_t i_scomData,
uint32_t i_operation,
uint32_t i_section);
#ifndef PPC_HYP
#ifdef __cplusplus
}
#endif
#endif // PPC_HYP
#endif // FOR_PORE_RAMMING
#endif // _P8_PORE_TABLE_GEN_API_H