2 * CXL Flash Device Driver
4 * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
5 * Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
7 * Copyright (C) 2015 IBM Corporation
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.
15 #ifndef _CXLFLASH_COMMON_H
16 #define _CXLFLASH_COMMON_H
18 #include <linux/list.h>
19 #include <linux/rwsem.h>
20 #include <linux/types.h>
21 #include <scsi/scsi.h>
22 #include <scsi/scsi_device.h>
24 extern const struct file_operations cxlflash_cxl_fops;
26 #define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
28 #define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
29 #define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
30 #define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
37 #define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))
39 /* AFU command retry limit */
40 #define MC_RETRY_CNT 5 /* sufficient for SCSI check and
43 /* Command management definitions */
44 #define CXLFLASH_NUM_CMDS (2 * CXLFLASH_MAX_CMDS) /* Must be a pow2 for
50 #define CXLFLASH_MAX_CMDS 256
51 #define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
53 /* RRQ for master issued cmds */
54 #define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS
57 static inline void check_sizes(void)
59 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS);
62 /* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
63 #define CMD_BUFSIZE SIZE_4K
65 /* flags in IOA status area for host use */
67 #define B_ERROR 0x02 /* set with B_DONE */
68 #define B_TIMEOUT 0x04 /* set with B_DONE & B_ERROR */
70 enum cxlflash_lr_state {
76 enum cxlflash_init_state {
84 STATE_NORMAL, /* Normal running state, everything good */
85 STATE_RESET, /* Reset state, trying to reset/recover */
86 STATE_FAILTERM /* Failed/terminating state, error out users/threads */
90 * Each context has its own set of resource handles that is visible
91 * only from that context.
96 struct cxl_context *mcctx;
99 struct pci_device_id *dev_id;
100 struct Scsi_Host *host;
102 ulong cxlflash_regs_pci;
104 struct work_struct work_q;
105 enum cxlflash_init_state init_state;
106 enum cxlflash_lr_state lr_state;
108 atomic_t scan_host_needed;
110 struct cxl_afu *cxl_afu;
111 struct pci_dev *parent_dev;
113 atomic_t recovery_threads;
114 struct mutex ctx_recovery_mutex;
115 struct mutex ctx_tbl_list_mutex;
116 struct rw_semaphore ioctl_rwsem;
117 struct ctx_info *ctx_tbl[MAX_CONTEXT];
118 struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
119 struct file_operations cxl_fops;
121 /* Parameters that are LUN table related */
122 int last_lun_index[CXLFLASH_NUM_FC_PORTS];
123 int promote_lun_index;
124 struct list_head lluns; /* list of llun_info structs */
126 wait_queue_head_t tmf_waitq;
127 spinlock_t tmf_slock;
129 wait_queue_head_t reset_waitq;
130 enum cxlflash_state state;
134 struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */
135 struct sisl_ioasa sa; /* IOASA must follow IOARCB */
137 struct completion cevent;
138 char *buf; /* per command buffer */
145 /* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
146 * However for performance reasons the IOARCB/IOASA should be
147 * cache line aligned.
149 } __aligned(cache_line_size());
152 /* Stuff requiring alignment go first. */
154 u64 rrq_entry[NUM_RRQ_ENTRY]; /* 2K RRQ */
156 * Command & data for AFU commands.
158 struct afu_cmd cmd[CXLFLASH_NUM_CMDS];
160 /* Beware of alignment till here. Preferably introduce new
161 * fields after this point
165 struct cxl_ioctl_start_work work;
166 struct cxlflash_afu_map __iomem *afu_map; /* entire MMIO map */
167 struct sisl_host_map __iomem *host_map; /* MC host map */
168 struct sisl_ctrl_map __iomem *ctrl_map; /* MC control map */
170 struct kref mapcount;
172 ctx_hndl_t ctx_hndl; /* master's context handle */
180 u32 cmd_couts; /* Number of command checkouts */
181 u32 internal_lun; /* User-desired LUN mode for this AFU */
184 u64 interface_version;
186 struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */
190 static inline u64 lun_to_lunid(u64 lun)
194 int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
195 return be64_to_cpu(lun_id);
198 int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8);
199 void cxlflash_list_init(void);
200 void cxlflash_term_global_luns(void);
201 void cxlflash_free_errpage(void);
202 int cxlflash_ioctl(struct scsi_device *, int, void __user *);
203 void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *);
204 int cxlflash_mark_contexts_error(struct cxlflash_cfg *);
205 void cxlflash_term_local_luns(struct cxlflash_cfg *);
206 void cxlflash_restore_luntable(struct cxlflash_cfg *);
208 #endif /* ifndef _CXLFLASH_COMMON_H */