]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
41fa2ada | 2 | /* |
553448f6 | 3 | * zfcp device driver |
1da177e4 | 4 | * |
553448f6 | 5 | * Global definitions for the zfcp device driver. |
41fa2ada | 6 | * |
a53c8fab | 7 | * Copyright IBM Corp. 2002, 2010 |
41fa2ada | 8 | */ |
1da177e4 | 9 | |
1da177e4 LT |
10 | #ifndef ZFCP_DEF_H |
11 | #define ZFCP_DEF_H | |
12 | ||
1da177e4 LT |
13 | /*************************** INCLUDES *****************************************/ |
14 | ||
15 | #include <linux/init.h> | |
16 | #include <linux/moduleparam.h> | |
1da177e4 LT |
17 | #include <linux/major.h> |
18 | #include <linux/blkdev.h> | |
19 | #include <linux/delay.h> | |
20 | #include <linux/timer.h> | |
dd52e0ea HC |
21 | #include <linux/slab.h> |
22 | #include <linux/mempool.h> | |
23 | #include <linux/syscalls.h> | |
f1346372 | 24 | #include <linux/scatterlist.h> |
dd52e0ea | 25 | #include <linux/ioctl.h> |
9d544f2b SS |
26 | #include <scsi/fc/fc_fs.h> |
27 | #include <scsi/fc/fc_gs.h> | |
1da177e4 LT |
28 | #include <scsi/scsi.h> |
29 | #include <scsi/scsi_tcq.h> | |
30 | #include <scsi/scsi_cmnd.h> | |
31 | #include <scsi/scsi_device.h> | |
32 | #include <scsi/scsi_host.h> | |
33 | #include <scsi/scsi_transport.h> | |
34 | #include <scsi/scsi_transport_fc.h> | |
9d544f2b | 35 | #include <scsi/scsi_bsg_fc.h> |
1da177e4 | 36 | #include <asm/ccwdev.h> |
1da177e4 LT |
37 | #include <asm/debug.h> |
38 | #include <asm/ebcdic.h> | |
bd43a42b | 39 | #include <asm/sysinfo.h> |
dd52e0ea | 40 | #include "zfcp_fsf.h" |
2d1e547f | 41 | #include "zfcp_fc.h" |
34c2b712 | 42 | #include "zfcp_qdio.h" |
1da177e4 | 43 | |
b6bd2fb9 | 44 | struct zfcp_reqlist; |
1da177e4 | 45 | |
06506d00 | 46 | /********************* SCSI SPECIFIC DEFINES *********************************/ |
f6c0e7a7 | 47 | #define ZFCP_SCSI_ER_TIMEOUT (10*HZ) |
1da177e4 | 48 | |
1da177e4 LT |
49 | /********************* FSF SPECIFIC DEFINES *********************************/ |
50 | ||
1da177e4 LT |
51 | /* ATTENTION: value must not be used by hardware */ |
52 | #define FSF_QTCB_UNSOLICITED_STATUS 0x6305 | |
22753fa5 | 53 | |
1da177e4 | 54 | /* timeout value for "default timer" for fsf requests */ |
2abbe866 | 55 | #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ) |
1da177e4 | 56 | |
1da177e4 LT |
57 | /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/ |
58 | ||
41fa2ada SS |
59 | /* |
60 | * Note, the leftmost status byte is common among adapter, port | |
1da177e4 LT |
61 | * and unit |
62 | */ | |
63 | #define ZFCP_COMMON_FLAGS 0xfff00000 | |
1da177e4 LT |
64 | |
65 | /* common status bits */ | |
1da177e4 LT |
66 | #define ZFCP_STATUS_COMMON_RUNNING 0x40000000 |
67 | #define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000 | |
68 | #define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000 | |
1da177e4 | 69 | #define ZFCP_STATUS_COMMON_OPEN 0x04000000 |
1da177e4 LT |
70 | #define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000 |
71 | #define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000 | |
d736a27b | 72 | #define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000 |
cc8c2829 | 73 | #define ZFCP_STATUS_COMMON_NOESC 0x00200000 |
1da177e4 LT |
74 | |
75 | /* adapter status */ | |
86a9668a | 76 | #define ZFCP_STATUS_ADAPTER_MB_ACT 0x00000001 |
1da177e4 | 77 | #define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002 |
339f4f4e | 78 | #define ZFCP_STATUS_ADAPTER_SIOSL_ISSUED 0x00000004 |
1da177e4 LT |
79 | #define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008 |
80 | #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010 | |
cb452149 | 81 | #define ZFCP_STATUS_ADAPTER_SUSPENDED 0x00000040 |
1da177e4 LT |
82 | #define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100 |
83 | #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200 | |
dcc18f48 | 84 | #define ZFCP_STATUS_ADAPTER_DATA_DIV_ENABLED 0x00000400 |
1da177e4 | 85 | |
1da177e4 LT |
86 | /* remote port status */ |
87 | #define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001 | |
14e242ea | 88 | #define ZFCP_STATUS_PORT_LINK_TEST 0x00000002 |
1da177e4 | 89 | |
1da177e4 | 90 | /* FSF request status (this does not have a common part) */ |
1da177e4 LT |
91 | #define ZFCP_STATUS_FSFREQ_ERROR 0x00000008 |
92 | #define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010 | |
1da177e4 LT |
93 | #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040 |
94 | #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080 | |
1da177e4 | 95 | #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200 |
1da177e4 LT |
96 | #define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000 |
97 | ||
1da177e4 LT |
98 | /************************* STRUCTURE DEFINITIONS *****************************/ |
99 | ||
100 | struct zfcp_fsf_req; | |
101 | ||
102 | /* holds various memory pools of an adapter */ | |
103 | struct zfcp_adapter_mempool { | |
a4623c46 | 104 | mempool_t *erp_req; |
799b76d0 | 105 | mempool_t *gid_pn_req; |
a4623c46 SS |
106 | mempool_t *scsi_req; |
107 | mempool_t *scsi_abort; | |
108 | mempool_t *status_read_req; | |
c7b279ae | 109 | mempool_t *sr_data; |
dbf5dfe9 | 110 | mempool_t *gid_pn; |
a4623c46 | 111 | mempool_t *qtcb_pool; |
1da177e4 LT |
112 | }; |
113 | ||
1da177e4 LT |
114 | struct zfcp_erp_action { |
115 | struct list_head list; | |
116 | int action; /* requested action code */ | |
117 | struct zfcp_adapter *adapter; /* device which should be recovered */ | |
118 | struct zfcp_port *port; | |
b62a8d9b | 119 | struct scsi_device *sdev; |
44cc76f2 | 120 | u32 status; /* recovery status */ |
1da177e4 | 121 | u32 step; /* active step of this erp action */ |
e60a6d69 | 122 | unsigned long fsf_req_id; |
1da177e4 LT |
123 | struct timer_list timer; |
124 | }; | |
125 | ||
c9615858 CS |
126 | struct fsf_latency_record { |
127 | u32 min; | |
128 | u32 max; | |
129 | u64 sum; | |
130 | }; | |
131 | ||
132 | struct latency_cont { | |
133 | struct fsf_latency_record channel; | |
134 | struct fsf_latency_record fabric; | |
135 | u64 counter; | |
136 | }; | |
137 | ||
138 | struct zfcp_latencies { | |
139 | struct latency_cont read; | |
140 | struct latency_cont write; | |
141 | struct latency_cont cmd; | |
142 | spinlock_t lock; | |
143 | }; | |
1da177e4 LT |
144 | |
145 | struct zfcp_adapter { | |
f3450c7b | 146 | struct kref ref; |
7ba58c9c SS |
147 | u64 peer_wwnn; /* P2P peer WWNN */ |
148 | u64 peer_wwpn; /* P2P peer WWPN */ | |
13e1e1f0 | 149 | u32 peer_d_id; /* P2P peer D_ID */ |
1da177e4 | 150 | struct ccw_device *ccw_device; /* S/390 ccw device */ |
564e1c86 | 151 | struct zfcp_qdio *qdio; |
1da177e4 LT |
152 | u32 hydra_version; /* Hydra version */ |
153 | u32 fsf_lic_version; | |
aef4a983 MS |
154 | u32 adapter_features; /* FCP channel features */ |
155 | u32 connection_features; /* host connection features */ | |
1da177e4 | 156 | u32 hardware_version; /* of FCP channel */ |
c9615858 | 157 | u16 timer_ticks; /* time int for a tick */ |
1da177e4 | 158 | struct Scsi_Host *scsi_host; /* Pointer to mid-layer */ |
ecf0c772 SS |
159 | struct list_head port_list; /* remote port list */ |
160 | rwlock_t port_list_lock; /* port list lock */ | |
fea9d6c7 | 161 | unsigned long req_no; /* unique FSF req number */ |
b6bd2fb9 | 162 | struct zfcp_reqlist *req_list; |
1da177e4 | 163 | u32 fsf_req_seq_no; /* FSF cmnd seq number */ |
1da177e4 LT |
164 | rwlock_t abort_lock; /* Protects against SCSI |
165 | stack abort/command | |
166 | completion races */ | |
d26ab06e | 167 | atomic_t stat_miss; /* # missing status reads*/ |
64deb6ef | 168 | unsigned int stat_read_buf_num; |
d26ab06e | 169 | struct work_struct stat_work; |
1da177e4 LT |
170 | atomic_t status; /* status of this adapter */ |
171 | struct list_head erp_ready_head; /* error recovery for this | |
172 | adapter/devices */ | |
347c6a96 | 173 | wait_queue_head_t erp_ready_wq; |
1da177e4 LT |
174 | struct list_head erp_running_head; |
175 | rwlock_t erp_lock; | |
1da177e4 LT |
176 | wait_queue_head_t erp_done_wqh; |
177 | struct zfcp_erp_action erp_action; /* pending error recovery */ | |
178 | atomic_t erp_counter; | |
179 | u32 erp_total_count; /* total nr of enqueued erp | |
180 | actions */ | |
181 | u32 erp_low_mem_count; /* nr of erp actions waiting | |
182 | for memory */ | |
347c6a96 | 183 | struct task_struct *erp_thread; |
bd0072ec | 184 | struct zfcp_fc_wka_ports *gs; /* generic services */ |
d46f384a | 185 | struct zfcp_dbf *dbf; /* debug traces */ |
1da177e4 | 186 | struct zfcp_adapter_mempool pool; /* Adapter memory pools */ |
f6cd94b1 AH |
187 | struct fc_host_statistics *fc_stats; |
188 | struct fsf_qtcb_bottom_port *stats_reset_data; | |
189 | unsigned long stats_reset; | |
18f87a67 | 190 | struct delayed_work scan_work; |
038d9446 | 191 | struct work_struct ns_up_work; |
bd43a42b | 192 | struct service_level service_level; |
4544683a | 193 | struct workqueue_struct *work_queue; |
68322984 | 194 | struct device_dma_parameters dma_parms; |
2d1e547f | 195 | struct zfcp_fc_events events; |
18f87a67 | 196 | unsigned long next_port_scan; |
1da177e4 LT |
197 | }; |
198 | ||
1da177e4 | 199 | struct zfcp_port { |
615f59e0 | 200 | struct device dev; |
3859f6a2 | 201 | struct fc_rport *rport; /* rport of fc transport class */ |
1da177e4 | 202 | struct list_head list; /* list of remote ports */ |
1da177e4 | 203 | struct zfcp_adapter *adapter; /* adapter used to access port */ |
ecf0c772 SS |
204 | struct list_head unit_list; /* head of logical unit list */ |
205 | rwlock_t unit_list_lock; /* unit list lock */ | |
d99b601b | 206 | atomic_t units; /* zfcp_unit count */ |
1da177e4 | 207 | atomic_t status; /* status of this remote port */ |
7ba58c9c SS |
208 | u64 wwnn; /* WWNN if known */ |
209 | u64 wwpn; /* WWPN */ | |
13e1e1f0 | 210 | u32 d_id; /* D_ID */ |
1da177e4 LT |
211 | u32 handle; /* handle assigned by FSF */ |
212 | struct zfcp_erp_action erp_action; /* pending error recovery */ | |
213 | atomic_t erp_counter; | |
75bfc283 RW |
214 | u32 maxframe_size; |
215 | u32 supported_classes; | |
5ab944f9 | 216 | struct work_struct gid_pn_work; |
8fdf30d5 | 217 | struct work_struct test_link_work; |
a2fa0aed CS |
218 | struct work_struct rport_work; |
219 | enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task; | |
1bf3ff02 | 220 | unsigned int starget_id; |
1da177e4 LT |
221 | }; |
222 | ||
b62a8d9b CS |
223 | /** |
224 | * struct zfcp_unit - LUN configured via zfcp sysfs | |
225 | * @dev: struct device for sysfs representation and reference counting | |
226 | * @list: entry in LUN/unit list per zfcp_port | |
227 | * @port: reference to zfcp_port where this LUN is configured | |
228 | * @fcp_lun: 64 bit LUN value | |
229 | * @scsi_work: for running scsi_scan_target | |
230 | * | |
231 | * This is the representation of a LUN that has been configured for | |
232 | * usage. The main data here is the 64 bit LUN value, data for | |
233 | * running I/O and recovery is in struct zfcp_scsi_dev. | |
234 | */ | |
1da177e4 | 235 | struct zfcp_unit { |
b62a8d9b CS |
236 | struct device dev; |
237 | struct list_head list; | |
238 | struct zfcp_port *port; | |
239 | u64 fcp_lun; | |
92d5193b | 240 | struct work_struct scsi_work; |
1da177e4 LT |
241 | }; |
242 | ||
57c23773 CS |
243 | /** |
244 | * struct zfcp_scsi_dev - zfcp data per SCSI device | |
245 | * @status: zfcp internal status flags | |
246 | * @lun_handle: handle from "open lun" for issuing FSF requests | |
247 | * @erp_action: zfcp erp data for opening and recovering this LUN | |
248 | * @erp_counter: zfcp erp counter for this LUN | |
249 | * @latencies: FSF channel and fabric latencies | |
250 | * @port: zfcp_port where this LUN belongs to | |
251 | */ | |
252 | struct zfcp_scsi_dev { | |
253 | atomic_t status; | |
254 | u32 lun_handle; | |
255 | struct zfcp_erp_action erp_action; | |
256 | atomic_t erp_counter; | |
257 | struct zfcp_latencies latencies; | |
258 | struct zfcp_port *port; | |
259 | }; | |
260 | ||
261 | /** | |
262 | * sdev_to_zfcp - Access zfcp LUN data for SCSI device | |
263 | * @sdev: scsi_device where to get the zfcp_scsi_dev pointer | |
264 | */ | |
265 | static inline struct zfcp_scsi_dev *sdev_to_zfcp(struct scsi_device *sdev) | |
266 | { | |
267 | return scsi_transport_device_data(sdev); | |
268 | } | |
269 | ||
270 | /** | |
271 | * zfcp_scsi_dev_lun - Return SCSI device LUN as 64 bit FCP LUN | |
272 | * @sdev: SCSI device where to get the LUN from | |
273 | */ | |
274 | static inline u64 zfcp_scsi_dev_lun(struct scsi_device *sdev) | |
275 | { | |
276 | u64 fcp_lun; | |
277 | ||
278 | int_to_scsilun(sdev->lun, (struct scsi_lun *)&fcp_lun); | |
279 | return fcp_lun; | |
280 | } | |
281 | ||
42428f74 SS |
282 | /** |
283 | * struct zfcp_fsf_req - basic FSF request structure | |
284 | * @list: list of FSF requests | |
285 | * @req_id: unique request ID | |
286 | * @adapter: adapter this request belongs to | |
34c2b712 | 287 | * @qdio_req: qdio queue related values |
42428f74 SS |
288 | * @completion: used to signal the completion of the request |
289 | * @status: status of the request | |
290 | * @fsf_command: FSF command issued | |
291 | * @qtcb: associated QTCB | |
292 | * @seq_no: sequence number of this request | |
293 | * @data: private data | |
294 | * @timer: timer data of this request | |
295 | * @erp_action: reference to erp action if request issued on behalf of ERP | |
296 | * @pool: reference to memory pool if used for this request | |
297 | * @issued: time when request was send (STCK) | |
42428f74 SS |
298 | * @handler: handler which should be called to process response |
299 | */ | |
1da177e4 | 300 | struct zfcp_fsf_req { |
42428f74 SS |
301 | struct list_head list; |
302 | unsigned long req_id; | |
303 | struct zfcp_adapter *adapter; | |
34c2b712 | 304 | struct zfcp_qdio_req qdio_req; |
42428f74 SS |
305 | struct completion completion; |
306 | u32 status; | |
307 | u32 fsf_command; | |
308 | struct fsf_qtcb *qtcb; | |
309 | u32 seq_no; | |
310 | void *data; | |
311 | struct timer_list timer; | |
312 | struct zfcp_erp_action *erp_action; | |
313 | mempool_t *pool; | |
314 | unsigned long long issued; | |
c41f8cbd | 315 | void (*handler)(struct zfcp_fsf_req *); |
1da177e4 LT |
316 | }; |
317 | ||
86a9668a SS |
318 | static inline |
319 | int zfcp_adapter_multi_buffer_active(struct zfcp_adapter *adapter) | |
320 | { | |
321 | return atomic_read(&adapter->status) & ZFCP_STATUS_ADAPTER_MB_ACT; | |
322 | } | |
323 | ||
1da177e4 | 324 | #endif /* ZFCP_DEF_H */ |