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 #include "scsi/fc/fc_els.h"
11 #include "scsi/fc/fc_fs.h"
12 #include "scsi/fc/fc_ns.h"
13 #include "scsi/fc/fc_gs.h"
14 #include "scsi/fc_frame.h"
15 #include "../include/efc_common.h"
16 #include "../libefc_sli/sli4.h"
18 #define EFC_SERVICE_PARMS_LENGTH 120
19 #define EFC_NAME_LENGTH 32
20 #define EFC_SM_NAME_LENGTH 64
21 #define EFC_DISPLAY_BUS_INFO_LENGTH 16
23 #define EFC_WWN_LENGTH 32
25 #define EFC_FC_ELS_DEFAULT_RETRIES 3
28 #define EFC_FC_ELS_SEND_DEFAULT_TIMEOUT 0
29 #define EFC_FC_FLOGI_TIMEOUT_SEC 5
30 #define EFC_SHUTDOWN_TIMEOUT_USEC 30000000
32 /* Return values for calls from base driver to libefc */
33 #define EFC_SCSI_CALL_COMPLETE 0
34 #define EFC_SCSI_CALL_ASYNC 1
36 /* Local port topology */
37 enum efc_nport_topology {
38 EFC_NPORT_TOPO_UNKNOWN = 0,
39 EFC_NPORT_TOPO_FABRIC,
44 #define enable_target_rscn(efc) 1
46 enum efc_node_shutd_rsn {
47 EFC_NODE_SHUTDOWN_DEFAULT = 0,
48 EFC_NODE_SHUTDOWN_EXPLICIT_LOGO,
49 EFC_NODE_SHUTDOWN_IMPLICIT_LOGO,
52 enum efc_node_send_ls_acc {
53 EFC_NODE_SEND_LS_ACC_NONE = 0,
54 EFC_NODE_SEND_LS_ACC_PLOGI,
55 EFC_NODE_SEND_LS_ACC_PRLI,
58 #define EFC_LINK_STATUS_UP 0
59 #define EFC_LINK_STATUS_DOWN 1
61 /* State machine context header */
63 void (*current_state)(struct efc_sm_ctx *ctx,
66 const char *description;
70 /* Description of discovered Fabric Domain */
71 struct efc_domain_record {
87 enum efc_hw_domain_event {
88 EFC_HW_DOMAIN_ALLOC_OK,
89 EFC_HW_DOMAIN_ALLOC_FAIL,
90 EFC_HW_DOMAIN_ATTACH_OK,
91 EFC_HW_DOMAIN_ATTACH_FAIL,
92 EFC_HW_DOMAIN_FREE_OK,
93 EFC_HW_DOMAIN_FREE_FAIL,
96 EFC_HW_DOMAIN_CHANGED,
100 * Fibre Channel port object
102 * @list_entry: nport list entry
103 * @ref: reference count, each node takes a reference
104 * @release: function to free nport object
105 * @efc: pointer back to efc
106 * @instance_index: unique instance index value
107 * @display_name: port display name
108 * @is_vport: Is NPIV port
109 * @free_req_pending: pending request to free resources
110 * @attached: mark attached if reg VPI succeeds
111 * @p2p_winner: TRUE if we're the point-to-point winner
112 * @domain: pointer back to domain
115 * @tgt_data: target backend private port data
116 * @ini_data: initiator backend private port data
118 * @fc_id: port FC address
119 * @dma: memory for Service Parameters
120 * @wwnn_str: wwpn string
121 * @sli_wwpn: SLI provided wwpn
122 * @sli_wwnn: SLI provided wwnn
123 * @sm: nport state machine context
124 * @lookup: fc_id to node lookup object
125 * @enable_ini: SCSI initiator enabled for this port
126 * @enable_tgt: SCSI target enabled for this port
127 * @enable_rscn: port will be expecting RSCN
128 * @shutting_down: nport in process of shutting down
129 * @p2p_port_id: our port id for point-to-point
130 * @topology: topology: fabric/p2p/unknown
131 * @service_params: login parameters
132 * @p2p_remote_port_id: remote node's port id for point-to-point
136 struct list_head list_entry;
138 void (*release)(struct kref *arg);
141 char display_name[EFC_NAME_LENGTH];
143 bool free_req_pending;
146 struct efc_domain *domain;
156 u8 wwnn_str[EFC_WWN_LENGTH];
160 struct efc_sm_ctx sm;
161 struct xarray lookup;
167 enum efc_nport_topology topology;
168 u8 service_params[EFC_SERVICE_PARMS_LENGTH];
169 u32 p2p_remote_port_id;
173 * Fibre Channel domain object
175 * This object is a container for the various SLI components needed
176 * to connect to the domain of a FC or FCoE switch
177 * @efc: pointer back to efc
178 * @instance_index: unique instance index value
179 * @display_name: Node display name
180 * @nport_list: linked list of nports associated with this domain
181 * @ref: Reference count, each nport takes a reference
182 * @release: Function to free domain object
183 * @ini_domain: initiator backend private domain data
184 * @tgt_domain: target backend private domain data
185 * @sm: state machine context
186 * @fcf: FC Forwarder table index
187 * @fcf_indicator: FCFI
189 * @nport_count: Number of nports allocated
190 * @dma: memory for Service Parameters
191 * @fcf_wwn: WWN for FCF/switch
192 * @drvsm: driver domain sm context
193 * @attached: set true after attach completes
195 * @is_loop: is loop topology
196 * @is_nlport: is public loop
197 * @domain_found_pending:A domain found is pending, drec is updated
198 * @req_domain_free: True if domain object should be free'd
199 * @req_accept_frames: set in domain state machine to enable frames
200 * @domain_notify_pend: Set in domain SM to avoid duplicate node event post
201 * @pending_drec: Pending drec if a domain found is pending
202 * @service_params: any nports service parameters
203 * @flogi_service_params:Fabric/P2p service parameters from FLOGI
204 * @lookup: d_id to node lookup object
205 * @nport: Pointer to first (physical) SLI port
209 char display_name[EFC_NAME_LENGTH];
210 struct list_head nport_list;
212 void (*release)(struct kref *arg);
216 /* Declarations private to HW/SLI */
223 /* Declarations private to FC trannport */
225 struct efc_sm_ctx drvsm;
230 bool domain_found_pending;
231 bool req_domain_free;
232 bool req_accept_frames;
233 bool domain_notify_pend;
235 struct efc_domain_record pending_drec;
236 u8 service_params[EFC_SERVICE_PARMS_LENGTH];
237 u8 flogi_service_params[EFC_SERVICE_PARMS_LENGTH];
239 struct xarray lookup;
241 struct efc_nport *nport;
247 * This object represents a connection between the SLI port and another
248 * Nx_Port on the fabric. Note this can be either a well known port such
249 * as a F_Port (i.e. ff:ff:fe) or another N_Port.
252 * @attached: true if attached
253 * @nport: associated SLI port
254 * @node: associated node
256 struct efc_remote_node {
263 struct efc_nport *nport;
269 * @efc: pointer back to efc structure
270 * @display_name: Node display name
271 * @nort: Assosiated nport pointer.
272 * @hold_frames: hold incoming frames if true
273 * @els_io_enabled: Enable allocating els ios for this node
274 * @els_ios_lock: lock to protect the els ios list
275 * @els_ios_list: ELS I/O's for this node
276 * @ini_node: backend initiator private node data
277 * @tgt_node: backend target private node data
278 * @rnode: Remote node
279 * @sm: state machine context
280 * @evtdepth: current event posting nesting depth
281 * @req_free: this node is to be free'd
282 * @attached: node is attached (REGLOGIN complete)
283 * @fcp_enabled: node is enabled to handle FCP
284 * @rscn_pending: for name server node RSCN is pending
285 * @send_plogi: send PLOGI accept, upon completion of node attach
286 * @send_plogi_acc: TRUE if io_alloc() is enabled.
287 * @send_ls_acc: type of LS acc to send
288 * @ls_acc_io: SCSI IO for LS acc
289 * @ls_acc_oxid: OX_ID for pending accept
290 * @ls_acc_did: D_ID for pending accept
291 * @shutdown_reason: reason for node shutdown
292 * @sparm_dma_buf: service parameters buffer
293 * @service_params: plogi/acc frame from remote device
294 * @pend_frames_lock: lock for inbound pending frames list
295 * @pend_frames: inbound pending frames list
296 * @pend_frames_processed:count of frames processed in hold frames interval
297 * @ox_id_in_use: used to verify one at a time us of ox_id
298 * @els_retries_remaining:for ELS, number of retries remaining
299 * @els_req_cnt: number of outstanding ELS requests
300 * @els_cmpl_cnt: number of outstanding ELS completions
301 * @abort_cnt: Abort counter for debugging purpos
302 * @current_state_name: current node state
303 * @prev_state_name: previous node state
304 * @current_evt: current event
305 * @prev_evt: previous event
306 * @targ: node is target capable
307 * @init: node is init capable
308 * @refound: Handle node refound case when node is being deleted
309 * @els_io_pend_list: list of pending (not yet processed) ELS IOs
310 * @els_io_active_list: list of active (processed) ELS IOs
311 * @nodedb_state: Node debugging, saved state
312 * @gidpt_delay_timer: GIDPT delay timer
313 * @time_last_gidpt_msec:Start time of last target RSCN GIDPT
314 * @wwnn: remote port WWNN
315 * @wwpn: remote port WWPN
319 char display_name[EFC_NAME_LENGTH];
320 struct efc_nport *nport;
322 void (*release)(struct kref *arg);
332 spinlock_t els_ios_lock;
333 struct list_head els_ios_list;
337 struct efc_remote_node rnode;
338 /* Declarations private to FC trannport */
339 struct efc_sm_ctx sm;
342 enum efc_node_send_ls_acc send_ls_acc;
346 enum efc_node_shutd_rsn shutdown_reason;
350 struct efc_dma sparm_dma_buf;
351 u8 service_params[EFC_SERVICE_PARMS_LENGTH];
352 spinlock_t pend_frames_lock;
353 struct list_head pend_frames;
354 u32 pend_frames_processed;
356 u32 els_retries_remaining;
361 char current_state_name[EFC_SM_NAME_LENGTH];
362 char prev_state_name[EFC_SM_NAME_LENGTH];
366 void (*nodedb_state)(struct efc_sm_ctx *ctx,
368 struct timer_list gidpt_delay_timer;
369 u64 time_last_gidpt_msec;
371 char wwnn[EFC_WWN_LENGTH];
372 char wwpn[EFC_WWN_LENGTH];
378 * Collection of the information required to restore a virtual port across
383 * @tgt_data: target backend pointer
384 * @ini_data: initiator backend pointe
385 * @nport: Used to match record after attaching for update
390 struct list_head list_entry;
398 struct efc_nport *nport;
401 #define node_printf(node, fmt, args...) \
402 efc_log_info(node->efc, "[%s] " fmt, node->display_name, ##args)
404 /* Node SM IO Context Callback structure */
408 struct efc_hw_rq_buffer *header;
409 struct efc_hw_rq_buffer *payload;
410 struct efc_dma els_rsp;
412 /* Actual length of data received */
416 struct efc_hw_rq_buffer {
424 * Defines a general FC sequence object
425 * @hw: HW that owns this sequence
426 * @fcfi: FCFI associated with sequence
427 * @header: Received frame header
428 * @payload: Received frame header
429 * @hw_priv: HW private context
431 struct efc_hw_sequence {
432 struct list_head list_entry;
435 struct efc_hw_rq_buffer *header;
436 struct efc_hw_rq_buffer *payload;
440 enum efc_disc_io_type {
442 EFC_DISC_IO_ELS_RESP,
447 struct efc_io_els_params {
453 struct efc_io_ct_params {
461 union efc_disc_io_param {
462 struct efc_io_els_params els;
463 struct efc_io_ct_params ct;
467 struct efc_dma req; /* send buffer */
468 struct efc_dma rsp; /* receive buffer */
469 enum efc_disc_io_type io_type; /* EFC_DISC_IO_TYPE enum*/
470 u16 xmit_len; /* Length of els request*/
471 u16 rsp_len; /* Max length of rsps to be rcvd */
472 u32 rpi; /* Registered RPI */
473 u32 vpi; /* VPI for this nport */
476 bool rpi_registered; /* if false, use tmp RPI */
477 union efc_disc_io_param iparam;
480 /* Return value indiacating the sequence can not be freed */
481 #define EFC_HW_SEQ_HOLD 0
482 /* Return value indiacating the sequence can be freed */
483 #define EFC_HW_SEQ_FREE 1
485 struct libefc_function_template {
487 int (*new_nport)(struct efc *efc, struct efc_nport *sp);
488 void (*del_nport)(struct efc *efc, struct efc_nport *sp);
491 int (*scsi_new_node)(struct efc *efc, struct efc_node *n);
492 int (*scsi_del_node)(struct efc *efc, struct efc_node *n, int reason);
494 int (*issue_mbox_rqst)(void *efct, void *buf, void *cb, void *arg);
496 int (*send_els)(struct efc *efc, struct efc_disc_io *io);
498 int (*send_bls)(struct efc *efc, u32 type, struct sli_bls_params *bls);
500 int (*hw_seq_free)(struct efc *efc, struct efc_hw_sequence *seq);
503 #define EFC_LOG_LIB 0x01
504 #define EFC_LOG_NODE 0x02
505 #define EFC_LOG_PORT 0x04
506 #define EFC_LOG_DOMAIN 0x08
507 #define EFC_LOG_ELS 0x10
508 #define EFC_LOG_DOMAIN_SM 0x20
509 #define EFC_LOG_SM 0x40
511 /* efc library port structure */
523 mempool_t *node_pool;
524 struct dma_pool *node_dma_pool;
529 struct list_head vport_list;
530 /* lock to protect the vport list */
531 spinlock_t vport_lock;
533 struct libefc_function_template tt;
534 /* lock to protect the discovery library.
535 * Refer to efclib.c for more details.
544 struct efc_domain *domain;
545 void (*domain_free_cb)(struct efc *efc, void *arg);
546 void *domain_free_cb_arg;
548 u64 tgt_rscn_delay_msec;
549 u64 tgt_rscn_period_msec;
551 bool external_loopback;
554 mempool_t *els_io_pool;
555 atomic_t els_io_alloc_failed_count;
557 /* hold pending frames */
559 /* lock to protect pending frames list access */
560 spinlock_t pend_frames_lock;
561 struct list_head pend_frames;
562 /* count of pending frames that were processed */
563 u32 pend_frames_processed;
568 * EFC library registration
569 * **********************************/
570 int efcport_init(struct efc *efc);
571 void efcport_destroy(struct efc *efc);
574 * **********************************/
575 int efc_domain_cb(void *arg, int event, void *data);
577 efc_register_domain_free_cb(struct efc *efc,
578 void (*callback)(struct efc *efc, void *arg),
583 * **********************************/
584 void efc_nport_cb(void *arg, int event, void *data);
586 efc_vport_create_spec(struct efc *efc, u64 wwnn, u64 wwpn, u32 fc_id,
587 bool enable_ini, bool enable_tgt,
588 void *tgt_data, void *ini_data);
589 int efc_nport_vport_new(struct efc_domain *domain, u64 wwpn,
590 u64 wwnn, u32 fc_id, bool ini, bool tgt,
591 void *tgt_data, void *ini_data);
592 int efc_nport_vport_del(struct efc *efc, struct efc_domain *domain,
595 void efc_vport_del_all(struct efc *efc);
599 * **********************************/
600 int efc_remote_node_cb(void *arg, int event, void *data);
601 void efc_node_fcid_display(u32 fc_id, char *buffer, u32 buf_len);
602 void efc_node_post_shutdown(struct efc_node *node, void *arg);
603 u64 efc_node_get_wwpn(struct efc_node *node);
606 * EFC FCP/ELS/CT interface
607 * **********************************/
608 void efc_dispatch_frame(struct efc *efc, struct efc_hw_sequence *seq);
609 void efc_disc_io_complete(struct efc_disc_io *io, u32 len, u32 status,
613 * EFC SCSI INTERACTION LAYER
614 * **********************************/
615 void efc_scsi_sess_reg_complete(struct efc_node *node, u32 status);
616 void efc_scsi_del_initiator_complete(struct efc *efc, struct efc_node *node);
617 void efc_scsi_del_target_complete(struct efc *efc, struct efc_node *node);
618 void efc_scsi_io_list_empty(struct efc *efc, struct efc_node *node);
620 #endif /* __EFCLIB_H__ */