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