2 * Copyright(c) 2007 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
23 * These comments only apply to the 'port code' which consists of the lport,
24 * disc and rport blocks.
28 * The lport, disc and rport blocks all have mutexes that are used to protect
29 * those objects. The main motivation for these locks is to prevent from
30 * having an lport reset just before we send a frame. In that scenario the
31 * lport's FID would get set to zero and then we'd send a frame with an
32 * invalid SID. We also need to ensure that states don't change unexpectedly
33 * while processing another state.
37 * The following heirarchy defines the locking rules. A greater lock
38 * may be held before acquiring a lesser lock, but a lesser lock should never
39 * be held while attempting to acquire a greater lock. Here is the heirarchy-
41 * lport > disc, lport > rport, disc > rport
45 * The callbacks cause complications with this scheme. There is a callback
46 * from the rport (to either lport or disc) and a callback from disc
49 * As rports exit the rport state machine a callback is made to the owner of
50 * the rport to notify success or failure. Since the callback is likely to
51 * cause the lport or disc to grab its lock we cannot hold the rport lock
52 * while making the callback. To ensure that the rport is not free'd while
53 * processing the callback the rport callbacks are serialized through a
54 * single-threaded workqueue. An rport would never be free'd while in a
55 * callback handler becuase no other rport work in this queue can be executed
58 * When discovery succeeds or fails a callback is made to the lport as
59 * notification. Currently, succesful discovery causes the lport to take no
60 * action. A failure will cause the lport to reset. There is likely a circular
61 * locking problem with this implementation.
67 * The critical sections protected by the lport's mutex are quite broad and
68 * may be improved upon in the future. The lport code and its locking doesn't
69 * influence the I/O path, so excessive locking doesn't penalize I/O
72 * The strategy is to lock whenever processing a request or response. Note
73 * that every _enter_* function corresponds to a state change. They generally
74 * change the lports state and then send a request out on the wire. We lock
75 * before calling any of these functions to protect that state change. This
76 * means that the entry points into the lport block manage the locks while
77 * the state machine can transition between states (i.e. _enter_* functions)
78 * while always staying protected.
80 * When handling responses we also hold the lport mutex broadly. When the
81 * lport receives the response frame it locks the mutex and then calls the
82 * appropriate handler for the particuar response. Generally a response will
83 * trigger a state change and so the lock must already be held.
85 * Retries also have to consider the locking. The retries occur from a work
86 * context and the work function will lock the lport and then retry the state
87 * (i.e. _enter_* function).
90 #include <linux/timer.h>
91 #include <asm/unaligned.h>
93 #include <scsi/fc/fc_gs.h>
95 #include <scsi/libfc.h>
96 #include <scsi/fc_encode.h>
100 /* Fabric IDs to use for point-to-point mode, chosen on whims. */
101 #define FC_LOCAL_PTP_FID_LO 0x010101
102 #define FC_LOCAL_PTP_FID_HI 0x010102
104 #define DNS_DELAY 3 /* Discovery delay after RSCN (in seconds)*/
106 static void fc_lport_error(struct fc_lport *, struct fc_frame *);
108 static void fc_lport_enter_reset(struct fc_lport *);
109 static void fc_lport_enter_flogi(struct fc_lport *);
110 static void fc_lport_enter_dns(struct fc_lport *);
111 static void fc_lport_enter_rft_id(struct fc_lport *);
112 static void fc_lport_enter_scr(struct fc_lport *);
113 static void fc_lport_enter_ready(struct fc_lport *);
114 static void fc_lport_enter_logo(struct fc_lport *);
116 static const char *fc_lport_state_names[] = {
117 [LPORT_ST_DISABLED] = "disabled",
118 [LPORT_ST_FLOGI] = "FLOGI",
119 [LPORT_ST_DNS] = "dNS",
120 [LPORT_ST_RFT_ID] = "RFT_ID",
121 [LPORT_ST_SCR] = "SCR",
122 [LPORT_ST_READY] = "Ready",
123 [LPORT_ST_LOGO] = "LOGO",
124 [LPORT_ST_RESET] = "reset",
127 static int fc_frame_drop(struct fc_lport *lport, struct fc_frame *fp)
134 * fc_lport_rport_callback() - Event handler for rport events
135 * @lport: The lport which is receiving the event
136 * @rdata: private remote port data
137 * @event: The event that occured
139 * Locking Note: The rport lock should not be held when calling
142 static void fc_lport_rport_callback(struct fc_lport *lport,
143 struct fc_rport_priv *rdata,
144 enum fc_rport_event event)
146 FC_LPORT_DBG(lport, "Received a %d event for port (%6x)\n", event,
149 mutex_lock(&lport->lp_mutex);
152 if (lport->state == LPORT_ST_DNS) {
153 lport->dns_rp = rdata;
154 fc_lport_enter_rft_id(lport);
156 FC_LPORT_DBG(lport, "Received an READY event "
157 "on port (%6x) for the directory "
158 "server, but the lport is not "
159 "in the DNS state, it's in the "
160 "%d state", rdata->ids.port_id,
162 lport->tt.rport_logoff(rdata);
166 case RPORT_EV_FAILED:
168 lport->dns_rp = NULL;
173 mutex_unlock(&lport->lp_mutex);
177 * fc_lport_state() - Return a string which represents the lport's state
178 * @lport: The lport whose state is to converted to a string
180 static const char *fc_lport_state(struct fc_lport *lport)
184 cp = fc_lport_state_names[lport->state];
191 * fc_lport_ptp_setup() - Create an rport for point-to-point mode
192 * @lport: The lport to attach the ptp rport to
193 * @fid: The FID of the ptp rport
194 * @remote_wwpn: The WWPN of the ptp rport
195 * @remote_wwnn: The WWNN of the ptp rport
197 static void fc_lport_ptp_setup(struct fc_lport *lport,
198 u32 remote_fid, u64 remote_wwpn,
201 mutex_lock(&lport->disc.disc_mutex);
203 lport->tt.rport_logoff(lport->ptp_rp);
204 lport->ptp_rp = lport->tt.rport_create(lport, remote_fid);
205 lport->ptp_rp->ids.port_name = remote_wwpn;
206 lport->ptp_rp->ids.node_name = remote_wwnn;
207 mutex_unlock(&lport->disc.disc_mutex);
209 lport->tt.rport_login(lport->ptp_rp);
211 fc_lport_enter_ready(lport);
214 void fc_get_host_port_type(struct Scsi_Host *shost)
216 /* TODO - currently just NPORT */
217 fc_host_port_type(shost) = FC_PORTTYPE_NPORT;
219 EXPORT_SYMBOL(fc_get_host_port_type);
221 void fc_get_host_port_state(struct Scsi_Host *shost)
223 struct fc_lport *lp = shost_priv(shost);
225 mutex_lock(&lp->lp_mutex);
227 fc_host_port_state(shost) = FC_PORTSTATE_LINKDOWN;
231 fc_host_port_state(shost) = FC_PORTSTATE_ONLINE;
234 fc_host_port_state(shost) = FC_PORTSTATE_OFFLINE;
236 mutex_unlock(&lp->lp_mutex);
238 EXPORT_SYMBOL(fc_get_host_port_state);
240 void fc_get_host_speed(struct Scsi_Host *shost)
242 struct fc_lport *lport = shost_priv(shost);
244 fc_host_speed(shost) = lport->link_speed;
246 EXPORT_SYMBOL(fc_get_host_speed);
248 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *shost)
250 struct fc_host_statistics *fcoe_stats;
251 struct fc_lport *lp = shost_priv(shost);
252 struct timespec v0, v1;
255 fcoe_stats = &lp->host_stats;
256 memset(fcoe_stats, 0, sizeof(struct fc_host_statistics));
258 jiffies_to_timespec(jiffies, &v0);
259 jiffies_to_timespec(lp->boot_time, &v1);
260 fcoe_stats->seconds_since_last_reset = (v0.tv_sec - v1.tv_sec);
262 for_each_possible_cpu(cpu) {
263 struct fcoe_dev_stats *stats;
265 stats = per_cpu_ptr(lp->dev_stats, cpu);
267 fcoe_stats->tx_frames += stats->TxFrames;
268 fcoe_stats->tx_words += stats->TxWords;
269 fcoe_stats->rx_frames += stats->RxFrames;
270 fcoe_stats->rx_words += stats->RxWords;
271 fcoe_stats->error_frames += stats->ErrorFrames;
272 fcoe_stats->invalid_crc_count += stats->InvalidCRCCount;
273 fcoe_stats->fcp_input_requests += stats->InputRequests;
274 fcoe_stats->fcp_output_requests += stats->OutputRequests;
275 fcoe_stats->fcp_control_requests += stats->ControlRequests;
276 fcoe_stats->fcp_input_megabytes += stats->InputMegabytes;
277 fcoe_stats->fcp_output_megabytes += stats->OutputMegabytes;
278 fcoe_stats->link_failure_count += stats->LinkFailureCount;
280 fcoe_stats->lip_count = -1;
281 fcoe_stats->nos_count = -1;
282 fcoe_stats->loss_of_sync_count = -1;
283 fcoe_stats->loss_of_signal_count = -1;
284 fcoe_stats->prim_seq_protocol_err_count = -1;
285 fcoe_stats->dumped_frames = -1;
288 EXPORT_SYMBOL(fc_get_host_stats);
291 * Fill in FLOGI command for request.
294 fc_lport_flogi_fill(struct fc_lport *lport, struct fc_els_flogi *flogi,
297 struct fc_els_csp *sp;
298 struct fc_els_cssp *cp;
300 memset(flogi, 0, sizeof(*flogi));
301 flogi->fl_cmd = (u8) op;
302 put_unaligned_be64(lport->wwpn, &flogi->fl_wwpn);
303 put_unaligned_be64(lport->wwnn, &flogi->fl_wwnn);
305 sp->sp_hi_ver = 0x20;
306 sp->sp_lo_ver = 0x20;
307 sp->sp_bb_cred = htons(10); /* this gets set by gateway */
308 sp->sp_bb_data = htons((u16) lport->mfs);
309 cp = &flogi->fl_cssp[3 - 1]; /* class 3 parameters */
310 cp->cp_class = htons(FC_CPC_VALID | FC_CPC_SEQ);
311 if (op != ELS_FLOGI) {
312 sp->sp_features = htons(FC_SP_FT_CIRO);
313 sp->sp_tot_seq = htons(255); /* seq. we accept */
314 sp->sp_rel_off = htons(0x1f);
315 sp->sp_e_d_tov = htonl(lport->e_d_tov);
317 cp->cp_rdfs = htons((u16) lport->mfs);
318 cp->cp_con_seq = htons(255);
324 * Add a supported FC-4 type.
326 static void fc_lport_add_fc4_type(struct fc_lport *lport, enum fc_fh_type type)
330 mp = &lport->fcts.ff_type_map[type / FC_NS_BPW];
331 *mp = htonl(ntohl(*mp) | 1UL << (type % FC_NS_BPW));
335 * fc_lport_recv_rlir_req() - Handle received Registered Link Incident Report.
336 * @lport: Fibre Channel local port recieving the RLIR
337 * @sp: current sequence in the RLIR exchange
338 * @fp: RLIR request frame
340 * Locking Note: The lport lock is expected to be held before calling
343 static void fc_lport_recv_rlir_req(struct fc_seq *sp, struct fc_frame *fp,
344 struct fc_lport *lport)
346 FC_LPORT_DBG(lport, "Received RLIR request while in state %s\n",
347 fc_lport_state(lport));
349 lport->tt.seq_els_rsp_send(sp, ELS_LS_ACC, NULL);
354 * fc_lport_recv_echo_req() - Handle received ECHO request
355 * @lport: Fibre Channel local port recieving the ECHO
356 * @sp: current sequence in the ECHO exchange
357 * @fp: ECHO request frame
359 * Locking Note: The lport lock is expected to be held before calling
362 static void fc_lport_recv_echo_req(struct fc_seq *sp, struct fc_frame *in_fp,
363 struct fc_lport *lport)
366 struct fc_exch *ep = fc_seq_exch(sp);
372 FC_LPORT_DBG(lport, "Received ECHO request while in state %s\n",
373 fc_lport_state(lport));
375 len = fr_len(in_fp) - sizeof(struct fc_frame_header);
376 pp = fc_frame_payload_get(in_fp, len);
378 if (len < sizeof(__be32))
379 len = sizeof(__be32);
381 fp = fc_frame_alloc(lport, len);
383 dp = fc_frame_payload_get(fp, len);
385 *((__be32 *)dp) = htonl(ELS_LS_ACC << 24);
386 sp = lport->tt.seq_start_next(sp);
387 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ;
388 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
389 FC_TYPE_ELS, f_ctl, 0);
390 lport->tt.seq_send(lport, sp, fp);
392 fc_frame_free(in_fp);
396 * fc_lport_recv_rnid_req() - Handle received Request Node ID data request
397 * @sp: The sequence in the RNID exchange
398 * @fp: The RNID request frame
399 * @lport: The local port recieving the RNID
401 * Locking Note: The lport lock is expected to be held before calling
404 static void fc_lport_recv_rnid_req(struct fc_seq *sp, struct fc_frame *in_fp,
405 struct fc_lport *lport)
408 struct fc_exch *ep = fc_seq_exch(sp);
409 struct fc_els_rnid *req;
411 struct fc_els_rnid_resp rnid;
412 struct fc_els_rnid_cid cid;
413 struct fc_els_rnid_gen gen;
415 struct fc_seq_els_data rjt_data;
420 FC_LPORT_DBG(lport, "Received RNID request while in state %s\n",
421 fc_lport_state(lport));
423 req = fc_frame_payload_get(in_fp, sizeof(*req));
426 rjt_data.reason = ELS_RJT_LOGIC;
427 rjt_data.explan = ELS_EXPL_NONE;
428 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
432 if (fmt != ELS_RNIDF_GEN ||
433 ntohl(lport->rnid_gen.rnid_atype) == 0) {
434 fmt = ELS_RNIDF_NONE; /* nothing to provide */
435 len -= sizeof(rp->gen);
437 fp = fc_frame_alloc(lport, len);
439 rp = fc_frame_payload_get(fp, len);
441 rp->rnid.rnid_cmd = ELS_LS_ACC;
442 rp->rnid.rnid_fmt = fmt;
443 rp->rnid.rnid_cid_len = sizeof(rp->cid);
444 rp->cid.rnid_wwpn = htonll(lport->wwpn);
445 rp->cid.rnid_wwnn = htonll(lport->wwnn);
446 if (fmt == ELS_RNIDF_GEN) {
447 rp->rnid.rnid_sid_len = sizeof(rp->gen);
448 memcpy(&rp->gen, &lport->rnid_gen,
451 sp = lport->tt.seq_start_next(sp);
452 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ;
453 f_ctl |= FC_FC_END_SEQ | FC_FC_SEQ_INIT;
454 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
455 FC_TYPE_ELS, f_ctl, 0);
456 lport->tt.seq_send(lport, sp, fp);
459 fc_frame_free(in_fp);
463 * fc_lport_recv_logo_req() - Handle received fabric LOGO request
464 * @lport: Fibre Channel local port recieving the LOGO
465 * @sp: current sequence in the LOGO exchange
466 * @fp: LOGO request frame
468 * Locking Note: The lport lock is exected to be held before calling
471 static void fc_lport_recv_logo_req(struct fc_seq *sp, struct fc_frame *fp,
472 struct fc_lport *lport)
474 lport->tt.seq_els_rsp_send(sp, ELS_LS_ACC, NULL);
475 fc_lport_enter_reset(lport);
480 * fc_fabric_login() - Start the lport state machine
481 * @lport: The lport that should log into the fabric
483 * Locking Note: This function should not be called
484 * with the lport lock held.
486 int fc_fabric_login(struct fc_lport *lport)
490 mutex_lock(&lport->lp_mutex);
491 if (lport->state == LPORT_ST_DISABLED) {
492 fc_lport_enter_reset(lport);
495 mutex_unlock(&lport->lp_mutex);
499 EXPORT_SYMBOL(fc_fabric_login);
502 * __fc_linkup() - Handler for transport linkup events
503 * @lport: The lport whose link is up
505 * Locking: must be called with the lp_mutex held
507 void __fc_linkup(struct fc_lport *lport)
509 if (!lport->link_up) {
512 if (lport->state == LPORT_ST_RESET)
513 fc_lport_enter_flogi(lport);
518 * fc_linkup() - Handler for transport linkup events
519 * @lport: The lport whose link is up
521 void fc_linkup(struct fc_lport *lport)
523 printk(KERN_INFO "libfc: Link up on port (%6x)\n",
524 fc_host_port_id(lport->host));
526 mutex_lock(&lport->lp_mutex);
528 mutex_unlock(&lport->lp_mutex);
530 EXPORT_SYMBOL(fc_linkup);
533 * __fc_linkdown() - Handler for transport linkdown events
534 * @lport: The lport whose link is down
536 * Locking: must be called with the lp_mutex held
538 void __fc_linkdown(struct fc_lport *lport)
540 if (lport->link_up) {
542 fc_lport_enter_reset(lport);
543 lport->tt.fcp_cleanup(lport);
548 * fc_linkdown() - Handler for transport linkdown events
549 * @lport: The lport whose link is down
551 void fc_linkdown(struct fc_lport *lport)
553 printk(KERN_INFO "libfc: Link down on port (%6x)\n",
554 fc_host_port_id(lport->host));
556 mutex_lock(&lport->lp_mutex);
557 __fc_linkdown(lport);
558 mutex_unlock(&lport->lp_mutex);
560 EXPORT_SYMBOL(fc_linkdown);
563 * fc_fabric_logoff() - Logout of the fabric
564 * @lport: fc_lport pointer to logoff the fabric
567 * 0 for success, -1 for failure
569 int fc_fabric_logoff(struct fc_lport *lport)
571 lport->tt.disc_stop_final(lport);
572 mutex_lock(&lport->lp_mutex);
574 lport->tt.rport_logoff(lport->dns_rp);
575 mutex_unlock(&lport->lp_mutex);
576 lport->tt.rport_flush_queue();
577 mutex_lock(&lport->lp_mutex);
578 fc_lport_enter_logo(lport);
579 mutex_unlock(&lport->lp_mutex);
580 cancel_delayed_work_sync(&lport->retry_work);
583 EXPORT_SYMBOL(fc_fabric_logoff);
586 * fc_lport_destroy() - unregister a fc_lport
587 * @lport: fc_lport pointer to unregister
592 * exit routine for fc_lport instance
593 * clean-up all the allocated memory
594 * and free up other system resources.
597 int fc_lport_destroy(struct fc_lport *lport)
599 mutex_lock(&lport->lp_mutex);
600 lport->state = LPORT_ST_DISABLED;
602 lport->tt.frame_send = fc_frame_drop;
603 mutex_unlock(&lport->lp_mutex);
605 lport->tt.fcp_abort_io(lport);
606 lport->tt.disc_stop_final(lport);
607 lport->tt.exch_mgr_reset(lport, 0, 0);
610 EXPORT_SYMBOL(fc_lport_destroy);
613 * fc_set_mfs() - sets up the mfs for the corresponding fc_lport
614 * @lport: fc_lport pointer to unregister
615 * @mfs: the new mfs for fc_lport
617 * Set mfs for the given fc_lport to the new mfs.
619 * Return: 0 for success
621 int fc_set_mfs(struct fc_lport *lport, u32 mfs)
623 unsigned int old_mfs;
626 mutex_lock(&lport->lp_mutex);
628 old_mfs = lport->mfs;
630 if (mfs >= FC_MIN_MAX_FRAME) {
632 if (mfs > FC_MAX_FRAME)
634 mfs -= sizeof(struct fc_frame_header);
639 if (!rc && mfs < old_mfs)
640 fc_lport_enter_reset(lport);
642 mutex_unlock(&lport->lp_mutex);
646 EXPORT_SYMBOL(fc_set_mfs);
649 * fc_lport_disc_callback() - Callback for discovery events
650 * @lport: FC local port
651 * @event: The discovery event
653 void fc_lport_disc_callback(struct fc_lport *lport, enum fc_disc_event event)
656 case DISC_EV_SUCCESS:
657 FC_LPORT_DBG(lport, "Discovery succeeded\n");
660 printk(KERN_ERR "libfc: Discovery failed for port (%6x)\n",
661 fc_host_port_id(lport->host));
662 mutex_lock(&lport->lp_mutex);
663 fc_lport_enter_reset(lport);
664 mutex_unlock(&lport->lp_mutex);
673 * fc_rport_enter_ready() - Enter the ready state and start discovery
674 * @lport: Fibre Channel local port that is ready
676 * Locking Note: The lport lock is expected to be held before calling
679 static void fc_lport_enter_ready(struct fc_lport *lport)
681 FC_LPORT_DBG(lport, "Entered READY from state %s\n",
682 fc_lport_state(lport));
684 fc_lport_state_enter(lport, LPORT_ST_READY);
686 fc_vport_set_state(lport->vport, FC_VPORT_ACTIVE);
687 fc_vports_linkchange(lport);
690 lport->tt.disc_start(fc_lport_disc_callback, lport);
694 * fc_lport_recv_flogi_req() - Receive a FLOGI request
695 * @sp_in: The sequence the FLOGI is on
696 * @rx_fp: The frame the FLOGI is in
697 * @lport: The lport that recieved the request
699 * A received FLOGI request indicates a point-to-point connection.
700 * Accept it with the common service parameters indicating our N port.
701 * Set up to do a PLOGI if we have the higher-number WWPN.
703 * Locking Note: The lport lock is expected to be held before calling
706 static void fc_lport_recv_flogi_req(struct fc_seq *sp_in,
707 struct fc_frame *rx_fp,
708 struct fc_lport *lport)
711 struct fc_frame_header *fh;
714 struct fc_els_flogi *flp;
715 struct fc_els_flogi *new_flp;
721 FC_LPORT_DBG(lport, "Received FLOGI request while in state %s\n",
722 fc_lport_state(lport));
724 fh = fc_frame_header_get(rx_fp);
725 remote_fid = ntoh24(fh->fh_s_id);
726 flp = fc_frame_payload_get(rx_fp, sizeof(*flp));
729 remote_wwpn = get_unaligned_be64(&flp->fl_wwpn);
730 if (remote_wwpn == lport->wwpn) {
731 printk(KERN_WARNING "libfc: Received FLOGI from port "
732 "with same WWPN %llx\n", remote_wwpn);
735 FC_LPORT_DBG(lport, "FLOGI from port WWPN %llx\n", remote_wwpn);
738 * XXX what is the right thing to do for FIDs?
739 * The originator might expect our S_ID to be 0xfffffe.
740 * But if so, both of us could end up with the same FID.
742 local_fid = FC_LOCAL_PTP_FID_LO;
743 if (remote_wwpn < lport->wwpn) {
744 local_fid = FC_LOCAL_PTP_FID_HI;
745 if (!remote_fid || remote_fid == local_fid)
746 remote_fid = FC_LOCAL_PTP_FID_LO;
747 } else if (!remote_fid) {
748 remote_fid = FC_LOCAL_PTP_FID_HI;
751 fc_host_port_id(lport->host) = local_fid;
753 fp = fc_frame_alloc(lport, sizeof(*flp));
755 sp = lport->tt.seq_start_next(fr_seq(rx_fp));
756 new_flp = fc_frame_payload_get(fp, sizeof(*flp));
757 fc_lport_flogi_fill(lport, new_flp, ELS_FLOGI);
758 new_flp->fl_cmd = (u8) ELS_LS_ACC;
761 * Send the response. If this fails, the originator should
762 * repeat the sequence.
764 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ;
765 ep = fc_seq_exch(sp);
766 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
767 FC_TYPE_ELS, f_ctl, 0);
768 lport->tt.seq_send(lport, sp, fp);
771 fc_lport_error(lport, fp);
773 fc_lport_ptp_setup(lport, remote_fid, remote_wwpn,
774 get_unaligned_be64(&flp->fl_wwnn));
778 fc_frame_free(rx_fp);
782 * fc_lport_recv_req() - The generic lport request handler
783 * @lport: The lport that received the request
784 * @sp: The sequence the request is on
785 * @fp: The frame the request is in
787 * This function will see if the lport handles the request or
788 * if an rport should handle the request.
790 * Locking Note: This function should not be called with the lport
791 * lock held becuase it will grab the lock.
793 static void fc_lport_recv_req(struct fc_lport *lport, struct fc_seq *sp,
796 struct fc_frame_header *fh = fc_frame_header_get(fp);
797 void (*recv) (struct fc_seq *, struct fc_frame *, struct fc_lport *);
799 mutex_lock(&lport->lp_mutex);
802 * Handle special ELS cases like FLOGI, LOGO, and
803 * RSCN here. These don't require a session.
804 * Even if we had a session, it might not be ready.
808 else if (fh->fh_type == FC_TYPE_ELS &&
809 fh->fh_r_ctl == FC_RCTL_ELS_REQ) {
813 recv = lport->tt.rport_recv_req;
814 switch (fc_frame_payload_op(fp)) {
816 recv = fc_lport_recv_flogi_req;
819 fh = fc_frame_header_get(fp);
820 if (ntoh24(fh->fh_s_id) == FC_FID_FLOGI)
821 recv = fc_lport_recv_logo_req;
824 recv = lport->tt.disc_recv_req;
827 recv = fc_lport_recv_echo_req;
830 recv = fc_lport_recv_rlir_req;
833 recv = fc_lport_recv_rnid_req;
839 FC_LPORT_DBG(lport, "dropping invalid frame (eof %x)\n",
843 mutex_unlock(&lport->lp_mutex);
846 * The common exch_done for all request may not be good
847 * if any request requires longer hold on exhange. XXX
849 lport->tt.exch_done(sp);
853 * fc_lport_reset() - Reset an lport
854 * @lport: The lport which should be reset
856 * Locking Note: This functions should not be called with the
859 int fc_lport_reset(struct fc_lport *lport)
861 cancel_delayed_work_sync(&lport->retry_work);
862 mutex_lock(&lport->lp_mutex);
863 fc_lport_enter_reset(lport);
864 mutex_unlock(&lport->lp_mutex);
867 EXPORT_SYMBOL(fc_lport_reset);
870 * fc_lport_reset_locked() - Reset the local port
871 * @lport: Fibre Channel local port to be reset
873 * Locking Note: The lport lock is expected to be held before calling
876 static void fc_lport_reset_locked(struct fc_lport *lport)
879 lport->tt.rport_logoff(lport->dns_rp);
881 lport->ptp_rp = NULL;
883 lport->tt.disc_stop(lport);
885 lport->tt.exch_mgr_reset(lport, 0, 0);
886 fc_host_fabric_name(lport->host) = 0;
887 fc_host_port_id(lport->host) = 0;
891 * fc_lport_enter_reset() - Reset the local port
892 * @lport: Fibre Channel local port to be reset
894 * Locking Note: The lport lock is expected to be held before calling
897 static void fc_lport_enter_reset(struct fc_lport *lport)
899 FC_LPORT_DBG(lport, "Entered RESET state from %s state\n",
900 fc_lport_state(lport));
904 fc_vport_set_state(lport->vport, FC_VPORT_INITIALIZING);
906 fc_vport_set_state(lport->vport, FC_VPORT_LINKDOWN);
908 fc_lport_state_enter(lport, LPORT_ST_RESET);
909 fc_vports_linkchange(lport);
910 fc_lport_reset_locked(lport);
912 fc_lport_enter_flogi(lport);
916 * fc_lport_enter_disabled() - disable the local port
917 * @lport: Fibre Channel local port to be reset
919 * Locking Note: The lport lock is expected to be held before calling
922 static void fc_lport_enter_disabled(struct fc_lport *lport)
924 FC_LPORT_DBG(lport, "Entered disabled state from %s state\n",
925 fc_lport_state(lport));
927 fc_lport_state_enter(lport, LPORT_ST_DISABLED);
928 fc_vports_linkchange(lport);
929 fc_lport_reset_locked(lport);
933 * fc_lport_error() - Handler for any errors
934 * @lport: The fc_lport object
935 * @fp: The frame pointer
937 * If the error was caused by a resource allocation failure
938 * then wait for half a second and retry, otherwise retry
939 * after the e_d_tov time.
941 static void fc_lport_error(struct fc_lport *lport, struct fc_frame *fp)
943 unsigned long delay = 0;
944 FC_LPORT_DBG(lport, "Error %ld in state %s, retries %d\n",
945 PTR_ERR(fp), fc_lport_state(lport),
948 if (!fp || PTR_ERR(fp) == -FC_EX_TIMEOUT) {
950 * Memory allocation failure, or the exchange timed out.
953 if (lport->retry_count < lport->max_retry_count) {
954 lport->retry_count++;
956 delay = msecs_to_jiffies(500);
958 delay = msecs_to_jiffies(lport->e_d_tov);
960 schedule_delayed_work(&lport->retry_work, delay);
962 switch (lport->state) {
963 case LPORT_ST_DISABLED:
966 case LPORT_ST_RFT_ID:
971 fc_lport_enter_reset(lport);
979 * fc_lport_rft_id_resp() - Handle response to Register Fibre
980 * Channel Types by ID (RFT_ID) request
981 * @sp: current sequence in RFT_ID exchange
982 * @fp: response frame
983 * @lp_arg: Fibre Channel host port instance
985 * Locking Note: This function will be called without the lport lock
986 * held, but it will lock, call an _enter_* function or fc_lport_error
987 * and then unlock the lport.
989 static void fc_lport_rft_id_resp(struct fc_seq *sp, struct fc_frame *fp,
992 struct fc_lport *lport = lp_arg;
993 struct fc_frame_header *fh;
994 struct fc_ct_hdr *ct;
996 FC_LPORT_DBG(lport, "Received a RFT_ID %s\n", fc_els_resp_type(fp));
998 if (fp == ERR_PTR(-FC_EX_CLOSED))
1001 mutex_lock(&lport->lp_mutex);
1003 if (lport->state != LPORT_ST_RFT_ID) {
1004 FC_LPORT_DBG(lport, "Received a RFT_ID response, but in state "
1005 "%s\n", fc_lport_state(lport));
1012 fc_lport_error(lport, fp);
1016 fh = fc_frame_header_get(fp);
1017 ct = fc_frame_payload_get(fp, sizeof(*ct));
1019 if (fh && ct && fh->fh_type == FC_TYPE_CT &&
1020 ct->ct_fs_type == FC_FST_DIR &&
1021 ct->ct_fs_subtype == FC_NS_SUBTYPE &&
1022 ntohs(ct->ct_cmd) == FC_FS_ACC)
1023 fc_lport_enter_scr(lport);
1025 fc_lport_error(lport, fp);
1029 mutex_unlock(&lport->lp_mutex);
1033 * fc_lport_scr_resp() - Handle response to State Change Register (SCR) request
1034 * @sp: current sequence in SCR exchange
1035 * @fp: response frame
1036 * @lp_arg: Fibre Channel lport port instance that sent the registration request
1038 * Locking Note: This function will be called without the lport lock
1039 * held, but it will lock, call an _enter_* function or fc_lport_error
1040 * and then unlock the lport.
1042 static void fc_lport_scr_resp(struct fc_seq *sp, struct fc_frame *fp,
1045 struct fc_lport *lport = lp_arg;
1048 FC_LPORT_DBG(lport, "Received a SCR %s\n", fc_els_resp_type(fp));
1050 if (fp == ERR_PTR(-FC_EX_CLOSED))
1053 mutex_lock(&lport->lp_mutex);
1055 if (lport->state != LPORT_ST_SCR) {
1056 FC_LPORT_DBG(lport, "Received a SCR response, but in state "
1057 "%s\n", fc_lport_state(lport));
1064 fc_lport_error(lport, fp);
1068 op = fc_frame_payload_op(fp);
1069 if (op == ELS_LS_ACC)
1070 fc_lport_enter_ready(lport);
1072 fc_lport_error(lport, fp);
1077 mutex_unlock(&lport->lp_mutex);
1081 * fc_lport_enter_scr() - Send a State Change Register (SCR) request
1082 * @lport: Fibre Channel local port to register for state changes
1084 * Locking Note: The lport lock is expected to be held before calling
1087 static void fc_lport_enter_scr(struct fc_lport *lport)
1089 struct fc_frame *fp;
1091 FC_LPORT_DBG(lport, "Entered SCR state from %s state\n",
1092 fc_lport_state(lport));
1094 fc_lport_state_enter(lport, LPORT_ST_SCR);
1096 fp = fc_frame_alloc(lport, sizeof(struct fc_els_scr));
1098 fc_lport_error(lport, fp);
1102 if (!lport->tt.elsct_send(lport, FC_FID_FCTRL, fp, ELS_SCR,
1103 fc_lport_scr_resp, lport, lport->e_d_tov))
1104 fc_lport_error(lport, NULL);
1108 * fc_lport_enter_rft_id() - Register FC4-types with the name server
1109 * @lport: Fibre Channel local port to register
1111 * Locking Note: The lport lock is expected to be held before calling
1114 static void fc_lport_enter_rft_id(struct fc_lport *lport)
1116 struct fc_frame *fp;
1117 struct fc_ns_fts *lps;
1120 FC_LPORT_DBG(lport, "Entered RFT_ID state from %s state\n",
1121 fc_lport_state(lport));
1123 fc_lport_state_enter(lport, LPORT_ST_RFT_ID);
1126 i = sizeof(lps->ff_type_map) / sizeof(lps->ff_type_map[0]);
1128 if (ntohl(lps->ff_type_map[i]) != 0)
1131 /* nothing to register, move on to SCR */
1132 fc_lport_enter_scr(lport);
1136 fp = fc_frame_alloc(lport, sizeof(struct fc_ct_hdr) +
1137 sizeof(struct fc_ns_rft));
1139 fc_lport_error(lport, fp);
1143 if (!lport->tt.elsct_send(lport, FC_FID_DIR_SERV, fp, FC_NS_RFT_ID,
1144 fc_lport_rft_id_resp,
1145 lport, lport->e_d_tov))
1146 fc_lport_error(lport, fp);
1149 static struct fc_rport_operations fc_lport_rport_ops = {
1150 .event_callback = fc_lport_rport_callback,
1154 * fc_rport_enter_dns() - Create a rport to the name server
1155 * @lport: Fibre Channel local port requesting a rport for the name server
1157 * Locking Note: The lport lock is expected to be held before calling
1160 static void fc_lport_enter_dns(struct fc_lport *lport)
1162 struct fc_rport_priv *rdata;
1164 FC_LPORT_DBG(lport, "Entered DNS state from %s state\n",
1165 fc_lport_state(lport));
1167 fc_lport_state_enter(lport, LPORT_ST_DNS);
1169 mutex_lock(&lport->disc.disc_mutex);
1170 rdata = lport->tt.rport_create(lport, FC_FID_DIR_SERV);
1171 mutex_unlock(&lport->disc.disc_mutex);
1175 rdata->ops = &fc_lport_rport_ops;
1176 lport->tt.rport_login(rdata);
1180 fc_lport_error(lport, NULL);
1184 * fc_lport_timeout() - Handler for the retry_work timer.
1185 * @work: The work struct of the fc_lport
1187 static void fc_lport_timeout(struct work_struct *work)
1189 struct fc_lport *lport =
1190 container_of(work, struct fc_lport,
1193 mutex_lock(&lport->lp_mutex);
1195 switch (lport->state) {
1196 case LPORT_ST_DISABLED:
1199 case LPORT_ST_READY:
1202 case LPORT_ST_RESET:
1204 case LPORT_ST_FLOGI:
1205 fc_lport_enter_flogi(lport);
1208 fc_lport_enter_dns(lport);
1210 case LPORT_ST_RFT_ID:
1211 fc_lport_enter_rft_id(lport);
1214 fc_lport_enter_scr(lport);
1217 fc_lport_enter_logo(lport);
1221 mutex_unlock(&lport->lp_mutex);
1225 * fc_lport_logo_resp() - Handle response to LOGO request
1226 * @sp: current sequence in LOGO exchange
1227 * @fp: response frame
1228 * @lp_arg: Fibre Channel lport port instance that sent the LOGO request
1230 * Locking Note: This function will be called without the lport lock
1231 * held, but it will lock, call an _enter_* function or fc_lport_error
1232 * and then unlock the lport.
1234 void fc_lport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
1237 struct fc_lport *lport = lp_arg;
1240 FC_LPORT_DBG(lport, "Received a LOGO %s\n", fc_els_resp_type(fp));
1242 if (fp == ERR_PTR(-FC_EX_CLOSED))
1245 mutex_lock(&lport->lp_mutex);
1247 if (lport->state != LPORT_ST_LOGO) {
1248 FC_LPORT_DBG(lport, "Received a LOGO response, but in state "
1249 "%s\n", fc_lport_state(lport));
1256 fc_lport_error(lport, fp);
1260 op = fc_frame_payload_op(fp);
1261 if (op == ELS_LS_ACC)
1262 fc_lport_enter_disabled(lport);
1264 fc_lport_error(lport, fp);
1269 mutex_unlock(&lport->lp_mutex);
1271 EXPORT_SYMBOL(fc_lport_logo_resp);
1274 * fc_rport_enter_logo() - Logout of the fabric
1275 * @lport: Fibre Channel local port to be logged out
1277 * Locking Note: The lport lock is expected to be held before calling
1280 static void fc_lport_enter_logo(struct fc_lport *lport)
1282 struct fc_frame *fp;
1283 struct fc_els_logo *logo;
1285 FC_LPORT_DBG(lport, "Entered LOGO state from %s state\n",
1286 fc_lport_state(lport));
1288 fc_lport_state_enter(lport, LPORT_ST_LOGO);
1289 fc_vports_linkchange(lport);
1291 fp = fc_frame_alloc(lport, sizeof(*logo));
1293 fc_lport_error(lport, fp);
1297 if (!lport->tt.elsct_send(lport, FC_FID_FLOGI, fp, ELS_LOGO,
1298 fc_lport_logo_resp, lport, lport->e_d_tov))
1299 fc_lport_error(lport, NULL);
1303 * fc_lport_flogi_resp() - Handle response to FLOGI request
1304 * @sp: current sequence in FLOGI exchange
1305 * @fp: response frame
1306 * @lp_arg: Fibre Channel lport port instance that sent the FLOGI request
1308 * Locking Note: This function will be called without the lport lock
1309 * held, but it will lock, call an _enter_* function or fc_lport_error
1310 * and then unlock the lport.
1312 void fc_lport_flogi_resp(struct fc_seq *sp, struct fc_frame *fp,
1315 struct fc_lport *lport = lp_arg;
1316 struct fc_frame_header *fh;
1317 struct fc_els_flogi *flp;
1320 unsigned int r_a_tov;
1321 unsigned int e_d_tov;
1324 FC_LPORT_DBG(lport, "Received a FLOGI %s\n", fc_els_resp_type(fp));
1326 if (fp == ERR_PTR(-FC_EX_CLOSED))
1329 mutex_lock(&lport->lp_mutex);
1331 if (lport->state != LPORT_ST_FLOGI) {
1332 FC_LPORT_DBG(lport, "Received a FLOGI response, but in state "
1333 "%s\n", fc_lport_state(lport));
1340 fc_lport_error(lport, fp);
1344 fh = fc_frame_header_get(fp);
1345 did = ntoh24(fh->fh_d_id);
1346 if (fc_frame_payload_op(fp) == ELS_LS_ACC && did != 0) {
1348 printk(KERN_INFO "libfc: Assigned FID (%6x) in FLOGI response\n",
1350 fc_host_port_id(lport->host) = did;
1352 flp = fc_frame_payload_get(fp, sizeof(*flp));
1354 mfs = ntohs(flp->fl_csp.sp_bb_data) &
1356 if (mfs >= FC_SP_MIN_MAX_PAYLOAD &&
1359 csp_flags = ntohs(flp->fl_csp.sp_features);
1360 r_a_tov = ntohl(flp->fl_csp.sp_r_a_tov);
1361 e_d_tov = ntohl(flp->fl_csp.sp_e_d_tov);
1362 if (csp_flags & FC_SP_FT_EDTR)
1365 lport->npiv_enabled = !!(csp_flags & FC_SP_FT_NPIV_ACC);
1367 if ((csp_flags & FC_SP_FT_FPORT) == 0) {
1368 if (e_d_tov > lport->e_d_tov)
1369 lport->e_d_tov = e_d_tov;
1370 lport->r_a_tov = 2 * e_d_tov;
1371 printk(KERN_INFO "libfc: Port (%6x) entered "
1372 "point to point mode\n", did);
1373 fc_lport_ptp_setup(lport, ntoh24(fh->fh_s_id),
1379 lport->e_d_tov = e_d_tov;
1380 lport->r_a_tov = r_a_tov;
1381 fc_host_fabric_name(lport->host) =
1382 get_unaligned_be64(&flp->fl_wwnn);
1383 fc_lport_enter_dns(lport);
1387 FC_LPORT_DBG(lport, "Bad FLOGI response\n");
1393 mutex_unlock(&lport->lp_mutex);
1395 EXPORT_SYMBOL(fc_lport_flogi_resp);
1398 * fc_rport_enter_flogi() - Send a FLOGI request to the fabric manager
1399 * @lport: Fibre Channel local port to be logged in to the fabric
1401 * Locking Note: The lport lock is expected to be held before calling
1404 void fc_lport_enter_flogi(struct fc_lport *lport)
1406 struct fc_frame *fp;
1408 FC_LPORT_DBG(lport, "Entered FLOGI state from %s state\n",
1409 fc_lport_state(lport));
1411 fc_lport_state_enter(lport, LPORT_ST_FLOGI);
1413 fp = fc_frame_alloc(lport, sizeof(struct fc_els_flogi));
1415 return fc_lport_error(lport, fp);
1417 if (!lport->tt.elsct_send(lport, FC_FID_FLOGI, fp,
1418 lport->vport ? ELS_FDISC : ELS_FLOGI,
1419 fc_lport_flogi_resp, lport, lport->e_d_tov))
1420 fc_lport_error(lport, NULL);
1423 /* Configure a fc_lport */
1424 int fc_lport_config(struct fc_lport *lport)
1426 INIT_DELAYED_WORK(&lport->retry_work, fc_lport_timeout);
1427 mutex_init(&lport->lp_mutex);
1429 fc_lport_state_enter(lport, LPORT_ST_DISABLED);
1431 fc_lport_add_fc4_type(lport, FC_TYPE_FCP);
1432 fc_lport_add_fc4_type(lport, FC_TYPE_CT);
1436 EXPORT_SYMBOL(fc_lport_config);
1438 int fc_lport_init(struct fc_lport *lport)
1440 if (!lport->tt.lport_recv)
1441 lport->tt.lport_recv = fc_lport_recv_req;
1443 if (!lport->tt.lport_reset)
1444 lport->tt.lport_reset = fc_lport_reset;
1446 fc_host_port_type(lport->host) = FC_PORTTYPE_NPORT;
1447 fc_host_node_name(lport->host) = lport->wwnn;
1448 fc_host_port_name(lport->host) = lport->wwpn;
1449 fc_host_supported_classes(lport->host) = FC_COS_CLASS3;
1450 memset(fc_host_supported_fc4s(lport->host), 0,
1451 sizeof(fc_host_supported_fc4s(lport->host)));
1452 fc_host_supported_fc4s(lport->host)[2] = 1;
1453 fc_host_supported_fc4s(lport->host)[7] = 1;
1455 /* This value is also unchanging */
1456 memset(fc_host_active_fc4s(lport->host), 0,
1457 sizeof(fc_host_active_fc4s(lport->host)));
1458 fc_host_active_fc4s(lport->host)[2] = 1;
1459 fc_host_active_fc4s(lport->host)[7] = 1;
1460 fc_host_maxframe_size(lport->host) = lport->mfs;
1461 fc_host_supported_speeds(lport->host) = 0;
1462 if (lport->link_supported_speeds & FC_PORTSPEED_1GBIT)
1463 fc_host_supported_speeds(lport->host) |= FC_PORTSPEED_1GBIT;
1464 if (lport->link_supported_speeds & FC_PORTSPEED_10GBIT)
1465 fc_host_supported_speeds(lport->host) |= FC_PORTSPEED_10GBIT;
1469 EXPORT_SYMBOL(fc_lport_init);