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