xref: /openbmc/linux/drivers/s390/net/qeth_core.h (revision 5b394b2d)
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 	unsigned int buf_elements_sent;
108 
109 	unsigned int skbs_sent_pack;
110 	unsigned int bufs_sent_pack;
111 
112 	unsigned int sc_dp_p;
113 	unsigned int sc_p_dp;
114 	/* qdio_cq_handler: number of times called, time spent in */
115 	__u64 cq_start_time;
116 	unsigned int cq_cnt;
117 	unsigned int cq_time;
118 	/* qdio_input_handler: number of times called, time spent in */
119 	__u64 inbound_start_time;
120 	unsigned int inbound_cnt;
121 	unsigned int inbound_time;
122 	/* qeth_send_packet: number of times called, time spent in */
123 	__u64 outbound_start_time;
124 	unsigned int outbound_cnt;
125 	unsigned int outbound_time;
126 	/* qdio_output_handler: number of times called, time spent in */
127 	__u64 outbound_handler_start_time;
128 	unsigned int outbound_handler_cnt;
129 	unsigned int outbound_handler_time;
130 	/* number of calls to and time spent in do_QDIO for inbound queue */
131 	__u64 inbound_do_qdio_start_time;
132 	unsigned int inbound_do_qdio_cnt;
133 	unsigned int inbound_do_qdio_time;
134 	/* number of calls to and time spent in do_QDIO for outbound queues */
135 	__u64 outbound_do_qdio_start_time;
136 	unsigned int outbound_do_qdio_cnt;
137 	unsigned int outbound_do_qdio_time;
138 	unsigned int large_send_bytes;
139 	unsigned int large_send_cnt;
140 	unsigned int sg_skbs_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 	unsigned int rx_csum;
152 };
153 
154 /* Routing stuff */
155 struct qeth_routing_info {
156 	enum qeth_routing_types type;
157 };
158 
159 /* IPA stuff */
160 struct qeth_ipa_info {
161 	__u32 supported_funcs;
162 	__u32 enabled_funcs;
163 };
164 
165 /* SETBRIDGEPORT stuff */
166 enum qeth_sbp_roles {
167 	QETH_SBP_ROLE_NONE	= 0,
168 	QETH_SBP_ROLE_PRIMARY	= 1,
169 	QETH_SBP_ROLE_SECONDARY	= 2,
170 };
171 
172 enum qeth_sbp_states {
173 	QETH_SBP_STATE_INACTIVE	= 0,
174 	QETH_SBP_STATE_STANDBY	= 1,
175 	QETH_SBP_STATE_ACTIVE	= 2,
176 };
177 
178 #define QETH_SBP_HOST_NOTIFICATION 1
179 
180 struct qeth_sbp_info {
181 	__u32 supported_funcs;
182 	enum qeth_sbp_roles role;
183 	__u32 hostnotification:1;
184 	__u32 reflect_promisc:1;
185 	__u32 reflect_promisc_primary:1;
186 };
187 
188 struct qeth_vnicc_info {
189 	/* supported/currently configured VNICCs; updated in IPA exchanges */
190 	u32 sup_chars;
191 	u32 cur_chars;
192 	/* supported commands: bitmasks which VNICCs support respective cmd */
193 	u32 set_char_sup;
194 	u32 getset_timeout_sup;
195 	/* timeout value for the learning characteristic */
196 	u32 learning_timeout;
197 	/* characteristics wanted/configured by user */
198 	u32 wanted_chars;
199 	/* has user explicitly enabled rx_bcast while online? */
200 	bool rx_bcast_enabled;
201 };
202 
203 static inline int qeth_is_ipa_supported(struct qeth_ipa_info *ipa,
204 		enum qeth_ipa_funcs func)
205 {
206 	return (ipa->supported_funcs & func);
207 }
208 
209 static inline int qeth_is_ipa_enabled(struct qeth_ipa_info *ipa,
210 		enum qeth_ipa_funcs func)
211 {
212 	return (ipa->supported_funcs & ipa->enabled_funcs & func);
213 }
214 
215 #define qeth_adp_supported(c, f) \
216 	qeth_is_ipa_supported(&c->options.adp, f)
217 #define qeth_adp_enabled(c, f) \
218 	qeth_is_ipa_enabled(&c->options.adp, f)
219 #define qeth_is_supported(c, f) \
220 	qeth_is_ipa_supported(&c->options.ipa4, f)
221 #define qeth_is_enabled(c, f) \
222 	qeth_is_ipa_enabled(&c->options.ipa4, f)
223 #define qeth_is_supported6(c, f) \
224 	qeth_is_ipa_supported(&c->options.ipa6, f)
225 #define qeth_is_enabled6(c, f) \
226 	qeth_is_ipa_enabled(&c->options.ipa6, f)
227 #define qeth_is_ipafunc_supported(c, prot, f) \
228 	 ((prot == QETH_PROT_IPV6) ? \
229 		qeth_is_supported6(c, f) : qeth_is_supported(c, f))
230 #define qeth_is_ipafunc_enabled(c, prot, f) \
231 	 ((prot == QETH_PROT_IPV6) ? \
232 		qeth_is_enabled6(c, f) : qeth_is_enabled(c, f))
233 
234 #define QETH_IDX_FUNC_LEVEL_OSD		 0x0101
235 #define QETH_IDX_FUNC_LEVEL_IQD		 0x4108
236 
237 #define QETH_BUFSIZE		4096
238 #define CCW_CMD_WRITE		0x01
239 #define CCW_CMD_READ		0x02
240 
241 /**
242  * some more defs
243  */
244 #define QETH_TX_TIMEOUT		100 * HZ
245 #define QETH_RCD_TIMEOUT	60 * HZ
246 #define QETH_RECLAIM_WORK_TIME	HZ
247 #define QETH_MAX_PORTNO		15
248 
249 /*IPv6 address autoconfiguration stuff*/
250 #define UNIQUE_ID_IF_CREATE_ADDR_FAILED 0xfffe
251 #define UNIQUE_ID_NOT_BY_CARD		0x10000
252 
253 /*****************************************************************************/
254 /* QDIO queue and buffer handling                                            */
255 /*****************************************************************************/
256 #define QETH_MAX_QUEUES 4
257 #define QETH_IN_BUF_SIZE_DEFAULT 65536
258 #define QETH_IN_BUF_COUNT_DEFAULT 64
259 #define QETH_IN_BUF_COUNT_HSDEFAULT 128
260 #define QETH_IN_BUF_COUNT_MIN 8
261 #define QETH_IN_BUF_COUNT_MAX 128
262 #define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
263 #define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
264 		 ((card)->qdio.in_buf_pool.buf_count / 2)
265 
266 /* buffers we have to be behind before we get a PCI */
267 #define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
268 /*enqueued free buffers left before we get a PCI*/
269 #define QETH_PCI_THRESHOLD_B(card) 0
270 /*not used unless the microcode gets patched*/
271 #define QETH_PCI_TIMER_VALUE(card) 3
272 
273 /* priority queing */
274 #define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
275 #define QETH_DEFAULT_QUEUE    2
276 #define QETH_NO_PRIO_QUEUEING 0
277 #define QETH_PRIO_Q_ING_PREC  1
278 #define QETH_PRIO_Q_ING_TOS   2
279 #define QETH_PRIO_Q_ING_SKB   3
280 #define QETH_PRIO_Q_ING_VLAN  4
281 
282 /* Packing */
283 #define QETH_LOW_WATERMARK_PACK  2
284 #define QETH_HIGH_WATERMARK_PACK 5
285 #define QETH_WATERMARK_PACK_FUZZ 1
286 
287 /* large receive scatter gather copy break */
288 #define QETH_RX_SG_CB (PAGE_SIZE >> 1)
289 #define QETH_RX_PULL_LEN 256
290 
291 struct qeth_hdr_layer3 {
292 	__u8  id;
293 	__u8  flags;
294 	__u16 inbound_checksum; /*TSO:__u16 seqno */
295 	__u32 token;		/*TSO: __u32 reserved */
296 	__u16 length;
297 	__u8  vlan_prio;
298 	__u8  ext_flags;
299 	__u16 vlan_id;
300 	__u16 frame_offset;
301 	union {
302 		/* TX: */
303 		u8 ipv6_addr[16];
304 		struct ipv4 {
305 			u8 res[12];
306 			u32 addr;
307 		} ipv4;
308 		/* RX: */
309 		struct rx {
310 			u8 res1[2];
311 			u8 src_mac[6];
312 			u8 res2[4];
313 			u16 vlan_id;
314 			u8 res3[2];
315 		} rx;
316 	} next_hop;
317 };
318 
319 struct qeth_hdr_layer2 {
320 	__u8 id;
321 	__u8 flags[3];
322 	__u8 port_no;
323 	__u8 hdr_length;
324 	__u16 pkt_length;
325 	__u16 seq_no;
326 	__u16 vlan_id;
327 	__u32 reserved;
328 	__u8 reserved2[16];
329 } __attribute__ ((packed));
330 
331 struct qeth_hdr_osn {
332 	__u8 id;
333 	__u8 reserved;
334 	__u16 seq_no;
335 	__u16 reserved2;
336 	__u16 control_flags;
337 	__u16 pdu_length;
338 	__u8 reserved3[18];
339 	__u32 ccid;
340 } __attribute__ ((packed));
341 
342 struct qeth_hdr {
343 	union {
344 		struct qeth_hdr_layer2 l2;
345 		struct qeth_hdr_layer3 l3;
346 		struct qeth_hdr_osn    osn;
347 	} hdr;
348 } __attribute__ ((packed));
349 
350 /*TCP Segmentation Offload header*/
351 struct qeth_hdr_ext_tso {
352 	__u16 hdr_tot_len;
353 	__u8  imb_hdr_no;
354 	__u8  reserved;
355 	__u8  hdr_type;
356 	__u8  hdr_version;
357 	__u16 hdr_len;
358 	__u32 payload_len;
359 	__u16 mss;
360 	__u16 dg_hdr_len;
361 	__u8  padding[16];
362 } __attribute__ ((packed));
363 
364 struct qeth_hdr_tso {
365 	struct qeth_hdr hdr;	/*hdr->hdr.l3.xxx*/
366 	struct qeth_hdr_ext_tso ext;
367 } __attribute__ ((packed));
368 
369 
370 /* flags for qeth_hdr.flags */
371 #define QETH_HDR_PASSTHRU 0x10
372 #define QETH_HDR_IPV6     0x80
373 #define QETH_HDR_CAST_MASK 0x07
374 enum qeth_cast_flags {
375 	QETH_CAST_UNICAST   = 0x06,
376 	QETH_CAST_MULTICAST = 0x04,
377 	QETH_CAST_BROADCAST = 0x05,
378 	QETH_CAST_ANYCAST   = 0x07,
379 	QETH_CAST_NOCAST    = 0x00,
380 };
381 
382 enum qeth_layer2_frame_flags {
383 	QETH_LAYER2_FLAG_MULTICAST = 0x01,
384 	QETH_LAYER2_FLAG_BROADCAST = 0x02,
385 	QETH_LAYER2_FLAG_UNICAST   = 0x04,
386 	QETH_LAYER2_FLAG_VLAN      = 0x10,
387 };
388 
389 enum qeth_header_ids {
390 	QETH_HEADER_TYPE_LAYER3 = 0x01,
391 	QETH_HEADER_TYPE_LAYER2 = 0x02,
392 	QETH_HEADER_TYPE_TSO	= 0x03,
393 	QETH_HEADER_TYPE_OSN    = 0x04,
394 };
395 /* flags for qeth_hdr.ext_flags */
396 #define QETH_HDR_EXT_VLAN_FRAME       0x01
397 #define QETH_HDR_EXT_TOKEN_ID         0x02
398 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
399 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
400 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
401 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
402 #define QETH_HDR_EXT_UDP	      0x40 /*bit off for TCP*/
403 
404 enum qeth_qdio_buffer_states {
405 	/*
406 	 * inbound: read out by driver; owned by hardware in order to be filled
407 	 * outbound: owned by driver in order to be filled
408 	 */
409 	QETH_QDIO_BUF_EMPTY,
410 	/*
411 	 * inbound: filled by hardware; owned by driver in order to be read out
412 	 * outbound: filled by driver; owned by hardware in order to be sent
413 	 */
414 	QETH_QDIO_BUF_PRIMED,
415 	/*
416 	 * inbound: not applicable
417 	 * outbound: identified to be pending in TPQ
418 	 */
419 	QETH_QDIO_BUF_PENDING,
420 	/*
421 	 * inbound: not applicable
422 	 * outbound: found in completion queue
423 	 */
424 	QETH_QDIO_BUF_IN_CQ,
425 	/*
426 	 * inbound: not applicable
427 	 * outbound: handled via transfer pending / completion queue
428 	 */
429 	QETH_QDIO_BUF_HANDLED_DELAYED,
430 };
431 
432 enum qeth_qdio_info_states {
433 	QETH_QDIO_UNINITIALIZED,
434 	QETH_QDIO_ALLOCATED,
435 	QETH_QDIO_ESTABLISHED,
436 	QETH_QDIO_CLEANING
437 };
438 
439 struct qeth_buffer_pool_entry {
440 	struct list_head list;
441 	struct list_head init_list;
442 	void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
443 };
444 
445 struct qeth_qdio_buffer_pool {
446 	struct list_head entry_list;
447 	int buf_count;
448 };
449 
450 struct qeth_qdio_buffer {
451 	struct qdio_buffer *buffer;
452 	/* the buffer pool entry currently associated to this buffer */
453 	struct qeth_buffer_pool_entry *pool_entry;
454 	struct sk_buff *rx_skb;
455 };
456 
457 struct qeth_qdio_q {
458 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
459 	struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
460 	int next_buf_to_init;
461 };
462 
463 struct qeth_qdio_out_buffer {
464 	struct qdio_buffer *buffer;
465 	atomic_t state;
466 	int next_element_to_fill;
467 	struct sk_buff_head skb_list;
468 	int is_header[QDIO_MAX_ELEMENTS_PER_BUFFER];
469 
470 	struct qeth_qdio_out_q *q;
471 	struct qeth_qdio_out_buffer *next_pending;
472 };
473 
474 struct qeth_card;
475 
476 enum qeth_out_q_states {
477        QETH_OUT_Q_UNLOCKED,
478        QETH_OUT_Q_LOCKED,
479        QETH_OUT_Q_LOCKED_FLUSH,
480 };
481 
482 struct qeth_qdio_out_q {
483 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
484 	struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
485 	struct qdio_outbuf_state *bufstates; /* convenience pointer */
486 	int queue_no;
487 	struct qeth_card *card;
488 	atomic_t state;
489 	int do_pack;
490 	/*
491 	 * index of buffer to be filled by driver; state EMPTY or PACKING
492 	 */
493 	int next_buf_to_fill;
494 	/*
495 	 * number of buffers that are currently filled (PRIMED)
496 	 * -> these buffers are hardware-owned
497 	 */
498 	atomic_t used_buffers;
499 	/* indicates whether PCI flag must be set (or if one is outstanding) */
500 	atomic_t set_pci_flags_count;
501 };
502 
503 struct qeth_qdio_info {
504 	atomic_t state;
505 	/* input */
506 	int no_in_queues;
507 	struct qeth_qdio_q *in_q;
508 	struct qeth_qdio_q *c_q;
509 	struct qeth_qdio_buffer_pool in_buf_pool;
510 	struct qeth_qdio_buffer_pool init_pool;
511 	int in_buf_size;
512 
513 	/* output */
514 	int no_out_queues;
515 	struct qeth_qdio_out_q **out_qs;
516 	struct qdio_outbuf_state *out_bufstates;
517 
518 	/* priority queueing */
519 	int do_prio_queueing;
520 	int default_out_queue;
521 };
522 
523 /**
524  * buffer stuff for read channel
525  */
526 #define QETH_CMD_BUFFER_NO	8
527 
528 /**
529  *  channel state machine
530  */
531 enum qeth_channel_states {
532 	CH_STATE_UP,
533 	CH_STATE_DOWN,
534 	CH_STATE_ACTIVATING,
535 	CH_STATE_HALTED,
536 	CH_STATE_STOPPED,
537 	CH_STATE_RCD,
538 	CH_STATE_RCD_DONE,
539 };
540 /**
541  * card state machine
542  */
543 enum qeth_card_states {
544 	CARD_STATE_DOWN,
545 	CARD_STATE_HARDSETUP,
546 	CARD_STATE_SOFTSETUP,
547 	CARD_STATE_UP,
548 	CARD_STATE_RECOVER,
549 };
550 
551 /**
552  * Protocol versions
553  */
554 enum qeth_prot_versions {
555 	QETH_PROT_IPV4 = 0x0004,
556 	QETH_PROT_IPV6 = 0x0006,
557 };
558 
559 enum qeth_cmd_buffer_state {
560 	BUF_STATE_FREE,
561 	BUF_STATE_LOCKED,
562 };
563 
564 enum qeth_cq {
565 	QETH_CQ_DISABLED = 0,
566 	QETH_CQ_ENABLED = 1,
567 	QETH_CQ_NOTAVAILABLE = 2,
568 };
569 
570 struct qeth_ipato {
571 	bool enabled;
572 	bool invert4;
573 	bool invert6;
574 	struct list_head entries;
575 };
576 
577 struct qeth_channel;
578 
579 struct qeth_cmd_buffer {
580 	enum qeth_cmd_buffer_state state;
581 	struct qeth_channel *channel;
582 	unsigned char *data;
583 	int rc;
584 	void (*callback) (struct qeth_channel *, struct qeth_cmd_buffer *);
585 };
586 
587 static inline struct qeth_ipa_cmd *__ipa_cmd(struct qeth_cmd_buffer *iob)
588 {
589 	return (struct qeth_ipa_cmd *)(iob->data + IPA_PDU_HEADER_SIZE);
590 }
591 
592 /**
593  * definition of a qeth channel, used for read and write
594  */
595 struct qeth_channel {
596 	enum qeth_channel_states state;
597 	struct ccw1 *ccw;
598 	spinlock_t iob_lock;
599 	wait_queue_head_t wait_q;
600 	struct ccw_device *ccwdev;
601 /*command buffer for control data*/
602 	struct qeth_cmd_buffer iob[QETH_CMD_BUFFER_NO];
603 	atomic_t irq_pending;
604 	int io_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 	enum qeth_card_types type;
664 	enum qeth_link_types link_type;
665 	int broadcast_capable;
666 	int unique_id;
667 	bool layer_enforced;
668 	struct qeth_card_blkt blkt;
669 	enum qeth_ipa_promisc_modes promisc_mode;
670 	__u32 diagass_support;
671 	__u32 hwtrap;
672 };
673 
674 struct qeth_card_options {
675 	struct qeth_routing_info route4;
676 	struct qeth_ipa_info ipa4;
677 	struct qeth_ipa_info adp; /*Adapter parameters*/
678 	struct qeth_routing_info route6;
679 	struct qeth_ipa_info ipa6;
680 	struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
681 	struct qeth_vnicc_info vnicc; /* VNICC options */
682 	int fake_broadcast;
683 	int layer2;
684 	int performance_stats;
685 	int rx_sg_cb;
686 	enum qeth_ipa_isolation_modes isolation;
687 	enum qeth_ipa_isolation_modes prev_isolation;
688 	int sniffer;
689 	enum qeth_cq cq;
690 	char hsuid[9];
691 };
692 
693 /*
694  * thread bits for qeth_card thread masks
695  */
696 enum qeth_threads {
697 	QETH_RECOVER_THREAD = 1,
698 };
699 
700 struct qeth_osn_info {
701 	int (*assist_cb)(struct net_device *dev, void *data);
702 	int (*data_cb)(struct sk_buff *skb);
703 };
704 
705 enum qeth_discipline_id {
706 	QETH_DISCIPLINE_UNDETERMINED = -1,
707 	QETH_DISCIPLINE_LAYER3 = 0,
708 	QETH_DISCIPLINE_LAYER2 = 1,
709 };
710 
711 struct qeth_discipline {
712 	const struct device_type *devtype;
713 	int (*process_rx_buffer)(struct qeth_card *card, int budget, int *done);
714 	int (*recover)(void *ptr);
715 	int (*setup) (struct ccwgroup_device *);
716 	void (*remove) (struct ccwgroup_device *);
717 	int (*set_online) (struct ccwgroup_device *);
718 	int (*set_offline) (struct ccwgroup_device *);
719 	int (*freeze)(struct ccwgroup_device *);
720 	int (*thaw) (struct ccwgroup_device *);
721 	int (*restore)(struct ccwgroup_device *);
722 	int (*do_ioctl)(struct net_device *dev, struct ifreq *rq, int cmd);
723 	int (*control_event_handler)(struct qeth_card *card,
724 					struct qeth_ipa_cmd *cmd);
725 };
726 
727 struct qeth_vlan_vid {
728 	struct list_head list;
729 	unsigned short vid;
730 };
731 
732 enum qeth_addr_disposition {
733 	QETH_DISP_ADDR_DELETE = 0,
734 	QETH_DISP_ADDR_DO_NOTHING = 1,
735 	QETH_DISP_ADDR_ADD = 2,
736 };
737 
738 struct qeth_rx {
739 	int b_count;
740 	int b_index;
741 	struct qdio_buffer_element *b_element;
742 	int e_offset;
743 	int qdio_err;
744 };
745 
746 struct carrier_info {
747 	__u8  card_type;
748 	__u16 port_mode;
749 	__u32 port_speed;
750 };
751 
752 struct qeth_switch_info {
753 	__u32 capabilities;
754 	__u32 settings;
755 };
756 
757 #define QETH_NAPI_WEIGHT NAPI_POLL_WEIGHT
758 
759 struct qeth_card {
760 	struct list_head list;
761 	enum qeth_card_states state;
762 	int lan_online;
763 	spinlock_t lock;
764 	struct ccwgroup_device *gdev;
765 	struct qeth_channel read;
766 	struct qeth_channel write;
767 	struct qeth_channel data;
768 
769 	struct net_device *dev;
770 	struct net_device_stats stats;
771 
772 	struct qeth_card_info info;
773 	struct qeth_token token;
774 	struct qeth_seqno seqno;
775 	struct qeth_card_options options;
776 
777 	wait_queue_head_t wait_q;
778 	spinlock_t mclock;
779 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
780 	struct mutex vid_list_mutex;		/* vid_list */
781 	struct list_head vid_list;
782 	DECLARE_HASHTABLE(mac_htable, 4);
783 	DECLARE_HASHTABLE(ip_htable, 4);
784 	DECLARE_HASHTABLE(ip_mc_htable, 4);
785 	struct work_struct kernel_thread_starter;
786 	spinlock_t thread_mask_lock;
787 	unsigned long thread_start_mask;
788 	unsigned long thread_allowed_mask;
789 	unsigned long thread_running_mask;
790 	struct task_struct *recovery_task;
791 	spinlock_t ip_lock;
792 	struct qeth_ipato ipato;
793 	struct list_head cmd_waiter_list;
794 	/* QDIO buffer handling */
795 	struct qeth_qdio_info qdio;
796 	struct qeth_perf_stats perf_stats;
797 	int read_or_write_problem;
798 	struct qeth_osn_info osn_info;
799 	struct qeth_discipline *discipline;
800 	atomic_t force_alloc_skb;
801 	struct service_level qeth_service_level;
802 	struct qdio_ssqd_desc ssqd;
803 	debug_info_t *debug;
804 	struct mutex conf_mutex;
805 	struct mutex discipline_mutex;
806 	struct napi_struct napi;
807 	struct qeth_rx rx;
808 	struct delayed_work buffer_reclaim_work;
809 	int reclaim_index;
810 	struct work_struct close_dev_work;
811 };
812 
813 struct qeth_card_list_struct {
814 	struct list_head list;
815 	rwlock_t rwlock;
816 };
817 
818 struct qeth_trap_id {
819 	__u16 lparnr;
820 	char vmname[8];
821 	__u8 chpid;
822 	__u8 ssid;
823 	__u16 devno;
824 } __packed;
825 
826 /*some helper functions*/
827 #define QETH_CARD_IFNAME(card) (((card)->dev)? (card)->dev->name : "")
828 
829 static inline void qeth_scrub_qdio_buffer(struct qdio_buffer *buf,
830 					  unsigned int elements)
831 {
832 	unsigned int i;
833 
834 	for (i = 0; i < elements; i++)
835 		memset(&buf->element[i], 0, sizeof(struct qdio_buffer_element));
836 	buf->element[14].sflags = 0;
837 	buf->element[15].sflags = 0;
838 }
839 
840 /**
841  * qeth_get_elements_for_range() -	find number of SBALEs to cover range.
842  * @start:				Start of the address range.
843  * @end:				Address after the end of the range.
844  *
845  * Returns the number of pages, and thus QDIO buffer elements, needed to cover
846  * the specified address range.
847  */
848 static inline int qeth_get_elements_for_range(addr_t start, addr_t end)
849 {
850 	return PFN_UP(end) - PFN_DOWN(start);
851 }
852 
853 static inline int qeth_get_micros(void)
854 {
855 	return (int) (get_tod_clock() >> 12);
856 }
857 
858 static inline int qeth_get_ip_version(struct sk_buff *skb)
859 {
860 	struct vlan_ethhdr *veth = vlan_eth_hdr(skb);
861 	__be16 prot = veth->h_vlan_proto;
862 
863 	if (prot == htons(ETH_P_8021Q))
864 		prot = veth->h_vlan_encapsulated_proto;
865 
866 	switch (prot) {
867 	case htons(ETH_P_IPV6):
868 		return 6;
869 	case htons(ETH_P_IP):
870 		return 4;
871 	default:
872 		return 0;
873 	}
874 }
875 
876 static inline void qeth_rx_csum(struct qeth_card *card, struct sk_buff *skb,
877 				u8 flags)
878 {
879 	if ((card->dev->features & NETIF_F_RXCSUM) &&
880 	    (flags & QETH_HDR_EXT_CSUM_TRANSP_REQ)) {
881 		skb->ip_summed = CHECKSUM_UNNECESSARY;
882 		if (card->options.performance_stats)
883 			card->perf_stats.rx_csum++;
884 	} else {
885 		skb->ip_summed = CHECKSUM_NONE;
886 	}
887 }
888 
889 static inline void qeth_tx_csum(struct sk_buff *skb, u8 *flags, int ipv)
890 {
891 	*flags |= QETH_HDR_EXT_CSUM_TRANSP_REQ;
892 	if ((ipv == 4 && ip_hdr(skb)->protocol == IPPROTO_UDP) ||
893 	    (ipv == 6 && ipv6_hdr(skb)->nexthdr == IPPROTO_UDP))
894 		*flags |= QETH_HDR_EXT_UDP;
895 	if (ipv == 4) {
896 		/* some HW requires combined L3+L4 csum offload: */
897 		*flags |= QETH_HDR_EXT_CSUM_HDR_REQ;
898 		ip_hdr(skb)->check = 0;
899 	}
900 }
901 
902 static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
903 		struct qeth_buffer_pool_entry *entry)
904 {
905 	list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
906 }
907 
908 static inline int qeth_is_diagass_supported(struct qeth_card *card,
909 		enum qeth_diags_cmds cmd)
910 {
911 	return card->info.diagass_support & (__u32)cmd;
912 }
913 
914 int qeth_send_simple_setassparms_prot(struct qeth_card *card,
915 				      enum qeth_ipa_funcs ipa_func,
916 				      u16 cmd_code, long data,
917 				      enum qeth_prot_versions prot);
918 /* IPv4 variant */
919 static inline int qeth_send_simple_setassparms(struct qeth_card *card,
920 					       enum qeth_ipa_funcs ipa_func,
921 					       u16 cmd_code, long data)
922 {
923 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
924 						 data, QETH_PROT_IPV4);
925 }
926 
927 static inline int qeth_send_simple_setassparms_v6(struct qeth_card *card,
928 						  enum qeth_ipa_funcs ipa_func,
929 						  u16 cmd_code, long data)
930 {
931 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
932 						 data, QETH_PROT_IPV6);
933 }
934 
935 int qeth_get_priority_queue(struct qeth_card *card, struct sk_buff *skb,
936 			    int ipv);
937 static inline struct qeth_qdio_out_q *qeth_get_tx_queue(struct qeth_card *card,
938 							struct sk_buff *skb,
939 							int ipv, int cast_type)
940 {
941 	if (IS_IQD(card) && cast_type != RTN_UNICAST)
942 		return card->qdio.out_qs[card->qdio.no_out_queues - 1];
943 	if (!card->qdio.do_prio_queueing)
944 		return card->qdio.out_qs[card->qdio.default_out_queue];
945 	return card->qdio.out_qs[qeth_get_priority_queue(card, skb, ipv)];
946 }
947 
948 extern struct qeth_discipline qeth_l2_discipline;
949 extern struct qeth_discipline qeth_l3_discipline;
950 extern const struct attribute_group *qeth_generic_attr_groups[];
951 extern const struct attribute_group *qeth_osn_attr_groups[];
952 extern const struct attribute_group qeth_device_attr_group;
953 extern const struct attribute_group qeth_device_blkt_group;
954 extern const struct device_type qeth_generic_devtype;
955 extern struct workqueue_struct *qeth_wq;
956 
957 int qeth_card_hw_is_reachable(struct qeth_card *);
958 const char *qeth_get_cardname_short(struct qeth_card *);
959 int qeth_realloc_buffer_pool(struct qeth_card *, int);
960 int qeth_core_load_discipline(struct qeth_card *, enum qeth_discipline_id);
961 void qeth_core_free_discipline(struct qeth_card *);
962 
963 /* exports for qeth discipline device drivers */
964 extern struct qeth_card_list_struct qeth_core_card_list;
965 extern struct kmem_cache *qeth_core_header_cache;
966 extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
967 
968 struct net_device *qeth_clone_netdev(struct net_device *orig);
969 void qeth_set_recovery_task(struct qeth_card *);
970 void qeth_clear_recovery_task(struct qeth_card *);
971 void qeth_set_allowed_threads(struct qeth_card *, unsigned long , int);
972 int qeth_threads_running(struct qeth_card *, unsigned long);
973 int qeth_wait_for_threads(struct qeth_card *, unsigned long);
974 int qeth_do_run_thread(struct qeth_card *, unsigned long);
975 void qeth_clear_thread_start_bit(struct qeth_card *, unsigned long);
976 void qeth_clear_thread_running_bit(struct qeth_card *, unsigned long);
977 int qeth_core_hardsetup_card(struct qeth_card *);
978 void qeth_print_status_message(struct qeth_card *);
979 int qeth_init_qdio_queues(struct qeth_card *);
980 int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
981 		  int (*reply_cb)
982 		  (struct qeth_card *, struct qeth_reply *, unsigned long),
983 		  void *);
984 struct qeth_cmd_buffer *qeth_get_ipacmd_buffer(struct qeth_card *,
985 			enum qeth_ipa_cmds, enum qeth_prot_versions);
986 struct sk_buff *qeth_core_get_next_skb(struct qeth_card *,
987 		struct qeth_qdio_buffer *, struct qdio_buffer_element **, int *,
988 		struct qeth_hdr **);
989 void qeth_schedule_recovery(struct qeth_card *);
990 int qeth_poll(struct napi_struct *napi, int budget);
991 void qeth_clear_ipacmd_list(struct qeth_card *);
992 int qeth_qdio_clear_card(struct qeth_card *, int);
993 void qeth_clear_working_pool_list(struct qeth_card *);
994 void qeth_clear_cmd_buffers(struct qeth_channel *);
995 void qeth_clear_qdio_buffers(struct qeth_card *);
996 void qeth_setadp_promisc_mode(struct qeth_card *);
997 struct net_device_stats *qeth_get_stats(struct net_device *);
998 int qeth_setadpparms_change_macaddr(struct qeth_card *);
999 void qeth_tx_timeout(struct net_device *);
1000 void qeth_prepare_control_data(struct qeth_card *, int,
1001 				struct qeth_cmd_buffer *);
1002 void qeth_release_buffer(struct qeth_channel *, struct qeth_cmd_buffer *);
1003 void qeth_prepare_ipa_cmd(struct qeth_card *card, struct qeth_cmd_buffer *iob);
1004 struct qeth_cmd_buffer *qeth_wait_for_buffer(struct qeth_channel *);
1005 int qeth_query_switch_attributes(struct qeth_card *card,
1006 				  struct qeth_switch_info *sw_info);
1007 int qeth_send_control_data(struct qeth_card *, int, struct qeth_cmd_buffer *,
1008 	int (*reply_cb)(struct qeth_card *, struct qeth_reply*, unsigned long),
1009 	void *reply_param);
1010 int qeth_get_elements_no(struct qeth_card *card, struct sk_buff *skb,
1011 			 int extra_elems, int data_offset);
1012 int qeth_get_elements_for_frags(struct sk_buff *);
1013 int qeth_do_send_packet_fast(struct qeth_qdio_out_q *queue, struct sk_buff *skb,
1014 			     struct qeth_hdr *hdr, unsigned int offset,
1015 			     unsigned int hd_len);
1016 int qeth_do_send_packet(struct qeth_card *card, struct qeth_qdio_out_q *queue,
1017 			struct sk_buff *skb, struct qeth_hdr *hdr,
1018 			unsigned int offset, unsigned int hd_len,
1019 			int elements_needed);
1020 int qeth_do_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1021 int qeth_core_get_sset_count(struct net_device *, int);
1022 void qeth_core_get_ethtool_stats(struct net_device *,
1023 				struct ethtool_stats *, u64 *);
1024 void qeth_core_get_strings(struct net_device *, u32, u8 *);
1025 void qeth_core_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
1026 void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
1027 int qeth_core_ethtool_get_link_ksettings(struct net_device *netdev,
1028 					 struct ethtool_link_ksettings *cmd);
1029 int qeth_set_access_ctrl_online(struct qeth_card *card, int fallback);
1030 int qeth_hdr_chk_and_bounce(struct sk_buff *, struct qeth_hdr **, int);
1031 int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
1032 int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
1033 void qeth_trace_features(struct qeth_card *);
1034 void qeth_close_dev(struct qeth_card *);
1035 int qeth_send_setassparms(struct qeth_card *, struct qeth_cmd_buffer *, __u16,
1036 			  long,
1037 			  int (*reply_cb)(struct qeth_card *,
1038 					  struct qeth_reply *, unsigned long),
1039 			  void *);
1040 int qeth_setassparms_cb(struct qeth_card *, struct qeth_reply *, unsigned long);
1041 struct qeth_cmd_buffer *qeth_get_setassparms_cmd(struct qeth_card *,
1042 						 enum qeth_ipa_funcs,
1043 						 __u16, __u16,
1044 						 enum qeth_prot_versions);
1045 int qeth_set_features(struct net_device *, netdev_features_t);
1046 void qeth_enable_hw_features(struct net_device *dev);
1047 netdev_features_t qeth_fix_features(struct net_device *, netdev_features_t);
1048 netdev_features_t qeth_features_check(struct sk_buff *skb,
1049 				      struct net_device *dev,
1050 				      netdev_features_t features);
1051 int qeth_vm_request_mac(struct qeth_card *card);
1052 int qeth_add_hw_header(struct qeth_card *card, struct sk_buff *skb,
1053 		       struct qeth_hdr **hdr, unsigned int hdr_len,
1054 		       unsigned int proto_len, unsigned int *elements);
1055 
1056 /* exports for OSN */
1057 int qeth_osn_assist(struct net_device *, void *, int);
1058 int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
1059 		int (*assist_cb)(struct net_device *, void *),
1060 		int (*data_cb)(struct sk_buff *));
1061 void qeth_osn_deregister(struct net_device *);
1062 
1063 #endif /* __QETH_CORE_H__ */
1064