src/vendorcode/amd/agesa/f15/Proc/HT/htPage.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * Create outline and references for HyperTransport Component mainpage documentation.
   6  *
   7  * Design guides, maintenance guides, and general documentation, are
   8  * collected using this file onto the documentation mainpage.
   9  * This file contains doxygen comment blocks, only.
  10  *
  11  * @xrefitem bom "File Content Label" "Release Content"
  12  * @e project:      AGESA
  13  * @e sub-project:  Documentation
  14  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  15  *
  16  */
  17 /*
  18  ******************************************************************************
  19  *
  20  * Copyright (C) 2012 Advanced Micro Devices, Inc.
  21  * All rights reserved.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions are met:
  25  *     * Redistributions of source code must retain the above copyright
  26  *       notice, this list of conditions and the following disclaimer.
  27  *     * Redistributions in binary form must reproduce the above copyright
  28  *       notice, this list of conditions and the following disclaimer in the
  29  *       documentation and/or other materials provided with the distribution.
  30  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  31  *       its contributors may be used to endorse or promote products derived
  32  *       from this software without specific prior written permission.
  33  *
  34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  35  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  36  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  37  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  38  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  39  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  40  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  43  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  44  *
  45  ******************************************************************************
  46  */
  47
  48 /**
  49  * @page htmain HyperTransport Component Documentation
  50  *
  51  * Additional documentation for the HyperTransport component consists of
  52  *
  53  * - Member Cross References
  54  *   - @subpage instanceshtnb "HT Northbridge Method Instances"
  55  * - Maintenance Guides:
  56  *   - @subpage htimplintf "HT Internal Interface Implementation Guide"
  57  *   - @subpage htimplfeat "HT Feature Implementation Guide"
  58  *   - @subpage htimplnb   "HT Northbridge Implementation Guide"
  59  *   - add here >>>
  60  * - Design Guides:
  61  *   - @subpage htgraphdesign "Graph Support Design"
  62  *   - @subpage physicalsockethowto "How to Create a Physical System Socket Map"
  63  *   - add here >>>
  64  *
  65  */