[linux-2.6-block.git] / drivers / s390 / net / ctcm_main.h

/*
 *	drivers/s390/net/ctcm_main.h
 *
 *	Copyright IBM Corp. 2001, 2007
 *	Authors:	Fritz Elfert (felfert@millenux.com)
 *			Peter Tiedemann (ptiedem@de.ibm.com)
 */

#ifndef _CTCM_MAIN_H_
#define _CTCM_MAIN_H_

#include <asm/ccwdev.h>
#include <asm/ccwgroup.h>

#include <linux/skbuff.h>
#include <linux/netdevice.h>

#include "fsm.h"
#include "ctcm_dbug.h"
#include "ctcm_mpc.h"

#define CTC_DRIVER_NAME	"ctcm"
#define CTC_DEVICE_NAME	"ctc"
#define MPC_DEVICE_NAME	"mpc"
#define CTC_DEVICE_GENE CTC_DEVICE_NAME "%d"
#define MPC_DEVICE_GENE	MPC_DEVICE_NAME "%d"

#define CHANNEL_FLAGS_READ	0
#define CHANNEL_FLAGS_WRITE	1
#define CHANNEL_FLAGS_INUSE	2
#define CHANNEL_FLAGS_BUFSIZE_CHANGED	4
#define CHANNEL_FLAGS_FAILED	8
#define CHANNEL_FLAGS_WAITIRQ	16
#define CHANNEL_FLAGS_RWMASK	1
#define CHANNEL_DIRECTION(f) (f & CHANNEL_FLAGS_RWMASK)

#define LOG_FLAG_ILLEGALPKT	1
#define LOG_FLAG_ILLEGALSIZE	2
#define LOG_FLAG_OVERRUN	4
#define LOG_FLAG_NOMEM		8

#define ctcm_pr_debug(fmt, arg...) printk(KERN_DEBUG fmt, ##arg)

#define CTCM_PR_DEBUG(fmt, arg...) \
	do { \
		if (do_debug) \
			printk(KERN_DEBUG fmt, ##arg); \
	} while (0)

#define	CTCM_PR_DBGDATA(fmt, arg...) \
	do { \
		if (do_debug_data) \
			printk(KERN_DEBUG fmt, ##arg); \
	} while (0)

#define	CTCM_D3_DUMP(buf, len) \
	do { \
		if (do_debug_data) \
			ctcmpc_dumpit(buf, len); \
	} while (0)

#define	CTCM_CCW_DUMP(buf, len) \
	do { \
		if (do_debug_ccw) \
			ctcmpc_dumpit(buf, len); \
	} while (0)

/**
 * Enum for classifying detected devices
 */
enum ctcm_channel_types {
	/* Device is not a channel  */
	ctcm_channel_type_none,

	/* Device is a CTC/A */
	ctcm_channel_type_parallel,

	/* Device is a FICON channel */
	ctcm_channel_type_ficon,

	/* Device is a ESCON channel */
	ctcm_channel_type_escon
};

/*
 * CCW commands, used in this driver.
 */
#define CCW_CMD_WRITE		0x01
#define CCW_CMD_READ		0x02
#define CCW_CMD_NOOP		0x03
#define CCW_CMD_TIC             0x08
#define CCW_CMD_SENSE_CMD	0x14
#define CCW_CMD_WRITE_CTL	0x17
#define CCW_CMD_SET_EXTENDED	0xc3
#define CCW_CMD_PREPARE		0xe3

#define CTCM_PROTO_S390		0
#define CTCM_PROTO_LINUX	1
#define CTCM_PROTO_LINUX_TTY	2
#define CTCM_PROTO_OS390	3
#define CTCM_PROTO_MPC		4
#define CTCM_PROTO_MAX		4

#define CTCM_BUFSIZE_LIMIT	65535
#define CTCM_BUFSIZE_DEFAULT	32768
#define MPC_BUFSIZE_DEFAULT	CTCM_BUFSIZE_LIMIT

#define CTCM_TIME_1_SEC		1000
#define CTCM_TIME_5_SEC		5000
#define CTCM_TIME_10_SEC	10000

#define CTCM_INITIAL_BLOCKLEN	2

#define CTCM_READ		0
#define CTCM_WRITE		1

#define CTCM_ID_SIZE		20+3

struct ctcm_profile {
	unsigned long maxmulti;
	unsigned long maxcqueue;
	unsigned long doios_single;
	unsigned long doios_multi;
	unsigned long txlen;
	unsigned long tx_time;
	struct timespec send_stamp;
};

/*
 * Definition of one channel
 */
struct channel {
	struct channel *next;
	char id[CTCM_ID_SIZE];
	struct ccw_device *cdev;
	/*
	 * Type of this channel.
	 * CTC/A or Escon for valid channels.
	 */
	enum ctcm_channel_types type;
	/*
	 * Misc. flags. See CHANNEL_FLAGS_... below
	 */
	__u32 flags;
	__u16 protocol;		/* protocol of this channel (4 = MPC) */
	/*
	 * I/O and irq related stuff
	 */
	struct ccw1 *ccw;
	struct irb *irb;
	/*
	 * RX/TX buffer size
	 */
	int max_bufsize;
	struct sk_buff *trans_skb;	/* transmit/receive buffer */
	struct sk_buff_head io_queue;	/* universal I/O queue */
	struct tasklet_struct ch_tasklet;	/* MPC ONLY */
	/*
	 * TX queue for collecting skb's during busy.
	 */
	struct sk_buff_head collect_queue;
	/*
	 * Amount of data in collect_queue.
	 */
	int collect_len;
	/*
	 * spinlock for collect_queue and collect_len
	 */
	spinlock_t collect_lock;
	/*
	 * Timer for detecting unresposive
	 * I/O operations.
	 */
	fsm_timer timer;
	/* MPC ONLY section begin */
	__u32	th_seq_num;	/* SNA TH seq number */
	__u8	th_seg;
	__u32	pdu_seq;
	struct sk_buff		*xid_skb;
	char			*xid_skb_data;
	struct th_header	*xid_th;
	struct xid2		*xid;
	char			*xid_id;
	struct th_header	*rcvd_xid_th;
	struct xid2		*rcvd_xid;
	char			*rcvd_xid_id;
	__u8			in_mpcgroup;
	fsm_timer		sweep_timer;
	struct sk_buff_head	sweep_queue;
	struct th_header	*discontact_th;
	struct tasklet_struct	ch_disc_tasklet;
	/* MPC ONLY section end */

	int retry;		/* retry counter for misc. operations */
	fsm_instance *fsm;	/* finite state machine of this channel */
	struct net_device *netdev;	/* corresponding net_device */
	struct ctcm_profile prof;
	__u8 *trans_skb_data;
	__u16 logflags;
	__u8  sense_rc; /* last unit check sense code report control */
};

struct ctcm_priv {
	struct net_device_stats	stats;
	unsigned long	tbusy;

	/* The MPC group struct of this interface */
	struct	mpc_group	*mpcg;	/* MPC only */
	struct	xid2		*xid;	/* MPC only */

	/* The finite state machine of this interface */
	fsm_instance *fsm;

	/* The protocol of this device */
	__u16 protocol;

	/* Timer for restarting after I/O Errors */
	fsm_timer	restart_timer;

	int buffer_size;	/* ctc only */

	struct channel *channel[2];
};

int ctcm_open(struct net_device *dev);
int ctcm_close(struct net_device *dev);

/*
 * prototypes for non-static sysfs functions
 */
int ctcm_add_attributes(struct device *dev);
void ctcm_remove_attributes(struct device *dev);
int ctcm_add_files(struct device *dev);
void ctcm_remove_files(struct device *dev);

/*
 * Compatibility macros for busy handling
 * of network devices.
 */
static inline void ctcm_clear_busy_do(struct net_device *dev)
{
	clear_bit(0, &(((struct ctcm_priv *)dev->ml_priv)->tbusy));
	netif_wake_queue(dev);
}

static inline void ctcm_clear_busy(struct net_device *dev)
{
	struct mpc_group *grp;
	grp = ((struct ctcm_priv *)dev->ml_priv)->mpcg;

	if (!(grp && grp->in_sweep))
		ctcm_clear_busy_do(dev);
}


static inline int ctcm_test_and_set_busy(struct net_device *dev)
{
	netif_stop_queue(dev);
	return test_and_set_bit(0,
			&(((struct ctcm_priv *)dev->ml_priv)->tbusy));
}

extern int loglevel;
extern struct channel *channels;

void ctcm_unpack_skb(struct channel *ch, struct sk_buff *pskb);

/*
 * Functions related to setup and device detection.
 */

static inline int ctcm_less_than(char *id1, char *id2)
{
	unsigned long dev1, dev2;

	id1 = id1 + 5;
	id2 = id2 + 5;

	dev1 = simple_strtoul(id1, &id1, 16);
	dev2 = simple_strtoul(id2, &id2, 16);

	return (dev1 < dev2);
}

int ctcm_ch_alloc_buffer(struct channel *ch);

static inline int ctcm_checkalloc_buffer(struct channel *ch)
{
	if (ch->trans_skb == NULL)
		return ctcm_ch_alloc_buffer(ch);
	if (ch->flags & CHANNEL_FLAGS_BUFSIZE_CHANGED) {
		dev_kfree_skb(ch->trans_skb);
		return ctcm_ch_alloc_buffer(ch);
	}
	return 0;
}

struct mpc_group *ctcmpc_init_mpc_group(struct ctcm_priv *priv);

/* test if protocol attribute (of struct ctcm_priv or struct channel)
 * has MPC protocol setting. Type is not checked
 */
#define IS_MPC(p) ((p)->protocol == CTCM_PROTO_MPC)

/* test if struct ctcm_priv of struct net_device has MPC protocol setting */
#define IS_MPCDEV(dev) IS_MPC((struct ctcm_priv *)dev->ml_priv)

static inline gfp_t gfp_type(void)
{
	return in_interrupt() ? GFP_ATOMIC : GFP_KERNEL;
}

/*
 * Definition of our link level header.
 */
struct ll_header {
	__u16 length;
	__u16 type;
	__u16 unused;
};
#define LL_HEADER_LENGTH (sizeof(struct ll_header))

#endif
Commit	Line	Data
293d984f PT	1	/*
	2	* drivers/s390/net/ctcm_main.h
	3	*
	4	* Copyright IBM Corp. 2001, 2007
	5	* Authors: Fritz Elfert (felfert@millenux.com)
	6	* Peter Tiedemann (ptiedem@de.ibm.com)
	7	*/
	8
	9	#ifndef _CTCM_MAIN_H_
	10	#define _CTCM_MAIN_H_
	11
	12	#include <asm/ccwdev.h>
	13	#include <asm/ccwgroup.h>
	14
	15	#include <linux/skbuff.h>
	16	#include <linux/netdevice.h>
	17
	18	#include "fsm.h"
293d984f PT	19	#include "ctcm_dbug.h"
	20	#include "ctcm_mpc.h"
	21
	22	#define CTC_DRIVER_NAME "ctcm"
	23	#define CTC_DEVICE_NAME "ctc"
293d984f	24	#define MPC_DEVICE_NAME "mpc"
aa3f2cb6 PT	25	#define CTC_DEVICE_GENE CTC_DEVICE_NAME "%d"
aa3f2cb6 PT	26	#define MPC_DEVICE_GENE MPC_DEVICE_NAME "%d"
293d984f PT	27
	28	#define CHANNEL_FLAGS_READ 0
	29	#define CHANNEL_FLAGS_WRITE 1
	30	#define CHANNEL_FLAGS_INUSE 2
	31	#define CHANNEL_FLAGS_BUFSIZE_CHANGED 4
	32	#define CHANNEL_FLAGS_FAILED 8
	33	#define CHANNEL_FLAGS_WAITIRQ 16
	34	#define CHANNEL_FLAGS_RWMASK 1
	35	#define CHANNEL_DIRECTION(f) (f & CHANNEL_FLAGS_RWMASK)
	36
	37	#define LOG_FLAG_ILLEGALPKT 1
	38	#define LOG_FLAG_ILLEGALSIZE 2
	39	#define LOG_FLAG_OVERRUN 4
	40	#define LOG_FLAG_NOMEM 8
	41
	42	#define ctcm_pr_debug(fmt, arg...) printk(KERN_DEBUG fmt, ##arg)
293d984f	43
aa3f2cb6 PT	44	#define CTCM_PR_DEBUG(fmt, arg...) \
	45	do { \
	46	if (do_debug) \
	47	printk(KERN_DEBUG fmt, ##arg); \
	48	} while (0)
	49
	50	#define CTCM_PR_DBGDATA(fmt, arg...) \
	51	do { \
	52	if (do_debug_data) \
	53	printk(KERN_DEBUG fmt, ##arg); \
	54	} while (0)
	55
	56	#define CTCM_D3_DUMP(buf, len) \
	57	do { \
	58	if (do_debug_data) \
	59	ctcmpc_dumpit(buf, len); \
	60	} while (0)
	61
	62	#define CTCM_CCW_DUMP(buf, len) \
	63	do { \
	64	if (do_debug_ccw) \
	65	ctcmpc_dumpit(buf, len); \
	66	} while (0)
	67
0ca8cc6f UB	68	/**
	69	* Enum for classifying detected devices
	70	*/
	71	enum ctcm_channel_types {
	72	/* Device is not a channel */
	73	ctcm_channel_type_none,
	74
	75	/* Device is a CTC/A */
	76	ctcm_channel_type_parallel,
	77
	78	/* Device is a FICON channel */
	79	ctcm_channel_type_ficon,
	80
	81	/* Device is a ESCON channel */
	82	ctcm_channel_type_escon
	83	};
	84
293d984f PT	85	/*
	86	* CCW commands, used in this driver.
	87	*/
	88	#define CCW_CMD_WRITE 0x01
	89	#define CCW_CMD_READ 0x02
	90	#define CCW_CMD_NOOP 0x03
	91	#define CCW_CMD_TIC 0x08
	92	#define CCW_CMD_SENSE_CMD 0x14
	93	#define CCW_CMD_WRITE_CTL 0x17
	94	#define CCW_CMD_SET_EXTENDED 0xc3
	95	#define CCW_CMD_PREPARE 0xe3
	96
	97	#define CTCM_PROTO_S390 0
	98	#define CTCM_PROTO_LINUX 1
	99	#define CTCM_PROTO_LINUX_TTY 2
	100	#define CTCM_PROTO_OS390 3
	101	#define CTCM_PROTO_MPC 4
	102	#define CTCM_PROTO_MAX 4
	103
	104	#define CTCM_BUFSIZE_LIMIT 65535
	105	#define CTCM_BUFSIZE_DEFAULT 32768
	106	#define MPC_BUFSIZE_DEFAULT CTCM_BUFSIZE_LIMIT
	107
	108	#define CTCM_TIME_1_SEC 1000
	109	#define CTCM_TIME_5_SEC 5000
	110	#define CTCM_TIME_10_SEC 10000
	111
	112	#define CTCM_INITIAL_BLOCKLEN 2
	113
3c09e264 UB	114	#define CTCM_READ 0
3c09e264 UB	115	#define CTCM_WRITE 1
293d984f	116
2a0217d5	117	#define CTCM_ID_SIZE 20+3
293d984f PT	118
	119	struct ctcm_profile {
	120	unsigned long maxmulti;
	121	unsigned long maxcqueue;
	122	unsigned long doios_single;
	123	unsigned long doios_multi;
	124	unsigned long txlen;
	125	unsigned long tx_time;
	126	struct timespec send_stamp;
	127	};
	128
	129	/*
	130	* Definition of one channel
	131	*/
	132	struct channel {
	133	struct channel *next;
	134	char id[CTCM_ID_SIZE];
	135	struct ccw_device *cdev;
	136	/*
	137	* Type of this channel.
	138	* CTC/A or Escon for valid channels.
	139	*/
0ca8cc6f	140	enum ctcm_channel_types type;
293d984f PT	141	/*
	142	* Misc. flags. See CHANNEL_FLAGS_... below
	143	*/
	144	__u32 flags;
	145	__u16 protocol; /* protocol of this channel (4 = MPC) */
	146	/*
	147	* I/O and irq related stuff
	148	*/
	149	struct ccw1 *ccw;
	150	struct irb *irb;
	151	/*
	152	* RX/TX buffer size
	153	*/
	154	int max_bufsize;
	155	struct sk_buff trans_skb; / transmit/receive buffer */
	156	struct sk_buff_head io_queue; /* universal I/O queue */
	157	struct tasklet_struct ch_tasklet; /* MPC ONLY */
	158	/*
	159	* TX queue for collecting skb's during busy.
	160	*/
	161	struct sk_buff_head collect_queue;
	162	/*
	163	* Amount of data in collect_queue.
	164	*/
	165	int collect_len;
	166	/*
	167	* spinlock for collect_queue and collect_len
	168	*/
	169	spinlock_t collect_lock;
	170	/*
	171	* Timer for detecting unresposive
	172	* I/O operations.
	173	*/
	174	fsm_timer timer;
	175	/* MPC ONLY section begin */
	176	__u32 th_seq_num; /* SNA TH seq number */
	177	__u8 th_seg;
	178	__u32 pdu_seq;
	179	struct sk_buff *xid_skb;
	180	char *xid_skb_data;
	181	struct th_header *xid_th;
	182	struct xid2 *xid;
	183	char *xid_id;
	184	struct th_header *rcvd_xid_th;
	185	struct xid2 *rcvd_xid;
	186	char *rcvd_xid_id;
	187	__u8 in_mpcgroup;
	188	fsm_timer sweep_timer;
	189	struct sk_buff_head sweep_queue;
	190	struct th_header *discontact_th;
	191	struct tasklet_struct ch_disc_tasklet;
	192	/* MPC ONLY section end */
	193
	194	int retry; /* retry counter for misc. operations */
	195	fsm_instance fsm; / finite state machine of this channel */
	196	struct net_device netdev; / corresponding net_device */
	197	struct ctcm_profile prof;
aa3f2cb6	198	__u8 *trans_skb_data;
293d984f	199	__u16 logflags;
aa3f2cb6	200	__u8 sense_rc; /* last unit check sense code report control */
293d984f PT	201	};
	202
	203	struct ctcm_priv {
	204	struct net_device_stats stats;
	205	unsigned long tbusy;
	206
	207	/* The MPC group struct of this interface */
	208	struct mpc_group mpcg; / MPC only */
	209	struct xid2 xid; / MPC only */
	210
	211	/* The finite state machine of this interface */
	212	fsm_instance *fsm;
	213
	214	/* The protocol of this device */
	215	__u16 protocol;
	216
	217	/* Timer for restarting after I/O Errors */
	218	fsm_timer restart_timer;
	219
	220	int buffer_size; /* ctc only */
	221
	222	struct channel *channel[2];
	223	};
	224
	225	int ctcm_open(struct net_device *dev);
	226	int ctcm_close(struct net_device *dev);
	227
	228	/*
	229	* prototypes for non-static sysfs functions
	230	*/
	231	int ctcm_add_attributes(struct device *dev);
	232	void ctcm_remove_attributes(struct device *dev);
	233	int ctcm_add_files(struct device *dev);
	234	void ctcm_remove_files(struct device *dev);
	235
	236	/*
	237	* Compatibility macros for busy handling
	238	* of network devices.
	239	*/
	240	static inline void ctcm_clear_busy_do(struct net_device *dev)
	241	{
261893d3	242	clear_bit(0, &(((struct ctcm_priv *)dev->ml_priv)->tbusy));
293d984f PT	243	netif_wake_queue(dev);
	244	}
	245
	246	static inline void ctcm_clear_busy(struct net_device *dev)
	247	{
	248	struct mpc_group *grp;
261893d3	249	grp = ((struct ctcm_priv *)dev->ml_priv)->mpcg;
293d984f PT	250
	251	if (!(grp && grp->in_sweep))
	252	ctcm_clear_busy_do(dev);
	253	}
	254
	255
	256	static inline int ctcm_test_and_set_busy(struct net_device *dev)
	257	{
	258	netif_stop_queue(dev);
261893d3 PT	259	return test_and_set_bit(0,
261893d3 PT	260	&(((struct ctcm_priv *)dev->ml_priv)->tbusy));
293d984f PT	261	}
	262
	263	extern int loglevel;
	264	extern struct channel *channels;
	265
	266	void ctcm_unpack_skb(struct channel ch, struct sk_buff pskb);
	267
	268	/*
	269	* Functions related to setup and device detection.
	270	*/
	271
	272	static inline int ctcm_less_than(char id1, char id2)
	273	{
	274	unsigned long dev1, dev2;
	275
	276	id1 = id1 + 5;
	277	id2 = id2 + 5;
	278
	279	dev1 = simple_strtoul(id1, &id1, 16);
	280	dev2 = simple_strtoul(id2, &id2, 16);
	281
	282	return (dev1 < dev2);
	283	}
	284
	285	int ctcm_ch_alloc_buffer(struct channel *ch);
	286
	287	static inline int ctcm_checkalloc_buffer(struct channel *ch)
	288	{
	289	if (ch->trans_skb == NULL)
	290	return ctcm_ch_alloc_buffer(ch);
	291	if (ch->flags & CHANNEL_FLAGS_BUFSIZE_CHANGED) {
	292	dev_kfree_skb(ch->trans_skb);
	293	return ctcm_ch_alloc_buffer(ch);
	294	}
	295	return 0;
	296	}
	297
	298	struct mpc_group ctcmpc_init_mpc_group(struct ctcm_priv priv);
	299
	300	/* test if protocol attribute (of struct ctcm_priv or struct channel)
	301	* has MPC protocol setting. Type is not checked
	302	*/
	303	#define IS_MPC(p) ((p)->protocol == CTCM_PROTO_MPC)
	304
	305	/* test if struct ctcm_priv of struct net_device has MPC protocol setting */
261893d3	306	#define IS_MPCDEV(dev) IS_MPC((struct ctcm_priv *)dev->ml_priv)
293d984f PT	307
	308	static inline gfp_t gfp_type(void)
	309	{
	310	return in_interrupt() ? GFP_ATOMIC : GFP_KERNEL;
	311	}
	312
	313	/*
	314	* Definition of our link level header.
	315	*/
	316	struct ll_header {
	317	__u16 length;
	318	__u16 type;
	319	__u16 unused;
	320	};
	321	#define LL_HEADER_LENGTH (sizeof(struct ll_header))
	322
	323	#endif