b645fa0f3f64db3b3c2bc4bb9889517aecc328ce
[linux-2.6.git] / drivers / net / atl1e / atl1e.h
1 /*
2  * Copyright(c) 2007 Atheros Corporation. All rights reserved.
3  * Copyright(c) 2007 xiong huang <xiong.huang@atheros.com>
4  *
5  * Derived from Intel e1000 driver
6  * Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License as published by the Free
10  * Software Foundation; either version 2 of the License, or (at your option)
11  * any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
16  * more details.
17  *
18  * You should have received a copy of the GNU General Public License along with
19  * this program; if not, write to the Free Software Foundation, Inc., 59
20  * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  */
22
23 #ifndef _ATL1E_H_
24 #define _ATL1E_H_
25
26 #include <linux/version.h>
27 #include <linux/init.h>
28 #include <linux/types.h>
29 #include <linux/errno.h>
30 #include <linux/module.h>
31 #include <linux/pci.h>
32 #include <linux/netdevice.h>
33 #include <linux/etherdevice.h>
34 #include <linux/skbuff.h>
35 #include <linux/ioport.h>
36 #include <linux/slab.h>
37 #include <linux/list.h>
38 #include <linux/delay.h>
39 #include <linux/sched.h>
40 #include <linux/in.h>
41 #include <linux/ip.h>
42 #include <linux/ipv6.h>
43 #include <linux/udp.h>
44 #include <linux/mii.h>
45 #include <linux/io.h>
46 #include <linux/vmalloc.h>
47 #include <linux/pagemap.h>
48 #include <linux/tcp.h>
49 #include <linux/mii.h>
50 #include <linux/ethtool.h>
51 #include <linux/if_vlan.h>
52 #include <linux/workqueue.h>
53 #include <net/checksum.h>
54 #include <net/ip6_checksum.h>
55
56 #include "atl1e_hw.h"
57
58 #define PCI_REG_COMMAND  0x04    /* PCI Command Register */
59 #define CMD_IO_SPACE     0x0001
60 #define CMD_MEMORY_SPACE 0x0002
61 #define CMD_BUS_MASTER   0x0004
62
63 #define BAR_0   0
64 #define BAR_1   1
65 #define BAR_5   5
66
67 /* Wake Up Filter Control */
68 #define AT_WUFC_LNKC 0x00000001 /* Link Status Change Wakeup Enable */
69 #define AT_WUFC_MAG  0x00000002 /* Magic Packet Wakeup Enable */
70 #define AT_WUFC_EX   0x00000004 /* Directed Exact Wakeup Enable */
71 #define AT_WUFC_MC   0x00000008 /* Multicast Wakeup Enable */
72 #define AT_WUFC_BC   0x00000010 /* Broadcast Wakeup Enable */
73
74 #define SPEED_0            0xffff
75 #define HALF_DUPLEX        1
76 #define FULL_DUPLEX        2
77
78 /* Error Codes */
79 #define AT_ERR_EEPROM      1
80 #define AT_ERR_PHY         2
81 #define AT_ERR_CONFIG      3
82 #define AT_ERR_PARAM       4
83 #define AT_ERR_MAC_TYPE    5
84 #define AT_ERR_PHY_TYPE    6
85 #define AT_ERR_PHY_SPEED   7
86 #define AT_ERR_PHY_RES     8
87 #define AT_ERR_TIMEOUT     9
88
89 #define MAX_JUMBO_FRAME_SIZE 0x2000
90
91 #define AT_VLAN_TAG_TO_TPD_TAG(_vlan, _tpd)    \
92         _tpd = (((_vlan) << (4)) | (((_vlan) >> 13) & 7) |\
93                  (((_vlan) >> 9) & 8))
94
95 #define AT_TPD_TAG_TO_VLAN_TAG(_tpd, _vlan)    \
96         _vlan = (((_tpd) >> 8) | (((_tpd) & 0x77) << 9) |\
97                    (((_tdp) & 0x88) << 5))
98
99 #define AT_MAX_RECEIVE_QUEUE    4
100 #define AT_PAGE_NUM_PER_QUEUE   2
101
102 #define AT_DMA_HI_ADDR_MASK     0xffffffff00000000ULL
103 #define AT_DMA_LO_ADDR_MASK     0x00000000ffffffffULL
104
105 #define AT_TX_WATCHDOG  (5 * HZ)
106 #define AT_MAX_INT_WORK         10
107 #define AT_TWSI_EEPROM_TIMEOUT  100
108 #define AT_HW_MAX_IDLE_DELAY    10
109 #define AT_SUSPEND_LINK_TIMEOUT 28
110
111 #define AT_REGS_LEN     75
112 #define AT_EEPROM_LEN   512
113 #define AT_ADV_MASK     (ADVERTISE_10_HALF  |\
114                          ADVERTISE_10_FULL  |\
115                          ADVERTISE_100_HALF |\
116                          ADVERTISE_100_FULL |\
117                          ADVERTISE_1000_FULL)
118
119 /* tpd word 2 */
120 #define TPD_BUFLEN_MASK         0x3FFF
121 #define TPD_BUFLEN_SHIFT        0
122 #define TPD_DMAINT_MASK         0x0001
123 #define TPD_DMAINT_SHIFT        14
124 #define TPD_PKTNT_MASK          0x0001
125 #define TPD_PKTINT_SHIFT        15
126 #define TPD_VLANTAG_MASK        0xFFFF
127 #define TPD_VLAN_SHIFT          16
128
129 /* tpd word 3 bits 0:4 */
130 #define TPD_EOP_MASK            0x0001
131 #define TPD_EOP_SHIFT           0
132 #define TPD_IP_VERSION_MASK     0x0001
133 #define TPD_IP_VERSION_SHIFT    1       /* 0 : IPV4, 1 : IPV6 */
134 #define TPD_INS_VL_TAG_MASK     0x0001
135 #define TPD_INS_VL_TAG_SHIFT    2
136 #define TPD_CC_SEGMENT_EN_MASK  0x0001
137 #define TPD_CC_SEGMENT_EN_SHIFT 3
138 #define TPD_SEGMENT_EN_MASK     0x0001
139 #define TPD_SEGMENT_EN_SHIFT    4
140
141 /* tdp word 3 bits 5:7 if ip version is 0 */
142 #define TPD_IP_CSUM_MASK        0x0001
143 #define TPD_IP_CSUM_SHIFT       5
144 #define TPD_TCP_CSUM_MASK       0x0001
145 #define TPD_TCP_CSUM_SHIFT      6
146 #define TPD_UDP_CSUM_MASK       0x0001
147 #define TPD_UDP_CSUM_SHIFT      7
148
149 /* tdp word 3 bits 5:7 if ip version is 1 */
150 #define TPD_V6_IPHLLO_MASK      0x0007
151 #define TPD_V6_IPHLLO_SHIFT     7
152
153 /* tpd word 3 bits 8:9 bit */
154 #define TPD_VL_TAGGED_MASK      0x0001
155 #define TPD_VL_TAGGED_SHIFT     8
156 #define TPD_ETHTYPE_MASK        0x0001
157 #define TPD_ETHTYPE_SHIFT       9
158
159 /* tdp word 3 bits 10:13 if ip version is 0 */
160 #define TDP_V4_IPHL_MASK        0x000F
161 #define TPD_V4_IPHL_SHIFT       10
162
163 /* tdp word 3 bits 10:13 if ip version is 1 */
164 #define TPD_V6_IPHLHI_MASK      0x000F
165 #define TPD_V6_IPHLHI_SHIFT     10
166
167 /* tpd word 3 bit 14:31 if segment enabled */
168 #define TPD_TCPHDRLEN_MASK      0x000F
169 #define TPD_TCPHDRLEN_SHIFT     14
170 #define TPD_HDRFLAG_MASK        0x0001
171 #define TPD_HDRFLAG_SHIFT       18
172 #define TPD_MSS_MASK            0x1FFF
173 #define TPD_MSS_SHIFT           19
174
175 /* tdp word 3 bit 16:31 if custom csum enabled */
176 #define TPD_PLOADOFFSET_MASK    0x00FF
177 #define TPD_PLOADOFFSET_SHIFT   16
178 #define TPD_CCSUMOFFSET_MASK    0x00FF
179 #define TPD_CCSUMOFFSET_SHIFT   24
180
181 struct atl1e_tpd_desc {
182         __le64 buffer_addr;
183         __le32 word2;
184         __le32 word3;
185 };
186
187 /* how about 0x2000 */
188 #define MAX_TX_BUF_LEN      0x2000
189 #define MAX_TX_BUF_SHIFT    13
190 /*#define MAX_TX_BUF_LEN  0x3000 */
191
192 /* rrs word 1 bit 0:31 */
193 #define RRS_RX_CSUM_MASK        0xFFFF
194 #define RRS_RX_CSUM_SHIFT       0
195 #define RRS_PKT_SIZE_MASK       0x3FFF
196 #define RRS_PKT_SIZE_SHIFT      16
197 #define RRS_CPU_NUM_MASK        0x0003
198 #define RRS_CPU_NUM_SHIFT       30
199
200 #define RRS_IS_RSS_IPV4         0x0001
201 #define RRS_IS_RSS_IPV4_TCP     0x0002
202 #define RRS_IS_RSS_IPV6         0x0004
203 #define RRS_IS_RSS_IPV6_TCP     0x0008
204 #define RRS_IS_IPV6             0x0010
205 #define RRS_IS_IP_FRAG          0x0020
206 #define RRS_IS_IP_DF            0x0040
207 #define RRS_IS_802_3            0x0080
208 #define RRS_IS_VLAN_TAG         0x0100
209 #define RRS_IS_ERR_FRAME        0x0200
210 #define RRS_IS_IPV4             0x0400
211 #define RRS_IS_UDP              0x0800
212 #define RRS_IS_TCP              0x1000
213 #define RRS_IS_BCAST            0x2000
214 #define RRS_IS_MCAST            0x4000
215 #define RRS_IS_PAUSE            0x8000
216
217 #define RRS_ERR_BAD_CRC         0x0001
218 #define RRS_ERR_CODE            0x0002
219 #define RRS_ERR_DRIBBLE         0x0004
220 #define RRS_ERR_RUNT            0x0008
221 #define RRS_ERR_RX_OVERFLOW     0x0010
222 #define RRS_ERR_TRUNC           0x0020
223 #define RRS_ERR_IP_CSUM         0x0040
224 #define RRS_ERR_L4_CSUM         0x0080
225 #define RRS_ERR_LENGTH          0x0100
226 #define RRS_ERR_DES_ADDR        0x0200
227
228 struct atl1e_recv_ret_status {
229         u16 seq_num;
230         u16 hash_lo;
231         __le32  word1;
232         u16 pkt_flag;
233         u16 err_flag;
234         u16 hash_hi;
235         u16 vtag;
236 };
237
238 enum atl1e_dma_req_block {
239         atl1e_dma_req_128 = 0,
240         atl1e_dma_req_256 = 1,
241         atl1e_dma_req_512 = 2,
242         atl1e_dma_req_1024 = 3,
243         atl1e_dma_req_2048 = 4,
244         atl1e_dma_req_4096 = 5
245 };
246
247 enum atl1e_rrs_type {
248         atl1e_rrs_disable = 0,
249         atl1e_rrs_ipv4 = 1,
250         atl1e_rrs_ipv4_tcp = 2,
251         atl1e_rrs_ipv6 = 4,
252         atl1e_rrs_ipv6_tcp = 8
253 };
254
255 enum atl1e_nic_type {
256         athr_l1e = 0,
257         athr_l2e_revA = 1,
258         athr_l2e_revB = 2
259 };
260
261 struct atl1e_hw_stats {
262         /* rx */
263         unsigned long rx_ok;          /* The number of good packet received. */
264         unsigned long rx_bcast;       /* The number of good broadcast packet received. */
265         unsigned long rx_mcast;       /* The number of good multicast packet received. */
266         unsigned long rx_pause;       /* The number of Pause packet received. */
267         unsigned long rx_ctrl;        /* The number of Control packet received other than Pause frame. */
268         unsigned long rx_fcs_err;     /* The number of packets with bad FCS. */
269         unsigned long rx_len_err;     /* The number of packets with mismatch of length field and actual size. */
270         unsigned long rx_byte_cnt;    /* The number of bytes of good packet received. FCS is NOT included. */
271         unsigned long rx_runt;        /* The number of packets received that are less than 64 byte long and with good FCS. */
272         unsigned long rx_frag;        /* The number of packets received that are less than 64 byte long and with bad FCS. */
273         unsigned long rx_sz_64;       /* The number of good and bad packets received that are 64 byte long. */
274         unsigned long rx_sz_65_127;   /* The number of good and bad packets received that are between 65 and 127-byte long. */
275         unsigned long rx_sz_128_255;  /* The number of good and bad packets received that are between 128 and 255-byte long. */
276         unsigned long rx_sz_256_511;  /* The number of good and bad packets received that are between 256 and 511-byte long. */
277         unsigned long rx_sz_512_1023; /* The number of good and bad packets received that are between 512 and 1023-byte long. */
278         unsigned long rx_sz_1024_1518;    /* The number of good and bad packets received that are between 1024 and 1518-byte long. */
279         unsigned long rx_sz_1519_max; /* The number of good and bad packets received that are between 1519-byte and MTU. */
280         unsigned long rx_sz_ov;       /* The number of good and bad packets received that are more than MTU size truncated by Selene. */
281         unsigned long rx_rxf_ov;      /* The number of frame dropped due to occurrence of RX FIFO overflow. */
282         unsigned long rx_rrd_ov;      /* The number of frame dropped due to occurrence of RRD overflow. */
283         unsigned long rx_align_err;   /* Alignment Error */
284         unsigned long rx_bcast_byte_cnt;  /* The byte count of broadcast packet received, excluding FCS. */
285         unsigned long rx_mcast_byte_cnt;  /* The byte count of multicast packet received, excluding FCS. */
286         unsigned long rx_err_addr;    /* The number of packets dropped due to address filtering. */
287
288         /* tx */
289         unsigned long tx_ok;      /* The number of good packet transmitted. */
290         unsigned long tx_bcast;       /* The number of good broadcast packet transmitted. */
291         unsigned long tx_mcast;       /* The number of good multicast packet transmitted. */
292         unsigned long tx_pause;       /* The number of Pause packet transmitted. */
293         unsigned long tx_exc_defer;   /* The number of packets transmitted with excessive deferral. */
294         unsigned long tx_ctrl;        /* The number of packets transmitted is a control frame, excluding Pause frame. */
295         unsigned long tx_defer;       /* The number of packets transmitted that is deferred. */
296         unsigned long tx_byte_cnt;    /* The number of bytes of data transmitted. FCS is NOT included. */
297         unsigned long tx_sz_64;       /* The number of good and bad packets transmitted that are 64 byte long. */
298         unsigned long tx_sz_65_127;   /* The number of good and bad packets transmitted that are between 65 and 127-byte long. */
299         unsigned long tx_sz_128_255;  /* The number of good and bad packets transmitted that are between 128 and 255-byte long. */
300         unsigned long tx_sz_256_511;  /* The number of good and bad packets transmitted that are between 256 and 511-byte long. */
301         unsigned long tx_sz_512_1023; /* The number of good and bad packets transmitted that are between 512 and 1023-byte long. */
302         unsigned long tx_sz_1024_1518;    /* The number of good and bad packets transmitted that are between 1024 and 1518-byte long. */
303         unsigned long tx_sz_1519_max; /* The number of good and bad packets transmitted that are between 1519-byte and MTU. */
304         unsigned long tx_1_col;       /* The number of packets subsequently transmitted successfully with a single prior collision. */
305         unsigned long tx_2_col;       /* The number of packets subsequently transmitted successfully with multiple prior collisions. */
306         unsigned long tx_late_col;    /* The number of packets transmitted with late collisions. */
307         unsigned long tx_abort_col;   /* The number of transmit packets aborted due to excessive collisions. */
308         unsigned long tx_underrun;    /* The number of transmit packets aborted due to transmit FIFO underrun, or TRD FIFO underrun */
309         unsigned long tx_rd_eop;      /* The number of times that read beyond the EOP into the next frame area when TRD was not written timely */
310         unsigned long tx_len_err;     /* The number of transmit packets with length field does NOT match the actual frame size. */
311         unsigned long tx_trunc;       /* The number of transmit packets truncated due to size exceeding MTU. */
312         unsigned long tx_bcast_byte;  /* The byte count of broadcast packet transmitted, excluding FCS. */
313         unsigned long tx_mcast_byte;  /* The byte count of multicast packet transmitted, excluding FCS. */
314 };
315
316 struct atl1e_hw {
317         u8 __iomem      *hw_addr;            /* inner register address */
318         resource_size_t mem_rang;
319         struct atl1e_adapter *adapter;
320         enum atl1e_nic_type  nic_type;
321         u16 device_id;
322         u16 vendor_id;
323         u16 subsystem_id;
324         u16 subsystem_vendor_id;
325         u8  revision_id;
326         u16 pci_cmd_word;
327         u8 mac_addr[ETH_ALEN];
328         u8 perm_mac_addr[ETH_ALEN];
329         u8 preamble_len;
330         u16 max_frame_size;
331         u16 rx_jumbo_th;
332         u16 tx_jumbo_th;
333
334         u16 media_type;
335 #define MEDIA_TYPE_AUTO_SENSOR  0
336 #define MEDIA_TYPE_100M_FULL    1
337 #define MEDIA_TYPE_100M_HALF    2
338 #define MEDIA_TYPE_10M_FULL     3
339 #define MEDIA_TYPE_10M_HALF     4
340
341         u16 autoneg_advertised;
342 #define ADVERTISE_10_HALF               0x0001
343 #define ADVERTISE_10_FULL               0x0002
344 #define ADVERTISE_100_HALF              0x0004
345 #define ADVERTISE_100_FULL              0x0008
346 #define ADVERTISE_1000_HALF             0x0010 /* Not used, just FYI */
347 #define ADVERTISE_1000_FULL             0x0020
348         u16 mii_autoneg_adv_reg;
349         u16 mii_1000t_ctrl_reg;
350
351         u16 imt;        /* Interrupt Moderator timer ( 2us resolution) */
352         u16 ict;        /* Interrupt Clear timer (2us resolution) */
353         u32 smb_timer;
354         u16 rrd_thresh; /* Threshold of number of RRD produced to trigger
355                           interrupt request */
356         u16 tpd_thresh;
357         u16 rx_count_down; /* 2us resolution */
358         u16 tx_count_down;
359
360         u8 tpd_burst;   /* Number of TPD to prefetch in cache-aligned burst. */
361         enum atl1e_rrs_type rrs_type;
362         u32 base_cpu;
363         u32 indirect_tab;
364
365         enum atl1e_dma_req_block dmar_block;
366         enum atl1e_dma_req_block dmaw_block;
367         u8 dmaw_dly_cnt;
368         u8 dmar_dly_cnt;
369
370         bool phy_configured;
371         bool re_autoneg;
372         bool emi_ca;
373 };
374
375 /*
376  * wrapper around a pointer to a socket buffer,
377  * so a DMA handle can be stored along with the buffer
378  */
379 struct atl1e_tx_buffer {
380         struct sk_buff *skb;
381         u16 length;
382         dma_addr_t dma;
383 };
384
385 struct atl1e_rx_page {
386         dma_addr_t      dma;    /* receive rage DMA address */
387         u8              *addr;   /* receive rage virtual address */
388         dma_addr_t      write_offset_dma;  /* the DMA address which contain the
389                                               receive data offset in the page */
390         u32             *write_offset_addr; /* the virtaul address which contain
391                                              the receive data offset in the page */
392         u32             read_offset;       /* the offset where we have read */
393 };
394
395 struct atl1e_rx_page_desc {
396         struct atl1e_rx_page   rx_page[AT_PAGE_NUM_PER_QUEUE];
397         u8  rx_using;
398         u16 rx_nxseq;
399 };
400
401 /* transmit packet descriptor (tpd) ring */
402 struct atl1e_tx_ring {
403         struct atl1e_tpd_desc *desc;  /* descriptor ring virtual address  */
404         dma_addr_t         dma;    /* descriptor ring physical address */
405         u16                count;  /* the count of transmit rings  */
406         rwlock_t           tx_lock;
407         u16                next_to_use;
408         atomic_t           next_to_clean;
409         struct atl1e_tx_buffer *tx_buffer;
410         dma_addr_t         cmb_dma;
411         u32                *cmb;
412 };
413
414 /* receive packet descriptor ring */
415 struct atl1e_rx_ring {
416         void            *desc;
417         dma_addr_t      dma;
418         int             size;
419         u32             page_size; /* bytes length of rxf page */
420         u32             real_page_size; /* real_page_size = page_size + jumbo + aliagn */
421         struct atl1e_rx_page_desc       rx_page_desc[AT_MAX_RECEIVE_QUEUE];
422 };
423
424 /* board specific private data structure */
425 struct atl1e_adapter {
426         struct net_device   *netdev;
427         struct pci_dev      *pdev;
428         struct vlan_group   *vlgrp;
429         struct napi_struct  napi;
430         struct mii_if_info  mii;    /* MII interface info */
431         struct atl1e_hw        hw;
432         struct atl1e_hw_stats  hw_stats;
433         struct net_device_stats net_stats;
434
435         bool have_msi;
436         u32 wol;
437         u16 link_speed;
438         u16 link_duplex;
439
440         spinlock_t mdio_lock;
441         spinlock_t tx_lock;
442         atomic_t irq_sem;
443
444         struct work_struct reset_task;
445         struct work_struct link_chg_task;
446         struct timer_list watchdog_timer;
447         struct timer_list phy_config_timer;
448
449         /* All Descriptor memory */
450         dma_addr_t      ring_dma;
451         void            *ring_vir_addr;
452         int             ring_size;
453
454         struct atl1e_tx_ring tx_ring;
455         struct atl1e_rx_ring rx_ring;
456         int num_rx_queues;
457         unsigned long flags;
458 #define __AT_TESTING        0x0001
459 #define __AT_RESETTING      0x0002
460 #define __AT_DOWN           0x0003
461
462         u32 bd_number;     /* board number;*/
463         u32 pci_state[16];
464         u32 *config_space;
465 };
466
467 #define AT_WRITE_REG(a, reg, value) ( \
468                 writel((value), ((a)->hw_addr + reg)))
469
470 #define AT_WRITE_FLUSH(a) (\
471                 readl((a)->hw_addr))
472
473 #define AT_READ_REG(a, reg) ( \
474                 readl((a)->hw_addr + reg))
475
476 #define AT_WRITE_REGB(a, reg, value) (\
477                 writeb((value), ((a)->hw_addr + reg)))
478
479 #define AT_READ_REGB(a, reg) (\
480                 readb((a)->hw_addr + reg))
481
482 #define AT_WRITE_REGW(a, reg, value) (\
483                 writew((value), ((a)->hw_addr + reg)))
484
485 #define AT_READ_REGW(a, reg) (\
486                 readw((a)->hw_addr + reg))
487
488 #define AT_WRITE_REG_ARRAY(a, reg, offset, value) ( \
489                 writel((value), (((a)->hw_addr + reg) + ((offset) << 2))))
490
491 #define AT_READ_REG_ARRAY(a, reg, offset) ( \
492                 readl(((a)->hw_addr + reg) + ((offset) << 2)))
493
494 extern char atl1e_driver_name[];
495 extern char atl1e_driver_version[];
496
497 extern void atl1e_check_options(struct atl1e_adapter *adapter);
498 extern int atl1e_up(struct atl1e_adapter *adapter);
499 extern void atl1e_down(struct atl1e_adapter *adapter);
500 extern void atl1e_reinit_locked(struct atl1e_adapter *adapter);
501 extern s32 atl1e_reset_hw(struct atl1e_hw *hw);
502 extern void atl1e_set_ethtool_ops(struct net_device *netdev);
503 #endif /* _ATL1_E_H_ */