Commit | Line | Data |
---|---|---|
65be2c79 MO |
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 MC_DISCOVERY_TIMEOUT 5 /* 5 secs */ | |
32 | ||
33 | #define CHAN2PORT(_x) ((_x) + 1) | |
2cb79266 | 34 | #define PORT2CHAN(_x) ((_x) - 1) |
65be2c79 MO |
35 | |
36 | enum lun_mode { | |
37 | MODE_NONE = 0, | |
2cb79266 | 38 | MODE_VIRTUAL, |
65be2c79 MO |
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) */ | |
2cb79266 | 46 | enum lun_mode mode; /* NONE, VIRTUAL, PHYSICAL */ |
65be2c79 MO |
47 | int users; /* Number of users w/ references to LUN */ |
48 | ||
49 | u8 wwid[16]; | |
50 | ||
51 | struct mutex mutex; | |
52 | ||
2cb79266 | 53 | struct blka blka; |
65be2c79 MO |
54 | struct list_head list; |
55 | }; | |
56 | ||
57 | /* Local (per-adapter) lun_info structure */ | |
58 | struct llun_info { | |
59 | u64 lun_id[CXLFLASH_NUM_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 newly_created; /* Whether the LUN was just discovered */ | |
2cb79266 | 64 | bool in_table; /* Whether a LUN table entry was created */ |
65be2c79 MO |
65 | |
66 | u8 wwid[16]; /* Keep a duplicate copy here? */ | |
67 | ||
68 | struct glun_info *parent; /* Pointer to entry in global LUN structure */ | |
69 | struct scsi_device *sdev; | |
70 | struct list_head list; | |
71 | }; | |
72 | ||
73 | struct lun_access { | |
74 | struct llun_info *lli; | |
75 | struct scsi_device *sdev; | |
76 | struct list_head list; | |
77 | }; | |
78 | ||
79 | enum ctx_ctrl { | |
80 | CTX_CTRL_CLONE = (1 << 1), | |
81 | CTX_CTRL_ERR = (1 << 2), | |
82 | CTX_CTRL_ERR_FALLBACK = (1 << 3), | |
83 | CTX_CTRL_NOPID = (1 << 4), | |
84 | CTX_CTRL_FILE = (1 << 5) | |
85 | }; | |
86 | ||
87 | #define ENCODE_CTXID(_ctx, _id) (((((u64)_ctx) & 0xFFFFFFFF0) << 28) | _id) | |
88 | #define DECODE_CTXID(_val) (_val & 0xFFFFFFFF) | |
89 | ||
90 | struct ctx_info { | |
91 | struct sisl_ctrl_map *ctrl_map; /* initialized at startup */ | |
92 | struct sisl_rht_entry *rht_start; /* 1 page (req'd for alignment), | |
93 | alloc/free on attach/detach */ | |
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 */ | |
2cb79266 | 97 | bool *rht_needs_ws; /* User-desired write-same function per RHTE */ |
65be2c79 MO |
98 | |
99 | struct cxl_ioctl_start_work work; | |
100 | u64 ctxid; | |
101 | int lfd; | |
102 | pid_t pid; | |
103 | bool unavail; | |
104 | bool err_recovery_active; | |
105 | struct mutex mutex; /* Context protection */ | |
106 | struct cxl_context *ctx; | |
107 | struct list_head luns; /* LUNs attached to this context */ | |
108 | const struct vm_operations_struct *cxl_mmap_vmops; | |
109 | struct file *file; | |
110 | struct list_head list; /* Link contexts in error recovery */ | |
111 | }; | |
112 | ||
113 | struct cxlflash_global { | |
114 | struct mutex mutex; | |
115 | struct list_head gluns;/* list of glun_info structs */ | |
116 | struct page *err_page; /* One page of all 0xF for error notification */ | |
117 | }; | |
118 | ||
2cb79266 MO |
119 | int cxlflash_vlun_resize(struct scsi_device *, struct dk_cxlflash_resize *); |
120 | int _cxlflash_vlun_resize(struct scsi_device *, struct ctx_info *, | |
121 | struct dk_cxlflash_resize *); | |
122 | ||
65be2c79 MO |
123 | int cxlflash_disk_release(struct scsi_device *, struct dk_cxlflash_release *); |
124 | int _cxlflash_disk_release(struct scsi_device *, struct ctx_info *, | |
125 | struct dk_cxlflash_release *); | |
126 | ||
2cb79266 MO |
127 | int cxlflash_disk_clone(struct scsi_device *, struct dk_cxlflash_clone *); |
128 | ||
129 | int cxlflash_disk_virtual_open(struct scsi_device *, void *); | |
130 | ||
65be2c79 MO |
131 | int cxlflash_lun_attach(struct glun_info *, enum lun_mode, bool); |
132 | void cxlflash_lun_detach(struct glun_info *); | |
133 | ||
134 | struct ctx_info *get_context(struct cxlflash_cfg *, u64, void *, enum ctx_ctrl); | |
135 | void put_context(struct ctx_info *); | |
136 | ||
137 | struct sisl_rht_entry *get_rhte(struct ctx_info *, res_hndl_t, | |
138 | struct llun_info *); | |
139 | ||
140 | struct sisl_rht_entry *rhte_checkout(struct ctx_info *, struct llun_info *); | |
141 | void rhte_checkin(struct ctx_info *, struct sisl_rht_entry *); | |
142 | ||
2cb79266 MO |
143 | void cxlflash_ba_terminate(struct ba_lun *); |
144 | ||
65be2c79 MO |
145 | int cxlflash_manage_lun(struct scsi_device *, struct dk_cxlflash_manage_lun *); |
146 | ||
147 | #endif /* ifndef _CXLFLASH_SUPERPIPE_H */ |