blob: ba038ef57606b9f6c593dbee38f616eb893b65da [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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236/* Signature for error recovery functions. */
237typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
238
239/*
Stefan Haberland2dedf0d2010-05-17 10:00:11 +0200240 * Unique identifier for dasd device.
241 */
242#define UA_NOT_CONFIGURED 0x00
243#define UA_BASE_DEVICE 0x01
244#define UA_BASE_PAV_ALIAS 0x02
245#define UA_HYPER_PAV_ALIAS 0x03
246
247struct dasd_uid {
248 __u8 type;
249 char vendor[4];
250 char serial[15];
251 __u16 ssid;
252 __u8 real_unit_addr;
253 __u8 base_unit_addr;
254 char vduit[33];
255};
256
257/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 * the struct dasd_discipline is
259 * sth like a table of virtual functions, if you think of dasd_eckd
260 * inheriting dasd...
261 * no, currently we are not planning to reimplement the driver in C++
262 */
263struct dasd_discipline {
264 struct module *owner;
265 char ebcname[8]; /* a name used for tagging and printks */
266 char name[8]; /* a name used for tagging and printks */
267 int max_blocks; /* maximum number of blocks to be chained */
268
269 struct list_head list; /* used for list of disciplines */
270
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100271 /*
272 * Device recognition functions. check_device is used to verify
273 * the sense data and the information returned by read device
274 * characteristics. It returns 0 if the discipline can be used
275 * for the device in question. uncheck_device is called during
276 * device shutdown to deregister a device from its discipline.
277 */
278 int (*check_device) (struct dasd_device *);
279 void (*uncheck_device) (struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100281 /*
282 * do_analysis is used in the step from device state "basic" to
283 * state "accept". It returns 0 if the device can be made ready,
284 * it returns -EMEDIUMTYPE if the device can't be made ready or
285 * -EAGAIN if do_analysis started a ccw that needs to complete
286 * before the analysis may be repeated.
287 */
288 int (*do_analysis) (struct dasd_block *);
289
290 /*
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100291 * This function is called, when new paths become available.
292 * Disciplins may use this callback to do necessary setup work,
293 * e.g. verify that new path is compatible with the current
294 * configuration.
295 */
296 int (*verify_path)(struct dasd_device *, __u8);
297
298 /*
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100299 * Last things to do when a device is set online, and first things
300 * when it is set offline.
301 */
302 int (*ready_to_online) (struct dasd_device *);
303 int (*online_to_ready) (struct dasd_device *);
304
305 /*
306 * Device operation functions. build_cp creates a ccw chain for
307 * a block device request, start_io starts the request and
308 * term_IO cancels it (e.g. in case of a timeout). format_device
309 * returns a ccw chain to be used to format the device.
310 * handle_terminated_request allows to examine a cqr and prepare
311 * it for retry.
312 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100314 struct dasd_block *,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 struct request *);
316 int (*start_IO) (struct dasd_ccw_req *);
317 int (*term_IO) (struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100318 void (*handle_terminated_request) (struct dasd_ccw_req *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
320 struct format_data_t *);
321 int (*free_cp) (struct dasd_ccw_req *, struct request *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100322
323 /*
324 * Error recovery functions. examine_error() returns a value that
325 * indicates what to do for an error condition. If examine_error()
Horst Hummel138c0142006-06-29 14:58:12 +0200326 * returns 'dasd_era_recover' erp_action() is called to create a
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100327 * special error recovery ccw. erp_postaction() is called after
328 * an error recovery ccw has finished its execution. dump_sense
329 * is called for every error condition to print the sense data
330 * to the console.
331 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
333 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
334 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
335 struct irb *);
Stefan Haberlandaeec92c2009-07-07 16:37:06 +0200336 void (*dump_sense_dbf) (struct dasd_device *, struct irb *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100338 void (*handle_unsolicited_interrupt) (struct dasd_device *,
339 struct irb *);
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 /* i/o control functions. */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100342 int (*fill_geometry) (struct dasd_block *, struct hd_geometry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100344 int (*ioctl) (struct dasd_block *, unsigned int, void __user *);
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200345
346 /* suspend/resume functions */
347 int (*freeze) (struct dasd_device *);
348 int (*restore) (struct dasd_device *);
Stefan Haberland501183f2010-05-17 10:00:10 +0200349
350 /* reload device after state change */
351 int (*reload) (struct dasd_device *);
Stefan Haberland2dedf0d2010-05-17 10:00:11 +0200352
353 int (*get_uid) (struct dasd_device *, struct dasd_uid *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354};
355
356extern struct dasd_discipline *dasd_diag_discipline_pointer;
357
Horst Hummel3d052592006-04-27 18:40:28 -0700358/*
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800359 * Notification numbers for extended error reporting notifications:
360 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
361 * eer pointer) is freed. The error reporting module needs to do all necessary
362 * cleanup steps.
363 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
364 */
365#define DASD_EER_DISABLE 0
366#define DASD_EER_TRIGGER 1
367
368/* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
369#define DASD_EER_FATALERROR 1
370#define DASD_EER_NOPATH 2
371#define DASD_EER_STATECHANGE 3
372#define DASD_EER_PPRCSUSPEND 4
373
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100374struct dasd_path {
375 __u8 opm;
376 __u8 tbvpm;
377 __u8 ppm;
378 __u8 npm;
379};
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381struct dasd_device {
382 /* Block device stuff. */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100383 struct dasd_block *block;
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 unsigned int devindex;
Horst Hummel138c0142006-06-29 14:58:12 +0200386 unsigned long flags; /* per device flags */
387 unsigned short features; /* copy of devmap-features (read-only!) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800389 /* extended error reporting stuff (eer) */
390 struct dasd_ccw_req *eer_cqr;
391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 /* Device discipline stuff. */
393 struct dasd_discipline *discipline;
Peter Oberparleiteraa888612006-02-20 18:28:13 -0800394 struct dasd_discipline *base_discipline;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 char *private;
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100396 struct dasd_path path_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 /* Device state and target state. */
399 int state, target;
Stefan Haberland9eb25122010-02-26 22:37:46 +0100400 struct mutex state_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 int stopped; /* device (ccw_device_start) was stopped */
402
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100403 /* reference count. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 atomic_t ref_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406 /* ccw queue and memory for static ccw/erp buffers. */
407 struct list_head ccw_queue;
408 spinlock_t mem_lock;
409 void *ccw_mem;
410 void *erp_mem;
411 struct list_head ccw_chunks;
412 struct list_head erp_chunks;
413
414 atomic_t tasklet_scheduled;
415 struct tasklet_struct tasklet;
416 struct work_struct kick_work;
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200417 struct work_struct restore_device;
Stefan Haberland501183f2010-05-17 10:00:10 +0200418 struct work_struct reload_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 struct timer_list timer;
420
421 debug_info_t *debug_area;
422
423 struct ccw_device *cdev;
424
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100425 /* hook for alias management */
426 struct list_head alias_list;
Stefan Haberland7c8faa82010-08-09 18:13:00 +0200427
428 /* default expiration time in s */
429 unsigned long default_expires;
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100430};
431
432struct dasd_block {
433 /* Block device stuff. */
434 struct gendisk *gdp;
435 struct request_queue *request_queue;
436 spinlock_t request_queue_lock;
437 struct block_device *bdev;
438 atomic_t open_count;
439
Stefan Weinhuberb44b0ab32009-03-26 15:23:47 +0100440 unsigned long long blocks; /* size of volume in blocks */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100441 unsigned int bp_block; /* bytes per block */
442 unsigned int s2b_shift; /* log2 (bp_block/512) */
443
444 struct dasd_device *base;
445 struct list_head ccw_queue;
446 spinlock_t queue_lock;
447
448 atomic_t tasklet_scheduled;
449 struct tasklet_struct tasklet;
450 struct timer_list timer;
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452#ifdef CONFIG_DASD_PROFILE
453 struct dasd_profile_info_t profile;
454#endif
455};
456
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100457
458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459/* reasons why device (ccw_device_start) was stopped */
460#define DASD_STOPPED_NOT_ACC 1 /* not accessible */
461#define DASD_STOPPED_QUIESCE 2 /* Quiesced */
462#define DASD_STOPPED_PENDING 4 /* long busy */
463#define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100464#define DASD_STOPPED_SU 16 /* summary unit check handling */
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200465#define DASD_STOPPED_PM 32 /* pm state transition */
466#define DASD_UNRESUMED_PM 64 /* pm resume failed state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468/* per device flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469#define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800470#define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
471#define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
Stefan Weinhuber33b62a32010-03-08 12:26:24 +0100472#define DASD_FLAG_DEVICE_RO 6 /* The device itself is read-only. Don't
473 * confuse this with the user specified
474 * read-only feature.
475 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
477void dasd_put_device_wake(struct dasd_device *);
478
479/*
480 * Reference count inliners
481 */
482static inline void
483dasd_get_device(struct dasd_device *device)
484{
485 atomic_inc(&device->ref_count);
486}
487
488static inline void
489dasd_put_device(struct dasd_device *device)
490{
491 if (atomic_dec_return(&device->ref_count) == 0)
492 dasd_put_device_wake(device);
493}
494
495/*
496 * The static memory in ccw_mem and erp_mem is managed by a sorted
497 * list of free memory chunks.
498 */
499struct dasd_mchunk
500{
501 struct list_head list;
502 unsigned long size;
503} __attribute__ ((aligned(8)));
504
505static inline void
506dasd_init_chunklist(struct list_head *chunk_list, void *mem,
507 unsigned long size)
508{
509 struct dasd_mchunk *chunk;
510
511 INIT_LIST_HEAD(chunk_list);
512 chunk = (struct dasd_mchunk *) mem;
513 chunk->size = size - sizeof(struct dasd_mchunk);
514 list_add(&chunk->list, chunk_list);
515}
516
517static inline void *
518dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
519{
520 struct dasd_mchunk *chunk, *tmp;
521
522 size = (size + 7L) & -8L;
523 list_for_each_entry(chunk, chunk_list, list) {
524 if (chunk->size < size)
525 continue;
526 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
527 char *endaddr = (char *) (chunk + 1) + chunk->size;
528 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
529 tmp->size = size;
530 chunk->size -= size + sizeof(struct dasd_mchunk);
531 chunk = tmp;
532 } else
533 list_del(&chunk->list);
534 return (void *) (chunk + 1);
535 }
536 return NULL;
537}
538
539static inline void
540dasd_free_chunk(struct list_head *chunk_list, void *mem)
541{
542 struct dasd_mchunk *chunk, *tmp;
543 struct list_head *p, *left;
544
545 chunk = (struct dasd_mchunk *)
546 ((char *) mem - sizeof(struct dasd_mchunk));
547 /* Find out the left neighbour in chunk_list. */
548 left = chunk_list;
549 list_for_each(p, chunk_list) {
550 if (list_entry(p, struct dasd_mchunk, list) > chunk)
551 break;
552 left = p;
553 }
554 /* Try to merge with right neighbour = next element from left. */
555 if (left->next != chunk_list) {
556 tmp = list_entry(left->next, struct dasd_mchunk, list);
557 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
558 list_del(&tmp->list);
559 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
560 }
561 }
562 /* Try to merge with left neighbour. */
563 if (left != chunk_list) {
564 tmp = list_entry(left, struct dasd_mchunk, list);
565 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
566 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
567 return;
568 }
569 }
570 __list_add(&chunk->list, left, left->next);
571}
572
573/*
574 * Check if bsize is in { 512, 1024, 2048, 4096 }
575 */
576static inline int
577dasd_check_blocksize(int bsize)
578{
vignesh babue108ceb2007-10-12 16:11:39 +0200579 if (bsize < 512 || bsize > 4096 || !is_power_of_2(bsize))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 return -EMEDIUMTYPE;
581 return 0;
582}
583
584/* externals in dasd.c */
585#define DASD_PROFILE_ON 1
586#define DASD_PROFILE_OFF 0
587
588extern debug_info_t *dasd_debug_area;
589extern struct dasd_profile_info_t dasd_global_profile;
590extern unsigned int dasd_profile_level;
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -0700591extern const struct block_device_operations dasd_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Christoph Lametere18b8902006-12-06 20:33:20 -0800593extern struct kmem_cache *dasd_page_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
595struct dasd_ccw_req *
Stefan Haberland68b781f2009-09-11 10:28:29 +0200596dasd_kmalloc_request(int , int, int, struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597struct dasd_ccw_req *
Stefan Haberland68b781f2009-09-11 10:28:29 +0200598dasd_smalloc_request(int , int, int, struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
600void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
601
602static inline int
603dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
604{
605 return set_normalized_cda(ccw, cda);
606}
607
608struct dasd_device *dasd_alloc_device(void);
609void dasd_free_device(struct dasd_device *);
610
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100611struct dasd_block *dasd_alloc_block(void);
612void dasd_free_block(struct dasd_block *);
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614void dasd_enable_device(struct dasd_device *);
615void dasd_set_target_state(struct dasd_device *, int);
616void dasd_kick_device(struct dasd_device *);
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200617void dasd_restore_device(struct dasd_device *);
Stefan Haberland501183f2010-05-17 10:00:10 +0200618void dasd_reload_device(struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620void dasd_add_request_head(struct dasd_ccw_req *);
621void dasd_add_request_tail(struct dasd_ccw_req *);
622int dasd_start_IO(struct dasd_ccw_req *);
623int dasd_term_IO(struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100624void dasd_schedule_device_bh(struct dasd_device *);
625void dasd_schedule_block_bh(struct dasd_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626int dasd_sleep_on(struct dasd_ccw_req *);
627int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
628int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100629void dasd_device_set_timer(struct dasd_device *, int);
630void dasd_device_clear_timer(struct dasd_device *);
631void dasd_block_set_timer(struct dasd_block *, int);
632void dasd_block_clear_timer(struct dasd_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633int dasd_cancel_req(struct dasd_ccw_req *);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100634int dasd_flush_device_queue(struct dasd_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
636void dasd_generic_remove (struct ccw_device *cdev);
637int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
638int dasd_generic_set_offline (struct ccw_device *cdev);
639int dasd_generic_notify(struct ccw_device *, int);
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100640int dasd_generic_last_path_gone(struct dasd_device *);
641int dasd_generic_path_operational(struct dasd_device *);
642
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100643void dasd_generic_handle_state_change(struct dasd_device *);
Stefan Haberlandd41dd122009-06-16 10:30:25 +0200644int dasd_generic_pm_freeze(struct ccw_device *);
645int dasd_generic_restore_device(struct ccw_device *);
Stefan Haberlanda23ed002010-05-26 23:27:09 +0200646enum uc_todo dasd_generic_uc_handler(struct ccw_device *, struct irb *);
Stefan Weinhubera4d26c62011-01-05 12:48:03 +0100647void dasd_generic_path_event(struct ccw_device *, int *);
648int dasd_generic_verify_path(struct dasd_device *, __u8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Stefan Haberland68b781f2009-09-11 10:28:29 +0200650int dasd_generic_read_dev_chars(struct dasd_device *, int, void *, int);
Stefan Weinhuberf3eb5382009-03-26 15:23:48 +0100651char *dasd_get_sense(struct irb *);
Cornelia Huck17283b52007-05-04 18:47:51 +0200652
Stefan Weinhubereb6e1992009-12-07 12:51:51 +0100653void dasd_device_set_stop_bits(struct dasd_device *, int);
654void dasd_device_remove_stop_bits(struct dasd_device *, int);
655
Stefan Weinhuber33b62a32010-03-08 12:26:24 +0100656int dasd_device_is_ro(struct dasd_device *);
657
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659/* externals in dasd_devmap.c */
660extern int dasd_max_devindex;
661extern int dasd_probeonly;
662extern int dasd_autodetect;
Horst Hummel40545572006-06-29 15:08:18 +0200663extern int dasd_nopav;
Stefan Weinhuberf3eb5382009-03-26 15:23:48 +0100664extern int dasd_nofcx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666int dasd_devmap_init(void);
667void dasd_devmap_exit(void);
668
669struct dasd_device *dasd_create_device(struct ccw_device *);
670void dasd_delete_device(struct dasd_device *);
671
Horst Hummelf24acd42005-05-01 08:58:59 -0700672int dasd_get_feature(struct ccw_device *, int);
673int dasd_set_feature(struct ccw_device *, int, int);
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675int dasd_add_sysfs_files(struct ccw_device *);
676void dasd_remove_sysfs_files(struct ccw_device *);
677
678struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
Martin Schwidefskya00bfd72006-09-20 15:59:05 +0200679struct dasd_device *dasd_device_from_cdev_locked(struct ccw_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680struct dasd_device *dasd_device_from_devindex(int);
681
682int dasd_parse(void);
Cornelia Huck69f90f62008-05-15 16:52:34 +0200683int dasd_busid_known(const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
685/* externals in dasd_gendisk.c */
686int dasd_gendisk_init(void);
687void dasd_gendisk_exit(void);
Stefan Weinhuber8e09f212008-01-26 14:11:23 +0100688int dasd_gendisk_alloc(struct dasd_block *);
689void dasd_gendisk_free(struct dasd_block *);
690int dasd_scan_partitions(struct dasd_block *);
691void dasd_destroy_partitions(struct dasd_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
693/* externals in dasd_ioctl.c */
Al Viro57a7c0b2008-03-02 10:36:08 -0500694int dasd_ioctl(struct block_device *, fmode_t, unsigned int, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696/* externals in dasd_proc.c */
697int dasd_proc_init(void);
698void dasd_proc_exit(void);
699
700/* externals in dasd_erp.c */
701struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
702struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
703struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
704 struct dasd_device *);
705void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
706void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
Stefan Haberlandfc19f382009-03-26 15:23:49 +0100707void dasd_log_sense_dbf(struct dasd_ccw_req *cqr, struct irb *irb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/* externals in dasd_3990_erp.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
Stefan Haberlandf60c7682008-04-17 07:46:08 +0200711void dasd_3990_erp_handle_sim(struct dasd_device *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Stefan Weinhuber20c64462006-03-24 03:15:25 -0800713/* externals in dasd_eer.c */
714#ifdef CONFIG_DASD_EER
715int dasd_eer_init(void);
716void dasd_eer_exit(void);
717int dasd_eer_enable(struct dasd_device *);
718void dasd_eer_disable(struct dasd_device *);
719void dasd_eer_write(struct dasd_device *, struct dasd_ccw_req *cqr,
720 unsigned int id);
721void dasd_eer_snss(struct dasd_device *);
722
723static inline int dasd_eer_enabled(struct dasd_device *device)
724{
725 return device->eer_cqr != NULL;
726}
727#else
728#define dasd_eer_init() (0)
729#define dasd_eer_exit() do { } while (0)
730#define dasd_eer_enable(d) (0)
731#define dasd_eer_disable(d) do { } while (0)
732#define dasd_eer_write(d,c,i) do { } while (0)
733#define dasd_eer_snss(d) do { } while (0)
734#define dasd_eer_enabled(d) (0)
735#endif /* CONFIG_DASD_ERR */
736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737#endif /* __KERNEL__ */
738
739#endif /* DASD_H */