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 18 #include <linux/list.h> 19 #include <linux/rwsem.h> 20 #include <linux/types.h> 21 #include <scsi/scsi.h> 22 #include <scsi/scsi_cmnd.h> 23 #include <scsi/scsi_device.h> 24 25 extern const struct file_operations cxlflash_cxl_fops; 26 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 38 #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 51 #define CXLFLASH_MAX_CMDS 256 52 #define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS 53 54 /* RRQ for master issued cmds */ 55 #define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS 56 57 58 static 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 71 enum cxlflash_lr_state { 72 LINK_RESET_INVALID, 73 LINK_RESET_REQUIRED, 74 LINK_RESET_COMPLETE 75 }; 76 77 enum cxlflash_init_state { 78 INIT_STATE_NONE, 79 INIT_STATE_PCI, 80 INIT_STATE_AFU, 81 INIT_STATE_SCSI 82 }; 83 84 enum cxlflash_state { 85 STATE_NORMAL, /* Normal running state, everything good */ 86 STATE_RESET, /* Reset state, trying to reset/recover */ 87 STATE_FAILTERM /* Failed/terminating state, error out users/threads */ 88 }; 89 90 /* 91 * Each context has its own set of resource handles that is visible 92 * only from that context. 93 */ 94 95 struct 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 105 struct work_struct work_q; 106 enum cxlflash_init_state init_state; 107 enum cxlflash_lr_state lr_state; 108 int lr_port; 109 atomic_t scan_host_needed; 110 111 struct cxl_afu *cxl_afu; 112 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; 120 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 */ 125 126 wait_queue_head_t tmf_waitq; 127 spinlock_t tmf_slock; 128 bool tmf_active; 129 wait_queue_head_t reset_waitq; 130 enum cxlflash_state state; 131 }; 132 133 struct 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; 138 struct afu *parent; 139 140 u8 cmd_tmf:1; 141 142 /* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned. 143 * However for performance reasons the IOARCB/IOASA should be 144 * cache line aligned. 145 */ 146 } __aligned(cache_line_size()); 147 148 static inline struct afu_cmd *sc_to_afuc(struct scsi_cmnd *sc) 149 { 150 return PTR_ALIGN(scsi_cmd_priv(sc), __alignof__(struct afu_cmd)); 151 } 152 153 static inline struct afu_cmd *sc_to_afucz(struct scsi_cmnd *sc) 154 { 155 struct afu_cmd *afuc = sc_to_afuc(sc); 156 157 memset(afuc, 0, sizeof(*afuc)); 158 return afuc; 159 } 160 161 struct afu { 162 /* Stuff requiring alignment go first. */ 163 164 u64 rrq_entry[NUM_RRQ_ENTRY]; /* 2K RRQ */ 165 166 /* Beware of alignment till here. Preferably introduce new 167 * fields after this point 168 */ 169 170 /* AFU HW */ 171 struct cxl_ioctl_start_work work; 172 struct cxlflash_afu_map __iomem *afu_map; /* entire MMIO map */ 173 struct sisl_host_map __iomem *host_map; /* MC host map */ 174 struct sisl_ctrl_map __iomem *ctrl_map; /* MC control map */ 175 176 struct kref mapcount; 177 178 ctx_hndl_t ctx_hndl; /* master's context handle */ 179 u64 *hrrq_start; 180 u64 *hrrq_end; 181 u64 *hrrq_curr; 182 bool toggle; 183 atomic_t cmds_active; /* Number of currently active AFU commands */ 184 s64 room; 185 spinlock_t rrin_slock; /* Lock to rrin queuing and cmd_room updates */ 186 u64 hb; 187 u32 internal_lun; /* User-desired LUN mode for this AFU */ 188 189 char version[16]; 190 u64 interface_version; 191 192 struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */ 193 194 }; 195 196 static inline u64 lun_to_lunid(u64 lun) 197 { 198 __be64 lun_id; 199 200 int_to_scsilun(lun, (struct scsi_lun *)&lun_id); 201 return be64_to_cpu(lun_id); 202 } 203 204 int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8); 205 void cxlflash_list_init(void); 206 void cxlflash_term_global_luns(void); 207 void cxlflash_free_errpage(void); 208 int cxlflash_ioctl(struct scsi_device *, int, void __user *); 209 void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *); 210 int cxlflash_mark_contexts_error(struct cxlflash_cfg *); 211 void cxlflash_term_local_luns(struct cxlflash_cfg *); 212 void cxlflash_restore_luntable(struct cxlflash_cfg *); 213 214 #endif /* ifndef _CXLFLASH_COMMON_H */ 215