scsi/qla2xxx: Convert to SPDX license identifiers
[linux-2.6-microblaze.git] / drivers / scsi / qla2xxx / qla_nvme.h
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 /* default dev loss time (seconds) before transport tears down ctrl */
17 #define NVME_FC_DEV_LOSS_TMO  30
18
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
24 struct scsi_qla_host;
25 struct qla_hw_data;
26 struct req_que;
27 struct srb;
28
29 struct nvme_private {
30         struct srb      *sp;
31         struct nvmefc_ls_req *fd;
32         struct work_struct ls_work;
33         struct work_struct abort_work;
34         int comp_status;
35         spinlock_t cmd_lock;
36 };
37
38 struct qla_nvme_rport {
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. */
50         __le16  nport_handle;           /* N_PORT handle. */
51         __le16  timeout;                /* Command timeout. */
52
53         __le16  dseg_count;             /* Data segment count. */
54         __le16  nvme_rsp_dsd_len;       /* NVMe RSP DSD length */
55
56         uint64_t rsvd;
57
58         __le16  control_flags;          /* Control Flags */
59 #define CF_NVME_FIRST_BURST_ENABLE      BIT_11
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
65         __le16  nvme_cmnd_dseg_len;             /* Data segment length. */
66         __le64   nvme_cmnd_dseg_address __packed;/* Data segment address. */
67         __le64   nvme_rsp_dseg_address __packed; /* Data segment address. */
68
69         __le32  byte_count;             /* Total byte count. */
70
71         uint8_t port_id[3];             /* PortID of destination port. */
72         uint8_t vp_index;
73
74         struct dsd64 nvme_dsd;
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;
84         __le16  status;
85         __le16  nport_handle;
86         __le16  tx_dseg_count;
87         uint8_t  vp_index;
88         uint8_t  rsvd;
89         __le16  timeout;
90         __le16  control_flags;
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
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;
102         struct dsd64 dsd[2];
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;
109         __le16  rsvd0;
110         __le16  rsvd1;
111         uint8_t vp_index;
112         uint8_t rsvd2;
113         __le16  rsvd3;
114         __le16  nport_handle;
115         __le16  frame_size;
116         __le16  rsvd4;
117         __le32  exchange_address;
118         uint8_t d_id[3];
119         uint8_t r_ctl;
120         be_id_t s_id;
121         uint8_t cs_ctl;
122         uint8_t f_ctl[3];
123         uint8_t type;
124         __le16  seq_cnt;
125         uint8_t df_ctl;
126         uint8_t seq_id;
127         __le16  rx_id;
128         __le16  ox_id;
129         __le32  param;
130         __le32  desc0;
131 #define PT_LS4_PAYLOAD_OFFSET 0x2c
132 #define PT_LS4_FIRST_PACKET_LEN 20
133         __le32  desc_len;
134         __le32  payload[3];
135 };
136
137 /*
138  * Global functions prototype in qla_nvme.c source file.
139  */
140 int qla_nvme_register_hba(struct scsi_qla_host *);
141 int  qla_nvme_register_remote(struct scsi_qla_host *, struct fc_port *);
142 void qla_nvme_delete(struct scsi_qla_host *);
143 void qla24xx_nvme_ls4_iocb(struct scsi_qla_host *, struct pt_ls4_request *,
144     struct req_que *);
145 void qla24xx_async_gffid_sp_done(struct srb *sp, int);
146 #endif