ethernet: support GMAC driver for RK3128
[firefly-linux-kernel-4.4.55.git] / drivers / net / ethernet / rockchip / gmac / 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 #ifndef __STMMAC_H__
24 #define __STMMAC_H__
25
26 #define STMMAC_RESOURCE_NAME   "stmmaceth"
27 #define DRV_MODULE_VERSION      "March_2013"
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
36 struct stmmac_priv {
37         /* Frequently used values are kept adjacent for cache effect */
38         struct dma_extended_desc *dma_etx ____cacheline_aligned_in_smp;
39         struct dma_desc *dma_tx;
40         struct sk_buff **tx_skbuff;
41         unsigned int cur_tx;
42         unsigned int dirty_tx;
43         unsigned int dma_tx_size;
44         u32 tx_count_frames;
45         u32 tx_coal_frames;
46         u32 tx_coal_timer;
47         dma_addr_t *tx_skbuff_dma;
48         dma_addr_t dma_tx_phy;
49         int tx_coalesce;
50         int hwts_tx_en;
51         spinlock_t tx_lock;
52         bool tx_path_in_lpi_mode;
53         struct timer_list txtimer;
54
55         struct dma_desc *dma_rx ____cacheline_aligned_in_smp;
56         struct dma_extended_desc *dma_erx;
57         struct sk_buff **rx_skbuff;
58         unsigned int cur_rx;
59         unsigned int dirty_rx;
60         unsigned int dma_rx_size;
61         unsigned int dma_buf_sz;
62         u32 rx_riwt;
63         int hwts_rx_en;
64         dma_addr_t *rx_skbuff_dma;
65         dma_addr_t dma_rx_phy;
66
67         struct napi_struct napi ____cacheline_aligned_in_smp;
68
69         void __iomem *ioaddr;
70         struct net_device *dev;
71         struct device *device;
72         struct mac_device_info *hw;
73         int no_csum_insertion;
74         spinlock_t lock;
75
76         struct phy_device *phydev ____cacheline_aligned_in_smp;
77         int oldlink;
78         int speed;
79         int oldduplex;
80         unsigned int flow_ctrl;
81         unsigned int pause;
82         struct mii_bus *mii;
83         int mii_irq[PHY_MAX_ADDR];
84
85         struct stmmac_extra_stats xstats ____cacheline_aligned_in_smp;
86         struct plat_stmmacenet_data *plat;
87         struct dma_features dma_cap;
88         struct stmmac_counters mmc;
89         int hw_cap_support;
90         int synopsys_id;
91         u32 msg_enable;
92         int wolopts;
93         int wol_irq;
94         struct clk *stmmac_clk;
95         int clk_csr;
96         struct timer_list eee_ctrl_timer;
97         int lpi_irq;
98         int eee_enabled;
99         int eee_active;
100         int tx_lpi_timer;
101         int pcs;
102         unsigned int mode;
103         int extend_desc;
104         struct ptp_clock *ptp_clock;
105         struct ptp_clock_info ptp_clock_ops;
106         unsigned int default_addend;
107         u32 adv_ts;
108         int use_riwt;
109         spinlock_t ptp_lock;
110         bool mdio_registered;
111 };
112
113 struct bsp_priv {
114         bool power_ctrl_by_pmu;
115         char pmu_regulator[32];
116         int pmu_enable_level;
117         int power_io;
118         int power_io_level;
119         int reset_io;
120         int reset_io_level;
121         int phy_iface;
122
123         struct clk *clk_mac;
124         struct clk *clk_mac_pll;
125         struct clk *gmac_clkin;
126         struct clk *mac_clk_rx;
127         struct clk *mac_clk_tx;
128         struct clk *clk_mac_ref;
129         struct clk *clk_mac_refout;
130         struct clk *aclk_mac;
131         struct clk *pclk_mac;
132         bool clk_enable;
133
134         int (*phy_power_on)(bool enable);
135         int (*gmac_clk_enable)(bool enable);
136 };
137
138 extern int phyaddr;
139
140 extern int stmmac_mdio_unregister(struct net_device *ndev);
141 extern int stmmac_mdio_register(struct net_device *ndev);
142 extern void stmmac_set_ethtool_ops(struct net_device *netdev);
143 extern const struct stmmac_desc_ops enh_desc_ops;
144 extern const struct stmmac_desc_ops ndesc_ops;
145 extern const struct stmmac_hwtimestamp stmmac_ptp;
146 extern int stmmac_ptp_register(struct stmmac_priv *priv);
147 extern void stmmac_ptp_unregister(struct stmmac_priv *priv);
148 int stmmac_freeze(struct net_device *ndev);
149 int stmmac_restore(struct net_device *ndev);
150 int stmmac_resume(struct net_device *ndev);
151 int stmmac_suspend(struct net_device *ndev);
152 int stmmac_dvr_remove(struct net_device *ndev);
153 struct stmmac_priv *stmmac_dvr_probe(struct device *device,
154                                      struct plat_stmmacenet_data *plat_dat,
155                                      void __iomem *addr);
156 void stmmac_disable_eee_mode(struct stmmac_priv *priv);
157 bool stmmac_eee_init(struct stmmac_priv *priv);
158
159 extern struct platform_driver stmmac_pltfr_driver;
160 static inline int stmmac_register_platform(void)
161 {
162         int err;
163
164         err = platform_driver_register(&stmmac_pltfr_driver);
165         if (err)
166                 pr_err("stmmac: failed to register the platform driver\n");
167
168         return err;
169 }
170
171 static inline void stmmac_unregister_platform(void)
172 {
173         platform_driver_unregister(&stmmac_pltfr_driver);
174 }
175
176 #ifdef CONFIG_STMMAC_PCI
177 extern struct pci_driver stmmac_pci_driver;
178 static inline int stmmac_register_pci(void)
179 {
180         int err;
181
182         err = pci_register_driver(&stmmac_pci_driver);
183         if (err)
184                 pr_err("stmmac: failed to register the PCI driver\n");
185
186         return err;
187 }
188
189 static inline void stmmac_unregister_pci(void)
190 {
191         pci_unregister_driver(&stmmac_pci_driver);
192 }
193 #else
194 static inline int stmmac_register_pci(void)
195 {
196         pr_debug("stmmac: do not register the PCI driver\n");
197
198         return 0;
199 }
200
201 static inline void stmmac_unregister_pci(void)
202 {
203 }
204 #endif /* CONFIG_STMMAC_PCI */
205
206 #endif /* __STMMAC_H__ */