xref: /linux/drivers/s390/net/qeth_core.h (revision 6a35ddc5445a8291ced6247a67977e110275acde)
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 #define QETH_RX_PULL_LEN 256
225 
226 struct qeth_hdr_layer3 {
227 	__u8  id;
228 	__u8  flags;
229 	__u16 inbound_checksum; /*TSO:__u16 seqno */
230 	__u32 token;		/*TSO: __u32 reserved */
231 	__u16 length;
232 	__u8  vlan_prio;
233 	__u8  ext_flags;
234 	__u16 vlan_id;
235 	__u16 frame_offset;
236 	union {
237 		/* TX: */
238 		struct in6_addr ipv6_addr;
239 		struct ipv4 {
240 			u8 res[12];
241 			u32 addr;
242 		} ipv4;
243 		/* RX: */
244 		struct rx {
245 			u8 res1[2];
246 			u8 src_mac[6];
247 			u8 res2[4];
248 			u16 vlan_id;
249 			u8 res3[2];
250 		} rx;
251 	} next_hop;
252 };
253 
254 struct qeth_hdr_layer2 {
255 	__u8 id;
256 	__u8 flags[3];
257 	__u8 port_no;
258 	__u8 hdr_length;
259 	__u16 pkt_length;
260 	__u16 seq_no;
261 	__u16 vlan_id;
262 	__u32 reserved;
263 	__u8 reserved2[16];
264 } __attribute__ ((packed));
265 
266 struct qeth_hdr_osn {
267 	__u8 id;
268 	__u8 reserved;
269 	__u16 seq_no;
270 	__u16 reserved2;
271 	__u16 control_flags;
272 	__u16 pdu_length;
273 	__u8 reserved3[18];
274 	__u32 ccid;
275 } __attribute__ ((packed));
276 
277 struct qeth_hdr {
278 	union {
279 		struct qeth_hdr_layer2 l2;
280 		struct qeth_hdr_layer3 l3;
281 		struct qeth_hdr_osn    osn;
282 	} hdr;
283 } __attribute__ ((packed));
284 
285 /*TCP Segmentation Offload header*/
286 struct qeth_hdr_ext_tso {
287 	__u16 hdr_tot_len;
288 	__u8  imb_hdr_no;
289 	__u8  reserved;
290 	__u8  hdr_type;
291 	__u8  hdr_version;
292 	__u16 hdr_len;
293 	__u32 payload_len;
294 	__u16 mss;
295 	__u16 dg_hdr_len;
296 	__u8  padding[16];
297 } __attribute__ ((packed));
298 
299 struct qeth_hdr_tso {
300 	struct qeth_hdr hdr;	/*hdr->hdr.l3.xxx*/
301 	struct qeth_hdr_ext_tso ext;
302 } __attribute__ ((packed));
303 
304 
305 /* flags for qeth_hdr.flags */
306 #define QETH_HDR_PASSTHRU 0x10
307 #define QETH_HDR_IPV6     0x80
308 #define QETH_HDR_CAST_MASK 0x07
309 enum qeth_cast_flags {
310 	QETH_CAST_UNICAST   = 0x06,
311 	QETH_CAST_MULTICAST = 0x04,
312 	QETH_CAST_BROADCAST = 0x05,
313 	QETH_CAST_ANYCAST   = 0x07,
314 	QETH_CAST_NOCAST    = 0x00,
315 };
316 
317 enum qeth_layer2_frame_flags {
318 	QETH_LAYER2_FLAG_MULTICAST = 0x01,
319 	QETH_LAYER2_FLAG_BROADCAST = 0x02,
320 	QETH_LAYER2_FLAG_UNICAST   = 0x04,
321 	QETH_LAYER2_FLAG_VLAN      = 0x10,
322 };
323 
324 enum qeth_header_ids {
325 	QETH_HEADER_TYPE_LAYER3 = 0x01,
326 	QETH_HEADER_TYPE_LAYER2 = 0x02,
327 	QETH_HEADER_TYPE_L3_TSO	= 0x03,
328 	QETH_HEADER_TYPE_OSN    = 0x04,
329 	QETH_HEADER_TYPE_L2_TSO	= 0x06,
330 	QETH_HEADER_MASK_INVAL	= 0x80,
331 };
332 /* flags for qeth_hdr.ext_flags */
333 #define QETH_HDR_EXT_VLAN_FRAME       0x01
334 #define QETH_HDR_EXT_TOKEN_ID         0x02
335 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
336 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
337 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
338 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
339 #define QETH_HDR_EXT_UDP	      0x40 /*bit off for TCP*/
340 
341 static inline bool qeth_l2_same_vlan(struct qeth_hdr_layer2 *h1,
342 				     struct qeth_hdr_layer2 *h2)
343 {
344 	return !((h1->flags[2] ^ h2->flags[2]) & QETH_LAYER2_FLAG_VLAN) &&
345 	       h1->vlan_id == h2->vlan_id;
346 }
347 
348 static inline bool qeth_l3_iqd_same_vlan(struct qeth_hdr_layer3 *h1,
349 					 struct qeth_hdr_layer3 *h2)
350 {
351 	return !((h1->ext_flags ^ h2->ext_flags) & QETH_HDR_EXT_VLAN_FRAME) &&
352 	       h1->vlan_id == h2->vlan_id;
353 }
354 
355 static inline bool qeth_l3_same_next_hop(struct qeth_hdr_layer3 *h1,
356 					 struct qeth_hdr_layer3 *h2)
357 {
358 	return !((h1->flags ^ h2->flags) & QETH_HDR_IPV6) &&
359 	       ipv6_addr_equal(&h1->next_hop.ipv6_addr,
360 			       &h2->next_hop.ipv6_addr);
361 }
362 
363 enum qeth_qdio_info_states {
364 	QETH_QDIO_UNINITIALIZED,
365 	QETH_QDIO_ALLOCATED,
366 	QETH_QDIO_ESTABLISHED,
367 	QETH_QDIO_CLEANING
368 };
369 
370 struct qeth_buffer_pool_entry {
371 	struct list_head list;
372 	struct list_head init_list;
373 	void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
374 };
375 
376 struct qeth_qdio_buffer_pool {
377 	struct list_head entry_list;
378 	int buf_count;
379 };
380 
381 struct qeth_qdio_buffer {
382 	struct qdio_buffer *buffer;
383 	/* the buffer pool entry currently associated to this buffer */
384 	struct qeth_buffer_pool_entry *pool_entry;
385 	struct sk_buff *rx_skb;
386 };
387 
388 struct qeth_qdio_q {
389 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
390 	struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
391 	int next_buf_to_init;
392 };
393 
394 enum qeth_qdio_out_buffer_state {
395 	/* Owned by driver, in order to be filled. */
396 	QETH_QDIO_BUF_EMPTY,
397 	/* Filled by driver; owned by hardware in order to be sent. */
398 	QETH_QDIO_BUF_PRIMED,
399 	/* Identified to be pending in TPQ. */
400 	QETH_QDIO_BUF_PENDING,
401 	/* Found in completion queue. */
402 	QETH_QDIO_BUF_IN_CQ,
403 	/* Handled via transfer pending / completion queue. */
404 	QETH_QDIO_BUF_HANDLED_DELAYED,
405 };
406 
407 struct qeth_qdio_out_buffer {
408 	struct qdio_buffer *buffer;
409 	atomic_t state;
410 	int next_element_to_fill;
411 	unsigned int bytes;
412 	struct sk_buff_head skb_list;
413 	int is_header[QDIO_MAX_ELEMENTS_PER_BUFFER];
414 
415 	struct qeth_qdio_out_q *q;
416 	struct qeth_qdio_out_buffer *next_pending;
417 };
418 
419 struct qeth_card;
420 
421 enum qeth_out_q_states {
422        QETH_OUT_Q_UNLOCKED,
423        QETH_OUT_Q_LOCKED,
424        QETH_OUT_Q_LOCKED_FLUSH,
425 };
426 
427 #define QETH_CARD_STAT_ADD(_c, _stat, _val)	((_c)->stats._stat += (_val))
428 #define QETH_CARD_STAT_INC(_c, _stat)		QETH_CARD_STAT_ADD(_c, _stat, 1)
429 
430 #define QETH_TXQ_STAT_ADD(_q, _stat, _val)	((_q)->stats._stat += (_val))
431 #define QETH_TXQ_STAT_INC(_q, _stat)		QETH_TXQ_STAT_ADD(_q, _stat, 1)
432 
433 struct qeth_card_stats {
434 	u64 rx_bufs;
435 	u64 rx_skb_csum;
436 	u64 rx_sg_skbs;
437 	u64 rx_sg_frags;
438 	u64 rx_sg_alloc_page;
439 
440 	u64 rx_dropped_nomem;
441 	u64 rx_dropped_notsupp;
442 	u64 rx_dropped_runt;
443 
444 	/* rtnl_link_stats64 */
445 	u64 rx_packets;
446 	u64 rx_bytes;
447 	u64 rx_multicast;
448 	u64 rx_length_errors;
449 	u64 rx_frame_errors;
450 	u64 rx_fifo_errors;
451 };
452 
453 struct qeth_out_q_stats {
454 	u64 bufs;
455 	u64 bufs_pack;
456 	u64 buf_elements;
457 	u64 skbs_pack;
458 	u64 skbs_sg;
459 	u64 skbs_csum;
460 	u64 skbs_tso;
461 	u64 skbs_linearized;
462 	u64 skbs_linearized_fail;
463 	u64 tso_bytes;
464 	u64 packing_mode_switch;
465 	u64 stopped;
466 	u64 completion_yield;
467 	u64 completion_timer;
468 
469 	/* rtnl_link_stats64 */
470 	u64 tx_packets;
471 	u64 tx_bytes;
472 	u64 tx_errors;
473 	u64 tx_dropped;
474 };
475 
476 #define QETH_TX_TIMER_USECS		500
477 
478 struct qeth_qdio_out_q {
479 	struct qdio_buffer *qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
480 	struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
481 	struct qdio_outbuf_state *bufstates; /* convenience pointer */
482 	struct qeth_out_q_stats stats;
483 	u8 next_buf_to_fill;
484 	u8 max_elements;
485 	u8 queue_no;
486 	u8 do_pack;
487 	struct qeth_card *card;
488 	atomic_t state;
489 	/*
490 	 * number of buffers that are currently filled (PRIMED)
491 	 * -> these buffers are hardware-owned
492 	 */
493 	atomic_t used_buffers;
494 	/* indicates whether PCI flag must be set (or if one is outstanding) */
495 	atomic_t set_pci_flags_count;
496 	struct napi_struct napi;
497 	struct timer_list timer;
498 	struct qeth_hdr *prev_hdr;
499 	u8 bulk_start;
500 	u8 bulk_count;
501 	u8 bulk_max;
502 };
503 
504 #define qeth_for_each_output_queue(card, q, i)		\
505 	for (i = 0; i < card->qdio.no_out_queues &&	\
506 		    (q = card->qdio.out_qs[i]); i++)
507 
508 #define	qeth_napi_to_out_queue(n) container_of(n, struct qeth_qdio_out_q, napi)
509 
510 static inline void qeth_tx_arm_timer(struct qeth_qdio_out_q *queue)
511 {
512 	if (timer_pending(&queue->timer))
513 		return;
514 	mod_timer(&queue->timer, usecs_to_jiffies(QETH_TX_TIMER_USECS) +
515 				 jiffies);
516 }
517 
518 static inline bool qeth_out_queue_is_full(struct qeth_qdio_out_q *queue)
519 {
520 	return atomic_read(&queue->used_buffers) >= QDIO_MAX_BUFFERS_PER_Q;
521 }
522 
523 static inline bool qeth_out_queue_is_empty(struct qeth_qdio_out_q *queue)
524 {
525 	return atomic_read(&queue->used_buffers) == 0;
526 }
527 
528 struct qeth_qdio_info {
529 	atomic_t state;
530 	/* input */
531 	int no_in_queues;
532 	struct qeth_qdio_q *in_q;
533 	struct qeth_qdio_q *c_q;
534 	struct qeth_qdio_buffer_pool in_buf_pool;
535 	struct qeth_qdio_buffer_pool init_pool;
536 	int in_buf_size;
537 
538 	/* output */
539 	int no_out_queues;
540 	struct qeth_qdio_out_q *out_qs[QETH_MAX_QUEUES];
541 	struct qdio_outbuf_state *out_bufstates;
542 
543 	/* priority queueing */
544 	int do_prio_queueing;
545 	int default_out_queue;
546 };
547 
548 /**
549  *  channel state machine
550  */
551 enum qeth_channel_states {
552 	CH_STATE_UP,
553 	CH_STATE_DOWN,
554 	CH_STATE_HALTED,
555 	CH_STATE_STOPPED,
556 };
557 /**
558  * card state machine
559  */
560 enum qeth_card_states {
561 	CARD_STATE_DOWN,
562 	CARD_STATE_HARDSETUP,
563 	CARD_STATE_SOFTSETUP,
564 };
565 
566 /**
567  * Protocol versions
568  */
569 enum qeth_prot_versions {
570 	QETH_PROT_NONE = 0x0000,
571 	QETH_PROT_IPV4 = 0x0004,
572 	QETH_PROT_IPV6 = 0x0006,
573 };
574 
575 enum qeth_cq {
576 	QETH_CQ_DISABLED = 0,
577 	QETH_CQ_ENABLED = 1,
578 	QETH_CQ_NOTAVAILABLE = 2,
579 };
580 
581 struct qeth_ipato {
582 	bool enabled;
583 	bool invert4;
584 	bool invert6;
585 	struct list_head entries;
586 };
587 
588 struct qeth_channel {
589 	struct ccw_device *ccwdev;
590 	struct qeth_cmd_buffer *active_cmd;
591 	enum qeth_channel_states state;
592 	atomic_t irq_pending;
593 };
594 
595 struct qeth_reply {
596 	int (*callback)(struct qeth_card *card, struct qeth_reply *reply,
597 			unsigned long data);
598 	void *param;
599 };
600 
601 struct qeth_cmd_buffer {
602 	struct list_head list;
603 	struct completion done;
604 	spinlock_t lock;
605 	unsigned int length;
606 	refcount_t ref_count;
607 	struct qeth_channel *channel;
608 	struct qeth_reply reply;
609 	long timeout;
610 	unsigned char *data;
611 	void (*finalize)(struct qeth_card *card, struct qeth_cmd_buffer *iob);
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_cmd(struct qeth_cmd_buffer *iob)
623 {
624 	return (struct qeth_ipa_cmd *)(iob->data + IPA_PDU_HEADER_SIZE);
625 }
626 
627 static inline struct ccw1 *__ccw_from_cmd(struct qeth_cmd_buffer *iob)
628 {
629 	return (struct ccw1 *)(iob->data + ALIGN(iob->length, 8));
630 }
631 
632 static inline bool qeth_trylock_channel(struct qeth_channel *channel)
633 {
634 	return atomic_cmpxchg(&channel->irq_pending, 0, 1) == 0;
635 }
636 
637 /**
638  *  OSA card related definitions
639  */
640 struct qeth_token {
641 	__u32 issuer_rm_w;
642 	__u32 issuer_rm_r;
643 	__u32 cm_filter_w;
644 	__u32 cm_filter_r;
645 	__u32 cm_connection_w;
646 	__u32 cm_connection_r;
647 	__u32 ulp_filter_w;
648 	__u32 ulp_filter_r;
649 	__u32 ulp_connection_w;
650 	__u32 ulp_connection_r;
651 };
652 
653 struct qeth_seqno {
654 	__u32 trans_hdr;
655 	__u32 pdu_hdr;
656 	__u32 pdu_hdr_ack;
657 	__u16 ipa;
658 };
659 
660 struct qeth_card_blkt {
661 	int time_total;
662 	int inter_packet;
663 	int inter_packet_jumbo;
664 };
665 
666 #define QETH_BROADCAST_WITH_ECHO    0x01
667 #define QETH_BROADCAST_WITHOUT_ECHO 0x02
668 #define QETH_LAYER2_MAC_REGISTERED  0x02
669 struct qeth_card_info {
670 	unsigned short unit_addr2;
671 	unsigned short cula;
672 	u8 chpid;
673 	__u16 func_level;
674 	char mcl_level[QETH_MCL_LENGTH + 1];
675 	u8 open_when_online:1;
676 	u8 promisc_mode:1;
677 	u8 use_v1_blkt:1;
678 	u8 is_vm_nic:1;
679 	int mac_bits;
680 	enum qeth_card_types type;
681 	enum qeth_link_types link_type;
682 	int broadcast_capable;
683 	int unique_id;
684 	bool layer_enforced;
685 	struct qeth_card_blkt blkt;
686 	__u32 diagass_support;
687 	__u32 hwtrap;
688 };
689 
690 enum qeth_discipline_id {
691 	QETH_DISCIPLINE_UNDETERMINED = -1,
692 	QETH_DISCIPLINE_LAYER3 = 0,
693 	QETH_DISCIPLINE_LAYER2 = 1,
694 };
695 
696 struct qeth_card_options {
697 	struct qeth_ipa_caps ipa4;
698 	struct qeth_ipa_caps ipa6;
699 	struct qeth_routing_info route4;
700 	struct qeth_routing_info route6;
701 	struct qeth_ipa_caps adp; /* Adapter parameters */
702 	struct qeth_sbp_info sbp; /* SETBRIDGEPORT options */
703 	struct qeth_vnicc_info vnicc; /* VNICC options */
704 	int fake_broadcast;
705 	enum qeth_discipline_id layer;
706 	int rx_sg_cb;
707 	enum qeth_ipa_isolation_modes isolation;
708 	enum qeth_ipa_isolation_modes prev_isolation;
709 	int sniffer;
710 	enum qeth_cq cq;
711 	char hsuid[9];
712 };
713 
714 #define	IS_LAYER2(card)	((card)->options.layer == QETH_DISCIPLINE_LAYER2)
715 #define	IS_LAYER3(card)	((card)->options.layer == QETH_DISCIPLINE_LAYER3)
716 
717 /*
718  * thread bits for qeth_card thread masks
719  */
720 enum qeth_threads {
721 	QETH_RECOVER_THREAD = 1,
722 };
723 
724 struct qeth_osn_info {
725 	int (*assist_cb)(struct net_device *dev, void *data);
726 	int (*data_cb)(struct sk_buff *skb);
727 };
728 
729 struct qeth_discipline {
730 	const struct device_type *devtype;
731 	int (*process_rx_buffer)(struct qeth_card *card, int budget, int *done);
732 	int (*recover)(void *ptr);
733 	int (*setup) (struct ccwgroup_device *);
734 	void (*remove) (struct ccwgroup_device *);
735 	int (*set_online) (struct ccwgroup_device *);
736 	int (*set_offline) (struct ccwgroup_device *);
737 	int (*do_ioctl)(struct net_device *dev, struct ifreq *rq, int cmd);
738 	int (*control_event_handler)(struct qeth_card *card,
739 					struct qeth_ipa_cmd *cmd);
740 };
741 
742 enum qeth_addr_disposition {
743 	QETH_DISP_ADDR_DELETE = 0,
744 	QETH_DISP_ADDR_DO_NOTHING = 1,
745 	QETH_DISP_ADDR_ADD = 2,
746 };
747 
748 struct qeth_rx {
749 	int b_count;
750 	int b_index;
751 	struct qdio_buffer_element *b_element;
752 	int e_offset;
753 	int qdio_err;
754 };
755 
756 struct carrier_info {
757 	__u8  card_type;
758 	__u16 port_mode;
759 	__u32 port_speed;
760 };
761 
762 struct qeth_switch_info {
763 	__u32 capabilities;
764 	__u32 settings;
765 };
766 
767 #define QETH_NAPI_WEIGHT NAPI_POLL_WEIGHT
768 
769 struct qeth_card {
770 	enum qeth_card_states state;
771 	spinlock_t lock;
772 	struct ccwgroup_device *gdev;
773 	struct qeth_cmd_buffer *read_cmd;
774 	struct qeth_channel read;
775 	struct qeth_channel write;
776 	struct qeth_channel data;
777 
778 	struct net_device *dev;
779 	struct qeth_card_stats stats;
780 	struct qeth_card_info info;
781 	struct qeth_token token;
782 	struct qeth_seqno seqno;
783 	struct qeth_card_options options;
784 
785 	struct workqueue_struct *event_wq;
786 	struct workqueue_struct *cmd_wq;
787 	wait_queue_head_t wait_q;
788 	DECLARE_HASHTABLE(mac_htable, 4);
789 	DECLARE_HASHTABLE(ip_htable, 4);
790 	struct mutex ip_lock;
791 	DECLARE_HASHTABLE(ip_mc_htable, 4);
792 	struct work_struct rx_mode_work;
793 	struct work_struct kernel_thread_starter;
794 	spinlock_t thread_mask_lock;
795 	unsigned long thread_start_mask;
796 	unsigned long thread_allowed_mask;
797 	unsigned long thread_running_mask;
798 	struct qeth_ipato ipato;
799 	struct list_head cmd_waiter_list;
800 	/* QDIO buffer handling */
801 	struct qeth_qdio_info qdio;
802 	int read_or_write_problem;
803 	struct qeth_osn_info osn_info;
804 	struct qeth_discipline *discipline;
805 	atomic_t force_alloc_skb;
806 	struct service_level qeth_service_level;
807 	struct qdio_ssqd_desc ssqd;
808 	debug_info_t *debug;
809 	struct mutex sbp_lock;
810 	struct mutex conf_mutex;
811 	struct mutex discipline_mutex;
812 	struct napi_struct napi;
813 	struct qeth_rx rx;
814 	struct delayed_work buffer_reclaim_work;
815 	int reclaim_index;
816 	struct work_struct close_dev_work;
817 };
818 
819 static inline bool qeth_card_hw_is_reachable(struct qeth_card *card)
820 {
821 	return card->state == CARD_STATE_SOFTSETUP;
822 }
823 
824 static inline void qeth_unlock_channel(struct qeth_card *card,
825 				       struct qeth_channel *channel)
826 {
827 	atomic_set(&channel->irq_pending, 0);
828 	wake_up(&card->wait_q);
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 bool qeth_iqd_is_mcast_queue(struct qeth_card *card,
857 					   struct qeth_qdio_out_q *queue)
858 {
859 	return qeth_iqd_translate_txq(card->dev, queue->queue_no) ==
860 	       QETH_IQD_MCAST_TXQ;
861 }
862 
863 static inline void qeth_scrub_qdio_buffer(struct qdio_buffer *buf,
864 					  unsigned int elements)
865 {
866 	unsigned int i;
867 
868 	for (i = 0; i < elements; i++)
869 		memset(&buf->element[i], 0, sizeof(struct qdio_buffer_element));
870 	buf->element[14].sflags = 0;
871 	buf->element[15].sflags = 0;
872 }
873 
874 /**
875  * qeth_get_elements_for_range() -	find number of SBALEs to cover range.
876  * @start:				Start of the address range.
877  * @end:				Address after the end of the range.
878  *
879  * Returns the number of pages, and thus QDIO buffer elements, needed to cover
880  * the specified address range.
881  */
882 static inline int qeth_get_elements_for_range(addr_t start, addr_t end)
883 {
884 	return PFN_UP(end) - PFN_DOWN(start);
885 }
886 
887 static inline int qeth_get_ip_version(struct sk_buff *skb)
888 {
889 	struct vlan_ethhdr *veth = vlan_eth_hdr(skb);
890 	__be16 prot = veth->h_vlan_proto;
891 
892 	if (prot == htons(ETH_P_8021Q))
893 		prot = veth->h_vlan_encapsulated_proto;
894 
895 	switch (prot) {
896 	case htons(ETH_P_IPV6):
897 		return 6;
898 	case htons(ETH_P_IP):
899 		return 4;
900 	default:
901 		return 0;
902 	}
903 }
904 
905 static inline int qeth_get_ether_cast_type(struct sk_buff *skb)
906 {
907 	u8 *addr = eth_hdr(skb)->h_dest;
908 
909 	if (is_multicast_ether_addr(addr))
910 		return is_broadcast_ether_addr(addr) ? RTN_BROADCAST :
911 						       RTN_MULTICAST;
912 	return RTN_UNICAST;
913 }
914 
915 static inline struct dst_entry *qeth_dst_check_rcu(struct sk_buff *skb, int ipv)
916 {
917 	struct dst_entry *dst = skb_dst(skb);
918 	struct rt6_info *rt;
919 
920 	rt = (struct rt6_info *) dst;
921 	if (dst)
922 		dst = dst_check(dst, (ipv == 6) ? rt6_get_cookie(rt) : 0);
923 	return dst;
924 }
925 
926 static inline void qeth_rx_csum(struct qeth_card *card, struct sk_buff *skb,
927 				u8 flags)
928 {
929 	if ((card->dev->features & NETIF_F_RXCSUM) &&
930 	    (flags & QETH_HDR_EXT_CSUM_TRANSP_REQ)) {
931 		skb->ip_summed = CHECKSUM_UNNECESSARY;
932 		QETH_CARD_STAT_INC(card, rx_skb_csum);
933 	} else {
934 		skb->ip_summed = CHECKSUM_NONE;
935 	}
936 }
937 
938 static inline void qeth_tx_csum(struct sk_buff *skb, u8 *flags, int ipv)
939 {
940 	*flags |= QETH_HDR_EXT_CSUM_TRANSP_REQ;
941 	if ((ipv == 4 && ip_hdr(skb)->protocol == IPPROTO_UDP) ||
942 	    (ipv == 6 && ipv6_hdr(skb)->nexthdr == IPPROTO_UDP))
943 		*flags |= QETH_HDR_EXT_UDP;
944 }
945 
946 static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
947 		struct qeth_buffer_pool_entry *entry)
948 {
949 	list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
950 }
951 
952 static inline int qeth_is_diagass_supported(struct qeth_card *card,
953 		enum qeth_diags_cmds cmd)
954 {
955 	return card->info.diagass_support & (__u32)cmd;
956 }
957 
958 int qeth_send_simple_setassparms_prot(struct qeth_card *card,
959 				      enum qeth_ipa_funcs ipa_func,
960 				      u16 cmd_code, u32 *data,
961 				      enum qeth_prot_versions prot);
962 /* IPv4 variant */
963 static inline int qeth_send_simple_setassparms(struct qeth_card *card,
964 					       enum qeth_ipa_funcs ipa_func,
965 					       u16 cmd_code, u32 *data)
966 {
967 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
968 						 data, QETH_PROT_IPV4);
969 }
970 
971 static inline int qeth_send_simple_setassparms_v6(struct qeth_card *card,
972 						  enum qeth_ipa_funcs ipa_func,
973 						  u16 cmd_code, u32 *data)
974 {
975 	return qeth_send_simple_setassparms_prot(card, ipa_func, cmd_code,
976 						 data, QETH_PROT_IPV6);
977 }
978 
979 int qeth_get_priority_queue(struct qeth_card *card, struct sk_buff *skb);
980 
981 extern struct qeth_discipline qeth_l2_discipline;
982 extern struct qeth_discipline qeth_l3_discipline;
983 extern const struct ethtool_ops qeth_ethtool_ops;
984 extern const struct ethtool_ops qeth_osn_ethtool_ops;
985 extern const struct attribute_group *qeth_generic_attr_groups[];
986 extern const struct attribute_group *qeth_osn_attr_groups[];
987 extern const struct attribute_group qeth_device_attr_group;
988 extern const struct attribute_group qeth_device_blkt_group;
989 extern const struct device_type qeth_generic_devtype;
990 
991 const char *qeth_get_cardname_short(struct qeth_card *);
992 int qeth_realloc_buffer_pool(struct qeth_card *, int);
993 int qeth_core_load_discipline(struct qeth_card *, enum qeth_discipline_id);
994 void qeth_core_free_discipline(struct qeth_card *);
995 
996 /* exports for qeth discipline device drivers */
997 extern struct kmem_cache *qeth_core_header_cache;
998 extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
999 
1000 struct net_device *qeth_clone_netdev(struct net_device *orig);
1001 struct qeth_card *qeth_get_card_by_busid(char *bus_id);
1002 void qeth_set_allowed_threads(struct qeth_card *, unsigned long , int);
1003 int qeth_threads_running(struct qeth_card *, unsigned long);
1004 int qeth_do_run_thread(struct qeth_card *, unsigned long);
1005 void qeth_clear_thread_start_bit(struct qeth_card *, unsigned long);
1006 void qeth_clear_thread_running_bit(struct qeth_card *, unsigned long);
1007 int qeth_core_hardsetup_card(struct qeth_card *card, bool *carrier_ok);
1008 int qeth_stop_channel(struct qeth_channel *channel);
1009 
1010 void qeth_print_status_message(struct qeth_card *);
1011 int qeth_init_qdio_queues(struct qeth_card *);
1012 int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
1013 		  int (*reply_cb)
1014 		  (struct qeth_card *, struct qeth_reply *, unsigned long),
1015 		  void *);
1016 struct qeth_cmd_buffer *qeth_ipa_alloc_cmd(struct qeth_card *card,
1017 					   enum qeth_ipa_cmds cmd_code,
1018 					   enum qeth_prot_versions prot,
1019 					   unsigned int data_length);
1020 struct qeth_cmd_buffer *qeth_alloc_cmd(struct qeth_channel *channel,
1021 				       unsigned int length, unsigned int ccws,
1022 				       long timeout);
1023 struct qeth_cmd_buffer *qeth_get_setassparms_cmd(struct qeth_card *card,
1024 						 enum qeth_ipa_funcs ipa_func,
1025 						 u16 cmd_code,
1026 						 unsigned int data_length,
1027 						 enum qeth_prot_versions prot);
1028 struct qeth_cmd_buffer *qeth_get_diag_cmd(struct qeth_card *card,
1029 					  enum qeth_diags_cmds sub_cmd,
1030 					  unsigned int data_length);
1031 void qeth_notify_cmd(struct qeth_cmd_buffer *iob, int reason);
1032 void qeth_put_cmd(struct qeth_cmd_buffer *iob);
1033 
1034 struct sk_buff *qeth_core_get_next_skb(struct qeth_card *,
1035 		struct qeth_qdio_buffer *, struct qdio_buffer_element **, int *,
1036 		struct qeth_hdr **);
1037 void qeth_schedule_recovery(struct qeth_card *);
1038 int qeth_poll(struct napi_struct *napi, int budget);
1039 void qeth_clear_ipacmd_list(struct qeth_card *);
1040 int qeth_qdio_clear_card(struct qeth_card *, int);
1041 void qeth_clear_working_pool_list(struct qeth_card *);
1042 void qeth_drain_output_queues(struct qeth_card *card);
1043 void qeth_setadp_promisc_mode(struct qeth_card *card, bool enable);
1044 int qeth_setadpparms_change_macaddr(struct qeth_card *);
1045 void qeth_tx_timeout(struct net_device *, unsigned int txqueue);
1046 void qeth_prepare_ipa_cmd(struct qeth_card *card, struct qeth_cmd_buffer *iob,
1047 			  u16 cmd_length);
1048 int qeth_query_switch_attributes(struct qeth_card *card,
1049 				  struct qeth_switch_info *sw_info);
1050 int qeth_query_card_info(struct qeth_card *card,
1051 			 struct carrier_info *carrier_info);
1052 unsigned int qeth_count_elements(struct sk_buff *skb, unsigned int data_offset);
1053 int qeth_do_send_packet(struct qeth_card *card, struct qeth_qdio_out_q *queue,
1054 			struct sk_buff *skb, struct qeth_hdr *hdr,
1055 			unsigned int offset, unsigned int hd_len,
1056 			int elements_needed);
1057 int qeth_do_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1058 void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
1059 int qeth_set_access_ctrl_online(struct qeth_card *card, int fallback);
1060 int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
1061 int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
1062 void qeth_trace_features(struct qeth_card *);
1063 int qeth_setassparms_cb(struct qeth_card *, struct qeth_reply *, unsigned long);
1064 int qeth_set_features(struct net_device *, netdev_features_t);
1065 void qeth_enable_hw_features(struct net_device *dev);
1066 netdev_features_t qeth_fix_features(struct net_device *, netdev_features_t);
1067 netdev_features_t qeth_features_check(struct sk_buff *skb,
1068 				      struct net_device *dev,
1069 				      netdev_features_t features);
1070 void qeth_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats);
1071 u16 qeth_iqd_select_queue(struct net_device *dev, struct sk_buff *skb,
1072 			  u8 cast_type, struct net_device *sb_dev);
1073 int qeth_open(struct net_device *dev);
1074 int qeth_stop(struct net_device *dev);
1075 
1076 int qeth_vm_request_mac(struct qeth_card *card);
1077 int qeth_xmit(struct qeth_card *card, struct sk_buff *skb,
1078 	      struct qeth_qdio_out_q *queue, int ipv,
1079 	      void (*fill_header)(struct qeth_qdio_out_q *queue,
1080 				  struct qeth_hdr *hdr, struct sk_buff *skb,
1081 				  int ipv, unsigned int data_len));
1082 
1083 /* exports for OSN */
1084 int qeth_osn_assist(struct net_device *, void *, int);
1085 int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
1086 		int (*assist_cb)(struct net_device *, void *),
1087 		int (*data_cb)(struct sk_buff *));
1088 void qeth_osn_deregister(struct net_device *);
1089 
1090 #endif /* __QETH_CORE_H__ */
1091