blob: fcaa23e8afaf647b9e8905f9d96f87f497d2e622 [file] [log] [blame]
Frank Vibrans2b4c8312011-02-14 18:30:54 +00001/* $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
Edward O'Callaghane3f47ea2014-11-18 18:27:29 +110012 * @e \$Revision: 63425 $ @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $
Frank Vibrans2b4c8312011-02-14 18:30:54 +000013 *
14 */
Edward O'Callaghane3f47ea2014-11-18 18:27:29 +110015/*****************************************************************************
Frank Vibrans2b4c8312011-02-14 18:30:54 +000016 *
Edward O'Callaghane3f47ea2014-11-18 18:27:29 +110017 * Copyright (c) 2008 - 2012, Advanced Micro Devices, Inc.
Frank Vibrans2b4c8312011-02-14 18:30:54 +000018 * All rights reserved.
Edward O'Callaghane963b382014-07-06 19:27:14 +100019 *
Frank Vibrans2b4c8312011-02-14 18:30:54 +000020 * 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.
Edward O'Callaghane963b382014-07-06 19:27:14 +100027 * * Neither the name of Advanced Micro Devices, Inc. nor the names of
28 * its contributors may be used to endorse or promote products derived
Frank Vibrans2b4c8312011-02-14 18:30:54 +000029 * from this software without specific prior written permission.
Edward O'Callaghane963b382014-07-06 19:27:14 +100030 *
Frank Vibrans2b4c8312011-02-14 18:30:54 +000031 * 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.
Edward O'Callaghane3f47ea2014-11-18 18:27:29 +110041 ******************************************************************************
Frank Vibrans2b4c8312011-02-14 18:30:54 +000042 */
43
44#ifndef _OPTION_WHEA_H_
45#define _OPTION_WHEA_H_
46
47/*----------------------------------------------------------------------------------------
48 * M I X E D (Definitions And Macros / Typedefs, Structures, Enums)
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, S T R U C T U R E S, E N U M S
60 *----------------------------------------------------------------------------------------
61 */
62
63typedef AGESA_STATUS OPTION_WHEA_FEATURE (
64 IN OUT AMD_CONFIG_PARAMS *StdHeader,
65 IN OUT VOID **WheaMcePtr,
66 IN OUT VOID **WheaCmcPtr
67 );
68
69#define WHEA_STRUCT_VERSION 0x01
70
71/// The Option Configuration of WHEA
72typedef struct {
73 UINT16 OptWheaVersion; ///< The version number of WHEA
74 OPTION_WHEA_FEATURE *WheaFeature; ///< The Option Feature of WHEA
75} OPTION_WHEA_CONFIGURATION;
76
77/*----------------------------------------------------------------------------------------
78 * F U N C T I O N P R O T O T Y P E
79 *----------------------------------------------------------------------------------------
80 */
81
82
83#endif // _OPTION_WHEA_H_