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