2 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
17 * Maintained at www.Open-FCoE.org
20 #include <linux/types.h>
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/list.h>
24 #include <linux/netdevice.h>
25 #include <linux/errno.h>
26 #include <linux/crc32.h>
27 #include <scsi/libfcoe.h>
31 MODULE_AUTHOR("Open-FCoE.org");
32 MODULE_DESCRIPTION("FIP discovery protocol and FCoE transport for FCoE HBAs");
33 MODULE_LICENSE("GPL v2");
35 static int fcoe_transport_create(const char *, struct kernel_param *);
36 static int fcoe_transport_destroy(const char *, struct kernel_param *);
37 static int fcoe_transport_show(char *buffer, const struct kernel_param *kp);
38 static struct fcoe_transport *fcoe_transport_lookup(struct net_device *device);
39 static struct fcoe_transport *fcoe_netdev_map_lookup(struct net_device *device);
40 static int fcoe_transport_enable(const char *, struct kernel_param *);
41 static int fcoe_transport_disable(const char *, struct kernel_param *);
42 static int libfcoe_device_notification(struct notifier_block *notifier,
43 ulong event, void *ptr);
45 static LIST_HEAD(fcoe_transports);
46 static DEFINE_MUTEX(ft_mutex);
47 static LIST_HEAD(fcoe_netdevs);
48 static DEFINE_MUTEX(fn_mutex);
50 unsigned int libfcoe_debug_logging;
51 module_param_named(debug_logging, libfcoe_debug_logging, int, S_IRUGO|S_IWUSR);
52 MODULE_PARM_DESC(debug_logging, "a bit mask of logging levels");
54 module_param_call(show, NULL, fcoe_transport_show, NULL, S_IRUSR);
55 __MODULE_PARM_TYPE(show, "string");
56 MODULE_PARM_DESC(show, " Show attached FCoE transports");
58 module_param_call(create, fcoe_transport_create, NULL,
59 (void *)FIP_MODE_FABRIC, S_IWUSR);
60 __MODULE_PARM_TYPE(create, "string");
61 MODULE_PARM_DESC(create, " Creates fcoe instance on a ethernet interface");
63 module_param_call(create_vn2vn, fcoe_transport_create, NULL,
64 (void *)FIP_MODE_VN2VN, S_IWUSR);
65 __MODULE_PARM_TYPE(create_vn2vn, "string");
66 MODULE_PARM_DESC(create_vn2vn, " Creates a VN_node to VN_node FCoE instance "
67 "on an Ethernet interface");
69 module_param_call(destroy, fcoe_transport_destroy, NULL, NULL, S_IWUSR);
70 __MODULE_PARM_TYPE(destroy, "string");
71 MODULE_PARM_DESC(destroy, " Destroys fcoe instance on a ethernet interface");
73 module_param_call(enable, fcoe_transport_enable, NULL, NULL, S_IWUSR);
74 __MODULE_PARM_TYPE(enable, "string");
75 MODULE_PARM_DESC(enable, " Enables fcoe on a ethernet interface.");
77 module_param_call(disable, fcoe_transport_disable, NULL, NULL, S_IWUSR);
78 __MODULE_PARM_TYPE(disable, "string");
79 MODULE_PARM_DESC(disable, " Disables fcoe on a ethernet interface.");
81 /* notification function for packets from net device */
82 static struct notifier_block libfcoe_notifier = {
83 .notifier_call = libfcoe_device_notification,
86 void fcoe_wwn_to_str(u64 wwn, char *buf, int len)
90 u64_to_wwn(wwn, wwpn);
91 snprintf(buf, len, "%02x%02x%02x%02x%02x%02x%02x%02x",
92 wwpn[0], wwpn[1], wwpn[2], wwpn[3],
93 wwpn[4], wwpn[5], wwpn[6], wwpn[7]);
95 EXPORT_SYMBOL_GPL(fcoe_wwn_to_str);
98 * fcoe_validate_vport_create() - Validate a vport before creating it
99 * @vport: NPIV port to be created
101 * This routine is meant to add validation for a vport before creating it
102 * via fcoe_vport_create().
103 * Current validations are:
104 * - WWPN supplied is unique for given lport
106 int fcoe_validate_vport_create(struct fc_vport *vport)
108 struct Scsi_Host *shost = vport_to_shost(vport);
109 struct fc_lport *n_port = shost_priv(shost);
110 struct fc_lport *vn_port;
114 mutex_lock(&n_port->lp_mutex);
116 fcoe_wwn_to_str(vport->port_name, buf, sizeof(buf));
117 /* Check if the wwpn is not same as that of the lport */
118 if (!memcmp(&n_port->wwpn, &vport->port_name, sizeof(u64))) {
119 LIBFCOE_TRANSPORT_DBG("vport WWPN 0x%s is same as that of the "
120 "base port WWPN\n", buf);
125 /* Check if there is any existing vport with same wwpn */
126 list_for_each_entry(vn_port, &n_port->vports, list) {
127 if (!memcmp(&vn_port->wwpn, &vport->port_name, sizeof(u64))) {
128 LIBFCOE_TRANSPORT_DBG("vport with given WWPN 0x%s "
129 "already exists\n", buf);
135 mutex_unlock(&n_port->lp_mutex);
138 EXPORT_SYMBOL_GPL(fcoe_validate_vport_create);
141 * fcoe_get_wwn() - Get the world wide name from LLD if it supports it
142 * @netdev: the associated net device
143 * @wwn: the output WWN
144 * @type: the type of WWN (WWPN or WWNN)
146 * Returns: 0 for success
148 int fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type)
150 const struct net_device_ops *ops = netdev->netdev_ops;
152 if (ops->ndo_fcoe_get_wwn)
153 return ops->ndo_fcoe_get_wwn(netdev, wwn, type);
156 EXPORT_SYMBOL_GPL(fcoe_get_wwn);
159 * fcoe_fc_crc() - Calculates the CRC for a given frame
160 * @fp: The frame to be checksumed
162 * This uses crc32() routine to calculate the CRC for a frame
164 * Return: The 32 bit CRC value
166 u32 fcoe_fc_crc(struct fc_frame *fp)
168 struct sk_buff *skb = fp_skb(fp);
169 struct skb_frag_struct *frag;
171 unsigned long off, len, clen;
175 crc = crc32(~0, skb->data, skb_headlen(skb));
177 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
178 frag = &skb_shinfo(skb)->frags[i];
179 off = frag->page_offset;
182 clen = min(len, PAGE_SIZE - (off & ~PAGE_MASK));
184 skb_frag_page(frag) + (off >> PAGE_SHIFT),
185 KM_SKB_DATA_SOFTIRQ);
186 crc = crc32(crc, data + (off & ~PAGE_MASK), clen);
187 kunmap_atomic(data, KM_SKB_DATA_SOFTIRQ);
194 EXPORT_SYMBOL_GPL(fcoe_fc_crc);
197 * fcoe_start_io() - Start FCoE I/O
198 * @skb: The packet to be transmitted
200 * This routine is called from the net device to start transmitting
203 * Returns: 0 for success
205 int fcoe_start_io(struct sk_buff *skb)
207 struct sk_buff *nskb;
210 nskb = skb_clone(skb, GFP_ATOMIC);
213 rc = dev_queue_xmit(nskb);
219 EXPORT_SYMBOL_GPL(fcoe_start_io);
223 * fcoe_clean_pending_queue() - Dequeue a skb and free it
224 * @lport: The local port to dequeue a skb on
226 void fcoe_clean_pending_queue(struct fc_lport *lport)
228 struct fcoe_port *port = lport_priv(lport);
231 spin_lock_bh(&port->fcoe_pending_queue.lock);
232 while ((skb = __skb_dequeue(&port->fcoe_pending_queue)) != NULL) {
233 spin_unlock_bh(&port->fcoe_pending_queue.lock);
235 spin_lock_bh(&port->fcoe_pending_queue.lock);
237 spin_unlock_bh(&port->fcoe_pending_queue.lock);
239 EXPORT_SYMBOL_GPL(fcoe_clean_pending_queue);
242 * fcoe_check_wait_queue() - Attempt to clear the transmit backlog
243 * @lport: The local port whose backlog is to be cleared
245 * This empties the wait_queue, dequeues the head of the wait_queue queue
246 * and calls fcoe_start_io() for each packet. If all skb have been
247 * transmitted it returns the qlen. If an error occurs it restores
248 * wait_queue (to try again later) and returns -1.
250 * The wait_queue is used when the skb transmit fails. The failed skb
251 * will go in the wait_queue which will be emptied by the timer function or
252 * by the next skb transmit.
254 void fcoe_check_wait_queue(struct fc_lport *lport, struct sk_buff *skb)
256 struct fcoe_port *port = lport_priv(lport);
259 spin_lock_bh(&port->fcoe_pending_queue.lock);
262 __skb_queue_tail(&port->fcoe_pending_queue, skb);
264 if (port->fcoe_pending_queue_active)
266 port->fcoe_pending_queue_active = 1;
268 while (port->fcoe_pending_queue.qlen) {
269 /* keep qlen > 0 until fcoe_start_io succeeds */
270 port->fcoe_pending_queue.qlen++;
271 skb = __skb_dequeue(&port->fcoe_pending_queue);
273 spin_unlock_bh(&port->fcoe_pending_queue.lock);
274 rc = fcoe_start_io(skb);
275 spin_lock_bh(&port->fcoe_pending_queue.lock);
278 __skb_queue_head(&port->fcoe_pending_queue, skb);
279 /* undo temporary increment above */
280 port->fcoe_pending_queue.qlen--;
283 /* undo temporary increment above */
284 port->fcoe_pending_queue.qlen--;
287 if (port->fcoe_pending_queue.qlen < port->min_queue_depth)
289 if (port->fcoe_pending_queue.qlen && !timer_pending(&port->timer))
290 mod_timer(&port->timer, jiffies + 2);
291 port->fcoe_pending_queue_active = 0;
293 if (port->fcoe_pending_queue.qlen > port->max_queue_depth)
295 spin_unlock_bh(&port->fcoe_pending_queue.lock);
297 EXPORT_SYMBOL_GPL(fcoe_check_wait_queue);
300 * fcoe_queue_timer() - The fcoe queue timer
301 * @lport: The local port
303 * Calls fcoe_check_wait_queue on timeout
305 void fcoe_queue_timer(ulong lport)
307 fcoe_check_wait_queue((struct fc_lport *)lport, NULL);
309 EXPORT_SYMBOL_GPL(fcoe_queue_timer);
312 * fcoe_get_paged_crc_eof() - Allocate a page to be used for the trailer CRC
313 * @skb: The packet to be transmitted
314 * @tlen: The total length of the trailer
315 * @fps: The fcoe context
317 * This routine allocates a page for frame trailers. The page is re-used if
318 * there is enough room left on it for the current trailer. If there isn't
319 * enough buffer left a new page is allocated for the trailer. Reference to
320 * the page from this function as well as the skbs using the page fragments
321 * ensure that the page is freed at the appropriate time.
323 * Returns: 0 for success
325 int fcoe_get_paged_crc_eof(struct sk_buff *skb, int tlen,
326 struct fcoe_percpu_s *fps)
330 page = fps->crc_eof_page;
332 page = alloc_page(GFP_ATOMIC);
336 fps->crc_eof_page = page;
337 fps->crc_eof_offset = 0;
341 skb_fill_page_desc(skb, skb_shinfo(skb)->nr_frags, page,
342 fps->crc_eof_offset, tlen);
344 skb->data_len += tlen;
345 skb->truesize += tlen;
346 fps->crc_eof_offset += sizeof(struct fcoe_crc_eof);
348 if (fps->crc_eof_offset >= PAGE_SIZE) {
349 fps->crc_eof_page = NULL;
350 fps->crc_eof_offset = 0;
356 EXPORT_SYMBOL_GPL(fcoe_get_paged_crc_eof);
359 * fcoe_transport_lookup - find an fcoe transport that matches a netdev
360 * @netdev: The netdev to look for from all attached transports
362 * Returns : ptr to the fcoe transport that supports this netdev or NULL
365 * The ft_mutex should be held when this is called
367 static struct fcoe_transport *fcoe_transport_lookup(struct net_device *netdev)
369 struct fcoe_transport *ft = NULL;
371 list_for_each_entry(ft, &fcoe_transports, list)
372 if (ft->match && ft->match(netdev))
378 * fcoe_transport_attach - Attaches an FCoE transport
379 * @ft: The fcoe transport to be attached
381 * Returns : 0 for success
383 int fcoe_transport_attach(struct fcoe_transport *ft)
387 mutex_lock(&ft_mutex);
389 LIBFCOE_TRANSPORT_DBG("transport %s already attached\n",
395 /* Add default transport to the tail */
396 if (strcmp(ft->name, FCOE_TRANSPORT_DEFAULT))
397 list_add(&ft->list, &fcoe_transports);
399 list_add_tail(&ft->list, &fcoe_transports);
402 LIBFCOE_TRANSPORT_DBG("attaching transport %s\n", ft->name);
405 mutex_unlock(&ft_mutex);
408 EXPORT_SYMBOL(fcoe_transport_attach);
411 * fcoe_transport_detach - Detaches an FCoE transport
412 * @ft: The fcoe transport to be attached
414 * Returns : 0 for success
416 int fcoe_transport_detach(struct fcoe_transport *ft)
419 struct fcoe_netdev_mapping *nm = NULL, *tmp;
421 mutex_lock(&ft_mutex);
423 LIBFCOE_TRANSPORT_DBG("transport %s already detached\n",
429 /* remove netdev mapping for this transport as it is going away */
430 mutex_lock(&fn_mutex);
431 list_for_each_entry_safe(nm, tmp, &fcoe_netdevs, list) {
433 LIBFCOE_TRANSPORT_DBG("transport %s going away, "
434 "remove its netdev mapping for %s\n",
435 ft->name, nm->netdev->name);
440 mutex_unlock(&fn_mutex);
443 ft->attached = false;
444 LIBFCOE_TRANSPORT_DBG("detaching transport %s\n", ft->name);
447 mutex_unlock(&ft_mutex);
451 EXPORT_SYMBOL(fcoe_transport_detach);
453 static int fcoe_transport_show(char *buffer, const struct kernel_param *kp)
456 struct fcoe_transport *ft = NULL;
458 i = j = sprintf(buffer, "Attached FCoE transports:");
459 mutex_lock(&ft_mutex);
460 list_for_each_entry(ft, &fcoe_transports, list) {
461 if (i >= PAGE_SIZE - IFNAMSIZ)
463 i += snprintf(&buffer[i], IFNAMSIZ, "%s ", ft->name);
465 mutex_unlock(&ft_mutex);
467 i += snprintf(&buffer[i], IFNAMSIZ, "none");
471 static int __init fcoe_transport_init(void)
473 register_netdevice_notifier(&libfcoe_notifier);
477 static int __exit fcoe_transport_exit(void)
479 struct fcoe_transport *ft;
481 unregister_netdevice_notifier(&libfcoe_notifier);
482 mutex_lock(&ft_mutex);
483 list_for_each_entry(ft, &fcoe_transports, list)
484 printk(KERN_ERR "FCoE transport %s is still attached!\n",
486 mutex_unlock(&ft_mutex);
491 static int fcoe_add_netdev_mapping(struct net_device *netdev,
492 struct fcoe_transport *ft)
494 struct fcoe_netdev_mapping *nm;
496 nm = kmalloc(sizeof(*nm), GFP_KERNEL);
498 printk(KERN_ERR "Unable to allocate netdev_mapping");
505 mutex_lock(&fn_mutex);
506 list_add(&nm->list, &fcoe_netdevs);
507 mutex_unlock(&fn_mutex);
512 static void fcoe_del_netdev_mapping(struct net_device *netdev)
514 struct fcoe_netdev_mapping *nm = NULL, *tmp;
516 mutex_lock(&fn_mutex);
517 list_for_each_entry_safe(nm, tmp, &fcoe_netdevs, list) {
518 if (nm->netdev == netdev) {
521 mutex_unlock(&fn_mutex);
525 mutex_unlock(&fn_mutex);
530 * fcoe_netdev_map_lookup - find the fcoe transport that matches the netdev on which
533 * Returns : ptr to the fcoe transport that supports this netdev or NULL
536 * The ft_mutex should be held when this is called
538 static struct fcoe_transport *fcoe_netdev_map_lookup(struct net_device *netdev)
540 struct fcoe_transport *ft = NULL;
541 struct fcoe_netdev_mapping *nm;
543 mutex_lock(&fn_mutex);
544 list_for_each_entry(nm, &fcoe_netdevs, list) {
545 if (netdev == nm->netdev) {
547 mutex_unlock(&fn_mutex);
552 mutex_unlock(&fn_mutex);
557 * fcoe_if_to_netdev() - Parse a name buffer to get a net device
558 * @buffer: The name of the net device
560 * Returns: NULL or a ptr to net_device
562 static struct net_device *fcoe_if_to_netdev(const char *buffer)
565 char ifname[IFNAMSIZ + 2];
568 strlcpy(ifname, buffer, IFNAMSIZ);
569 cp = ifname + strlen(ifname);
570 while (--cp >= ifname && *cp == '\n')
572 return dev_get_by_name(&init_net, ifname);
578 * libfcoe_device_notification() - Handler for net device events
579 * @notifier: The context of the notification
580 * @event: The type of event
581 * @ptr: The net device that the event was on
583 * This function is called by the Ethernet driver in case of link change event.
585 * Returns: 0 for success
587 static int libfcoe_device_notification(struct notifier_block *notifier,
588 ulong event, void *ptr)
590 struct net_device *netdev = ptr;
593 case NETDEV_UNREGISTER:
594 printk(KERN_ERR "libfcoe_device_notification: NETDEV_UNREGISTER %s\n",
596 fcoe_del_netdev_mapping(netdev);
604 * fcoe_transport_create() - Create a fcoe interface
605 * @buffer: The name of the Ethernet interface to create on
606 * @kp: The associated kernel param
608 * Called from sysfs. This holds the ft_mutex while calling the
609 * registered fcoe transport's create function.
611 * Returns: 0 for success
613 static int fcoe_transport_create(const char *buffer, struct kernel_param *kp)
616 struct net_device *netdev = NULL;
617 struct fcoe_transport *ft = NULL;
618 enum fip_state fip_mode = (enum fip_state)(long)kp->arg;
620 mutex_lock(&ft_mutex);
622 netdev = fcoe_if_to_netdev(buffer);
624 LIBFCOE_TRANSPORT_DBG("Invalid device %s.\n", buffer);
628 ft = fcoe_netdev_map_lookup(netdev);
630 LIBFCOE_TRANSPORT_DBG("transport %s already has existing "
631 "FCoE instance on %s.\n",
632 ft->name, netdev->name);
637 ft = fcoe_transport_lookup(netdev);
639 LIBFCOE_TRANSPORT_DBG("no FCoE transport found for %s.\n",
644 rc = fcoe_add_netdev_mapping(netdev, ft);
646 LIBFCOE_TRANSPORT_DBG("failed to add new netdev mapping "
647 "for FCoE transport %s for %s.\n",
648 ft->name, netdev->name);
652 /* pass to transport create */
653 rc = ft->create ? ft->create(netdev, fip_mode) : -ENODEV;
655 fcoe_del_netdev_mapping(netdev);
657 LIBFCOE_TRANSPORT_DBG("transport %s %s to create fcoe on %s.\n",
658 ft->name, (rc) ? "failed" : "succeeded",
664 mutex_unlock(&ft_mutex);
669 * fcoe_transport_destroy() - Destroy a FCoE interface
670 * @buffer: The name of the Ethernet interface to be destroyed
671 * @kp: The associated kernel parameter
673 * Called from sysfs. This holds the ft_mutex while calling the
674 * registered fcoe transport's destroy function.
676 * Returns: 0 for success
678 static int fcoe_transport_destroy(const char *buffer, struct kernel_param *kp)
681 struct net_device *netdev = NULL;
682 struct fcoe_transport *ft = NULL;
684 mutex_lock(&ft_mutex);
686 netdev = fcoe_if_to_netdev(buffer);
688 LIBFCOE_TRANSPORT_DBG("invalid device %s.\n", buffer);
692 ft = fcoe_netdev_map_lookup(netdev);
694 LIBFCOE_TRANSPORT_DBG("no FCoE transport found for %s.\n",
699 /* pass to transport destroy */
700 rc = ft->destroy ? ft->destroy(netdev) : -ENODEV;
701 fcoe_del_netdev_mapping(netdev);
702 LIBFCOE_TRANSPORT_DBG("transport %s %s to destroy fcoe on %s.\n",
703 ft->name, (rc) ? "failed" : "succeeded",
709 mutex_unlock(&ft_mutex);
714 * fcoe_transport_disable() - Disables a FCoE interface
715 * @buffer: The name of the Ethernet interface to be disabled
716 * @kp: The associated kernel parameter
720 * Returns: 0 for success
722 static int fcoe_transport_disable(const char *buffer, struct kernel_param *kp)
725 struct net_device *netdev = NULL;
726 struct fcoe_transport *ft = NULL;
728 mutex_lock(&ft_mutex);
730 netdev = fcoe_if_to_netdev(buffer);
734 ft = fcoe_netdev_map_lookup(netdev);
738 rc = ft->disable ? ft->disable(netdev) : -ENODEV;
743 mutex_unlock(&ft_mutex);
745 if (rc == -ERESTARTSYS)
746 return restart_syscall();
752 * fcoe_transport_enable() - Enables a FCoE interface
753 * @buffer: The name of the Ethernet interface to be enabled
754 * @kp: The associated kernel parameter
758 * Returns: 0 for success
760 static int fcoe_transport_enable(const char *buffer, struct kernel_param *kp)
763 struct net_device *netdev = NULL;
764 struct fcoe_transport *ft = NULL;
766 mutex_lock(&ft_mutex);
768 netdev = fcoe_if_to_netdev(buffer);
772 ft = fcoe_netdev_map_lookup(netdev);
776 rc = ft->enable ? ft->enable(netdev) : -ENODEV;
781 mutex_unlock(&ft_mutex);
786 * libfcoe_init() - Initialization routine for libfcoe.ko
788 static int __init libfcoe_init(void)
790 fcoe_transport_init();
794 module_init(libfcoe_init);
797 * libfcoe_exit() - Tear down libfcoe.ko
799 static void __exit libfcoe_exit(void)
801 fcoe_transport_exit();
803 module_exit(libfcoe_exit);