1 // SPDX-License-Identifier: GPL-2.0+
3 * Micrel KS8851_MLL 16bit Network driver
4 * Copyright (c) 2011 Roberto Cerati <roberto.cerati@bticino.it>
14 #include <linux/delay.h>
16 #include "ks8851_mll.h"
18 #define DRIVERNAME "ks8851_mll"
20 #define RX_BUF_SIZE 2000
23 * struct ks_net - KS8851 driver private data
24 * @dev : legacy non-DM ethernet device structure
25 * @iobase : register base
26 * @bus_width : i/o bus width.
27 * @sharedbus : Multipex(addr and data bus) mode indicator.
28 * @extra_byte : number of extra byte prepended rx pkt.
32 struct eth_device dev;
41 #define BE3 0x8000 /* Byte Enable 3 */
42 #define BE2 0x4000 /* Byte Enable 2 */
43 #define BE1 0x2000 /* Byte Enable 1 */
44 #define BE0 0x1000 /* Byte Enable 0 */
46 static u8 ks_rdreg8(struct ks_net *ks, u16 offset)
48 u8 shift_bit = offset & 0x03;
49 u8 shift_data = (offset & 1) << 3;
51 writew(offset | (BE0 << shift_bit), ks->iobase + 2);
53 return (u8)(readw(ks->iobase) >> shift_data);
56 static u16 ks_rdreg16(struct ks_net *ks, u16 offset)
58 writew(offset | ((BE1 | BE0) << (offset & 0x02)), ks->iobase + 2);
60 return readw(ks->iobase);
63 static void ks_wrreg16(struct ks_net *ks, u16 offset, u16 val)
65 writew(offset | ((BE1 | BE0) << (offset & 0x02)), ks->iobase + 2);
66 writew(val, ks->iobase);
70 * ks_inblk - read a block of data from QMU. This is called after sudo DMA mode
73 * @wptr: buffer address to save data
74 * @len: length in byte to read
76 static inline void ks_inblk(struct ks_net *ks, u16 *wptr, u32 len)
81 *wptr++ = readw(ks->iobase);
85 * ks_outblk - write data to QMU. This is called after sudo DMA mode enabled.
86 * @ks: The chip information
87 * @wptr: buffer address
88 * @len: length in byte to write
90 static inline void ks_outblk(struct ks_net *ks, u16 *wptr, u32 len)
95 writew(*wptr++, ks->iobase);
98 static void ks_enable_int(struct ks_net *ks)
100 ks_wrreg16(ks, KS_IER, IRQ_LCI | IRQ_TXI | IRQ_RXI);
103 static void ks_set_powermode(struct ks_net *ks, unsigned int pwrmode)
107 ks_rdreg16(ks, KS_GRR);
108 pmecr = ks_rdreg16(ks, KS_PMECR);
109 pmecr &= ~PMECR_PM_MASK;
112 ks_wrreg16(ks, KS_PMECR, pmecr);
116 * ks_read_config - read chip configuration of bus width.
117 * @ks: The chip information
119 static void ks_read_config(struct ks_net *ks)
123 /* Regardless of bus width, 8 bit read should always work. */
124 reg_data = ks_rdreg8(ks, KS_CCR) & 0x00FF;
125 reg_data |= ks_rdreg8(ks, KS_CCR + 1) << 8;
127 /* addr/data bus are multiplexed */
128 ks->sharedbus = (reg_data & CCR_SHARED) == CCR_SHARED;
131 * There are garbage data when reading data from QMU,
132 * depending on bus-width.
134 if (reg_data & CCR_8BIT) {
135 ks->bus_width = ENUM_BUS_8BIT;
137 } else if (reg_data & CCR_16BIT) {
138 ks->bus_width = ENUM_BUS_16BIT;
141 ks->bus_width = ENUM_BUS_32BIT;
147 * ks_soft_reset - issue one of the soft reset to the device
148 * @ks: The device state.
149 * @op: The bit(s) to set in the GRR
151 * Issue the relevant soft-reset command to the device's GRR register
154 * Note, the delays are in there as a caution to ensure that the reset
155 * has time to take effect and then complete. Since the datasheet does
156 * not currently specify the exact sequence, we have chosen something
157 * that seems to work with our device.
159 static void ks_soft_reset(struct ks_net *ks, unsigned int op)
161 /* Disable interrupt first */
162 ks_wrreg16(ks, KS_IER, 0x0000);
163 ks_wrreg16(ks, KS_GRR, op);
164 mdelay(10); /* wait a short time to effect reset */
165 ks_wrreg16(ks, KS_GRR, 0);
166 mdelay(1); /* wait for condition to clear */
169 void ks_enable_qmu(struct ks_net *ks)
173 w = ks_rdreg16(ks, KS_TXCR);
175 /* Enables QMU Transmit (TXCR). */
176 ks_wrreg16(ks, KS_TXCR, w | TXCR_TXE);
178 /* Enable RX Frame Count Threshold and Auto-Dequeue RXQ Frame */
179 w = ks_rdreg16(ks, KS_RXQCR);
180 ks_wrreg16(ks, KS_RXQCR, w | RXQCR_RXFCTE);
182 /* Enables QMU Receive (RXCR1). */
183 w = ks_rdreg16(ks, KS_RXCR1);
184 ks_wrreg16(ks, KS_RXCR1, w | RXCR1_RXE);
187 static void ks_disable_qmu(struct ks_net *ks)
191 w = ks_rdreg16(ks, KS_TXCR);
193 /* Disables QMU Transmit (TXCR). */
195 ks_wrreg16(ks, KS_TXCR, w);
197 /* Disables QMU Receive (RXCR1). */
198 w = ks_rdreg16(ks, KS_RXCR1);
200 ks_wrreg16(ks, KS_RXCR1, w);
203 static inline void ks_read_qmu(struct ks_net *ks, u16 *buf, u32 len)
205 u32 r = ks->extra_byte & 0x1;
206 u32 w = ks->extra_byte - r;
208 /* 1. set sudo DMA mode */
209 ks_wrreg16(ks, KS_RXFDPR, RXFDPR_RXFPAI);
210 ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL | RXQCR_SDA);
213 * 2. read prepend data
215 * read 4 + extra bytes and discard them.
216 * extra bytes for dummy, 2 for status, 2 for len
222 ks_inblk(ks, buf, w + 2 + 2);
224 /* 3. read pkt data */
225 ks_inblk(ks, buf, ALIGN(len, 4));
227 /* 4. reset sudo DMA Mode */
228 ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL);
231 static int ks_rcv(struct ks_net *ks, uchar *data)
236 ks->rxfc = ks_rdreg16(ks, KS_RXFCTR) >> 8;
241 /* Checking Received packet status */
242 sts = ks_rdreg16(ks, KS_RXFHSR);
243 /* Get packet len from hardware */
244 len = ks_rdreg16(ks, KS_RXFHBCR);
246 if ((sts & RXFSHR_RXFV) && len && (len < RX_BUF_SIZE)) {
247 /* read data block including CRC 4 bytes */
248 ks_read_qmu(ks, (u16 *)data, len);
253 ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL | RXQCR_RRXEF);
254 printf(DRIVERNAME ": bad packet (sts=0x%04x len=0x%04x)\n", sts, len);
260 * ks_read_selftest - read the selftest memory info.
261 * @ks: The device state
263 * Read and check the TX/RX memory selftest information.
265 static int ks_read_selftest(struct ks_net *ks)
267 u16 both_done = MBIR_TXMBF | MBIR_RXMBF;
271 mbir = ks_rdreg16(ks, KS_MBIR);
273 if ((mbir & both_done) != both_done) {
274 printf(DRIVERNAME ": Memory selftest not finished\n");
278 if (mbir & MBIR_TXMBFA) {
279 printf(DRIVERNAME ": TX memory selftest fails\n");
283 if (mbir & MBIR_RXMBFA) {
284 printf(DRIVERNAME ": RX memory selftest fails\n");
288 debug(DRIVERNAME ": the selftest passes\n");
293 static void ks_setup(struct ks_net *ks)
297 /* Setup Transmit Frame Data Pointer Auto-Increment (TXFDPR) */
298 ks_wrreg16(ks, KS_TXFDPR, TXFDPR_TXFPAI);
300 /* Setup Receive Frame Data Pointer Auto-Increment */
301 ks_wrreg16(ks, KS_RXFDPR, RXFDPR_RXFPAI);
303 /* Setup Receive Frame Threshold - 1 frame (RXFCTFC) */
304 ks_wrreg16(ks, KS_RXFCTR, 1 & RXFCTR_THRESHOLD_MASK);
306 /* Setup RxQ Command Control (RXQCR) */
307 ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL);
310 * set the force mode to half duplex, default is full duplex
311 * because if the auto-negotiation fails, most switch uses
314 w = ks_rdreg16(ks, KS_P1MBCR);
315 w &= ~P1MBCR_FORCE_FDX;
316 ks_wrreg16(ks, KS_P1MBCR, w);
318 w = TXCR_TXFCE | TXCR_TXPE | TXCR_TXCRC | TXCR_TCGIP;
319 ks_wrreg16(ks, KS_TXCR, w);
321 w = RXCR1_RXFCE | RXCR1_RXBE | RXCR1_RXUE | RXCR1_RXME | RXCR1_RXIPFCC;
326 ks_wrreg16(ks, KS_RXCR1, w);
329 static void ks_setup_int(struct ks_net *ks)
331 /* Clear the interrupts status of the hardware. */
332 ks_wrreg16(ks, KS_ISR, 0xffff);
335 static int ks8851_mll_detect_chip(struct ks_net *ks)
341 val = ks_rdreg16(ks, KS_CIDER);
344 /* Special case -- no chip present */
345 printf(DRIVERNAME ": is chip mounted ?\n");
347 } else if ((val & 0xfff0) != CIDER_ID) {
348 printf(DRIVERNAME ": Invalid chip id 0x%04x\n", val);
352 debug("Read back KS8851 id 0x%x\n", val);
354 if ((val & 0xfff0) != CIDER_ID) {
355 printf(DRIVERNAME ": Unknown chip ID %04x\n", val);
362 static void ks8851_mll_reset(struct ks_net *ks)
364 /* wake up powermode to normal mode */
365 ks_set_powermode(ks, PMECR_PM_NORMAL);
366 mdelay(1); /* wait for normal mode to take effect */
368 /* Disable interrupt and reset */
369 ks_soft_reset(ks, GRR_GSR);
371 /* turn off the IRQs and ack any outstanding */
372 ks_wrreg16(ks, KS_IER, 0x0000);
373 ks_wrreg16(ks, KS_ISR, 0xffff);
375 /* shutdown RX/TX QMU */
379 static void ks8851_mll_phy_configure(struct ks_net *ks)
386 /* Probing the phy */
387 data = ks_rdreg16(ks, KS_OBCR);
388 ks_wrreg16(ks, KS_OBCR, data | OBCR_ODS_16MA);
390 debug(DRIVERNAME ": phy initialized\n");
393 static void ks8851_mll_enable(struct ks_net *ks)
395 ks_wrreg16(ks, KS_ISR, 0xffff);
400 static int ks8851_mll_init_common(struct ks_net *ks)
402 if (ks_read_selftest(ks)) {
403 printf(DRIVERNAME ": Selftest failed\n");
407 ks8851_mll_reset(ks);
409 /* Configure the PHY, initialize the link state */
410 ks8851_mll_phy_configure(ks);
414 /* Turn on Tx + Rx */
415 ks8851_mll_enable(ks);
420 static void ks_write_qmu(struct ks_net *ks, u8 *pdata, u16 len)
423 /* start header at txb[0] to align txw entries */
425 txw[1] = cpu_to_le16(len);
427 /* 1. set sudo-DMA mode */
428 ks_wrreg16(ks, KS_TXFDPR, TXFDPR_TXFPAI);
429 ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL | RXQCR_SDA);
430 /* 2. write status/length info */
431 ks_outblk(ks, txw, 4);
432 /* 3. write pkt data */
433 ks_outblk(ks, (u16 *)pdata, ALIGN(len, 4));
434 /* 4. reset sudo-DMA mode */
435 ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL);
436 /* 5. Enqueue Tx(move the pkt from TX buffer into TXQ) */
437 ks_wrreg16(ks, KS_TXQCR, TXQCR_METFE);
438 /* 6. wait until TXQCR_METFE is auto-cleared */
439 do { } while (ks_rdreg16(ks, KS_TXQCR) & TXQCR_METFE);
442 static int ks8851_mll_send_common(struct ks_net *ks, void *packet, int length)
444 u8 *data = (u8 *)packet;
445 u16 tmplen = (u16)length;
449 * Extra space are required:
450 * 4 byte for alignment, 4 for status/length, 4 for CRC
452 retv = ks_rdreg16(ks, KS_TXMIR) & 0x1fff;
453 if (retv >= tmplen + 12) {
454 ks_write_qmu(ks, data, tmplen);
458 printf(DRIVERNAME ": failed to send packet: No buffer\n");
462 static void ks8851_mll_halt_common(struct ks_net *ks)
464 ks8851_mll_reset(ks);
468 * Maximum receive ring size; that is, the number of packets
469 * we can buffer before overflow happens. Basically, this just
470 * needs to be enough to prevent a packet being discarded while
471 * we are processing the previous one.
473 static int ks8851_mll_recv_common(struct ks_net *ks, uchar *data)
478 status = ks_rdreg16(ks, KS_ISR);
480 ks_wrreg16(ks, KS_ISR, status);
482 if (ks->rxfc || (status & IRQ_RXI))
483 ret = ks_rcv(ks, data);
485 if (status & IRQ_LDI) {
486 u16 pmecr = ks_rdreg16(ks, KS_PMECR);
488 pmecr &= ~PMECR_WKEVT_MASK;
489 ks_wrreg16(ks, KS_PMECR, pmecr | PMECR_WKEVT_LINK);
495 static void ks8851_mll_write_hwaddr_common(struct ks_net *ks, u8 enetaddr[6])
497 u16 addrl, addrm, addrh;
499 addrh = (enetaddr[0] << 8) | enetaddr[1];
500 addrm = (enetaddr[2] << 8) | enetaddr[3];
501 addrl = (enetaddr[4] << 8) | enetaddr[5];
503 ks_wrreg16(ks, KS_MARH, addrh);
504 ks_wrreg16(ks, KS_MARM, addrm);
505 ks_wrreg16(ks, KS_MARL, addrl);
508 #ifndef CONFIG_DM_ETH
509 static int ks8851_mll_init(struct eth_device *dev, struct bd_info *bd)
511 struct ks_net *ks = container_of(dev, struct ks_net, dev);
513 return ks8851_mll_init_common(ks);
516 static void ks8851_mll_halt(struct eth_device *dev)
518 struct ks_net *ks = container_of(dev, struct ks_net, dev);
520 ks8851_mll_halt_common(ks);
523 static int ks8851_mll_send(struct eth_device *dev, void *packet, int length)
525 struct ks_net *ks = container_of(dev, struct ks_net, dev);
527 return ks8851_mll_send_common(ks, packet, length);
530 static int ks8851_mll_recv(struct eth_device *dev)
532 struct ks_net *ks = container_of(dev, struct ks_net, dev);
535 ret = ks8851_mll_recv_common(ks, net_rx_packets[0]);
537 net_process_received_packet(net_rx_packets[0], ret);
542 static int ks8851_mll_write_hwaddr(struct eth_device *dev)
544 struct ks_net *ks = container_of(dev, struct ks_net, dev);
546 ks8851_mll_write_hwaddr_common(ks, ks->dev.enetaddr);
551 int ks8851_mll_initialize(u8 dev_num, int base_addr)
555 ks = calloc(1, sizeof(*ks));
559 ks->iobase = base_addr;
561 /* Try to detect chip. Will fail if not present. */
562 if (ks8851_mll_detect_chip(ks)) {
567 ks->dev.init = ks8851_mll_init;
568 ks->dev.halt = ks8851_mll_halt;
569 ks->dev.send = ks8851_mll_send;
570 ks->dev.recv = ks8851_mll_recv;
571 ks->dev.write_hwaddr = ks8851_mll_write_hwaddr;
572 sprintf(ks->dev.name, "%s-%hu", DRIVERNAME, dev_num);
574 eth_register(&ks->dev);
578 #else /* ifdef CONFIG_DM_ETH */
579 static int ks8851_start(struct udevice *dev)
581 struct ks_net *ks = dev_get_priv(dev);
583 return ks8851_mll_init_common(ks);
586 static void ks8851_stop(struct udevice *dev)
588 struct ks_net *ks = dev_get_priv(dev);
590 ks8851_mll_halt_common(ks);
593 static int ks8851_send(struct udevice *dev, void *packet, int length)
595 struct ks_net *ks = dev_get_priv(dev);
598 ret = ks8851_mll_send_common(ks, packet, length);
600 return ret ? 0 : -ETIMEDOUT;
603 static int ks8851_recv(struct udevice *dev, int flags, uchar **packetp)
605 struct ks_net *ks = dev_get_priv(dev);
606 uchar *data = net_rx_packets[0];
609 ret = ks8851_mll_recv_common(ks, data);
611 *packetp = (void *)data;
613 return ret ? ret : -EAGAIN;
616 static int ks8851_write_hwaddr(struct udevice *dev)
618 struct ks_net *ks = dev_get_priv(dev);
619 struct eth_pdata *pdata = dev_get_plat(dev);
621 ks8851_mll_write_hwaddr_common(ks, pdata->enetaddr);
626 static int ks8851_read_rom_hwaddr(struct udevice *dev)
628 struct ks_net *ks = dev_get_priv(dev);
629 struct eth_pdata *pdata = dev_get_plat(dev);
630 u16 addrl, addrm, addrh;
632 /* No EEPROM means no valid MAC address. */
633 if (!(ks_rdreg16(ks, KS_CCR) & CCR_EEPROM))
637 * If the EEPROM contains valid MAC address, it is loaded into
638 * the NIC on power on. Read the MAC out of the NIC registers.
640 addrl = ks_rdreg16(ks, KS_MARL);
641 addrm = ks_rdreg16(ks, KS_MARM);
642 addrh = ks_rdreg16(ks, KS_MARH);
644 pdata->enetaddr[0] = (addrh >> 8) & 0xff;
645 pdata->enetaddr[1] = addrh & 0xff;
646 pdata->enetaddr[2] = (addrm >> 8) & 0xff;
647 pdata->enetaddr[3] = addrm & 0xff;
648 pdata->enetaddr[4] = (addrl >> 8) & 0xff;
649 pdata->enetaddr[5] = addrl & 0xff;
651 return !is_valid_ethaddr(pdata->enetaddr);
654 static int ks8851_bind(struct udevice *dev)
656 return device_set_name(dev, dev->name);
659 static int ks8851_probe(struct udevice *dev)
661 struct ks_net *ks = dev_get_priv(dev);
663 /* Try to detect chip. Will fail if not present. */
664 ks8851_mll_detect_chip(ks);
669 static int ks8851_of_to_plat(struct udevice *dev)
671 struct ks_net *ks = dev_get_priv(dev);
672 struct eth_pdata *pdata = dev_get_plat(dev);
674 pdata->iobase = dev_read_addr(dev);
675 ks->iobase = pdata->iobase;
680 static const struct eth_ops ks8851_ops = {
681 .start = ks8851_start,
685 .write_hwaddr = ks8851_write_hwaddr,
686 .read_rom_hwaddr = ks8851_read_rom_hwaddr,
689 static const struct udevice_id ks8851_ids[] = {
690 { .compatible = "micrel,ks8851-mll" },
694 U_BOOT_DRIVER(ks8851) = {
695 .name = "eth_ks8851",
697 .of_match = ks8851_ids,
699 .of_to_plat = ks8851_of_to_plat,
700 .probe = ks8851_probe,
702 .priv_auto = sizeof(struct ks_net),
703 .plat_auto = sizeof(struct eth_pdata),
704 .flags = DM_FLAG_ALLOC_PRIV_DMA,