1 /*******************************************************************************
2   Copyright (C) 2007-2009  STMicroelectronics Ltd
3 
4   This program is free software; you can redistribute it and/or modify it
5   under the terms and conditions of the GNU General Public License,
6   version 2, as published by the Free Software Foundation.
7 
8   This program is distributed in the hope it will be useful, but WITHOUT
9   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
11   more details.
12 
13   The full GNU General Public License is included in this distribution in
14   the file called "COPYING".
15 
16   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
17 *******************************************************************************/
18 
19 #ifndef __STMMAC_H__
20 #define __STMMAC_H__
21 
22 #define STMMAC_RESOURCE_NAME   "stmmaceth"
23 #define DRV_MODULE_VERSION	"Jan_2016"
24 
25 #include <linux/clk.h>
26 #include <linux/stmmac.h>
27 #include <linux/phy.h>
28 #include <linux/pci.h>
29 #include "common.h"
30 #include <linux/ptp_clock_kernel.h>
31 #include <linux/reset.h>
32 
33 struct stmmac_resources {
34 	void __iomem *addr;
35 	const char *mac;
36 	int wol_irq;
37 	int lpi_irq;
38 	int irq;
39 };
40 
41 struct stmmac_tx_info {
42 	dma_addr_t buf;
43 	bool map_as_page;
44 	unsigned len;
45 	bool last_segment;
46 	bool is_jumbo;
47 };
48 
49 struct stmmac_priv {
50 	/* Frequently used values are kept adjacent for cache effect */
51 	struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
52 	struct dma_desc *dma_tx;
53 	struct sk_buff **tx_skbuff;
54 	unsigned int cur_tx;
55 	unsigned int dirty_tx;
56 	u32 tx_count_frames;
57 	u32 tx_coal_frames;
58 	u32 tx_coal_timer;
59 	struct stmmac_tx_info *tx_skbuff_dma;
60 	dma_addr_t dma_tx_phy;
61 	int tx_coalesce;
62 	int hwts_tx_en;
63 	bool tx_path_in_lpi_mode;
64 	struct timer_list txtimer;
65 	bool tso;
66 
67 	struct dma_desc *dma_rx	____cacheline_aligned_in_smp;
68 	struct dma_extended_desc *dma_erx;
69 	struct sk_buff **rx_skbuff;
70 	unsigned int cur_rx;
71 	unsigned int dirty_rx;
72 	unsigned int dma_buf_sz;
73 	unsigned int rx_copybreak;
74 	unsigned int rx_zeroc_thresh;
75 	u32 rx_riwt;
76 	int hwts_rx_en;
77 	dma_addr_t *rx_skbuff_dma;
78 	dma_addr_t dma_rx_phy;
79 
80 	struct napi_struct napi ____cacheline_aligned_in_smp;
81 
82 	void __iomem *ioaddr;
83 	struct net_device *dev;
84 	struct device *device;
85 	struct mac_device_info *hw;
86 	spinlock_t lock;
87 
88 	int oldlink;
89 	int speed;
90 	int oldduplex;
91 	unsigned int flow_ctrl;
92 	unsigned int pause;
93 	struct mii_bus *mii;
94 	int mii_irq[PHY_MAX_ADDR];
95 
96 	struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
97 	struct plat_stmmacenet_data *plat;
98 	struct dma_features dma_cap;
99 	struct stmmac_counters mmc;
100 	int hw_cap_support;
101 	int synopsys_id;
102 	u32 msg_enable;
103 	int wolopts;
104 	int wol_irq;
105 	int clk_csr;
106 	struct timer_list eee_ctrl_timer;
107 	int lpi_irq;
108 	int eee_enabled;
109 	int eee_active;
110 	int tx_lpi_timer;
111 	unsigned int mode;
112 	int extend_desc;
113 	struct ptp_clock *ptp_clock;
114 	struct ptp_clock_info ptp_clock_ops;
115 	unsigned int default_addend;
116 	u32 adv_ts;
117 	int use_riwt;
118 	int irq_wake;
119 	spinlock_t ptp_lock;
120 	void __iomem *mmcaddr;
121 	void __iomem *ptpaddr;
122 	u32 rx_tail_addr;
123 	u32 tx_tail_addr;
124 	u32 mss;
125 
126 #ifdef CONFIG_DEBUG_FS
127 	struct dentry *dbgfs_dir;
128 	struct dentry *dbgfs_rings_status;
129 	struct dentry *dbgfs_dma_cap;
130 #endif
131 };
132 
133 int stmmac_mdio_unregister(struct net_device *ndev);
134 int stmmac_mdio_register(struct net_device *ndev);
135 int stmmac_mdio_reset(struct mii_bus *mii);
136 void stmmac_set_ethtool_ops(struct net_device *netdev);
137 
138 void stmmac_ptp_register(struct stmmac_priv *priv);
139 void stmmac_ptp_unregister(struct stmmac_priv *priv);
140 int stmmac_resume(struct device *dev);
141 int stmmac_suspend(struct device *dev);
142 int stmmac_dvr_remove(struct device *dev);
143 int stmmac_dvr_probe(struct device *device,
144 		     struct plat_stmmacenet_data *plat_dat,
145 		     struct stmmac_resources *res);
146 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
147 bool stmmac_eee_init(struct stmmac_priv *priv);
148 
149 #endif /* __STMMAC_H__ */
150