src/vendorcode/amd/agesa/f15tn/Proc/CPU/Feature/cpuHtc.h - mirrors/cros/chromiumos/third_party/coreboot - Git at Google

 /* $NoKeywords:$ */
 /**
  * @file
  *
  * AMD AGESA CPU Hardware Thermal Control (HTC) Functions declarations.
  *
  * Contains code that declares the AGESA CPU HTC related APIs
  *
  * @xrefitem bom "File Content Label" "Release Content"
  * @e project:      AGESA
  * @e sub-project:  CPU/Feature
  * @e \$Revision: 63692 $   @e \$Date: 2012-01-03 22:13:28 -0600 (Tue, 03 Jan 2012) $
  *
  */
 /*
  ******************************************************************************
  *
  * 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 _CPU_HTC_H_
 #define _CPU_HTC_H_

 /*----------------------------------------------------------------------------------------
  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  *----------------------------------------------------------------------------------------
  */
 //  Forward declaration needed for multi-structure mutual references
 AGESA_FORWARD_DECLARATION (HTC_FAMILY_SERVICES);

 /*----------------------------------------------------------------------------------------
  *                 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     A N D     S T R U C T U R E S
  *----------------------------------------------------------------------------------------
  */

 /*---------------------------------------------------------------------------------------*/
 /**
  *  Family specific call to check if Hardware Thermal Control (HTC) is supported.
  *
  * @param[in]    HtcServices        HTC services.
  * @param[in]    Socket             Zero-based socket number.
  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
  * @param[in]    StdHeader          Config Handle for library, services.
  *
  * @retval       TRUE               HTC is supported.
  * @retval       FALSE              HTC is not supported.
  *
  */
 typedef BOOLEAN F_HTC_IS_SUPPORTED (
   IN       HTC_FAMILY_SERVICES    *HtcServices,
   IN       UINT32                 Socket,
   IN       PLATFORM_CONFIGURATION *PlatformConfig,
   IN       AMD_CONFIG_PARAMS      *StdHeader
   );

 /// Reference to a Method.
 typedef F_HTC_IS_SUPPORTED *PF_HTC_IS_SUPPORTED;

 /*---------------------------------------------------------------------------------------*/
 /**
  *  Family specific call to enable HTC.
  *
  * @param[in]    HtcServices        HTC services.
  * @param[in]    EntryPoint         Timepoint designator.
  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
  * @param[in]    StdHeader          Config Handle for library, services.
  *
  * @return       Family specific error value.
  *
  */
 typedef AGESA_STATUS F_HTC_INIT (
   IN       HTC_FAMILY_SERVICES    *HtcServices,
   IN       UINT64                  EntryPoint,
   IN       PLATFORM_CONFIGURATION *PlatformConfig,
   IN       AMD_CONFIG_PARAMS      *StdHeader
   );

 /// Reference to a Method.
 typedef F_HTC_INIT *PF_HTC_INIT;

 /**
  * Provide the interface to the HTC Family Specific Services.
  *
  * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
  * Each supported Family must provide an implementation for all methods in this interface, even if the
  * implementation is a CommonReturn().
  */
 /* typedef  */struct _HTC_FAMILY_SERVICES {
   UINT16          Revision;                                             ///< Interface version
   // Public Methods.
   PF_HTC_IS_SUPPORTED IsHtcSupported;                                   ///< Method: Family specific call to check if HTC is supported.
   PF_HTC_INIT         EnableHtcOnSocket;                                ///< Method: Family specific call to enable HTC.
 } /* HTC_FAMILY_SERVICES */;


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

 #endif  // _CPU_HTC_H_
	/* $NoKeywords:$ */
	/**
	* @file
	*
	* AMD AGESA CPU Hardware Thermal Control (HTC) Functions declarations.
	*
	* Contains code that declares the AGESA CPU HTC related APIs
	*
	* @xrefitem bom "File Content Label" "Release Content"
	* @e project: AGESA
	* @e sub-project: CPU/Feature
	* @e \$Revision: 63692 $ @e \$Date: 2012-01-03 22:13:28 -0600 (Tue, 03 Jan 2012) $
	*
	*/
	/*
	******************************************************************************
	*
	* 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 _CPU_HTC_H_
	#define _CPU_HTC_H_

	/*----------------------------------------------------------------------------------------
	* M I X E D (Definitions And Macros / Typedefs, Structures, Enums)
	*----------------------------------------------------------------------------------------
	*/
	// Forward declaration needed for multi-structure mutual references
	AGESA_FORWARD_DECLARATION (HTC_FAMILY_SERVICES);

	/*----------------------------------------------------------------------------------------
	* 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 A N D S T R U C T U R E S
	*----------------------------------------------------------------------------------------
	*/

	/---------------------------------------------------------------------------------------/
	/**
	* Family specific call to check if Hardware Thermal Control (HTC) is supported.
	*
	* @param[in] HtcServices HTC services.
	* @param[in] Socket Zero-based socket number.
	* @param[in] PlatformConfig Contains the runtime modifiable feature input data.
	* @param[in] StdHeader Config Handle for library, services.
	*
	* @retval TRUE HTC is supported.
	* @retval FALSE HTC is not supported.
	*
	*/
	typedef BOOLEAN F_HTC_IS_SUPPORTED (
	IN HTC_FAMILY_SERVICES *HtcServices,
	IN UINT32 Socket,
	IN PLATFORM_CONFIGURATION *PlatformConfig,
	IN AMD_CONFIG_PARAMS *StdHeader
	);

	/// Reference to a Method.
	typedef F_HTC_IS_SUPPORTED *PF_HTC_IS_SUPPORTED;

	/---------------------------------------------------------------------------------------/
	/**
	* Family specific call to enable HTC.
	*
	* @param[in] HtcServices HTC services.
	* @param[in] EntryPoint Timepoint designator.
	* @param[in] PlatformConfig Contains the runtime modifiable feature input data.
	* @param[in] StdHeader Config Handle for library, services.
	*
	* @return Family specific error value.
	*
	*/
	typedef AGESA_STATUS F_HTC_INIT (
	IN HTC_FAMILY_SERVICES *HtcServices,
	IN UINT64 EntryPoint,
	IN PLATFORM_CONFIGURATION *PlatformConfig,
	IN AMD_CONFIG_PARAMS *StdHeader
	);

	/// Reference to a Method.
	typedef F_HTC_INIT *PF_HTC_INIT;

	/**
	* Provide the interface to the HTC Family Specific Services.
	*
	* Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
	* Each supported Family must provide an implementation for all methods in this interface, even if the
	* implementation is a CommonReturn().
	*/
	/* typedef */struct _HTC_FAMILY_SERVICES {
	UINT16 Revision; ///< Interface version
	// Public Methods.
	PF_HTC_IS_SUPPORTED IsHtcSupported; ///< Method: Family specific call to check if HTC is supported.
	PF_HTC_INIT EnableHtcOnSocket; ///< Method: Family specific call to enable HTC.
	} /* HTC_FAMILY_SERVICES */;


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

	#endif // _CPU_HTC_H_