xref: /openbmc/linux/drivers/s390/net/qeth_core.h (revision 3557b3fd)
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_ipa_supported(struct qeth_ipa_info *ipa,
169 		enum qeth_ipa_funcs func)
170 {
171 	return (ipa->supported_funcs & func);
172 }
173 
174 static inline int qeth_is_ipa_enabled(struct qeth_ipa_info *ipa,
175 		enum qeth_ipa_funcs func)
176 {
177 	return (ipa->supported_funcs & ipa->enabled_funcs & func);
178 }
179 
180 #define qeth_adp_supported(c, f) \
181 	qeth_is_ipa_supported(&c->options.adp, f)
182 #define qeth_adp_enabled(c, f) \
183 	qeth_is_ipa_enabled(&c->options.adp, f)
184 #define qeth_is_supported(c, f) \
185 	qeth_is_ipa_supported(&c->options.ipa4, f)
186 #define qeth_is_enabled(c, f) \
187 	qeth_is_ipa_enabled(&c->options.ipa4, f)
188 #define qeth_is_supported6(c, f) \
189 	qeth_is_ipa_supported(&c->options.ipa6, f)
190 #define qeth_is_enabled6(c, f) \
191 	qeth_is_ipa_enabled(&c->options.ipa6, f)
192 #define qeth_is_ipafunc_supported(c, prot, f) \
193 	 ((prot == QETH_PROT_IPV6) ? \
194 		qeth_is_supported6(c, f) : qeth_is_supported(c, f))
195 #define qeth_is_ipafunc_enabled(c, prot, f) \
196 	 ((prot == QETH_PROT_IPV6) ? \
197 		qeth_is_enabled6(c, f) : qeth_is_enabled(c, f))
198 
199 #define QETH_IDX_FUNC_LEVEL_OSD		 0x0101
200 #define QETH_IDX_FUNC_LEVEL_IQD		 0x4108
201 
202 #define QETH_BUFSIZE		4096
203 #define CCW_CMD_WRITE		0x01
204 #define CCW_CMD_READ		0x02
205 
206 /**
207  * some more defs
208  */
209 #define QETH_TX_TIMEOUT		100 * HZ
210 #define QETH_RCD_TIMEOUT	60 * HZ
211 #define QETH_RECLAIM_WORK_TIME	HZ
212 #define QETH_MAX_PORTNO		15
213 
214 /*IPv6 address autoconfiguration stuff*/
215 #define UNIQUE_ID_IF_CREATE_ADDR_FAILED 0xfffe
216 #define UNIQUE_ID_NOT_BY_CARD		0x10000
217 
218 /*****************************************************************************/
219 /* QDIO queue and buffer handling                                            */
220 /*****************************************************************************/
221 #define QETH_MAX_QUEUES 4
222 #define QETH_IQD_MIN_TXQ	2	/* One for ucast, one for mcast. */
223 #define QETH_IQD_MCAST_TXQ	0
224 #define QETH_IQD_MIN_UCAST_TXQ	1
225 #define QETH_IN_BUF_SIZE_DEFAULT 65536
226 #define QETH_IN_BUF_COUNT_DEFAULT 64
227 #define QETH_IN_BUF_COUNT_HSDEFAULT 128
228 #define QETH_IN_BUF_COUNT_MIN 8
229 #define QETH_IN_BUF_COUNT_MAX 128
230 #define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
231 #define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
232 		 ((card)->qdio.in_buf_pool.buf_count / 2)
233 
234 /* buffers we have to be behind before we get a PCI */
235 #define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
236 /*enqueued free buffers left before we get a PCI*/
237 #define QETH_PCI_THRESHOLD_B(card) 0
238 /*not used unless the microcode gets patched*/
239 #define QETH_PCI_TIMER_VALUE(card) 3
240 
241 /* priority queing */
242 #define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
243 #define QETH_DEFAULT_QUEUE    2
244 #define QETH_NO_PRIO_QUEUEING 0
245 #define QETH_PRIO_Q_ING_PREC  1
246 #define QETH_PRIO_Q_ING_TOS   2
247 #define QETH_PRIO_Q_ING_SKB   3
248 #define QETH_PRIO_Q_ING_VLAN  4
249 
250 /* Packing */
251 #define QETH_LOW_WATERMARK_PACK  2
252 #define QETH_HIGH_WATERMARK_PACK 5
253 #define QETH_WATERMARK_PACK_FUZZ 1
254 
255 /* large receive scatter gather copy break */
256 #define QETH_RX_SG_CB (PAGE_SIZE >> 1)
257 #define QETH_RX_PULL_LEN 256
258 
259 struct qeth_hdr_layer3 {
260 	__u8  id;
261 	__u8  flags;
262 	__u16 inbound_checksum; /*TSO:__u16 seqno */
263 	__u32 token;		/*TSO: __u32 reserved */
264 	__u16 length;
265 	__u8  vlan_prio;
266 	__u8  ext_flags;
267 	__u16 vlan_id;
268 	__u16 frame_offset;
269 	union {
270 		/* TX: */
271 		struct in6_addr ipv6_addr;
272 		struct ipv4 {
273 			u8 res[12];
274 			u32 addr;
275 		} ipv4;
276 		/* RX: */
277 		struct rx {
278 			u8 res1[2];
279 			u8 src_mac[6];
280 			u8 res2[4];
281 			u16 vlan_id;
282 			u8 res3[2];
283 		} rx;
284 	} next_hop;
285 };
286 
287 struct qeth_hdr_layer2 {
288 	__u8 id;
289 	__u8 flags[3];
290 	__u8 port_no;
291 	__u8 hdr_length;
292 	__u16 pkt_length;
293 	__u16 seq_no;
294 	__u16 vlan_id;
295 	__u32 reserved;
296 	__u8 reserved2[16];
297 } __attribute__ ((packed));
298 
299 struct qeth_hdr_osn {
300 	__u8 id;
301 	__u8 reserved;
302 	__u16 seq_no;
303 	__u16 reserved2;
304 	__u16 control_flags;
305 	__u16 pdu_length;
306 	__u8 reserved3[18];
307 	__u32 ccid;
308 } __attribute__ ((packed));
309 
310 struct qeth_hdr {
311 	union {
312 		struct qeth_hdr_layer2 l2;
313 		struct qeth_hdr_layer3 l3;
314 		struct qeth_hdr_osn    osn;
315 	} hdr;
316 } __attribute__ ((packed));
317 
318 /*TCP Segmentation Offload header*/
319 struct qeth_hdr_ext_tso {
320 	__u16 hdr_tot_len;
321 	__u8  imb_hdr_no;
322 	__u8  reserved;
323 	__u8  hdr_type;
324 	__u8  hdr_version;
325 	__u16 hdr_len;
326 	__u32 payload_len;
327 	__u16 mss;
328 	__u16 dg_hdr_len;
329 	__u8  padding[16];
330 } __attribute__ ((packed));
331 
332 struct qeth_hdr_tso {
333 	struct qeth_hdr hdr;	/*hdr->hdr.l3.xxx*/
334 	struct qeth_hdr_ext_tso ext;
335 } __attribute__ ((packed));
336 
337 
338 /* flags for qeth_hdr.flags */
339 #define QETH_HDR_PASSTHRU 0x10
340 #define QETH_HDR_IPV6     0x80
341 #define QETH_HDR_CAST_MASK 0x07
342 enum qeth_cast_flags {
343 	QETH_CAST_UNICAST   = 0x06,
344 	QETH_CAST_MULTICAST = 0x04,
345 	QETH_CAST_BROADCAST = 0x05,
346 	QETH_CAST_ANYCAST   = 0x07,
347 	QETH_CAST_NOCAST    = 0x00,
348 };
349 
350 enum qeth_layer2_frame_flags {
351 	QETH_LAYER2_FLAG_MULTICAST = 0x01,
352 	QETH_LAYER2_FLAG_BROADCAST = 0x02,
353 	QETH_LAYER2_FLAG_UNICAST   = 0x04,
354 	QETH_LAYER2_FLAG_VLAN      = 0x10,
355 };
356 
357 enum qeth_header_ids {
358 	QETH_HEADER_TYPE_LAYER3 = 0x01,
359 	QETH_HEADER_TYPE_LAYER2 = 0x02,
360 	QETH_HEADER_TYPE_L3_TSO	= 0x03,
361 	QETH_HEADER_TYPE_OSN    = 0x04,
362 	QETH_HEADER_TYPE_L2_TSO	= 0x06,
363 };
364 /* flags for qeth_hdr.ext_flags */
365 #define QETH_HDR_EXT_VLAN_FRAME       0x01
366 #define QETH_HDR_EXT_TOKEN_ID         0x02
367 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
368 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
369 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
370 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
371 #define QETH_HDR_EXT_UDP	      0x40 /*bit off for TCP*/
372 
373 enum qeth_qdio_buffer_states {
374 	/*
375 	 * inbound: read out by driver; owned by hardware in order to be filled
376 	 * outbound: owned by driver in order to be filled
377 	 */
378 	QETH_QDIO_BUF_EMPTY,
379 	/*
380 	 * inbound: filled by hardware; owned by driver in order to be read out
381 	 * outbound: filled by driver; owned by hardware in order to be sent
382 	 */
383 	QETH_QDIO_BUF_PRIMED,
384 	/*
385 	 * inbound: not applicable
386 	 * outbound: identified to be pending in TPQ
387 	 */
388 	QETH_QDIO_BUF_PENDING,
389 	/*
390 	 * inbound: not applicable
391 	 * outbound: found in completion queue
392 	 */
393 	QETH_QDIO_BUF_IN_CQ,
394 	/*
395 	 * inbound: not applicable
396 	 * outbound: handled via transfer pending / completion queue
397 	 */
398 	QETH_QDIO_BUF_HANDLED_DELAYED,
399 };
400 
401 enum qeth_qdio_info_states {
402 	QETH_QDIO_UNINITIALIZED,
403 	QETH_QDIO_ALLOCATED,
404 	QETH_QDIO_ESTABLISHED,
405 	QETH_QDIO_CLEANING
406 };
407 
408 struct qeth_buffer_pool_entry {
409 	struct list_head list;
410 	struct list_head init_list;
411 	void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
412 };
413 
414 struct qeth_qdio_buffer_pool {
415 	struct list_head entry_list;
416 	int buf_count;
417 };
418 
419 struct qeth_qdio_buffer {
420 	struct qdio_buffer *buffer;
421 	/* the buffer pool entry currently associated to this buffer */
422 	struct qeth_buffer_pool_entry *pool_entry;
423 	struct sk_buff *rx_skb;
424 };
425 
426 struct qeth_qdio_q {
427 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
428 	struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
429 	int next_buf_to_init;
430 };
431 
432 struct qeth_qdio_out_buffer {
433 	struct qdio_buffer *buffer;
434 	atomic_t state;
435 	int next_element_to_fill;
436 	struct sk_buff_head skb_list;
437 	int is_header[QDIO_MAX_ELEMENTS_PER_BUFFER];
438 
439 	struct qeth_qdio_out_q *q;
440 	struct qeth_qdio_out_buffer *next_pending;
441 };
442 
443 struct qeth_card;
444 
445 enum qeth_out_q_states {
446        QETH_OUT_Q_UNLOCKED,
447        QETH_OUT_Q_LOCKED,
448        QETH_OUT_Q_LOCKED_FLUSH,
449 };
450 
451 #define QETH_CARD_STAT_ADD(_c, _stat, _val)	((_c)->stats._stat += (_val))
452 #define QETH_CARD_STAT_INC(_c, _stat)		QETH_CARD_STAT_ADD(_c, _stat, 1)
453 
454 #define QETH_TXQ_STAT_ADD(_q, _stat, _val)	((_q)->stats._stat += (_val))
455 #define QETH_TXQ_STAT_INC(_q, _stat)		QETH_TXQ_STAT_ADD(_q, _stat, 1)
456 
457 struct qeth_card_stats {
458 	u64 rx_bufs;
459 	u64 rx_skb_csum;
460 	u64 rx_sg_skbs;
461 	u64 rx_sg_frags;
462 	u64 rx_sg_alloc_page;
463 
464 	/* rtnl_link_stats64 */
465 	u64 rx_packets;
466 	u64 rx_bytes;
467 	u64 rx_errors;
468 	u64 rx_dropped;
469 	u64 rx_multicast;
470 };
471 
472 struct qeth_out_q_stats {
473 	u64 bufs;
474 	u64 bufs_pack;
475 	u64 buf_elements;
476 	u64 skbs_pack;
477 	u64 skbs_sg;
478 	u64 skbs_csum;
479 	u64 skbs_tso;
480 	u64 skbs_linearized;
481 	u64 skbs_linearized_fail;
482 	u64 tso_bytes;
483 	u64 packing_mode_switch;
484 	u64 stopped;
485 
486 	/* rtnl_link_stats64 */
487 	u64 tx_packets;
488 	u64 tx_bytes;
489 	u64 tx_errors;
490 	u64 tx_dropped;
491 };
492 
493 struct qeth_qdio_out_q {
494 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
495 	struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
496 	struct qdio_outbuf_state *bufstates; /* convenience pointer */
497 	struct qeth_out_q_stats stats;
498 	int queue_no;
499 	struct qeth_card *card;
500 	atomic_t state;
501 	int do_pack;
502 	/*
503 	 * index of buffer to be filled by driver; state EMPTY or PACKING
504 	 */
505 	int next_buf_to_fill;
506 	/*
507 	 * number of buffers that are currently filled (PRIMED)
508 	 * -> these buffers are hardware-owned
509 	 */
510 	atomic_t used_buffers;
511 	/* indicates whether PCI flag must be set (or if one is outstanding) */
512 	atomic_t set_pci_flags_count;
513 };
514 
515 static inline bool qeth_out_queue_is_full(struct qeth_qdio_out_q *queue)
516 {
517 	return atomic_read(&queue->used_buffers) >= QDIO_MAX_BUFFERS_PER_Q;
518 }
519 
520 struct qeth_qdio_info {
521 	atomic_t state;
522 	/* input */
523 	int no_in_queues;
524 	struct qeth_qdio_q *in_q;
525 	struct qeth_qdio_q *c_q;
526 	struct qeth_qdio_buffer_pool in_buf_pool;
527 	struct qeth_qdio_buffer_pool init_pool;
528 	int in_buf_size;
529 
530 	/* output */
531 	int no_out_queues;
532 	struct qeth_qdio_out_q *out_qs[QETH_MAX_QUEUES];
533 	struct qdio_outbuf_state *out_bufstates;
534 
535 	/* priority queueing */
536 	int do_prio_queueing;
537 	int default_out_queue;
538 };
539 
540 /**
541  * buffer stuff for read channel
542  */
543 #define QETH_CMD_BUFFER_NO	8
544 
545 /**
546  *  channel state machine
547  */
548 enum qeth_channel_states {
549 	CH_STATE_UP,
550 	CH_STATE_DOWN,
551 	CH_STATE_HALTED,
552 	CH_STATE_STOPPED,
553 	CH_STATE_RCD,
554 	CH_STATE_RCD_DONE,
555 };
556 /**
557  * card state machine
558  */
559 enum qeth_card_states {
560 	CARD_STATE_DOWN,
561 	CARD_STATE_HARDSETUP,
562 	CARD_STATE_SOFTSETUP,
563 };
564 
565 /**
566  * Protocol versions
567  */
568 enum qeth_prot_versions {
569 	QETH_PROT_IPV4 = 0x0004,
570 	QETH_PROT_IPV6 = 0x0006,
571 };
572 
573 enum qeth_cmd_buffer_state {
574 	BUF_STATE_FREE,
575 	BUF_STATE_LOCKED,
576 };
577 
578 enum qeth_cq {
579 	QETH_CQ_DISABLED = 0,
580 	QETH_CQ_ENABLED = 1,
581 	QETH_CQ_NOTAVAILABLE = 2,
582 };
583 
584 struct qeth_ipato {
585 	bool enabled;
586 	bool invert4;
587 	bool invert6;
588 	struct list_head entries;
589 };
590 
591 struct qeth_channel;
592 
593 struct qeth_cmd_buffer {
594 	enum qeth_cmd_buffer_state state;
595 	struct qeth_channel *channel;
596 	struct qeth_reply *reply;
597 	long timeout;
598 	unsigned char *data;
599 	void (*finalize)(struct qeth_card *card, struct qeth_cmd_buffer *iob,
600 			 unsigned int length);
601 	void (*callback)(struct qeth_card *card, struct qeth_channel *channel,
602 			 struct qeth_cmd_buffer *iob);
603 };
604 
605 static inline struct qeth_ipa_cmd *__ipa_cmd(struct qeth_cmd_buffer *iob)
606 {
607 	return (struct qeth_ipa_cmd *)(iob->data + IPA_PDU_HEADER_SIZE);
608 }
609 
610 /**
611  * definition of a qeth channel, used for read and write
612  */
613 struct qeth_channel {
614 	enum qeth_channel_states state;
615 	struct ccw1 *ccw;
616 	spinlock_t iob_lock;
617 	wait_queue_head_t wait_q;
618 	struct ccw_device *ccwdev;
619 /*command buffer for control data*/
620 	struct qeth_cmd_buffer iob[QETH_CMD_BUFFER_NO];
621 	atomic_t irq_pending;
622 	int io_buf_no;
623 };
624 
625 static inline bool qeth_trylock_channel(struct qeth_channel *channel)
626 {
627 	return atomic_cmpxchg(&channel->irq_pending, 0, 1) == 0;
628 }
629 
630 /**
631  *  OSA card related definitions
632  */
633 struct qeth_token {
634 	__u32 issuer_rm_w;
635 	__u32 issuer_rm_r;
636 	__u32 cm_filter_w;
637 	__u32 cm_filter_r;
638 	__u32 cm_connection_w;
639 	__u32 cm_connection_r;
640 	__u32 ulp_filter_w;
641 	__u32 ulp_filter_r;
642 	__u32 ulp_connection_w;
643 	__u32 ulp_connection_r;
644 };
645 
646 struct qeth_seqno {
647 	__u32 trans_hdr;
648 	__u32 pdu_hdr;
649 	__u32 pdu_hdr_ack;
650 	__u16 ipa;
651 	__u32 pkt_seqno;
652 };
653 
654 struct qeth_reply {
655 	struct list_head list;
656 	struct completion received;
657 	int (*callback)(struct qeth_card *, struct qeth_reply *,
658 		unsigned long);
659 	u32 seqno;
660 	unsigned long offset;
661 	int rc;
662 	void *param;
663 	refcount_t refcnt;
664 };
665 
666 struct qeth_card_blkt {
667 	int time_total;
668 	int inter_packet;
669 	int inter_packet_jumbo;
670 };
671 
672 #define QETH_BROADCAST_WITH_ECHO    0x01
673 #define QETH_BROADCAST_WITHOUT_ECHO 0x02
674 #define QETH_LAYER2_MAC_REGISTERED  0x02
675 struct qeth_card_info {
676 	unsigned short unit_addr2;
677 	unsigned short cula;
678 	unsigned short chpid;
679 	__u16 func_level;
680 	char mcl_level[QETH_MCL_LENGTH + 1];
681 	u8 open_when_online:1;
682 	int guestlan;
683 	int mac_bits;
684 	enum qeth_card_types type;
685 	enum qeth_link_types link_type;
686 	int broadcast_capable;
687 	int unique_id;
688 	bool layer_enforced;
689 	struct qeth_card_blkt blkt;
690 	enum qeth_ipa_promisc_modes promisc_mode;
691 	__u32 diagass_support;
692 	__u32 hwtrap;
693 };
694 
695 enum qeth_discipline_id {
696 	QETH_DISCIPLINE_UNDETERMINED = -1,
697 	QETH_DISCIPLINE_LAYER3 = 0,
698 	QETH_DISCIPLINE_LAYER2 = 1,
699 };
700 
701 struct qeth_card_options {
702 	struct qeth_routing_info route4;
703 	struct qeth_ipa_info ipa4;
704 	struct qeth_ipa_info adp; /*Adapter parameters*/
705 	struct qeth_routing_info route6;
706 	struct qeth_ipa_info ipa6;
707 	struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
708 	struct qeth_vnicc_info vnicc; /* VNICC options */
709 	int fake_broadcast;
710 	enum qeth_discipline_id layer;
711 	int rx_sg_cb;
712 	enum qeth_ipa_isolation_modes isolation;
713 	enum qeth_ipa_isolation_modes prev_isolation;
714 	int sniffer;
715 	enum qeth_cq cq;
716 	char hsuid[9];
717 };
718 
719 #define	IS_LAYER2(card)	((card)->options.layer == QETH_DISCIPLINE_LAYER2)
720 #define	IS_LAYER3(card)	((card)->options.layer == QETH_DISCIPLINE_LAYER3)
721 
722 /*
723  * thread bits for qeth_card thread masks
724  */
725 enum qeth_threads {
726 	QETH_RECOVER_THREAD = 1,
727 };
728 
729 struct qeth_osn_info {
730 	int (*assist_cb)(struct net_device *dev, void *data);
731 	int (*data_cb)(struct sk_buff *skb);
732 };
733 
734 struct qeth_discipline {
735 	const struct device_type *devtype;
736 	int (*process_rx_buffer)(struct qeth_card *card, int budget, int *done);
737 	int (*recover)(void *ptr);
738 	int (*setup) (struct ccwgroup_device *);
739 	void (*remove) (struct ccwgroup_device *);
740 	int (*set_online) (struct ccwgroup_device *);
741 	int (*set_offline) (struct ccwgroup_device *);
742 	int (*freeze)(struct ccwgroup_device *);
743 	int (*thaw) (struct ccwgroup_device *);
744 	int (*restore)(struct ccwgroup_device *);
745 	int (*do_ioctl)(struct net_device *dev, struct ifreq *rq, int cmd);
746 	int (*control_event_handler)(struct qeth_card *card,
747 					struct qeth_ipa_cmd *cmd);
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 	enum qeth_card_states state;
779 	spinlock_t lock;
780 	struct ccwgroup_device *gdev;
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 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 		QETH_CARD_STAT_INC(card, rx_skb_csum);
905 	} else {
906 		skb->ip_summed = CHECKSUM_NONE;
907 	}
908 }
909 
910 static inline void qeth_tx_csum(struct sk_buff *skb, u8 *flags, int ipv)
911 {
912 	*flags |= QETH_HDR_EXT_CSUM_TRANSP_REQ;
913 	if ((ipv == 4 && ip_hdr(skb)->protocol == IPPROTO_UDP) ||
914 	    (ipv == 6 && ipv6_hdr(skb)->nexthdr == IPPROTO_UDP))
915 		*flags |= QETH_HDR_EXT_UDP;
916 }
917 
918 static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
919 		struct qeth_buffer_pool_entry *entry)
920 {
921 	list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
922 }
923 
924 static inline int qeth_is_diagass_supported(struct qeth_card *card,
925 		enum qeth_diags_cmds cmd)
926 {
927 	return card->info.diagass_support & (__u32)cmd;
928 }
929 
930 int qeth_send_simple_setassparms_prot(struct qeth_card *card,
931 				      enum qeth_ipa_funcs ipa_func,
932 				      u16 cmd_code, long data,
933 				      enum qeth_prot_versions prot);
934 /* IPv4 variant */
935 static inline int qeth_send_simple_setassparms(struct qeth_card *card,
936 					       enum qeth_ipa_funcs ipa_func,
937 					       u16 cmd_code, long data)
938 {
939 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
940 						 data, QETH_PROT_IPV4);
941 }
942 
943 static inline int qeth_send_simple_setassparms_v6(struct qeth_card *card,
944 						  enum qeth_ipa_funcs ipa_func,
945 						  u16 cmd_code, long data)
946 {
947 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
948 						 data, QETH_PROT_IPV6);
949 }
950 
951 int qeth_get_priority_queue(struct qeth_card *card, struct sk_buff *skb);
952 
953 extern struct qeth_discipline qeth_l2_discipline;
954 extern struct qeth_discipline qeth_l3_discipline;
955 extern const struct ethtool_ops qeth_ethtool_ops;
956 extern const struct ethtool_ops qeth_osn_ethtool_ops;
957 extern const struct attribute_group *qeth_generic_attr_groups[];
958 extern const struct attribute_group *qeth_osn_attr_groups[];
959 extern const struct attribute_group qeth_device_attr_group;
960 extern const struct attribute_group qeth_device_blkt_group;
961 extern const struct device_type qeth_generic_devtype;
962 
963 const char *qeth_get_cardname_short(struct qeth_card *);
964 int qeth_realloc_buffer_pool(struct qeth_card *, int);
965 int qeth_core_load_discipline(struct qeth_card *, enum qeth_discipline_id);
966 void qeth_core_free_discipline(struct qeth_card *);
967 
968 /* exports for qeth discipline device drivers */
969 extern struct kmem_cache *qeth_core_header_cache;
970 extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
971 
972 struct net_device *qeth_clone_netdev(struct net_device *orig);
973 struct qeth_card *qeth_get_card_by_busid(char *bus_id);
974 void qeth_set_allowed_threads(struct qeth_card *, unsigned long , int);
975 int qeth_threads_running(struct qeth_card *, unsigned long);
976 int qeth_do_run_thread(struct qeth_card *, unsigned long);
977 void qeth_clear_thread_start_bit(struct qeth_card *, unsigned long);
978 void qeth_clear_thread_running_bit(struct qeth_card *, unsigned long);
979 int qeth_core_hardsetup_card(struct qeth_card *card, bool *carrier_ok);
980 void qeth_print_status_message(struct qeth_card *);
981 int qeth_init_qdio_queues(struct qeth_card *);
982 int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
983 		  int (*reply_cb)
984 		  (struct qeth_card *, struct qeth_reply *, unsigned long),
985 		  void *);
986 struct qeth_cmd_buffer *qeth_get_ipacmd_buffer(struct qeth_card *,
987 			enum qeth_ipa_cmds, enum qeth_prot_versions);
988 struct sk_buff *qeth_core_get_next_skb(struct qeth_card *,
989 		struct qeth_qdio_buffer *, struct qdio_buffer_element **, int *,
990 		struct qeth_hdr **);
991 void qeth_schedule_recovery(struct qeth_card *);
992 int qeth_poll(struct napi_struct *napi, int budget);
993 void qeth_clear_ipacmd_list(struct qeth_card *);
994 int qeth_qdio_clear_card(struct qeth_card *, int);
995 void qeth_clear_working_pool_list(struct qeth_card *);
996 void qeth_clear_cmd_buffers(struct qeth_channel *);
997 void qeth_drain_output_queues(struct qeth_card *card);
998 void qeth_setadp_promisc_mode(struct qeth_card *);
999 int qeth_setadpparms_change_macaddr(struct qeth_card *);
1000 void qeth_tx_timeout(struct net_device *);
1001 void qeth_release_buffer(struct qeth_channel *, struct qeth_cmd_buffer *);
1002 void qeth_prepare_ipa_cmd(struct qeth_card *card, struct qeth_cmd_buffer *iob,
1003 			  u16 cmd_length);
1004 struct qeth_cmd_buffer *qeth_wait_for_buffer(struct qeth_channel *);
1005 int qeth_query_switch_attributes(struct qeth_card *card,
1006 				  struct qeth_switch_info *sw_info);
1007 int qeth_query_card_info(struct qeth_card *card,
1008 			 struct carrier_info *carrier_info);
1009 unsigned int qeth_count_elements(struct sk_buff *skb, unsigned int data_offset);
1010 int qeth_do_send_packet(struct qeth_card *card, struct qeth_qdio_out_q *queue,
1011 			struct sk_buff *skb, struct qeth_hdr *hdr,
1012 			unsigned int offset, unsigned int hd_len,
1013 			int elements_needed);
1014 int qeth_do_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1015 void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
1016 int qeth_set_access_ctrl_online(struct qeth_card *card, int fallback);
1017 int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
1018 int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
1019 void qeth_trace_features(struct qeth_card *);
1020 int qeth_setassparms_cb(struct qeth_card *, struct qeth_reply *, unsigned long);
1021 struct qeth_cmd_buffer *qeth_get_setassparms_cmd(struct qeth_card *,
1022 						 enum qeth_ipa_funcs,
1023 						 __u16, __u16,
1024 						 enum qeth_prot_versions);
1025 int qeth_set_features(struct net_device *, netdev_features_t);
1026 void qeth_enable_hw_features(struct net_device *dev);
1027 netdev_features_t qeth_fix_features(struct net_device *, netdev_features_t);
1028 netdev_features_t qeth_features_check(struct sk_buff *skb,
1029 				      struct net_device *dev,
1030 				      netdev_features_t features);
1031 void qeth_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats);
1032 u16 qeth_iqd_select_queue(struct net_device *dev, struct sk_buff *skb,
1033 			  u8 cast_type, struct net_device *sb_dev);
1034 int qeth_open(struct net_device *dev);
1035 int qeth_stop(struct net_device *dev);
1036 
1037 int qeth_vm_request_mac(struct qeth_card *card);
1038 int qeth_xmit(struct qeth_card *card, struct sk_buff *skb,
1039 	      struct qeth_qdio_out_q *queue, int ipv, int cast_type,
1040 	      void (*fill_header)(struct qeth_qdio_out_q *queue,
1041 				  struct qeth_hdr *hdr, struct sk_buff *skb,
1042 				  int ipv, int cast_type,
1043 				  unsigned int data_len));
1044 
1045 /* exports for OSN */
1046 int qeth_osn_assist(struct net_device *, void *, int);
1047 int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
1048 		int (*assist_cb)(struct net_device *, void *),
1049 		int (*data_cb)(struct sk_buff *));
1050 void qeth_osn_deregister(struct net_device *);
1051 
1052 #endif /* __QETH_CORE_H__ */
1053