Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/shaggy...
[linux-2.6] / drivers / s390 / net / qeth.h
1 #ifndef __QETH_H__
2 #define __QETH_H__
3
4 #include <linux/if.h>
5 #include <linux/if_arp.h>
6
7 #include <linux/if_tr.h>
8 #include <linux/trdevice.h>
9 #include <linux/etherdevice.h>
10 #include <linux/if_vlan.h>
11 #include <linux/ctype.h>
12
13 #include <net/ipv6.h>
14 #include <linux/in6.h>
15 #include <net/if_inet6.h>
16 #include <net/addrconf.h>
17
18
19 #include <linux/bitops.h>
20
21 #include <asm/debug.h>
22 #include <asm/qdio.h>
23 #include <asm/ccwdev.h>
24 #include <asm/ccwgroup.h>
25
26 #include "qeth_mpc.h"
27
28 #ifdef CONFIG_QETH_IPV6
29 #define QETH_VERSION_IPV6       ":IPv6"
30 #else
31 #define QETH_VERSION_IPV6       ""
32 #endif
33 #ifdef CONFIG_QETH_VLAN
34 #define QETH_VERSION_VLAN       ":VLAN"
35 #else
36 #define QETH_VERSION_VLAN       ""
37 #endif
38
39 /**
40  * Debug Facility stuff
41  */
42 #define QETH_DBF_SETUP_NAME "qeth_setup"
43 #define QETH_DBF_SETUP_LEN 8
44 #define QETH_DBF_SETUP_PAGES 8
45 #define QETH_DBF_SETUP_NR_AREAS 1
46 #define QETH_DBF_SETUP_LEVEL 5
47
48 #define QETH_DBF_MISC_NAME "qeth_misc"
49 #define QETH_DBF_MISC_LEN 128
50 #define QETH_DBF_MISC_PAGES 2
51 #define QETH_DBF_MISC_NR_AREAS 1
52 #define QETH_DBF_MISC_LEVEL 2
53
54 #define QETH_DBF_DATA_NAME "qeth_data"
55 #define QETH_DBF_DATA_LEN 96
56 #define QETH_DBF_DATA_PAGES 8
57 #define QETH_DBF_DATA_NR_AREAS 1
58 #define QETH_DBF_DATA_LEVEL 2
59
60 #define QETH_DBF_CONTROL_NAME "qeth_control"
61 #define QETH_DBF_CONTROL_LEN 256
62 #define QETH_DBF_CONTROL_PAGES 8
63 #define QETH_DBF_CONTROL_NR_AREAS 2
64 #define QETH_DBF_CONTROL_LEVEL 5
65
66 #define QETH_DBF_TRACE_NAME "qeth_trace"
67 #define QETH_DBF_TRACE_LEN 8
68 #define QETH_DBF_TRACE_PAGES 4
69 #define QETH_DBF_TRACE_NR_AREAS 2
70 #define QETH_DBF_TRACE_LEVEL 3
71 extern debug_info_t *qeth_dbf_trace;
72
73 #define QETH_DBF_SENSE_NAME "qeth_sense"
74 #define QETH_DBF_SENSE_LEN 64
75 #define QETH_DBF_SENSE_PAGES 2
76 #define QETH_DBF_SENSE_NR_AREAS 1
77 #define QETH_DBF_SENSE_LEVEL 2
78
79 #define QETH_DBF_QERR_NAME "qeth_qerr"
80 #define QETH_DBF_QERR_LEN 8
81 #define QETH_DBF_QERR_PAGES 2
82 #define QETH_DBF_QERR_NR_AREAS 2
83 #define QETH_DBF_QERR_LEVEL 2
84
85 #define QETH_DBF_TEXT(name,level,text) \
86         do { \
87                 debug_text_event(qeth_dbf_##name,level,text); \
88         } while (0)
89
90 #define QETH_DBF_HEX(name,level,addr,len) \
91         do { \
92                 debug_event(qeth_dbf_##name,level,(void*)(addr),len); \
93         } while (0)
94
95 DECLARE_PER_CPU(char[256], qeth_dbf_txt_buf);
96
97 #define QETH_DBF_TEXT_(name,level,text...)                              \
98         do {                                                            \
99                 char* dbf_txt_buf = get_cpu_var(qeth_dbf_txt_buf);      \
100                 sprintf(dbf_txt_buf, text);                             \
101                 debug_text_event(qeth_dbf_##name,level,dbf_txt_buf);    \
102                 put_cpu_var(qeth_dbf_txt_buf);                          \
103         } while (0)
104
105 #define QETH_DBF_SPRINTF(name,level,text...) \
106         do { \
107                 debug_sprintf_event(qeth_dbf_trace, level, ##text ); \
108                 debug_sprintf_event(qeth_dbf_trace, level, text ); \
109         } while (0)
110
111 /**
112  * some more debug stuff
113  */
114 #define PRINTK_HEADER   "qeth: "
115
116 #define HEXDUMP16(importance,header,ptr) \
117 PRINT_##importance(header "%02x %02x %02x %02x  %02x %02x %02x %02x  " \
118                    "%02x %02x %02x %02x  %02x %02x %02x %02x\n", \
119                    *(((char*)ptr)),*(((char*)ptr)+1),*(((char*)ptr)+2), \
120                    *(((char*)ptr)+3),*(((char*)ptr)+4),*(((char*)ptr)+5), \
121                    *(((char*)ptr)+6),*(((char*)ptr)+7),*(((char*)ptr)+8), \
122                    *(((char*)ptr)+9),*(((char*)ptr)+10),*(((char*)ptr)+11), \
123                    *(((char*)ptr)+12),*(((char*)ptr)+13), \
124                    *(((char*)ptr)+14),*(((char*)ptr)+15)); \
125 PRINT_##importance(header "%02x %02x %02x %02x  %02x %02x %02x %02x  " \
126                    "%02x %02x %02x %02x  %02x %02x %02x %02x\n", \
127                    *(((char*)ptr)+16),*(((char*)ptr)+17), \
128                    *(((char*)ptr)+18),*(((char*)ptr)+19), \
129                    *(((char*)ptr)+20),*(((char*)ptr)+21), \
130                    *(((char*)ptr)+22),*(((char*)ptr)+23), \
131                    *(((char*)ptr)+24),*(((char*)ptr)+25), \
132                    *(((char*)ptr)+26),*(((char*)ptr)+27), \
133                    *(((char*)ptr)+28),*(((char*)ptr)+29), \
134                    *(((char*)ptr)+30),*(((char*)ptr)+31));
135
136 static inline void
137 qeth_hex_dump(unsigned char *buf, size_t len)
138 {
139         size_t i;
140
141         for (i = 0; i < len; i++) {
142                 if (i && !(i % 16))
143                         printk("\n");
144                 printk("%02x ", *(buf + i));
145         }
146         printk("\n");
147 }
148
149 #define SENSE_COMMAND_REJECT_BYTE 0
150 #define SENSE_COMMAND_REJECT_FLAG 0x80
151 #define SENSE_RESETTING_EVENT_BYTE 1
152 #define SENSE_RESETTING_EVENT_FLAG 0x80
153
154 #define atomic_swap(a,b) xchg((int *)a.counter, b)
155
156 /*
157  * Common IO related definitions
158  */
159 extern struct device *qeth_root_dev;
160 extern struct ccw_driver qeth_ccw_driver;
161 extern struct ccwgroup_driver qeth_ccwgroup_driver;
162
163 #define CARD_RDEV(card) card->read.ccwdev
164 #define CARD_WDEV(card) card->write.ccwdev
165 #define CARD_DDEV(card) card->data.ccwdev
166 #define CARD_BUS_ID(card) card->gdev->dev.bus_id
167 #define CARD_RDEV_ID(card) card->read.ccwdev->dev.bus_id
168 #define CARD_WDEV_ID(card) card->write.ccwdev->dev.bus_id
169 #define CARD_DDEV_ID(card) card->data.ccwdev->dev.bus_id
170 #define CHANNEL_ID(channel) channel->ccwdev->dev.bus_id
171
172 #define CARD_FROM_CDEV(cdev) (struct qeth_card *) \
173                 ((struct ccwgroup_device *)cdev->dev.driver_data)\
174                 ->dev.driver_data;
175
176 /**
177  * card stuff
178  */
179 #ifdef CONFIG_QETH_PERF_STATS
180 struct qeth_perf_stats {
181         unsigned int bufs_rec;
182         unsigned int bufs_sent;
183
184         unsigned int skbs_sent_pack;
185         unsigned int bufs_sent_pack;
186
187         unsigned int sc_dp_p;
188         unsigned int sc_p_dp;
189         /* qdio_input_handler: number of times called, time spent in */
190         __u64 inbound_start_time;
191         unsigned int inbound_cnt;
192         unsigned int inbound_time;
193         /* qeth_send_packet: number of times called, time spent in */
194         __u64 outbound_start_time;
195         unsigned int outbound_cnt;
196         unsigned int outbound_time;
197         /* qdio_output_handler: number of times called, time spent in */
198         __u64 outbound_handler_start_time;
199         unsigned int outbound_handler_cnt;
200         unsigned int outbound_handler_time;
201         /* number of calls to and time spent in do_QDIO for inbound queue */
202         __u64 inbound_do_qdio_start_time;
203         unsigned int inbound_do_qdio_cnt;
204         unsigned int inbound_do_qdio_time;
205         /* number of calls to and time spent in do_QDIO for outbound queues */
206         __u64 outbound_do_qdio_start_time;
207         unsigned int outbound_do_qdio_cnt;
208         unsigned int outbound_do_qdio_time;
209         /* eddp data */
210         unsigned int large_send_bytes;
211         unsigned int large_send_cnt;
212         unsigned int sg_skbs_sent;
213         unsigned int sg_frags_sent;
214 };
215 #endif /* CONFIG_QETH_PERF_STATS */
216
217 /* Routing stuff */
218 struct qeth_routing_info {
219         enum qeth_routing_types type;
220 };
221
222 /* IPA stuff */
223 struct qeth_ipa_info {
224         __u32 supported_funcs;
225         __u32 enabled_funcs;
226 };
227
228 static inline int
229 qeth_is_ipa_supported(struct qeth_ipa_info *ipa, enum qeth_ipa_funcs func)
230 {
231         return (ipa->supported_funcs & func);
232 }
233
234 static inline int
235 qeth_is_ipa_enabled(struct qeth_ipa_info *ipa, enum qeth_ipa_funcs func)
236 {
237         return (ipa->supported_funcs & ipa->enabled_funcs & func);
238 }
239
240 #define qeth_adp_supported(c,f) \
241         qeth_is_ipa_supported(&c->options.adp, f)
242 #define qeth_adp_enabled(c,f) \
243         qeth_is_ipa_enabled(&c->options.adp, f)
244 #define qeth_is_supported(c,f) \
245         qeth_is_ipa_supported(&c->options.ipa4, f)
246 #define qeth_is_enabled(c,f) \
247         qeth_is_ipa_enabled(&c->options.ipa4, f)
248 #ifdef CONFIG_QETH_IPV6
249 #define qeth_is_supported6(c,f) \
250         qeth_is_ipa_supported(&c->options.ipa6, f)
251 #define qeth_is_enabled6(c,f) \
252         qeth_is_ipa_enabled(&c->options.ipa6, f)
253 #else /* CONFIG_QETH_IPV6 */
254 #define qeth_is_supported6(c,f) 0
255 #define qeth_is_enabled6(c,f) 0
256 #endif /* CONFIG_QETH_IPV6 */
257 #define qeth_is_ipafunc_supported(c,prot,f) \
258          (prot==QETH_PROT_IPV6)? qeth_is_supported6(c,f):qeth_is_supported(c,f)
259 #define qeth_is_ipafunc_enabled(c,prot,f) \
260          (prot==QETH_PROT_IPV6)? qeth_is_enabled6(c,f):qeth_is_enabled(c,f)
261
262
263 #define QETH_IDX_FUNC_LEVEL_OSAE_ENA_IPAT 0x0101
264 #define QETH_IDX_FUNC_LEVEL_OSAE_DIS_IPAT 0x0101
265 #define QETH_IDX_FUNC_LEVEL_IQD_ENA_IPAT 0x4108
266 #define QETH_IDX_FUNC_LEVEL_IQD_DIS_IPAT 0x5108
267
268 #define QETH_MODELLIST_ARRAY \
269         {{0x1731,0x01,0x1732,0x01,QETH_CARD_TYPE_OSAE,1, \
270         QETH_IDX_FUNC_LEVEL_OSAE_ENA_IPAT, \
271         QETH_IDX_FUNC_LEVEL_OSAE_DIS_IPAT, \
272         QETH_MAX_QUEUES,0}, \
273         {0x1731,0x05,0x1732,0x05,QETH_CARD_TYPE_IQD,0, \
274         QETH_IDX_FUNC_LEVEL_IQD_ENA_IPAT, \
275         QETH_IDX_FUNC_LEVEL_IQD_DIS_IPAT, \
276         QETH_MAX_QUEUES,0x103}, \
277         {0x1731,0x06,0x1732,0x06,QETH_CARD_TYPE_OSN,0, \
278         QETH_IDX_FUNC_LEVEL_OSAE_ENA_IPAT, \
279         QETH_IDX_FUNC_LEVEL_OSAE_DIS_IPAT, \
280         QETH_MAX_QUEUES,0}, \
281         {0,0,0,0,0,0,0,0,0}}
282
283 #define QETH_REAL_CARD          1
284 #define QETH_VLAN_CARD          2
285 #define QETH_BUFSIZE            4096
286
287 /**
288  * some more defs
289  */
290 #define IF_NAME_LEN             16
291 #define QETH_TX_TIMEOUT         100 * HZ
292 #define QETH_HEADER_SIZE        32
293 #define MAX_PORTNO              15
294 #define QETH_FAKE_LL_LEN_ETH    ETH_HLEN
295 #define QETH_FAKE_LL_LEN_TR     (sizeof(struct trh_hdr)-TR_MAXRIFLEN+sizeof(struct trllc))
296 #define QETH_FAKE_LL_V6_ADDR_POS 24
297
298 /*IPv6 address autoconfiguration stuff*/
299 #define UNIQUE_ID_IF_CREATE_ADDR_FAILED 0xfffe
300 #define UNIQUE_ID_NOT_BY_CARD           0x10000
301
302 /*****************************************************************************/
303 /* QDIO queue and buffer handling                                            */
304 /*****************************************************************************/
305 #define QETH_MAX_QUEUES 4
306 #define QETH_IN_BUF_SIZE_DEFAULT 65536
307 #define QETH_IN_BUF_COUNT_DEFAULT 16
308 #define QETH_IN_BUF_COUNT_MIN 8
309 #define QETH_IN_BUF_COUNT_MAX 128
310 #define QETH_MAX_BUFFER_ELEMENTS(card) ((card)->qdio.in_buf_size >> 12)
311 #define QETH_IN_BUF_REQUEUE_THRESHOLD(card) \
312                 ((card)->qdio.in_buf_pool.buf_count / 2)
313
314 /* buffers we have to be behind before we get a PCI */
315 #define QETH_PCI_THRESHOLD_A(card) ((card)->qdio.in_buf_pool.buf_count+1)
316 /*enqueued free buffers left before we get a PCI*/
317 #define QETH_PCI_THRESHOLD_B(card) 0
318 /*not used unless the microcode gets patched*/
319 #define QETH_PCI_TIMER_VALUE(card) 3
320
321 #define QETH_MIN_INPUT_THRESHOLD 1
322 #define QETH_MAX_INPUT_THRESHOLD 500
323 #define QETH_MIN_OUTPUT_THRESHOLD 1
324 #define QETH_MAX_OUTPUT_THRESHOLD 300
325
326 /* priority queing */
327 #define QETH_PRIOQ_DEFAULT QETH_NO_PRIO_QUEUEING
328 #define QETH_DEFAULT_QUEUE    2
329 #define QETH_NO_PRIO_QUEUEING 0
330 #define QETH_PRIO_Q_ING_PREC  1
331 #define QETH_PRIO_Q_ING_TOS   2
332 #define IP_TOS_LOWDELAY 0x10
333 #define IP_TOS_HIGHTHROUGHPUT 0x08
334 #define IP_TOS_HIGHRELIABILITY 0x04
335 #define IP_TOS_NOTIMPORTANT 0x02
336
337 /* Packing */
338 #define QETH_LOW_WATERMARK_PACK  2
339 #define QETH_HIGH_WATERMARK_PACK 5
340 #define QETH_WATERMARK_PACK_FUZZ 1
341
342 #define QETH_IP_HEADER_SIZE 40
343
344 struct qeth_hdr_layer3 {
345         __u8  id;
346         __u8  flags;
347         __u16 inbound_checksum; /*TSO:__u16 seqno */
348         __u32 token;            /*TSO: __u32 reserved */
349         __u16 length;
350         __u8  vlan_prio;
351         __u8  ext_flags;
352         __u16 vlan_id;
353         __u16 frame_offset;
354         __u8  dest_addr[16];
355 } __attribute__ ((packed));
356
357 struct qeth_hdr_layer2 {
358         __u8 id;
359         __u8 flags[3];
360         __u8 port_no;
361         __u8 hdr_length;
362         __u16 pkt_length;
363         __u16 seq_no;
364         __u16 vlan_id;
365         __u32 reserved;
366         __u8 reserved2[16];
367 } __attribute__ ((packed));
368
369 struct qeth_hdr_osn {
370         __u8 id;
371         __u8 reserved;
372         __u16 seq_no;
373         __u16 reserved2;
374         __u16 control_flags;
375         __u16 pdu_length;
376         __u8 reserved3[18];
377         __u32 ccid;
378 } __attribute__ ((packed));
379                                             
380 struct qeth_hdr {
381         union {
382                 struct qeth_hdr_layer2 l2;
383                 struct qeth_hdr_layer3 l3;
384                 struct qeth_hdr_osn    osn;
385         } hdr;
386 } __attribute__ ((packed));
387
388 /*TCP Segmentation Offload header*/
389 struct qeth_hdr_ext_tso {
390         __u16 hdr_tot_len;
391         __u8  imb_hdr_no;
392         __u8  reserved;
393         __u8  hdr_type;
394         __u8  hdr_version;
395         __u16 hdr_len;
396         __u32 payload_len;
397         __u16 mss;
398         __u16 dg_hdr_len;
399         __u8  padding[16];
400 } __attribute__ ((packed));
401
402 struct qeth_hdr_tso {
403         struct qeth_hdr hdr;    /*hdr->hdr.l3.xxx*/
404         struct qeth_hdr_ext_tso ext;
405 } __attribute__ ((packed));
406
407
408 /* flags for qeth_hdr.flags */
409 #define QETH_HDR_PASSTHRU 0x10
410 #define QETH_HDR_IPV6     0x80
411 #define QETH_HDR_CAST_MASK 0x07
412 enum qeth_cast_flags {
413         QETH_CAST_UNICAST   = 0x06,
414         QETH_CAST_MULTICAST = 0x04,
415         QETH_CAST_BROADCAST = 0x05,
416         QETH_CAST_ANYCAST   = 0x07,
417         QETH_CAST_NOCAST    = 0x00,
418 };
419
420 enum qeth_layer2_frame_flags {
421         QETH_LAYER2_FLAG_MULTICAST = 0x01,
422         QETH_LAYER2_FLAG_BROADCAST = 0x02,
423         QETH_LAYER2_FLAG_UNICAST   = 0x04,
424         QETH_LAYER2_FLAG_VLAN      = 0x10,
425 };
426
427 enum qeth_header_ids {
428         QETH_HEADER_TYPE_LAYER3 = 0x01,
429         QETH_HEADER_TYPE_LAYER2 = 0x02,
430         QETH_HEADER_TYPE_TSO    = 0x03,
431         QETH_HEADER_TYPE_OSN    = 0x04,
432 };
433 /* flags for qeth_hdr.ext_flags */
434 #define QETH_HDR_EXT_VLAN_FRAME       0x01
435 #define QETH_HDR_EXT_TOKEN_ID         0x02
436 #define QETH_HDR_EXT_INCLUDE_VLAN_TAG 0x04
437 #define QETH_HDR_EXT_SRC_MAC_ADDR     0x08
438 #define QETH_HDR_EXT_CSUM_HDR_REQ     0x10
439 #define QETH_HDR_EXT_CSUM_TRANSP_REQ  0x20
440 #define QETH_HDR_EXT_UDP_TSO          0x40 /*bit off for TCP*/
441
442 static inline int
443 qeth_is_last_sbale(struct qdio_buffer_element *sbale)
444 {
445         return (sbale->flags & SBAL_FLAGS_LAST_ENTRY);
446 }
447
448 enum qeth_qdio_buffer_states {
449         /*
450          * inbound: read out by driver; owned by hardware in order to be filled
451          * outbound: owned by driver in order to be filled
452          */
453         QETH_QDIO_BUF_EMPTY,
454         /*
455          * inbound: filled by hardware; owned by driver in order to be read out
456          * outbound: filled by driver; owned by hardware in order to be sent
457          */
458         QETH_QDIO_BUF_PRIMED,
459 };
460
461 enum qeth_qdio_info_states {
462         QETH_QDIO_UNINITIALIZED,
463         QETH_QDIO_ALLOCATED,
464         QETH_QDIO_ESTABLISHED,
465 };
466
467 struct qeth_buffer_pool_entry {
468         struct list_head list;
469         struct list_head init_list;
470         void *elements[QDIO_MAX_ELEMENTS_PER_BUFFER];
471 };
472
473 struct qeth_qdio_buffer_pool {
474         struct list_head entry_list;
475         int buf_count;
476 };
477
478 struct qeth_qdio_buffer {
479         struct qdio_buffer *buffer;
480         volatile enum qeth_qdio_buffer_states state;
481         /* the buffer pool entry currently associated to this buffer */
482         struct qeth_buffer_pool_entry *pool_entry;
483 };
484
485 struct qeth_qdio_q {
486         struct qdio_buffer qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
487         struct qeth_qdio_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
488         /*
489          * buf_to_init means "buffer must be initialized by driver and must
490          * be made available for hardware" -> state is set to EMPTY
491          */
492         volatile int next_buf_to_init;
493 } __attribute__ ((aligned(256)));
494
495 /* possible types of qeth large_send support */
496 enum qeth_large_send_types {
497         QETH_LARGE_SEND_NO,
498         QETH_LARGE_SEND_EDDP,
499         QETH_LARGE_SEND_TSO,
500 };
501
502 struct qeth_qdio_out_buffer {
503         struct qdio_buffer *buffer;
504         atomic_t state;
505         volatile int next_element_to_fill;
506         struct sk_buff_head skb_list;
507         struct list_head ctx_list;
508 };
509
510 struct qeth_card;
511
512 enum qeth_out_q_states {
513        QETH_OUT_Q_UNLOCKED,
514        QETH_OUT_Q_LOCKED,
515        QETH_OUT_Q_LOCKED_FLUSH,
516 };
517
518 struct qeth_qdio_out_q {
519         struct qdio_buffer qdio_bufs[QDIO_MAX_BUFFERS_PER_Q];
520         struct qeth_qdio_out_buffer bufs[QDIO_MAX_BUFFERS_PER_Q];
521         int queue_no;
522         struct qeth_card *card;
523         atomic_t state;
524         volatile int do_pack;
525         /*
526          * index of buffer to be filled by driver; state EMPTY or PACKING
527          */
528         volatile int next_buf_to_fill;
529         /*
530          * number of buffers that are currently filled (PRIMED)
531          * -> these buffers are hardware-owned
532          */
533         atomic_t used_buffers;
534         /* indicates whether PCI flag must be set (or if one is outstanding) */
535         atomic_t set_pci_flags_count;
536 } __attribute__ ((aligned(256)));
537
538 struct qeth_qdio_info {
539         volatile enum qeth_qdio_info_states state;
540         /* input */
541         struct qeth_qdio_q *in_q;
542         struct qeth_qdio_buffer_pool in_buf_pool;
543         struct qeth_qdio_buffer_pool init_pool;
544         int in_buf_size;
545
546         /* output */
547         int no_out_queues;
548         struct qeth_qdio_out_q **out_qs;
549
550         /* priority queueing */
551         int do_prio_queueing;
552         int default_out_queue;
553 };
554
555 enum qeth_send_errors {
556         QETH_SEND_ERROR_NONE,
557         QETH_SEND_ERROR_LINK_FAILURE,
558         QETH_SEND_ERROR_RETRY,
559         QETH_SEND_ERROR_KICK_IT,
560 };
561
562 #define QETH_ETH_MAC_V4      0x0100 /* like v4 */
563 #define QETH_ETH_MAC_V6      0x3333 /* like v6 */
564 /* tr mc mac is longer, but that will be enough to detect mc frames */
565 #define QETH_TR_MAC_NC       0xc000 /* non-canonical */
566 #define QETH_TR_MAC_C        0x0300 /* canonical */
567
568 #define DEFAULT_ADD_HHLEN 0
569 #define MAX_ADD_HHLEN 1024
570
571 /**
572  * buffer stuff for read channel
573  */
574 #define QETH_CMD_BUFFER_NO      8
575
576 /**
577  *  channel state machine
578  */
579 enum qeth_channel_states {
580         CH_STATE_UP,
581         CH_STATE_DOWN,
582         CH_STATE_ACTIVATING,
583         CH_STATE_HALTED,
584         CH_STATE_STOPPED,
585 };
586 /**
587  * card state machine
588  */
589 enum qeth_card_states {
590         CARD_STATE_DOWN,
591         CARD_STATE_HARDSETUP,
592         CARD_STATE_SOFTSETUP,
593         CARD_STATE_UP,
594         CARD_STATE_RECOVER,
595 };
596
597 /**
598  * Protocol versions
599  */
600 enum qeth_prot_versions {
601         QETH_PROT_IPV4 = 0x0004,
602         QETH_PROT_IPV6 = 0x0006,
603 };
604
605 enum qeth_ip_types {
606         QETH_IP_TYPE_NORMAL,
607         QETH_IP_TYPE_VIPA,
608         QETH_IP_TYPE_RXIP,
609         QETH_IP_TYPE_DEL_ALL_MC,
610 };
611
612 enum qeth_cmd_buffer_state {
613         BUF_STATE_FREE,
614         BUF_STATE_LOCKED,
615         BUF_STATE_PROCESSED,
616 };
617 /**
618  * IP address and multicast list
619  */
620 struct qeth_ipaddr {
621         struct list_head entry;
622         enum qeth_ip_types type;
623         enum qeth_ipa_setdelip_flags set_flags;
624         enum qeth_ipa_setdelip_flags del_flags;
625         int is_multicast;
626         volatile int users;
627         enum qeth_prot_versions proto;
628         unsigned char mac[OSA_ADDR_LEN];
629         union {
630                 struct {
631                         unsigned int addr;
632                         unsigned int mask;
633                 } a4;
634                 struct {
635                         struct in6_addr addr;
636                         unsigned int pfxlen;
637                 } a6;
638         } u;
639 };
640
641 struct qeth_ipato_entry {
642         struct list_head entry;
643         enum qeth_prot_versions proto;
644         char addr[16];
645         int mask_bits;
646 };
647
648 struct qeth_ipato {
649         int enabled;
650         int invert4;
651         int invert6;
652         struct list_head entries;
653 };
654
655 struct qeth_channel;
656
657 struct qeth_cmd_buffer {
658         enum qeth_cmd_buffer_state state;
659         struct qeth_channel *channel;
660         unsigned char *data;
661         int rc;
662         void (*callback) (struct qeth_channel *, struct qeth_cmd_buffer *);
663 };
664
665
666 /**
667  * definition of a qeth channel, used for read and write
668  */
669 struct qeth_channel {
670         enum qeth_channel_states state;
671         struct ccw1 ccw;
672         spinlock_t iob_lock;
673         wait_queue_head_t wait_q;
674         struct tasklet_struct irq_tasklet;
675         struct ccw_device *ccwdev;
676 /*command buffer for control data*/
677         struct qeth_cmd_buffer iob[QETH_CMD_BUFFER_NO];
678         atomic_t irq_pending;
679         volatile int io_buf_no;
680         volatile int buf_no;
681 };
682
683 /**
684  *  OSA card related definitions
685  */
686 struct qeth_token {
687         __u32 issuer_rm_w;
688         __u32 issuer_rm_r;
689         __u32 cm_filter_w;
690         __u32 cm_filter_r;
691         __u32 cm_connection_w;
692         __u32 cm_connection_r;
693         __u32 ulp_filter_w;
694         __u32 ulp_filter_r;
695         __u32 ulp_connection_w;
696         __u32 ulp_connection_r;
697 };
698
699 struct qeth_seqno {
700         __u32 trans_hdr;
701         __u32 pdu_hdr;
702         __u32 pdu_hdr_ack;
703         __u16 ipa;
704         __u32 pkt_seqno;
705 };
706
707 struct qeth_reply {
708         struct list_head list;
709         wait_queue_head_t wait_q;
710         int (*callback)(struct qeth_card *,struct qeth_reply *,unsigned long);
711         u32 seqno;
712         unsigned long offset;
713         int received;
714         int rc;
715         void *param;
716         struct qeth_card *card;
717         atomic_t refcnt;
718 };
719
720
721 struct qeth_card_blkt {
722         int time_total;
723         int inter_packet;
724         int inter_packet_jumbo;
725 };
726
727 #define QETH_BROADCAST_WITH_ECHO    0x01
728 #define QETH_BROADCAST_WITHOUT_ECHO 0x02
729 #define QETH_LAYER2_MAC_READ        0x01
730 #define QETH_LAYER2_MAC_REGISTERED  0x02
731 struct qeth_card_info {
732         unsigned short unit_addr2;
733         unsigned short cula;
734         unsigned short chpid;
735         __u16 func_level;
736         char mcl_level[QETH_MCL_LENGTH + 1];
737         int guestlan;
738         int mac_bits;
739         int portname_required;
740         int portno;
741         char portname[9];
742         enum qeth_card_types type;
743         enum qeth_link_types link_type;
744         int is_multicast_different;
745         int initial_mtu;
746         int max_mtu;
747         int broadcast_capable;
748         int unique_id;
749         struct qeth_card_blkt blkt;
750         __u32 csum_mask;
751         enum qeth_ipa_promisc_modes promisc_mode;
752 };
753
754 struct qeth_card_options {
755         struct qeth_routing_info route4;
756         struct qeth_ipa_info ipa4;
757         struct qeth_ipa_info adp; /*Adapter parameters*/
758 #ifdef CONFIG_QETH_IPV6
759         struct qeth_routing_info route6;
760         struct qeth_ipa_info ipa6;
761 #endif /* QETH_IPV6 */
762         enum qeth_checksum_types checksum_type;
763         int broadcast_mode;
764         int macaddr_mode;
765         int fake_broadcast;
766         int add_hhlen;
767         int fake_ll;
768         int layer2;
769         enum qeth_large_send_types large_send;
770 };
771
772 /*
773  * thread bits for qeth_card thread masks
774  */
775 enum qeth_threads {
776         QETH_SET_IP_THREAD  = 1,
777         QETH_RECOVER_THREAD = 2,
778         QETH_SET_PROMISC_MODE_THREAD = 4,
779 };
780
781 struct qeth_osn_info {
782         int (*assist_cb)(struct net_device *dev, void *data);
783         int (*data_cb)(struct sk_buff *skb);
784 };
785
786 struct qeth_card {
787         struct list_head list;
788         enum qeth_card_states state;
789         int lan_online;
790         spinlock_t lock;
791 /*hardware and sysfs stuff*/
792         struct ccwgroup_device *gdev;
793         struct qeth_channel read;
794         struct qeth_channel write;
795         struct qeth_channel data;
796
797         struct net_device *dev;
798         struct net_device_stats stats;
799
800         struct qeth_card_info info;
801         struct qeth_token token;
802         struct qeth_seqno seqno;
803         struct qeth_card_options options;
804
805         wait_queue_head_t wait_q;
806 #ifdef CONFIG_QETH_VLAN
807         spinlock_t vlanlock;
808         struct vlan_group *vlangrp;
809 #endif
810         struct work_struct kernel_thread_starter;
811         spinlock_t thread_mask_lock;
812         volatile unsigned long thread_start_mask;
813         volatile unsigned long thread_allowed_mask;
814         volatile unsigned long thread_running_mask;
815         spinlock_t ip_lock;
816         struct list_head ip_list;
817         struct list_head *ip_tbd_list;
818         struct qeth_ipato ipato;
819         struct list_head cmd_waiter_list;
820         /* QDIO buffer handling */
821         struct qeth_qdio_info qdio;
822 #ifdef CONFIG_QETH_PERF_STATS
823         struct qeth_perf_stats perf_stats;
824 #endif /* CONFIG_QETH_PERF_STATS */
825         int use_hard_stop;
826         int (*orig_hard_header)(struct sk_buff *,struct net_device *,
827                                 unsigned short,void *,void *,unsigned);
828         struct qeth_osn_info osn_info; 
829 };
830
831 struct qeth_card_list_struct {
832         struct list_head list;
833         rwlock_t rwlock;
834 };
835
836 extern struct qeth_card_list_struct qeth_card_list;
837
838 /*notifier list */
839 struct qeth_notify_list_struct {
840         struct list_head list;
841         struct task_struct *task;
842         int signum;
843 };
844 extern spinlock_t qeth_notify_lock;
845 extern struct list_head qeth_notify_list;
846
847 /*some helper functions*/
848
849 #define QETH_CARD_IFNAME(card) (((card)->dev)? (card)->dev->name : "")
850
851 static inline __u8
852 qeth_get_ipa_adp_type(enum qeth_link_types link_type)
853 {
854         switch (link_type) {
855         case QETH_LINK_TYPE_HSTR:
856                 return 2;
857         default:
858                 return 1;
859         }
860 }
861
862 static inline int
863 qeth_realloc_headroom(struct qeth_card *card, struct sk_buff **skb, int size)
864 {
865         struct sk_buff *new_skb = NULL;
866
867         if (skb_headroom(*skb) < size){
868                 new_skb = skb_realloc_headroom(*skb, size);
869                 if (!new_skb) {
870                         PRINT_ERR("qeth_prepare_skb: could "
871                                   "not realloc headroom for qeth_hdr "
872                                   "on interface %s", QETH_CARD_IFNAME(card));
873                         return -ENOMEM;
874                 }
875                 kfree_skb(*skb);
876                 *skb = new_skb;
877         }
878         return 0;
879 }
880
881 static inline struct sk_buff *
882 qeth_pskb_unshare(struct sk_buff *skb, int pri)
883 {
884         struct sk_buff *nskb;
885         if (!skb_cloned(skb))
886                 return skb;
887         nskb = skb_copy(skb, pri);
888         kfree_skb(skb); /* free our shared copy */
889         return nskb;
890 }
891
892 static inline void *
893 qeth_push_skb(struct qeth_card *card, struct sk_buff **skb, int size)
894 {
895         void *hdr;
896
897         hdr = (void *) skb_push(*skb, size);
898         /*
899          * sanity check, the Linux memory allocation scheme should
900          * never present us cases like this one (the qdio header size plus
901          * the first 40 bytes of the paket cross a 4k boundary)
902          */
903         if ((((unsigned long) hdr) & (~(PAGE_SIZE - 1))) !=
904             (((unsigned long) hdr + size +
905               QETH_IP_HEADER_SIZE) & (~(PAGE_SIZE - 1)))) {
906                 PRINT_ERR("qeth_prepare_skb: misaligned "
907                           "packet on interface %s. Discarded.",
908                           QETH_CARD_IFNAME(card));
909                 return NULL;
910         }
911         return hdr;
912 }
913
914
915 static inline int
916 qeth_get_hlen(__u8 link_type)
917 {
918 #ifdef CONFIG_QETH_IPV6
919         switch (link_type) {
920         case QETH_LINK_TYPE_HSTR:
921         case QETH_LINK_TYPE_LANE_TR:
922                 return sizeof(struct qeth_hdr_tso) + TR_HLEN;
923         default:
924 #ifdef CONFIG_QETH_VLAN
925                 return sizeof(struct qeth_hdr_tso) + VLAN_ETH_HLEN;
926 #else
927                 return sizeof(struct qeth_hdr_tso) + ETH_HLEN;
928 #endif
929         }
930 #else  /* CONFIG_QETH_IPV6 */
931 #ifdef CONFIG_QETH_VLAN
932         return sizeof(struct qeth_hdr_tso) + VLAN_HLEN;
933 #else
934         return sizeof(struct qeth_hdr_tso);
935 #endif
936 #endif /* CONFIG_QETH_IPV6 */
937 }
938
939 static inline unsigned short
940 qeth_get_netdev_flags(struct qeth_card *card)
941 {
942         if (card->options.layer2 &&
943            (card->info.type == QETH_CARD_TYPE_OSAE))
944                 return 0;
945         switch (card->info.type) {
946         case QETH_CARD_TYPE_IQD:
947         case QETH_CARD_TYPE_OSN:        
948                 return IFF_NOARP;
949 #ifdef CONFIG_QETH_IPV6
950         default:
951                 return 0;
952 #else
953         default:
954                 return IFF_NOARP;
955 #endif
956         }
957 }
958
959 static inline int
960 qeth_get_initial_mtu_for_card(struct qeth_card * card)
961 {
962         switch (card->info.type) {
963         case QETH_CARD_TYPE_UNKNOWN:
964                 return 1500;
965         case QETH_CARD_TYPE_IQD:
966                 return card->info.max_mtu;
967         case QETH_CARD_TYPE_OSAE:
968                 switch (card->info.link_type) {
969                 case QETH_LINK_TYPE_HSTR:
970                 case QETH_LINK_TYPE_LANE_TR:
971                         return 2000;
972                 default:
973                         return 1492;
974                 }
975         default:
976                 return 1500;
977         }
978 }
979
980 static inline int
981 qeth_get_max_mtu_for_card(int cardtype)
982 {
983         switch (cardtype) {
984                 
985         case QETH_CARD_TYPE_UNKNOWN:
986         case QETH_CARD_TYPE_OSAE:
987         case QETH_CARD_TYPE_OSN:
988                 return 61440;
989         case QETH_CARD_TYPE_IQD:
990                 return 57344;
991         default:
992                 return 1500;
993         }
994 }
995
996 static inline int
997 qeth_get_mtu_out_of_mpc(int cardtype)
998 {
999         switch (cardtype) {
1000         case QETH_CARD_TYPE_IQD:
1001                 return 1;
1002         default:
1003                 return 0;
1004         }
1005 }
1006
1007 static inline int
1008 qeth_get_mtu_outof_framesize(int framesize)
1009 {
1010         switch (framesize) {
1011         case 0x4000:
1012                 return 8192;
1013         case 0x6000:
1014                 return 16384;
1015         case 0xa000:
1016                 return 32768;
1017         case 0xffff:
1018                 return 57344;
1019         default:
1020                 return 0;
1021         }
1022 }
1023
1024 static inline int
1025 qeth_mtu_is_valid(struct qeth_card * card, int mtu)
1026 {
1027         switch (card->info.type) {
1028         case QETH_CARD_TYPE_OSAE:
1029                 return ((mtu >= 576) && (mtu <= 61440));
1030         case QETH_CARD_TYPE_IQD:
1031                 return ((mtu >= 576) &&
1032                         (mtu <= card->info.max_mtu + 4096 - 32));
1033         case QETH_CARD_TYPE_OSN:
1034         case QETH_CARD_TYPE_UNKNOWN:
1035         default:
1036                 return 1;
1037         }
1038 }
1039
1040 static inline int
1041 qeth_get_arphdr_type(int cardtype, int linktype)
1042 {
1043         switch (cardtype) {
1044         case QETH_CARD_TYPE_OSAE:
1045         case QETH_CARD_TYPE_OSN:
1046                 switch (linktype) {
1047                 case QETH_LINK_TYPE_LANE_TR:
1048                 case QETH_LINK_TYPE_HSTR:
1049                         return ARPHRD_IEEE802_TR;
1050                 default:
1051                         return ARPHRD_ETHER;
1052                 }
1053         case QETH_CARD_TYPE_IQD:
1054         default:
1055                 return ARPHRD_ETHER;
1056         }
1057 }
1058
1059 #ifdef CONFIG_QETH_PERF_STATS
1060 static inline int
1061 qeth_get_micros(void)
1062 {
1063         return (int) (get_clock() >> 12);
1064 }
1065 #endif
1066
1067 static inline int
1068 qeth_get_qdio_q_format(struct qeth_card *card)
1069 {
1070         switch (card->info.type) {
1071         case QETH_CARD_TYPE_IQD:
1072                 return 2;
1073         default:
1074                 return 0;
1075         }
1076 }
1077
1078 static inline int
1079 qeth_isxdigit(char * buf)
1080 {
1081         while (*buf) {
1082                 if (!isxdigit(*buf++))
1083                         return 0;
1084         }
1085         return 1;
1086 }
1087
1088 static inline void
1089 qeth_ipaddr4_to_string(const __u8 *addr, char *buf)
1090 {
1091         sprintf(buf, "%i.%i.%i.%i", addr[0], addr[1], addr[2], addr[3]);
1092 }
1093
1094 static inline int
1095 qeth_string_to_ipaddr4(const char *buf, __u8 *addr)
1096 {
1097         int count = 0, rc = 0;
1098         int in[4];
1099
1100         rc = sscanf(buf, "%d.%d.%d.%d%n", 
1101                     &in[0], &in[1], &in[2], &in[3], &count);
1102         if (rc != 4  || count) 
1103                 return -EINVAL;
1104         for (count = 0; count < 4; count++) {
1105                 if (in[count] > 255)
1106                         return -EINVAL;
1107                 addr[count] = in[count];
1108         }
1109         return 0;
1110 }
1111
1112 static inline void
1113 qeth_ipaddr6_to_string(const __u8 *addr, char *buf)
1114 {
1115         sprintf(buf, "%02x%02x:%02x%02x:%02x%02x:%02x%02x"
1116                      ":%02x%02x:%02x%02x:%02x%02x:%02x%02x",
1117                      addr[0], addr[1], addr[2], addr[3],
1118                      addr[4], addr[5], addr[6], addr[7],
1119                      addr[8], addr[9], addr[10], addr[11],
1120                      addr[12], addr[13], addr[14], addr[15]);
1121 }
1122
1123 static inline int
1124 qeth_string_to_ipaddr6(const char *buf, __u8 *addr)
1125 {
1126         char *end, *start;
1127         __u16 *in;
1128         char num[5];
1129         int num2, cnt, out, found, save_cnt;
1130         unsigned short in_tmp[8] = {0, };
1131
1132         cnt = out = found = save_cnt = num2 = 0;
1133         end = start = (char *) buf;
1134         in = (__u16 *) addr;    
1135         memset(in, 0, 16);
1136         while (end) {
1137                 end = strchr(end,':');
1138                 if (end == NULL) {
1139                         end = (char *)buf + (strlen(buf));
1140                         out = 1;
1141                 }
1142                 if ((end - start)) { 
1143                         memset(num, 0, 5);
1144                         memcpy(num, start, end - start);
1145                         if (!qeth_isxdigit(num))
1146                                 return -EINVAL;
1147                         sscanf(start, "%x", &num2);
1148                         if (found)
1149                                 in_tmp[save_cnt++] = num2;
1150                         else
1151                                 in[cnt++] = num2;
1152                         if (out)
1153                                 break;
1154                 } else {
1155                         if (found)
1156                                 return -EINVAL;
1157                         found = 1;
1158                 }
1159                 start = ++end;
1160         }
1161         cnt = 7;
1162         while (save_cnt)
1163                 in[cnt--] = in_tmp[--save_cnt];
1164         return 0;
1165 }
1166
1167 static inline void
1168 qeth_ipaddr_to_string(enum qeth_prot_versions proto, const __u8 *addr,
1169                       char *buf)
1170 {
1171         if (proto == QETH_PROT_IPV4)
1172                 return qeth_ipaddr4_to_string(addr, buf);
1173         else if (proto == QETH_PROT_IPV6)
1174                 return qeth_ipaddr6_to_string(addr, buf);
1175 }
1176
1177 static inline int
1178 qeth_string_to_ipaddr(const char *buf, enum qeth_prot_versions proto,
1179                       __u8 *addr)
1180 {
1181         if (proto == QETH_PROT_IPV4)
1182                 return qeth_string_to_ipaddr4(buf, addr);
1183         else if (proto == QETH_PROT_IPV6)
1184                 return qeth_string_to_ipaddr6(buf, addr);
1185         else
1186                 return -EINVAL;
1187 }
1188
1189 extern int
1190 qeth_setrouting_v4(struct qeth_card *);
1191 extern int
1192 qeth_setrouting_v6(struct qeth_card *);
1193
1194 extern int
1195 qeth_add_ipato_entry(struct qeth_card *, struct qeth_ipato_entry *);
1196
1197 extern void
1198 qeth_del_ipato_entry(struct qeth_card *, enum qeth_prot_versions, u8 *, int);
1199
1200 extern int
1201 qeth_add_vipa(struct qeth_card *, enum qeth_prot_versions, const u8 *);
1202
1203 extern void
1204 qeth_del_vipa(struct qeth_card *, enum qeth_prot_versions, const u8 *);
1205
1206 extern int
1207 qeth_add_rxip(struct qeth_card *, enum qeth_prot_versions, const u8 *);
1208
1209 extern void
1210 qeth_del_rxip(struct qeth_card *, enum qeth_prot_versions, const u8 *);
1211
1212 extern int
1213 qeth_notifier_register(struct task_struct *, int );
1214
1215 extern int
1216 qeth_notifier_unregister(struct task_struct * );
1217
1218 extern void
1219 qeth_schedule_recovery(struct qeth_card *);
1220
1221 extern int
1222 qeth_realloc_buffer_pool(struct qeth_card *, int);
1223
1224 extern int
1225 qeth_set_large_send(struct qeth_card *, enum qeth_large_send_types);
1226
1227 extern void
1228 qeth_fill_header(struct qeth_card *, struct qeth_hdr *,
1229                  struct sk_buff *, int, int);
1230 extern void
1231 qeth_flush_buffers(struct qeth_qdio_out_q *, int, int, int);
1232
1233 extern int
1234 qeth_osn_assist(struct net_device *, void *, int);
1235
1236 extern int
1237 qeth_osn_register(unsigned char *read_dev_no,
1238                  struct net_device **,
1239                  int (*assist_cb)(struct net_device *, void *),
1240                  int (*data_cb)(struct sk_buff *));
1241
1242 extern void
1243 qeth_osn_deregister(struct net_device *);
1244                 
1245 #endif /* __QETH_H__ */