src/vendorcode/amd/agesa/f15tn/Include/OptionsHt.h - mirrors/cros/chromiumos/third_party/coreboot - Git at Google

 /* $NoKeywords:$ */
 /**
  * @file
  *
  * AMD HyperTransport option API.
  *
  * Contains option pre-compile logic.  This file is used by the options
  * installer and internally by the HT code initializers.
  *
  * @xrefitem bom "File Content Label" "Release Content"
  * @e project:      AGESA
  * @e sub-project:  OPTION
  * @e \$Revision: 63425 $   @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $
  *
  */
 /*****************************************************************************
  *
  * 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_HT_H_
 #define _OPTION_HT_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
  *----------------------------------------------------------------------------------------
  */


 /*----------------------------------------------------------------------------------------
  *               T Y P E D E F S,   S T R U C T U R E S,    E N U M S
  *----------------------------------------------------------------------------------------
  */

 /**
  * Provide HT build option results
  */
 typedef struct {
   CONST BOOLEAN IsUsingRecoveryHt;                   ///< Manual BUID Swap List processing should assume that HT Recovery was used.
   CONST BOOLEAN IsSetHtCrcFlood;                     ///< Enable setting of HT CRC Flood.
                                                      ///< Build-time only customizable - @BldCfgItem{BLDCFG_SET_HTCRC_SYNC_FLOOD}
   CONST BOOLEAN IsUsingUnitIdClumping;               ///< Enable automatically HT Spec compliant Unit Id Clumping.
                                                      ///< Build-time only customizable - @BldCfgItem{BLDCFG_USE_UNIT_ID_CLUMPING}
   CONST AMD_HT_INTERFACE *HtOptionPlatformDefaults;  ///< A set of build time options for HT constructor.
   CONST VOID *HtOptionInternalInterface;             ///< Use this internal interface initializer.
   CONST VOID *HtOptionInternalFeatures;              ///< Use this internal feature set initializer.
   CONST VOID *HtOptionFamilyNorthbridgeList;         ///< Use this list of northbridge initializers.
   CONST UINT8 *CONST *HtOptionBuiltinTopologies;     ///< Use this list of built-in topologies.
 } OPTION_HT_CONFIGURATION;

 typedef AGESA_STATUS
 F_OPTION_HT_INIT_RESET (
   IN       AMD_CONFIG_PARAMS        *StdHeader,
   IN       AMD_HT_RESET_INTERFACE   *AmdHtResetInterface
   );

 typedef F_OPTION_HT_INIT_RESET *PF_OPTION_HT_INIT_RESET;

 typedef AGESA_STATUS
 F_OPTION_HT_RESET_CONSTRUCTOR (
   IN       AMD_CONFIG_PARAMS         *StdHeader,
   IN       AMD_HT_RESET_INTERFACE    *AmdHtResetInterface
   );

 typedef F_OPTION_HT_RESET_CONSTRUCTOR *PF_OPTION_HT_RESET_CONSTRUCTOR;

 /**
  * Provide HT reset initialization build option results
  */
 typedef struct {
   PF_OPTION_HT_INIT_RESET HtInitReset;               ///< Method: HT reset initialization.
   PF_OPTION_HT_RESET_CONSTRUCTOR HtResetConstructor; ///< Method: HT reset initialization.
 } OPTION_HT_INIT_RESET;

 /*----------------------------------------------------------------------------------------
  *                        F U N C T I O N    P R O T O T Y P E
  *----------------------------------------------------------------------------------------
  */

 #endif  // _OPTION_HT_H_
	/* $NoKeywords:$ */
	/**
	* @file
	*
	* AMD HyperTransport option API.
	*
	* Contains option pre-compile logic. This file is used by the options
	* installer and internally by the HT code initializers.
	*
	* @xrefitem bom "File Content Label" "Release Content"
	* @e project: AGESA
	* @e sub-project: OPTION
	* @e \$Revision: 63425 $ @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $
	*
	*/
	/*****************************************************************************
	*
	* 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_HT_H_
	#define _OPTION_HT_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
	*----------------------------------------------------------------------------------------
	*/


	/*----------------------------------------------------------------------------------------
	* T Y P E D E F S, S T R U C T U R E S, E N U M S
	*----------------------------------------------------------------------------------------
	*/

	/**
	* Provide HT build option results
	*/
	typedef struct {
	CONST BOOLEAN IsUsingRecoveryHt; ///< Manual BUID Swap List processing should assume that HT Recovery was used.
	CONST BOOLEAN IsSetHtCrcFlood; ///< Enable setting of HT CRC Flood.
	///< Build-time only customizable - @BldCfgItem{BLDCFG_SET_HTCRC_SYNC_FLOOD}
	CONST BOOLEAN IsUsingUnitIdClumping; ///< Enable automatically HT Spec compliant Unit Id Clumping.
	///< Build-time only customizable - @BldCfgItem{BLDCFG_USE_UNIT_ID_CLUMPING}
	CONST AMD_HT_INTERFACE *HtOptionPlatformDefaults; ///< A set of build time options for HT constructor.
	CONST VOID *HtOptionInternalInterface; ///< Use this internal interface initializer.
	CONST VOID *HtOptionInternalFeatures; ///< Use this internal feature set initializer.
	CONST VOID *HtOptionFamilyNorthbridgeList; ///< Use this list of northbridge initializers.
	CONST UINT8 CONST HtOptionBuiltinTopologies; ///< Use this list of built-in topologies.
	} OPTION_HT_CONFIGURATION;

	typedef AGESA_STATUS
	F_OPTION_HT_INIT_RESET (
	IN AMD_CONFIG_PARAMS *StdHeader,
	IN AMD_HT_RESET_INTERFACE *AmdHtResetInterface
	);

	typedef F_OPTION_HT_INIT_RESET *PF_OPTION_HT_INIT_RESET;

	typedef AGESA_STATUS
	F_OPTION_HT_RESET_CONSTRUCTOR (
	IN AMD_CONFIG_PARAMS *StdHeader,
	IN AMD_HT_RESET_INTERFACE *AmdHtResetInterface
	);

	typedef F_OPTION_HT_RESET_CONSTRUCTOR *PF_OPTION_HT_RESET_CONSTRUCTOR;

	/**
	* Provide HT reset initialization build option results
	*/
	typedef struct {
	PF_OPTION_HT_INIT_RESET HtInitReset; ///< Method: HT reset initialization.
	PF_OPTION_HT_RESET_CONSTRUCTOR HtResetConstructor; ///< Method: HT reset initialization.
	} OPTION_HT_INIT_RESET;

	/*----------------------------------------------------------------------------------------
	* F U N C T I O N P R O T O T Y P E
	*----------------------------------------------------------------------------------------
	*/

	#endif // _OPTION_HT_H_