2 * Altera 10/100/1000 triple speed ethernet mac driver
4 * Copyright (C) 2008 Altera Corporation.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
14 #include <fdt_support.h>
19 #include <asm/cache.h>
20 #include <asm/global_data.h>
21 #include <linux/dma-mapping.h>
23 #include "altera_tse.h"
25 DECLARE_GLOBAL_DATA_PTR;
27 static inline void alt_sgdma_construct_descriptor(
28 struct alt_sgdma_descriptor *desc,
29 struct alt_sgdma_descriptor *next,
35 int write_fixed_or_sop)
40 * Mark the "next" descriptor as "not" owned by hardware. This prevents
41 * The SGDMA controller from continuing to process the chain.
43 next->descriptor_control = next->descriptor_control &
44 ~ALT_SGDMA_DESCRIPTOR_CONTROL_OWNED_BY_HW_MSK;
46 memset(desc, 0, sizeof(struct alt_sgdma_descriptor));
47 desc->source = virt_to_phys(read_addr);
48 desc->destination = virt_to_phys(write_addr);
49 desc->next = virt_to_phys(next);
50 desc->bytes_to_transfer = length_or_eop;
53 * Set the descriptor control block as follows:
54 * - Set "owned by hardware" bit
55 * - Optionally set "generate EOP" bit
56 * - Optionally set the "read from fixed address" bit
57 * - Optionally set the "write to fixed address bit (which serves
58 * serves as a "generate SOP" control bit in memory-to-stream mode).
59 * - Set the 4-bit atlantic channel, if specified
61 * Note this step is performed after all other descriptor information
62 * has been filled out so that, if the controller already happens to be
63 * pointing at this descriptor, it will not run (via the "owned by
64 * hardware" bit) until all other descriptor has been set up.
66 val = ALT_SGDMA_DESCRIPTOR_CONTROL_OWNED_BY_HW_MSK;
68 val |= ALT_SGDMA_DESCRIPTOR_CONTROL_GENERATE_EOP_MSK;
70 val |= ALT_SGDMA_DESCRIPTOR_CONTROL_READ_FIXED_ADDRESS_MSK;
71 if (write_fixed_or_sop)
72 val |= ALT_SGDMA_DESCRIPTOR_CONTROL_WRITE_FIXED_ADDRESS_MSK;
73 desc->descriptor_control = val;
76 static int alt_sgdma_wait_transfer(struct alt_sgdma_registers *regs)
81 /* Wait for the descriptor (chain) to complete */
84 status = readl(®s->status);
85 if (!(status & ALT_SGDMA_STATUS_BUSY_MSK))
87 if (get_timer(ctime) > ALT_TSE_SGDMA_BUSY_TIMEOUT) {
89 debug("sgdma timeout\n");
95 writel(0, ®s->control);
97 writel(0xff, ®s->status);
102 static int alt_sgdma_start_transfer(struct alt_sgdma_registers *regs,
103 struct alt_sgdma_descriptor *desc)
107 /* Point the controller at the descriptor */
108 writel(virt_to_phys(desc), ®s->next_descriptor_pointer);
111 * Set up SGDMA controller to:
112 * - Disable interrupt generation
113 * - Run once a valid descriptor is written to controller
114 * - Stop on an error with any particular descriptor
116 val = ALT_SGDMA_CONTROL_RUN_MSK | ALT_SGDMA_CONTROL_STOP_DMA_ER_MSK;
117 writel(val, ®s->control);
122 static void tse_adjust_link(struct altera_tse_priv *priv,
123 struct phy_device *phydev)
125 struct alt_tse_mac *mac_dev = priv->mac_dev;
129 debug("%s: No link.\n", phydev->dev->name);
133 refvar = readl(&mac_dev->command_config);
136 refvar |= ALTERA_TSE_CMD_HD_ENA_MSK;
138 refvar &= ~ALTERA_TSE_CMD_HD_ENA_MSK;
140 switch (phydev->speed) {
142 refvar |= ALTERA_TSE_CMD_ETH_SPEED_MSK;
143 refvar &= ~ALTERA_TSE_CMD_ENA_10_MSK;
146 refvar &= ~ALTERA_TSE_CMD_ETH_SPEED_MSK;
147 refvar &= ~ALTERA_TSE_CMD_ENA_10_MSK;
150 refvar &= ~ALTERA_TSE_CMD_ETH_SPEED_MSK;
151 refvar |= ALTERA_TSE_CMD_ENA_10_MSK;
154 writel(refvar, &mac_dev->command_config);
157 static int altera_tse_send_sgdma(struct udevice *dev, void *packet, int length)
159 struct altera_tse_priv *priv = dev_get_priv(dev);
160 struct alt_sgdma_descriptor *tx_desc = priv->tx_desc;
162 alt_sgdma_construct_descriptor(
165 packet, /* read addr */
166 NULL, /* write addr */
167 length, /* length or EOP ,will change for each tx */
170 1 /* write fixed or sop */
173 /* send the packet */
174 alt_sgdma_start_transfer(priv->sgdma_tx, tx_desc);
175 alt_sgdma_wait_transfer(priv->sgdma_tx);
176 debug("sent %d bytes\n", tx_desc->actual_bytes_transferred);
178 return tx_desc->actual_bytes_transferred;
181 static int altera_tse_recv_sgdma(struct udevice *dev, int flags,
184 struct altera_tse_priv *priv = dev_get_priv(dev);
185 struct alt_sgdma_descriptor *rx_desc = priv->rx_desc;
188 if (rx_desc->descriptor_status &
189 ALT_SGDMA_DESCRIPTOR_STATUS_TERMINATED_BY_EOP_MSK) {
190 alt_sgdma_wait_transfer(priv->sgdma_rx);
191 packet_length = rx_desc->actual_bytes_transferred;
192 debug("recv %d bytes\n", packet_length);
193 *packetp = priv->rx_buf;
195 return packet_length;
201 static int altera_tse_free_pkt_sgdma(struct udevice *dev, uchar *packet,
204 struct altera_tse_priv *priv = dev_get_priv(dev);
205 struct alt_sgdma_descriptor *rx_desc = priv->rx_desc;
207 alt_sgdma_construct_descriptor(
210 NULL, /* read addr */
211 priv->rx_buf, /* write addr */
212 0, /* length or EOP */
215 0 /* write fixed or sop */
218 /* setup the sgdma */
219 alt_sgdma_start_transfer(priv->sgdma_rx, rx_desc);
220 debug("recv setup\n");
225 static void altera_tse_stop_mac(struct altera_tse_priv *priv)
227 struct alt_tse_mac *mac_dev = priv->mac_dev;
232 writel(ALTERA_TSE_CMD_SW_RESET_MSK, &mac_dev->command_config);
233 ctime = get_timer(0);
235 status = readl(&mac_dev->command_config);
236 if (!(status & ALTERA_TSE_CMD_SW_RESET_MSK))
238 if (get_timer(ctime) > ALT_TSE_SW_RESET_TIMEOUT) {
239 debug("Reset mac timeout\n");
245 static void altera_tse_stop_sgdma(struct udevice *dev)
247 struct altera_tse_priv *priv = dev_get_priv(dev);
248 struct alt_sgdma_registers *rx_sgdma = priv->sgdma_rx;
249 struct alt_sgdma_registers *tx_sgdma = priv->sgdma_tx;
250 struct alt_sgdma_descriptor *rx_desc = priv->rx_desc;
253 /* clear rx desc & wait for sgdma to complete */
254 rx_desc->descriptor_control = 0;
255 writel(0, &rx_sgdma->control);
256 ret = alt_sgdma_wait_transfer(rx_sgdma);
257 if (ret == -ETIMEDOUT)
258 writel(ALT_SGDMA_CONTROL_SOFTWARERESET_MSK,
261 writel(0, &tx_sgdma->control);
262 ret = alt_sgdma_wait_transfer(tx_sgdma);
263 if (ret == -ETIMEDOUT)
264 writel(ALT_SGDMA_CONTROL_SOFTWARERESET_MSK,
268 static void msgdma_reset(struct msgdma_csr *csr)
274 writel(MSGDMA_CSR_STAT_MASK, &csr->status);
275 writel(MSGDMA_CSR_CTL_RESET, &csr->control);
276 ctime = get_timer(0);
278 status = readl(&csr->status);
279 if (!(status & MSGDMA_CSR_STAT_RESETTING))
281 if (get_timer(ctime) > ALT_TSE_SW_RESET_TIMEOUT) {
282 debug("Reset msgdma timeout\n");
287 writel(MSGDMA_CSR_STAT_MASK, &csr->status);
290 static u32 msgdma_wait(struct msgdma_csr *csr)
295 /* Wait for the descriptor to complete */
296 ctime = get_timer(0);
298 status = readl(&csr->status);
299 if (!(status & MSGDMA_CSR_STAT_BUSY))
301 if (get_timer(ctime) > ALT_TSE_SGDMA_BUSY_TIMEOUT) {
302 debug("sgdma timeout\n");
307 writel(MSGDMA_CSR_STAT_MASK, &csr->status);
312 static int altera_tse_send_msgdma(struct udevice *dev, void *packet,
315 struct altera_tse_priv *priv = dev_get_priv(dev);
316 struct msgdma_extended_desc *desc = priv->tx_desc;
317 u32 tx_buf = virt_to_phys(packet);
320 writel(tx_buf, &desc->read_addr_lo);
321 writel(0, &desc->read_addr_hi);
322 writel(0, &desc->write_addr_lo);
323 writel(0, &desc->write_addr_hi);
324 writel(length, &desc->len);
325 writel(0, &desc->burst_seq_num);
326 writel(MSGDMA_DESC_TX_STRIDE, &desc->stride);
327 writel(MSGDMA_DESC_CTL_TX_SINGLE, &desc->control);
328 status = msgdma_wait(priv->sgdma_tx);
329 debug("sent %d bytes, status %08x\n", length, status);
334 static int altera_tse_recv_msgdma(struct udevice *dev, int flags,
337 struct altera_tse_priv *priv = dev_get_priv(dev);
338 struct msgdma_csr *csr = priv->sgdma_rx;
339 struct msgdma_response *resp = priv->rx_resp;
340 u32 level, length, status;
342 level = readl(&csr->resp_fill_level);
343 if (level & 0xffff) {
344 length = readl(&resp->bytes_transferred);
345 status = readl(&resp->status);
346 debug("recv %d bytes, status %08x\n", length, status);
347 *packetp = priv->rx_buf;
355 static int altera_tse_free_pkt_msgdma(struct udevice *dev, uchar *packet,
358 struct altera_tse_priv *priv = dev_get_priv(dev);
359 struct msgdma_extended_desc *desc = priv->rx_desc;
360 u32 rx_buf = virt_to_phys(priv->rx_buf);
362 writel(0, &desc->read_addr_lo);
363 writel(0, &desc->read_addr_hi);
364 writel(rx_buf, &desc->write_addr_lo);
365 writel(0, &desc->write_addr_hi);
366 writel(PKTSIZE_ALIGN, &desc->len);
367 writel(0, &desc->burst_seq_num);
368 writel(MSGDMA_DESC_RX_STRIDE, &desc->stride);
369 writel(MSGDMA_DESC_CTL_RX_SINGLE, &desc->control);
370 debug("recv setup\n");
375 static void altera_tse_stop_msgdma(struct udevice *dev)
377 struct altera_tse_priv *priv = dev_get_priv(dev);
379 msgdma_reset(priv->sgdma_rx);
380 msgdma_reset(priv->sgdma_tx);
383 static int tse_mdio_read(struct mii_dev *bus, int addr, int devad, int reg)
385 struct altera_tse_priv *priv = bus->priv;
386 struct alt_tse_mac *mac_dev = priv->mac_dev;
389 /* set mdio address */
390 writel(addr, &mac_dev->mdio_phy1_addr);
392 value = readl(&mac_dev->mdio_phy1[reg]);
394 return value & 0xffff;
397 static int tse_mdio_write(struct mii_dev *bus, int addr, int devad, int reg,
400 struct altera_tse_priv *priv = bus->priv;
401 struct alt_tse_mac *mac_dev = priv->mac_dev;
403 /* set mdio address */
404 writel(addr, &mac_dev->mdio_phy1_addr);
406 writel(val, &mac_dev->mdio_phy1[reg]);
411 static int tse_mdio_init(const char *name, struct altera_tse_priv *priv)
413 struct mii_dev *bus = mdio_alloc();
416 printf("Failed to allocate MDIO bus\n");
420 bus->read = tse_mdio_read;
421 bus->write = tse_mdio_write;
422 snprintf(bus->name, sizeof(bus->name), "%s", name);
424 bus->priv = (void *)priv;
426 return mdio_register(bus);
429 static int tse_phy_init(struct altera_tse_priv *priv, void *dev)
431 struct phy_device *phydev;
433 phydev = phy_connect(priv->bus, -1, dev, priv->interface);
437 phydev->supported &= PHY_GBIT_FEATURES;
438 phydev->advertising = phydev->supported;
440 priv->phydev = phydev;
446 static int altera_tse_write_hwaddr(struct udevice *dev)
448 struct altera_tse_priv *priv = dev_get_priv(dev);
449 struct alt_tse_mac *mac_dev = priv->mac_dev;
450 struct eth_pdata *pdata = dev_get_plat(dev);
451 u8 *hwaddr = pdata->enetaddr;
454 mac_lo = (hwaddr[3] << 24) | (hwaddr[2] << 16) |
455 (hwaddr[1] << 8) | hwaddr[0];
456 mac_hi = (hwaddr[5] << 8) | hwaddr[4];
457 debug("Set MAC address to 0x%04x%08x\n", mac_hi, mac_lo);
459 writel(mac_lo, &mac_dev->mac_addr_0);
460 writel(mac_hi, &mac_dev->mac_addr_1);
461 writel(mac_lo, &mac_dev->supp_mac_addr_0_0);
462 writel(mac_hi, &mac_dev->supp_mac_addr_0_1);
463 writel(mac_lo, &mac_dev->supp_mac_addr_1_0);
464 writel(mac_hi, &mac_dev->supp_mac_addr_1_1);
465 writel(mac_lo, &mac_dev->supp_mac_addr_2_0);
466 writel(mac_hi, &mac_dev->supp_mac_addr_2_1);
467 writel(mac_lo, &mac_dev->supp_mac_addr_3_0);
468 writel(mac_hi, &mac_dev->supp_mac_addr_3_1);
473 static int altera_tse_send(struct udevice *dev, void *packet, int length)
475 struct altera_tse_priv *priv = dev_get_priv(dev);
476 unsigned long tx_buf = (unsigned long)packet;
478 flush_dcache_range(tx_buf, tx_buf + length);
480 return priv->ops->send(dev, packet, length);
483 static int altera_tse_recv(struct udevice *dev, int flags, uchar **packetp)
485 struct altera_tse_priv *priv = dev_get_priv(dev);
487 return priv->ops->recv(dev, flags, packetp);
490 static int altera_tse_free_pkt(struct udevice *dev, uchar *packet,
493 struct altera_tse_priv *priv = dev_get_priv(dev);
494 unsigned long rx_buf = (unsigned long)priv->rx_buf;
496 invalidate_dcache_range(rx_buf, rx_buf + PKTSIZE_ALIGN);
498 return priv->ops->free_pkt(dev, packet, length);
501 static void altera_tse_stop(struct udevice *dev)
503 struct altera_tse_priv *priv = dev_get_priv(dev);
505 priv->ops->stop(dev);
506 altera_tse_stop_mac(priv);
509 static int altera_tse_start(struct udevice *dev)
511 struct altera_tse_priv *priv = dev_get_priv(dev);
512 struct alt_tse_mac *mac_dev = priv->mac_dev;
516 /* need to create sgdma */
517 debug("Configuring rx desc\n");
518 altera_tse_free_pkt(dev, priv->rx_buf, PKTSIZE_ALIGN);
520 debug("Configuring TSE Mac\n");
521 /* Initialize MAC registers */
522 writel(PKTSIZE_ALIGN, &mac_dev->max_frame_length);
523 writel(priv->rx_fifo_depth - 16, &mac_dev->rx_sel_empty_threshold);
524 writel(0, &mac_dev->rx_sel_full_threshold);
525 writel(priv->tx_fifo_depth - 16, &mac_dev->tx_sel_empty_threshold);
526 writel(0, &mac_dev->tx_sel_full_threshold);
527 writel(8, &mac_dev->rx_almost_empty_threshold);
528 writel(8, &mac_dev->rx_almost_full_threshold);
529 writel(8, &mac_dev->tx_almost_empty_threshold);
530 writel(3, &mac_dev->tx_almost_full_threshold);
533 writel(0, &mac_dev->rx_cmd_stat);
534 writel(0, &mac_dev->tx_cmd_stat);
537 val = ALTERA_TSE_CMD_TX_ENA_MSK | ALTERA_TSE_CMD_RX_ENA_MSK;
538 writel(val, &mac_dev->command_config);
540 /* Start up the PHY */
541 ret = phy_startup(priv->phydev);
543 debug("Could not initialize PHY %s\n",
544 priv->phydev->dev->name);
548 tse_adjust_link(priv, priv->phydev);
550 if (!priv->phydev->link)
556 static const struct tse_ops tse_sgdma_ops = {
557 .send = altera_tse_send_sgdma,
558 .recv = altera_tse_recv_sgdma,
559 .free_pkt = altera_tse_free_pkt_sgdma,
560 .stop = altera_tse_stop_sgdma,
563 static const struct tse_ops tse_msgdma_ops = {
564 .send = altera_tse_send_msgdma,
565 .recv = altera_tse_recv_msgdma,
566 .free_pkt = altera_tse_free_pkt_msgdma,
567 .stop = altera_tse_stop_msgdma,
570 static int altera_tse_probe(struct udevice *dev)
572 struct eth_pdata *pdata = dev_get_plat(dev);
573 struct altera_tse_priv *priv = dev_get_priv(dev);
574 void *blob = (void *)gd->fdt_blob;
575 int node = dev_of_offset(dev);
576 const char *list, *end;
578 void *base, *desc_mem = NULL;
579 unsigned long addr, size;
580 int parent, addrc, sizec;
584 priv->dma_type = dev_get_driver_data(dev);
585 if (priv->dma_type == ALT_SGDMA)
586 priv->ops = &tse_sgdma_ops;
588 priv->ops = &tse_msgdma_ops;
590 * decode regs. there are multiple reg tuples, and they need to
591 * match with reg-names.
593 parent = fdt_parent_offset(blob, node);
594 fdt_support_default_count_cells(blob, parent, &addrc, &sizec);
595 list = fdt_getprop(blob, node, "reg-names", &len);
599 cell = fdt_getprop(blob, node, "reg", &len);
604 addr = fdt_translate_address((void *)blob,
606 size = fdt_addr_to_cpu(cell[idx + addrc]);
607 base = map_physmem(addr, size, MAP_NOCACHE);
609 if (strcmp(list, "control_port") == 0)
610 priv->mac_dev = base;
611 else if (strcmp(list, "rx_csr") == 0)
612 priv->sgdma_rx = base;
613 else if (strcmp(list, "rx_desc") == 0)
614 priv->rx_desc = base;
615 else if (strcmp(list, "rx_resp") == 0)
616 priv->rx_resp = base;
617 else if (strcmp(list, "tx_csr") == 0)
618 priv->sgdma_tx = base;
619 else if (strcmp(list, "tx_desc") == 0)
620 priv->tx_desc = base;
621 else if (strcmp(list, "s1") == 0)
623 idx += addrc + sizec;
626 /* decode fifo depth */
627 priv->rx_fifo_depth = fdtdec_get_int(blob, node,
629 priv->tx_fifo_depth = fdtdec_get_int(blob, node,
632 addr = fdtdec_get_int(blob, node,
634 addr = fdt_node_offset_by_phandle(blob, addr);
635 priv->phyaddr = fdtdec_get_int(blob, addr,
638 if (priv->dma_type == ALT_SGDMA) {
639 len = sizeof(struct alt_sgdma_descriptor) * 4;
641 desc_mem = dma_alloc_coherent(len, &addr);
645 memset(desc_mem, 0, len);
646 priv->tx_desc = desc_mem;
647 priv->rx_desc = priv->tx_desc +
648 2 * sizeof(struct alt_sgdma_descriptor);
650 /* allocate recv packet buffer */
651 priv->rx_buf = malloc_cache_aligned(PKTSIZE_ALIGN);
655 /* stop controller */
656 debug("Reset TSE & SGDMAs\n");
657 altera_tse_stop(dev);
660 priv->interface = pdata->phy_interface;
661 tse_mdio_init(dev->name, priv);
662 priv->bus = miiphy_get_dev_by_name(dev->name);
664 ret = tse_phy_init(priv, dev);
669 static int altera_tse_of_to_plat(struct udevice *dev)
671 struct eth_pdata *pdata = dev_get_plat(dev);
673 pdata->phy_interface = dev_read_phy_mode(dev);
674 if (pdata->phy_interface == PHY_INTERFACE_MODE_NA)
680 static const struct eth_ops altera_tse_ops = {
681 .start = altera_tse_start,
682 .send = altera_tse_send,
683 .recv = altera_tse_recv,
684 .free_pkt = altera_tse_free_pkt,
685 .stop = altera_tse_stop,
686 .write_hwaddr = altera_tse_write_hwaddr,
689 static const struct udevice_id altera_tse_ids[] = {
690 { .compatible = "altr,tse-msgdma-1.0", .data = ALT_MSGDMA },
691 { .compatible = "altr,tse-1.0", .data = ALT_SGDMA },
695 U_BOOT_DRIVER(altera_tse) = {
696 .name = "altera_tse",
698 .of_match = altera_tse_ids,
699 .ops = &altera_tse_ops,
700 .of_to_plat = altera_tse_of_to_plat,
701 .plat_auto = sizeof(struct eth_pdata),
702 .priv_auto = sizeof(struct altera_tse_priv),
703 .probe = altera_tse_probe,