1 /*******************************************************************************
2   This contains the functions to handle the pci driver.
3 
4   Copyright (C) 2011-2012  Vayavya Labs Pvt 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: Rayagond Kokatanur <rayagond@vayavyalabs.com>
23   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
24 *******************************************************************************/
25 
26 #include <linux/pci.h>
27 #include <linux/dmi.h>
28 
29 #include "stmmac.h"
30 
31 /*
32  * This struct is used to associate PCI Function of MAC controller on a board,
33  * discovered via DMI, with the address of PHY connected to the MAC. The
34  * negative value of the address means that MAC controller is not connected
35  * with PHY.
36  */
37 struct stmmac_pci_dmi_data {
38 	const char *name;
39 	unsigned int func;
40 	int phy_addr;
41 };
42 
43 struct stmmac_pci_info {
44 	struct pci_dev *pdev;
45 	int (*setup)(struct plat_stmmacenet_data *plat,
46 		     struct stmmac_pci_info *info);
47 	struct stmmac_pci_dmi_data *dmi;
48 };
49 
50 static int stmmac_pci_find_phy_addr(struct stmmac_pci_info *info)
51 {
52 	const char *name = dmi_get_system_info(DMI_BOARD_NAME);
53 	unsigned int func = PCI_FUNC(info->pdev->devfn);
54 	struct stmmac_pci_dmi_data *dmi;
55 
56 	/*
57 	 * Galileo boards with old firmware don't support DMI. We always return
58 	 * 1 here, so at least first found MAC controller would be probed.
59 	 */
60 	if (!name)
61 		return 1;
62 
63 	for (dmi = info->dmi; dmi->name && *dmi->name; dmi++) {
64 		if (!strcmp(dmi->name, name) && dmi->func == func)
65 			return dmi->phy_addr;
66 	}
67 
68 	return -ENODEV;
69 }
70 
71 static void stmmac_default_data(struct plat_stmmacenet_data *plat)
72 {
73 	plat->bus_id = 1;
74 	plat->phy_addr = 0;
75 	plat->interface = PHY_INTERFACE_MODE_GMII;
76 	plat->clk_csr = 2;	/* clk_csr_i = 20-35MHz & MDC = clk_csr_i/16 */
77 	plat->has_gmac = 1;
78 	plat->force_sf_dma_mode = 1;
79 
80 	plat->mdio_bus_data->phy_reset = NULL;
81 	plat->mdio_bus_data->phy_mask = 0;
82 
83 	plat->dma_cfg->pbl = 32;
84 	plat->dma_cfg->pblx8 = true;
85 	/* TODO: AXI */
86 
87 	/* Set default value for multicast hash bins */
88 	plat->multicast_filter_bins = HASH_TABLE_SIZE;
89 
90 	/* Set default value for unicast filter entries */
91 	plat->unicast_filter_entries = 1;
92 
93 	/* Set the maxmtu to a default of JUMBO_LEN */
94 	plat->maxmtu = JUMBO_LEN;
95 }
96 
97 static int quark_default_data(struct plat_stmmacenet_data *plat,
98 			      struct stmmac_pci_info *info)
99 {
100 	struct pci_dev *pdev = info->pdev;
101 	int ret;
102 
103 	/*
104 	 * Refuse to load the driver and register net device if MAC controller
105 	 * does not connect to any PHY interface.
106 	 */
107 	ret = stmmac_pci_find_phy_addr(info);
108 	if (ret < 0)
109 		return ret;
110 
111 	plat->bus_id = PCI_DEVID(pdev->bus->number, pdev->devfn);
112 	plat->phy_addr = ret;
113 	plat->interface = PHY_INTERFACE_MODE_RMII;
114 	plat->clk_csr = 2;
115 	plat->has_gmac = 1;
116 	plat->force_sf_dma_mode = 1;
117 
118 	plat->mdio_bus_data->phy_reset = NULL;
119 	plat->mdio_bus_data->phy_mask = 0;
120 
121 	plat->dma_cfg->pbl = 16;
122 	plat->dma_cfg->pblx8 = true;
123 	plat->dma_cfg->fixed_burst = 1;
124 	/* AXI (TODO) */
125 
126 	/* Set default value for multicast hash bins */
127 	plat->multicast_filter_bins = HASH_TABLE_SIZE;
128 
129 	/* Set default value for unicast filter entries */
130 	plat->unicast_filter_entries = 1;
131 
132 	/* Set the maxmtu to a default of JUMBO_LEN */
133 	plat->maxmtu = JUMBO_LEN;
134 
135 	return 0;
136 }
137 
138 static struct stmmac_pci_dmi_data quark_pci_dmi_data[] = {
139 	{
140 		.name = "Galileo",
141 		.func = 6,
142 		.phy_addr = 1,
143 	},
144 	{
145 		.name = "GalileoGen2",
146 		.func = 6,
147 		.phy_addr = 1,
148 	},
149 	{}
150 };
151 
152 static struct stmmac_pci_info quark_pci_info = {
153 	.setup = quark_default_data,
154 	.dmi = quark_pci_dmi_data,
155 };
156 
157 /**
158  * stmmac_pci_probe
159  *
160  * @pdev: pci device pointer
161  * @id: pointer to table of device id/id's.
162  *
163  * Description: This probing function gets called for all PCI devices which
164  * match the ID table and are not "owned" by other driver yet. This function
165  * gets passed a "struct pci_dev *" for each device whose entry in the ID table
166  * matches the device. The probe functions returns zero when the driver choose
167  * to take "ownership" of the device or an error code(-ve no) otherwise.
168  */
169 static int stmmac_pci_probe(struct pci_dev *pdev,
170 			    const struct pci_device_id *id)
171 {
172 	struct stmmac_pci_info *info = (struct stmmac_pci_info *)id->driver_data;
173 	struct plat_stmmacenet_data *plat;
174 	struct stmmac_resources res;
175 	int i;
176 	int ret;
177 
178 	plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
179 	if (!plat)
180 		return -ENOMEM;
181 
182 	plat->mdio_bus_data = devm_kzalloc(&pdev->dev,
183 					   sizeof(*plat->mdio_bus_data),
184 					   GFP_KERNEL);
185 	if (!plat->mdio_bus_data)
186 		return -ENOMEM;
187 
188 	plat->dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*plat->dma_cfg),
189 				     GFP_KERNEL);
190 	if (!plat->dma_cfg)
191 		return -ENOMEM;
192 
193 	/* Enable pci device */
194 	ret = pcim_enable_device(pdev);
195 	if (ret) {
196 		dev_err(&pdev->dev, "%s: ERROR: failed to enable device\n",
197 			__func__);
198 		return ret;
199 	}
200 
201 	/* Get the base address of device */
202 	for (i = 0; i <= PCI_STD_RESOURCE_END; i++) {
203 		if (pci_resource_len(pdev, i) == 0)
204 			continue;
205 		ret = pcim_iomap_regions(pdev, BIT(i), pci_name(pdev));
206 		if (ret)
207 			return ret;
208 		break;
209 	}
210 
211 	pci_set_master(pdev);
212 
213 	if (info) {
214 		info->pdev = pdev;
215 		if (info->setup) {
216 			ret = info->setup(plat, info);
217 			if (ret)
218 				return ret;
219 		}
220 	} else
221 		stmmac_default_data(plat);
222 
223 	pci_enable_msi(pdev);
224 
225 	memset(&res, 0, sizeof(res));
226 	res.addr = pcim_iomap_table(pdev)[i];
227 	res.wol_irq = pdev->irq;
228 	res.irq = pdev->irq;
229 
230 	return stmmac_dvr_probe(&pdev->dev, plat, &res);
231 }
232 
233 /**
234  * stmmac_pci_remove
235  *
236  * @pdev: platform device pointer
237  * Description: this function calls the main to free the net resources
238  * and releases the PCI resources.
239  */
240 static void stmmac_pci_remove(struct pci_dev *pdev)
241 {
242 	stmmac_dvr_remove(&pdev->dev);
243 }
244 
245 static SIMPLE_DEV_PM_OPS(stmmac_pm_ops, stmmac_suspend, stmmac_resume);
246 
247 #define STMMAC_VENDOR_ID 0x700
248 #define STMMAC_QUARK_ID  0x0937
249 #define STMMAC_DEVICE_ID 0x1108
250 
251 static const struct pci_device_id stmmac_id_table[] = {
252 	{PCI_DEVICE(STMMAC_VENDOR_ID, STMMAC_DEVICE_ID)},
253 	{PCI_DEVICE(PCI_VENDOR_ID_STMICRO, PCI_DEVICE_ID_STMICRO_MAC)},
254 	{PCI_VDEVICE(INTEL, STMMAC_QUARK_ID), (kernel_ulong_t)&quark_pci_info},
255 	{}
256 };
257 
258 MODULE_DEVICE_TABLE(pci, stmmac_id_table);
259 
260 static struct pci_driver stmmac_pci_driver = {
261 	.name = STMMAC_RESOURCE_NAME,
262 	.id_table = stmmac_id_table,
263 	.probe = stmmac_pci_probe,
264 	.remove = stmmac_pci_remove,
265 	.driver         = {
266 		.pm     = &stmmac_pm_ops,
267 	},
268 };
269 
270 module_pci_driver(stmmac_pci_driver);
271 
272 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PCI driver");
273 MODULE_AUTHOR("Rayagond Kokatanur <rayagond.kokatanur@vayavyalabs.com>");
274 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
275 MODULE_LICENSE("GPL");
276