2 * Copyright (c) 2008-2009 Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2009 Intel Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 * Maintained at www.Open-FCoE.org
21 #include <linux/types.h>
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/list.h>
25 #include <linux/spinlock.h>
26 #include <linux/timer.h>
27 #include <linux/netdevice.h>
28 #include <linux/etherdevice.h>
29 #include <linux/ethtool.h>
30 #include <linux/if_ether.h>
31 #include <linux/if_vlan.h>
32 #include <linux/netdevice.h>
33 #include <linux/errno.h>
34 #include <linux/bitops.h>
35 #include <net/rtnetlink.h>
37 #include <scsi/fc/fc_els.h>
38 #include <scsi/fc/fc_fs.h>
39 #include <scsi/fc/fc_fip.h>
40 #include <scsi/fc/fc_encaps.h>
41 #include <scsi/fc/fc_fcoe.h>
43 #include <scsi/libfc.h>
44 #include <scsi/libfcoe.h>
46 MODULE_AUTHOR("Open-FCoE.org");
47 MODULE_DESCRIPTION("FIP discovery protocol support for FCoE HBAs");
48 MODULE_LICENSE("GPL v2");
50 #define FCOE_CTLR_MIN_FKA 500 /* min keep alive (mS) */
51 #define FCOE_CTLR_DEF_FKA FIP_DEF_FKA /* default keep alive (mS) */
53 static void fcoe_ctlr_timeout(unsigned long);
54 static void fcoe_ctlr_link_work(struct work_struct *);
55 static void fcoe_ctlr_recv_work(struct work_struct *);
57 static u8 fcoe_all_fcfs[ETH_ALEN] = FIP_ALL_FCF_MACS;
59 static u32 fcoe_ctlr_debug; /* 1 for basic, 2 for noisy debug */
61 #define FIP_DBG_LVL(level, fmt, args...) \
63 if (fcoe_ctlr_debug >= (level)) \
64 FC_DBG(fmt, ##args); \
67 #define FIP_DBG(fmt, args...) FIP_DBG_LVL(1, fmt, ##args)
70 * Return non-zero if FCF fcoe_size has been validated.
72 static inline int fcoe_ctlr_mtu_valid(const struct fcoe_fcf *fcf)
74 return (fcf->flags & FIP_FL_SOL) != 0;
78 * Return non-zero if the FCF is usable.
80 static inline int fcoe_ctlr_fcf_usable(struct fcoe_fcf *fcf)
82 u16 flags = FIP_FL_SOL | FIP_FL_AVAIL;
84 return (fcf->flags & flags) == flags;
88 * fcoe_ctlr_init() - Initialize the FCoE Controller instance.
89 * @fip: FCoE controller.
91 void fcoe_ctlr_init(struct fcoe_ctlr *fip)
93 fip->state = FIP_ST_LINK_WAIT;
94 INIT_LIST_HEAD(&fip->fcfs);
95 spin_lock_init(&fip->lock);
96 fip->flogi_oxid = FC_XID_UNKNOWN;
97 setup_timer(&fip->timer, fcoe_ctlr_timeout, (unsigned long)fip);
98 INIT_WORK(&fip->link_work, fcoe_ctlr_link_work);
99 INIT_WORK(&fip->recv_work, fcoe_ctlr_recv_work);
100 skb_queue_head_init(&fip->fip_recv_list);
102 EXPORT_SYMBOL(fcoe_ctlr_init);
105 * fcoe_ctlr_reset_fcfs() - Reset and free all FCFs for a controller.
106 * @fip: FCoE controller.
108 * Called with &fcoe_ctlr lock held.
110 static void fcoe_ctlr_reset_fcfs(struct fcoe_ctlr *fip)
112 struct fcoe_fcf *fcf;
113 struct fcoe_fcf *next;
116 list_for_each_entry_safe(fcf, next, &fip->fcfs, list) {
117 list_del(&fcf->list);
125 * fcoe_ctlr_destroy() - Disable and tear-down the FCoE controller.
126 * @fip: FCoE controller.
128 * This is called by FCoE drivers before freeing the &fcoe_ctlr.
130 * The receive handler will have been deleted before this to guarantee
131 * that no more recv_work will be scheduled.
133 * The timer routine will simply return once we set FIP_ST_DISABLED.
134 * This guarantees that no further timeouts or work will be scheduled.
136 void fcoe_ctlr_destroy(struct fcoe_ctlr *fip)
138 flush_work(&fip->recv_work);
139 spin_lock_bh(&fip->lock);
140 fip->state = FIP_ST_DISABLED;
141 fcoe_ctlr_reset_fcfs(fip);
142 spin_unlock_bh(&fip->lock);
143 del_timer_sync(&fip->timer);
144 flush_work(&fip->link_work);
146 EXPORT_SYMBOL(fcoe_ctlr_destroy);
149 * fcoe_ctlr_fcoe_size() - Return the maximum FCoE size required for VN_Port.
150 * @fip: FCoE controller.
152 * Returns the maximum packet size including the FCoE header and trailer,
153 * but not including any Ethernet or VLAN headers.
155 static inline u32 fcoe_ctlr_fcoe_size(struct fcoe_ctlr *fip)
158 * Determine the max FCoE frame size allowed, including
159 * FCoE header and trailer.
160 * Note: lp->mfs is currently the payload size, not the frame size.
162 return fip->lp->mfs + sizeof(struct fc_frame_header) +
163 sizeof(struct fcoe_hdr) + sizeof(struct fcoe_crc_eof);
167 * fcoe_ctlr_solicit() - Send a solicitation.
168 * @fip: FCoE controller.
169 * @fcf: Destination FCF. If NULL, a multicast solicitation is sent.
171 static void fcoe_ctlr_solicit(struct fcoe_ctlr *fip, struct fcoe_fcf *fcf)
176 struct fip_header fip;
178 struct fip_mac_desc mac;
179 struct fip_wwn_desc wwnn;
180 struct fip_size_desc size;
181 } __attribute__((packed)) desc;
182 } __attribute__((packed)) *sol;
185 skb = dev_alloc_skb(sizeof(*sol));
189 sol = (struct fip_sol *)skb->data;
191 memset(sol, 0, sizeof(*sol));
192 memcpy(sol->eth.h_dest, fcf ? fcf->fcf_mac : fcoe_all_fcfs, ETH_ALEN);
193 memcpy(sol->eth.h_source, fip->ctl_src_addr, ETH_ALEN);
194 sol->eth.h_proto = htons(ETH_P_FIP);
196 sol->fip.fip_ver = FIP_VER_ENCAPS(FIP_VER);
197 sol->fip.fip_op = htons(FIP_OP_DISC);
198 sol->fip.fip_subcode = FIP_SC_SOL;
199 sol->fip.fip_dl_len = htons(sizeof(sol->desc) / FIP_BPW);
200 sol->fip.fip_flags = htons(FIP_FL_FPMA);
202 sol->fip.fip_flags |= htons(FIP_FL_SPMA);
204 sol->desc.mac.fd_desc.fip_dtype = FIP_DT_MAC;
205 sol->desc.mac.fd_desc.fip_dlen = sizeof(sol->desc.mac) / FIP_BPW;
206 memcpy(sol->desc.mac.fd_mac, fip->ctl_src_addr, ETH_ALEN);
208 sol->desc.wwnn.fd_desc.fip_dtype = FIP_DT_NAME;
209 sol->desc.wwnn.fd_desc.fip_dlen = sizeof(sol->desc.wwnn) / FIP_BPW;
210 put_unaligned_be64(fip->lp->wwnn, &sol->desc.wwnn.fd_wwn);
212 fcoe_size = fcoe_ctlr_fcoe_size(fip);
213 sol->desc.size.fd_desc.fip_dtype = FIP_DT_FCOE_SIZE;
214 sol->desc.size.fd_desc.fip_dlen = sizeof(sol->desc.size) / FIP_BPW;
215 sol->desc.size.fd_size = htons(fcoe_size);
217 skb_put(skb, sizeof(*sol));
218 skb->protocol = htons(ETH_P_FIP);
219 skb_reset_mac_header(skb);
220 skb_reset_network_header(skb);
224 fip->sol_time = jiffies;
228 * fcoe_ctlr_link_up() - Start FCoE controller.
229 * @fip: FCoE controller.
231 * Called from the LLD when the network link is ready.
233 void fcoe_ctlr_link_up(struct fcoe_ctlr *fip)
235 spin_lock_bh(&fip->lock);
236 if (fip->state == FIP_ST_NON_FIP || fip->state == FIP_ST_AUTO) {
239 spin_unlock_bh(&fip->lock);
241 } else if (fip->state == FIP_ST_LINK_WAIT) {
242 fip->state = FIP_ST_AUTO;
245 spin_unlock_bh(&fip->lock);
246 FIP_DBG("%s", "setting AUTO mode.\n");
248 fcoe_ctlr_solicit(fip, NULL);
250 spin_unlock_bh(&fip->lock);
252 EXPORT_SYMBOL(fcoe_ctlr_link_up);
255 * fcoe_ctlr_reset() - Reset FIP.
256 * @fip: FCoE controller.
257 * @new_state: FIP state to be entered.
259 * Returns non-zero if the link was up and now isn't.
261 static int fcoe_ctlr_reset(struct fcoe_ctlr *fip, enum fip_state new_state)
263 struct fc_lport *lp = fip->lp;
266 spin_lock_bh(&fip->lock);
267 fcoe_ctlr_reset_fcfs(fip);
268 del_timer(&fip->timer);
269 fip->state = new_state;
270 fip->ctlr_ka_time = 0;
271 fip->port_ka_time = 0;
273 fip->flogi_oxid = FC_XID_UNKNOWN;
276 link_dropped = fip->link;
278 spin_unlock_bh(&fip->lock);
283 if (new_state == FIP_ST_ENABLED) {
284 fcoe_ctlr_solicit(fip, NULL);
292 * fcoe_ctlr_link_down() - Stop FCoE controller.
293 * @fip: FCoE controller.
295 * Returns non-zero if the link was up and now isn't.
297 * Called from the LLD when the network link is not ready.
298 * There may be multiple calls while the link is down.
300 int fcoe_ctlr_link_down(struct fcoe_ctlr *fip)
302 return fcoe_ctlr_reset(fip, FIP_ST_LINK_WAIT);
304 EXPORT_SYMBOL(fcoe_ctlr_link_down);
307 * fcoe_ctlr_send_keep_alive() - Send a keep-alive to the selected FCF.
308 * @fip: FCoE controller.
309 * @ports: 0 for controller keep-alive, 1 for port keep-alive.
310 * @sa: source MAC address.
312 * A controller keep-alive is sent every fka_period (typically 8 seconds).
313 * The source MAC is the native MAC address.
315 * A port keep-alive is sent every 90 seconds while logged in.
316 * The source MAC is the assigned mapped source address.
317 * The destination is the FCF's F-port.
319 static void fcoe_ctlr_send_keep_alive(struct fcoe_ctlr *fip, int ports, u8 *sa)
324 struct fip_header fip;
325 struct fip_mac_desc mac;
326 } __attribute__((packed)) *kal;
327 struct fip_vn_desc *vn;
330 struct fcoe_fcf *fcf;
334 if (!fcf || !fc_host_port_id(lp->host))
337 len = fcoe_ctlr_fcoe_size(fip) + sizeof(struct ethhdr);
338 BUG_ON(len < sizeof(*kal) + sizeof(*vn));
339 skb = dev_alloc_skb(len);
343 kal = (struct fip_kal *)skb->data;
345 memcpy(kal->eth.h_dest, fcf->fcf_mac, ETH_ALEN);
346 memcpy(kal->eth.h_source, sa, ETH_ALEN);
347 kal->eth.h_proto = htons(ETH_P_FIP);
349 kal->fip.fip_ver = FIP_VER_ENCAPS(FIP_VER);
350 kal->fip.fip_op = htons(FIP_OP_CTRL);
351 kal->fip.fip_subcode = FIP_SC_KEEP_ALIVE;
352 kal->fip.fip_dl_len = htons((sizeof(kal->mac) +
353 ports * sizeof(*vn)) / FIP_BPW);
354 kal->fip.fip_flags = htons(FIP_FL_FPMA);
356 kal->fip.fip_flags |= htons(FIP_FL_SPMA);
358 kal->mac.fd_desc.fip_dtype = FIP_DT_MAC;
359 kal->mac.fd_desc.fip_dlen = sizeof(kal->mac) / FIP_BPW;
360 memcpy(kal->mac.fd_mac, fip->ctl_src_addr, ETH_ALEN);
363 vn = (struct fip_vn_desc *)(kal + 1);
364 vn->fd_desc.fip_dtype = FIP_DT_VN_ID;
365 vn->fd_desc.fip_dlen = sizeof(*vn) / FIP_BPW;
366 memcpy(vn->fd_mac, fip->data_src_addr, ETH_ALEN);
367 hton24(vn->fd_fc_id, fc_host_port_id(lp->host));
368 put_unaligned_be64(lp->wwpn, &vn->fd_wwpn);
372 skb->protocol = htons(ETH_P_FIP);
373 skb_reset_mac_header(skb);
374 skb_reset_network_header(skb);
379 * fcoe_ctlr_encaps() - Encapsulate an ELS frame for FIP, without sending it.
380 * @fip: FCoE controller.
381 * @dtype: FIP descriptor type for the frame.
382 * @skb: FCoE ELS frame including FC header but no FCoE headers.
384 * Returns non-zero error code on failure.
386 * The caller must check that the length is a multiple of 4.
388 * The @skb must have enough headroom (28 bytes) and tailroom (8 bytes).
389 * Headroom includes the FIP encapsulation description, FIP header, and
390 * Ethernet header. The tailroom is for the FIP MAC descriptor.
392 static int fcoe_ctlr_encaps(struct fcoe_ctlr *fip,
393 u8 dtype, struct sk_buff *skb)
395 struct fip_encaps_head {
397 struct fip_header fip;
398 struct fip_encaps encaps;
399 } __attribute__((packed)) *cap;
400 struct fip_mac_desc *mac;
401 struct fcoe_fcf *fcf;
407 dlen = sizeof(struct fip_encaps) + skb->len; /* len before push */
408 cap = (struct fip_encaps_head *)skb_push(skb, sizeof(*cap));
410 memset(cap, 0, sizeof(*cap));
411 memcpy(cap->eth.h_dest, fcf->fcf_mac, ETH_ALEN);
412 memcpy(cap->eth.h_source, fip->ctl_src_addr, ETH_ALEN);
413 cap->eth.h_proto = htons(ETH_P_FIP);
415 cap->fip.fip_ver = FIP_VER_ENCAPS(FIP_VER);
416 cap->fip.fip_op = htons(FIP_OP_LS);
417 cap->fip.fip_subcode = FIP_SC_REQ;
418 cap->fip.fip_dl_len = htons((dlen + sizeof(*mac)) / FIP_BPW);
419 cap->fip.fip_flags = htons(FIP_FL_FPMA);
421 cap->fip.fip_flags |= htons(FIP_FL_SPMA);
423 cap->encaps.fd_desc.fip_dtype = dtype;
424 cap->encaps.fd_desc.fip_dlen = dlen / FIP_BPW;
426 mac = (struct fip_mac_desc *)skb_put(skb, sizeof(*mac));
427 memset(mac, 0, sizeof(mac));
428 mac->fd_desc.fip_dtype = FIP_DT_MAC;
429 mac->fd_desc.fip_dlen = sizeof(*mac) / FIP_BPW;
430 if (dtype != FIP_DT_FLOGI)
431 memcpy(mac->fd_mac, fip->data_src_addr, ETH_ALEN);
433 memcpy(mac->fd_mac, fip->ctl_src_addr, ETH_ALEN);
435 skb->protocol = htons(ETH_P_FIP);
436 skb_reset_mac_header(skb);
437 skb_reset_network_header(skb);
442 * fcoe_ctlr_els_send() - Send an ELS frame encapsulated by FIP if appropriate.
443 * @fip: FCoE controller.
444 * @skb: FCoE ELS frame including FC header but no FCoE headers.
446 * Returns a non-zero error code if the frame should not be sent.
447 * Returns zero if the caller should send the frame with FCoE encapsulation.
449 * The caller must check that the length is a multiple of 4.
450 * The SKB must have enough headroom (28 bytes) and tailroom (8 bytes).
452 int fcoe_ctlr_els_send(struct fcoe_ctlr *fip, struct sk_buff *skb)
454 struct fc_frame_header *fh;
458 fh = (struct fc_frame_header *)skb->data;
459 op = *(u8 *)(fh + 1);
461 if (op == ELS_FLOGI) {
462 old_xid = fip->flogi_oxid;
463 fip->flogi_oxid = ntohs(fh->fh_ox_id);
464 if (fip->state == FIP_ST_AUTO) {
465 if (old_xid == FC_XID_UNKNOWN)
466 fip->flogi_count = 0;
468 if (fip->flogi_count < 3)
473 if (fip->state == FIP_ST_NON_FIP)
477 if (fip->state == FIP_ST_NON_FIP)
485 if (ntoh24(fh->fh_s_id))
490 if (fip->state != FIP_ST_ENABLED)
492 if (ntoh24(fh->fh_d_id) != FC_FID_FLOGI)
497 if (fip->flogi_oxid == FC_XID_UNKNOWN)
499 if (!ntoh24(fh->fh_s_id))
501 if (fip->state == FIP_ST_AUTO)
504 * Here we must've gotten an SID by accepting an FLOGI
505 * from a point-to-point connection. Switch to using
506 * the source mac based on the SID. The destination
507 * MAC in this case would have been set by receving the
510 fip->flogi_oxid = FC_XID_UNKNOWN;
511 fc_fcoe_set_mac(fip->data_src_addr, fh->fh_s_id);
514 if (fip->state != FIP_ST_ENABLED)
518 if (fcoe_ctlr_encaps(fip, op, skb))
526 EXPORT_SYMBOL(fcoe_ctlr_els_send);
529 * fcoe_ctlr_age_fcfs() - Reset and free all old FCFs for a controller.
530 * @fip: FCoE controller.
532 * Called with lock held.
534 * An FCF is considered old if we have missed three advertisements.
535 * That is, there have been no valid advertisement from it for three
536 * times its keep-alive period including fuzz.
538 * In addition, determine the time when an FCF selection can occur.
540 static void fcoe_ctlr_age_fcfs(struct fcoe_ctlr *fip)
542 struct fcoe_fcf *fcf;
543 struct fcoe_fcf *next;
544 unsigned long sel_time = 0;
546 list_for_each_entry_safe(fcf, next, &fip->fcfs, list) {
547 if (time_after(jiffies, fcf->time + fcf->fka_period * 3 +
548 msecs_to_jiffies(FIP_FCF_FUZZ * 3))) {
549 if (fip->sel_fcf == fcf)
551 list_del(&fcf->list);
552 WARN_ON(!fip->fcf_count);
555 } else if (fcoe_ctlr_mtu_valid(fcf) &&
556 (!sel_time || time_before(sel_time, fcf->time))) {
557 sel_time = fcf->time;
561 sel_time += msecs_to_jiffies(FCOE_CTLR_START_DELAY);
562 fip->sel_time = sel_time;
563 if (time_before(sel_time, fip->timer.expires))
564 mod_timer(&fip->timer, sel_time);
571 * fcoe_ctlr_parse_adv() - Decode a FIP advertisement into a new FCF entry.
572 * @skb: received FIP advertisement frame
573 * @fcf: resulting FCF entry.
575 * Returns zero on a valid parsed advertisement,
576 * otherwise returns non zero value.
578 static int fcoe_ctlr_parse_adv(struct sk_buff *skb, struct fcoe_fcf *fcf)
580 struct fip_header *fiph;
581 struct fip_desc *desc = NULL;
582 struct fip_wwn_desc *wwn;
583 struct fip_fab_desc *fab;
584 struct fip_fka_desc *fka;
589 memset(fcf, 0, sizeof(*fcf));
590 fcf->fka_period = msecs_to_jiffies(FCOE_CTLR_DEF_FKA);
592 fiph = (struct fip_header *)skb->data;
593 fcf->flags = ntohs(fiph->fip_flags);
595 rlen = ntohs(fiph->fip_dl_len) * 4;
596 if (rlen + sizeof(*fiph) > skb->len)
599 desc = (struct fip_desc *)(fiph + 1);
601 dlen = desc->fip_dlen * FIP_BPW;
602 if (dlen < sizeof(*desc) || dlen > rlen)
604 switch (desc->fip_dtype) {
606 if (dlen != sizeof(struct fip_pri_desc))
608 fcf->pri = ((struct fip_pri_desc *)desc)->fd_pri;
611 if (dlen != sizeof(struct fip_mac_desc))
614 ((struct fip_mac_desc *)desc)->fd_mac,
616 if (!is_valid_ether_addr(fcf->fcf_mac)) {
617 FIP_DBG("invalid MAC addr in FIP adv\n");
622 if (dlen != sizeof(struct fip_wwn_desc))
624 wwn = (struct fip_wwn_desc *)desc;
625 fcf->switch_name = get_unaligned_be64(&wwn->fd_wwn);
628 if (dlen != sizeof(struct fip_fab_desc))
630 fab = (struct fip_fab_desc *)desc;
631 fcf->fabric_name = get_unaligned_be64(&fab->fd_wwn);
632 fcf->vfid = ntohs(fab->fd_vfid);
633 fcf->fc_map = ntoh24(fab->fd_map);
636 if (dlen != sizeof(struct fip_fka_desc))
638 fka = (struct fip_fka_desc *)desc;
639 t = ntohl(fka->fd_fka_period);
640 if (t >= FCOE_CTLR_MIN_FKA)
641 fcf->fka_period = msecs_to_jiffies(t);
644 case FIP_DT_FCOE_SIZE:
650 FIP_DBG("unexpected descriptor type %x in FIP adv\n",
652 /* standard says ignore unknown descriptors >= 128 */
653 if (desc->fip_dtype < FIP_DT_VENDOR_BASE)
657 desc = (struct fip_desc *)((char *)desc + dlen);
660 if (!fcf->fc_map || (fcf->fc_map & 0x10000))
662 if (!fcf->switch_name || !fcf->fabric_name)
667 FIP_DBG("FIP length error in descriptor type %x len %zu\n",
668 desc->fip_dtype, dlen);
673 * fcoe_ctlr_recv_adv() - Handle an incoming advertisement.
674 * @fip: FCoE controller.
675 * @skb: Received FIP packet.
677 static void fcoe_ctlr_recv_adv(struct fcoe_ctlr *fip, struct sk_buff *skb)
679 struct fcoe_fcf *fcf;
681 struct fcoe_fcf *found;
682 unsigned long sol_tov = msecs_to_jiffies(FCOE_CTRL_SOL_TOV);
686 if (fcoe_ctlr_parse_adv(skb, &new))
689 spin_lock_bh(&fip->lock);
690 first = list_empty(&fip->fcfs);
692 list_for_each_entry(fcf, &fip->fcfs, list) {
693 if (fcf->switch_name == new.switch_name &&
694 fcf->fabric_name == new.fabric_name &&
695 fcf->fc_map == new.fc_map &&
696 compare_ether_addr(fcf->fcf_mac, new.fcf_mac) == 0) {
702 if (fip->fcf_count >= FCOE_CTLR_FCF_LIMIT)
705 fcf = kmalloc(sizeof(*fcf), GFP_ATOMIC);
710 memcpy(fcf, &new, sizeof(new));
711 list_add(&fcf->list, &fip->fcfs);
714 * Flags in advertisements are ignored once the FCF is
715 * selected. Flags in unsolicited advertisements are
716 * ignored after a usable solicited advertisement
719 if (fcf == fip->sel_fcf) {
720 fip->ctlr_ka_time -= fcf->fka_period;
721 fip->ctlr_ka_time += new.fka_period;
722 if (time_before(fip->ctlr_ka_time, fip->timer.expires))
723 mod_timer(&fip->timer, fip->ctlr_ka_time);
724 } else if (!fcoe_ctlr_fcf_usable(fcf))
725 fcf->flags = new.flags;
726 fcf->fka_period = new.fka_period;
727 memcpy(fcf->fcf_mac, new.fcf_mac, ETH_ALEN);
729 mtu_valid = fcoe_ctlr_mtu_valid(fcf);
731 FIP_DBG_LVL(found ? 2 : 1, "%s FCF for fab %llx map %x val %d\n",
732 found ? "old" : "new",
733 fcf->fabric_name, fcf->fc_map, mtu_valid);
736 * If this advertisement is not solicited and our max receive size
737 * hasn't been verified, send a solicited advertisement.
740 fcoe_ctlr_solicit(fip, fcf);
743 * If its been a while since we did a solicit, and this is
744 * the first advertisement we've received, do a multicast
745 * solicitation to gather as many advertisements as we can
746 * before selection occurs.
748 if (first && time_after(jiffies, fip->sol_time + sol_tov))
749 fcoe_ctlr_solicit(fip, NULL);
752 * If this is the first validated FCF, note the time and
753 * set a timer to trigger selection.
755 if (mtu_valid && !fip->sel_time && fcoe_ctlr_fcf_usable(fcf)) {
756 fip->sel_time = jiffies +
757 msecs_to_jiffies(FCOE_CTLR_START_DELAY);
758 if (!timer_pending(&fip->timer) ||
759 time_before(fip->sel_time, fip->timer.expires))
760 mod_timer(&fip->timer, fip->sel_time);
763 spin_unlock_bh(&fip->lock);
767 * fcoe_ctlr_recv_els() - Handle an incoming FIP-encapsulated ELS frame.
768 * @fip: FCoE controller.
769 * @skb: Received FIP packet.
771 static void fcoe_ctlr_recv_els(struct fcoe_ctlr *fip, struct sk_buff *skb)
773 struct fc_lport *lp = fip->lp;
774 struct fip_header *fiph;
776 struct fc_frame_header *fh = NULL;
777 struct fip_desc *desc;
778 struct fip_encaps *els;
779 struct fcoe_dev_stats *stats;
780 enum fip_desc_type els_dtype = 0;
783 u8 granted_mac[ETH_ALEN] = { 0 };
788 fiph = (struct fip_header *)skb->data;
789 sub = fiph->fip_subcode;
790 if (sub != FIP_SC_REQ && sub != FIP_SC_REP)
793 rlen = ntohs(fiph->fip_dl_len) * 4;
794 if (rlen + sizeof(*fiph) > skb->len)
797 desc = (struct fip_desc *)(fiph + 1);
799 dlen = desc->fip_dlen * FIP_BPW;
800 if (dlen < sizeof(*desc) || dlen > rlen)
802 switch (desc->fip_dtype) {
804 if (dlen != sizeof(struct fip_mac_desc))
807 ((struct fip_mac_desc *)desc)->fd_mac,
809 if (!is_valid_ether_addr(granted_mac)) {
810 FIP_DBG("invalid MAC addrs in FIP ELS\n");
820 if (dlen < sizeof(*els) + sizeof(*fh) + 1)
822 els_len = dlen - sizeof(*els);
823 els = (struct fip_encaps *)desc;
824 fh = (struct fc_frame_header *)(els + 1);
825 els_dtype = desc->fip_dtype;
828 FIP_DBG("unexpected descriptor type %x "
829 "in FIP adv\n", desc->fip_dtype);
830 /* standard says ignore unknown descriptors >= 128 */
831 if (desc->fip_dtype < FIP_DT_VENDOR_BASE)
835 desc = (struct fip_desc *)((char *)desc + dlen);
841 els_op = *(u8 *)(fh + 1);
843 if (els_dtype == FIP_DT_FLOGI && sub == FIP_SC_REP &&
844 fip->flogi_oxid == ntohs(fh->fh_ox_id) &&
845 els_op == ELS_LS_ACC && is_valid_ether_addr(granted_mac)) {
846 fip->flogi_oxid = FC_XID_UNKNOWN;
847 fip->update_mac(fip, fip->data_src_addr, granted_mac);
848 memcpy(fip->data_src_addr, granted_mac, ETH_ALEN);
852 * Convert skb into an fc_frame containing only the ELS.
854 skb_pull(skb, (u8 *)fh - skb->data);
855 skb_trim(skb, els_len);
856 fp = (struct fc_frame *)skb;
858 fr_sof(fp) = FC_SOF_I3;
859 fr_eof(fp) = FC_EOF_T;
862 stats = fc_lport_get_stats(lp);
864 stats->RxWords += skb->len / FIP_BPW;
866 fc_exch_recv(lp, lp->emp, fp);
870 FIP_DBG("FIP length error in descriptor type %x len %zu\n",
871 desc->fip_dtype, dlen);
877 * fcoe_ctlr_recv_els() - Handle an incoming link reset frame.
878 * @fip: FCoE controller.
879 * @fh: Received FIP header.
881 * There may be multiple VN_Port descriptors.
882 * The overall length has already been checked.
884 static void fcoe_ctlr_recv_clr_vlink(struct fcoe_ctlr *fip,
885 struct fip_header *fh)
887 struct fip_desc *desc;
888 struct fip_mac_desc *mp;
889 struct fip_wwn_desc *wp;
890 struct fip_vn_desc *vp;
893 struct fcoe_fcf *fcf = fip->sel_fcf;
894 struct fc_lport *lp = fip->lp;
897 FIP_DBG("Clear Virtual Link received\n");
900 if (!fcf || !fc_host_port_id(lp->host))
904 * mask of required descriptors. Validating each one clears its bit.
906 desc_mask = BIT(FIP_DT_MAC) | BIT(FIP_DT_NAME) | BIT(FIP_DT_VN_ID);
908 rlen = ntohs(fh->fip_dl_len) * FIP_BPW;
909 desc = (struct fip_desc *)(fh + 1);
910 while (rlen >= sizeof(*desc)) {
911 dlen = desc->fip_dlen * FIP_BPW;
914 switch (desc->fip_dtype) {
916 mp = (struct fip_mac_desc *)desc;
917 if (dlen < sizeof(*mp))
919 if (compare_ether_addr(mp->fd_mac, fcf->fcf_mac))
921 desc_mask &= ~BIT(FIP_DT_MAC);
924 wp = (struct fip_wwn_desc *)desc;
925 if (dlen < sizeof(*wp))
927 if (get_unaligned_be64(&wp->fd_wwn) != fcf->switch_name)
929 desc_mask &= ~BIT(FIP_DT_NAME);
932 vp = (struct fip_vn_desc *)desc;
933 if (dlen < sizeof(*vp))
935 if (compare_ether_addr(vp->fd_mac,
936 fip->data_src_addr) == 0 &&
937 get_unaligned_be64(&vp->fd_wwpn) == lp->wwpn &&
938 ntoh24(vp->fd_fc_id) == fc_host_port_id(lp->host))
939 desc_mask &= ~BIT(FIP_DT_VN_ID);
942 /* standard says ignore unknown descriptors >= 128 */
943 if (desc->fip_dtype < FIP_DT_VENDOR_BASE)
947 desc = (struct fip_desc *)((char *)desc + dlen);
952 * reset only if all required descriptors were present and valid.
955 FIP_DBG("missing descriptors mask %x\n", desc_mask);
957 FIP_DBG("performing Clear Virtual Link\n");
958 fcoe_ctlr_reset(fip, FIP_ST_ENABLED);
963 * fcoe_ctlr_recv() - Receive a FIP frame.
964 * @fip: FCoE controller.
965 * @skb: Received FIP packet.
967 * This is called from NET_RX_SOFTIRQ.
969 void fcoe_ctlr_recv(struct fcoe_ctlr *fip, struct sk_buff *skb)
971 spin_lock_bh(&fip->fip_recv_list.lock);
972 __skb_queue_tail(&fip->fip_recv_list, skb);
973 spin_unlock_bh(&fip->fip_recv_list.lock);
974 schedule_work(&fip->recv_work);
976 EXPORT_SYMBOL(fcoe_ctlr_recv);
979 * fcoe_ctlr_recv_handler() - Receive a FIP frame.
980 * @fip: FCoE controller.
981 * @skb: Received FIP packet.
983 * Returns non-zero if the frame is dropped.
985 static int fcoe_ctlr_recv_handler(struct fcoe_ctlr *fip, struct sk_buff *skb)
987 struct fip_header *fiph;
989 enum fip_state state;
993 if (skb_linearize(skb))
995 if (skb->len < sizeof(*fiph))
998 if (compare_ether_addr(eh->h_dest, fip->ctl_src_addr) &&
999 compare_ether_addr(eh->h_dest, FIP_ALL_ENODE_MACS))
1001 fiph = (struct fip_header *)skb->data;
1002 op = ntohs(fiph->fip_op);
1003 sub = fiph->fip_subcode;
1005 FIP_DBG_LVL(2, "ver %x op %x/%x dl %x fl %x\n",
1006 FIP_VER_DECAPS(fiph->fip_ver), op, sub,
1007 ntohs(fiph->fip_dl_len), ntohs(fiph->fip_flags));
1009 if (FIP_VER_DECAPS(fiph->fip_ver) != FIP_VER)
1011 if (ntohs(fiph->fip_dl_len) * FIP_BPW + sizeof(*fiph) > skb->len)
1014 spin_lock_bh(&fip->lock);
1016 if (state == FIP_ST_AUTO) {
1018 fip->state = FIP_ST_ENABLED;
1019 state = FIP_ST_ENABLED;
1020 FIP_DBG("using FIP mode\n");
1022 spin_unlock_bh(&fip->lock);
1023 if (state != FIP_ST_ENABLED)
1026 if (op == FIP_OP_LS) {
1027 fcoe_ctlr_recv_els(fip, skb); /* consumes skb */
1030 if (op == FIP_OP_DISC && sub == FIP_SC_ADV)
1031 fcoe_ctlr_recv_adv(fip, skb);
1032 else if (op == FIP_OP_CTRL && sub == FIP_SC_CLR_VLINK)
1033 fcoe_ctlr_recv_clr_vlink(fip, fiph);
1042 * fcoe_ctlr_select() - Select the best FCF, if possible.
1043 * @fip: FCoE controller.
1045 * If there are conflicting advertisements, no FCF can be chosen.
1047 * Called with lock held.
1049 static void fcoe_ctlr_select(struct fcoe_ctlr *fip)
1051 struct fcoe_fcf *fcf;
1052 struct fcoe_fcf *best = NULL;
1054 list_for_each_entry(fcf, &fip->fcfs, list) {
1055 FIP_DBG("consider FCF for fab %llx VFID %d map %x val %d\n",
1056 fcf->fabric_name, fcf->vfid,
1057 fcf->fc_map, fcoe_ctlr_mtu_valid(fcf));
1058 if (!fcoe_ctlr_fcf_usable(fcf)) {
1059 FIP_DBG("FCF for fab %llx map %x %svalid %savailable\n",
1060 fcf->fabric_name, fcf->fc_map,
1061 (fcf->flags & FIP_FL_SOL) ? "" : "in",
1062 (fcf->flags & FIP_FL_AVAIL) ? "" : "un");
1069 if (fcf->fabric_name != best->fabric_name ||
1070 fcf->vfid != best->vfid ||
1071 fcf->fc_map != best->fc_map) {
1072 FIP_DBG("conflicting fabric, VFID, or FC-MAP\n");
1075 if (fcf->pri < best->pri)
1078 fip->sel_fcf = best;
1082 * fcoe_ctlr_timeout() - FIP timer function.
1083 * @arg: &fcoe_ctlr pointer.
1085 * Ages FCFs. Triggers FCF selection if possible. Sends keep-alives.
1087 static void fcoe_ctlr_timeout(unsigned long arg)
1089 struct fcoe_ctlr *fip = (struct fcoe_ctlr *)arg;
1090 struct fcoe_fcf *sel;
1091 struct fcoe_fcf *fcf;
1092 unsigned long next_timer = jiffies + msecs_to_jiffies(FIP_VN_KA_PERIOD);
1093 DECLARE_MAC_BUF(buf);
1097 spin_lock_bh(&fip->lock);
1098 if (fip->state == FIP_ST_DISABLED) {
1099 spin_unlock_bh(&fip->lock);
1104 fcoe_ctlr_age_fcfs(fip);
1107 if (!sel && fip->sel_time && time_after_eq(jiffies, fip->sel_time)) {
1108 fcoe_ctlr_select(fip);
1114 fcf = sel; /* the old FCF may have been freed */
1116 printk(KERN_INFO "host%d: FIP selected "
1117 "Fibre-Channel Forwarder MAC %s\n",
1118 fip->lp->host->host_no,
1119 print_mac(buf, sel->fcf_mac));
1120 memcpy(fip->dest_addr, sel->fcf_mac, ETH_ALEN);
1121 fip->port_ka_time = jiffies +
1122 msecs_to_jiffies(FIP_VN_KA_PERIOD);
1123 fip->ctlr_ka_time = jiffies + sel->fka_period;
1126 printk(KERN_NOTICE "host%d: "
1127 "FIP Fibre-Channel Forwarder timed out. "
1128 "Starting FCF discovery.\n",
1129 fip->lp->host->host_no);
1132 schedule_work(&fip->link_work);
1138 if (time_after_eq(jiffies, fip->ctlr_ka_time)) {
1139 fip->ctlr_ka_time = jiffies + sel->fka_period;
1142 if (time_after(next_timer, fip->ctlr_ka_time))
1143 next_timer = fip->ctlr_ka_time;
1145 if (time_after_eq(jiffies, fip->port_ka_time)) {
1146 fip->port_ka_time += jiffies +
1147 msecs_to_jiffies(FIP_VN_KA_PERIOD);
1150 if (time_after(next_timer, fip->port_ka_time))
1151 next_timer = fip->port_ka_time;
1152 mod_timer(&fip->timer, next_timer);
1153 } else if (fip->sel_time) {
1154 next_timer = fip->sel_time +
1155 msecs_to_jiffies(FCOE_CTLR_START_DELAY);
1156 mod_timer(&fip->timer, next_timer);
1158 spin_unlock_bh(&fip->lock);
1161 fcoe_ctlr_send_keep_alive(fip, 0, fip->ctl_src_addr);
1163 fcoe_ctlr_send_keep_alive(fip, 1, fip->data_src_addr);
1167 * fcoe_ctlr_link_work() - worker thread function for link changes.
1168 * @work: pointer to link_work member inside &fcoe_ctlr.
1170 * See if the link status has changed and if so, report it.
1172 * This is here because fc_linkup() and fc_linkdown() must not
1173 * be called from the timer directly, since they use a mutex.
1175 static void fcoe_ctlr_link_work(struct work_struct *work)
1177 struct fcoe_ctlr *fip;
1181 fip = container_of(work, struct fcoe_ctlr, link_work);
1182 spin_lock_bh(&fip->lock);
1183 last_link = fip->last_link;
1185 fip->last_link = link;
1186 spin_unlock_bh(&fip->lock);
1188 if (last_link != link) {
1192 fcoe_ctlr_reset(fip, FIP_ST_LINK_WAIT);
1197 * fcoe_ctlr_recv_work() - Worker thread function for receiving FIP frames.
1198 * @recv_work: pointer to recv_work member inside &fcoe_ctlr.
1200 static void fcoe_ctlr_recv_work(struct work_struct *recv_work)
1202 struct fcoe_ctlr *fip;
1203 struct sk_buff *skb;
1205 fip = container_of(recv_work, struct fcoe_ctlr, recv_work);
1206 spin_lock_bh(&fip->fip_recv_list.lock);
1207 while ((skb = __skb_dequeue(&fip->fip_recv_list))) {
1208 spin_unlock_bh(&fip->fip_recv_list.lock);
1209 fcoe_ctlr_recv_handler(fip, skb);
1210 spin_lock_bh(&fip->fip_recv_list.lock);
1212 spin_unlock_bh(&fip->fip_recv_list.lock);
1216 * fcoe_ctlr_recv_flogi() - snoop Pre-FIP receipt of FLOGI response or request.
1217 * @fip: FCoE controller.
1219 * @sa: Ethernet source MAC address from received FCoE frame.
1221 * Snoop potential response to FLOGI or even incoming FLOGI.
1223 * The caller has checked that we are waiting for login as indicated
1224 * by fip->flogi_oxid != FC_XID_UNKNOWN.
1226 * The caller is responsible for freeing the frame.
1228 * Return non-zero if the frame should not be delivered to libfc.
1230 int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *fip, struct fc_frame *fp, u8 *sa)
1232 struct fc_frame_header *fh;
1236 fh = fc_frame_header_get(fp);
1237 if (fh->fh_type != FC_TYPE_ELS)
1240 op = fc_frame_payload_op(fp);
1241 if (op == ELS_LS_ACC && fh->fh_r_ctl == FC_RCTL_ELS_REP &&
1242 fip->flogi_oxid == ntohs(fh->fh_ox_id)) {
1244 spin_lock_bh(&fip->lock);
1245 if (fip->state != FIP_ST_AUTO && fip->state != FIP_ST_NON_FIP) {
1246 spin_unlock_bh(&fip->lock);
1249 fip->state = FIP_ST_NON_FIP;
1250 FIP_DBG("received FLOGI LS_ACC using non-FIP mode\n");
1254 * If the src mac addr is FC_OUI-based, then we mark the
1255 * address_mode flag to use FC_OUI-based Ethernet DA.
1256 * Otherwise we use the FCoE gateway addr
1258 if (!compare_ether_addr(sa, (u8[6])FC_FCOE_FLOGI_MAC)) {
1261 memcpy(fip->dest_addr, sa, ETH_ALEN);
1264 fip->flogi_oxid = FC_XID_UNKNOWN;
1265 memcpy(mac, fip->data_src_addr, ETH_ALEN);
1266 fc_fcoe_set_mac(fip->data_src_addr, fh->fh_d_id);
1267 spin_unlock_bh(&fip->lock);
1269 fip->update_mac(fip, mac, fip->data_src_addr);
1270 } else if (op == ELS_FLOGI && fh->fh_r_ctl == FC_RCTL_ELS_REQ && sa) {
1272 * Save source MAC for point-to-point responses.
1274 spin_lock_bh(&fip->lock);
1275 if (fip->state == FIP_ST_AUTO || fip->state == FIP_ST_NON_FIP) {
1276 memcpy(fip->dest_addr, sa, ETH_ALEN);
1278 if (fip->state == FIP_ST_NON_FIP)
1279 FIP_DBG("received FLOGI REQ, "
1280 "using non-FIP mode\n");
1281 fip->state = FIP_ST_NON_FIP;
1283 spin_unlock_bh(&fip->lock);
1287 EXPORT_SYMBOL(fcoe_ctlr_recv_flogi);
1290 * fcoe_wwn_from_mac() - Converts 48-bit IEEE MAC address to 64-bit FC WWN.
1292 * @scheme: check port
1293 * @port: port indicator for converting
1295 * Returns: u64 fc world wide name
1297 u64 fcoe_wwn_from_mac(unsigned char mac[MAX_ADDR_LEN],
1298 unsigned int scheme, unsigned int port)
1303 /* The MAC is in NO, so flip only the low 48 bits */
1304 host_mac = ((u64) mac[0] << 40) |
1305 ((u64) mac[1] << 32) |
1306 ((u64) mac[2] << 24) |
1307 ((u64) mac[3] << 16) |
1308 ((u64) mac[4] << 8) |
1311 WARN_ON(host_mac >= (1ULL << 48));
1312 wwn = host_mac | ((u64) scheme << 60);
1318 WARN_ON(port >= 0xfff);
1319 wwn |= (u64) port << 48;
1328 EXPORT_SYMBOL_GPL(fcoe_wwn_from_mac);
1331 * fcoe_libfc_config() - sets up libfc related properties for lport
1332 * @lp: ptr to the fc_lport
1333 * @tt: libfc function template
1335 * Returns : 0 for success
1337 int fcoe_libfc_config(struct fc_lport *lp, struct libfc_function_template *tt)
1339 /* Set the function pointers set by the LLDD */
1340 memcpy(&lp->tt, tt, sizeof(*tt));
1341 if (fc_fcp_init(lp))
1351 EXPORT_SYMBOL_GPL(fcoe_libfc_config);