stmmac: add the Energy Efficient Ethernet support
[cascardo/linux.git] / drivers / net / ethernet / stmicro / stmmac / stmmac_platform.c
1 /*******************************************************************************
2   This contains the functions to handle the platform driver.
3
4   Copyright (C) 2007-2011  STMicroelectronics Ltd
5
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
24
25 #include <linux/platform_device.h>
26 #include <linux/io.h>
27 #include <linux/of.h>
28 #include <linux/of_net.h>
29 #include "stmmac.h"
30
31 #ifdef CONFIG_OF
32 static int __devinit stmmac_probe_config_dt(struct platform_device *pdev,
33                                             struct plat_stmmacenet_data *plat,
34                                             const char **mac)
35 {
36         struct device_node *np = pdev->dev.of_node;
37
38         if (!np)
39                 return -ENODEV;
40
41         *mac = of_get_mac_address(np);
42         plat->interface = of_get_phy_mode(np);
43         plat->mdio_bus_data = devm_kzalloc(&pdev->dev,
44                                            sizeof(struct stmmac_mdio_bus_data),
45                                            GFP_KERNEL);
46
47         /*
48          * Currently only the properties needed on SPEAr600
49          * are provided. All other properties should be added
50          * once needed on other platforms.
51          */
52         if (of_device_is_compatible(np, "st,spear600-gmac")) {
53                 plat->has_gmac = 1;
54                 plat->pmt = 1;
55         }
56
57         return 0;
58 }
59 #else
60 static int __devinit stmmac_probe_config_dt(struct platform_device *pdev,
61                                             struct plat_stmmacenet_data *plat,
62                                             const char **mac)
63 {
64         return -ENOSYS;
65 }
66 #endif /* CONFIG_OF */
67
68 /**
69  * stmmac_pltfr_probe
70  * @pdev: platform device pointer
71  * Description: platform_device probe function. It allocates
72  * the necessary resources and invokes the main to init
73  * the net device, register the mdio bus etc.
74  */
75 static int stmmac_pltfr_probe(struct platform_device *pdev)
76 {
77         int ret = 0;
78         struct resource *res;
79         void __iomem *addr = NULL;
80         struct stmmac_priv *priv = NULL;
81         struct plat_stmmacenet_data *plat_dat = NULL;
82         const char *mac = NULL;
83
84         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
85         if (!res)
86                 return -ENODEV;
87
88         if (!request_mem_region(res->start, resource_size(res), pdev->name)) {
89                 pr_err("%s: ERROR: memory allocation failed"
90                        "cannot get the I/O addr 0x%x\n",
91                        __func__, (unsigned int)res->start);
92                 return -EBUSY;
93         }
94
95         addr = ioremap(res->start, resource_size(res));
96         if (!addr) {
97                 pr_err("%s: ERROR: memory mapping failed", __func__);
98                 ret = -ENOMEM;
99                 goto out_release_region;
100         }
101
102         if (pdev->dev.of_node) {
103                 plat_dat = devm_kzalloc(&pdev->dev,
104                                         sizeof(struct plat_stmmacenet_data),
105                                         GFP_KERNEL);
106                 if (!plat_dat) {
107                         pr_err("%s: ERROR: no memory", __func__);
108                         ret = -ENOMEM;
109                         goto out_unmap;
110                 }
111
112                 ret = stmmac_probe_config_dt(pdev, plat_dat, &mac);
113                 if (ret) {
114                         pr_err("%s: main dt probe failed", __func__);
115                         goto out_unmap;
116                 }
117         } else {
118                 plat_dat = pdev->dev.platform_data;
119         }
120
121         /* Custom initialisation (if needed)*/
122         if (plat_dat->init) {
123                 ret = plat_dat->init(pdev);
124                 if (unlikely(ret))
125                         goto out_unmap;
126         }
127
128         priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr);
129         if (!priv) {
130                 pr_err("%s: main driver probe failed", __func__);
131                 goto out_unmap;
132         }
133
134         /* Get MAC address if available (DT) */
135         if (mac)
136                 memcpy(priv->dev->dev_addr, mac, ETH_ALEN);
137
138         /* Get the MAC information */
139         priv->dev->irq = platform_get_irq_byname(pdev, "macirq");
140         if (priv->dev->irq == -ENXIO) {
141                 pr_err("%s: ERROR: MAC IRQ configuration "
142                        "information not found\n", __func__);
143                 ret = -ENXIO;
144                 goto out_unmap;
145         }
146
147         /*
148          * On some platforms e.g. SPEAr the wake up irq differs from the mac irq
149          * The external wake up irq can be passed through the platform code
150          * named as "eth_wake_irq"
151          *
152          * In case the wake up interrupt is not passed from the platform
153          * so the driver will continue to use the mac irq (ndev->irq)
154          */
155         priv->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
156         if (priv->wol_irq == -ENXIO)
157                 priv->wol_irq = priv->dev->irq;
158
159         priv->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
160
161         platform_set_drvdata(pdev, priv->dev);
162
163         pr_debug("STMMAC platform driver registration completed");
164
165         return 0;
166
167 out_unmap:
168         iounmap(addr);
169         platform_set_drvdata(pdev, NULL);
170
171 out_release_region:
172         release_mem_region(res->start, resource_size(res));
173
174         return ret;
175 }
176
177 /**
178  * stmmac_pltfr_remove
179  * @pdev: platform device pointer
180  * Description: this function calls the main to free the net resources
181  * and calls the platforms hook and release the resources (e.g. mem).
182  */
183 static int stmmac_pltfr_remove(struct platform_device *pdev)
184 {
185         struct net_device *ndev = platform_get_drvdata(pdev);
186         struct stmmac_priv *priv = netdev_priv(ndev);
187         struct resource *res;
188         int ret = stmmac_dvr_remove(ndev);
189
190         if (priv->plat->exit)
191                 priv->plat->exit(pdev);
192
193         platform_set_drvdata(pdev, NULL);
194
195         iounmap((void __force __iomem *)priv->ioaddr);
196         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
197         release_mem_region(res->start, resource_size(res));
198
199         return ret;
200 }
201
202 #ifdef CONFIG_PM
203 static int stmmac_pltfr_suspend(struct device *dev)
204 {
205         struct net_device *ndev = dev_get_drvdata(dev);
206
207         return stmmac_suspend(ndev);
208 }
209
210 static int stmmac_pltfr_resume(struct device *dev)
211 {
212         struct net_device *ndev = dev_get_drvdata(dev);
213
214         return stmmac_resume(ndev);
215 }
216
217 int stmmac_pltfr_freeze(struct device *dev)
218 {
219         int ret;
220         struct plat_stmmacenet_data *plat_dat = dev_get_platdata(dev);
221         struct net_device *ndev = dev_get_drvdata(dev);
222         struct platform_device *pdev = to_platform_device(dev);
223
224         ret = stmmac_freeze(ndev);
225         if (plat_dat->exit)
226                 plat_dat->exit(pdev);
227
228         return ret;
229 }
230
231 int stmmac_pltfr_restore(struct device *dev)
232 {
233         struct plat_stmmacenet_data *plat_dat = dev_get_platdata(dev);
234         struct net_device *ndev = dev_get_drvdata(dev);
235         struct platform_device *pdev = to_platform_device(dev);
236
237         if (plat_dat->init)
238                 plat_dat->init(pdev);
239
240         return stmmac_restore(ndev);
241 }
242
243 static const struct dev_pm_ops stmmac_pltfr_pm_ops = {
244         .suspend = stmmac_pltfr_suspend,
245         .resume = stmmac_pltfr_resume,
246         .freeze = stmmac_pltfr_freeze,
247         .thaw = stmmac_pltfr_restore,
248         .restore = stmmac_pltfr_restore,
249 };
250 #else
251 static const struct dev_pm_ops stmmac_pltfr_pm_ops;
252 #endif /* CONFIG_PM */
253
254 static const struct of_device_id stmmac_dt_ids[] = {
255         { .compatible = "st,spear600-gmac", },
256         { /* sentinel */ }
257 };
258 MODULE_DEVICE_TABLE(of, stmmac_dt_ids);
259
260 struct platform_driver stmmac_pltfr_driver = {
261         .probe = stmmac_pltfr_probe,
262         .remove = stmmac_pltfr_remove,
263         .driver = {
264                    .name = STMMAC_RESOURCE_NAME,
265                    .owner = THIS_MODULE,
266                    .pm = &stmmac_pltfr_pm_ops,
267                    .of_match_table = of_match_ptr(stmmac_dt_ids),
268                    },
269 };
270
271 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver");
272 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
273 MODULE_LICENSE("GPL");