easi.h

OMAP1030 处理器的ARM 侧硬件测试代码 OMAP1030 是TI的双核处理器

/* ============================================================================
*
*            TEXAS INSTRUMENTS INCORPORATED PROPRIETARY INFORMATION
*
*   Property of Texas Instruments
*   For Unrestricted Internal Use Only 
*   Unauthorized reproduction and/or distribution is strictly prohibited.
*   This product is protected under copyright law and trade secret law as an unpublished work.
*   Created 2003, (C) Copyright 2003 Texas Instruments.  All rights reserved.
*
*   Component:     EASI - EASI beach component
*    
*   Filename:      EASI.h           
*    
*   Description:   EASI Componenent Error handler functions
*
*   Domain:        ALL
*
*   Board:         ALL
*
*   Fucntional Specifcation Version: Not valid
*
*   Validating Test Cases: None
*    
* =============================================================================
*/
#ifndef __EASI_H
#define __EASI_H

/* ============================================================================
* INCLUDE FILES (only if necessary)
* =============================================================================
*/
#ifdef __cplusplus
extern "C"
{
#endif

/* ============================================================================
* EXPORTED DEFINITIONS
* =============================================================================
*/


/* ============================================================================
* EXPORTED TYPES
* =============================================================================
*/


/* ============================================================================
* EXPORTED VARIABLES
* =============================================================================
*/


/* ============================================================================
* EXPORTED FUNCTIONS/MACROS
* =============================================================================
*/

/* ----------------------------------------------------------------------------
* FUNCTION		: EASI_SetError
*
* INPUTS:
*
* 	Identifier	: errorCode 
* 	Type		: const ReturnCode_t 
* 	Description	: Sets the current error code to specified value
*
* RETURNS:			
*
* 	Type		: ReturnCode_t 
* 	Description	: RET_OK                    No errors occured
*                 RET_PARAM_OUT_OF_RANGE    Input Parameter out of range
*
* PURPOSE: 		: Sets beach error code to new value
*
* METHOD:		: Checks input parameters
*                 Sets error code to new value
*
* NOTE:         : This function should not be called by test cases and libraries
*                 other than beach functions 
*
* -----------------------------------------------------------------------------
*/
extern ReturnCode_t  EASI_SetError( 
                        const ReturnCode_t  errorCode 
                        ); 

/* ----------------------------------------------------------------------------
* FUNCTION		: EASI_ClearError
*
* RETURNS:			
*
* 	Type		: ReturnCode_t 
* 	Description	: RET_OK              No errors occured
*
* PURPOSE: 		: Sets Current error to default value RET_OK
*
* METHOD:		: sets current error to default value
*
* -----------------------------------------------------------------------------
*/
extern ReturnCode_t  EASI_ClearError(
                        void
                        ); 

/* ----------------------------------------------------------------------------
* FUNCTION		: EASI_GetLastError    
*
* OUTPUTS:			
*
* 	Identifier	: pLastError 
* 	Type		: ReturnCode_t *const 
* 	Description	: Last beach/EASI error that occured
*
* RETURNS:			
*
* 	Type		: ReturnCode_t 
* 	Description	: RET_OK              No errors occured
*                 RET_BAD_NULL_PARAM  pointer Paramater was set to NULL
*
* PURPOSE: 		: Allows user get last beach error.
*
* METHOD:		: Checks input parameters
*                 sets returned parameter to latest error;
*
* -----------------------------------------------------------------------------
*/
extern ReturnCode_t  EASI_GetLastError( 
                        ReturnCode_t  *const pLastError 
                        ); 


#ifdef __cplusplus
}
#endif
#endif	/* __EASI_H */