Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 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 | |
Manoj Kumar | 471a5a6 | 2015-10-21 15:11:10 -0500 | [diff] [blame] | 31 | #define CMD_TIMEOUT 30 /* 30 secs */ |
Manoj Kumar | 3ebf203 | 2015-10-21 15:11:00 -0500 | [diff] [blame] | 32 | #define CMD_RETRIES 5 /* 5 retries for scsi_execute */ |
| 33 | |
| 34 | #define MAX_SECTOR_UNIT 512 /* max_sector is in 512 byte multiples */ |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 35 | |
| 36 | #define CHAN2PORT(_x) ((_x) + 1) |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 37 | #define PORT2CHAN(_x) ((_x) - 1) |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 38 | |
| 39 | enum lun_mode { |
| 40 | MODE_NONE = 0, |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 41 | MODE_VIRTUAL, |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 42 | MODE_PHYSICAL |
| 43 | }; |
| 44 | |
| 45 | /* Global (entire driver, spans adapters) lun_info structure */ |
| 46 | struct glun_info { |
| 47 | u64 max_lba; /* from read cap(16) */ |
| 48 | u32 blk_len; /* from read cap(16) */ |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 49 | enum lun_mode mode; /* NONE, VIRTUAL, PHYSICAL */ |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 50 | int users; /* Number of users w/ references to LUN */ |
| 51 | |
| 52 | u8 wwid[16]; |
| 53 | |
| 54 | struct mutex mutex; |
| 55 | |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 56 | struct blka blka; |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 57 | struct list_head list; |
| 58 | }; |
| 59 | |
| 60 | /* Local (per-adapter) lun_info structure */ |
| 61 | struct llun_info { |
| 62 | u64 lun_id[CXLFLASH_NUM_FC_PORTS]; /* from REPORT_LUNS */ |
| 63 | u32 lun_index; /* Index in the LUN table */ |
| 64 | u32 host_no; /* host_no from Scsi_host */ |
| 65 | u32 port_sel; /* What port to use for this LUN */ |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 66 | bool in_table; /* Whether a LUN table entry was created */ |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 67 | |
| 68 | u8 wwid[16]; /* Keep a duplicate copy here? */ |
| 69 | |
| 70 | struct glun_info *parent; /* Pointer to entry in global LUN structure */ |
| 71 | struct scsi_device *sdev; |
| 72 | struct list_head list; |
| 73 | }; |
| 74 | |
| 75 | struct lun_access { |
| 76 | struct llun_info *lli; |
| 77 | struct scsi_device *sdev; |
| 78 | struct list_head list; |
| 79 | }; |
| 80 | |
| 81 | enum ctx_ctrl { |
| 82 | CTX_CTRL_CLONE = (1 << 1), |
| 83 | CTX_CTRL_ERR = (1 << 2), |
| 84 | CTX_CTRL_ERR_FALLBACK = (1 << 3), |
| 85 | CTX_CTRL_NOPID = (1 << 4), |
| 86 | CTX_CTRL_FILE = (1 << 5) |
| 87 | }; |
| 88 | |
Matthew R. Ochs | a76df36 | 2015-10-21 15:11:43 -0500 | [diff] [blame] | 89 | #define ENCODE_CTXID(_ctx, _id) (((((u64)_ctx) & 0xFFFFFFFF0ULL) << 28) | _id) |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 90 | #define DECODE_CTXID(_val) (_val & 0xFFFFFFFF) |
| 91 | |
| 92 | struct ctx_info { |
Matthew R. Ochs | 1786f4a | 2015-10-21 15:14:48 -0500 | [diff] [blame] | 93 | struct sisl_ctrl_map __iomem *ctrl_map; /* initialized at startup */ |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 94 | struct sisl_rht_entry *rht_start; /* 1 page (req'd for alignment), |
| 95 | alloc/free on attach/detach */ |
| 96 | u32 rht_out; /* Number of checked out RHT entries */ |
| 97 | u32 rht_perms; /* User-defined permissions for RHT entries */ |
| 98 | struct llun_info **rht_lun; /* Mapping of RHT entries to LUNs */ |
Matthew R. Ochs | e568e23 | 2015-10-21 15:11:34 -0500 | [diff] [blame] | 99 | u8 *rht_needs_ws; /* User-desired write-same function per RHTE */ |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 100 | |
| 101 | struct cxl_ioctl_start_work work; |
| 102 | u64 ctxid; |
| 103 | int lfd; |
| 104 | pid_t pid; |
| 105 | bool unavail; |
| 106 | bool err_recovery_active; |
| 107 | struct mutex mutex; /* Context protection */ |
| 108 | struct cxl_context *ctx; |
| 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 | |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 121 | int cxlflash_vlun_resize(struct scsi_device *, struct dk_cxlflash_resize *); |
| 122 | int _cxlflash_vlun_resize(struct scsi_device *, struct ctx_info *, |
| 123 | struct dk_cxlflash_resize *); |
| 124 | |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 125 | int cxlflash_disk_release(struct scsi_device *, struct dk_cxlflash_release *); |
| 126 | int _cxlflash_disk_release(struct scsi_device *, struct ctx_info *, |
| 127 | struct dk_cxlflash_release *); |
| 128 | |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 129 | int cxlflash_disk_clone(struct scsi_device *, struct dk_cxlflash_clone *); |
| 130 | |
| 131 | int cxlflash_disk_virtual_open(struct scsi_device *, void *); |
| 132 | |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 133 | int cxlflash_lun_attach(struct glun_info *, enum lun_mode, bool); |
| 134 | void cxlflash_lun_detach(struct glun_info *); |
| 135 | |
| 136 | struct ctx_info *get_context(struct cxlflash_cfg *, u64, void *, enum ctx_ctrl); |
| 137 | void put_context(struct ctx_info *); |
| 138 | |
| 139 | struct sisl_rht_entry *get_rhte(struct ctx_info *, res_hndl_t, |
| 140 | struct llun_info *); |
| 141 | |
| 142 | struct sisl_rht_entry *rhte_checkout(struct ctx_info *, struct llun_info *); |
| 143 | void rhte_checkin(struct ctx_info *, struct sisl_rht_entry *); |
| 144 | |
Matthew R. Ochs | 2cb7926 | 2015-08-13 21:47:53 -0500 | [diff] [blame] | 145 | void cxlflash_ba_terminate(struct ba_lun *); |
| 146 | |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 147 | int cxlflash_manage_lun(struct scsi_device *, struct dk_cxlflash_manage_lun *); |
| 148 | |
Matthew R. Ochs | aacb4ff | 2015-10-21 15:15:52 -0500 | [diff] [blame] | 149 | int check_state(struct cxlflash_cfg *); |
| 150 | |
Matthew R. Ochs | 65be2c7 | 2015-08-13 21:47:43 -0500 | [diff] [blame] | 151 | #endif /* ifndef _CXLFLASH_SUPERPIPE_H */ |