blob: 539908f65cc4c0137d1c306fa4d5f7a4942697ec [file] [log] [blame]
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -05001/*
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
18#include <linux/list.h>
Matthew R. Ochs0a27ae52015-10-21 15:11:52 -050019#include <linux/rwsem.h>
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050020#include <linux/types.h>
21#include <scsi/scsi.h>
Matthew R. Ochs5fbb96c82016-11-28 18:42:19 -060022#include <scsi/scsi_cmnd.h>
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050023#include <scsi/scsi_device.h>
24
Matthew R. Ochs17ead262015-10-21 15:15:37 -050025extern const struct file_operations cxlflash_cxl_fops;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050026
27#define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
28
29#define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
30#define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
31#define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
32 max_sectors
33 in units of
34 512 byte
35 sectors
36 */
37
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050038#define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))
39
40/* AFU command retry limit */
41#define MC_RETRY_CNT 5 /* sufficient for SCSI check and
42 certain AFU errors */
43
44/* Command management definitions */
45#define CXLFLASH_NUM_CMDS (2 * CXLFLASH_MAX_CMDS) /* Must be a pow2 for
46 alignment and more
47 efficient array
48 index derivation
49 */
50
Manoj N. Kumar83430832016-03-04 15:55:20 -060051#define CXLFLASH_MAX_CMDS 256
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050052#define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
53
Manoj N. Kumar83430832016-03-04 15:55:20 -060054/* RRQ for master issued cmds */
55#define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS
56
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050057
58static inline void check_sizes(void)
59{
60 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS);
61}
62
63/* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
64#define CMD_BUFSIZE SIZE_4K
65
66/* flags in IOA status area for host use */
67#define B_DONE 0x01
68#define B_ERROR 0x02 /* set with B_DONE */
69#define B_TIMEOUT 0x04 /* set with B_DONE & B_ERROR */
70
71enum cxlflash_lr_state {
72 LINK_RESET_INVALID,
73 LINK_RESET_REQUIRED,
74 LINK_RESET_COMPLETE
75};
76
77enum cxlflash_init_state {
78 INIT_STATE_NONE,
79 INIT_STATE_PCI,
80 INIT_STATE_AFU,
81 INIT_STATE_SCSI
82};
83
Matthew R. Ochs5cdac812015-08-13 21:47:34 -050084enum cxlflash_state {
85 STATE_NORMAL, /* Normal running state, everything good */
Matthew R. Ochs439e85c2015-10-21 15:12:00 -050086 STATE_RESET, /* Reset state, trying to reset/recover */
Matthew R. Ochs5cdac812015-08-13 21:47:34 -050087 STATE_FAILTERM /* Failed/terminating state, error out users/threads */
88};
89
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -050090/*
91 * Each context has its own set of resource handles that is visible
92 * only from that context.
93 */
94
95struct cxlflash_cfg {
96 struct afu *afu;
97 struct cxl_context *mcctx;
98
99 struct pci_dev *dev;
100 struct pci_device_id *dev_id;
101 struct Scsi_Host *host;
102
103 ulong cxlflash_regs_pci;
104
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500105 struct work_struct work_q;
106 enum cxlflash_init_state init_state;
107 enum cxlflash_lr_state lr_state;
108 int lr_port;
Matthew R. Ochsef510742015-10-21 15:13:37 -0500109 atomic_t scan_host_needed;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500110
111 struct cxl_afu *cxl_afu;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500112
Matthew R. Ochs65be2c72015-08-13 21:47:43 -0500113 atomic_t recovery_threads;
114 struct mutex ctx_recovery_mutex;
115 struct mutex ctx_tbl_list_mutex;
Matthew R. Ochs0a27ae52015-10-21 15:11:52 -0500116 struct rw_semaphore ioctl_rwsem;
Matthew R. Ochs65be2c72015-08-13 21:47:43 -0500117 struct ctx_info *ctx_tbl[MAX_CONTEXT];
118 struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
119 struct file_operations cxl_fops;
120
Matthew R. Ochs2cb79262015-08-13 21:47:53 -0500121 /* Parameters that are LUN table related */
122 int last_lun_index[CXLFLASH_NUM_FC_PORTS];
123 int promote_lun_index;
Matthew R. Ochs65be2c72015-08-13 21:47:43 -0500124 struct list_head lluns; /* list of llun_info structs */
125
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500126 wait_queue_head_t tmf_waitq;
Matthew R. Ochs018d1dc952015-10-21 15:13:21 -0500127 spinlock_t tmf_slock;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500128 bool tmf_active;
Matthew R. Ochs439e85c2015-10-21 15:12:00 -0500129 wait_queue_head_t reset_waitq;
Matthew R. Ochs5cdac812015-08-13 21:47:34 -0500130 enum cxlflash_state state;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500131};
132
133struct afu_cmd {
134 struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */
135 struct sisl_ioasa sa; /* IOASA must follow IOARCB */
136 spinlock_t slock;
137 struct completion cevent;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500138 struct afu *parent;
139 int slot;
140 atomic_t free;
141
142 u8 cmd_tmf:1;
143
144 /* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
145 * However for performance reasons the IOARCB/IOASA should be
146 * cache line aligned.
147 */
148} __aligned(cache_line_size());
149
Matthew R. Ochs5fbb96c82016-11-28 18:42:19 -0600150static inline struct afu_cmd *sc_to_afuc(struct scsi_cmnd *sc)
151{
152 return PTR_ALIGN(scsi_cmd_priv(sc), __alignof__(struct afu_cmd));
153}
154
155static inline struct afu_cmd *sc_to_afucz(struct scsi_cmnd *sc)
156{
157 struct afu_cmd *afuc = sc_to_afuc(sc);
158
159 memset(afuc, 0, sizeof(*afuc));
160 return afuc;
161}
162
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500163struct afu {
164 /* Stuff requiring alignment go first. */
165
Manoj N. Kumar83430832016-03-04 15:55:20 -0600166 u64 rrq_entry[NUM_RRQ_ENTRY]; /* 2K RRQ */
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500167 /*
168 * Command & data for AFU commands.
169 */
170 struct afu_cmd cmd[CXLFLASH_NUM_CMDS];
171
172 /* Beware of alignment till here. Preferably introduce new
173 * fields after this point
174 */
175
176 /* AFU HW */
177 struct cxl_ioctl_start_work work;
Matthew R. Ochs1786f4a2015-10-21 15:14:48 -0500178 struct cxlflash_afu_map __iomem *afu_map; /* entire MMIO map */
179 struct sisl_host_map __iomem *host_map; /* MC host map */
180 struct sisl_ctrl_map __iomem *ctrl_map; /* MC control map */
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500181
Manoj Kumarb45cdbaf2015-12-14 15:07:23 -0600182 struct kref mapcount;
183
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500184 ctx_hndl_t ctx_hndl; /* master's context handle */
185 u64 *hrrq_start;
186 u64 *hrrq_end;
187 u64 *hrrq_curr;
188 bool toggle;
Uma Krishnan11f7b182016-11-28 18:41:45 -0600189 s64 room;
190 spinlock_t rrin_slock; /* Lock to rrin queuing and cmd_room updates */
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500191 u64 hb;
192 u32 cmd_couts; /* Number of command checkouts */
193 u32 internal_lun; /* User-desired LUN mode for this AFU */
194
Matthew R. Ochse5ce0672015-10-21 15:14:01 -0500195 char version[16];
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500196 u64 interface_version;
197
198 struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */
199
200};
201
202static inline u64 lun_to_lunid(u64 lun)
203{
Matthew R. Ochs1786f4a2015-10-21 15:14:48 -0500204 __be64 lun_id;
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500205
206 int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
Matthew R. Ochs1786f4a2015-10-21 15:14:48 -0500207 return be64_to_cpu(lun_id);
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500208}
209
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500210int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8);
Matthew R. Ochs65be2c72015-08-13 21:47:43 -0500211void cxlflash_list_init(void);
212void cxlflash_term_global_luns(void);
213void cxlflash_free_errpage(void);
214int cxlflash_ioctl(struct scsi_device *, int, void __user *);
215void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *);
216int cxlflash_mark_contexts_error(struct cxlflash_cfg *);
217void cxlflash_term_local_luns(struct cxlflash_cfg *);
Matthew R. Ochs2cb79262015-08-13 21:47:53 -0500218void cxlflash_restore_luntable(struct cxlflash_cfg *);
Matthew R. Ochs65be2c72015-08-13 21:47:43 -0500219
Matthew R. Ochsc21e0bb2015-06-09 17:15:52 -0500220#endif /* ifndef _CXLFLASH_COMMON_H */