xref: /openbmc/linux/drivers/s390/net/qeth_core.h (revision a0ae2562c6c4b2721d9fddba63b7286c13517d9f)
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 	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 
239 /**
240  * some more defs
241  */
242 #define QETH_TX_TIMEOUT		100 * HZ
243 #define QETH_RCD_TIMEOUT	60 * HZ
244 #define QETH_RECLAIM_WORK_TIME	HZ
245 #define QETH_MAX_PORTNO		15
246 
247 /*IPv6 address autoconfiguration stuff*/
248 #define UNIQUE_ID_IF_CREATE_ADDR_FAILED 0xfffe
249 #define UNIQUE_ID_NOT_BY_CARD		0x10000
250 
251 /*****************************************************************************/
252 /* QDIO queue and buffer handling                                            */
253 /*****************************************************************************/
254 #define QETH_MAX_QUEUES 4
255 #define QETH_IN_BUF_SIZE_DEFAULT 65536
256 #define QETH_IN_BUF_COUNT_DEFAULT 64
257 #define QETH_IN_BUF_COUNT_HSDEFAULT 128
258 #define QETH_IN_BUF_COUNT_MIN 8
259 #define QETH_IN_BUF_COUNT_MAX 128
260 #define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
261 #define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
262 		 ((card)->qdio.in_buf_pool.buf_count / 2)
263 
264 /* buffers we have to be behind before we get a PCI */
265 #define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
266 /*enqueued free buffers left before we get a PCI*/
267 #define QETH_PCI_THRESHOLD_B(card) 0
268 /*not used unless the microcode gets patched*/
269 #define QETH_PCI_TIMER_VALUE(card) 3
270 
271 /* priority queing */
272 #define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
273 #define QETH_DEFAULT_QUEUE    2
274 #define QETH_NO_PRIO_QUEUEING 0
275 #define QETH_PRIO_Q_ING_PREC  1
276 #define QETH_PRIO_Q_ING_TOS   2
277 #define QETH_PRIO_Q_ING_SKB   3
278 #define QETH_PRIO_Q_ING_VLAN  4
279 
280 /* Packing */
281 #define QETH_LOW_WATERMARK_PACK  2
282 #define QETH_HIGH_WATERMARK_PACK 5
283 #define QETH_WATERMARK_PACK_FUZZ 1
284 
285 /* large receive scatter gather copy break */
286 #define QETH_RX_SG_CB (PAGE_SIZE >> 1)
287 #define QETH_RX_PULL_LEN 256
288 
289 struct qeth_hdr_layer3 {
290 	__u8  id;
291 	__u8  flags;
292 	__u16 inbound_checksum; /*TSO:__u16 seqno */
293 	__u32 token;		/*TSO: __u32 reserved */
294 	__u16 length;
295 	__u8  vlan_prio;
296 	__u8  ext_flags;
297 	__u16 vlan_id;
298 	__u16 frame_offset;
299 	union {
300 		/* TX: */
301 		u8 ipv6_addr[16];
302 		struct ipv4 {
303 			u8 res[12];
304 			u32 addr;
305 		} ipv4;
306 		/* RX: */
307 		struct rx {
308 			u8 res1[2];
309 			u8 src_mac[6];
310 			u8 res2[4];
311 			u16 vlan_id;
312 			u8 res3[2];
313 		} rx;
314 	} next_hop;
315 };
316 
317 struct qeth_hdr_layer2 {
318 	__u8 id;
319 	__u8 flags[3];
320 	__u8 port_no;
321 	__u8 hdr_length;
322 	__u16 pkt_length;
323 	__u16 seq_no;
324 	__u16 vlan_id;
325 	__u32 reserved;
326 	__u8 reserved2[16];
327 } __attribute__ ((packed));
328 
329 struct qeth_hdr_osn {
330 	__u8 id;
331 	__u8 reserved;
332 	__u16 seq_no;
333 	__u16 reserved2;
334 	__u16 control_flags;
335 	__u16 pdu_length;
336 	__u8 reserved3[18];
337 	__u32 ccid;
338 } __attribute__ ((packed));
339 
340 struct qeth_hdr {
341 	union {
342 		struct qeth_hdr_layer2 l2;
343 		struct qeth_hdr_layer3 l3;
344 		struct qeth_hdr_osn    osn;
345 	} hdr;
346 } __attribute__ ((packed));
347 
348 /*TCP Segmentation Offload header*/
349 struct qeth_hdr_ext_tso {
350 	__u16 hdr_tot_len;
351 	__u8  imb_hdr_no;
352 	__u8  reserved;
353 	__u8  hdr_type;
354 	__u8  hdr_version;
355 	__u16 hdr_len;
356 	__u32 payload_len;
357 	__u16 mss;
358 	__u16 dg_hdr_len;
359 	__u8  padding[16];
360 } __attribute__ ((packed));
361 
362 struct qeth_hdr_tso {
363 	struct qeth_hdr hdr;	/*hdr->hdr.l3.xxx*/
364 	struct qeth_hdr_ext_tso ext;
365 } __attribute__ ((packed));
366 
367 
368 /* flags for qeth_hdr.flags */
369 #define QETH_HDR_PASSTHRU 0x10
370 #define QETH_HDR_IPV6     0x80
371 #define QETH_HDR_CAST_MASK 0x07
372 enum qeth_cast_flags {
373 	QETH_CAST_UNICAST   = 0x06,
374 	QETH_CAST_MULTICAST = 0x04,
375 	QETH_CAST_BROADCAST = 0x05,
376 	QETH_CAST_ANYCAST   = 0x07,
377 	QETH_CAST_NOCAST    = 0x00,
378 };
379 
380 enum qeth_layer2_frame_flags {
381 	QETH_LAYER2_FLAG_MULTICAST = 0x01,
382 	QETH_LAYER2_FLAG_BROADCAST = 0x02,
383 	QETH_LAYER2_FLAG_UNICAST   = 0x04,
384 	QETH_LAYER2_FLAG_VLAN      = 0x10,
385 };
386 
387 enum qeth_header_ids {
388 	QETH_HEADER_TYPE_LAYER3 = 0x01,
389 	QETH_HEADER_TYPE_LAYER2 = 0x02,
390 	QETH_HEADER_TYPE_TSO	= 0x03,
391 	QETH_HEADER_TYPE_OSN    = 0x04,
392 };
393 /* flags for qeth_hdr.ext_flags */
394 #define QETH_HDR_EXT_VLAN_FRAME       0x01
395 #define QETH_HDR_EXT_TOKEN_ID         0x02
396 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
397 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
398 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
399 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
400 #define QETH_HDR_EXT_UDP	      0x40 /*bit off for TCP*/
401 
402 enum qeth_qdio_buffer_states {
403 	/*
404 	 * inbound: read out by driver; owned by hardware in order to be filled
405 	 * outbound: owned by driver in order to be filled
406 	 */
407 	QETH_QDIO_BUF_EMPTY,
408 	/*
409 	 * inbound: filled by hardware; owned by driver in order to be read out
410 	 * outbound: filled by driver; owned by hardware in order to be sent
411 	 */
412 	QETH_QDIO_BUF_PRIMED,
413 	/*
414 	 * inbound: not applicable
415 	 * outbound: identified to be pending in TPQ
416 	 */
417 	QETH_QDIO_BUF_PENDING,
418 	/*
419 	 * inbound: not applicable
420 	 * outbound: found in completion queue
421 	 */
422 	QETH_QDIO_BUF_IN_CQ,
423 	/*
424 	 * inbound: not applicable
425 	 * outbound: handled via transfer pending / completion queue
426 	 */
427 	QETH_QDIO_BUF_HANDLED_DELAYED,
428 };
429 
430 enum qeth_qdio_info_states {
431 	QETH_QDIO_UNINITIALIZED,
432 	QETH_QDIO_ALLOCATED,
433 	QETH_QDIO_ESTABLISHED,
434 	QETH_QDIO_CLEANING
435 };
436 
437 struct qeth_buffer_pool_entry {
438 	struct list_head list;
439 	struct list_head init_list;
440 	void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
441 };
442 
443 struct qeth_qdio_buffer_pool {
444 	struct list_head entry_list;
445 	int buf_count;
446 };
447 
448 struct qeth_qdio_buffer {
449 	struct qdio_buffer *buffer;
450 	/* the buffer pool entry currently associated to this buffer */
451 	struct qeth_buffer_pool_entry *pool_entry;
452 	struct sk_buff *rx_skb;
453 };
454 
455 struct qeth_qdio_q {
456 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
457 	struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
458 	int next_buf_to_init;
459 };
460 
461 struct qeth_qdio_out_buffer {
462 	struct qdio_buffer *buffer;
463 	atomic_t state;
464 	int next_element_to_fill;
465 	struct sk_buff_head skb_list;
466 	int is_header[QDIO_MAX_ELEMENTS_PER_BUFFER];
467 
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 };
561 
562 enum qeth_cq {
563 	QETH_CQ_DISABLED = 0,
564 	QETH_CQ_ENABLED = 1,
565 	QETH_CQ_NOTAVAILABLE = 2,
566 };
567 
568 struct qeth_ipato {
569 	bool enabled;
570 	bool invert4;
571 	bool invert6;
572 	struct list_head entries;
573 };
574 
575 struct qeth_channel;
576 
577 struct qeth_cmd_buffer {
578 	enum qeth_cmd_buffer_state state;
579 	struct qeth_channel *channel;
580 	unsigned char *data;
581 	int rc;
582 	void (*callback) (struct qeth_channel *, struct qeth_cmd_buffer *);
583 };
584 
585 static inline struct qeth_ipa_cmd *__ipa_cmd(struct qeth_cmd_buffer *iob)
586 {
587 	return (struct qeth_ipa_cmd *)(iob->data + IPA_PDU_HEADER_SIZE);
588 }
589 
590 /**
591  * definition of a qeth channel, used for read and write
592  */
593 struct qeth_channel {
594 	enum qeth_channel_states state;
595 	struct ccw1 ccw;
596 	spinlock_t iob_lock;
597 	wait_queue_head_t wait_q;
598 	struct ccw_device *ccwdev;
599 /*command buffer for control data*/
600 	struct qeth_cmd_buffer iob[QETH_CMD_BUFFER_NO];
601 	atomic_t irq_pending;
602 	int io_buf_no;
603 };
604 
605 /**
606  *  OSA card related definitions
607  */
608 struct qeth_token {
609 	__u32 issuer_rm_w;
610 	__u32 issuer_rm_r;
611 	__u32 cm_filter_w;
612 	__u32 cm_filter_r;
613 	__u32 cm_connection_w;
614 	__u32 cm_connection_r;
615 	__u32 ulp_filter_w;
616 	__u32 ulp_filter_r;
617 	__u32 ulp_connection_w;
618 	__u32 ulp_connection_r;
619 };
620 
621 struct qeth_seqno {
622 	__u32 trans_hdr;
623 	__u32 pdu_hdr;
624 	__u32 pdu_hdr_ack;
625 	__u16 ipa;
626 	__u32 pkt_seqno;
627 };
628 
629 struct qeth_reply {
630 	struct list_head list;
631 	wait_queue_head_t wait_q;
632 	int (*callback)(struct qeth_card *, struct qeth_reply *,
633 		unsigned long);
634 	u32 seqno;
635 	unsigned long offset;
636 	atomic_t received;
637 	int rc;
638 	void *param;
639 	struct qeth_card *card;
640 	refcount_t refcnt;
641 };
642 
643 struct qeth_card_blkt {
644 	int time_total;
645 	int inter_packet;
646 	int inter_packet_jumbo;
647 };
648 
649 #define QETH_BROADCAST_WITH_ECHO    0x01
650 #define QETH_BROADCAST_WITHOUT_ECHO 0x02
651 #define QETH_LAYER2_MAC_READ	    0x01
652 #define QETH_LAYER2_MAC_REGISTERED  0x02
653 struct qeth_card_info {
654 	unsigned short unit_addr2;
655 	unsigned short cula;
656 	unsigned short chpid;
657 	__u16 func_level;
658 	char mcl_level[QETH_MCL_LENGTH + 1];
659 	int guestlan;
660 	int mac_bits;
661 	int portno;
662 	enum qeth_card_types type;
663 	enum qeth_link_types link_type;
664 	int initial_mtu;
665 	int max_mtu;
666 	int broadcast_capable;
667 	int unique_id;
668 	bool layer_enforced;
669 	struct qeth_card_blkt blkt;
670 	enum qeth_ipa_promisc_modes promisc_mode;
671 	__u32 diagass_support;
672 	__u32 hwtrap;
673 };
674 
675 struct qeth_card_options {
676 	struct qeth_routing_info route4;
677 	struct qeth_ipa_info ipa4;
678 	struct qeth_ipa_info adp; /*Adapter parameters*/
679 	struct qeth_routing_info route6;
680 	struct qeth_ipa_info ipa6;
681 	struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
682 	struct qeth_vnicc_info vnicc; /* VNICC options */
683 	int fake_broadcast;
684 	int layer2;
685 	int performance_stats;
686 	int rx_sg_cb;
687 	enum qeth_ipa_isolation_modes isolation;
688 	enum qeth_ipa_isolation_modes prev_isolation;
689 	int sniffer;
690 	enum qeth_cq cq;
691 	char hsuid[9];
692 };
693 
694 /*
695  * thread bits for qeth_card thread masks
696  */
697 enum qeth_threads {
698 	QETH_RECOVER_THREAD = 1,
699 };
700 
701 struct qeth_osn_info {
702 	int (*assist_cb)(struct net_device *dev, void *data);
703 	int (*data_cb)(struct sk_buff *skb);
704 };
705 
706 enum qeth_discipline_id {
707 	QETH_DISCIPLINE_UNDETERMINED = -1,
708 	QETH_DISCIPLINE_LAYER3 = 0,
709 	QETH_DISCIPLINE_LAYER2 = 1,
710 };
711 
712 struct qeth_discipline {
713 	const struct device_type *devtype;
714 	int (*process_rx_buffer)(struct qeth_card *card, int budget, int *done);
715 	int (*recover)(void *ptr);
716 	int (*setup) (struct ccwgroup_device *);
717 	void (*remove) (struct ccwgroup_device *);
718 	int (*set_online) (struct ccwgroup_device *);
719 	int (*set_offline) (struct ccwgroup_device *);
720 	int (*freeze)(struct ccwgroup_device *);
721 	int (*thaw) (struct ccwgroup_device *);
722 	int (*restore)(struct ccwgroup_device *);
723 	int (*do_ioctl)(struct net_device *dev, struct ifreq *rq, int cmd);
724 	int (*control_event_handler)(struct qeth_card *card,
725 					struct qeth_ipa_cmd *cmd);
726 };
727 
728 struct qeth_vlan_vid {
729 	struct list_head list;
730 	unsigned short vid;
731 };
732 
733 enum qeth_addr_disposition {
734 	QETH_DISP_ADDR_DELETE = 0,
735 	QETH_DISP_ADDR_DO_NOTHING = 1,
736 	QETH_DISP_ADDR_ADD = 2,
737 };
738 
739 struct qeth_rx {
740 	int b_count;
741 	int b_index;
742 	struct qdio_buffer_element *b_element;
743 	int e_offset;
744 	int qdio_err;
745 };
746 
747 struct carrier_info {
748 	__u8  card_type;
749 	__u16 port_mode;
750 	__u32 port_speed;
751 };
752 
753 struct qeth_switch_info {
754 	__u32 capabilities;
755 	__u32 settings;
756 };
757 
758 #define QETH_NAPI_WEIGHT NAPI_POLL_WEIGHT
759 
760 struct qeth_card {
761 	struct list_head list;
762 	enum qeth_card_states state;
763 	int lan_online;
764 	spinlock_t lock;
765 	struct ccwgroup_device *gdev;
766 	struct qeth_channel read;
767 	struct qeth_channel write;
768 	struct qeth_channel data;
769 
770 	struct net_device *dev;
771 	struct net_device_stats stats;
772 
773 	struct qeth_card_info info;
774 	struct qeth_token token;
775 	struct qeth_seqno seqno;
776 	struct qeth_card_options options;
777 
778 	wait_queue_head_t wait_q;
779 	spinlock_t mclock;
780 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
781 	struct mutex vid_list_mutex;		/* vid_list */
782 	struct list_head vid_list;
783 	DECLARE_HASHTABLE(mac_htable, 4);
784 	DECLARE_HASHTABLE(ip_htable, 4);
785 	DECLARE_HASHTABLE(ip_mc_htable, 4);
786 	struct work_struct kernel_thread_starter;
787 	spinlock_t thread_mask_lock;
788 	unsigned long thread_start_mask;
789 	unsigned long thread_allowed_mask;
790 	unsigned long thread_running_mask;
791 	struct task_struct *recovery_task;
792 	spinlock_t ip_lock;
793 	struct qeth_ipato ipato;
794 	struct list_head cmd_waiter_list;
795 	/* QDIO buffer handling */
796 	struct qeth_qdio_info qdio;
797 	struct qeth_perf_stats perf_stats;
798 	int read_or_write_problem;
799 	struct qeth_osn_info osn_info;
800 	struct qeth_discipline *discipline;
801 	atomic_t force_alloc_skb;
802 	struct service_level qeth_service_level;
803 	struct qdio_ssqd_desc ssqd;
804 	debug_info_t *debug;
805 	struct mutex conf_mutex;
806 	struct mutex discipline_mutex;
807 	struct napi_struct napi;
808 	struct qeth_rx rx;
809 	struct delayed_work buffer_reclaim_work;
810 	int reclaim_index;
811 	struct work_struct close_dev_work;
812 };
813 
814 struct qeth_card_list_struct {
815 	struct list_head list;
816 	rwlock_t rwlock;
817 };
818 
819 struct qeth_trap_id {
820 	__u16 lparnr;
821 	char vmname[8];
822 	__u8 chpid;
823 	__u8 ssid;
824 	__u16 devno;
825 } __packed;
826 
827 /*some helper functions*/
828 #define QETH_CARD_IFNAME(card) (((card)->dev)? (card)->dev->name : "")
829 
830 static inline void qeth_scrub_qdio_buffer(struct qdio_buffer *buf,
831 					  unsigned int elements)
832 {
833 	unsigned int i;
834 
835 	for (i = 0; i < elements; i++)
836 		memset(&buf->element[i], 0, sizeof(struct qdio_buffer_element));
837 	buf->element[14].sflags = 0;
838 	buf->element[15].sflags = 0;
839 }
840 
841 /**
842  * qeth_get_elements_for_range() -	find number of SBALEs to cover range.
843  * @start:				Start of the address range.
844  * @end:				Address after the end of the range.
845  *
846  * Returns the number of pages, and thus QDIO buffer elements, needed to cover
847  * the specified address range.
848  */
849 static inline int qeth_get_elements_for_range(addr_t start, addr_t end)
850 {
851 	return PFN_UP(end) - PFN_DOWN(start);
852 }
853 
854 static inline int qeth_get_micros(void)
855 {
856 	return (int) (get_tod_clock() >> 12);
857 }
858 
859 static inline int qeth_get_ip_version(struct sk_buff *skb)
860 {
861 	struct vlan_ethhdr *veth = vlan_eth_hdr(skb);
862 	__be16 prot = veth->h_vlan_proto;
863 
864 	if (prot == htons(ETH_P_8021Q))
865 		prot = veth->h_vlan_encapsulated_proto;
866 
867 	switch (prot) {
868 	case htons(ETH_P_IPV6):
869 		return 6;
870 	case htons(ETH_P_IP):
871 		return 4;
872 	default:
873 		return 0;
874 	}
875 }
876 
877 static inline void qeth_rx_csum(struct qeth_card *card, struct sk_buff *skb,
878 				u8 flags)
879 {
880 	if ((card->dev->features & NETIF_F_RXCSUM) &&
881 	    (flags & QETH_HDR_EXT_CSUM_TRANSP_REQ)) {
882 		skb->ip_summed = CHECKSUM_UNNECESSARY;
883 		if (card->options.performance_stats)
884 			card->perf_stats.rx_csum++;
885 	} else {
886 		skb->ip_summed = CHECKSUM_NONE;
887 	}
888 }
889 
890 static inline void qeth_tx_csum(struct sk_buff *skb, u8 *flags, int ipv)
891 {
892 	*flags |= QETH_HDR_EXT_CSUM_TRANSP_REQ;
893 	if ((ipv == 4 && ip_hdr(skb)->protocol == IPPROTO_UDP) ||
894 	    (ipv == 6 && ipv6_hdr(skb)->nexthdr == IPPROTO_UDP))
895 		*flags |= QETH_HDR_EXT_UDP;
896 	if (ipv == 4) {
897 		/* some HW requires combined L3+L4 csum offload: */
898 		*flags |= QETH_HDR_EXT_CSUM_HDR_REQ;
899 		ip_hdr(skb)->check = 0;
900 	}
901 }
902 
903 static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
904 		struct qeth_buffer_pool_entry *entry)
905 {
906 	list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
907 }
908 
909 static inline int qeth_is_diagass_supported(struct qeth_card *card,
910 		enum qeth_diags_cmds cmd)
911 {
912 	return card->info.diagass_support & (__u32)cmd;
913 }
914 
915 int qeth_send_simple_setassparms_prot(struct qeth_card *card,
916 				      enum qeth_ipa_funcs ipa_func,
917 				      u16 cmd_code, long data,
918 				      enum qeth_prot_versions prot);
919 /* IPv4 variant */
920 static inline int qeth_send_simple_setassparms(struct qeth_card *card,
921 					       enum qeth_ipa_funcs ipa_func,
922 					       u16 cmd_code, long data)
923 {
924 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
925 						 data, QETH_PROT_IPV4);
926 }
927 
928 static inline int qeth_send_simple_setassparms_v6(struct qeth_card *card,
929 						  enum qeth_ipa_funcs ipa_func,
930 						  u16 cmd_code, long data)
931 {
932 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
933 						 data, QETH_PROT_IPV6);
934 }
935 
936 int qeth_get_priority_queue(struct qeth_card *card, struct sk_buff *skb,
937 			    int ipv);
938 static inline struct qeth_qdio_out_q *qeth_get_tx_queue(struct qeth_card *card,
939 							struct sk_buff *skb,
940 							int ipv, int cast_type)
941 {
942 	if (IS_IQD(card) && cast_type != RTN_UNICAST)
943 		return card->qdio.out_qs[card->qdio.no_out_queues - 1];
944 	if (!card->qdio.do_prio_queueing)
945 		return card->qdio.out_qs[card->qdio.default_out_queue];
946 	return card->qdio.out_qs[qeth_get_priority_queue(card, skb, ipv)];
947 }
948 
949 extern struct qeth_discipline qeth_l2_discipline;
950 extern struct qeth_discipline qeth_l3_discipline;
951 extern const struct attribute_group *qeth_generic_attr_groups[];
952 extern const struct attribute_group *qeth_osn_attr_groups[];
953 extern const struct attribute_group qeth_device_attr_group;
954 extern const struct attribute_group qeth_device_blkt_group;
955 extern const struct device_type qeth_generic_devtype;
956 extern struct workqueue_struct *qeth_wq;
957 
958 int qeth_card_hw_is_reachable(struct qeth_card *);
959 const char *qeth_get_cardname_short(struct qeth_card *);
960 int qeth_realloc_buffer_pool(struct qeth_card *, int);
961 int qeth_core_load_discipline(struct qeth_card *, enum qeth_discipline_id);
962 void qeth_core_free_discipline(struct qeth_card *);
963 
964 /* exports for qeth discipline device drivers */
965 extern struct qeth_card_list_struct qeth_core_card_list;
966 extern struct kmem_cache *qeth_core_header_cache;
967 extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
968 
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_change_mtu(struct net_device *, int);
999 int qeth_setadpparms_change_macaddr(struct qeth_card *);
1000 void qeth_tx_timeout(struct net_device *);
1001 void qeth_prepare_control_data(struct qeth_card *, int,
1002 				struct qeth_cmd_buffer *);
1003 void qeth_release_buffer(struct qeth_channel *, struct qeth_cmd_buffer *);
1004 void qeth_prepare_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *, char);
1005 struct qeth_cmd_buffer *qeth_wait_for_buffer(struct qeth_channel *);
1006 int qeth_query_switch_attributes(struct qeth_card *card,
1007 				  struct qeth_switch_info *sw_info);
1008 int qeth_send_control_data(struct qeth_card *, int, struct qeth_cmd_buffer *,
1009 	int (*reply_cb)(struct qeth_card *, struct qeth_reply*, unsigned long),
1010 	void *reply_param);
1011 int qeth_get_elements_no(struct qeth_card *card, struct sk_buff *skb,
1012 			 int extra_elems, int data_offset);
1013 int qeth_get_elements_for_frags(struct sk_buff *);
1014 int qeth_do_send_packet_fast(struct qeth_qdio_out_q *queue, struct sk_buff *skb,
1015 			     struct qeth_hdr *hdr, unsigned int offset,
1016 			     unsigned int hd_len);
1017 int qeth_do_send_packet(struct qeth_card *card, struct qeth_qdio_out_q *queue,
1018 			struct sk_buff *skb, struct qeth_hdr *hdr,
1019 			unsigned int offset, unsigned int hd_len,
1020 			int elements_needed);
1021 int qeth_do_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1022 int qeth_core_get_sset_count(struct net_device *, int);
1023 void qeth_core_get_ethtool_stats(struct net_device *,
1024 				struct ethtool_stats *, u64 *);
1025 void qeth_core_get_strings(struct net_device *, u32, u8 *);
1026 void qeth_core_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
1027 void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
1028 int qeth_core_ethtool_get_link_ksettings(struct net_device *netdev,
1029 					 struct ethtool_link_ksettings *cmd);
1030 int qeth_set_access_ctrl_online(struct qeth_card *card, int fallback);
1031 int qeth_hdr_chk_and_bounce(struct sk_buff *, struct qeth_hdr **, int);
1032 int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
1033 int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
1034 void qeth_trace_features(struct qeth_card *);
1035 void qeth_close_dev(struct qeth_card *);
1036 int qeth_send_setassparms(struct qeth_card *, struct qeth_cmd_buffer *, __u16,
1037 			  long,
1038 			  int (*reply_cb)(struct qeth_card *,
1039 					  struct qeth_reply *, unsigned long),
1040 			  void *);
1041 int qeth_setassparms_cb(struct qeth_card *, struct qeth_reply *, unsigned long);
1042 struct qeth_cmd_buffer *qeth_get_setassparms_cmd(struct qeth_card *,
1043 						 enum qeth_ipa_funcs,
1044 						 __u16, __u16,
1045 						 enum qeth_prot_versions);
1046 int qeth_set_features(struct net_device *, netdev_features_t);
1047 void qeth_enable_hw_features(struct net_device *dev);
1048 netdev_features_t qeth_fix_features(struct net_device *, netdev_features_t);
1049 netdev_features_t qeth_features_check(struct sk_buff *skb,
1050 				      struct net_device *dev,
1051 				      netdev_features_t features);
1052 int qeth_vm_request_mac(struct qeth_card *card);
1053 int qeth_push_hdr(struct sk_buff *skb, struct qeth_hdr **hdr, unsigned int len);
1054 
1055 /* exports for OSN */
1056 int qeth_osn_assist(struct net_device *, void *, int);
1057 int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
1058 		int (*assist_cb)(struct net_device *, void *),
1059 		int (*data_cb)(struct sk_buff *));
1060 void qeth_osn_deregister(struct net_device *);
1061 
1062 #endif /* __QETH_CORE_H__ */
1063