www.pudn.com > DeviceNet.zip > conn3.h, change:2003-09-19,size:7725b


/***************************************************************************** 
 * 
 * Microchip DeviceNet Stack (Bit-Strobed Messaging Connection Object Header) 
 * 
 ***************************************************************************** 
 * FileName:        conn3.h 
 * Dependencies:     
 * Processor:       PIC18F with CAN 
 * Compiler:       	C18 02.10.02 or higher 
 * Linker:          MPLINK 03.20.01 or higher 
 * Company:         Microchip Technology Incorporated 
 * 
 * Software License Agreement 
 * 
 * The software supplied herewith by Microchip Technology Incorporated 
 * (the "Company") is intended and supplied to you, the Company's 
 * customer, for use solely and exclusively with products manufactured 
 * by the Company.  
 * 
 * The software is owned by the Company and/or its supplier, and is  
 * protected under applicable copyright laws. All rights are reserved.  
 * Any use in violation of the foregoing restrictions may subject the  
 * user to criminal sanctions under applicable laws, as well as to  
 * civil liability for the breach of the terms and conditions of this  
 * license. 
 * 
 * THIS SOFTWARE IS PROVIDED IN AN "AS IS" CONDITION. NO WARRANTIES,  
 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED  
 * TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A  
 * PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,  
 * IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR  
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER. 
 * 
 * 
 * This file contains Bit-Strobe messaging support for the Connection Object  
 * described in Section 5-4 and Chapter 7 of Volume 1 of the DeviceNet  
 * specification. Additional support is in the UsrConn.c file. 
 *  
 * 
 * 
 * Author               Date        Comment 
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
 * Ross Fosler			04/28/03	...	 
 *  
 *****************************************************************************/ 
 
 
#ifndef	__CONN3_H__ 
#define	__CONN3_H__ 
 
/********************************************************************* 
 * Connection related variables 
 ********************************************************************/ 
extern CONN_STROBE 	uConn3; 
 
//extern unsigned char	uConn3RxBuffer[8]; 
//extern unsigned char	uConn3TxBuffer[8]; 
 
 
 
/********************************************************************* 
 * Function:        unsigned char _Conn3Create(void) 
 * 
 * PreCondition:    The CAN (or other) driver must be prepared to  
 *					accept some filter settings. 
 * 
 * Input:       	none	 
 *                   
 * Output:      	unsigned char handle to the connection	 
 * 
 * Side Effects:    none 
 * 
 * Overview:        This function creates a connection  
 *					in the predefined set and returns a  
 *					handle to the connection. The connection is  
 *					placed into a 'configuring' state.  
 *					 
 *					This function will call out to the users code 
 *					for additional resource allocation. If the  
 *					user returns NULL then the allocation will not 
 *					occur. 
 * 
 * Note:            This function is not called directly by  
 *					application code. 
 ********************************************************************/ 
unsigned char _Conn3Create(void); 
 
 
/********************************************************************* 
 * Function:        unsigned char _Conn3Close() 
 * 
 * PreCondition:    The connection should have already been open. 
 * 
 * Input:       	none 
 *                   
 * Output:      	unsigned char instance that closed 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Closes the specified connection. Users code is  
 *					notified to release any used resources. 
 * 
 * Note:            none 
 ********************************************************************/ 
unsigned char _Conn3Close(void); 
 
 
/********************************************************************* 
 * Function:        void _Conn3TimerEvent(void) 
 * 
 * PreCondition:    None 
 * 
 * Input:       	None	 
 *                   
 * Output:      	None 
 * 
 * Side Effects:    None 
 * 
 * Overview:        Update timer and process any timer events. If the  
 *					timer overflows then the state of the connection 
 *					is changed. 
 * 
 * Note:            None 
 ********************************************************************/ 
void _Conn3TimerEvent(void); 
 
 
/********************************************************************* 
 * Function:        void _Conn3RxEvent(void) 
 * 
 * PreCondition:    none 
 * 
 * Input:       	none 
 *                   
 * Output:      	none 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Process received data for this connection. 
 * 
 * Note:            This event occures when data has been received 
 *					for this connection instance. 
 ********************************************************************/ 
void _Conn3RxEvent(void); 
 
 
/********************************************************************* 
 * Function:        void _Conn3TxOpenEvent(void) 
 * 
 * PreCondition:    A transmit request must have been made. 
 * 
 * Input:       	none	 
 *                   
 * Output:      	none 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Process open transmit que event 
 * 
 * Note:            This event occurs when the buffer is available  
 *					for this connection instance to transmit. A  
 *					transmit request must have been made to enter  
 *					this function. 
 ********************************************************************/ 
void _Conn3TxOpenEvent(void); 
 
 
/********************************************************************* 
 * Function:        void _Conn3TxEvent(void) 
 * 
 * PreCondition:    Data must have been queued to transmit. 
 * 
 * Input:       	none	 
 *                   
 * Output:      	none 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Process data for this connection. 
 * 
 * Note:            This event occurs when the buffer has successfully 
 *					placed the requested data on the bus. 
 ********************************************************************/ 
void _Conn3TxEvent(void); 
 
 
/********************************************************************* 
 * Function:        unsigned char _Conn3ExplicitEvent(void) 
 * 
 * PreCondition:    none 
 * 
 * Input:       	none	 
 *                   
 * Output:      	unsigned char success of the request 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Handle explicit messaging for this instance 
 * 
 * Note:            None 
 ********************************************************************/ 
unsigned char _Conn3ExplicitEvent(void); 
 
 
/********************************************************************* 
 * Function:        unsigned char _Conn3GetAttrib() 
 * 
 * PreCondition:    none 
 * 
 * Input:       	none 
 *                   
 * Output:      	unsigned char success of the request 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Handle explicit messaging 
 * 
 * Note:            None 
 ********************************************************************/ 
unsigned char _Conn3GetAttrib(void);   
 
 
/********************************************************************* 
 * Function:        unsigned char _Conn3SetAttrib(void) 
 * 
 * PreCondition:    none 
 * 
 * Input:       	none 
 *                   
 * Output:      	unsigned char success of the request 
 * 
 * Side Effects:    none 
 * 
 * Overview:        Handle explicit messaging 
 * 
 * Note:            None 
 ********************************************************************/ 
unsigned char _Conn3SetAttrib(void); 
 
 
			    
#endif	/*__CONN3_H__*/