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

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * AMD WHEA option API.
   6  *
   7  * Contains structures and values used to control the WHEA option code.
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project:      AGESA
  11  * @e sub-project:  OPTION
  12  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  13  *
  14  */
  15 /*****************************************************************************
  16  *
  17  * Copyright (C) 2012 Advanced Micro Devices, Inc.
  18  * All rights reserved.
  19  *
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions are met:
  22  *     * Redistributions of source code must retain the above copyright
  23  *       notice, this list of conditions and the following disclaimer.
  24  *     * Redistributions in binary form must reproduce the above copyright
  25  *       notice, this list of conditions and the following disclaimer in the
  26  *       documentation and/or other materials provided with the distribution.
  27  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  28  *       its contributors may be used to endorse or promote products derived
  29  *       from this software without specific prior written permission.
  30  *
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  33  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  34  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  36  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  38  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  39  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  40  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  41  *
  42  ******************************************************************************
  43  */
  44
  45 #ifndef _OPTION_WHEA_H_
  46 #define _OPTION_WHEA_H_
  47
  48 /*----------------------------------------------------------------------------------------
  49  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  50  *----------------------------------------------------------------------------------------
  51  */
  52
  53 /*----------------------------------------------------------------------------------------
  54  *                 D E F I N I T I O N S     A N D     M A C R O S
  55  *----------------------------------------------------------------------------------------
  56  */
  57
  58
  59 /*----------------------------------------------------------------------------------------
  60  *               T Y P E D E F S,   S T R U C T U R E S,    E N U M S
  61  *----------------------------------------------------------------------------------------
  62  */
  63
  64 typedef AGESA_STATUS OPTION_WHEA_FEATURE (
  65   IN OUT   AMD_CONFIG_PARAMS    *StdHeader,
  66   IN OUT   VOID                 **WheaMcePtr,
  67   IN OUT   VOID                 **WheaCmcPtr
  68   );
  69
  70 #define WHEA_STRUCT_VERSION  0x01
  71
  72 /// The Option Configuration of WHEA
  73 typedef struct  {
  74   UINT16              OptWheaVersion;       ///< The version number of WHEA
  75   OPTION_WHEA_FEATURE  *WheaFeature;        ///< The Option Feature of WHEA
  76 } OPTION_WHEA_CONFIGURATION;
  77
  78 /*----------------------------------------------------------------------------------------
  79  *                        F U N C T I O N    P R O T O T Y P E
  80  *----------------------------------------------------------------------------------------
  81  */
  82
  83
  84 #endif  // _OPTION_WHEA_H_