]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/s390/scsi/zfcp_def.h
[SCSI] zfcp: Remove duplicate assignment of req_seq_no
[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 *
a2fa0aed 6 * Copyright IBM Corporation 2002, 2009
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
LT
35#include <asm/ccwdev.h>
36#include <asm/qdio.h>
37#include <asm/debug.h>
38#include <asm/ebcdic.h>
bd43a42b 39#include <asm/sysinfo.h>
dd52e0ea 40#include "zfcp_fsf.h"
1da177e4 41
b6bd2fb9 42struct zfcp_reqlist;
1da177e4 43
06506d00 44/********************* SCSI SPECIFIC DEFINES *********************************/
f6c0e7a7 45#define ZFCP_SCSI_ER_TIMEOUT (10*HZ)
1da177e4
LT
46
47/********************* CIO/QDIO SPECIFIC DEFINES *****************************/
48
1da177e4
LT
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 \
c41f8cbd 57 (FSF_MAX_SBALS_PER_REQ * ZFCP_MAX_SBALES_PER_SBAL - 2)
1da177e4
LT
58 /* request ID + QTCB in SBALE 0 + 1 of first SBAL in chain */
59
8d1a0060
SS
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
1da177e4
LT
64/********************* FSF SPECIFIC DEFINES *********************************/
65
1da177e4
LT
66/* ATTENTION: value must not be used by hardware */
67#define FSF_QTCB_UNSOLICITED_STATUS 0x6305
22753fa5 68
1da177e4 69/* timeout value for "default timer" for fsf requests */
2abbe866 70#define ZFCP_FSF_REQUEST_TIMEOUT (60*HZ)
1da177e4 71
1da177e4
LT
72/*************** ADAPTER/PORT/UNIT AND FSF_REQ STATUS FLAGS ******************/
73
41fa2ada
SS
74/*
75 * Note, the leftmost status byte is common among adapter, port
1da177e4
LT
76 * and unit
77 */
78#define ZFCP_COMMON_FLAGS 0xfff00000
1da177e4
LT
79
80/* common status bits */
1da177e4
LT
81#define ZFCP_STATUS_COMMON_RUNNING 0x40000000
82#define ZFCP_STATUS_COMMON_ERP_FAILED 0x20000000
83#define ZFCP_STATUS_COMMON_UNBLOCKED 0x10000000
1da177e4 84#define ZFCP_STATUS_COMMON_OPEN 0x04000000
1da177e4
LT
85#define ZFCP_STATUS_COMMON_ERP_INUSE 0x01000000
86#define ZFCP_STATUS_COMMON_ACCESS_DENIED 0x00800000
d736a27b 87#define ZFCP_STATUS_COMMON_ACCESS_BOXED 0x00400000
cc8c2829 88#define ZFCP_STATUS_COMMON_NOESC 0x00200000
1da177e4
LT
89
90/* adapter status */
91#define ZFCP_STATUS_ADAPTER_QDIOUP 0x00000002
1da177e4
LT
92#define ZFCP_STATUS_ADAPTER_XCONFIG_OK 0x00000008
93#define ZFCP_STATUS_ADAPTER_HOST_CON_INIT 0x00000010
1da177e4
LT
94#define ZFCP_STATUS_ADAPTER_ERP_PENDING 0x00000100
95#define ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED 0x00000200
96
1da177e4
LT
97/* remote port status */
98#define ZFCP_STATUS_PORT_PHYS_OPEN 0x00000001
14e242ea 99#define ZFCP_STATUS_PORT_LINK_TEST 0x00000002
1da177e4 100
1da177e4 101/* logical unit status */
1da177e4
LT
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) */
1da177e4 106#define ZFCP_STATUS_FSFREQ_TASK_MANAGEMENT 0x00000002
1da177e4
LT
107#define ZFCP_STATUS_FSFREQ_ERROR 0x00000008
108#define ZFCP_STATUS_FSFREQ_CLEANUP 0x00000010
1da177e4
LT
109#define ZFCP_STATUS_FSFREQ_ABORTSUCCEEDED 0x00000040
110#define ZFCP_STATUS_FSFREQ_ABORTNOTNEEDED 0x00000080
1da177e4 111#define ZFCP_STATUS_FSFREQ_TMFUNCFAILED 0x00000200
1da177e4
LT
112#define ZFCP_STATUS_FSFREQ_DISMISSED 0x00001000
113
1da177e4
LT
114/************************* STRUCTURE DEFINITIONS *****************************/
115
116struct zfcp_fsf_req;
117
118/* holds various memory pools of an adapter */
119struct zfcp_adapter_mempool {
a4623c46 120 mempool_t *erp_req;
799b76d0 121 mempool_t *gid_pn_req;
a4623c46
SS
122 mempool_t *scsi_req;
123 mempool_t *scsi_abort;
124 mempool_t *status_read_req;
125 mempool_t *status_read_data;
dbf5dfe9 126 mempool_t *gid_pn;
a4623c46 127 mempool_t *qtcb_pool;
1da177e4
LT
128};
129
1da177e4 130struct zfcp_qdio_queue {
0406289e
CS
131 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
132 u8 first; /* index of next free bfr in queue */
133 atomic_t count; /* number of free buffers in queue */
1da177e4
LT
134};
135
136struct zfcp_erp_action {
137 struct list_head list;
138 int action; /* requested action code */
139 struct zfcp_adapter *adapter; /* device which should be recovered */
140 struct zfcp_port *port;
141 struct zfcp_unit *unit;
44cc76f2 142 u32 status; /* recovery status */
1da177e4 143 u32 step; /* active step of this erp action */
e60a6d69 144 unsigned long fsf_req_id;
1da177e4
LT
145 struct timer_list timer;
146};
147
c9615858
CS
148struct fsf_latency_record {
149 u32 min;
150 u32 max;
151 u64 sum;
152};
153
154struct latency_cont {
155 struct fsf_latency_record channel;
156 struct fsf_latency_record fabric;
157 u64 counter;
158};
159
160struct zfcp_latencies {
161 struct latency_cont read;
162 struct latency_cont write;
163 struct latency_cont cmd;
164 spinlock_t lock;
165};
1da177e4 166
564e1c86
SS
167/** struct zfcp_qdio - basic QDIO data structure
168 * @resp_q: response queue
169 * @req_q: request queue
170 * @stat_lock: lock to protect req_q_util and req_q_time
171 * @req_q_lock; lock to serialize access to request queue
172 * @req_q_time: time of last fill level change
173 * @req_q_util: used for accounting
174 * @req_q_full: queue full incidents
175 * @req_q_wq: used to wait for SBAL availability
176 * @adapter: adapter used in conjunction with this QDIO structure
177 */
178struct zfcp_qdio {
179 struct zfcp_qdio_queue resp_q;
180 struct zfcp_qdio_queue req_q;
181 spinlock_t stat_lock;
182 spinlock_t req_q_lock;
41e05a12 183 unsigned long long req_q_time;
564e1c86
SS
184 u64 req_q_util;
185 atomic_t req_q_full;
186 wait_queue_head_t req_q_wq;
187 struct zfcp_adapter *adapter;
188};
189
1da177e4 190struct zfcp_adapter {
f3450c7b 191 struct kref ref;
7ba58c9c
SS
192 u64 peer_wwnn; /* P2P peer WWNN */
193 u64 peer_wwpn; /* P2P peer WWPN */
13e1e1f0 194 u32 peer_d_id; /* P2P peer D_ID */
1da177e4 195 struct ccw_device *ccw_device; /* S/390 ccw device */
564e1c86 196 struct zfcp_qdio *qdio;
1da177e4
LT
197 u32 hydra_version; /* Hydra version */
198 u32 fsf_lic_version;
aef4a983
MS
199 u32 adapter_features; /* FCP channel features */
200 u32 connection_features; /* host connection features */
1da177e4 201 u32 hardware_version; /* of FCP channel */
c9615858 202 u16 timer_ticks; /* time int for a tick */
1da177e4 203 struct Scsi_Host *scsi_host; /* Pointer to mid-layer */
ecf0c772
SS
204 struct list_head port_list; /* remote port list */
205 rwlock_t port_list_lock; /* port list lock */
fea9d6c7 206 unsigned long req_no; /* unique FSF req number */
b6bd2fb9 207 struct zfcp_reqlist *req_list;
1da177e4 208 u32 fsf_req_seq_no; /* FSF cmnd seq number */
1da177e4
LT
209 rwlock_t abort_lock; /* Protects against SCSI
210 stack abort/command
211 completion races */
d26ab06e
SS
212 atomic_t stat_miss; /* # missing status reads*/
213 struct work_struct stat_work;
1da177e4
LT
214 atomic_t status; /* status of this adapter */
215 struct list_head erp_ready_head; /* error recovery for this
216 adapter/devices */
347c6a96 217 wait_queue_head_t erp_ready_wq;
1da177e4
LT
218 struct list_head erp_running_head;
219 rwlock_t erp_lock;
1da177e4
LT
220 wait_queue_head_t erp_done_wqh;
221 struct zfcp_erp_action erp_action; /* pending error recovery */
222 atomic_t erp_counter;
223 u32 erp_total_count; /* total nr of enqueued erp
224 actions */
225 u32 erp_low_mem_count; /* nr of erp actions waiting
226 for memory */
347c6a96 227 struct task_struct *erp_thread;
bd0072ec 228 struct zfcp_fc_wka_ports *gs; /* generic services */
d46f384a 229 struct zfcp_dbf *dbf; /* debug traces */
1da177e4 230 struct zfcp_adapter_mempool pool; /* Adapter memory pools */
f6cd94b1
AH
231 struct fc_host_statistics *fc_stats;
232 struct fsf_qtcb_bottom_port *stats_reset_data;
233 unsigned long stats_reset;
cc8c2829 234 struct work_struct scan_work;
bd43a42b 235 struct service_level service_level;
4544683a 236 struct workqueue_struct *work_queue;
1da177e4
LT
237};
238
1da177e4
LT
239struct zfcp_port {
240 struct device sysfs_device; /* sysfs device */
3859f6a2 241 struct fc_rport *rport; /* rport of fc transport class */
1da177e4 242 struct list_head list; /* list of remote ports */
1da177e4 243 struct zfcp_adapter *adapter; /* adapter used to access port */
ecf0c772
SS
244 struct list_head unit_list; /* head of logical unit list */
245 rwlock_t unit_list_lock; /* unit list lock */
1da177e4 246 atomic_t status; /* status of this remote port */
7ba58c9c
SS
247 u64 wwnn; /* WWNN if known */
248 u64 wwpn; /* WWPN */
13e1e1f0 249 u32 d_id; /* D_ID */
1da177e4
LT
250 u32 handle; /* handle assigned by FSF */
251 struct zfcp_erp_action erp_action; /* pending error recovery */
252 atomic_t erp_counter;
75bfc283
RW
253 u32 maxframe_size;
254 u32 supported_classes;
5ab944f9 255 struct work_struct gid_pn_work;
8fdf30d5 256 struct work_struct test_link_work;
a2fa0aed
CS
257 struct work_struct rport_work;
258 enum { RPORT_NONE, RPORT_ADD, RPORT_DEL } rport_task;
1da177e4
LT
259};
260
1da177e4
LT
261struct zfcp_unit {
262 struct device sysfs_device; /* sysfs device */
263 struct list_head list; /* list of logical units */
1da177e4
LT
264 struct zfcp_port *port; /* remote port of unit */
265 atomic_t status; /* status of this logical unit */
7ba58c9c 266 u64 fcp_lun; /* own FCP_LUN */
1da177e4
LT
267 u32 handle; /* handle assigned by FSF */
268 struct scsi_device *device; /* scsi device struct pointer */
269 struct zfcp_erp_action erp_action; /* pending error recovery */
270 atomic_t erp_counter;
c9615858 271 struct zfcp_latencies latencies;
92d5193b 272 struct work_struct scsi_work;
1da177e4
LT
273};
274
42428f74
SS
275/**
276 * struct zfcp_queue_req - queue related values for a request
277 * @sbal_number: number of free SBALs
278 * @sbal_first: first SBAL for this request
279 * @sbal_last: last SBAL for this request
280 * @sbal_limit: last possible SBAL for this request
281 * @sbale_curr: current SBALE at creation of this request
282 * @sbal_response: SBAL used in interrupt
283 * @qdio_outb_usage: usage of outbound queue
284 * @qdio_inb_usage: usage of inbound queue
285 */
286struct zfcp_queue_req {
287 u8 sbal_number;
288 u8 sbal_first;
289 u8 sbal_last;
290 u8 sbal_limit;
291 u8 sbale_curr;
292 u8 sbal_response;
293 u16 qdio_outb_usage;
294 u16 qdio_inb_usage;
295};
296
297/**
298 * struct zfcp_fsf_req - basic FSF request structure
299 * @list: list of FSF requests
300 * @req_id: unique request ID
301 * @adapter: adapter this request belongs to
302 * @queue_req: queue related values
303 * @completion: used to signal the completion of the request
304 * @status: status of the request
305 * @fsf_command: FSF command issued
306 * @qtcb: associated QTCB
307 * @seq_no: sequence number of this request
308 * @data: private data
309 * @timer: timer data of this request
310 * @erp_action: reference to erp action if request issued on behalf of ERP
311 * @pool: reference to memory pool if used for this request
312 * @issued: time when request was send (STCK)
313 * @unit: reference to unit if this request is a SCSI request
314 * @handler: handler which should be called to process response
315 */
1da177e4 316struct zfcp_fsf_req {
42428f74
SS
317 struct list_head list;
318 unsigned long req_id;
319 struct zfcp_adapter *adapter;
320 struct zfcp_queue_req queue_req;
321 struct completion completion;
322 u32 status;
323 u32 fsf_command;
324 struct fsf_qtcb *qtcb;
325 u32 seq_no;
326 void *data;
327 struct timer_list timer;
328 struct zfcp_erp_action *erp_action;
329 mempool_t *pool;
330 unsigned long long issued;
331 struct zfcp_unit *unit;
c41f8cbd 332 void (*handler)(struct zfcp_fsf_req *);
1da177e4
LT
333};
334
1da177e4
LT
335/* driver data */
336struct zfcp_data {
337 struct scsi_host_template scsi_host_template;
dd52e0ea 338 struct scsi_transport_template *scsi_transport_template;
a4623c46
SS
339 struct kmem_cache *gpn_ft_cache;
340 struct kmem_cache *qtcb_cache;
7ba58c9c
SS
341 struct kmem_cache *sr_buffer_cache;
342 struct kmem_cache *gid_pn_cache;
ee744622 343 struct kmem_cache *adisc_cache;
1da177e4
LT
344};
345
1da177e4
LT
346/********************** ZFCP SPECIFIC DEFINES ********************************/
347
1da177e4
LT
348#define ZFCP_SET 0x00000100
349#define ZFCP_CLEAR 0x00000200
350
1da177e4 351#endif /* ZFCP_DEF_H */