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   You should have received a copy of the GNU General Public License along with
14   this program; if not, write to the Free Software Foundation, Inc.,
15   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
16 
17   The full GNU General Public License is included in this distribution in
18   the file called "COPYING".
19 
20   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
21 *******************************************************************************/
22 
23 #ifndef __STMMAC_H__
24 #define __STMMAC_H__
25 
26 #define STMMAC_RESOURCE_NAME   "stmmaceth"
27 #define DRV_MODULE_VERSION	"Jan_2016"
28 
29 #include <linux/clk.h>
30 #include <linux/stmmac.h>
31 #include <linux/phy.h>
32 #include <linux/pci.h>
33 #include "common.h"
34 #include <linux/ptp_clock_kernel.h>
35 #include <linux/reset.h>
36 
37 struct stmmac_resources {
38 	void __iomem *addr;
39 	const char *mac;
40 	int wol_irq;
41 	int lpi_irq;
42 	int irq;
43 };
44 
45 struct stmmac_tx_info {
46 	dma_addr_t buf;
47 	bool map_as_page;
48 	unsigned len;
49 	bool last_segment;
50 	bool is_jumbo;
51 };
52 
53 struct stmmac_priv {
54 	/* Frequently used values are kept adjacent for cache effect */
55 	struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
56 	struct dma_desc *dma_tx;
57 	struct sk_buff **tx_skbuff;
58 	unsigned int cur_tx;
59 	unsigned int dirty_tx;
60 	u32 tx_count_frames;
61 	u32 tx_coal_frames;
62 	u32 tx_coal_timer;
63 	struct stmmac_tx_info *tx_skbuff_dma;
64 	dma_addr_t dma_tx_phy;
65 	int tx_coalesce;
66 	int hwts_tx_en;
67 	spinlock_t tx_lock;
68 	bool tx_path_in_lpi_mode;
69 	struct timer_list txtimer;
70 	bool tso;
71 
72 	struct dma_desc *dma_rx	____cacheline_aligned_in_smp;
73 	struct dma_extended_desc *dma_erx;
74 	struct sk_buff **rx_skbuff;
75 	unsigned int cur_rx;
76 	unsigned int dirty_rx;
77 	unsigned int dma_buf_sz;
78 	unsigned int rx_copybreak;
79 	unsigned int rx_zeroc_thresh;
80 	u32 rx_riwt;
81 	int hwts_rx_en;
82 	dma_addr_t *rx_skbuff_dma;
83 	dma_addr_t dma_rx_phy;
84 
85 	struct napi_struct napi ____cacheline_aligned_in_smp;
86 
87 	void __iomem *ioaddr;
88 	struct net_device *dev;
89 	struct device *device;
90 	struct mac_device_info *hw;
91 	spinlock_t lock;
92 
93 	struct phy_device *phydev ____cacheline_aligned_in_smp;
94 	int oldlink;
95 	int speed;
96 	int oldduplex;
97 	unsigned int flow_ctrl;
98 	unsigned int pause;
99 	struct mii_bus *mii;
100 	int mii_irq[PHY_MAX_ADDR];
101 
102 	struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
103 	struct plat_stmmacenet_data *plat;
104 	struct dma_features dma_cap;
105 	struct stmmac_counters mmc;
106 	int hw_cap_support;
107 	int synopsys_id;
108 	u32 msg_enable;
109 	int wolopts;
110 	int wol_irq;
111 	struct clk *stmmac_clk;
112 	struct clk *pclk;
113 	struct reset_control *stmmac_rst;
114 	int clk_csr;
115 	struct timer_list eee_ctrl_timer;
116 	int lpi_irq;
117 	int eee_enabled;
118 	int eee_active;
119 	int tx_lpi_timer;
120 	int pcs;
121 	unsigned int mode;
122 	int extend_desc;
123 	struct ptp_clock *ptp_clock;
124 	struct ptp_clock_info ptp_clock_ops;
125 	unsigned int default_addend;
126 	struct clk *clk_ptp_ref;
127 	unsigned int clk_ptp_rate;
128 	u32 adv_ts;
129 	int use_riwt;
130 	int irq_wake;
131 	spinlock_t ptp_lock;
132 	void __iomem *mmcaddr;
133 	u32 rx_tail_addr;
134 	u32 tx_tail_addr;
135 	u32 mss;
136 
137 #ifdef CONFIG_DEBUG_FS
138 	struct dentry *dbgfs_dir;
139 	struct dentry *dbgfs_rings_status;
140 	struct dentry *dbgfs_dma_cap;
141 #endif
142 };
143 
144 int stmmac_mdio_unregister(struct net_device *ndev);
145 int stmmac_mdio_register(struct net_device *ndev);
146 int stmmac_mdio_reset(struct mii_bus *mii);
147 void stmmac_set_ethtool_ops(struct net_device *netdev);
148 
149 int stmmac_ptp_register(struct stmmac_priv *priv);
150 void stmmac_ptp_unregister(struct stmmac_priv *priv);
151 int stmmac_resume(struct device *dev);
152 int stmmac_suspend(struct device *dev);
153 int stmmac_dvr_remove(struct device *dev);
154 int stmmac_dvr_probe(struct device *device,
155 		     struct plat_stmmacenet_data *plat_dat,
156 		     struct stmmac_resources *res);
157 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
158 bool stmmac_eee_init(struct stmmac_priv *priv);
159 
160 #endif /* __STMMAC_H__ */
161