include/linux/nvme-fc-driver.h

14  * **********************  FC-NVME LS API ********************
16  *  Data structures used by both FC-NVME hosts and FC-NVME
17  *  targets to perform FC-NVME LS requests or transmit
25  *            to the LLDD to perform a NVME-FC LS request and obtain
27  *            Used by nvme-fc transport (host) to send LS's such as
30  *            Used by the nvmet-fc transport (controller) to send
71  *            to request the transmit the NVME-FC LS response to a
72  *            NVME-FC LS request.   The structure originates in the LLDD
75  *            FC exchange context for the NVME-FC LS request that was
77  *            Used by the LLDD to pass the nvmet-fc transport (controller)
80  *            Used by the LLDD to pass the nvme-fc transport (host)
85  * from the FC link. The address of the structure is passed to the nvmet-fc
86  * or nvme-fc layer via the xxx_rcv_ls_req() transport routines.
91  * the remote N_Port that sent the LS as well as any FC exchange context.
132  * **********************  LLDD FC-NVME Host API ********************
134  *  For FC LLDD's that are the NVME Host role.
141  * struct nvme_fc_port_info - port-specific ids and FC connection-specific
146  * @node_name: FC WWNN for the port
147  * @port_name: FC WWPN for the port
153  * @port_id:      FC N_Port_ID currently assigned the port. Upper 8 bits must
172  * struct nvmefc_fcp_req - Request structure passed from NVME-FC transport
175  * Values set by the NVME-FC layer prior to calling the LLDD fcp_io
206  *             status of the FCP operation at the NVME-FC level.
253  * struct nvme_fc_local_port - structure used between NVME-FC transport and
260  * @port_num:  NVME-FC transport host port number
262  * @node_name: FC WWNN for the port
263  * @port_name: FC WWPN for the port
276  * @port_id:      FC N_Port_ID currently assigned the port. Upper 8 bits must
296  * struct nvme_fc_remote_port - structure used between NVME-FC transport and
303  * @port_num:  NVME-FC transport remote subsystem port number
305  * @node_name: FC WWNN for the port
306  * @port_name: FC WWPN for the port
307  * @localport: pointer to the NVME-FC local host port the subsystem is
318  * @port_id:      FC N_Port_ID currently assigned the port. Upper 8 bits must
343  *                 NVME-FC transport remembers template reference and may
384  * @ls_req:  Called to issue a FC-NVME FC-4 LS service request.
392  * @fcp_io:  called to issue a FC-NVME I/O request.  The I/O may be for
394  *       fully describe the io: the buffer containing the FC-NVME CMD IU
396  *       and the buffer to place the FC-NVME RSP IU into.  The LLDD will
406  *       indicating an FC transport Aborted status.
412  *       indicating an FC transport Aborted status.
415  * @xmt_ls_rsp:  Called to transmit the response to a FC-NVME FC-4 LS service.
448  *       memory that it would like fc nvme layer to allocate on the LLDD's
455  *       memory that it would like fc nvme layer to allocate on the LLDD's
462  *       memory that it would like fc nvme layer to allocate on the LLDD's
469  *       memory that it would like fc nvme layer to allocate on the LLDD's
540  * Routine called to pass a NVME-FC LS request, received by the lldd,
541  * to the nvme-fc transport.
573  * @req: IO request from nvme fc to driver
578  * ***************  LLDD FC-NVME Target/Subsystem API ***************
580  *  For FC LLDD's that are the NVME Subsystem role
586  * struct nvmet_fc_port_info - port-specific ids and FC connection-specific
591  * @node_name: FC WWNN for the port
592  * @port_name: FC WWPN for the port
595  * @port_id:      FC N_Port_ID currently assigned the port. Upper 8 bits must
605 /* Operations that NVME-FC layer may request the LLDD to perform for FCP */
616  * struct nvmefc_tgt_fcp_req - Structure used between LLDD and NVMET-FC
618  *                            the specific FC-NVME IU operation(s) to perform
619  *                            for a FC-NVME FCP IO.
621  * Structure used between LLDD and nvmet-fc layer to represent the exchange
622  * context for a FC-NVME FCP I/O operation (e.g. a nvme sqe, the sqe-related
626  * from the FC link. The address of the structure is passed to the nvmet-fc
631  * the FCP I/O was received on, the remote FC NVME initiator that sent the
632  * FCP I/O, and any FC exchange context.  Upon completion of the FCP target
634  * op done() routine, allowing the nvmet-fc layer to release dma resources.
636  * further access will be made by the nvmet-fc layer and the LLDD can
643  *   When the structure is used for an FCP target operation, the nvmet-fc
646  *     upon compeletion of the operation.  The nvmet-fc layer will also set a
649  * Values set by the NVMET-FC layer prior to calling the LLDD fcp_op
680  * @nvmet_fc_private:  pointer to an internal NVMET-FC layer structure used
681  *            as part of the NVMET-FC processing. The LLDD is not to
726  * struct nvmet_fc_target_port - structure used between NVME-FC transport and
733  * @port_num:  NVME-FC transport subsystem port number
734  * @node_name: FC WWNN for the port
735  * @port_name: FC WWPN for the port
745  * @port_id:      FC N_Port_ID currently assigned the port. Upper 8 bits must
767  *                 registrations. NVME-FC transport remembers template
778  * @xmt_ls_rsp:  Called to transmit the response to a FC-NVME FC-4 LS service.
806  *           more FC sequences (preferrably 1).  Note: the fc-nvme layer
811  *           more FC sequences (preferrably 1). The LLDD is to generate
813  *           Note: the FC-NVME layer may call the WRITEDATA operation
817  *           more FC sequences (preferrably 1). If an error occurs during
827  *           may retramsit the FCP_RSP iu if necessary per FC-NVME. Upon
836  *           FCP_RSP iu if FCP_CONF is not received per FC-NVME. Upon
851  *       operations, the fc-nvme layer may immediate convert, in the same
890  * @ls_req:  Called to issue a FC-NVME FC-4 LS service request.
895  *       LS request is identified by the hosthandle argument. The nvmet-fc
896  *       transport is only allowed to issue FC-NVME LS's on behalf of an
914  *       indicating an FC transport Aborted status.
946  *       memory that it would like fc nvme layer to allocate on the LLDD's
953  *       memory that it would like nvmet-fc layer to allocate on the LLDD's
1000  * Routine called to pass a NVME-FC LS request, received by the lldd,
1001  * to the nvmet-fc transport.
1029  * connectivity to a NVME-FC host port which there had been active
1031  * hosthandle. The hosthandle is given to the nvmet-fc transport
1033  * The nvmet-fc transport will cache the hostport value with the
1035  * When the LLDD calls this routine, the nvmet-fc transport will
1043  * port, the nvmet-fc transport will call the ops->host_release()
1044  * callback. As of the callback, the nvmet-fc transport will no