1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2021 Broadcom. All Rights Reserved. The term
4 * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
10 * Port object for physical port and NPIV ports.
14 * NPORT REFERENCE COUNTING
16 * A nport reference should be taken when:
17 * - an nport is allocated
18 * - a vport populates associated nport
19 * - a remote node is allocated
20 * - a unsolicited frame is processed
21 * The reference should be dropped when:
22 * - the unsolicited frame processesing is done
23 * - the remote node is removed
24 * - the vport is removed
25 * - the nport is removed
31 efc_nport_cb(void *arg, int event, void *data)
33 struct efc *efc = arg;
34 struct efc_nport *nport = data;
35 unsigned long flags = 0;
37 efc_log_debug(efc, "nport event: %s\n", efc_sm_event_name(event));
39 spin_lock_irqsave(&efc->lock, flags);
40 efc_sm_post_event(&nport->sm, event, NULL);
41 spin_unlock_irqrestore(&efc->lock, flags);
44 static struct efc_nport *
45 efc_nport_find_wwn(struct efc_domain *domain, uint64_t wwnn, uint64_t wwpn)
47 struct efc_nport *nport = NULL;
49 /* Find a nport, given the WWNN and WWPN */
50 list_for_each_entry(nport, &domain->nport_list, list_entry) {
51 if (nport->wwnn == wwnn && nport->wwpn == wwpn)
58 _efc_nport_free(struct kref *arg)
60 struct efc_nport *nport = container_of(arg, struct efc_nport, ref);
66 efc_nport_alloc(struct efc_domain *domain, uint64_t wwpn, uint64_t wwnn,
67 u32 fc_id, bool enable_ini, bool enable_tgt)
69 struct efc_nport *nport;
71 if (domain->efc->enable_ini)
74 /* Return a failure if this nport has already been allocated */
75 if ((wwpn != 0) || (wwnn != 0)) {
76 nport = efc_nport_find_wwn(domain, wwnn, wwpn);
78 efc_log_err(domain->efc,
79 "NPORT %016llX %016llX already allocated\n",
85 nport = kzalloc(sizeof(*nport), GFP_ATOMIC);
89 /* initialize refcount */
90 kref_init(&nport->ref);
91 nport->release = _efc_nport_free;
93 nport->efc = domain->efc;
94 snprintf(nport->display_name, sizeof(nport->display_name), "------");
95 nport->domain = domain;
96 xa_init(&nport->lookup);
97 nport->instance_index = domain->nport_count++;
98 nport->sm.app = nport;
99 nport->enable_ini = enable_ini;
100 nport->enable_tgt = enable_tgt;
101 nport->enable_rscn = (nport->enable_ini ||
102 (nport->enable_tgt && enable_target_rscn(nport->efc)));
104 /* Copy service parameters from domain */
105 memcpy(nport->service_params, domain->service_params,
106 sizeof(struct fc_els_flogi));
108 /* Update requested fc_id */
109 nport->fc_id = fc_id;
111 /* Update the nport's service parameters for the new wwn's */
114 snprintf(nport->wwnn_str, sizeof(nport->wwnn_str), "%016llX",
115 (unsigned long long)wwnn);
118 * if this is the "first" nport of the domain,
119 * then make it the "phys" nport
121 if (list_empty(&domain->nport_list))
122 domain->nport = nport;
124 INIT_LIST_HEAD(&nport->list_entry);
125 list_add_tail(&nport->list_entry, &domain->nport_list);
127 kref_get(&domain->ref);
129 efc_log_debug(domain->efc, "New Nport [%s]\n", nport->display_name);
135 efc_nport_free(struct efc_nport *nport)
137 struct efc_domain *domain;
142 domain = nport->domain;
143 efc_log_debug(domain->efc, "[%s] free nport\n", nport->display_name);
144 list_del(&nport->list_entry);
146 * if this is the physical nport,
147 * then clear it out of the domain
149 if (nport == domain->nport)
150 domain->nport = NULL;
152 xa_destroy(&nport->lookup);
153 xa_erase(&domain->lookup, nport->fc_id);
155 if (list_empty(&domain->nport_list))
156 efc_domain_post_event(domain, EFC_EVT_ALL_CHILD_NODES_FREE,
159 kref_put(&domain->ref, domain->release);
160 kref_put(&nport->ref, nport->release);
164 efc_nport_find(struct efc_domain *domain, u32 d_id)
166 struct efc_nport *nport;
168 /* Find a nport object, given an FC_ID */
169 nport = xa_load(&domain->lookup, d_id);
170 if (!nport || !kref_get_unless_zero(&nport->ref))
177 efc_nport_attach(struct efc_nport *nport, u32 fc_id)
180 struct efc_node *node;
181 struct efc *efc = nport->efc;
185 rc = xa_err(xa_store(&nport->domain->lookup, fc_id, nport, GFP_ATOMIC));
187 efc_log_err(efc, "Sport lookup store failed: %d\n", rc);
191 /* Update our display_name */
192 efc_node_fcid_display(fc_id, nport->display_name,
193 sizeof(nport->display_name));
195 xa_for_each(&nport->lookup, index, node) {
196 efc_node_update_display_name(node);
199 efc_log_debug(nport->efc, "[%s] attach nport: fc_id x%06x\n",
200 nport->display_name, fc_id);
202 /* Register a nport, given an FC_ID */
203 rc = efc_cmd_nport_attach(efc, nport, fc_id);
205 efc_log_err(nport->efc,
206 "efc_hw_port_attach failed: %d\n", rc);
213 efc_nport_shutdown(struct efc_nport *nport)
215 struct efc *efc = nport->efc;
216 struct efc_node *node;
219 xa_for_each(&nport->lookup, index, node) {
220 if (!(node->rnode.fc_id == FC_FID_FLOGI && nport->is_vport)) {
221 efc_node_post_event(node, EFC_EVT_SHUTDOWN, NULL);
226 * If this is a vport, logout of the fabric
227 * controller so that it deletes the vport
230 /* if link is down, don't send logo */
231 if (efc->link_status == EFC_LINK_STATUS_DOWN) {
232 efc_node_post_event(node, EFC_EVT_SHUTDOWN, NULL);
236 efc_log_debug(efc, "[%s] nport shutdown vport, send logo\n",
239 if (!efc_send_logo(node)) {
240 /* sent LOGO, wait for response */
241 efc_node_transition(node, __efc_d_wait_logo_rsp, NULL);
246 * failed to send LOGO,
247 * go ahead and cleanup node anyways
249 node_printf(node, "Failed to send LOGO\n");
250 efc_node_post_event(node, EFC_EVT_SHUTDOWN_EXPLICIT_LOGO, NULL);
255 efc_vport_link_down(struct efc_nport *nport)
257 struct efc *efc = nport->efc;
258 struct efc_vport *vport;
260 /* Clear the nport reference in the vport specification */
261 list_for_each_entry(vport, &efc->vport_list, list_entry) {
262 if (vport->nport == nport) {
263 kref_put(&nport->ref, nport->release);
271 __efc_nport_common(const char *funcname, struct efc_sm_ctx *ctx,
272 enum efc_sm_event evt, void *arg)
274 struct efc_nport *nport = ctx->app;
275 struct efc_domain *domain = nport->domain;
276 struct efc *efc = nport->efc;
280 case EFC_EVT_REENTER:
282 case EFC_EVT_ALL_CHILD_NODES_FREE:
284 case EFC_EVT_NPORT_ATTACH_OK:
285 efc_sm_transition(ctx, __efc_nport_attached, NULL);
287 case EFC_EVT_SHUTDOWN:
288 /* Flag this nport as shutting down */
289 nport->shutting_down = true;
292 efc_vport_link_down(nport);
294 if (xa_empty(&nport->lookup)) {
295 /* Remove the nport from the domain's lookup table */
296 xa_erase(&domain->lookup, nport->fc_id);
297 efc_sm_transition(ctx, __efc_nport_wait_port_free,
299 if (efc_cmd_nport_free(efc, nport)) {
300 efc_log_debug(nport->efc,
301 "efc_hw_port_free failed\n");
302 /* Not much we can do, free the nport anyways */
303 efc_nport_free(nport);
306 /* sm: node list is not empty / shutdown nodes */
307 efc_sm_transition(ctx,
308 __efc_nport_wait_shutdown, NULL);
309 efc_nport_shutdown(nport);
313 efc_log_debug(nport->efc, "[%s] %-20s %-20s not handled\n",
314 nport->display_name, funcname,
315 efc_sm_event_name(evt));
320 __efc_nport_allocated(struct efc_sm_ctx *ctx,
321 enum efc_sm_event evt, void *arg)
323 struct efc_nport *nport = ctx->app;
324 struct efc_domain *domain = nport->domain;
326 nport_sm_trace(nport);
329 /* the physical nport is attached */
330 case EFC_EVT_NPORT_ATTACH_OK:
331 WARN_ON(nport != domain->nport);
332 efc_sm_transition(ctx, __efc_nport_attached, NULL);
335 case EFC_EVT_NPORT_ALLOC_OK:
339 __efc_nport_common(__func__, ctx, evt, arg);
344 __efc_nport_vport_init(struct efc_sm_ctx *ctx,
345 enum efc_sm_event evt, void *arg)
347 struct efc_nport *nport = ctx->app;
348 struct efc *efc = nport->efc;
350 nport_sm_trace(nport);
353 case EFC_EVT_ENTER: {
354 __be64 be_wwpn = cpu_to_be64(nport->wwpn);
356 if (nport->wwpn == 0)
357 efc_log_debug(efc, "vport: letting f/w select WWN\n");
359 if (nport->fc_id != U32_MAX) {
360 efc_log_debug(efc, "vport: hard coding port id: %x\n",
364 efc_sm_transition(ctx, __efc_nport_vport_wait_alloc, NULL);
365 /* If wwpn is zero, then we'll let the f/w assign wwpn*/
366 if (efc_cmd_nport_alloc(efc, nport, nport->domain,
367 nport->wwpn == 0 ? NULL :
368 (uint8_t *)&be_wwpn)) {
369 efc_log_err(efc, "Can't allocate port\n");
376 __efc_nport_common(__func__, ctx, evt, arg);
381 __efc_nport_vport_wait_alloc(struct efc_sm_ctx *ctx,
382 enum efc_sm_event evt, void *arg)
384 struct efc_nport *nport = ctx->app;
385 struct efc *efc = nport->efc;
387 nport_sm_trace(nport);
390 case EFC_EVT_NPORT_ALLOC_OK: {
391 struct fc_els_flogi *sp;
393 sp = (struct fc_els_flogi *)nport->service_params;
395 if (nport->wwnn == 0) {
396 nport->wwnn = be64_to_cpu(nport->sli_wwnn);
397 nport->wwpn = be64_to_cpu(nport->sli_wwpn);
398 snprintf(nport->wwnn_str, sizeof(nport->wwnn_str),
399 "%016llX", nport->wwpn);
402 /* Update the nport's service parameters */
403 sp->fl_wwpn = cpu_to_be64(nport->wwpn);
404 sp->fl_wwnn = cpu_to_be64(nport->wwnn);
407 * if nport->fc_id is uninitialized,
408 * then request that the fabric node use FDISC
410 * Otherwise we're restoring vports, or we're in
411 * fabric emulation mode, so attach the fc_id
413 if (nport->fc_id == U32_MAX) {
414 struct efc_node *fabric;
416 fabric = efc_node_alloc(nport, FC_FID_FLOGI, false,
419 efc_log_err(efc, "efc_node_alloc() failed\n");
422 efc_node_transition(fabric, __efc_vport_fabric_init,
425 snprintf(nport->wwnn_str, sizeof(nport->wwnn_str),
426 "%016llX", nport->wwpn);
427 efc_nport_attach(nport, nport->fc_id);
429 efc_sm_transition(ctx, __efc_nport_vport_allocated, NULL);
433 __efc_nport_common(__func__, ctx, evt, arg);
438 __efc_nport_vport_allocated(struct efc_sm_ctx *ctx,
439 enum efc_sm_event evt, void *arg)
441 struct efc_nport *nport = ctx->app;
442 struct efc *efc = nport->efc;
444 nport_sm_trace(nport);
447 * This state is entered after the nport is allocated;
448 * it then waits for a fabric node
449 * FDISC to complete, which requests a nport attach.
450 * The nport attach complete is handled in this state.
453 case EFC_EVT_NPORT_ATTACH_OK: {
454 struct efc_node *node;
456 /* Find our fabric node, and forward this event */
457 node = efc_node_find(nport, FC_FID_FLOGI);
459 efc_log_debug(efc, "can't find node %06x\n", FC_FID_FLOGI);
462 /* sm: / forward nport attach to fabric node */
463 efc_node_post_event(node, evt, NULL);
464 efc_sm_transition(ctx, __efc_nport_attached, NULL);
468 __efc_nport_common(__func__, ctx, evt, arg);
473 efc_vport_update_spec(struct efc_nport *nport)
475 struct efc *efc = nport->efc;
476 struct efc_vport *vport;
477 unsigned long flags = 0;
479 spin_lock_irqsave(&efc->vport_lock, flags);
480 list_for_each_entry(vport, &efc->vport_list, list_entry) {
481 if (vport->nport == nport) {
482 vport->wwnn = nport->wwnn;
483 vport->wwpn = nport->wwpn;
484 vport->tgt_data = nport->tgt_data;
485 vport->ini_data = nport->ini_data;
489 spin_unlock_irqrestore(&efc->vport_lock, flags);
493 __efc_nport_attached(struct efc_sm_ctx *ctx,
494 enum efc_sm_event evt, void *arg)
496 struct efc_nport *nport = ctx->app;
497 struct efc *efc = nport->efc;
499 nport_sm_trace(nport);
502 case EFC_EVT_ENTER: {
503 struct efc_node *node;
507 "[%s] NPORT attached WWPN %016llX WWNN %016llX\n",
509 nport->wwpn, nport->wwnn);
511 xa_for_each(&nport->lookup, index, node)
512 efc_node_update_display_name(node);
514 efc->tt.new_nport(efc, nport);
517 * Update the vport (if its not the physical nport)
521 efc_vport_update_spec(nport);
527 "[%s] NPORT deattached WWPN %016llX WWNN %016llX\n",
529 nport->wwpn, nport->wwnn);
531 efc->tt.del_nport(efc, nport);
534 __efc_nport_common(__func__, ctx, evt, arg);
539 __efc_nport_wait_shutdown(struct efc_sm_ctx *ctx,
540 enum efc_sm_event evt, void *arg)
542 struct efc_nport *nport = ctx->app;
543 struct efc_domain *domain = nport->domain;
544 struct efc *efc = nport->efc;
546 nport_sm_trace(nport);
549 case EFC_EVT_NPORT_ALLOC_OK:
550 case EFC_EVT_NPORT_ALLOC_FAIL:
551 case EFC_EVT_NPORT_ATTACH_OK:
552 case EFC_EVT_NPORT_ATTACH_FAIL:
553 /* ignore these events - just wait for the all free event */
556 case EFC_EVT_ALL_CHILD_NODES_FREE: {
558 * Remove the nport from the domain's
559 * sparse vector lookup table
561 xa_erase(&domain->lookup, nport->fc_id);
562 efc_sm_transition(ctx, __efc_nport_wait_port_free, NULL);
563 if (efc_cmd_nport_free(efc, nport)) {
564 efc_log_err(nport->efc, "efc_hw_port_free failed\n");
565 /* Not much we can do, free the nport anyways */
566 efc_nport_free(nport);
571 __efc_nport_common(__func__, ctx, evt, arg);
576 __efc_nport_wait_port_free(struct efc_sm_ctx *ctx,
577 enum efc_sm_event evt, void *arg)
579 struct efc_nport *nport = ctx->app;
581 nport_sm_trace(nport);
584 case EFC_EVT_NPORT_ATTACH_OK:
585 /* Ignore as we are waiting for the free CB */
587 case EFC_EVT_NPORT_FREE_OK: {
588 /* All done, free myself */
589 efc_nport_free(nport);
593 __efc_nport_common(__func__, ctx, evt, arg);
598 efc_vport_nport_alloc(struct efc_domain *domain, struct efc_vport *vport)
600 struct efc_nport *nport;
602 lockdep_assert_held(&domain->efc->lock);
604 nport = efc_nport_alloc(domain, vport->wwpn, vport->wwnn, vport->fc_id,
605 vport->enable_ini, vport->enable_tgt);
606 vport->nport = nport;
610 kref_get(&nport->ref);
611 nport->is_vport = true;
612 nport->tgt_data = vport->tgt_data;
613 nport->ini_data = vport->ini_data;
615 efc_sm_transition(&nport->sm, __efc_nport_vport_init, NULL);
621 efc_vport_start(struct efc_domain *domain)
623 struct efc *efc = domain->efc;
624 struct efc_vport *vport;
625 struct efc_vport *next;
627 unsigned long flags = 0;
629 /* Use the vport spec to find the associated vports and start them */
630 spin_lock_irqsave(&efc->vport_lock, flags);
631 list_for_each_entry_safe(vport, next, &efc->vport_list, list_entry) {
633 if (efc_vport_nport_alloc(domain, vport))
637 spin_unlock_irqrestore(&efc->vport_lock, flags);
643 efc_nport_vport_new(struct efc_domain *domain, uint64_t wwpn, uint64_t wwnn,
644 u32 fc_id, bool ini, bool tgt, void *tgt_data,
647 struct efc *efc = domain->efc;
648 struct efc_vport *vport;
650 unsigned long flags = 0;
652 if (ini && domain->efc->enable_ini == 0) {
653 efc_log_debug(efc, "driver initiator mode not enabled\n");
657 if (tgt && domain->efc->enable_tgt == 0) {
658 efc_log_debug(efc, "driver target mode not enabled\n");
663 * Create a vport spec if we need to recreate
664 * this vport after a link up event
666 vport = efc_vport_create_spec(domain->efc, wwnn, wwpn, fc_id, ini, tgt,
669 efc_log_err(efc, "failed to create vport object entry\n");
673 spin_lock_irqsave(&efc->lock, flags);
674 rc = efc_vport_nport_alloc(domain, vport);
675 spin_unlock_irqrestore(&efc->lock, flags);
681 efc_nport_vport_del(struct efc *efc, struct efc_domain *domain,
682 u64 wwpn, uint64_t wwnn)
684 struct efc_nport *nport;
685 struct efc_vport *vport;
686 struct efc_vport *next;
687 unsigned long flags = 0;
689 spin_lock_irqsave(&efc->vport_lock, flags);
690 /* walk the efc_vport_list and remove from there */
691 list_for_each_entry_safe(vport, next, &efc->vport_list, list_entry) {
692 if (vport->wwpn == wwpn && vport->wwnn == wwnn) {
693 list_del(&vport->list_entry);
698 spin_unlock_irqrestore(&efc->vport_lock, flags);
701 /* No domain means no nport to look for */
705 spin_lock_irqsave(&efc->lock, flags);
706 list_for_each_entry(nport, &domain->nport_list, list_entry) {
707 if (nport->wwpn == wwpn && nport->wwnn == wwnn) {
708 kref_put(&nport->ref, nport->release);
709 /* Shutdown this NPORT */
710 efc_sm_post_event(&nport->sm, EFC_EVT_SHUTDOWN, NULL);
715 spin_unlock_irqrestore(&efc->lock, flags);
720 efc_vport_del_all(struct efc *efc)
722 struct efc_vport *vport;
723 struct efc_vport *next;
724 unsigned long flags = 0;
726 spin_lock_irqsave(&efc->vport_lock, flags);
727 list_for_each_entry_safe(vport, next, &efc->vport_list, list_entry) {
728 list_del(&vport->list_entry);
731 spin_unlock_irqrestore(&efc->vport_lock, flags);
735 efc_vport_create_spec(struct efc *efc, uint64_t wwnn, uint64_t wwpn,
736 u32 fc_id, bool enable_ini,
737 bool enable_tgt, void *tgt_data, void *ini_data)
739 struct efc_vport *vport;
740 unsigned long flags = 0;
743 * walk the efc_vport_list and return failure
744 * if a valid(vport with non zero WWPN and WWNN) vport entry
747 spin_lock_irqsave(&efc->vport_lock, flags);
748 list_for_each_entry(vport, &efc->vport_list, list_entry) {
749 if ((wwpn && vport->wwpn == wwpn) &&
750 (wwnn && vport->wwnn == wwnn)) {
752 "VPORT %016llX %016llX already allocated\n",
754 spin_unlock_irqrestore(&efc->vport_lock, flags);
759 vport = kzalloc(sizeof(*vport), GFP_ATOMIC);
761 spin_unlock_irqrestore(&efc->vport_lock, flags);
767 vport->fc_id = fc_id;
768 vport->enable_tgt = enable_tgt;
769 vport->enable_ini = enable_ini;
770 vport->tgt_data = tgt_data;
771 vport->ini_data = ini_data;
773 INIT_LIST_HEAD(&vport->list_entry);
774 list_add_tail(&vport->list_entry, &efc->vport_list);
775 spin_unlock_irqrestore(&efc->vport_lock, flags);