1 /*******************************************************************************
2 STMMAC Common Header File
4 Copyright (C) 2007-2009 STMicroelectronics Ltd
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.
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
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.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
22 Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
28 #include <linux/etherdevice.h>
29 #include <linux/netdevice.h>
30 #include <linux/phy.h>
31 #include <linux/module.h>
32 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
33 #define STMMAC_VLAN_TAG_USED
34 #include <linux/if_vlan.h>
40 /* Synopsys Core versions */
41 #define DWMAC_CORE_3_40 0x34
42 #define DWMAC_CORE_3_50 0x35
44 #undef FRAME_FILTER_DEBUG
45 /* #define FRAME_FILTER_DEBUG */
47 /* Extra statistic and debug information exposed by ethtool */
48 struct stmmac_extra_stats
{
50 unsigned long tx_underflow ____cacheline_aligned
;
51 unsigned long tx_carrier
;
52 unsigned long tx_losscarrier
;
53 unsigned long vlan_tag
;
54 unsigned long tx_deferred
;
55 unsigned long tx_vlan
;
56 unsigned long tx_jabber
;
57 unsigned long tx_frame_flushed
;
58 unsigned long tx_payload_error
;
59 unsigned long tx_ip_header_error
;
61 unsigned long rx_desc
;
62 unsigned long sa_filter_fail
;
63 unsigned long overflow_error
;
64 unsigned long ipc_csum_error
;
65 unsigned long rx_collision
;
67 unsigned long dribbling_bit
;
68 unsigned long rx_length
;
70 unsigned long rx_multicast
;
71 unsigned long rx_gmac_overflow
;
72 unsigned long rx_watchdog
;
73 unsigned long da_rx_filter_fail
;
74 unsigned long sa_rx_filter_fail
;
75 unsigned long rx_missed_cntr
;
76 unsigned long rx_overflow_cntr
;
77 unsigned long rx_vlan
;
78 /* Tx/Rx IRQ error info */
79 unsigned long tx_undeflow_irq
;
80 unsigned long tx_process_stopped_irq
;
81 unsigned long tx_jabber_irq
;
82 unsigned long rx_overflow_irq
;
83 unsigned long rx_buf_unav_irq
;
84 unsigned long rx_process_stopped_irq
;
85 unsigned long rx_watchdog_irq
;
86 unsigned long tx_early_irq
;
87 unsigned long fatal_bus_error_irq
;
88 /* Tx/Rx IRQ Events */
89 unsigned long rx_early_irq
;
90 unsigned long threshold
;
91 unsigned long tx_pkt_n
;
92 unsigned long rx_pkt_n
;
93 unsigned long normal_irq_n
;
94 unsigned long rx_normal_irq_n
;
95 unsigned long napi_poll
;
96 unsigned long tx_normal_irq_n
;
97 unsigned long tx_clean
;
98 unsigned long tx_reset_ic_bit
;
99 unsigned long irq_receive_pmt_irq_n
;
101 unsigned long mmc_tx_irq_n
;
102 unsigned long mmc_rx_irq_n
;
103 unsigned long mmc_rx_csum_offload_irq_n
;
105 unsigned long irq_tx_path_in_lpi_mode_n
;
106 unsigned long irq_tx_path_exit_lpi_mode_n
;
107 unsigned long irq_rx_path_in_lpi_mode_n
;
108 unsigned long irq_rx_path_exit_lpi_mode_n
;
109 unsigned long phy_eee_wakeup_error_n
;
110 /* Extended RDES status */
111 unsigned long ip_hdr_err
;
112 unsigned long ip_payload_err
;
113 unsigned long ip_csum_bypassed
;
114 unsigned long ipv4_pkt_rcvd
;
115 unsigned long ipv6_pkt_rcvd
;
116 unsigned long rx_msg_type_ext_no_ptp
;
117 unsigned long rx_msg_type_sync
;
118 unsigned long rx_msg_type_follow_up
;
119 unsigned long rx_msg_type_delay_req
;
120 unsigned long rx_msg_type_delay_resp
;
121 unsigned long rx_msg_type_pdelay_req
;
122 unsigned long rx_msg_type_pdelay_resp
;
123 unsigned long rx_msg_type_pdelay_follow_up
;
124 unsigned long ptp_frame_type
;
125 unsigned long ptp_ver
;
126 unsigned long timestamp_dropped
;
127 unsigned long av_pkt_rcvd
;
128 unsigned long av_tagged_pkt_rcvd
;
129 unsigned long vlan_tag_priority_val
;
130 unsigned long l3_filter_match
;
131 unsigned long l4_filter_match
;
132 unsigned long l3_l4_filter_no_match
;
134 unsigned long irq_pcs_ane_n
;
135 unsigned long irq_pcs_link_n
;
136 unsigned long irq_rgmii_n
;
137 unsigned long pcs_link
;
138 unsigned long pcs_duplex
;
139 unsigned long pcs_speed
;
142 /* CSR Frequency Access Defines*/
143 #define CSR_F_35M 35000000
144 #define CSR_F_60M 60000000
145 #define CSR_F_100M 100000000
146 #define CSR_F_150M 150000000
147 #define CSR_F_250M 250000000
148 #define CSR_F_300M 300000000
150 #define MAC_CSR_H_FRQ_MASK 0x20
152 #define HASH_TABLE_SIZE 64
153 #define PAUSE_TIME 0x200
155 /* Flow Control defines */
159 #define FLOW_AUTO (FLOW_TX | FLOW_RX)
162 #define STMMAC_PCS_RGMII (1 << 0)
163 #define STMMAC_PCS_SGMII (1 << 1)
164 #define STMMAC_PCS_TBI (1 << 2)
165 #define STMMAC_PCS_RTBI (1 << 3)
167 #define SF_DMA_MODE 1 /* DMA STORE-AND-FORWARD Operation Mode */
169 /* DAM HW feature register fields */
170 #define DMA_HW_FEAT_MIISEL 0x00000001 /* 10/100 Mbps Support */
171 #define DMA_HW_FEAT_GMIISEL 0x00000002 /* 1000 Mbps Support */
172 #define DMA_HW_FEAT_HDSEL 0x00000004 /* Half-Duplex Support */
173 #define DMA_HW_FEAT_EXTHASHEN 0x00000008 /* Expanded DA Hash Filter */
174 #define DMA_HW_FEAT_HASHSEL 0x00000010 /* HASH Filter */
175 #define DMA_HW_FEAT_ADDMAC 0x00000020 /* Multiple MAC Addr Reg */
176 #define DMA_HW_FEAT_PCSSEL 0x00000040 /* PCS registers */
177 #define DMA_HW_FEAT_L3L4FLTREN 0x00000080 /* Layer 3 & Layer 4 Feature */
178 #define DMA_HW_FEAT_SMASEL 0x00000100 /* SMA(MDIO) Interface */
179 #define DMA_HW_FEAT_RWKSEL 0x00000200 /* PMT Remote Wakeup */
180 #define DMA_HW_FEAT_MGKSEL 0x00000400 /* PMT Magic Packet */
181 #define DMA_HW_FEAT_MMCSEL 0x00000800 /* RMON Module */
182 #define DMA_HW_FEAT_TSVER1SEL 0x00001000 /* Only IEEE 1588-2002 */
183 #define DMA_HW_FEAT_TSVER2SEL 0x00002000 /* IEEE 1588-2008 PTPv2 */
184 #define DMA_HW_FEAT_EEESEL 0x00004000 /* Energy Efficient Ethernet */
185 #define DMA_HW_FEAT_AVSEL 0x00008000 /* AV Feature */
186 #define DMA_HW_FEAT_TXCOESEL 0x00010000 /* Checksum Offload in Tx */
187 #define DMA_HW_FEAT_RXTYP1COE 0x00020000 /* IP COE (Type 1) in Rx */
188 #define DMA_HW_FEAT_RXTYP2COE 0x00040000 /* IP COE (Type 2) in Rx */
189 #define DMA_HW_FEAT_RXFIFOSIZE 0x00080000 /* Rx FIFO > 2048 Bytes */
190 #define DMA_HW_FEAT_RXCHCNT 0x00300000 /* No. additional Rx Channels */
191 #define DMA_HW_FEAT_TXCHCNT 0x00c00000 /* No. additional Tx Channels */
192 #define DMA_HW_FEAT_ENHDESSEL 0x01000000 /* Alternate Descriptor */
193 /* Timestamping with Internal System Time */
194 #define DMA_HW_FEAT_INTTSEN 0x02000000
195 #define DMA_HW_FEAT_FLEXIPPSEN 0x04000000 /* Flexible PPS Output */
196 #define DMA_HW_FEAT_SAVLANINS 0x08000000 /* Source Addr or VLAN */
197 #define DMA_HW_FEAT_ACTPHYIF 0x70000000 /* Active/selected PHY iface */
198 #define DEFAULT_DMA_PBL 8
200 /* Max/Min RI Watchdog Timer count value */
201 #define MAX_DMA_RIWT 0xff
202 #define MIN_DMA_RIWT 0x20
203 /* Tx coalesce parameters */
204 #define STMMAC_COAL_TX_TIMER 40000
205 #define STMMAC_MAX_COAL_TX_TICK 100000
206 #define STMMAC_TX_MAX_FRAMES 256
207 #define STMMAC_TX_FRAMES 64
210 enum rx_frame_status
{
217 enum dma_irq_status
{
219 tx_hard_error_bump_tc
= 0x2,
224 /* EEE and LPI defines */
225 #define CORE_IRQ_TX_PATH_IN_LPI_MODE (1 << 0)
226 #define CORE_IRQ_TX_PATH_EXIT_LPI_MODE (1 << 1)
227 #define CORE_IRQ_RX_PATH_IN_LPI_MODE (1 << 2)
228 #define CORE_IRQ_RX_PATH_EXIT_LPI_MODE (1 << 3)
230 #define CORE_PCS_ANE_COMPLETE (1 << 5)
231 #define CORE_PCS_LINK_STATUS (1 << 6)
232 #define CORE_RGMII_IRQ (1 << 7)
234 /* Physical Coding Sublayer */
238 unsigned int lp_pause
;
239 unsigned int lp_duplex
;
242 #define STMMAC_PCS_PAUSE 1
243 #define STMMAC_PCS_ASYM_PAUSE 2
245 /* DMA HW capabilities */
246 struct dma_features
{
247 unsigned int mbps_10_100
;
248 unsigned int mbps_1000
;
249 unsigned int half_duplex
;
250 unsigned int hash_filter
;
251 unsigned int multi_addr
;
253 unsigned int sma_mdio
;
254 unsigned int pmt_remote_wake_up
;
255 unsigned int pmt_magic_frame
;
258 unsigned int time_stamp
;
260 unsigned int atime_stamp
;
261 /* 802.3az - Energy-Efficient Ethernet (EEE) */
266 unsigned int rx_coe_type1
;
267 unsigned int rx_coe_type2
;
268 unsigned int rxfifo_over_2048
;
269 /* TX and RX number of channels */
270 unsigned int number_rx_channel
;
271 unsigned int number_tx_channel
;
272 /* Alternate (enhanced) DESC mode */
273 unsigned int enh_desc
;
276 /* GMAC TX FIFO is 8K, Rx FIFO is 16K */
277 #define BUF_SIZE_16KiB 16384
278 #define BUF_SIZE_8KiB 8192
279 #define BUF_SIZE_4KiB 4096
280 #define BUF_SIZE_2KiB 2048
282 /* Power Down and WOL */
283 #define PMT_NOT_SUPPORTED 0
284 #define PMT_SUPPORTED 1
286 /* Common MAC defines */
287 #define MAC_CTRL_REG 0x00000000 /* MAC Control */
288 #define MAC_ENABLE_TX 0x00000008 /* Transmitter Enable */
289 #define MAC_RNABLE_RX 0x00000004 /* Receiver Enable */
291 /* Default LPI timers */
292 #define STMMAC_DEFAULT_LIT_LS 0x3E8
293 #define STMMAC_DEFAULT_TWT_LS 0x1E
295 #define STMMAC_CHAIN_MODE 0x1
296 #define STMMAC_RING_MODE 0x2
298 #define JUMBO_LEN 9000
300 /* Descriptors helpers */
301 struct stmmac_desc_ops
{
302 /* DMA RX descriptor ring initialization */
303 void (*init_rx_desc
) (struct dma_desc
*p
, int disable_rx_ic
, int mode
,
305 /* DMA TX descriptor ring initialization */
306 void (*init_tx_desc
) (struct dma_desc
*p
, int mode
, int end
);
308 /* Invoked by the xmit function to prepare the tx descriptor */
309 void (*prepare_tx_desc
) (struct dma_desc
*p
, int is_fs
, int len
,
310 int csum_flag
, int mode
);
311 /* Set/get the owner of the descriptor */
312 void (*set_tx_owner
) (struct dma_desc
*p
);
313 int (*get_tx_owner
) (struct dma_desc
*p
);
314 /* Invoked by the xmit function to close the tx descriptor */
315 void (*close_tx_desc
) (struct dma_desc
*p
);
316 /* Clean the tx descriptor as soon as the tx irq is received */
317 void (*release_tx_desc
) (struct dma_desc
*p
, int mode
);
318 /* Clear interrupt on tx frame completion. When this bit is
319 * set an interrupt happens as soon as the frame is transmitted */
320 void (*clear_tx_ic
) (struct dma_desc
*p
);
321 /* Last tx segment reports the transmit status */
322 int (*get_tx_ls
) (struct dma_desc
*p
);
323 /* Return the transmit status looking at the TDES1 */
324 int (*tx_status
) (void *data
, struct stmmac_extra_stats
*x
,
325 struct dma_desc
*p
, void __iomem
*ioaddr
);
326 /* Get the buffer size from the descriptor */
327 int (*get_tx_len
) (struct dma_desc
*p
);
328 /* Handle extra events on specific interrupts hw dependent */
329 int (*get_rx_owner
) (struct dma_desc
*p
);
330 void (*set_rx_owner
) (struct dma_desc
*p
);
331 /* Get the receive frame size */
332 int (*get_rx_frame_len
) (struct dma_desc
*p
, int rx_coe_type
);
333 /* Return the reception status looking at the RDES1 */
334 int (*rx_status
) (void *data
, struct stmmac_extra_stats
*x
,
336 void (*rx_extended_status
) (void *data
, struct stmmac_extra_stats
*x
,
337 struct dma_extended_desc
*p
);
338 /* Set tx timestamp enable bit */
339 void (*enable_tx_timestamp
) (struct dma_desc
*p
);
340 /* get tx timestamp status */
341 int (*get_tx_timestamp_status
) (struct dma_desc
*p
);
342 /* get timestamp value */
343 u64(*get_timestamp
) (void *desc
, u32 ats
);
344 /* get rx timestamp status */
345 int (*get_rx_timestamp_status
) (void *desc
, u32 ats
);
348 extern const struct stmmac_desc_ops enh_desc_ops
;
349 extern const struct stmmac_desc_ops ndesc_ops
;
351 /* Specific DMA helpers */
352 struct stmmac_dma_ops
{
353 /* DMA core initialization */
354 int (*init
) (void __iomem
*ioaddr
, int pbl
, int fb
, int mb
,
355 int burst_len
, u32 dma_tx
, u32 dma_rx
, int atds
);
356 /* Dump DMA registers */
357 void (*dump_regs
) (void __iomem
*ioaddr
);
358 /* Set tx/rx threshold in the csr6 register
359 * An invalid value enables the store-and-forward mode */
360 void (*dma_mode
) (void __iomem
*ioaddr
, int txmode
, int rxmode
);
361 /* To track extra statistic (if supported) */
362 void (*dma_diagnostic_fr
) (void *data
, struct stmmac_extra_stats
*x
,
363 void __iomem
*ioaddr
);
364 void (*enable_dma_transmission
) (void __iomem
*ioaddr
);
365 void (*enable_dma_irq
) (void __iomem
*ioaddr
);
366 void (*disable_dma_irq
) (void __iomem
*ioaddr
);
367 void (*start_tx
) (void __iomem
*ioaddr
);
368 void (*stop_tx
) (void __iomem
*ioaddr
);
369 void (*start_rx
) (void __iomem
*ioaddr
);
370 void (*stop_rx
) (void __iomem
*ioaddr
);
371 int (*dma_interrupt
) (void __iomem
*ioaddr
,
372 struct stmmac_extra_stats
*x
);
373 /* If supported then get the optional core features */
374 unsigned int (*get_hw_feature
) (void __iomem
*ioaddr
);
375 /* Program the HW RX Watchdog */
376 void (*rx_watchdog
) (void __iomem
*ioaddr
, u32 riwt
);
379 struct mac_device_info
;
381 /* Helpers to program the MAC core */
383 /* MAC core initialization */
384 void (*core_init
)(struct mac_device_info
*hw
, int mtu
);
385 /* Enable and verify that the IPC module is supported */
386 int (*rx_ipc
)(struct mac_device_info
*hw
);
387 /* Dump MAC registers */
388 void (*dump_regs
)(struct mac_device_info
*hw
);
389 /* Handle extra events on specific interrupts hw dependent */
390 int (*host_irq_status
)(struct mac_device_info
*hw
,
391 struct stmmac_extra_stats
*x
);
392 /* Multicast filter setting */
393 void (*set_filter
)(struct mac_device_info
*hw
, struct net_device
*dev
);
394 /* Flow control setting */
395 void (*flow_ctrl
)(struct mac_device_info
*hw
, unsigned int duplex
,
396 unsigned int fc
, unsigned int pause_time
);
397 /* Set power management mode (e.g. magic frame) */
398 void (*pmt
)(struct mac_device_info
*hw
, unsigned long mode
);
399 /* Set/Get Unicast MAC addresses */
400 void (*set_umac_addr
)(struct mac_device_info
*hw
, unsigned char *addr
,
402 void (*get_umac_addr
)(struct mac_device_info
*hw
, unsigned char *addr
,
404 void (*set_eee_mode
)(struct mac_device_info
*hw
);
405 void (*reset_eee_mode
)(struct mac_device_info
*hw
);
406 void (*set_eee_timer
)(struct mac_device_info
*hw
, int ls
, int tw
);
407 void (*set_eee_pls
)(struct mac_device_info
*hw
, int link
);
408 void (*ctrl_ane
)(struct mac_device_info
*hw
, bool restart
);
409 void (*get_adv
)(struct mac_device_info
*hw
, struct rgmii_adv
*adv
);
412 /* PTP and HW Timer helpers */
413 struct stmmac_hwtimestamp
{
414 void (*config_hw_tstamping
) (void __iomem
*ioaddr
, u32 data
);
415 void (*config_sub_second_increment
) (void __iomem
*ioaddr
);
416 int (*init_systime
) (void __iomem
*ioaddr
, u32 sec
, u32 nsec
);
417 int (*config_addend
) (void __iomem
*ioaddr
, u32 addend
);
418 int (*adjust_systime
) (void __iomem
*ioaddr
, u32 sec
, u32 nsec
,
420 u64(*get_systime
) (void __iomem
*ioaddr
);
423 extern const struct stmmac_hwtimestamp stmmac_ptp
;
432 unsigned int addr
; /* MII Address */
433 unsigned int data
; /* MII Data */
436 /* Helpers to manage the descriptors for chain and ring modes */
437 struct stmmac_mode_ops
{
438 void (*init
) (void *des
, dma_addr_t phy_addr
, unsigned int size
,
439 unsigned int extend_desc
);
440 unsigned int (*is_jumbo_frm
) (int len
, int ehn_desc
);
441 int (*jumbo_frm
)(void *priv
, struct sk_buff
*skb
, int csum
);
442 int (*set_16kib_bfsize
)(int mtu
);
443 void (*init_desc3
)(struct dma_desc
*p
);
444 void (*refill_desc3
) (void *priv
, struct dma_desc
*p
);
445 void (*clean_desc3
) (void *priv
, struct dma_desc
*p
);
448 struct mac_device_info
{
449 const struct stmmac_ops
*mac
;
450 const struct stmmac_desc_ops
*desc
;
451 const struct stmmac_dma_ops
*dma
;
452 const struct stmmac_mode_ops
*mode
;
453 const struct stmmac_hwtimestamp
*ptp
;
454 struct mii_regs mii
; /* MII register Addresses */
455 struct mac_link link
;
456 unsigned int synopsys_uid
;
457 void __iomem
*pcsr
; /* vpointer to device CSRs */
458 int multicast_filter_bins
;
459 int unicast_filter_entries
;
461 unsigned int rx_csum
;
464 struct mac_device_info
*dwmac1000_setup(void __iomem
*ioaddr
, int mcbins
,
465 int perfect_uc_entries
);
466 struct mac_device_info
*dwmac100_setup(void __iomem
*ioaddr
);
468 void stmmac_set_mac_addr(void __iomem
*ioaddr
, u8 addr
[6],
469 unsigned int high
, unsigned int low
);
470 void stmmac_get_mac_addr(void __iomem
*ioaddr
, unsigned char *addr
,
471 unsigned int high
, unsigned int low
);
473 void stmmac_set_mac(void __iomem
*ioaddr
, bool enable
);
475 void dwmac_dma_flush_tx_fifo(void __iomem
*ioaddr
);
476 extern const struct stmmac_mode_ops ring_mode_ops
;
477 extern const struct stmmac_mode_ops chain_mode_ops
;
479 #endif /* __COMMON_H__ */