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