]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/s390/scsi/zfcp_def.h
[SCSI] zfcp: Introduce experimental support for DIF/DIX
[mirror_ubuntu-bionic-kernel.git] / drivers / s390 / scsi / zfcp_def.h
CommitLineData
41fa2ada 1/*
553448f6 2 * zfcp device driver
1da177e4 3 *
553448f6 4 * Global definitions for the zfcp device driver.
41fa2ada 5 *
615f59e0 6 * Copyright IBM Corporation 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 43struct 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 */
75#define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
1da177e4
LT
76#define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
77#define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
1da177e4
LT
78#define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
79#define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
dcc18f48 80#define ZFCP_STATUS_ADAPTER_DATA_DIV_ENABLED 0x00000400
1da177e4 81
1da177e4
LT
82/* remote port status */
83#define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
14e242ea 84#define ZFCP_STATUS_PORT_LINK_TEST 0x00000002
1da177e4 85
1da177e4 86/* logical unit status */
1da177e4
LT
87#define ZFCP_STATUS_UNIT_SHARED 0x00000004
88#define ZFCP_STATUS_UNIT_READONLY 0x00000008
89
90/* FSF request status (this does not have a common part) */
1da177e4 91#define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002
1da177e4
LT
92#define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
93#define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
1da177e4
LT
94#define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
95#define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
1da177e4 96#define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
1da177e4
LT
97#define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
98
1da177e4
LT
99/************************* STRUCTURE DEFINITIONS *****************************/
100
101struct zfcp_fsf_req;
102
103/* holds various memory pools of an adapter */
104struct zfcp_adapter_mempool {
a4623c46 105 mempool_t *erp_req;
799b76d0 106 mempool_t *gid_pn_req;
a4623c46
SS
107 mempool_t *scsi_req;
108 mempool_t *scsi_abort;
109 mempool_t *status_read_req;
110 mempool_t *status_read_data;
dbf5dfe9 111 mempool_t *gid_pn;
a4623c46 112 mempool_t *qtcb_pool;
1da177e4
LT
113};
114
1da177e4
LT
115struct 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 zfcp_unit *unit;
44cc76f2 121 u32 status; /* recovery status */
1da177e4 122 u32 step; /* active step of this erp action */
e60a6d69 123 unsigned long fsf_req_id;
1da177e4
LT
124 struct timer_list timer;
125};
126
c9615858
CS
127struct fsf_latency_record {
128 u32 min;
129 u32 max;
130 u64 sum;
131};
132
133struct latency_cont {
134 struct fsf_latency_record channel;
135 struct fsf_latency_record fabric;
136 u64 counter;
137};
138
139struct zfcp_latencies {
140 struct latency_cont read;
141 struct latency_cont write;
142 struct latency_cont cmd;
143 spinlock_t lock;
144};
1da177e4
LT
145
146struct zfcp_adapter {
f3450c7b 147 struct kref ref;
7ba58c9c
SS
148 u64 peer_wwnn; /* P2P peer WWNN */
149 u64 peer_wwpn; /* P2P peer WWPN */
13e1e1f0 150 u32 peer_d_id; /* P2P peer D_ID */
1da177e4 151 struct ccw_device *ccw_device; /* S/390 ccw device */
564e1c86 152 struct zfcp_qdio *qdio;
1da177e4
LT
153 u32 hydra_version; /* Hydra version */
154 u32 fsf_lic_version;
aef4a983
MS
155 u32 adapter_features; /* FCP channel features */
156 u32 connection_features; /* host connection features */
1da177e4 157 u32 hardware_version; /* of FCP channel */
c9615858 158 u16 timer_ticks; /* time int for a tick */
1da177e4 159 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */
ecf0c772
SS
160 struct list_head port_list; /* remote port list */
161 rwlock_t port_list_lock; /* port list lock */
fea9d6c7 162 unsigned long req_no; /* unique FSF req number */
b6bd2fb9 163 struct zfcp_reqlist *req_list;
1da177e4 164 u32 fsf_req_seq_no; /* FSF cmnd seq number */
1da177e4
LT
165 rwlock_t abort_lock; /* Protects against SCSI
166 stack abort/command
167 completion races */
d26ab06e 168 atomic_t stat_miss; /* # missing status reads*/
64deb6ef 169 unsigned int stat_read_buf_num;
d26ab06e 170 struct work_struct stat_work;
1da177e4
LT
171 atomic_t status; /* status of this adapter */
172 struct list_head erp_ready_head; /* error recovery for this
173 adapter/devices */
347c6a96 174 wait_queue_head_t erp_ready_wq;
1da177e4
LT
175 struct list_head erp_running_head;
176 rwlock_t erp_lock;
1da177e4
LT
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 */
347c6a96 184 struct task_struct *erp_thread;
bd0072ec 185 struct zfcp_fc_wka_ports *gs; /* generic services */
d46f384a 186 struct zfcp_dbf *dbf; /* debug traces */
1da177e4 187 struct zfcp_adapter_mempool pool; /* Adapter memory pools */
f6cd94b1
AH
188 struct fc_host_statistics *fc_stats;
189 struct fsf_qtcb_bottom_port *stats_reset_data;
190 unsigned long stats_reset;
cc8c2829 191 struct work_struct scan_work;
bd43a42b 192 struct service_level service_level;
4544683a 193 struct workqueue_struct *work_queue;
68322984 194 struct device_dma_parameters dma_parms;
2d1e547f 195 struct zfcp_fc_events events;
1da177e4
LT
196};
197
1da177e4 198struct zfcp_port {
615f59e0 199 struct device dev;
3859f6a2 200 struct fc_rport *rport; /* rport of fc transport class */
1da177e4 201 struct list_head list; /* list of remote ports */
1da177e4 202 struct zfcp_adapter *adapter; /* adapter used to access port */
ecf0c772
SS
203 struct list_head unit_list; /* head of logical unit list */
204 rwlock_t unit_list_lock; /* unit list lock */
1da177e4 205 atomic_t status; /* status of this remote port */
7ba58c9c
SS
206 u64 wwnn; /* WWNN if known */
207 u64 wwpn; /* WWPN */
13e1e1f0 208 u32 d_id; /* D_ID */
1da177e4
LT
209 u32 handle; /* handle assigned by FSF */
210 struct zfcp_erp_action erp_action; /* pending error recovery */
211 atomic_t erp_counter;
75bfc283
RW
212 u32 maxframe_size;
213 u32 supported_classes;
5ab944f9 214 struct work_struct gid_pn_work;
8fdf30d5 215 struct work_struct test_link_work;
a2fa0aed
CS
216 struct work_struct rport_work;
217 enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task;
1bf3ff02 218 unsigned int starget_id;
1da177e4
LT
219};
220
1da177e4 221struct zfcp_unit {
615f59e0 222 struct device dev;
1da177e4 223 struct list_head list; /* list of logical units */
1da177e4
LT
224 struct zfcp_port *port; /* remote port of unit */
225 atomic_t status; /* status of this logical unit */
7ba58c9c 226 u64 fcp_lun; /* own FCP_LUN */
1da177e4
LT
227 u32 handle; /* handle assigned by FSF */
228 struct scsi_device *device; /* scsi device struct pointer */
229 struct zfcp_erp_action erp_action; /* pending error recovery */
230 atomic_t erp_counter;
c9615858 231 struct zfcp_latencies latencies;
92d5193b 232 struct work_struct scsi_work;
1da177e4
LT
233};
234
42428f74
SS
235/**
236 * struct zfcp_fsf_req - basic FSF request structure
237 * @list: list of FSF requests
238 * @req_id: unique request ID
239 * @adapter: adapter this request belongs to
34c2b712 240 * @qdio_req: qdio queue related values
42428f74
SS
241 * @completion: used to signal the completion of the request
242 * @status: status of the request
243 * @fsf_command: FSF command issued
244 * @qtcb: associated QTCB
245 * @seq_no: sequence number of this request
246 * @data: private data
247 * @timer: timer data of this request
248 * @erp_action: reference to erp action if request issued on behalf of ERP
249 * @pool: reference to memory pool if used for this request
250 * @issued: time when request was send (STCK)
251 * @unit: reference to unit if this request is a SCSI request
252 * @handler: handler which should be called to process response
253 */
1da177e4 254struct zfcp_fsf_req {
42428f74
SS
255 struct list_head list;
256 unsigned long req_id;
257 struct zfcp_adapter *adapter;
34c2b712 258 struct zfcp_qdio_req qdio_req;
42428f74
SS
259 struct completion completion;
260 u32 status;
261 u32 fsf_command;
262 struct fsf_qtcb *qtcb;
263 u32 seq_no;
264 void *data;
265 struct timer_list timer;
266 struct zfcp_erp_action *erp_action;
267 mempool_t *pool;
268 unsigned long long issued;
269 struct zfcp_unit *unit;
c41f8cbd 270 void (*handler)(struct zfcp_fsf_req *);
1da177e4
LT
271};
272
1da177e4
LT
273/* driver data */
274struct zfcp_data {
275 struct scsi_host_template scsi_host_template;
dd52e0ea 276 struct scsi_transport_template *scsi_transport_template;
a4623c46
SS
277 struct kmem_cache *gpn_ft_cache;
278 struct kmem_cache *qtcb_cache;
7ba58c9c
SS
279 struct kmem_cache *sr_buffer_cache;
280 struct kmem_cache *gid_pn_cache;
ee744622 281 struct kmem_cache *adisc_cache;
1da177e4
LT
282};
283
1da177e4
LT
284/********************** ZFCP SPECIFIC DEFINES ********************************/
285
1da177e4
LT
286#define ZFCP_SET 0x00000100
287#define ZFCP_CLEAR 0x00000200
288
1da177e4 289#endif /* ZFCP_DEF_H */