[deliverable/linux.git] / drivers / net / arcnet / arcdevice.h

/*
 * INET         An implementation of the TCP/IP protocol suite for the LINUX
 *              operating system.  NET  is implemented using the  BSD Socket
 *              interface as the means of communication with the user level.
 *
 *              Definitions used by the ARCnet driver.
 *
 * Authors:     Avery Pennarun and David Woodhouse
 *
 *              This program is free software; you can redistribute it and/or
 *              modify it under the terms of the GNU General Public License
 *              as published by the Free Software Foundation; either version
 *              2 of the License, or (at your option) any later version.
 *
 */
#ifndef _LINUX_ARCDEVICE_H
#define _LINUX_ARCDEVICE_H

#include <asm/timex.h>
#include <linux/if_arcnet.h>

#ifdef __KERNEL__
#include  <linux/irqreturn.h>

/*
 * RECON_THRESHOLD is the maximum number of RECON messages to receive
 * within one minute before printing a "cabling problem" warning. The
 * default value should be fine.
 *
 * After that, a "cabling restored" message will be printed on the next IRQ
 * if no RECON messages have been received for 10 seconds.
 *
 * Do not define RECON_THRESHOLD at all if you want to disable this feature.
 */
#define RECON_THRESHOLD 30

/*
 * Define this to the minimum "timeout" value.  If a transmit takes longer
 * than TX_TIMEOUT jiffies, Linux will abort the TX and retry.  On a large
 * network, or one with heavy network traffic, this timeout may need to be
 * increased.  The larger it is, though, the longer it will be between
 * necessary transmits - don't set this too high.
 */
#define TX_TIMEOUT (HZ * 200 / 1000)

/* Display warnings about the driver being an ALPHA version. */
#undef ALPHA_WARNING

/*
 * Debugging bitflags: each option can be enabled individually.
 *
 * Note: only debug flags included in the ARCNET_DEBUG_MAX define will
 *   actually be available.  GCC will (at least, GCC 2.7.0 will) notice
 *   lines using a BUGLVL not in ARCNET_DEBUG_MAX and automatically optimize
 *   them out.
 */
#define D_NORMAL	1	/* important operational info             */
#define D_EXTRA		2	/* useful, but non-vital information      */
#define	D_INIT		4	/* show init/probe messages               */
#define D_INIT_REASONS	8	/* show reasons for discarding probes     */
#define D_RECON		32	/* print a message whenever token is lost */
#define D_PROTO		64	/* debug auto-protocol support            */
/* debug levels below give LOTS of output during normal operation! */
#define D_DURING	128	/* trace operations (including irq's)     */
#define D_TX	        256	/* show tx packets                        */
#define D_RX		512	/* show rx packets                        */
#define D_SKB		1024	/* show skb's                             */
#define D_SKB_SIZE	2048	/* show skb sizes			  */
#define D_TIMING	4096	/* show time needed to copy buffers to card */
#define D_DEBUG         8192    /* Very detailed debug line for line */

#ifndef ARCNET_DEBUG_MAX
#define ARCNET_DEBUG_MAX (127)	/* change to ~0 if you want detailed debugging */
#endif

#ifndef ARCNET_DEBUG
#define ARCNET_DEBUG (D_NORMAL | D_EXTRA)
#endif
extern int arcnet_debug;

#define BUGLVL(x)	((x) & ARCNET_DEBUG_MAX & arcnet_debug)

/* macros to simplify debug checking */
#define arc_printk(x, dev, fmt, ...)					\
do {									\
	if (BUGLVL(x)) {						\
		if ((x) == D_NORMAL)					\
			netdev_warn(dev, fmt, ##__VA_ARGS__);		\
		else if ((x) < D_DURING)				\
			netdev_info(dev, fmt, ##__VA_ARGS__);		\
		else							\
			netdev_dbg(dev, fmt, ##__VA_ARGS__);		\
	}								\
} while (0)

#define arc_cont(x, fmt, ...)						\
do {									\
	if (BUGLVL(x))							\
		pr_cont(fmt, ##__VA_ARGS__);				\
} while (0)

/* see how long a function call takes to run, expressed in CPU cycles */
#define TIME(dev, name, bytes, call)					\
do {									\
	if (BUGLVL(D_TIMING)) {						\
		unsigned long _x, _y;					\
		_x = get_cycles();					\
		call;							\
		_y = get_cycles();					\
		arc_printk(D_TIMING, dev,				\
			   "%s: %d bytes in %lu cycles == %lu Kbytes/100Mcycle\n", \
			   name, bytes, _y - _x,			\
			   100000000 / 1024 * bytes / (_y - _x + 1));	\
	} else {							\
		call;							\
	}								\
} while (0)

/*
 * Time needed to reset the card - in ms (milliseconds).  This works on my
 * SMC PC100.  I can't find a reference that tells me just how long I
 * should wait.
 */
#define RESETtime (300)

/*
 * These are the max/min lengths of packet payload, not including the
 * arc_hardware header, but definitely including the soft header.
 *
 * Note: packet sizes 254, 255, 256 are impossible because of the way
 * ARCnet registers work  That's why RFC1201 defines "exception" packets.
 * In non-RFC1201 protocols, we have to just tack some extra bytes on the
 * end.
 */
#define MTU	253		/* normal packet max size */
#define MinTU	257		/* extended packet min size */
#define XMTU	508		/* extended packet max size */

/* status/interrupt mask bit fields */
#define TXFREEflag	0x01	/* transmitter available */
#define TXACKflag       0x02	/* transmitted msg. ackd */
#define RECONflag       0x04	/* network reconfigured */
#define TESTflag        0x08	/* test flag */
#define EXCNAKflag      0x08    /* excesive nak flag */
#define RESETflag       0x10	/* power-on-reset */
#define RES1flag        0x20	/* reserved - usually set by jumper */
#define RES2flag        0x40	/* reserved - usually set by jumper */
#define NORXflag        0x80	/* receiver inhibited */

/* Flags used for IO-mapped memory operations */
#define AUTOINCflag     0x40	/* Increase location with each access */
#define IOMAPflag       0x02	/* (for 90xx) Use IO mapped memory, not mmap */
#define ENABLE16flag    0x80	/* (for 90xx) Enable 16-bit mode */

/* in the command register, the following bits have these meanings:
 *                0-2     command
 *                3-4     page number (for enable rcv/xmt command)
 *                 7      receive broadcasts
 */
#define NOTXcmd         0x01	/* disable transmitter */
#define NORXcmd         0x02	/* disable receiver */
#define TXcmd           0x03	/* enable transmitter */
#define RXcmd           0x04	/* enable receiver */
#define CONFIGcmd       0x05	/* define configuration */
#define CFLAGScmd       0x06	/* clear flags */
#define TESTcmd         0x07	/* load test flags */

/* flags for "clear flags" command */
#define RESETclear      0x08	/* power-on-reset */
#define CONFIGclear     0x10	/* system reconfigured */

#define EXCNAKclear     0x0E    /* Clear and acknowledge the excive nak bit */

/* flags for "load test flags" command */
#define TESTload        0x08	/* test flag (diagnostic) */

/* byte deposited into first address of buffers on reset */
#define TESTvalue       0321	/* that's octal for 0xD1 :) */

/* for "enable receiver" command */
#define RXbcasts        0x80	/* receive broadcasts */

/* flags for "define configuration" command */
#define NORMALconf      0x00	/* 1-249 byte packets */
#define EXTconf         0x08	/* 250-504 byte packets */

/* card feature flags, set during auto-detection.
 * (currently only used by com20020pci)
 */
#define ARC_IS_5MBIT    1   /* card default speed is 5MBit */
#define ARC_CAN_10MBIT  2   /* card uses COM20022, supporting 10MBit,
				 but default is 2.5MBit. */

/* information needed to define an encapsulation driver */
struct ArcProto {
	char suffix;		/* a for RFC1201, e for ether-encap, etc. */
	int mtu;		/* largest possible packet */
	int is_ip;              /* This is a ip plugin - not a raw thing */

	void (*rx)(struct net_device *dev, int bufnum,
		   struct archdr *pkthdr, int length);
	int (*build_header)(struct sk_buff *skb, struct net_device *dev,
			    unsigned short ethproto, uint8_t daddr);

	/* these functions return '1' if the skb can now be freed */
	int (*prepare_tx)(struct net_device *dev, struct archdr *pkt,
			  int length, int bufnum);
	int (*continue_tx)(struct net_device *dev, int bufnum);
	int (*ack_tx)(struct net_device *dev, int acked);
};

extern struct ArcProto *arc_proto_map[256], *arc_proto_default,
	*arc_bcast_proto, *arc_raw_proto;

/*
 * "Incoming" is information needed for each address that could be sending
 * to us.  Mostly for partially-received split packets.
 */
struct Incoming {
	struct sk_buff *skb;	/* packet data buffer             */
	__be16 sequence;	/* sequence number of assembly    */
	uint8_t lastpacket,	/* number of last packet (from 1) */
		numpackets;	/* number of packets in split     */
};

/* only needed for RFC1201 */
struct Outgoing {
	struct ArcProto *proto;	/* protocol driver that owns this:
				 *   if NULL, no packet is pending.
				 */
	struct sk_buff *skb;	/* buffer from upper levels */
	struct archdr *pkt;	/* a pointer into the skb */
	uint16_t length,	/* bytes total */
		dataleft,	/* bytes left */
		segnum,		/* segment being sent */
		numsegs;	/* number of segments */
};

struct arcnet_local {
	uint8_t config,		/* current value of CONFIG register */
		timeout,	/* Extended timeout for COM20020 */
		backplane,	/* Backplane flag for COM20020 */
		clockp,		/* COM20020 clock divider */
		clockm,		/* COM20020 clock multiplier flag */
		setup,		/* Contents of setup1 register */
		setup2,		/* Contents of setup2 register */
		intmask;	/* current value of INTMASK register */
	uint8_t default_proto[256];	/* default encap to use for each host */
	int	cur_tx,		/* buffer used by current transmit, or -1 */
		next_tx,	/* buffer where a packet is ready to send */
		cur_rx;		/* current receive buffer */
	int	lastload_dest,	/* can last loaded packet be acked? */
		lasttrans_dest;	/* can last TX'd packet be acked? */
	int	timed_out;	/* need to process TX timeout and drop packet */
	unsigned long last_timeout;	/* time of last reported timeout */
	char *card_name;	/* card ident string */
	int card_flags;		/* special card features */

	/* On preemtive and SMB a lock is needed */
	spinlock_t lock;

	/*
	 * Buffer management: an ARCnet card has 4 x 512-byte buffers, each of
	 * which can be used for either sending or receiving.  The new dynamic
	 * buffer management routines use a simple circular queue of available
	 * buffers, and take them as they're needed.  This way, we simplify
	 * situations in which we (for example) want to pre-load a transmit
	 * buffer, or start receiving while we copy a received packet to
	 * memory.
	 *
	 * The rules: only the interrupt handler is allowed to _add_ buffers to
	 * the queue; thus, this doesn't require a lock.  Both the interrupt
	 * handler and the transmit function will want to _remove_ buffers, so
	 * we need to handle the situation where they try to do it at the same
	 * time.
	 *
	 * If next_buf == first_free_buf, the queue is empty.  Since there are
	 * only four possible buffers, the queue should never be full.
	 */
	atomic_t buf_lock;
	int buf_queue[5];
	int next_buf, first_free_buf;

	/* network "reconfiguration" handling */
	unsigned long first_recon; /* time of "first" RECON message to count */
	unsigned long last_recon;  /* time of most recent RECON */
	int num_recons;		/* number of RECONs between first and last. */
	int network_down;	/* do we think the network is down? */

	int excnak_pending;    /* We just got an excesive nak interrupt */

	struct {
		uint16_t sequence;	/* sequence number (incs with each packet) */
		__be16 aborted_seq;

		struct Incoming incoming[256];	/* one from each address */
	} rfc1201;

	/* really only used by rfc1201, but we'll pretend it's not */
	struct Outgoing outgoing;	/* packet currently being sent */

	/* hardware-specific functions */
	struct {
		struct module *owner;
		void (*command)(struct net_device *dev, int cmd);
		int (*status)(struct net_device *dev);
		void (*intmask)(struct net_device *dev, int mask);
		int (*reset)(struct net_device *dev, int really_reset);
		void (*open)(struct net_device *dev);
		void (*close)(struct net_device *dev);

		void (*copy_to_card)(struct net_device *dev, int bufnum,
				     int offset, void *buf, int count);
		void (*copy_from_card)(struct net_device *dev, int bufnum,
				       int offset, void *buf, int count);
	} hw;

	void __iomem *mem_start;	/* pointer to ioremap'ed MMIO */
};

#define ARCRESET(x)  (lp->hw.reset(dev, (x)))
#define ACOMMAND(x)  (lp->hw.command(dev, (x)))
#define ASTATUS()    (lp->hw.status(dev))
#define AINTMASK(x)  (lp->hw.intmask(dev, (x)))

#if ARCNET_DEBUG_MAX & D_SKB
void arcnet_dump_skb(struct net_device *dev, struct sk_buff *skb, char *desc);
#else
static inline
void arcnet_dump_skb(struct net_device *dev, struct sk_buff *skb, char *desc)
{
}
#endif

void arcnet_unregister_proto(struct ArcProto *proto);
irqreturn_t arcnet_interrupt(int irq, void *dev_id);
struct net_device *alloc_arcdev(const char *name);

int arcnet_open(struct net_device *dev);
int arcnet_close(struct net_device *dev);
netdev_tx_t arcnet_send_packet(struct sk_buff *skb,
			       struct net_device *dev);
void arcnet_timeout(struct net_device *dev);

/* I/O equivalents */

#ifdef CONFIG_SA1100_CT6001
#define BUS_ALIGN  2  /* 8 bit device on a 16 bit bus - needs padding */
#else
#define BUS_ALIGN  1
#endif

/* addr and offset allow register like names to define the actual IO  address.
 * A configuration option multiplies the offset for alignment.
 */
#define arcnet_inb(addr, offset)					\
	inb((addr) + BUS_ALIGN * (offset))
#define arcnet_outb(value, addr, offset)				\
	outb(value, (addr) + BUS_ALIGN * (offset))

#define arcnet_insb(addr, offset, buffer, count)			\
	insb((addr) + BUS_ALIGN * (offset), buffer, count)
#define arcnet_outsb(addr, offset, buffer, count)			\
	outsb((addr) + BUS_ALIGN * (offset), buffer, count)

#define arcnet_inw(addr, offset)					\
	inw((addr) + BUS_ALIGN * (offset))
#define arcnet_outw(value, addr, offset)				\
	outw(value, (addr) + BUS_ALIGN * (offset))

#define arcnet_insw(addr, offset, buffer, count)			\
	insw((addr) + BUS_ALIGN * (offset), buffer, count)
#define arcnet_outsw(addr, offset, buffer, count)			\
	outsw((addr) + BUS_ALIGN * (offset), buffer, count)

#endif				/* __KERNEL__ */
#endif				/* _LINUX_ARCDEVICE_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* INET An implementation of the TCP/IP protocol suite for the LINUX
	3	* operating system. NET is implemented using the BSD Socket
	4	* interface as the means of communication with the user level.
	5	*
	6	* Definitions used by the ARCnet driver.
	7	*
	8	* Authors: Avery Pennarun and David Woodhouse
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License
	12	* as published by the Free Software Foundation; either version
	13	* 2 of the License, or (at your option) any later version.
	14	*
	15	*/
	16	#ifndef _LINUX_ARCDEVICE_H
	17	#define _LINUX_ARCDEVICE_H
	18
	19	#include <asm/timex.h>
	20	#include <linux/if_arcnet.h>
	21
	22	#ifdef __KERNEL__
a6b7a407	23	#include <linux/irqreturn.h>
1da177e4	24
1da177e4 LT	25	/*
	26	* RECON_THRESHOLD is the maximum number of RECON messages to receive
	27	* within one minute before printing a "cabling problem" warning. The
	28	* default value should be fine.
	29	*
	30	* After that, a "cabling restored" message will be printed on the next IRQ
	31	* if no RECON messages have been received for 10 seconds.
	32	*
	33	* Do not define RECON_THRESHOLD at all if you want to disable this feature.
	34	*/
	35	#define RECON_THRESHOLD 30
	36
1da177e4 LT	37	/*
	38	* Define this to the minimum "timeout" value. If a transmit takes longer
	39	* than TX_TIMEOUT jiffies, Linux will abort the TX and retry. On a large
	40	* network, or one with heavy network traffic, this timeout may need to be
	41	* increased. The larger it is, though, the longer it will be between
	42	* necessary transmits - don't set this too high.
	43	*/
	44	#define TX_TIMEOUT (HZ * 200 / 1000)
	45
1da177e4 LT	46	/* Display warnings about the driver being an ALPHA version. */
	47	#undef ALPHA_WARNING
	48
1da177e4 LT	49	/*
1da177e4 LT	50	* Debugging bitflags: each option can be enabled individually.
cb334648	51	*
1da177e4 LT	52	* Note: only debug flags included in the ARCNET_DEBUG_MAX define will
	53	* actually be available. GCC will (at least, GCC 2.7.0 will) notice
	54	* lines using a BUGLVL not in ARCNET_DEBUG_MAX and automatically optimize
	55	* them out.
	56	*/
	57	#define D_NORMAL 1 /* important operational info */
	58	#define D_EXTRA 2 /* useful, but non-vital information */
	59	#define D_INIT 4 /* show init/probe messages */
	60	#define D_INIT_REASONS 8 /* show reasons for discarding probes */
	61	#define D_RECON 32 /* print a message whenever token is lost */
	62	#define D_PROTO 64 /* debug auto-protocol support */
	63	/* debug levels below give LOTS of output during normal operation! */
	64	#define D_DURING 128 /* trace operations (including irq's) */
	65	#define D_TX 256 /* show tx packets */
	66	#define D_RX 512 /* show rx packets */
	67	#define D_SKB 1024 /* show skb's */
	68	#define D_SKB_SIZE 2048 /* show skb sizes */
	69	#define D_TIMING 4096 /* show time needed to copy buffers to card */
	70	#define D_DEBUG 8192 /* Very detailed debug line for line */
	71
	72	#ifndef ARCNET_DEBUG_MAX
	73	#define ARCNET_DEBUG_MAX (127) /* change to ~0 if you want detailed debugging */
	74	#endif
	75
	76	#ifndef ARCNET_DEBUG
cb334648	77	#define ARCNET_DEBUG (D_NORMAL \| D_EXTRA)
1da177e4 LT	78	#endif
	79	extern int arcnet_debug;
	80
72aeea48	81	#define BUGLVL(x) ((x) & ARCNET_DEBUG_MAX & arcnet_debug)
d77510f3	82
1da177e4	83	/* macros to simplify debug checking */
a34c0932	84	#define arc_printk(x, dev, fmt, ...) \
d77510f3	85	do { \
a34c0932 JP	86	if (BUGLVL(x)) { \
	87	if ((x) == D_NORMAL) \
	88	netdev_warn(dev, fmt, ##__VA_ARGS__); \
	89	else if ((x) < D_DURING) \
	90	netdev_info(dev, fmt, ##__VA_ARGS__); \
	91	else \
	92	netdev_dbg(dev, fmt, ##__VA_ARGS__); \
	93	} \
d77510f3 JP	94	} while (0)
d77510f3 JP	95
a34c0932	96	#define arc_cont(x, fmt, ...) \
d77510f3	97	do { \
a34c0932 JP	98	if (BUGLVL(x)) \
a34c0932 JP	99	pr_cont(fmt, ##__VA_ARGS__); \
d77510f3	100	} while (0)
1da177e4 LT	101
1da177e4 LT	102	/* see how long a function call takes to run, expressed in CPU cycles */
a34c0932	103	#define TIME(dev, name, bytes, call) \
72aeea48 JP	104	do { \
72aeea48 JP	105	if (BUGLVL(D_TIMING)) { \
cb334648 JP	106	unsigned long _x, _y; \
	107	_x = get_cycles(); \
	108	call; \
	109	_y = get_cycles(); \
a34c0932 JP	110	arc_printk(D_TIMING, dev, \
	111	"%s: %d bytes in %lu cycles == %lu Kbytes/100Mcycle\n", \
	112	name, bytes, _y - _x, \
	113	100000000 / 1024 * bytes / (_y - _x + 1)); \
72aeea48	114	} else { \
cb334648	115	call; \
72aeea48 JP	116	} \
72aeea48 JP	117	} while (0)
1da177e4	118
1da177e4 LT	119	/*
	120	* Time needed to reset the card - in ms (milliseconds). This works on my
	121	* SMC PC100. I can't find a reference that tells me just how long I
	122	* should wait.
	123	*/
	124	#define RESETtime (300)
	125
	126	/*
	127	* These are the max/min lengths of packet payload, not including the
	128	* arc_hardware header, but definitely including the soft header.
	129	*
	130	* Note: packet sizes 254, 255, 256 are impossible because of the way
	131	* ARCnet registers work That's why RFC1201 defines "exception" packets.
	132	* In non-RFC1201 protocols, we have to just tack some extra bytes on the
	133	* end.
	134	*/
	135	#define MTU 253 /* normal packet max size */
	136	#define MinTU 257 /* extended packet min size */
	137	#define XMTU 508 /* extended packet max size */
	138
	139	/* status/interrupt mask bit fields */
	140	#define TXFREEflag 0x01 /* transmitter available */
	141	#define TXACKflag 0x02 /* transmitted msg. ackd */
	142	#define RECONflag 0x04 /* network reconfigured */
	143	#define TESTflag 0x08 /* test flag */
	144	#define EXCNAKflag 0x08 /* excesive nak flag */
	145	#define RESETflag 0x10 /* power-on-reset */
	146	#define RES1flag 0x20 /* reserved - usually set by jumper */
	147	#define RES2flag 0x40 /* reserved - usually set by jumper */
	148	#define NORXflag 0x80 /* receiver inhibited */
	149
	150	/* Flags used for IO-mapped memory operations */
	151	#define AUTOINCflag 0x40 /* Increase location with each access */
	152	#define IOMAPflag 0x02 /* (for 90xx) Use IO mapped memory, not mmap */
	153	#define ENABLE16flag 0x80 /* (for 90xx) Enable 16-bit mode */
	154
	155	/* in the command register, the following bits have these meanings:
	156	* 0-2 command
	157	* 3-4 page number (for enable rcv/xmt command)
	158	* 7 receive broadcasts
	159	*/
	160	#define NOTXcmd 0x01 /* disable transmitter */
	161	#define NORXcmd 0x02 /* disable receiver */
	162	#define TXcmd 0x03 /* enable transmitter */
	163	#define RXcmd 0x04 /* enable receiver */
	164	#define CONFIGcmd 0x05 /* define configuration */
	165	#define CFLAGScmd 0x06 /* clear flags */
	166	#define TESTcmd 0x07 /* load test flags */
	167
	168	/* flags for "clear flags" command */
	169	#define RESETclear 0x08 /* power-on-reset */
	170	#define CONFIGclear 0x10 /* system reconfigured */
	171
	172	#define EXCNAKclear 0x0E /* Clear and acknowledge the excive nak bit */
	173
	174	/* flags for "load test flags" command */
	175	#define TESTload 0x08 /* test flag (diagnostic) */
	176
	177	/* byte deposited into first address of buffers on reset */
	178	#define TESTvalue 0321 /* that's octal for 0xD1 :) */
	179
	180	/* for "enable receiver" command */
	181	#define RXbcasts 0x80 /* receive broadcasts */
	182
183	/* flags for "define configuration" command */
184	#define NORMALconf 0x00 /* 1-249 byte packets */
185	#define EXTconf 0x08 /* 250-504 byte packets */
186
187	/* card feature flags, set during auto-detection.
188	* (currently only used by com20020pci)
189	*/
190	#define ARC_IS_5MBIT 1 /* card default speed is 5MBit */
191	#define ARC_CAN_10MBIT 2 /* card uses COM20022, supporting 10MBit,
192	but default is 2.5MBit. */
193
1da177e4 LT	194	/* information needed to define an encapsulation driver */
	195	struct ArcProto {
	196	char suffix; /* a for RFC1201, e for ether-encap, etc. */
	197	int mtu; /* largest possible packet */
	198	int is_ip; /* This is a ip plugin - not a raw thing */
	199
cb334648 JP	200	void (rx)(struct net_device dev, int bufnum,
	201	struct archdr *pkthdr, int length);
	202	int (build_header)(struct sk_buff skb, struct net_device *dev,
	203	unsigned short ethproto, uint8_t daddr);
1da177e4 LT	204
1da177e4 LT	205	/* these functions return '1' if the skb can now be freed */
d6d7d3ed JP	206	int (prepare_tx)(struct net_device dev, struct archdr *pkt,
d6d7d3ed JP	207	int length, int bufnum);
cb334648 JP	208	int (continue_tx)(struct net_device dev, int bufnum);
cb334648 JP	209	int (ack_tx)(struct net_device dev, int acked);
1da177e4 LT	210	};
	211
	212	extern struct ArcProto arc_proto_map[256], arc_proto_default,
	213	arc_bcast_proto, arc_raw_proto;
1da177e4	214
1da177e4 LT	215	/*
	216	* "Incoming" is information needed for each address that could be sending
	217	* to us. Mostly for partially-received split packets.
	218	*/
	219	struct Incoming {
	220	struct sk_buff skb; / packet data buffer */
701181ac	221	__be16 sequence; /* sequence number of assembly */
1da177e4 LT	222	uint8_t lastpacket, /* number of last packet (from 1) */
	223	numpackets; /* number of packets in split */
	224	};
	225
1da177e4 LT	226	/* only needed for RFC1201 */
	227	struct Outgoing {
	228	struct ArcProto proto; / protocol driver that owns this:
	229	* if NULL, no packet is pending.
	230	*/
	231	struct sk_buff skb; / buffer from upper levels */
	232	struct archdr pkt; / a pointer into the skb */
	233	uint16_t length, /* bytes total */
	234	dataleft, /* bytes left */
	235	segnum, /* segment being sent */
	236	numsegs; /* number of segments */
	237	};
	238
1da177e4	239	struct arcnet_local {
1da177e4 LT	240	uint8_t config, /* current value of CONFIG register */
	241	timeout, /* Extended timeout for COM20020 */
	242	backplane, /* Backplane flag for COM20020 */
	243	clockp, /* COM20020 clock divider */
	244	clockm, /* COM20020 clock multiplier flag */
	245	setup, /* Contents of setup1 register */
	246	setup2, /* Contents of setup2 register */
	247	intmask; /* current value of INTMASK register */
	248	uint8_t default_proto[256]; /* default encap to use for each host */
	249	int cur_tx, /* buffer used by current transmit, or -1 */
	250	next_tx, /* buffer where a packet is ready to send */
	251	cur_rx; /* current receive buffer */
	252	int lastload_dest, /* can last loaded packet be acked? */
	253	lasttrans_dest; /* can last TX'd packet be acked? */
	254	int timed_out; /* need to process TX timeout and drop packet */
	255	unsigned long last_timeout; /* time of last reported timeout */
	256	char card_name; / card ident string */
	257	int card_flags; /* special card features */
	258
1da177e4 LT	259	/* On preemtive and SMB a lock is needed */
	260	spinlock_t lock;
	261
	262	/*
	263	* Buffer management: an ARCnet card has 4 x 512-byte buffers, each of
	264	* which can be used for either sending or receiving. The new dynamic
	265	* buffer management routines use a simple circular queue of available
	266	* buffers, and take them as they're needed. This way, we simplify
	267	* situations in which we (for example) want to pre-load a transmit
	268	* buffer, or start receiving while we copy a received packet to
	269	* memory.
cb334648	270	*
1da177e4 LT	271	* The rules: only the interrupt handler is allowed to _add_ buffers to
	272	* the queue; thus, this doesn't require a lock. Both the interrupt
	273	* handler and the transmit function will want to _remove_ buffers, so
	274	* we need to handle the situation where they try to do it at the same
	275	* time.
cb334648	276	*
1da177e4 LT	277	* If next_buf == first_free_buf, the queue is empty. Since there are
	278	* only four possible buffers, the queue should never be full.
	279	*/
	280	atomic_t buf_lock;
	281	int buf_queue[5];
	282	int next_buf, first_free_buf;
	283
	284	/* network "reconfiguration" handling */
9307b570 CO	285	unsigned long first_recon; /* time of "first" RECON message to count */
9307b570 CO	286	unsigned long last_recon; /* time of most recent RECON */
1da177e4	287	int num_recons; /* number of RECONs between first and last. */
db55b62c	288	int network_down; /* do we think the network is down? */
1da177e4	289
db55b62c	290	int excnak_pending; /* We just got an excesive nak interrupt */
1da177e4 LT	291
	292	struct {
	293	uint16_t sequence; /* sequence number (incs with each packet) */
701181ac	294	__be16 aborted_seq;
1da177e4 LT	295
	296	struct Incoming incoming[256]; /* one from each address */
	297	} rfc1201;
	298
	299	/* really only used by rfc1201, but we'll pretend it's not */
	300	struct Outgoing outgoing; /* packet currently being sent */
	301
	302	/* hardware-specific functions */
	303	struct {
	304	struct module *owner;
cb334648 JP	305	void (command)(struct net_device dev, int cmd);
	306	int (status)(struct net_device dev);
	307	void (intmask)(struct net_device dev, int mask);
	308	int (reset)(struct net_device dev, int really_reset);
	309	void (open)(struct net_device dev);
	310	void (close)(struct net_device dev);
	311
d6d7d3ed JP	312	void (copy_to_card)(struct net_device dev, int bufnum,
	313	int offset, void *buf, int count);
	314	void (copy_from_card)(struct net_device dev, int bufnum,
	315	int offset, void *buf, int count);
1da177e4 LT	316	} hw;
	317
	318	void __iomem mem_start; / pointer to ioremap'ed MMIO */
	319	};
	320
1da177e4 LT	321	#define ARCRESET(x) (lp->hw.reset(dev, (x)))
	322	#define ACOMMAND(x) (lp->hw.command(dev, (x)))
	323	#define ASTATUS() (lp->hw.status(dev))
	324	#define AINTMASK(x) (lp->hw.intmask(dev, (x)))
	325
1da177e4 LT	326	#if ARCNET_DEBUG_MAX & D_SKB
	327	void arcnet_dump_skb(struct net_device dev, struct sk_buff skb, char *desc);
	328	#else
83df99b5 JP	329	static inline
	330	void arcnet_dump_skb(struct net_device dev, struct sk_buff skb, char *desc)
	331	{
	332	}
1da177e4 LT	333	#endif
1da177e4 LT	334
1da177e4	335	void arcnet_unregister_proto(struct ArcProto *proto);
7d12e780	336	irqreturn_t arcnet_interrupt(int irq, void *dev_id);
bca5b893 SH	337	struct net_device alloc_arcdev(const char name);
	338
	339	int arcnet_open(struct net_device *dev);
	340	int arcnet_close(struct net_device *dev);
61357325	341	netdev_tx_t arcnet_send_packet(struct sk_buff *skb,
cb334648	342	struct net_device *dev);
bca5b893	343	void arcnet_timeout(struct net_device *dev);
1da177e4	344
e5fcfc1f JP	345	/* I/O equivalents */
e5fcfc1f JP	346
0fec6513 JP	347	#ifdef CONFIG_SA1100_CT6001
	348	#define BUS_ALIGN 2 /* 8 bit device on a 16 bit bus - needs padding */
	349	#else
	350	#define BUS_ALIGN 1
	351	#endif
	352
e5fcfc1f JP	353	/* addr and offset allow register like names to define the actual IO address.
	354	* A configuration option multiplies the offset for alignment.
	355	*/
	356	#define arcnet_inb(addr, offset) \
0fec6513	357	inb((addr) + BUS_ALIGN * (offset))
e5fcfc1f	358	#define arcnet_outb(value, addr, offset) \
0fec6513	359	outb(value, (addr) + BUS_ALIGN * (offset))
e5fcfc1f JP	360
e5fcfc1f JP	361	#define arcnet_insb(addr, offset, buffer, count) \
0fec6513	362	insb((addr) + BUS_ALIGN * (offset), buffer, count)
e5fcfc1f	363	#define arcnet_outsb(addr, offset, buffer, count) \
0fec6513	364	outsb((addr) + BUS_ALIGN * (offset), buffer, count)
e5fcfc1f JP	365
e5fcfc1f JP	366	#define arcnet_inw(addr, offset) \
0fec6513	367	inw((addr) + BUS_ALIGN * (offset))
e5fcfc1f	368	#define arcnet_outw(value, addr, offset) \
0fec6513	369	outw(value, (addr) + BUS_ALIGN * (offset))
e5fcfc1f JP	370
e5fcfc1f JP	371	#define arcnet_insw(addr, offset, buffer, count) \
0fec6513	372	insw((addr) + BUS_ALIGN * (offset), buffer, count)
e5fcfc1f	373	#define arcnet_outsw(addr, offset, buffer, count) \
0fec6513	374	outsw((addr) + BUS_ALIGN * (offset), buffer, count)
e5fcfc1f	375
1da177e4 LT	376	#endif /* __KERNEL__ */
1da177e4 LT	377	#endif /* _LINUX_ARCDEVICE_H */