Commit | Line | Data |
---|---|---|
c21e0bbf 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_COMMON_H | |
16 | #define _CXLFLASH_COMMON_H | |
17 | ||
18 | #include <linux/list.h> | |
0a27ae51 | 19 | #include <linux/rwsem.h> |
c21e0bbf MO |
20 | #include <linux/types.h> |
21 | #include <scsi/scsi.h> | |
22 | #include <scsi/scsi_device.h> | |
23 | ||
17ead26f | 24 | extern const struct file_operations cxlflash_cxl_fops; |
c21e0bbf MO |
25 | |
26 | #define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */ | |
27 | ||
28 | #define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */ | |
29 | #define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */ | |
30 | #define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants | |
31 | max_sectors | |
32 | in units of | |
33 | 512 byte | |
34 | sectors | |
35 | */ | |
36 | ||
c21e0bbf MO |
37 | #define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry)) |
38 | ||
39 | /* AFU command retry limit */ | |
40 | #define MC_RETRY_CNT 5 /* sufficient for SCSI check and | |
41 | certain AFU errors */ | |
42 | ||
43 | /* Command management definitions */ | |
44 | #define CXLFLASH_NUM_CMDS (2 * CXLFLASH_MAX_CMDS) /* Must be a pow2 for | |
45 | alignment and more | |
46 | efficient array | |
47 | index derivation | |
48 | */ | |
49 | ||
83430833 | 50 | #define CXLFLASH_MAX_CMDS 256 |
c21e0bbf MO |
51 | #define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS |
52 | ||
83430833 MK |
53 | /* RRQ for master issued cmds */ |
54 | #define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS | |
55 | ||
c21e0bbf MO |
56 | |
57 | static inline void check_sizes(void) | |
58 | { | |
59 | BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS); | |
60 | } | |
61 | ||
62 | /* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */ | |
63 | #define CMD_BUFSIZE SIZE_4K | |
64 | ||
65 | /* flags in IOA status area for host use */ | |
66 | #define B_DONE 0x01 | |
67 | #define B_ERROR 0x02 /* set with B_DONE */ | |
68 | #define B_TIMEOUT 0x04 /* set with B_DONE & B_ERROR */ | |
69 | ||
70 | enum cxlflash_lr_state { | |
71 | LINK_RESET_INVALID, | |
72 | LINK_RESET_REQUIRED, | |
73 | LINK_RESET_COMPLETE | |
74 | }; | |
75 | ||
76 | enum cxlflash_init_state { | |
77 | INIT_STATE_NONE, | |
78 | INIT_STATE_PCI, | |
79 | INIT_STATE_AFU, | |
80 | INIT_STATE_SCSI | |
81 | }; | |
82 | ||
5cdac81a MO |
83 | enum cxlflash_state { |
84 | STATE_NORMAL, /* Normal running state, everything good */ | |
439e85c1 | 85 | STATE_RESET, /* Reset state, trying to reset/recover */ |
5cdac81a MO |
86 | STATE_FAILTERM /* Failed/terminating state, error out users/threads */ |
87 | }; | |
88 | ||
c21e0bbf MO |
89 | /* |
90 | * Each context has its own set of resource handles that is visible | |
91 | * only from that context. | |
92 | */ | |
93 | ||
94 | struct cxlflash_cfg { | |
95 | struct afu *afu; | |
96 | struct cxl_context *mcctx; | |
97 | ||
98 | struct pci_dev *dev; | |
99 | struct pci_device_id *dev_id; | |
100 | struct Scsi_Host *host; | |
101 | ||
102 | ulong cxlflash_regs_pci; | |
103 | ||
c21e0bbf MO |
104 | struct work_struct work_q; |
105 | enum cxlflash_init_state init_state; | |
106 | enum cxlflash_lr_state lr_state; | |
107 | int lr_port; | |
ef51074a | 108 | atomic_t scan_host_needed; |
c21e0bbf MO |
109 | |
110 | struct cxl_afu *cxl_afu; | |
c21e0bbf | 111 | |
65be2c79 MO |
112 | atomic_t recovery_threads; |
113 | struct mutex ctx_recovery_mutex; | |
114 | struct mutex ctx_tbl_list_mutex; | |
0a27ae51 | 115 | struct rw_semaphore ioctl_rwsem; |
65be2c79 MO |
116 | struct ctx_info *ctx_tbl[MAX_CONTEXT]; |
117 | struct list_head ctx_err_recovery; /* contexts w/ recovery pending */ | |
118 | struct file_operations cxl_fops; | |
119 | ||
2cb79266 MO |
120 | /* Parameters that are LUN table related */ |
121 | int last_lun_index[CXLFLASH_NUM_FC_PORTS]; | |
122 | int promote_lun_index; | |
65be2c79 MO |
123 | struct list_head lluns; /* list of llun_info structs */ |
124 | ||
c21e0bbf | 125 | wait_queue_head_t tmf_waitq; |
018d1dc9 | 126 | spinlock_t tmf_slock; |
c21e0bbf | 127 | bool tmf_active; |
439e85c1 | 128 | wait_queue_head_t reset_waitq; |
5cdac81a | 129 | enum cxlflash_state state; |
c21e0bbf MO |
130 | }; |
131 | ||
132 | struct afu_cmd { | |
133 | struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */ | |
134 | struct sisl_ioasa sa; /* IOASA must follow IOARCB */ | |
135 | spinlock_t slock; | |
136 | struct completion cevent; | |
c21e0bbf MO |
137 | struct afu *parent; |
138 | int slot; | |
139 | atomic_t free; | |
140 | ||
141 | u8 cmd_tmf:1; | |
142 | ||
143 | /* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned. | |
144 | * However for performance reasons the IOARCB/IOASA should be | |
145 | * cache line aligned. | |
146 | */ | |
147 | } __aligned(cache_line_size()); | |
148 | ||
149 | struct afu { | |
150 | /* Stuff requiring alignment go first. */ | |
151 | ||
83430833 | 152 | u64 rrq_entry[NUM_RRQ_ENTRY]; /* 2K RRQ */ |
c21e0bbf MO |
153 | /* |
154 | * Command & data for AFU commands. | |
155 | */ | |
156 | struct afu_cmd cmd[CXLFLASH_NUM_CMDS]; | |
157 | ||
158 | /* Beware of alignment till here. Preferably introduce new | |
159 | * fields after this point | |
160 | */ | |
161 | ||
162 | /* AFU HW */ | |
163 | struct cxl_ioctl_start_work work; | |
1786f4a0 MO |
164 | struct cxlflash_afu_map __iomem *afu_map; /* entire MMIO map */ |
165 | struct sisl_host_map __iomem *host_map; /* MC host map */ | |
166 | struct sisl_ctrl_map __iomem *ctrl_map; /* MC control map */ | |
c21e0bbf | 167 | |
b45cdbaf MK |
168 | struct kref mapcount; |
169 | ||
c21e0bbf MO |
170 | ctx_hndl_t ctx_hndl; /* master's context handle */ |
171 | u64 *hrrq_start; | |
172 | u64 *hrrq_end; | |
173 | u64 *hrrq_curr; | |
174 | bool toggle; | |
11f7b184 UK |
175 | s64 room; |
176 | spinlock_t rrin_slock; /* Lock to rrin queuing and cmd_room updates */ | |
c21e0bbf MO |
177 | u64 hb; |
178 | u32 cmd_couts; /* Number of command checkouts */ | |
179 | u32 internal_lun; /* User-desired LUN mode for this AFU */ | |
180 | ||
e5ce067b | 181 | char version[16]; |
c21e0bbf MO |
182 | u64 interface_version; |
183 | ||
184 | struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */ | |
185 | ||
186 | }; | |
187 | ||
188 | static inline u64 lun_to_lunid(u64 lun) | |
189 | { | |
1786f4a0 | 190 | __be64 lun_id; |
c21e0bbf MO |
191 | |
192 | int_to_scsilun(lun, (struct scsi_lun *)&lun_id); | |
1786f4a0 | 193 | return be64_to_cpu(lun_id); |
c21e0bbf MO |
194 | } |
195 | ||
c21e0bbf | 196 | int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8); |
65be2c79 MO |
197 | void cxlflash_list_init(void); |
198 | void cxlflash_term_global_luns(void); | |
199 | void cxlflash_free_errpage(void); | |
200 | int cxlflash_ioctl(struct scsi_device *, int, void __user *); | |
201 | void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *); | |
202 | int cxlflash_mark_contexts_error(struct cxlflash_cfg *); | |
203 | void cxlflash_term_local_luns(struct cxlflash_cfg *); | |
2cb79266 | 204 | void cxlflash_restore_luntable(struct cxlflash_cfg *); |
65be2c79 | 205 | |
c21e0bbf | 206 | #endif /* ifndef _CXLFLASH_COMMON_H */ |