gpptypes.h File Reference

---

Detailed Description

Defines the type system for DSP/BIOS Link.

============================================================================

Path:

/gpp/inc/usr/

Version:

1.65.01.06 ============================================================================

Copyright:

Copyright (C) 2002-2009, Texas Instruments Incorporated - https://www.ti.com/

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 Texas Instruments Incorporated 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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. ============================================================================

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	IN
	Argument specification syntax ============================================================================.
#define	OUT
#define	CONST   const
#define	USES(filename)
	Empty macro to indicate header file dependency ============================================================================.
#define	Void   void
#define	FALSE   0u
	Boolean constants ============================================================================.
#define	TRUE   1u
#define	NULL   ((void *)0)
	Definition is language specific ============================================================================.
#define	NULL_CHAR   '\0'
	String terminator. ============================================================================.
#define	REG8(A)   (*(volatile Char8 *) (A))
	Macros to access register fields. ============================================================================.
#define	REG16(A)   (*(volatile Uint16 *) (A))
#define	REG32(A)   (*(volatile Uint32 *) (A))
Typedefs
typedef signed char	Int8
	Basic data types ============================================================================.
typedef signed short int	Int16
typedef signed long int	Int32
typedef unsigned char	Uint8
typedef unsigned short int	Uint16
typedef unsigned long int	Uint32
typedef float	Real32
typedef double	Real64
typedef short int	Bool
typedef char	Char8
typedef short	Char16
typedef unsigned char	Uchar8
typedef unsigned short	Uchar16
typedef int	Int
typedef void *	Pvoid
typedef Char8 *	Pstr
typedef Uchar8 *	Pustr
typedef Uint32	ProcessorId
	These types are used across DSP/BIOS Link. ============================================================================.
typedef Uint32	ChannelId
PoolId
This type is used for identifying the different pools used by DSPLINK. ============================================================================ ============================================================================
#define	STATIC   static
	Free for OEMs to add their own generic stuff, if they so desire ============================================================================.
#define	EXTERN   extern
#define	NORMAL_API   CDECL
#define	IMPORT_API   DLLIMPORT
#define	EXPORT_API   DLLEXPORT
typedef Uint16	PoolId

---

Define Documentation

#define IN

Argument specification syntax ============================================================================.

============================================================================

Macro:

IN/OUT/OPTIONAL/CONST

#define OUT

#define CONST   const

#define USES

(

filename )

Empty macro to indicate header file dependency ============================================================================.

============================================================================

Macro:

USES

#define Void   void

#define FALSE   0u

Boolean constants ============================================================================.

============================================================================

Constant:

TRUE/FALSE

#define TRUE   1u

#define NULL   ((void *)0)

Definition is language specific ============================================================================.

============================================================================

Constant:

NULL

#define NULL_CHAR   '\0'

String terminator. ============================================================================.

============================================================================

Constant:

NULL_CHAR

#define REG8

(

A )

(*(volatile Char8 *) (A))

Macros to access register fields. ============================================================================.

============================================================================

Macro:

REG8/REG16/REG32

#define REG16

(

A )

(*(volatile Uint16 *) (A))

#define REG32

(

A )

(*(volatile Uint32 *) (A))

#define STATIC   static

Free for OEMs to add their own generic stuff, if they so desire ============================================================================.

============================================================================

Macro:

OS Specific standard definitions ============================================================================

Macro:

Calling convention

Definition of CDECL, DLLIMPORT, DLLEXPORT can be defined by OEM for his compiler ============================================================================

#define EXTERN   extern

#define NORMAL_API   CDECL

#define IMPORT_API   DLLIMPORT

#define EXPORT_API   DLLEXPORT

---

Typedef Documentation

typedef signed char Int8

Basic data types ============================================================================.

============================================================================

Macro:

Data types

typedef signed short int Int16

typedef signed long int Int32

typedef unsigned char Uint8

typedef unsigned short int Uint16

typedef unsigned long int Uint32

typedef float Real32

typedef double Real64

typedef short int Bool

typedef char Char8

typedef short Char16

typedef unsigned char Uchar8

typedef unsigned short Uchar16

typedef int Int

typedef void* Pvoid

typedef Char8* Pstr

typedef Uchar8* Pustr

typedef Uint32 ProcessorId

These types are used across DSP/BIOS Link. ============================================================================.

============================================================================

Macro:

DSP/BIOS Link specific types

typedef Uint32 ChannelId

typedef Uint16 PoolId