Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pch_gbe.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1999 - 2010 Intel Corporation.
3  * Copyright (C) 2010 OKI SEMICONDUCTOR Co., LTD.
4  *
5  * This code was derived from the Intel e1000e Linux driver.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; version 2 of the License.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
19  */
20 
21 #ifndef _PCH_GBE_H_
22 #define _PCH_GBE_H_
23 
24 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 
26 #include <linux/mii.h>
27 #include <linux/delay.h>
28 #include <linux/pci.h>
29 #include <linux/netdevice.h>
30 #include <linux/etherdevice.h>
31 #include <linux/ethtool.h>
32 #include <linux/vmalloc.h>
33 #include <net/ip.h>
34 #include <net/tcp.h>
35 #include <net/udp.h>
36 
45 };
49 struct pch_gbe_regs {
100 };
101 
102 /* Interrupt Status */
103 /* Interrupt Status Hold */
104 /* Interrupt Enable */
105 #define PCH_GBE_INT_RX_DMA_CMPLT 0x00000001 /* Receive DMA Transfer Complete */
106 #define PCH_GBE_INT_RX_VALID 0x00000002 /* MAC Normal Receive Complete */
107 #define PCH_GBE_INT_RX_FRAME_ERR 0x00000004 /* Receive frame error */
108 #define PCH_GBE_INT_RX_FIFO_ERR 0x00000008 /* Receive FIFO Overflow */
109 #define PCH_GBE_INT_RX_DMA_ERR 0x00000010 /* Receive DMA Transfer Error */
110 #define PCH_GBE_INT_RX_DSC_EMP 0x00000020 /* Receive Descriptor Empty */
111 #define PCH_GBE_INT_TX_CMPLT 0x00000100 /* MAC Transmission Complete */
112 #define PCH_GBE_INT_TX_DMA_CMPLT 0x00000200 /* DMA Transfer Complete */
113 #define PCH_GBE_INT_TX_FIFO_ERR 0x00000400 /* Transmission FIFO underflow. */
114 #define PCH_GBE_INT_TX_DMA_ERR 0x00000800 /* Transmission DMA Error */
115 #define PCH_GBE_INT_PAUSE_CMPLT 0x00001000 /* Pause Transmission complete */
116 #define PCH_GBE_INT_MIIM_CMPLT 0x00010000 /* MIIM I/F Read completion */
117 #define PCH_GBE_INT_PHY_INT 0x00100000 /* Interruption from PHY */
118 #define PCH_GBE_INT_WOL_DET 0x01000000 /* Wake On LAN Event detection. */
119 #define PCH_GBE_INT_TCPIP_ERR 0x10000000 /* TCP/IP Accelerator Error */
120 
121 /* Mode */
122 #define PCH_GBE_MODE_MII_ETHER 0x00000000 /* GIGA Ethernet Mode [MII] */
123 #define PCH_GBE_MODE_GMII_ETHER 0x80000000 /* GIGA Ethernet Mode [GMII] */
124 #define PCH_GBE_MODE_HALF_DUPLEX 0x00000000 /* Duplex Mode [half duplex] */
125 #define PCH_GBE_MODE_FULL_DUPLEX 0x40000000 /* Duplex Mode [full duplex] */
126 #define PCH_GBE_MODE_FR_BST 0x04000000 /* Frame bursting is done */
127 
128 /* Reset */
129 #define PCH_GBE_ALL_RST 0x80000000 /* All reset */
130 #define PCH_GBE_TX_RST 0x00008000 /* TX MAC, TX FIFO, TX DMA reset */
131 #define PCH_GBE_RX_RST 0x00004000 /* RX MAC, RX FIFO, RX DMA reset */
132 
133 /* TCP/IP Accelerator Control */
134 #define PCH_GBE_EX_LIST_EN 0x00000008 /* External List Enable */
135 #define PCH_GBE_RX_TCPIPACC_OFF 0x00000004 /* RX TCP/IP ACC Disabled */
136 #define PCH_GBE_TX_TCPIPACC_EN 0x00000002 /* TX TCP/IP ACC Enable */
137 #define PCH_GBE_RX_TCPIPACC_EN 0x00000001 /* RX TCP/IP ACC Enable */
138 
139 /* MAC RX Enable */
140 #define PCH_GBE_MRE_MAC_RX_EN 0x00000001 /* MAC Receive Enable */
141 
142 /* RX Flow Control */
143 #define PCH_GBE_FL_CTRL_EN 0x80000000 /* Pause packet is enabled */
144 
145 /* Pause Packet Request */
146 #define PCH_GBE_PS_PKT_RQ 0x80000000 /* Pause packet Request */
147 
148 /* RX Mode */
149 #define PCH_GBE_ADD_FIL_EN 0x80000000 /* Address Filtering Enable */
150 /* Multicast Filtering Enable */
151 #define PCH_GBE_MLT_FIL_EN 0x40000000
152 /* Receive Almost Empty Threshold */
153 #define PCH_GBE_RH_ALM_EMP_4 0x00000000 /* 4 words */
154 #define PCH_GBE_RH_ALM_EMP_8 0x00004000 /* 8 words */
155 #define PCH_GBE_RH_ALM_EMP_16 0x00008000 /* 16 words */
156 #define PCH_GBE_RH_ALM_EMP_32 0x0000C000 /* 32 words */
157 /* Receive Almost Full Threshold */
158 #define PCH_GBE_RH_ALM_FULL_4 0x00000000 /* 4 words */
159 #define PCH_GBE_RH_ALM_FULL_8 0x00001000 /* 8 words */
160 #define PCH_GBE_RH_ALM_FULL_16 0x00002000 /* 16 words */
161 #define PCH_GBE_RH_ALM_FULL_32 0x00003000 /* 32 words */
162 /* RX FIFO Read Triger Threshold */
163 #define PCH_GBE_RH_RD_TRG_4 0x00000000 /* 4 words */
164 #define PCH_GBE_RH_RD_TRG_8 0x00000200 /* 8 words */
165 #define PCH_GBE_RH_RD_TRG_16 0x00000400 /* 16 words */
166 #define PCH_GBE_RH_RD_TRG_32 0x00000600 /* 32 words */
167 #define PCH_GBE_RH_RD_TRG_64 0x00000800 /* 64 words */
168 #define PCH_GBE_RH_RD_TRG_128 0x00000A00 /* 128 words */
169 #define PCH_GBE_RH_RD_TRG_256 0x00000C00 /* 256 words */
170 #define PCH_GBE_RH_RD_TRG_512 0x00000E00 /* 512 words */
171 
172 /* Receive Descriptor bit definitions */
173 #define PCH_GBE_RXD_ACC_STAT_BCAST 0x00000400
174 #define PCH_GBE_RXD_ACC_STAT_MCAST 0x00000200
175 #define PCH_GBE_RXD_ACC_STAT_UCAST 0x00000100
176 #define PCH_GBE_RXD_ACC_STAT_TCPIPOK 0x000000C0
177 #define PCH_GBE_RXD_ACC_STAT_IPOK 0x00000080
178 #define PCH_GBE_RXD_ACC_STAT_TCPOK 0x00000040
179 #define PCH_GBE_RXD_ACC_STAT_IP6ERR 0x00000020
180 #define PCH_GBE_RXD_ACC_STAT_OFLIST 0x00000010
181 #define PCH_GBE_RXD_ACC_STAT_TYPEIP 0x00000008
182 #define PCH_GBE_RXD_ACC_STAT_MACL 0x00000004
183 #define PCH_GBE_RXD_ACC_STAT_PPPOE 0x00000002
184 #define PCH_GBE_RXD_ACC_STAT_VTAGT 0x00000001
185 #define PCH_GBE_RXD_GMAC_STAT_PAUSE 0x0200
186 #define PCH_GBE_RXD_GMAC_STAT_MARBR 0x0100
187 #define PCH_GBE_RXD_GMAC_STAT_MARMLT 0x0080
188 #define PCH_GBE_RXD_GMAC_STAT_MARIND 0x0040
189 #define PCH_GBE_RXD_GMAC_STAT_MARNOTMT 0x0020
190 #define PCH_GBE_RXD_GMAC_STAT_TLONG 0x0010
191 #define PCH_GBE_RXD_GMAC_STAT_TSHRT 0x0008
192 #define PCH_GBE_RXD_GMAC_STAT_NOTOCTAL 0x0004
193 #define PCH_GBE_RXD_GMAC_STAT_NBLERR 0x0002
194 #define PCH_GBE_RXD_GMAC_STAT_CRCERR 0x0001
195 
196 /* Transmit Descriptor bit definitions */
197 #define PCH_GBE_TXD_CTRL_TCPIP_ACC_OFF 0x0008
198 #define PCH_GBE_TXD_CTRL_ITAG 0x0004
199 #define PCH_GBE_TXD_CTRL_ICRC 0x0002
200 #define PCH_GBE_TXD_CTRL_APAD 0x0001
201 #define PCH_GBE_TXD_WORDS_SHIFT 2
202 #define PCH_GBE_TXD_GMAC_STAT_CMPLT 0x2000
203 #define PCH_GBE_TXD_GMAC_STAT_ABT 0x1000
204 #define PCH_GBE_TXD_GMAC_STAT_EXCOL 0x0800
205 #define PCH_GBE_TXD_GMAC_STAT_SNGCOL 0x0400
206 #define PCH_GBE_TXD_GMAC_STAT_MLTCOL 0x0200
207 #define PCH_GBE_TXD_GMAC_STAT_CRSER 0x0100
208 #define PCH_GBE_TXD_GMAC_STAT_TLNG 0x0080
209 #define PCH_GBE_TXD_GMAC_STAT_TSHRT 0x0040
210 #define PCH_GBE_TXD_GMAC_STAT_LTCOL 0x0020
211 #define PCH_GBE_TXD_GMAC_STAT_TFUNDFLW 0x0010
212 #define PCH_GBE_TXD_GMAC_STAT_RTYCNT_MASK 0x000F
213 
214 /* TX Mode */
215 #define PCH_GBE_TM_NO_RTRY 0x80000000 /* No Retransmission */
216 #define PCH_GBE_TM_LONG_PKT 0x40000000 /* Long Packt TX Enable */
217 #define PCH_GBE_TM_ST_AND_FD 0x20000000 /* Stare and Forward */
218 #define PCH_GBE_TM_SHORT_PKT 0x10000000 /* Short Packet TX Enable */
219 #define PCH_GBE_TM_LTCOL_RETX 0x08000000 /* Retransmission at Late Collision */
220 /* Frame Start Threshold */
221 #define PCH_GBE_TM_TH_TX_STRT_4 0x00000000 /* 4 words */
222 #define PCH_GBE_TM_TH_TX_STRT_8 0x00004000 /* 8 words */
223 #define PCH_GBE_TM_TH_TX_STRT_16 0x00008000 /* 16 words */
224 #define PCH_GBE_TM_TH_TX_STRT_32 0x0000C000 /* 32 words */
225 /* Transmit Almost Empty Threshold */
226 #define PCH_GBE_TM_TH_ALM_EMP_4 0x00000000 /* 4 words */
227 #define PCH_GBE_TM_TH_ALM_EMP_8 0x00000800 /* 8 words */
228 #define PCH_GBE_TM_TH_ALM_EMP_16 0x00001000 /* 16 words */
229 #define PCH_GBE_TM_TH_ALM_EMP_32 0x00001800 /* 32 words */
230 #define PCH_GBE_TM_TH_ALM_EMP_64 0x00002000 /* 64 words */
231 #define PCH_GBE_TM_TH_ALM_EMP_128 0x00002800 /* 128 words */
232 #define PCH_GBE_TM_TH_ALM_EMP_256 0x00003000 /* 256 words */
233 #define PCH_GBE_TM_TH_ALM_EMP_512 0x00003800 /* 512 words */
234 /* Transmit Almost Full Threshold */
235 #define PCH_GBE_TM_TH_ALM_FULL_4 0x00000000 /* 4 words */
236 #define PCH_GBE_TM_TH_ALM_FULL_8 0x00000200 /* 8 words */
237 #define PCH_GBE_TM_TH_ALM_FULL_16 0x00000400 /* 16 words */
238 #define PCH_GBE_TM_TH_ALM_FULL_32 0x00000600 /* 32 words */
239 
240 /* RX FIFO Status */
241 #define PCH_GBE_RF_ALM_FULL 0x80000000 /* RX FIFO is almost full. */
242 #define PCH_GBE_RF_ALM_EMP 0x40000000 /* RX FIFO is almost empty. */
243 #define PCH_GBE_RF_RD_TRG 0x20000000 /* Become more than RH_RD_TRG. */
244 #define PCH_GBE_RF_STRWD 0x1FFE0000 /* The word count of RX FIFO. */
245 #define PCH_GBE_RF_RCVING 0x00010000 /* Stored in RX FIFO. */
246 
247 /* MAC Address Mask */
248 #define PCH_GBE_BUSY 0x80000000
249 
250 /* MIIM */
251 #define PCH_GBE_MIIM_OPER_WRITE 0x04000000
252 #define PCH_GBE_MIIM_OPER_READ 0x00000000
253 #define PCH_GBE_MIIM_OPER_READY 0x04000000
254 #define PCH_GBE_MIIM_PHY_ADDR_SHIFT 21
255 #define PCH_GBE_MIIM_REG_ADDR_SHIFT 16
256 
257 /* RGMII Status */
258 #define PCH_GBE_LINK_UP 0x80000008
259 #define PCH_GBE_RXC_SPEED_MSK 0x00000006
260 #define PCH_GBE_RXC_SPEED_2_5M 0x00000000 /* 2.5MHz */
261 #define PCH_GBE_RXC_SPEED_25M 0x00000002 /* 25MHz */
262 #define PCH_GBE_RXC_SPEED_125M 0x00000004 /* 100MHz */
263 #define PCH_GBE_DUPLEX_FULL 0x00000001
264 
265 /* RGMII Control */
266 #define PCH_GBE_CRS_SEL 0x00000010
267 #define PCH_GBE_RGMII_RATE_125M 0x00000000
268 #define PCH_GBE_RGMII_RATE_25M 0x00000008
269 #define PCH_GBE_RGMII_RATE_2_5M 0x0000000C
270 #define PCH_GBE_RGMII_MODE_GMII 0x00000000
271 #define PCH_GBE_RGMII_MODE_RGMII 0x00000002
272 #define PCH_GBE_CHIP_TYPE_EXTERNAL 0x00000000
273 #define PCH_GBE_CHIP_TYPE_INTERNAL 0x00000001
274 
275 /* DMA Control */
276 #define PCH_GBE_RX_DMA_EN 0x00000002 /* Enables Receive DMA */
277 #define PCH_GBE_TX_DMA_EN 0x00000001 /* Enables Transmission DMA */
278 
279 /* RX DMA STATUS */
280 #define PCH_GBE_IDLE_CHECK 0xFFFFFFFE
281 
282 /* Wake On LAN Status */
283 #define PCH_GBE_WLS_BR 0x00000008 /* Broadcas Address */
284 #define PCH_GBE_WLS_MLT 0x00000004 /* Multicast Address */
285 
286 /* The Frame registered in Address Recognizer */
287 #define PCH_GBE_WLS_IND 0x00000002
288 #define PCH_GBE_WLS_MP 0x00000001 /* Magic packet Address */
289 
290 /* Wake On LAN Control */
291 #define PCH_GBE_WLC_WOL_MODE 0x00010000
292 #define PCH_GBE_WLC_IGN_TLONG 0x00000100
293 #define PCH_GBE_WLC_IGN_TSHRT 0x00000080
294 #define PCH_GBE_WLC_IGN_OCTER 0x00000040
295 #define PCH_GBE_WLC_IGN_NBLER 0x00000020
296 #define PCH_GBE_WLC_IGN_CRCER 0x00000010
297 #define PCH_GBE_WLC_BR 0x00000008
298 #define PCH_GBE_WLC_MLT 0x00000004
299 #define PCH_GBE_WLC_IND 0x00000002
300 #define PCH_GBE_WLC_MP 0x00000001
301 
302 /* Wake On LAN Address Mask */
303 #define PCH_GBE_WLA_BUSY 0x80000000
304 
305 
306 
307 /* TX/RX descriptor defines */
308 #define PCH_GBE_MAX_TXD 4096
309 #define PCH_GBE_DEFAULT_TXD 256
310 #define PCH_GBE_MIN_TXD 8
311 #define PCH_GBE_MAX_RXD 4096
312 #define PCH_GBE_DEFAULT_RXD 256
313 #define PCH_GBE_MIN_RXD 8
314 
315 /* Number of Transmit and Receive Descriptors must be a multiple of 8 */
316 #define PCH_GBE_TX_DESC_MULTIPLE 8
317 #define PCH_GBE_RX_DESC_MULTIPLE 8
318 
319 /* Read/Write operation is done through MII Management IF */
320 #define PCH_GBE_HAL_MIIM_READ ((u32)0x00000000)
321 #define PCH_GBE_HAL_MIIM_WRITE ((u32)0x04000000)
322 
323 /* flow control values */
324 #define PCH_GBE_FC_NONE 0
325 #define PCH_GBE_FC_RX_PAUSE 1
326 #define PCH_GBE_FC_TX_PAUSE 2
327 #define PCH_GBE_FC_FULL 3
328 #define PCH_GBE_FC_DEFAULT PCH_GBE_FC_FULL
329 
330 
331 struct pch_gbe_hw;
345  void (*get_bus_info) (struct pch_gbe_hw *);
346  s32 (*init_hw) (struct pch_gbe_hw *);
347  s32 (*read_phy_reg) (struct pch_gbe_hw *, u32, u16 *);
348  s32 (*write_phy_reg) (struct pch_gbe_hw *, u32, u16);
349  void (*reset_phy) (struct pch_gbe_hw *);
350  void (*sw_reset_phy) (struct pch_gbe_hw *);
353  s32 (*read_mac_addr) (struct pch_gbe_hw *);
354 };
355 
369  u8 addr[6];
378 };
379 
394 };
395 
405 };
406 
412 struct pch_gbe_hw {
413  void *back;
414 
417 
418  const struct pch_gbe_functions *func;
422 };
423 
442 };
443 
464 };
465 
466 
475  struct sk_buff *skb;
477  unsigned char *rx_buffer;
478  unsigned long time_stamp;
480  bool mapped;
481 };
482 
498  unsigned int size;
499  unsigned int count;
500  unsigned int next_to_use;
501  unsigned int next_to_clean;
503 };
504 
518  unsigned char *rx_buff_pool;
520  unsigned int rx_buff_pool_size;
521  unsigned int size;
522  unsigned int count;
523  unsigned int next_to_use;
524  unsigned int next_to_clean;
526 };
527 
582 };
583 
614  struct pci_dev *pdev;
617  struct pch_gbe_hw hw;
620  struct mii_if_info mii;
624  unsigned long led_status;
627  unsigned long rx_buffer_len;
628  unsigned long tx_queue_len;
629  bool have_msi;
633  struct pci_dev *ptp_pdev;
634 };
635 
636 extern const char pch_driver_version[];
637 
638 /* pch_gbe_main.c */
639 extern int pch_gbe_up(struct pch_gbe_adapter *adapter);
640 extern void pch_gbe_down(struct pch_gbe_adapter *adapter);
641 extern void pch_gbe_reinit_locked(struct pch_gbe_adapter *adapter);
642 extern void pch_gbe_reset(struct pch_gbe_adapter *adapter);
644  struct pch_gbe_tx_ring *txdr);
646  struct pch_gbe_rx_ring *rxdr);
648  struct pch_gbe_tx_ring *tx_ring);
650  struct pch_gbe_rx_ring *rx_ring);
651 extern void pch_gbe_update_stats(struct pch_gbe_adapter *adapter);
652 #ifdef CONFIG_PCH_PTP
653 extern u32 pch_ch_control_read(struct pci_dev *pdev);
654 extern void pch_ch_control_write(struct pci_dev *pdev, u32 val);
655 extern u32 pch_ch_event_read(struct pci_dev *pdev);
656 extern void pch_ch_event_write(struct pci_dev *pdev, u32 val);
657 extern u32 pch_src_uuid_lo_read(struct pci_dev *pdev);
658 extern u32 pch_src_uuid_hi_read(struct pci_dev *pdev);
659 extern u64 pch_rx_snap_read(struct pci_dev *pdev);
660 extern u64 pch_tx_snap_read(struct pci_dev *pdev);
661 extern int pch_set_station_address(u8 *addr, struct pci_dev *pdev);
662 #endif
663 
664 /* pch_gbe_param.c */
665 extern void pch_gbe_check_options(struct pch_gbe_adapter *adapter);
666 
667 /* pch_gbe_ethtool.c */
668 extern void pch_gbe_set_ethtool_ops(struct net_device *netdev);
669 
670 /* pch_gbe_mac.c */
671 extern s32 pch_gbe_mac_force_mac_fc(struct pch_gbe_hw *hw);
673 extern u16 pch_gbe_mac_ctrl_miim(struct pch_gbe_hw *hw,
674  u32 addr, u32 dir, u32 reg, u16 data);
675 #endif /* _PCH_GBE_H_ */