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 /* Frequently used values are kept adjacent for cache effect */
50 struct stmmac_tx_queue {
51 	u32 queue_index;
52 	struct stmmac_priv *priv_data;
53 	struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
54 	struct dma_desc *dma_tx;
55 	struct sk_buff **tx_skbuff;
56 	struct stmmac_tx_info *tx_skbuff_dma;
57 	unsigned int cur_tx;
58 	unsigned int dirty_tx;
59 	dma_addr_t dma_tx_phy;
60 	u32 tx_tail_addr;
61 };
62 
63 struct stmmac_rx_queue {
64 	u32 queue_index;
65 	struct stmmac_priv *priv_data;
66 	struct dma_extended_desc *dma_erx;
67 	struct dma_desc *dma_rx ____cacheline_aligned_in_smp;
68 	struct sk_buff **rx_skbuff;
69 	dma_addr_t *rx_skbuff_dma;
70 	struct napi_struct napi ____cacheline_aligned_in_smp;
71 	unsigned int cur_rx;
72 	unsigned int dirty_rx;
73 	u32 rx_zeroc_thresh;
74 	dma_addr_t dma_rx_phy;
75 	u32 rx_tail_addr;
76 };
77 
78 struct stmmac_priv {
79 	/* Frequently used values are kept adjacent for cache effect */
80 	struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
81 	struct dma_desc *dma_tx;
82 	struct sk_buff **tx_skbuff;
83 	unsigned int cur_tx;
84 	unsigned int dirty_tx;
85 	u32 tx_count_frames;
86 	u32 tx_coal_frames;
87 	u32 tx_coal_timer;
88 	int tx_coalesce;
89 	int hwts_tx_en;
90 	bool tx_path_in_lpi_mode;
91 	struct timer_list txtimer;
92 	bool tso;
93 
94 	/* TX Queue */
95 	struct stmmac_tx_queue *tx_queue;
96 
97 	/* RX Queue */
98 	struct stmmac_rx_queue *rx_queue;
99 
100 	unsigned int dma_buf_sz;
101 	unsigned int rx_copybreak;
102 	u32 rx_riwt;
103 	int hwts_rx_en;
104 
105 	void __iomem *ioaddr;
106 	struct net_device *dev;
107 	struct device *device;
108 	struct mac_device_info *hw;
109 	spinlock_t lock;
110 
111 	int oldlink;
112 	int speed;
113 	int oldduplex;
114 	unsigned int flow_ctrl;
115 	unsigned int pause;
116 	struct mii_bus *mii;
117 	int mii_irq[PHY_MAX_ADDR];
118 
119 	struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
120 	struct plat_stmmacenet_data *plat;
121 	struct dma_features dma_cap;
122 	struct stmmac_counters mmc;
123 	int hw_cap_support;
124 	int synopsys_id;
125 	u32 msg_enable;
126 	int wolopts;
127 	int wol_irq;
128 	int clk_csr;
129 	struct timer_list eee_ctrl_timer;
130 	int lpi_irq;
131 	int eee_enabled;
132 	int eee_active;
133 	int tx_lpi_timer;
134 	unsigned int mode;
135 	int extend_desc;
136 	struct ptp_clock *ptp_clock;
137 	struct ptp_clock_info ptp_clock_ops;
138 	unsigned int default_addend;
139 	u32 adv_ts;
140 	int use_riwt;
141 	int irq_wake;
142 	spinlock_t ptp_lock;
143 	void __iomem *mmcaddr;
144 	void __iomem *ptpaddr;
145 	u32 mss;
146 
147 #ifdef CONFIG_DEBUG_FS
148 	struct dentry *dbgfs_dir;
149 	struct dentry *dbgfs_rings_status;
150 	struct dentry *dbgfs_dma_cap;
151 #endif
152 };
153 
154 int stmmac_mdio_unregister(struct net_device *ndev);
155 int stmmac_mdio_register(struct net_device *ndev);
156 int stmmac_mdio_reset(struct mii_bus *mii);
157 void stmmac_set_ethtool_ops(struct net_device *netdev);
158 
159 void stmmac_ptp_register(struct stmmac_priv *priv);
160 void stmmac_ptp_unregister(struct stmmac_priv *priv);
161 int stmmac_resume(struct device *dev);
162 int stmmac_suspend(struct device *dev);
163 int stmmac_dvr_remove(struct device *dev);
164 int stmmac_dvr_probe(struct device *device,
165 		     struct plat_stmmacenet_data *plat_dat,
166 		     struct stmmac_resources *res);
167 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
168 bool stmmac_eee_init(struct stmmac_priv *priv);
169 
170 #endif /* __STMMAC_H__ */
171