xref: /openbmc/linux/drivers/s390/net/qeth_core.h (revision 9cfc5c90)
1 /*
2  *    Copyright IBM Corp. 2007
3  *    Author(s): Utz Bacher <utz.bacher@de.ibm.com>,
4  *		 Frank Pavlic <fpavlic@de.ibm.com>,
5  *		 Thomas Spatzier <tspat@de.ibm.com>,
6  *		 Frank Blaschka <frank.blaschka@de.ibm.com>
7  */
8 
9 #ifndef __QETH_CORE_H__
10 #define __QETH_CORE_H__
11 
12 #include <linux/if.h>
13 #include <linux/if_arp.h>
14 #include <linux/etherdevice.h>
15 #include <linux/if_vlan.h>
16 #include <linux/ctype.h>
17 #include <linux/in6.h>
18 #include <linux/bitops.h>
19 #include <linux/seq_file.h>
20 #include <linux/ethtool.h>
21 #include <linux/hashtable.h>
22 
23 #include <net/ipv6.h>
24 #include <net/if_inet6.h>
25 #include <net/addrconf.h>
26 
27 #include <asm/debug.h>
28 #include <asm/qdio.h>
29 #include <asm/ccwdev.h>
30 #include <asm/ccwgroup.h>
31 #include <asm/sysinfo.h>
32 
33 #include "qeth_core_mpc.h"
34 
35 /**
36  * Debug Facility stuff
37  */
38 enum qeth_dbf_names {
39 	QETH_DBF_SETUP,
40 	QETH_DBF_MSG,
41 	QETH_DBF_CTRL,
42 	QETH_DBF_INFOS	/* must be last element */
43 };
44 
45 struct qeth_dbf_info {
46 	char name[DEBUG_MAX_NAME_LEN];
47 	int pages;
48 	int areas;
49 	int len;
50 	int level;
51 	struct debug_view *view;
52 	debug_info_t *id;
53 };
54 
55 #define QETH_DBF_CTRL_LEN 256
56 
57 #define QETH_DBF_TEXT(name, level, text) \
58 	debug_text_event(qeth_dbf[QETH_DBF_##name].id, level, text)
59 
60 #define QETH_DBF_HEX(name, level, addr, len) \
61 	debug_event(qeth_dbf[QETH_DBF_##name].id, level, (void *)(addr), len)
62 
63 #define QETH_DBF_MESSAGE(level, text...) \
64 	debug_sprintf_event(qeth_dbf[QETH_DBF_MSG].id, level, text)
65 
66 #define QETH_DBF_TEXT_(name, level, text...) \
67 	qeth_dbf_longtext(qeth_dbf[QETH_DBF_##name].id, level, text)
68 
69 #define QETH_CARD_TEXT(card, level, text) \
70 	debug_text_event(card->debug, level, text)
71 
72 #define QETH_CARD_HEX(card, level, addr, len) \
73 	debug_event(card->debug, level, (void *)(addr), len)
74 
75 #define QETH_CARD_MESSAGE(card, text...) \
76 	debug_sprintf_event(card->debug, level, text)
77 
78 #define QETH_CARD_TEXT_(card, level, text...) \
79 	qeth_dbf_longtext(card->debug, level, text)
80 
81 #define SENSE_COMMAND_REJECT_BYTE 0
82 #define SENSE_COMMAND_REJECT_FLAG 0x80
83 #define SENSE_RESETTING_EVENT_BYTE 1
84 #define SENSE_RESETTING_EVENT_FLAG 0x80
85 
86 /*
87  * Common IO related definitions
88  */
89 #define CARD_RDEV(card) card->read.ccwdev
90 #define CARD_WDEV(card) card->write.ccwdev
91 #define CARD_DDEV(card) card->data.ccwdev
92 #define CARD_BUS_ID(card) dev_name(&card->gdev->dev)
93 #define CARD_RDEV_ID(card) dev_name(&card->read.ccwdev->dev)
94 #define CARD_WDEV_ID(card) dev_name(&card->write.ccwdev->dev)
95 #define CARD_DDEV_ID(card) dev_name(&card->data.ccwdev->dev)
96 #define CHANNEL_ID(channel) dev_name(&channel->ccwdev->dev)
97 
98 /**
99  * card stuff
100  */
101 struct qeth_perf_stats {
102 	unsigned int bufs_rec;
103 	unsigned int bufs_sent;
104 
105 	unsigned int skbs_sent_pack;
106 	unsigned int bufs_sent_pack;
107 
108 	unsigned int sc_dp_p;
109 	unsigned int sc_p_dp;
110 	/* qdio_cq_handler: number of times called, time spent in */
111 	__u64 cq_start_time;
112 	unsigned int cq_cnt;
113 	unsigned int cq_time;
114 	/* qdio_input_handler: number of times called, time spent in */
115 	__u64 inbound_start_time;
116 	unsigned int inbound_cnt;
117 	unsigned int inbound_time;
118 	/* qeth_send_packet: number of times called, time spent in */
119 	__u64 outbound_start_time;
120 	unsigned int outbound_cnt;
121 	unsigned int outbound_time;
122 	/* qdio_output_handler: number of times called, time spent in */
123 	__u64 outbound_handler_start_time;
124 	unsigned int outbound_handler_cnt;
125 	unsigned int outbound_handler_time;
126 	/* number of calls to and time spent in do_QDIO for inbound queue */
127 	__u64 inbound_do_qdio_start_time;
128 	unsigned int inbound_do_qdio_cnt;
129 	unsigned int inbound_do_qdio_time;
130 	/* number of calls to and time spent in do_QDIO for outbound queues */
131 	__u64 outbound_do_qdio_start_time;
132 	unsigned int outbound_do_qdio_cnt;
133 	unsigned int outbound_do_qdio_time;
134 	unsigned int large_send_bytes;
135 	unsigned int large_send_cnt;
136 	unsigned int sg_skbs_sent;
137 	unsigned int sg_frags_sent;
138 	/* initial values when measuring starts */
139 	unsigned long initial_rx_packets;
140 	unsigned long initial_tx_packets;
141 	/* inbound scatter gather data */
142 	unsigned int sg_skbs_rx;
143 	unsigned int sg_frags_rx;
144 	unsigned int sg_alloc_page_rx;
145 	unsigned int tx_csum;
146 	unsigned int tx_lin;
147 };
148 
149 /* Routing stuff */
150 struct qeth_routing_info {
151 	enum qeth_routing_types type;
152 };
153 
154 /* IPA stuff */
155 struct qeth_ipa_info {
156 	__u32 supported_funcs;
157 	__u32 enabled_funcs;
158 };
159 
160 /* SETBRIDGEPORT stuff */
161 enum qeth_sbp_roles {
162 	QETH_SBP_ROLE_NONE	= 0,
163 	QETH_SBP_ROLE_PRIMARY	= 1,
164 	QETH_SBP_ROLE_SECONDARY	= 2,
165 };
166 
167 enum qeth_sbp_states {
168 	QETH_SBP_STATE_INACTIVE	= 0,
169 	QETH_SBP_STATE_STANDBY	= 1,
170 	QETH_SBP_STATE_ACTIVE	= 2,
171 };
172 
173 #define QETH_SBP_HOST_NOTIFICATION 1
174 
175 struct qeth_sbp_info {
176 	__u32 supported_funcs;
177 	enum qeth_sbp_roles role;
178 	__u32 hostnotification:1;
179 	__u32 reflect_promisc:1;
180 	__u32 reflect_promisc_primary:1;
181 };
182 
183 static inline int qeth_is_ipa_supported(struct qeth_ipa_info *ipa,
184 		enum qeth_ipa_funcs func)
185 {
186 	return (ipa->supported_funcs & func);
187 }
188 
189 static inline int qeth_is_ipa_enabled(struct qeth_ipa_info *ipa,
190 		enum qeth_ipa_funcs func)
191 {
192 	return (ipa->supported_funcs & ipa->enabled_funcs & func);
193 }
194 
195 #define qeth_adp_supported(c, f) \
196 	qeth_is_ipa_supported(&c->options.adp, f)
197 #define qeth_adp_enabled(c, f) \
198 	qeth_is_ipa_enabled(&c->options.adp, f)
199 #define qeth_is_supported(c, f) \
200 	qeth_is_ipa_supported(&c->options.ipa4, f)
201 #define qeth_is_enabled(c, f) \
202 	qeth_is_ipa_enabled(&c->options.ipa4, f)
203 #define qeth_is_supported6(c, f) \
204 	qeth_is_ipa_supported(&c->options.ipa6, f)
205 #define qeth_is_enabled6(c, f) \
206 	qeth_is_ipa_enabled(&c->options.ipa6, f)
207 #define qeth_is_ipafunc_supported(c, prot, f) \
208 	 ((prot == QETH_PROT_IPV6) ? \
209 		qeth_is_supported6(c, f) : qeth_is_supported(c, f))
210 #define qeth_is_ipafunc_enabled(c, prot, f) \
211 	 ((prot == QETH_PROT_IPV6) ? \
212 		qeth_is_enabled6(c, f) : qeth_is_enabled(c, f))
213 
214 #define QETH_IDX_FUNC_LEVEL_OSD		 0x0101
215 #define QETH_IDX_FUNC_LEVEL_IQD		 0x4108
216 
217 #define QETH_MODELLIST_ARRAY \
218 	{{0x1731, 0x01, 0x1732, QETH_CARD_TYPE_OSD, QETH_MAX_QUEUES, 0}, \
219 	 {0x1731, 0x05, 0x1732, QETH_CARD_TYPE_IQD, QETH_MAX_QUEUES, 0x103}, \
220 	 {0x1731, 0x06, 0x1732, QETH_CARD_TYPE_OSN, QETH_MAX_QUEUES, 0}, \
221 	 {0x1731, 0x02, 0x1732, QETH_CARD_TYPE_OSM, QETH_MAX_QUEUES, 0}, \
222 	 {0x1731, 0x02, 0x1732, QETH_CARD_TYPE_OSX, QETH_MAX_QUEUES, 0}, \
223 	 {0, 0, 0, 0, 0, 0} }
224 #define QETH_CU_TYPE_IND	0
225 #define QETH_CU_MODEL_IND	1
226 #define QETH_DEV_TYPE_IND	2
227 #define QETH_DEV_MODEL_IND	3
228 #define QETH_QUEUE_NO_IND	4
229 #define QETH_MULTICAST_IND	5
230 
231 #define QETH_REAL_CARD		1
232 #define QETH_VLAN_CARD		2
233 #define QETH_BUFSIZE		4096
234 
235 /**
236  * some more defs
237  */
238 #define QETH_TX_TIMEOUT		100 * HZ
239 #define QETH_RCD_TIMEOUT	60 * HZ
240 #define QETH_RECLAIM_WORK_TIME	HZ
241 #define QETH_HEADER_SIZE	32
242 #define QETH_MAX_PORTNO		15
243 
244 /*IPv6 address autoconfiguration stuff*/
245 #define UNIQUE_ID_IF_CREATE_ADDR_FAILED 0xfffe
246 #define UNIQUE_ID_NOT_BY_CARD		0x10000
247 
248 /*****************************************************************************/
249 /* QDIO queue and buffer handling                                            */
250 /*****************************************************************************/
251 #define QETH_MAX_QUEUES 4
252 #define QETH_IN_BUF_SIZE_DEFAULT 65536
253 #define QETH_IN_BUF_COUNT_DEFAULT 64
254 #define QETH_IN_BUF_COUNT_HSDEFAULT 128
255 #define QETH_IN_BUF_COUNT_MIN 8
256 #define QETH_IN_BUF_COUNT_MAX 128
257 #define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
258 #define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
259 		 ((card)->qdio.in_buf_pool.buf_count / 2)
260 
261 /* buffers we have to be behind before we get a PCI */
262 #define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
263 /*enqueued free buffers left before we get a PCI*/
264 #define QETH_PCI_THRESHOLD_B(card) 0
265 /*not used unless the microcode gets patched*/
266 #define QETH_PCI_TIMER_VALUE(card) 3
267 
268 /* priority queing */
269 #define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
270 #define QETH_DEFAULT_QUEUE    2
271 #define QETH_NO_PRIO_QUEUEING 0
272 #define QETH_PRIO_Q_ING_PREC  1
273 #define QETH_PRIO_Q_ING_TOS   2
274 #define QETH_PRIO_Q_ING_SKB   3
275 #define QETH_PRIO_Q_ING_VLAN  4
276 
277 /* Packing */
278 #define QETH_LOW_WATERMARK_PACK  2
279 #define QETH_HIGH_WATERMARK_PACK 5
280 #define QETH_WATERMARK_PACK_FUZZ 1
281 
282 #define QETH_IP_HEADER_SIZE 40
283 
284 /* large receive scatter gather copy break */
285 #define QETH_RX_SG_CB (PAGE_SIZE >> 1)
286 #define QETH_RX_PULL_LEN 256
287 
288 struct qeth_hdr_layer3 {
289 	__u8  id;
290 	__u8  flags;
291 	__u16 inbound_checksum; /*TSO:__u16 seqno */
292 	__u32 token;		/*TSO: __u32 reserved */
293 	__u16 length;
294 	__u8  vlan_prio;
295 	__u8  ext_flags;
296 	__u16 vlan_id;
297 	__u16 frame_offset;
298 	__u8  dest_addr[16];
299 } __attribute__ ((packed));
300 
301 struct qeth_hdr_layer2 {
302 	__u8 id;
303 	__u8 flags[3];
304 	__u8 port_no;
305 	__u8 hdr_length;
306 	__u16 pkt_length;
307 	__u16 seq_no;
308 	__u16 vlan_id;
309 	__u32 reserved;
310 	__u8 reserved2[16];
311 } __attribute__ ((packed));
312 
313 struct qeth_hdr_osn {
314 	__u8 id;
315 	__u8 reserved;
316 	__u16 seq_no;
317 	__u16 reserved2;
318 	__u16 control_flags;
319 	__u16 pdu_length;
320 	__u8 reserved3[18];
321 	__u32 ccid;
322 } __attribute__ ((packed));
323 
324 struct qeth_hdr {
325 	union {
326 		struct qeth_hdr_layer2 l2;
327 		struct qeth_hdr_layer3 l3;
328 		struct qeth_hdr_osn    osn;
329 	} hdr;
330 } __attribute__ ((packed));
331 
332 /*TCP Segmentation Offload header*/
333 struct qeth_hdr_ext_tso {
334 	__u16 hdr_tot_len;
335 	__u8  imb_hdr_no;
336 	__u8  reserved;
337 	__u8  hdr_type;
338 	__u8  hdr_version;
339 	__u16 hdr_len;
340 	__u32 payload_len;
341 	__u16 mss;
342 	__u16 dg_hdr_len;
343 	__u8  padding[16];
344 } __attribute__ ((packed));
345 
346 struct qeth_hdr_tso {
347 	struct qeth_hdr hdr;	/*hdr->hdr.l3.xxx*/
348 	struct qeth_hdr_ext_tso ext;
349 } __attribute__ ((packed));
350 
351 
352 /* flags for qeth_hdr.flags */
353 #define QETH_HDR_PASSTHRU 0x10
354 #define QETH_HDR_IPV6     0x80
355 #define QETH_HDR_CAST_MASK 0x07
356 enum qeth_cast_flags {
357 	QETH_CAST_UNICAST   = 0x06,
358 	QETH_CAST_MULTICAST = 0x04,
359 	QETH_CAST_BROADCAST = 0x05,
360 	QETH_CAST_ANYCAST   = 0x07,
361 	QETH_CAST_NOCAST    = 0x00,
362 };
363 
364 enum qeth_layer2_frame_flags {
365 	QETH_LAYER2_FLAG_MULTICAST = 0x01,
366 	QETH_LAYER2_FLAG_BROADCAST = 0x02,
367 	QETH_LAYER2_FLAG_UNICAST   = 0x04,
368 	QETH_LAYER2_FLAG_VLAN      = 0x10,
369 };
370 
371 enum qeth_header_ids {
372 	QETH_HEADER_TYPE_LAYER3 = 0x01,
373 	QETH_HEADER_TYPE_LAYER2 = 0x02,
374 	QETH_HEADER_TYPE_TSO	= 0x03,
375 	QETH_HEADER_TYPE_OSN    = 0x04,
376 };
377 /* flags for qeth_hdr.ext_flags */
378 #define QETH_HDR_EXT_VLAN_FRAME       0x01
379 #define QETH_HDR_EXT_TOKEN_ID         0x02
380 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
381 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
382 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
383 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
384 #define QETH_HDR_EXT_UDP	      0x40 /*bit off for TCP*/
385 
386 enum qeth_qdio_buffer_states {
387 	/*
388 	 * inbound: read out by driver; owned by hardware in order to be filled
389 	 * outbound: owned by driver in order to be filled
390 	 */
391 	QETH_QDIO_BUF_EMPTY,
392 	/*
393 	 * inbound: filled by hardware; owned by driver in order to be read out
394 	 * outbound: filled by driver; owned by hardware in order to be sent
395 	 */
396 	QETH_QDIO_BUF_PRIMED,
397 	/*
398 	 * inbound: not applicable
399 	 * outbound: identified to be pending in TPQ
400 	 */
401 	QETH_QDIO_BUF_PENDING,
402 	/*
403 	 * inbound: not applicable
404 	 * outbound: found in completion queue
405 	 */
406 	QETH_QDIO_BUF_IN_CQ,
407 	/*
408 	 * inbound: not applicable
409 	 * outbound: handled via transfer pending / completion queue
410 	 */
411 	QETH_QDIO_BUF_HANDLED_DELAYED,
412 };
413 
414 enum qeth_qdio_info_states {
415 	QETH_QDIO_UNINITIALIZED,
416 	QETH_QDIO_ALLOCATED,
417 	QETH_QDIO_ESTABLISHED,
418 	QETH_QDIO_CLEANING
419 };
420 
421 struct qeth_buffer_pool_entry {
422 	struct list_head list;
423 	struct list_head init_list;
424 	void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
425 };
426 
427 struct qeth_qdio_buffer_pool {
428 	struct list_head entry_list;
429 	int buf_count;
430 };
431 
432 struct qeth_qdio_buffer {
433 	struct qdio_buffer *buffer;
434 	/* the buffer pool entry currently associated to this buffer */
435 	struct qeth_buffer_pool_entry *pool_entry;
436 	struct sk_buff *rx_skb;
437 };
438 
439 struct qeth_qdio_q {
440 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
441 	struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
442 	int next_buf_to_init;
443 };
444 
445 struct qeth_qdio_out_buffer {
446 	struct qdio_buffer *buffer;
447 	atomic_t state;
448 	int next_element_to_fill;
449 	struct sk_buff_head skb_list;
450 	int is_header[16];
451 
452 	struct qaob *aob;
453 	struct qeth_qdio_out_q *q;
454 	struct qeth_qdio_out_buffer *next_pending;
455 };
456 
457 struct qeth_card;
458 
459 enum qeth_out_q_states {
460        QETH_OUT_Q_UNLOCKED,
461        QETH_OUT_Q_LOCKED,
462        QETH_OUT_Q_LOCKED_FLUSH,
463 };
464 
465 struct qeth_qdio_out_q {
466 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
467 	struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
468 	struct qdio_outbuf_state *bufstates; /* convenience pointer */
469 	int queue_no;
470 	struct qeth_card *card;
471 	atomic_t state;
472 	int do_pack;
473 	/*
474 	 * index of buffer to be filled by driver; state EMPTY or PACKING
475 	 */
476 	int next_buf_to_fill;
477 	/*
478 	 * number of buffers that are currently filled (PRIMED)
479 	 * -> these buffers are hardware-owned
480 	 */
481 	atomic_t used_buffers;
482 	/* indicates whether PCI flag must be set (or if one is outstanding) */
483 	atomic_t set_pci_flags_count;
484 };
485 
486 struct qeth_qdio_info {
487 	atomic_t state;
488 	/* input */
489 	int no_in_queues;
490 	struct qeth_qdio_q *in_q;
491 	struct qeth_qdio_q *c_q;
492 	struct qeth_qdio_buffer_pool in_buf_pool;
493 	struct qeth_qdio_buffer_pool init_pool;
494 	int in_buf_size;
495 
496 	/* output */
497 	int no_out_queues;
498 	struct qeth_qdio_out_q **out_qs;
499 	struct qdio_outbuf_state *out_bufstates;
500 
501 	/* priority queueing */
502 	int do_prio_queueing;
503 	int default_out_queue;
504 };
505 
506 enum qeth_send_errors {
507 	QETH_SEND_ERROR_NONE,
508 	QETH_SEND_ERROR_LINK_FAILURE,
509 	QETH_SEND_ERROR_RETRY,
510 	QETH_SEND_ERROR_KICK_IT,
511 };
512 
513 #define QETH_ETH_MAC_V4      0x0100 /* like v4 */
514 #define QETH_ETH_MAC_V6      0x3333 /* like v6 */
515 /* tr mc mac is longer, but that will be enough to detect mc frames */
516 #define QETH_TR_MAC_NC       0xc000 /* non-canonical */
517 #define QETH_TR_MAC_C        0x0300 /* canonical */
518 
519 #define DEFAULT_ADD_HHLEN 0
520 #define MAX_ADD_HHLEN 1024
521 
522 /**
523  * buffer stuff for read channel
524  */
525 #define QETH_CMD_BUFFER_NO	8
526 
527 /**
528  *  channel state machine
529  */
530 enum qeth_channel_states {
531 	CH_STATE_UP,
532 	CH_STATE_DOWN,
533 	CH_STATE_ACTIVATING,
534 	CH_STATE_HALTED,
535 	CH_STATE_STOPPED,
536 	CH_STATE_RCD,
537 	CH_STATE_RCD_DONE,
538 };
539 /**
540  * card state machine
541  */
542 enum qeth_card_states {
543 	CARD_STATE_DOWN,
544 	CARD_STATE_HARDSETUP,
545 	CARD_STATE_SOFTSETUP,
546 	CARD_STATE_UP,
547 	CARD_STATE_RECOVER,
548 };
549 
550 /**
551  * Protocol versions
552  */
553 enum qeth_prot_versions {
554 	QETH_PROT_IPV4 = 0x0004,
555 	QETH_PROT_IPV6 = 0x0006,
556 };
557 
558 enum qeth_ip_types {
559 	QETH_IP_TYPE_NORMAL,
560 	QETH_IP_TYPE_VIPA,
561 	QETH_IP_TYPE_RXIP,
562 	QETH_IP_TYPE_DEL_ALL_MC,
563 };
564 
565 enum qeth_cmd_buffer_state {
566 	BUF_STATE_FREE,
567 	BUF_STATE_LOCKED,
568 	BUF_STATE_PROCESSED,
569 };
570 
571 enum qeth_cq {
572 	QETH_CQ_DISABLED = 0,
573 	QETH_CQ_ENABLED = 1,
574 	QETH_CQ_NOTAVAILABLE = 2,
575 };
576 
577 struct qeth_ipato {
578 	int enabled;
579 	int invert4;
580 	int invert6;
581 	struct list_head entries;
582 };
583 
584 struct qeth_channel;
585 
586 struct qeth_cmd_buffer {
587 	enum qeth_cmd_buffer_state state;
588 	struct qeth_channel *channel;
589 	unsigned char *data;
590 	int rc;
591 	void (*callback) (struct qeth_channel *, struct qeth_cmd_buffer *);
592 };
593 
594 /**
595  * definition of a qeth channel, used for read and write
596  */
597 struct qeth_channel {
598 	enum qeth_channel_states state;
599 	struct ccw1 ccw;
600 	spinlock_t iob_lock;
601 	wait_queue_head_t wait_q;
602 	struct ccw_device *ccwdev;
603 /*command buffer for control data*/
604 	struct qeth_cmd_buffer iob[QETH_CMD_BUFFER_NO];
605 	atomic_t irq_pending;
606 	int io_buf_no;
607 	int buf_no;
608 };
609 
610 /**
611  *  OSA card related definitions
612  */
613 struct qeth_token {
614 	__u32 issuer_rm_w;
615 	__u32 issuer_rm_r;
616 	__u32 cm_filter_w;
617 	__u32 cm_filter_r;
618 	__u32 cm_connection_w;
619 	__u32 cm_connection_r;
620 	__u32 ulp_filter_w;
621 	__u32 ulp_filter_r;
622 	__u32 ulp_connection_w;
623 	__u32 ulp_connection_r;
624 };
625 
626 struct qeth_seqno {
627 	__u32 trans_hdr;
628 	__u32 pdu_hdr;
629 	__u32 pdu_hdr_ack;
630 	__u16 ipa;
631 	__u32 pkt_seqno;
632 };
633 
634 struct qeth_reply {
635 	struct list_head list;
636 	wait_queue_head_t wait_q;
637 	int (*callback)(struct qeth_card *, struct qeth_reply *,
638 		unsigned long);
639 	u32 seqno;
640 	unsigned long offset;
641 	atomic_t received;
642 	int rc;
643 	void *param;
644 	struct qeth_card *card;
645 	atomic_t refcnt;
646 };
647 
648 
649 struct qeth_card_blkt {
650 	int time_total;
651 	int inter_packet;
652 	int inter_packet_jumbo;
653 };
654 
655 #define QETH_BROADCAST_WITH_ECHO    0x01
656 #define QETH_BROADCAST_WITHOUT_ECHO 0x02
657 #define QETH_LAYER2_MAC_READ	    0x01
658 #define QETH_LAYER2_MAC_REGISTERED  0x02
659 struct qeth_card_info {
660 	unsigned short unit_addr2;
661 	unsigned short cula;
662 	unsigned short chpid;
663 	__u16 func_level;
664 	char mcl_level[QETH_MCL_LENGTH + 1];
665 	int guestlan;
666 	int mac_bits;
667 	int portno;
668 	enum qeth_card_types type;
669 	enum qeth_link_types link_type;
670 	int is_multicast_different;
671 	int initial_mtu;
672 	int max_mtu;
673 	int broadcast_capable;
674 	int unique_id;
675 	struct qeth_card_blkt blkt;
676 	__u32 csum_mask;
677 	__u32 tx_csum_mask;
678 	enum qeth_ipa_promisc_modes promisc_mode;
679 	__u32 diagass_support;
680 	__u32 hwtrap;
681 };
682 
683 struct qeth_card_options {
684 	struct qeth_routing_info route4;
685 	struct qeth_ipa_info ipa4;
686 	struct qeth_ipa_info adp; /*Adapter parameters*/
687 	struct qeth_routing_info route6;
688 	struct qeth_ipa_info ipa6;
689 	struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
690 	int fake_broadcast;
691 	int add_hhlen;
692 	int layer2;
693 	int performance_stats;
694 	int rx_sg_cb;
695 	enum qeth_ipa_isolation_modes isolation;
696 	enum qeth_ipa_isolation_modes prev_isolation;
697 	int sniffer;
698 	enum qeth_cq cq;
699 	char hsuid[9];
700 };
701 
702 /*
703  * thread bits for qeth_card thread masks
704  */
705 enum qeth_threads {
706 	QETH_RECOVER_THREAD = 1,
707 };
708 
709 struct qeth_osn_info {
710 	int (*assist_cb)(struct net_device *dev, void *data);
711 	int (*data_cb)(struct sk_buff *skb);
712 };
713 
714 enum qeth_discipline_id {
715 	QETH_DISCIPLINE_LAYER3 = 0,
716 	QETH_DISCIPLINE_LAYER2 = 1,
717 };
718 
719 struct qeth_discipline {
720 	void (*start_poll)(struct ccw_device *, int, unsigned long);
721 	qdio_handler_t *input_handler;
722 	qdio_handler_t *output_handler;
723 	int (*recover)(void *ptr);
724 	int (*setup) (struct ccwgroup_device *);
725 	void (*remove) (struct ccwgroup_device *);
726 	int (*set_online) (struct ccwgroup_device *);
727 	int (*set_offline) (struct ccwgroup_device *);
728 	void (*shutdown)(struct ccwgroup_device *);
729 	int (*prepare) (struct ccwgroup_device *);
730 	void (*complete) (struct ccwgroup_device *);
731 	int (*freeze)(struct ccwgroup_device *);
732 	int (*thaw) (struct ccwgroup_device *);
733 	int (*restore)(struct ccwgroup_device *);
734 	int (*control_event_handler)(struct qeth_card *card,
735 					struct qeth_ipa_cmd *cmd);
736 };
737 
738 struct qeth_vlan_vid {
739 	struct list_head list;
740 	unsigned short vid;
741 };
742 
743 enum qeth_mac_disposition {
744 	QETH_DISP_MAC_DELETE = 0,
745 	QETH_DISP_MAC_DO_NOTHING = 1,
746 	QETH_DISP_MAC_ADD = 2,
747 };
748 
749 struct qeth_mac {
750 	u8 mac_addr[OSA_ADDR_LEN];
751 	u8 is_uc:1;
752 	u8 disp_flag:2;
753 	struct hlist_node hnode;
754 };
755 
756 struct qeth_rx {
757 	int b_count;
758 	int b_index;
759 	struct qdio_buffer_element *b_element;
760 	int e_offset;
761 	int qdio_err;
762 };
763 
764 struct carrier_info {
765 	__u8  card_type;
766 	__u16 port_mode;
767 	__u32 port_speed;
768 };
769 
770 struct qeth_switch_info {
771 	__u32 capabilities;
772 	__u32 settings;
773 };
774 
775 #define QETH_NAPI_WEIGHT NAPI_POLL_WEIGHT
776 
777 struct qeth_card {
778 	struct list_head list;
779 	enum qeth_card_states state;
780 	int lan_online;
781 	spinlock_t lock;
782 	struct ccwgroup_device *gdev;
783 	struct qeth_channel read;
784 	struct qeth_channel write;
785 	struct qeth_channel data;
786 
787 	struct net_device *dev;
788 	struct net_device_stats stats;
789 
790 	struct qeth_card_info info;
791 	struct qeth_token token;
792 	struct qeth_seqno seqno;
793 	struct qeth_card_options options;
794 
795 	wait_queue_head_t wait_q;
796 	spinlock_t vlanlock;
797 	spinlock_t mclock;
798 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
799 	struct list_head vid_list;
800 	DECLARE_HASHTABLE(mac_htable, 4);
801 	struct work_struct kernel_thread_starter;
802 	spinlock_t thread_mask_lock;
803 	unsigned long thread_start_mask;
804 	unsigned long thread_allowed_mask;
805 	unsigned long thread_running_mask;
806 	struct task_struct *recovery_task;
807 	spinlock_t ip_lock;
808 	struct list_head ip_list;
809 	struct list_head *ip_tbd_list;
810 	struct qeth_ipato ipato;
811 	struct list_head cmd_waiter_list;
812 	/* QDIO buffer handling */
813 	struct qeth_qdio_info qdio;
814 	struct qeth_perf_stats perf_stats;
815 	int read_or_write_problem;
816 	struct qeth_osn_info osn_info;
817 	struct qeth_discipline *discipline;
818 	atomic_t force_alloc_skb;
819 	struct service_level qeth_service_level;
820 	struct qdio_ssqd_desc ssqd;
821 	debug_info_t *debug;
822 	struct mutex conf_mutex;
823 	struct mutex discipline_mutex;
824 	struct napi_struct napi;
825 	struct qeth_rx rx;
826 	struct delayed_work buffer_reclaim_work;
827 	int reclaim_index;
828 	struct work_struct close_dev_work;
829 };
830 
831 struct qeth_card_list_struct {
832 	struct list_head list;
833 	rwlock_t rwlock;
834 };
835 
836 struct qeth_trap_id {
837 	__u16 lparnr;
838 	char vmname[8];
839 	__u8 chpid;
840 	__u8 ssid;
841 	__u16 devno;
842 } __packed;
843 
844 /*some helper functions*/
845 #define QETH_CARD_IFNAME(card) (((card)->dev)? (card)->dev->name : "")
846 
847 static inline int qeth_get_micros(void)
848 {
849 	return (int) (get_tod_clock() >> 12);
850 }
851 
852 static inline int qeth_get_ip_version(struct sk_buff *skb)
853 {
854 	__be16 *p = &((struct ethhdr *)skb->data)->h_proto;
855 
856 	if (*p == ETH_P_8021Q)
857 		p += 2;
858 	switch (*p) {
859 	case ETH_P_IPV6:
860 		return 6;
861 	case ETH_P_IP:
862 		return 4;
863 	default:
864 		return 0;
865 	}
866 }
867 
868 static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
869 		struct qeth_buffer_pool_entry *entry)
870 {
871 	list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
872 }
873 
874 static inline int qeth_is_diagass_supported(struct qeth_card *card,
875 		enum qeth_diags_cmds cmd)
876 {
877 	return card->info.diagass_support & (__u32)cmd;
878 }
879 
880 extern struct qeth_discipline qeth_l2_discipline;
881 extern struct qeth_discipline qeth_l3_discipline;
882 extern const struct attribute_group *qeth_generic_attr_groups[];
883 extern const struct attribute_group *qeth_osn_attr_groups[];
884 extern struct workqueue_struct *qeth_wq;
885 
886 int qeth_card_hw_is_reachable(struct qeth_card *);
887 const char *qeth_get_cardname_short(struct qeth_card *);
888 int qeth_realloc_buffer_pool(struct qeth_card *, int);
889 int qeth_core_load_discipline(struct qeth_card *, enum qeth_discipline_id);
890 void qeth_core_free_discipline(struct qeth_card *);
891 
892 /* exports for qeth discipline device drivers */
893 extern struct qeth_card_list_struct qeth_core_card_list;
894 extern struct kmem_cache *qeth_core_header_cache;
895 extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
896 
897 void qeth_set_recovery_task(struct qeth_card *);
898 void qeth_clear_recovery_task(struct qeth_card *);
899 void qeth_set_allowed_threads(struct qeth_card *, unsigned long , int);
900 int qeth_threads_running(struct qeth_card *, unsigned long);
901 int qeth_wait_for_threads(struct qeth_card *, unsigned long);
902 int qeth_do_run_thread(struct qeth_card *, unsigned long);
903 void qeth_clear_thread_start_bit(struct qeth_card *, unsigned long);
904 void qeth_clear_thread_running_bit(struct qeth_card *, unsigned long);
905 int qeth_core_hardsetup_card(struct qeth_card *);
906 void qeth_print_status_message(struct qeth_card *);
907 int qeth_init_qdio_queues(struct qeth_card *);
908 int qeth_send_startlan(struct qeth_card *);
909 int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
910 		  int (*reply_cb)
911 		  (struct qeth_card *, struct qeth_reply *, unsigned long),
912 		  void *);
913 struct qeth_cmd_buffer *qeth_get_ipacmd_buffer(struct qeth_card *,
914 			enum qeth_ipa_cmds, enum qeth_prot_versions);
915 int qeth_query_setadapterparms(struct qeth_card *);
916 int qeth_check_qdio_errors(struct qeth_card *, struct qdio_buffer *,
917 		unsigned int, const char *);
918 void qeth_queue_input_buffer(struct qeth_card *, int);
919 struct sk_buff *qeth_core_get_next_skb(struct qeth_card *,
920 		struct qeth_qdio_buffer *, struct qdio_buffer_element **, int *,
921 		struct qeth_hdr **);
922 void qeth_schedule_recovery(struct qeth_card *);
923 void qeth_qdio_start_poll(struct ccw_device *, int, unsigned long);
924 void qeth_qdio_input_handler(struct ccw_device *,
925 		unsigned int, unsigned int, int,
926 		int, unsigned long);
927 void qeth_qdio_output_handler(struct ccw_device *, unsigned int,
928 			int, int, int, unsigned long);
929 void qeth_clear_ipacmd_list(struct qeth_card *);
930 int qeth_qdio_clear_card(struct qeth_card *, int);
931 void qeth_clear_working_pool_list(struct qeth_card *);
932 void qeth_clear_cmd_buffers(struct qeth_channel *);
933 void qeth_clear_qdio_buffers(struct qeth_card *);
934 void qeth_setadp_promisc_mode(struct qeth_card *);
935 struct net_device_stats *qeth_get_stats(struct net_device *);
936 int qeth_change_mtu(struct net_device *, int);
937 int qeth_setadpparms_change_macaddr(struct qeth_card *);
938 void qeth_tx_timeout(struct net_device *);
939 void qeth_prepare_control_data(struct qeth_card *, int,
940 				struct qeth_cmd_buffer *);
941 void qeth_release_buffer(struct qeth_channel *, struct qeth_cmd_buffer *);
942 void qeth_prepare_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *, char);
943 struct qeth_cmd_buffer *qeth_wait_for_buffer(struct qeth_channel *);
944 int qeth_mdio_read(struct net_device *, int, int);
945 int qeth_snmp_command(struct qeth_card *, char __user *);
946 int qeth_query_oat_command(struct qeth_card *, char __user *);
947 int qeth_query_switch_attributes(struct qeth_card *card,
948 				  struct qeth_switch_info *sw_info);
949 int qeth_send_control_data(struct qeth_card *, int, struct qeth_cmd_buffer *,
950 	int (*reply_cb)(struct qeth_card *, struct qeth_reply*, unsigned long),
951 	void *reply_param);
952 int qeth_bridgeport_query_ports(struct qeth_card *card,
953 	enum qeth_sbp_roles *role, enum qeth_sbp_states *state);
954 int qeth_bridgeport_setrole(struct qeth_card *card, enum qeth_sbp_roles role);
955 int qeth_bridgeport_an_set(struct qeth_card *card, int enable);
956 int qeth_get_priority_queue(struct qeth_card *, struct sk_buff *, int, int);
957 int qeth_get_elements_no(struct qeth_card *, struct sk_buff *, int);
958 int qeth_get_elements_for_frags(struct sk_buff *);
959 int qeth_do_send_packet_fast(struct qeth_card *, struct qeth_qdio_out_q *,
960 			struct sk_buff *, struct qeth_hdr *, int, int, int);
961 int qeth_do_send_packet(struct qeth_card *, struct qeth_qdio_out_q *,
962 		    struct sk_buff *, struct qeth_hdr *, int);
963 int qeth_core_get_sset_count(struct net_device *, int);
964 void qeth_core_get_ethtool_stats(struct net_device *,
965 				struct ethtool_stats *, u64 *);
966 void qeth_core_get_strings(struct net_device *, u32, u8 *);
967 void qeth_core_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
968 void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
969 int qeth_core_ethtool_get_settings(struct net_device *, struct ethtool_cmd *);
970 int qeth_set_access_ctrl_online(struct qeth_card *card, int fallback);
971 int qeth_hdr_chk_and_bounce(struct sk_buff *, struct qeth_hdr **, int);
972 int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
973 int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
974 int qeth_query_ipassists(struct qeth_card *, enum qeth_prot_versions prot);
975 void qeth_trace_features(struct qeth_card *);
976 void qeth_close_dev(struct qeth_card *);
977 int qeth_send_simple_setassparms(struct qeth_card *, enum qeth_ipa_funcs,
978 				 __u16, long);
979 int qeth_send_setassparms(struct qeth_card *, struct qeth_cmd_buffer *, __u16,
980 			  long,
981 			  int (*reply_cb)(struct qeth_card *,
982 					  struct qeth_reply *, unsigned long),
983 			  void *);
984 int qeth_start_ipa_tx_checksum(struct qeth_card *);
985 int qeth_set_rx_csum(struct qeth_card *, int);
986 
987 /* exports for OSN */
988 int qeth_osn_assist(struct net_device *, void *, int);
989 int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
990 		int (*assist_cb)(struct net_device *, void *),
991 		int (*data_cb)(struct sk_buff *));
992 void qeth_osn_deregister(struct net_device *);
993 
994 #endif /* __QETH_CORE_H__ */
995