include/scsi/libfc.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
5  * Maintained at www.Open-FCoE.org
43  * enum fc_lport_state - Local port states
44  * @LPORT_ST_DISABLED: Disabled
49  * @LPORT_ST_RFF_ID:   Register FC-4 Features by ID (RFF_ID) sent
84  * enum fc_rport_state - Remote port states
86  * @RPORT_ST_FLOGI:   Waiting for FLOGI completion for point-to-multipoint
87  * @RPORT_ST_PLOGI_WAIT:   Waiting for peer to login for point-to-multipoint
108  * struct fc_disc_port - temporary discovery port to hold rport identifiers
122  * enum fc_rport_event - Remote port events
140  * struct fc_rport_operations - Operations for a remote port
149  * struct fc_rport_libfc_priv - libfc internal information about a remote port
169  * struct fc_rport_priv - libfc remote port and discovery info
188  * @rcu:	    Structure used for freeing in an RCU-safe manner
221  * struct fc_stats - fc stats structure
269  * struct fc_seq_els_data - ELS data used for passing ELS specific responses
281  * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
377  * struct fc_seq - FC sequence
381  * @rec_data: FC-4 value for REC
395  * struct fc_exch - Fibre Channel Exchange
413  * @encaps:       encapsulation information for lower-level driver
420  *                task that has been interrupted to execute the soft-IRQ
463 #define	fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)  argument
517 	 * If s_id is non-zero, reset only exchanges originating from that FID.
518 	 * If d_id is non-zero, reset only exchanges sending to that FID.
528 	 * notified when the local port is assigned a FC-ID.
530 	 * The frame, if non-NULL, is the incoming frame with the
535 	 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
555 	 * Called with the SCSI host lock unlocked and irqs disabled.
614  * struct fc_disc - Discovery context
621  * @rports:        List of discovered remote ports
657  * struct fc_lport - Local port
694  * @fcts:                  FC-4 type mask
698  * @prov:		   Pointers available for use by passive FC-4 providers
699  * @lport_list:            Linkage on module-wide list of local ports
763  * struct fc4_prov - FC-4 provider registration
779  * Register FC-4 provider with libfc.
789  * fc_lport_test_ready() - Determine if a local port is in the READY state
794 	return lport->state == LPORT_ST_READY;  in fc_lport_test_ready()
798  * fc_set_wwnn() - Set the World Wide Node Name of a local port
804 	lport->wwnn = wwnn;  in fc_set_wwnn()
808  * fc_set_wwpn() - Set the World Wide Port Name of a local port
814 	lport->wwpn = wwpn;  in fc_set_wwpn()
818  * fc_lport_state_enter() - Change a local port's state
825 	if (state != lport->state)  in fc_lport_state_enter()
826 		lport->retry_count = 0;  in fc_lport_state_enter()
827 	lport->state = state;  in fc_lport_state_enter()
831  * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
836 	lport->stats = alloc_percpu(struct fc_stats);  in fc_lport_init_stats()
837 	if (!lport->stats)  in fc_lport_init_stats()
838 		return -ENOMEM;  in fc_lport_init_stats()
843  * fc_lport_free_stats() - Free memory for a local port's statistics
848 	free_percpu(lport->stats);  in fc_lport_free_stats()
852  * lport_priv() - Return the private data from a local port
861  * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
878 	lport->host = shost;  in libfc_host_alloc()
879 	INIT_LIST_HEAD(&lport->ema_list);  in libfc_host_alloc()
880 	INIT_LIST_HEAD(&lport->vports);  in libfc_host_alloc()
889 	if (fsp && fsp->cmd)  in fc_fcp_is_read()
890 		return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;  in fc_fcp_is_read()
989 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
990 void fc_seq_set_resp(struct fc_seq *sp,
994 void fc_seq_release(struct fc_seq *sp);
1006 int fc_seq_send(struct fc_lport *lport, struct fc_seq *sp, struct fc_frame *fp);
1008 void fc_exch_done(struct fc_seq *sp);