sjabca~1.h

SMALLrtos下的CAN通信远码

/*
********************************************************************************************************************
**描述：    独立的CAN 控制器SJA1000基本功能实现头文件定义(BasicCAN 工作方式）
**文件名:   SJABcanOS.H
**应用语言: KEIL C51
**版本 :    V1.0
**广州周立功单片机发展有限公司 保留所有的版权
********************************************************************************************************************
*/
#ifndef         _SJABCANOS_H 
#define         _SJABCANOS_H
	
/*
*******************************************************************************************************************
*						  变量及函数的存储方式定义
********************************************************************************************************************
*/
#ifndef 	   _SJABCANOS_GLOBAL_
#define 	   SJABCANOS_GLOBAL	   extern
	
#else
#define 	   SJABCANOS_GLOBAL 
#endif

/************************************************************************
 *定义命令字                                                            *
 ************************************************************************/ 
#define         TR_CMD           0x01          //发送请求命令
#define         AT_CMD           0x02          //夭折发送命令
#define         RRB_CMD          0x04          //释放接收缓冲区
#define         COS_CMD          0x08          //清除超载状态
#define         GTS_CMD          0x10          //进入睡眠状态命令  




/*
***********************************************************************
*以下为应用函数定义                            *
***********************************************************************
*/
/*
***********************************************************************
 *函数原型: bit   BCAN_HW_INIT(unsigned char  BCAN_ACR, 				*
 *										 unsigned char	BCAN_AMR,		*
 *										 unsigned char	Bus_Timing0,	*
 *										 unsigned char	Bus_Timing1,	*
 *										 unsigned char	Out_Control,	*
 *										 unsigned char	Clock_Out		*
 *										 )								*
 *参数说明: 															*
 *	  BCAN_ACR:存放验收代码寄存器（ACR）的参数设置						*
 *	  BCAN_AMR:存放接收屏蔽寄存器（AMR）的参数设置						*
 *	  Bus_Timing0:存放总线定时0寄存器(BTR0)的参数设置					*
 *	  Bus_Timing1:存放总线定时1寄存器(BTR1)的参数设置					*
 *	  Out_Control:存放输出控制寄存器 (OC)  的参数设置					*
 *	  Clock_Out:存放时钟分频寄存器 (CDR) 的参数设置 					*
 *																		*						 
 *返回值:																*
 *			 0 ; 表示初始化成功 										*
 *			 1 ; 表示初始化失败 										*
 *																		* 
 *说明:CAN控制器的初始化只能在复位模式下才能完成。初始化操作之前请先进入*
 *	   到复位操作模式,并将要初始化的各参数的值按数据手册中的计算方法,正 *
 *	   确的按实际需要计算好参数后，将参数写入对应的寄存器 。			*
 *注： 为了CAN控制器的正确运行，请务必仔细的阅读SJA1000的数据手册		*
 *																		*
 *示例：设应用系统中晶体频率16MHZ，节点只接收ID(标志符）高八位为		*
 *		'10101010'的消息，系统波特率为50Kbit/s,关闭CLKOUT输出。 		*
 *		则根据数据手册中的计算方法的各参数如下：						*
 *		ACR==0AAH,AMR==00H,BTR0==0C9H,BTR1==0C9H,OC==0FFH,CDR=48H		*
 * 则调用本函数为： 													*
 *	   BCAN_HW_INIT(0xaa,0x00,0xc9,0xc9,0xff,0x48)						*					  
 ***********************************************************************
 */
 SJABCANOS_GLOBAL bit 		BCAN_HW_INIT(unsigned char	BCAN_ACR,		
							  unsigned char  BCAN_AMR,		
							  unsigned char  BandRate,	
							  unsigned char  Out_Control,	 
							  unsigned char  Clock_Out		
							  ) ;				   

/*
************************************************************************************************************************
**函数原型:  void	SJASendData(unsigned	char			*databuf,
**									unsigned	char	cmd
**									)
**参数说明:  databuf	存放要发送到总线的特定帧格式的数据的缓冲区首地址
**				cmd		发送命令	
**返回值:	
**说明：	本函数用于向can总线发送数据
************************************************************************************************************************
*/
SJABCANOS_GLOBAL	void	SJASendData(unsigned	char			*databuf,
												unsigned	char	cmd
												);

/*
************************************************************************************************************************
**函数原型:  void	SJARcvData(unsigned	char			*databuf)
**参数说明:  databuf	存放要接收数据缓冲区首地址
**			 
**返回值:		
**说明：	本函数用于接收can总线数据
************************************************************************************************************************
*/
SJABCANOS_GLOBAL	unsigned char	SJARcvData(unsigned	char	*databuf);


/*
***********************************************************************
*BasicCAN OS 定义结束                                       *
***********************************************************************
*/
#endif