Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc-2.6
[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_qdio.h"
41
42 struct zfcp_reqlist;
43
44 /********************* SCSI SPECIFIC DEFINES *********************************/
45 #define ZFCP_SCSI_ER_TIMEOUT                    (10*HZ)
46
47 /********************* CIO/QDIO SPECIFIC DEFINES *****************************/
48
49 /* DMQ bug workaround: don't use last SBALE */
50 #define ZFCP_MAX_SBALES_PER_SBAL        (QDIO_MAX_ELEMENTS_PER_BUFFER - 1)
51
52 /* index of last SBALE (with respect to DMQ bug workaround) */
53 #define ZFCP_LAST_SBALE_PER_SBAL        (ZFCP_MAX_SBALES_PER_SBAL - 1)
54
55 /* max. number of (data buffer) SBALEs in largest SBAL chain */
56 #define ZFCP_MAX_SBALES_PER_REQ         \
57         (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
58         /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
59
60 #define ZFCP_MAX_SECTORS (ZFCP_MAX_SBALES_PER_REQ * 8)
61         /* max. number of (data buffer) SBALEs in largest SBAL chain
62            multiplied with number of sectors per 4k block */
63
64 /********************* FSF SPECIFIC DEFINES *********************************/
65
66 /* ATTENTION: value must not be used by hardware */
67 #define FSF_QTCB_UNSOLICITED_STATUS             0x6305
68
69 /* timeout value for "default timer" for fsf requests */
70 #define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
71
72 /*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
73
74 /*
75  * Note, the leftmost status byte is common among adapter, port
76  * and unit
77  */
78 #define ZFCP_COMMON_FLAGS                       0xfff00000
79
80 /* common status bits */
81 #define ZFCP_STATUS_COMMON_RUNNING              0x40000000
82 #define ZFCP_STATUS_COMMON_ERP_FAILED           0x20000000
83 #define ZFCP_STATUS_COMMON_UNBLOCKED            0x10000000
84 #define ZFCP_STATUS_COMMON_OPEN                 0x04000000
85 #define ZFCP_STATUS_COMMON_ERP_INUSE            0x01000000
86 #define ZFCP_STATUS_COMMON_ACCESS_DENIED        0x00800000
87 #define ZFCP_STATUS_COMMON_ACCESS_BOXED         0x00400000
88 #define ZFCP_STATUS_COMMON_NOESC                0x00200000
89
90 /* adapter status */
91 #define ZFCP_STATUS_ADAPTER_QDIOUP              0x00000002
92 #define ZFCP_STATUS_ADAPTER_XCONFIG_OK          0x00000008
93 #define ZFCP_STATUS_ADAPTER_HOST_CON_INIT       0x00000010
94 #define ZFCP_STATUS_ADAPTER_ERP_PENDING         0x00000100
95 #define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED      0x00000200
96
97 /* remote port status */
98 #define ZFCP_STATUS_PORT_PHYS_OPEN              0x00000001
99 #define ZFCP_STATUS_PORT_LINK_TEST              0x00000002
100
101 /* logical unit status */
102 #define ZFCP_STATUS_UNIT_SHARED                 0x00000004
103 #define ZFCP_STATUS_UNIT_READONLY               0x00000008
104
105 /* FSF request status (this does not have a common part) */
106 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT      0x00000002
107 #define ZFCP_STATUS_FSFREQ_ERROR                0x00000008
108 #define ZFCP_STATUS_FSFREQ_CLEANUP              0x00000010
109 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED       0x00000040
110 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED       0x00000080
111 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED         0x00000200
112 #define ZFCP_STATUS_FSFREQ_DISMISSED            0x00001000
113
114 /************************* STRUCTURE DEFINITIONS *****************************/
115
116 struct zfcp_fsf_req;
117
118 /* holds various memory pools of an adapter */
119 struct zfcp_adapter_mempool {
120         mempool_t *erp_req;
121         mempool_t *gid_pn_req;
122         mempool_t *scsi_req;
123         mempool_t *scsi_abort;
124         mempool_t *status_read_req;
125         mempool_t *status_read_data;
126         mempool_t *gid_pn;
127         mempool_t *qtcb_pool;
128 };
129
130 struct zfcp_erp_action {
131         struct list_head list;
132         int action;                   /* requested action code */
133         struct zfcp_adapter *adapter; /* device which should be recovered */
134         struct zfcp_port *port;
135         struct zfcp_unit *unit;
136         u32             status;       /* recovery status */
137         u32 step;                     /* active step of this erp action */
138         unsigned long           fsf_req_id;
139         struct timer_list timer;
140 };
141
142 struct fsf_latency_record {
143         u32 min;
144         u32 max;
145         u64 sum;
146 };
147
148 struct latency_cont {
149         struct fsf_latency_record channel;
150         struct fsf_latency_record fabric;
151         u64 counter;
152 };
153
154 struct zfcp_latencies {
155         struct latency_cont read;
156         struct latency_cont write;
157         struct latency_cont cmd;
158         spinlock_t lock;
159 };
160
161 struct zfcp_adapter {
162         struct kref             ref;
163         u64                     peer_wwnn;         /* P2P peer WWNN */
164         u64                     peer_wwpn;         /* P2P peer WWPN */
165         u32                     peer_d_id;         /* P2P peer D_ID */
166         struct ccw_device       *ccw_device;       /* S/390 ccw device */
167         struct zfcp_qdio        *qdio;
168         u32                     hydra_version;     /* Hydra version */
169         u32                     fsf_lic_version;
170         u32                     adapter_features;  /* FCP channel features */
171         u32                     connection_features; /* host connection features */
172         u32                     hardware_version;  /* of FCP channel */
173         u16                     timer_ticks;       /* time int for a tick */
174         struct Scsi_Host        *scsi_host;        /* Pointer to mid-layer */
175         struct list_head        port_list;         /* remote port list */
176         rwlock_t                port_list_lock;    /* port list lock */
177         unsigned long           req_no;            /* unique FSF req number */
178         struct zfcp_reqlist     *req_list;
179         u32                     fsf_req_seq_no;    /* FSF cmnd seq number */
180         rwlock_t                abort_lock;        /* Protects against SCSI
181                                                       stack abort/command
182                                                       completion races */
183         atomic_t                stat_miss;         /* # missing status reads*/
184         struct work_struct      stat_work;
185         atomic_t                status;            /* status of this adapter */
186         struct list_head        erp_ready_head;    /* error recovery for this
187                                                       adapter/devices */
188         wait_queue_head_t       erp_ready_wq;
189         struct list_head        erp_running_head;
190         rwlock_t                erp_lock;
191         wait_queue_head_t       erp_done_wqh;
192         struct zfcp_erp_action  erp_action;        /* pending error recovery */
193         atomic_t                erp_counter;
194         u32                     erp_total_count;   /* total nr of enqueued erp
195                                                       actions */
196         u32                     erp_low_mem_count; /* nr of erp actions waiting
197                                                       for memory */
198         struct task_struct      *erp_thread;
199         struct zfcp_fc_wka_ports *gs;              /* generic services */
200         struct zfcp_dbf         *dbf;              /* debug traces */
201         struct zfcp_adapter_mempool     pool;      /* Adapter memory pools */
202         struct fc_host_statistics *fc_stats;
203         struct fsf_qtcb_bottom_port *stats_reset_data;
204         unsigned long           stats_reset;
205         struct work_struct      scan_work;
206         struct service_level    service_level;
207         struct workqueue_struct *work_queue;
208 };
209
210 struct zfcp_port {
211         struct device          dev;
212         struct fc_rport        *rport;         /* rport of fc transport class */
213         struct list_head       list;           /* list of remote ports */
214         struct zfcp_adapter    *adapter;       /* adapter used to access port */
215         struct list_head        unit_list;      /* head of logical unit list */
216         rwlock_t                unit_list_lock; /* unit list lock */
217         atomic_t               status;         /* status of this remote port */
218         u64                    wwnn;           /* WWNN if known */
219         u64                    wwpn;           /* WWPN */
220         u32                    d_id;           /* D_ID */
221         u32                    handle;         /* handle assigned by FSF */
222         struct zfcp_erp_action erp_action;     /* pending error recovery */
223         atomic_t               erp_counter;
224         u32                    maxframe_size;
225         u32                    supported_classes;
226         struct work_struct     gid_pn_work;
227         struct work_struct     test_link_work;
228         struct work_struct     rport_work;
229         enum { RPORT_NONE, RPORT_ADD, RPORT_DEL }  rport_task;
230 };
231
232 struct zfcp_unit {
233         struct device          dev;
234         struct list_head       list;           /* list of logical units */
235         struct zfcp_port       *port;          /* remote port of unit */
236         atomic_t               status;         /* status of this logical unit */
237         u64                    fcp_lun;        /* own FCP_LUN */
238         u32                    handle;         /* handle assigned by FSF */
239         struct scsi_device     *device;        /* scsi device struct pointer */
240         struct zfcp_erp_action erp_action;     /* pending error recovery */
241         atomic_t               erp_counter;
242         struct zfcp_latencies   latencies;
243         struct work_struct      scsi_work;
244 };
245
246 /**
247  * struct zfcp_fsf_req - basic FSF request structure
248  * @list: list of FSF requests
249  * @req_id: unique request ID
250  * @adapter: adapter this request belongs to
251  * @qdio_req: qdio queue related values
252  * @completion: used to signal the completion of the request
253  * @status: status of the request
254  * @fsf_command: FSF command issued
255  * @qtcb: associated QTCB
256  * @seq_no: sequence number of this request
257  * @data: private data
258  * @timer: timer data of this request
259  * @erp_action: reference to erp action if request issued on behalf of ERP
260  * @pool: reference to memory pool if used for this request
261  * @issued: time when request was send (STCK)
262  * @unit: reference to unit if this request is a SCSI request
263  * @handler: handler which should be called to process response
264  */
265 struct zfcp_fsf_req {
266         struct list_head        list;
267         unsigned long           req_id;
268         struct zfcp_adapter     *adapter;
269         struct zfcp_qdio_req    qdio_req;
270         struct completion       completion;
271         u32                     status;
272         u32                     fsf_command;
273         struct fsf_qtcb         *qtcb;
274         u32                     seq_no;
275         void                    *data;
276         struct timer_list       timer;
277         struct zfcp_erp_action  *erp_action;
278         mempool_t               *pool;
279         unsigned long long      issued;
280         struct zfcp_unit        *unit;
281         void                    (*handler)(struct zfcp_fsf_req *);
282 };
283
284 /* driver data */
285 struct zfcp_data {
286         struct scsi_host_template scsi_host_template;
287         struct scsi_transport_template *scsi_transport_template;
288         struct kmem_cache       *gpn_ft_cache;
289         struct kmem_cache       *qtcb_cache;
290         struct kmem_cache       *sr_buffer_cache;
291         struct kmem_cache       *gid_pn_cache;
292         struct kmem_cache       *adisc_cache;
293 };
294
295 /********************** ZFCP SPECIFIC DEFINES ********************************/
296
297 #define ZFCP_SET                0x00000100
298 #define ZFCP_CLEAR              0x00000200
299
300 #endif /* ZFCP_DEF_H */