src/vendorcode/amd/agesa/f15/Proc/Common/CommonReturns.c

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * Common Return routines.
   6  *
   7  * @xrefitem bom "File Content Label" "Release Content"
   8  * @e project:      AGESA
   9  * @e sub-project:  Common
  10  * @e \$Revision: 56279 $   @e \$Date: 2011-07-11 13:11:28 -0600 (Mon, 11 Jul 2011) $
  11  *
  12  */
  13 /*
  14 *****************************************************************************
  15 *
  16 * Copyright (C) 2012 Advanced Micro Devices, Inc.
  17 * All rights reserved.
  18 *
  19 * Redistribution and use in source and binary forms, with or without
  20 * modification, are permitted provided that the following conditions are met:
  21 *     * Redistributions of source code must retain the above copyright
  22 *       notice, this list of conditions and the following disclaimer.
  23 *     * Redistributions in binary form must reproduce the above copyright
  24 *       notice, this list of conditions and the following disclaimer in the
  25 *       documentation and/or other materials provided with the distribution.
  26 *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  27 *       its contributors may be used to endorse or promote products derived
  28 *       from this software without specific prior written permission.
  29 *
  30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  32 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33 * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  34 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  35 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  36 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  37 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  39 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40 *
  41 * ***************************************************************************
  42 *
  43 */
  44
  45 /*
  46  *----------------------------------------------------------------------------
  47  *                                MODULES USED
  48  *
  49  *----------------------------------------------------------------------------
  50  */
  51
  52
  53 #include "AGESA.h"
  54 #include "Ids.h"
  55 #include "Filecode.h"
  56 #include "CommonReturns.h"
  57 CODE_GROUP (G1_PEICC)
  58 RDATA_GROUP (G2_PEI)
  59
  60 #define FILECODE PROC_COMMON_COMMONRETURNS_FILECODE
  61 /*----------------------------------------------------------------------------
  62  *                          DEFINITIONS AND MACROS
  63  *
  64  *----------------------------------------------------------------------------
  65  */
  66
  67 /*----------------------------------------------------------------------------------------
  68  *           P R O T O T Y P E S     O F     L O C A L     F U  N C T I O N S
  69  *----------------------------------------------------------------------------------------
  70  */
  71 AGESA_STATUS
  72 CommonFchInitStub (
  73   IN       VOID       *DataPtr
  74   );
  75
  76 VOID
  77 FchTaskDummy (
  78   IN       VOID       *DataPtr
  79   );
  80
  81 /*----------------------------------------------------------------------------------------*/
  82 /**
  83 * Return TRUE.
  84 *
  85 * @retval TRUE  Default case, no special action
  86 */
  87 BOOLEAN
  88 CommonReturnTrue ( VOID )
  89 {
  90   return TRUE;
  91 }
  92
  93
  94 /*----------------------------------------------------------------------------------------*/
  95 /**
  96 * Return False.
  97 *
  98 * @retval FALSE  Default case, no special action
  99 */
 100 BOOLEAN
 101 CommonReturnFalse ( VOID )
 102 {
 103   return FALSE;
 104 }
 105
 106 /*----------------------------------------------------------------------------------------*/
 107 /**
 108  * Return (UINT8)zero.
 109  *
 110  *
 111  * @retval zero    None, or only case zero.
 112  */
 113 UINT8
 114 CommonReturnZero8 ( VOID )
 115 {
 116   return 0;
 117 }
 118
 119 /*----------------------------------------------------------------------------------------*/
 120 /**
 121  * Return (UINT32)zero.
 122  *
 123  *
 124  * @retval zero    None, or only case zero.
 125  */
 126 UINT32
 127 CommonReturnZero32 ( VOID )
 128 {
 129   return 0;
 130 }
 131
 132 /*----------------------------------------------------------------------------------------*/
 133 /**
 134  * Return (UINT64)zero.
 135  *
 136  *
 137  * @retval zero    None, or only case zero.
 138  */
 139 UINT64
 140 CommonReturnZero64 ( VOID )
 141 {
 142   return 0;
 143 }
 144
 145 /*----------------------------------------------------------------------------------------*/
 146 /**
 147  * Return NULL
 148  *
 149  * @retval NULL    pointer to nothing
 150  */
 151 VOID *
 152 CommonReturnNULL ( VOID )
 153 {
 154   return NULL;
 155 }
 156
 157 /*----------------------------------------------------------------------------------------*/
 158 /**
 159 * Return AGESA_SUCCESS.
 160 *
 161 * @retval AGESA_SUCCESS Success.
 162 */
 163 AGESA_STATUS
 164 CommonReturnAgesaSuccess ( VOID )
 165 {
 166   return AGESA_SUCCESS;
 167 }
 168
 169
 170 /*----------------------------------------------------------------------------------------*/
 171 /**
 172  * Do Nothing.
 173  *
 174  */
 175 VOID
 176 CommonVoid ( VOID )
 177 {
 178 }
 179
 180 /*----------------------------------------------------------------------------------------*/
 181 /**
 182  * ASSERT if this routine is called.
 183  *
 184  */
 185 VOID
 186 CommonAssert ( VOID )
 187 {
 188   ASSERT (FALSE);
 189 }
 190
 191
 192 /*----------------------------------------------------------------------------------------*/
 193 /**
 194 * Return AGESA_SUCCESS.
 195 *
 196 * @retval AGESA_SUCCESS Success.
 197 */
 198 AGESA_STATUS
 199 CommonFchInitStub (
 200   IN       VOID       *DataPtr
 201   )
 202 {
 203   return AGESA_SUCCESS;
 204 }
 205
 206
 207 VOID
 208 FchTaskDummy (
 209   IN       VOID       *DataPtr
 210   )
 211 {
 212 }
 213