2  * Copyright(c) 2007 - 2008 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/module.h>
 
  21 #include <linux/version.h>
 
  22 #include <linux/kernel.h>
 
  23 #include <linux/pci.h>
 
  24 #include <linux/init.h>
 
  25 #include <linux/spinlock.h>
 
  26 #include <linux/netdevice.h>
 
  27 #include <linux/etherdevice.h>
 
  28 #include <linux/if_vlan.h>
 
  29 #include <net/rtnetlink.h>
 
  31 #include <scsi/fc/fc_els.h>
 
  32 #include <scsi/fc/fc_encaps.h>
 
  33 #include <scsi/fc/fc_fs.h>
 
  34 #include <scsi/scsi_transport.h>
 
  35 #include <scsi/scsi_transport_fc.h>
 
  37 #include <scsi/libfc.h>
 
  38 #include <scsi/libfcoe.h>
 
  39 #include <scsi/fc_transport_fcoe.h>
 
  41 #define FCOE_SW_VERSION "0.1"
 
  42 #define FCOE_SW_NAME    "fcoesw"
 
  43 #define FCOE_SW_VENDOR  "Open-FCoE.org"
 
  45 #define FCOE_MAX_LUN            255
 
  46 #define FCOE_MAX_FCP_TARGET     256
 
  48 #define FCOE_MAX_OUTSTANDING_COMMANDS   1024
 
  50 #define FCOE_MIN_XID            0x0001  /* the min xid supported by fcoe_sw */
 
  51 #define FCOE_MAX_XID            0x07ef  /* the max xid supported by fcoe_sw */
 
  53 static struct scsi_transport_template *scsi_transport_fcoe_sw;
 
  55 struct fc_function_template fcoe_sw_transport_function = {
 
  56         .show_host_node_name = 1,
 
  57         .show_host_port_name = 1,
 
  58         .show_host_supported_classes = 1,
 
  59         .show_host_supported_fc4s = 1,
 
  60         .show_host_active_fc4s = 1,
 
  61         .show_host_maxframe_size = 1,
 
  63         .show_host_port_id = 1,
 
  64         .show_host_supported_speeds = 1,
 
  65         .get_host_speed = fc_get_host_speed,
 
  67         .show_host_port_type = 1,
 
  68         .get_host_port_state = fc_get_host_port_state,
 
  69         .show_host_port_state = 1,
 
  70         .show_host_symbolic_name = 1,
 
  72         .dd_fcrport_size = sizeof(struct fc_rport_libfc_priv),
 
  73         .show_rport_maxframe_size = 1,
 
  74         .show_rport_supported_classes = 1,
 
  76         .show_host_fabric_name = 1,
 
  77         .show_starget_node_name = 1,
 
  78         .show_starget_port_name = 1,
 
  79         .show_starget_port_id = 1,
 
  80         .set_rport_dev_loss_tmo = fc_set_rport_loss_tmo,
 
  81         .show_rport_dev_loss_tmo = 1,
 
  82         .get_fc_host_stats = fc_get_host_stats,
 
  83         .issue_fc_host_lip = fcoe_reset,
 
  85         .terminate_rport_io = fc_rport_terminate_io,
 
  88 static struct scsi_host_template fcoe_sw_shost_template = {
 
  89         .module = THIS_MODULE,
 
  90         .name = "FCoE Driver",
 
  91         .proc_name = FCOE_SW_NAME,
 
  92         .queuecommand = fc_queuecommand,
 
  93         .eh_abort_handler = fc_eh_abort,
 
  94         .eh_device_reset_handler = fc_eh_device_reset,
 
  95         .eh_host_reset_handler = fc_eh_host_reset,
 
  96         .slave_alloc = fc_slave_alloc,
 
  97         .change_queue_depth = fc_change_queue_depth,
 
  98         .change_queue_type = fc_change_queue_type,
 
 101         .can_queue = FCOE_MAX_OUTSTANDING_COMMANDS,
 
 102         .use_clustering = ENABLE_CLUSTERING,
 
 103         .sg_tablesize = SG_ALL,
 
 104         .max_sectors = 0xffff,
 
 108  * fcoe_sw_lport_config - sets up the fc_lport
 
 109  * @lp: ptr to the fc_lport
 
 110  * @shost: ptr to the parent scsi host
 
 112  * Returns: 0 for success
 
 115 static int fcoe_sw_lport_config(struct fc_lport *lp)
 
 120         lp->max_retry_count = 3;
 
 121         lp->e_d_tov = 2 * 1000; /* FC-FS default */
 
 122         lp->r_a_tov = 2 * 2 * 1000;
 
 123         lp->service_params = (FCP_SPPF_INIT_FCN | FCP_SPPF_RD_XRDY_DIS |
 
 124                               FCP_SPPF_RETRY | FCP_SPPF_CONF_COMPL);
 
 127          * allocate per cpu stats block
 
 129         for_each_online_cpu(i)
 
 130                 lp->dev_stats[i] = kzalloc(sizeof(struct fcoe_dev_stats),
 
 133         /* lport fc_lport related configuration */
 
 140  * fcoe_sw_netdev_config - sets up fcoe_softc for lport and network
 
 142  * @lp : ptr to the fc_lport
 
 143  * @netdev : ptr to the associated netdevice struct
 
 145  * Must be called after fcoe_sw_lport_config() as it will use lport mutex
 
 147  * Returns : 0 for success
 
 150 static int fcoe_sw_netdev_config(struct fc_lport *lp, struct net_device *netdev)
 
 154         struct fcoe_softc *fc;
 
 155         u8 flogi_maddr[ETH_ALEN];
 
 157         /* Setup lport private data to point to fcoe softc */
 
 160         fc->real_dev = netdev;
 
 161         fc->phys_dev = netdev;
 
 163         /* Require support for get_pauseparam ethtool op. */
 
 164         if (netdev->priv_flags & IFF_802_1Q_VLAN)
 
 165                 fc->phys_dev = vlan_dev_real_dev(netdev);
 
 167         /* Do not support for bonding device */
 
 168         if ((fc->real_dev->priv_flags & IFF_MASTER_ALB) ||
 
 169             (fc->real_dev->priv_flags & IFF_SLAVE_INACTIVE) ||
 
 170             (fc->real_dev->priv_flags & IFF_MASTER_8023AD)) {
 
 175          * Determine max frame size based on underlying device and optional
 
 176          * user-configured limit.  If the MFS is too low, fcoe_link_ok()
 
 177          * will return 0, so do this first.
 
 179         mfs = fc->real_dev->mtu - (sizeof(struct fcoe_hdr) +
 
 180                                    sizeof(struct fcoe_crc_eof));
 
 181         if (fc_set_mfs(lp, mfs))
 
 184         lp->link_status = ~FC_PAUSE & ~FC_LINK_UP;
 
 185         if (!fcoe_link_ok(lp))
 
 186                 lp->link_status |= FC_LINK_UP;
 
 188         /* offload features support */
 
 189         if (fc->real_dev->features & NETIF_F_SG)
 
 193         skb_queue_head_init(&fc->fcoe_pending_queue);
 
 195         /* setup Source Mac Address */
 
 196         memcpy(fc->ctl_src_addr, fc->real_dev->dev_addr,
 
 197                fc->real_dev->addr_len);
 
 199         wwnn = fcoe_wwn_from_mac(fc->real_dev->dev_addr, 1, 0);
 
 200         fc_set_wwnn(lp, wwnn);
 
 201         /* XXX - 3rd arg needs to be vlan id */
 
 202         wwpn = fcoe_wwn_from_mac(fc->real_dev->dev_addr, 2, 0);
 
 203         fc_set_wwpn(lp, wwpn);
 
 206          * Add FCoE MAC address as second unicast MAC address
 
 207          * or enter promiscuous mode if not capable of listening
 
 208          * for multiple unicast MACs.
 
 211         memcpy(flogi_maddr, (u8[6]) FC_FCOE_FLOGI_MAC, ETH_ALEN);
 
 212         dev_unicast_add(fc->real_dev, flogi_maddr, ETH_ALEN);
 
 216          * setup the receive function from ethernet driver
 
 217          * on the ethertype for the given device
 
 219         fc->fcoe_packet_type.func = fcoe_rcv;
 
 220         fc->fcoe_packet_type.type = __constant_htons(ETH_P_FCOE);
 
 221         fc->fcoe_packet_type.dev = fc->real_dev;
 
 222         dev_add_pack(&fc->fcoe_packet_type);
 
 228  * fcoe_sw_shost_config - sets up fc_lport->host
 
 229  * @lp : ptr to the fc_lport
 
 230  * @shost : ptr to the associated scsi host
 
 231  * @dev : device associated to scsi host
 
 233  * Must be called after fcoe_sw_lport_config) and fcoe_sw_netdev_config()
 
 235  * Returns : 0 for success
 
 238 static int fcoe_sw_shost_config(struct fc_lport *lp, struct Scsi_Host *shost,
 
 243         /* lport scsi host config */
 
 246         lp->host->max_lun = FCOE_MAX_LUN;
 
 247         lp->host->max_id = FCOE_MAX_FCP_TARGET;
 
 248         lp->host->max_channel = 0;
 
 249         lp->host->transportt = scsi_transport_fcoe_sw;
 
 251         /* add the new host to the SCSI-ml */
 
 252         rc = scsi_add_host(lp->host, dev);
 
 254                 FC_DBG("fcoe_sw_shost_config:error on scsi_add_host\n");
 
 257         sprintf(fc_host_symbolic_name(lp->host), "%s v%s over %s",
 
 258                 FCOE_SW_NAME, FCOE_SW_VERSION,
 
 259                 fcoe_netdev(lp)->name);
 
 265  * fcoe_sw_em_config - allocates em for this lport
 
 266  * @lp: the port that em is to allocated for
 
 268  * Returns : 0 on success
 
 270 static inline int fcoe_sw_em_config(struct fc_lport *lp)
 
 274         lp->emp = fc_exch_mgr_alloc(lp, FC_CLASS_3,
 
 275                                     FCOE_MIN_XID, FCOE_MAX_XID);
 
 283  * fcoe_sw_destroy - FCoE software HBA tear-down function
 
 284  * @netdev: ptr to the associated net_device
 
 286  * Returns: 0 if link is OK for use by FCoE.
 
 288 static int fcoe_sw_destroy(struct net_device *netdev)
 
 291         struct fc_lport *lp = NULL;
 
 292         struct fcoe_softc *fc;
 
 293         u8 flogi_maddr[ETH_ALEN];
 
 297         printk(KERN_DEBUG "fcoe_sw_destroy:interface on %s\n",
 
 300         lp = fcoe_hostlist_lookup(netdev);
 
 306         /* Logout of the fabric */
 
 307         fc_fabric_logoff(lp);
 
 309         /* Remove the instance from fcoe's list */
 
 310         fcoe_hostlist_remove(lp);
 
 312         /* Don't listen for Ethernet packets anymore */
 
 313         dev_remove_pack(&fc->fcoe_packet_type);
 
 315         /* Cleanup the fc_lport */
 
 316         fc_lport_destroy(lp);
 
 319         /* Detach from the scsi-ml */
 
 320         fc_remove_host(lp->host);
 
 321         scsi_remove_host(lp->host);
 
 323         /* There are no more rports or I/O, free the EM */
 
 325                 fc_exch_mgr_free(lp->emp);
 
 327         /* Delete secondary MAC addresses */
 
 329         memcpy(flogi_maddr, (u8[6]) FC_FCOE_FLOGI_MAC, ETH_ALEN);
 
 330         dev_unicast_delete(fc->real_dev, flogi_maddr, ETH_ALEN);
 
 331         if (compare_ether_addr(fc->data_src_addr, (u8[6]) { 0 }))
 
 332                 dev_unicast_delete(fc->real_dev, fc->data_src_addr, ETH_ALEN);
 
 335         /* Free the per-CPU revieve threads */
 
 336         fcoe_percpu_clean(lp);
 
 338         /* Free existing skbs */
 
 339         fcoe_clean_pending_queue(lp);
 
 341         /* Free memory used by statistical counters */
 
 342         for_each_online_cpu(cpu)
 
 343                 kfree(lp->dev_stats[cpu]);
 
 345         /* Release the net_device and Scsi_Host */
 
 346         dev_put(fc->real_dev);
 
 347         scsi_host_put(lp->host);
 
 352 static struct libfc_function_template fcoe_sw_libfc_fcn_templ = {
 
 353         .frame_send = fcoe_xmit,
 
 357  * fcoe_sw_create - this function creates the fcoe interface
 
 358  * @netdev: pointer the associated netdevice
 
 360  * Creates fc_lport struct and scsi_host for lport, configures lport
 
 361  * and starts fabric login.
 
 363  * Returns : 0 on success
 
 365 static int fcoe_sw_create(struct net_device *netdev)
 
 368         struct fc_lport *lp = NULL;
 
 369         struct fcoe_softc *fc;
 
 370         struct Scsi_Host *shost;
 
 374         printk(KERN_DEBUG "fcoe_sw_create:interface on %s\n",
 
 377         lp = fcoe_hostlist_lookup(netdev);
 
 381         shost = fcoe_host_alloc(&fcoe_sw_shost_template,
 
 382                                 sizeof(struct fcoe_softc));
 
 384                 FC_DBG("Could not allocate host structure\n");
 
 387         lp = shost_priv(shost);
 
 390         /* configure fc_lport, e.g., em */
 
 391         rc = fcoe_sw_lport_config(lp);
 
 393                 FC_DBG("Could not configure lport\n");
 
 397         /* configure lport network properties */
 
 398         rc = fcoe_sw_netdev_config(lp, netdev);
 
 400                 FC_DBG("Could not configure netdev for lport\n");
 
 404         /* configure lport scsi host properties */
 
 405         rc = fcoe_sw_shost_config(lp, shost, &netdev->dev);
 
 407                 FC_DBG("Could not configure shost for lport\n");
 
 411         /* lport exch manager allocation */
 
 412         rc = fcoe_sw_em_config(lp);
 
 414                 FC_DBG("Could not configure em for lport\n");
 
 418         /* Initialize the library */
 
 419         rc = fcoe_libfc_config(lp, &fcoe_sw_libfc_fcn_templ);
 
 421                 FC_DBG("Could not configure libfc for lport!\n");
 
 425         /* add to lports list */
 
 426         fcoe_hostlist_add(lp);
 
 428         lp->boot_time = jiffies;
 
 437         fc_exch_mgr_free(lp->emp); /* Free the EM */
 
 439         scsi_host_put(lp->host);
 
 444  * fcoe_sw_match - the fcoe sw transport match function
 
 446  * Returns : false always
 
 448 static bool fcoe_sw_match(struct net_device *netdev)
 
 450         /* FIXME - for sw transport, always return false */
 
 454 /* the sw hba fcoe transport */
 
 455 struct fcoe_transport fcoe_sw_transport = {
 
 457         .create = fcoe_sw_create,
 
 458         .destroy = fcoe_sw_destroy,
 
 459         .match = fcoe_sw_match,
 
 465  * fcoe_sw_init - registers fcoe_sw_transport
 
 467  * Returns : 0 on success
 
 469 int __init fcoe_sw_init(void)
 
 471         /* attach to scsi transport */
 
 472         scsi_transport_fcoe_sw =
 
 473                 fc_attach_transport(&fcoe_sw_transport_function);
 
 474         if (!scsi_transport_fcoe_sw) {
 
 475                 printk(KERN_ERR "fcoe_sw_init:fc_attach_transport() failed\n");
 
 478         /* register sw transport */
 
 479         fcoe_transport_register(&fcoe_sw_transport);
 
 484  * fcoe_sw_exit - unregisters fcoe_sw_transport
 
 486  * Returns : 0 on success
 
 488 int __exit fcoe_sw_exit(void)
 
 490         /* dettach the transport */
 
 491         fc_release_transport(scsi_transport_fcoe_sw);
 
 492         fcoe_transport_unregister(&fcoe_sw_transport);