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