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>
98 /* Fabric IDs to use for point-to-point mode, chosen on whims. */
99 #define FC_LOCAL_PTP_FID_LO 0x010101
100 #define FC_LOCAL_PTP_FID_HI 0x010102
102 #define DNS_DELAY 3 /* Discovery delay after RSCN (in seconds)*/
104 static int fc_lport_debug;
106 #define FC_DEBUG_LPORT(fmt...) \
108 if (fc_lport_debug) \
112 static void fc_lport_error(struct fc_lport *, struct fc_frame *);
114 static void fc_lport_enter_reset(struct fc_lport *);
115 static void fc_lport_enter_flogi(struct fc_lport *);
116 static void fc_lport_enter_dns(struct fc_lport *);
117 static void fc_lport_enter_rpn_id(struct fc_lport *);
118 static void fc_lport_enter_rft_id(struct fc_lport *);
119 static void fc_lport_enter_scr(struct fc_lport *);
120 static void fc_lport_enter_ready(struct fc_lport *);
121 static void fc_lport_enter_logo(struct fc_lport *);
123 static const char *fc_lport_state_names[] = {
124 [LPORT_ST_NONE] = "none",
125 [LPORT_ST_FLOGI] = "FLOGI",
126 [LPORT_ST_DNS] = "dNS",
127 [LPORT_ST_RPN_ID] = "RPN_ID",
128 [LPORT_ST_RFT_ID] = "RFT_ID",
129 [LPORT_ST_SCR] = "SCR",
130 [LPORT_ST_READY] = "Ready",
131 [LPORT_ST_LOGO] = "LOGO",
132 [LPORT_ST_RESET] = "reset",
135 static int fc_frame_drop(struct fc_lport *lport, struct fc_frame *fp)
142 * fc_lport_rport_callback() - Event handler for rport events
143 * @lport: The lport which is receiving the event
144 * @rport: The rport which the event has occured on
145 * @event: The event that occured
147 * Locking Note: The rport lock should not be held when calling
150 static void fc_lport_rport_callback(struct fc_lport *lport,
151 struct fc_rport *rport,
152 enum fc_rport_event event)
154 FC_DEBUG_LPORT("Received a %d event for port (%6x)\n", event,
158 case RPORT_EV_CREATED:
159 if (rport->port_id == FC_FID_DIR_SERV) {
160 mutex_lock(&lport->lp_mutex);
161 if (lport->state == LPORT_ST_DNS) {
162 lport->dns_rp = rport;
163 fc_lport_enter_rpn_id(lport);
165 FC_DEBUG_LPORT("Received an CREATED event on "
166 "port (%6x) for the directory "
167 "server, but the lport is not "
168 "in the DNS state, it's in the "
169 "%d state", rport->port_id,
171 lport->tt.rport_logoff(rport);
173 mutex_unlock(&lport->lp_mutex);
175 FC_DEBUG_LPORT("Received an event for port (%6x) "
176 "which is not the directory server\n",
180 case RPORT_EV_FAILED:
182 if (rport->port_id == FC_FID_DIR_SERV) {
183 mutex_lock(&lport->lp_mutex);
184 lport->dns_rp = NULL;
185 mutex_unlock(&lport->lp_mutex);
188 FC_DEBUG_LPORT("Received an event for port (%6x) "
189 "which is not the directory server\n",
198 * fc_lport_state() - Return a string which represents the lport's state
199 * @lport: The lport whose state is to converted to a string
201 static const char *fc_lport_state(struct fc_lport *lport)
205 cp = fc_lport_state_names[lport->state];
212 * fc_lport_ptp_setup() - Create an rport for point-to-point mode
213 * @lport: The lport to attach the ptp rport to
214 * @fid: The FID of the ptp rport
215 * @remote_wwpn: The WWPN of the ptp rport
216 * @remote_wwnn: The WWNN of the ptp rport
218 static void fc_lport_ptp_setup(struct fc_lport *lport,
219 u32 remote_fid, u64 remote_wwpn,
222 struct fc_disc_port dp;
225 dp.ids.port_id = remote_fid;
226 dp.ids.port_name = remote_wwpn;
227 dp.ids.node_name = remote_wwnn;
228 dp.ids.roles = FC_RPORT_ROLE_UNKNOWN;
231 lport->tt.rport_logoff(lport->ptp_rp);
232 lport->ptp_rp = NULL;
235 lport->ptp_rp = lport->tt.rport_create(&dp);
237 lport->tt.rport_login(lport->ptp_rp);
239 fc_lport_enter_ready(lport);
242 void fc_get_host_port_type(struct Scsi_Host *shost)
244 /* TODO - currently just NPORT */
245 fc_host_port_type(shost) = FC_PORTTYPE_NPORT;
247 EXPORT_SYMBOL(fc_get_host_port_type);
249 void fc_get_host_port_state(struct Scsi_Host *shost)
251 struct fc_lport *lp = shost_priv(shost);
254 fc_host_port_state(shost) = FC_PORTSTATE_ONLINE;
256 fc_host_port_state(shost) = FC_PORTSTATE_OFFLINE;
258 EXPORT_SYMBOL(fc_get_host_port_state);
260 void fc_get_host_speed(struct Scsi_Host *shost)
262 struct fc_lport *lport = shost_priv(shost);
264 fc_host_speed(shost) = lport->link_speed;
266 EXPORT_SYMBOL(fc_get_host_speed);
268 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *shost)
271 struct fc_host_statistics *fcoe_stats;
272 struct fc_lport *lp = shost_priv(shost);
273 struct timespec v0, v1;
275 fcoe_stats = &lp->host_stats;
276 memset(fcoe_stats, 0, sizeof(struct fc_host_statistics));
278 jiffies_to_timespec(jiffies, &v0);
279 jiffies_to_timespec(lp->boot_time, &v1);
280 fcoe_stats->seconds_since_last_reset = (v0.tv_sec - v1.tv_sec);
282 for_each_online_cpu(i) {
283 struct fcoe_dev_stats *stats = lp->dev_stats[i];
286 fcoe_stats->tx_frames += stats->TxFrames;
287 fcoe_stats->tx_words += stats->TxWords;
288 fcoe_stats->rx_frames += stats->RxFrames;
289 fcoe_stats->rx_words += stats->RxWords;
290 fcoe_stats->error_frames += stats->ErrorFrames;
291 fcoe_stats->invalid_crc_count += stats->InvalidCRCCount;
292 fcoe_stats->fcp_input_requests += stats->InputRequests;
293 fcoe_stats->fcp_output_requests += stats->OutputRequests;
294 fcoe_stats->fcp_control_requests += stats->ControlRequests;
295 fcoe_stats->fcp_input_megabytes += stats->InputMegabytes;
296 fcoe_stats->fcp_output_megabytes += stats->OutputMegabytes;
297 fcoe_stats->link_failure_count += stats->LinkFailureCount;
299 fcoe_stats->lip_count = -1;
300 fcoe_stats->nos_count = -1;
301 fcoe_stats->loss_of_sync_count = -1;
302 fcoe_stats->loss_of_signal_count = -1;
303 fcoe_stats->prim_seq_protocol_err_count = -1;
304 fcoe_stats->dumped_frames = -1;
307 EXPORT_SYMBOL(fc_get_host_stats);
310 * Fill in FLOGI command for request.
313 fc_lport_flogi_fill(struct fc_lport *lport, struct fc_els_flogi *flogi,
316 struct fc_els_csp *sp;
317 struct fc_els_cssp *cp;
319 memset(flogi, 0, sizeof(*flogi));
320 flogi->fl_cmd = (u8) op;
321 put_unaligned_be64(lport->wwpn, &flogi->fl_wwpn);
322 put_unaligned_be64(lport->wwnn, &flogi->fl_wwnn);
324 sp->sp_hi_ver = 0x20;
325 sp->sp_lo_ver = 0x20;
326 sp->sp_bb_cred = htons(10); /* this gets set by gateway */
327 sp->sp_bb_data = htons((u16) lport->mfs);
328 cp = &flogi->fl_cssp[3 - 1]; /* class 3 parameters */
329 cp->cp_class = htons(FC_CPC_VALID | FC_CPC_SEQ);
330 if (op != ELS_FLOGI) {
331 sp->sp_features = htons(FC_SP_FT_CIRO);
332 sp->sp_tot_seq = htons(255); /* seq. we accept */
333 sp->sp_rel_off = htons(0x1f);
334 sp->sp_e_d_tov = htonl(lport->e_d_tov);
336 cp->cp_rdfs = htons((u16) lport->mfs);
337 cp->cp_con_seq = htons(255);
343 * Add a supported FC-4 type.
345 static void fc_lport_add_fc4_type(struct fc_lport *lport, enum fc_fh_type type)
349 mp = &lport->fcts.ff_type_map[type / FC_NS_BPW];
350 *mp = htonl(ntohl(*mp) | 1UL << (type % FC_NS_BPW));
354 * fc_lport_recv_rlir_req() - Handle received Registered Link Incident Report.
355 * @lport: Fibre Channel local port recieving the RLIR
356 * @sp: current sequence in the RLIR exchange
357 * @fp: RLIR request frame
359 * Locking Note: The lport lock is exected to be held before calling
362 static void fc_lport_recv_rlir_req(struct fc_seq *sp, struct fc_frame *fp,
363 struct fc_lport *lport)
365 FC_DEBUG_LPORT("Received RLIR request while in state %s\n",
366 fc_lport_state(lport));
368 lport->tt.seq_els_rsp_send(sp, ELS_LS_ACC, NULL);
373 * fc_lport_recv_echo_req() - Handle received ECHO request
374 * @lport: Fibre Channel local port recieving the ECHO
375 * @sp: current sequence in the ECHO exchange
376 * @fp: ECHO request frame
378 * Locking Note: The lport lock is exected to be held before calling
381 static void fc_lport_recv_echo_req(struct fc_seq *sp, struct fc_frame *in_fp,
382 struct fc_lport *lport)
385 struct fc_exch *ep = fc_seq_exch(sp);
391 FC_DEBUG_LPORT("Received RLIR request while in state %s\n",
392 fc_lport_state(lport));
394 len = fr_len(in_fp) - sizeof(struct fc_frame_header);
395 pp = fc_frame_payload_get(in_fp, len);
397 if (len < sizeof(__be32))
398 len = sizeof(__be32);
400 fp = fc_frame_alloc(lport, len);
402 dp = fc_frame_payload_get(fp, len);
404 *((u32 *)dp) = htonl(ELS_LS_ACC << 24);
405 sp = lport->tt.seq_start_next(sp);
406 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ;
407 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
408 FC_TYPE_ELS, f_ctl, 0);
409 lport->tt.seq_send(lport, sp, fp);
411 fc_frame_free(in_fp);
415 * fc_lport_recv_echo_req() - Handle received Request Node ID data request
416 * @lport: Fibre Channel local port recieving the RNID
417 * @sp: current sequence in the RNID exchange
418 * @fp: RNID request frame
420 * Locking Note: The lport lock is exected to be held before calling
423 static void fc_lport_recv_rnid_req(struct fc_seq *sp, struct fc_frame *in_fp,
424 struct fc_lport *lport)
427 struct fc_exch *ep = fc_seq_exch(sp);
428 struct fc_els_rnid *req;
430 struct fc_els_rnid_resp rnid;
431 struct fc_els_rnid_cid cid;
432 struct fc_els_rnid_gen gen;
434 struct fc_seq_els_data rjt_data;
439 FC_DEBUG_LPORT("Received RNID request while in state %s\n",
440 fc_lport_state(lport));
442 req = fc_frame_payload_get(in_fp, sizeof(*req));
445 rjt_data.reason = ELS_RJT_LOGIC;
446 rjt_data.explan = ELS_EXPL_NONE;
447 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
451 if (fmt != ELS_RNIDF_GEN ||
452 ntohl(lport->rnid_gen.rnid_atype) == 0) {
453 fmt = ELS_RNIDF_NONE; /* nothing to provide */
454 len -= sizeof(rp->gen);
456 fp = fc_frame_alloc(lport, len);
458 rp = fc_frame_payload_get(fp, len);
460 rp->rnid.rnid_cmd = ELS_LS_ACC;
461 rp->rnid.rnid_fmt = fmt;
462 rp->rnid.rnid_cid_len = sizeof(rp->cid);
463 rp->cid.rnid_wwpn = htonll(lport->wwpn);
464 rp->cid.rnid_wwnn = htonll(lport->wwnn);
465 if (fmt == ELS_RNIDF_GEN) {
466 rp->rnid.rnid_sid_len = sizeof(rp->gen);
467 memcpy(&rp->gen, &lport->rnid_gen,
470 sp = lport->tt.seq_start_next(sp);
471 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ;
472 f_ctl |= FC_FC_END_SEQ | FC_FC_SEQ_INIT;
473 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
474 FC_TYPE_ELS, f_ctl, 0);
475 lport->tt.seq_send(lport, sp, fp);
478 fc_frame_free(in_fp);
482 * fc_lport_recv_adisc_req() - Handle received Address Discovery Request
483 * @lport: Fibre Channel local port recieving the ADISC
484 * @sp: current sequence in the ADISC exchange
485 * @fp: ADISC request frame
487 * Locking Note: The lport lock is expected to be held before calling
490 static void fc_lport_recv_adisc_req(struct fc_seq *sp, struct fc_frame *in_fp,
491 struct fc_lport *lport)
494 struct fc_exch *ep = fc_seq_exch(sp);
495 struct fc_els_adisc *req, *rp;
496 struct fc_seq_els_data rjt_data;
500 FC_DEBUG_LPORT("Received ADISC request while in state %s\n",
501 fc_lport_state(lport));
503 req = fc_frame_payload_get(in_fp, sizeof(*req));
506 rjt_data.reason = ELS_RJT_LOGIC;
507 rjt_data.explan = ELS_EXPL_NONE;
508 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
511 fp = fc_frame_alloc(lport, len);
513 rp = fc_frame_payload_get(fp, len);
515 rp->adisc_cmd = ELS_LS_ACC;
516 rp->adisc_wwpn = htonll(lport->wwpn);
517 rp->adisc_wwnn = htonll(lport->wwnn);
518 hton24(rp->adisc_port_id,
519 fc_host_port_id(lport->host));
520 sp = lport->tt.seq_start_next(sp);
521 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ;
522 f_ctl |= FC_FC_END_SEQ | FC_FC_SEQ_INIT;
523 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
524 FC_TYPE_ELS, f_ctl, 0);
525 lport->tt.seq_send(lport, sp, fp);
528 fc_frame_free(in_fp);
532 * fc_lport_recv_logo_req() - Handle received fabric LOGO request
533 * @lport: Fibre Channel local port recieving the LOGO
534 * @sp: current sequence in the LOGO exchange
535 * @fp: LOGO request frame
537 * Locking Note: The lport lock is exected to be held before calling
540 static void fc_lport_recv_logo_req(struct fc_seq *sp, struct fc_frame *fp,
541 struct fc_lport *lport)
543 lport->tt.seq_els_rsp_send(sp, ELS_LS_ACC, NULL);
544 fc_lport_enter_reset(lport);
549 * fc_fabric_login() - Start the lport state machine
550 * @lport: The lport that should log into the fabric
552 * Locking Note: This function should not be called
553 * with the lport lock held.
555 int fc_fabric_login(struct fc_lport *lport)
559 mutex_lock(&lport->lp_mutex);
560 if (lport->state == LPORT_ST_NONE) {
561 fc_lport_enter_reset(lport);
564 mutex_unlock(&lport->lp_mutex);
568 EXPORT_SYMBOL(fc_fabric_login);
571 * fc_linkup() - Handler for transport linkup events
572 * @lport: The lport whose link is up
574 void fc_linkup(struct fc_lport *lport)
576 FC_DEBUG_LPORT("Link is up for port (%6x)\n",
577 fc_host_port_id(lport->host));
579 mutex_lock(&lport->lp_mutex);
580 if (!lport->link_up) {
583 if (lport->state == LPORT_ST_RESET)
584 fc_lport_enter_flogi(lport);
586 mutex_unlock(&lport->lp_mutex);
588 EXPORT_SYMBOL(fc_linkup);
591 * fc_linkdown() - Handler for transport linkdown events
592 * @lport: The lport whose link is down
594 void fc_linkdown(struct fc_lport *lport)
596 mutex_lock(&lport->lp_mutex);
597 FC_DEBUG_LPORT("Link is down for port (%6x)\n",
598 fc_host_port_id(lport->host));
600 if (lport->link_up) {
602 fc_lport_enter_reset(lport);
603 lport->tt.fcp_cleanup(lport);
605 mutex_unlock(&lport->lp_mutex);
607 EXPORT_SYMBOL(fc_linkdown);
610 * fc_fabric_logoff() - Logout of the fabric
611 * @lport: fc_lport pointer to logoff the fabric
614 * 0 for success, -1 for failure
616 int fc_fabric_logoff(struct fc_lport *lport)
618 lport->tt.disc_stop_final(lport);
619 mutex_lock(&lport->lp_mutex);
620 fc_lport_enter_logo(lport);
621 mutex_unlock(&lport->lp_mutex);
622 cancel_delayed_work_sync(&lport->retry_work);
625 EXPORT_SYMBOL(fc_fabric_logoff);
628 * fc_lport_destroy() - unregister a fc_lport
629 * @lport: fc_lport pointer to unregister
634 * exit routine for fc_lport instance
635 * clean-up all the allocated memory
636 * and free up other system resources.
639 int fc_lport_destroy(struct fc_lport *lport)
641 lport->tt.frame_send = fc_frame_drop;
642 lport->tt.fcp_abort_io(lport);
643 lport->tt.exch_mgr_reset(lport, 0, 0);
646 EXPORT_SYMBOL(fc_lport_destroy);
649 * fc_set_mfs() - sets up the mfs for the corresponding fc_lport
650 * @lport: fc_lport pointer to unregister
651 * @mfs: the new mfs for fc_lport
653 * Set mfs for the given fc_lport to the new mfs.
655 * Return: 0 for success
657 int fc_set_mfs(struct fc_lport *lport, u32 mfs)
659 unsigned int old_mfs;
662 mutex_lock(&lport->lp_mutex);
664 old_mfs = lport->mfs;
666 if (mfs >= FC_MIN_MAX_FRAME) {
668 if (mfs > FC_MAX_FRAME)
670 mfs -= sizeof(struct fc_frame_header);
675 if (!rc && mfs < old_mfs)
676 fc_lport_enter_reset(lport);
678 mutex_unlock(&lport->lp_mutex);
682 EXPORT_SYMBOL(fc_set_mfs);
685 * fc_lport_disc_callback() - Callback for discovery events
686 * @lport: FC local port
687 * @event: The discovery event
689 void fc_lport_disc_callback(struct fc_lport *lport, enum fc_disc_event event)
692 case DISC_EV_SUCCESS:
693 FC_DEBUG_LPORT("Got a SUCCESS event for port (%6x)\n",
694 fc_host_port_id(lport->host));
697 FC_DEBUG_LPORT("Got a FAILED event for port (%6x)\n",
698 fc_host_port_id(lport->host));
699 mutex_lock(&lport->lp_mutex);
700 fc_lport_enter_reset(lport);
701 mutex_unlock(&lport->lp_mutex);
710 * fc_rport_enter_ready() - Enter the ready state and start discovery
711 * @lport: Fibre Channel local port that is ready
713 * Locking Note: The lport lock is expected to be held before calling
716 static void fc_lport_enter_ready(struct fc_lport *lport)
718 FC_DEBUG_LPORT("Port (%6x) entered Ready from state %s\n",
719 fc_host_port_id(lport->host), fc_lport_state(lport));
721 fc_lport_state_enter(lport, LPORT_ST_READY);
723 lport->tt.disc_start(fc_lport_disc_callback, lport);
727 * fc_lport_recv_flogi_req() - Receive a FLOGI request
728 * @sp_in: The sequence the FLOGI is on
729 * @rx_fp: The frame the FLOGI is in
730 * @lport: The lport that recieved the request
732 * A received FLOGI request indicates a point-to-point connection.
733 * Accept it with the common service parameters indicating our N port.
734 * Set up to do a PLOGI if we have the higher-number WWPN.
736 * Locking Note: The lport lock is exected to be held before calling
739 static void fc_lport_recv_flogi_req(struct fc_seq *sp_in,
740 struct fc_frame *rx_fp,
741 struct fc_lport *lport)
744 struct fc_frame_header *fh;
747 struct fc_els_flogi *flp;
748 struct fc_els_flogi *new_flp;
754 FC_DEBUG_LPORT("Received FLOGI request while in state %s\n",
755 fc_lport_state(lport));
757 fh = fc_frame_header_get(rx_fp);
758 remote_fid = ntoh24(fh->fh_s_id);
759 flp = fc_frame_payload_get(rx_fp, sizeof(*flp));
762 remote_wwpn = get_unaligned_be64(&flp->fl_wwpn);
763 if (remote_wwpn == lport->wwpn) {
764 FC_DBG("FLOGI from port with same WWPN %llx "
765 "possible configuration error\n", remote_wwpn);
768 FC_DBG("FLOGI from port WWPN %llx\n", remote_wwpn);
771 * XXX what is the right thing to do for FIDs?
772 * The originator might expect our S_ID to be 0xfffffe.
773 * But if so, both of us could end up with the same FID.
775 local_fid = FC_LOCAL_PTP_FID_LO;
776 if (remote_wwpn < lport->wwpn) {
777 local_fid = FC_LOCAL_PTP_FID_HI;
778 if (!remote_fid || remote_fid == local_fid)
779 remote_fid = FC_LOCAL_PTP_FID_LO;
780 } else if (!remote_fid) {
781 remote_fid = FC_LOCAL_PTP_FID_HI;
784 fc_host_port_id(lport->host) = local_fid;
786 fp = fc_frame_alloc(lport, sizeof(*flp));
788 sp = lport->tt.seq_start_next(fr_seq(rx_fp));
789 new_flp = fc_frame_payload_get(fp, sizeof(*flp));
790 fc_lport_flogi_fill(lport, new_flp, ELS_FLOGI);
791 new_flp->fl_cmd = (u8) ELS_LS_ACC;
794 * Send the response. If this fails, the originator should
795 * repeat the sequence.
797 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ | FC_FC_END_SEQ;
798 ep = fc_seq_exch(sp);
799 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
800 FC_TYPE_ELS, f_ctl, 0);
801 lport->tt.seq_send(lport, sp, fp);
804 fc_lport_error(lport, fp);
806 fc_lport_ptp_setup(lport, remote_fid, remote_wwpn,
807 get_unaligned_be64(&flp->fl_wwnn));
809 lport->tt.disc_start(fc_lport_disc_callback, lport);
813 fc_frame_free(rx_fp);
817 * fc_lport_recv_req() - The generic lport request handler
818 * @lport: The lport that received the request
819 * @sp: The sequence the request is on
820 * @fp: The frame the request is in
822 * This function will see if the lport handles the request or
823 * if an rport should handle the request.
825 * Locking Note: This function should not be called with the lport
826 * lock held becuase it will grab the lock.
828 static void fc_lport_recv_req(struct fc_lport *lport, struct fc_seq *sp,
831 struct fc_frame_header *fh = fc_frame_header_get(fp);
832 void (*recv) (struct fc_seq *, struct fc_frame *, struct fc_lport *);
833 struct fc_rport *rport;
836 struct fc_seq_els_data rjt_data;
838 mutex_lock(&lport->lp_mutex);
841 * Handle special ELS cases like FLOGI, LOGO, and
842 * RSCN here. These don't require a session.
843 * Even if we had a session, it might not be ready.
845 if (fh->fh_type == FC_TYPE_ELS && fh->fh_r_ctl == FC_RCTL_ELS_REQ) {
850 switch (fc_frame_payload_op(fp)) {
852 recv = fc_lport_recv_flogi_req;
855 fh = fc_frame_header_get(fp);
856 if (ntoh24(fh->fh_s_id) == FC_FID_FLOGI)
857 recv = fc_lport_recv_logo_req;
860 recv = lport->tt.disc_recv_req;
863 recv = fc_lport_recv_echo_req;
866 recv = fc_lport_recv_rlir_req;
869 recv = fc_lport_recv_rnid_req;
872 recv = fc_lport_recv_adisc_req;
881 * If this is a new incoming PLOGI, we won't find it.
883 s_id = ntoh24(fh->fh_s_id);
884 d_id = ntoh24(fh->fh_d_id);
886 rport = lport->tt.rport_lookup(lport, s_id);
888 lport->tt.rport_recv_req(sp, fp, rport);
891 rjt_data.reason = ELS_RJT_UNAB;
892 rjt_data.explan = ELS_EXPL_NONE;
893 lport->tt.seq_els_rsp_send(sp,
900 FC_DBG("dropping invalid frame (eof %x)\n", fr_eof(fp));
903 mutex_unlock(&lport->lp_mutex);
906 * The common exch_done for all request may not be good
907 * if any request requires longer hold on exhange. XXX
909 lport->tt.exch_done(sp);
913 * fc_lport_reset() - Reset an lport
914 * @lport: The lport which should be reset
916 * Locking Note: This functions should not be called with the
919 int fc_lport_reset(struct fc_lport *lport)
921 cancel_delayed_work_sync(&lport->retry_work);
922 mutex_lock(&lport->lp_mutex);
923 fc_lport_enter_reset(lport);
924 mutex_unlock(&lport->lp_mutex);
927 EXPORT_SYMBOL(fc_lport_reset);
930 * fc_rport_enter_reset() - Reset the local port
931 * @lport: Fibre Channel local port to be reset
933 * Locking Note: The lport lock is expected to be held before calling
936 static void fc_lport_enter_reset(struct fc_lport *lport)
938 FC_DEBUG_LPORT("Port (%6x) entered RESET state from %s state\n",
939 fc_host_port_id(lport->host), fc_lport_state(lport));
941 fc_lport_state_enter(lport, LPORT_ST_RESET);
944 lport->tt.rport_logoff(lport->dns_rp);
947 lport->tt.rport_logoff(lport->ptp_rp);
948 lport->ptp_rp = NULL;
951 lport->tt.disc_stop(lport);
953 lport->tt.exch_mgr_reset(lport, 0, 0);
954 fc_host_fabric_name(lport->host) = 0;
955 fc_host_port_id(lport->host) = 0;
958 fc_lport_enter_flogi(lport);
962 * fc_lport_error() - Handler for any errors
963 * @lport: The fc_lport object
964 * @fp: The frame pointer
966 * If the error was caused by a resource allocation failure
967 * then wait for half a second and retry, otherwise retry
968 * after the e_d_tov time.
970 static void fc_lport_error(struct fc_lport *lport, struct fc_frame *fp)
972 unsigned long delay = 0;
973 FC_DEBUG_LPORT("Error %ld in state %s, retries %d\n",
974 PTR_ERR(fp), fc_lport_state(lport),
977 if (!fp || PTR_ERR(fp) == -FC_EX_TIMEOUT) {
979 * Memory allocation failure, or the exchange timed out.
982 if (lport->retry_count < lport->max_retry_count) {
983 lport->retry_count++;
985 delay = msecs_to_jiffies(500);
987 delay = msecs_to_jiffies(lport->e_d_tov);
989 schedule_delayed_work(&lport->retry_work, delay);
991 switch (lport->state) {
995 case LPORT_ST_RPN_ID:
996 case LPORT_ST_RFT_ID:
1001 fc_lport_enter_reset(lport);
1009 * fc_lport_rft_id_resp() - Handle response to Register Fibre
1010 * Channel Types by ID (RPN_ID) request
1011 * @sp: current sequence in RPN_ID exchange
1012 * @fp: response frame
1013 * @lp_arg: Fibre Channel host port instance
1015 * Locking Note: This function will be called without the lport lock
1016 * held, but it will lock, call an _enter_* function or fc_lport_error
1017 * and then unlock the lport.
1019 static void fc_lport_rft_id_resp(struct fc_seq *sp, struct fc_frame *fp,
1022 struct fc_lport *lport = lp_arg;
1023 struct fc_frame_header *fh;
1024 struct fc_ct_hdr *ct;
1026 if (fp == ERR_PTR(-FC_EX_CLOSED))
1029 mutex_lock(&lport->lp_mutex);
1031 FC_DEBUG_LPORT("Received a RFT_ID response\n");
1034 fc_lport_error(lport, fp);
1038 if (lport->state != LPORT_ST_RFT_ID) {
1039 FC_DBG("Received a RFT_ID response, but in state %s\n",
1040 fc_lport_state(lport));
1044 fh = fc_frame_header_get(fp);
1045 ct = fc_frame_payload_get(fp, sizeof(*ct));
1047 if (fh && ct && fh->fh_type == FC_TYPE_CT &&
1048 ct->ct_fs_type == FC_FST_DIR &&
1049 ct->ct_fs_subtype == FC_NS_SUBTYPE &&
1050 ntohs(ct->ct_cmd) == FC_FS_ACC)
1051 fc_lport_enter_scr(lport);
1053 fc_lport_error(lport, fp);
1057 mutex_unlock(&lport->lp_mutex);
1061 * fc_lport_rpn_id_resp() - Handle response to Register Port
1062 * Name by ID (RPN_ID) request
1063 * @sp: current sequence in RPN_ID exchange
1064 * @fp: response frame
1065 * @lp_arg: Fibre Channel host port instance
1067 * Locking Note: This function will be called without the lport lock
1068 * held, but it will lock, call an _enter_* function or fc_lport_error
1069 * and then unlock the lport.
1071 static void fc_lport_rpn_id_resp(struct fc_seq *sp, struct fc_frame *fp,
1074 struct fc_lport *lport = lp_arg;
1075 struct fc_frame_header *fh;
1076 struct fc_ct_hdr *ct;
1078 if (fp == ERR_PTR(-FC_EX_CLOSED))
1081 mutex_lock(&lport->lp_mutex);
1083 FC_DEBUG_LPORT("Received a RPN_ID response\n");
1086 fc_lport_error(lport, fp);
1090 if (lport->state != LPORT_ST_RPN_ID) {
1091 FC_DBG("Received a RPN_ID response, but in state %s\n",
1092 fc_lport_state(lport));
1096 fh = fc_frame_header_get(fp);
1097 ct = fc_frame_payload_get(fp, sizeof(*ct));
1098 if (fh && ct && fh->fh_type == FC_TYPE_CT &&
1099 ct->ct_fs_type == FC_FST_DIR &&
1100 ct->ct_fs_subtype == FC_NS_SUBTYPE &&
1101 ntohs(ct->ct_cmd) == FC_FS_ACC)
1102 fc_lport_enter_rft_id(lport);
1104 fc_lport_error(lport, fp);
1109 mutex_unlock(&lport->lp_mutex);
1113 * fc_lport_scr_resp() - Handle response to State Change Register (SCR) request
1114 * @sp: current sequence in SCR exchange
1115 * @fp: response frame
1116 * @lp_arg: Fibre Channel lport port instance that sent the registration request
1118 * Locking Note: This function will be called without the lport lock
1119 * held, but it will lock, call an _enter_* function or fc_lport_error
1120 * and then unlock the lport.
1122 static void fc_lport_scr_resp(struct fc_seq *sp, struct fc_frame *fp,
1125 struct fc_lport *lport = lp_arg;
1128 if (fp == ERR_PTR(-FC_EX_CLOSED))
1131 mutex_lock(&lport->lp_mutex);
1133 FC_DEBUG_LPORT("Received a SCR response\n");
1136 fc_lport_error(lport, fp);
1140 if (lport->state != LPORT_ST_SCR) {
1141 FC_DBG("Received a SCR response, but in state %s\n",
1142 fc_lport_state(lport));
1146 op = fc_frame_payload_op(fp);
1147 if (op == ELS_LS_ACC)
1148 fc_lport_enter_ready(lport);
1150 fc_lport_error(lport, fp);
1155 mutex_unlock(&lport->lp_mutex);
1159 * fc_lport_enter_scr() - Send a State Change Register (SCR) request
1160 * @lport: Fibre Channel local port to register for state changes
1162 * Locking Note: The lport lock is expected to be held before calling
1165 static void fc_lport_enter_scr(struct fc_lport *lport)
1167 struct fc_frame *fp;
1169 FC_DEBUG_LPORT("Port (%6x) entered SCR state from %s state\n",
1170 fc_host_port_id(lport->host), fc_lport_state(lport));
1172 fc_lport_state_enter(lport, LPORT_ST_SCR);
1174 fp = fc_frame_alloc(lport, sizeof(struct fc_els_scr));
1176 fc_lport_error(lport, fp);
1180 if (!lport->tt.elsct_send(lport, NULL, fp, ELS_SCR,
1181 fc_lport_scr_resp, lport, lport->e_d_tov))
1182 fc_lport_error(lport, fp);
1186 * fc_lport_enter_rft_id() - Register FC4-types with the name server
1187 * @lport: Fibre Channel local port to register
1189 * Locking Note: The lport lock is expected to be held before calling
1192 static void fc_lport_enter_rft_id(struct fc_lport *lport)
1194 struct fc_frame *fp;
1195 struct fc_ns_fts *lps;
1198 FC_DEBUG_LPORT("Port (%6x) entered RFT_ID state from %s state\n",
1199 fc_host_port_id(lport->host), fc_lport_state(lport));
1201 fc_lport_state_enter(lport, LPORT_ST_RFT_ID);
1204 i = sizeof(lps->ff_type_map) / sizeof(lps->ff_type_map[0]);
1206 if (ntohl(lps->ff_type_map[i]) != 0)
1209 /* nothing to register, move on to SCR */
1210 fc_lport_enter_scr(lport);
1214 fp = fc_frame_alloc(lport, sizeof(struct fc_ct_hdr) +
1215 sizeof(struct fc_ns_rft));
1217 fc_lport_error(lport, fp);
1221 if (!lport->tt.elsct_send(lport, NULL, fp, FC_NS_RFT_ID,
1222 fc_lport_rft_id_resp,
1223 lport, lport->e_d_tov))
1224 fc_lport_error(lport, fp);
1228 * fc_rport_enter_rft_id() - Register port name with the name server
1229 * @lport: Fibre Channel local port to register
1231 * Locking Note: The lport lock is expected to be held before calling
1234 static void fc_lport_enter_rpn_id(struct fc_lport *lport)
1236 struct fc_frame *fp;
1238 FC_DEBUG_LPORT("Port (%6x) entered RPN_ID state from %s state\n",
1239 fc_host_port_id(lport->host), fc_lport_state(lport));
1241 fc_lport_state_enter(lport, LPORT_ST_RPN_ID);
1243 fp = fc_frame_alloc(lport, sizeof(struct fc_ct_hdr) +
1244 sizeof(struct fc_ns_rn_id));
1246 fc_lport_error(lport, fp);
1250 if (!lport->tt.elsct_send(lport, NULL, fp, FC_NS_RPN_ID,
1251 fc_lport_rpn_id_resp,
1252 lport, lport->e_d_tov))
1253 fc_lport_error(lport, fp);
1256 static struct fc_rport_operations fc_lport_rport_ops = {
1257 .event_callback = fc_lport_rport_callback,
1261 * fc_rport_enter_dns() - Create a rport to the name server
1262 * @lport: Fibre Channel local port requesting a rport for the name server
1264 * Locking Note: The lport lock is expected to be held before calling
1267 static void fc_lport_enter_dns(struct fc_lport *lport)
1269 struct fc_rport *rport;
1270 struct fc_rport_libfc_priv *rdata;
1271 struct fc_disc_port dp;
1273 dp.ids.port_id = FC_FID_DIR_SERV;
1274 dp.ids.port_name = -1;
1275 dp.ids.node_name = -1;
1276 dp.ids.roles = FC_RPORT_ROLE_UNKNOWN;
1279 FC_DEBUG_LPORT("Port (%6x) entered DNS state from %s state\n",
1280 fc_host_port_id(lport->host), fc_lport_state(lport));
1282 fc_lport_state_enter(lport, LPORT_ST_DNS);
1284 rport = lport->tt.rport_create(&dp);
1288 rdata = rport->dd_data;
1289 rdata->ops = &fc_lport_rport_ops;
1290 lport->tt.rport_login(rport);
1294 fc_lport_error(lport, NULL);
1298 * fc_lport_timeout() - Handler for the retry_work timer.
1299 * @work: The work struct of the fc_lport
1301 static void fc_lport_timeout(struct work_struct *work)
1303 struct fc_lport *lport =
1304 container_of(work, struct fc_lport,
1307 mutex_lock(&lport->lp_mutex);
1309 switch (lport->state) {
1311 case LPORT_ST_READY:
1312 case LPORT_ST_RESET:
1315 case LPORT_ST_FLOGI:
1316 fc_lport_enter_flogi(lport);
1319 fc_lport_enter_dns(lport);
1321 case LPORT_ST_RPN_ID:
1322 fc_lport_enter_rpn_id(lport);
1324 case LPORT_ST_RFT_ID:
1325 fc_lport_enter_rft_id(lport);
1328 fc_lport_enter_scr(lport);
1331 fc_lport_enter_logo(lport);
1335 mutex_unlock(&lport->lp_mutex);
1339 * fc_lport_logo_resp() - Handle response to LOGO request
1340 * @sp: current sequence in LOGO exchange
1341 * @fp: response frame
1342 * @lp_arg: Fibre Channel lport port instance that sent the LOGO request
1344 * Locking Note: This function will be called without the lport lock
1345 * held, but it will lock, call an _enter_* function or fc_lport_error
1346 * and then unlock the lport.
1348 static void fc_lport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
1351 struct fc_lport *lport = lp_arg;
1354 if (fp == ERR_PTR(-FC_EX_CLOSED))
1357 mutex_lock(&lport->lp_mutex);
1359 FC_DEBUG_LPORT("Received a LOGO response\n");
1362 fc_lport_error(lport, fp);
1366 if (lport->state != LPORT_ST_LOGO) {
1367 FC_DBG("Received a LOGO response, but in state %s\n",
1368 fc_lport_state(lport));
1372 op = fc_frame_payload_op(fp);
1373 if (op == ELS_LS_ACC)
1374 fc_lport_enter_reset(lport);
1376 fc_lport_error(lport, fp);
1381 mutex_unlock(&lport->lp_mutex);
1385 * fc_rport_enter_logo() - Logout of the fabric
1386 * @lport: Fibre Channel local port to be logged out
1388 * Locking Note: The lport lock is expected to be held before calling
1391 static void fc_lport_enter_logo(struct fc_lport *lport)
1393 struct fc_frame *fp;
1394 struct fc_els_logo *logo;
1396 FC_DEBUG_LPORT("Port (%6x) entered LOGO state from %s state\n",
1397 fc_host_port_id(lport->host), fc_lport_state(lport));
1399 fc_lport_state_enter(lport, LPORT_ST_LOGO);
1401 /* DNS session should be closed so we can release it here */
1403 lport->tt.rport_logoff(lport->dns_rp);
1405 fp = fc_frame_alloc(lport, sizeof(*logo));
1407 fc_lport_error(lport, fp);
1411 if (!lport->tt.elsct_send(lport, NULL, fp, ELS_LOGO, fc_lport_logo_resp,
1412 lport, lport->e_d_tov))
1413 fc_lport_error(lport, fp);
1417 * fc_lport_flogi_resp() - Handle response to FLOGI request
1418 * @sp: current sequence in FLOGI exchange
1419 * @fp: response frame
1420 * @lp_arg: Fibre Channel lport port instance that sent the FLOGI request
1422 * Locking Note: This function will be called without the lport lock
1423 * held, but it will lock, call an _enter_* function or fc_lport_error
1424 * and then unlock the lport.
1426 static void fc_lport_flogi_resp(struct fc_seq *sp, struct fc_frame *fp,
1429 struct fc_lport *lport = lp_arg;
1430 struct fc_frame_header *fh;
1431 struct fc_els_flogi *flp;
1434 unsigned int r_a_tov;
1435 unsigned int e_d_tov;
1438 if (fp == ERR_PTR(-FC_EX_CLOSED))
1441 mutex_lock(&lport->lp_mutex);
1443 FC_DEBUG_LPORT("Received a FLOGI response\n");
1446 fc_lport_error(lport, fp);
1450 if (lport->state != LPORT_ST_FLOGI) {
1451 FC_DBG("Received a FLOGI response, but in state %s\n",
1452 fc_lport_state(lport));
1456 fh = fc_frame_header_get(fp);
1457 did = ntoh24(fh->fh_d_id);
1458 if (fc_frame_payload_op(fp) == ELS_LS_ACC && did != 0) {
1460 FC_DEBUG_LPORT("Assigned fid %x\n", did);
1461 fc_host_port_id(lport->host) = did;
1463 flp = fc_frame_payload_get(fp, sizeof(*flp));
1465 mfs = ntohs(flp->fl_csp.sp_bb_data) &
1467 if (mfs >= FC_SP_MIN_MAX_PAYLOAD &&
1470 csp_flags = ntohs(flp->fl_csp.sp_features);
1471 r_a_tov = ntohl(flp->fl_csp.sp_r_a_tov);
1472 e_d_tov = ntohl(flp->fl_csp.sp_e_d_tov);
1473 if (csp_flags & FC_SP_FT_EDTR)
1475 if ((csp_flags & FC_SP_FT_FPORT) == 0) {
1476 if (e_d_tov > lport->e_d_tov)
1477 lport->e_d_tov = e_d_tov;
1478 lport->r_a_tov = 2 * e_d_tov;
1479 FC_DBG("Point-to-Point mode\n");
1480 fc_lport_ptp_setup(lport, ntoh24(fh->fh_s_id),
1486 lport->e_d_tov = e_d_tov;
1487 lport->r_a_tov = r_a_tov;
1488 fc_host_fabric_name(lport->host) =
1489 get_unaligned_be64(&flp->fl_wwnn);
1490 fc_lport_enter_dns(lport);
1495 csp_flags = ntohs(flp->fl_csp.sp_features);
1496 if ((csp_flags & FC_SP_FT_FPORT) == 0) {
1497 lport->tt.disc_start(fc_lport_disc_callback,
1502 FC_DBG("bad FLOGI response\n");
1508 mutex_unlock(&lport->lp_mutex);
1512 * fc_rport_enter_flogi() - Send a FLOGI request to the fabric manager
1513 * @lport: Fibre Channel local port to be logged in to the fabric
1515 * Locking Note: The lport lock is expected to be held before calling
1518 void fc_lport_enter_flogi(struct fc_lport *lport)
1520 struct fc_frame *fp;
1522 FC_DEBUG_LPORT("Processing FLOGI state\n");
1524 fc_lport_state_enter(lport, LPORT_ST_FLOGI);
1526 fp = fc_frame_alloc(lport, sizeof(struct fc_els_flogi));
1528 return fc_lport_error(lport, fp);
1530 if (!lport->tt.elsct_send(lport, NULL, fp, ELS_FLOGI,
1531 fc_lport_flogi_resp, lport, lport->e_d_tov))
1532 fc_lport_error(lport, fp);
1535 /* Configure a fc_lport */
1536 int fc_lport_config(struct fc_lport *lport)
1538 INIT_DELAYED_WORK(&lport->retry_work, fc_lport_timeout);
1539 mutex_init(&lport->lp_mutex);
1541 fc_lport_state_enter(lport, LPORT_ST_NONE);
1543 fc_lport_add_fc4_type(lport, FC_TYPE_FCP);
1544 fc_lport_add_fc4_type(lport, FC_TYPE_CT);
1548 EXPORT_SYMBOL(fc_lport_config);
1550 int fc_lport_init(struct fc_lport *lport)
1552 if (!lport->tt.lport_recv)
1553 lport->tt.lport_recv = fc_lport_recv_req;
1555 if (!lport->tt.lport_reset)
1556 lport->tt.lport_reset = fc_lport_reset;
1558 fc_host_port_type(lport->host) = FC_PORTTYPE_NPORT;
1559 fc_host_node_name(lport->host) = lport->wwnn;
1560 fc_host_port_name(lport->host) = lport->wwpn;
1561 fc_host_supported_classes(lport->host) = FC_COS_CLASS3;
1562 memset(fc_host_supported_fc4s(lport->host), 0,
1563 sizeof(fc_host_supported_fc4s(lport->host)));
1564 fc_host_supported_fc4s(lport->host)[2] = 1;
1565 fc_host_supported_fc4s(lport->host)[7] = 1;
1567 /* This value is also unchanging */
1568 memset(fc_host_active_fc4s(lport->host), 0,
1569 sizeof(fc_host_active_fc4s(lport->host)));
1570 fc_host_active_fc4s(lport->host)[2] = 1;
1571 fc_host_active_fc4s(lport->host)[7] = 1;
1572 fc_host_maxframe_size(lport->host) = lport->mfs;
1573 fc_host_supported_speeds(lport->host) = 0;
1574 if (lport->link_supported_speeds & FC_PORTSPEED_1GBIT)
1575 fc_host_supported_speeds(lport->host) |= FC_PORTSPEED_1GBIT;
1576 if (lport->link_supported_speeds & FC_PORTSPEED_10GBIT)
1577 fc_host_supported_speeds(lport->host) |= FC_PORTSPEED_10GBIT;
1581 EXPORT_SYMBOL(fc_lport_init);