net: ks8851: Add DM support
[oweals/u-boot.git] / drivers / net / ks8851_mll.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Micrel KS8851_MLL 16bit Network driver
4  * Copyright (c) 2011 Roberto Cerati <roberto.cerati@bticino.it>
5  */
6
7 #include <log.h>
8 #include <asm/io.h>
9 #include <common.h>
10 #include <command.h>
11 #include <malloc.h>
12 #include <net.h>
13 #include <miiphy.h>
14 #include <linux/delay.h>
15
16 #include "ks8851_mll.h"
17
18 #define DRIVERNAME                      "ks8851_mll"
19
20 #define RX_BUF_SIZE                     2000
21
22 /*
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.
29  */
30 struct ks_net {
31 #ifndef CONFIG_DM_ETH
32         struct eth_device       dev;
33 #endif
34         phys_addr_t             iobase;
35         int                     bus_width;
36         u16                     sharedbus;
37         u16                     rxfc;
38         u8                      extra_byte;
39 };
40
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 */
45
46 static u8 ks_rdreg8(struct ks_net *ks, u16 offset)
47 {
48         u8 shift_bit = offset & 0x03;
49         u8 shift_data = (offset & 1) << 3;
50
51         writew(offset | (BE0 << shift_bit), ks->iobase + 2);
52
53         return (u8)(readw(ks->iobase) >> shift_data);
54 }
55
56 static u16 ks_rdreg16(struct ks_net *ks, u16 offset)
57 {
58         writew(offset | ((BE1 | BE0) << (offset & 0x02)), ks->iobase + 2);
59
60         return readw(ks->iobase);
61 }
62
63 static void ks_wrreg16(struct ks_net *ks, u16 offset, u16 val)
64 {
65         writew(offset | ((BE1 | BE0) << (offset & 0x02)), ks->iobase + 2);
66         writew(val, ks->iobase);
67 }
68
69 /*
70  * ks_inblk - read a block of data from QMU. This is called after sudo DMA mode
71  * enabled.
72  * @ks: The chip state
73  * @wptr: buffer address to save data
74  * @len: length in byte to read
75  */
76 static inline void ks_inblk(struct ks_net *ks, u16 *wptr, u32 len)
77 {
78         len >>= 1;
79
80         while (len--)
81                 *wptr++ = readw(ks->iobase);
82 }
83
84 /*
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
89  */
90 static inline void ks_outblk(struct ks_net *ks, u16 *wptr, u32 len)
91 {
92         len >>= 1;
93
94         while (len--)
95                 writew(*wptr++, ks->iobase);
96 }
97
98 static void ks_enable_int(struct ks_net *ks)
99 {
100         ks_wrreg16(ks, KS_IER, IRQ_LCI | IRQ_TXI | IRQ_RXI);
101 }
102
103 static void ks_set_powermode(struct ks_net *ks, unsigned int pwrmode)
104 {
105         unsigned int pmecr;
106
107         ks_rdreg16(ks, KS_GRR);
108         pmecr = ks_rdreg16(ks, KS_PMECR);
109         pmecr &= ~PMECR_PM_MASK;
110         pmecr |= pwrmode;
111
112         ks_wrreg16(ks, KS_PMECR, pmecr);
113 }
114
115 /*
116  * ks_read_config - read chip configuration of bus width.
117  * @ks: The chip information
118  */
119 static void ks_read_config(struct ks_net *ks)
120 {
121         u16 reg_data = 0;
122
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;
126
127         /* addr/data bus are multiplexed */
128         ks->sharedbus = (reg_data & CCR_SHARED) == CCR_SHARED;
129
130         /*
131          * There are garbage data when reading data from QMU,
132          * depending on bus-width.
133          */
134         if (reg_data & CCR_8BIT) {
135                 ks->bus_width = ENUM_BUS_8BIT;
136                 ks->extra_byte = 1;
137         } else if (reg_data & CCR_16BIT) {
138                 ks->bus_width = ENUM_BUS_16BIT;
139                 ks->extra_byte = 2;
140         } else {
141                 ks->bus_width = ENUM_BUS_32BIT;
142                 ks->extra_byte = 4;
143         }
144 }
145
146 /*
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
150  *
151  * Issue the relevant soft-reset command to the device's GRR register
152  * specified by @op.
153  *
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.
158  */
159 static void ks_soft_reset(struct ks_net *ks, unsigned int op)
160 {
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 */
167 }
168
169 void ks_enable_qmu(struct ks_net *ks)
170 {
171         u16 w;
172
173         w = ks_rdreg16(ks, KS_TXCR);
174
175         /* Enables QMU Transmit (TXCR). */
176         ks_wrreg16(ks, KS_TXCR, w | TXCR_TXE);
177
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);
181
182         /* Enables QMU Receive (RXCR1). */
183         w = ks_rdreg16(ks, KS_RXCR1);
184         ks_wrreg16(ks, KS_RXCR1, w | RXCR1_RXE);
185 }
186
187 static void ks_disable_qmu(struct ks_net *ks)
188 {
189         u16 w;
190
191         w = ks_rdreg16(ks, KS_TXCR);
192
193         /* Disables QMU Transmit (TXCR). */
194         w &= ~TXCR_TXE;
195         ks_wrreg16(ks, KS_TXCR, w);
196
197         /* Disables QMU Receive (RXCR1). */
198         w = ks_rdreg16(ks, KS_RXCR1);
199         w &= ~RXCR1_RXE;
200         ks_wrreg16(ks, KS_RXCR1, w);
201 }
202
203 static inline void ks_read_qmu(struct ks_net *ks, u16 *buf, u32 len)
204 {
205         u32 r = ks->extra_byte & 0x1;
206         u32 w = ks->extra_byte - r;
207
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);
211
212         /*
213          * 2. read prepend data
214          *
215          * read 4 + extra bytes and discard them.
216          * extra bytes for dummy, 2 for status, 2 for len
217          */
218
219         if (r)
220                 ks_rdreg8(ks, 0);
221
222         ks_inblk(ks, buf, w + 2 + 2);
223
224         /* 3. read pkt data */
225         ks_inblk(ks, buf, ALIGN(len, 4));
226
227         /* 4. reset sudo DMA Mode */
228         ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL);
229 }
230
231 static int ks_rcv(struct ks_net *ks, uchar *data)
232 {
233         u16 sts, len;
234
235         if (!ks->rxfc)
236                 ks->rxfc = ks_rdreg16(ks, KS_RXFCTR) >> 8;
237
238         if (!ks->rxfc)
239                 return 0;
240
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);
245
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);
249                 ks->rxfc--;
250                 return len - 4;
251         }
252
253         ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL | RXQCR_RRXEF);
254         printf(DRIVERNAME ": bad packet\n");
255         return 0;
256 }
257
258 /*
259  * ks_read_selftest - read the selftest memory info.
260  * @ks: The device state
261  *
262  * Read and check the TX/RX memory selftest information.
263  */
264 static int ks_read_selftest(struct ks_net *ks)
265 {
266         u16 both_done = MBIR_TXMBF | MBIR_RXMBF;
267         u16 mbir;
268         int ret = 0;
269
270         mbir = ks_rdreg16(ks, KS_MBIR);
271
272         if ((mbir & both_done) != both_done) {
273                 printf(DRIVERNAME ": Memory selftest not finished\n");
274                 return 0;
275         }
276
277         if (mbir & MBIR_TXMBFA) {
278                 printf(DRIVERNAME ": TX memory selftest fails\n");
279                 ret |= 1;
280         }
281
282         if (mbir & MBIR_RXMBFA) {
283                 printf(DRIVERNAME ": RX memory selftest fails\n");
284                 ret |= 2;
285         }
286
287         debug(DRIVERNAME ": the selftest passes\n");
288
289         return ret;
290 }
291
292 static void ks_setup(struct ks_net *ks)
293 {
294         u16 w;
295
296         /* Setup Transmit Frame Data Pointer Auto-Increment (TXFDPR) */
297         ks_wrreg16(ks, KS_TXFDPR, TXFDPR_TXFPAI);
298
299         /* Setup Receive Frame Data Pointer Auto-Increment */
300         ks_wrreg16(ks, KS_RXFDPR, RXFDPR_RXFPAI);
301
302         /* Setup Receive Frame Threshold - 1 frame (RXFCTFC) */
303         ks_wrreg16(ks, KS_RXFCTR, 1 & RXFCTR_THRESHOLD_MASK);
304
305         /* Setup RxQ Command Control (RXQCR) */
306         ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL);
307
308         /*
309          * set the force mode to half duplex, default is full duplex
310          * because if the auto-negotiation fails, most switch uses
311          * half-duplex.
312          */
313         w = ks_rdreg16(ks, KS_P1MBCR);
314         w &= ~P1MBCR_FORCE_FDX;
315         ks_wrreg16(ks, KS_P1MBCR, w);
316
317         w = TXCR_TXFCE | TXCR_TXPE | TXCR_TXCRC | TXCR_TCGIP;
318         ks_wrreg16(ks, KS_TXCR, w);
319
320         w = RXCR1_RXFCE | RXCR1_RXBE | RXCR1_RXUE | RXCR1_RXME | RXCR1_RXIPFCC;
321
322         /* Normal mode */
323         w |= RXCR1_RXPAFMA;
324
325         ks_wrreg16(ks, KS_RXCR1, w);
326 }
327
328 static void ks_setup_int(struct ks_net *ks)
329 {
330         /* Clear the interrupts status of the hardware. */
331         ks_wrreg16(ks, KS_ISR, 0xffff);
332 }
333
334 static int ks8851_mll_detect_chip(struct ks_net *ks)
335 {
336         unsigned short val;
337
338         ks_read_config(ks);
339
340         val = ks_rdreg16(ks, KS_CIDER);
341
342         if (val == 0xffff) {
343                 /* Special case -- no chip present */
344                 printf(DRIVERNAME ":  is chip mounted ?\n");
345                 return -1;
346         } else if ((val & 0xfff0) != CIDER_ID) {
347                 printf(DRIVERNAME ": Invalid chip id 0x%04x\n", val);
348                 return -1;
349         }
350
351         debug("Read back KS8851 id 0x%x\n", val);
352
353         if ((val & 0xfff0) != CIDER_ID) {
354                 printf(DRIVERNAME ": Unknown chip ID %04x\n", val);
355                 return -1;
356         }
357
358         return 0;
359 }
360
361 static void ks8851_mll_reset(struct ks_net *ks)
362 {
363         /* wake up powermode to normal mode */
364         ks_set_powermode(ks, PMECR_PM_NORMAL);
365         mdelay(1);      /* wait for normal mode to take effect */
366
367         /* Disable interrupt and reset */
368         ks_soft_reset(ks, GRR_GSR);
369
370         /* turn off the IRQs and ack any outstanding */
371         ks_wrreg16(ks, KS_IER, 0x0000);
372         ks_wrreg16(ks, KS_ISR, 0xffff);
373
374         /* shutdown RX/TX QMU */
375         ks_disable_qmu(ks);
376 }
377
378 static void ks8851_mll_phy_configure(struct ks_net *ks)
379 {
380         u16 data;
381
382         ks_setup(ks);
383         ks_setup_int(ks);
384
385         /* Probing the phy */
386         data = ks_rdreg16(ks, KS_OBCR);
387         ks_wrreg16(ks, KS_OBCR, data | OBCR_ODS_16MA);
388
389         debug(DRIVERNAME ": phy initialized\n");
390 }
391
392 static void ks8851_mll_enable(struct ks_net *ks)
393 {
394         ks_wrreg16(ks, KS_ISR, 0xffff);
395         ks_enable_int(ks);
396         ks_enable_qmu(ks);
397 }
398
399 static int ks8851_mll_init_common(struct ks_net *ks)
400 {
401         if (ks_read_selftest(ks)) {
402                 printf(DRIVERNAME ": Selftest failed\n");
403                 return -1;
404         }
405
406         ks8851_mll_reset(ks);
407
408         /* Configure the PHY, initialize the link state */
409         ks8851_mll_phy_configure(ks);
410
411         ks->rxfc = 0;
412
413         /* Turn on Tx + Rx */
414         ks8851_mll_enable(ks);
415
416         return 0;
417 }
418
419 static void ks_write_qmu(struct ks_net *ks, u8 *pdata, u16 len)
420 {
421         __le16 txw[2];
422         /* start header at txb[0] to align txw entries */
423         txw[0] = 0;
424         txw[1] = cpu_to_le16(len);
425
426         /* 1. set sudo-DMA mode */
427         ks_wrreg16(ks, KS_TXFDPR, TXFDPR_TXFPAI);
428         ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL | RXQCR_SDA);
429         /* 2. write status/length info */
430         ks_outblk(ks, txw, 4);
431         /* 3. write pkt data */
432         ks_outblk(ks, (u16 *)pdata, ALIGN(len, 4));
433         /* 4. reset sudo-DMA mode */
434         ks_wrreg16(ks, KS_RXQCR, RXQCR_CMD_CNTL);
435         /* 5. Enqueue Tx(move the pkt from TX buffer into TXQ) */
436         ks_wrreg16(ks, KS_TXQCR, TXQCR_METFE);
437         /* 6. wait until TXQCR_METFE is auto-cleared */
438         do { } while (ks_rdreg16(ks, KS_TXQCR) & TXQCR_METFE);
439 }
440
441 static int ks8851_mll_send_common(struct ks_net *ks, void *packet, int length)
442 {
443         u8 *data = (u8 *)packet;
444         u16 tmplen = (u16)length;
445         u16 retv;
446
447         /*
448          * Extra space are required:
449          * 4 byte for alignment, 4 for status/length, 4 for CRC
450          */
451         retv = ks_rdreg16(ks, KS_TXMIR) & 0x1fff;
452         if (retv >= tmplen + 12) {
453                 ks_write_qmu(ks, data, tmplen);
454                 return 0;
455         }
456
457         printf(DRIVERNAME ": failed to send packet: No buffer\n");
458         return -1;
459 }
460
461 static void ks8851_mll_halt_common(struct ks_net *ks)
462 {
463         ks8851_mll_reset(ks);
464 }
465
466 /*
467  * Maximum receive ring size; that is, the number of packets
468  * we can buffer before overflow happens. Basically, this just
469  * needs to be enough to prevent a packet being discarded while
470  * we are processing the previous one.
471  */
472 static int ks8851_mll_recv_common(struct ks_net *ks, uchar *data)
473 {
474         u16 status;
475         int ret = 0;
476
477         status = ks_rdreg16(ks, KS_ISR);
478
479         ks_wrreg16(ks, KS_ISR, status);
480
481         if (ks->rxfc || (status & IRQ_RXI))
482                 ret = ks_rcv(ks, data);
483
484         if (status & IRQ_LDI) {
485                 u16 pmecr = ks_rdreg16(ks, KS_PMECR);
486
487                 pmecr &= ~PMECR_WKEVT_MASK;
488                 ks_wrreg16(ks, KS_PMECR, pmecr | PMECR_WKEVT_LINK);
489         }
490
491         return ret;
492 }
493
494 static void ks8851_mll_write_hwaddr_common(struct ks_net *ks, u8 enetaddr[6])
495 {
496         u16 addrl, addrm, addrh;
497
498         addrh = (enetaddr[0] << 8) | enetaddr[1];
499         addrm = (enetaddr[2] << 8) | enetaddr[3];
500         addrl = (enetaddr[4] << 8) | enetaddr[5];
501
502         ks_wrreg16(ks, KS_MARH, addrh);
503         ks_wrreg16(ks, KS_MARM, addrm);
504         ks_wrreg16(ks, KS_MARL, addrl);
505 }
506
507 #ifndef CONFIG_DM_ETH
508 static int ks8851_mll_init(struct eth_device *dev, bd_t *bd)
509 {
510         struct ks_net *ks = container_of(dev, struct ks_net, dev);
511
512         return ks8851_mll_init_common(ks);
513 }
514
515 static void ks8851_mll_halt(struct eth_device *dev)
516 {
517         struct ks_net *ks = container_of(dev, struct ks_net, dev);
518
519         ks8851_mll_halt_common(ks);
520 }
521
522 static int ks8851_mll_send(struct eth_device *dev, void *packet, int length)
523 {
524         struct ks_net *ks = container_of(dev, struct ks_net, dev);
525
526         return ks8851_mll_send_common(ks, packet, length);
527 }
528
529 static int ks8851_mll_recv(struct eth_device *dev)
530 {
531         struct ks_net *ks = container_of(dev, struct ks_net, dev);
532         int ret;
533
534         ret = ks8851_mll_recv_common(ks, net_rx_packets[0]);
535         if (ret)
536                 net_process_received_packet(net_rx_packets[0], ret);
537
538         return ret;
539 }
540
541 static int ks8851_mll_write_hwaddr(struct eth_device *dev)
542 {
543         struct ks_net *ks = container_of(dev, struct ks_net, dev);
544
545         ks8851_mll_write_hwaddr_common(ks, ks->dev.enetaddr);
546
547         return 0;
548 }
549
550 int ks8851_mll_initialize(u8 dev_num, int base_addr)
551 {
552         struct ks_net *ks;
553
554         ks = calloc(1, sizeof(*ks));
555         if (!ks)
556                 return -ENOMEM;
557
558         ks->iobase = base_addr;
559
560         /* Try to detect chip. Will fail if not present. */
561         if (ks8851_mll_detect_chip(ks)) {
562                 free(ks);
563                 return -1;
564         }
565
566         ks->dev.init = ks8851_mll_init;
567         ks->dev.halt = ks8851_mll_halt;
568         ks->dev.send = ks8851_mll_send;
569         ks->dev.recv = ks8851_mll_recv;
570         ks->dev.write_hwaddr = ks8851_mll_write_hwaddr;
571         sprintf(ks->dev.name, "%s-%hu", DRIVERNAME, dev_num);
572
573         eth_register(&ks->dev);
574
575         return 0;
576 }
577 #else   /* ifdef CONFIG_DM_ETH */
578 static int ks8851_start(struct udevice *dev)
579 {
580         struct ks_net *ks = dev_get_priv(dev);
581
582         return ks8851_mll_init_common(ks);
583 }
584
585 static void ks8851_stop(struct udevice *dev)
586 {
587         struct ks_net *ks = dev_get_priv(dev);
588
589         ks8851_mll_halt_common(ks);
590 }
591
592 static int ks8851_send(struct udevice *dev, void *packet, int length)
593 {
594         struct ks_net *ks = dev_get_priv(dev);
595         int ret;
596
597         ret = ks8851_mll_send_common(ks, packet, length);
598
599         return ret ? 0 : -ETIMEDOUT;
600 }
601
602 static int ks8851_recv(struct udevice *dev, int flags, uchar **packetp)
603 {
604         struct ks_net *ks = dev_get_priv(dev);
605         uchar *data = net_rx_packets[0];
606         int ret;
607
608         ret = ks8851_mll_recv_common(ks, data);
609         if (ret)
610                 *packetp = (void *)data;
611
612         return ret ? ret : -EAGAIN;
613 }
614
615 static int ks8851_write_hwaddr(struct udevice *dev)
616 {
617         struct ks_net *ks = dev_get_priv(dev);
618         struct eth_pdata *pdata = dev_get_platdata(dev);
619
620         ks8851_mll_write_hwaddr_common(ks, pdata->enetaddr);
621
622         return 0;
623 }
624
625 static int ks8851_bind(struct udevice *dev)
626 {
627         return device_set_name(dev, dev->name);
628 }
629
630 static int ks8851_probe(struct udevice *dev)
631 {
632         struct ks_net *ks = dev_get_priv(dev);
633
634         /* Try to detect chip. Will fail if not present. */
635         ks8851_mll_detect_chip(ks);
636
637         return 0;
638 }
639
640 static int ks8851_ofdata_to_platdata(struct udevice *dev)
641 {
642         struct ks_net *ks = dev_get_priv(dev);
643         struct eth_pdata *pdata = dev_get_platdata(dev);
644
645         pdata->iobase = devfdt_get_addr(dev);
646         ks->iobase = pdata->iobase;
647
648         return 0;
649 }
650
651 static const struct eth_ops ks8851_ops = {
652         .start          = ks8851_start,
653         .stop           = ks8851_stop,
654         .send           = ks8851_send,
655         .recv           = ks8851_recv,
656         .write_hwaddr   = ks8851_write_hwaddr,
657 };
658
659 static const struct udevice_id ks8851_ids[] = {
660         { .compatible = "micrel,ks8851-mll" },
661         { }
662 };
663
664 U_BOOT_DRIVER(ks8851) = {
665         .name           = "eth_ks8851",
666         .id             = UCLASS_ETH,
667         .of_match       = ks8851_ids,
668         .bind           = ks8851_bind,
669         .ofdata_to_platdata = ks8851_ofdata_to_platdata,
670         .probe          = ks8851_probe,
671         .ops            = &ks8851_ops,
672         .priv_auto_alloc_size = sizeof(struct ks_net),
673         .platdata_auto_alloc_size = sizeof(struct eth_pdata),
674         .flags          = DM_FLAG_ALLOC_PRIV_DMA,
675 };
676 #endif