| /* $NoKeywords:$ */ |
| /** |
| * @file |
| * |
| * Common Return routines. |
| * |
| * @xrefitem bom "File Content Label" "Release Content" |
| * @e project: AGESA |
| * @e sub-project: Common |
| * @e \$Revision: 35136 $ @e \$Date: 2010-07-16 11:29:48 +0800 (Fri, 16 Jul 2010) $ |
| * |
| */ |
| /* |
| ***************************************************************************** |
| * |
| * Copyright (c) 2011, Advanced Micro Devices, Inc. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * * Neither the name of Advanced Micro Devices, Inc. nor the names of |
| * its contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY |
| * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| * *************************************************************************** |
| * |
| */ |
| |
| /* |
| *---------------------------------------------------------------------------- |
| * MODULES USED |
| * |
| *---------------------------------------------------------------------------- |
| */ |
| |
| |
| #include "AGESA.h" |
| #include "Ids.h" |
| #include "CommonReturns.h" |
| #include "Filecode.h" |
| CODE_GROUP (G1_PEICC) |
| RDATA_GROUP (G1_PEICC) |
| |
| #define FILECODE PROC_COMMON_COMMONRETURNS_FILECODE |
| /*---------------------------------------------------------------------------- |
| * DEFINITIONS AND MACROS |
| * |
| *---------------------------------------------------------------------------- |
| */ |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return TRUE. |
| * |
| * @retval TRUE Default case, no special action |
| */ |
| BOOLEAN |
| CommonReturnTrue (VOID) |
| { |
| return TRUE; |
| } |
| |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return False. |
| * |
| * @retval FALSE Default case, no special action |
| */ |
| BOOLEAN |
| CommonReturnFalse (VOID) |
| { |
| return FALSE; |
| } |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return (UINT8)zero. |
| * |
| * |
| * @retval zero None, or only case zero. |
| */ |
| UINT8 |
| CommonReturnZero8 (VOID) |
| { |
| return 0; |
| } |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return (UINT32)zero. |
| * |
| * |
| * @retval zero None, or only case zero. |
| */ |
| UINT32 |
| CommonReturnZero32 (VOID) |
| { |
| return 0; |
| } |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return (UINT64)zero. |
| * |
| * |
| * @retval zero None, or only case zero. |
| */ |
| UINT64 |
| CommonReturnZero64 (VOID) |
| { |
| return 0; |
| } |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return NULL |
| * |
| * @retval NULL pointer to nothing |
| */ |
| VOID * |
| CommonReturnNULL (VOID) |
| { |
| return NULL; |
| } |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Return AGESA_SUCCESS. |
| * |
| * @retval AGESA_SUCCESS Success. |
| */ |
| AGESA_STATUS |
| CommonReturnAgesaSuccess (VOID) |
| { |
| return AGESA_SUCCESS; |
| } |
| |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * Do Nothing. |
| * |
| */ |
| VOID |
| CommonVoid (VOID) |
| { |
| } |
| |
| /*----------------------------------------------------------------------------------------*/ |
| /** |
| * ASSERT if this routine is called. |
| * |
| */ |
| VOID |
| CommonAssert (VOID) |
| { |
| ASSERT (FALSE); |
| } |