1 // SPDX-License-Identifier: GPL-2.0+
3 * Micrel KS8851_MLL 16bit Network driver
14 #include <linux/delay.h>
16 #include "ks8851_mll.h"
18 #define DRIVERNAME "ks8851_mll"
20 #define MAX_RECV_FRAMES 32
21 #define MAX_BUF_SIZE 2048
22 #define TX_BUF_SIZE 2000
23 #define RX_BUF_SIZE 2000
25 static const struct chip_id chip_ids[] = {
26 {CIDER_ID, "KSZ8851"},
31 * union ks_tx_hdr - tx header data
32 * @txb: The header as bytes
33 * @txw: The header as 16bit, little-endian words
35 * A dual representation of the tx header data to allow
36 * access to individual bytes, and to allow 16bit accesses
37 * with 16bit alignment.
45 * struct ks_net - KS8851 driver private data
46 * @net_device : The network device we're bound to
47 * @txh : temporaly buffer to save status/length.
48 * @frame_head_info : frame header information for multi-pkt rx.
49 * @statelock : Lock on this structure for tx list.
50 * @msg_enable : The message flags controlling driver output (see ethtool).
51 * @frame_cnt : number of frames received.
52 * @bus_width : i/o bus width.
53 * @irq : irq number assigned to this device.
54 * @rc_rxqcr : Cached copy of KS_RXQCR.
55 * @rc_txcr : Cached copy of KS_TXCR.
56 * @rc_ier : Cached copy of KS_IER.
57 * @sharedbus : Multipex(addr and data bus) mode indicator.
58 * @cmd_reg_cache : command register cached.
59 * @cmd_reg_cache_int : command register cached. Used in the irq handler.
60 * @promiscuous : promiscuous mode indicator.
61 * @all_mcast : mutlicast indicator.
62 * @mcast_lst_size : size of multicast list.
63 * @mcast_lst : multicast list.
64 * @mcast_bits : multicast enabed.
65 * @mac_addr : MAC address assigned to this device.
67 * @extra_byte : number of extra byte prepended rx pkt.
68 * @enabled : indicator this device works.
71 /* Receive multiplex framer header info */
72 struct type_frame_head {
73 u16 sts; /* Frame status */
74 u16 len; /* Byte count */
75 } fr_h_i[MAX_RECV_FRAMES];
78 struct net_device *netdev;
80 struct type_frame_head *frame_head_info;
90 u16 cmd_reg_cache_int;
94 u8 mcast_lst[MAX_MCAST_LST][MAC_ADDR_LEN];
95 u8 mcast_bits[HW_MCAST_SIZE];
102 #define BE3 0x8000 /* Byte Enable 3 */
103 #define BE2 0x4000 /* Byte Enable 2 */
104 #define BE1 0x2000 /* Byte Enable 1 */
105 #define BE0 0x1000 /* Byte Enable 0 */
107 static u8 ks_rdreg8(struct eth_device *dev, u16 offset)
109 u8 shift_bit = offset & 0x03;
110 u8 shift_data = (offset & 1) << 3;
112 writew(offset | (BE0 << shift_bit), dev->iobase + 2);
114 return (u8)(readw(dev->iobase) >> shift_data);
117 static u16 ks_rdreg16(struct eth_device *dev, u16 offset)
119 writew(offset | ((BE1 | BE0) << (offset & 0x02)), dev->iobase + 2);
121 return readw(dev->iobase);
124 static void ks_wrreg8(struct eth_device *dev, u16 offset, u8 val)
126 u8 shift_bit = (offset & 0x03);
127 u16 value_write = (u16)(val << ((offset & 1) << 3));
129 writew(offset | (BE0 << shift_bit), dev->iobase + 2);
130 writew(value_write, dev->iobase);
133 static void ks_wrreg16(struct eth_device *dev, u16 offset, u16 val)
135 writew(offset | ((BE1 | BE0) << (offset & 0x02)), dev->iobase + 2);
136 writew(val, dev->iobase);
140 * ks_inblk - read a block of data from QMU. This is called after sudo DMA mode
142 * @ks: The chip state
143 * @wptr: buffer address to save data
144 * @len: length in byte to read
146 static inline void ks_inblk(struct eth_device *dev, u16 *wptr, u32 len)
151 *wptr++ = readw(dev->iobase);
155 * ks_outblk - write data to QMU. This is called after sudo DMA mode enabled.
156 * @ks: The chip information
157 * @wptr: buffer address
158 * @len: length in byte to write
160 static inline void ks_outblk(struct eth_device *dev, u16 *wptr, u32 len)
165 writew(*wptr++, dev->iobase);
168 static void ks_enable_int(struct eth_device *dev)
170 ks_wrreg16(dev, KS_IER, ks->rc_ier);
173 static void ks_set_powermode(struct eth_device *dev, unsigned pwrmode)
177 ks_rdreg16(dev, KS_GRR);
178 pmecr = ks_rdreg16(dev, KS_PMECR);
179 pmecr &= ~PMECR_PM_MASK;
182 ks_wrreg16(dev, KS_PMECR, pmecr);
186 * ks_read_config - read chip configuration of bus width.
187 * @ks: The chip information
189 static void ks_read_config(struct eth_device *dev)
193 /* Regardless of bus width, 8 bit read should always work. */
194 reg_data = ks_rdreg8(dev, KS_CCR) & 0x00FF;
195 reg_data |= ks_rdreg8(dev, KS_CCR + 1) << 8;
197 /* addr/data bus are multiplexed */
198 ks->sharedbus = (reg_data & CCR_SHARED) == CCR_SHARED;
201 * There are garbage data when reading data from QMU,
202 * depending on bus-width.
204 if (reg_data & CCR_8BIT) {
205 ks->bus_width = ENUM_BUS_8BIT;
207 } else if (reg_data & CCR_16BIT) {
208 ks->bus_width = ENUM_BUS_16BIT;
211 ks->bus_width = ENUM_BUS_32BIT;
217 * ks_soft_reset - issue one of the soft reset to the device
218 * @ks: The device state.
219 * @op: The bit(s) to set in the GRR
221 * Issue the relevant soft-reset command to the device's GRR register
224 * Note, the delays are in there as a caution to ensure that the reset
225 * has time to take effect and then complete. Since the datasheet does
226 * not currently specify the exact sequence, we have chosen something
227 * that seems to work with our device.
229 static void ks_soft_reset(struct eth_device *dev, unsigned op)
231 /* Disable interrupt first */
232 ks_wrreg16(dev, KS_IER, 0x0000);
233 ks_wrreg16(dev, KS_GRR, op);
234 mdelay(10); /* wait a short time to effect reset */
235 ks_wrreg16(dev, KS_GRR, 0);
236 mdelay(1); /* wait for condition to clear */
239 void ks_enable_qmu(struct eth_device *dev)
243 w = ks_rdreg16(dev, KS_TXCR);
245 /* Enables QMU Transmit (TXCR). */
246 ks_wrreg16(dev, KS_TXCR, w | TXCR_TXE);
248 /* Enable RX Frame Count Threshold and Auto-Dequeue RXQ Frame */
249 w = ks_rdreg16(dev, KS_RXQCR);
250 ks_wrreg16(dev, KS_RXQCR, w | RXQCR_RXFCTE);
252 /* Enables QMU Receive (RXCR1). */
253 w = ks_rdreg16(dev, KS_RXCR1);
254 ks_wrreg16(dev, KS_RXCR1, w | RXCR1_RXE);
257 static void ks_disable_qmu(struct eth_device *dev)
261 w = ks_rdreg16(dev, KS_TXCR);
263 /* Disables QMU Transmit (TXCR). */
265 ks_wrreg16(dev, KS_TXCR, w);
267 /* Disables QMU Receive (RXCR1). */
268 w = ks_rdreg16(dev, KS_RXCR1);
270 ks_wrreg16(dev, KS_RXCR1, w);
273 static inline void ks_read_qmu(struct eth_device *dev, u16 *buf, u32 len)
275 u32 r = ks->extra_byte & 0x1;
276 u32 w = ks->extra_byte - r;
278 /* 1. set sudo DMA mode */
279 ks_wrreg16(dev, KS_RXFDPR, RXFDPR_RXFPAI);
280 ks_wrreg8(dev, KS_RXQCR, (ks->rc_rxqcr | RXQCR_SDA) & 0xff);
283 * 2. read prepend data
285 * read 4 + extra bytes and discard them.
286 * extra bytes for dummy, 2 for status, 2 for len
292 ks_inblk(dev, buf, w + 2 + 2);
294 /* 3. read pkt data */
295 ks_inblk(dev, buf, ALIGN(len, 4));
297 /* 4. reset sudo DMA Mode */
298 ks_wrreg8(dev, KS_RXQCR, (ks->rc_rxqcr & ~RXQCR_SDA) & 0xff);
301 static void ks_rcv(struct eth_device *dev, uchar **pv_data)
303 struct type_frame_head *frame_hdr = ks->frame_head_info;
306 ks->frame_cnt = ks_rdreg16(dev, KS_RXFCTR) >> 8;
308 /* read all header information */
309 for (i = 0; i < ks->frame_cnt; i++) {
310 /* Checking Received packet status */
311 frame_hdr->sts = ks_rdreg16(dev, KS_RXFHSR);
312 /* Get packet len from hardware */
313 frame_hdr->len = ks_rdreg16(dev, KS_RXFHBCR);
317 frame_hdr = ks->frame_head_info;
318 while (ks->frame_cnt--) {
319 if ((frame_hdr->sts & RXFSHR_RXFV) &&
320 (frame_hdr->len < RX_BUF_SIZE) &&
322 /* read data block including CRC 4 bytes */
323 ks_read_qmu(dev, (u16 *)(*pv_data), frame_hdr->len);
325 /* net_rx_packets buffer size is ok (*pv_data) */
326 net_process_received_packet(*pv_data, frame_hdr->len);
329 ks_wrreg16(dev, KS_RXQCR, (ks->rc_rxqcr | RXQCR_RRXEF));
330 printf(DRIVERNAME ": bad packet\n");
337 * ks_read_selftest - read the selftest memory info.
338 * @ks: The device state
340 * Read and check the TX/RX memory selftest information.
342 static int ks_read_selftest(struct eth_device *dev)
344 u16 both_done = MBIR_TXMBF | MBIR_RXMBF;
348 mbir = ks_rdreg16(dev, KS_MBIR);
350 if ((mbir & both_done) != both_done) {
351 printf(DRIVERNAME ": Memory selftest not finished\n");
355 if (mbir & MBIR_TXMBFA) {
356 printf(DRIVERNAME ": TX memory selftest fails\n");
360 if (mbir & MBIR_RXMBFA) {
361 printf(DRIVERNAME ": RX memory selftest fails\n");
365 debug(DRIVERNAME ": the selftest passes\n");
370 static void ks_setup(struct eth_device *dev)
374 /* Setup Transmit Frame Data Pointer Auto-Increment (TXFDPR) */
375 ks_wrreg16(dev, KS_TXFDPR, TXFDPR_TXFPAI);
377 /* Setup Receive Frame Data Pointer Auto-Increment */
378 ks_wrreg16(dev, KS_RXFDPR, RXFDPR_RXFPAI);
380 /* Setup Receive Frame Threshold - 1 frame (RXFCTFC) */
381 ks_wrreg16(dev, KS_RXFCTR, 1 & RXFCTR_THRESHOLD_MASK);
383 /* Setup RxQ Command Control (RXQCR) */
384 ks->rc_rxqcr = RXQCR_CMD_CNTL;
385 ks_wrreg16(dev, KS_RXQCR, ks->rc_rxqcr);
388 * set the force mode to half duplex, default is full duplex
389 * because if the auto-negotiation fails, most switch uses
392 w = ks_rdreg16(dev, KS_P1MBCR);
393 w &= ~P1MBCR_FORCE_FDX;
394 ks_wrreg16(dev, KS_P1MBCR, w);
396 w = TXCR_TXFCE | TXCR_TXPE | TXCR_TXCRC | TXCR_TCGIP;
397 ks_wrreg16(dev, KS_TXCR, w);
399 w = RXCR1_RXFCE | RXCR1_RXBE | RXCR1_RXUE | RXCR1_RXME | RXCR1_RXIPFCC;
404 ks_wrreg16(dev, KS_RXCR1, w);
407 static void ks_setup_int(struct eth_device *dev)
411 /* Clear the interrupts status of the hardware. */
412 ks_wrreg16(dev, KS_ISR, 0xffff);
414 /* Enables the interrupts of the hardware. */
415 ks->rc_ier = (IRQ_LCI | IRQ_TXI | IRQ_RXI);
418 static int ks8851_mll_detect_chip(struct eth_device *dev)
420 unsigned short val, i;
424 val = ks_rdreg16(dev, KS_CIDER);
427 /* Special case -- no chip present */
428 printf(DRIVERNAME ": is chip mounted ?\n");
430 } else if ((val & 0xfff0) != CIDER_ID) {
431 printf(DRIVERNAME ": Invalid chip id 0x%04x\n", val);
435 debug("Read back KS8851 id 0x%x\n", val);
437 /* only one entry in the table */
439 for (i = 0; chip_ids[i].id != 0; i++) {
440 if (chip_ids[i].id == val)
443 if (!chip_ids[i].id) {
444 printf(DRIVERNAME ": Unknown chip ID %04x\n", val);
448 dev->priv = (void *)&chip_ids[i];
453 static void ks8851_mll_reset(struct eth_device *dev)
455 /* wake up powermode to normal mode */
456 ks_set_powermode(dev, PMECR_PM_NORMAL);
457 mdelay(1); /* wait for normal mode to take effect */
459 /* Disable interrupt and reset */
460 ks_soft_reset(dev, GRR_GSR);
462 /* turn off the IRQs and ack any outstanding */
463 ks_wrreg16(dev, KS_IER, 0x0000);
464 ks_wrreg16(dev, KS_ISR, 0xffff);
466 /* shutdown RX/TX QMU */
470 static void ks8851_mll_phy_configure(struct eth_device *dev)
477 /* Probing the phy */
478 data = ks_rdreg16(dev, KS_OBCR);
479 ks_wrreg16(dev, KS_OBCR, data | OBCR_ODS_16MA);
481 debug(DRIVERNAME ": phy initialized\n");
484 static void ks8851_mll_enable(struct eth_device *dev)
486 ks_wrreg16(dev, KS_ISR, 0xffff);
491 static int ks8851_mll_init(struct eth_device *dev, bd_t *bd)
493 struct chip_id *id = dev->priv;
495 debug(DRIVERNAME ": detected %s controller\n", id->name);
497 if (ks_read_selftest(dev)) {
498 printf(DRIVERNAME ": Selftest failed\n");
502 ks8851_mll_reset(dev);
504 /* Configure the PHY, initialize the link state */
505 ks8851_mll_phy_configure(dev);
507 /* static allocation of private informations */
508 ks->frame_head_info = fr_h_i;
510 /* Turn on Tx + Rx */
511 ks8851_mll_enable(dev);
516 static void ks_write_qmu(struct eth_device *dev, u8 *pdata, u16 len)
518 /* start header at txb[0] to align txw entries */
520 ks->txh.txw[1] = cpu_to_le16(len);
522 /* 1. set sudo-DMA mode */
523 ks_wrreg16(dev, KS_TXFDPR, TXFDPR_TXFPAI);
524 ks_wrreg8(dev, KS_RXQCR, (ks->rc_rxqcr | RXQCR_SDA) & 0xff);
525 /* 2. write status/lenth info */
526 ks_outblk(dev, ks->txh.txw, 4);
527 /* 3. write pkt data */
528 ks_outblk(dev, (u16 *)pdata, ALIGN(len, 4));
529 /* 4. reset sudo-DMA mode */
530 ks_wrreg8(dev, KS_RXQCR, (ks->rc_rxqcr & ~RXQCR_SDA) & 0xff);
531 /* 5. Enqueue Tx(move the pkt from TX buffer into TXQ) */
532 ks_wrreg16(dev, KS_TXQCR, TXQCR_METFE);
533 /* 6. wait until TXQCR_METFE is auto-cleared */
534 do { } while (ks_rdreg16(dev, KS_TXQCR) & TXQCR_METFE);
537 static int ks8851_mll_send(struct eth_device *dev, void *packet, int length)
539 u8 *data = (u8 *)packet;
540 u16 tmplen = (u16)length;
544 * Extra space are required:
545 * 4 byte for alignment, 4 for status/length, 4 for CRC
547 retv = ks_rdreg16(dev, KS_TXMIR) & 0x1fff;
548 if (retv >= tmplen + 12) {
549 ks_write_qmu(dev, data, tmplen);
552 printf(DRIVERNAME ": failed to send packet: No buffer\n");
557 static void ks8851_mll_halt(struct eth_device *dev)
559 ks8851_mll_reset(dev);
563 * Maximum receive ring size; that is, the number of packets
564 * we can buffer before overflow happens. Basically, this just
565 * needs to be enough to prevent a packet being discarded while
566 * we are processing the previous one.
568 static int ks8851_mll_recv(struct eth_device *dev)
572 status = ks_rdreg16(dev, KS_ISR);
574 ks_wrreg16(dev, KS_ISR, status);
576 if ((status & IRQ_RXI))
577 ks_rcv(dev, (uchar **)net_rx_packets);
579 if ((status & IRQ_LDI)) {
580 u16 pmecr = ks_rdreg16(dev, KS_PMECR);
581 pmecr &= ~PMECR_WKEVT_MASK;
582 ks_wrreg16(dev, KS_PMECR, pmecr | PMECR_WKEVT_LINK);
588 static int ks8851_mll_write_hwaddr(struct eth_device *dev)
590 u16 addrl, addrm, addrh;
592 addrh = (dev->enetaddr[0] << 8) | dev->enetaddr[1];
593 addrm = (dev->enetaddr[2] << 8) | dev->enetaddr[3];
594 addrl = (dev->enetaddr[4] << 8) | dev->enetaddr[5];
596 ks_wrreg16(dev, KS_MARH, addrh);
597 ks_wrreg16(dev, KS_MARM, addrm);
598 ks_wrreg16(dev, KS_MARL, addrl);
603 int ks8851_mll_initialize(u8 dev_num, int base_addr)
605 struct eth_device *dev;
607 dev = malloc(sizeof(*dev));
609 printf("Error: Failed to allocate memory\n");
612 memset(dev, 0, sizeof(*dev));
614 dev->iobase = base_addr;
618 /* Try to detect chip. Will fail if not present. */
619 if (ks8851_mll_detect_chip(dev)) {
624 dev->init = ks8851_mll_init;
625 dev->halt = ks8851_mll_halt;
626 dev->send = ks8851_mll_send;
627 dev->recv = ks8851_mll_recv;
628 dev->write_hwaddr = ks8851_mll_write_hwaddr;
629 sprintf(dev->name, "%s-%hu", DRIVERNAME, dev_num);