[net-next-2.6.git] / drivers / net / slip.h

/*
 * slip.h	Define the SLIP device driver interface and constants.
 *
 * NOTE:	THIS FILE WILL BE MOVED TO THE LINUX INCLUDE DIRECTORY
 *		AS SOON AS POSSIBLE!
 *
 * Version:	@(#)slip.h	1.2.0	03/28/93
 *
 * Fixes:
 *		Alan Cox	: 	Added slip mtu field.
 *		Matt Dillon	:	Printable slip (borrowed from net2e)
 *		Alan Cox	:	Added SL_SLIP_LOTS
 *	Dmitry Gorodchanin	:	A lot of changes in the 'struct slip'
 *	Dmitry Gorodchanin	:	Added CSLIP statistics.
 *	Stanislav Voronyi	:	Make line checking as created by
 *					Igor Chechik, RELCOM Corp.
 *	Craig Schlenter		:	Fixed #define bug that caused
 *					CSLIP telnets to hang in 1.3.61-6
 *
 * Author:	Fred N. van Kempen, <waltje@uwalt.nl.mugnet.org>
 */
#ifndef _LINUX_SLIP_H
#define _LINUX_SLIP_H


#if defined(CONFIG_INET) && defined(CONFIG_SLIP_COMPRESSED)
# define SL_INCLUDE_CSLIP
#endif

#ifdef SL_INCLUDE_CSLIP
# define SL_MODE_DEFAULT SL_MODE_ADAPTIVE
#else
# define SL_MODE_DEFAULT SL_MODE_SLIP
#endif

/* SLIP configuration. */
#define SL_NRUNIT	256		/* MAX number of SLIP channels;
					   This can be overridden with
					   insmod -oslip_maxdev=nnn	*/
#define SL_MTU		296		/* 296; I am used to 600- FvK	*/

/* SLIP protocol characters. */
#define END             0300		/* indicates end of frame	*/
#define ESC             0333		/* indicates byte stuffing	*/
#define ESC_END         0334		/* ESC ESC_END means END 'data'	*/
#define ESC_ESC         0335		/* ESC ESC_ESC means ESC 'data'	*/


struct slip {
  int			magic;

  /* Various fields. */
  struct tty_struct	*tty;		/* ptr to TTY structure		*/
  struct net_device	*dev;		/* easy for intr handling	*/
  spinlock_t		lock;

#ifdef SL_INCLUDE_CSLIP
  struct slcompress	*slcomp;	/* for header compression 	*/
  unsigned char		*cbuff;		/* compression buffer		*/
#endif

  /* These are pointers to the malloc()ed frame buffers. */
  unsigned char		*rbuff;		/* receiver buffer		*/
  int                   rcount;         /* received chars counter       */
  unsigned char		*xbuff;		/* transmitter buffer		*/
  unsigned char         *xhead;         /* pointer to next byte to XMIT */
  int                   xleft;          /* bytes left in XMIT queue     */

  /* SLIP interface statistics. */
  unsigned long		rx_packets;	/* inbound frames counter	*/
  unsigned long         tx_packets;     /* outbound frames counter      */
  unsigned long		rx_bytes;	/* inbound byte counte		*/
  unsigned long         tx_bytes;       /* outbound byte counter	*/
  unsigned long         rx_errors;      /* Parity, etc. errors          */
  unsigned long         tx_errors;      /* Planned stuff                */
  unsigned long         rx_dropped;     /* No memory for skb            */
  unsigned long         tx_dropped;     /* When MTU change              */
  unsigned long         rx_over_errors; /* Frame bigger then SLIP buf.  */
#ifdef SL_INCLUDE_CSLIP
  unsigned long		tx_compressed;
  unsigned long		rx_compressed;
  unsigned long		tx_misses;
#endif
  /* Detailed SLIP statistics. */

  int			mtu;		/* Our mtu (to spot changes!)   */
  int                   buffsize;       /* Max buffers sizes            */

#ifdef CONFIG_SLIP_MODE_SLIP6
  int			xdata, xbits;	/* 6 bit slip controls 		*/
#endif

  unsigned long		flags;		/* Flag values/ mode etc	*/
#define SLF_INUSE	0		/* Channel in use               */
#define SLF_ESCAPE	1               /* ESC received                 */
#define SLF_ERROR	2               /* Parity, etc. error           */
#define SLF_KEEPTEST	3		/* Keepalive test flag		*/
#define SLF_OUTWAIT	4		/* is outpacket was flag	*/

  unsigned char		mode;		/* SLIP mode			*/
  unsigned char		leased;
  dev_t			line;
  pid_t			pid;
#define SL_MODE_SLIP	0
#define SL_MODE_CSLIP	1
#define SL_MODE_SLIP6	2		/* Matt Dillon's printable slip */
#define SL_MODE_CSLIP6	(SL_MODE_SLIP6|SL_MODE_CSLIP)
#define SL_MODE_AX25	4
#define SL_MODE_ADAPTIVE 8
#ifdef CONFIG_SLIP_SMART
  unsigned char		outfill;	/* # of sec between outfill packet */
  unsigned char		keepalive;	/* keepalive seconds		*/
  struct timer_list	outfill_timer;
  struct timer_list	keepalive_timer;
#endif
};

#define SLIP_MAGIC 0x5302

#endif	/* _LINUX_SLIP.H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* slip.h Define the SLIP device driver interface and constants.
	3	*
	4	* NOTE: THIS FILE WILL BE MOVED TO THE LINUX INCLUDE DIRECTORY
	5	* AS SOON AS POSSIBLE!
	6	*
	7	* Version: @(#)slip.h 1.2.0 03/28/93
	8	*
	9	* Fixes:
	10	* Alan Cox : Added slip mtu field.
	11	* Matt Dillon : Printable slip (borrowed from net2e)
	12	* Alan Cox : Added SL_SLIP_LOTS
	13	* Dmitry Gorodchanin : A lot of changes in the 'struct slip'
	14	* Dmitry Gorodchanin : Added CSLIP statistics.
	15	* Stanislav Voronyi : Make line checking as created by
	16	* Igor Chechik, RELCOM Corp.
	17	* Craig Schlenter : Fixed #define bug that caused
	18	* CSLIP telnets to hang in 1.3.61-6
	19	*
	20	* Author: Fred N. van Kempen, <waltje@uwalt.nl.mugnet.org>
	21	*/
	22	#ifndef _LINUX_SLIP_H
	23	#define _LINUX_SLIP_H
	24
1da177e4 LT	25
	26	#if defined(CONFIG_INET) && defined(CONFIG_SLIP_COMPRESSED)
	27	# define SL_INCLUDE_CSLIP
	28	#endif
	29
	30	#ifdef SL_INCLUDE_CSLIP
	31	# define SL_MODE_DEFAULT SL_MODE_ADAPTIVE
	32	#else
	33	# define SL_MODE_DEFAULT SL_MODE_SLIP
	34	#endif
	35
	36	/* SLIP configuration. */
	37	#define SL_NRUNIT 256 /* MAX number of SLIP channels;
	38	This can be overridden with
	39	insmod -oslip_maxdev=nnn */
	40	#define SL_MTU 296 /* 296; I am used to 600- FvK */
	41
	42	/* SLIP protocol characters. */
	43	#define END 0300 /* indicates end of frame */
	44	#define ESC 0333 /* indicates byte stuffing */
	45	#define ESC_END 0334 /* ESC ESC_END means END 'data' */
	46	#define ESC_ESC 0335 /* ESC ESC_ESC means ESC 'data' */
	47
	48
	49	struct slip {
	50	int magic;
	51
	52	/* Various fields. */
	53	struct tty_struct tty; / ptr to TTY structure */
	54	struct net_device dev; / easy for intr handling */
	55	spinlock_t lock;
	56
	57	#ifdef SL_INCLUDE_CSLIP
	58	struct slcompress slcomp; / for header compression */
	59	unsigned char cbuff; / compression buffer */
	60	#endif
	61
	62	/* These are pointers to the malloc()ed frame buffers. */
	63	unsigned char rbuff; / receiver buffer */
	64	int rcount; /* received chars counter */
	65	unsigned char xbuff; / transmitter buffer */
	66	unsigned char xhead; / pointer to next byte to XMIT */
	67	int xleft; /* bytes left in XMIT queue */
	68
	69	/* SLIP interface statistics. */
	70	unsigned long rx_packets; /* inbound frames counter */
	71	unsigned long tx_packets; /* outbound frames counter */
	72	unsigned long rx_bytes; /* inbound byte counte */
	73	unsigned long tx_bytes; /* outbound byte counter */
	74	unsigned long rx_errors; /* Parity, etc. errors */
	75	unsigned long tx_errors; /* Planned stuff */
	76	unsigned long rx_dropped; /* No memory for skb */
	77	unsigned long tx_dropped; /* When MTU change */
	78	unsigned long rx_over_errors; /* Frame bigger then SLIP buf. */
	79	#ifdef SL_INCLUDE_CSLIP
	80	unsigned long tx_compressed;
	81	unsigned long rx_compressed;
	82	unsigned long tx_misses;
	83	#endif
	84	/* Detailed SLIP statistics. */
	85
	86	int mtu; /* Our mtu (to spot changes!) */
	87	int buffsize; /* Max buffers sizes */
	88
89	#ifdef CONFIG_SLIP_MODE_SLIP6
90	int xdata, xbits; /* 6 bit slip controls */
91	#endif
92
93	unsigned long flags; /* Flag values/ mode etc */
94	#define SLF_INUSE 0 /* Channel in use */
95	#define SLF_ESCAPE 1 /* ESC received */
96	#define SLF_ERROR 2 /* Parity, etc. error */
97	#define SLF_KEEPTEST 3 /* Keepalive test flag */
98	#define SLF_OUTWAIT 4 /* is outpacket was flag */
99
100	unsigned char mode; /* SLIP mode */
101	unsigned char leased;
102	dev_t line;
103	pid_t pid;
104	#define SL_MODE_SLIP 0
105	#define SL_MODE_CSLIP 1
106	#define SL_MODE_SLIP6 2 /* Matt Dillon's printable slip */
107	#define SL_MODE_CSLIP6 (SL_MODE_SLIP6\|SL_MODE_CSLIP)
108	#define SL_MODE_AX25 4
109	#define SL_MODE_ADAPTIVE 8
6aa20a22	110	#ifdef CONFIG_SLIP_SMART
1da177e4 LT	111	unsigned char outfill; /* # of sec between outfill packet */
	112	unsigned char keepalive; /* keepalive seconds */
	113	struct timer_list outfill_timer;
	114	struct timer_list keepalive_timer;
6aa20a22	115	#endif
1da177e4 LT	116	};
	117
	118	#define SLIP_MAGIC 0x5302
	119
	120	#endif /* _LINUX_SLIP.H */