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