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