elinmint.h

这个是我在microchip公司的网站下载的PIC18系列单片的一些驱动程序

/*********************************************************************
 *
 *              LIN-Master Include File
 *
 *********************************************************************
 * FileName:        ELINMInt.h
 * Dependencies:    ELINMInt.def
 * Processor:       18Fxxxx
 * Compilers:	    Microchip C Compiler -> mcc C18 v2.20 or better
 * Assembler:       MPASMWIN 02.70.02 or higher
 * Linker:          MPLINK 2.33.00 or higher
 * Company:         Microchip Technology, Inc.
 *
 * Software License Agreement
 *
 * The software supplied herewith by Microchip Technology Incorporated
 * (the "Company") is intended and supplied to you, the Company抯
 * 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.
 *
 *
 * LIN Master header file, for EUSART enabled 18F parts
 *
 * Author               Date            Comment
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * CG			09/4/03	        Initial Release (Maestro 1.0)
 ********************************************************************/

#ifndef _ELINMINT_H          // Used to avoid duplicate inclusion
        #define _ELINMINT_H

/*********************************************************************
 *
 * General purpose typedef's used by LIN Master libray.
 *
 * Remove these definations if they are already defined in one of your
 * application files.  Make sure that corresponding header file is
 * included before including this header file.
 ********************************************************************/

typedef enum _BOOL { FALSE = 0, TRUE } BOOL;                            // defintion of boolean types
typedef unsigned char BYTE;                                             // definition of BYTE

#include   "ELINMInt.def"                                               // .DEF file is included here - necessary! 

#if defined(HI_TECH_C)                                                  // check if is using HITECH C or Microchip C
    #define HITECH_C18
#else
    #define MCHP_C18
#endif

#if defined(MCHP_C18) && defined(HITECH_C18)
#error "Invalid Compiler selection."
#endif

#if !defined(MCHP_C18) && !defined(HITECH_C18)
#error "Compiler not supported."
#endif

#if defined(MCHP_C18)
    #include <p18cxxx.h>                                                // p18cxxx.h, must have current processor
                                                                        // defined.
#endif

#if defined(HITECH_C18)
    #include <pic18.h>
    #include <stdio.h>
#endif

// start position to fill TX vector - the buffer used in transmission shall be loaded
// with the data to be transmitted from this position because position 0 is loaded with
// SYNC character and position one contains the ID

#define		ELIMINT_TXMSG_INIT		2		        
                                                                                

// definitions to make Microchip C and Hitech C compatible

#if defined(MCHP_C18)

// TXSTA bits definitions
        #define TXSTA_TX9D              TXSTAbits.TX9D
        #define TXSTA_TRMT              TXSTAbits.TRMT
        #define TXSTA_BRGH              TXSTAbits.BRGH
        #define TXSTA_SENDB             TXSTAbits.SENDB
        #define TXSTA_SYNC              TXSTAbits.SYNC
        #define TXSTA_TXEN              TXSTAbits.TXEN
        #define TXSTA_TX9               TXSTAbits.TX9
        #define TXSTA_CSRC              TXSTAbits.CSRC

	#define	RCSTA_RX9D              RCSTAbits.RX9D
	#define	RCSTA_OERR		RCSTAbits.OERR		
	#define	RCSTA_FERR		RCSTAbits.FERR
	#define	RCSTA_ADDEN		RCSTAbits.ADDEN		
	#define	RCSTA_CREN		RCSTAbits.CREN
	#define	RCSTA_SREN		RCSTAbits.SREN		
	#define	RCSTA_RX9		RCSTAbits.RX9
	#define	RCSTA_SPEN		RCSTAbits.SPEN		

	#define	BAUDCON_ABDEN		BAUDCONbits.ABDEN	
	#define	BAUDCON_WUE		BAUDCONbits.WUE	
	#define	BAUDCON_BRG16		BAUDCONbits.BRG16	
	#define	BAUDCON_SCKP		BAUDCONbits.SCKP	
	#define	BAUDCON_RCIDL		BAUDCONbits.RCIDL	
	#define	BAUDCON_ABDOVF		BAUDCONbits.ABDOVF	
		
	#define	INTCON_GIE		INTCONbits.GIE
	#define	INTCON_GIEH		INTCONbits.GIEH
	#define	INTCON_PEIE		INTCONbits.PEIE
	#define	INTCON_GIEL		INTCONbits.GIEL
	#define	INTCON_TMR0IE		INTCONbits.TMR0IE
	#define	INTCON_TMR0IF		INTCONbits.TMR0IF
	#define	INTCON_RBIF		INTCONbits.RBIF
	
	#define	PIR1_TXIF		PIR1bits.TXIF
	#define	PIR1_RCIF		PIR1bits.RCIF

	#define	PIE1_TXIE		PIE1bits.TXIE
	#define	PIE1_RCIE		PIE1bits.RCIE		
	
	#define	IPR1_TXIP		IPR1bits.TXIP
	#define	IPR1_TXIP		IPR1bits.TXIP		
												
#endif

#if defined(HITECH_C18)

        #define TXSTA_TX9D              TX9D
        #define TXSTA_TRMT              TRMT
        #define TXSTA_BRGH              BRGH
        #define TXSTA_SENDB             SENDB
        #define TXSTA_SYNC              SYNC
        #define TXSTA_TXEN              TXEN
        #define TXSTA_TX9               TX9
        #define TXSTA_CSRC              CSRC

	#define	RCSTA_RX9D		RX9D
	#define	RCSTA_OERR		OERR		
	#define	RCSTA_FERR		FERR
	#define	RCSTA_ADDEN		ADDEN		
	#define	RCSTA_CREN		CREN
	#define	RCSTA_SREN		SREN		
	#define	RCSTA_RX9		RX9
	#define	RCSTA_SPEN		SPEN		

	#define	BAUDCON_ABDEN		ABDEN	
	#define	BAUDCON_WUE		WUE	
	#define	BAUDCON_BRG16		BRG16	
	#define	BAUDCON_SCKP		SCKP	
	#define	BAUDCON_RCIDL		RCIDL	
	#define	BAUDCON_ABDOVF		ABDOVF	

	#define	INTCON_GIE		GIE
	#define	INTCON_GIEH		GIEH
	#define	INTCON_PEIE		PEIE
	#define	INTCON_GIEL		GIEL
	#define	INTCON_TMR0IE		TMR0IE
	#define	INTCON_TMR0IF		TMR0IF
	#define	INTCON_RBIF		RBIF

	#define	PIR1_TXIF		TXIF
	#define	PIR1_RCIF		RCIF

	#define	PIE1_TXIE		TXIE
	#define	PIE1_RCIE		RCIE		
		
	#define	IPR1_TXIP		TXIP
	#define	IPR1_TXIP		TXIP		

#endif


// Constants used to set the different flags that control 
// the protocol's behavior

//#define	ELINMINT_TXBIT			0x01			// TX state active flag
//#define	ELINMINT_RXBIT			0x02			// RX state active flag
#define	ELINMINT_ERRORBIT		0x04			// ERROR detected flag	
#define	ELINMINT_IDLEBIT		0x08			// Bus IDLE state flag

#define	ELINMINT_EXTENDED_ID	        0x3E			// extended message id - this is an special ID
#define	ELINMINT_EXTENDED_ID1	        0x3F			// extended message id1 - reserved for future expansion
#define	ELINMINT_WAKEUP_BYTE	        0x80			// wake-up byte generated by a slave or the master 
                                                                // to wake-up the network from sleep

/******************************************************************************
* !! Error Codes associated with the protocol !!
******************************************************************************/

#define ELINMINT_NO_ERROR               0x00                    // NO ERROR Detected !
#define	ELINMINT_THMIN_ERROR		0x10			// ERROR CODE: HEADER time too short
#define	ELINMINT_THMAX_ERROR		0x20			// ERROR CODE: HEADER time too long
#define	ELINMINT_TFMIN_ERROR		0x30			// ERROR CODE: FRAME time too short			
#define	ELINMINT_TFMAX_ERROR		0x40			// ERROR CODE: FRAME time too long
#define	ELINMINT_CHECKSUM_ERROR		0x50			// ERROR CODE: Checksum incorrect
#define	ELINMINT_DATA_ERROR		0x60			// ERROR CODE: Data Transmitted different from received
#define	ELINMINT_FRAMING_ERROR		0x70			// ERROR CODE: Data received incorrectly -> Framing Error

/********************************************************************
                        IMPORTANT:

The handler uses about ELINMINT_NINST_HANDLER_MIN instructions. 

The following defines check the minimum handler time against the 
interrup period and if the handler time exceeds the interrup period 
then an error message is generated.

*********************************************************************/

#define	ELINMINT_NINST_HANDLER_MIN	112L			// number of inst. run by the protocol during an Int.

// here the necessary time to run the protocol during an int. is calculated as a function of
// the uC's clock frequency (CLOCK_FREQ) and the number of inst. of the LIN int. handler

#define	ELINMINT_INT_HANDLER_TIME	((1000000L*(4*(ELINMINT_NINST_HANDLER_MIN+5)))/CLOCK_FREQ) 

// after that the processing time of the protocol is compared with the interrupt. 
// execution time and if smaller ( interrupt period > processing time)
// then set an error message.

#if	ELINMINT_INT_HANDLER_TIME>ELINMINT_INTERRUPT_PERIOD
	#error		"LIN TIMING NOT VIABLE - INTERRUPT PERIOD TOO SMALL !!"	
#endif

// calculate the bit time in usec.
#define	ELINMINT_BIT_PERIOD				1000000L/ELINMINT_BAUD

// calculate the ratio between the int. period and the bit time (1/BAUD) 
#define	ELINMINT_INT_PER_BAUD_RATIO		        ELINMINT_BIT_PERIOD/ELINMINT_INTERRUPT_PERIOD

/********************************************************************
                        IMPORTANT:

The handler calculates the limit times for header and frame based on
the relation between the number of interrupts and the number of bits
to be transmitted. Therefore for higher precision is recommended that 
the period of the interrupt where the handler is invoked to be small.

The correction factor calculates the ratio between the bit transmission 
time and the interrup period. Once it's calculated the correction factor 
is applied to the minimum and maximum header and frame times.
This is done because the LIN Interrupt handler in fact counts the number
of interrupts. Once this factor is applied the number of bits 
transmitted and/or received and the time this operations took can be 
checked.
*********************************************************************/

#define	ELINMINT_CORRECTION_FACTOR      (100L*ELINMINT_BIT_PERIOD)/ELINMINT_INTERRUPT_PERIOD    // relation betwenn int. and  times
#define ELINMINT_SLEEP_TIMEOUTB         25000L                                                  // bus idle timeout (defines the sleep time)
#define ELINMINT_SLEEP_TIMEOUT          ((ELINMINT_SLEEP_TIMEOUTB*ELINMINT_CORRECTION_FACTOR)/100L)       // idle bus in number of interrupts


#define	ELINMINT_DELAY_TO_WAKEUP	5L*ELINMINT_CORRECTION_FACTOR   // from Twudel, (4+1)*(Ints to bits ratio)

#define ELINMINT_TBIT           	1000000L/ELINMINT_BAUD          // bit time in microseconds


// here the minimum and maximum header times in number of bits is set

#define ELINMINT_THEADER_MINB   	34L                             // minimum number of bits in the header
#define ELINMINT_THEADER_MAXB   	(((ELINMINT_THEADER_MINB+1)*14L)/10L)   //  minimum number of bits in the header

//here the minimum and maximum header times in number of interrupts is calculated

#define ELINMINT_THEADER_MIN   		(ELINMINT_THEADER_MINB*ELINMINT_CORRECTION_FACTOR)/100  // minimum header time in interrupts
#define ELINMINT_THEADER_MAX   		(ELINMINT_THEADER_MAXB*ELINMINT_CORRECTION_FACTOR)/100  // maximum header time in interrupts

// serial port related constants

#define	ELINMINT_TXSTA_INIT		0x26		                // transmit enable+High BaudRate+TSR Empty
#define	ELINMINT_RCSTA_INIT		0x90		                // serial Port Enabled+enable receiver
#define	ELINMINT_BAUDCON_INIT		0x48		                // receiver Idle+16bit baud rate generator
#define	ELINMINT_PIE1_INIT		0x00		                // no serial interrupt 

// standard values used by the protocol

#define	ELINMINT_DUMMY_VALUE	        0xFF		                // dummy byte 
#define	ELINMINT_SYNC_VALUE		0x55		                // sync value 

//*********************************************************************
// ID union, used to define the ID and also allow the bit by bit access
//*********************************************************************

typedef union ELINMINT_ID
{
 unsigned char ID;

 struct
 {
  unsigned ID0:1;
  unsigned ID1:1;
  unsigned ID2:1;
  unsigned ID3:1;
  unsigned ID4:1;
  unsigned ID5:1;
  unsigned ID6:1;
  unsigned ID7:1; 
 } IDbits;
} ELINMINT_ID;


//*********************************************************************
// Message size union, used to define the size of a message and at the 
// same time to allow the bit by bit access
//*********************************************************************

typedef union ELINMINT_MESSAGE_SIZE
{
 unsigned char SIZE;

 struct
 {
  unsigned SIZE0:1;
  unsigned SIZE1:1;
  unsigned SIZE2:1;
  unsigned SIZE3:1;
  unsigned SIZE4:1;
  unsigned SIZE5:1;
  unsigned SIZE6:1;
  unsigned SIZE7:1; 
 } SIZEbits;
} ELINMINT_MESSAGE_SIZE;