[mirror_ubuntu-jammy-kernel.git] / drivers / scsi / qla2xxx / qla_nvme.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * QLogic Fibre Channel HBA Driver
 * Copyright (c)  2003-2017 QLogic Corporation
 */
#ifndef __QLA_NVME_H
#define __QLA_NVME_H

#include <uapi/scsi/fc/fc_fs.h>
#include <uapi/scsi/fc/fc_els.h>
#include <linux/nvme-fc-driver.h>

#include "qla_def.h"
#include "qla_dsd.h"

/* default dev loss time (seconds) before transport tears down ctrl */
#define NVME_FC_DEV_LOSS_TMO  30

#define NVME_ATIO_CMD_OFF 32
#define NVME_FIRST_PACKET_CMDLEN (64 - NVME_ATIO_CMD_OFF)
#define Q2T_NVME_NUM_TAGS 2048
#define QLA_MAX_FC_SEGMENTS 64

struct scsi_qla_host;
struct qla_hw_data;
struct req_que;
struct srb;

struct nvme_private {
	struct srb	*sp;
	struct nvmefc_ls_req *fd;
	struct work_struct ls_work;
	struct work_struct abort_work;
	int comp_status;
	spinlock_t cmd_lock;
};

struct qla_nvme_rport {
	struct fc_port *fcport;
};

#define COMMAND_NVME    0x88            /* Command Type FC-NVMe IOCB */
struct cmd_nvme {
	uint8_t entry_type;             /* Entry type. */
	uint8_t entry_count;            /* Entry count. */
	uint8_t sys_define;             /* System defined. */
	uint8_t entry_status;           /* Entry Status. */

	uint32_t handle;                /* System handle. */
	__le16	nport_handle;		/* N_PORT handle. */
	__le16	timeout;		/* Command timeout. */

	__le16	dseg_count;		/* Data segment count. */
	__le16	nvme_rsp_dsd_len;	/* NVMe RSP DSD length */

	uint64_t rsvd;

	__le16	control_flags;		/* Control Flags */
#define CF_NVME_FIRST_BURST_ENABLE	BIT_11
#define CF_DIF_SEG_DESCR_ENABLE         BIT_3
#define CF_DATA_SEG_DESCR_ENABLE        BIT_2
#define CF_READ_DATA                    BIT_1
#define CF_WRITE_DATA                   BIT_0

	__le16	nvme_cmnd_dseg_len;             /* Data segment length. */
	__le64	 nvme_cmnd_dseg_address __packed;/* Data segment address. */
	__le64	 nvme_rsp_dseg_address __packed; /* Data segment address. */

	__le32	byte_count;		/* Total byte count. */

	uint8_t port_id[3];             /* PortID of destination port. */
	uint8_t vp_index;

	struct dsd64 nvme_dsd;
};

#define PT_LS4_REQUEST 0x89	/* Link Service pass-through IOCB (request) */
struct pt_ls4_request {
	uint8_t entry_type;
	uint8_t entry_count;
	uint8_t sys_define;
	uint8_t entry_status;
	uint32_t handle;
	__le16	status;
	__le16	nport_handle;
	__le16	tx_dseg_count;
	uint8_t  vp_index;
	uint8_t  rsvd;
	__le16	timeout;
	__le16	control_flags;
#define CF_LS4_SHIFT		13
#define CF_LS4_ORIGINATOR	0
#define CF_LS4_RESPONDER	1
#define CF_LS4_RESPONDER_TERM	2

	__le16	rx_dseg_count;
	__le16	rsvd2;
	__le32	exchange_address;
	__le32	rsvd3;
	__le32	rx_byte_count;
	__le32	tx_byte_count;
	struct dsd64 dsd[2];
};

#define PT_LS4_UNSOL 0x56	/* pass-up unsolicited rec FC-NVMe request */
struct pt_ls4_rx_unsol {
	uint8_t entry_type;
	uint8_t entry_count;
	__le16	rsvd0;
	__le16	rsvd1;
	uint8_t vp_index;
	uint8_t rsvd2;
	__le16	rsvd3;
	__le16	nport_handle;
	__le16	frame_size;
	__le16	rsvd4;
	__le32	exchange_address;
	uint8_t d_id[3];
	uint8_t r_ctl;
	be_id_t s_id;
	uint8_t cs_ctl;
	uint8_t f_ctl[3];
	uint8_t type;
	__le16	seq_cnt;
	uint8_t df_ctl;
	uint8_t seq_id;
	__le16	rx_id;
	__le16	ox_id;
	__le32	param;
	__le32	desc0;
#define PT_LS4_PAYLOAD_OFFSET 0x2c
#define PT_LS4_FIRST_PACKET_LEN 20
	__le32	desc_len;
	__le32	payload[3];
};

/*
 * Global functions prototype in qla_nvme.c source file.
 */
int qla_nvme_register_hba(struct scsi_qla_host *);
int  qla_nvme_register_remote(struct scsi_qla_host *, struct fc_port *);
void qla_nvme_delete(struct scsi_qla_host *);
void qla24xx_nvme_ls4_iocb(struct scsi_qla_host *, struct pt_ls4_request *,
    struct req_que *);
void qla24xx_async_gffid_sp_done(struct srb *sp, int);
#endif
Commit	Line	Data
77adf3f0	1	/* SPDX-License-Identifier: GPL-2.0-only */
e84067d7 DG	2	/*
	3	* QLogic Fibre Channel HBA Driver
	4	* Copyright (c) 2003-2017 QLogic Corporation
e84067d7 DG	5	*/
	6	#ifndef __QLA_NVME_H
	7	#define __QLA_NVME_H
	8
e84067d7 DG	9	#include <uapi/scsi/fc/fc_fs.h>
	10	#include <uapi/scsi/fc/fc_els.h>
	11	#include <linux/nvme-fc-driver.h>
	12
0f7e51f6	13	#include "qla_def.h"
15b7a68c	14	#include "qla_dsd.h"
0f7e51f6	15
9dd9686b DT	16	/* default dev loss time (seconds) before transport tears down ctrl */
	17	#define NVME_FC_DEV_LOSS_TMO 30
	18
e84067d7 DG	19	#define NVME_ATIO_CMD_OFF 32
	20	#define NVME_FIRST_PACKET_CMDLEN (64 - NVME_ATIO_CMD_OFF)
	21	#define Q2T_NVME_NUM_TAGS 2048
	22	#define QLA_MAX_FC_SEGMENTS 64
	23
0f7e51f6	24	struct scsi_qla_host;
	25	struct qla_hw_data;
	26	struct req_que;
e84067d7	27	struct srb;
0f7e51f6	28
e84067d7 DG	29	struct nvme_private {
	30	struct srb *sp;
	31	struct nvmefc_ls_req *fd;
	32	struct work_struct ls_work;
e473b307	33	struct work_struct abort_work;
e84067d7	34	int comp_status;
4c2a2d01	35	spinlock_t cmd_lock;
e84067d7 DG	36	};
e84067d7 DG	37
9dd9686b	38	struct qla_nvme_rport {
e84067d7 DG	39	struct fc_port *fcport;
	40	};
	41
	42	#define COMMAND_NVME 0x88 /* Command Type FC-NVMe IOCB */
	43	struct cmd_nvme {
	44	uint8_t entry_type; /* Entry type. */
	45	uint8_t entry_count; /* Entry count. */
	46	uint8_t sys_define; /* System defined. */
	47	uint8_t entry_status; /* Entry Status. */
	48
	49	uint32_t handle; /* System handle. */
21038b09 BVA	50	__le16 nport_handle; /* N_PORT handle. */
21038b09 BVA	51	__le16 timeout; /* Command timeout. */
e84067d7	52
21038b09 BVA	53	__le16 dseg_count; /* Data segment count. */
21038b09 BVA	54	__le16 nvme_rsp_dsd_len; /* NVMe RSP DSD length */
e84067d7 DG	55
	56	uint64_t rsvd;
	57
21038b09	58	__le16 control_flags; /* Control Flags */
03aaa89f	59	#define CF_NVME_FIRST_BURST_ENABLE BIT_11
e84067d7 DG	60	#define CF_DIF_SEG_DESCR_ENABLE BIT_3
	61	#define CF_DATA_SEG_DESCR_ENABLE BIT_2
	62	#define CF_READ_DATA BIT_1
	63	#define CF_WRITE_DATA BIT_0
	64
21038b09	65	__le16 nvme_cmnd_dseg_len; /* Data segment length. */
d4556a49 BVA	66	__le64 nvme_cmnd_dseg_address __packed;/* Data segment address. */
d4556a49 BVA	67	__le64 nvme_rsp_dseg_address __packed; /* Data segment address. */
e84067d7	68
21038b09	69	__le32 byte_count; /* Total byte count. */
e84067d7 DG	70
	71	uint8_t port_id[3]; /* PortID of destination port. */
	72	uint8_t vp_index;
	73
15b7a68c	74	struct dsd64 nvme_dsd;
e84067d7 DG	75	};
	76
	77	#define PT_LS4_REQUEST 0x89 /* Link Service pass-through IOCB (request) */
	78	struct pt_ls4_request {
	79	uint8_t entry_type;
	80	uint8_t entry_count;
	81	uint8_t sys_define;
	82	uint8_t entry_status;
	83	uint32_t handle;
21038b09 BVA	84	__le16 status;
	85	__le16 nport_handle;
	86	__le16 tx_dseg_count;
e84067d7 DG	87	uint8_t vp_index;
e84067d7 DG	88	uint8_t rsvd;
21038b09 BVA	89	__le16 timeout;
21038b09 BVA	90	__le16 control_flags;
e84067d7 DG	91	#define CF_LS4_SHIFT 13
	92	#define CF_LS4_ORIGINATOR 0
	93	#define CF_LS4_RESPONDER 1
	94	#define CF_LS4_RESPONDER_TERM 2
	95
21038b09 BVA	96	__le16 rx_dseg_count;
	97	__le16 rsvd2;
	98	__le32 exchange_address;
	99	__le32 rsvd3;
	100	__le32 rx_byte_count;
	101	__le32 tx_byte_count;
15b7a68c	102	struct dsd64 dsd[2];
e84067d7 DG	103	};
	104
	105	#define PT_LS4_UNSOL 0x56 /* pass-up unsolicited rec FC-NVMe request */
	106	struct pt_ls4_rx_unsol {
	107	uint8_t entry_type;
	108	uint8_t entry_count;
21038b09 BVA	109	__le16 rsvd0;
21038b09 BVA	110	__le16 rsvd1;
e84067d7 DG	111	uint8_t vp_index;
e84067d7 DG	112	uint8_t rsvd2;
21038b09 BVA	113	__le16 rsvd3;
	114	__le16 nport_handle;
	115	__le16 frame_size;
	116	__le16 rsvd4;
	117	__le32 exchange_address;
e84067d7 DG	118	uint8_t d_id[3];
e84067d7 DG	119	uint8_t r_ctl;
df95f39a	120	be_id_t s_id;
e84067d7 DG	121	uint8_t cs_ctl;
	122	uint8_t f_ctl[3];
	123	uint8_t type;
21038b09	124	__le16 seq_cnt;
e84067d7 DG	125	uint8_t df_ctl;
e84067d7 DG	126	uint8_t seq_id;
21038b09 BVA	127	__le16 rx_id;
	128	__le16 ox_id;
	129	__le32 param;
	130	__le32 desc0;
e84067d7 DG	131	#define PT_LS4_PAYLOAD_OFFSET 0x2c
e84067d7 DG	132	#define PT_LS4_FIRST_PACKET_LEN 20
21038b09 BVA	133	__le32 desc_len;
21038b09 BVA	134	__le32 payload[3];
e84067d7	135	};
0f7e51f6	136
	137	/*
	138	* Global functions prototype in qla_nvme.c source file.
	139	*/
8777e431	140	int qla_nvme_register_hba(struct scsi_qla_host *);
0f7e51f6	141	int qla_nvme_register_remote(struct scsi_qla_host , struct fc_port );
0f7e51f6	142	void qla_nvme_delete(struct scsi_qla_host *);
0f7e51f6	143	void qla24xx_nvme_ls4_iocb(struct scsi_qla_host , struct pt_ls4_request ,
0f7e51f6	144	struct req_que *);
6c18a43e	145	void qla24xx_async_gffid_sp_done(struct srb *sp, int);
e84067d7	146	#endif