2 * rionet - Ethernet driver over RapidIO messaging services
4 * Copyright 2005 MontaVista Software, Inc.
5 * Matt Porter <mporter@kernel.crashing.org>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/delay.h>
17 #include <linux/rio.h>
18 #include <linux/rio_drv.h>
19 #include <linux/slab.h>
20 #include <linux/rio_ids.h>
22 #include <linux/netdevice.h>
23 #include <linux/etherdevice.h>
24 #include <linux/skbuff.h>
25 #include <linux/crc32.h>
26 #include <linux/ethtool.h>
27 #include <linux/reboot.h>
29 #define DRV_NAME "rionet"
30 #define DRV_VERSION "0.3"
31 #define DRV_AUTHOR "Matt Porter <mporter@kernel.crashing.org>"
32 #define DRV_DESC "Ethernet over RapidIO"
34 MODULE_AUTHOR(DRV_AUTHOR);
35 MODULE_DESCRIPTION(DRV_DESC);
36 MODULE_LICENSE("GPL");
38 #define RIONET_DEFAULT_MSGLEVEL \
44 #define RIONET_DOORBELL_JOIN 0x1000
45 #define RIONET_DOORBELL_LEAVE 0x1001
47 #define RIONET_MAILBOX 0
49 #define RIONET_TX_RING_SIZE CONFIG_RIONET_TX_SIZE
50 #define RIONET_RX_RING_SIZE CONFIG_RIONET_RX_SIZE
51 #define RIONET_MAX_NETS 8
52 #define RIONET_MSG_SIZE RIO_MAX_MSG_SIZE
53 #define RIONET_MAX_MTU (RIONET_MSG_SIZE - ETH_HLEN)
55 struct rionet_private {
56 struct rio_mport *mport;
57 struct sk_buff *rx_skb[RIONET_RX_RING_SIZE];
58 struct sk_buff *tx_skb[RIONET_TX_RING_SIZE];
70 struct list_head node;
76 struct net_device *ndev;
77 struct list_head peers;
78 spinlock_t lock; /* net info access lock */
79 struct rio_dev **active;
80 int nact; /* number of active peers */
83 static struct rionet_net nets[RIONET_MAX_NETS];
85 #define is_rionet_capable(src_ops, dst_ops) \
86 ((src_ops & RIO_SRC_OPS_DATA_MSG) && \
87 (dst_ops & RIO_DST_OPS_DATA_MSG) && \
88 (src_ops & RIO_SRC_OPS_DOORBELL) && \
89 (dst_ops & RIO_DST_OPS_DOORBELL))
90 #define dev_rionet_capable(dev) \
91 is_rionet_capable(dev->src_ops, dev->dst_ops)
93 #define RIONET_MAC_MATCH(x) (!memcmp((x), "\00\01\00\01", 4))
94 #define RIONET_GET_DESTID(x) ((*((u8 *)x + 4) << 8) | *((u8 *)x + 5))
96 static int rionet_rx_clean(struct net_device *ndev)
100 struct rionet_private *rnet = netdev_priv(ndev);
106 if (!rnet->rx_skb[i])
109 if (!(data = rio_get_inb_message(rnet->mport, RIONET_MAILBOX)))
112 rnet->rx_skb[i]->data = data;
113 skb_put(rnet->rx_skb[i], RIO_MAX_MSG_SIZE);
114 rnet->rx_skb[i]->protocol =
115 eth_type_trans(rnet->rx_skb[i], ndev);
116 error = netif_rx(rnet->rx_skb[i]);
118 if (error == NET_RX_DROP) {
119 ndev->stats.rx_dropped++;
121 ndev->stats.rx_packets++;
122 ndev->stats.rx_bytes += RIO_MAX_MSG_SIZE;
125 } while ((i = (i + 1) % RIONET_RX_RING_SIZE) != rnet->rx_slot);
130 static void rionet_rx_fill(struct net_device *ndev, int end)
133 struct rionet_private *rnet = netdev_priv(ndev);
137 rnet->rx_skb[i] = dev_alloc_skb(RIO_MAX_MSG_SIZE);
139 if (!rnet->rx_skb[i])
142 rio_add_inb_buffer(rnet->mport, RIONET_MAILBOX,
143 rnet->rx_skb[i]->data);
144 } while ((i = (i + 1) % RIONET_RX_RING_SIZE) != end);
149 static int rionet_queue_tx_msg(struct sk_buff *skb, struct net_device *ndev,
150 struct rio_dev *rdev)
152 struct rionet_private *rnet = netdev_priv(ndev);
154 rio_add_outb_message(rnet->mport, rdev, 0, skb->data, skb->len);
155 rnet->tx_skb[rnet->tx_slot] = skb;
157 ndev->stats.tx_packets++;
158 ndev->stats.tx_bytes += skb->len;
160 if (++rnet->tx_cnt == RIONET_TX_RING_SIZE)
161 netif_stop_queue(ndev);
164 rnet->tx_slot &= (RIONET_TX_RING_SIZE - 1);
166 if (netif_msg_tx_queued(rnet))
167 printk(KERN_INFO "%s: queued skb len %8.8x\n", DRV_NAME,
173 static int rionet_start_xmit(struct sk_buff *skb, struct net_device *ndev)
176 struct rionet_private *rnet = netdev_priv(ndev);
177 struct ethhdr *eth = (struct ethhdr *)skb->data;
182 spin_lock_irqsave(&rnet->tx_lock, flags);
184 if (is_multicast_ether_addr(eth->h_dest))
185 add_num = nets[rnet->mport->id].nact;
187 if ((rnet->tx_cnt + add_num) > RIONET_TX_RING_SIZE) {
188 netif_stop_queue(ndev);
189 spin_unlock_irqrestore(&rnet->tx_lock, flags);
190 printk(KERN_ERR "%s: BUG! Tx Ring full when queue awake!\n",
192 return NETDEV_TX_BUSY;
195 if (is_multicast_ether_addr(eth->h_dest)) {
198 for (i = 0; i < RIO_MAX_ROUTE_ENTRIES(rnet->mport->sys_size);
200 if (nets[rnet->mport->id].active[i]) {
201 rionet_queue_tx_msg(skb, ndev,
202 nets[rnet->mport->id].active[i]);
204 atomic_inc(&skb->users);
207 } else if (RIONET_MAC_MATCH(eth->h_dest)) {
208 destid = RIONET_GET_DESTID(eth->h_dest);
209 if (nets[rnet->mport->id].active[destid])
210 rionet_queue_tx_msg(skb, ndev,
211 nets[rnet->mport->id].active[destid]);
214 * If the target device was removed from the list of
215 * active peers but we still have TX packets targeting
216 * it just report sending a packet to the target
217 * (without actual packet transfer).
219 dev_kfree_skb_any(skb);
220 ndev->stats.tx_packets++;
221 ndev->stats.tx_bytes += skb->len;
225 spin_unlock_irqrestore(&rnet->tx_lock, flags);
230 static void rionet_dbell_event(struct rio_mport *mport, void *dev_id, u16 sid, u16 tid,
233 struct net_device *ndev = dev_id;
234 struct rionet_private *rnet = netdev_priv(ndev);
235 struct rionet_peer *peer;
236 unsigned char netid = rnet->mport->id;
238 if (netif_msg_intr(rnet))
239 printk(KERN_INFO "%s: doorbell sid %4.4x tid %4.4x info %4.4x",
240 DRV_NAME, sid, tid, info);
241 if (info == RIONET_DOORBELL_JOIN) {
242 if (!nets[netid].active[sid]) {
243 spin_lock(&nets[netid].lock);
244 list_for_each_entry(peer, &nets[netid].peers, node) {
245 if (peer->rdev->destid == sid) {
246 nets[netid].active[sid] = peer->rdev;
250 spin_unlock(&nets[netid].lock);
252 rio_mport_send_doorbell(mport, sid,
253 RIONET_DOORBELL_JOIN);
255 } else if (info == RIONET_DOORBELL_LEAVE) {
256 spin_lock(&nets[netid].lock);
257 if (nets[netid].active[sid]) {
258 nets[netid].active[sid] = NULL;
261 spin_unlock(&nets[netid].lock);
263 if (netif_msg_intr(rnet))
264 printk(KERN_WARNING "%s: unhandled doorbell\n",
269 static void rionet_inb_msg_event(struct rio_mport *mport, void *dev_id, int mbox, int slot)
272 struct net_device *ndev = dev_id;
273 struct rionet_private *rnet = netdev_priv(ndev);
275 if (netif_msg_intr(rnet))
276 printk(KERN_INFO "%s: inbound message event, mbox %d slot %d\n",
277 DRV_NAME, mbox, slot);
279 spin_lock(&rnet->lock);
280 if ((n = rionet_rx_clean(ndev)) != rnet->rx_slot)
281 rionet_rx_fill(ndev, n);
282 spin_unlock(&rnet->lock);
285 static void rionet_outb_msg_event(struct rio_mport *mport, void *dev_id, int mbox, int slot)
287 struct net_device *ndev = dev_id;
288 struct rionet_private *rnet = netdev_priv(ndev);
290 spin_lock(&rnet->tx_lock);
292 if (netif_msg_intr(rnet))
294 "%s: outbound message event, mbox %d slot %d\n",
295 DRV_NAME, mbox, slot);
297 while (rnet->tx_cnt && (rnet->ack_slot != slot)) {
298 /* dma unmap single */
299 dev_kfree_skb_irq(rnet->tx_skb[rnet->ack_slot]);
300 rnet->tx_skb[rnet->ack_slot] = NULL;
302 rnet->ack_slot &= (RIONET_TX_RING_SIZE - 1);
306 if (rnet->tx_cnt < RIONET_TX_RING_SIZE)
307 netif_wake_queue(ndev);
309 spin_unlock(&rnet->tx_lock);
312 static int rionet_open(struct net_device *ndev)
315 struct rionet_peer *peer;
316 struct rionet_private *rnet = netdev_priv(ndev);
317 unsigned char netid = rnet->mport->id;
320 if (netif_msg_ifup(rnet))
321 printk(KERN_INFO "%s: open\n", DRV_NAME);
323 if ((rc = rio_request_inb_dbell(rnet->mport,
325 RIONET_DOORBELL_JOIN,
326 RIONET_DOORBELL_LEAVE,
327 rionet_dbell_event)) < 0)
330 if ((rc = rio_request_inb_mbox(rnet->mport,
334 rionet_inb_msg_event)) < 0)
337 if ((rc = rio_request_outb_mbox(rnet->mport,
341 rionet_outb_msg_event)) < 0)
344 /* Initialize inbound message ring */
345 for (i = 0; i < RIONET_RX_RING_SIZE; i++)
346 rnet->rx_skb[i] = NULL;
348 rionet_rx_fill(ndev, 0);
354 netif_carrier_on(ndev);
355 netif_start_queue(ndev);
357 spin_lock_irqsave(&nets[netid].lock, flags);
358 list_for_each_entry(peer, &nets[netid].peers, node) {
359 /* Send a join message */
360 rio_send_doorbell(peer->rdev, RIONET_DOORBELL_JOIN);
362 spin_unlock_irqrestore(&nets[netid].lock, flags);
369 static int rionet_close(struct net_device *ndev)
371 struct rionet_private *rnet = netdev_priv(ndev);
372 struct rionet_peer *peer;
373 unsigned char netid = rnet->mport->id;
377 if (netif_msg_ifup(rnet))
378 printk(KERN_INFO "%s: close %s\n", DRV_NAME, ndev->name);
380 netif_stop_queue(ndev);
381 netif_carrier_off(ndev);
384 for (i = 0; i < RIONET_RX_RING_SIZE; i++)
385 kfree_skb(rnet->rx_skb[i]);
387 spin_lock_irqsave(&nets[netid].lock, flags);
388 list_for_each_entry(peer, &nets[netid].peers, node) {
389 if (nets[netid].active[peer->rdev->destid]) {
390 rio_send_doorbell(peer->rdev, RIONET_DOORBELL_LEAVE);
391 nets[netid].active[peer->rdev->destid] = NULL;
394 rio_release_outb_dbell(peer->rdev, peer->res);
396 spin_unlock_irqrestore(&nets[netid].lock, flags);
398 rio_release_inb_dbell(rnet->mport, RIONET_DOORBELL_JOIN,
399 RIONET_DOORBELL_LEAVE);
400 rio_release_inb_mbox(rnet->mport, RIONET_MAILBOX);
401 rio_release_outb_mbox(rnet->mport, RIONET_MAILBOX);
406 static void rionet_remove_dev(struct device *dev, struct subsys_interface *sif)
408 struct rio_dev *rdev = to_rio_dev(dev);
409 unsigned char netid = rdev->net->hport->id;
410 struct rionet_peer *peer;
411 int state, found = 0;
414 if (!dev_rionet_capable(rdev))
417 spin_lock_irqsave(&nets[netid].lock, flags);
418 list_for_each_entry(peer, &nets[netid].peers, node) {
419 if (peer->rdev == rdev) {
420 list_del(&peer->node);
421 if (nets[netid].active[rdev->destid]) {
422 state = atomic_read(&rdev->state);
423 if (state != RIO_DEVICE_GONE &&
424 state != RIO_DEVICE_INITIALIZING) {
425 rio_send_doorbell(rdev,
426 RIONET_DOORBELL_LEAVE);
428 nets[netid].active[rdev->destid] = NULL;
435 spin_unlock_irqrestore(&nets[netid].lock, flags);
439 rio_release_outb_dbell(rdev, peer->res);
444 static void rionet_get_drvinfo(struct net_device *ndev,
445 struct ethtool_drvinfo *info)
447 struct rionet_private *rnet = netdev_priv(ndev);
449 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
450 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
451 strlcpy(info->fw_version, "n/a", sizeof(info->fw_version));
452 strlcpy(info->bus_info, rnet->mport->name, sizeof(info->bus_info));
455 static u32 rionet_get_msglevel(struct net_device *ndev)
457 struct rionet_private *rnet = netdev_priv(ndev);
459 return rnet->msg_enable;
462 static void rionet_set_msglevel(struct net_device *ndev, u32 value)
464 struct rionet_private *rnet = netdev_priv(ndev);
466 rnet->msg_enable = value;
469 static const struct ethtool_ops rionet_ethtool_ops = {
470 .get_drvinfo = rionet_get_drvinfo,
471 .get_msglevel = rionet_get_msglevel,
472 .set_msglevel = rionet_set_msglevel,
473 .get_link = ethtool_op_get_link,
476 static const struct net_device_ops rionet_netdev_ops = {
477 .ndo_open = rionet_open,
478 .ndo_stop = rionet_close,
479 .ndo_start_xmit = rionet_start_xmit,
480 .ndo_validate_addr = eth_validate_addr,
481 .ndo_set_mac_address = eth_mac_addr,
484 static int rionet_setup_netdev(struct rio_mport *mport, struct net_device *ndev)
487 struct rionet_private *rnet;
489 const size_t rionet_active_bytes = sizeof(void *) *
490 RIO_MAX_ROUTE_ENTRIES(mport->sys_size);
492 nets[mport->id].active = (struct rio_dev **)__get_free_pages(GFP_KERNEL,
493 get_order(rionet_active_bytes));
494 if (!nets[mport->id].active) {
498 memset((void *)nets[mport->id].active, 0, rionet_active_bytes);
500 /* Set up private area */
501 rnet = netdev_priv(ndev);
505 /* Set the default MAC address */
506 device_id = rio_local_get_device_id(mport);
507 ndev->dev_addr[0] = 0x00;
508 ndev->dev_addr[1] = 0x01;
509 ndev->dev_addr[2] = 0x00;
510 ndev->dev_addr[3] = 0x01;
511 ndev->dev_addr[4] = device_id >> 8;
512 ndev->dev_addr[5] = device_id & 0xff;
514 ndev->netdev_ops = &rionet_netdev_ops;
515 ndev->mtu = RIONET_MAX_MTU;
516 /* MTU range: 68 - 4082 */
517 ndev->min_mtu = ETH_MIN_MTU;
518 ndev->max_mtu = RIONET_MAX_MTU;
519 ndev->features = NETIF_F_LLTX;
520 SET_NETDEV_DEV(ndev, &mport->dev);
521 ndev->ethtool_ops = &rionet_ethtool_ops;
523 spin_lock_init(&rnet->lock);
524 spin_lock_init(&rnet->tx_lock);
526 rnet->msg_enable = RIONET_DEFAULT_MSGLEVEL;
528 rc = register_netdev(ndev);
530 free_pages((unsigned long)nets[mport->id].active,
531 get_order(rionet_active_bytes));
535 printk(KERN_INFO "%s: %s %s Version %s, MAC %pM, %s\n",
547 static int rionet_add_dev(struct device *dev, struct subsys_interface *sif)
550 u32 lsrc_ops, ldst_ops;
551 struct rionet_peer *peer;
552 struct net_device *ndev = NULL;
553 struct rio_dev *rdev = to_rio_dev(dev);
554 unsigned char netid = rdev->net->hport->id;
556 if (netid >= RIONET_MAX_NETS)
560 * If first time through this net, make sure local device is rionet
561 * capable and setup netdev (this step will be skipped in later probes
564 if (!nets[netid].ndev) {
565 rio_local_read_config_32(rdev->net->hport, RIO_SRC_OPS_CAR,
567 rio_local_read_config_32(rdev->net->hport, RIO_DST_OPS_CAR,
569 if (!is_rionet_capable(lsrc_ops, ldst_ops)) {
571 "%s: local device %s is not network capable\n",
572 DRV_NAME, rdev->net->hport->name);
576 /* Allocate our net_device structure */
577 ndev = alloc_etherdev(sizeof(struct rionet_private));
583 rc = rionet_setup_netdev(rdev->net->hport, ndev);
585 printk(KERN_ERR "%s: failed to setup netdev (rc=%d)\n",
591 INIT_LIST_HEAD(&nets[netid].peers);
592 spin_lock_init(&nets[netid].lock);
593 nets[netid].nact = 0;
594 nets[netid].ndev = ndev;
598 * If the remote device has mailbox/doorbell capabilities,
599 * add it to the peer list.
601 if (dev_rionet_capable(rdev)) {
602 struct rionet_private *rnet;
605 rnet = netdev_priv(nets[netid].ndev);
607 peer = kzalloc(sizeof(*peer), GFP_KERNEL);
613 peer->res = rio_request_outb_dbell(peer->rdev,
614 RIONET_DOORBELL_JOIN,
615 RIONET_DOORBELL_LEAVE);
617 pr_err("%s: error requesting doorbells\n", DRV_NAME);
623 spin_lock_irqsave(&nets[netid].lock, flags);
624 list_add_tail(&peer->node, &nets[netid].peers);
625 spin_unlock_irqrestore(&nets[netid].lock, flags);
626 pr_debug("%s: %s add peer %s\n",
627 DRV_NAME, __func__, rio_name(rdev));
629 /* If netdev is already opened, send join request to new peer */
631 rio_send_doorbell(peer->rdev, RIONET_DOORBELL_JOIN);
639 static int rionet_shutdown(struct notifier_block *nb, unsigned long code,
642 struct rionet_peer *peer;
646 pr_debug("%s: %s\n", DRV_NAME, __func__);
648 for (i = 0; i < RIONET_MAX_NETS; i++) {
652 spin_lock_irqsave(&nets[i].lock, flags);
653 list_for_each_entry(peer, &nets[i].peers, node) {
654 if (nets[i].active[peer->rdev->destid]) {
655 rio_send_doorbell(peer->rdev,
656 RIONET_DOORBELL_LEAVE);
657 nets[i].active[peer->rdev->destid] = NULL;
660 spin_unlock_irqrestore(&nets[i].lock, flags);
666 static void rionet_remove_mport(struct device *dev,
667 struct class_interface *class_intf)
669 struct rio_mport *mport = to_rio_mport(dev);
670 struct net_device *ndev;
673 pr_debug("%s %s\n", __func__, mport->name);
675 WARN(nets[id].nact, "%s called when connected to %d peers\n",
676 __func__, nets[id].nact);
677 WARN(!nets[id].ndev, "%s called for mport without NDEV\n",
681 ndev = nets[id].ndev;
682 netif_stop_queue(ndev);
683 unregister_netdev(ndev);
685 free_pages((unsigned long)nets[id].active,
686 get_order(sizeof(void *) *
687 RIO_MAX_ROUTE_ENTRIES(mport->sys_size)));
688 nets[id].active = NULL;
690 nets[id].ndev = NULL;
695 static struct rio_device_id rionet_id_table[] = {
696 {RIO_DEVICE(RIO_ANY_ID, RIO_ANY_ID)},
697 { 0, } /* terminate list */
700 MODULE_DEVICE_TABLE(rapidio, rionet_id_table);
703 static struct subsys_interface rionet_interface = {
705 .subsys = &rio_bus_type,
706 .add_dev = rionet_add_dev,
707 .remove_dev = rionet_remove_dev,
710 static struct notifier_block rionet_notifier = {
711 .notifier_call = rionet_shutdown,
714 /* the rio_mport_interface is used to handle local mport devices */
715 static struct class_interface rio_mport_interface __refdata = {
716 .class = &rio_mport_class,
718 .remove_dev = rionet_remove_mport,
721 static int __init rionet_init(void)
725 ret = register_reboot_notifier(&rionet_notifier);
727 pr_err("%s: failed to register reboot notifier (err=%d)\n",
732 ret = class_interface_register(&rio_mport_interface);
734 pr_err("%s: class_interface_register error: %d\n",
739 return subsys_interface_register(&rionet_interface);
742 static void __exit rionet_exit(void)
744 unregister_reboot_notifier(&rionet_notifier);
745 subsys_interface_unregister(&rionet_interface);
746 class_interface_unregister(&rio_mport_interface);
749 late_initcall(rionet_init);
750 module_exit(rionet_exit);