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

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  *
   6  *
   7  *
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project:      AGESA
  11  * @e sub-project:  GNB
  12  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  13  *
  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
  47 /*----------------------------------------------------------------------------------------
  48  *                             M O D U L E S    U S E D
  49  *----------------------------------------------------------------------------------------
  50  */
  51
  52 /*----------------------------------------------------------------------------------------
  53  *                   D E F I N I T I O N S    A N D    M A C R O S
  54  *----------------------------------------------------------------------------------------
  55  */
  56
  57
  58 /*----------------------------------------------------------------------------------------
  59  *                  T Y P E D E F S     A N D     S T R U C T U  R E S
  60  *----------------------------------------------------------------------------------------
  61  */
  62
  63
  64 /*----------------------------------------------------------------------------------------
  65  *           P R O T O T Y P E S     O F     L O C A L     F U  N C T I O N S
  66  *----------------------------------------------------------------------------------------
  67  */
  68 AGESA_STATUS
  69 GnbInitAtReset (
  70   IN      AMD_CONFIG_PARAMS       *StdHeader
  71   );
  72
  73 AGESA_STATUS
  74 GnbInitAtEarly (
  75   IN OUT   AMD_EARLY_PARAMS        *EarlyParamsPtr
  76   );
  77
  78 VOID
  79 GnbInitDataStructAtEnvDef (
  80   IN OUT  GNB_ENV_CONFIGURATION   *GnbEnvConfigPtr,
  81   IN      AMD_ENV_PARAMS          *EnvParamsPtr
  82   );
  83
  84 AGESA_STATUS
  85 GnbInitAtEnv (
  86   IN       AMD_ENV_PARAMS          *EnvParamsPtr
  87   );
  88
  89 AGESA_STATUS
  90 GnbInitAtPost (
  91   IN OUT  AMD_POST_PARAMS         *PostParamsPtr
  92   );
  93
  94 AGESA_STATUS
  95 GnbInitAtMid (
  96   IN OUT   AMD_MID_PARAMS          *MidParamsPtr
  97   );
  98
  99 AGESA_STATUS
 100 GnbInitAtLate (
 101   IN OUT   AMD_LATE_PARAMS         *LateParamsPtr
 102   );
 103
 104 AGESA_STATUS
 105 AmdGnbRecovery (
 106   IN       AMD_CONFIG_PARAMS *StdHeader
 107   );
 108
 109 AGESA_STATUS
 110 GnbInitAtPostAfterDram (
 111   IN OUT   AMD_POST_PARAMS         *PostParamsPtr
 112   );
 113
 114 AGESA_STATUS
 115 GnbInitAtEarlier (
 116   IN OUT   AMD_EARLY_PARAMS        *EarlyParamsPtr
 117   );
 118
 119 /*----------------------------------------------------------------------------------------*/
 120 /**
 121  * Init GNB at Reset Stub
 122  *
 123  *
 124  *
 125  * @param[in] StdHeader           Standard configuration header
 126  * @retval    AGESA_SUCCESS       Always succeeds
 127  */
 128
 129 AGESA_STATUS
 130 GnbInitAtReset (
 131   IN      AMD_CONFIG_PARAMS       *StdHeader
 132   )
 133 {
 134
 135   return  AGESA_SUCCESS;
 136 }
 137
 138 /*----------------------------------------------------------------------------------------*/
 139 /**
 140  * Init GNB at Early Stub
 141  *
 142  *
 143  *
 144  * @param[in,out] EarlyParamsPtr    Pointer to early configuration params.
 145  * @retval        AGESA_SUCCESS     Always succeeds
 146  */
 147
 148 AGESA_STATUS
 149 GnbInitAtEarly (
 150   IN OUT   AMD_EARLY_PARAMS        *EarlyParamsPtr
 151   )
 152 {
 153   return  AGESA_SUCCESS;
 154 }
 155
 156 /*----------------------------------------------------------------------------------------*/
 157 /**
 158  * Default constructor of GNB configuration at Env
 159  *
 160  *
 161  *
 162  * @param[in] GnbEnvConfigPtr     Pointer to gnb env configuration params.
 163  * @param[in] EnvParamsPtr        Pointer to env configuration params.
 164  */
 165 VOID
 166 GnbInitDataStructAtEnvDef (
 167   IN OUT  GNB_ENV_CONFIGURATION   *GnbEnvConfigPtr,
 168   IN      AMD_ENV_PARAMS          *EnvParamsPtr
 169   )
 170 {
 171
 172 }
 173
 174 /*----------------------------------------------------------------------------------------*/
 175 /**
 176  * Init GNB at Env
 177  *
 178  *
 179  *
 180  * @param[in] EnvParamsPtr        Pointer to env configuration params.
 181 * @retval     AGESA_SUCCESS       Always succeeds
 182  */
 183
 184 AGESA_STATUS
 185 GnbInitAtEnv (
 186   IN       AMD_ENV_PARAMS          *EnvParamsPtr
 187   )
 188 {
 189
 190   return  AGESA_SUCCESS;
 191 }
 192
 193 /*----------------------------------------------------------------------------------------*/
 194 /**
 195  * Init GNB at Post
 196  *
 197  *
 198  *
 199  * @param[in,out] PostParamsPtr    Pointer to Post configuration params.
 200  * @retval        AGESA_SUCCESS   Always succeeds
 201  */
 202
 203 AGESA_STATUS
 204 GnbInitAtPost (
 205   IN OUT  AMD_POST_PARAMS         *PostParamsPtr
 206   )
 207 {
 208
 209   return  AGESA_SUCCESS;
 210 }
 211
 212 /*----------------------------------------------------------------------------------------*/
 213 /**
 214  * Init GNB at Mid post
 215  *
 216  *
 217  *
 218  * @param[in,out] MidParamsPtr    Pointer to mid configuration params.
 219  * @retval        AGESA_SUCCESS   Always succeeds
 220  */
 221
 222 AGESA_STATUS
 223 GnbInitAtMid (
 224   IN OUT   AMD_MID_PARAMS          *MidParamsPtr
 225   )
 226 {
 227
 228   return  AGESA_SUCCESS;
 229 }
 230
 231 /*----------------------------------------------------------------------------------------*/
 232 /**
 233  * Init GNB at Late post
 234  *
 235  *
 236  *
 237  * @param[in,out] LateParamsPtr     Pointer to late configuration params.
 238  * @retval        AGESA_SUCCESS     Always succeeds
 239  */
 240
 241 AGESA_STATUS
 242 GnbInitAtLate (
 243   IN OUT   AMD_LATE_PARAMS         *LateParamsPtr
 244   )
 245 {
 246
 247   return  AGESA_SUCCESS;
 248 }
 249
 250 /*----------------------------------------------------------------------------------------*/
 251 /**
 252  * AmdGnbRecovery
 253  *
 254  *
 255  *
 256  * @param[in] StdHeader       Standard configuration header
 257  * @retval    AGESA_SUCCESS   Always succeeds
 258  */
 259 AGESA_STATUS
 260 AmdGnbRecovery (
 261   IN       AMD_CONFIG_PARAMS *StdHeader
 262   )
 263 {
 264   return  AGESA_SUCCESS;
 265 }
 266
 267 /*----------------------------------------------------------------------------------------*/
 268 /**
 269  * Init GNB at Post after DRAM init
 270  *
 271  *
 272  *
 273  * @param[in]     PostParamsPtr   Pointer to post configuration parameters
 274  * @retval        AGESA_SUCCESS   Always succeeds
 275  */
 276
 277 AGESA_STATUS
 278 GnbInitAtPostAfterDram (
 279   IN OUT   AMD_POST_PARAMS         *PostParamsPtr
 280   )
 281 {
 282   return  AGESA_SUCCESS;
 283 }
 284
 285 /*----------------------------------------------------------------------------------------*/
 286 /**
 287  * Init GNB at Early Before CPU Stub
 288  *
 289  *
 290  *
 291  * @param[in,out] EarlyParamsPtr    Pointer to early configuration params.
 292  * @retval        AGESA_SUCCESS     Always succeeds
 293  */
 294
 295 AGESA_STATUS
 296 GnbInitAtEarlier (
 297   IN OUT   AMD_EARLY_PARAMS        *EarlyParamsPtr
 298   )
 299 {
 300   return  AGESA_SUCCESS;
 301 }