2 * Freescale PowerQUICC Ethernet Driver -- MIIM bus implementation
3 * Provides Bus interface for MIIM regs
5 * Author: Andy Fleming <afleming@freescale.com>
6 * Modifier: Sandeep Gopalpet <sandeep.kumar@freescale.com>
8 * Copyright 2002-2004, 2008-2009 Freescale Semiconductor, Inc.
10 * Based on gianfar_mii.c and ucc_geth_mii.c (Li Yang, Kim Phillips)
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version.
19 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/errno.h>
22 #include <linux/slab.h>
23 #include <linux/init.h>
24 #include <linux/delay.h>
25 #include <linux/module.h>
26 #include <linux/mii.h>
27 #include <linux/of_address.h>
28 #include <linux/of_mdio.h>
29 #include <linux/of_device.h>
32 #include <asm/ucc.h> /* for ucc_set_qe_mux_mii_mng() */
36 #define MIIMIND_BUSY 0x00000001
37 #define MIIMIND_NOTVALID 0x00000004
38 #define MIIMCFG_INIT_VALUE 0x00000007
39 #define MIIMCFG_RESET 0x80000000
41 #define MII_READ_COMMAND 0x00000001
44 u32 miimcfg; /* MII management configuration reg */
45 u32 miimcom; /* MII management command reg */
46 u32 miimadd; /* MII management address reg */
47 u32 miimcon; /* MII management control reg */
48 u32 miimstat; /* MII management status reg */
49 u32 miimind; /* MII management indication reg */
54 u32 ieventm; /* MDIO Interrupt event register (for etsec2)*/
55 u32 imaskm; /* MDIO Interrupt mask register (for etsec2)*/
57 u32 emapm; /* MDIO Event mapping register (for etsec2)*/
59 struct fsl_pq_mii mii;
61 u32 utbipar; /* TBI phy address reg (only on UCC) */
65 /* Number of microseconds to wait for an MII register to respond */
66 #define MII_TIMEOUT 1000
68 struct fsl_pq_mdio_priv {
70 struct fsl_pq_mii __iomem *regs;
71 int irqs[PHY_MAX_ADDR];
75 * Per-device-type data. Each type of device tree node that we support gets
78 * @mii_offset: the offset of the MII registers within the memory map of the
79 * node. Some nodes define only the MII registers, and some define the whole
80 * MAC (which includes the MII registers).
82 * @get_tbipa: determines the address of the TBIPA register
84 * @ucc_configure: a special function for extra QE configuration
86 struct fsl_pq_mdio_data {
87 unsigned int mii_offset; /* offset of the MII registers */
88 uint32_t __iomem * (*get_tbipa)(void __iomem *p);
89 void (*ucc_configure)(phys_addr_t start, phys_addr_t end);
93 * Write value to the PHY at mii_id at register regnum, on the bus attached
94 * to the local interface, which may be different from the generic mdio bus
95 * (tied to a single interface), waiting until the write is done before
96 * returning. This is helpful in programming interfaces like the TBI which
97 * control interfaces like onchip SERDES and are always tied to the local
98 * mdio pins, which may not be the same as system mdio bus, used for
99 * controlling the external PHYs, for example.
101 static int fsl_pq_mdio_write(struct mii_bus *bus, int mii_id, int regnum,
104 struct fsl_pq_mdio_priv *priv = bus->priv;
105 struct fsl_pq_mii __iomem *regs = priv->regs;
108 /* Set the PHY address and the register address we want to write */
109 out_be32(®s->miimadd, (mii_id << 8) | regnum);
111 /* Write out the value we want */
112 out_be32(®s->miimcon, value);
114 /* Wait for the transaction to finish */
115 status = spin_event_timeout(!(in_be32(®s->miimind) & MIIMIND_BUSY),
118 return status ? 0 : -ETIMEDOUT;
122 * Read the bus for PHY at addr mii_id, register regnum, and return the value.
123 * Clears miimcom first.
125 * All PHY operation done on the bus attached to the local interface, which
126 * may be different from the generic mdio bus. This is helpful in programming
127 * interfaces like the TBI which, in turn, control interfaces like on-chip
128 * SERDES and are always tied to the local mdio pins, which may not be the
129 * same as system mdio bus, used for controlling the external PHYs, for eg.
131 static int fsl_pq_mdio_read(struct mii_bus *bus, int mii_id, int regnum)
133 struct fsl_pq_mdio_priv *priv = bus->priv;
134 struct fsl_pq_mii __iomem *regs = priv->regs;
138 /* Set the PHY address and the register address we want to read */
139 out_be32(®s->miimadd, (mii_id << 8) | regnum);
141 /* Clear miimcom, and then initiate a read */
142 out_be32(®s->miimcom, 0);
143 out_be32(®s->miimcom, MII_READ_COMMAND);
145 /* Wait for the transaction to finish, normally less than 100us */
146 status = spin_event_timeout(!(in_be32(®s->miimind) &
147 (MIIMIND_NOTVALID | MIIMIND_BUSY)),
152 /* Grab the value of the register from miimstat */
153 value = in_be32(®s->miimstat);
155 dev_dbg(&bus->dev, "read %04x from address %x/%x\n", value, mii_id, regnum);
159 /* Reset the MIIM registers, and wait for the bus to free */
160 static int fsl_pq_mdio_reset(struct mii_bus *bus)
162 struct fsl_pq_mdio_priv *priv = bus->priv;
163 struct fsl_pq_mii __iomem *regs = priv->regs;
166 mutex_lock(&bus->mdio_lock);
168 /* Reset the management interface */
169 out_be32(®s->miimcfg, MIIMCFG_RESET);
171 /* Setup the MII Mgmt clock speed */
172 out_be32(®s->miimcfg, MIIMCFG_INIT_VALUE);
174 /* Wait until the bus is free */
175 status = spin_event_timeout(!(in_be32(®s->miimind) & MIIMIND_BUSY),
178 mutex_unlock(&bus->mdio_lock);
181 dev_err(&bus->dev, "timeout waiting for MII bus\n");
188 #if defined(CONFIG_GIANFAR) || defined(CONFIG_GIANFAR_MODULE)
190 * This is mildly evil, but so is our hardware for doing this.
191 * Also, we have to cast back to struct gfar because of
192 * definition weirdness done in gianfar.h.
194 static uint32_t __iomem *get_gfar_tbipa(void __iomem *p)
196 struct gfar __iomem *enet_regs = p;
198 return &enet_regs->tbipa;
202 * Return the TBIPAR address for an eTSEC2 node
204 static uint32_t __iomem *get_etsec_tbipa(void __iomem *p)
210 #if defined(CONFIG_UCC_GETH) || defined(CONFIG_UCC_GETH_MODULE)
212 * Return the TBIPAR address for a QE MDIO node
214 static uint32_t __iomem *get_ucc_tbipa(void __iomem *p)
216 struct fsl_pq_mdio __iomem *mdio = p;
218 return &mdio->utbipar;
222 * Find the UCC node that controls the given MDIO node
224 * For some reason, the QE MDIO nodes are not children of the UCC devices
225 * that control them. Therefore, we need to scan all UCC nodes looking for
226 * the one that encompases the given MDIO node. We do this by comparing
227 * physical addresses. The 'start' and 'end' addresses of the MDIO node are
228 * passed, and the correct UCC node will cover the entire address range.
230 * This assumes that there is only one QE MDIO node in the entire device tree.
232 static void ucc_configure(phys_addr_t start, phys_addr_t end)
234 static bool found_mii_master;
235 struct device_node *np = NULL;
237 if (found_mii_master)
240 for_each_compatible_node(np, NULL, "ucc_geth") {
242 const uint32_t *iprop;
246 ret = of_address_to_resource(np, 0, &res);
248 pr_debug("fsl-pq-mdio: no address range in node %s\n",
253 /* if our mdio regs fall within this UCC regs range */
254 if ((start < res.start) || (end > res.end))
257 iprop = of_get_property(np, "cell-index", NULL);
259 iprop = of_get_property(np, "device-id", NULL);
261 pr_debug("fsl-pq-mdio: no UCC ID in node %s\n",
267 id = be32_to_cpup(iprop);
270 * cell-index and device-id for QE nodes are
271 * numbered from 1, not 0.
273 if (ucc_set_qe_mux_mii_mng(id - 1) < 0) {
274 pr_debug("fsl-pq-mdio: invalid UCC ID in node %s\n",
279 pr_debug("fsl-pq-mdio: setting node UCC%u to MII master\n", id);
280 found_mii_master = true;
286 static struct of_device_id fsl_pq_mdio_match[] = {
287 #if defined(CONFIG_GIANFAR) || defined(CONFIG_GIANFAR_MODULE)
289 .compatible = "fsl,gianfar-tbi",
290 .data = &(struct fsl_pq_mdio_data) {
292 .get_tbipa = get_gfar_tbipa,
296 .compatible = "fsl,gianfar-mdio",
297 .data = &(struct fsl_pq_mdio_data) {
299 .get_tbipa = get_gfar_tbipa,
304 .compatible = "gianfar",
305 .data = &(struct fsl_pq_mdio_data) {
306 .mii_offset = offsetof(struct fsl_pq_mdio, mii),
307 .get_tbipa = get_gfar_tbipa,
311 .compatible = "fsl,etsec2-tbi",
312 .data = &(struct fsl_pq_mdio_data) {
313 .mii_offset = offsetof(struct fsl_pq_mdio, mii),
314 .get_tbipa = get_etsec_tbipa,
318 .compatible = "fsl,etsec2-mdio",
319 .data = &(struct fsl_pq_mdio_data) {
320 .mii_offset = offsetof(struct fsl_pq_mdio, mii),
321 .get_tbipa = get_etsec_tbipa,
325 #if defined(CONFIG_UCC_GETH) || defined(CONFIG_UCC_GETH_MODULE)
327 .compatible = "fsl,ucc-mdio",
328 .data = &(struct fsl_pq_mdio_data) {
330 .get_tbipa = get_ucc_tbipa,
331 .ucc_configure = ucc_configure,
335 /* Legacy UCC MDIO node */
337 .compatible = "ucc_geth_phy",
338 .data = &(struct fsl_pq_mdio_data) {
340 .get_tbipa = get_ucc_tbipa,
341 .ucc_configure = ucc_configure,
345 /* No Kconfig option for Fman support yet */
347 .compatible = "fsl,fman-mdio",
348 .data = &(struct fsl_pq_mdio_data) {
350 /* Fman TBI operations are handled elsewhere */
356 MODULE_DEVICE_TABLE(of, fsl_pq_mdio_match);
358 static int fsl_pq_mdio_probe(struct platform_device *pdev)
360 const struct of_device_id *id =
361 of_match_device(fsl_pq_mdio_match, &pdev->dev);
362 const struct fsl_pq_mdio_data *data = id->data;
363 struct device_node *np = pdev->dev.of_node;
365 struct device_node *tbi;
366 struct fsl_pq_mdio_priv *priv;
367 struct mii_bus *new_bus;
370 dev_dbg(&pdev->dev, "found %s compatible node\n", id->compatible);
372 new_bus = mdiobus_alloc_size(sizeof(*priv));
376 priv = new_bus->priv;
377 new_bus->name = "Freescale PowerQUICC MII Bus",
378 new_bus->read = &fsl_pq_mdio_read;
379 new_bus->write = &fsl_pq_mdio_write;
380 new_bus->reset = &fsl_pq_mdio_reset;
381 new_bus->irq = priv->irqs;
383 err = of_address_to_resource(np, 0, &res);
385 dev_err(&pdev->dev, "could not obtain address information\n");
389 snprintf(new_bus->id, MII_BUS_ID_SIZE, "%s@%llx", np->name,
390 (unsigned long long)res.start);
392 priv->map = of_iomap(np, 0);
399 * Some device tree nodes represent only the MII registers, and
400 * others represent the MAC and MII registers. The 'mii_offset' field
401 * contains the offset of the MII registers inside the mapped register
404 if (data->mii_offset > resource_size(&res)) {
405 dev_err(&pdev->dev, "invalid register map\n");
409 priv->regs = priv->map + data->mii_offset;
411 new_bus->parent = &pdev->dev;
412 dev_set_drvdata(&pdev->dev, new_bus);
414 if (data->get_tbipa) {
415 for_each_child_of_node(np, tbi) {
416 if (strcmp(tbi->type, "tbi-phy") == 0) {
417 dev_dbg(&pdev->dev, "found TBI PHY node %s\n",
418 strrchr(tbi->full_name, '/') + 1);
424 const u32 *prop = of_get_property(tbi, "reg", NULL);
425 uint32_t __iomem *tbipa;
429 "missing 'reg' property in node %s\n",
435 tbipa = data->get_tbipa(priv->map);
437 out_be32(tbipa, be32_to_cpup(prop));
441 if (data->ucc_configure)
442 data->ucc_configure(res.start, res.end);
444 err = of_mdiobus_register(new_bus, np);
446 dev_err(&pdev->dev, "cannot register %s as MDIO bus\n",
463 static int fsl_pq_mdio_remove(struct platform_device *pdev)
465 struct device *device = &pdev->dev;
466 struct mii_bus *bus = dev_get_drvdata(device);
467 struct fsl_pq_mdio_priv *priv = bus->priv;
469 mdiobus_unregister(bus);
471 dev_set_drvdata(device, NULL);
479 static struct platform_driver fsl_pq_mdio_driver = {
481 .name = "fsl-pq_mdio",
482 .owner = THIS_MODULE,
483 .of_match_table = fsl_pq_mdio_match,
485 .probe = fsl_pq_mdio_probe,
486 .remove = fsl_pq_mdio_remove,
489 module_platform_driver(fsl_pq_mdio_driver);
491 MODULE_LICENSE("GPL");