scsi: cxlflash: Reset hardware queue context via specified register
[linux-block.git] / drivers / scsi / cxlflash / common.h
CommitLineData
c21e0bbf
MO
1/*
2 * CXL Flash Device Driver
3 *
4 * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
5 * Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
6 *
7 * Copyright (C) 2015 IBM Corporation
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
13 */
14
15#ifndef _CXLFLASH_COMMON_H
16#define _CXLFLASH_COMMON_H
17
cba06e6d 18#include <linux/irq_poll.h>
c21e0bbf 19#include <linux/list.h>
0a27ae51 20#include <linux/rwsem.h>
c21e0bbf
MO
21#include <linux/types.h>
22#include <scsi/scsi.h>
5fbb96c8 23#include <scsi/scsi_cmnd.h>
c21e0bbf
MO
24#include <scsi/scsi_device.h>
25
17ead26f 26extern const struct file_operations cxlflash_cxl_fops;
c21e0bbf 27
78ae028e 28#define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
56518072
MO
29#define MAX_FC_PORTS CXLFLASH_MAX_FC_PORTS /* max ports per AFU */
30#define LEGACY_FC_PORTS 2 /* legacy ports per AFU */
31
32#define CHAN2PORTBANK(_x) ((_x) >> ilog2(CXLFLASH_NUM_FC_PORTS_PER_BANK))
33#define CHAN2BANKPORT(_x) ((_x) & (CXLFLASH_NUM_FC_PORTS_PER_BANK - 1))
c21e0bbf 34
8fa4f177
MO
35#define CHAN2PORTMASK(_x) (1 << (_x)) /* channel to port mask */
36#define PORTMASK2CHAN(_x) (ilog2((_x))) /* port mask to channel */
37#define PORTNUM2CHAN(_x) ((_x) - 1) /* port number to channel */
38
fcc87e74 39#define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
c21e0bbf
MO
40#define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
41#define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
fcc87e74
MO
42 * max_sectors
43 * in units of
44 * 512 byte
45 * sectors
46 */
c21e0bbf 47
c21e0bbf
MO
48#define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))
49
50/* AFU command retry limit */
fcc87e74 51#define MC_RETRY_CNT 5 /* Sufficient for SCSI and certain AFU errors */
c21e0bbf
MO
52
53/* Command management definitions */
83430833 54#define CXLFLASH_MAX_CMDS 256
c21e0bbf
MO
55#define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
56
83430833
MK
57/* RRQ for master issued cmds */
58#define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS
59
696d0b0c
MO
60/* SQ for master issued cmds */
61#define NUM_SQ_ENTRY CXLFLASH_MAX_CMDS
62
3065267a
MO
63/* Hardware queue definitions */
64#define CXLFLASH_DEF_HWQS 1
65#define CXLFLASH_MAX_HWQS 8
bfc0bab1
UK
66#define PRIMARY_HWQ 0
67
c21e0bbf
MO
68
69static inline void check_sizes(void)
70{
56518072 71 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_FC_PORTS_PER_BANK);
cd41e18d 72 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_MAX_CMDS);
c21e0bbf
MO
73}
74
75/* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
76#define CMD_BUFSIZE SIZE_4K
77
c21e0bbf
MO
78enum cxlflash_lr_state {
79 LINK_RESET_INVALID,
80 LINK_RESET_REQUIRED,
81 LINK_RESET_COMPLETE
82};
83
84enum cxlflash_init_state {
85 INIT_STATE_NONE,
86 INIT_STATE_PCI,
87 INIT_STATE_AFU,
88 INIT_STATE_SCSI
89};
90
5cdac81a 91enum cxlflash_state {
323e3342
MO
92 STATE_PROBING, /* Initial state during probe */
93 STATE_PROBED, /* Temporary state, probe completed but EEH occurred */
5cdac81a 94 STATE_NORMAL, /* Normal running state, everything good */
439e85c1 95 STATE_RESET, /* Reset state, trying to reset/recover */
5cdac81a
MO
96 STATE_FAILTERM /* Failed/terminating state, error out users/threads */
97};
98
1dd0c0e4
MO
99enum cxlflash_hwq_mode {
100 HWQ_MODE_RR, /* Roundrobin (default) */
101 HWQ_MODE_TAG, /* Distribute based on block MQ tag */
102 HWQ_MODE_CPU, /* CPU affinity */
103 MAX_HWQ_MODE
104};
105
c21e0bbf
MO
106/*
107 * Each context has its own set of resource handles that is visible
108 * only from that context.
109 */
110
111struct cxlflash_cfg {
112 struct afu *afu;
c21e0bbf
MO
113
114 struct pci_dev *dev;
115 struct pci_device_id *dev_id;
116 struct Scsi_Host *host;
78ae028e 117 int num_fc_ports;
c21e0bbf
MO
118
119 ulong cxlflash_regs_pci;
120
c21e0bbf
MO
121 struct work_struct work_q;
122 enum cxlflash_init_state init_state;
123 enum cxlflash_lr_state lr_state;
124 int lr_port;
ef51074a 125 atomic_t scan_host_needed;
c21e0bbf
MO
126
127 struct cxl_afu *cxl_afu;
c21e0bbf 128
65be2c79
MO
129 atomic_t recovery_threads;
130 struct mutex ctx_recovery_mutex;
131 struct mutex ctx_tbl_list_mutex;
0a27ae51 132 struct rw_semaphore ioctl_rwsem;
65be2c79
MO
133 struct ctx_info *ctx_tbl[MAX_CONTEXT];
134 struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
135 struct file_operations cxl_fops;
136
2cb79266 137 /* Parameters that are LUN table related */
78ae028e 138 int last_lun_index[MAX_FC_PORTS];
2cb79266 139 int promote_lun_index;
65be2c79
MO
140 struct list_head lluns; /* list of llun_info structs */
141
c21e0bbf 142 wait_queue_head_t tmf_waitq;
018d1dc9 143 spinlock_t tmf_slock;
c21e0bbf 144 bool tmf_active;
439e85c1 145 wait_queue_head_t reset_waitq;
5cdac81a 146 enum cxlflash_state state;
c21e0bbf
MO
147};
148
149struct afu_cmd {
150 struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */
151 struct sisl_ioasa sa; /* IOASA must follow IOARCB */
c21e0bbf 152 struct afu *parent;
fe7f9698 153 struct scsi_cmnd *scp;
9ba848ac 154 struct completion cevent;
f918b4a8 155 struct list_head queue;
1dd0c0e4 156 u32 hwq_index;
c21e0bbf
MO
157
158 u8 cmd_tmf:1;
159
160 /* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
161 * However for performance reasons the IOARCB/IOASA should be
162 * cache line aligned.
163 */
164} __aligned(cache_line_size());
165
5fbb96c8
MO
166static inline struct afu_cmd *sc_to_afuc(struct scsi_cmnd *sc)
167{
168 return PTR_ALIGN(scsi_cmd_priv(sc), __alignof__(struct afu_cmd));
169}
170
171static inline struct afu_cmd *sc_to_afucz(struct scsi_cmnd *sc)
172{
173 struct afu_cmd *afuc = sc_to_afuc(sc);
174
175 memset(afuc, 0, sizeof(*afuc));
176 return afuc;
177}
178
bfc0bab1 179struct hwq {
c21e0bbf 180 /* Stuff requiring alignment go first. */
696d0b0c
MO
181 struct sisl_ioarcb sq[NUM_SQ_ENTRY]; /* 16K SQ */
182 u64 rrq_entry[NUM_RRQ_ENTRY]; /* 2K RRQ */
c21e0bbf
MO
183
184 /* Beware of alignment till here. Preferably introduce new
185 * fields after this point
186 */
bfc0bab1
UK
187 struct afu *afu;
188 struct cxl_context *ctx;
c21e0bbf 189 struct cxl_ioctl_start_work work;
1786f4a0
MO
190 struct sisl_host_map __iomem *host_map; /* MC host map */
191 struct sisl_ctrl_map __iomem *ctrl_map; /* MC control map */
c21e0bbf 192 ctx_hndl_t ctx_hndl; /* master's context handle */
bfc0bab1 193 u32 index; /* Index of this hwq */
696d0b0c
MO
194
195 atomic_t hsq_credits;
66ea9bcc 196 spinlock_t hsq_slock; /* Hardware send queue lock */
696d0b0c
MO
197 struct sisl_ioarcb *hsq_start;
198 struct sisl_ioarcb *hsq_end;
199 struct sisl_ioarcb *hsq_curr;
f918b4a8 200 spinlock_t hrrq_slock;
c21e0bbf
MO
201 u64 *hrrq_start;
202 u64 *hrrq_end;
203 u64 *hrrq_curr;
204 bool toggle;
bfc0bab1 205
11f7b184 206 s64 room;
bfc0bab1
UK
207
208 struct irq_poll irqpoll;
209} __aligned(cache_line_size());
210
211struct afu {
3065267a 212 struct hwq hwqs[CXLFLASH_MAX_HWQS];
bfc0bab1 213 int (*send_cmd)(struct afu *, struct afu_cmd *);
a96851d3 214 int (*context_reset)(struct hwq *);
bfc0bab1
UK
215
216 /* AFU HW */
217 struct cxlflash_afu_map __iomem *afu_map; /* entire MMIO map */
218
219 atomic_t cmds_active; /* Number of currently active AFU commands */
c21e0bbf 220 u64 hb;
c21e0bbf 221 u32 internal_lun; /* User-desired LUN mode for this AFU */
1dd0c0e4 222
3065267a
MO
223 u32 num_hwqs; /* Number of hardware queues */
224 u32 desired_hwqs; /* Desired h/w queues, effective on AFU reset */
1dd0c0e4
MO
225 enum cxlflash_hwq_mode hwq_mode; /* Steering mode for h/w queues */
226 u32 hwq_rr_count; /* Count to distribute traffic for roundrobin */
c21e0bbf 227
e5ce067b 228 char version[16];
c21e0bbf
MO
229 u64 interface_version;
230
cba06e6d 231 u32 irqpoll_weight;
c21e0bbf 232 struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */
c21e0bbf
MO
233};
234
bfc0bab1
UK
235static inline struct hwq *get_hwq(struct afu *afu, u32 index)
236{
3065267a 237 WARN_ON(index >= CXLFLASH_MAX_HWQS);
bfc0bab1
UK
238
239 return &afu->hwqs[index];
240}
241
cba06e6d
MO
242static inline bool afu_is_irqpoll_enabled(struct afu *afu)
243{
244 return !!afu->irqpoll_weight;
245}
246
696d0b0c
MO
247static inline bool afu_is_cmd_mode(struct afu *afu, u64 cmd_mode)
248{
249 u64 afu_cap = afu->interface_version >> SISL_INTVER_CAP_SHIFT;
250
251 return afu_cap & cmd_mode;
252}
253
254static inline bool afu_is_sq_cmd_mode(struct afu *afu)
255{
256 return afu_is_cmd_mode(afu, SISL_INTVER_CAP_SQ_CMD_MODE);
257}
258
259static inline bool afu_is_ioarrin_cmd_mode(struct afu *afu)
260{
261 return afu_is_cmd_mode(afu, SISL_INTVER_CAP_IOARRIN_CMD_MODE);
262}
263
c21e0bbf
MO
264static inline u64 lun_to_lunid(u64 lun)
265{
1786f4a0 266 __be64 lun_id;
c21e0bbf
MO
267
268 int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
1786f4a0 269 return be64_to_cpu(lun_id);
c21e0bbf
MO
270}
271
56518072
MO
272static inline struct fc_port_bank __iomem *get_fc_port_bank(
273 struct cxlflash_cfg *cfg, int i)
0aa14887
MO
274{
275 struct afu *afu = cfg->afu;
276
56518072
MO
277 return &afu->afu_map->global.bank[CHAN2PORTBANK(i)];
278}
279
280static inline __be64 __iomem *get_fc_port_regs(struct cxlflash_cfg *cfg, int i)
281{
282 struct fc_port_bank __iomem *fcpb = get_fc_port_bank(cfg, i);
283
284 return &fcpb->fc_port_regs[CHAN2BANKPORT(i)][0];
0aa14887
MO
285}
286
287static inline __be64 __iomem *get_fc_port_luns(struct cxlflash_cfg *cfg, int i)
288{
56518072 289 struct fc_port_bank __iomem *fcpb = get_fc_port_bank(cfg, i);
0aa14887 290
56518072 291 return &fcpb->fc_port_luns[CHAN2BANKPORT(i)][0];
0aa14887
MO
292}
293
fcc87e74 294int cxlflash_afu_sync(struct afu *afu, ctx_hndl_t c, res_hndl_t r, u8 mode);
65be2c79
MO
295void cxlflash_list_init(void);
296void cxlflash_term_global_luns(void);
297void cxlflash_free_errpage(void);
fcc87e74
MO
298int cxlflash_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
299void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *cfg);
300int cxlflash_mark_contexts_error(struct cxlflash_cfg *cfg);
301void cxlflash_term_local_luns(struct cxlflash_cfg *cfg);
302void cxlflash_restore_luntable(struct cxlflash_cfg *cfg);
65be2c79 303
c21e0bbf 304#endif /* ifndef _CXLFLASH_COMMON_H */