path: root/src/vendorcode/amd/agesa/f15tn/Proc/HT/htNotify.h

/* $NoKeywords:$ */
/**
 * @file
 *
 * HT Notify interface.
 *
 * This file provides internal interface to event and status
 * notification.
 *
 * @xrefitem bom "File Content Label" "Release Content"
 * @e project:      AGESA
 * @e sub-project:  HyperTransport
 * @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 _HT_NOTIFY_H_
#define _HT_NOTIFY_H_

/*----------------------------------------------------------------------------------------*/
/* Event specific event data definitions.
 * All structures must be 4 UINT32's in size, no more, no less.
 */

/// For event ::HT_EVENT_HW_SYNCFLOOD
typedef struct {
  UINT32 Node;                   ///< The Node on which observed
  UINT32 Link;                   ///< The Link on that Node which reported synch flood
  UINT32 Reserved1;              ///< Reserved.
  UINT32 Reserved2;              ///< Reserved.
} HT_EVENT_DATA_HW_SYNCFLOOD;

/// For event ::HT_EVENT_HW_HTCRC
typedef struct {
  UINT32 Node;                   ///< The Node on which event is observed
  UINT32 Link;                   ///< The Link on that Node which reported CRC error
  UINT32 LaneMask;               ///< The CRC lane mask for the Link
  UINT32 Reserved1;              ///< Reserved.
} HT_EVENT_DATA_HW_HT_CRC;

/// For event ::HT_EVENT_NCOH_BUS_MAX_EXCEED
typedef struct {
  UINT32 Node;                   ///< the Node with this non-coherent chain
  UINT32 Link;                   ///< the Link on that Node to this chain
  UINT32 Bus;                    ///< the current bus number
  UINT32 Reserved1;              ///< Reserved.
} HT_EVENT_DATA_NCOH_BUS_MAX_EXCEED;

/// For event ::HT_EVENT_NCOH_CFG_MAP_EXCEED
typedef struct {
  UINT32 Node;                   ///< the Node with this non-coherent chain
  UINT32 Link;                   ///< the Link on that Node to this chain
  UINT32 Reserved1;              ///< Reserved.
  UINT32 Reserved2;              ///< Reserved.
} HT_EVENT_DATA_NCOH_CFG_MAP_EXCEED;

/// For event ::HT_EVENT_NCOH_BUID_EXCEED
typedef struct {
  UINT32 Node;                   ///< the Node with this non-coherent chain
  UINT32 Link;                   ///< the Link on that Node to this chain
  UINT32 Depth;                  ///< the position on the chain, zero is CPU host
  UINT16 CurrentBuid;            ///< the current available BUID
  UINT16 UnitCount;              ///< the number of ids which would be consumed by this device
} HT_EVENT_DATA_NCOH_BUID_EXCEED;

/// For event ::HT_EVENT_NCOH_DEVICE_FAILED
typedef struct {
  UINT32 Node;                   ///< the Node with this non-coherent chain
  UINT32 Link;                   ///< the Link on that Node to this chain
  UINT32 Depth;                  ///< the position on the chain, zero is CPU host
  UINT32 AttemptedBuid;          ///< the BUID we tried to assign to that device
} HT_EVENT_DATA_NCOH_DEVICE_FAILED;

/// For event ::HT_EVENT_NCOH_AUTO_DEPTH
typedef struct {
  UINT32 Node;                   ///< the Node with this non-coherent chain
  UINT32 Link;                   ///< the Link on that Node to this chain
  UINT32 Depth;                  ///< the position on the chain of the last device, zero is CPU host
  UINT32 Reserved1;              ///< Reserved.
} HT_EVENT_DATA_NCOH_AUTO_DEPTH;

/// For event ::HT_EVENT_OPT_REQUIRED_CAP_RETRY,
///           ::HT_EVENT_OPT_REQUIRED_CAP_GEN3.
typedef struct {
  UINT32 Node;                   ///< the Node with this non-coherent chain
  UINT32 Link;                   ///< the Link on that Node to this chain
  UINT32 Depth;                  ///< the position on the chain, zero is CPU host
  UINT32 Reserved1;              ///< Reserved.
} HT_EVENT_DATA_OPT_REQUIRED_CAP;

/// For event ::HT_EVENT_OPT_UNUSED_LINKS
typedef struct {
  UINT32 NodeA;                  ///< One of the nodes connected
  UINT32 LinkA;                  ///< its unusable link
  UINT32 NodeB;                  ///< The other connected node
  UINT32 LinkB;                  ///< its unusable link
} HT_EVENT_DATA_OPT_UNUSED_LINKS;

/// For event ::HT_EVENT_OPT_LINK_PAIR_EXCEED
typedef struct {
  UINT32 NodeA;                  ///< One of the nodes connected
  UINT32 NodeB;                  ///< The other connected node
  UINT32 MasterLink;             ///< NodeA's unusable Master link
  UINT32 AltLink;                ///< NodeA's unusable Alternatelink
} HT_EVENT_DATA_OPT_LINK_PAIR_EXCEED;

/// For event ::HT_EVENT_COH_NO_TOPOLOGY.
/// There is no routing for this system's topology.
typedef struct {
  UINT32 TotalNodes;             ///< the number of Nodes in the unmatched topology
  UINT32 Reserved1;              ///< Reserved.
  UINT32 Reserved2;              ///< Reserved.
  UINT32 Reserved3;              ///< Reserved.
} HT_EVENT_DATA_COH_NO_TOPOLOGY;

/// For event ::HT_EVENT_COH_PROCESSOR_TYPE_MIX
typedef struct {
  UINT32 Node;                   ///< the Node from which the incompatible family was found
  UINT32 Link;                   ///< the Link to the incompatible Node
  UINT32 TotalNodes;             ///< the number of Nodes found at that point
  UINT32 Reserved1;              ///< Reserved.
} HT_EVENT_DATA_COH_PROCESSOR_TYPE_MIX;

/// For event ::HT_EVENT_COH_NODE_DISCOVERED
typedef struct {
  UINT32 Node;                   ///< the Node from which the new Node was found
  UINT32 Link;                   ///< the Link to the new Node
  UINT32 NewNode;                ///< the Node id of the newly discovered Node
  UINT32 TempRoute;              ///< the new Node is temporarily at this id
} HT_EVENT_DATA_COH_NODE_DISCOVERED;

/// For event ::HT_EVENT_COH_MPCAP_MISMATCH
typedef struct {
  UINT32 Node;                   ///< the Node from which condition was observed
  UINT32 Link;                   ///< the Link on the current Node
  UINT32 SysMpCap;               ///< the current aggregate system capability (the minimum found so far)
  UINT32 TotalNodes;             ///< the number of Nodes found, before this was observed
} HT_EVENT_DATA_COH_MP_CAP_MISMATCH;

/*----------------------------------------------------------------------------------------*/
/* Event specific Notify functions.
 */

VOID
NotifyAlertHwSyncFlood (
  IN       UINT8        Node,
  IN       UINT8        Link,
  IN       STATE_DATA   *State
  );

VOID
NotifyAlertHwHtCrc (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      LaneMask,
  IN       STATE_DATA *State
  );

VOID
NotifyErrorNcohBusMaxExceed (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Bus,
  IN       STATE_DATA *State
  );

VOID
NotifyErrorNcohCfgMapExceed (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       STATE_DATA *State
  );

VOID
NotifyErrorNcohBuidExceed (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Depth,
  IN       UINT8      Id,
  IN       UINT8      Units,
  IN       STATE_DATA *State
  );

VOID
NotifyErrorNcohDeviceFailed (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Depth,
  IN       UINT8      Id,
  IN       STATE_DATA *State
  );

VOID
NotifyInfoNcohAutoDepth (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Depth,
  IN       STATE_DATA *State
  );

VOID
NotifyWarningOptRequiredCapRetry (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Depth,
  IN       STATE_DATA *State
  );

VOID
NotifyWarningOptRequiredCapGen3 (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Depth,
  IN       STATE_DATA *State
  );

VOID
NotifyWarningOptUnusedLinks (
  IN       UINT32    NodeA,
  IN       UINT32    LinkA,
  IN       UINT32    NodeB,
  IN       UINT32    LinkB,
  IN       STATE_DATA *State
  );

VOID
NotifyWarningOptLinkPairExceed (
  IN       UINT32    NodeA,
  IN       UINT32    NodeB,
  IN       UINT32    MasterLink,
  IN       UINT32    AltLink,
  IN       STATE_DATA *State
  );

VOID
NotifyErrorCohNoTopology (
  IN       UINT8      Nodes,
  IN       STATE_DATA *State
  );

VOID
NotifyFatalCohProcessorTypeMix (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Nodes,
  IN       STATE_DATA *State
  );

VOID
NotifyInfoCohNodeDiscovered (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      NewNode,
  IN       UINT8      TempRoute,
  IN       STATE_DATA *State
  );

VOID
NotifyFatalCohMpCapMismatch (
  IN       UINT8      Node,
  IN       UINT8      Link,
  IN       UINT8      Cap,
  IN       UINT8      Nodes,
  IN       STATE_DATA *State
  );

#endif /* _HT_NOTIFY_H_ */