1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (C) 2021 Broadcom. All Rights Reserved. The term 4 * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 5 */ 6 7 #ifndef __EFCLIB_H__ 8 #define __EFCLIB_H__ 9 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" 17 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 22 23 #define EFC_WWN_LENGTH 32 24 25 #define EFC_FC_ELS_DEFAULT_RETRIES 3 26 27 /* Timeouts */ 28 #define EFC_FC_ELS_SEND_DEFAULT_TIMEOUT 0 29 #define EFC_FC_FLOGI_TIMEOUT_SEC 5 30 #define EFC_SHUTDOWN_TIMEOUT_USEC 30000000 31 32 /* Return values for calls from base driver to libefc */ 33 #define EFC_SCSI_CALL_COMPLETE 0 34 #define EFC_SCSI_CALL_ASYNC 1 35 36 /* Local port topology */ 37 enum efc_nport_topology { 38 EFC_NPORT_TOPO_UNKNOWN = 0, 39 EFC_NPORT_TOPO_FABRIC, 40 EFC_NPORT_TOPO_P2P, 41 EFC_NPORT_TOPO_FC_AL, 42 }; 43 44 #define enable_target_rscn(efc) 1 45 46 enum efc_node_shutd_rsn { 47 EFC_NODE_SHUTDOWN_DEFAULT = 0, 48 EFC_NODE_SHUTDOWN_EXPLICIT_LOGO, 49 EFC_NODE_SHUTDOWN_IMPLICIT_LOGO, 50 }; 51 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, 56 }; 57 58 #define EFC_LINK_STATUS_UP 0 59 #define EFC_LINK_STATUS_DOWN 1 60 61 /* State machine context header */ 62 struct efc_sm_ctx { 63 void (*current_state)(struct efc_sm_ctx *ctx, 64 u32 evt, void *arg); 65 66 const char *description; 67 void *app; 68 }; 69 70 /* Description of discovered Fabric Domain */ 71 struct efc_domain_record { 72 u32 index; 73 u32 priority; 74 u8 address[6]; 75 u8 wwn[8]; 76 union { 77 u8 vlan[512]; 78 u8 loop[128]; 79 } map; 80 u32 speed; 81 u32 fc_id; 82 bool is_loop; 83 bool is_nport; 84 }; 85 86 /* Domain events */ 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, 94 EFC_HW_DOMAIN_LOST, 95 EFC_HW_DOMAIN_FOUND, 96 EFC_HW_DOMAIN_CHANGED, 97 }; 98 99 /** 100 * Fibre Channel port object 101 * 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 113 * @wwpn: port wwpn 114 * @wwnn: port wwnn 115 * @tgt_data: target backend private port data 116 * @ini_data: initiator backend private port data 117 * @indicator: VPI 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 133 */ 134 135 struct efc_nport { 136 struct list_head list_entry; 137 struct kref ref; 138 void (*release)(struct kref *arg); 139 struct efc *efc; 140 u32 instance_index; 141 char display_name[EFC_NAME_LENGTH]; 142 bool is_vport; 143 bool free_req_pending; 144 bool attached; 145 bool p2p_winner; 146 struct efc_domain *domain; 147 u64 wwpn; 148 u64 wwnn; 149 void *tgt_data; 150 void *ini_data; 151 152 u32 indicator; 153 u32 fc_id; 154 struct efc_dma dma; 155 156 u8 wwnn_str[EFC_WWN_LENGTH]; 157 __be64 sli_wwpn; 158 __be64 sli_wwnn; 159 160 struct efc_sm_ctx sm; 161 struct xarray lookup; 162 bool enable_ini; 163 bool enable_tgt; 164 bool enable_rscn; 165 bool shutting_down; 166 u32 p2p_port_id; 167 enum efc_nport_topology topology; 168 u8 service_params[EFC_SERVICE_PARMS_LENGTH]; 169 u32 p2p_remote_port_id; 170 }; 171 172 /** 173 * Fibre Channel domain object 174 * 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 188 * @indicator: VFI 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 194 * @is_fc: is FC 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 206 */ 207 struct efc_domain { 208 struct efc *efc; 209 char display_name[EFC_NAME_LENGTH]; 210 struct list_head nport_list; 211 struct kref ref; 212 void (*release)(struct kref *arg); 213 void *ini_domain; 214 void *tgt_domain; 215 216 /* Declarations private to HW/SLI */ 217 u32 fcf; 218 u32 fcf_indicator; 219 u32 indicator; 220 u32 nport_count; 221 struct efc_dma dma; 222 223 /* Declarations private to FC trannport */ 224 u64 fcf_wwn; 225 struct efc_sm_ctx drvsm; 226 bool attached; 227 bool is_fc; 228 bool is_loop; 229 bool is_nlport; 230 bool domain_found_pending; 231 bool req_domain_free; 232 bool req_accept_frames; 233 bool domain_notify_pend; 234 235 struct efc_domain_record pending_drec; 236 u8 service_params[EFC_SERVICE_PARMS_LENGTH]; 237 u8 flogi_service_params[EFC_SERVICE_PARMS_LENGTH]; 238 239 struct xarray lookup; 240 241 struct efc_nport *nport; 242 }; 243 244 /** 245 * Remote Node object 246 * 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. 250 * @indicator: RPI 251 * @fc_id: FC address 252 * @attached: true if attached 253 * @nport: associated SLI port 254 * @node: associated node 255 */ 256 struct efc_remote_node { 257 u32 indicator; 258 u32 index; 259 u32 fc_id; 260 261 bool attached; 262 263 struct efc_nport *nport; 264 void *node; 265 }; 266 267 /** 268 * FC Node object 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 316 */ 317 struct efc_node { 318 struct efc *efc; 319 char display_name[EFC_NAME_LENGTH]; 320 struct efc_nport *nport; 321 struct kref ref; 322 void (*release)(struct kref *arg); 323 bool hold_frames; 324 bool els_io_enabled; 325 bool send_plogi_acc; 326 bool send_plogi; 327 bool rscn_pending; 328 bool fcp_enabled; 329 bool attached; 330 bool req_free; 331 332 spinlock_t els_ios_lock; 333 struct list_head els_ios_list; 334 void *ini_node; 335 void *tgt_node; 336 337 struct efc_remote_node rnode; 338 /* Declarations private to FC trannport */ 339 struct efc_sm_ctx sm; 340 u32 evtdepth; 341 342 enum efc_node_send_ls_acc send_ls_acc; 343 void *ls_acc_io; 344 u32 ls_acc_oxid; 345 u32 ls_acc_did; 346 enum efc_node_shutd_rsn shutdown_reason; 347 bool targ; 348 bool init; 349 bool refound; 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; 355 u32 ox_id_in_use; 356 u32 els_retries_remaining; 357 u32 els_req_cnt; 358 u32 els_cmpl_cnt; 359 u32 abort_cnt; 360 361 char current_state_name[EFC_SM_NAME_LENGTH]; 362 char prev_state_name[EFC_SM_NAME_LENGTH]; 363 int current_evt; 364 int prev_evt; 365 366 void (*nodedb_state)(struct efc_sm_ctx *ctx, 367 u32 evt, void *arg); 368 struct timer_list gidpt_delay_timer; 369 u64 time_last_gidpt_msec; 370 371 char wwnn[EFC_WWN_LENGTH]; 372 char wwpn[EFC_WWN_LENGTH]; 373 }; 374 375 /** 376 * NPIV port 377 * 378 * Collection of the information required to restore a virtual port across 379 * link events 380 * @wwnn: node name 381 * @wwpn: port name 382 * @fc_id: port id 383 * @tgt_data: target backend pointer 384 * @ini_data: initiator backend pointe 385 * @nport: Used to match record after attaching for update 386 * 387 */ 388 389 struct efc_vport { 390 struct list_head list_entry; 391 u64 wwnn; 392 u64 wwpn; 393 u32 fc_id; 394 bool enable_tgt; 395 bool enable_ini; 396 void *tgt_data; 397 void *ini_data; 398 struct efc_nport *nport; 399 }; 400 401 #define node_printf(node, fmt, args...) \ 402 efc_log_info(node->efc, "[%s] " fmt, node->display_name, ##args) 403 404 /* Node SM IO Context Callback structure */ 405 struct efc_node_cb { 406 int status; 407 int ext_status; 408 struct efc_hw_rq_buffer *header; 409 struct efc_hw_rq_buffer *payload; 410 struct efc_dma els_rsp; 411 412 /* Actual length of data received */ 413 int rsp_len; 414 }; 415 416 struct efc_hw_rq_buffer { 417 u16 rqindex; 418 struct efc_dma dma; 419 }; 420 421 /** 422 * FC sequence object 423 * 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 430 */ 431 struct efc_hw_sequence { 432 struct list_head list_entry; 433 void *hw; 434 u8 fcfi; 435 struct efc_hw_rq_buffer *header; 436 struct efc_hw_rq_buffer *payload; 437 void *hw_priv; 438 }; 439 440 enum efc_disc_io_type { 441 EFC_DISC_IO_ELS_REQ, 442 EFC_DISC_IO_ELS_RESP, 443 EFC_DISC_IO_CT_REQ, 444 EFC_DISC_IO_CT_RESP 445 }; 446 447 struct efc_io_els_params { 448 u32 s_id; 449 u16 ox_id; 450 u8 timeout; 451 }; 452 453 struct efc_io_ct_params { 454 u8 r_ctl; 455 u8 type; 456 u8 df_ctl; 457 u8 timeout; 458 u16 ox_id; 459 }; 460 461 union efc_disc_io_param { 462 struct efc_io_els_params els; 463 struct efc_io_ct_params ct; 464 }; 465 466 struct efc_disc_io { 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 */ 474 u32 s_id; 475 u32 d_id; 476 bool rpi_registered; /* if false, use tmp RPI */ 477 union efc_disc_io_param iparam; 478 }; 479 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 484 485 struct libefc_function_template { 486 /*Sport*/ 487 int (*new_nport)(struct efc *efc, struct efc_nport *sp); 488 void (*del_nport)(struct efc *efc, struct efc_nport *sp); 489 490 /*Scsi Node*/ 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); 493 494 int (*issue_mbox_rqst)(void *efct, void *buf, void *cb, void *arg); 495 /*Send ELS IO*/ 496 int (*send_els)(struct efc *efc, struct efc_disc_io *io); 497 /*Send BLS IO*/ 498 int (*send_bls)(struct efc *efc, u32 type, struct sli_bls_params *bls); 499 /*Free HW frame*/ 500 int (*hw_seq_free)(struct efc *efc, struct efc_hw_sequence *seq); 501 }; 502 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 510 511 /* efc library port structure */ 512 struct efc { 513 void *base; 514 struct pci_dev *pci; 515 struct sli4 *sli; 516 u32 fcfi; 517 u64 req_wwpn; 518 u64 req_wwnn; 519 520 u64 def_wwpn; 521 u64 def_wwnn; 522 u64 max_xfer_size; 523 mempool_t *node_pool; 524 struct dma_pool *node_dma_pool; 525 u32 nodes_count; 526 527 u32 link_status; 528 529 struct list_head vport_list; 530 /* lock to protect the vport list */ 531 spinlock_t vport_lock; 532 533 struct libefc_function_template tt; 534 /* lock to protect the discovery library. 535 * Refer to efclib.c for more details. 536 */ 537 spinlock_t lock; 538 539 bool enable_ini; 540 bool enable_tgt; 541 542 u32 log_level; 543 544 struct efc_domain *domain; 545 void (*domain_free_cb)(struct efc *efc, void *arg); 546 void *domain_free_cb_arg; 547 548 u64 tgt_rscn_delay_msec; 549 u64 tgt_rscn_period_msec; 550 551 bool external_loopback; 552 u32 nodedb_mask; 553 u32 logmask; 554 mempool_t *els_io_pool; 555 atomic_t els_io_alloc_failed_count; 556 557 /* hold pending frames */ 558 bool hold_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; 564 565 }; 566 567 /* 568 * EFC library registration 569 * **********************************/ 570 int efcport_init(struct efc *efc); 571 void efcport_destroy(struct efc *efc); 572 /* 573 * EFC Domain 574 * **********************************/ 575 int efc_domain_cb(void *arg, int event, void *data); 576 void 577 efc_register_domain_free_cb(struct efc *efc, 578 void (*callback)(struct efc *efc, void *arg), 579 void *arg); 580 581 /* 582 * EFC nport 583 * **********************************/ 584 void efc_nport_cb(void *arg, int event, void *data); 585 struct efc_vport * 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, 593 u64 wwpn, u64 wwnn); 594 595 void efc_vport_del_all(struct efc *efc); 596 597 /* 598 * EFC Node 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); 604 605 /* 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, 610 u32 ext_status); 611 612 /* 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); 619 620 #endif /* __EFCLIB_H__ */ 621