2 * Copyright(c) 2007 - 2008 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
17 * Maintained at www.Open-FCoE.org
23 * This file contains all processing regarding fc_rports. It contains the
24 * rport state machine and does all rport interaction with the transport class.
25 * There should be no other places in libfc that interact directly with the
26 * transport class in regards to adding and deleting rports.
28 * fc_rport's represent N_Port's within the fabric.
34 * The rport should never hold the rport mutex and then attempt to acquire
35 * either the lport or disc mutexes. The rport's mutex is considered lesser
36 * than both the lport's mutex and the disc mutex. Refer to fc_lport.c for
37 * more comments on the heirarchy.
39 * The locking strategy is similar to the lport's strategy. The lock protects
40 * the rport's states and is held and released by the entry points to the rport
41 * block. All _enter_* functions correspond to rport states and expect the rport
42 * mutex to be locked before calling them. This means that rports only handle
43 * one request or response at a time, since they're not critical for the I/O
44 * path this potential over-use of the mutex is acceptable.
47 #include <linux/kernel.h>
48 #include <linux/spinlock.h>
49 #include <linux/interrupt.h>
50 #include <linux/rcupdate.h>
51 #include <linux/timer.h>
52 #include <linux/workqueue.h>
53 #include <asm/unaligned.h>
55 #include <scsi/libfc.h>
56 #include <scsi/fc_encode.h>
58 struct workqueue_struct *rport_event_queue;
60 static void fc_rport_enter_plogi(struct fc_rport_priv *);
61 static void fc_rport_enter_prli(struct fc_rport_priv *);
62 static void fc_rport_enter_rtv(struct fc_rport_priv *);
63 static void fc_rport_enter_ready(struct fc_rport_priv *);
64 static void fc_rport_enter_logo(struct fc_rport_priv *);
66 static void fc_rport_recv_plogi_req(struct fc_rport_priv *,
67 struct fc_seq *, struct fc_frame *);
68 static void fc_rport_recv_prli_req(struct fc_rport_priv *,
69 struct fc_seq *, struct fc_frame *);
70 static void fc_rport_recv_prlo_req(struct fc_rport_priv *,
71 struct fc_seq *, struct fc_frame *);
72 static void fc_rport_recv_logo_req(struct fc_rport_priv *,
73 struct fc_seq *, struct fc_frame *);
74 static void fc_rport_timeout(struct work_struct *);
75 static void fc_rport_error(struct fc_rport_priv *, struct fc_frame *);
76 static void fc_rport_error_retry(struct fc_rport_priv *, struct fc_frame *);
77 static void fc_rport_work(struct work_struct *);
79 static const char *fc_rport_state_names[] = {
80 [RPORT_ST_INIT] = "Init",
81 [RPORT_ST_PLOGI] = "PLOGI",
82 [RPORT_ST_PRLI] = "PRLI",
83 [RPORT_ST_RTV] = "RTV",
84 [RPORT_ST_READY] = "Ready",
85 [RPORT_ST_LOGO] = "LOGO",
86 [RPORT_ST_DELETE] = "Delete",
90 * fc_rport_lookup() - lookup a remote port by port_id
91 * @lport: Fibre Channel host port instance
92 * @port_id: remote port port_id to match
94 static struct fc_rport_priv *fc_rport_lookup(const struct fc_lport *lport,
97 struct fc_rport_priv *rdata;
99 list_for_each_entry(rdata, &lport->disc.rports, peers)
100 if (rdata->ids.port_id == port_id &&
101 rdata->rp_state != RPORT_ST_DELETE)
107 * fc_rport_create() - Create a new remote port
108 * @lport: The local port that the new remote port is for
109 * @port_id: The port ID for the new remote port
111 * Locking note: must be called with the disc_mutex held.
113 static struct fc_rport_priv *fc_rport_create(struct fc_lport *lport,
116 struct fc_rport_priv *rdata;
118 rdata = lport->tt.rport_lookup(lport, port_id);
122 rdata = kzalloc(sizeof(*rdata), GFP_KERNEL);
126 rdata->ids.node_name = -1;
127 rdata->ids.port_name = -1;
128 rdata->ids.port_id = port_id;
129 rdata->ids.roles = FC_RPORT_ROLE_UNKNOWN;
131 kref_init(&rdata->kref);
132 mutex_init(&rdata->rp_mutex);
133 rdata->local_port = lport;
134 rdata->rp_state = RPORT_ST_INIT;
135 rdata->event = RPORT_EV_NONE;
136 rdata->flags = FC_RP_FLAGS_REC_SUPPORTED;
137 rdata->e_d_tov = lport->e_d_tov;
138 rdata->r_a_tov = lport->r_a_tov;
139 rdata->maxframe_size = FC_MIN_MAX_PAYLOAD;
140 INIT_DELAYED_WORK(&rdata->retry_work, fc_rport_timeout);
141 INIT_WORK(&rdata->event_work, fc_rport_work);
142 if (port_id != FC_FID_DIR_SERV)
143 list_add(&rdata->peers, &lport->disc.rports);
148 * fc_rport_destroy() - free a remote port after last reference is released.
149 * @kref: pointer to kref inside struct fc_rport_priv
151 static void fc_rport_destroy(struct kref *kref)
153 struct fc_rport_priv *rdata;
155 rdata = container_of(kref, struct fc_rport_priv, kref);
160 * fc_rport_state() - return a string for the state the rport is in
161 * @rdata: remote port private data
163 static const char *fc_rport_state(struct fc_rport_priv *rdata)
167 cp = fc_rport_state_names[rdata->rp_state];
174 * fc_set_rport_loss_tmo() - Set the remote port loss timeout in seconds.
175 * @rport: Pointer to Fibre Channel remote port structure
176 * @timeout: timeout in seconds
178 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout)
181 rport->dev_loss_tmo = timeout + 5;
183 rport->dev_loss_tmo = 30;
185 EXPORT_SYMBOL(fc_set_rport_loss_tmo);
188 * fc_plogi_get_maxframe() - Get max payload from the common service parameters
189 * @flp: FLOGI payload structure
190 * @maxval: upper limit, may be less than what is in the service parameters
192 static unsigned int fc_plogi_get_maxframe(struct fc_els_flogi *flp,
198 * Get max payload from the common service parameters and the
199 * class 3 receive data field size.
201 mfs = ntohs(flp->fl_csp.sp_bb_data) & FC_SP_BB_DATA_MASK;
202 if (mfs >= FC_SP_MIN_MAX_PAYLOAD && mfs < maxval)
204 mfs = ntohs(flp->fl_cssp[3 - 1].cp_rdfs);
205 if (mfs >= FC_SP_MIN_MAX_PAYLOAD && mfs < maxval)
211 * fc_rport_state_enter() - Change the rport's state
212 * @rdata: The rport whose state should change
213 * @new: The new state of the rport
215 * Locking Note: Called with the rport lock held
217 static void fc_rport_state_enter(struct fc_rport_priv *rdata,
218 enum fc_rport_state new)
220 if (rdata->rp_state != new)
222 rdata->rp_state = new;
225 static void fc_rport_work(struct work_struct *work)
228 struct fc_rport_priv *rdata =
229 container_of(work, struct fc_rport_priv, event_work);
230 struct fc_rport_libfc_priv *rp;
231 enum fc_rport_event event;
232 struct fc_lport *lport = rdata->local_port;
233 struct fc_rport_operations *rport_ops;
234 struct fc_rport_identifiers ids;
235 struct fc_rport *rport;
237 mutex_lock(&rdata->rp_mutex);
238 event = rdata->event;
239 rport_ops = rdata->ops;
240 rport = rdata->rport;
242 FC_RPORT_DBG(rdata, "work event %u\n", event);
247 rdata->event = RPORT_EV_NONE;
248 kref_get(&rdata->kref);
249 mutex_unlock(&rdata->rp_mutex);
252 rport = fc_remote_port_add(lport->host, 0, &ids);
254 FC_RPORT_DBG(rdata, "Failed to add the rport\n");
255 lport->tt.rport_logoff(rdata);
256 kref_put(&rdata->kref, lport->tt.rport_destroy);
259 mutex_lock(&rdata->rp_mutex);
261 FC_RPORT_DBG(rdata, "rport already allocated\n");
262 rdata->rport = rport;
263 rport->maxframe_size = rdata->maxframe_size;
264 rport->supported_classes = rdata->supported_classes;
267 rp->local_port = lport;
268 rp->rp_state = rdata->rp_state;
269 rp->flags = rdata->flags;
270 rp->e_d_tov = rdata->e_d_tov;
271 rp->r_a_tov = rdata->r_a_tov;
272 mutex_unlock(&rdata->rp_mutex);
274 if (rport_ops && rport_ops->event_callback) {
275 FC_RPORT_DBG(rdata, "callback ev %d\n", event);
276 rport_ops->event_callback(lport, rdata, event);
278 kref_put(&rdata->kref, lport->tt.rport_destroy);
281 case RPORT_EV_FAILED:
284 port_id = rdata->ids.port_id;
285 mutex_unlock(&rdata->rp_mutex);
287 if (port_id != FC_FID_DIR_SERV) {
288 mutex_lock(&lport->disc.disc_mutex);
289 list_del(&rdata->peers);
290 mutex_unlock(&lport->disc.disc_mutex);
293 if (rport_ops && rport_ops->event_callback) {
294 FC_RPORT_DBG(rdata, "callback ev %d\n", event);
295 rport_ops->event_callback(lport, rdata, event);
297 cancel_delayed_work_sync(&rdata->retry_work);
300 * Reset any outstanding exchanges before freeing rport.
302 lport->tt.exch_mgr_reset(lport, 0, port_id);
303 lport->tt.exch_mgr_reset(lport, port_id, 0);
307 rp->rp_state = RPORT_ST_DELETE;
308 mutex_lock(&rdata->rp_mutex);
310 mutex_unlock(&rdata->rp_mutex);
311 fc_remote_port_delete(rport);
313 kref_put(&rdata->kref, lport->tt.rport_destroy);
317 mutex_unlock(&rdata->rp_mutex);
323 * fc_rport_login() - Start the remote port login state machine
324 * @rdata: private remote port
326 * Locking Note: Called without the rport lock held. This
327 * function will hold the rport lock, call an _enter_*
328 * function and then unlock the rport.
330 int fc_rport_login(struct fc_rport_priv *rdata)
332 mutex_lock(&rdata->rp_mutex);
334 FC_RPORT_DBG(rdata, "Login to port\n");
336 fc_rport_enter_plogi(rdata);
338 mutex_unlock(&rdata->rp_mutex);
344 * fc_rport_enter_delete() - schedule a remote port to be deleted.
345 * @rdata: private remote port
346 * @event: event to report as the reason for deletion
348 * Locking Note: Called with the rport lock held.
350 * Allow state change into DELETE only once.
352 * Call queue_work only if there's no event already pending.
353 * Set the new event so that the old pending event will not occur.
354 * Since we have the mutex, even if fc_rport_work() is already started,
355 * it'll see the new event.
357 static void fc_rport_enter_delete(struct fc_rport_priv *rdata,
358 enum fc_rport_event event)
360 if (rdata->rp_state == RPORT_ST_DELETE)
363 FC_RPORT_DBG(rdata, "Delete port\n");
365 fc_rport_state_enter(rdata, RPORT_ST_DELETE);
367 if (rdata->event == RPORT_EV_NONE)
368 queue_work(rport_event_queue, &rdata->event_work);
369 rdata->event = event;
373 * fc_rport_logoff() - Logoff and remove an rport
374 * @rdata: private remote port
376 * Locking Note: Called without the rport lock held. This
377 * function will hold the rport lock, call an _enter_*
378 * function and then unlock the rport.
380 int fc_rport_logoff(struct fc_rport_priv *rdata)
382 mutex_lock(&rdata->rp_mutex);
384 FC_RPORT_DBG(rdata, "Remove port\n");
386 if (rdata->rp_state == RPORT_ST_DELETE) {
387 FC_RPORT_DBG(rdata, "Port in Delete state, not removing\n");
388 mutex_unlock(&rdata->rp_mutex);
392 fc_rport_enter_logo(rdata);
395 * Change the state to Delete so that we discard
398 fc_rport_enter_delete(rdata, RPORT_EV_STOP);
399 mutex_unlock(&rdata->rp_mutex);
406 * fc_rport_enter_ready() - The rport is ready
407 * @rdata: private remote port
409 * Locking Note: The rport lock is expected to be held before calling
412 static void fc_rport_enter_ready(struct fc_rport_priv *rdata)
414 fc_rport_state_enter(rdata, RPORT_ST_READY);
416 FC_RPORT_DBG(rdata, "Port is Ready\n");
418 if (rdata->event == RPORT_EV_NONE)
419 queue_work(rport_event_queue, &rdata->event_work);
420 rdata->event = RPORT_EV_READY;
424 * fc_rport_timeout() - Handler for the retry_work timer.
425 * @work: The work struct of the fc_rport_priv
427 * Locking Note: Called without the rport lock held. This
428 * function will hold the rport lock, call an _enter_*
429 * function and then unlock the rport.
431 static void fc_rport_timeout(struct work_struct *work)
433 struct fc_rport_priv *rdata =
434 container_of(work, struct fc_rport_priv, retry_work.work);
436 mutex_lock(&rdata->rp_mutex);
438 switch (rdata->rp_state) {
440 fc_rport_enter_plogi(rdata);
443 fc_rport_enter_prli(rdata);
446 fc_rport_enter_rtv(rdata);
449 fc_rport_enter_logo(rdata);
453 case RPORT_ST_DELETE:
457 mutex_unlock(&rdata->rp_mutex);
461 * fc_rport_error() - Error handler, called once retries have been exhausted
462 * @rdata: private remote port
463 * @fp: The frame pointer
465 * Locking Note: The rport lock is expected to be held before
466 * calling this routine
468 static void fc_rport_error(struct fc_rport_priv *rdata, struct fc_frame *fp)
470 FC_RPORT_DBG(rdata, "Error %ld in state %s, retries %d\n",
471 IS_ERR(fp) ? -PTR_ERR(fp) : 0,
472 fc_rport_state(rdata), rdata->retries);
474 switch (rdata->rp_state) {
478 fc_rport_enter_delete(rdata, RPORT_EV_FAILED);
481 fc_rport_enter_ready(rdata);
483 case RPORT_ST_DELETE:
491 * fc_rport_error_retry() - Error handler when retries are desired
492 * @rdata: private remote port data
493 * @fp: The frame pointer
495 * If the error was an exchange timeout retry immediately,
496 * otherwise wait for E_D_TOV.
498 * Locking Note: The rport lock is expected to be held before
499 * calling this routine
501 static void fc_rport_error_retry(struct fc_rport_priv *rdata,
504 unsigned long delay = FC_DEF_E_D_TOV;
506 /* make sure this isn't an FC_EX_CLOSED error, never retry those */
507 if (PTR_ERR(fp) == -FC_EX_CLOSED)
508 return fc_rport_error(rdata, fp);
510 if (rdata->retries < rdata->local_port->max_rport_retry_count) {
511 FC_RPORT_DBG(rdata, "Error %ld in state %s, retrying\n",
512 PTR_ERR(fp), fc_rport_state(rdata));
514 /* no additional delay on exchange timeouts */
515 if (PTR_ERR(fp) == -FC_EX_TIMEOUT)
517 schedule_delayed_work(&rdata->retry_work, delay);
521 return fc_rport_error(rdata, fp);
525 * fc_rport_plogi_recv_resp() - Handle incoming ELS PLOGI response
526 * @sp: current sequence in the PLOGI exchange
527 * @fp: response frame
528 * @rdata_arg: private remote port data
530 * Locking Note: This function will be called without the rport lock
531 * held, but it will lock, call an _enter_* function or fc_rport_error
532 * and then unlock the rport.
534 static void fc_rport_plogi_resp(struct fc_seq *sp, struct fc_frame *fp,
537 struct fc_rport_priv *rdata = rdata_arg;
538 struct fc_lport *lport = rdata->local_port;
539 struct fc_els_flogi *plp = NULL;
545 mutex_lock(&rdata->rp_mutex);
547 FC_RPORT_DBG(rdata, "Received a PLOGI %s\n", fc_els_resp_type(fp));
549 if (rdata->rp_state != RPORT_ST_PLOGI) {
550 FC_RPORT_DBG(rdata, "Received a PLOGI response, but in state "
551 "%s\n", fc_rport_state(rdata));
558 fc_rport_error_retry(rdata, fp);
562 op = fc_frame_payload_op(fp);
563 if (op == ELS_LS_ACC &&
564 (plp = fc_frame_payload_get(fp, sizeof(*plp))) != NULL) {
565 rdata->ids.port_name = get_unaligned_be64(&plp->fl_wwpn);
566 rdata->ids.node_name = get_unaligned_be64(&plp->fl_wwnn);
568 tov = ntohl(plp->fl_csp.sp_e_d_tov);
569 if (ntohs(plp->fl_csp.sp_features) & FC_SP_FT_EDTR)
571 if (tov > rdata->e_d_tov)
572 rdata->e_d_tov = tov;
573 csp_seq = ntohs(plp->fl_csp.sp_tot_seq);
574 cssp_seq = ntohs(plp->fl_cssp[3 - 1].cp_con_seq);
575 if (cssp_seq < csp_seq)
577 rdata->max_seq = csp_seq;
578 rdata->maxframe_size = fc_plogi_get_maxframe(plp, lport->mfs);
581 * If the rport is one of the well known addresses
582 * we skip PRLI and RTV and go straight to READY.
584 if (rdata->ids.port_id >= FC_FID_DOM_MGR)
585 fc_rport_enter_ready(rdata);
587 fc_rport_enter_prli(rdata);
589 fc_rport_error_retry(rdata, fp);
594 mutex_unlock(&rdata->rp_mutex);
595 kref_put(&rdata->kref, rdata->local_port->tt.rport_destroy);
599 * fc_rport_enter_plogi() - Send Port Login (PLOGI) request to peer
600 * @rdata: private remote port data
602 * Locking Note: The rport lock is expected to be held before calling
605 static void fc_rport_enter_plogi(struct fc_rport_priv *rdata)
607 struct fc_lport *lport = rdata->local_port;
610 FC_RPORT_DBG(rdata, "Port entered PLOGI state from %s state\n",
611 fc_rport_state(rdata));
613 fc_rport_state_enter(rdata, RPORT_ST_PLOGI);
615 rdata->maxframe_size = FC_MIN_MAX_PAYLOAD;
616 fp = fc_frame_alloc(lport, sizeof(struct fc_els_flogi));
618 fc_rport_error_retry(rdata, fp);
621 rdata->e_d_tov = lport->e_d_tov;
623 if (!lport->tt.elsct_send(lport, rdata->ids.port_id, fp, ELS_PLOGI,
624 fc_rport_plogi_resp, rdata, lport->e_d_tov))
625 fc_rport_error_retry(rdata, fp);
627 kref_get(&rdata->kref);
631 * fc_rport_prli_resp() - Process Login (PRLI) response handler
632 * @sp: current sequence in the PRLI exchange
633 * @fp: response frame
634 * @rdata_arg: private remote port data
636 * Locking Note: This function will be called without the rport lock
637 * held, but it will lock, call an _enter_* function or fc_rport_error
638 * and then unlock the rport.
640 static void fc_rport_prli_resp(struct fc_seq *sp, struct fc_frame *fp,
643 struct fc_rport_priv *rdata = rdata_arg;
645 struct fc_els_prli prli;
646 struct fc_els_spp spp;
648 u32 roles = FC_RPORT_ROLE_UNKNOWN;
652 mutex_lock(&rdata->rp_mutex);
654 FC_RPORT_DBG(rdata, "Received a PRLI %s\n", fc_els_resp_type(fp));
656 if (rdata->rp_state != RPORT_ST_PRLI) {
657 FC_RPORT_DBG(rdata, "Received a PRLI response, but in state "
658 "%s\n", fc_rport_state(rdata));
665 fc_rport_error_retry(rdata, fp);
669 /* reinitialize remote port roles */
670 rdata->ids.roles = FC_RPORT_ROLE_UNKNOWN;
672 op = fc_frame_payload_op(fp);
673 if (op == ELS_LS_ACC) {
674 pp = fc_frame_payload_get(fp, sizeof(*pp));
675 if (pp && pp->prli.prli_spp_len >= sizeof(pp->spp)) {
676 fcp_parm = ntohl(pp->spp.spp_params);
677 if (fcp_parm & FCP_SPPF_RETRY)
678 rdata->flags |= FC_RP_FLAGS_RETRY;
681 rdata->supported_classes = FC_COS_CLASS3;
682 if (fcp_parm & FCP_SPPF_INIT_FCN)
683 roles |= FC_RPORT_ROLE_FCP_INITIATOR;
684 if (fcp_parm & FCP_SPPF_TARG_FCN)
685 roles |= FC_RPORT_ROLE_FCP_TARGET;
687 rdata->ids.roles = roles;
688 fc_rport_enter_rtv(rdata);
691 FC_RPORT_DBG(rdata, "Bad ELS response for PRLI command\n");
692 fc_rport_enter_delete(rdata, RPORT_EV_FAILED);
698 mutex_unlock(&rdata->rp_mutex);
699 kref_put(&rdata->kref, rdata->local_port->tt.rport_destroy);
703 * fc_rport_logo_resp() - Logout (LOGO) response handler
704 * @sp: current sequence in the LOGO exchange
705 * @fp: response frame
706 * @rdata_arg: private remote port data
708 * Locking Note: This function will be called without the rport lock
709 * held, but it will lock, call an _enter_* function or fc_rport_error
710 * and then unlock the rport.
712 static void fc_rport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
715 struct fc_rport_priv *rdata = rdata_arg;
718 mutex_lock(&rdata->rp_mutex);
720 FC_RPORT_DBG(rdata, "Received a LOGO %s\n", fc_els_resp_type(fp));
722 if (rdata->rp_state != RPORT_ST_LOGO) {
723 FC_RPORT_DBG(rdata, "Received a LOGO response, but in state "
724 "%s\n", fc_rport_state(rdata));
731 fc_rport_error_retry(rdata, fp);
735 op = fc_frame_payload_op(fp);
736 if (op == ELS_LS_ACC) {
737 fc_rport_enter_rtv(rdata);
739 FC_RPORT_DBG(rdata, "Bad ELS response for LOGO command\n");
740 fc_rport_enter_delete(rdata, RPORT_EV_LOGO);
746 mutex_unlock(&rdata->rp_mutex);
747 kref_put(&rdata->kref, rdata->local_port->tt.rport_destroy);
751 * fc_rport_enter_prli() - Send Process Login (PRLI) request to peer
752 * @rdata: private remote port data
754 * Locking Note: The rport lock is expected to be held before calling
757 static void fc_rport_enter_prli(struct fc_rport_priv *rdata)
759 struct fc_lport *lport = rdata->local_port;
761 struct fc_els_prli prli;
762 struct fc_els_spp spp;
766 FC_RPORT_DBG(rdata, "Port entered PRLI state from %s state\n",
767 fc_rport_state(rdata));
769 fc_rport_state_enter(rdata, RPORT_ST_PRLI);
771 fp = fc_frame_alloc(lport, sizeof(*pp));
773 fc_rport_error_retry(rdata, fp);
777 if (!lport->tt.elsct_send(lport, rdata->ids.port_id, fp, ELS_PRLI,
778 fc_rport_prli_resp, rdata, lport->e_d_tov))
779 fc_rport_error_retry(rdata, fp);
781 kref_get(&rdata->kref);
785 * fc_rport_els_rtv_resp() - Request Timeout Value response handler
786 * @sp: current sequence in the RTV exchange
787 * @fp: response frame
788 * @rdata_arg: private remote port data
790 * Many targets don't seem to support this.
792 * Locking Note: This function will be called without the rport lock
793 * held, but it will lock, call an _enter_* function or fc_rport_error
794 * and then unlock the rport.
796 static void fc_rport_rtv_resp(struct fc_seq *sp, struct fc_frame *fp,
799 struct fc_rport_priv *rdata = rdata_arg;
802 mutex_lock(&rdata->rp_mutex);
804 FC_RPORT_DBG(rdata, "Received a RTV %s\n", fc_els_resp_type(fp));
806 if (rdata->rp_state != RPORT_ST_RTV) {
807 FC_RPORT_DBG(rdata, "Received a RTV response, but in state "
808 "%s\n", fc_rport_state(rdata));
815 fc_rport_error(rdata, fp);
819 op = fc_frame_payload_op(fp);
820 if (op == ELS_LS_ACC) {
821 struct fc_els_rtv_acc *rtv;
825 rtv = fc_frame_payload_get(fp, sizeof(*rtv));
827 toq = ntohl(rtv->rtv_toq);
828 tov = ntohl(rtv->rtv_r_a_tov);
831 rdata->r_a_tov = tov;
832 tov = ntohl(rtv->rtv_e_d_tov);
833 if (toq & FC_ELS_RTV_EDRES)
837 rdata->e_d_tov = tov;
841 fc_rport_enter_ready(rdata);
846 mutex_unlock(&rdata->rp_mutex);
847 kref_put(&rdata->kref, rdata->local_port->tt.rport_destroy);
851 * fc_rport_enter_rtv() - Send Request Timeout Value (RTV) request to peer
852 * @rdata: private remote port data
854 * Locking Note: The rport lock is expected to be held before calling
857 static void fc_rport_enter_rtv(struct fc_rport_priv *rdata)
860 struct fc_lport *lport = rdata->local_port;
862 FC_RPORT_DBG(rdata, "Port entered RTV state from %s state\n",
863 fc_rport_state(rdata));
865 fc_rport_state_enter(rdata, RPORT_ST_RTV);
867 fp = fc_frame_alloc(lport, sizeof(struct fc_els_rtv));
869 fc_rport_error_retry(rdata, fp);
873 if (!lport->tt.elsct_send(lport, rdata->ids.port_id, fp, ELS_RTV,
874 fc_rport_rtv_resp, rdata, lport->e_d_tov))
875 fc_rport_error_retry(rdata, fp);
877 kref_get(&rdata->kref);
881 * fc_rport_enter_logo() - Send Logout (LOGO) request to peer
882 * @rdata: private remote port data
884 * Locking Note: The rport lock is expected to be held before calling
887 static void fc_rport_enter_logo(struct fc_rport_priv *rdata)
889 struct fc_lport *lport = rdata->local_port;
892 FC_RPORT_DBG(rdata, "Port entered LOGO state from %s state\n",
893 fc_rport_state(rdata));
895 fc_rport_state_enter(rdata, RPORT_ST_LOGO);
897 fp = fc_frame_alloc(lport, sizeof(struct fc_els_logo));
899 fc_rport_error_retry(rdata, fp);
903 if (!lport->tt.elsct_send(lport, rdata->ids.port_id, fp, ELS_LOGO,
904 fc_rport_logo_resp, rdata, lport->e_d_tov))
905 fc_rport_error_retry(rdata, fp);
907 kref_get(&rdata->kref);
912 * fc_rport_recv_req() - Receive a request from a rport
913 * @sp: current sequence in the PLOGI exchange
914 * @fp: response frame
915 * @lport: Fibre Channel local port
917 * Locking Note: Called with the lport lock held.
919 void fc_rport_recv_req(struct fc_seq *sp, struct fc_frame *fp,
920 struct fc_lport *lport)
922 struct fc_rport_priv *rdata;
923 struct fc_frame_header *fh;
924 struct fc_seq_els_data els_data;
929 els_data.explan = ELS_EXPL_NONE;
930 els_data.reason = ELS_RJT_NONE;
932 fh = fc_frame_header_get(fp);
933 s_id = ntoh24(fh->fh_s_id);
935 mutex_lock(&lport->disc.disc_mutex);
936 rdata = lport->tt.rport_lookup(lport, s_id);
938 mutex_unlock(&lport->disc.disc_mutex);
939 els_data.reason = ELS_RJT_UNAB;
940 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &els_data);
944 mutex_lock(&rdata->rp_mutex);
945 mutex_unlock(&lport->disc.disc_mutex);
947 op = fc_frame_payload_op(fp);
950 fc_rport_recv_plogi_req(rdata, sp, fp);
953 fc_rport_recv_prli_req(rdata, sp, fp);
956 fc_rport_recv_prlo_req(rdata, sp, fp);
959 fc_rport_recv_logo_req(rdata, sp, fp);
963 lport->tt.seq_els_rsp_send(sp, ELS_RRQ, &els_data);
967 lport->tt.seq_els_rsp_send(sp, ELS_REC, &els_data);
970 els_data.reason = ELS_RJT_UNSUP;
971 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &els_data);
975 mutex_unlock(&rdata->rp_mutex);
979 * fc_rport_recv_plogi_req() - Handle incoming Port Login (PLOGI) request
980 * @rdata: private remote port data
981 * @sp: current sequence in the PLOGI exchange
982 * @fp: PLOGI request frame
984 * Locking Note: The rport lock is exected to be held before calling
987 static void fc_rport_recv_plogi_req(struct fc_rport_priv *rdata,
988 struct fc_seq *sp, struct fc_frame *rx_fp)
990 struct fc_lport *lport = rdata->local_port;
991 struct fc_frame *fp = rx_fp;
993 struct fc_frame_header *fh;
994 struct fc_els_flogi *pl;
995 struct fc_seq_els_data rjt_data;
999 enum fc_els_rjt_reason reject = 0;
1003 fh = fc_frame_header_get(fp);
1005 FC_RPORT_DBG(rdata, "Received PLOGI request while in state %s\n",
1006 fc_rport_state(rdata));
1008 sid = ntoh24(fh->fh_s_id);
1009 pl = fc_frame_payload_get(fp, sizeof(*pl));
1011 FC_RPORT_DBG(rdata, "Received PLOGI too short\n");
1013 /* XXX TBD: send reject? */
1017 wwpn = get_unaligned_be64(&pl->fl_wwpn);
1018 wwnn = get_unaligned_be64(&pl->fl_wwnn);
1021 * If the session was just created, possibly due to the incoming PLOGI,
1022 * set the state appropriately and accept the PLOGI.
1024 * If we had also sent a PLOGI, and if the received PLOGI is from a
1025 * higher WWPN, we accept it, otherwise an LS_RJT is sent with reason
1026 * "command already in progress".
1028 * XXX TBD: If the session was ready before, the PLOGI should result in
1029 * all outstanding exchanges being reset.
1031 switch (rdata->rp_state) {
1033 FC_RPORT_DBG(rdata, "Received PLOGI, wwpn %llx state INIT "
1034 "- reject\n", (unsigned long long)wwpn);
1035 reject = ELS_RJT_UNSUP;
1037 case RPORT_ST_PLOGI:
1038 FC_RPORT_DBG(rdata, "Received PLOGI in PLOGI state %d\n",
1040 if (wwpn < lport->wwpn)
1041 reject = ELS_RJT_INPROG;
1044 case RPORT_ST_READY:
1045 FC_RPORT_DBG(rdata, "Received PLOGI in logged-in state %d "
1046 "- ignored for now\n", rdata->rp_state);
1047 /* XXX TBD - should reset */
1049 case RPORT_ST_DELETE:
1051 FC_RPORT_DBG(rdata, "Received PLOGI in unexpected "
1052 "state %d\n", rdata->rp_state);
1059 rjt_data.reason = reject;
1060 rjt_data.explan = ELS_EXPL_NONE;
1061 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
1064 fp = fc_frame_alloc(lport, sizeof(*pl));
1067 rjt_data.reason = ELS_RJT_UNAB;
1068 rjt_data.explan = ELS_EXPL_NONE;
1069 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
1072 sp = lport->tt.seq_start_next(sp);
1074 rdata->ids.port_name = wwpn;
1075 rdata->ids.node_name = wwnn;
1078 * Get session payload size from incoming PLOGI.
1080 rdata->maxframe_size =
1081 fc_plogi_get_maxframe(pl, lport->mfs);
1082 fc_frame_free(rx_fp);
1083 fc_plogi_fill(lport, fp, ELS_LS_ACC);
1086 * Send LS_ACC. If this fails,
1087 * the originator should retry.
1089 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ;
1090 f_ctl |= FC_FC_END_SEQ | FC_FC_SEQ_INIT;
1091 ep = fc_seq_exch(sp);
1092 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
1093 FC_TYPE_ELS, f_ctl, 0);
1094 lport->tt.seq_send(lport, sp, fp);
1095 if (rdata->rp_state == RPORT_ST_PLOGI)
1096 fc_rport_enter_prli(rdata);
1102 * fc_rport_recv_prli_req() - Handle incoming Process Login (PRLI) request
1103 * @rdata: private remote port data
1104 * @sp: current sequence in the PRLI exchange
1105 * @fp: PRLI request frame
1107 * Locking Note: The rport lock is exected to be held before calling
1110 static void fc_rport_recv_prli_req(struct fc_rport_priv *rdata,
1111 struct fc_seq *sp, struct fc_frame *rx_fp)
1113 struct fc_lport *lport = rdata->local_port;
1115 struct fc_frame *fp;
1116 struct fc_frame_header *fh;
1118 struct fc_els_prli prli;
1119 struct fc_els_spp spp;
1121 struct fc_els_spp *rspp; /* request service param page */
1122 struct fc_els_spp *spp; /* response spp */
1125 enum fc_els_rjt_reason reason = ELS_RJT_UNAB;
1126 enum fc_els_rjt_explan explan = ELS_EXPL_NONE;
1127 enum fc_els_spp_resp resp;
1128 struct fc_seq_els_data rjt_data;
1131 u32 roles = FC_RPORT_ROLE_UNKNOWN;
1134 fh = fc_frame_header_get(rx_fp);
1136 FC_RPORT_DBG(rdata, "Received PRLI request while in state %s\n",
1137 fc_rport_state(rdata));
1139 switch (rdata->rp_state) {
1141 case RPORT_ST_READY:
1142 reason = ELS_RJT_NONE;
1145 fc_frame_free(rx_fp);
1149 len = fr_len(rx_fp) - sizeof(*fh);
1150 pp = fc_frame_payload_get(rx_fp, sizeof(*pp));
1152 reason = ELS_RJT_PROT;
1153 explan = ELS_EXPL_INV_LEN;
1155 plen = ntohs(pp->prli.prli_len);
1156 if ((plen % 4) != 0 || plen > len) {
1157 reason = ELS_RJT_PROT;
1158 explan = ELS_EXPL_INV_LEN;
1159 } else if (plen < len) {
1162 plen = pp->prli.prli_spp_len;
1163 if ((plen % 4) != 0 || plen < sizeof(*spp) ||
1164 plen > len || len < sizeof(*pp)) {
1165 reason = ELS_RJT_PROT;
1166 explan = ELS_EXPL_INV_LEN;
1170 if (reason != ELS_RJT_NONE ||
1171 (fp = fc_frame_alloc(lport, len)) == NULL) {
1172 rjt_data.reason = reason;
1173 rjt_data.explan = explan;
1174 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
1176 sp = lport->tt.seq_start_next(sp);
1178 pp = fc_frame_payload_get(fp, len);
1181 pp->prli.prli_cmd = ELS_LS_ACC;
1182 pp->prli.prli_spp_len = plen;
1183 pp->prli.prli_len = htons(len);
1184 len -= sizeof(struct fc_els_prli);
1186 /* reinitialize remote port roles */
1187 rdata->ids.roles = FC_RPORT_ROLE_UNKNOWN;
1190 * Go through all the service parameter pages and build
1191 * response. If plen indicates longer SPP than standard,
1192 * use that. The entire response has been pre-cleared above.
1195 while (len >= plen) {
1196 spp->spp_type = rspp->spp_type;
1197 spp->spp_type_ext = rspp->spp_type_ext;
1198 spp->spp_flags = rspp->spp_flags & FC_SPP_EST_IMG_PAIR;
1199 resp = FC_SPP_RESP_ACK;
1200 if (rspp->spp_flags & FC_SPP_RPA_VAL)
1201 resp = FC_SPP_RESP_NO_PA;
1202 switch (rspp->spp_type) {
1203 case 0: /* common to all FC-4 types */
1206 fcp_parm = ntohl(rspp->spp_params);
1207 if (fcp_parm * FCP_SPPF_RETRY)
1208 rdata->flags |= FC_RP_FLAGS_RETRY;
1209 rdata->supported_classes = FC_COS_CLASS3;
1210 if (fcp_parm & FCP_SPPF_INIT_FCN)
1211 roles |= FC_RPORT_ROLE_FCP_INITIATOR;
1212 if (fcp_parm & FCP_SPPF_TARG_FCN)
1213 roles |= FC_RPORT_ROLE_FCP_TARGET;
1214 rdata->ids.roles = roles;
1217 htonl(lport->service_params);
1220 resp = FC_SPP_RESP_INVL;
1223 spp->spp_flags |= resp;
1225 rspp = (struct fc_els_spp *)((char *)rspp + plen);
1226 spp = (struct fc_els_spp *)((char *)spp + plen);
1230 * Send LS_ACC. If this fails, the originator should retry.
1232 f_ctl = FC_FC_EX_CTX | FC_FC_LAST_SEQ;
1233 f_ctl |= FC_FC_END_SEQ | FC_FC_SEQ_INIT;
1234 ep = fc_seq_exch(sp);
1235 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REP, ep->did, ep->sid,
1236 FC_TYPE_ELS, f_ctl, 0);
1237 lport->tt.seq_send(lport, sp, fp);
1240 * Get lock and re-check state.
1242 switch (rdata->rp_state) {
1244 fc_rport_enter_ready(rdata);
1246 case RPORT_ST_READY:
1252 fc_frame_free(rx_fp);
1256 * fc_rport_recv_prlo_req() - Handle incoming Process Logout (PRLO) request
1257 * @rdata: private remote port data
1258 * @sp: current sequence in the PRLO exchange
1259 * @fp: PRLO request frame
1261 * Locking Note: The rport lock is exected to be held before calling
1264 static void fc_rport_recv_prlo_req(struct fc_rport_priv *rdata,
1266 struct fc_frame *fp)
1268 struct fc_lport *lport = rdata->local_port;
1270 struct fc_frame_header *fh;
1271 struct fc_seq_els_data rjt_data;
1273 fh = fc_frame_header_get(fp);
1275 FC_RPORT_DBG(rdata, "Received PRLO request while in state %s\n",
1276 fc_rport_state(rdata));
1278 if (rdata->rp_state == RPORT_ST_DELETE) {
1284 rjt_data.reason = ELS_RJT_UNAB;
1285 rjt_data.explan = ELS_EXPL_NONE;
1286 lport->tt.seq_els_rsp_send(sp, ELS_LS_RJT, &rjt_data);
1291 * fc_rport_recv_logo_req() - Handle incoming Logout (LOGO) request
1292 * @rdata: private remote port data
1293 * @sp: current sequence in the LOGO exchange
1294 * @fp: LOGO request frame
1296 * Locking Note: The rport lock is exected to be held before calling
1299 static void fc_rport_recv_logo_req(struct fc_rport_priv *rdata,
1301 struct fc_frame *fp)
1303 struct fc_frame_header *fh;
1304 struct fc_lport *lport = rdata->local_port;
1306 fh = fc_frame_header_get(fp);
1308 FC_RPORT_DBG(rdata, "Received LOGO request while in state %s\n",
1309 fc_rport_state(rdata));
1311 if (rdata->rp_state == RPORT_ST_DELETE) {
1316 fc_rport_enter_delete(rdata, RPORT_EV_LOGO);
1318 lport->tt.seq_els_rsp_send(sp, ELS_LS_ACC, NULL);
1322 static void fc_rport_flush_queue(void)
1324 flush_workqueue(rport_event_queue);
1327 int fc_rport_init(struct fc_lport *lport)
1329 if (!lport->tt.rport_lookup)
1330 lport->tt.rport_lookup = fc_rport_lookup;
1332 if (!lport->tt.rport_create)
1333 lport->tt.rport_create = fc_rport_create;
1335 if (!lport->tt.rport_login)
1336 lport->tt.rport_login = fc_rport_login;
1338 if (!lport->tt.rport_logoff)
1339 lport->tt.rport_logoff = fc_rport_logoff;
1341 if (!lport->tt.rport_recv_req)
1342 lport->tt.rport_recv_req = fc_rport_recv_req;
1344 if (!lport->tt.rport_flush_queue)
1345 lport->tt.rport_flush_queue = fc_rport_flush_queue;
1347 if (!lport->tt.rport_destroy)
1348 lport->tt.rport_destroy = fc_rport_destroy;
1352 EXPORT_SYMBOL(fc_rport_init);
1354 int fc_setup_rport(void)
1356 rport_event_queue = create_singlethread_workqueue("fc_rport_eq");
1357 if (!rport_event_queue)
1361 EXPORT_SYMBOL(fc_setup_rport);
1363 void fc_destroy_rport(void)
1365 destroy_workqueue(rport_event_queue);
1367 EXPORT_SYMBOL(fc_destroy_rport);
1369 void fc_rport_terminate_io(struct fc_rport *rport)
1371 struct fc_rport_libfc_priv *rp = rport->dd_data;
1372 struct fc_lport *lport = rp->local_port;
1374 lport->tt.exch_mgr_reset(lport, 0, rport->port_id);
1375 lport->tt.exch_mgr_reset(lport, rport->port_id, 0);
1377 EXPORT_SYMBOL(fc_rport_terminate_io);