1 /*******************************************************************************
2   STMMAC Common Header File
3 
4   Copyright (C) 2007-2009  STMicroelectronics Ltd
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   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
24 
25 #ifndef __COMMON_H__
26 #define __COMMON_H__
27 
28 #include <linux/etherdevice.h>
29 #include <linux/netdevice.h>
30 #include <linux/stmmac.h>
31 #include <linux/phy.h>
32 #include <linux/module.h>
33 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
34 #define STMMAC_VLAN_TAG_USED
35 #include <linux/if_vlan.h>
36 #endif
37 
38 #include "descs.h"
39 #include "mmc.h"
40 
41 /* Synopsys Core versions */
42 #define	DWMAC_CORE_3_40	0x34
43 #define	DWMAC_CORE_3_50	0x35
44 #define	DWMAC_CORE_4_00	0x40
45 #define STMMAC_CHAN0	0	/* Always supported and default for all chips */
46 
47 #define DMA_TX_SIZE 512
48 #define DMA_RX_SIZE 512
49 #define STMMAC_GET_ENTRY(x, size)	((x + 1) & (size - 1))
50 
51 #undef FRAME_FILTER_DEBUG
52 /* #define FRAME_FILTER_DEBUG */
53 
54 /* Extra statistic and debug information exposed by ethtool */
55 struct stmmac_extra_stats {
56 	/* Transmit errors */
57 	unsigned long tx_underflow ____cacheline_aligned;
58 	unsigned long tx_carrier;
59 	unsigned long tx_losscarrier;
60 	unsigned long vlan_tag;
61 	unsigned long tx_deferred;
62 	unsigned long tx_vlan;
63 	unsigned long tx_jabber;
64 	unsigned long tx_frame_flushed;
65 	unsigned long tx_payload_error;
66 	unsigned long tx_ip_header_error;
67 	/* Receive errors */
68 	unsigned long rx_desc;
69 	unsigned long sa_filter_fail;
70 	unsigned long overflow_error;
71 	unsigned long ipc_csum_error;
72 	unsigned long rx_collision;
73 	unsigned long rx_crc;
74 	unsigned long dribbling_bit;
75 	unsigned long rx_length;
76 	unsigned long rx_mii;
77 	unsigned long rx_multicast;
78 	unsigned long rx_gmac_overflow;
79 	unsigned long rx_watchdog;
80 	unsigned long da_rx_filter_fail;
81 	unsigned long sa_rx_filter_fail;
82 	unsigned long rx_missed_cntr;
83 	unsigned long rx_overflow_cntr;
84 	unsigned long rx_vlan;
85 	/* Tx/Rx IRQ error info */
86 	unsigned long tx_undeflow_irq;
87 	unsigned long tx_process_stopped_irq;
88 	unsigned long tx_jabber_irq;
89 	unsigned long rx_overflow_irq;
90 	unsigned long rx_buf_unav_irq;
91 	unsigned long rx_process_stopped_irq;
92 	unsigned long rx_watchdog_irq;
93 	unsigned long tx_early_irq;
94 	unsigned long fatal_bus_error_irq;
95 	/* Tx/Rx IRQ Events */
96 	unsigned long rx_early_irq;
97 	unsigned long threshold;
98 	unsigned long tx_pkt_n;
99 	unsigned long rx_pkt_n;
100 	unsigned long normal_irq_n;
101 	unsigned long rx_normal_irq_n;
102 	unsigned long napi_poll;
103 	unsigned long tx_normal_irq_n;
104 	unsigned long tx_clean;
105 	unsigned long tx_set_ic_bit;
106 	unsigned long irq_receive_pmt_irq_n;
107 	/* MMC info */
108 	unsigned long mmc_tx_irq_n;
109 	unsigned long mmc_rx_irq_n;
110 	unsigned long mmc_rx_csum_offload_irq_n;
111 	/* EEE */
112 	unsigned long irq_tx_path_in_lpi_mode_n;
113 	unsigned long irq_tx_path_exit_lpi_mode_n;
114 	unsigned long irq_rx_path_in_lpi_mode_n;
115 	unsigned long irq_rx_path_exit_lpi_mode_n;
116 	unsigned long phy_eee_wakeup_error_n;
117 	/* Extended RDES status */
118 	unsigned long ip_hdr_err;
119 	unsigned long ip_payload_err;
120 	unsigned long ip_csum_bypassed;
121 	unsigned long ipv4_pkt_rcvd;
122 	unsigned long ipv6_pkt_rcvd;
123 	unsigned long rx_msg_type_ext_no_ptp;
124 	unsigned long rx_msg_type_sync;
125 	unsigned long rx_msg_type_follow_up;
126 	unsigned long rx_msg_type_delay_req;
127 	unsigned long rx_msg_type_delay_resp;
128 	unsigned long rx_msg_type_pdelay_req;
129 	unsigned long rx_msg_type_pdelay_resp;
130 	unsigned long rx_msg_type_pdelay_follow_up;
131 	unsigned long ptp_frame_type;
132 	unsigned long ptp_ver;
133 	unsigned long timestamp_dropped;
134 	unsigned long av_pkt_rcvd;
135 	unsigned long av_tagged_pkt_rcvd;
136 	unsigned long vlan_tag_priority_val;
137 	unsigned long l3_filter_match;
138 	unsigned long l4_filter_match;
139 	unsigned long l3_l4_filter_no_match;
140 	/* PCS */
141 	unsigned long irq_pcs_ane_n;
142 	unsigned long irq_pcs_link_n;
143 	unsigned long irq_rgmii_n;
144 	unsigned long pcs_link;
145 	unsigned long pcs_duplex;
146 	unsigned long pcs_speed;
147 	/* debug register */
148 	unsigned long mtl_tx_status_fifo_full;
149 	unsigned long mtl_tx_fifo_not_empty;
150 	unsigned long mmtl_fifo_ctrl;
151 	unsigned long mtl_tx_fifo_read_ctrl_write;
152 	unsigned long mtl_tx_fifo_read_ctrl_wait;
153 	unsigned long mtl_tx_fifo_read_ctrl_read;
154 	unsigned long mtl_tx_fifo_read_ctrl_idle;
155 	unsigned long mac_tx_in_pause;
156 	unsigned long mac_tx_frame_ctrl_xfer;
157 	unsigned long mac_tx_frame_ctrl_idle;
158 	unsigned long mac_tx_frame_ctrl_wait;
159 	unsigned long mac_tx_frame_ctrl_pause;
160 	unsigned long mac_gmii_tx_proto_engine;
161 	unsigned long mtl_rx_fifo_fill_level_full;
162 	unsigned long mtl_rx_fifo_fill_above_thresh;
163 	unsigned long mtl_rx_fifo_fill_below_thresh;
164 	unsigned long mtl_rx_fifo_fill_level_empty;
165 	unsigned long mtl_rx_fifo_read_ctrl_flush;
166 	unsigned long mtl_rx_fifo_read_ctrl_read_data;
167 	unsigned long mtl_rx_fifo_read_ctrl_status;
168 	unsigned long mtl_rx_fifo_read_ctrl_idle;
169 	unsigned long mtl_rx_fifo_ctrl_active;
170 	unsigned long mac_rx_frame_ctrl_fifo;
171 	unsigned long mac_gmii_rx_proto_engine;
172 	/* TSO */
173 	unsigned long tx_tso_frames;
174 	unsigned long tx_tso_nfrags;
175 };
176 
177 /* CSR Frequency Access Defines*/
178 #define CSR_F_35M	35000000
179 #define CSR_F_60M	60000000
180 #define CSR_F_100M	100000000
181 #define CSR_F_150M	150000000
182 #define CSR_F_250M	250000000
183 #define CSR_F_300M	300000000
184 
185 #define	MAC_CSR_H_FRQ_MASK	0x20
186 
187 #define HASH_TABLE_SIZE 64
188 #define PAUSE_TIME 0xffff
189 
190 /* Flow Control defines */
191 #define FLOW_OFF	0
192 #define FLOW_RX		1
193 #define FLOW_TX		2
194 #define FLOW_AUTO	(FLOW_TX | FLOW_RX)
195 
196 /* PCS defines */
197 #define STMMAC_PCS_RGMII	(1 << 0)
198 #define STMMAC_PCS_SGMII	(1 << 1)
199 #define STMMAC_PCS_TBI		(1 << 2)
200 #define STMMAC_PCS_RTBI		(1 << 3)
201 
202 #define SF_DMA_MODE 1		/* DMA STORE-AND-FORWARD Operation Mode */
203 
204 /* DAM HW feature register fields */
205 #define DMA_HW_FEAT_MIISEL	0x00000001	/* 10/100 Mbps Support */
206 #define DMA_HW_FEAT_GMIISEL	0x00000002	/* 1000 Mbps Support */
207 #define DMA_HW_FEAT_HDSEL	0x00000004	/* Half-Duplex Support */
208 #define DMA_HW_FEAT_EXTHASHEN	0x00000008	/* Expanded DA Hash Filter */
209 #define DMA_HW_FEAT_HASHSEL	0x00000010	/* HASH Filter */
210 #define DMA_HW_FEAT_ADDMAC	0x00000020	/* Multiple MAC Addr Reg */
211 #define DMA_HW_FEAT_PCSSEL	0x00000040	/* PCS registers */
212 #define DMA_HW_FEAT_L3L4FLTREN	0x00000080	/* Layer 3 & Layer 4 Feature */
213 #define DMA_HW_FEAT_SMASEL	0x00000100	/* SMA(MDIO) Interface */
214 #define DMA_HW_FEAT_RWKSEL	0x00000200	/* PMT Remote Wakeup */
215 #define DMA_HW_FEAT_MGKSEL	0x00000400	/* PMT Magic Packet */
216 #define DMA_HW_FEAT_MMCSEL	0x00000800	/* RMON Module */
217 #define DMA_HW_FEAT_TSVER1SEL	0x00001000	/* Only IEEE 1588-2002 */
218 #define DMA_HW_FEAT_TSVER2SEL	0x00002000	/* IEEE 1588-2008 PTPv2 */
219 #define DMA_HW_FEAT_EEESEL	0x00004000	/* Energy Efficient Ethernet */
220 #define DMA_HW_FEAT_AVSEL	0x00008000	/* AV Feature */
221 #define DMA_HW_FEAT_TXCOESEL	0x00010000	/* Checksum Offload in Tx */
222 #define DMA_HW_FEAT_RXTYP1COE	0x00020000	/* IP COE (Type 1) in Rx */
223 #define DMA_HW_FEAT_RXTYP2COE	0x00040000	/* IP COE (Type 2) in Rx */
224 #define DMA_HW_FEAT_RXFIFOSIZE	0x00080000	/* Rx FIFO > 2048 Bytes */
225 #define DMA_HW_FEAT_RXCHCNT	0x00300000	/* No. additional Rx Channels */
226 #define DMA_HW_FEAT_TXCHCNT	0x00c00000	/* No. additional Tx Channels */
227 #define DMA_HW_FEAT_ENHDESSEL	0x01000000	/* Alternate Descriptor */
228 /* Timestamping with Internal System Time */
229 #define DMA_HW_FEAT_INTTSEN	0x02000000
230 #define DMA_HW_FEAT_FLEXIPPSEN	0x04000000	/* Flexible PPS Output */
231 #define DMA_HW_FEAT_SAVLANINS	0x08000000	/* Source Addr or VLAN */
232 #define DMA_HW_FEAT_ACTPHYIF	0x70000000	/* Active/selected PHY iface */
233 #define DEFAULT_DMA_PBL		8
234 
235 /* Max/Min RI Watchdog Timer count value */
236 #define MAX_DMA_RIWT		0xff
237 #define MIN_DMA_RIWT		0x20
238 /* Tx coalesce parameters */
239 #define STMMAC_COAL_TX_TIMER	40000
240 #define STMMAC_MAX_COAL_TX_TICK	100000
241 #define STMMAC_TX_MAX_FRAMES	256
242 #define STMMAC_TX_FRAMES	64
243 
244 /* Rx IPC status */
245 enum rx_frame_status {
246 	good_frame = 0x0,
247 	discard_frame = 0x1,
248 	csum_none = 0x2,
249 	llc_snap = 0x4,
250 	dma_own = 0x8,
251 	rx_not_ls = 0x10,
252 };
253 
254 /* Tx status */
255 enum tx_frame_status {
256 	tx_done = 0x0,
257 	tx_not_ls = 0x1,
258 	tx_err = 0x2,
259 	tx_dma_own = 0x4,
260 };
261 
262 enum dma_irq_status {
263 	tx_hard_error = 0x1,
264 	tx_hard_error_bump_tc = 0x2,
265 	handle_rx = 0x4,
266 	handle_tx = 0x8,
267 };
268 
269 /* EEE and LPI defines */
270 #define	CORE_IRQ_TX_PATH_IN_LPI_MODE	(1 << 0)
271 #define	CORE_IRQ_TX_PATH_EXIT_LPI_MODE	(1 << 1)
272 #define	CORE_IRQ_RX_PATH_IN_LPI_MODE	(1 << 2)
273 #define	CORE_IRQ_RX_PATH_EXIT_LPI_MODE	(1 << 3)
274 
275 #define	CORE_PCS_ANE_COMPLETE		(1 << 5)
276 #define	CORE_PCS_LINK_STATUS		(1 << 6)
277 #define	CORE_RGMII_IRQ			(1 << 7)
278 #define CORE_IRQ_MTL_RX_OVERFLOW	BIT(8)
279 
280 /* Physical Coding Sublayer */
281 struct rgmii_adv {
282 	unsigned int pause;
283 	unsigned int duplex;
284 	unsigned int lp_pause;
285 	unsigned int lp_duplex;
286 };
287 
288 #define STMMAC_PCS_PAUSE	1
289 #define STMMAC_PCS_ASYM_PAUSE	2
290 
291 /* DMA HW capabilities */
292 struct dma_features {
293 	unsigned int mbps_10_100;
294 	unsigned int mbps_1000;
295 	unsigned int half_duplex;
296 	unsigned int hash_filter;
297 	unsigned int multi_addr;
298 	unsigned int pcs;
299 	unsigned int sma_mdio;
300 	unsigned int pmt_remote_wake_up;
301 	unsigned int pmt_magic_frame;
302 	unsigned int rmon;
303 	/* IEEE 1588-2002 */
304 	unsigned int time_stamp;
305 	/* IEEE 1588-2008 */
306 	unsigned int atime_stamp;
307 	/* 802.3az - Energy-Efficient Ethernet (EEE) */
308 	unsigned int eee;
309 	unsigned int av;
310 	unsigned int tsoen;
311 	/* TX and RX csum */
312 	unsigned int tx_coe;
313 	unsigned int rx_coe;
314 	unsigned int rx_coe_type1;
315 	unsigned int rx_coe_type2;
316 	unsigned int rxfifo_over_2048;
317 	/* TX and RX number of channels */
318 	unsigned int number_rx_channel;
319 	unsigned int number_tx_channel;
320 	/* Alternate (enhanced) DESC mode */
321 	unsigned int enh_desc;
322 };
323 
324 /* GMAC TX FIFO is 8K, Rx FIFO is 16K */
325 #define BUF_SIZE_16KiB 16384
326 #define BUF_SIZE_8KiB 8192
327 #define BUF_SIZE_4KiB 4096
328 #define BUF_SIZE_2KiB 2048
329 
330 /* Power Down and WOL */
331 #define PMT_NOT_SUPPORTED 0
332 #define PMT_SUPPORTED 1
333 
334 /* Common MAC defines */
335 #define MAC_CTRL_REG		0x00000000	/* MAC Control */
336 #define MAC_ENABLE_TX		0x00000008	/* Transmitter Enable */
337 #define MAC_RNABLE_RX		0x00000004	/* Receiver Enable */
338 
339 /* Default LPI timers */
340 #define STMMAC_DEFAULT_LIT_LS	0x3E8
341 #define STMMAC_DEFAULT_TWT_LS	0x1E
342 
343 #define STMMAC_CHAIN_MODE	0x1
344 #define STMMAC_RING_MODE	0x2
345 
346 #define JUMBO_LEN		9000
347 
348 /* Descriptors helpers */
349 struct stmmac_desc_ops {
350 	/* DMA RX descriptor ring initialization */
351 	void (*init_rx_desc) (struct dma_desc *p, int disable_rx_ic, int mode,
352 			      int end);
353 	/* DMA TX descriptor ring initialization */
354 	void (*init_tx_desc) (struct dma_desc *p, int mode, int end);
355 
356 	/* Invoked by the xmit function to prepare the tx descriptor */
357 	void (*prepare_tx_desc) (struct dma_desc *p, int is_fs, int len,
358 				 bool csum_flag, int mode, bool tx_own,
359 				 bool ls);
360 	void (*prepare_tso_tx_desc)(struct dma_desc *p, int is_fs, int len1,
361 				    int len2, bool tx_own, bool ls,
362 				    unsigned int tcphdrlen,
363 				    unsigned int tcppayloadlen);
364 	/* Set/get the owner of the descriptor */
365 	void (*set_tx_owner) (struct dma_desc *p);
366 	int (*get_tx_owner) (struct dma_desc *p);
367 	/* Clean the tx descriptor as soon as the tx irq is received */
368 	void (*release_tx_desc) (struct dma_desc *p, int mode);
369 	/* Clear interrupt on tx frame completion. When this bit is
370 	 * set an interrupt happens as soon as the frame is transmitted */
371 	void (*set_tx_ic)(struct dma_desc *p);
372 	/* Last tx segment reports the transmit status */
373 	int (*get_tx_ls) (struct dma_desc *p);
374 	/* Return the transmit status looking at the TDES1 */
375 	int (*tx_status) (void *data, struct stmmac_extra_stats *x,
376 			  struct dma_desc *p, void __iomem *ioaddr);
377 	/* Get the buffer size from the descriptor */
378 	int (*get_tx_len) (struct dma_desc *p);
379 	/* Handle extra events on specific interrupts hw dependent */
380 	void (*set_rx_owner) (struct dma_desc *p);
381 	/* Get the receive frame size */
382 	int (*get_rx_frame_len) (struct dma_desc *p, int rx_coe_type);
383 	/* Return the reception status looking at the RDES1 */
384 	int (*rx_status) (void *data, struct stmmac_extra_stats *x,
385 			  struct dma_desc *p);
386 	void (*rx_extended_status) (void *data, struct stmmac_extra_stats *x,
387 				    struct dma_extended_desc *p);
388 	/* Set tx timestamp enable bit */
389 	void (*enable_tx_timestamp) (struct dma_desc *p);
390 	/* get tx timestamp status */
391 	int (*get_tx_timestamp_status) (struct dma_desc *p);
392 	/* get timestamp value */
393 	 u64(*get_timestamp) (void *desc, u32 ats);
394 	/* get rx timestamp status */
395 	int (*get_rx_timestamp_status) (void *desc, u32 ats);
396 	/* Display ring */
397 	void (*display_ring)(void *head, unsigned int size, bool rx);
398 	/* set MSS via context descriptor */
399 	void (*set_mss)(struct dma_desc *p, unsigned int mss);
400 };
401 
402 extern const struct stmmac_desc_ops enh_desc_ops;
403 extern const struct stmmac_desc_ops ndesc_ops;
404 
405 /* Specific DMA helpers */
406 struct stmmac_dma_ops {
407 	/* DMA core initialization */
408 	int (*reset)(void __iomem *ioaddr);
409 	void (*init)(void __iomem *ioaddr, int pbl, int fb, int mb,
410 		     int aal, u32 dma_tx, u32 dma_rx, int atds);
411 	/* Configure the AXI Bus Mode Register */
412 	void (*axi)(void __iomem *ioaddr, struct stmmac_axi *axi);
413 	/* Dump DMA registers */
414 	void (*dump_regs) (void __iomem *ioaddr);
415 	/* Set tx/rx threshold in the csr6 register
416 	 * An invalid value enables the store-and-forward mode */
417 	void (*dma_mode)(void __iomem *ioaddr, int txmode, int rxmode,
418 			 int rxfifosz);
419 	/* To track extra statistic (if supported) */
420 	void (*dma_diagnostic_fr) (void *data, struct stmmac_extra_stats *x,
421 				   void __iomem *ioaddr);
422 	void (*enable_dma_transmission) (void __iomem *ioaddr);
423 	void (*enable_dma_irq) (void __iomem *ioaddr);
424 	void (*disable_dma_irq) (void __iomem *ioaddr);
425 	void (*start_tx) (void __iomem *ioaddr);
426 	void (*stop_tx) (void __iomem *ioaddr);
427 	void (*start_rx) (void __iomem *ioaddr);
428 	void (*stop_rx) (void __iomem *ioaddr);
429 	int (*dma_interrupt) (void __iomem *ioaddr,
430 			      struct stmmac_extra_stats *x);
431 	/* If supported then get the optional core features */
432 	void (*get_hw_feature)(void __iomem *ioaddr,
433 			       struct dma_features *dma_cap);
434 	/* Program the HW RX Watchdog */
435 	void (*rx_watchdog) (void __iomem *ioaddr, u32 riwt);
436 	void (*set_tx_ring_len)(void __iomem *ioaddr, u32 len);
437 	void (*set_rx_ring_len)(void __iomem *ioaddr, u32 len);
438 	void (*set_rx_tail_ptr)(void __iomem *ioaddr, u32 tail_ptr, u32 chan);
439 	void (*set_tx_tail_ptr)(void __iomem *ioaddr, u32 tail_ptr, u32 chan);
440 	void (*enable_tso)(void __iomem *ioaddr, bool en, u32 chan);
441 };
442 
443 struct mac_device_info;
444 
445 /* Helpers to program the MAC core */
446 struct stmmac_ops {
447 	/* MAC core initialization */
448 	void (*core_init)(struct mac_device_info *hw, int mtu);
449 	/* Enable and verify that the IPC module is supported */
450 	int (*rx_ipc)(struct mac_device_info *hw);
451 	/* Dump MAC registers */
452 	void (*dump_regs)(struct mac_device_info *hw);
453 	/* Handle extra events on specific interrupts hw dependent */
454 	int (*host_irq_status)(struct mac_device_info *hw,
455 			       struct stmmac_extra_stats *x);
456 	/* Multicast filter setting */
457 	void (*set_filter)(struct mac_device_info *hw, struct net_device *dev);
458 	/* Flow control setting */
459 	void (*flow_ctrl)(struct mac_device_info *hw, unsigned int duplex,
460 			  unsigned int fc, unsigned int pause_time);
461 	/* Set power management mode (e.g. magic frame) */
462 	void (*pmt)(struct mac_device_info *hw, unsigned long mode);
463 	/* Set/Get Unicast MAC addresses */
464 	void (*set_umac_addr)(struct mac_device_info *hw, unsigned char *addr,
465 			      unsigned int reg_n);
466 	void (*get_umac_addr)(struct mac_device_info *hw, unsigned char *addr,
467 			      unsigned int reg_n);
468 	void (*set_eee_mode)(struct mac_device_info *hw);
469 	void (*reset_eee_mode)(struct mac_device_info *hw);
470 	void (*set_eee_timer)(struct mac_device_info *hw, int ls, int tw);
471 	void (*set_eee_pls)(struct mac_device_info *hw, int link);
472 	void (*ctrl_ane)(struct mac_device_info *hw, bool restart);
473 	void (*get_adv)(struct mac_device_info *hw, struct rgmii_adv *adv);
474 	void (*debug)(void __iomem *ioaddr, struct stmmac_extra_stats *x);
475 };
476 
477 /* PTP and HW Timer helpers */
478 struct stmmac_hwtimestamp {
479 	void (*config_hw_tstamping) (void __iomem *ioaddr, u32 data);
480 	u32 (*config_sub_second_increment) (void __iomem *ioaddr, u32 clk_rate);
481 	int (*init_systime) (void __iomem *ioaddr, u32 sec, u32 nsec);
482 	int (*config_addend) (void __iomem *ioaddr, u32 addend);
483 	int (*adjust_systime) (void __iomem *ioaddr, u32 sec, u32 nsec,
484 			       int add_sub);
485 	 u64(*get_systime) (void __iomem *ioaddr);
486 };
487 
488 extern const struct stmmac_hwtimestamp stmmac_ptp;
489 extern const struct stmmac_mode_ops dwmac4_ring_mode_ops;
490 
491 struct mac_link {
492 	int port;
493 	int duplex;
494 	int speed;
495 };
496 
497 struct mii_regs {
498 	unsigned int addr;	/* MII Address */
499 	unsigned int data;	/* MII Data */
500 };
501 
502 /* Helpers to manage the descriptors for chain and ring modes */
503 struct stmmac_mode_ops {
504 	void (*init) (void *des, dma_addr_t phy_addr, unsigned int size,
505 		      unsigned int extend_desc);
506 	unsigned int (*is_jumbo_frm) (int len, int ehn_desc);
507 	int (*jumbo_frm)(void *priv, struct sk_buff *skb, int csum);
508 	int (*set_16kib_bfsize)(int mtu);
509 	void (*init_desc3)(struct dma_desc *p);
510 	void (*refill_desc3) (void *priv, struct dma_desc *p);
511 	void (*clean_desc3) (void *priv, struct dma_desc *p);
512 };
513 
514 struct mac_device_info {
515 	const struct stmmac_ops *mac;
516 	const struct stmmac_desc_ops *desc;
517 	const struct stmmac_dma_ops *dma;
518 	const struct stmmac_mode_ops *mode;
519 	const struct stmmac_hwtimestamp *ptp;
520 	struct mii_regs mii;	/* MII register Addresses */
521 	struct mac_link link;
522 	void __iomem *pcsr;     /* vpointer to device CSRs */
523 	int multicast_filter_bins;
524 	int unicast_filter_entries;
525 	int mcast_bits_log2;
526 	unsigned int rx_csum;
527 };
528 
529 struct mac_device_info *dwmac1000_setup(void __iomem *ioaddr, int mcbins,
530 					int perfect_uc_entries,
531 					int *synopsys_id);
532 struct mac_device_info *dwmac100_setup(void __iomem *ioaddr, int *synopsys_id);
533 struct mac_device_info *dwmac4_setup(void __iomem *ioaddr, int mcbins,
534 				     int perfect_uc_entries, int *synopsys_id);
535 
536 void stmmac_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
537 			 unsigned int high, unsigned int low);
538 void stmmac_get_mac_addr(void __iomem *ioaddr, unsigned char *addr,
539 			 unsigned int high, unsigned int low);
540 void stmmac_set_mac(void __iomem *ioaddr, bool enable);
541 
542 void stmmac_dwmac4_set_mac_addr(void __iomem *ioaddr, u8 addr[6],
543 				unsigned int high, unsigned int low);
544 void stmmac_dwmac4_get_mac_addr(void __iomem *ioaddr, unsigned char *addr,
545 				unsigned int high, unsigned int low);
546 void stmmac_dwmac4_set_mac(void __iomem *ioaddr, bool enable);
547 
548 void dwmac_dma_flush_tx_fifo(void __iomem *ioaddr);
549 extern const struct stmmac_mode_ops ring_mode_ops;
550 extern const struct stmmac_mode_ops chain_mode_ops;
551 extern const struct stmmac_desc_ops dwmac4_desc_ops;
552 
553 /**
554  * stmmac_get_synopsys_id - return the SYINID.
555  * @priv: driver private structure
556  * Description: this simple function is to decode and return the SYINID
557  * starting from the HW core register.
558  */
559 static inline u32 stmmac_get_synopsys_id(u32 hwid)
560 {
561 	/* Check Synopsys Id (not available on old chips) */
562 	if (likely(hwid)) {
563 		u32 uid = ((hwid & 0x0000ff00) >> 8);
564 		u32 synid = (hwid & 0x000000ff);
565 
566 		pr_info("stmmac - user ID: 0x%x, Synopsys ID: 0x%x\n",
567 			uid, synid);
568 
569 		return synid;
570 	}
571 	return 0;
572 }
573 #endif /* __COMMON_H__ */
574