1 /* MOXA ART Ethernet (RTL8201CP) driver.
3 * Copyright (C) 2013 Jonas Jensen
5 * Jonas Jensen <jonas.jensen@gmail.com>
8 * Moxa Technology Co., Ltd. <www.moxa.com>
10 * This file is licensed under the terms of the GNU General Public
11 * License version 2. This program is licensed "as is" without any
12 * warranty of any kind, whether express or implied.
15 #include <linux/module.h>
16 #include <linux/netdevice.h>
17 #include <linux/etherdevice.h>
18 #include <linux/skbuff.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/ethtool.h>
21 #include <linux/platform_device.h>
22 #include <linux/interrupt.h>
23 #include <linux/irq.h>
24 #include <linux/of_address.h>
25 #include <linux/of_irq.h>
26 #include <linux/crc32.h>
27 #include <linux/crc32c.h>
29 #include "moxart_ether.h"
31 static inline void moxart_desc_write(u32 data
, u32
*desc
)
33 *desc
= cpu_to_le32(data
);
36 static inline u32
moxart_desc_read(u32
*desc
)
38 return le32_to_cpu(*desc
);
41 static inline void moxart_emac_write(struct net_device
*ndev
,
42 unsigned int reg
, unsigned long value
)
44 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
46 writel(value
, priv
->base
+ reg
);
49 static void moxart_update_mac_address(struct net_device
*ndev
)
51 moxart_emac_write(ndev
, REG_MAC_MS_ADDRESS
,
52 ((ndev
->dev_addr
[0] << 8) | (ndev
->dev_addr
[1])));
53 moxart_emac_write(ndev
, REG_MAC_MS_ADDRESS
+ 4,
54 ((ndev
->dev_addr
[2] << 24) |
55 (ndev
->dev_addr
[3] << 16) |
56 (ndev
->dev_addr
[4] << 8) |
57 (ndev
->dev_addr
[5])));
60 static int moxart_set_mac_address(struct net_device
*ndev
, void *addr
)
62 struct sockaddr
*address
= addr
;
64 if (!is_valid_ether_addr(address
->sa_data
))
65 return -EADDRNOTAVAIL
;
67 memcpy(ndev
->dev_addr
, address
->sa_data
, ndev
->addr_len
);
68 moxart_update_mac_address(ndev
);
73 static void moxart_mac_free_memory(struct net_device
*ndev
)
75 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
78 for (i
= 0; i
< RX_DESC_NUM
; i
++)
79 dma_unmap_single(&ndev
->dev
, priv
->rx_mapping
[i
],
80 priv
->rx_buf_size
, DMA_FROM_DEVICE
);
82 if (priv
->tx_desc_base
)
83 dma_free_coherent(NULL
, TX_REG_DESC_SIZE
* TX_DESC_NUM
,
84 priv
->tx_desc_base
, priv
->tx_base
);
86 if (priv
->rx_desc_base
)
87 dma_free_coherent(NULL
, RX_REG_DESC_SIZE
* RX_DESC_NUM
,
88 priv
->rx_desc_base
, priv
->rx_base
);
90 kfree(priv
->tx_buf_base
);
91 kfree(priv
->rx_buf_base
);
94 static void moxart_mac_reset(struct net_device
*ndev
)
96 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
98 writel(SW_RST
, priv
->base
+ REG_MAC_CTRL
);
99 while (readl(priv
->base
+ REG_MAC_CTRL
) & SW_RST
)
102 writel(0, priv
->base
+ REG_INTERRUPT_MASK
);
104 priv
->reg_maccr
= RX_BROADPKT
| FULLDUP
| CRC_APD
| RX_FTL
;
107 static void moxart_mac_enable(struct net_device
*ndev
)
109 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
111 writel(0x00001010, priv
->base
+ REG_INT_TIMER_CTRL
);
112 writel(0x00000001, priv
->base
+ REG_APOLL_TIMER_CTRL
);
113 writel(0x00000390, priv
->base
+ REG_DMA_BLEN_CTRL
);
115 priv
->reg_imr
|= (RPKT_FINISH_M
| XPKT_FINISH_M
);
116 writel(priv
->reg_imr
, priv
->base
+ REG_INTERRUPT_MASK
);
118 priv
->reg_maccr
|= (RCV_EN
| XMT_EN
| RDMA_EN
| XDMA_EN
);
119 writel(priv
->reg_maccr
, priv
->base
+ REG_MAC_CTRL
);
122 static void moxart_mac_setup_desc_ring(struct net_device
*ndev
)
124 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
128 for (i
= 0; i
< TX_DESC_NUM
; i
++) {
129 desc
= priv
->tx_desc_base
+ i
* TX_REG_DESC_SIZE
;
130 memset(desc
, 0, TX_REG_DESC_SIZE
);
132 priv
->tx_buf
[i
] = priv
->tx_buf_base
+ priv
->tx_buf_size
* i
;
134 moxart_desc_write(TX_DESC1_END
, desc
+ TX_REG_OFFSET_DESC1
);
139 for (i
= 0; i
< RX_DESC_NUM
; i
++) {
140 desc
= priv
->rx_desc_base
+ i
* RX_REG_DESC_SIZE
;
141 memset(desc
, 0, RX_REG_DESC_SIZE
);
142 moxart_desc_write(RX_DESC0_DMA_OWN
, desc
+ RX_REG_OFFSET_DESC0
);
143 moxart_desc_write(RX_BUF_SIZE
& RX_DESC1_BUF_SIZE_MASK
,
144 desc
+ RX_REG_OFFSET_DESC1
);
146 priv
->rx_buf
[i
] = priv
->rx_buf_base
+ priv
->rx_buf_size
* i
;
147 priv
->rx_mapping
[i
] = dma_map_single(&ndev
->dev
,
151 if (dma_mapping_error(&ndev
->dev
, priv
->rx_mapping
[i
]))
152 netdev_err(ndev
, "DMA mapping error\n");
154 moxart_desc_write(priv
->rx_mapping
[i
],
155 desc
+ RX_REG_OFFSET_DESC2
+ RX_DESC2_ADDRESS_PHYS
);
156 moxart_desc_write((uintptr_t)priv
->rx_buf
[i
],
157 desc
+ RX_REG_OFFSET_DESC2
+ RX_DESC2_ADDRESS_VIRT
);
159 moxart_desc_write(RX_DESC1_END
, desc
+ RX_REG_OFFSET_DESC1
);
163 /* reset the MAC controller TX/RX desciptor base address */
164 writel(priv
->tx_base
, priv
->base
+ REG_TXR_BASE_ADDRESS
);
165 writel(priv
->rx_base
, priv
->base
+ REG_RXR_BASE_ADDRESS
);
168 static int moxart_mac_open(struct net_device
*ndev
)
170 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
172 if (!is_valid_ether_addr(ndev
->dev_addr
))
173 return -EADDRNOTAVAIL
;
175 napi_enable(&priv
->napi
);
177 moxart_mac_reset(ndev
);
178 moxart_update_mac_address(ndev
);
179 moxart_mac_setup_desc_ring(ndev
);
180 moxart_mac_enable(ndev
);
181 netif_start_queue(ndev
);
183 netdev_dbg(ndev
, "%s: IMR=0x%x, MACCR=0x%x\n",
184 __func__
, readl(priv
->base
+ REG_INTERRUPT_MASK
),
185 readl(priv
->base
+ REG_MAC_CTRL
));
190 static int moxart_mac_stop(struct net_device
*ndev
)
192 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
194 napi_disable(&priv
->napi
);
196 netif_stop_queue(ndev
);
198 /* disable all interrupts */
199 writel(0, priv
->base
+ REG_INTERRUPT_MASK
);
201 /* disable all functions */
202 writel(0, priv
->base
+ REG_MAC_CTRL
);
207 static int moxart_rx_poll(struct napi_struct
*napi
, int budget
)
209 struct moxart_mac_priv_t
*priv
= container_of(napi
,
210 struct moxart_mac_priv_t
,
212 struct net_device
*ndev
= priv
->ndev
;
215 unsigned int desc0
, len
;
216 int rx_head
= priv
->rx_head
;
219 while (rx
< budget
) {
220 desc
= priv
->rx_desc_base
+ (RX_REG_DESC_SIZE
* rx_head
);
221 desc0
= moxart_desc_read(desc
+ RX_REG_OFFSET_DESC0
);
222 rmb(); /* ensure desc0 is up to date */
224 if (desc0
& RX_DESC0_DMA_OWN
)
227 if (desc0
& (RX_DESC0_ERR
| RX_DESC0_CRC_ERR
| RX_DESC0_FTL
|
228 RX_DESC0_RUNT
| RX_DESC0_ODD_NB
)) {
229 net_dbg_ratelimited("packet error\n");
230 priv
->stats
.rx_dropped
++;
231 priv
->stats
.rx_errors
++;
235 len
= desc0
& RX_DESC0_FRAME_LEN_MASK
;
237 if (len
> RX_BUF_SIZE
)
240 dma_sync_single_for_cpu(&ndev
->dev
,
241 priv
->rx_mapping
[rx_head
],
242 priv
->rx_buf_size
, DMA_FROM_DEVICE
);
243 skb
= netdev_alloc_skb_ip_align(ndev
, len
);
245 if (unlikely(!skb
)) {
246 net_dbg_ratelimited("netdev_alloc_skb_ip_align failed\n");
247 priv
->stats
.rx_dropped
++;
248 priv
->stats
.rx_errors
++;
252 memcpy(skb
->data
, priv
->rx_buf
[rx_head
], len
);
254 skb
->protocol
= eth_type_trans(skb
, ndev
);
255 napi_gro_receive(&priv
->napi
, skb
);
258 priv
->stats
.rx_packets
++;
259 priv
->stats
.rx_bytes
+= len
;
260 if (desc0
& RX_DESC0_MULTICAST
)
261 priv
->stats
.multicast
++;
264 wmb(); /* prevent setting ownership back too early */
265 moxart_desc_write(RX_DESC0_DMA_OWN
, desc
+ RX_REG_OFFSET_DESC0
);
267 rx_head
= RX_NEXT(rx_head
);
268 priv
->rx_head
= rx_head
;
275 priv
->reg_imr
|= RPKT_FINISH_M
;
276 writel(priv
->reg_imr
, priv
->base
+ REG_INTERRUPT_MASK
);
281 static void moxart_tx_finished(struct net_device
*ndev
)
283 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
284 unsigned tx_head
= priv
->tx_head
;
285 unsigned tx_tail
= priv
->tx_tail
;
287 while (tx_tail
!= tx_head
) {
288 dma_unmap_single(&ndev
->dev
, priv
->tx_mapping
[tx_tail
],
289 priv
->tx_len
[tx_tail
], DMA_TO_DEVICE
);
291 priv
->stats
.tx_packets
++;
292 priv
->stats
.tx_bytes
+= priv
->tx_skb
[tx_tail
]->len
;
294 dev_kfree_skb_irq(priv
->tx_skb
[tx_tail
]);
295 priv
->tx_skb
[tx_tail
] = NULL
;
297 tx_tail
= TX_NEXT(tx_tail
);
299 priv
->tx_tail
= tx_tail
;
302 static irqreturn_t
moxart_mac_interrupt(int irq
, void *dev_id
)
304 struct net_device
*ndev
= (struct net_device
*) dev_id
;
305 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
306 unsigned int ists
= readl(priv
->base
+ REG_INTERRUPT_STATUS
);
308 if (ists
& XPKT_OK_INT_STS
)
309 moxart_tx_finished(ndev
);
311 if (ists
& RPKT_FINISH
) {
312 if (napi_schedule_prep(&priv
->napi
)) {
313 priv
->reg_imr
&= ~RPKT_FINISH_M
;
314 writel(priv
->reg_imr
, priv
->base
+ REG_INTERRUPT_MASK
);
315 __napi_schedule(&priv
->napi
);
322 static int moxart_mac_start_xmit(struct sk_buff
*skb
, struct net_device
*ndev
)
324 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
327 unsigned int tx_head
= priv
->tx_head
;
329 int ret
= NETDEV_TX_BUSY
;
331 desc
= priv
->tx_desc_base
+ (TX_REG_DESC_SIZE
* tx_head
);
333 spin_lock_irq(&priv
->txlock
);
334 if (moxart_desc_read(desc
+ TX_REG_OFFSET_DESC0
) & TX_DESC0_DMA_OWN
) {
335 net_dbg_ratelimited("no TX space for packet\n");
336 priv
->stats
.tx_dropped
++;
339 rmb(); /* ensure data is only read that had TX_DESC0_DMA_OWN cleared */
341 len
= skb
->len
> TX_BUF_SIZE
? TX_BUF_SIZE
: skb
->len
;
343 priv
->tx_mapping
[tx_head
] = dma_map_single(&ndev
->dev
, skb
->data
,
345 if (dma_mapping_error(&ndev
->dev
, priv
->tx_mapping
[tx_head
])) {
346 netdev_err(ndev
, "DMA mapping error\n");
350 priv
->tx_len
[tx_head
] = len
;
351 priv
->tx_skb
[tx_head
] = skb
;
353 moxart_desc_write(priv
->tx_mapping
[tx_head
],
354 desc
+ TX_REG_OFFSET_DESC2
+ TX_DESC2_ADDRESS_PHYS
);
355 moxart_desc_write((uintptr_t)skb
->data
,
356 desc
+ TX_REG_OFFSET_DESC2
+ TX_DESC2_ADDRESS_VIRT
);
358 if (skb
->len
< ETH_ZLEN
) {
359 memset(&skb
->data
[skb
->len
],
360 0, ETH_ZLEN
- skb
->len
);
364 dma_sync_single_for_device(&ndev
->dev
, priv
->tx_mapping
[tx_head
],
365 priv
->tx_buf_size
, DMA_TO_DEVICE
);
367 txdes1
= TX_DESC1_LTS
| TX_DESC1_FTS
| (len
& TX_DESC1_BUF_SIZE_MASK
);
368 if (tx_head
== TX_DESC_NUM_MASK
)
369 txdes1
|= TX_DESC1_END
;
370 moxart_desc_write(txdes1
, desc
+ TX_REG_OFFSET_DESC1
);
371 wmb(); /* flush descriptor before transferring ownership */
372 moxart_desc_write(TX_DESC0_DMA_OWN
, desc
+ TX_REG_OFFSET_DESC0
);
374 /* start to send packet */
375 writel(0xffffffff, priv
->base
+ REG_TX_POLL_DEMAND
);
377 priv
->tx_head
= TX_NEXT(tx_head
);
379 netif_trans_update(ndev
);
382 spin_unlock_irq(&priv
->txlock
);
387 static struct net_device_stats
*moxart_mac_get_stats(struct net_device
*ndev
)
389 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
394 static void moxart_mac_setmulticast(struct net_device
*ndev
)
396 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
397 struct netdev_hw_addr
*ha
;
400 netdev_for_each_mc_addr(ha
, ndev
) {
401 crc_val
= crc32_le(~0, ha
->addr
, ETH_ALEN
);
402 crc_val
= (crc_val
>> 26) & 0x3f;
404 writel(readl(priv
->base
+ REG_MCAST_HASH_TABLE1
) |
405 (1UL << (crc_val
- 32)),
406 priv
->base
+ REG_MCAST_HASH_TABLE1
);
408 writel(readl(priv
->base
+ REG_MCAST_HASH_TABLE0
) |
410 priv
->base
+ REG_MCAST_HASH_TABLE0
);
415 static void moxart_mac_set_rx_mode(struct net_device
*ndev
)
417 struct moxart_mac_priv_t
*priv
= netdev_priv(ndev
);
419 spin_lock_irq(&priv
->txlock
);
421 (ndev
->flags
& IFF_PROMISC
) ? (priv
->reg_maccr
|= RCV_ALL
) :
422 (priv
->reg_maccr
&= ~RCV_ALL
);
424 (ndev
->flags
& IFF_ALLMULTI
) ? (priv
->reg_maccr
|= RX_MULTIPKT
) :
425 (priv
->reg_maccr
&= ~RX_MULTIPKT
);
427 if ((ndev
->flags
& IFF_MULTICAST
) && netdev_mc_count(ndev
)) {
428 priv
->reg_maccr
|= HT_MULTI_EN
;
429 moxart_mac_setmulticast(ndev
);
431 priv
->reg_maccr
&= ~HT_MULTI_EN
;
434 writel(priv
->reg_maccr
, priv
->base
+ REG_MAC_CTRL
);
436 spin_unlock_irq(&priv
->txlock
);
439 static struct net_device_ops moxart_netdev_ops
= {
440 .ndo_open
= moxart_mac_open
,
441 .ndo_stop
= moxart_mac_stop
,
442 .ndo_start_xmit
= moxart_mac_start_xmit
,
443 .ndo_get_stats
= moxart_mac_get_stats
,
444 .ndo_set_rx_mode
= moxart_mac_set_rx_mode
,
445 .ndo_set_mac_address
= moxart_set_mac_address
,
446 .ndo_validate_addr
= eth_validate_addr
,
447 .ndo_change_mtu
= eth_change_mtu
,
450 static int moxart_mac_probe(struct platform_device
*pdev
)
452 struct device
*p_dev
= &pdev
->dev
;
453 struct device_node
*node
= p_dev
->of_node
;
454 struct net_device
*ndev
;
455 struct moxart_mac_priv_t
*priv
;
456 struct resource
*res
;
460 ndev
= alloc_etherdev(sizeof(struct moxart_mac_priv_t
));
464 irq
= irq_of_parse_and_map(node
, 0);
466 netdev_err(ndev
, "irq_of_parse_and_map failed\n");
471 priv
= netdev_priv(ndev
);
474 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
475 ndev
->base_addr
= res
->start
;
476 priv
->base
= devm_ioremap_resource(p_dev
, res
);
477 if (IS_ERR(priv
->base
)) {
478 dev_err(p_dev
, "devm_ioremap_resource failed\n");
479 ret
= PTR_ERR(priv
->base
);
483 spin_lock_init(&priv
->txlock
);
485 priv
->tx_buf_size
= TX_BUF_SIZE
;
486 priv
->rx_buf_size
= RX_BUF_SIZE
;
488 priv
->tx_desc_base
= dma_alloc_coherent(NULL
, TX_REG_DESC_SIZE
*
489 TX_DESC_NUM
, &priv
->tx_base
,
490 GFP_DMA
| GFP_KERNEL
);
491 if (priv
->tx_desc_base
== NULL
) {
496 priv
->rx_desc_base
= dma_alloc_coherent(NULL
, RX_REG_DESC_SIZE
*
497 RX_DESC_NUM
, &priv
->rx_base
,
498 GFP_DMA
| GFP_KERNEL
);
499 if (priv
->rx_desc_base
== NULL
) {
504 priv
->tx_buf_base
= kmalloc(priv
->tx_buf_size
* TX_DESC_NUM
,
506 if (!priv
->tx_buf_base
) {
511 priv
->rx_buf_base
= kmalloc(priv
->rx_buf_size
* RX_DESC_NUM
,
513 if (!priv
->rx_buf_base
) {
518 platform_set_drvdata(pdev
, ndev
);
520 ret
= devm_request_irq(p_dev
, irq
, moxart_mac_interrupt
, 0,
523 netdev_err(ndev
, "devm_request_irq failed\n");
527 ndev
->netdev_ops
= &moxart_netdev_ops
;
528 netif_napi_add(ndev
, &priv
->napi
, moxart_rx_poll
, RX_DESC_NUM
);
529 ndev
->priv_flags
|= IFF_UNICAST_FLT
;
532 SET_NETDEV_DEV(ndev
, &pdev
->dev
);
534 ret
= register_netdev(ndev
);
540 netdev_dbg(ndev
, "%s: IRQ=%d address=%pM\n",
541 __func__
, ndev
->irq
, ndev
->dev_addr
);
546 netdev_err(ndev
, "init failed\n");
547 moxart_mac_free_memory(ndev
);
553 static int moxart_remove(struct platform_device
*pdev
)
555 struct net_device
*ndev
= platform_get_drvdata(pdev
);
557 unregister_netdev(ndev
);
558 free_irq(ndev
->irq
, ndev
);
559 moxart_mac_free_memory(ndev
);
565 static const struct of_device_id moxart_mac_match
[] = {
566 { .compatible
= "moxa,moxart-mac" },
569 MODULE_DEVICE_TABLE(of
, moxart_mac_match
);
571 static struct platform_driver moxart_mac_driver
= {
572 .probe
= moxart_mac_probe
,
573 .remove
= moxart_remove
,
575 .name
= "moxart-ethernet",
576 .of_match_table
= moxart_mac_match
,
579 module_platform_driver(moxart_mac_driver
);
581 MODULE_DESCRIPTION("MOXART RTL8201CP Ethernet driver");
582 MODULE_LICENSE("GPL v2");
583 MODULE_AUTHOR("Jonas Jensen <jonas.jensen@gmail.com>");