2 * Microchip ENCX24J600 ethernet driver
4 * Copyright (C) 2015 Gridpoint
5 * Author: Jon Ringle <jringle@gridpoint.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
14 #include <linux/device.h>
15 #include <linux/errno.h>
16 #include <linux/etherdevice.h>
17 #include <linux/ethtool.h>
18 #include <linux/interrupt.h>
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/netdevice.h>
22 #include <linux/regmap.h>
23 #include <linux/skbuff.h>
24 #include <linux/spi/spi.h>
26 #include "encx24j600_hw.h"
28 #define DRV_NAME "encx24j600"
29 #define DRV_VERSION "1.0"
31 #define DEFAULT_MSG_ENABLE (NETIF_MSG_DRV | NETIF_MSG_PROBE | NETIF_MSG_LINK)
32 static int debug
= -1;
33 module_param(debug
, int, 0);
34 MODULE_PARM_DESC(debug
, "Debug level (0=none,...,16=all)");
36 /* SRAM memory layout:
38 * 0x0000-0x05ff TX buffers 1.5KB (1*1536) reside in the GP area in SRAM
39 * 0x0600-0x5fff RX buffers 22.5KB (15*1536) reside in the RX area in SRAM
41 #define ENC_TX_BUF_START 0x0000U
42 #define ENC_RX_BUF_START 0x0600U
43 #define ENC_RX_BUF_END 0x5fffU
44 #define ENC_SRAM_SIZE 0x6000U
52 struct encx24j600_priv
{
53 struct net_device
*ndev
;
54 struct mutex lock
; /* device access lock */
55 struct encx24j600_context ctx
;
56 struct sk_buff
*tx_skb
;
57 struct task_struct
*kworker_task
;
58 struct kthread_worker kworker
;
59 struct kthread_work tx_work
;
60 struct kthread_work setrx_work
;
70 static void dump_packet(const char *msg
, int len
, const char *data
)
72 pr_debug(DRV_NAME
": %s - packet len:%d\n", msg
, len
);
73 print_hex_dump_bytes("pk data: ", DUMP_PREFIX_OFFSET
, data
, len
);
76 static void encx24j600_dump_rsv(struct encx24j600_priv
*priv
, const char *msg
,
79 struct net_device
*dev
= priv
->ndev
;
81 netdev_info(dev
, "RX packet Len:%d\n", rsv
->len
);
82 netdev_dbg(dev
, "%s - NextPk: 0x%04x\n", msg
,
84 netdev_dbg(dev
, "RxOK: %d, DribbleNibble: %d\n",
85 RSV_GETBIT(rsv
->rxstat
, RSV_RXOK
),
86 RSV_GETBIT(rsv
->rxstat
, RSV_DRIBBLENIBBLE
));
87 netdev_dbg(dev
, "CRCErr:%d, LenChkErr: %d, LenOutOfRange: %d\n",
88 RSV_GETBIT(rsv
->rxstat
, RSV_CRCERROR
),
89 RSV_GETBIT(rsv
->rxstat
, RSV_LENCHECKERR
),
90 RSV_GETBIT(rsv
->rxstat
, RSV_LENOUTOFRANGE
));
91 netdev_dbg(dev
, "Multicast: %d, Broadcast: %d, LongDropEvent: %d, CarrierEvent: %d\n",
92 RSV_GETBIT(rsv
->rxstat
, RSV_RXMULTICAST
),
93 RSV_GETBIT(rsv
->rxstat
, RSV_RXBROADCAST
),
94 RSV_GETBIT(rsv
->rxstat
, RSV_RXLONGEVDROPEV
),
95 RSV_GETBIT(rsv
->rxstat
, RSV_CARRIEREV
));
96 netdev_dbg(dev
, "ControlFrame: %d, PauseFrame: %d, UnknownOp: %d, VLanTagFrame: %d\n",
97 RSV_GETBIT(rsv
->rxstat
, RSV_RXCONTROLFRAME
),
98 RSV_GETBIT(rsv
->rxstat
, RSV_RXPAUSEFRAME
),
99 RSV_GETBIT(rsv
->rxstat
, RSV_RXUNKNOWNOPCODE
),
100 RSV_GETBIT(rsv
->rxstat
, RSV_RXTYPEVLAN
));
103 static u16
encx24j600_read_reg(struct encx24j600_priv
*priv
, u8 reg
)
105 struct net_device
*dev
= priv
->ndev
;
106 unsigned int val
= 0;
107 int ret
= regmap_read(priv
->ctx
.regmap
, reg
, &val
);
109 netif_err(priv
, drv
, dev
, "%s: error %d reading reg %02x\n",
114 static void encx24j600_write_reg(struct encx24j600_priv
*priv
, u8 reg
, u16 val
)
116 struct net_device
*dev
= priv
->ndev
;
117 int ret
= regmap_write(priv
->ctx
.regmap
, reg
, val
);
119 netif_err(priv
, drv
, dev
, "%s: error %d writing reg %02x=%04x\n",
120 __func__
, ret
, reg
, val
);
123 static void encx24j600_update_reg(struct encx24j600_priv
*priv
, u8 reg
,
126 struct net_device
*dev
= priv
->ndev
;
127 int ret
= regmap_update_bits(priv
->ctx
.regmap
, reg
, mask
, val
);
129 netif_err(priv
, drv
, dev
, "%s: error %d updating reg %02x=%04x~%04x\n",
130 __func__
, ret
, reg
, val
, mask
);
133 static u16
encx24j600_read_phy(struct encx24j600_priv
*priv
, u8 reg
)
135 struct net_device
*dev
= priv
->ndev
;
136 unsigned int val
= 0;
137 int ret
= regmap_read(priv
->ctx
.phymap
, reg
, &val
);
139 netif_err(priv
, drv
, dev
, "%s: error %d reading %02x\n",
144 static void encx24j600_write_phy(struct encx24j600_priv
*priv
, u8 reg
, u16 val
)
146 struct net_device
*dev
= priv
->ndev
;
147 int ret
= regmap_write(priv
->ctx
.phymap
, reg
, val
);
149 netif_err(priv
, drv
, dev
, "%s: error %d writing reg %02x=%04x\n",
150 __func__
, ret
, reg
, val
);
153 static void encx24j600_clr_bits(struct encx24j600_priv
*priv
, u8 reg
, u16 mask
)
155 encx24j600_update_reg(priv
, reg
, mask
, 0);
158 static void encx24j600_set_bits(struct encx24j600_priv
*priv
, u8 reg
, u16 mask
)
160 encx24j600_update_reg(priv
, reg
, mask
, mask
);
163 static void encx24j600_cmd(struct encx24j600_priv
*priv
, u8 cmd
)
165 struct net_device
*dev
= priv
->ndev
;
166 int ret
= regmap_write(priv
->ctx
.regmap
, cmd
, 0);
168 netif_err(priv
, drv
, dev
, "%s: error %d with cmd %02x\n",
172 static int encx24j600_raw_read(struct encx24j600_priv
*priv
, u8 reg
, u8
*data
,
176 mutex_lock(&priv
->ctx
.mutex
);
177 ret
= regmap_encx24j600_spi_read(&priv
->ctx
, reg
, data
, count
);
178 mutex_unlock(&priv
->ctx
.mutex
);
183 static int encx24j600_raw_write(struct encx24j600_priv
*priv
, u8 reg
,
184 const u8
*data
, size_t count
)
187 mutex_lock(&priv
->ctx
.mutex
);
188 ret
= regmap_encx24j600_spi_write(&priv
->ctx
, reg
, data
, count
);
189 mutex_unlock(&priv
->ctx
.mutex
);
194 static void encx24j600_update_phcon1(struct encx24j600_priv
*priv
)
196 u16 phcon1
= encx24j600_read_phy(priv
, PHCON1
);
197 if (priv
->autoneg
== AUTONEG_ENABLE
) {
198 phcon1
|= ANEN
| RENEG
;
201 if (priv
->speed
== SPEED_100
)
206 if (priv
->full_duplex
)
211 encx24j600_write_phy(priv
, PHCON1
, phcon1
);
214 /* Waits for autonegotiation to complete. */
215 static int encx24j600_wait_for_autoneg(struct encx24j600_priv
*priv
)
217 struct net_device
*dev
= priv
->ndev
;
218 unsigned long timeout
= jiffies
+ msecs_to_jiffies(2000);
223 phstat1
= encx24j600_read_phy(priv
, PHSTAT1
);
224 while ((phstat1
& ANDONE
) == 0) {
225 if (time_after(jiffies
, timeout
)) {
228 netif_notice(priv
, drv
, dev
, "timeout waiting for autoneg done\n");
230 priv
->autoneg
= AUTONEG_DISABLE
;
231 phstat3
= encx24j600_read_phy(priv
, PHSTAT3
);
232 priv
->speed
= (phstat3
& PHY3SPD100
)
233 ? SPEED_100
: SPEED_10
;
234 priv
->full_duplex
= (phstat3
& PHY3DPX
) ? 1 : 0;
235 encx24j600_update_phcon1(priv
);
236 netif_notice(priv
, drv
, dev
, "Using parallel detection: %s/%s",
237 priv
->speed
== SPEED_100
? "100" : "10",
238 priv
->full_duplex
? "Full" : "Half");
243 phstat1
= encx24j600_read_phy(priv
, PHSTAT1
);
246 estat
= encx24j600_read_reg(priv
, ESTAT
);
247 if (estat
& PHYDPX
) {
248 encx24j600_set_bits(priv
, MACON2
, FULDPX
);
249 encx24j600_write_reg(priv
, MABBIPG
, 0x15);
251 encx24j600_clr_bits(priv
, MACON2
, FULDPX
);
252 encx24j600_write_reg(priv
, MABBIPG
, 0x12);
253 /* Max retransmittions attempt */
254 encx24j600_write_reg(priv
, MACLCON
, 0x370f);
260 /* Access the PHY to determine link status */
261 static void encx24j600_check_link_status(struct encx24j600_priv
*priv
)
263 struct net_device
*dev
= priv
->ndev
;
266 estat
= encx24j600_read_reg(priv
, ESTAT
);
268 if (estat
& PHYLNK
) {
269 if (priv
->autoneg
== AUTONEG_ENABLE
)
270 encx24j600_wait_for_autoneg(priv
);
272 netif_carrier_on(dev
);
273 netif_info(priv
, ifup
, dev
, "link up\n");
275 netif_info(priv
, ifdown
, dev
, "link down\n");
277 /* Re-enable autoneg since we won't know what we might be
278 * connected to when the link is brought back up again.
280 priv
->autoneg
= AUTONEG_ENABLE
;
281 priv
->full_duplex
= true;
282 priv
->speed
= SPEED_100
;
283 netif_carrier_off(dev
);
287 static void encx24j600_int_link_handler(struct encx24j600_priv
*priv
)
289 struct net_device
*dev
= priv
->ndev
;
291 netif_dbg(priv
, intr
, dev
, "%s", __func__
);
292 encx24j600_check_link_status(priv
);
293 encx24j600_clr_bits(priv
, EIR
, LINKIF
);
296 static void encx24j600_tx_complete(struct encx24j600_priv
*priv
, bool err
)
298 struct net_device
*dev
= priv
->ndev
;
305 mutex_lock(&priv
->lock
);
308 dev
->stats
.tx_errors
++;
310 dev
->stats
.tx_packets
++;
312 dev
->stats
.tx_bytes
+= priv
->tx_skb
->len
;
314 encx24j600_clr_bits(priv
, EIR
, TXIF
| TXABTIF
);
316 netif_dbg(priv
, tx_done
, dev
, "TX Done%s\n", err
? ": Err" : "");
318 dev_kfree_skb(priv
->tx_skb
);
321 netif_wake_queue(dev
);
323 mutex_unlock(&priv
->lock
);
326 static int encx24j600_receive_packet(struct encx24j600_priv
*priv
,
329 struct net_device
*dev
= priv
->ndev
;
330 struct sk_buff
*skb
= netdev_alloc_skb(dev
, rsv
->len
+ NET_IP_ALIGN
);
332 pr_err_ratelimited("RX: OOM: packet dropped\n");
333 dev
->stats
.rx_dropped
++;
336 skb_reserve(skb
, NET_IP_ALIGN
);
337 encx24j600_raw_read(priv
, RRXDATA
, skb_put(skb
, rsv
->len
), rsv
->len
);
339 if (netif_msg_pktdata(priv
))
340 dump_packet("RX", skb
->len
, skb
->data
);
343 skb
->protocol
= eth_type_trans(skb
, dev
);
344 skb
->ip_summed
= CHECKSUM_COMPLETE
;
347 dev
->stats
.rx_packets
++;
348 dev
->stats
.rx_bytes
+= rsv
->len
;
349 priv
->next_packet
= rsv
->next_packet
;
356 static void encx24j600_rx_packets(struct encx24j600_priv
*priv
, u8 packet_count
)
358 struct net_device
*dev
= priv
->ndev
;
360 while (packet_count
--) {
364 encx24j600_write_reg(priv
, ERXRDPT
, priv
->next_packet
);
365 encx24j600_raw_read(priv
, RRXDATA
, (u8
*)&rsv
, sizeof(rsv
));
367 if (netif_msg_rx_status(priv
))
368 encx24j600_dump_rsv(priv
, __func__
, &rsv
);
370 if (!RSV_GETBIT(rsv
.rxstat
, RSV_RXOK
) ||
371 (rsv
.len
> MAX_FRAMELEN
)) {
372 netif_err(priv
, rx_err
, dev
, "RX Error %04x\n",
374 dev
->stats
.rx_errors
++;
376 if (RSV_GETBIT(rsv
.rxstat
, RSV_CRCERROR
))
377 dev
->stats
.rx_crc_errors
++;
378 if (RSV_GETBIT(rsv
.rxstat
, RSV_LENCHECKERR
))
379 dev
->stats
.rx_frame_errors
++;
380 if (rsv
.len
> MAX_FRAMELEN
)
381 dev
->stats
.rx_over_errors
++;
383 encx24j600_receive_packet(priv
, &rsv
);
386 newrxtail
= priv
->next_packet
- 2;
387 if (newrxtail
== ENC_RX_BUF_START
)
388 newrxtail
= SRAM_SIZE
- 2;
390 encx24j600_cmd(priv
, SETPKTDEC
);
391 encx24j600_write_reg(priv
, ERXTAIL
, newrxtail
);
395 static irqreturn_t
encx24j600_isr(int irq
, void *dev_id
)
397 struct encx24j600_priv
*priv
= dev_id
;
398 struct net_device
*dev
= priv
->ndev
;
401 /* Clear interrupts */
402 encx24j600_cmd(priv
, CLREIE
);
404 eir
= encx24j600_read_reg(priv
, EIR
);
407 encx24j600_int_link_handler(priv
);
410 encx24j600_tx_complete(priv
, false);
413 encx24j600_tx_complete(priv
, true);
417 /* Packet counter is full */
418 netif_err(priv
, rx_err
, dev
, "Packet counter full\n");
420 dev
->stats
.rx_dropped
++;
421 encx24j600_clr_bits(priv
, EIR
, RXABTIF
);
427 mutex_lock(&priv
->lock
);
429 packet_count
= encx24j600_read_reg(priv
, ESTAT
) & 0xff;
430 while (packet_count
) {
431 encx24j600_rx_packets(priv
, packet_count
);
432 packet_count
= encx24j600_read_reg(priv
, ESTAT
) & 0xff;
435 mutex_unlock(&priv
->lock
);
438 /* Enable interrupts */
439 encx24j600_cmd(priv
, SETEIE
);
444 static int encx24j600_soft_reset(struct encx24j600_priv
*priv
)
450 /* Write and verify a test value to EUDAST */
451 regcache_cache_bypass(priv
->ctx
.regmap
, true);
454 encx24j600_write_reg(priv
, EUDAST
, EUDAST_TEST_VAL
);
455 eudast
= encx24j600_read_reg(priv
, EUDAST
);
456 usleep_range(25, 100);
457 } while ((eudast
!= EUDAST_TEST_VAL
) && --timeout
);
458 regcache_cache_bypass(priv
->ctx
.regmap
, false);
465 /* Wait for CLKRDY to become set */
467 while (!(encx24j600_read_reg(priv
, ESTAT
) & CLKRDY
) && --timeout
)
468 usleep_range(25, 100);
475 /* Issue a System Reset command */
476 encx24j600_cmd(priv
, SETETHRST
);
477 usleep_range(25, 100);
479 /* Confirm that EUDAST has 0000h after system reset */
480 if (encx24j600_read_reg(priv
, EUDAST
) != 0) {
485 /* Wait for PHY register and status bits to become available */
486 usleep_range(256, 1000);
492 static int encx24j600_hw_reset(struct encx24j600_priv
*priv
)
496 mutex_lock(&priv
->lock
);
497 ret
= encx24j600_soft_reset(priv
);
498 mutex_unlock(&priv
->lock
);
503 static void encx24j600_reset_hw_tx(struct encx24j600_priv
*priv
)
505 encx24j600_set_bits(priv
, ECON2
, TXRST
);
506 encx24j600_clr_bits(priv
, ECON2
, TXRST
);
509 static void encx24j600_hw_init_tx(struct encx24j600_priv
*priv
)
512 encx24j600_reset_hw_tx(priv
);
514 /* Clear the TXIF flag if were previously set */
515 encx24j600_clr_bits(priv
, EIR
, TXIF
| TXABTIF
);
517 /* Write the Tx Buffer pointer */
518 encx24j600_write_reg(priv
, EGPWRPT
, ENC_TX_BUF_START
);
521 static void encx24j600_hw_init_rx(struct encx24j600_priv
*priv
)
523 encx24j600_cmd(priv
, DISABLERX
);
525 /* Set up RX packet start address in the SRAM */
526 encx24j600_write_reg(priv
, ERXST
, ENC_RX_BUF_START
);
528 /* Preload the RX Data pointer to the beginning of the RX area */
529 encx24j600_write_reg(priv
, ERXRDPT
, ENC_RX_BUF_START
);
531 priv
->next_packet
= ENC_RX_BUF_START
;
533 /* Set up RX end address in the SRAM */
534 encx24j600_write_reg(priv
, ERXTAIL
, ENC_SRAM_SIZE
- 2);
536 /* Reset the user data pointers */
537 encx24j600_write_reg(priv
, EUDAST
, ENC_SRAM_SIZE
);
538 encx24j600_write_reg(priv
, EUDAND
, ENC_SRAM_SIZE
+ 1);
540 /* Set Max Frame length */
541 encx24j600_write_reg(priv
, MAMXFL
, MAX_FRAMELEN
);
544 static void encx24j600_dump_config(struct encx24j600_priv
*priv
,
547 pr_info(DRV_NAME
": %s\n", msg
);
549 /* CHIP configuration */
550 pr_info(DRV_NAME
" ECON1: %04X\n", encx24j600_read_reg(priv
, ECON1
));
551 pr_info(DRV_NAME
" ECON2: %04X\n", encx24j600_read_reg(priv
, ECON2
));
552 pr_info(DRV_NAME
" ERXFCON: %04X\n", encx24j600_read_reg(priv
,
554 pr_info(DRV_NAME
" ESTAT: %04X\n", encx24j600_read_reg(priv
, ESTAT
));
555 pr_info(DRV_NAME
" EIR: %04X\n", encx24j600_read_reg(priv
, EIR
));
556 pr_info(DRV_NAME
" EIDLED: %04X\n", encx24j600_read_reg(priv
, EIDLED
));
558 /* MAC layer configuration */
559 pr_info(DRV_NAME
" MACON1: %04X\n", encx24j600_read_reg(priv
, MACON1
));
560 pr_info(DRV_NAME
" MACON2: %04X\n", encx24j600_read_reg(priv
, MACON2
));
561 pr_info(DRV_NAME
" MAIPG: %04X\n", encx24j600_read_reg(priv
, MAIPG
));
562 pr_info(DRV_NAME
" MACLCON: %04X\n", encx24j600_read_reg(priv
,
564 pr_info(DRV_NAME
" MABBIPG: %04X\n", encx24j600_read_reg(priv
,
567 /* PHY configuation */
568 pr_info(DRV_NAME
" PHCON1: %04X\n", encx24j600_read_phy(priv
, PHCON1
));
569 pr_info(DRV_NAME
" PHCON2: %04X\n", encx24j600_read_phy(priv
, PHCON2
));
570 pr_info(DRV_NAME
" PHANA: %04X\n", encx24j600_read_phy(priv
, PHANA
));
571 pr_info(DRV_NAME
" PHANLPA: %04X\n", encx24j600_read_phy(priv
,
573 pr_info(DRV_NAME
" PHANE: %04X\n", encx24j600_read_phy(priv
, PHANE
));
574 pr_info(DRV_NAME
" PHSTAT1: %04X\n", encx24j600_read_phy(priv
,
576 pr_info(DRV_NAME
" PHSTAT2: %04X\n", encx24j600_read_phy(priv
,
578 pr_info(DRV_NAME
" PHSTAT3: %04X\n", encx24j600_read_phy(priv
,
582 static void encx24j600_set_rxfilter_mode(struct encx24j600_priv
*priv
)
584 switch (priv
->rxfilter
) {
585 case RXFILTER_PROMISC
:
586 encx24j600_set_bits(priv
, MACON1
, PASSALL
);
587 encx24j600_write_reg(priv
, ERXFCON
, UCEN
| MCEN
| NOTMEEN
);
590 encx24j600_clr_bits(priv
, MACON1
, PASSALL
);
591 encx24j600_write_reg(priv
, ERXFCON
, UCEN
| CRCEN
| BCEN
| MCEN
);
593 case RXFILTER_NORMAL
:
595 encx24j600_clr_bits(priv
, MACON1
, PASSALL
);
596 encx24j600_write_reg(priv
, ERXFCON
, UCEN
| CRCEN
| BCEN
);
601 static int encx24j600_hw_init(struct encx24j600_priv
*priv
)
606 priv
->hw_enabled
= false;
608 /* PHY Leds: link status,
609 * LEDA: Link State + collision events
610 * LEDB: Link State + transmit/receive events
612 encx24j600_update_reg(priv
, EIDLED
, 0xff00, 0xcb00);
614 /* Loopback disabled */
615 encx24j600_write_reg(priv
, MACON1
, 0x9);
617 /* interpacket gap value */
618 encx24j600_write_reg(priv
, MAIPG
, 0x0c12);
620 /* Write the auto negotiation pattern */
621 encx24j600_write_phy(priv
, PHANA
, PHANA_DEFAULT
);
623 encx24j600_update_phcon1(priv
);
624 encx24j600_check_link_status(priv
);
626 macon2
= MACON2_RSV1
| TXCRCEN
| PADCFG0
| PADCFG2
| MACON2_DEFER
;
627 if ((priv
->autoneg
== AUTONEG_DISABLE
) && priv
->full_duplex
)
630 encx24j600_set_bits(priv
, MACON2
, macon2
);
632 priv
->rxfilter
= RXFILTER_NORMAL
;
633 encx24j600_set_rxfilter_mode(priv
);
635 /* Program the Maximum frame length */
636 encx24j600_write_reg(priv
, MAMXFL
, MAX_FRAMELEN
);
638 /* Init Tx pointers */
639 encx24j600_hw_init_tx(priv
);
641 /* Init Rx pointers */
642 encx24j600_hw_init_rx(priv
);
644 if (netif_msg_hw(priv
))
645 encx24j600_dump_config(priv
, "Hw is initialized");
650 static void encx24j600_hw_enable(struct encx24j600_priv
*priv
)
652 /* Clear the interrupt flags in case was set */
653 encx24j600_clr_bits(priv
, EIR
, (PCFULIF
| RXABTIF
| TXABTIF
| TXIF
|
656 /* Enable the interrupts */
657 encx24j600_write_reg(priv
, EIE
, (PCFULIE
| RXABTIE
| TXABTIE
| TXIE
|
658 PKTIE
| LINKIE
| INTIE
));
661 encx24j600_cmd(priv
, ENABLERX
);
663 priv
->hw_enabled
= true;
666 static void encx24j600_hw_disable(struct encx24j600_priv
*priv
)
668 /* Disable all interrupts */
669 encx24j600_write_reg(priv
, EIE
, 0);
672 encx24j600_cmd(priv
, DISABLERX
);
674 priv
->hw_enabled
= false;
677 static int encx24j600_setlink(struct net_device
*dev
, u8 autoneg
, u16 speed
,
680 struct encx24j600_priv
*priv
= netdev_priv(dev
);
683 if (!priv
->hw_enabled
) {
684 /* link is in low power mode now; duplex setting
685 * will take effect on next encx24j600_hw_init()
687 if (speed
== SPEED_10
|| speed
== SPEED_100
) {
688 priv
->autoneg
= (autoneg
== AUTONEG_ENABLE
);
689 priv
->full_duplex
= (duplex
== DUPLEX_FULL
);
690 priv
->speed
= (speed
== SPEED_100
);
692 netif_warn(priv
, link
, dev
, "unsupported link speed setting\n");
693 /*speeds other than SPEED_10 and SPEED_100 */
694 /*are not supported by chip */
698 netif_warn(priv
, link
, dev
, "Warning: hw must be disabled to set link mode\n");
704 static void encx24j600_hw_get_macaddr(struct encx24j600_priv
*priv
,
705 unsigned char *ethaddr
)
709 val
= encx24j600_read_reg(priv
, MAADR1
);
711 ethaddr
[0] = val
& 0x00ff;
712 ethaddr
[1] = (val
& 0xff00) >> 8;
714 val
= encx24j600_read_reg(priv
, MAADR2
);
716 ethaddr
[2] = val
& 0x00ffU
;
717 ethaddr
[3] = (val
& 0xff00U
) >> 8;
719 val
= encx24j600_read_reg(priv
, MAADR3
);
721 ethaddr
[4] = val
& 0x00ffU
;
722 ethaddr
[5] = (val
& 0xff00U
) >> 8;
725 /* Program the hardware MAC address from dev->dev_addr.*/
726 static int encx24j600_set_hw_macaddr(struct net_device
*dev
)
728 struct encx24j600_priv
*priv
= netdev_priv(dev
);
730 if (priv
->hw_enabled
) {
731 netif_info(priv
, drv
, dev
, "Hardware must be disabled to set Mac address\n");
735 mutex_lock(&priv
->lock
);
737 netif_info(priv
, drv
, dev
, "%s: Setting MAC address to %pM\n",
738 dev
->name
, dev
->dev_addr
);
740 encx24j600_write_reg(priv
, MAADR3
, (dev
->dev_addr
[4] |
741 dev
->dev_addr
[5] << 8));
742 encx24j600_write_reg(priv
, MAADR2
, (dev
->dev_addr
[2] |
743 dev
->dev_addr
[3] << 8));
744 encx24j600_write_reg(priv
, MAADR1
, (dev
->dev_addr
[0] |
745 dev
->dev_addr
[1] << 8));
747 mutex_unlock(&priv
->lock
);
752 /* Store the new hardware address in dev->dev_addr, and update the MAC.*/
753 static int encx24j600_set_mac_address(struct net_device
*dev
, void *addr
)
755 struct sockaddr
*address
= addr
;
757 if (netif_running(dev
))
759 if (!is_valid_ether_addr(address
->sa_data
))
760 return -EADDRNOTAVAIL
;
762 memcpy(dev
->dev_addr
, address
->sa_data
, dev
->addr_len
);
763 return encx24j600_set_hw_macaddr(dev
);
766 static int encx24j600_open(struct net_device
*dev
)
768 struct encx24j600_priv
*priv
= netdev_priv(dev
);
770 int ret
= request_threaded_irq(priv
->ctx
.spi
->irq
, NULL
, encx24j600_isr
,
771 IRQF_TRIGGER_FALLING
| IRQF_ONESHOT
,
773 if (unlikely(ret
< 0)) {
774 netdev_err(dev
, "request irq %d failed (ret = %d)\n",
775 priv
->ctx
.spi
->irq
, ret
);
779 encx24j600_hw_disable(priv
);
780 encx24j600_hw_init(priv
);
781 encx24j600_hw_enable(priv
);
782 netif_start_queue(dev
);
787 static int encx24j600_stop(struct net_device
*dev
)
789 struct encx24j600_priv
*priv
= netdev_priv(dev
);
791 netif_stop_queue(dev
);
792 free_irq(priv
->ctx
.spi
->irq
, priv
);
796 static void encx24j600_setrx_proc(struct kthread_work
*ws
)
798 struct encx24j600_priv
*priv
=
799 container_of(ws
, struct encx24j600_priv
, setrx_work
);
801 mutex_lock(&priv
->lock
);
802 encx24j600_set_rxfilter_mode(priv
);
803 mutex_unlock(&priv
->lock
);
806 static void encx24j600_set_multicast_list(struct net_device
*dev
)
808 struct encx24j600_priv
*priv
= netdev_priv(dev
);
809 int oldfilter
= priv
->rxfilter
;
811 if (dev
->flags
& IFF_PROMISC
) {
812 netif_dbg(priv
, link
, dev
, "promiscuous mode\n");
813 priv
->rxfilter
= RXFILTER_PROMISC
;
814 } else if ((dev
->flags
& IFF_ALLMULTI
) || !netdev_mc_empty(dev
)) {
815 netif_dbg(priv
, link
, dev
, "%smulticast mode\n",
816 (dev
->flags
& IFF_ALLMULTI
) ? "all-" : "");
817 priv
->rxfilter
= RXFILTER_MULTI
;
819 netif_dbg(priv
, link
, dev
, "normal mode\n");
820 priv
->rxfilter
= RXFILTER_NORMAL
;
823 if (oldfilter
!= priv
->rxfilter
)
824 queue_kthread_work(&priv
->kworker
, &priv
->setrx_work
);
827 static void encx24j600_hw_tx(struct encx24j600_priv
*priv
)
829 struct net_device
*dev
= priv
->ndev
;
830 netif_info(priv
, tx_queued
, dev
, "TX Packet Len:%d\n",
833 if (netif_msg_pktdata(priv
))
834 dump_packet("TX", priv
->tx_skb
->len
, priv
->tx_skb
->data
);
836 if (encx24j600_read_reg(priv
, EIR
) & TXABTIF
)
837 /* Last transmition aborted due to error. Reset TX interface */
838 encx24j600_reset_hw_tx(priv
);
840 /* Clear the TXIF flag if were previously set */
841 encx24j600_clr_bits(priv
, EIR
, TXIF
);
843 /* Set the data pointer to the TX buffer address in the SRAM */
844 encx24j600_write_reg(priv
, EGPWRPT
, ENC_TX_BUF_START
);
846 /* Copy the packet into the SRAM */
847 encx24j600_raw_write(priv
, WGPDATA
, (u8
*)priv
->tx_skb
->data
,
850 /* Program the Tx buffer start pointer */
851 encx24j600_write_reg(priv
, ETXST
, ENC_TX_BUF_START
);
853 /* Program the packet length */
854 encx24j600_write_reg(priv
, ETXLEN
, priv
->tx_skb
->len
);
856 /* Start the transmission */
857 encx24j600_cmd(priv
, SETTXRTS
);
860 static void encx24j600_tx_proc(struct kthread_work
*ws
)
862 struct encx24j600_priv
*priv
=
863 container_of(ws
, struct encx24j600_priv
, tx_work
);
865 mutex_lock(&priv
->lock
);
866 encx24j600_hw_tx(priv
);
867 mutex_unlock(&priv
->lock
);
870 static netdev_tx_t
encx24j600_tx(struct sk_buff
*skb
, struct net_device
*dev
)
872 struct encx24j600_priv
*priv
= netdev_priv(dev
);
874 netif_stop_queue(dev
);
876 /* save the timestamp */
877 netif_trans_update(dev
);
879 /* Remember the skb for deferred processing */
882 queue_kthread_work(&priv
->kworker
, &priv
->tx_work
);
887 /* Deal with a transmit timeout */
888 static void encx24j600_tx_timeout(struct net_device
*dev
)
890 struct encx24j600_priv
*priv
= netdev_priv(dev
);
892 netif_err(priv
, tx_err
, dev
, "TX timeout at %ld, latency %ld\n",
893 jiffies
, jiffies
- dev_trans_start(dev
));
895 dev
->stats
.tx_errors
++;
896 netif_wake_queue(dev
);
900 static int encx24j600_get_regs_len(struct net_device
*dev
)
902 return SFR_REG_COUNT
;
905 static void encx24j600_get_regs(struct net_device
*dev
,
906 struct ethtool_regs
*regs
, void *p
)
908 struct encx24j600_priv
*priv
= netdev_priv(dev
);
913 mutex_lock(&priv
->lock
);
914 for (reg
= 0; reg
< SFR_REG_COUNT
; reg
+= 2) {
915 unsigned int val
= 0;
916 /* ignore errors for unreadable registers */
917 regmap_read(priv
->ctx
.regmap
, reg
, &val
);
918 buff
[reg
] = val
& 0xffff;
920 mutex_unlock(&priv
->lock
);
923 static void encx24j600_get_drvinfo(struct net_device
*dev
,
924 struct ethtool_drvinfo
*info
)
926 strlcpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
927 strlcpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
928 strlcpy(info
->bus_info
, dev_name(dev
->dev
.parent
),
929 sizeof(info
->bus_info
));
932 static int encx24j600_get_settings(struct net_device
*dev
,
933 struct ethtool_cmd
*cmd
)
935 struct encx24j600_priv
*priv
= netdev_priv(dev
);
937 cmd
->transceiver
= XCVR_INTERNAL
;
938 cmd
->supported
= SUPPORTED_10baseT_Half
| SUPPORTED_10baseT_Full
|
939 SUPPORTED_100baseT_Half
| SUPPORTED_100baseT_Full
|
940 SUPPORTED_Autoneg
| SUPPORTED_TP
;
942 ethtool_cmd_speed_set(cmd
, priv
->speed
);
943 cmd
->duplex
= priv
->full_duplex
? DUPLEX_FULL
: DUPLEX_HALF
;
945 cmd
->autoneg
= priv
->autoneg
? AUTONEG_ENABLE
: AUTONEG_DISABLE
;
950 static int encx24j600_set_settings(struct net_device
*dev
,
951 struct ethtool_cmd
*cmd
)
953 return encx24j600_setlink(dev
, cmd
->autoneg
,
954 ethtool_cmd_speed(cmd
), cmd
->duplex
);
957 static u32
encx24j600_get_msglevel(struct net_device
*dev
)
959 struct encx24j600_priv
*priv
= netdev_priv(dev
);
960 return priv
->msg_enable
;
963 static void encx24j600_set_msglevel(struct net_device
*dev
, u32 val
)
965 struct encx24j600_priv
*priv
= netdev_priv(dev
);
966 priv
->msg_enable
= val
;
969 static const struct ethtool_ops encx24j600_ethtool_ops
= {
970 .get_settings
= encx24j600_get_settings
,
971 .set_settings
= encx24j600_set_settings
,
972 .get_drvinfo
= encx24j600_get_drvinfo
,
973 .get_msglevel
= encx24j600_get_msglevel
,
974 .set_msglevel
= encx24j600_set_msglevel
,
975 .get_regs_len
= encx24j600_get_regs_len
,
976 .get_regs
= encx24j600_get_regs
,
979 static const struct net_device_ops encx24j600_netdev_ops
= {
980 .ndo_open
= encx24j600_open
,
981 .ndo_stop
= encx24j600_stop
,
982 .ndo_start_xmit
= encx24j600_tx
,
983 .ndo_set_rx_mode
= encx24j600_set_multicast_list
,
984 .ndo_set_mac_address
= encx24j600_set_mac_address
,
985 .ndo_tx_timeout
= encx24j600_tx_timeout
,
986 .ndo_validate_addr
= eth_validate_addr
,
989 static int encx24j600_spi_probe(struct spi_device
*spi
)
993 struct net_device
*ndev
;
994 struct encx24j600_priv
*priv
;
997 ndev
= alloc_etherdev(sizeof(struct encx24j600_priv
));
1004 priv
= netdev_priv(ndev
);
1005 spi_set_drvdata(spi
, priv
);
1006 dev_set_drvdata(&spi
->dev
, priv
);
1007 SET_NETDEV_DEV(ndev
, &spi
->dev
);
1009 priv
->msg_enable
= netif_msg_init(debug
, DEFAULT_MSG_ENABLE
);
1012 /* Default configuration PHY configuration */
1013 priv
->full_duplex
= true;
1014 priv
->autoneg
= AUTONEG_ENABLE
;
1015 priv
->speed
= SPEED_100
;
1017 priv
->ctx
.spi
= spi
;
1018 devm_regmap_init_encx24j600(&spi
->dev
, &priv
->ctx
);
1019 ndev
->irq
= spi
->irq
;
1020 ndev
->netdev_ops
= &encx24j600_netdev_ops
;
1022 mutex_init(&priv
->lock
);
1024 /* Reset device and check if it is connected */
1025 if (encx24j600_hw_reset(priv
)) {
1026 netif_err(priv
, probe
, ndev
,
1027 DRV_NAME
": Chip is not detected\n");
1032 /* Initialize the device HW to the consistent state */
1033 if (encx24j600_hw_init(priv
)) {
1034 netif_err(priv
, probe
, ndev
,
1035 DRV_NAME
": HW initialization error\n");
1040 init_kthread_worker(&priv
->kworker
);
1041 init_kthread_work(&priv
->tx_work
, encx24j600_tx_proc
);
1042 init_kthread_work(&priv
->setrx_work
, encx24j600_setrx_proc
);
1044 priv
->kworker_task
= kthread_run(kthread_worker_fn
, &priv
->kworker
,
1047 if (IS_ERR(priv
->kworker_task
)) {
1048 ret
= PTR_ERR(priv
->kworker_task
);
1052 /* Get the MAC address from the chip */
1053 encx24j600_hw_get_macaddr(priv
, ndev
->dev_addr
);
1055 ndev
->ethtool_ops
= &encx24j600_ethtool_ops
;
1057 ret
= register_netdev(ndev
);
1058 if (unlikely(ret
)) {
1059 netif_err(priv
, probe
, ndev
, "Error %d initializing card encx24j600 card\n",
1064 eidled
= encx24j600_read_reg(priv
, EIDLED
);
1065 if (((eidled
& DEVID_MASK
) >> DEVID_SHIFT
) != ENCX24J600_DEV_ID
) {
1067 goto out_unregister
;
1070 netif_info(priv
, probe
, ndev
, "Silicon rev ID: 0x%02x\n",
1071 (eidled
& REVID_MASK
) >> REVID_SHIFT
);
1073 netif_info(priv
, drv
, priv
->ndev
, "MAC address %pM\n", ndev
->dev_addr
);
1078 unregister_netdev(priv
->ndev
);
1086 static int encx24j600_spi_remove(struct spi_device
*spi
)
1088 struct encx24j600_priv
*priv
= dev_get_drvdata(&spi
->dev
);
1090 unregister_netdev(priv
->ndev
);
1092 free_netdev(priv
->ndev
);
1097 static const struct spi_device_id encx24j600_spi_id_table
[] = {
1098 { .name
= "encx24j600" },
1101 MODULE_DEVICE_TABLE(spi
, encx24j600_spi_id_table
);
1103 static struct spi_driver encx24j600_spi_net_driver
= {
1106 .owner
= THIS_MODULE
,
1107 .bus
= &spi_bus_type
,
1109 .probe
= encx24j600_spi_probe
,
1110 .remove
= encx24j600_spi_remove
,
1111 .id_table
= encx24j600_spi_id_table
,
1114 static int __init
encx24j600_init(void)
1116 return spi_register_driver(&encx24j600_spi_net_driver
);
1118 module_init(encx24j600_init
);
1120 static void encx24j600_exit(void)
1122 spi_unregister_driver(&encx24j600_spi_net_driver
);
1124 module_exit(encx24j600_exit
);
1126 MODULE_DESCRIPTION(DRV_NAME
" ethernet driver");
1127 MODULE_AUTHOR("Jon Ringle <jringle@gridpoint.com>");
1128 MODULE_LICENSE("GPL");
1129 MODULE_ALIAS("spi:" DRV_NAME
);