tmwincom.h

wince host 和 target PCI驱动程序

/*
 * Copyright (c) 1995,1996,1997 by Philips Semiconductors.
 *
 * +------------------------------------------------------------------+
 * | This software is furnished under a license and may only be used  |
 * | and copied in accordance with the terms and conditions of  such  |
 * | a license and with the inclusion of this copyright notice. This  |
 * | software or any other copies of this software may not be provided|
 * | or otherwise made available to any other person.  The ownership  |
 * | and title of this software is not transferred.                   |
 * |                                                                  |
 * | The information in this software is subject  to change without   |
 * | any  prior notice and should not be construed as a commitment by |
 * | Philips Semiconductors.                                          |
 * |                                                                  |
 * | this code and information is provided "as is" without any        |
 * | warranty of any kind, either expressed or implied, including but |
 * | not limited to the implied warranties of merchantability and/or  |
 * | fitness for any particular purpose.                              |
 * +------------------------------------------------------------------+
 *
 *  Module name	: tmwincom.h    1.7
 *
 *  Last update	: 21:30:12 - 97/12/10
 *
 *  Description	: 
 *
 *	Contains shared data structures and constants that are needed by the
 *	host and the target.
 *
 *	Revision	:
 *	960325	Tilakraj Roy 		Created
 *	960718	Charles Peplinski 	Added U and S defs.
 *	960108	Tilakraj Roy		Changed component codes for release
 *	970318	Tilakraj Roy		Accumulated all data structure size constans here 
 *
 */
 

#ifndef  TMWINCOM_INCLUDED
#define  TMWINCOM_INCLUDED




#ifdef __TCS__
#include "tmwindef.h"
#endif


#ifdef __cplusplus
extern "C" {
#endif
/*-----------------------------includes-------------------------------------*/

/*-----------------------------defines---------------------------------------*/

#define	TMSTD_MAJOR_VERSION		(4)		/* TriMedia Manager Major Version Number */
#define TMSTD_MINOR_VERSION     (8)		/* TriMedia Manager Minor Version Number */

/*
	COMPONENT CODES FOR ERROR STATUS
*/

/* TriMedia manager HOST Components */
#define TM_STATUS_HCOMP_PNP     (0x1)	/* Host Plug and Pray component */
#define TM_STATUS_HCOMP_IPC     (0x2)	/* Host Interprocessor communicaiton component */
#define TM_STATUS_HCOMP_CHNL    (0x3)	/* Host Channel component */
#define TM_STATUS_HCOMP_STRM    (0x4)	/* Host Stream Component - not implemented */
#define TM_STATUS_HCOMP_MSG     (0x5)	/* Host Message Component */
#define TM_STATUS_HCOMP_TMIF	(0x6)	/* Host User to Kernel Mode Inteface component */
#define TM_STATUS_HCOMP_BUFFER	(0x7)	/* Host User mode buffer locking component */
#define TM_STATUS_HCOMP_TASK	(0x8)	/* Host Dynamic Task Downloader Component */
#define TM_STATUS_HCOMP_SHMEM	(0x9)	/* Host Shared Memory Allocation Component */
#define TM_STATUS_HCOMP_TMMAN32 (0xa)	/* Host User Mode DLL component */
#define TM_STATUS_HCOMP_TMMAN16 (0xb)	/* Host User Mode 16 bit DLL component - not implemented */
#define TM_STATUS_HCOMP_TMMANR0 (0xc)	/* Host Kernel Mode API Component */
#define TM_STATUS_HCOMP_CLNT 	(0xd)	/* Host Process Client Component */
#define TM_STATUS_HCOMP_HAL 	(0xe)	/* Host Hardware Abstraction Layer Component */
#define TM_STATUS_HCOMP_LOADER 	(0xf)	/* Host Image Loader component */
#define TM_STATUS_HCOMP_TMLD 	(0x10)	/* Host Bootstrap loader component */
#define TM_STATUS_HCOMP_BOARD 	(0x11)	/* Host Board componenr */




/* TriMedia manager target components */
#define TM_STATUS_TCOMP_IPC     (0x80)	/* Target Interprocessor communicaiton component */
#define TM_STATUS_TCOMP_CHNL    (0x81)	/* Target Channel component */
#define TM_STATUS_TCOMP_MSG     (0x82)	/* Target Message Component */
#define TM_STATUS_TCOMP_TMMAN   (0x83)	/* Target API component */
#define TM_STATUS_TCOMP_RTOS    (0x84)	/* Target Real Time Operating System Component */
#define TM_STATUS_TCOMP_HAL 	(0x85)	/* Target Hardware Abstraction Layer Component */
#define TM_STATUS_TCOMP_DBG 	(0x86)	/* Target Debugging Component */
#define TM_STATUS_TCOMP_TMOS 	(0x87)	/* Target Operating System Dependent Component */
#define TM_STATUS_TCOMP_TASK 	(0x88)	/* Target Dynamic Task Downloader Component */

/* All component codes from 0x0 to 0x100 are reserved for TM Man */

/*	Reserved for MPEG */
#define TM_STATUS_COMP_MPEG1_BEGIN		(0x100)
#define TM_STATUS_COMP_MPEG1_END		(0x10f)

/*	Reserved for  AUDIO */
#define TM_STATUS_COMP_AUDIO_BEGIN		(0x200)
#define TM_STATUS_COMP_AUDIO_END		(0x20f)

/*	Reserved for 3D */
#define TM_STATUS_COMP_3D_BEGIN			(0x300)
#define TM_STATUS_COMP_3D_END			(0x30f)

/*	Reserved for Sys soft Debugger */
#define TM_STATUS_COMP_DEBUG_BEGIN		(0x400)
#define TM_STATUS_COMP_DEBUG_END		(0x40f)

/*	Reserved for Modem */
#define TM_STATUS_COMP_MODEM_BEGIN		(0x500)
#define TM_STATUS_COMP_MODEM_END		(0x50f)

/*	Reserved for Fax */
#define TM_STATUS_COMP_FAX_BEGIN		(0x600)
#define TM_STATUS_COMP_FAX_END			(0x60f)

/*	Reserved for Video Conferencing */
#define TM_STATUS_COMP_VC_BEGIN			(0x700)
#define TM_STATUS_COMP_VC_END			(0x70f)

/*	Reserved for MPEG2 */
#define TM_STATUS_COMP_MPEG2_BEGIN		(0x800)
#define TM_STATUS_COMP_MPEG2_END		(0x80f)

/*	Reserved for MPEG4 */
#define TM_STATUS_COMP_MPEG4_BEGIN		(0x900)
#define TM_STATUS_COMP_MPEG4_END		(0x90f)

/*	Reserved for Dolby AC-3 */
#define TM_STATUS_COMP_AC3_BEGIN		(0xa00)
#define TM_STATUS_COMP_AC3_END			(0xa0f)

typedef	DWORD			STATUS;


#ifndef IN
#define IN
#endif

#ifndef  OUT
#define OUT
#endif


#define	TMERR(c,e)		((STATUS)(((c) << 16 ) | ((e) & 0xffff) ))
#define	TM_STATUS(x)	((STATUS)(x))
#define TMOK			((STATUS)0)

#define	STATUS2BOOL(x)	(x == TMOK)

#define	FlagSet(d,f)			((d) |= (f))
#define	FlagClr(d,f)			((d) &= (~f))
#define	FlagGet(d,f)			( ((d) & (f)) != 0 )

#define BitSet(d,y)		( (d) |=  ( 1 << (b) ) )
#define BitGet(d,y)		( ((d) &  (1 << (b))) != 0)
#define BitClr(d,y)		( (d) &= (~( 1 << (b) ) ) )


#define 	TMSTD_MAX_CHANNELS	0x80	/* Maximum number of channels supported */
#define 	TMSTD_MAX_CLIENTS	0x20	/* Maximum number of user mode suported */
#define 	TMSTD_MAX_MESSAGES	0x40	/* Maximum number of messages supported */
#define 	TMSTD_MAX_TASKS		0x40	/* Maximum number of tasks supported */
#define		TMSTD_MAX_CLNT_ADVIRORY_REQUESTS	0x100	/* Maximum number of callbacks that canbe queued for a dll */

#define TMSTD_NAME_LENGTH	255			/* Maximum filename length */
#define TMSTD_PATH_LENGTH	512			/* Maximum pathname length */

#define TMSTD_DBG_OPTIONMONO     0x01
#define TMSTD_DBG_OPTIONPERSIST  0x02
#define TMSTD_DBG_OPTIONVOLATILE 0x04
#define TMSTD_DBG_OPTIONSTDOUT   0x08
#define TMSTD_DBG_OPTIONSTDERR   0x10
#define TMSTD_DBG_MAXOUTFUNC     5


#define TMSTD_PACKET_ARGUMENT_SIZE 0x5	/* Number of arguments in a packet */

/*-------------------------------types----------------------------------------*/

/* for clarity in meaning, use these data types: */
typedef long            S32;
typedef unsigned long   U32;
typedef short           S16;
typedef unsigned short  U16;
typedef char            S8;
typedef unsigned char   U8;

/* COMMON VERSION STRUCT */

typedef	struct _TMSTD_VERSION_INFO
{
	DWORD	dwMajor;
	DWORD	dwMinor;
	DWORD	dwBuild;
}	TMSTD_VERSION_INFO, *PTMSTD_VERSION_INFO;



typedef struct _TMSTD_PACKET
{	DWORD		dwCommand;
	DWORD		dwArgument[TMSTD_PACKET_ARGUMENT_SIZE];
}	TMSTD_PACKET,	*PTMSTD_PACKET;


typedef struct	_TMSTD_MEMORY_BLOCK
{
	DWORD		dwPhysical;
	DWORD		dwSize;
	DWORD		dwLinear;
}	TMSTD_MEMORY_BLOCK, *PTMSTD_MEMORY_BLOCK;

/*------------------------------functions------------------------------------*/


#ifdef __cplusplus
};
#endif	/* C++ */
	
#endif	/* TMWINCOM_INCLUDED */