| /* $NoKeywords:$ */ |
| /** |
| * @file |
| * |
| * AMD Memory option API. |
| * |
| * Contains structures and values used to control the Memory option code. |
| * |
| * @xrefitem bom "File Content Label" "Release Content" |
| * @e project: AGESA |
| * @e sub-project: OPTION |
| * @e \$Revision: 64574 $ @e \$Date: 2012-01-25 01:01:51 -0600 (Wed, 25 Jan 2012) $ |
| * |
| */ |
| /***************************************************************************** |
| * |
| * Copyright 2008 - 2012 ADVANCED MICRO DEVICES, INC. All Rights Reserved. |
| * |
| * AMD is granting you permission to use this software (the Materials) |
| * pursuant to the terms and conditions of your Software License Agreement |
| * with AMD. This header does *NOT* give you permission to use the Materials |
| * or any rights under AMD's intellectual property. Your use of any portion |
| * of these Materials shall constitute your acceptance of those terms and |
| * conditions. If you do not agree to the terms and conditions of the Software |
| * License Agreement, please do not use any portion of these Materials. |
| * |
| * CONFIDENTIALITY: The Materials and all other information, identified as |
| * confidential and provided to you by AMD shall be kept confidential in |
| * accordance with the terms and conditions of the Software License Agreement. |
| * |
| * LIMITATION OF LIABILITY: THE MATERIALS AND ANY OTHER RELATED INFORMATION |
| * PROVIDED TO YOU BY AMD ARE PROVIDED "AS IS" WITHOUT ANY EXPRESS OR IMPLIED |
| * WARRANTY OF ANY KIND, INCLUDING BUT NOT LIMITED TO WARRANTIES OF |
| * MERCHANTABILITY, NONINFRINGEMENT, TITLE, FITNESS FOR ANY PARTICULAR PURPOSE, |
| * OR WARRANTIES ARISING FROM CONDUCT, COURSE OF DEALING, OR USAGE OF TRADE. |
| * IN NO EVENT SHALL AMD OR ITS LICENSORS BE LIABLE FOR ANY DAMAGES WHATSOEVER |
| * (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS |
| * INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT OF AMD'S NEGLIGENCE, |
| * GROSS NEGLIGENCE, THE USE OF OR INABILITY TO USE THE MATERIALS OR ANY OTHER |
| * RELATED INFORMATION PROVIDED TO YOU BY AMD, EVEN IF AMD HAS BEEN ADVISED OF |
| * THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME JURISDICTIONS PROHIBIT THE |
| * EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, |
| * THE ABOVE LIMITATION MAY NOT APPLY TO YOU. |
| * |
| * AMD does not assume any responsibility for any errors which may appear in |
| * the Materials or any other related information provided to you by AMD, or |
| * result from use of the Materials or any related information. |
| * |
| * You agree that you will not reverse engineer or decompile the Materials. |
| * |
| * NO SUPPORT OBLIGATION: AMD is not obligated to furnish, support, or make any |
| * further information, software, technical information, know-how, or show-how |
| * available to you. Additionally, AMD retains the right to modify the |
| * Materials at any time, without notice, and is not obligated to provide such |
| * modified Materials to you. |
| * |
| * U.S. GOVERNMENT RESTRICTED RIGHTS: The Materials are provided with |
| * "RESTRICTED RIGHTS." Use, duplication, or disclosure by the Government is |
| * subject to the restrictions as set forth in FAR 52.227-14 and |
| * DFAR252.227-7013, et seq., or its successor. Use of the Materials by the |
| * Government constitutes acknowledgement of AMD's proprietary rights in them. |
| * |
| * EXPORT ASSURANCE: You agree and certify that neither the Materials, nor any |
| * direct product thereof will be exported directly or indirectly, into any |
| * country prohibited by the United States Export Administration Act and the |
| * regulations thereunder, without the required authorization from the U.S. |
| * government nor will be used for any purpose prohibited by the same. |
| ****************************************************************************** |
| */ |
| |
| #ifndef _OPTION_MEMORY_H_ |
| #define _OPTION_MEMORY_H_ |
| |
| /* Memory Includes */ |
| #include "mm.h" |
| #include "mn.h" |
| #include "mt.h" |
| #include "ma.h" |
| #include "mp.h" |
| /*---------------------------------------------------------------------------------------- |
| * M I X E D (Definitions And Macros / Typedefs, Structures, Enums) |
| *---------------------------------------------------------------------------------------- |
| */ |
| |
| /*---------------------------------------------------------------------------------------- |
| * D E F I N I T I O N S A N D M A C R O S |
| *---------------------------------------------------------------------------------------- |
| */ |
| |
| #define MAX_FF_TYPES 6 ///< Maximum number of DDR Form factors (UDIMMs, RDIMMMs, SODIMMS) supported |
| |
| /*---------------------------------------------------------------------------------------- |
| * T Y P E D E F S, S T R U C T U R E S, E N U M S |
| *---------------------------------------------------------------------------------------- |
| */ |
| |
| /* |
| * STANDARD MEMORY FEATURE FUNCTION POINTER |
| */ |
| |
| typedef BOOLEAN OPTION_MEM_FEATURE_NB ( |
| IN OUT MEM_NB_BLOCK *NBPtr |
| ); |
| |
| typedef BOOLEAN MEM_TECH_FEAT ( |
| IN OUT MEM_TECH_BLOCK *TechPtr |
| ); |
| |
| typedef UINT8 MEM_TABLE_FEAT ( |
| IN OUT MEM_TABLE_ALIAS **MTPtr |
| ); |
| |
| #define MEM_FEAT_BLOCK_NB_STRUCT_VERSION 0x01 |
| |
| /** |
| * MEMORY FEATURE BLOCK - This structure serves as a vector table for standard |
| * memory feature implementation functions. It contains vectors for all of the |
| * features that are supported by the various Northbridge devices supported by |
| * AGESA. |
| */ |
| typedef struct _MEM_FEAT_BLOCK_NB { |
| UINT16 OptMemFeatVersion; ///< Version of memory feature block. |
| OPTION_MEM_FEATURE_NB *OnlineSpare; ///< Online spare support. |
| OPTION_MEM_FEATURE_NB *InterleaveBanks; ///< Bank (Chip select) interleaving support. |
| OPTION_MEM_FEATURE_NB *UndoInterleaveBanks; ///< Undo Bank (Chip Select) interleaving. |
| OPTION_MEM_FEATURE_NB *CheckInterleaveNodes; ///< Check for Node interleaving support. |
| OPTION_MEM_FEATURE_NB *InterleaveNodes; ///< Node interleaving support. |
| OPTION_MEM_FEATURE_NB *InterleaveChannels; ///< Channel interleaving support. |
| OPTION_MEM_FEATURE_NB *InterleaveRegion; ///< Interleave Region support. |
| OPTION_MEM_FEATURE_NB *CheckEcc; ///< Check for ECC support. |
| OPTION_MEM_FEATURE_NB *InitEcc; ///< ECC support. |
| OPTION_MEM_FEATURE_NB *Training; ///< Choose the type of training (Parallel, standard or hardcoded). |
| OPTION_MEM_FEATURE_NB *LvDdr3; ///< Low voltage DDR3 dimm support |
| OPTION_MEM_FEATURE_NB *OnDimmThermal; ///< On-Dimm thermal management |
| MEM_TECH_FEAT *DramInit; ///< Choose the type of Dram init (hardware based or software based). |
| OPTION_MEM_FEATURE_NB *ExcludeDIMM; ///< Exclude a dimm. |
| OPTION_MEM_FEATURE_NB *excel221; |
| OPTION_MEM_FEATURE_NB *InitCPG; ///< Continuous pattern generation. |
| OPTION_MEM_FEATURE_NB *InitHwRxEn; ///< Hardware Receiver Enable Training Initilization. |
| } MEM_FEAT_BLOCK_NB; |
| |
| typedef AGESA_STATUS MEM_MAIN_FLOW_CONTROL ( |
| IN OUT MEM_MAIN_DATA_BLOCK *MemMainPtr |
| ); |
| |
| typedef BOOLEAN OPTION_MEM_FEATURE_MAIN ( |
| IN MEM_MAIN_DATA_BLOCK *MMPtr |
| ); |
| |
| typedef BOOLEAN MEM_NB_CONSTRUCTOR ( |
| IN OUT MEM_NB_BLOCK *NBPtr, |
| IN OUT MEM_DATA_STRUCT *MemPtr, |
| IN MEM_FEAT_BLOCK_NB *FeatPtr, |
| IN MEM_SHARED_DATA *mmSharedPtr, ///< Pointer to Memory scratchpad |
| IN UINT8 NodeID |
| ); |
| |
| typedef BOOLEAN MEM_TECH_CONSTRUCTOR ( |
| IN OUT MEM_TECH_BLOCK *TechPtr, |
| IN OUT MEM_NB_BLOCK *NBPtr |
| ); |
| |
| typedef VOID MEM_INITIALIZER ( |
| IN OUT MEM_DATA_STRUCT *MemPtr |
| ); |
| |
| typedef AGESA_STATUS MEM_PLATFORM_CFG ( |
| IN struct _MEM_DATA_STRUCT *MemData, |
| IN UINT8 SocketID, |
| IN CH_DEF_STRUCT *CurrentChannel |
| ); |
| |
| typedef BOOLEAN MEM_IDENDIMM_CONSTRUCTOR ( |
| IN OUT MEM_NB_BLOCK *NBPtr, |
| IN OUT MEM_DATA_STRUCT *MemPtr, |
| IN UINT8 NodeID |
| ); |
| |
| typedef VOID MEM_TECH_TRAINING_FEAT ( |
| IN OUT MEM_TECH_BLOCK *TechPtr, |
| IN UINT8 Pass |
| ); |
| |
| typedef BOOLEAN MEM_RESUME_CONSTRUCTOR ( |
| IN OUT VOID *S3NBPtr, |
| IN OUT MEM_DATA_STRUCT *MemPtr, |
| IN UINT8 NodeID |
| ); |
| |
| typedef AGESA_STATUS MEM_PLAT_SPEC_CFG ( |
| IN struct _MEM_DATA_STRUCT *MemData, |
| IN OUT CH_DEF_STRUCT *CurrentChannel, |
| IN OUT MEM_PS_BLOCK *PsPtr |
| ); |
| |
| typedef AGESA_STATUS MEM_FLOW_CFG ( |
| IN OUT MEM_MAIN_DATA_BLOCK *MemData |
| ); |
| |
| #define MEM_FEAT_BLOCK_MAIN_STRUCT_VERSION 0x01 |
| |
| /** |
| * MAIN FEATURE BLOCK - This structure serves as vector table for memory features |
| * that shared between all northbridge devices. |
| */ |
| typedef struct _MEM_FEAT_BLOCK_MAIN { |
| UINT16 OptMemFeatVersion; ///< Version of main feature block. |
| OPTION_MEM_FEATURE_MAIN *Training; ///< Training features. |
| OPTION_MEM_FEATURE_MAIN *ExcludeDIMM; ///< Exclude a dimm. |
| OPTION_MEM_FEATURE_MAIN *OnlineSpare; ///< On-line spare. |
| OPTION_MEM_FEATURE_MAIN *InterleaveNodes; ///< Node interleave. |
| OPTION_MEM_FEATURE_MAIN *InitEcc; ///< Initialize ECC on all nodes if they all support it. |
| OPTION_MEM_FEATURE_MAIN *MemClr; ///< Memory Clear. |
| OPTION_MEM_FEATURE_MAIN *MemDmi; ///< Memory DMI Support. |
| OPTION_MEM_FEATURE_MAIN *excel222; |
| OPTION_MEM_FEATURE_MAIN *LvDDR3; ///< Low voltage DDR3 support. |
| OPTION_MEM_FEATURE_MAIN *UmaAllocation; ///< Uma Allocation. |
| OPTION_MEM_FEATURE_MAIN *MemSave; ///< Memory Context Save |
| OPTION_MEM_FEATURE_MAIN *MemRestore; ///< Memory Context Restore |
| } MEM_FEAT_BLOCK_MAIN; |
| |
| #define MEM_NB_SUPPORT_STRUCT_VERSION 0x01 |
| #define MEM_TECH_FEAT_BLOCK_STRUCT_VERSION 0x01 |
| #define MEM_TECH_TRAIN_SEQUENCE_STRUCT_VERSION 0x01 |
| #define MEM_TECH_LRDIMM_STRUCT_VERSION 0x01 |
| /** |
| * MEMORY TECHNOLOGY FEATURE BLOCK - This structure serves as a vector table for standard |
| * memory feature implementation functions. It contains vectors for all of the |
| * features that are supported by the various Technology features supported by |
| * AGESA. |
| */ |
| typedef struct _MEM_TECH_FEAT_BLOCK { |
| UINT16 OptMemTechFeatVersion; ///< Version of memory Tech feature block. |
| MEM_TECH_FEAT *EnterHardwareTraining; ///<Enter HW WL Training |
| MEM_TECH_FEAT *SwWLTraining; ///<SW Write Levelization training |
| MEM_TECH_FEAT *HwBasedWLTrainingPart1; ///<HW based write levelization Training Part 1 |
| MEM_TECH_FEAT *HwBasedDQSReceiverEnableTrainingPart1; ///<HW based DQS receiver Enabled Training Part 1 |
| MEM_TECH_FEAT *HwBasedWLTrainingPart2; ///<HW based write levelization Training Part 2 |
| MEM_TECH_FEAT *HwBasedDQSReceiverEnableTrainingPart2; ///<HW based DQS receiver Enabled Training Part 2 |
| MEM_TECH_FEAT *TrainExitHwTrn; ///<Exit HW WL Training |
| MEM_TECH_FEAT *NonOptimizedSWDQSRecEnTrainingPart1; ///< Non-Optimized Software based receiver Enable Training part 1 |
| MEM_TECH_FEAT *OptimizedSwDqsRecEnTrainingPart1; ///< Optimized Software based receiver Enable Training part 1 |
| MEM_TECH_FEAT *NonOptimizedSRdWrPosTraining; ///< Non-Optimized Rd Wr Position training |
| MEM_TECH_FEAT *OptimizedSRdWrPosTraining; ///< Optimized Rd Wr Position training |
| MEM_TECH_FEAT *MaxRdLatencyTraining; ///< MaxReadLatency Training |
| MEM_TECH_FEAT *RdPosTraining; ///< HW Rx En Seed Training |
| } MEM_TECH_FEAT_BLOCK; |
| |
| /** |
| * MEMORY TECHNOLOGY LRDIMM BLOCK - This structure serves as a vector table for standard |
| * memory feature implementation functions. It contains vectors for all of the |
| * features that are supported by the various LRDIMM features supported by |
| * AGESA. |
| */ |
| typedef struct _MEM_TECH_LRDIMM { |
| UINT16 OptMemTechLrdimmVersion; ///< Version of memory Tech feature block. |
| MEM_TECH_FEAT *MemTInitializeLrdimm; ///< LRDIMM initialization |
| } MEM_TECH_LRDIMM; |
| /** |
| * MEMORY NORTHBRIDGE SUPPORT STRUCT - This structure groups the Northbridge dependent |
| * options together in a list to provide a single access point for all code to use |
| * and to ensure that everything corresponding to the same NB type is grouped together. |
| * |
| * The Technology Block pointers are not included in this structure because DRAM technology |
| * needs to be decoupled from the northbridge type. |
| * |
| */ |
| typedef struct _MEM_NB_SUPPORT { |
| UINT16 MemNBSupportVersion; ///< Version of northbridge support. |
| MEM_NB_CONSTRUCTOR *MemConstructNBBlock; ///< NorthBridge block constructor. |
| MEM_INITIALIZER *MemNInitDefaults; ///< Default value initialization for MEM_DATA_STRUCT. |
| MEM_FEAT_BLOCK_NB *MemFeatBlock; ///< Memory feature block. |
| MEM_RESUME_CONSTRUCTOR *MemS3ResumeConstructNBBlock; ///< S3 memory initialization northbridge block constructor. |
| MEM_IDENDIMM_CONSTRUCTOR *MemIdentifyDimmConstruct; ///< Constructor for address to dimm identification. |
| } MEM_NB_SUPPORT; |
| |
| /* |
| * MEMORY Non-Training FEATURES - This structure serves as a vector table for standard |
| * memory non-training feature implementation functions. It contains vectors for all of the |
| * features that are supported by the various Technology devices supported by |
| * AGESA. |
| */ |
| |
| /** |
| * MAIN TRAINING SEQUENCE LIST - This structure serves as vector table for memory features |
| * that shared between all northbridge devices. |
| */ |
| typedef struct _MEM_FEAT_TRAIN_SEQ { |
| UINT16 OptMemTrainingSequenceListVersion; ///< Version of main feature block. |
| OPTION_MEM_FEATURE_NB *TrainingSequence; ///< Training Sequence function. |
| OPTION_MEM_FEATURE_NB *TrainingSequenceEnabled; ///< Enable function. |
| MEM_TECH_FEAT_BLOCK *MemTechFeatBlock; ///< Memory feature block. |
| } MEM_FEAT_TRAIN_SEQ; |
| |
| /** |
| * PLATFORM SPECIFIC CONFIGURATION BLOCK - This structure groups various PSC table |
| * entries which are used by PSC engine |
| */ |
| typedef struct _MEM_PSC_TABLE_BLOCK { |
| PSC_TBL_ENTRY **TblEntryOfMaxFreq; ///< Table entry of MaxFreq. |
| PSC_TBL_ENTRY **TblEntryOfDramTerm; ///< Table entry of Dram Term. |
| PSC_TBL_ENTRY **TblEntryOfODTPattern; ///< Table entry of ODT Pattern. |
| PSC_TBL_ENTRY **TblEntryOfSAO; ///< Table entry of Slow access mode, AddrTmg and ODC.. |
| PSC_TBL_ENTRY **TblEntryOfMR0WR; ///< Table entry of MR0[WR]. |
| PSC_TBL_ENTRY **TblEntryOfMR0CL; ///< Table entry of MR0[CL]. |
| PSC_TBL_ENTRY **TblEntryOfRC2IBT; ///< Table entry of RC2 IBT. |
| PSC_TBL_ENTRY **TblEntryOfRC10OpSpeed; ///< Table entry of RC10[operating speed]. |
| PSC_TBL_ENTRY **TblEntryOfLRIBT;///< Table entry of LRDIMM IBT |
| PSC_TBL_ENTRY **TblEntryOfLRNPR; ///< Table entry of LRDIMM F0RC13[NumPhysicalRanks]. |
| PSC_TBL_ENTRY **TblEntryOfLRNLR; ///< Table entry of LRDIMM F0RC13[NumLogicalRanks]. |
| PSC_TBL_ENTRY **TblEntryOfGen; ///< Table entry of CLKDis map and CKE, ODT as well as ChipSel tri-state map. |
| PSC_TBL_ENTRY **excel224; |
| PSC_TBL_ENTRY **TblEntryOfWLSeed; ///< Table entry of WL seed |
| PSC_TBL_ENTRY **TblEntryOfHWRxENSeed; ///< Table entry of HW RxEN seed |
| } MEM_PSC_TABLE_BLOCK; |
| |
| typedef BOOLEAN MEM_PSC_FLOW ( |
| IN OUT MEM_NB_BLOCK *NBPtr, |
| IN MEM_PSC_TABLE_BLOCK *EntryOfTables |
| ); |
| |
| /** |
| * PLATFORM SPECIFIC CONFIGURATION FLOW BLOCK - Pointers to the sub-engines of platform |
| * specific configuration. |
| */ |
| typedef struct _MEM_PSC_FLOW_BLOCK { |
| MEM_PSC_TABLE_BLOCK *EntryOfTables; ///<Entry of NB specific MEM_PSC_TABLE_BLOCK |
| MEM_PSC_FLOW *MaxFrequency; ///< Sub-engine which performs "Max Frequency" value extraction. |
| MEM_PSC_FLOW *DramTerm; ///< Sub-engine which performs "Dram Term" value extraction. |
| MEM_PSC_FLOW *ODTPattern; ///< Sub-engine which performs "ODT Pattern" value extraction. |
| MEM_PSC_FLOW *SAO; ///< Sub-engine which performs "Slow access mode, AddrTmg and ODC" value extraction. |
| MEM_PSC_FLOW *MR0WrCL; ///< Sub-engine which performs "MR0[WR] and MR0[CL]" value extraction. |
| MEM_PSC_FLOW *RC2IBT; ///< Sub-engine "RC2 IBT" value extraction. |
| MEM_PSC_FLOW *RC10OpSpeed; ///< Sub-engine "RC10[operating speed]" value extraction. |
| MEM_PSC_FLOW *LRIBT; ///< Sub-engine "LRDIMM IBT" value extraction. |
| MEM_PSC_FLOW *LRNPR; ///< Sub-engine "LRDIMM F0RC13[NumPhysicalRanks]" value extraction. |
| MEM_PSC_FLOW *LRNLR; ///< Sub-engine "LRDIMM F0RC13[NumLogicalRanks]" value extraction. |
| MEM_PSC_FLOW *excel225; |
| MEM_PSC_FLOW *TrainingSeedVal; ///< Sub-engine for WL and HW RxEn pass1 seed value extraction |
| } MEM_PSC_FLOW_BLOCK; |
| |
| /*---------------------------------------------------------------------------------------- |
| * F U N C T I O N P R O T O T Y P E |
| *---------------------------------------------------------------------------------------- |
| */ |
| /* Feature Default Return */ |
| BOOLEAN MemFDefRet ( |
| IN OUT MEM_NB_BLOCK *NBPtr |
| ); |
| |
| BOOLEAN MemMDefRet ( |
| IN MEM_MAIN_DATA_BLOCK *MMPtr |
| ); |
| |
| BOOLEAN MemMDefRetFalse ( |
| IN MEM_MAIN_DATA_BLOCK *MMPtr |
| ); |
| |
| /* Table Feature Default Return */ |
| UINT8 MemFTableDefRet ( |
| IN OUT MEM_TABLE_ALIAS **MTPtr |
| ); |
| /* S3 Feature Default Return */ |
| BOOLEAN MemFS3DefConstructorRet ( |
| IN OUT VOID *S3NBPtr, |
| IN OUT MEM_DATA_STRUCT *MemPtr, |
| IN UINT8 NodeID |
| ); |
| |
| BOOLEAN MemNIdentifyDimmConstructorRetDef ( |
| IN OUT MEM_NB_BLOCK *NBPtr, |
| IN OUT MEM_DATA_STRUCT *MemPtr, |
| IN UINT8 NodeID |
| ); |
| |
| BOOLEAN |
| MemProcessConditionalOverrides ( |
| IN PSO_TABLE *PlatformMemoryConfiguration, |
| IN OUT MEM_NB_BLOCK *NBPtr, |
| IN UINT8 PsoAction, |
| IN UINT8 Dimm |
| ); |
| |
| #endif // _OPTION_MEMORY_H_ |