s390/ap: Fix wrong or missing comments
[linux-3.10.git] / drivers / s390 / net / qeth_core.h
1 /*
2  *  drivers/s390/net/qeth_core.h
3  *
4  *    Copyright IBM Corp. 2007
5  *    Author(s): Utz Bacher <utz.bacher@de.ibm.com>,
6  *               Frank Pavlic <fpavlic@de.ibm.com>,
7  *               Thomas Spatzier <tspat@de.ibm.com>,
8  *               Frank Blaschka <frank.blaschka@de.ibm.com>
9  */
10
11 #ifndef __QETH_CORE_H__
12 #define __QETH_CORE_H__
13
14 #include <linux/if.h>
15 #include <linux/if_arp.h>
16 #include <linux/if_tr.h>
17 #include <linux/trdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/if_vlan.h>
20 #include <linux/ctype.h>
21 #include <linux/in6.h>
22 #include <linux/bitops.h>
23 #include <linux/seq_file.h>
24 #include <linux/ethtool.h>
25
26 #include <net/ipv6.h>
27 #include <net/if_inet6.h>
28 #include <net/addrconf.h>
29
30 #include <asm/debug.h>
31 #include <asm/qdio.h>
32 #include <asm/ccwdev.h>
33 #include <asm/ccwgroup.h>
34 #include <asm/sysinfo.h>
35
36 #include "qeth_core_mpc.h"
37
38 /**
39  * Debug Facility stuff
40  */
41 enum qeth_dbf_names {
42         QETH_DBF_SETUP,
43         QETH_DBF_MSG,
44         QETH_DBF_CTRL,
45         QETH_DBF_INFOS  /* must be last element */
46 };
47
48 struct qeth_dbf_info {
49         char name[DEBUG_MAX_NAME_LEN];
50         int pages;
51         int areas;
52         int len;
53         int level;
54         struct debug_view *view;
55         debug_info_t *id;
56 };
57
58 #define QETH_DBF_CTRL_LEN 256
59
60 #define QETH_DBF_TEXT(name, level, text) \
61         debug_text_event(qeth_dbf[QETH_DBF_##name].id, level, text)
62
63 #define QETH_DBF_HEX(name, level, addr, len) \
64         debug_event(qeth_dbf[QETH_DBF_##name].id, level, (void *)(addr), len)
65
66 #define QETH_DBF_MESSAGE(level, text...) \
67         debug_sprintf_event(qeth_dbf[QETH_DBF_MSG].id, level, text)
68
69 #define QETH_DBF_TEXT_(name, level, text...) \
70         qeth_dbf_longtext(qeth_dbf[QETH_DBF_##name].id, level, text)
71
72 #define QETH_CARD_TEXT(card, level, text) \
73         debug_text_event(card->debug, level, text)
74
75 #define QETH_CARD_HEX(card, level, addr, len) \
76         debug_event(card->debug, level, (void *)(addr), len)
77
78 #define QETH_CARD_MESSAGE(card, text...) \
79         debug_sprintf_event(card->debug, level, text)
80
81 #define QETH_CARD_TEXT_(card, level, text...) \
82         qeth_dbf_longtext(card->debug, level, text)
83
84 #define SENSE_COMMAND_REJECT_BYTE 0
85 #define SENSE_COMMAND_REJECT_FLAG 0x80
86 #define SENSE_RESETTING_EVENT_BYTE 1
87 #define SENSE_RESETTING_EVENT_FLAG 0x80
88
89 /*
90  * Common IO related definitions
91  */
92 #define CARD_RDEV(card) card->read.ccwdev
93 #define CARD_WDEV(card) card->write.ccwdev
94 #define CARD_DDEV(card) card->data.ccwdev
95 #define CARD_BUS_ID(card) dev_name(&card->gdev->dev)
96 #define CARD_RDEV_ID(card) dev_name(&card->read.ccwdev->dev)
97 #define CARD_WDEV_ID(card) dev_name(&card->write.ccwdev->dev)
98 #define CARD_DDEV_ID(card) dev_name(&card->data.ccwdev->dev)
99 #define CHANNEL_ID(channel) dev_name(&channel->ccwdev->dev)
100
101 /**
102  * card stuff
103  */
104 struct qeth_perf_stats {
105         unsigned int bufs_rec;
106         unsigned int bufs_sent;
107
108         unsigned int skbs_sent_pack;
109         unsigned int bufs_sent_pack;
110
111         unsigned int sc_dp_p;
112         unsigned int sc_p_dp;
113         /* qdio_cq_handler: number of times called, time spent in */
114         __u64 cq_start_time;
115         unsigned int cq_cnt;
116         unsigned int cq_time;
117         /* qdio_input_handler: number of times called, time spent in */
118         __u64 inbound_start_time;
119         unsigned int inbound_cnt;
120         unsigned int inbound_time;
121         /* qeth_send_packet: number of times called, time spent in */
122         __u64 outbound_start_time;
123         unsigned int outbound_cnt;
124         unsigned int outbound_time;
125         /* qdio_output_handler: number of times called, time spent in */
126         __u64 outbound_handler_start_time;
127         unsigned int outbound_handler_cnt;
128         unsigned int outbound_handler_time;
129         /* number of calls to and time spent in do_QDIO for inbound queue */
130         __u64 inbound_do_qdio_start_time;
131         unsigned int inbound_do_qdio_cnt;
132         unsigned int inbound_do_qdio_time;
133         /* number of calls to and time spent in do_QDIO for outbound queues */
134         __u64 outbound_do_qdio_start_time;
135         unsigned int outbound_do_qdio_cnt;
136         unsigned int outbound_do_qdio_time;
137         unsigned int large_send_bytes;
138         unsigned int large_send_cnt;
139         unsigned int sg_skbs_sent;
140         unsigned int sg_frags_sent;
141         /* initial values when measuring starts */
142         unsigned long initial_rx_packets;
143         unsigned long initial_tx_packets;
144         /* inbound scatter gather data */
145         unsigned int sg_skbs_rx;
146         unsigned int sg_frags_rx;
147         unsigned int sg_alloc_page_rx;
148         unsigned int tx_csum;
149         unsigned int tx_lin;
150 };
151
152 /* Routing stuff */
153 struct qeth_routing_info {
154         enum qeth_routing_types type;
155 };
156
157 /* IPA stuff */
158 struct qeth_ipa_info {
159         __u32 supported_funcs;
160         __u32 enabled_funcs;
161 };
162
163 static inline int qeth_is_ipa_supported(struct qeth_ipa_info *ipa,
164                 enum qeth_ipa_funcs func)
165 {
166         return (ipa->supported_funcs & func);
167 }
168
169 static inline int qeth_is_ipa_enabled(struct qeth_ipa_info *ipa,
170                 enum qeth_ipa_funcs func)
171 {
172         return (ipa->supported_funcs & ipa->enabled_funcs & func);
173 }
174
175 #define qeth_adp_supported(c, f) \
176         qeth_is_ipa_supported(&c->options.adp, f)
177 #define qeth_adp_enabled(c, f) \
178         qeth_is_ipa_enabled(&c->options.adp, f)
179 #define qeth_is_supported(c, f) \
180         qeth_is_ipa_supported(&c->options.ipa4, f)
181 #define qeth_is_enabled(c, f) \
182         qeth_is_ipa_enabled(&c->options.ipa4, f)
183 #define qeth_is_supported6(c, f) \
184         qeth_is_ipa_supported(&c->options.ipa6, f)
185 #define qeth_is_enabled6(c, f) \
186         qeth_is_ipa_enabled(&c->options.ipa6, f)
187 #define qeth_is_ipafunc_supported(c, prot, f) \
188          ((prot == QETH_PROT_IPV6) ? \
189                 qeth_is_supported6(c, f) : qeth_is_supported(c, f))
190 #define qeth_is_ipafunc_enabled(c, prot, f) \
191          ((prot == QETH_PROT_IPV6) ? \
192                 qeth_is_enabled6(c, f) : qeth_is_enabled(c, f))
193
194 #define QETH_IDX_FUNC_LEVEL_OSD          0x0101
195 #define QETH_IDX_FUNC_LEVEL_IQD          0x4108
196
197 #define QETH_MODELLIST_ARRAY \
198         {{0x1731, 0x01, 0x1732, QETH_CARD_TYPE_OSD, QETH_MAX_QUEUES, 0}, \
199          {0x1731, 0x05, 0x1732, QETH_CARD_TYPE_IQD, QETH_MAX_QUEUES, 0x103}, \
200          {0x1731, 0x06, 0x1732, QETH_CARD_TYPE_OSN, QETH_MAX_QUEUES, 0}, \
201          {0x1731, 0x02, 0x1732, QETH_CARD_TYPE_OSM, QETH_MAX_QUEUES, 0}, \
202          {0x1731, 0x02, 0x1732, QETH_CARD_TYPE_OSX, QETH_MAX_QUEUES, 0}, \
203          {0, 0, 0, 0, 0, 0} }
204 #define QETH_CU_TYPE_IND        0
205 #define QETH_CU_MODEL_IND       1
206 #define QETH_DEV_TYPE_IND       2
207 #define QETH_DEV_MODEL_IND      3
208 #define QETH_QUEUE_NO_IND       4
209 #define QETH_MULTICAST_IND      5
210
211 #define QETH_REAL_CARD          1
212 #define QETH_VLAN_CARD          2
213 #define QETH_BUFSIZE            4096
214
215 /**
216  * some more defs
217  */
218 #define QETH_TX_TIMEOUT         100 * HZ
219 #define QETH_RCD_TIMEOUT        60 * HZ
220 #define QETH_RECLAIM_WORK_TIME  HZ
221 #define QETH_HEADER_SIZE        32
222 #define QETH_MAX_PORTNO         15
223
224 /*IPv6 address autoconfiguration stuff*/
225 #define UNIQUE_ID_IF_CREATE_ADDR_FAILED 0xfffe
226 #define UNIQUE_ID_NOT_BY_CARD           0x10000
227
228 /*****************************************************************************/
229 /* QDIO queue and buffer handling                                            */
230 /*****************************************************************************/
231 #define QETH_MAX_QUEUES 4
232 #define QETH_IN_BUF_SIZE_DEFAULT 65536
233 #define QETH_IN_BUF_COUNT_DEFAULT 64
234 #define QETH_IN_BUF_COUNT_HSDEFAULT 128
235 #define QETH_IN_BUF_COUNT_MIN 8
236 #define QETH_IN_BUF_COUNT_MAX 128
237 #define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
238 #define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
239                  ((card)->qdio.in_buf_pool.buf_count / 2)
240
241 /* buffers we have to be behind before we get a PCI */
242 #define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
243 /*enqueued free buffers left before we get a PCI*/
244 #define QETH_PCI_THRESHOLD_B(card) 0
245 /*not used unless the microcode gets patched*/
246 #define QETH_PCI_TIMER_VALUE(card) 3
247
248 /* priority queing */
249 #define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
250 #define QETH_DEFAULT_QUEUE    2
251 #define QETH_NO_PRIO_QUEUEING 0
252 #define QETH_PRIO_Q_ING_PREC  1
253 #define QETH_PRIO_Q_ING_TOS   2
254 #define IP_TOS_LOWDELAY 0x10
255 #define IP_TOS_HIGHTHROUGHPUT 0x08
256 #define IP_TOS_HIGHRELIABILITY 0x04
257 #define IP_TOS_NOTIMPORTANT 0x02
258
259 /* Packing */
260 #define QETH_LOW_WATERMARK_PACK  2
261 #define QETH_HIGH_WATERMARK_PACK 5
262 #define QETH_WATERMARK_PACK_FUZZ 1
263
264 #define QETH_IP_HEADER_SIZE 40
265
266 /* large receive scatter gather copy break */
267 #define QETH_RX_SG_CB (PAGE_SIZE >> 1)
268 #define QETH_RX_PULL_LEN 256
269
270 struct qeth_hdr_layer3 {
271         __u8  id;
272         __u8  flags;
273         __u16 inbound_checksum; /*TSO:__u16 seqno */
274         __u32 token;            /*TSO: __u32 reserved */
275         __u16 length;
276         __u8  vlan_prio;
277         __u8  ext_flags;
278         __u16 vlan_id;
279         __u16 frame_offset;
280         __u8  dest_addr[16];
281 } __attribute__ ((packed));
282
283 struct qeth_hdr_layer2 {
284         __u8 id;
285         __u8 flags[3];
286         __u8 port_no;
287         __u8 hdr_length;
288         __u16 pkt_length;
289         __u16 seq_no;
290         __u16 vlan_id;
291         __u32 reserved;
292         __u8 reserved2[16];
293 } __attribute__ ((packed));
294
295 struct qeth_hdr_osn {
296         __u8 id;
297         __u8 reserved;
298         __u16 seq_no;
299         __u16 reserved2;
300         __u16 control_flags;
301         __u16 pdu_length;
302         __u8 reserved3[18];
303         __u32 ccid;
304 } __attribute__ ((packed));
305
306 struct qeth_hdr {
307         union {
308                 struct qeth_hdr_layer2 l2;
309                 struct qeth_hdr_layer3 l3;
310                 struct qeth_hdr_osn    osn;
311         } hdr;
312 } __attribute__ ((packed));
313
314 /*TCP Segmentation Offload header*/
315 struct qeth_hdr_ext_tso {
316         __u16 hdr_tot_len;
317         __u8  imb_hdr_no;
318         __u8  reserved;
319         __u8  hdr_type;
320         __u8  hdr_version;
321         __u16 hdr_len;
322         __u32 payload_len;
323         __u16 mss;
324         __u16 dg_hdr_len;
325         __u8  padding[16];
326 } __attribute__ ((packed));
327
328 struct qeth_hdr_tso {
329         struct qeth_hdr hdr;    /*hdr->hdr.l3.xxx*/
330         struct qeth_hdr_ext_tso ext;
331 } __attribute__ ((packed));
332
333
334 /* flags for qeth_hdr.flags */
335 #define QETH_HDR_PASSTHRU 0x10
336 #define QETH_HDR_IPV6     0x80
337 #define QETH_HDR_CAST_MASK 0x07
338 enum qeth_cast_flags {
339         QETH_CAST_UNICAST   = 0x06,
340         QETH_CAST_MULTICAST = 0x04,
341         QETH_CAST_BROADCAST = 0x05,
342         QETH_CAST_ANYCAST   = 0x07,
343         QETH_CAST_NOCAST    = 0x00,
344 };
345
346 enum qeth_layer2_frame_flags {
347         QETH_LAYER2_FLAG_MULTICAST = 0x01,
348         QETH_LAYER2_FLAG_BROADCAST = 0x02,
349         QETH_LAYER2_FLAG_UNICAST   = 0x04,
350         QETH_LAYER2_FLAG_VLAN      = 0x10,
351 };
352
353 enum qeth_header_ids {
354         QETH_HEADER_TYPE_LAYER3 = 0x01,
355         QETH_HEADER_TYPE_LAYER2 = 0x02,
356         QETH_HEADER_TYPE_TSO    = 0x03,
357         QETH_HEADER_TYPE_OSN    = 0x04,
358 };
359 /* flags for qeth_hdr.ext_flags */
360 #define QETH_HDR_EXT_VLAN_FRAME       0x01
361 #define QETH_HDR_EXT_TOKEN_ID         0x02
362 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
363 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
364 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
365 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
366 #define QETH_HDR_EXT_UDP              0x40 /*bit off for TCP*/
367
368 static inline int qeth_is_last_sbale(struct qdio_buffer_element *sbale)
369 {
370         return (sbale->eflags & SBAL_EFLAGS_LAST_ENTRY);
371 }
372
373 enum qeth_qdio_buffer_states {
374         /*
375          * inbound: read out by driver; owned by hardware in order to be filled
376          * outbound: owned by driver in order to be filled
377          */
378         QETH_QDIO_BUF_EMPTY,
379         /*
380          * inbound: filled by hardware; owned by driver in order to be read out
381          * outbound: filled by driver; owned by hardware in order to be sent
382          */
383         QETH_QDIO_BUF_PRIMED,
384         /*
385          * inbound: not applicable
386          * outbound: identified to be pending in TPQ
387          */
388         QETH_QDIO_BUF_PENDING,
389         /*
390          * inbound: not applicable
391          * outbound: found in completion queue
392          */
393         QETH_QDIO_BUF_IN_CQ,
394         /*
395          * inbound: not applicable
396          * outbound: handled via transfer pending / completion queue
397          */
398         QETH_QDIO_BUF_HANDLED_DELAYED,
399 };
400
401 enum qeth_qdio_info_states {
402         QETH_QDIO_UNINITIALIZED,
403         QETH_QDIO_ALLOCATED,
404         QETH_QDIO_ESTABLISHED,
405         QETH_QDIO_CLEANING
406 };
407
408 struct qeth_buffer_pool_entry {
409         struct list_head list;
410         struct list_head init_list;
411         void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
412 };
413
414 struct qeth_qdio_buffer_pool {
415         struct list_head entry_list;
416         int buf_count;
417 };
418
419 struct qeth_qdio_buffer {
420         struct qdio_buffer *buffer;
421         /* the buffer pool entry currently associated to this buffer */
422         struct qeth_buffer_pool_entry *pool_entry;
423         struct sk_buff *rx_skb;
424 };
425
426 struct qeth_qdio_q {
427         struct qdio_buffer qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
428         struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
429         int next_buf_to_init;
430 } __attribute__ ((aligned(256)));
431
432 struct qeth_qdio_out_buffer {
433         struct qdio_buffer *buffer;
434         atomic_t state;
435         int next_element_to_fill;
436         struct sk_buff_head skb_list;
437         int is_header[16];
438
439         struct qaob *aob;
440         struct qeth_qdio_out_q *q;
441         struct qeth_qdio_out_buffer *next_pending;
442 };
443
444 struct qeth_card;
445
446 enum qeth_out_q_states {
447        QETH_OUT_Q_UNLOCKED,
448        QETH_OUT_Q_LOCKED,
449        QETH_OUT_Q_LOCKED_FLUSH,
450 };
451
452 struct qeth_qdio_out_q {
453         struct qdio_buffer qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
454         struct qeth_qdio_out_buffer *bufs[QDIO_MAX_BUFFERS_PER_Q];
455         struct qdio_outbuf_state *bufstates; /* convenience pointer */
456         int queue_no;
457         struct qeth_card *card;
458         atomic_t state;
459         int do_pack;
460         /*
461          * index of buffer to be filled by driver; state EMPTY or PACKING
462          */
463         int next_buf_to_fill;
464         /*
465          * number of buffers that are currently filled (PRIMED)
466          * -> these buffers are hardware-owned
467          */
468         atomic_t used_buffers;
469         /* indicates whether PCI flag must be set (or if one is outstanding) */
470         atomic_t set_pci_flags_count;
471 } __attribute__ ((aligned(256)));
472
473 struct qeth_qdio_info {
474         atomic_t state;
475         /* input */
476         int no_in_queues;
477         struct qeth_qdio_q *in_q;
478         struct qeth_qdio_q *c_q;
479         struct qeth_qdio_buffer_pool in_buf_pool;
480         struct qeth_qdio_buffer_pool init_pool;
481         int in_buf_size;
482
483         /* output */
484         int no_out_queues;
485         struct qeth_qdio_out_q **out_qs;
486         struct qdio_outbuf_state *out_bufstates;
487
488         /* priority queueing */
489         int do_prio_queueing;
490         int default_out_queue;
491 };
492
493 enum qeth_send_errors {
494         QETH_SEND_ERROR_NONE,
495         QETH_SEND_ERROR_LINK_FAILURE,
496         QETH_SEND_ERROR_RETRY,
497         QETH_SEND_ERROR_KICK_IT,
498 };
499
500 #define QETH_ETH_MAC_V4      0x0100 /* like v4 */
501 #define QETH_ETH_MAC_V6      0x3333 /* like v6 */
502 /* tr mc mac is longer, but that will be enough to detect mc frames */
503 #define QETH_TR_MAC_NC       0xc000 /* non-canonical */
504 #define QETH_TR_MAC_C        0x0300 /* canonical */
505
506 #define DEFAULT_ADD_HHLEN 0
507 #define MAX_ADD_HHLEN 1024
508
509 /**
510  * buffer stuff for read channel
511  */
512 #define QETH_CMD_BUFFER_NO      8
513
514 /**
515  *  channel state machine
516  */
517 enum qeth_channel_states {
518         CH_STATE_UP,
519         CH_STATE_DOWN,
520         CH_STATE_ACTIVATING,
521         CH_STATE_HALTED,
522         CH_STATE_STOPPED,
523         CH_STATE_RCD,
524         CH_STATE_RCD_DONE,
525 };
526 /**
527  * card state machine
528  */
529 enum qeth_card_states {
530         CARD_STATE_DOWN,
531         CARD_STATE_HARDSETUP,
532         CARD_STATE_SOFTSETUP,
533         CARD_STATE_UP,
534         CARD_STATE_RECOVER,
535 };
536
537 /**
538  * Protocol versions
539  */
540 enum qeth_prot_versions {
541         QETH_PROT_IPV4 = 0x0004,
542         QETH_PROT_IPV6 = 0x0006,
543 };
544
545 enum qeth_ip_types {
546         QETH_IP_TYPE_NORMAL,
547         QETH_IP_TYPE_VIPA,
548         QETH_IP_TYPE_RXIP,
549         QETH_IP_TYPE_DEL_ALL_MC,
550 };
551
552 enum qeth_cmd_buffer_state {
553         BUF_STATE_FREE,
554         BUF_STATE_LOCKED,
555         BUF_STATE_PROCESSED,
556 };
557
558 enum qeth_cq {
559         QETH_CQ_DISABLED = 0,
560         QETH_CQ_ENABLED = 1,
561         QETH_CQ_NOTAVAILABLE = 2,
562 };
563
564 struct qeth_ipato {
565         int enabled;
566         int invert4;
567         int invert6;
568         struct list_head entries;
569 };
570
571 struct qeth_channel;
572
573 struct qeth_cmd_buffer {
574         enum qeth_cmd_buffer_state state;
575         struct qeth_channel *channel;
576         unsigned char *data;
577         int rc;
578         void (*callback) (struct qeth_channel *, struct qeth_cmd_buffer *);
579 };
580
581 /**
582  * definition of a qeth channel, used for read and write
583  */
584 struct qeth_channel {
585         enum qeth_channel_states state;
586         struct ccw1 ccw;
587         spinlock_t iob_lock;
588         wait_queue_head_t wait_q;
589         struct tasklet_struct irq_tasklet;
590         struct ccw_device *ccwdev;
591 /*command buffer for control data*/
592         struct qeth_cmd_buffer iob[QETH_CMD_BUFFER_NO];
593         atomic_t irq_pending;
594         int io_buf_no;
595         int buf_no;
596 };
597
598 /**
599  *  OSA card related definitions
600  */
601 struct qeth_token {
602         __u32 issuer_rm_w;
603         __u32 issuer_rm_r;
604         __u32 cm_filter_w;
605         __u32 cm_filter_r;
606         __u32 cm_connection_w;
607         __u32 cm_connection_r;
608         __u32 ulp_filter_w;
609         __u32 ulp_filter_r;
610         __u32 ulp_connection_w;
611         __u32 ulp_connection_r;
612 };
613
614 struct qeth_seqno {
615         __u32 trans_hdr;
616         __u32 pdu_hdr;
617         __u32 pdu_hdr_ack;
618         __u16 ipa;
619         __u32 pkt_seqno;
620 };
621
622 struct qeth_reply {
623         struct list_head list;
624         wait_queue_head_t wait_q;
625         int (*callback)(struct qeth_card *, struct qeth_reply *,
626                 unsigned long);
627         u32 seqno;
628         unsigned long offset;
629         atomic_t received;
630         int rc;
631         void *param;
632         struct qeth_card *card;
633         atomic_t refcnt;
634 };
635
636
637 struct qeth_card_blkt {
638         int time_total;
639         int inter_packet;
640         int inter_packet_jumbo;
641 };
642
643 #define QETH_BROADCAST_WITH_ECHO    0x01
644 #define QETH_BROADCAST_WITHOUT_ECHO 0x02
645 #define QETH_LAYER2_MAC_READ        0x01
646 #define QETH_LAYER2_MAC_REGISTERED  0x02
647 struct qeth_card_info {
648         unsigned short unit_addr2;
649         unsigned short cula;
650         unsigned short chpid;
651         __u16 func_level;
652         char mcl_level[QETH_MCL_LENGTH + 1];
653         int guestlan;
654         int mac_bits;
655         int portname_required;
656         int portno;
657         char portname[9];
658         enum qeth_card_types type;
659         enum qeth_link_types link_type;
660         int is_multicast_different;
661         int initial_mtu;
662         int max_mtu;
663         int broadcast_capable;
664         int unique_id;
665         struct qeth_card_blkt blkt;
666         __u32 csum_mask;
667         __u32 tx_csum_mask;
668         enum qeth_ipa_promisc_modes promisc_mode;
669         __u32 diagass_support;
670         __u32 hwtrap;
671 };
672
673 struct qeth_card_options {
674         struct qeth_routing_info route4;
675         struct qeth_ipa_info ipa4;
676         struct qeth_ipa_info adp; /*Adapter parameters*/
677         struct qeth_routing_info route6;
678         struct qeth_ipa_info ipa6;
679         int broadcast_mode;
680         int macaddr_mode;
681         int fake_broadcast;
682         int add_hhlen;
683         int layer2;
684         int performance_stats;
685         int rx_sg_cb;
686         enum qeth_ipa_isolation_modes isolation;
687         int sniffer;
688         enum qeth_cq cq;
689         char hsuid[9];
690 };
691
692 /*
693  * thread bits for qeth_card thread masks
694  */
695 enum qeth_threads {
696         QETH_RECOVER_THREAD = 1,
697 };
698
699 struct qeth_osn_info {
700         int (*assist_cb)(struct net_device *dev, void *data);
701         int (*data_cb)(struct sk_buff *skb);
702 };
703
704 enum qeth_discipline_id {
705         QETH_DISCIPLINE_LAYER3 = 0,
706         QETH_DISCIPLINE_LAYER2 = 1,
707 };
708
709 struct qeth_discipline {
710         void (*start_poll)(struct ccw_device *, int, unsigned long);
711         qdio_handler_t *input_handler;
712         qdio_handler_t *output_handler;
713         int (*recover)(void *ptr);
714         int (*setup) (struct ccwgroup_device *);
715         void (*remove) (struct ccwgroup_device *);
716         int (*set_online) (struct ccwgroup_device *);
717         int (*set_offline) (struct ccwgroup_device *);
718         void (*shutdown)(struct ccwgroup_device *);
719         int (*prepare) (struct ccwgroup_device *);
720         void (*complete) (struct ccwgroup_device *);
721         int (*freeze)(struct ccwgroup_device *);
722         int (*thaw) (struct ccwgroup_device *);
723         int (*restore)(struct ccwgroup_device *);
724 };
725
726 struct qeth_vlan_vid {
727         struct list_head list;
728         unsigned short vid;
729 };
730
731 struct qeth_mc_mac {
732         struct list_head list;
733         __u8 mc_addr[MAX_ADDR_LEN];
734         unsigned char mc_addrlen;
735         int is_vmac;
736 };
737
738 struct qeth_rx {
739         int b_count;
740         int b_index;
741         struct qdio_buffer_element *b_element;
742         int e_offset;
743         int qdio_err;
744 };
745
746 #define QETH_NAPI_WEIGHT 128
747
748 struct qeth_card {
749         struct list_head list;
750         enum qeth_card_states state;
751         int lan_online;
752         spinlock_t lock;
753         struct ccwgroup_device *gdev;
754         struct qeth_channel read;
755         struct qeth_channel write;
756         struct qeth_channel data;
757
758         struct net_device *dev;
759         struct net_device_stats stats;
760
761         struct qeth_card_info info;
762         struct qeth_token token;
763         struct qeth_seqno seqno;
764         struct qeth_card_options options;
765
766         wait_queue_head_t wait_q;
767         spinlock_t vlanlock;
768         spinlock_t mclock;
769         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
770         struct list_head vid_list;
771         struct list_head mc_list;
772         struct work_struct kernel_thread_starter;
773         spinlock_t thread_mask_lock;
774         unsigned long thread_start_mask;
775         unsigned long thread_allowed_mask;
776         unsigned long thread_running_mask;
777         spinlock_t ip_lock;
778         struct list_head ip_list;
779         struct list_head *ip_tbd_list;
780         struct qeth_ipato ipato;
781         struct list_head cmd_waiter_list;
782         /* QDIO buffer handling */
783         struct qeth_qdio_info qdio;
784         struct qeth_perf_stats perf_stats;
785         int read_or_write_problem;
786         struct qeth_osn_info osn_info;
787         struct qeth_discipline *discipline;
788         atomic_t force_alloc_skb;
789         struct service_level qeth_service_level;
790         struct qdio_ssqd_desc ssqd;
791         debug_info_t *debug;
792         struct mutex conf_mutex;
793         struct mutex discipline_mutex;
794         struct napi_struct napi;
795         struct qeth_rx rx;
796         struct delayed_work buffer_reclaim_work;
797         int reclaim_index;
798 };
799
800 struct qeth_card_list_struct {
801         struct list_head list;
802         rwlock_t rwlock;
803 };
804
805 struct qeth_trap_id {
806         __u16 lparnr;
807         char vmname[8];
808         __u8 chpid;
809         __u8 ssid;
810         __u16 devno;
811 } __packed;
812
813 /*some helper functions*/
814 #define QETH_CARD_IFNAME(card) (((card)->dev)? (card)->dev->name : "")
815
816 static inline struct qeth_card *CARD_FROM_CDEV(struct ccw_device *cdev)
817 {
818         struct qeth_card *card = dev_get_drvdata(&((struct ccwgroup_device *)
819                 dev_get_drvdata(&cdev->dev))->dev);
820         return card;
821 }
822
823 static inline int qeth_get_micros(void)
824 {
825         return (int) (get_clock() >> 12);
826 }
827
828 static inline int qeth_get_ip_version(struct sk_buff *skb)
829 {
830         struct ethhdr *ehdr = (struct ethhdr *)skb->data;
831         switch (ehdr->h_proto) {
832         case ETH_P_IPV6:
833                 return 6;
834         case ETH_P_IP:
835                 return 4;
836         default:
837                 return 0;
838         }
839 }
840
841 static inline void qeth_put_buffer_pool_entry(struct qeth_card *card,
842                 struct qeth_buffer_pool_entry *entry)
843 {
844         list_add_tail(&entry->list, &card->qdio.in_buf_pool.entry_list);
845 }
846
847 static inline int qeth_is_diagass_supported(struct qeth_card *card,
848                 enum qeth_diags_cmds cmd)
849 {
850         return card->info.diagass_support & (__u32)cmd;
851 }
852
853 extern struct qeth_discipline qeth_l2_discipline;
854 extern struct qeth_discipline qeth_l3_discipline;
855 extern const struct attribute_group *qeth_generic_attr_groups[];
856 extern const struct attribute_group *qeth_osn_attr_groups[];
857
858 const char *qeth_get_cardname_short(struct qeth_card *);
859 int qeth_realloc_buffer_pool(struct qeth_card *, int);
860 int qeth_core_load_discipline(struct qeth_card *, enum qeth_discipline_id);
861 void qeth_core_free_discipline(struct qeth_card *);
862 void qeth_buffer_reclaim_work(struct work_struct *);
863
864 /* exports for qeth discipline device drivers */
865 extern struct qeth_card_list_struct qeth_core_card_list;
866 extern struct kmem_cache *qeth_core_header_cache;
867 extern struct qeth_dbf_info qeth_dbf[QETH_DBF_INFOS];
868
869 void qeth_set_allowed_threads(struct qeth_card *, unsigned long , int);
870 int qeth_threads_running(struct qeth_card *, unsigned long);
871 int qeth_wait_for_threads(struct qeth_card *, unsigned long);
872 int qeth_do_run_thread(struct qeth_card *, unsigned long);
873 void qeth_clear_thread_start_bit(struct qeth_card *, unsigned long);
874 void qeth_clear_thread_running_bit(struct qeth_card *, unsigned long);
875 int qeth_core_hardsetup_card(struct qeth_card *);
876 void qeth_print_status_message(struct qeth_card *);
877 int qeth_init_qdio_queues(struct qeth_card *);
878 int qeth_send_startlan(struct qeth_card *);
879 int qeth_send_stoplan(struct qeth_card *);
880 int qeth_send_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *,
881                   int (*reply_cb)
882                   (struct qeth_card *, struct qeth_reply *, unsigned long),
883                   void *);
884 struct qeth_cmd_buffer *qeth_get_ipacmd_buffer(struct qeth_card *,
885                         enum qeth_ipa_cmds, enum qeth_prot_versions);
886 int qeth_query_setadapterparms(struct qeth_card *);
887 int qeth_check_qdio_errors(struct qeth_card *, struct qdio_buffer *,
888                 unsigned int, const char *);
889 void qeth_queue_input_buffer(struct qeth_card *, int);
890 struct sk_buff *qeth_core_get_next_skb(struct qeth_card *,
891                 struct qeth_qdio_buffer *, struct qdio_buffer_element **, int *,
892                 struct qeth_hdr **);
893 void qeth_schedule_recovery(struct qeth_card *);
894 void qeth_qdio_start_poll(struct ccw_device *, int, unsigned long);
895 void qeth_qdio_input_handler(struct ccw_device *,
896                 unsigned int, unsigned int, int,
897                 int, unsigned long);
898 void qeth_qdio_output_handler(struct ccw_device *, unsigned int,
899                         int, int, int, unsigned long);
900 void qeth_clear_ipacmd_list(struct qeth_card *);
901 int qeth_qdio_clear_card(struct qeth_card *, int);
902 void qeth_clear_working_pool_list(struct qeth_card *);
903 void qeth_clear_cmd_buffers(struct qeth_channel *);
904 void qeth_clear_qdio_buffers(struct qeth_card *);
905 void qeth_setadp_promisc_mode(struct qeth_card *);
906 struct net_device_stats *qeth_get_stats(struct net_device *);
907 int qeth_change_mtu(struct net_device *, int);
908 int qeth_setadpparms_change_macaddr(struct qeth_card *);
909 void qeth_tx_timeout(struct net_device *);
910 void qeth_prepare_control_data(struct qeth_card *, int,
911                                 struct qeth_cmd_buffer *);
912 void qeth_release_buffer(struct qeth_channel *, struct qeth_cmd_buffer *);
913 void qeth_prepare_ipa_cmd(struct qeth_card *, struct qeth_cmd_buffer *, char);
914 struct qeth_cmd_buffer *qeth_wait_for_buffer(struct qeth_channel *);
915 int qeth_mdio_read(struct net_device *, int, int);
916 int qeth_snmp_command(struct qeth_card *, char __user *);
917 int qeth_query_oat_command(struct qeth_card *, char __user *);
918 struct qeth_cmd_buffer *qeth_get_adapter_cmd(struct qeth_card *, __u32, __u32);
919 int qeth_default_setadapterparms_cb(struct qeth_card *, struct qeth_reply *,
920                                         unsigned long);
921 int qeth_send_control_data(struct qeth_card *, int, struct qeth_cmd_buffer *,
922         int (*reply_cb)(struct qeth_card *, struct qeth_reply*, unsigned long),
923         void *reply_param);
924 int qeth_get_priority_queue(struct qeth_card *, struct sk_buff *, int, int);
925 int qeth_get_elements_no(struct qeth_card *, void *, struct sk_buff *, int);
926 int qeth_do_send_packet_fast(struct qeth_card *, struct qeth_qdio_out_q *,
927                         struct sk_buff *, struct qeth_hdr *, int, int, int);
928 int qeth_do_send_packet(struct qeth_card *, struct qeth_qdio_out_q *,
929                     struct sk_buff *, struct qeth_hdr *, int);
930 int qeth_core_get_sset_count(struct net_device *, int);
931 void qeth_core_get_ethtool_stats(struct net_device *,
932                                 struct ethtool_stats *, u64 *);
933 void qeth_core_get_strings(struct net_device *, u32, u8 *);
934 void qeth_core_get_drvinfo(struct net_device *, struct ethtool_drvinfo *);
935 void qeth_dbf_longtext(debug_info_t *id, int level, char *text, ...);
936 int qeth_core_ethtool_get_settings(struct net_device *, struct ethtool_cmd *);
937 int qeth_set_access_ctrl_online(struct qeth_card *card);
938 int qeth_hdr_chk_and_bounce(struct sk_buff *, int);
939 int qeth_configure_cq(struct qeth_card *, enum qeth_cq);
940 int qeth_hw_trap(struct qeth_card *, enum qeth_diags_trap_action);
941 int qeth_query_ipassists(struct qeth_card *, enum qeth_prot_versions prot);
942
943 /* exports for OSN */
944 int qeth_osn_assist(struct net_device *, void *, int);
945 int qeth_osn_register(unsigned char *read_dev_no, struct net_device **,
946                 int (*assist_cb)(struct net_device *, void *),
947                 int (*data_cb)(struct sk_buff *));
948 void qeth_osn_deregister(struct net_device *);
949
950 #endif /* __QETH_CORE_H__ */