1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * CXL Flash Device Driver 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation 6*4882a593Smuzhiyun * Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation 7*4882a593Smuzhiyun * 8*4882a593Smuzhiyun * Copyright (C) 2015 IBM Corporation 9*4882a593Smuzhiyun */ 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun #ifndef _CXLFLASH_SUPERPIPE_H 12*4882a593Smuzhiyun #define _CXLFLASH_SUPERPIPE_H 13*4882a593Smuzhiyun 14*4882a593Smuzhiyun extern struct cxlflash_global global; 15*4882a593Smuzhiyun 16*4882a593Smuzhiyun /* 17*4882a593Smuzhiyun * Terminology: use afu (and not adapter) to refer to the HW. 18*4882a593Smuzhiyun * Adapter is the entire slot and includes PSL out of which 19*4882a593Smuzhiyun * only the AFU is visible to user space. 20*4882a593Smuzhiyun */ 21*4882a593Smuzhiyun 22*4882a593Smuzhiyun /* Chunk size parms: note sislite minimum chunk size is 23*4882a593Smuzhiyun * 0x10000 LBAs corresponding to a NMASK or 16. 24*4882a593Smuzhiyun */ 25*4882a593Smuzhiyun #define MC_CHUNK_SIZE (1 << MC_RHT_NMASK) /* in LBAs */ 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun #define CMD_TIMEOUT 30 /* 30 secs */ 28*4882a593Smuzhiyun #define CMD_RETRIES 5 /* 5 retries for scsi_execute */ 29*4882a593Smuzhiyun 30*4882a593Smuzhiyun #define MAX_SECTOR_UNIT 512 /* max_sector is in 512 byte multiples */ 31*4882a593Smuzhiyun 32*4882a593Smuzhiyun enum lun_mode { 33*4882a593Smuzhiyun MODE_NONE = 0, 34*4882a593Smuzhiyun MODE_VIRTUAL, 35*4882a593Smuzhiyun MODE_PHYSICAL 36*4882a593Smuzhiyun }; 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun /* Global (entire driver, spans adapters) lun_info structure */ 39*4882a593Smuzhiyun struct glun_info { 40*4882a593Smuzhiyun u64 max_lba; /* from read cap(16) */ 41*4882a593Smuzhiyun u32 blk_len; /* from read cap(16) */ 42*4882a593Smuzhiyun enum lun_mode mode; /* NONE, VIRTUAL, PHYSICAL */ 43*4882a593Smuzhiyun int users; /* Number of users w/ references to LUN */ 44*4882a593Smuzhiyun 45*4882a593Smuzhiyun u8 wwid[16]; 46*4882a593Smuzhiyun 47*4882a593Smuzhiyun struct mutex mutex; 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun struct blka blka; 50*4882a593Smuzhiyun struct list_head list; 51*4882a593Smuzhiyun }; 52*4882a593Smuzhiyun 53*4882a593Smuzhiyun /* Local (per-adapter) lun_info structure */ 54*4882a593Smuzhiyun struct llun_info { 55*4882a593Smuzhiyun u64 lun_id[MAX_FC_PORTS]; /* from REPORT_LUNS */ 56*4882a593Smuzhiyun u32 lun_index; /* Index in the LUN table */ 57*4882a593Smuzhiyun u32 host_no; /* host_no from Scsi_host */ 58*4882a593Smuzhiyun u32 port_sel; /* What port to use for this LUN */ 59*4882a593Smuzhiyun bool in_table; /* Whether a LUN table entry was created */ 60*4882a593Smuzhiyun 61*4882a593Smuzhiyun u8 wwid[16]; /* Keep a duplicate copy here? */ 62*4882a593Smuzhiyun 63*4882a593Smuzhiyun struct glun_info *parent; /* Pointer to entry in global LUN structure */ 64*4882a593Smuzhiyun struct scsi_device *sdev; 65*4882a593Smuzhiyun struct list_head list; 66*4882a593Smuzhiyun }; 67*4882a593Smuzhiyun 68*4882a593Smuzhiyun struct lun_access { 69*4882a593Smuzhiyun struct llun_info *lli; 70*4882a593Smuzhiyun struct scsi_device *sdev; 71*4882a593Smuzhiyun struct list_head list; 72*4882a593Smuzhiyun }; 73*4882a593Smuzhiyun 74*4882a593Smuzhiyun enum ctx_ctrl { 75*4882a593Smuzhiyun CTX_CTRL_CLONE = (1 << 1), 76*4882a593Smuzhiyun CTX_CTRL_ERR = (1 << 2), 77*4882a593Smuzhiyun CTX_CTRL_ERR_FALLBACK = (1 << 3), 78*4882a593Smuzhiyun CTX_CTRL_NOPID = (1 << 4), 79*4882a593Smuzhiyun CTX_CTRL_FILE = (1 << 5) 80*4882a593Smuzhiyun }; 81*4882a593Smuzhiyun 82*4882a593Smuzhiyun #define ENCODE_CTXID(_ctx, _id) (((((u64)_ctx) & 0xFFFFFFFF0ULL) << 28) | _id) 83*4882a593Smuzhiyun #define DECODE_CTXID(_val) (_val & 0xFFFFFFFF) 84*4882a593Smuzhiyun 85*4882a593Smuzhiyun struct ctx_info { 86*4882a593Smuzhiyun struct sisl_ctrl_map __iomem *ctrl_map; /* initialized at startup */ 87*4882a593Smuzhiyun struct sisl_rht_entry *rht_start; /* 1 page (req'd for alignment), 88*4882a593Smuzhiyun * alloc/free on attach/detach 89*4882a593Smuzhiyun */ 90*4882a593Smuzhiyun u32 rht_out; /* Number of checked out RHT entries */ 91*4882a593Smuzhiyun u32 rht_perms; /* User-defined permissions for RHT entries */ 92*4882a593Smuzhiyun struct llun_info **rht_lun; /* Mapping of RHT entries to LUNs */ 93*4882a593Smuzhiyun u8 *rht_needs_ws; /* User-desired write-same function per RHTE */ 94*4882a593Smuzhiyun 95*4882a593Smuzhiyun u64 ctxid; 96*4882a593Smuzhiyun u64 irqs; /* Number of interrupts requested for context */ 97*4882a593Smuzhiyun pid_t pid; 98*4882a593Smuzhiyun bool initialized; 99*4882a593Smuzhiyun bool unavail; 100*4882a593Smuzhiyun bool err_recovery_active; 101*4882a593Smuzhiyun struct mutex mutex; /* Context protection */ 102*4882a593Smuzhiyun struct kref kref; 103*4882a593Smuzhiyun void *ctx; 104*4882a593Smuzhiyun struct cxlflash_cfg *cfg; 105*4882a593Smuzhiyun struct list_head luns; /* LUNs attached to this context */ 106*4882a593Smuzhiyun const struct vm_operations_struct *cxl_mmap_vmops; 107*4882a593Smuzhiyun struct file *file; 108*4882a593Smuzhiyun struct list_head list; /* Link contexts in error recovery */ 109*4882a593Smuzhiyun }; 110*4882a593Smuzhiyun 111*4882a593Smuzhiyun struct cxlflash_global { 112*4882a593Smuzhiyun struct mutex mutex; 113*4882a593Smuzhiyun struct list_head gluns;/* list of glun_info structs */ 114*4882a593Smuzhiyun struct page *err_page; /* One page of all 0xF for error notification */ 115*4882a593Smuzhiyun }; 116*4882a593Smuzhiyun 117*4882a593Smuzhiyun int cxlflash_vlun_resize(struct scsi_device *sdev, 118*4882a593Smuzhiyun struct dk_cxlflash_resize *resize); 119*4882a593Smuzhiyun int _cxlflash_vlun_resize(struct scsi_device *sdev, struct ctx_info *ctxi, 120*4882a593Smuzhiyun struct dk_cxlflash_resize *resize); 121*4882a593Smuzhiyun 122*4882a593Smuzhiyun int cxlflash_disk_release(struct scsi_device *sdev, 123*4882a593Smuzhiyun struct dk_cxlflash_release *release); 124*4882a593Smuzhiyun int _cxlflash_disk_release(struct scsi_device *sdev, struct ctx_info *ctxi, 125*4882a593Smuzhiyun struct dk_cxlflash_release *release); 126*4882a593Smuzhiyun 127*4882a593Smuzhiyun int cxlflash_disk_clone(struct scsi_device *sdev, 128*4882a593Smuzhiyun struct dk_cxlflash_clone *clone); 129*4882a593Smuzhiyun 130*4882a593Smuzhiyun int cxlflash_disk_virtual_open(struct scsi_device *sdev, void *arg); 131*4882a593Smuzhiyun 132*4882a593Smuzhiyun int cxlflash_lun_attach(struct glun_info *gli, enum lun_mode mode, bool locked); 133*4882a593Smuzhiyun void cxlflash_lun_detach(struct glun_info *gli); 134*4882a593Smuzhiyun 135*4882a593Smuzhiyun struct ctx_info *get_context(struct cxlflash_cfg *cfg, u64 rctxit, void *arg, 136*4882a593Smuzhiyun enum ctx_ctrl ctrl); 137*4882a593Smuzhiyun void put_context(struct ctx_info *ctxi); 138*4882a593Smuzhiyun 139*4882a593Smuzhiyun struct sisl_rht_entry *get_rhte(struct ctx_info *ctxi, res_hndl_t rhndl, 140*4882a593Smuzhiyun struct llun_info *lli); 141*4882a593Smuzhiyun 142*4882a593Smuzhiyun struct sisl_rht_entry *rhte_checkout(struct ctx_info *ctxi, 143*4882a593Smuzhiyun struct llun_info *lli); 144*4882a593Smuzhiyun void rhte_checkin(struct ctx_info *ctxi, struct sisl_rht_entry *rhte); 145*4882a593Smuzhiyun 146*4882a593Smuzhiyun void cxlflash_ba_terminate(struct ba_lun *ba_lun); 147*4882a593Smuzhiyun 148*4882a593Smuzhiyun int cxlflash_manage_lun(struct scsi_device *sdev, 149*4882a593Smuzhiyun struct dk_cxlflash_manage_lun *manage); 150*4882a593Smuzhiyun 151*4882a593Smuzhiyun int check_state(struct cxlflash_cfg *cfg); 152*4882a593Smuzhiyun 153*4882a593Smuzhiyun #endif /* ifndef _CXLFLASH_SUPERPIPE_H */ 154