1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * drivers/net/ethernet/ibm/emac/zmii.c
5 * Driver for PowerPC 4xx on-chip ethernet controller, ZMII bridge support.
7 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
8 * <benh@kernel.crashing.org>
10 * Based on the arch/ppc version of the driver:
12 * Copyright (c) 2004, 2005 Zultys Technologies.
13 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
15 * Based on original work by
16 * Armin Kuster <akuster@mvista.com>
17 * Copyright 2001 MontaVista Softare Inc.
19 #include <linux/slab.h>
20 #include <linux/kernel.h>
21 #include <linux/ethtool.h>
22 #include <linux/of_address.h>
29 #define ZMII_FER_MDI(idx) (0x80000000 >> ((idx) * 4))
30 #define ZMII_FER_MDI_ALL (ZMII_FER_MDI(0) | ZMII_FER_MDI(1) | \
31 ZMII_FER_MDI(2) | ZMII_FER_MDI(3))
33 #define ZMII_FER_SMII(idx) (0x40000000 >> ((idx) * 4))
34 #define ZMII_FER_RMII(idx) (0x20000000 >> ((idx) * 4))
35 #define ZMII_FER_MII(idx) (0x10000000 >> ((idx) * 4))
38 #define ZMII_SSR_SCI(idx) (0x40000000 >> ((idx) * 4))
39 #define ZMII_SSR_FSS(idx) (0x20000000 >> ((idx) * 4))
40 #define ZMII_SSR_SP(idx) (0x10000000 >> ((idx) * 4))
42 /* ZMII only supports MII, RMII and SMII
43 * we also support autodetection for backward compatibility
45 static inline int zmii_valid_mode(int mode)
47 return mode == PHY_INTERFACE_MODE_MII ||
48 mode == PHY_INTERFACE_MODE_RMII ||
49 mode == PHY_INTERFACE_MODE_SMII ||
50 mode == PHY_INTERFACE_MODE_NA;
53 static inline const char *zmii_mode_name(int mode)
56 case PHY_INTERFACE_MODE_MII:
58 case PHY_INTERFACE_MODE_RMII:
60 case PHY_INTERFACE_MODE_SMII:
67 static inline u32 zmii_mode_mask(int mode, int input)
70 case PHY_INTERFACE_MODE_MII:
71 return ZMII_FER_MII(input);
72 case PHY_INTERFACE_MODE_RMII:
73 return ZMII_FER_RMII(input);
74 case PHY_INTERFACE_MODE_SMII:
75 return ZMII_FER_SMII(input);
81 int zmii_attach(struct platform_device *ofdev, int input, int *mode)
83 struct zmii_instance *dev = platform_get_drvdata(ofdev);
84 struct zmii_regs __iomem *p = dev->base;
86 ZMII_DBG(dev, "init(%d, %d)" NL, input, *mode);
88 if (!zmii_valid_mode(*mode)) {
89 /* Probably an EMAC connected to RGMII,
90 * but it still may need ZMII for MDIO so
97 mutex_lock(&dev->lock);
99 /* Autodetect ZMII mode if not specified.
100 * This is only for backward compatibility with the old driver.
101 * Please, always specify PHY mode in your board port to avoid
104 if (dev->mode == PHY_INTERFACE_MODE_NA) {
105 if (*mode == PHY_INTERFACE_MODE_NA) {
106 u32 r = dev->fer_save;
108 ZMII_DBG(dev, "autodetecting mode, FER = 0x%08x" NL, r);
110 if (r & (ZMII_FER_MII(0) | ZMII_FER_MII(1)))
111 dev->mode = PHY_INTERFACE_MODE_MII;
112 else if (r & (ZMII_FER_RMII(0) | ZMII_FER_RMII(1)))
113 dev->mode = PHY_INTERFACE_MODE_RMII;
115 dev->mode = PHY_INTERFACE_MODE_SMII;
119 printk(KERN_NOTICE "%pOF: bridge in %s mode\n",
121 zmii_mode_name(dev->mode));
123 /* All inputs must use the same mode */
124 if (*mode != PHY_INTERFACE_MODE_NA && *mode != dev->mode) {
126 "%pOF: invalid mode %d specified for input %d\n",
127 ofdev->dev.of_node, *mode, input);
128 mutex_unlock(&dev->lock);
133 /* Report back correct PHY mode,
134 * it may be used during PHY initialization.
138 /* Enable this input */
139 out_be32(&p->fer, in_be32(&p->fer) | zmii_mode_mask(dev->mode, input));
142 mutex_unlock(&dev->lock);
147 void zmii_get_mdio(struct platform_device *ofdev, int input)
149 struct zmii_instance *dev = platform_get_drvdata(ofdev);
152 ZMII_DBG2(dev, "get_mdio(%d)" NL, input);
154 mutex_lock(&dev->lock);
156 fer = in_be32(&dev->base->fer) & ~ZMII_FER_MDI_ALL;
157 out_be32(&dev->base->fer, fer | ZMII_FER_MDI(input));
160 void zmii_put_mdio(struct platform_device *ofdev, int input)
162 struct zmii_instance *dev = platform_get_drvdata(ofdev);
164 ZMII_DBG2(dev, "put_mdio(%d)" NL, input);
165 mutex_unlock(&dev->lock);
169 void zmii_set_speed(struct platform_device *ofdev, int input, int speed)
171 struct zmii_instance *dev = platform_get_drvdata(ofdev);
174 mutex_lock(&dev->lock);
176 ssr = in_be32(&dev->base->ssr);
178 ZMII_DBG(dev, "speed(%d, %d)" NL, input, speed);
180 if (speed == SPEED_100)
181 ssr |= ZMII_SSR_SP(input);
183 ssr &= ~ZMII_SSR_SP(input);
185 out_be32(&dev->base->ssr, ssr);
187 mutex_unlock(&dev->lock);
190 void zmii_detach(struct platform_device *ofdev, int input)
192 struct zmii_instance *dev = platform_get_drvdata(ofdev);
194 BUG_ON(!dev || dev->users == 0);
196 mutex_lock(&dev->lock);
198 ZMII_DBG(dev, "detach(%d)" NL, input);
200 /* Disable this input */
201 out_be32(&dev->base->fer,
202 in_be32(&dev->base->fer) & ~zmii_mode_mask(dev->mode, input));
206 mutex_unlock(&dev->lock);
209 int zmii_get_regs_len(struct platform_device *ofdev)
211 return sizeof(struct emac_ethtool_regs_subhdr) +
212 sizeof(struct zmii_regs);
215 void *zmii_dump_regs(struct platform_device *ofdev, void *buf)
217 struct zmii_instance *dev = platform_get_drvdata(ofdev);
218 struct emac_ethtool_regs_subhdr *hdr = buf;
219 struct zmii_regs *regs = (struct zmii_regs *)(hdr + 1);
222 hdr->index = 0; /* for now, are there chips with more than one
223 * zmii ? if yes, then we'll add a cell_index
224 * like we do for emac
226 memcpy_fromio(regs, dev->base, sizeof(struct zmii_regs));
230 static int zmii_probe(struct platform_device *ofdev)
232 struct device_node *np = ofdev->dev.of_node;
233 struct zmii_instance *dev;
234 struct resource regs;
238 dev = kzalloc(sizeof(struct zmii_instance), GFP_KERNEL);
242 mutex_init(&dev->lock);
244 dev->mode = PHY_INTERFACE_MODE_NA;
247 if (of_address_to_resource(np, 0, ®s)) {
248 printk(KERN_ERR "%pOF: Can't get registers address\n", np);
253 dev->base = (struct zmii_regs __iomem *)ioremap(regs.start,
254 sizeof(struct zmii_regs));
255 if (dev->base == NULL) {
256 printk(KERN_ERR "%pOF: Can't map device registers!\n", np);
260 /* We may need FER value for autodetection later */
261 dev->fer_save = in_be32(&dev->base->fer);
263 /* Disable all inputs by default */
264 out_be32(&dev->base->fer, 0);
266 printk(KERN_INFO "ZMII %pOF initialized\n", ofdev->dev.of_node);
268 platform_set_drvdata(ofdev, dev);
278 static int zmii_remove(struct platform_device *ofdev)
280 struct zmii_instance *dev = platform_get_drvdata(ofdev);
282 WARN_ON(dev->users != 0);
290 static const struct of_device_id zmii_match[] =
293 .compatible = "ibm,zmii",
295 /* For backward compat with old DT */
302 static struct platform_driver zmii_driver = {
305 .of_match_table = zmii_match,
308 .remove = zmii_remove,
311 int __init zmii_init(void)
313 return platform_driver_register(&zmii_driver);
318 platform_driver_unregister(&zmii_driver);