armsys270.h

dm270 source code

/*
    DM270 ARM Evaluation Software

    (c)Texas Instruments 2003
*/

/**
    \mainpage DM270 ARM Chip Support Library (CSL)

    \htmlinclude DM270_ARM_CSL_INTRO.htm

See also,

    - \ref ARM_CSL_INSTALLATION

    - \ref ARM_CSL_MACROS

    - \ref TI_DISCLAIMER
*/

/**
    \page ARM_CSL_INSTALLATION  DM270 ARM CSL installation

	\htmlinclude DM270_ARM_CSL_INSTALL.htm
*/

/**
    \page ARM_CSL_MACROS  DM270 ARM CSL Register Access Macros

    \htmlinclude DM270_ARM_CSL_MACROS.htm
*/

/**
    \page TI_DISCLAIMER  TI Disclaimer

    \htmlinclude ti_disclaimer.htm
*/



/** \defgroup SYS ARM System control */
/*@{*/

/** \file armsys270.h
    \brief ARM System control related APIs

*/


#ifndef __ARM_SYS_270_H__
#define __ARM_SYS_270_H__

#include <armcsl_270.h>

#define _ARMSYS270_LIB_

#ifndef _Pr_KERNEL_

#include <stdio.h>

#ifndef __SAGITERS_H__
typedef enum {	
	FALSE,
	TRUE
} BOOL;
#endif

#endif /*	#ifndef _Pr_KERNEL_ */

#ifdef _Pr_KERNEL_

//#include <types.h>	// PrKernel types

#endif /*	#ifdef _Pr_KERNEL_ */

#ifndef STATUS
    #define STATUS Int16
#endif


// Return error codes
#ifndef E_PASS
    #define E_PASS  0   ///< When this value is returned, the operation was successful
#endif

#ifndef E_INVALID_INPUT
    #define E_INVALID_INPUT     (-1)    ///< When this value is returned, the operation was unsuccessful because the input parameters were invalid
#endif

#ifndef E_RESOURCE_UNAVAILABLE
    #define E_RESOURCE_UNAVAILABLE  (-2)    ///< When this value is returned, the operation was unsuccessful because a required resource was not available
#endif

#ifndef E_TIMEOUT
    #define E_TIMEOUT (-3)  ///< When this value is returned, the operation was unsuccessful because a timeout condition occured
#endif

#ifndef E_DEVICE
    #define E_DEVICE (-4)  ///< When this value is returned, the operation was unsuccessful because of a device specific error
#endif

#ifndef E_MISC
    #define E_MISC  ((Int16)0xF800)  ///< When this value is returned, the operation was unsuccessful because of a module specific error. The bits 7:0 of 0xF800 are replaced by module specific error code
#endif

#ifndef SDRAM_MEMORY_BASE
    #define SDRAM_MEMORY_BASE   0x900000    ///< SDRAM Memory Base Address
#endif

#endif /*   __ARM_SYS_270_H__   */

/*@}*/