Commit | Line | Data |
---|---|---|
41fa2ada | 1 | /* |
553448f6 | 2 | * zfcp device driver |
1da177e4 | 3 | * |
553448f6 | 4 | * Global definitions for the zfcp device driver. |
41fa2ada | 5 | * |
a2fa0aed | 6 | * Copyright IBM Corporation 2002, 2009 |
41fa2ada | 7 | */ |
1da177e4 | 8 | |
1da177e4 LT |
9 | #ifndef ZFCP_DEF_H |
10 | #define ZFCP_DEF_H | |
11 | ||
1da177e4 LT |
12 | /*************************** INCLUDES *****************************************/ |
13 | ||
14 | #include <linux/init.h> | |
15 | #include <linux/moduleparam.h> | |
1da177e4 LT |
16 | #include <linux/major.h> |
17 | #include <linux/blkdev.h> | |
18 | #include <linux/delay.h> | |
19 | #include <linux/timer.h> | |
dd52e0ea HC |
20 | #include <linux/slab.h> |
21 | #include <linux/mempool.h> | |
22 | #include <linux/syscalls.h> | |
f1346372 | 23 | #include <linux/scatterlist.h> |
dd52e0ea | 24 | #include <linux/ioctl.h> |
9d544f2b SS |
25 | #include <scsi/fc/fc_fs.h> |
26 | #include <scsi/fc/fc_gs.h> | |
1da177e4 LT |
27 | #include <scsi/scsi.h> |
28 | #include <scsi/scsi_tcq.h> | |
29 | #include <scsi/scsi_cmnd.h> | |
30 | #include <scsi/scsi_device.h> | |
31 | #include <scsi/scsi_host.h> | |
32 | #include <scsi/scsi_transport.h> | |
33 | #include <scsi/scsi_transport_fc.h> | |
9d544f2b | 34 | #include <scsi/scsi_bsg_fc.h> |
1da177e4 LT |
35 | #include <asm/ccwdev.h> |
36 | #include <asm/qdio.h> | |
37 | #include <asm/debug.h> | |
38 | #include <asm/ebcdic.h> | |
bd43a42b | 39 | #include <asm/sysinfo.h> |
dd52e0ea | 40 | #include "zfcp_fsf.h" |
1da177e4 | 41 | |
1da177e4 LT |
42 | /********************* GENERAL DEFINES *********************************/ |
43 | ||
06506d00 | 44 | #define REQUEST_LIST_SIZE 128 |
1da177e4 | 45 | |
06506d00 | 46 | /********************* SCSI SPECIFIC DEFINES *********************************/ |
f6c0e7a7 | 47 | #define ZFCP_SCSI_ER_TIMEOUT (10*HZ) |
1da177e4 LT |
48 | |
49 | /********************* CIO/QDIO SPECIFIC DEFINES *****************************/ | |
50 | ||
1da177e4 LT |
51 | /* DMQ bug workaround: don't use last SBALE */ |
52 | #define ZFCP_MAX_SBALES_PER_SBAL (QDIO_MAX_ELEMENTS_PER_BUFFER - 1) | |
53 | ||
54 | /* index of last SBALE (with respect to DMQ bug workaround) */ | |
55 | #define ZFCP_LAST_SBALE_PER_SBAL (ZFCP_MAX_SBALES_PER_SBAL - 1) | |
56 | ||
57 | /* max. number of (data buffer) SBALEs in largest SBAL chain */ | |
58 | #define ZFCP_MAX_SBALES_PER_REQ \ | |
c41f8cbd | 59 | (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2) |
1da177e4 LT |
60 | /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */ |
61 | ||
8d1a0060 SS |
62 | #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8) |
63 | /* max. number of (data buffer) SBALEs in largest SBAL chain | |
64 | multiplied with number of sectors per 4k block */ | |
65 | ||
1da177e4 LT |
66 | /********************* FSF SPECIFIC DEFINES *********************************/ |
67 | ||
1da177e4 LT |
68 | /* ATTENTION: value must not be used by hardware */ |
69 | #define FSF_QTCB_UNSOLICITED_STATUS 0x6305 | |
22753fa5 | 70 | |
1da177e4 | 71 | /* timeout value for "default timer" for fsf requests */ |
2abbe866 | 72 | #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ) |
1da177e4 | 73 | |
1da177e4 LT |
74 | /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/ |
75 | ||
41fa2ada SS |
76 | /* |
77 | * Note, the leftmost status byte is common among adapter, port | |
1da177e4 LT |
78 | * and unit |
79 | */ | |
80 | #define ZFCP_COMMON_FLAGS 0xfff00000 | |
1da177e4 LT |
81 | |
82 | /* common status bits */ | |
1da177e4 LT |
83 | #define ZFCP_STATUS_COMMON_RUNNING 0x40000000 |
84 | #define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000 | |
85 | #define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000 | |
1da177e4 | 86 | #define ZFCP_STATUS_COMMON_OPEN 0x04000000 |
1da177e4 LT |
87 | #define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000 |
88 | #define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000 | |
d736a27b | 89 | #define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000 |
cc8c2829 | 90 | #define ZFCP_STATUS_COMMON_NOESC 0x00200000 |
1da177e4 LT |
91 | |
92 | /* adapter status */ | |
93 | #define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002 | |
1da177e4 LT |
94 | #define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008 |
95 | #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010 | |
1da177e4 LT |
96 | #define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100 |
97 | #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200 | |
98 | ||
1da177e4 LT |
99 | /* remote port status */ |
100 | #define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001 | |
14e242ea | 101 | #define ZFCP_STATUS_PORT_LINK_TEST 0x00000002 |
1da177e4 | 102 | |
1da177e4 | 103 | /* logical unit status */ |
1da177e4 LT |
104 | #define ZFCP_STATUS_UNIT_SHARED 0x00000004 |
105 | #define ZFCP_STATUS_UNIT_READONLY 0x00000008 | |
106 | ||
107 | /* FSF request status (this does not have a common part) */ | |
1da177e4 | 108 | #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002 |
1da177e4 LT |
109 | #define ZFCP_STATUS_FSFREQ_ERROR 0x00000008 |
110 | #define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010 | |
1da177e4 LT |
111 | #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040 |
112 | #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080 | |
113 | #define ZFCP_STATUS_FSFREQ_ABORTED 0x00000100 | |
114 | #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200 | |
115 | #define ZFCP_STATUS_FSFREQ_TMFUNCNOTSUPP 0x00000400 | |
116 | #define ZFCP_STATUS_FSFREQ_RETRY 0x00000800 | |
117 | #define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000 | |
118 | ||
1da177e4 LT |
119 | /************************* STRUCTURE DEFINITIONS *****************************/ |
120 | ||
121 | struct zfcp_fsf_req; | |
122 | ||
123 | /* holds various memory pools of an adapter */ | |
124 | struct zfcp_adapter_mempool { | |
a4623c46 | 125 | mempool_t *erp_req; |
799b76d0 | 126 | mempool_t *gid_pn_req; |
a4623c46 SS |
127 | mempool_t *scsi_req; |
128 | mempool_t *scsi_abort; | |
129 | mempool_t *status_read_req; | |
130 | mempool_t *status_read_data; | |
dbf5dfe9 | 131 | mempool_t *gid_pn; |
a4623c46 | 132 | mempool_t *qtcb_pool; |
1da177e4 LT |
133 | }; |
134 | ||
1da177e4 | 135 | struct zfcp_qdio_queue { |
0406289e CS |
136 | struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q]; |
137 | u8 first; /* index of next free bfr in queue */ | |
138 | atomic_t count; /* number of free buffers in queue */ | |
1da177e4 LT |
139 | }; |
140 | ||
141 | struct zfcp_erp_action { | |
142 | struct list_head list; | |
143 | int action; /* requested action code */ | |
144 | struct zfcp_adapter *adapter; /* device which should be recovered */ | |
145 | struct zfcp_port *port; | |
146 | struct zfcp_unit *unit; | |
44cc76f2 | 147 | u32 status; /* recovery status */ |
1da177e4 LT |
148 | u32 step; /* active step of this erp action */ |
149 | struct zfcp_fsf_req *fsf_req; /* fsf request currently pending | |
150 | for this action */ | |
151 | struct timer_list timer; | |
152 | }; | |
153 | ||
c9615858 CS |
154 | struct fsf_latency_record { |
155 | u32 min; | |
156 | u32 max; | |
157 | u64 sum; | |
158 | }; | |
159 | ||
160 | struct latency_cont { | |
161 | struct fsf_latency_record channel; | |
162 | struct fsf_latency_record fabric; | |
163 | u64 counter; | |
164 | }; | |
165 | ||
166 | struct zfcp_latencies { | |
167 | struct latency_cont read; | |
168 | struct latency_cont write; | |
169 | struct latency_cont cmd; | |
170 | spinlock_t lock; | |
171 | }; | |
1da177e4 | 172 | |
564e1c86 SS |
173 | /** struct zfcp_qdio - basic QDIO data structure |
174 | * @resp_q: response queue | |
175 | * @req_q: request queue | |
176 | * @stat_lock: lock to protect req_q_util and req_q_time | |
177 | * @req_q_lock; lock to serialize access to request queue | |
178 | * @req_q_time: time of last fill level change | |
179 | * @req_q_util: used for accounting | |
180 | * @req_q_full: queue full incidents | |
181 | * @req_q_wq: used to wait for SBAL availability | |
182 | * @adapter: adapter used in conjunction with this QDIO structure | |
183 | */ | |
184 | struct zfcp_qdio { | |
185 | struct zfcp_qdio_queue resp_q; | |
186 | struct zfcp_qdio_queue req_q; | |
187 | spinlock_t stat_lock; | |
188 | spinlock_t req_q_lock; | |
41e05a12 | 189 | unsigned long long req_q_time; |
564e1c86 SS |
190 | u64 req_q_util; |
191 | atomic_t req_q_full; | |
192 | wait_queue_head_t req_q_wq; | |
193 | struct zfcp_adapter *adapter; | |
194 | }; | |
195 | ||
1da177e4 | 196 | struct zfcp_adapter { |
f3450c7b | 197 | struct kref ref; |
7ba58c9c SS |
198 | u64 peer_wwnn; /* P2P peer WWNN */ |
199 | u64 peer_wwpn; /* P2P peer WWPN */ | |
13e1e1f0 | 200 | u32 peer_d_id; /* P2P peer D_ID */ |
1da177e4 | 201 | struct ccw_device *ccw_device; /* S/390 ccw device */ |
564e1c86 | 202 | struct zfcp_qdio *qdio; |
1da177e4 LT |
203 | u32 hydra_version; /* Hydra version */ |
204 | u32 fsf_lic_version; | |
aef4a983 MS |
205 | u32 adapter_features; /* FCP channel features */ |
206 | u32 connection_features; /* host connection features */ | |
1da177e4 | 207 | u32 hardware_version; /* of FCP channel */ |
c9615858 | 208 | u16 timer_ticks; /* time int for a tick */ |
1da177e4 | 209 | struct Scsi_Host *scsi_host; /* Pointer to mid-layer */ |
ecf0c772 SS |
210 | struct list_head port_list; /* remote port list */ |
211 | rwlock_t port_list_lock; /* port list lock */ | |
fea9d6c7 VS |
212 | unsigned long req_no; /* unique FSF req number */ |
213 | struct list_head *req_list; /* list of pending reqs */ | |
214 | spinlock_t req_list_lock; /* request list lock */ | |
1da177e4 | 215 | u32 fsf_req_seq_no; /* FSF cmnd seq number */ |
1da177e4 LT |
216 | rwlock_t abort_lock; /* Protects against SCSI |
217 | stack abort/command | |
218 | completion races */ | |
d26ab06e SS |
219 | atomic_t stat_miss; /* # missing status reads*/ |
220 | struct work_struct stat_work; | |
1da177e4 LT |
221 | atomic_t status; /* status of this adapter */ |
222 | struct list_head erp_ready_head; /* error recovery for this | |
223 | adapter/devices */ | |
347c6a96 | 224 | wait_queue_head_t erp_ready_wq; |
1da177e4 LT |
225 | struct list_head erp_running_head; |
226 | rwlock_t erp_lock; | |
1da177e4 LT |
227 | wait_queue_head_t erp_done_wqh; |
228 | struct zfcp_erp_action erp_action; /* pending error recovery */ | |
229 | atomic_t erp_counter; | |
230 | u32 erp_total_count; /* total nr of enqueued erp | |
231 | actions */ | |
232 | u32 erp_low_mem_count; /* nr of erp actions waiting | |
233 | for memory */ | |
347c6a96 | 234 | struct task_struct *erp_thread; |
bd0072ec | 235 | struct zfcp_fc_wka_ports *gs; /* generic services */ |
d46f384a | 236 | struct zfcp_dbf *dbf; /* debug traces */ |
1da177e4 | 237 | struct zfcp_adapter_mempool pool; /* Adapter memory pools */ |
f6cd94b1 AH |
238 | struct fc_host_statistics *fc_stats; |
239 | struct fsf_qtcb_bottom_port *stats_reset_data; | |
240 | unsigned long stats_reset; | |
cc8c2829 | 241 | struct work_struct scan_work; |
bd43a42b | 242 | struct service_level service_level; |
4544683a | 243 | struct workqueue_struct *work_queue; |
1da177e4 LT |
244 | }; |
245 | ||
1da177e4 LT |
246 | struct zfcp_port { |
247 | struct device sysfs_device; /* sysfs device */ | |
3859f6a2 | 248 | struct fc_rport *rport; /* rport of fc transport class */ |
1da177e4 | 249 | struct list_head list; /* list of remote ports */ |
1da177e4 | 250 | struct zfcp_adapter *adapter; /* adapter used to access port */ |
ecf0c772 SS |
251 | struct list_head unit_list; /* head of logical unit list */ |
252 | rwlock_t unit_list_lock; /* unit list lock */ | |
1da177e4 | 253 | atomic_t status; /* status of this remote port */ |
7ba58c9c SS |
254 | u64 wwnn; /* WWNN if known */ |
255 | u64 wwpn; /* WWPN */ | |
13e1e1f0 | 256 | u32 d_id; /* D_ID */ |
1da177e4 LT |
257 | u32 handle; /* handle assigned by FSF */ |
258 | struct zfcp_erp_action erp_action; /* pending error recovery */ | |
259 | atomic_t erp_counter; | |
75bfc283 RW |
260 | u32 maxframe_size; |
261 | u32 supported_classes; | |
5ab944f9 | 262 | struct work_struct gid_pn_work; |
8fdf30d5 | 263 | struct work_struct test_link_work; |
a2fa0aed CS |
264 | struct work_struct rport_work; |
265 | enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task; | |
1da177e4 LT |
266 | }; |
267 | ||
1da177e4 LT |
268 | struct zfcp_unit { |
269 | struct device sysfs_device; /* sysfs device */ | |
270 | struct list_head list; /* list of logical units */ | |
1da177e4 LT |
271 | struct zfcp_port *port; /* remote port of unit */ |
272 | atomic_t status; /* status of this logical unit */ | |
7ba58c9c | 273 | u64 fcp_lun; /* own FCP_LUN */ |
1da177e4 LT |
274 | u32 handle; /* handle assigned by FSF */ |
275 | struct scsi_device *device; /* scsi device struct pointer */ | |
276 | struct zfcp_erp_action erp_action; /* pending error recovery */ | |
277 | atomic_t erp_counter; | |
c9615858 | 278 | struct zfcp_latencies latencies; |
92d5193b | 279 | struct work_struct scsi_work; |
1da177e4 LT |
280 | }; |
281 | ||
42428f74 SS |
282 | /** |
283 | * struct zfcp_queue_req - queue related values for a request | |
284 | * @sbal_number: number of free SBALs | |
285 | * @sbal_first: first SBAL for this request | |
286 | * @sbal_last: last SBAL for this request | |
287 | * @sbal_limit: last possible SBAL for this request | |
288 | * @sbale_curr: current SBALE at creation of this request | |
289 | * @sbal_response: SBAL used in interrupt | |
290 | * @qdio_outb_usage: usage of outbound queue | |
291 | * @qdio_inb_usage: usage of inbound queue | |
292 | */ | |
293 | struct zfcp_queue_req { | |
294 | u8 sbal_number; | |
295 | u8 sbal_first; | |
296 | u8 sbal_last; | |
297 | u8 sbal_limit; | |
298 | u8 sbale_curr; | |
299 | u8 sbal_response; | |
300 | u16 qdio_outb_usage; | |
301 | u16 qdio_inb_usage; | |
302 | }; | |
303 | ||
304 | /** | |
305 | * struct zfcp_fsf_req - basic FSF request structure | |
306 | * @list: list of FSF requests | |
307 | * @req_id: unique request ID | |
308 | * @adapter: adapter this request belongs to | |
309 | * @queue_req: queue related values | |
310 | * @completion: used to signal the completion of the request | |
311 | * @status: status of the request | |
312 | * @fsf_command: FSF command issued | |
313 | * @qtcb: associated QTCB | |
314 | * @seq_no: sequence number of this request | |
315 | * @data: private data | |
316 | * @timer: timer data of this request | |
317 | * @erp_action: reference to erp action if request issued on behalf of ERP | |
318 | * @pool: reference to memory pool if used for this request | |
319 | * @issued: time when request was send (STCK) | |
320 | * @unit: reference to unit if this request is a SCSI request | |
321 | * @handler: handler which should be called to process response | |
322 | */ | |
1da177e4 | 323 | struct zfcp_fsf_req { |
42428f74 SS |
324 | struct list_head list; |
325 | unsigned long req_id; | |
326 | struct zfcp_adapter *adapter; | |
327 | struct zfcp_queue_req queue_req; | |
328 | struct completion completion; | |
329 | u32 status; | |
330 | u32 fsf_command; | |
331 | struct fsf_qtcb *qtcb; | |
332 | u32 seq_no; | |
333 | void *data; | |
334 | struct timer_list timer; | |
335 | struct zfcp_erp_action *erp_action; | |
336 | mempool_t *pool; | |
337 | unsigned long long issued; | |
338 | struct zfcp_unit *unit; | |
c41f8cbd | 339 | void (*handler)(struct zfcp_fsf_req *); |
1da177e4 LT |
340 | }; |
341 | ||
1da177e4 LT |
342 | /* driver data */ |
343 | struct zfcp_data { | |
344 | struct scsi_host_template scsi_host_template; | |
dd52e0ea | 345 | struct scsi_transport_template *scsi_transport_template; |
a4623c46 SS |
346 | struct kmem_cache *gpn_ft_cache; |
347 | struct kmem_cache *qtcb_cache; | |
7ba58c9c SS |
348 | struct kmem_cache *sr_buffer_cache; |
349 | struct kmem_cache *gid_pn_cache; | |
1da177e4 LT |
350 | }; |
351 | ||
1da177e4 LT |
352 | /********************** ZFCP SPECIFIC DEFINES ********************************/ |
353 | ||
1da177e4 LT |
354 | #define ZFCP_SET 0x00000100 |
355 | #define ZFCP_CLEAR 0x00000200 | |
356 | ||
ca2d02c2 HC |
357 | /* |
358 | * Helper functions for request ID management. | |
359 | */ | |
360 | static inline int zfcp_reqlist_hash(unsigned long req_id) | |
361 | { | |
362 | return req_id % REQUEST_LIST_SIZE; | |
363 | } | |
364 | ||
ca2d02c2 HC |
365 | static inline void zfcp_reqlist_remove(struct zfcp_adapter *adapter, |
366 | struct zfcp_fsf_req *fsf_req) | |
367 | { | |
368 | list_del(&fsf_req->list); | |
369 | } | |
370 | ||
371 | static inline struct zfcp_fsf_req * | |
372 | zfcp_reqlist_find(struct zfcp_adapter *adapter, unsigned long req_id) | |
373 | { | |
374 | struct zfcp_fsf_req *request; | |
375 | unsigned int idx; | |
376 | ||
377 | idx = zfcp_reqlist_hash(req_id); | |
378 | list_for_each_entry(request, &adapter->req_list[idx], list) | |
379 | if (request->req_id == req_id) | |
380 | return request; | |
381 | return NULL; | |
382 | } | |
383 | ||
d1ad09db HC |
384 | static inline struct zfcp_fsf_req * |
385 | zfcp_reqlist_find_safe(struct zfcp_adapter *adapter, struct zfcp_fsf_req *req) | |
386 | { | |
387 | struct zfcp_fsf_req *request; | |
388 | unsigned int idx; | |
389 | ||
390 | for (idx = 0; idx < REQUEST_LIST_SIZE; idx++) { | |
391 | list_for_each_entry(request, &adapter->req_list[idx], list) | |
392 | if (request == req) | |
393 | return request; | |
394 | } | |
395 | return NULL; | |
396 | } | |
397 | ||
1da177e4 | 398 | #endif /* ZFCP_DEF_H */ |