2 * Copyright(c) 2015 EZchip Technologies.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
17 #include <linux/module.h>
18 #include <linux/etherdevice.h>
19 #include <linux/of_address.h>
20 #include <linux/of_irq.h>
21 #include <linux/of_net.h>
22 #include <linux/of_platform.h>
25 #define DRV_NAME "nps_mgt_enet"
27 static void nps_enet_clean_rx_fifo(struct net_device
*ndev
, u32 frame_len
)
29 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
30 u32 i
, len
= DIV_ROUND_UP(frame_len
, sizeof(u32
));
32 /* Empty Rx FIFO buffer by reading all words */
33 for (i
= 0; i
< len
; i
++)
34 nps_enet_reg_get(priv
, NPS_ENET_REG_RX_BUF
);
37 static void nps_enet_read_rx_fifo(struct net_device
*ndev
,
38 unsigned char *dst
, u32 length
)
40 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
41 s32 i
, last
= length
& (sizeof(u32
) - 1);
42 u32
*reg
= (u32
*)dst
, len
= length
/ sizeof(u32
);
43 bool dst_is_aligned
= IS_ALIGNED((unsigned long)dst
, sizeof(u32
));
45 /* In case dst is not aligned we need an intermediate buffer */
47 for (i
= 0; i
< len
; i
++, reg
++)
48 *reg
= nps_enet_reg_get(priv
, NPS_ENET_REG_RX_BUF
);
49 else { /* !dst_is_aligned */
50 for (i
= 0; i
< len
; i
++, reg
++) {
52 nps_enet_reg_get(priv
, NPS_ENET_REG_RX_BUF
);
54 /* to accommodate word-unaligned address of "reg"
55 * we have to do memcpy_toio() instead of simple "=".
57 memcpy_toio((void __iomem
*)reg
, &buf
, sizeof(buf
));
61 /* copy last bytes (if any) */
63 u32 buf
= nps_enet_reg_get(priv
, NPS_ENET_REG_RX_BUF
);
65 memcpy_toio((void __iomem
*)reg
, &buf
, last
);
69 static u32
nps_enet_rx_handler(struct net_device
*ndev
)
71 u32 frame_len
, err
= 0;
73 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
75 struct nps_enet_rx_ctl rx_ctrl
;
77 rx_ctrl
.value
= nps_enet_reg_get(priv
, NPS_ENET_REG_RX_CTL
);
78 frame_len
= rx_ctrl
.nr
;
80 /* Check if we got RX */
84 /* If we got here there is a work for us */
89 ndev
->stats
.rx_errors
++;
93 /* Check Rx CRC error */
95 ndev
->stats
.rx_crc_errors
++;
96 ndev
->stats
.rx_dropped
++;
100 /* Check Frame length Min 64b */
101 if (unlikely(frame_len
< ETH_ZLEN
)) {
102 ndev
->stats
.rx_length_errors
++;
103 ndev
->stats
.rx_dropped
++;
111 skb
= netdev_alloc_skb_ip_align(ndev
, frame_len
);
112 if (unlikely(!skb
)) {
113 ndev
->stats
.rx_errors
++;
114 ndev
->stats
.rx_dropped
++;
118 /* Copy frame from Rx fifo into the skb */
119 nps_enet_read_rx_fifo(ndev
, skb
->data
, frame_len
);
121 skb_put(skb
, frame_len
);
122 skb
->protocol
= eth_type_trans(skb
, ndev
);
123 skb
->ip_summed
= CHECKSUM_UNNECESSARY
;
125 ndev
->stats
.rx_packets
++;
126 ndev
->stats
.rx_bytes
+= frame_len
;
127 netif_receive_skb(skb
);
129 goto rx_irq_frame_done
;
133 nps_enet_clean_rx_fifo(ndev
, frame_len
);
136 /* Ack Rx ctrl register */
137 nps_enet_reg_set(priv
, NPS_ENET_REG_RX_CTL
, 0);
142 static void nps_enet_tx_handler(struct net_device
*ndev
)
144 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
145 struct nps_enet_tx_ctl tx_ctrl
;
147 tx_ctrl
.value
= nps_enet_reg_get(priv
, NPS_ENET_REG_TX_CTL
);
149 /* Check if we got TX */
150 if (!priv
->tx_packet_sent
|| tx_ctrl
.ct
)
153 /* Check Tx transmit error */
154 if (unlikely(tx_ctrl
.et
)) {
155 ndev
->stats
.tx_errors
++;
157 ndev
->stats
.tx_packets
++;
158 ndev
->stats
.tx_bytes
+= tx_ctrl
.nt
;
162 dev_kfree_skb(priv
->tx_skb
);
166 priv
->tx_packet_sent
= false;
168 if (netif_queue_stopped(ndev
))
169 netif_wake_queue(ndev
);
173 * nps_enet_poll - NAPI poll handler.
174 * @napi: Pointer to napi_struct structure.
175 * @budget: How many frames to process on one call.
177 * returns: Number of processed frames
179 static int nps_enet_poll(struct napi_struct
*napi
, int budget
)
181 struct net_device
*ndev
= napi
->dev
;
182 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
183 struct nps_enet_buf_int_enable buf_int_enable
;
186 buf_int_enable
.rx_rdy
= NPS_ENET_ENABLE
;
187 buf_int_enable
.tx_done
= NPS_ENET_ENABLE
;
188 nps_enet_tx_handler(ndev
);
189 work_done
= nps_enet_rx_handler(ndev
);
190 if (work_done
< budget
) {
192 nps_enet_reg_set(priv
, NPS_ENET_REG_BUF_INT_ENABLE
,
193 buf_int_enable
.value
);
200 * nps_enet_irq_handler - Global interrupt handler for ENET.
202 * @dev_instance: device instance.
204 * returns: IRQ_HANDLED for all cases.
206 * EZchip ENET has 2 interrupt causes, and depending on bits raised in
207 * CTRL registers we may tell what is a reason for interrupt to fire up.
208 * We got one for RX and the other for TX (completion).
210 static irqreturn_t
nps_enet_irq_handler(s32 irq
, void *dev_instance
)
212 struct net_device
*ndev
= dev_instance
;
213 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
214 struct nps_enet_rx_ctl rx_ctrl
;
215 struct nps_enet_tx_ctl tx_ctrl
;
217 rx_ctrl
.value
= nps_enet_reg_get(priv
, NPS_ENET_REG_RX_CTL
);
218 tx_ctrl
.value
= nps_enet_reg_get(priv
, NPS_ENET_REG_TX_CTL
);
220 if ((!tx_ctrl
.ct
&& priv
->tx_packet_sent
) || rx_ctrl
.cr
)
221 if (likely(napi_schedule_prep(&priv
->napi
))) {
222 nps_enet_reg_set(priv
, NPS_ENET_REG_BUF_INT_ENABLE
, 0);
223 __napi_schedule(&priv
->napi
);
229 static void nps_enet_set_hw_mac_address(struct net_device
*ndev
)
231 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
232 struct nps_enet_ge_mac_cfg_1 ge_mac_cfg_1
;
233 struct nps_enet_ge_mac_cfg_2
*ge_mac_cfg_2
= &priv
->ge_mac_cfg_2
;
235 /* set MAC address in HW */
236 ge_mac_cfg_1
.octet_0
= ndev
->dev_addr
[0];
237 ge_mac_cfg_1
.octet_1
= ndev
->dev_addr
[1];
238 ge_mac_cfg_1
.octet_2
= ndev
->dev_addr
[2];
239 ge_mac_cfg_1
.octet_3
= ndev
->dev_addr
[3];
240 ge_mac_cfg_2
->octet_4
= ndev
->dev_addr
[4];
241 ge_mac_cfg_2
->octet_5
= ndev
->dev_addr
[5];
243 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_1
,
246 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_2
,
247 ge_mac_cfg_2
->value
);
251 * nps_enet_hw_reset - Reset the network device.
252 * @ndev: Pointer to the network device.
254 * This function reset the PCS and TX fifo.
255 * The programming model is to set the relevant reset bits
256 * wait for some time for this to propagate and then unset
257 * the reset bits. This way we ensure that reset procedure
258 * is done successfully by device.
260 static void nps_enet_hw_reset(struct net_device
*ndev
)
262 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
263 struct nps_enet_ge_rst ge_rst
;
264 struct nps_enet_phase_fifo_ctl phase_fifo_ctl
;
267 phase_fifo_ctl
.value
= 0;
268 /* Pcs reset sequence*/
269 ge_rst
.gmac_0
= NPS_ENET_ENABLE
;
270 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_RST
, ge_rst
.value
);
271 usleep_range(10, 20);
273 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_RST
, ge_rst
.value
);
275 /* Tx fifo reset sequence */
276 phase_fifo_ctl
.rst
= NPS_ENET_ENABLE
;
277 phase_fifo_ctl
.init
= NPS_ENET_ENABLE
;
278 nps_enet_reg_set(priv
, NPS_ENET_REG_PHASE_FIFO_CTL
,
279 phase_fifo_ctl
.value
);
280 usleep_range(10, 20);
281 phase_fifo_ctl
.value
= 0;
282 nps_enet_reg_set(priv
, NPS_ENET_REG_PHASE_FIFO_CTL
,
283 phase_fifo_ctl
.value
);
286 static void nps_enet_hw_enable_control(struct net_device
*ndev
)
288 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
289 struct nps_enet_ge_mac_cfg_0 ge_mac_cfg_0
;
290 struct nps_enet_buf_int_enable buf_int_enable
;
291 struct nps_enet_ge_mac_cfg_2
*ge_mac_cfg_2
= &priv
->ge_mac_cfg_2
;
292 struct nps_enet_ge_mac_cfg_3
*ge_mac_cfg_3
= &priv
->ge_mac_cfg_3
;
293 s32 max_frame_length
;
295 ge_mac_cfg_0
.value
= 0;
296 buf_int_enable
.value
= 0;
297 /* Enable Rx and Tx statistics */
298 ge_mac_cfg_2
->stat_en
= NPS_ENET_GE_MAC_CFG_2_STAT_EN
;
300 /* Discard packets with different MAC address */
301 ge_mac_cfg_2
->disc_da
= NPS_ENET_ENABLE
;
303 /* Discard multicast packets */
304 ge_mac_cfg_2
->disc_mc
= NPS_ENET_ENABLE
;
306 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_2
,
307 ge_mac_cfg_2
->value
);
309 /* Discard Packets bigger than max frame length */
310 max_frame_length
= ETH_HLEN
+ ndev
->mtu
+ ETH_FCS_LEN
;
311 if (max_frame_length
<= NPS_ENET_MAX_FRAME_LENGTH
) {
312 ge_mac_cfg_3
->max_len
= max_frame_length
;
313 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_3
,
314 ge_mac_cfg_3
->value
);
317 /* Enable interrupts */
318 buf_int_enable
.rx_rdy
= NPS_ENET_ENABLE
;
319 buf_int_enable
.tx_done
= NPS_ENET_ENABLE
;
320 nps_enet_reg_set(priv
, NPS_ENET_REG_BUF_INT_ENABLE
,
321 buf_int_enable
.value
);
323 /* Write device MAC address to HW */
324 nps_enet_set_hw_mac_address(ndev
);
326 /* Rx and Tx HW features */
327 ge_mac_cfg_0
.tx_pad_en
= NPS_ENET_ENABLE
;
328 ge_mac_cfg_0
.tx_crc_en
= NPS_ENET_ENABLE
;
329 ge_mac_cfg_0
.rx_crc_strip
= NPS_ENET_ENABLE
;
331 /* IFG configuration */
332 ge_mac_cfg_0
.rx_ifg
= NPS_ENET_GE_MAC_CFG_0_RX_IFG
;
333 ge_mac_cfg_0
.tx_ifg
= NPS_ENET_GE_MAC_CFG_0_TX_IFG
;
335 /* preamble configuration */
336 ge_mac_cfg_0
.rx_pr_check_en
= NPS_ENET_ENABLE
;
337 ge_mac_cfg_0
.tx_pr_len
= NPS_ENET_GE_MAC_CFG_0_TX_PR_LEN
;
339 /* enable flow control frames */
340 ge_mac_cfg_0
.tx_fc_en
= NPS_ENET_ENABLE
;
341 ge_mac_cfg_0
.rx_fc_en
= NPS_ENET_ENABLE
;
342 ge_mac_cfg_0
.tx_fc_retr
= NPS_ENET_GE_MAC_CFG_0_TX_FC_RETR
;
344 /* Enable Rx and Tx */
345 ge_mac_cfg_0
.rx_en
= NPS_ENET_ENABLE
;
346 ge_mac_cfg_0
.tx_en
= NPS_ENET_ENABLE
;
348 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_0
,
352 static void nps_enet_hw_disable_control(struct net_device
*ndev
)
354 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
356 /* Disable interrupts */
357 nps_enet_reg_set(priv
, NPS_ENET_REG_BUF_INT_ENABLE
, 0);
359 /* Disable Rx and Tx */
360 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_0
, 0);
363 static void nps_enet_send_frame(struct net_device
*ndev
,
366 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
367 struct nps_enet_tx_ctl tx_ctrl
;
368 short length
= skb
->len
;
369 u32 i
, len
= DIV_ROUND_UP(length
, sizeof(u32
));
370 u32
*src
= (u32
*)virt_to_phys(skb
->data
);
371 bool src_is_aligned
= IS_ALIGNED((unsigned long)src
, sizeof(u32
));
374 /* In case src is not aligned we need an intermediate buffer */
376 for (i
= 0; i
< len
; i
++, src
++)
377 nps_enet_reg_set(priv
, NPS_ENET_REG_TX_BUF
, *src
);
378 else { /* !src_is_aligned */
379 for (i
= 0; i
< len
; i
++, src
++) {
382 /* to accommodate word-unaligned address of "src"
383 * we have to do memcpy_fromio() instead of simple "="
385 memcpy_fromio(&buf
, (void __iomem
*)src
, sizeof(buf
));
386 nps_enet_reg_set(priv
, NPS_ENET_REG_TX_BUF
, buf
);
389 /* Write the length of the Frame */
392 /* Indicate SW is done */
393 priv
->tx_packet_sent
= true;
394 tx_ctrl
.ct
= NPS_ENET_ENABLE
;
397 nps_enet_reg_set(priv
, NPS_ENET_REG_TX_CTL
, tx_ctrl
.value
);
401 * nps_enet_set_mac_address - Set the MAC address for this device.
402 * @ndev: Pointer to net_device structure.
403 * @p: 6 byte Address to be written as MAC address.
405 * This function copies the HW address from the sockaddr structure to the
406 * net_device structure and updates the address in HW.
408 * returns: -EBUSY if the net device is busy or 0 if the address is set
411 static s32
nps_enet_set_mac_address(struct net_device
*ndev
, void *p
)
413 struct sockaddr
*addr
= p
;
416 if (netif_running(ndev
))
419 res
= eth_mac_addr(ndev
, p
);
421 ether_addr_copy(ndev
->dev_addr
, addr
->sa_data
);
422 nps_enet_set_hw_mac_address(ndev
);
429 * nps_enet_set_rx_mode - Change the receive filtering mode.
430 * @ndev: Pointer to the network device.
432 * This function enables/disables promiscuous mode
434 static void nps_enet_set_rx_mode(struct net_device
*ndev
)
436 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
437 struct nps_enet_ge_mac_cfg_2 ge_mac_cfg_2
;
439 ge_mac_cfg_2
.value
= priv
->ge_mac_cfg_2
.value
;
441 if (ndev
->flags
& IFF_PROMISC
) {
442 ge_mac_cfg_2
.disc_da
= NPS_ENET_DISABLE
;
443 ge_mac_cfg_2
.disc_mc
= NPS_ENET_DISABLE
;
445 ge_mac_cfg_2
.disc_da
= NPS_ENET_ENABLE
;
446 ge_mac_cfg_2
.disc_mc
= NPS_ENET_ENABLE
;
449 nps_enet_reg_set(priv
, NPS_ENET_REG_GE_MAC_CFG_2
, ge_mac_cfg_2
.value
);
453 * nps_enet_open - Open the network device.
454 * @ndev: Pointer to the network device.
456 * returns: 0, on success or non-zero error value on failure.
458 * This function sets the MAC address, requests and enables an IRQ
459 * for the ENET device and starts the Tx queue.
461 static s32
nps_enet_open(struct net_device
*ndev
)
463 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
466 /* Reset private variables */
467 priv
->tx_packet_sent
= false;
468 priv
->ge_mac_cfg_2
.value
= 0;
469 priv
->ge_mac_cfg_3
.value
= 0;
471 /* ge_mac_cfg_3 default values */
472 priv
->ge_mac_cfg_3
.rx_ifg_th
= NPS_ENET_GE_MAC_CFG_3_RX_IFG_TH
;
473 priv
->ge_mac_cfg_3
.max_len
= NPS_ENET_GE_MAC_CFG_3_MAX_LEN
;
475 /* Disable HW device */
476 nps_enet_hw_disable_control(ndev
);
478 /* irq Rx allocation */
479 err
= request_irq(priv
->irq
, nps_enet_irq_handler
,
480 0, "enet-rx-tx", ndev
);
484 napi_enable(&priv
->napi
);
486 /* Enable HW device */
487 nps_enet_hw_reset(ndev
);
488 nps_enet_hw_enable_control(ndev
);
490 netif_start_queue(ndev
);
496 * nps_enet_stop - Close the network device.
497 * @ndev: Pointer to the network device.
499 * This function stops the Tx queue, disables interrupts for the ENET device.
501 static s32
nps_enet_stop(struct net_device
*ndev
)
503 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
505 napi_disable(&priv
->napi
);
506 netif_stop_queue(ndev
);
507 nps_enet_hw_disable_control(ndev
);
508 free_irq(priv
->irq
, ndev
);
514 * nps_enet_start_xmit - Starts the data transmission.
515 * @skb: sk_buff pointer that contains data to be Transmitted.
516 * @ndev: Pointer to net_device structure.
518 * returns: NETDEV_TX_OK, on success
519 * NETDEV_TX_BUSY, if any of the descriptors are not free.
521 * This function is invoked from upper layers to initiate transmission.
523 static netdev_tx_t
nps_enet_start_xmit(struct sk_buff
*skb
,
524 struct net_device
*ndev
)
526 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
528 /* This driver handles one frame at a time */
529 netif_stop_queue(ndev
);
531 nps_enet_send_frame(ndev
, skb
);
538 #ifdef CONFIG_NET_POLL_CONTROLLER
539 static void nps_enet_poll_controller(struct net_device
*ndev
)
541 disable_irq(ndev
->irq
);
542 nps_enet_irq_handler(ndev
->irq
, ndev
);
543 enable_irq(ndev
->irq
);
547 static const struct net_device_ops nps_netdev_ops
= {
548 .ndo_open
= nps_enet_open
,
549 .ndo_stop
= nps_enet_stop
,
550 .ndo_start_xmit
= nps_enet_start_xmit
,
551 .ndo_set_mac_address
= nps_enet_set_mac_address
,
552 .ndo_set_rx_mode
= nps_enet_set_rx_mode
,
553 #ifdef CONFIG_NET_POLL_CONTROLLER
554 .ndo_poll_controller
= nps_enet_poll_controller
,
558 static s32
nps_enet_probe(struct platform_device
*pdev
)
560 struct device
*dev
= &pdev
->dev
;
561 struct net_device
*ndev
;
562 struct nps_enet_priv
*priv
;
564 const char *mac_addr
;
565 struct resource
*res_regs
;
570 ndev
= alloc_etherdev(sizeof(struct nps_enet_priv
));
574 platform_set_drvdata(pdev
, ndev
);
575 SET_NETDEV_DEV(ndev
, dev
);
576 priv
= netdev_priv(ndev
);
578 /* The EZ NET specific entries in the device structure. */
579 ndev
->netdev_ops
= &nps_netdev_ops
;
580 ndev
->watchdog_timeo
= (400 * HZ
/ 1000);
581 /* FIXME :: no multicast support yet */
582 ndev
->flags
&= ~IFF_MULTICAST
;
584 res_regs
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
585 priv
->regs_base
= devm_ioremap_resource(dev
, res_regs
);
586 if (IS_ERR(priv
->regs_base
)) {
587 err
= PTR_ERR(priv
->regs_base
);
590 dev_dbg(dev
, "Registers base address is 0x%p\n", priv
->regs_base
);
592 /* set kernel MAC address to dev */
593 mac_addr
= of_get_mac_address(dev
->of_node
);
595 ether_addr_copy(ndev
->dev_addr
, mac_addr
);
597 eth_hw_addr_random(ndev
);
600 priv
->irq
= platform_get_irq(pdev
, 0);
602 dev_err(dev
, "failed to retrieve <irq Rx-Tx> value from device tree\n");
607 netif_napi_add(ndev
, &priv
->napi
, nps_enet_poll
,
608 NPS_ENET_NAPI_POLL_WEIGHT
);
610 /* Register the driver. Should be the last thing in probe */
611 err
= register_netdev(ndev
);
613 dev_err(dev
, "Failed to register ndev for %s, err = 0x%08x\n",
614 ndev
->name
, (s32
)err
);
618 dev_info(dev
, "(rx/tx=%d)\n", priv
->irq
);
622 netif_napi_del(&priv
->napi
);
630 static s32
nps_enet_remove(struct platform_device
*pdev
)
632 struct net_device
*ndev
= platform_get_drvdata(pdev
);
633 struct nps_enet_priv
*priv
= netdev_priv(ndev
);
635 unregister_netdev(ndev
);
637 netif_napi_del(&priv
->napi
);
642 static const struct of_device_id nps_enet_dt_ids
[] = {
643 { .compatible
= "ezchip,nps-mgt-enet" },
647 static struct platform_driver nps_enet_driver
= {
648 .probe
= nps_enet_probe
,
649 .remove
= nps_enet_remove
,
652 .of_match_table
= nps_enet_dt_ids
,
656 module_platform_driver(nps_enet_driver
);
658 MODULE_AUTHOR("EZchip Semiconductor");
659 MODULE_LICENSE("GPL v2");