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>
25 #define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
27 #define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
28 #define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
29 #define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
36 #define NUM_RRQ_ENTRY 16 /* for master issued cmds */
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 16
51 #define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
54 static inline void check_sizes(void)
56 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS);
59 /* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
60 #define CMD_BUFSIZE SIZE_4K
62 /* flags in IOA status area for host use */
64 #define B_ERROR 0x02 /* set with B_DONE */
65 #define B_TIMEOUT 0x04 /* set with B_DONE & B_ERROR */
67 enum cxlflash_lr_state {
73 enum cxlflash_init_state {
81 STATE_NORMAL, /* Normal running state, everything good */
82 STATE_LIMBO, /* Limbo running state, trying to reset/recover */
83 STATE_FAILTERM /* Failed/terminating state, error out users/threads */
87 * Each context has its own set of resource handles that is visible
88 * only from that context.
93 struct cxl_context *mcctx;
96 struct pci_device_id *dev_id;
97 struct Scsi_Host *host;
99 ulong cxlflash_regs_pci;
101 struct work_struct work_q;
102 enum cxlflash_init_state init_state;
103 enum cxlflash_lr_state lr_state;
106 struct cxl_afu *cxl_afu;
108 struct pci_pool *cxlflash_cmd_pool;
109 struct pci_dev *parent_dev;
111 atomic_t recovery_threads;
112 struct mutex ctx_recovery_mutex;
113 struct mutex ctx_tbl_list_mutex;
114 struct rw_semaphore ioctl_rwsem;
115 struct ctx_info *ctx_tbl[MAX_CONTEXT];
116 struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
117 struct file_operations cxl_fops;
119 atomic_t num_user_contexts;
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;
128 wait_queue_head_t limbo_waitq;
129 enum cxlflash_state state;
133 struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */
134 struct sisl_ioasa sa; /* IOASA must follow IOARCB */
136 struct completion cevent;
137 char *buf; /* per command buffer */
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.
148 } __aligned(cache_line_size());
151 /* Stuff requiring alignment go first. */
153 u64 rrq_entry[NUM_RRQ_ENTRY]; /* 128B RRQ */
155 * Command & data for AFU commands.
157 struct afu_cmd cmd[CXLFLASH_NUM_CMDS];
159 /* Beware of alignment till here. Preferably introduce new
160 * fields after this point
164 struct cxl_ioctl_start_work work;
165 struct cxlflash_afu_map *afu_map; /* entire MMIO map */
166 struct sisl_host_map *host_map; /* MC host map */
167 struct sisl_ctrl_map *ctrl_map; /* MC control map */
169 ctx_hndl_t ctx_hndl; /* master's context handle */
177 u32 cmd_couts; /* Number of command checkouts */
178 u32 internal_lun; /* User-desired LUN mode for this AFU */
181 u64 interface_version;
183 struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */
187 static inline u64 lun_to_lunid(u64 lun)
191 int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
192 return swab64(lun_id);
195 int cxlflash_send_cmd(struct afu *, struct afu_cmd *);
196 void cxlflash_wait_resp(struct afu *, struct afu_cmd *);
197 int cxlflash_afu_reset(struct cxlflash_cfg *);
198 struct afu_cmd *cxlflash_cmd_checkout(struct afu *);
199 void cxlflash_cmd_checkin(struct afu_cmd *);
200 int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8);
201 void cxlflash_list_init(void);
202 void cxlflash_term_global_luns(void);
203 void cxlflash_free_errpage(void);
204 int cxlflash_ioctl(struct scsi_device *, int, void __user *);
205 void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *);
206 int cxlflash_mark_contexts_error(struct cxlflash_cfg *);
207 void cxlflash_term_local_luns(struct cxlflash_cfg *);
208 void cxlflash_restore_luntable(struct cxlflash_cfg *);
210 #endif /* ifndef _CXLFLASH_COMMON_H */