[SCSI] zfcp: Add zfcp private struct as SCSI device driver data
[linux-3.10.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_UNIT_SHARED                 0x00000004
89 #define ZFCP_STATUS_UNIT_READONLY               0x00000008
90
91 /* FSF request status (this does not have a common part) */
92 #define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT      0x00000002
93 #define ZFCP_STATUS_FSFREQ_ERROR                0x00000008
94 #define ZFCP_STATUS_FSFREQ_CLEANUP              0x00000010
95 #define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED       0x00000040
96 #define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED       0x00000080
97 #define ZFCP_STATUS_FSFREQ_TMFUNCFAILED         0x00000200
98 #define ZFCP_STATUS_FSFREQ_DISMISSED            0x00001000
99
100 /************************* STRUCTURE DEFINITIONS *****************************/
101
102 struct zfcp_fsf_req;
103
104 /* holds various memory pools of an adapter */
105 struct zfcp_adapter_mempool {
106         mempool_t *erp_req;
107         mempool_t *gid_pn_req;
108         mempool_t *scsi_req;
109         mempool_t *scsi_abort;
110         mempool_t *status_read_req;
111         mempool_t *status_read_data;
112         mempool_t *gid_pn;
113         mempool_t *qtcb_pool;
114 };
115
116 struct 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;
121         struct zfcp_unit *unit;
122         u32             status;       /* recovery status */
123         u32 step;                     /* active step of this erp action */
124         unsigned long           fsf_req_id;
125         struct timer_list timer;
126 };
127
128 struct fsf_latency_record {
129         u32 min;
130         u32 max;
131         u64 sum;
132 };
133
134 struct latency_cont {
135         struct fsf_latency_record channel;
136         struct fsf_latency_record fabric;
137         u64 counter;
138 };
139
140 struct zfcp_latencies {
141         struct latency_cont read;
142         struct latency_cont write;
143         struct latency_cont cmd;
144         spinlock_t lock;
145 };
146
147 struct zfcp_adapter {
148         struct kref             ref;
149         u64                     peer_wwnn;         /* P2P peer WWNN */
150         u64                     peer_wwpn;         /* P2P peer WWPN */
151         u32                     peer_d_id;         /* P2P peer D_ID */
152         struct ccw_device       *ccw_device;       /* S/390 ccw device */
153         struct zfcp_qdio        *qdio;
154         u32                     hydra_version;     /* Hydra version */
155         u32                     fsf_lic_version;
156         u32                     adapter_features;  /* FCP channel features */
157         u32                     connection_features; /* host connection features */
158         u32                     hardware_version;  /* of FCP channel */
159         u16                     timer_ticks;       /* time int for a tick */
160         struct Scsi_Host        *scsi_host;        /* Pointer to mid-layer */
161         struct list_head        port_list;         /* remote port list */
162         rwlock_t                port_list_lock;    /* port list lock */
163         unsigned long           req_no;            /* unique FSF req number */
164         struct zfcp_reqlist     *req_list;
165         u32                     fsf_req_seq_no;    /* FSF cmnd seq number */
166         rwlock_t                abort_lock;        /* Protects against SCSI
167                                                       stack abort/command
168                                                       completion races */
169         atomic_t                stat_miss;         /* # missing status reads*/
170         unsigned int            stat_read_buf_num;
171         struct work_struct      stat_work;
172         atomic_t                status;            /* status of this adapter */
173         struct list_head        erp_ready_head;    /* error recovery for this
174                                                       adapter/devices */
175         wait_queue_head_t       erp_ready_wq;
176         struct list_head        erp_running_head;
177         rwlock_t                erp_lock;
178         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 */
185         struct task_struct      *erp_thread;
186         struct zfcp_fc_wka_ports *gs;              /* generic services */
187         struct zfcp_dbf         *dbf;              /* debug traces */
188         struct zfcp_adapter_mempool     pool;      /* Adapter memory pools */
189         struct fc_host_statistics *fc_stats;
190         struct fsf_qtcb_bottom_port *stats_reset_data;
191         unsigned long           stats_reset;
192         struct work_struct      scan_work;
193         struct service_level    service_level;
194         struct workqueue_struct *work_queue;
195         struct device_dma_parameters dma_parms;
196         struct zfcp_fc_events events;
197 };
198
199 struct zfcp_port {
200         struct device          dev;
201         struct fc_rport        *rport;         /* rport of fc transport class */
202         struct list_head       list;           /* list of remote ports */
203         struct zfcp_adapter    *adapter;       /* adapter used to access port */
204         struct list_head        unit_list;      /* head of logical unit list */
205         rwlock_t                unit_list_lock; /* unit list lock */
206         atomic_t               status;         /* status of this remote port */
207         u64                    wwnn;           /* WWNN if known */
208         u64                    wwpn;           /* WWPN */
209         u32                    d_id;           /* D_ID */
210         u32                    handle;         /* handle assigned by FSF */
211         struct zfcp_erp_action erp_action;     /* pending error recovery */
212         atomic_t               erp_counter;
213         u32                    maxframe_size;
214         u32                    supported_classes;
215         struct work_struct     gid_pn_work;
216         struct work_struct     test_link_work;
217         struct work_struct     rport_work;
218         enum { RPORT_NONE, RPORT_ADD, RPORT_DEL }  rport_task;
219         unsigned int            starget_id;
220 };
221
222 struct zfcp_unit {
223         struct device          dev;
224         struct list_head       list;           /* list of logical units */
225         struct zfcp_port       *port;          /* remote port of unit */
226         atomic_t               status;         /* status of this logical unit */
227         u64                    fcp_lun;        /* own FCP_LUN */
228         u32                    handle;         /* handle assigned by FSF */
229         struct scsi_device     *device;        /* scsi device struct pointer */
230         struct zfcp_erp_action erp_action;     /* pending error recovery */
231         atomic_t               erp_counter;
232         struct zfcp_latencies   latencies;
233         struct work_struct      scsi_work;
234 };
235
236 /**
237  * struct zfcp_scsi_dev - zfcp data per SCSI device
238  * @status: zfcp internal status flags
239  * @lun_handle: handle from "open lun" for issuing FSF requests
240  * @erp_action: zfcp erp data for opening and recovering this LUN
241  * @erp_counter: zfcp erp counter for this LUN
242  * @latencies: FSF channel and fabric latencies
243  * @port: zfcp_port where this LUN belongs to
244  */
245 struct zfcp_scsi_dev {
246         atomic_t                status;
247         u32                     lun_handle;
248         struct zfcp_erp_action  erp_action;
249         atomic_t                erp_counter;
250         struct zfcp_latencies   latencies;
251         struct zfcp_port        *port;
252 };
253
254 /**
255  * sdev_to_zfcp - Access zfcp LUN data for SCSI device
256  * @sdev: scsi_device where to get the zfcp_scsi_dev pointer
257  */
258 static inline struct zfcp_scsi_dev *sdev_to_zfcp(struct scsi_device *sdev)
259 {
260         return scsi_transport_device_data(sdev);
261 }
262
263 /**
264  * zfcp_scsi_dev_lun - Return SCSI device LUN as 64 bit FCP LUN
265  * @sdev: SCSI device where to get the LUN from
266  */
267 static inline u64 zfcp_scsi_dev_lun(struct scsi_device *sdev)
268 {
269         u64 fcp_lun;
270
271         int_to_scsilun(sdev->lun, (struct scsi_lun *)&fcp_lun);
272         return fcp_lun;
273 }
274
275 /**
276  * struct zfcp_fsf_req - basic FSF request structure
277  * @list: list of FSF requests
278  * @req_id: unique request ID
279  * @adapter: adapter this request belongs to
280  * @qdio_req: qdio queue related values
281  * @completion: used to signal the completion of the request
282  * @status: status of the request
283  * @fsf_command: FSF command issued
284  * @qtcb: associated QTCB
285  * @seq_no: sequence number of this request
286  * @data: private data
287  * @timer: timer data of this request
288  * @erp_action: reference to erp action if request issued on behalf of ERP
289  * @pool: reference to memory pool if used for this request
290  * @issued: time when request was send (STCK)
291  * @unit: reference to unit if this request is a SCSI request
292  * @handler: handler which should be called to process response
293  */
294 struct zfcp_fsf_req {
295         struct list_head        list;
296         unsigned long           req_id;
297         struct zfcp_adapter     *adapter;
298         struct zfcp_qdio_req    qdio_req;
299         struct completion       completion;
300         u32                     status;
301         u32                     fsf_command;
302         struct fsf_qtcb         *qtcb;
303         u32                     seq_no;
304         void                    *data;
305         struct timer_list       timer;
306         struct zfcp_erp_action  *erp_action;
307         mempool_t               *pool;
308         unsigned long long      issued;
309         struct zfcp_unit        *unit;
310         void                    (*handler)(struct zfcp_fsf_req *);
311 };
312
313 /* driver data */
314 struct zfcp_data {
315         struct scsi_host_template scsi_host_template;
316         struct scsi_transport_template *scsi_transport_template;
317         struct kmem_cache       *gpn_ft_cache;
318         struct kmem_cache       *qtcb_cache;
319         struct kmem_cache       *sr_buffer_cache;
320         struct kmem_cache       *gid_pn_cache;
321         struct kmem_cache       *adisc_cache;
322 };
323
324 /********************** ZFCP SPECIFIC DEFINES ********************************/
325
326 #define ZFCP_SET                0x00000100
327 #define ZFCP_CLEAR              0x00000200
328
329 #endif /* ZFCP_DEF_H */