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