ab4c376cb2763bf8c98ceac42d3e290b16ec341b
[firefly-linux-kernel-4.4.55.git] / drivers / net / ethernet / stmicro / stmmac / stmmac.h
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 #define STMMAC_RESOURCE_NAME   "stmmaceth"
24 #define DRV_MODULE_VERSION      "March_2012"
25
26 #include <linux/clk.h>
27 #include <linux/stmmac.h>
28 #include <linux/phy.h>
29 #include <linux/pci.h>
30 #include "common.h"
31 #ifdef CONFIG_STMMAC_TIMER
32 #include "stmmac_timer.h"
33 #endif
34
35 struct stmmac_priv {
36         /* Frequently used values are kept adjacent for cache effect */
37         struct dma_desc *dma_tx ____cacheline_aligned;
38         dma_addr_t dma_tx_phy;
39         struct sk_buff **tx_skbuff;
40         unsigned int cur_tx;
41         unsigned int dirty_tx;
42         unsigned int dma_tx_size;
43         int tx_coalesce;
44
45         struct dma_desc *dma_rx ;
46         unsigned int cur_rx;
47         unsigned int dirty_rx;
48         struct sk_buff **rx_skbuff;
49         dma_addr_t *rx_skbuff_dma;
50         struct sk_buff_head rx_recycle;
51
52         struct net_device *dev;
53         dma_addr_t dma_rx_phy;
54         unsigned int dma_rx_size;
55         unsigned int dma_buf_sz;
56         struct device *device;
57         struct mac_device_info *hw;
58         void __iomem *ioaddr;
59
60         struct stmmac_extra_stats xstats;
61         struct napi_struct napi;
62         int no_csum_insertion;
63
64         struct phy_device *phydev;
65         int oldlink;
66         int speed;
67         int oldduplex;
68         unsigned int flow_ctrl;
69         unsigned int pause;
70         struct mii_bus *mii;
71         int mii_irq[PHY_MAX_ADDR];
72
73         u32 msg_enable;
74         spinlock_t lock;
75         spinlock_t tx_lock;
76         int wolopts;
77         int wol_irq;
78 #ifdef CONFIG_STMMAC_TIMER
79         struct stmmac_timer *tm;
80 #endif
81         struct plat_stmmacenet_data *plat;
82         struct stmmac_counters mmc;
83         struct dma_features dma_cap;
84         int hw_cap_support;
85 #ifdef CONFIG_HAVE_CLK
86         struct clk *stmmac_clk;
87 #endif
88         int clk_csr;
89         int synopsys_id;
90         struct timer_list eee_ctrl_timer;
91         bool tx_path_in_lpi_mode;
92         int lpi_irq;
93         int eee_enabled;
94         int eee_active;
95         int tx_lpi_timer;
96 };
97
98 extern int phyaddr;
99
100 extern int stmmac_mdio_unregister(struct net_device *ndev);
101 extern int stmmac_mdio_register(struct net_device *ndev);
102 extern void stmmac_set_ethtool_ops(struct net_device *netdev);
103 extern const struct stmmac_desc_ops enh_desc_ops;
104 extern const struct stmmac_desc_ops ndesc_ops;
105 int stmmac_freeze(struct net_device *ndev);
106 int stmmac_restore(struct net_device *ndev);
107 int stmmac_resume(struct net_device *ndev);
108 int stmmac_suspend(struct net_device *ndev);
109 int stmmac_dvr_remove(struct net_device *ndev);
110 struct stmmac_priv *stmmac_dvr_probe(struct device *device,
111                                      struct plat_stmmacenet_data *plat_dat,
112                                      void __iomem *addr);
113 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
114 bool stmmac_eee_init(struct stmmac_priv *priv);
115
116 #ifdef CONFIG_HAVE_CLK
117 static inline int stmmac_clk_enable(struct stmmac_priv *priv)
118 {
119         if (!IS_ERR(priv->stmmac_clk))
120                 return clk_prepare_enable(priv->stmmac_clk);
121
122         return 0;
123 }
124
125 static inline void stmmac_clk_disable(struct stmmac_priv *priv)
126 {
127         if (IS_ERR(priv->stmmac_clk))
128                 return;
129
130         clk_disable_unprepare(priv->stmmac_clk);
131 }
132 static inline int stmmac_clk_get(struct stmmac_priv *priv)
133 {
134         priv->stmmac_clk = clk_get(priv->device, NULL);
135
136         if (IS_ERR(priv->stmmac_clk))
137                 return PTR_ERR(priv->stmmac_clk);
138
139         return 0;
140 }
141 #else
142 static inline int stmmac_clk_enable(struct stmmac_priv *priv)
143 {
144         return 0;
145 }
146 static inline void stmmac_clk_disable(struct stmmac_priv *priv)
147 {
148 }
149 static inline int stmmac_clk_get(struct stmmac_priv *priv)
150 {
151         return 0;
152 }
153 #endif /* CONFIG_HAVE_CLK */
154
155
156 #ifdef CONFIG_STMMAC_PLATFORM
157 extern struct platform_driver stmmac_pltfr_driver;
158 static inline int stmmac_register_platform(void)
159 {
160         int err;
161
162         err = platform_driver_register(&stmmac_pltfr_driver);
163         if (err)
164                 pr_err("stmmac: failed to register the platform driver\n");
165
166         return err;
167 }
168 static inline void stmmac_unregister_platform(void)
169 {
170         platform_driver_register(&stmmac_pltfr_driver);
171 }
172 #else
173 static inline int stmmac_register_platform(void)
174 {
175         pr_debug("stmmac: do not register the platf driver\n");
176
177         return -EINVAL;
178 }
179 static inline void stmmac_unregister_platform(void)
180 {
181 }
182 #endif /* CONFIG_STMMAC_PLATFORM */
183
184 #ifdef CONFIG_STMMAC_PCI
185 extern struct pci_driver stmmac_pci_driver;
186 static inline int stmmac_register_pci(void)
187 {
188         int err;
189
190         err = pci_register_driver(&stmmac_pci_driver);
191         if (err)
192                 pr_err("stmmac: failed to register the PCI driver\n");
193
194         return err;
195 }
196 static inline void stmmac_unregister_pci(void)
197 {
198         pci_unregister_driver(&stmmac_pci_driver);
199 }
200 #else
201 static inline int stmmac_register_pci(void)
202 {
203         pr_debug("stmmac: do not register the PCI driver\n");
204
205         return -EINVAL;
206 }
207 static inline void stmmac_unregister_pci(void)
208 {
209 }
210 #endif /* CONFIG_STMMAC_PCI */