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