2 * Ethernet driver for the WIZnet W5300 chip.
4 * Copyright (C) 2008-2009 WIZnet Co.,Ltd.
5 * Copyright (C) 2011 Taehun Kim <kth3321 <at> gmail.com>
6 * Copyright (C) 2012 Mike Sinkovsky <msink@permonline.ru>
8 * Licensed under the GPL-2 or later.
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/netdevice.h>
14 #include <linux/etherdevice.h>
15 #include <linux/platform_device.h>
16 #include <linux/platform_data/wiznet.h>
17 #include <linux/ethtool.h>
18 #include <linux/skbuff.h>
19 #include <linux/types.h>
20 #include <linux/errno.h>
21 #include <linux/delay.h>
22 #include <linux/slab.h>
23 #include <linux/spinlock.h>
25 #include <linux/ioport.h>
26 #include <linux/interrupt.h>
27 #include <linux/irq.h>
28 #include <linux/gpio.h>
30 #define DRV_NAME "w5300"
31 #define DRV_VERSION "2012-04-04"
33 MODULE_DESCRIPTION("WIZnet W5300 Ethernet driver v"DRV_VERSION
);
34 MODULE_AUTHOR("Mike Sinkovsky <msink@permonline.ru>");
35 MODULE_ALIAS("platform:"DRV_NAME
);
36 MODULE_LICENSE("GPL");
41 #define W5300_MR 0x0000 /* Mode Register */
42 #define MR_DBW (1 << 15) /* Data bus width */
43 #define MR_MPF (1 << 14) /* Mac layer pause frame */
44 #define MR_WDF(n) (((n)&7)<<11) /* Write data fetch time */
45 #define MR_RDH (1 << 10) /* Read data hold time */
46 #define MR_FS (1 << 8) /* FIFO swap */
47 #define MR_RST (1 << 7) /* S/W reset */
48 #define MR_PB (1 << 4) /* Ping block */
49 #define MR_DBS (1 << 2) /* Data bus swap */
50 #define MR_IND (1 << 0) /* Indirect mode */
51 #define W5300_IR 0x0002 /* Interrupt Register */
52 #define W5300_IMR 0x0004 /* Interrupt Mask Register */
53 #define IR_S0 0x0001 /* S0 interrupt */
54 #define W5300_SHARL 0x0008 /* Source MAC address (0123) */
55 #define W5300_SHARH 0x000c /* Source MAC address (45) */
56 #define W5300_TMSRL 0x0020 /* Transmit Memory Size (0123) */
57 #define W5300_TMSRH 0x0024 /* Transmit Memory Size (4567) */
58 #define W5300_RMSRL 0x0028 /* Receive Memory Size (0123) */
59 #define W5300_RMSRH 0x002c /* Receive Memory Size (4567) */
60 #define W5300_MTYPE 0x0030 /* Memory Type */
61 #define W5300_IDR 0x00fe /* Chip ID register */
62 #define IDR_W5300 0x5300 /* =0x5300 for WIZnet W5300 */
63 #define W5300_S0_MR 0x0200 /* S0 Mode Register */
64 #define S0_MR_CLOSED 0x0000 /* Close mode */
65 #define S0_MR_MACRAW 0x0004 /* MAC RAW mode (promiscuous) */
66 #define S0_MR_MACRAW_MF 0x0044 /* MAC RAW mode (filtered) */
67 #define W5300_S0_CR 0x0202 /* S0 Command Register */
68 #define S0_CR_OPEN 0x0001 /* OPEN command */
69 #define S0_CR_CLOSE 0x0010 /* CLOSE command */
70 #define S0_CR_SEND 0x0020 /* SEND command */
71 #define S0_CR_RECV 0x0040 /* RECV command */
72 #define W5300_S0_IMR 0x0204 /* S0 Interrupt Mask Register */
73 #define W5300_S0_IR 0x0206 /* S0 Interrupt Register */
74 #define S0_IR_RECV 0x0004 /* Receive interrupt */
75 #define S0_IR_SENDOK 0x0010 /* Send OK interrupt */
76 #define W5300_S0_SSR 0x0208 /* S0 Socket Status Register */
77 #define W5300_S0_TX_WRSR 0x0220 /* S0 TX Write Size Register */
78 #define W5300_S0_TX_FSR 0x0224 /* S0 TX Free Size Register */
79 #define W5300_S0_RX_RSR 0x0228 /* S0 Received data Size */
80 #define W5300_S0_TX_FIFO 0x022e /* S0 Transmit FIFO */
81 #define W5300_S0_RX_FIFO 0x0230 /* S0 Receive FIFO */
82 #define W5300_REGS_LEN 0x0400
85 * Device driver private data structure
91 u16 (*read
) (struct w5300_priv
*priv
, u16 addr
);
92 void (*write
)(struct w5300_priv
*priv
, u16 addr
, u16 data
);
97 struct napi_struct napi
;
98 struct net_device
*ndev
;
103 /************************************************************************
105 * Lowlevel I/O functions
107 ***********************************************************************/
110 * In direct address mode host system can directly access W5300 registers
111 * after mapping to Memory-Mapped I/O space.
113 * 0x400 bytes are required for memory space.
115 static inline u16
w5300_read_direct(struct w5300_priv
*priv
, u16 addr
)
117 return ioread16(priv
->base
+ (addr
<< CONFIG_WIZNET_BUS_SHIFT
));
120 static inline void w5300_write_direct(struct w5300_priv
*priv
,
123 iowrite16(data
, priv
->base
+ (addr
<< CONFIG_WIZNET_BUS_SHIFT
));
127 * In indirect address mode host system indirectly accesses registers by
128 * using Indirect Mode Address Register (IDM_AR) and Indirect Mode Data
129 * Register (IDM_DR), which are directly mapped to Memory-Mapped I/O space.
130 * Mode Register (MR) is directly accessible.
132 * Only 0x06 bytes are required for memory space.
134 #define W5300_IDM_AR 0x0002 /* Indirect Mode Address */
135 #define W5300_IDM_DR 0x0004 /* Indirect Mode Data */
137 static u16
w5300_read_indirect(struct w5300_priv
*priv
, u16 addr
)
142 spin_lock_irqsave(&priv
->reg_lock
, flags
);
143 w5300_write_direct(priv
, W5300_IDM_AR
, addr
);
145 data
= w5300_read_direct(priv
, W5300_IDM_DR
);
146 spin_unlock_irqrestore(&priv
->reg_lock
, flags
);
151 static void w5300_write_indirect(struct w5300_priv
*priv
, u16 addr
, u16 data
)
155 spin_lock_irqsave(&priv
->reg_lock
, flags
);
156 w5300_write_direct(priv
, W5300_IDM_AR
, addr
);
158 w5300_write_direct(priv
, W5300_IDM_DR
, data
);
160 spin_unlock_irqrestore(&priv
->reg_lock
, flags
);
163 #if defined(CONFIG_WIZNET_BUS_DIRECT)
164 #define w5300_read w5300_read_direct
165 #define w5300_write w5300_write_direct
167 #elif defined(CONFIG_WIZNET_BUS_INDIRECT)
168 #define w5300_read w5300_read_indirect
169 #define w5300_write w5300_write_indirect
171 #else /* CONFIG_WIZNET_BUS_ANY */
172 #define w5300_read priv->read
173 #define w5300_write priv->write
176 static u32
w5300_read32(struct w5300_priv
*priv
, u16 addr
)
179 data
= w5300_read(priv
, addr
) << 16;
180 data
|= w5300_read(priv
, addr
+ 2);
184 static void w5300_write32(struct w5300_priv
*priv
, u16 addr
, u32 data
)
186 w5300_write(priv
, addr
, data
>> 16);
187 w5300_write(priv
, addr
+ 2, data
);
190 static int w5300_command(struct w5300_priv
*priv
, u16 cmd
)
192 unsigned long timeout
= jiffies
+ msecs_to_jiffies(100);
194 w5300_write(priv
, W5300_S0_CR
, cmd
);
197 while (w5300_read(priv
, W5300_S0_CR
) != 0) {
198 if (time_after(jiffies
, timeout
))
206 static void w5300_read_frame(struct w5300_priv
*priv
, u8
*buf
, int len
)
211 for (i
= 0; i
< len
; i
+= 2) {
212 fifo
= w5300_read(priv
, W5300_S0_RX_FIFO
);
216 fifo
= w5300_read(priv
, W5300_S0_RX_FIFO
);
217 fifo
= w5300_read(priv
, W5300_S0_RX_FIFO
);
220 static void w5300_write_frame(struct w5300_priv
*priv
, u8
*buf
, int len
)
225 for (i
= 0; i
< len
; i
+= 2) {
228 w5300_write(priv
, W5300_S0_TX_FIFO
, fifo
);
230 w5300_write32(priv
, W5300_S0_TX_WRSR
, len
);
233 static void w5300_write_macaddr(struct w5300_priv
*priv
)
235 struct net_device
*ndev
= priv
->ndev
;
236 w5300_write32(priv
, W5300_SHARL
,
237 ndev
->dev_addr
[0] << 24 |
238 ndev
->dev_addr
[1] << 16 |
239 ndev
->dev_addr
[2] << 8 |
241 w5300_write(priv
, W5300_SHARH
,
242 ndev
->dev_addr
[4] << 8 |
247 static void w5300_hw_reset(struct w5300_priv
*priv
)
249 w5300_write_direct(priv
, W5300_MR
, MR_RST
);
252 w5300_write_direct(priv
, W5300_MR
, priv
->indirect
?
253 MR_WDF(7) | MR_PB
| MR_IND
:
256 w5300_write(priv
, W5300_IMR
, 0);
257 w5300_write_macaddr(priv
);
259 /* Configure 128K of internal memory
260 * as 64K RX fifo and 64K TX fifo
262 w5300_write32(priv
, W5300_RMSRL
, 64 << 24);
263 w5300_write32(priv
, W5300_RMSRH
, 0);
264 w5300_write32(priv
, W5300_TMSRL
, 64 << 24);
265 w5300_write32(priv
, W5300_TMSRH
, 0);
266 w5300_write(priv
, W5300_MTYPE
, 0x00ff);
270 static void w5300_hw_start(struct w5300_priv
*priv
)
272 w5300_write(priv
, W5300_S0_MR
, priv
->promisc
?
273 S0_MR_MACRAW
: S0_MR_MACRAW_MF
);
275 w5300_command(priv
, S0_CR_OPEN
);
276 w5300_write(priv
, W5300_S0_IMR
, S0_IR_RECV
| S0_IR_SENDOK
);
277 w5300_write(priv
, W5300_IMR
, IR_S0
);
281 static void w5300_hw_close(struct w5300_priv
*priv
)
283 w5300_write(priv
, W5300_IMR
, 0);
285 w5300_command(priv
, S0_CR_CLOSE
);
288 /***********************************************************************
290 * Device driver functions / callbacks
292 ***********************************************************************/
294 static void w5300_get_drvinfo(struct net_device
*ndev
,
295 struct ethtool_drvinfo
*info
)
297 strlcpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
298 strlcpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
299 strlcpy(info
->bus_info
, dev_name(ndev
->dev
.parent
),
300 sizeof(info
->bus_info
));
303 static u32
w5300_get_link(struct net_device
*ndev
)
305 struct w5300_priv
*priv
= netdev_priv(ndev
);
307 if (gpio_is_valid(priv
->link_gpio
))
308 return !!gpio_get_value(priv
->link_gpio
);
313 static u32
w5300_get_msglevel(struct net_device
*ndev
)
315 struct w5300_priv
*priv
= netdev_priv(ndev
);
317 return priv
->msg_enable
;
320 static void w5300_set_msglevel(struct net_device
*ndev
, u32 value
)
322 struct w5300_priv
*priv
= netdev_priv(ndev
);
324 priv
->msg_enable
= value
;
327 static int w5300_get_regs_len(struct net_device
*ndev
)
329 return W5300_REGS_LEN
;
332 static void w5300_get_regs(struct net_device
*ndev
,
333 struct ethtool_regs
*regs
, void *_buf
)
335 struct w5300_priv
*priv
= netdev_priv(ndev
);
341 for (addr
= 0; addr
< W5300_REGS_LEN
; addr
+= 2) {
342 switch (addr
& 0x23f) {
343 case W5300_S0_TX_FIFO
: /* cannot read TX_FIFO */
344 case W5300_S0_RX_FIFO
: /* cannot read RX_FIFO */
348 data
= w5300_read(priv
, addr
);
356 static void w5300_tx_timeout(struct net_device
*ndev
)
358 struct w5300_priv
*priv
= netdev_priv(ndev
);
360 netif_stop_queue(ndev
);
361 w5300_hw_reset(priv
);
362 w5300_hw_start(priv
);
363 ndev
->stats
.tx_errors
++;
364 netif_trans_update(ndev
);
365 netif_wake_queue(ndev
);
368 static int w5300_start_tx(struct sk_buff
*skb
, struct net_device
*ndev
)
370 struct w5300_priv
*priv
= netdev_priv(ndev
);
372 netif_stop_queue(ndev
);
374 w5300_write_frame(priv
, skb
->data
, skb
->len
);
376 ndev
->stats
.tx_packets
++;
377 ndev
->stats
.tx_bytes
+= skb
->len
;
379 netif_dbg(priv
, tx_queued
, ndev
, "tx queued\n");
381 w5300_command(priv
, S0_CR_SEND
);
386 static int w5300_napi_poll(struct napi_struct
*napi
, int budget
)
388 struct w5300_priv
*priv
= container_of(napi
, struct w5300_priv
, napi
);
389 struct net_device
*ndev
= priv
->ndev
;
394 for (rx_count
= 0; rx_count
< budget
; rx_count
++) {
395 u32 rx_fifo_len
= w5300_read32(priv
, W5300_S0_RX_RSR
);
396 if (rx_fifo_len
== 0)
399 rx_len
= w5300_read(priv
, W5300_S0_RX_FIFO
);
401 skb
= netdev_alloc_skb_ip_align(ndev
, roundup(rx_len
, 2));
402 if (unlikely(!skb
)) {
404 for (i
= 0; i
< rx_fifo_len
; i
+= 2)
405 w5300_read(priv
, W5300_S0_RX_FIFO
);
406 ndev
->stats
.rx_dropped
++;
410 skb_put(skb
, rx_len
);
411 w5300_read_frame(priv
, skb
->data
, rx_len
);
412 skb
->protocol
= eth_type_trans(skb
, ndev
);
414 netif_receive_skb(skb
);
415 ndev
->stats
.rx_packets
++;
416 ndev
->stats
.rx_bytes
+= rx_len
;
419 if (rx_count
< budget
) {
421 w5300_write(priv
, W5300_IMR
, IR_S0
);
428 static irqreturn_t
w5300_interrupt(int irq
, void *ndev_instance
)
430 struct net_device
*ndev
= ndev_instance
;
431 struct w5300_priv
*priv
= netdev_priv(ndev
);
433 int ir
= w5300_read(priv
, W5300_S0_IR
);
436 w5300_write(priv
, W5300_S0_IR
, ir
);
439 if (ir
& S0_IR_SENDOK
) {
440 netif_dbg(priv
, tx_done
, ndev
, "tx done\n");
441 netif_wake_queue(ndev
);
444 if (ir
& S0_IR_RECV
) {
445 if (napi_schedule_prep(&priv
->napi
)) {
446 w5300_write(priv
, W5300_IMR
, 0);
448 __napi_schedule(&priv
->napi
);
455 static irqreturn_t
w5300_detect_link(int irq
, void *ndev_instance
)
457 struct net_device
*ndev
= ndev_instance
;
458 struct w5300_priv
*priv
= netdev_priv(ndev
);
460 if (netif_running(ndev
)) {
461 if (gpio_get_value(priv
->link_gpio
) != 0) {
462 netif_info(priv
, link
, ndev
, "link is up\n");
463 netif_carrier_on(ndev
);
465 netif_info(priv
, link
, ndev
, "link is down\n");
466 netif_carrier_off(ndev
);
473 static void w5300_set_rx_mode(struct net_device
*ndev
)
475 struct w5300_priv
*priv
= netdev_priv(ndev
);
476 bool set_promisc
= (ndev
->flags
& IFF_PROMISC
) != 0;
478 if (priv
->promisc
!= set_promisc
) {
479 priv
->promisc
= set_promisc
;
480 w5300_hw_start(priv
);
484 static int w5300_set_macaddr(struct net_device
*ndev
, void *addr
)
486 struct w5300_priv
*priv
= netdev_priv(ndev
);
487 struct sockaddr
*sock_addr
= addr
;
489 if (!is_valid_ether_addr(sock_addr
->sa_data
))
490 return -EADDRNOTAVAIL
;
491 memcpy(ndev
->dev_addr
, sock_addr
->sa_data
, ETH_ALEN
);
492 w5300_write_macaddr(priv
);
496 static int w5300_open(struct net_device
*ndev
)
498 struct w5300_priv
*priv
= netdev_priv(ndev
);
500 netif_info(priv
, ifup
, ndev
, "enabling\n");
501 w5300_hw_start(priv
);
502 napi_enable(&priv
->napi
);
503 netif_start_queue(ndev
);
504 if (!gpio_is_valid(priv
->link_gpio
) ||
505 gpio_get_value(priv
->link_gpio
) != 0)
506 netif_carrier_on(ndev
);
510 static int w5300_stop(struct net_device
*ndev
)
512 struct w5300_priv
*priv
= netdev_priv(ndev
);
514 netif_info(priv
, ifdown
, ndev
, "shutting down\n");
515 w5300_hw_close(priv
);
516 netif_carrier_off(ndev
);
517 netif_stop_queue(ndev
);
518 napi_disable(&priv
->napi
);
522 static const struct ethtool_ops w5300_ethtool_ops
= {
523 .get_drvinfo
= w5300_get_drvinfo
,
524 .get_msglevel
= w5300_get_msglevel
,
525 .set_msglevel
= w5300_set_msglevel
,
526 .get_link
= w5300_get_link
,
527 .get_regs_len
= w5300_get_regs_len
,
528 .get_regs
= w5300_get_regs
,
531 static const struct net_device_ops w5300_netdev_ops
= {
532 .ndo_open
= w5300_open
,
533 .ndo_stop
= w5300_stop
,
534 .ndo_start_xmit
= w5300_start_tx
,
535 .ndo_tx_timeout
= w5300_tx_timeout
,
536 .ndo_set_rx_mode
= w5300_set_rx_mode
,
537 .ndo_set_mac_address
= w5300_set_macaddr
,
538 .ndo_validate_addr
= eth_validate_addr
,
539 .ndo_change_mtu
= eth_change_mtu
,
542 static int w5300_hw_probe(struct platform_device
*pdev
)
544 struct wiznet_platform_data
*data
= dev_get_platdata(&pdev
->dev
);
545 struct net_device
*ndev
= platform_get_drvdata(pdev
);
546 struct w5300_priv
*priv
= netdev_priv(ndev
);
547 const char *name
= netdev_name(ndev
);
548 struct resource
*mem
;
553 if (data
&& is_valid_ether_addr(data
->mac_addr
)) {
554 memcpy(ndev
->dev_addr
, data
->mac_addr
, ETH_ALEN
);
556 eth_hw_addr_random(ndev
);
559 mem
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
560 priv
->base
= devm_ioremap_resource(&pdev
->dev
, mem
);
561 if (IS_ERR(priv
->base
))
562 return PTR_ERR(priv
->base
);
564 mem_size
= resource_size(mem
);
566 spin_lock_init(&priv
->reg_lock
);
567 priv
->indirect
= mem_size
< W5300_BUS_DIRECT_SIZE
;
568 if (priv
->indirect
) {
569 priv
->read
= w5300_read_indirect
;
570 priv
->write
= w5300_write_indirect
;
572 priv
->read
= w5300_read_direct
;
573 priv
->write
= w5300_write_direct
;
576 w5300_hw_reset(priv
);
577 if (w5300_read(priv
, W5300_IDR
) != IDR_W5300
)
580 irq
= platform_get_irq(pdev
, 0);
583 ret
= request_irq(irq
, w5300_interrupt
,
584 IRQ_TYPE_LEVEL_LOW
, name
, ndev
);
589 priv
->link_gpio
= data
? data
->link_gpio
: -EINVAL
;
590 if (gpio_is_valid(priv
->link_gpio
)) {
591 char *link_name
= devm_kzalloc(&pdev
->dev
, 16, GFP_KERNEL
);
594 snprintf(link_name
, 16, "%s-link", name
);
595 priv
->link_irq
= gpio_to_irq(priv
->link_gpio
);
596 if (request_any_context_irq(priv
->link_irq
, w5300_detect_link
,
597 IRQF_TRIGGER_RISING
| IRQF_TRIGGER_FALLING
,
598 link_name
, priv
->ndev
) < 0)
599 priv
->link_gpio
= -EINVAL
;
602 netdev_info(ndev
, "at 0x%llx irq %d\n", (u64
)mem
->start
, irq
);
606 static int w5300_probe(struct platform_device
*pdev
)
608 struct w5300_priv
*priv
;
609 struct net_device
*ndev
;
612 ndev
= alloc_etherdev(sizeof(*priv
));
615 SET_NETDEV_DEV(ndev
, &pdev
->dev
);
616 platform_set_drvdata(pdev
, ndev
);
617 priv
= netdev_priv(ndev
);
620 ndev
->netdev_ops
= &w5300_netdev_ops
;
621 ndev
->ethtool_ops
= &w5300_ethtool_ops
;
622 ndev
->watchdog_timeo
= HZ
;
623 netif_napi_add(ndev
, &priv
->napi
, w5300_napi_poll
, 16);
625 /* This chip doesn't support VLAN packets with normal MTU,
626 * so disable VLAN for this device.
628 ndev
->features
|= NETIF_F_VLAN_CHALLENGED
;
630 err
= register_netdev(ndev
);
634 err
= w5300_hw_probe(pdev
);
641 unregister_netdev(ndev
);
647 static int w5300_remove(struct platform_device
*pdev
)
649 struct net_device
*ndev
= platform_get_drvdata(pdev
);
650 struct w5300_priv
*priv
= netdev_priv(ndev
);
652 w5300_hw_reset(priv
);
653 free_irq(priv
->irq
, ndev
);
654 if (gpio_is_valid(priv
->link_gpio
))
655 free_irq(priv
->link_irq
, ndev
);
657 unregister_netdev(ndev
);
662 #ifdef CONFIG_PM_SLEEP
663 static int w5300_suspend(struct device
*dev
)
665 struct platform_device
*pdev
= to_platform_device(dev
);
666 struct net_device
*ndev
= platform_get_drvdata(pdev
);
667 struct w5300_priv
*priv
= netdev_priv(ndev
);
669 if (netif_running(ndev
)) {
670 netif_carrier_off(ndev
);
671 netif_device_detach(ndev
);
673 w5300_hw_close(priv
);
678 static int w5300_resume(struct device
*dev
)
680 struct platform_device
*pdev
= to_platform_device(dev
);
681 struct net_device
*ndev
= platform_get_drvdata(pdev
);
682 struct w5300_priv
*priv
= netdev_priv(ndev
);
684 if (!netif_running(ndev
)) {
685 w5300_hw_reset(priv
);
686 w5300_hw_start(priv
);
688 netif_device_attach(ndev
);
689 if (!gpio_is_valid(priv
->link_gpio
) ||
690 gpio_get_value(priv
->link_gpio
) != 0)
691 netif_carrier_on(ndev
);
695 #endif /* CONFIG_PM_SLEEP */
697 static SIMPLE_DEV_PM_OPS(w5300_pm_ops
, w5300_suspend
, w5300_resume
);
699 static struct platform_driver w5300_driver
= {
704 .probe
= w5300_probe
,
705 .remove
= w5300_remove
,
708 module_platform_driver(w5300_driver
);