1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * rionet - Ethernet driver over RapidIO messaging services
5 * Copyright 2005 MontaVista Software, Inc.
6 * Matt Porter <mporter@kernel.crashing.org>
9 #include <linux/module.h>
10 #include <linux/kernel.h>
11 #include <linux/dma-mapping.h>
12 #include <linux/delay.h>
13 #include <linux/rio.h>
14 #include <linux/rio_drv.h>
15 #include <linux/slab.h>
16 #include <linux/rio_ids.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/skbuff.h>
21 #include <linux/crc32.h>
22 #include <linux/ethtool.h>
23 #include <linux/reboot.h>
25 #define DRV_NAME "rionet"
26 #define DRV_VERSION "0.3"
27 #define DRV_AUTHOR "Matt Porter <mporter@kernel.crashing.org>"
28 #define DRV_DESC "Ethernet over RapidIO"
30 MODULE_AUTHOR(DRV_AUTHOR
);
31 MODULE_DESCRIPTION(DRV_DESC
);
32 MODULE_LICENSE("GPL");
34 #define RIONET_DEFAULT_MSGLEVEL \
40 #define RIONET_DOORBELL_JOIN 0x1000
41 #define RIONET_DOORBELL_LEAVE 0x1001
43 #define RIONET_MAILBOX 0
45 #define RIONET_TX_RING_SIZE CONFIG_RIONET_TX_SIZE
46 #define RIONET_RX_RING_SIZE CONFIG_RIONET_RX_SIZE
47 #define RIONET_MAX_NETS 8
48 #define RIONET_MSG_SIZE RIO_MAX_MSG_SIZE
49 #define RIONET_MAX_MTU (RIONET_MSG_SIZE - ETH_HLEN)
51 struct rionet_private
{
52 struct rio_mport
*mport
;
53 struct sk_buff
*rx_skb
[RIONET_RX_RING_SIZE
];
54 struct sk_buff
*tx_skb
[RIONET_TX_RING_SIZE
];
66 struct list_head node
;
72 struct net_device
*ndev
;
73 struct list_head peers
;
74 spinlock_t lock
; /* net info access lock */
75 struct rio_dev
**active
;
76 int nact
; /* number of active peers */
79 static struct rionet_net nets
[RIONET_MAX_NETS
];
81 #define is_rionet_capable(src_ops, dst_ops) \
82 ((src_ops & RIO_SRC_OPS_DATA_MSG) && \
83 (dst_ops & RIO_DST_OPS_DATA_MSG) && \
84 (src_ops & RIO_SRC_OPS_DOORBELL) && \
85 (dst_ops & RIO_DST_OPS_DOORBELL))
86 #define dev_rionet_capable(dev) \
87 is_rionet_capable(dev->src_ops, dev->dst_ops)
89 #define RIONET_MAC_MATCH(x) (!memcmp((x), "\00\01\00\01", 4))
90 #define RIONET_GET_DESTID(x) ((*((u8 *)x + 4) << 8) | *((u8 *)x + 5))
92 static int rionet_rx_clean(struct net_device
*ndev
)
96 struct rionet_private
*rnet
= netdev_priv(ndev
);
102 if (!rnet
->rx_skb
[i
])
105 if (!(data
= rio_get_inb_message(rnet
->mport
, RIONET_MAILBOX
)))
108 rnet
->rx_skb
[i
]->data
= data
;
109 skb_put(rnet
->rx_skb
[i
], RIO_MAX_MSG_SIZE
);
110 rnet
->rx_skb
[i
]->protocol
=
111 eth_type_trans(rnet
->rx_skb
[i
], ndev
);
112 error
= netif_rx(rnet
->rx_skb
[i
]);
114 if (error
== NET_RX_DROP
) {
115 ndev
->stats
.rx_dropped
++;
117 ndev
->stats
.rx_packets
++;
118 ndev
->stats
.rx_bytes
+= RIO_MAX_MSG_SIZE
;
121 } while ((i
= (i
+ 1) % RIONET_RX_RING_SIZE
) != rnet
->rx_slot
);
126 static void rionet_rx_fill(struct net_device
*ndev
, int end
)
129 struct rionet_private
*rnet
= netdev_priv(ndev
);
133 rnet
->rx_skb
[i
] = dev_alloc_skb(RIO_MAX_MSG_SIZE
);
135 if (!rnet
->rx_skb
[i
])
138 rio_add_inb_buffer(rnet
->mport
, RIONET_MAILBOX
,
139 rnet
->rx_skb
[i
]->data
);
140 } while ((i
= (i
+ 1) % RIONET_RX_RING_SIZE
) != end
);
145 static int rionet_queue_tx_msg(struct sk_buff
*skb
, struct net_device
*ndev
,
146 struct rio_dev
*rdev
)
148 struct rionet_private
*rnet
= netdev_priv(ndev
);
150 rio_add_outb_message(rnet
->mport
, rdev
, 0, skb
->data
, skb
->len
);
151 rnet
->tx_skb
[rnet
->tx_slot
] = skb
;
153 ndev
->stats
.tx_packets
++;
154 ndev
->stats
.tx_bytes
+= skb
->len
;
156 if (++rnet
->tx_cnt
== RIONET_TX_RING_SIZE
)
157 netif_stop_queue(ndev
);
160 rnet
->tx_slot
&= (RIONET_TX_RING_SIZE
- 1);
162 if (netif_msg_tx_queued(rnet
))
163 printk(KERN_INFO
"%s: queued skb len %8.8x\n", DRV_NAME
,
169 static int rionet_start_xmit(struct sk_buff
*skb
, struct net_device
*ndev
)
172 struct rionet_private
*rnet
= netdev_priv(ndev
);
173 struct ethhdr
*eth
= (struct ethhdr
*)skb
->data
;
178 spin_lock_irqsave(&rnet
->tx_lock
, flags
);
180 if (is_multicast_ether_addr(eth
->h_dest
))
181 add_num
= nets
[rnet
->mport
->id
].nact
;
183 if ((rnet
->tx_cnt
+ add_num
) > RIONET_TX_RING_SIZE
) {
184 netif_stop_queue(ndev
);
185 spin_unlock_irqrestore(&rnet
->tx_lock
, flags
);
186 printk(KERN_ERR
"%s: BUG! Tx Ring full when queue awake!\n",
188 return NETDEV_TX_BUSY
;
191 if (is_multicast_ether_addr(eth
->h_dest
)) {
194 for (i
= 0; i
< RIO_MAX_ROUTE_ENTRIES(rnet
->mport
->sys_size
);
196 if (nets
[rnet
->mport
->id
].active
[i
]) {
197 rionet_queue_tx_msg(skb
, ndev
,
198 nets
[rnet
->mport
->id
].active
[i
]);
200 refcount_inc(&skb
->users
);
203 } else if (RIONET_MAC_MATCH(eth
->h_dest
)) {
204 destid
= RIONET_GET_DESTID(eth
->h_dest
);
205 if (nets
[rnet
->mport
->id
].active
[destid
])
206 rionet_queue_tx_msg(skb
, ndev
,
207 nets
[rnet
->mport
->id
].active
[destid
]);
210 * If the target device was removed from the list of
211 * active peers but we still have TX packets targeting
212 * it just report sending a packet to the target
213 * (without actual packet transfer).
215 ndev
->stats
.tx_packets
++;
216 ndev
->stats
.tx_bytes
+= skb
->len
;
217 dev_kfree_skb_any(skb
);
221 spin_unlock_irqrestore(&rnet
->tx_lock
, flags
);
226 static void rionet_dbell_event(struct rio_mport
*mport
, void *dev_id
, u16 sid
, u16 tid
,
229 struct net_device
*ndev
= dev_id
;
230 struct rionet_private
*rnet
= netdev_priv(ndev
);
231 struct rionet_peer
*peer
;
232 unsigned char netid
= rnet
->mport
->id
;
234 if (netif_msg_intr(rnet
))
235 printk(KERN_INFO
"%s: doorbell sid %4.4x tid %4.4x info %4.4x",
236 DRV_NAME
, sid
, tid
, info
);
237 if (info
== RIONET_DOORBELL_JOIN
) {
238 if (!nets
[netid
].active
[sid
]) {
239 spin_lock(&nets
[netid
].lock
);
240 list_for_each_entry(peer
, &nets
[netid
].peers
, node
) {
241 if (peer
->rdev
->destid
== sid
) {
242 nets
[netid
].active
[sid
] = peer
->rdev
;
246 spin_unlock(&nets
[netid
].lock
);
248 rio_mport_send_doorbell(mport
, sid
,
249 RIONET_DOORBELL_JOIN
);
251 } else if (info
== RIONET_DOORBELL_LEAVE
) {
252 spin_lock(&nets
[netid
].lock
);
253 if (nets
[netid
].active
[sid
]) {
254 nets
[netid
].active
[sid
] = NULL
;
257 spin_unlock(&nets
[netid
].lock
);
259 if (netif_msg_intr(rnet
))
260 printk(KERN_WARNING
"%s: unhandled doorbell\n",
265 static void rionet_inb_msg_event(struct rio_mport
*mport
, void *dev_id
, int mbox
, int slot
)
268 struct net_device
*ndev
= dev_id
;
269 struct rionet_private
*rnet
= netdev_priv(ndev
);
271 if (netif_msg_intr(rnet
))
272 printk(KERN_INFO
"%s: inbound message event, mbox %d slot %d\n",
273 DRV_NAME
, mbox
, slot
);
275 spin_lock(&rnet
->lock
);
276 if ((n
= rionet_rx_clean(ndev
)) != rnet
->rx_slot
)
277 rionet_rx_fill(ndev
, n
);
278 spin_unlock(&rnet
->lock
);
281 static void rionet_outb_msg_event(struct rio_mport
*mport
, void *dev_id
, int mbox
, int slot
)
283 struct net_device
*ndev
= dev_id
;
284 struct rionet_private
*rnet
= netdev_priv(ndev
);
286 spin_lock(&rnet
->tx_lock
);
288 if (netif_msg_intr(rnet
))
290 "%s: outbound message event, mbox %d slot %d\n",
291 DRV_NAME
, mbox
, slot
);
293 while (rnet
->tx_cnt
&& (rnet
->ack_slot
!= slot
)) {
294 /* dma unmap single */
295 dev_kfree_skb_irq(rnet
->tx_skb
[rnet
->ack_slot
]);
296 rnet
->tx_skb
[rnet
->ack_slot
] = NULL
;
298 rnet
->ack_slot
&= (RIONET_TX_RING_SIZE
- 1);
302 if (rnet
->tx_cnt
< RIONET_TX_RING_SIZE
)
303 netif_wake_queue(ndev
);
305 spin_unlock(&rnet
->tx_lock
);
308 static int rionet_open(struct net_device
*ndev
)
311 struct rionet_peer
*peer
;
312 struct rionet_private
*rnet
= netdev_priv(ndev
);
313 unsigned char netid
= rnet
->mport
->id
;
316 if (netif_msg_ifup(rnet
))
317 printk(KERN_INFO
"%s: open\n", DRV_NAME
);
319 if ((rc
= rio_request_inb_dbell(rnet
->mport
,
321 RIONET_DOORBELL_JOIN
,
322 RIONET_DOORBELL_LEAVE
,
323 rionet_dbell_event
)) < 0)
326 if ((rc
= rio_request_inb_mbox(rnet
->mport
,
330 rionet_inb_msg_event
)) < 0)
333 if ((rc
= rio_request_outb_mbox(rnet
->mport
,
337 rionet_outb_msg_event
)) < 0)
340 /* Initialize inbound message ring */
341 for (i
= 0; i
< RIONET_RX_RING_SIZE
; i
++)
342 rnet
->rx_skb
[i
] = NULL
;
344 rionet_rx_fill(ndev
, 0);
350 netif_carrier_on(ndev
);
351 netif_start_queue(ndev
);
353 spin_lock_irqsave(&nets
[netid
].lock
, flags
);
354 list_for_each_entry(peer
, &nets
[netid
].peers
, node
) {
355 /* Send a join message */
356 rio_send_doorbell(peer
->rdev
, RIONET_DOORBELL_JOIN
);
358 spin_unlock_irqrestore(&nets
[netid
].lock
, flags
);
365 static int rionet_close(struct net_device
*ndev
)
367 struct rionet_private
*rnet
= netdev_priv(ndev
);
368 struct rionet_peer
*peer
;
369 unsigned char netid
= rnet
->mport
->id
;
373 if (netif_msg_ifup(rnet
))
374 printk(KERN_INFO
"%s: close %s\n", DRV_NAME
, ndev
->name
);
376 netif_stop_queue(ndev
);
377 netif_carrier_off(ndev
);
380 for (i
= 0; i
< RIONET_RX_RING_SIZE
; i
++)
381 kfree_skb(rnet
->rx_skb
[i
]);
383 spin_lock_irqsave(&nets
[netid
].lock
, flags
);
384 list_for_each_entry(peer
, &nets
[netid
].peers
, node
) {
385 if (nets
[netid
].active
[peer
->rdev
->destid
]) {
386 rio_send_doorbell(peer
->rdev
, RIONET_DOORBELL_LEAVE
);
387 nets
[netid
].active
[peer
->rdev
->destid
] = NULL
;
390 rio_release_outb_dbell(peer
->rdev
, peer
->res
);
392 spin_unlock_irqrestore(&nets
[netid
].lock
, flags
);
394 rio_release_inb_dbell(rnet
->mport
, RIONET_DOORBELL_JOIN
,
395 RIONET_DOORBELL_LEAVE
);
396 rio_release_inb_mbox(rnet
->mport
, RIONET_MAILBOX
);
397 rio_release_outb_mbox(rnet
->mport
, RIONET_MAILBOX
);
402 static void rionet_remove_dev(struct device
*dev
, struct subsys_interface
*sif
)
404 struct rio_dev
*rdev
= to_rio_dev(dev
);
405 unsigned char netid
= rdev
->net
->hport
->id
;
406 struct rionet_peer
*peer
;
407 int state
, found
= 0;
410 if (!dev_rionet_capable(rdev
))
413 spin_lock_irqsave(&nets
[netid
].lock
, flags
);
414 list_for_each_entry(peer
, &nets
[netid
].peers
, node
) {
415 if (peer
->rdev
== rdev
) {
416 list_del(&peer
->node
);
417 if (nets
[netid
].active
[rdev
->destid
]) {
418 state
= atomic_read(&rdev
->state
);
419 if (state
!= RIO_DEVICE_GONE
&&
420 state
!= RIO_DEVICE_INITIALIZING
) {
421 rio_send_doorbell(rdev
,
422 RIONET_DOORBELL_LEAVE
);
424 nets
[netid
].active
[rdev
->destid
] = NULL
;
431 spin_unlock_irqrestore(&nets
[netid
].lock
, flags
);
435 rio_release_outb_dbell(rdev
, peer
->res
);
440 static void rionet_get_drvinfo(struct net_device
*ndev
,
441 struct ethtool_drvinfo
*info
)
443 struct rionet_private
*rnet
= netdev_priv(ndev
);
445 strlcpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
446 strlcpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
447 strlcpy(info
->fw_version
, "n/a", sizeof(info
->fw_version
));
448 strlcpy(info
->bus_info
, rnet
->mport
->name
, sizeof(info
->bus_info
));
451 static u32
rionet_get_msglevel(struct net_device
*ndev
)
453 struct rionet_private
*rnet
= netdev_priv(ndev
);
455 return rnet
->msg_enable
;
458 static void rionet_set_msglevel(struct net_device
*ndev
, u32 value
)
460 struct rionet_private
*rnet
= netdev_priv(ndev
);
462 rnet
->msg_enable
= value
;
465 static const struct ethtool_ops rionet_ethtool_ops
= {
466 .get_drvinfo
= rionet_get_drvinfo
,
467 .get_msglevel
= rionet_get_msglevel
,
468 .set_msglevel
= rionet_set_msglevel
,
469 .get_link
= ethtool_op_get_link
,
472 static const struct net_device_ops rionet_netdev_ops
= {
473 .ndo_open
= rionet_open
,
474 .ndo_stop
= rionet_close
,
475 .ndo_start_xmit
= rionet_start_xmit
,
476 .ndo_validate_addr
= eth_validate_addr
,
477 .ndo_set_mac_address
= eth_mac_addr
,
480 static int rionet_setup_netdev(struct rio_mport
*mport
, struct net_device
*ndev
)
483 struct rionet_private
*rnet
;
485 const size_t rionet_active_bytes
= sizeof(void *) *
486 RIO_MAX_ROUTE_ENTRIES(mport
->sys_size
);
488 nets
[mport
->id
].active
= (struct rio_dev
**)__get_free_pages(GFP_KERNEL
,
489 get_order(rionet_active_bytes
));
490 if (!nets
[mport
->id
].active
) {
494 memset((void *)nets
[mport
->id
].active
, 0, rionet_active_bytes
);
496 /* Set up private area */
497 rnet
= netdev_priv(ndev
);
501 /* Set the default MAC address */
502 device_id
= rio_local_get_device_id(mport
);
503 ndev
->dev_addr
[0] = 0x00;
504 ndev
->dev_addr
[1] = 0x01;
505 ndev
->dev_addr
[2] = 0x00;
506 ndev
->dev_addr
[3] = 0x01;
507 ndev
->dev_addr
[4] = device_id
>> 8;
508 ndev
->dev_addr
[5] = device_id
& 0xff;
510 ndev
->netdev_ops
= &rionet_netdev_ops
;
511 ndev
->mtu
= RIONET_MAX_MTU
;
512 /* MTU range: 68 - 4082 */
513 ndev
->min_mtu
= ETH_MIN_MTU
;
514 ndev
->max_mtu
= RIONET_MAX_MTU
;
515 ndev
->features
= NETIF_F_LLTX
;
516 SET_NETDEV_DEV(ndev
, &mport
->dev
);
517 ndev
->ethtool_ops
= &rionet_ethtool_ops
;
519 spin_lock_init(&rnet
->lock
);
520 spin_lock_init(&rnet
->tx_lock
);
522 rnet
->msg_enable
= RIONET_DEFAULT_MSGLEVEL
;
524 rc
= register_netdev(ndev
);
526 free_pages((unsigned long)nets
[mport
->id
].active
,
527 get_order(rionet_active_bytes
));
531 printk(KERN_INFO
"%s: %s %s Version %s, MAC %pM, %s\n",
543 static int rionet_add_dev(struct device
*dev
, struct subsys_interface
*sif
)
546 u32 lsrc_ops
, ldst_ops
;
547 struct rionet_peer
*peer
;
548 struct net_device
*ndev
= NULL
;
549 struct rio_dev
*rdev
= to_rio_dev(dev
);
550 unsigned char netid
= rdev
->net
->hport
->id
;
552 if (netid
>= RIONET_MAX_NETS
)
556 * If first time through this net, make sure local device is rionet
557 * capable and setup netdev (this step will be skipped in later probes
560 if (!nets
[netid
].ndev
) {
561 rio_local_read_config_32(rdev
->net
->hport
, RIO_SRC_OPS_CAR
,
563 rio_local_read_config_32(rdev
->net
->hport
, RIO_DST_OPS_CAR
,
565 if (!is_rionet_capable(lsrc_ops
, ldst_ops
)) {
567 "%s: local device %s is not network capable\n",
568 DRV_NAME
, rdev
->net
->hport
->name
);
572 /* Allocate our net_device structure */
573 ndev
= alloc_etherdev(sizeof(struct rionet_private
));
579 rc
= rionet_setup_netdev(rdev
->net
->hport
, ndev
);
581 printk(KERN_ERR
"%s: failed to setup netdev (rc=%d)\n",
587 INIT_LIST_HEAD(&nets
[netid
].peers
);
588 spin_lock_init(&nets
[netid
].lock
);
589 nets
[netid
].nact
= 0;
590 nets
[netid
].ndev
= ndev
;
594 * If the remote device has mailbox/doorbell capabilities,
595 * add it to the peer list.
597 if (dev_rionet_capable(rdev
)) {
598 struct rionet_private
*rnet
;
601 rnet
= netdev_priv(nets
[netid
].ndev
);
603 peer
= kzalloc(sizeof(*peer
), GFP_KERNEL
);
609 peer
->res
= rio_request_outb_dbell(peer
->rdev
,
610 RIONET_DOORBELL_JOIN
,
611 RIONET_DOORBELL_LEAVE
);
613 pr_err("%s: error requesting doorbells\n", DRV_NAME
);
619 spin_lock_irqsave(&nets
[netid
].lock
, flags
);
620 list_add_tail(&peer
->node
, &nets
[netid
].peers
);
621 spin_unlock_irqrestore(&nets
[netid
].lock
, flags
);
622 pr_debug("%s: %s add peer %s\n",
623 DRV_NAME
, __func__
, rio_name(rdev
));
625 /* If netdev is already opened, send join request to new peer */
627 rio_send_doorbell(peer
->rdev
, RIONET_DOORBELL_JOIN
);
635 static int rionet_shutdown(struct notifier_block
*nb
, unsigned long code
,
638 struct rionet_peer
*peer
;
642 pr_debug("%s: %s\n", DRV_NAME
, __func__
);
644 for (i
= 0; i
< RIONET_MAX_NETS
; i
++) {
648 spin_lock_irqsave(&nets
[i
].lock
, flags
);
649 list_for_each_entry(peer
, &nets
[i
].peers
, node
) {
650 if (nets
[i
].active
[peer
->rdev
->destid
]) {
651 rio_send_doorbell(peer
->rdev
,
652 RIONET_DOORBELL_LEAVE
);
653 nets
[i
].active
[peer
->rdev
->destid
] = NULL
;
656 spin_unlock_irqrestore(&nets
[i
].lock
, flags
);
662 static void rionet_remove_mport(struct device
*dev
,
663 struct class_interface
*class_intf
)
665 struct rio_mport
*mport
= to_rio_mport(dev
);
666 struct net_device
*ndev
;
669 pr_debug("%s %s\n", __func__
, mport
->name
);
671 WARN(nets
[id
].nact
, "%s called when connected to %d peers\n",
672 __func__
, nets
[id
].nact
);
673 WARN(!nets
[id
].ndev
, "%s called for mport without NDEV\n",
677 ndev
= nets
[id
].ndev
;
678 netif_stop_queue(ndev
);
679 unregister_netdev(ndev
);
681 free_pages((unsigned long)nets
[id
].active
,
682 get_order(sizeof(void *) *
683 RIO_MAX_ROUTE_ENTRIES(mport
->sys_size
)));
684 nets
[id
].active
= NULL
;
686 nets
[id
].ndev
= NULL
;
691 static struct rio_device_id rionet_id_table
[] = {
692 {RIO_DEVICE(RIO_ANY_ID
, RIO_ANY_ID
)},
693 { 0, } /* terminate list */
696 MODULE_DEVICE_TABLE(rapidio
, rionet_id_table
);
699 static struct subsys_interface rionet_interface
= {
701 .subsys
= &rio_bus_type
,
702 .add_dev
= rionet_add_dev
,
703 .remove_dev
= rionet_remove_dev
,
706 static struct notifier_block rionet_notifier
= {
707 .notifier_call
= rionet_shutdown
,
710 /* the rio_mport_interface is used to handle local mport devices */
711 static struct class_interface rio_mport_interface __refdata
= {
712 .class = &rio_mport_class
,
714 .remove_dev
= rionet_remove_mport
,
717 static int __init
rionet_init(void)
721 ret
= register_reboot_notifier(&rionet_notifier
);
723 pr_err("%s: failed to register reboot notifier (err=%d)\n",
728 ret
= class_interface_register(&rio_mport_interface
);
730 pr_err("%s: class_interface_register error: %d\n",
735 return subsys_interface_register(&rionet_interface
);
738 static void __exit
rionet_exit(void)
740 unregister_reboot_notifier(&rionet_notifier
);
741 subsys_interface_unregister(&rionet_interface
);
742 class_interface_unregister(&rio_mport_interface
);
745 late_initcall(rionet_init
);
746 module_exit(rionet_exit
);