rpc.h

嵌入式系统

/*-----------------------------------------------------------------------------
@@
@@ Copyright (c) 2001 Sharp Corporation All rights reserved.
@@
@@ (Summary)	: RPC driver user include file
@@
@@ (Comment)	:
@@
@@ (Author)		: Kazuko FUKUDA
@@
@@ (History)	: Date		Modifier	Comment
@@				  2001/1/15
@@ (RCS ID)		:
@@
-----------------------------------------------------------------------------*/
#ifndef APD_RPC_H
#define APD_RPC_H

/*+include files*************************************************************/
/*                                                                          */
/*                                                                          */
/**************************************************************************-*/
#include "type_def.h"
#include "dev_def.h"
#include "rpc_def.h"
#include "rpc_ref.h"
#include "rpc_sys_def.h"

/*+Public Type definitions***************************************************/
/*                                                                          */
/*                                                                          */
/**************************************************************************-*/

/******************************************************************************
@@
@@ {Name}       : APD_RPC_POWER_MODE
@@
@@ {Summary}    : CPU power mode
@@
@@ {Desc}       : Select CPU power mode type.
@@				  Use as the argument of the function "apd_RPCSetMode"
@@
@@ {History}    : Date        Modifier        Comment
@@				 2001/1/15	  Kazuko FUKUDA
@@ {END}
******************************************************************************/
typedef	enum {
	APD_RPC_POWER_ACTIVE = 0x00,	/* active mode */
	APD_RPC_POWER_STANDBY,			/* standby mode */
	APD_RPC_POWER_SLEEP,			/* sleep mode */
	APD_RPC_POWER_STOP,				/* stop mode */
	APD_RPC_POWER_STOP2 = 0x07		/* stop2 mode */
} APD_RPC_POWER_MODE;

/******************************************************************************
@@
@@ {Name}       : APD_RPC_MEM_MAP
@@
@@ {Summary}    : Select memory map
@@
@@ {Desc}       : Select memory map type.
@@				  Use as the argument of the function "apd_RPC_SetMMap"
@@
@@ {History}    : Date        Modifier        Comment
@@				 2001/1/15	  Kazuko FUKUDA
@@ {END}
******************************************************************************/
typedef enum {
	APD_RPC_MEMORY_MAP0 = 0,	/* default memory map */
	APD_RPC_MEMORY_MAP1			/* change memory map */
} APD_RPC_MEM_MAP;

/******************************************************************************
@@
@@ {Name}       : APD_RPC_IO_CLOCK
@@
@@ {Summary}    : Select IO to start or stop clock
@@
@@ {Desc}       : Argument of the functions, "apd_RPCStartClock" and
@@				  "apd_RPCStopClock". If you want to set the argeument more
@@				  than one IO, join each corresponding member with "or".
@@
@@ {History}    : Date        Modifier        Comment
@@				 2001/1/15	  Kazuko FUKUDA
@@ {END}
******************************************************************************/
typedef unsigned short	APD_RPC_IO_CLOCK;

/*+Public Macro definitions**************************************************/
/*                                                                          */
/*                                                                          */
/**************************************************************************-*/

#define	APD_RPC_CLK_IRDA	(APD_RPC_IO_CLOCK)0x0001	/* for IrDA module */
#define	APD_RPC_CLK_USB		(APD_RPC_IO_CLOCK)0x0002	/* for USB module */
#define	APD_RPC_CLK_LCDC	(APD_RPC_IO_CLOCK)0x0008	/* for LCDC module */
#define	APD_RPC_CLK_SPI 	(APD_RPC_IO_CLOCK)0x0020	/* for SPI module */
#define	APD_RPC_CLK_PWM0	(APD_RPC_IO_CLOCK)0x0040	/* for PWM0 module */
#define	APD_RPC_CLK_PWM1	(APD_RPC_IO_CLOCK)0x0080	/* for PWM1 module */
#define	APD_RPC_CLK_PWM2	(APD_RPC_IO_CLOCK)0x0100	/* for PWM2 module */
#define	APD_RPC_CLK_PWM3	(APD_RPC_IO_CLOCK)0x0200	/* for PWM3 module */
#define	APD_RPC_CLK_UART0	(APD_RPC_IO_CLOCK)0x0400	/* for UART0 module */
#define	APD_RPC_CLK_UART1	(APD_RPC_IO_CLOCK)0x0800	/* for UART1 module */
#define	APD_RPC_CLK_UART2	(APD_RPC_IO_CLOCK)0x1000	/* for UART2 module */
#define	APD_RPC_CLK_CT0  	(APD_RPC_IO_CLOCK)0x2000	/* for CT0 module */
#define	APD_RPC_CLK_CT1  	(APD_RPC_IO_CLOCK)0x4000	/* for CT1 module */
#define	APD_RPC_CLK_CT2  	(APD_RPC_IO_CLOCK)0x8000	/* for CT2 module */

/* Reset Output Control */
#define	APD_RPC_RESET_HIGH	0
#define	APD_RPC_RESET_LOW	1


#ifdef APD_RPC_C

/*-------------------------- Local context - START -------------------------*/

/*+include files*************************************************************/
/*                                                                          */
/*                                                                          */
/**************************************************************************-*/

#define VISIBLE             /* Mark as LOCAL context */

/*+Local Type definitions****************************************************/
/*                                                                          */
/*                                                                          */
/**************************************************************************-*/

/*+Local Macro definitions***************************************************/
/*                                                                          */
/*                                                                          */
/**************************************************************************-*/

/*+Local function prototypes*************************************************/
/*                                                                          */
/* Name         Type    Abstract                                            */
/* --------     ------- -----------                                         */
/**************************************************************************-*/

/*+Local data declarations***************************************************/
/*                                                                          */
/* Name         Type    Abstract                                            */
/* --------     ------- -----------                                         */
/*                                                                          */
/**************************************************************************-*/

/*-------------------------------- Local context - END ---------------------------------*/

#else
#define VISIBLE extern      /* Mark as GLOBAL context */
#endif

/*---------------------------- Global context - START ---------------------------------*/

/*+Public data declarations**************************************************/
/*                                                                          */
/* Name         Type    Abstract                                            */
/* --------     ------- -----------                                         */
/*                                                                          */
/**************************************************************************-*/

/*+Public function prototypes************************************************/
/*                                                                          */
/* Name         Type    Abstract                                            */
/* --------     ------- -----------                                         */
/*                                                                          */
/**************************************************************************-*/
VISIBLE APD_VOID apd_RPCInit(APD_VOID);
VISIBLE APD_VOID apd_RPCSetMode(APD_RPC_POWER_MODE mode);
VISIBLE APD_VOID apd_RPCStartClock(APD_RPC_IO_CLOCK assort);
VISIBLE APD_VOID apd_RPCStopClock(APD_RPC_IO_CLOCK assort);
VISIBLE APD_VOID apd_RPCSetMMap(APD_RPC_MEM_MAP map);
VISIBLE APD_VOID apd_RPCControlReset(APD_UCHAR res);
VISIBLE APD_UCHAR apd_RPCReadResetStatus(APD_VOID);
VISIBLE APD_VOID apd_RPCClearRflag(APD_UCHAR flg);
VISIBLE APD_ULONG apd_RPCReadID(APD_VOID);

/*-------------------------- Global context - END --------------------------*/

#undef VISIBLE
#endif	/* APD_RPC */