Linux Audio

Check our new training course

Linux BSP development engineering services

Need help to port Linux and bootloaders to your hardware?
Loading...
v6.8
  1/*
  2 * Qualcomm Atheros IPQ806x GMAC glue layer
  3 *
  4 * Copyright (C) 2015 The Linux Foundation
  5 *
  6 * Permission to use, copy, modify, and/or distribute this software for any
  7 * purpose with or without fee is hereby granted, provided that the above
  8 * copyright notice and this permission notice appear in all copies.
  9 *
 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 17 */
 18
 19#include <linux/device.h>
 20#include <linux/platform_device.h>
 21#include <linux/phy.h>
 22#include <linux/regmap.h>
 23#include <linux/clk.h>
 24#include <linux/reset.h>
 25#include <linux/of_net.h>
 26#include <linux/mfd/syscon.h>
 27#include <linux/stmmac.h>
 28#include <linux/of_mdio.h>
 29#include <linux/module.h>
 30#include <linux/sys_soc.h>
 31#include <linux/bitfield.h>
 32
 33#include "stmmac_platform.h"
 34
 35#define NSS_COMMON_CLK_GATE			0x8
 36#define NSS_COMMON_CLK_GATE_PTP_EN(x)		BIT(0x10 + x)
 37#define NSS_COMMON_CLK_GATE_RGMII_RX_EN(x)	BIT(0x9 + (x * 2))
 38#define NSS_COMMON_CLK_GATE_RGMII_TX_EN(x)	BIT(0x8 + (x * 2))
 39#define NSS_COMMON_CLK_GATE_GMII_RX_EN(x)	BIT(0x4 + x)
 40#define NSS_COMMON_CLK_GATE_GMII_TX_EN(x)	BIT(0x0 + x)
 41
 42#define NSS_COMMON_CLK_DIV0			0xC
 43#define NSS_COMMON_CLK_DIV_OFFSET(x)		(x * 8)
 44#define NSS_COMMON_CLK_DIV_MASK			0x7f
 45
 46#define NSS_COMMON_CLK_SRC_CTRL			0x14
 47#define NSS_COMMON_CLK_SRC_CTRL_OFFSET(x)	(x)
 48/* Mode is coded on 1 bit but is different depending on the MAC ID:
 49 * MAC0: QSGMII=0 RGMII=1
 50 * MAC1: QSGMII=0 SGMII=0 RGMII=1
 51 * MAC2 & MAC3: QSGMII=0 SGMII=1
 52 */
 53#define NSS_COMMON_CLK_SRC_CTRL_RGMII(x)	1
 54#define NSS_COMMON_CLK_SRC_CTRL_SGMII(x)	((x >= 2) ? 1 : 0)
 55
 56#define NSS_COMMON_GMAC_CTL(x)			(0x30 + (x * 4))
 57#define NSS_COMMON_GMAC_CTL_CSYS_REQ		BIT(19)
 58#define NSS_COMMON_GMAC_CTL_PHY_IFACE_SEL	BIT(16)
 59#define NSS_COMMON_GMAC_CTL_IFG_LIMIT_OFFSET	8
 60#define NSS_COMMON_GMAC_CTL_IFG_OFFSET		0
 61
 62#define NSS_COMMON_CLK_DIV_RGMII_1000		1
 63#define NSS_COMMON_CLK_DIV_RGMII_100		9
 64#define NSS_COMMON_CLK_DIV_RGMII_10		99
 65#define NSS_COMMON_CLK_DIV_SGMII_1000		0
 66#define NSS_COMMON_CLK_DIV_SGMII_100		4
 67#define NSS_COMMON_CLK_DIV_SGMII_10		49
 68
 69#define QSGMII_PCS_ALL_CH_CTL			0x80
 70#define QSGMII_PCS_CH_SPEED_FORCE		BIT(1)
 71#define QSGMII_PCS_CH_SPEED_10			0x0
 72#define QSGMII_PCS_CH_SPEED_100			BIT(2)
 73#define QSGMII_PCS_CH_SPEED_1000		BIT(3)
 74#define QSGMII_PCS_CH_SPEED_MASK		(QSGMII_PCS_CH_SPEED_FORCE | \
 75						 QSGMII_PCS_CH_SPEED_10 | \
 76						 QSGMII_PCS_CH_SPEED_100 | \
 77						 QSGMII_PCS_CH_SPEED_1000)
 78#define QSGMII_PCS_CH_SPEED_SHIFT(x)		((x) * 4)
 79
 80#define QSGMII_PCS_CAL_LCKDT_CTL		0x120
 81#define QSGMII_PCS_CAL_LCKDT_CTL_RST		BIT(19)
 82
 83/* Only GMAC1/2/3 support SGMII and their CTL register are not contiguous */
 84#define QSGMII_PHY_SGMII_CTL(x)			((x == 1) ? 0x134 : \
 85						 (0x13c + (4 * (x - 2))))
 86#define QSGMII_PHY_CDR_EN			BIT(0)
 87#define QSGMII_PHY_RX_FRONT_EN			BIT(1)
 88#define QSGMII_PHY_RX_SIGNAL_DETECT_EN		BIT(2)
 89#define QSGMII_PHY_TX_DRIVER_EN			BIT(3)
 90#define QSGMII_PHY_QSGMII_EN			BIT(7)
 91#define QSGMII_PHY_DEEMPHASIS_LVL_MASK		GENMASK(11, 10)
 92#define QSGMII_PHY_DEEMPHASIS_LVL(x)		FIELD_PREP(QSGMII_PHY_DEEMPHASIS_LVL_MASK, (x))
 93#define QSGMII_PHY_PHASE_LOOP_GAIN_MASK		GENMASK(14, 12)
 94#define QSGMII_PHY_PHASE_LOOP_GAIN(x)		FIELD_PREP(QSGMII_PHY_PHASE_LOOP_GAIN_MASK, (x))
 95#define QSGMII_PHY_RX_DC_BIAS_MASK		GENMASK(19, 18)
 96#define QSGMII_PHY_RX_DC_BIAS(x)		FIELD_PREP(QSGMII_PHY_RX_DC_BIAS_MASK, (x))
 97#define QSGMII_PHY_RX_INPUT_EQU_MASK		GENMASK(21, 20)
 98#define QSGMII_PHY_RX_INPUT_EQU(x)		FIELD_PREP(QSGMII_PHY_RX_INPUT_EQU_MASK, (x))
 99#define QSGMII_PHY_CDR_PI_SLEW_MASK		GENMASK(23, 22)
100#define QSGMII_PHY_CDR_PI_SLEW(x)		FIELD_PREP(QSGMII_PHY_CDR_PI_SLEW_MASK, (x))
101#define QSGMII_PHY_TX_SLEW_MASK			GENMASK(27, 26)
102#define QSGMII_PHY_TX_SLEW(x)			FIELD_PREP(QSGMII_PHY_TX_SLEW_MASK, (x))
103#define QSGMII_PHY_TX_DRV_AMP_MASK		GENMASK(31, 28)
104#define QSGMII_PHY_TX_DRV_AMP(x)		FIELD_PREP(QSGMII_PHY_TX_DRV_AMP_MASK, (x))
105
106struct ipq806x_gmac {
107	struct platform_device *pdev;
108	struct regmap *nss_common;
109	struct regmap *qsgmii_csr;
110	uint32_t id;
111	struct clk *core_clk;
112	phy_interface_t phy_mode;
113};
114
115static int get_clk_div_sgmii(struct ipq806x_gmac *gmac, unsigned int speed)
116{
117	struct device *dev = &gmac->pdev->dev;
118	int div;
119
120	switch (speed) {
121	case SPEED_1000:
122		div = NSS_COMMON_CLK_DIV_SGMII_1000;
123		break;
124
125	case SPEED_100:
126		div = NSS_COMMON_CLK_DIV_SGMII_100;
127		break;
128
129	case SPEED_10:
130		div = NSS_COMMON_CLK_DIV_SGMII_10;
131		break;
132
133	default:
134		dev_err(dev, "Speed %dMbps not supported in SGMII\n", speed);
135		return -EINVAL;
136	}
137
138	return div;
139}
140
141static int get_clk_div_rgmii(struct ipq806x_gmac *gmac, unsigned int speed)
142{
143	struct device *dev = &gmac->pdev->dev;
144	int div;
145
146	switch (speed) {
147	case SPEED_1000:
148		div = NSS_COMMON_CLK_DIV_RGMII_1000;
149		break;
150
151	case SPEED_100:
152		div = NSS_COMMON_CLK_DIV_RGMII_100;
153		break;
154
155	case SPEED_10:
156		div = NSS_COMMON_CLK_DIV_RGMII_10;
157		break;
158
159	default:
160		dev_err(dev, "Speed %dMbps not supported in RGMII\n", speed);
161		return -EINVAL;
162	}
163
164	return div;
165}
166
167static int ipq806x_gmac_set_speed(struct ipq806x_gmac *gmac, unsigned int speed)
168{
169	uint32_t clk_bits, val;
170	int div;
171
172	switch (gmac->phy_mode) {
173	case PHY_INTERFACE_MODE_RGMII:
174		div = get_clk_div_rgmii(gmac, speed);
175		clk_bits = NSS_COMMON_CLK_GATE_RGMII_RX_EN(gmac->id) |
176			   NSS_COMMON_CLK_GATE_RGMII_TX_EN(gmac->id);
177		break;
178
179	case PHY_INTERFACE_MODE_SGMII:
180		div = get_clk_div_sgmii(gmac, speed);
181		clk_bits = NSS_COMMON_CLK_GATE_GMII_RX_EN(gmac->id) |
182			   NSS_COMMON_CLK_GATE_GMII_TX_EN(gmac->id);
183		break;
184
185	default:
186		dev_err(&gmac->pdev->dev, "Unsupported PHY mode: \"%s\"\n",
187			phy_modes(gmac->phy_mode));
188		return -EINVAL;
189	}
190
191	/* Disable the clocks */
192	regmap_read(gmac->nss_common, NSS_COMMON_CLK_GATE, &val);
193	val &= ~clk_bits;
194	regmap_write(gmac->nss_common, NSS_COMMON_CLK_GATE, val);
195
196	/* Set the divider */
197	regmap_read(gmac->nss_common, NSS_COMMON_CLK_DIV0, &val);
198	val &= ~(NSS_COMMON_CLK_DIV_MASK
199		 << NSS_COMMON_CLK_DIV_OFFSET(gmac->id));
200	val |= div << NSS_COMMON_CLK_DIV_OFFSET(gmac->id);
201	regmap_write(gmac->nss_common, NSS_COMMON_CLK_DIV0, val);
202
203	/* Enable the clock back */
204	regmap_read(gmac->nss_common, NSS_COMMON_CLK_GATE, &val);
205	val |= clk_bits;
206	regmap_write(gmac->nss_common, NSS_COMMON_CLK_GATE, val);
207
208	return 0;
209}
210
211static int ipq806x_gmac_of_parse(struct ipq806x_gmac *gmac)
212{
213	struct device *dev = &gmac->pdev->dev;
214	int ret;
215
216	ret = of_get_phy_mode(dev->of_node, &gmac->phy_mode);
217	if (ret) {
218		dev_err(dev, "missing phy mode property\n");
219		return -EINVAL;
220	}
221
222	if (of_property_read_u32(dev->of_node, "qcom,id", &gmac->id) < 0) {
223		dev_err(dev, "missing qcom id property\n");
224		return -EINVAL;
225	}
226
227	/* The GMACs are called 1 to 4 in the documentation, but to simplify the
228	 * code and keep it consistent with the Linux convention, we'll number
229	 * them from 0 to 3 here.
230	 */
231	if (gmac->id > 3) {
232		dev_err(dev, "invalid gmac id\n");
233		return -EINVAL;
234	}
235
236	gmac->core_clk = devm_clk_get(dev, "stmmaceth");
237	if (IS_ERR(gmac->core_clk)) {
238		dev_err(dev, "missing stmmaceth clk property\n");
239		return PTR_ERR(gmac->core_clk);
240	}
241	clk_set_rate(gmac->core_clk, 266000000);
242
243	/* Setup the register map for the nss common registers */
244	gmac->nss_common = syscon_regmap_lookup_by_phandle(dev->of_node,
245							   "qcom,nss-common");
246	if (IS_ERR(gmac->nss_common)) {
247		dev_err(dev, "missing nss-common node\n");
248		return PTR_ERR(gmac->nss_common);
249	}
250
251	/* Setup the register map for the qsgmii csr registers */
252	gmac->qsgmii_csr = syscon_regmap_lookup_by_phandle(dev->of_node,
253							   "qcom,qsgmii-csr");
254	if (IS_ERR(gmac->qsgmii_csr))
255		dev_err(dev, "missing qsgmii-csr node\n");
256
257	return PTR_ERR_OR_ZERO(gmac->qsgmii_csr);
258}
259
260static void ipq806x_gmac_fix_mac_speed(void *priv, unsigned int speed, unsigned int mode)
261{
262	struct ipq806x_gmac *gmac = priv;
263
264	ipq806x_gmac_set_speed(gmac, speed);
265}
266
267static int
268ipq806x_gmac_configure_qsgmii_pcs_speed(struct ipq806x_gmac *gmac)
269{
270	struct platform_device *pdev = gmac->pdev;
271	struct device *dev = &pdev->dev;
272	struct device_node *dn;
273	int link_speed;
274	int val = 0;
275	int ret;
276
277	/* Some bootloader may apply wrong configuration and cause
278	 * not functioning port. If fixed link is not set,
279	 * reset the force speed bit.
280	 */
281	if (!of_phy_is_fixed_link(pdev->dev.of_node))
282		goto write;
283
284	dn = of_get_child_by_name(pdev->dev.of_node, "fixed-link");
285	ret = of_property_read_u32(dn, "speed", &link_speed);
286	of_node_put(dn);
287	if (ret) {
288		dev_err(dev, "found fixed-link node with no speed");
289		return ret;
290	}
291
292	val = QSGMII_PCS_CH_SPEED_FORCE;
293
294	switch (link_speed) {
295	case SPEED_1000:
296		val |= QSGMII_PCS_CH_SPEED_1000;
297		break;
298	case SPEED_100:
299		val |= QSGMII_PCS_CH_SPEED_100;
300		break;
301	case SPEED_10:
302		val |= QSGMII_PCS_CH_SPEED_10;
303		break;
304	}
305
306write:
307	regmap_update_bits(gmac->qsgmii_csr, QSGMII_PCS_ALL_CH_CTL,
308			   QSGMII_PCS_CH_SPEED_MASK <<
309			   QSGMII_PCS_CH_SPEED_SHIFT(gmac->id),
310			   val <<
311			   QSGMII_PCS_CH_SPEED_SHIFT(gmac->id));
312
313	return 0;
314}
315
316static const struct soc_device_attribute ipq806x_gmac_soc_v1[] = {
317	{
318		.revision = "1.*",
319	},
320	{
321		/* sentinel */
322	}
323};
324
325static int
326ipq806x_gmac_configure_qsgmii_params(struct ipq806x_gmac *gmac)
327{
328	struct platform_device *pdev = gmac->pdev;
329	const struct soc_device_attribute *soc;
330	struct device *dev = &pdev->dev;
331	u32 qsgmii_param;
332
333	switch (gmac->id) {
334	case 1:
335		soc = soc_device_match(ipq806x_gmac_soc_v1);
336
337		if (soc)
338			qsgmii_param = QSGMII_PHY_TX_DRV_AMP(0xc) |
339				       QSGMII_PHY_TX_SLEW(0x2) |
340				       QSGMII_PHY_DEEMPHASIS_LVL(0x2);
341		else
342			qsgmii_param = QSGMII_PHY_TX_DRV_AMP(0xd) |
343				       QSGMII_PHY_TX_SLEW(0x0) |
344				       QSGMII_PHY_DEEMPHASIS_LVL(0x0);
345
346		qsgmii_param |= QSGMII_PHY_RX_DC_BIAS(0x2);
347		break;
348	case 2:
349	case 3:
350		qsgmii_param = QSGMII_PHY_RX_DC_BIAS(0x3) |
351			       QSGMII_PHY_TX_DRV_AMP(0xc);
352		break;
353	default: /* gmac 0 can't be set in SGMII mode */
354		dev_err(dev, "gmac id %d can't be in SGMII mode", gmac->id);
355		return -EINVAL;
356	}
357
358	/* Common params across all gmac id */
359	qsgmii_param |= QSGMII_PHY_CDR_EN |
360			QSGMII_PHY_RX_FRONT_EN |
361			QSGMII_PHY_RX_SIGNAL_DETECT_EN |
362			QSGMII_PHY_TX_DRIVER_EN |
363			QSGMII_PHY_QSGMII_EN |
364			QSGMII_PHY_PHASE_LOOP_GAIN(0x4) |
365			QSGMII_PHY_RX_INPUT_EQU(0x1) |
366			QSGMII_PHY_CDR_PI_SLEW(0x2);
367
368	regmap_write(gmac->qsgmii_csr, QSGMII_PHY_SGMII_CTL(gmac->id),
369		     qsgmii_param);
370
371	return 0;
372}
373
374static int ipq806x_gmac_probe(struct platform_device *pdev)
375{
376	struct plat_stmmacenet_data *plat_dat;
377	struct stmmac_resources stmmac_res;
378	struct device *dev = &pdev->dev;
379	struct ipq806x_gmac *gmac;
380	int val;
381	int err;
382
383	val = stmmac_get_platform_resources(pdev, &stmmac_res);
384	if (val)
385		return val;
386
387	plat_dat = devm_stmmac_probe_config_dt(pdev, stmmac_res.mac);
388	if (IS_ERR(plat_dat))
389		return PTR_ERR(plat_dat);
390
391	gmac = devm_kzalloc(dev, sizeof(*gmac), GFP_KERNEL);
392	if (!gmac)
393		return -ENOMEM;
 
 
394
395	gmac->pdev = pdev;
396
397	err = ipq806x_gmac_of_parse(gmac);
398	if (err) {
399		dev_err(dev, "device tree parsing error\n");
400		return err;
401	}
402
403	regmap_write(gmac->qsgmii_csr, QSGMII_PCS_CAL_LCKDT_CTL,
404		     QSGMII_PCS_CAL_LCKDT_CTL_RST);
405
406	/* Inter frame gap is set to 12 */
407	val = 12 << NSS_COMMON_GMAC_CTL_IFG_OFFSET |
408	      12 << NSS_COMMON_GMAC_CTL_IFG_LIMIT_OFFSET;
409	/* We also initiate an AXI low power exit request */
410	val |= NSS_COMMON_GMAC_CTL_CSYS_REQ;
411	switch (gmac->phy_mode) {
412	case PHY_INTERFACE_MODE_RGMII:
413		val |= NSS_COMMON_GMAC_CTL_PHY_IFACE_SEL;
414		break;
415	case PHY_INTERFACE_MODE_SGMII:
416		val &= ~NSS_COMMON_GMAC_CTL_PHY_IFACE_SEL;
417		break;
418	default:
419		goto err_unsupported_phy;
 
 
 
420	}
421	regmap_write(gmac->nss_common, NSS_COMMON_GMAC_CTL(gmac->id), val);
422
423	/* Configure the clock src according to the mode */
424	regmap_read(gmac->nss_common, NSS_COMMON_CLK_SRC_CTRL, &val);
425	val &= ~(1 << NSS_COMMON_CLK_SRC_CTRL_OFFSET(gmac->id));
426	switch (gmac->phy_mode) {
427	case PHY_INTERFACE_MODE_RGMII:
428		val |= NSS_COMMON_CLK_SRC_CTRL_RGMII(gmac->id) <<
429			NSS_COMMON_CLK_SRC_CTRL_OFFSET(gmac->id);
430		break;
431	case PHY_INTERFACE_MODE_SGMII:
432		val |= NSS_COMMON_CLK_SRC_CTRL_SGMII(gmac->id) <<
433			NSS_COMMON_CLK_SRC_CTRL_OFFSET(gmac->id);
434		break;
435	default:
436		goto err_unsupported_phy;
 
 
 
437	}
438	regmap_write(gmac->nss_common, NSS_COMMON_CLK_SRC_CTRL, val);
439
440	/* Enable PTP clock */
441	regmap_read(gmac->nss_common, NSS_COMMON_CLK_GATE, &val);
442	val |= NSS_COMMON_CLK_GATE_PTP_EN(gmac->id);
443	switch (gmac->phy_mode) {
444	case PHY_INTERFACE_MODE_RGMII:
445		val |= NSS_COMMON_CLK_GATE_RGMII_RX_EN(gmac->id) |
446			NSS_COMMON_CLK_GATE_RGMII_TX_EN(gmac->id);
447		break;
448	case PHY_INTERFACE_MODE_SGMII:
449		val |= NSS_COMMON_CLK_GATE_GMII_RX_EN(gmac->id) |
450				NSS_COMMON_CLK_GATE_GMII_TX_EN(gmac->id);
451		break;
452	default:
453		goto err_unsupported_phy;
454	}
455	regmap_write(gmac->nss_common, NSS_COMMON_CLK_GATE, val);
456
457	if (gmac->phy_mode == PHY_INTERFACE_MODE_SGMII) {
458		err = ipq806x_gmac_configure_qsgmii_params(gmac);
459		if (err)
460			return err;
461
462		err = ipq806x_gmac_configure_qsgmii_pcs_speed(gmac);
463		if (err)
464			return err;
 
 
 
 
465	}
466
467	plat_dat->has_gmac = true;
468	plat_dat->bsp_priv = gmac;
469	plat_dat->fix_mac_speed = ipq806x_gmac_fix_mac_speed;
470	plat_dat->multicast_filter_bins = 0;
471	plat_dat->tx_fifo_size = 8192;
472	plat_dat->rx_fifo_size = 8192;
473
474	return stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
475
476err_unsupported_phy:
477	dev_err(&pdev->dev, "Unsupported PHY mode: \"%s\"\n",
478		phy_modes(gmac->phy_mode));
479	return -EINVAL;
 
480}
481
482static const struct of_device_id ipq806x_gmac_dwmac_match[] = {
483	{ .compatible = "qcom,ipq806x-gmac" },
484	{ }
485};
486MODULE_DEVICE_TABLE(of, ipq806x_gmac_dwmac_match);
487
488static struct platform_driver ipq806x_gmac_dwmac_driver = {
489	.probe = ipq806x_gmac_probe,
490	.remove_new = stmmac_pltfr_remove,
491	.driver = {
492		.name		= "ipq806x-gmac-dwmac",
493		.pm		= &stmmac_pltfr_pm_ops,
494		.of_match_table	= ipq806x_gmac_dwmac_match,
495	},
496};
497module_platform_driver(ipq806x_gmac_dwmac_driver);
498
499MODULE_AUTHOR("Mathieu Olivari <mathieu@codeaurora.org>");
500MODULE_DESCRIPTION("Qualcomm Atheros IPQ806x DWMAC specific glue layer");
501MODULE_LICENSE("Dual BSD/GPL");
v4.17
  1/*
  2 * Qualcomm Atheros IPQ806x GMAC glue layer
  3 *
  4 * Copyright (C) 2015 The Linux Foundation
  5 *
  6 * Permission to use, copy, modify, and/or distribute this software for any
  7 * purpose with or without fee is hereby granted, provided that the above
  8 * copyright notice and this permission notice appear in all copies.
  9 *
 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 17 */
 18
 19#include <linux/device.h>
 20#include <linux/platform_device.h>
 21#include <linux/phy.h>
 22#include <linux/regmap.h>
 23#include <linux/clk.h>
 24#include <linux/reset.h>
 25#include <linux/of_net.h>
 26#include <linux/mfd/syscon.h>
 27#include <linux/stmmac.h>
 28#include <linux/of_mdio.h>
 29#include <linux/module.h>
 
 
 30
 31#include "stmmac_platform.h"
 32
 33#define NSS_COMMON_CLK_GATE			0x8
 34#define NSS_COMMON_CLK_GATE_PTP_EN(x)		BIT(0x10 + x)
 35#define NSS_COMMON_CLK_GATE_RGMII_RX_EN(x)	BIT(0x9 + (x * 2))
 36#define NSS_COMMON_CLK_GATE_RGMII_TX_EN(x)	BIT(0x8 + (x * 2))
 37#define NSS_COMMON_CLK_GATE_GMII_RX_EN(x)	BIT(0x4 + x)
 38#define NSS_COMMON_CLK_GATE_GMII_TX_EN(x)	BIT(0x0 + x)
 39
 40#define NSS_COMMON_CLK_DIV0			0xC
 41#define NSS_COMMON_CLK_DIV_OFFSET(x)		(x * 8)
 42#define NSS_COMMON_CLK_DIV_MASK			0x7f
 43
 44#define NSS_COMMON_CLK_SRC_CTRL			0x14
 45#define NSS_COMMON_CLK_SRC_CTRL_OFFSET(x)	(x)
 46/* Mode is coded on 1 bit but is different depending on the MAC ID:
 47 * MAC0: QSGMII=0 RGMII=1
 48 * MAC1: QSGMII=0 SGMII=0 RGMII=1
 49 * MAC2 & MAC3: QSGMII=0 SGMII=1
 50 */
 51#define NSS_COMMON_CLK_SRC_CTRL_RGMII(x)	1
 52#define NSS_COMMON_CLK_SRC_CTRL_SGMII(x)	((x >= 2) ? 1 : 0)
 53
 54#define NSS_COMMON_GMAC_CTL(x)			(0x30 + (x * 4))
 55#define NSS_COMMON_GMAC_CTL_CSYS_REQ		BIT(19)
 56#define NSS_COMMON_GMAC_CTL_PHY_IFACE_SEL	BIT(16)
 57#define NSS_COMMON_GMAC_CTL_IFG_LIMIT_OFFSET	8
 58#define NSS_COMMON_GMAC_CTL_IFG_OFFSET		0
 59
 60#define NSS_COMMON_CLK_DIV_RGMII_1000		1
 61#define NSS_COMMON_CLK_DIV_RGMII_100		9
 62#define NSS_COMMON_CLK_DIV_RGMII_10		99
 63#define NSS_COMMON_CLK_DIV_SGMII_1000		0
 64#define NSS_COMMON_CLK_DIV_SGMII_100		4
 65#define NSS_COMMON_CLK_DIV_SGMII_10		49
 66
 
 
 
 
 
 
 
 
 
 
 
 67#define QSGMII_PCS_CAL_LCKDT_CTL		0x120
 68#define QSGMII_PCS_CAL_LCKDT_CTL_RST		BIT(19)
 69
 70/* Only GMAC1/2/3 support SGMII and their CTL register are not contiguous */
 71#define QSGMII_PHY_SGMII_CTL(x)			((x == 1) ? 0x134 : \
 72						 (0x13c + (4 * (x - 2))))
 73#define QSGMII_PHY_CDR_EN			BIT(0)
 74#define QSGMII_PHY_RX_FRONT_EN			BIT(1)
 75#define QSGMII_PHY_RX_SIGNAL_DETECT_EN		BIT(2)
 76#define QSGMII_PHY_TX_DRIVER_EN			BIT(3)
 77#define QSGMII_PHY_QSGMII_EN			BIT(7)
 78#define QSGMII_PHY_PHASE_LOOP_GAIN_OFFSET	12
 79#define QSGMII_PHY_RX_DC_BIAS_OFFSET		18
 80#define QSGMII_PHY_RX_INPUT_EQU_OFFSET		20
 81#define QSGMII_PHY_CDR_PI_SLEW_OFFSET		22
 82#define QSGMII_PHY_TX_DRV_AMP_OFFSET		28
 
 
 
 
 
 
 
 
 
 83
 84struct ipq806x_gmac {
 85	struct platform_device *pdev;
 86	struct regmap *nss_common;
 87	struct regmap *qsgmii_csr;
 88	uint32_t id;
 89	struct clk *core_clk;
 90	phy_interface_t phy_mode;
 91};
 92
 93static int get_clk_div_sgmii(struct ipq806x_gmac *gmac, unsigned int speed)
 94{
 95	struct device *dev = &gmac->pdev->dev;
 96	int div;
 97
 98	switch (speed) {
 99	case SPEED_1000:
100		div = NSS_COMMON_CLK_DIV_SGMII_1000;
101		break;
102
103	case SPEED_100:
104		div = NSS_COMMON_CLK_DIV_SGMII_100;
105		break;
106
107	case SPEED_10:
108		div = NSS_COMMON_CLK_DIV_SGMII_10;
109		break;
110
111	default:
112		dev_err(dev, "Speed %dMbps not supported in SGMII\n", speed);
113		return -EINVAL;
114	}
115
116	return div;
117}
118
119static int get_clk_div_rgmii(struct ipq806x_gmac *gmac, unsigned int speed)
120{
121	struct device *dev = &gmac->pdev->dev;
122	int div;
123
124	switch (speed) {
125	case SPEED_1000:
126		div = NSS_COMMON_CLK_DIV_RGMII_1000;
127		break;
128
129	case SPEED_100:
130		div = NSS_COMMON_CLK_DIV_RGMII_100;
131		break;
132
133	case SPEED_10:
134		div = NSS_COMMON_CLK_DIV_RGMII_10;
135		break;
136
137	default:
138		dev_err(dev, "Speed %dMbps not supported in RGMII\n", speed);
139		return -EINVAL;
140	}
141
142	return div;
143}
144
145static int ipq806x_gmac_set_speed(struct ipq806x_gmac *gmac, unsigned int speed)
146{
147	uint32_t clk_bits, val;
148	int div;
149
150	switch (gmac->phy_mode) {
151	case PHY_INTERFACE_MODE_RGMII:
152		div = get_clk_div_rgmii(gmac, speed);
153		clk_bits = NSS_COMMON_CLK_GATE_RGMII_RX_EN(gmac->id) |
154			   NSS_COMMON_CLK_GATE_RGMII_TX_EN(gmac->id);
155		break;
156
157	case PHY_INTERFACE_MODE_SGMII:
158		div = get_clk_div_sgmii(gmac, speed);
159		clk_bits = NSS_COMMON_CLK_GATE_GMII_RX_EN(gmac->id) |
160			   NSS_COMMON_CLK_GATE_GMII_TX_EN(gmac->id);
161		break;
162
163	default:
164		dev_err(&gmac->pdev->dev, "Unsupported PHY mode: \"%s\"\n",
165			phy_modes(gmac->phy_mode));
166		return -EINVAL;
167	}
168
169	/* Disable the clocks */
170	regmap_read(gmac->nss_common, NSS_COMMON_CLK_GATE, &val);
171	val &= ~clk_bits;
172	regmap_write(gmac->nss_common, NSS_COMMON_CLK_GATE, val);
173
174	/* Set the divider */
175	regmap_read(gmac->nss_common, NSS_COMMON_CLK_DIV0, &val);
176	val &= ~(NSS_COMMON_CLK_DIV_MASK
177		 << NSS_COMMON_CLK_DIV_OFFSET(gmac->id));
178	val |= div << NSS_COMMON_CLK_DIV_OFFSET(gmac->id);
179	regmap_write(gmac->nss_common, NSS_COMMON_CLK_DIV0, val);
180
181	/* Enable the clock back */
182	regmap_read(gmac->nss_common, NSS_COMMON_CLK_GATE, &val);
183	val |= clk_bits;
184	regmap_write(gmac->nss_common, NSS_COMMON_CLK_GATE, val);
185
186	return 0;
187}
188
189static int ipq806x_gmac_of_parse(struct ipq806x_gmac *gmac)
190{
191	struct device *dev = &gmac->pdev->dev;
 
192
193	gmac->phy_mode = of_get_phy_mode(dev->of_node);
194	if (gmac->phy_mode < 0) {
195		dev_err(dev, "missing phy mode property\n");
196		return -EINVAL;
197	}
198
199	if (of_property_read_u32(dev->of_node, "qcom,id", &gmac->id) < 0) {
200		dev_err(dev, "missing qcom id property\n");
201		return -EINVAL;
202	}
203
204	/* The GMACs are called 1 to 4 in the documentation, but to simplify the
205	 * code and keep it consistent with the Linux convention, we'll number
206	 * them from 0 to 3 here.
207	 */
208	if (gmac->id > 3) {
209		dev_err(dev, "invalid gmac id\n");
210		return -EINVAL;
211	}
212
213	gmac->core_clk = devm_clk_get(dev, "stmmaceth");
214	if (IS_ERR(gmac->core_clk)) {
215		dev_err(dev, "missing stmmaceth clk property\n");
216		return PTR_ERR(gmac->core_clk);
217	}
218	clk_set_rate(gmac->core_clk, 266000000);
219
220	/* Setup the register map for the nss common registers */
221	gmac->nss_common = syscon_regmap_lookup_by_phandle(dev->of_node,
222							   "qcom,nss-common");
223	if (IS_ERR(gmac->nss_common)) {
224		dev_err(dev, "missing nss-common node\n");
225		return PTR_ERR(gmac->nss_common);
226	}
227
228	/* Setup the register map for the qsgmii csr registers */
229	gmac->qsgmii_csr = syscon_regmap_lookup_by_phandle(dev->of_node,
230							   "qcom,qsgmii-csr");
231	if (IS_ERR(gmac->qsgmii_csr))
232		dev_err(dev, "missing qsgmii-csr node\n");
233
234	return PTR_ERR_OR_ZERO(gmac->qsgmii_csr);
235}
236
237static void ipq806x_gmac_fix_mac_speed(void *priv, unsigned int speed)
238{
239	struct ipq806x_gmac *gmac = priv;
240
241	ipq806x_gmac_set_speed(gmac, speed);
242}
243
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
244static int ipq806x_gmac_probe(struct platform_device *pdev)
245{
246	struct plat_stmmacenet_data *plat_dat;
247	struct stmmac_resources stmmac_res;
248	struct device *dev = &pdev->dev;
249	struct ipq806x_gmac *gmac;
250	int val;
251	int err;
252
253	val = stmmac_get_platform_resources(pdev, &stmmac_res);
254	if (val)
255		return val;
256
257	plat_dat = stmmac_probe_config_dt(pdev, &stmmac_res.mac);
258	if (IS_ERR(plat_dat))
259		return PTR_ERR(plat_dat);
260
261	gmac = devm_kzalloc(dev, sizeof(*gmac), GFP_KERNEL);
262	if (!gmac) {
263		err = -ENOMEM;
264		goto err_remove_config_dt;
265	}
266
267	gmac->pdev = pdev;
268
269	err = ipq806x_gmac_of_parse(gmac);
270	if (err) {
271		dev_err(dev, "device tree parsing error\n");
272		goto err_remove_config_dt;
273	}
274
275	regmap_write(gmac->qsgmii_csr, QSGMII_PCS_CAL_LCKDT_CTL,
276		     QSGMII_PCS_CAL_LCKDT_CTL_RST);
277
278	/* Inter frame gap is set to 12 */
279	val = 12 << NSS_COMMON_GMAC_CTL_IFG_OFFSET |
280	      12 << NSS_COMMON_GMAC_CTL_IFG_LIMIT_OFFSET;
281	/* We also initiate an AXI low power exit request */
282	val |= NSS_COMMON_GMAC_CTL_CSYS_REQ;
283	switch (gmac->phy_mode) {
284	case PHY_INTERFACE_MODE_RGMII:
285		val |= NSS_COMMON_GMAC_CTL_PHY_IFACE_SEL;
286		break;
287	case PHY_INTERFACE_MODE_SGMII:
288		val &= ~NSS_COMMON_GMAC_CTL_PHY_IFACE_SEL;
289		break;
290	default:
291		dev_err(&pdev->dev, "Unsupported PHY mode: \"%s\"\n",
292			phy_modes(gmac->phy_mode));
293		err = -EINVAL;
294		goto err_remove_config_dt;
295	}
296	regmap_write(gmac->nss_common, NSS_COMMON_GMAC_CTL(gmac->id), val);
297
298	/* Configure the clock src according to the mode */
299	regmap_read(gmac->nss_common, NSS_COMMON_CLK_SRC_CTRL, &val);
300	val &= ~(1 << NSS_COMMON_CLK_SRC_CTRL_OFFSET(gmac->id));
301	switch (gmac->phy_mode) {
302	case PHY_INTERFACE_MODE_RGMII:
303		val |= NSS_COMMON_CLK_SRC_CTRL_RGMII(gmac->id) <<
304			NSS_COMMON_CLK_SRC_CTRL_OFFSET(gmac->id);
305		break;
306	case PHY_INTERFACE_MODE_SGMII:
307		val |= NSS_COMMON_CLK_SRC_CTRL_SGMII(gmac->id) <<
308			NSS_COMMON_CLK_SRC_CTRL_OFFSET(gmac->id);
309		break;
310	default:
311		dev_err(&pdev->dev, "Unsupported PHY mode: \"%s\"\n",
312			phy_modes(gmac->phy_mode));
313		err = -EINVAL;
314		goto err_remove_config_dt;
315	}
316	regmap_write(gmac->nss_common, NSS_COMMON_CLK_SRC_CTRL, val);
317
318	/* Enable PTP clock */
319	regmap_read(gmac->nss_common, NSS_COMMON_CLK_GATE, &val);
320	val |= NSS_COMMON_CLK_GATE_PTP_EN(gmac->id);
 
 
 
 
 
 
 
 
 
 
 
 
321	regmap_write(gmac->nss_common, NSS_COMMON_CLK_GATE, val);
322
323	if (gmac->phy_mode == PHY_INTERFACE_MODE_SGMII) {
324		regmap_write(gmac->qsgmii_csr, QSGMII_PHY_SGMII_CTL(gmac->id),
325			     QSGMII_PHY_CDR_EN |
326			     QSGMII_PHY_RX_FRONT_EN |
327			     QSGMII_PHY_RX_SIGNAL_DETECT_EN |
328			     QSGMII_PHY_TX_DRIVER_EN |
329			     QSGMII_PHY_QSGMII_EN |
330			     0x4ul << QSGMII_PHY_PHASE_LOOP_GAIN_OFFSET |
331			     0x3ul << QSGMII_PHY_RX_DC_BIAS_OFFSET |
332			     0x1ul << QSGMII_PHY_RX_INPUT_EQU_OFFSET |
333			     0x2ul << QSGMII_PHY_CDR_PI_SLEW_OFFSET |
334			     0xCul << QSGMII_PHY_TX_DRV_AMP_OFFSET);
335	}
336
337	plat_dat->has_gmac = true;
338	plat_dat->bsp_priv = gmac;
339	plat_dat->fix_mac_speed = ipq806x_gmac_fix_mac_speed;
340
341	err = stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
342	if (err)
343		goto err_remove_config_dt;
344
345	return 0;
346
347err_remove_config_dt:
348	stmmac_remove_config_dt(pdev, plat_dat);
349
350	return err;
351}
352
353static const struct of_device_id ipq806x_gmac_dwmac_match[] = {
354	{ .compatible = "qcom,ipq806x-gmac" },
355	{ }
356};
357MODULE_DEVICE_TABLE(of, ipq806x_gmac_dwmac_match);
358
359static struct platform_driver ipq806x_gmac_dwmac_driver = {
360	.probe = ipq806x_gmac_probe,
361	.remove = stmmac_pltfr_remove,
362	.driver = {
363		.name		= "ipq806x-gmac-dwmac",
364		.pm		= &stmmac_pltfr_pm_ops,
365		.of_match_table	= ipq806x_gmac_dwmac_match,
366	},
367};
368module_platform_driver(ipq806x_gmac_dwmac_driver);
369
370MODULE_AUTHOR("Mathieu Olivari <mathieu@codeaurora.org>");
371MODULE_DESCRIPTION("Qualcomm Atheros IPQ806x DWMAC specific glue layer");
372MODULE_LICENSE("Dual BSD/GPL");