blob: 1dd12bd85a697f673af92726f5ec1ba2347e0416 [file] [log] [blame]
Horst Hummel138c0142006-06-29 14:58:12 +02001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * File...........: linux/drivers/s390/block/dasd_int.h
3 * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
Horst Hummel138c0142006-06-29 14:58:12 +02004 * Horst Hummel <Horst.Hummel@de.ibm.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Martin Schwidefsky <schwidefsky@de.ibm.com>
6 * Bugreports.to..: <Linux390@de.ibm.com>
Stefan Haberlandd41dd122009-06-16 10:30:25 +02007 * Copyright IBM Corp. 1999, 2009
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 */
9
10#ifndef DASD_INT_H
11#define DASD_INT_H
12
13#ifdef __KERNEL__
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015/* we keep old device allocation scheme; IOW, minors are still in 0..255 */
16#define DASD_PER_MAJOR (1U << (MINORBITS - DASD_PARTN_BITS))
17#define DASD_PARTN_MASK ((1 << DASD_PARTN_BITS) - 1)
18
19/*
20 * States a dasd device can have:
21 * new: the dasd_device structure is allocated.
22 * known: the discipline for the device is identified.
23 * basic: the device can do basic i/o.
Horst Hummel90f00942006-03-07 21:55:39 -080024 * unfmt: the device could not be analyzed (format is unknown).
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 * ready: partition detection is done and the device is can do block io.
26 * online: the device accepts requests from the block device queue.
27 *
28 * Things to do for startup state transitions:
29 * new -> known: find discipline for the device and create devfs entries.
30 * known -> basic: request irq line for the device.
31 * basic -> ready: do the initial analysis, e.g. format detection,
32 * do block device setup and detect partitions.
33 * ready -> online: schedule the device tasklet.
34 * Things to do for shutdown state transitions:
35 * online -> ready: just set the new device state.
36 * ready -> basic: flush requests from the block device layer, clear
37 * partition information and reset format information.
38 * basic -> known: terminate all requests and free irq.
39 * known -> new: remove devfs entries and forget discipline.
40 */
41
42#define DASD_STATE_NEW 0
43#define DASD_STATE_KNOWN 1
44#define DASD_STATE_BASIC 2
Horst Hummel90f00942006-03-07 21:55:39 -080045#define DASD_STATE_UNFMT 3
46#define DASD_STATE_READY 4
47#define DASD_STATE_ONLINE 5
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49#include <linux/module.h>
50#include <linux/wait.h>
51#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/genhd.h>
53#include <linux/hdreg.h>
54#include <linux/interrupt.h>
vignesh babue108ceb2007-10-12 16:11:39 +020055#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#include <asm/ccwdev.h>
57#include <linux/workqueue.h>
58#include <asm/debug.h>
59#include <asm/dasd.h>
60#include <asm/idals.h>
61
Stefan Haberland68b781f2009-09-11 10:28:29 +020062/* DASD discipline magic */
63#define DASD_ECKD_MAGIC 0xC5C3D2C4
64#define DASD_DIAG_MAGIC 0xC4C9C1C7
65#define DASD_FBA_MAGIC 0xC6C2C140
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/*
68 * SECTION: Type definitions
69 */
70struct dasd_device;
Stefan Weinhuber8e09f212008-01-26 14:11:23 +010071struct dasd_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73/* BIT DEFINITIONS FOR SENSE DATA */
74#define DASD_SENSE_BIT_0 0x80
75#define DASD_SENSE_BIT_1 0x40
76#define DASD_SENSE_BIT_2 0x20
77#define DASD_SENSE_BIT_3 0x10
78
Stefan Haberlandf60c7682008-04-17 07:46:08 +020079/* BIT DEFINITIONS FOR SIM SENSE */
80#define DASD_SIM_SENSE 0x0F
81#define DASD_SIM_MSG_TO_OP 0x03
82#define DASD_SIM_LOG 0x0C
83
Stefan Haberland2dedf0d2010-05-17 10:00:11 +020084/* lock class for nested cdev lock */
85#define CDEV_NESTED_FIRST 1
86#define CDEV_NESTED_SECOND 2
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/*
89 * SECTION: MACROs for klogd and s390 debug feature (dbf)
90 */
91#define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
92do { \
93 debug_sprintf_event(d_device->debug_area, \
94 d_level, \
95 d_str "\n", \
96 d_data); \
97} while(0)
98
99#define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
100do { \
101 debug_sprintf_exception(d_device->debug_area, \
102 d_level, \
103 d_str "\n", \
104 d_data); \
105} while(0)
106
107#define DBF_EVENT(d_level, d_str, d_data...)\
108do { \
109 debug_sprintf_event(dasd_debug_area, \
110 d_level,\
111 d_str "\n", \
112 d_data); \
113} while(0)
114
Stefan Haberlandb8ed5dd2009-12-07 12:51:52 +0100115#define DBF_EVENT_DEVID(d_level, d_cdev, d_str, d_data...) \
116do { \
117 struct ccw_dev_id __dev_id; \
118 ccw_device_get_id(d_cdev, &__dev_id); \
119 debug_sprintf_event(dasd_debug_area, \
120 d_level, \
121 "0.%x.%04x " d_str "\n", \
122 __dev_id.ssid, __dev_id.devno, d_data); \
123} while (0)
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#define DBF_EXC(d_level, d_str, d_data...)\
126do { \
127 debug_sprintf_exception(dasd_debug_area, \
128 d_level,\
129 d_str "\n", \
130 d_data); \
131} while(0)
132
Stefan Haberlandfc19f382009-03-26 15:23:49 +0100133/* limit size for an errorstring */
134#define ERRORLENGTH 30
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136/* definition of dbf debug levels */
137#define DBF_EMERG 0 /* system is unusable */
138#define DBF_ALERT 1 /* action must be taken immediately */
139#define DBF_CRIT 2 /* critical conditions */
140#define DBF_ERR 3 /* error conditions */
141#define DBF_WARNING 4 /* warning conditions */
142#define DBF_NOTICE 5 /* normal but significant condition */
143#define DBF_INFO 6 /* informational */
144#define DBF_DEBUG 6 /* debug-level messages */
145
146/* messages to be written via klogd and dbf */
147#define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
148do { \
149 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
Kay Sievers2a0217d2008-10-10 21:33:09 +0200150 dev_name(&d_device->cdev->dev), d_args); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
152} while(0)
153
154#define MESSAGE(d_loglevel,d_string,d_args...)\
155do { \
156 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
157 DBF_EVENT(DBF_ALERT, d_string, d_args); \
158} while(0)
159
160/* messages to be written via klogd only */
161#define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
162do { \
163 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
Kay Sievers2a0217d2008-10-10 21:33:09 +0200164 dev_name(&d_device->cdev->dev), d_args); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165} while(0)
166
167#define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
168do { \
169 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
170} while(0)
171
172struct dasd_ccw_req {
173 unsigned int magic; /* Eye catcher */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100174 struct list_head devlist; /* for dasd_device request queue */
175 struct list_head blocklist; /* for dasd_block request queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /* Where to execute what... */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100178 struct dasd_block *block; /* the originating block device */
179 struct dasd_device *memdev; /* the device used to allocate this */
180 struct dasd_device *startdev; /* device the request is started on */
Stefan Weinhuberf3eb5382009-03-26 15:23:48 +0100181 void *cpaddr; /* address of ccw or tcw */
182 unsigned char cpmode; /* 0 = cmd mode, 1 = itcw */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100183 char status; /* status of this request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 short retries; /* A retry counter */
185 unsigned long flags; /* flags of this request */
186
187 /* ... and how */
188 unsigned long starttime; /* jiffies time of request start */
Stefan Haberland7c8faa82010-08-09 18:13:00 +0200189 unsigned long expires; /* expiration period in jiffies */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100190 char lpm; /* logical path mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 void *data; /* pointer to data area */
192
193 /* these are important for recovering erroneous requests */
Stefan Weinhuber6cc7f162009-06-12 10:26:39 +0200194 int intrc; /* internal error, e.g. from start_IO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 struct irb irb; /* device status in case of an error */
196 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
197 void *function; /* originating ERP action */
198
199 /* these are for statistics only */
200 unsigned long long buildclk; /* TOD-clock of request generation */
201 unsigned long long startclk; /* TOD-clock of request start */
202 unsigned long long stopclk; /* TOD-clock of request interrupt */
203 unsigned long long endclk; /* TOD-clock of request termination */
204
205 /* Callback that is called after reaching final status. */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100206 void (*callback)(struct dasd_ccw_req *, void *data);
207 void *callback_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208};
209
Horst Hummel138c0142006-06-29 14:58:12 +0200210/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 * dasd_ccw_req -> status can be:
212 */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100213#define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
214#define DASD_CQR_DONE 0x01 /* request is completed successfully */
215#define DASD_CQR_NEED_ERP 0x02 /* request needs recovery action */
216#define DASD_CQR_IN_ERP 0x03 /* request is in recovery */
217#define DASD_CQR_FAILED 0x04 /* request is finally failed */
218#define DASD_CQR_TERMINATED 0x05 /* request was stopped by driver */
219
220#define DASD_CQR_QUEUED 0x80 /* request is queued to be processed */
221#define DASD_CQR_IN_IO 0x81 /* request is currently in IO */
222#define DASD_CQR_ERROR 0x82 /* request is completed with error */
223#define DASD_CQR_CLEAR_PENDING 0x83 /* request is clear pending */
224#define DASD_CQR_CLEARED 0x84 /* request was cleared */
Coly Li73ac36e2009-01-07 18:09:16 -0800225#define DASD_CQR_SUCCESS 0x85 /* request was successful */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100226
Stefan Haberland7c8faa82010-08-09 18:13:00 +0200227/* default expiration time*/
228#define DASD_EXPIRES 300
229#define DASD_EXPIRES_MAX 40000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231/* per dasd_ccw_req flags */
232#define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
Horst Hummel1c01b8a2006-01-06 00:19:15 -0800233#define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100234#define DASD_CQR_VERIFY_PATH 2 /* path verification request */
Stefan Weinhuber5a27e602011-01-05 12:48:04 +0100235#define DASD_CQR_ALLOW_SLOCK 3 /* Try this request even when lock was
236 * stolen. Should not be combined with
237 * DASD_CQR_FLAGS_USE_ERP
238 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
240/* Signature for error recovery functions. */
241typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
242
243/*
Stefan Haberland2dedf0d2010-05-17 10:00:11 +0200244 * Unique identifier for dasd device.
245 */
246#define UA_NOT_CONFIGURED 0x00
247#define UA_BASE_DEVICE 0x01
248#define UA_BASE_PAV_ALIAS 0x02
249#define UA_HYPER_PAV_ALIAS 0x03
250
251struct dasd_uid {
252 __u8 type;
253 char vendor[4];
254 char serial[15];
255 __u16 ssid;
256 __u8 real_unit_addr;
257 __u8 base_unit_addr;
258 char vduit[33];
259};
260
261/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 * the struct dasd_discipline is
263 * sth like a table of virtual functions, if you think of dasd_eckd
264 * inheriting dasd...
265 * no, currently we are not planning to reimplement the driver in C++
266 */
267struct dasd_discipline {
268 struct module *owner;
269 char ebcname[8]; /* a name used for tagging and printks */
270 char name[8]; /* a name used for tagging and printks */
271 int max_blocks; /* maximum number of blocks to be chained */
272
273 struct list_head list; /* used for list of disciplines */
274
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100275 /*
276 * Device recognition functions. check_device is used to verify
277 * the sense data and the information returned by read device
278 * characteristics. It returns 0 if the discipline can be used
279 * for the device in question. uncheck_device is called during
280 * device shutdown to deregister a device from its discipline.
281 */
282 int (*check_device) (struct dasd_device *);
283 void (*uncheck_device) (struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100285 /*
286 * do_analysis is used in the step from device state "basic" to
287 * state "accept". It returns 0 if the device can be made ready,
288 * it returns -EMEDIUMTYPE if the device can't be made ready or
289 * -EAGAIN if do_analysis started a ccw that needs to complete
290 * before the analysis may be repeated.
291 */
292 int (*do_analysis) (struct dasd_block *);
293
294 /*
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100295 * This function is called, when new paths become available.
296 * Disciplins may use this callback to do necessary setup work,
297 * e.g. verify that new path is compatible with the current
298 * configuration.
299 */
300 int (*verify_path)(struct dasd_device *, __u8);
301
302 /*
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100303 * Last things to do when a device is set online, and first things
304 * when it is set offline.
305 */
306 int (*ready_to_online) (struct dasd_device *);
307 int (*online_to_ready) (struct dasd_device *);
308
309 /*
310 * Device operation functions. build_cp creates a ccw chain for
311 * a block device request, start_io starts the request and
312 * term_IO cancels it (e.g. in case of a timeout). format_device
313 * returns a ccw chain to be used to format the device.
314 * handle_terminated_request allows to examine a cqr and prepare
315 * it for retry.
316 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100318 struct dasd_block *,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 struct request *);
320 int (*start_IO) (struct dasd_ccw_req *);
321 int (*term_IO) (struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100322 void (*handle_terminated_request) (struct dasd_ccw_req *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
324 struct format_data_t *);
325 int (*free_cp) (struct dasd_ccw_req *, struct request *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100326
327 /*
328 * Error recovery functions. examine_error() returns a value that
329 * indicates what to do for an error condition. If examine_error()
Horst Hummel138c0142006-06-29 14:58:12 +0200330 * returns 'dasd_era_recover' erp_action() is called to create a
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100331 * special error recovery ccw. erp_postaction() is called after
332 * an error recovery ccw has finished its execution. dump_sense
333 * is called for every error condition to print the sense data
334 * to the console.
335 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
337 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
338 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
339 struct irb *);
Stefan Haberlandaeec92c2009-07-07 16:37:06 +0200340 void (*dump_sense_dbf) (struct dasd_device *, struct irb *, char *);
Stefan Weinhuber5a27e602011-01-05 12:48:04 +0100341 void (*check_for_device_change) (struct dasd_device *,
342 struct dasd_ccw_req *,
343 struct irb *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 /* i/o control functions. */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100346 int (*fill_geometry) (struct dasd_block *, struct hd_geometry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100348 int (*ioctl) (struct dasd_block *, unsigned int, void __user *);
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200349
350 /* suspend/resume functions */
351 int (*freeze) (struct dasd_device *);
352 int (*restore) (struct dasd_device *);
Stefan Haberland501183f2010-05-17 10:00:10 +0200353
354 /* reload device after state change */
355 int (*reload) (struct dasd_device *);
Stefan Haberland2dedf0d2010-05-17 10:00:11 +0200356
357 int (*get_uid) (struct dasd_device *, struct dasd_uid *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358};
359
360extern struct dasd_discipline *dasd_diag_discipline_pointer;
361
Horst Hummel3d052592006-04-27 18:40:28 -0700362/*
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800363 * Notification numbers for extended error reporting notifications:
364 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
365 * eer pointer) is freed. The error reporting module needs to do all necessary
366 * cleanup steps.
367 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
368 */
369#define DASD_EER_DISABLE 0
370#define DASD_EER_TRIGGER 1
371
372/* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
373#define DASD_EER_FATALERROR 1
374#define DASD_EER_NOPATH 2
375#define DASD_EER_STATECHANGE 3
376#define DASD_EER_PPRCSUSPEND 4
377
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100378struct dasd_path {
379 __u8 opm;
380 __u8 tbvpm;
381 __u8 ppm;
382 __u8 npm;
383};
384
Stefan Weinhuber4fa52aa2011-07-24 10:48:32 +0200385struct dasd_profile_info {
386 /* legacy part of profile data, as in dasd_profile_info_t */
387 unsigned int dasd_io_reqs; /* number of requests processed */
388 unsigned int dasd_io_sects; /* number of sectors processed */
389 unsigned int dasd_io_secs[32]; /* histogram of request's sizes */
390 unsigned int dasd_io_times[32]; /* histogram of requests's times */
391 unsigned int dasd_io_timps[32]; /* h. of requests's times per sector */
392 unsigned int dasd_io_time1[32]; /* hist. of time from build to start */
393 unsigned int dasd_io_time2[32]; /* hist. of time from start to irq */
394 unsigned int dasd_io_time2ps[32]; /* hist. of time from start to irq */
395 unsigned int dasd_io_time3[32]; /* hist. of time from irq to end */
396 unsigned int dasd_io_nr_req[32]; /* hist. of # of requests in chanq */
397
398 /* new data */
399 struct timespec starttod; /* time of start or last reset */
400 unsigned int dasd_io_alias; /* requests using an alias */
401 unsigned int dasd_io_tpm; /* requests using transport mode */
402 unsigned int dasd_read_reqs; /* total number of read requests */
403 unsigned int dasd_read_sects; /* total number read sectors */
404 unsigned int dasd_read_alias; /* read request using an alias */
405 unsigned int dasd_read_tpm; /* read requests in transport mode */
406 unsigned int dasd_read_secs[32]; /* histogram of request's sizes */
407 unsigned int dasd_read_times[32]; /* histogram of requests's times */
408 unsigned int dasd_read_time1[32]; /* hist. time from build to start */
409 unsigned int dasd_read_time2[32]; /* hist. of time from start to irq */
410 unsigned int dasd_read_time3[32]; /* hist. of time from irq to end */
411 unsigned int dasd_read_nr_req[32]; /* hist. of # of requests in chanq */
412};
413
414struct dasd_profile {
415 struct dentry *dentry;
416 struct dasd_profile_info *data;
417 spinlock_t lock;
418};
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420struct dasd_device {
421 /* Block device stuff. */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100422 struct dasd_block *block;
423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 unsigned int devindex;
Horst Hummel138c0142006-06-29 14:58:12 +0200425 unsigned long flags; /* per device flags */
426 unsigned short features; /* copy of devmap-features (read-only!) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800428 /* extended error reporting stuff (eer) */
429 struct dasd_ccw_req *eer_cqr;
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 /* Device discipline stuff. */
432 struct dasd_discipline *discipline;
Peter Oberparleiteraa888612006-02-20 18:28:13 -0800433 struct dasd_discipline *base_discipline;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 char *private;
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100435 struct dasd_path path_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437 /* Device state and target state. */
438 int state, target;
Stefan Haberland9eb25122010-02-26 22:37:46 +0100439 struct mutex state_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 int stopped; /* device (ccw_device_start) was stopped */
441
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100442 /* reference count. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 atomic_t ref_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445 /* ccw queue and memory for static ccw/erp buffers. */
446 struct list_head ccw_queue;
447 spinlock_t mem_lock;
448 void *ccw_mem;
449 void *erp_mem;
450 struct list_head ccw_chunks;
451 struct list_head erp_chunks;
452
453 atomic_t tasklet_scheduled;
454 struct tasklet_struct tasklet;
455 struct work_struct kick_work;
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200456 struct work_struct restore_device;
Stefan Haberland501183f2010-05-17 10:00:10 +0200457 struct work_struct reload_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 struct timer_list timer;
459
460 debug_info_t *debug_area;
461
462 struct ccw_device *cdev;
463
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100464 /* hook for alias management */
465 struct list_head alias_list;
Stefan Haberland7c8faa82010-08-09 18:13:00 +0200466
467 /* default expiration time in s */
468 unsigned long default_expires;
Stefan Weinhuber4fa52aa2011-07-24 10:48:32 +0200469
470 struct dentry *debugfs_dentry;
471 struct dasd_profile profile;
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100472};
473
474struct dasd_block {
475 /* Block device stuff. */
476 struct gendisk *gdp;
477 struct request_queue *request_queue;
478 spinlock_t request_queue_lock;
479 struct block_device *bdev;
480 atomic_t open_count;
481
Stefan Weinhuberb44b0ab32009-03-26 15:23:47 +0100482 unsigned long long blocks; /* size of volume in blocks */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100483 unsigned int bp_block; /* bytes per block */
484 unsigned int s2b_shift; /* log2 (bp_block/512) */
485
486 struct dasd_device *base;
487 struct list_head ccw_queue;
488 spinlock_t queue_lock;
489
490 atomic_t tasklet_scheduled;
491 struct tasklet_struct tasklet;
492 struct timer_list timer;
493
Stefan Weinhuber4fa52aa2011-07-24 10:48:32 +0200494 struct dentry *debugfs_dentry;
495 struct dasd_profile profile;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496};
497
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100498
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500/* reasons why device (ccw_device_start) was stopped */
501#define DASD_STOPPED_NOT_ACC 1 /* not accessible */
502#define DASD_STOPPED_QUIESCE 2 /* Quiesced */
503#define DASD_STOPPED_PENDING 4 /* long busy */
504#define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100505#define DASD_STOPPED_SU 16 /* summary unit check handling */
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200506#define DASD_STOPPED_PM 32 /* pm state transition */
507#define DASD_UNRESUMED_PM 64 /* pm resume failed state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509/* per device flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510#define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800511#define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
512#define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
Stefan Weinhuber33b62a32010-03-08 12:26:24 +0100513#define DASD_FLAG_DEVICE_RO 6 /* The device itself is read-only. Don't
514 * confuse this with the user specified
515 * read-only feature.
516 */
Stefan Weinhuber5a27e602011-01-05 12:48:04 +0100517#define DASD_FLAG_IS_RESERVED 7 /* The device is reserved */
518#define DASD_FLAG_LOCK_STOLEN 8 /* The device lock was stolen */
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
521void dasd_put_device_wake(struct dasd_device *);
522
523/*
524 * Reference count inliners
525 */
526static inline void
527dasd_get_device(struct dasd_device *device)
528{
529 atomic_inc(&device->ref_count);
530}
531
532static inline void
533dasd_put_device(struct dasd_device *device)
534{
535 if (atomic_dec_return(&device->ref_count) == 0)
536 dasd_put_device_wake(device);
537}
538
539/*
540 * The static memory in ccw_mem and erp_mem is managed by a sorted
541 * list of free memory chunks.
542 */
543struct dasd_mchunk
544{
545 struct list_head list;
546 unsigned long size;
547} __attribute__ ((aligned(8)));
548
549static inline void
550dasd_init_chunklist(struct list_head *chunk_list, void *mem,
551 unsigned long size)
552{
553 struct dasd_mchunk *chunk;
554
555 INIT_LIST_HEAD(chunk_list);
556 chunk = (struct dasd_mchunk *) mem;
557 chunk->size = size - sizeof(struct dasd_mchunk);
558 list_add(&chunk->list, chunk_list);
559}
560
561static inline void *
562dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
563{
564 struct dasd_mchunk *chunk, *tmp;
565
566 size = (size + 7L) & -8L;
567 list_for_each_entry(chunk, chunk_list, list) {
568 if (chunk->size < size)
569 continue;
570 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
571 char *endaddr = (char *) (chunk + 1) + chunk->size;
572 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
573 tmp->size = size;
574 chunk->size -= size + sizeof(struct dasd_mchunk);
575 chunk = tmp;
576 } else
577 list_del(&chunk->list);
578 return (void *) (chunk + 1);
579 }
580 return NULL;
581}
582
583static inline void
584dasd_free_chunk(struct list_head *chunk_list, void *mem)
585{
586 struct dasd_mchunk *chunk, *tmp;
587 struct list_head *p, *left;
588
589 chunk = (struct dasd_mchunk *)
590 ((char *) mem - sizeof(struct dasd_mchunk));
591 /* Find out the left neighbour in chunk_list. */
592 left = chunk_list;
593 list_for_each(p, chunk_list) {
594 if (list_entry(p, struct dasd_mchunk, list) > chunk)
595 break;
596 left = p;
597 }
598 /* Try to merge with right neighbour = next element from left. */
599 if (left->next != chunk_list) {
600 tmp = list_entry(left->next, struct dasd_mchunk, list);
601 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
602 list_del(&tmp->list);
603 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
604 }
605 }
606 /* Try to merge with left neighbour. */
607 if (left != chunk_list) {
608 tmp = list_entry(left, struct dasd_mchunk, list);
609 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
610 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
611 return;
612 }
613 }
614 __list_add(&chunk->list, left, left->next);
615}
616
617/*
618 * Check if bsize is in { 512, 1024, 2048, 4096 }
619 */
620static inline int
621dasd_check_blocksize(int bsize)
622{
vignesh babue108ceb2007-10-12 16:11:39 +0200623 if (bsize < 512 || bsize > 4096 || !is_power_of_2(bsize))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return -EMEDIUMTYPE;
625 return 0;
626}
627
628/* externals in dasd.c */
Stefan Weinhuber4fa52aa2011-07-24 10:48:32 +0200629#define DASD_PROFILE_OFF 0
630#define DASD_PROFILE_ON 1
631#define DASD_PROFILE_GLOBAL_ONLY 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633extern debug_info_t *dasd_debug_area;
Stefan Weinhuber4fa52aa2011-07-24 10:48:32 +0200634extern struct dasd_profile_info dasd_global_profile_data;
635extern unsigned int dasd_global_profile_level;
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -0700636extern const struct block_device_operations dasd_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Christoph Lametere18b8902006-12-06 20:33:20 -0800638extern struct kmem_cache *dasd_page_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640struct dasd_ccw_req *
Stefan Haberland68b781f2009-09-11 10:28:29 +0200641dasd_kmalloc_request(int , int, int, struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642struct dasd_ccw_req *
Stefan Haberland68b781f2009-09-11 10:28:29 +0200643dasd_smalloc_request(int , int, int, struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
645void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
646
647static inline int
648dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
649{
650 return set_normalized_cda(ccw, cda);
651}
652
653struct dasd_device *dasd_alloc_device(void);
654void dasd_free_device(struct dasd_device *);
655
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100656struct dasd_block *dasd_alloc_block(void);
657void dasd_free_block(struct dasd_block *);
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659void dasd_enable_device(struct dasd_device *);
660void dasd_set_target_state(struct dasd_device *, int);
661void dasd_kick_device(struct dasd_device *);
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200662void dasd_restore_device(struct dasd_device *);
Stefan Haberland501183f2010-05-17 10:00:10 +0200663void dasd_reload_device(struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
665void dasd_add_request_head(struct dasd_ccw_req *);
666void dasd_add_request_tail(struct dasd_ccw_req *);
667int dasd_start_IO(struct dasd_ccw_req *);
668int dasd_term_IO(struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100669void dasd_schedule_device_bh(struct dasd_device *);
670void dasd_schedule_block_bh(struct dasd_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671int dasd_sleep_on(struct dasd_ccw_req *);
672int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
673int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100674void dasd_device_set_timer(struct dasd_device *, int);
675void dasd_device_clear_timer(struct dasd_device *);
676void dasd_block_set_timer(struct dasd_block *, int);
677void dasd_block_clear_timer(struct dasd_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678int dasd_cancel_req(struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100679int dasd_flush_device_queue(struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
681void dasd_generic_remove (struct ccw_device *cdev);
682int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
683int dasd_generic_set_offline (struct ccw_device *cdev);
684int dasd_generic_notify(struct ccw_device *, int);
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100685int dasd_generic_last_path_gone(struct dasd_device *);
686int dasd_generic_path_operational(struct dasd_device *);
687
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100688void dasd_generic_handle_state_change(struct dasd_device *);
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200689int dasd_generic_pm_freeze(struct ccw_device *);
690int dasd_generic_restore_device(struct ccw_device *);
Stefan Haberlanda23ed002010-05-26 23:27:09 +0200691enum uc_todo dasd_generic_uc_handler(struct ccw_device *, struct irb *);
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100692void dasd_generic_path_event(struct ccw_device *, int *);
693int dasd_generic_verify_path(struct dasd_device *, __u8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Stefan Haberland68b781f2009-09-11 10:28:29 +0200695int dasd_generic_read_dev_chars(struct dasd_device *, int, void *, int);
Stefan Weinhuberf3eb5382009-03-26 15:23:48 +0100696char *dasd_get_sense(struct irb *);
Cornelia Huck17283b52007-05-04 18:47:51 +0200697
Stefan Weinhubereb6e1992009-12-07 12:51:51 +0100698void dasd_device_set_stop_bits(struct dasd_device *, int);
699void dasd_device_remove_stop_bits(struct dasd_device *, int);
700
Stefan Weinhuber33b62a32010-03-08 12:26:24 +0100701int dasd_device_is_ro(struct dasd_device *);
702
Stefan Weinhuber4fa52aa2011-07-24 10:48:32 +0200703void dasd_profile_reset(struct dasd_profile *);
704int dasd_profile_on(struct dasd_profile *);
705void dasd_profile_off(struct dasd_profile *);
706void dasd_global_profile_reset(void);
707char *dasd_get_user_string(const char __user *, size_t);
Stefan Weinhuber33b62a32010-03-08 12:26:24 +0100708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/* externals in dasd_devmap.c */
710extern int dasd_max_devindex;
711extern int dasd_probeonly;
712extern int dasd_autodetect;
Horst Hummel40545572006-06-29 15:08:18 +0200713extern int dasd_nopav;
Stefan Weinhuberf3eb5382009-03-26 15:23:48 +0100714extern int dasd_nofcx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716int dasd_devmap_init(void);
717void dasd_devmap_exit(void);
718
719struct dasd_device *dasd_create_device(struct ccw_device *);
720void dasd_delete_device(struct dasd_device *);
721
Horst Hummelf24acd42005-05-01 08:58:59 -0700722int dasd_get_feature(struct ccw_device *, int);
723int dasd_set_feature(struct ccw_device *, int, int);
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725int dasd_add_sysfs_files(struct ccw_device *);
726void dasd_remove_sysfs_files(struct ccw_device *);
727
728struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
Martin Schwidefskya00bfd72006-09-20 15:59:05 +0200729struct dasd_device *dasd_device_from_cdev_locked(struct ccw_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730struct dasd_device *dasd_device_from_devindex(int);
731
Stefan Weinhuber65f8da42011-04-20 10:15:30 +0200732void dasd_add_link_to_gendisk(struct gendisk *, struct dasd_device *);
733struct dasd_device *dasd_device_from_gendisk(struct gendisk *);
734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735int dasd_parse(void);
Cornelia Huck69f90f62008-05-15 16:52:34 +0200736int dasd_busid_known(const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738/* externals in dasd_gendisk.c */
739int dasd_gendisk_init(void);
740void dasd_gendisk_exit(void);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100741int dasd_gendisk_alloc(struct dasd_block *);
742void dasd_gendisk_free(struct dasd_block *);
743int dasd_scan_partitions(struct dasd_block *);
744void dasd_destroy_partitions(struct dasd_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
746/* externals in dasd_ioctl.c */
Al Viro57a7c0b2008-03-02 10:36:08 -0500747int dasd_ioctl(struct block_device *, fmode_t, unsigned int, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749/* externals in dasd_proc.c */
750int dasd_proc_init(void);
751void dasd_proc_exit(void);
752
753/* externals in dasd_erp.c */
754struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
755struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
756struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
757 struct dasd_device *);
758void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
759void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
Stefan Haberlandfc19f382009-03-26 15:23:49 +0100760void dasd_log_sense_dbf(struct dasd_ccw_req *cqr, struct irb *irb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/* externals in dasd_3990_erp.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
Stefan Haberlandf60c7682008-04-17 07:46:08 +0200764void dasd_3990_erp_handle_sim(struct dasd_device *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800766/* externals in dasd_eer.c */
767#ifdef CONFIG_DASD_EER
768int dasd_eer_init(void);
769void dasd_eer_exit(void);
770int dasd_eer_enable(struct dasd_device *);
771void dasd_eer_disable(struct dasd_device *);
772void dasd_eer_write(struct dasd_device *, struct dasd_ccw_req *cqr,
773 unsigned int id);
774void dasd_eer_snss(struct dasd_device *);
775
776static inline int dasd_eer_enabled(struct dasd_device *device)
777{
778 return device->eer_cqr != NULL;
779}
780#else
781#define dasd_eer_init() (0)
782#define dasd_eer_exit() do { } while (0)
783#define dasd_eer_enable(d) (0)
784#define dasd_eer_disable(d) do { } while (0)
785#define dasd_eer_write(d,c,i) do { } while (0)
786#define dasd_eer_snss(d) do { } while (0)
787#define dasd_eer_enabled(d) (0)
788#endif /* CONFIG_DASD_ERR */
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790#endif /* __KERNEL__ */
791
792#endif /* DASD_H */