src/vendorcode/amd/agesa/f15/Include/OptionsHt.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * AMD HyperTransport option API.
   6  *
   7  * Contains option pre-compile logic.  This file is used by the options
   8  * installer and internally by the HT code initializers.
   9  *
  10  * @xrefitem bom "File Content Label" "Release Content"
  11  * @e project:      AGESA
  12  * @e sub-project:  OPTION
  13  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  14  *
  15  */
  16 /*****************************************************************************
  17  *
  18  * Copyright (C) 2012 Advanced Micro Devices, Inc.
  19  * All rights reserved.
  20  *
  21  * Redistribution and use in source and binary forms, with or without
  22  * modification, are permitted provided that the following conditions are met:
  23  *     * Redistributions of source code must retain the above copyright
  24  *       notice, this list of conditions and the following disclaimer.
  25  *     * Redistributions in binary form must reproduce the above copyright
  26  *       notice, this list of conditions and the following disclaimer in the
  27  *       documentation and/or other materials provided with the distribution.
  28  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  29  *       its contributors may be used to endorse or promote products derived
  30  *       from this software without specific prior written permission.
  31  *
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  34  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  35  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  36  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  37  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  38  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  39  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  41  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42  *
  43  ******************************************************************************
  44  */
  45
  46 #ifndef _OPTION_HT_H_
  47 #define _OPTION_HT_H_
  48
  49 /*----------------------------------------------------------------------------------------
  50  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  51  *----------------------------------------------------------------------------------------
  52  */
  53
  54 /*----------------------------------------------------------------------------------------
  55  *                 D E F I N I T I O N S     A N D     M A C R O S
  56  *----------------------------------------------------------------------------------------
  57  */
  58
  59
  60 /*----------------------------------------------------------------------------------------
  61  *               T Y P E D E F S,   S T R U C T U R E S,    E N U M S
  62  *----------------------------------------------------------------------------------------
  63  */
  64
  65 /**
  66  * Provide HT build option results
  67  */
  68 typedef struct {
  69   CONST BOOLEAN IsUsingRecoveryHt;                   ///< Manual BUID Swap List processing should assume that HT Recovery was used.
  70   CONST BOOLEAN IsSetHtCrcFlood;                     ///< Enable setting of HT CRC Flood.
  71                                                      ///< Build-time only customizable - @BldCfgItem{BLDCFG_SET_HTCRC_SYNC_FLOOD}
  72   CONST BOOLEAN IsUsingUnitIdClumping;               ///< Enable automatically HT Spec compliant Unit Id Clumping.
  73                                                      ///< Build-time only customizable - @BldCfgItem{BLDCFG_USE_UNIT_ID_CLUMPING}
  74   CONST AMD_HT_INTERFACE *HtOptionPlatformDefaults;  ///< A set of build time options for HT constructor.
  75   CONST VOID *HtOptionInternalInterface;             ///< Use this internal interface initializer.
  76   CONST VOID *HtOptionInternalFeatures;              ///< Use this internal feature set initializer.
  77   CONST VOID *HtOptionFamilyNorthbridgeList;         ///< Use this list of northbridge initializers.
  78   CONST UINT8 *CONST *HtOptionBuiltinTopologies;     ///< Use this list of built-in topologies.
  79 } OPTION_HT_CONFIGURATION;
  80
  81 typedef AGESA_STATUS
  82 F_OPTION_HT_INIT_RESET (
  83   IN       AMD_CONFIG_PARAMS        *StdHeader,
  84   IN       AMD_HT_RESET_INTERFACE   *AmdHtResetInterface
  85   );
  86
  87 typedef F_OPTION_HT_INIT_RESET *PF_OPTION_HT_INIT_RESET;
  88
  89 typedef AGESA_STATUS
  90 F_OPTION_HT_RESET_CONSTRUCTOR (
  91   IN       AMD_CONFIG_PARAMS         *StdHeader,
  92   IN       AMD_HT_RESET_INTERFACE    *AmdHtResetInterface
  93   );
  94
  95 typedef F_OPTION_HT_RESET_CONSTRUCTOR *PF_OPTION_HT_RESET_CONSTRUCTOR;
  96
  97 /**
  98  * Provide HT reset initialization build option results
  99  */
 100 typedef struct {
 101   PF_OPTION_HT_INIT_RESET HtInitReset;               ///< Method: HT reset initialization.
 102   PF_OPTION_HT_RESET_CONSTRUCTOR HtResetConstructor; ///< Method: HT reset initialization.
 103 } OPTION_HT_INIT_RESET;
 104
 105 /*----------------------------------------------------------------------------------------
 106  *                        F U N C T I O N    P R O T O T Y P E
 107  *----------------------------------------------------------------------------------------
 108  */
 109
 110 #endif  // _OPTION_HT_H_