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