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