blob: ed5d921e82cd18448a09a16a502724eae4f6ac76 [file] [log] [blame]
Swen Schillig41fa2ad2007-09-07 09:15:31 +02001/*
Christof Schmitt553448f2008-06-10 18:20:58 +02002 * zfcp device driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Christof Schmitt553448f2008-06-10 18:20:58 +02004 * Global definitions for the zfcp device driver.
Swen Schillig41fa2ad2007-09-07 09:15:31 +02005 *
Christof Schmitt615f59e2010-02-17 11:18:56 +01006 * Copyright IBM Corporation 2002, 2010
Swen Schillig41fa2ad2007-09-07 09:15:31 +02007 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#ifndef ZFCP_DEF_H
10#define ZFCP_DEF_H
11
Linus Torvalds1da177e2005-04-16 15:20:36 -070012/*************************** INCLUDES *****************************************/
13
14#include <linux/init.h>
15#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/major.h>
17#include <linux/blkdev.h>
18#include <linux/delay.h>
19#include <linux/timer.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020020#include <linux/slab.h>
21#include <linux/mempool.h>
22#include <linux/syscalls.h>
FUJITA Tomonorif1346372007-07-30 23:01:32 +090023#include <linux/scatterlist.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020024#include <linux/ioctl.h>
Sven Schuetz9d544f22009-04-06 18:31:47 +020025#include <scsi/fc/fc_fs.h>
26#include <scsi/fc/fc_gs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#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>
Sven Schuetz9d544f22009-04-06 18:31:47 +020034#include <scsi/scsi_bsg_fc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <asm/ccwdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/debug.h>
37#include <asm/ebcdic.h>
Christof Schmittbd43a42b72008-12-25 13:38:50 +010038#include <asm/sysinfo.h>
Heiko Carstensdd52e0e2006-09-18 22:28:49 +020039#include "zfcp_fsf.h"
Sven Schuetz2d1e5472010-07-16 15:37:39 +020040#include "zfcp_fc.h"
Christof Schmitt34c2b712010-02-17 11:18:59 +010041#include "zfcp_qdio.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Christof Schmittb6bd2fb2010-02-17 11:18:50 +010043struct zfcp_reqlist;
Andreas Herrmann06506d02006-05-22 18:18:19 +020044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045/********************* SCSI SPECIFIC DEFINES *********************************/
Andreas Herrmannf6c0e7a2006-08-02 11:05:52 +020046#define ZFCP_SCSI_ER_TIMEOUT (10*HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Linus Torvalds1da177e2005-04-16 15:20:36 -070048/********************* FSF SPECIFIC DEFINES *********************************/
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/* ATTENTION: value must not be used by hardware */
51#define FSF_QTCB_UNSOLICITED_STATUS 0x6305
Andreas Herrmann22753fa2005-06-13 13:15:15 +020052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053/* timeout value for "default timer" for fsf requests */
Andreas Herrmann2abbe862006-09-18 22:29:56 +020054#define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
57
Swen Schillig41fa2ad2007-09-07 09:15:31 +020058/*
59 * Note, the leftmost status byte is common among adapter, port
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * and unit
61 */
62#define ZFCP_COMMON_FLAGS 0xfff00000
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64/* common status bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#define ZFCP_STATUS_COMMON_RUNNING 0x40000000
66#define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000
67#define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#define ZFCP_STATUS_COMMON_OPEN 0x04000000
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000
70#define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000
Andreas Herrmannd736a27b2005-06-13 13:23:57 +020071#define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000
Swen Schilligcc8c2822008-06-10 18:21:00 +020072#define ZFCP_STATUS_COMMON_NOESC 0x00200000
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/* adapter status */
Swen Schillig86a96682011-08-15 14:40:32 +020075#define ZFCP_STATUS_ADAPTER_MB_ACT 0x00000001
Linus Torvalds1da177e2005-04-16 15:20:36 -070076#define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
Christof Schmitt339f4f42010-07-16 15:37:43 +020077#define ZFCP_STATUS_ADAPTER_SIOSL_ISSUED 0x00000004
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
79#define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
81#define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
Christof Schmittdcc18f42010-07-16 15:37:41 +020082#define ZFCP_STATUS_ADAPTER_DATA_DIV_ENABLED 0x00000400
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/* remote port status */
85#define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
Christof Schmitt14e242e2009-08-18 15:43:11 +020086#define ZFCP_STATUS_PORT_LINK_TEST 0x00000002
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/* logical unit status */
Christof Schmittb62a8d92010-09-08 14:39:55 +020089#define ZFCP_STATUS_LUN_SHARED 0x00000004
90#define ZFCP_STATUS_LUN_READONLY 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92/* FSF request status (this does not have a common part) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
94#define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
96#define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
Linus Torvalds1da177e2005-04-16 15:20:36 -070098#define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100/************************* STRUCTURE DEFINITIONS *****************************/
101
102struct zfcp_fsf_req;
103
104/* holds various memory pools of an adapter */
105struct zfcp_adapter_mempool {
Swen Schilliga4623c42009-08-18 15:43:15 +0200106 mempool_t *erp_req;
Christof Schmitt799b76d2009-08-18 15:43:20 +0200107 mempool_t *gid_pn_req;
Swen Schilliga4623c42009-08-18 15:43:15 +0200108 mempool_t *scsi_req;
109 mempool_t *scsi_abort;
110 mempool_t *status_read_req;
Christof Schmittc7b279a2011-02-22 19:54:40 +0100111 mempool_t *sr_data;
Christof Schmittdbf5dfe2009-11-24 16:54:10 +0100112 mempool_t *gid_pn;
Swen Schilliga4623c42009-08-18 15:43:15 +0200113 mempool_t *qtcb_pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114};
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116struct zfcp_erp_action {
117 struct list_head list;
118 int action; /* requested action code */
119 struct zfcp_adapter *adapter; /* device which should be recovered */
120 struct zfcp_port *port;
Christof Schmittb62a8d92010-09-08 14:39:55 +0200121 struct scsi_device *sdev;
Swen Schillig44cc76f2008-10-01 12:42:16 +0200122 u32 status; /* recovery status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 u32 step; /* active step of this erp action */
Christof Schmitte60a6d62010-02-17 11:18:49 +0100124 unsigned long fsf_req_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 struct timer_list timer;
126};
127
Christof Schmittc9615852008-05-06 11:00:05 +0200128struct fsf_latency_record {
129 u32 min;
130 u32 max;
131 u64 sum;
132};
133
134struct latency_cont {
135 struct fsf_latency_record channel;
136 struct fsf_latency_record fabric;
137 u64 counter;
138};
139
140struct zfcp_latencies {
141 struct latency_cont read;
142 struct latency_cont write;
143 struct latency_cont cmd;
144 spinlock_t lock;
145};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147struct zfcp_adapter {
Swen Schilligf3450c72009-11-24 16:53:59 +0100148 struct kref ref;
Swen Schillig7ba58c92008-10-01 12:42:18 +0200149 u64 peer_wwnn; /* P2P peer WWNN */
150 u64 peer_wwpn; /* P2P peer WWPN */
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200151 u32 peer_d_id; /* P2P peer D_ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 struct ccw_device *ccw_device; /* S/390 ccw device */
Swen Schillig564e1c82009-08-18 15:43:19 +0200153 struct zfcp_qdio *qdio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 u32 hydra_version; /* Hydra version */
155 u32 fsf_lic_version;
Maxim Shchetyninaef4a982005-09-13 21:51:16 +0200156 u32 adapter_features; /* FCP channel features */
157 u32 connection_features; /* host connection features */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 u32 hardware_version; /* of FCP channel */
Christof Schmittc9615852008-05-06 11:00:05 +0200159 u16 timer_ticks; /* time int for a tick */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */
Swen Schilligecf0c772009-11-24 16:53:58 +0100161 struct list_head port_list; /* remote port list */
162 rwlock_t port_list_lock; /* port list lock */
Volker Sameskefea9d6c2006-08-02 11:05:16 +0200163 unsigned long req_no; /* unique FSF req number */
Christof Schmittb6bd2fb2010-02-17 11:18:50 +0100164 struct zfcp_reqlist *req_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 u32 fsf_req_seq_no; /* FSF cmnd seq number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 rwlock_t abort_lock; /* Protects against SCSI
167 stack abort/command
168 completion races */
Swen Schilligd26ab062008-05-19 12:17:37 +0200169 atomic_t stat_miss; /* # missing status reads*/
Christof Schmitt64deb6e2010-04-30 18:09:36 +0200170 unsigned int stat_read_buf_num;
Swen Schilligd26ab062008-05-19 12:17:37 +0200171 struct work_struct stat_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 atomic_t status; /* status of this adapter */
173 struct list_head erp_ready_head; /* error recovery for this
174 adapter/devices */
Christof Schmitt347c6a92009-08-18 15:43:25 +0200175 wait_queue_head_t erp_ready_wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 struct list_head erp_running_head;
177 rwlock_t erp_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 wait_queue_head_t erp_done_wqh;
179 struct zfcp_erp_action erp_action; /* pending error recovery */
180 atomic_t erp_counter;
181 u32 erp_total_count; /* total nr of enqueued erp
182 actions */
183 u32 erp_low_mem_count; /* nr of erp actions waiting
184 for memory */
Christof Schmitt347c6a92009-08-18 15:43:25 +0200185 struct task_struct *erp_thread;
Christof Schmittbd0072e2009-11-24 16:54:11 +0100186 struct zfcp_fc_wka_ports *gs; /* generic services */
Christof Schmittd46f3842009-08-18 15:43:07 +0200187 struct zfcp_dbf *dbf; /* debug traces */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 struct zfcp_adapter_mempool pool; /* Adapter memory pools */
Andreas Herrmannf6cd94b2006-01-05 09:59:34 +0100189 struct fc_host_statistics *fc_stats;
190 struct fsf_qtcb_bottom_port *stats_reset_data;
191 unsigned long stats_reset;
Swen Schilligcc8c2822008-06-10 18:21:00 +0200192 struct work_struct scan_work;
Christof Schmitt038d9442011-02-22 19:54:48 +0100193 struct work_struct ns_up_work;
Christof Schmittbd43a42b72008-12-25 13:38:50 +0100194 struct service_level service_level;
Swen Schillig45446832009-08-18 15:43:17 +0200195 struct workqueue_struct *work_queue;
Christof Schmitt68322982010-04-30 18:09:33 +0200196 struct device_dma_parameters dma_parms;
Sven Schuetz2d1e5472010-07-16 15:37:39 +0200197 struct zfcp_fc_events events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198};
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200struct zfcp_port {
Christof Schmitt615f59e2010-02-17 11:18:56 +0100201 struct device dev;
Andreas Herrmann3859f6a2005-08-27 11:07:54 -0700202 struct fc_rport *rport; /* rport of fc transport class */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 struct list_head list; /* list of remote ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 struct zfcp_adapter *adapter; /* adapter used to access port */
Swen Schilligecf0c772009-11-24 16:53:58 +0100205 struct list_head unit_list; /* head of logical unit list */
206 rwlock_t unit_list_lock; /* unit list lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 atomic_t status; /* status of this remote port */
Swen Schillig7ba58c92008-10-01 12:42:18 +0200208 u64 wwnn; /* WWNN if known */
209 u64 wwpn; /* WWPN */
Andreas Herrmann13e1e1f2005-09-19 16:56:17 +0200210 u32 d_id; /* D_ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 u32 handle; /* handle assigned by FSF */
212 struct zfcp_erp_action erp_action; /* pending error recovery */
213 atomic_t erp_counter;
Ralph Wuerthner75bfc282006-05-22 18:24:33 +0200214 u32 maxframe_size;
215 u32 supported_classes;
Swen Schillig5ab944f2008-10-01 12:42:17 +0200216 struct work_struct gid_pn_work;
Christof Schmitt8fdf30d2009-03-02 13:09:01 +0100217 struct work_struct test_link_work;
Christof Schmitta2fa0ae2009-03-02 13:09:08 +0100218 struct work_struct rport_work;
219 enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task;
Christof Schmitt1bf3ff02010-07-16 15:37:35 +0200220 unsigned int starget_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221};
222
Christof Schmittb62a8d92010-09-08 14:39:55 +0200223/**
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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235struct zfcp_unit {
Christof Schmittb62a8d92010-09-08 14:39:55 +0200236 struct device dev;
237 struct list_head list;
238 struct zfcp_port *port;
239 u64 fcp_lun;
Swen Schillig92d51932009-04-17 15:08:04 +0200240 struct work_struct scsi_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241};
242
Swen Schillig42428f72009-08-18 15:43:18 +0200243/**
Christof Schmitt57c23772010-09-08 14:39:51 +0200244 * 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 */
252struct 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 */
265static 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 */
274static 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
282/**
Swen Schillig42428f72009-08-18 15:43:18 +0200283 * 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
Christof Schmitt34c2b712010-02-17 11:18:59 +0100287 * @qdio_req: qdio queue related values
Swen Schillig42428f72009-08-18 15:43:18 +0200288 * @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)
Swen Schillig42428f72009-08-18 15:43:18 +0200298 * @handler: handler which should be called to process response
299 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300struct zfcp_fsf_req {
Swen Schillig42428f72009-08-18 15:43:18 +0200301 struct list_head list;
302 unsigned long req_id;
303 struct zfcp_adapter *adapter;
Christof Schmitt34c2b712010-02-17 11:18:59 +0100304 struct zfcp_qdio_req qdio_req;
Swen Schillig42428f72009-08-18 15:43:18 +0200305 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;
Swen Schilligc41f8cb2008-07-02 10:56:39 +0200315 void (*handler)(struct zfcp_fsf_req *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316};
317
Swen Schillig86a96682011-08-15 14:40:32 +0200318static inline
319int zfcp_adapter_multi_buffer_active(struct zfcp_adapter *adapter)
320{
321 return atomic_read(&adapter->status) & ZFCP_STATUS_ADAPTER_MB_ACT;
322}
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324#endif /* ZFCP_DEF_H */