e0664e38cb0c08f0b11f27f24d57ba22ff8313d4
[people/mcb30/gpxe.git] / src / drivers / net / e1000 / e1000.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2006 Intel Corporation.
5
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
23   Linux NICS <linux.nics@intel.com>
24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26
27 *******************************************************************************/
28
29 /* Linux PRO/1000 Ethernet Driver main header file */
30
31 #ifndef _E1000_H_
32 #define _E1000_H_
33
34 #include <stdint.h>
35 #include <stdlib.h>
36 #include <stdio.h>
37 #include <gpxe/io.h>
38 #include <errno.h>
39 #include <byteswap.h>
40 #include <gpxe/pci.h>
41 #include <gpxe/malloc.h>
42 #include <gpxe/if_ether.h>
43 #include <gpxe/ethernet.h>
44 #include <gpxe/iobuf.h>
45 #include <gpxe/netdevice.h>
46
47 #define BAR_0           0
48 #define BAR_1           1
49 #define BAR_5           5
50
51 struct e1000_adapter;
52
53 #include "e1000_hw.h"
54
55 /* Supported Rx Buffer Sizes */
56 #define E1000_RXBUFFER_128   128    /* Used for packet split */
57 #define E1000_RXBUFFER_256   256    /* Used for packet split */
58 #define E1000_RXBUFFER_512   512
59 #define E1000_RXBUFFER_1024  1024
60 #define E1000_RXBUFFER_2048  2048
61 #define E1000_RXBUFFER_4096  4096
62 #define E1000_RXBUFFER_8192  8192
63 #define E1000_RXBUFFER_16384 16384
64
65 /* SmartSpeed delimiters */
66 #define E1000_SMARTSPEED_DOWNSHIFT 3
67 #define E1000_SMARTSPEED_MAX       15
68
69 /* Packet Buffer allocations */
70 #define E1000_PBA_BYTES_SHIFT 0xA
71 #define E1000_TX_HEAD_ADDR_SHIFT 7
72 #define E1000_PBA_TX_MASK 0xFFFF0000
73
74 /* Flow Control Watermarks */
75 #define E1000_FC_HIGH_DIFF 0x1638  /* High: 5688 bytes below Rx FIFO size */
76 #define E1000_FC_LOW_DIFF 0x1640   /* Low:  5696 bytes below Rx FIFO size */
77
78 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
79
80 /* this is the size past which hardware will drop packets when setting LPE=0 */
81 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
82
83 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
84 #define E1000_TX_QUEUE_WAKE     16
85 /* How many Rx Buffers do we bundle into one write to the hardware ? */
86 #define E1000_RX_BUFFER_WRITE   16      /* Must be power of 2 */
87
88 #define AUTO_ALL_MODES            0
89 #define E1000_EEPROM_82544_APM    0x0004
90 #define E1000_EEPROM_ICH8_APME    0x0004
91 #define E1000_EEPROM_APME         0x0400
92
93 #ifndef E1000_MASTER_SLAVE
94 /* Switch to override PHY master/slave setting */
95 #define E1000_MASTER_SLAVE      e1000_ms_hw_default
96 #endif
97
98 /* wrapper around a pointer to a socket buffer,
99  * so a DMA handle can be stored along with the buffer */
100 struct e1000_buffer {
101         struct sk_buff *skb;
102         unsigned long time_stamp;
103         uint16_t length;
104         uint16_t next_to_watch;
105 };
106
107 struct e1000_tx_ring {
108         /* pointer to the descriptor ring memory */
109         void *desc;
110         /* length of descriptor ring in bytes */
111         unsigned int size;
112         /* number of descriptors in the ring */
113         unsigned int count;
114         /* next descriptor to associate a buffer with */
115         unsigned int next_to_use;
116         /* next descriptor to check for DD status bit */
117         unsigned int next_to_clean;
118         /* array of buffer information structs */
119         struct e1000_buffer *buffer_info;
120
121         uint16_t tdh;
122         uint16_t tdt;
123         boolean_t last_tx_tso;
124 };
125
126 struct e1000_rx_ring {
127         /* pointer to the descriptor ring memory */
128         void *desc;
129         /* length of descriptor ring in bytes */
130         unsigned int size;
131         /* number of descriptors in the ring */
132         unsigned int count;
133         /* next descriptor to associate a buffer with */
134         unsigned int next_to_use;
135         /* next descriptor to check for DD status bit */
136         unsigned int next_to_clean;
137         /* array of buffer information structs */
138         struct e1000_buffer *buffer_info;
139         /* arrays of page information for packet split */
140         struct e1000_ps_page *ps_page;
141         struct e1000_ps_page_dma *ps_page_dma;
142
143         /* cpu for rx queue */
144         int cpu;
145
146         uint16_t rdh;
147         uint16_t rdt;
148 };
149
150 #define E1000_DESC_UNUSED(R) \
151         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
152         (R)->next_to_clean - (R)->next_to_use - 1)
153
154 #define E1000_RX_DESC_PS(R, i)      \
155         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
156 #define E1000_RX_DESC_EXT(R, i)     \
157         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
158 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
159 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
160 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
161 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
162
163 /* board specific private data structure */
164
165 struct e1000_adapter {
166         struct vlan_group *vlgrp;
167         uint16_t mng_vlan_id;
168         uint32_t bd_number;
169         uint32_t rx_buffer_len;
170         uint32_t wol;
171         uint32_t smartspeed;
172         uint32_t en_mng_pt;
173         uint16_t link_speed;
174         uint16_t link_duplex;
175
176         unsigned int total_tx_bytes;
177         unsigned int total_tx_packets;
178         unsigned int total_rx_bytes;
179         unsigned int total_rx_packets;
180         /* Interrupt Throttle Rate */
181         uint32_t itr;
182         uint32_t itr_setting;
183         uint16_t tx_itr;
184         uint16_t rx_itr;
185
186         uint8_t fc_autoneg;
187
188         unsigned long led_status;
189
190         /* TX */
191         struct e1000_tx_ring *tx_ring;      /* One per active queue */
192         unsigned int restart_queue;
193         unsigned long tx_queue_len;
194         uint32_t txd_cmd;
195         uint32_t tx_int_delay;
196         uint32_t tx_abs_int_delay;
197         uint32_t gotcl;
198         uint64_t gotcl_old;
199         uint64_t tpt_old;
200         uint64_t colc_old;
201         uint32_t tx_timeout_count;
202         uint32_t tx_fifo_head;
203         uint32_t tx_head_addr;
204         uint32_t tx_fifo_size;
205         uint8_t  tx_timeout_factor;
206         boolean_t pcix_82544;
207         boolean_t detect_tx_hung;
208
209         /* RX */
210         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
211                                struct e1000_rx_ring *rx_ring);
212         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
213                               struct e1000_rx_ring *rx_ring,
214                                 int cleaned_count);
215         struct e1000_rx_ring *rx_ring;      /* One per active queue */
216         int num_tx_queues;
217         int num_rx_queues;
218
219         uint64_t hw_csum_err;
220         uint64_t hw_csum_good;
221         uint64_t rx_hdr_split;
222         uint32_t alloc_rx_buff_failed;
223         uint32_t rx_int_delay;
224         uint32_t rx_abs_int_delay;
225         boolean_t rx_csum;
226         unsigned int rx_ps_pages;
227         uint32_t gorcl;
228         uint64_t gorcl_old;
229         uint16_t rx_ps_bsize0;
230
231
232         /* OS defined structs */
233         struct net_device *netdev;
234         struct pci_device *pdev;
235         struct net_device_stats net_stats;
236
237         /* structs defined in e1000_hw.h */
238         struct e1000_hw hw;
239         struct e1000_hw_stats stats;
240         struct e1000_phy_info phy_info;
241         struct e1000_phy_stats phy_stats;
242
243         uint32_t test_icr;
244         struct e1000_tx_ring test_tx_ring;
245         struct e1000_rx_ring test_rx_ring;
246
247         int msg_enable;
248         boolean_t have_msi;
249
250         /* to not mess up cache alignment, always add to the bottom */
251         boolean_t tso_force;
252         boolean_t smart_power_down;     /* phy smart power down */
253         boolean_t quad_port_a;
254         unsigned long flags;
255         uint32_t eeprom_wol;
256         
257 #define NUM_TX_DESC     8
258 #define NUM_RX_DESC     8
259
260         struct io_buffer *tx_iobuf[NUM_TX_DESC];
261         struct io_buffer *rx_iobuf[NUM_RX_DESC];
262
263         struct e1000_tx_desc *tx_base;
264         struct e1000_rx_desc *rx_base;
265         
266         uint32_t tx_ring_size;
267         uint32_t rx_ring_size;
268
269         uint32_t tx_head;
270         uint32_t tx_tail;
271         uint32_t tx_fill_ctr;
272         
273         uint32_t rx_curr;
274
275         uint32_t ioaddr;
276         uint32_t irqno;
277
278 };
279
280 enum e1000_state_t {
281         __E1000_TESTING,
282         __E1000_RESETTING,
283         __E1000_DOWN
284 };
285
286 #define E1000_MNG2HOST_PORT_623 (1 << 5)
287 #define E1000_MNG2HOST_PORT_664 (1 << 6)
288
289 #define E1000_ERT_2048 0x100
290
291 #define IORESOURCE_IO           0x00000100
292 #define IORESOURCE_MEM          0x00000200
293 #define IORESOURCE_PREFETCH     0x00001000
294
295 #endif /* _E1000_H_ */
296
297 /*
298  * Local variables:
299  *  c-basic-offset: 8
300  *  c-indent-level: 8
301  *  tab-width: 8
302  * End:
303  */