2 * File...........: linux/drivers/s390/block/dasd_int.h
3 * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
4 * Horst Hummel <Horst.Hummel@de.ibm.com>
5 * Martin Schwidefsky <schwidefsky@de.ibm.com>
6 * Bugreports.to..: <Linux390@de.ibm.com>
7 * (C) IBM Corporation, IBM Deutschland Entwicklung GmbH, 1999,2000
16 /* erp debugging in dasd.c and dasd_3990_erp.c */
20 /* we keep old device allocation scheme; IOW, minors are still in 0..255 */
21 #define DASD_PER_MAJOR (1U << (MINORBITS - DASD_PARTN_BITS))
22 #define DASD_PARTN_MASK ((1 << DASD_PARTN_BITS) - 1)
25 * States a dasd device can have:
26 * new: the dasd_device structure is allocated.
27 * known: the discipline for the device is identified.
28 * basic: the device can do basic i/o.
29 * accept: the device is analysed (format is known).
30 * ready: partition detection is done and the device is can do block io.
31 * online: the device accepts requests from the block device queue.
33 * Things to do for startup state transitions:
34 * new -> known: find discipline for the device and create devfs entries.
35 * known -> basic: request irq line for the device.
36 * basic -> ready: do the initial analysis, e.g. format detection,
37 * do block device setup and detect partitions.
38 * ready -> online: schedule the device tasklet.
39 * Things to do for shutdown state transitions:
40 * online -> ready: just set the new device state.
41 * ready -> basic: flush requests from the block device layer, clear
42 * partition information and reset format information.
43 * basic -> known: terminate all requests and free irq.
44 * known -> new: remove devfs entries and forget discipline.
47 #define DASD_STATE_NEW 0
48 #define DASD_STATE_KNOWN 1
49 #define DASD_STATE_BASIC 2
50 #define DASD_STATE_READY 3
51 #define DASD_STATE_ONLINE 4
53 #include <linux/module.h>
54 #include <linux/wait.h>
55 #include <linux/blkdev.h>
56 #include <linux/devfs_fs_kernel.h>
57 #include <linux/genhd.h>
58 #include <linux/hdreg.h>
59 #include <linux/interrupt.h>
60 #include <asm/ccwdev.h>
61 #include <linux/workqueue.h>
62 #include <asm/debug.h>
64 #include <asm/idals.h>
67 * SECTION: Type definitions
71 typedef int (*dasd_ioctl_fn_t) (struct block_device *bdev, int no, long args);
74 struct list_head list;
77 dasd_ioctl_fn_t handler;
81 dasd_era_fatal = -1, /* no chance to recover */
82 dasd_era_none = 0, /* don't recover, everything alright */
83 dasd_era_msg = 1, /* don't recover, just report... */
84 dasd_era_recover = 2 /* recovery action recommended */
87 /* BIT DEFINITIONS FOR SENSE DATA */
88 #define DASD_SENSE_BIT_0 0x80
89 #define DASD_SENSE_BIT_1 0x40
90 #define DASD_SENSE_BIT_2 0x20
91 #define DASD_SENSE_BIT_3 0x10
94 * SECTION: MACROs for klogd and s390 debug feature (dbf)
96 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
98 debug_sprintf_event(d_device->debug_area, \
104 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
106 debug_sprintf_exception(d_device->debug_area, \
112 #define DBF_EVENT(d_level, d_str, d_data...)\
114 debug_sprintf_event(dasd_debug_area, \
120 #define DBF_EXC(d_level, d_str, d_data...)\
122 debug_sprintf_exception(dasd_debug_area, \
128 /* definition of dbf debug levels */
129 #define DBF_EMERG 0 /* system is unusable */
130 #define DBF_ALERT 1 /* action must be taken immediately */
131 #define DBF_CRIT 2 /* critical conditions */
132 #define DBF_ERR 3 /* error conditions */
133 #define DBF_WARNING 4 /* warning conditions */
134 #define DBF_NOTICE 5 /* normal but significant condition */
135 #define DBF_INFO 6 /* informational */
136 #define DBF_DEBUG 6 /* debug-level messages */
138 /* messages to be written via klogd and dbf */
139 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
141 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
142 d_device->cdev->dev.bus_id, d_args); \
143 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
146 #define MESSAGE(d_loglevel,d_string,d_args...)\
148 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
149 DBF_EVENT(DBF_ALERT, d_string, d_args); \
152 /* messages to be written via klogd only */
153 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
155 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
156 d_device->cdev->dev.bus_id, d_args); \
159 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
161 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
164 struct dasd_ccw_req {
165 unsigned int magic; /* Eye catcher */
166 struct list_head list; /* list_head for request queueing. */
168 /* Where to execute what... */
169 struct dasd_device *device; /* device the request is for */
170 struct ccw1 *cpaddr; /* address of channel program */
171 char status; /* status of this request */
172 short retries; /* A retry counter */
173 unsigned long flags; /* flags of this request */
176 unsigned long starttime; /* jiffies time of request start */
177 int expires; /* expiration period in jiffies */
178 char lpm; /* logical path mask */
179 void *data; /* pointer to data area */
181 /* these are important for recovering erroneous requests */
182 struct irb irb; /* device status in case of an error */
183 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
184 void *function; /* originating ERP action */
186 /* these are for statistics only */
187 unsigned long long buildclk; /* TOD-clock of request generation */
188 unsigned long long startclk; /* TOD-clock of request start */
189 unsigned long long stopclk; /* TOD-clock of request interrupt */
190 unsigned long long endclk; /* TOD-clock of request termination */
192 /* Callback that is called after reaching final status. */
193 void (*callback)(struct dasd_ccw_req *, void *data);
198 * dasd_ccw_req -> status can be:
200 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
201 #define DASD_CQR_QUEUED 0x01 /* request is queued to be processed */
202 #define DASD_CQR_IN_IO 0x02 /* request is currently in IO */
203 #define DASD_CQR_DONE 0x03 /* request is completed successfully */
204 #define DASD_CQR_ERROR 0x04 /* request is completed with error */
205 #define DASD_CQR_FAILED 0x05 /* request is finally failed */
206 #define DASD_CQR_CLEAR 0x06 /* request is clear pending */
208 /* per dasd_ccw_req flags */
209 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
210 #define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
212 /* Signature for error recovery functions. */
213 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
216 * the struct dasd_discipline is
217 * sth like a table of virtual functions, if you think of dasd_eckd
219 * no, currently we are not planning to reimplement the driver in C++
221 struct dasd_discipline {
222 struct module *owner;
223 char ebcname[8]; /* a name used for tagging and printks */
224 char name[8]; /* a name used for tagging and printks */
225 int max_blocks; /* maximum number of blocks to be chained */
227 struct list_head list; /* used for list of disciplines */
230 * Device recognition functions. check_device is used to verify
231 * the sense data and the information returned by read device
232 * characteristics. It returns 0 if the discipline can be used
233 * for the device in question.
234 * do_analysis is used in the step from device state "basic" to
235 * state "accept". It returns 0 if the device can be made ready,
236 * it returns -EMEDIUMTYPE if the device can't be made ready or
237 * -EAGAIN if do_analysis started a ccw that needs to complete
238 * before the analysis may be repeated.
240 int (*check_device)(struct dasd_device *);
241 int (*do_analysis) (struct dasd_device *);
244 * Device operation functions. build_cp creates a ccw chain for
245 * a block device request, start_io starts the request and
246 * term_IO cancels it (e.g. in case of a timeout). format_device
247 * returns a ccw chain to be used to format the device.
249 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
251 int (*start_IO) (struct dasd_ccw_req *);
252 int (*term_IO) (struct dasd_ccw_req *);
253 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
254 struct format_data_t *);
255 int (*free_cp) (struct dasd_ccw_req *, struct request *);
257 * Error recovery functions. examine_error() returns a value that
258 * indicates what to do for an error condition. If examine_error()
259 * returns 'dasd_era_recover' erp_action() is called to create a
260 * special error recovery ccw. erp_postaction() is called after
261 * an error recovery ccw has finished its execution. dump_sense
262 * is called for every error condition to print the sense data
265 dasd_era_t(*examine_error) (struct dasd_ccw_req *, struct irb *);
266 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
267 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
268 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
271 /* i/o control functions. */
272 int (*fill_geometry) (struct dasd_device *, struct hd_geometry *);
273 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
276 extern struct dasd_discipline *dasd_diag_discipline_pointer;
280 * Notification numbers for extended error reporting notifications:
281 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
282 * eer pointer) is freed. The error reporting module needs to do all necessary
284 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
286 #define DASD_EER_DISABLE 0
287 #define DASD_EER_TRIGGER 1
289 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
290 #define DASD_EER_FATALERROR 1
291 #define DASD_EER_NOPATH 2
292 #define DASD_EER_STATECHANGE 3
293 #define DASD_EER_PPRCSUSPEND 4
296 * The dasd_eer_trigger structure contains all data that we need to send
297 * along with an DASD_EER_TRIGGER notification.
299 struct dasd_eer_trigger {
301 struct dasd_device *device;
302 struct dasd_ccw_req *cqr;
307 /* Block device stuff. */
309 request_queue_t *request_queue;
310 spinlock_t request_queue_lock;
311 struct block_device *bdev;
312 unsigned int devindex;
313 unsigned long blocks; /* size of volume in blocks */
314 unsigned int bp_block; /* bytes per block */
315 unsigned int s2b_shift; /* log2 (bp_block/512) */
316 unsigned long flags; /* per device flags */
317 unsigned short features; /* copy of devmap-features (read-only!) */
319 /* extended error reporting stuff (eer) */
322 /* Device discipline stuff. */
323 struct dasd_discipline *discipline;
326 /* Device state and target state. */
328 int stopped; /* device (ccw_device_start) was stopped */
330 /* Open and reference count. */
334 /* ccw queue and memory for static ccw/erp buffers. */
335 struct list_head ccw_queue;
339 struct list_head ccw_chunks;
340 struct list_head erp_chunks;
342 atomic_t tasklet_scheduled;
343 struct tasklet_struct tasklet;
344 struct work_struct kick_work;
345 struct timer_list timer;
347 debug_info_t *debug_area;
349 struct ccw_device *cdev;
351 #ifdef CONFIG_DASD_PROFILE
352 struct dasd_profile_info_t profile;
356 /* reasons why device (ccw_device_start) was stopped */
357 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
358 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
359 #define DASD_STOPPED_PENDING 4 /* long busy */
360 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
361 #define DASD_STOPPED_DC_EIO 16 /* disconnected, return -EIO */
363 /* per device flags */
364 #define DASD_FLAG_DSC_ERROR 2 /* return -EIO when disconnected */
365 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
367 void dasd_put_device_wake(struct dasd_device *);
370 * Reference count inliners
373 dasd_get_device(struct dasd_device *device)
375 atomic_inc(&device->ref_count);
379 dasd_put_device(struct dasd_device *device)
381 if (atomic_dec_return(&device->ref_count) == 0)
382 dasd_put_device_wake(device);
386 * The static memory in ccw_mem and erp_mem is managed by a sorted
387 * list of free memory chunks.
391 struct list_head list;
393 } __attribute__ ((aligned(8)));
396 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
399 struct dasd_mchunk *chunk;
401 INIT_LIST_HEAD(chunk_list);
402 chunk = (struct dasd_mchunk *) mem;
403 chunk->size = size - sizeof(struct dasd_mchunk);
404 list_add(&chunk->list, chunk_list);
408 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
410 struct dasd_mchunk *chunk, *tmp;
412 size = (size + 7L) & -8L;
413 list_for_each_entry(chunk, chunk_list, list) {
414 if (chunk->size < size)
416 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
417 char *endaddr = (char *) (chunk + 1) + chunk->size;
418 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
420 chunk->size -= size + sizeof(struct dasd_mchunk);
423 list_del(&chunk->list);
424 return (void *) (chunk + 1);
430 dasd_free_chunk(struct list_head *chunk_list, void *mem)
432 struct dasd_mchunk *chunk, *tmp;
433 struct list_head *p, *left;
435 chunk = (struct dasd_mchunk *)
436 ((char *) mem - sizeof(struct dasd_mchunk));
437 /* Find out the left neighbour in chunk_list. */
439 list_for_each(p, chunk_list) {
440 if (list_entry(p, struct dasd_mchunk, list) > chunk)
444 /* Try to merge with right neighbour = next element from left. */
445 if (left->next != chunk_list) {
446 tmp = list_entry(left->next, struct dasd_mchunk, list);
447 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
448 list_del(&tmp->list);
449 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
452 /* Try to merge with left neighbour. */
453 if (left != chunk_list) {
454 tmp = list_entry(left, struct dasd_mchunk, list);
455 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
456 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
460 __list_add(&chunk->list, left, left->next);
464 * Check if bsize is in { 512, 1024, 2048, 4096 }
467 dasd_check_blocksize(int bsize)
469 if (bsize < 512 || bsize > 4096 || (bsize & (bsize - 1)) != 0)
474 /* externals in dasd.c */
475 #define DASD_PROFILE_ON 1
476 #define DASD_PROFILE_OFF 0
478 extern debug_info_t *dasd_debug_area;
479 extern struct dasd_profile_info_t dasd_global_profile;
480 extern unsigned int dasd_profile_level;
481 extern struct block_device_operations dasd_device_operations;
483 extern kmem_cache_t *dasd_page_cache;
485 struct dasd_ccw_req *
486 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
487 struct dasd_ccw_req *
488 dasd_smalloc_request(char *, int, int, struct dasd_device *);
489 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
490 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
493 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
495 return set_normalized_cda(ccw, cda);
498 struct dasd_device *dasd_alloc_device(void);
499 void dasd_free_device(struct dasd_device *);
501 void dasd_enable_device(struct dasd_device *);
502 void dasd_set_target_state(struct dasd_device *, int);
503 void dasd_kick_device(struct dasd_device *);
505 void dasd_add_request_head(struct dasd_ccw_req *);
506 void dasd_add_request_tail(struct dasd_ccw_req *);
507 int dasd_start_IO(struct dasd_ccw_req *);
508 int dasd_term_IO(struct dasd_ccw_req *);
509 void dasd_schedule_bh(struct dasd_device *);
510 int dasd_sleep_on(struct dasd_ccw_req *);
511 int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
512 int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
513 void dasd_set_timer(struct dasd_device *, int);
514 void dasd_clear_timer(struct dasd_device *);
515 int dasd_cancel_req(struct dasd_ccw_req *);
516 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
517 void dasd_generic_remove (struct ccw_device *cdev);
518 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
519 int dasd_generic_set_offline (struct ccw_device *cdev);
520 int dasd_generic_notify(struct ccw_device *, int);
521 void dasd_generic_auto_online (struct ccw_driver *);
522 int dasd_register_eer_notifier(struct notifier_block *);
523 int dasd_unregister_eer_notifier(struct notifier_block *);
524 void dasd_write_eer_trigger(unsigned int , struct dasd_device *,
525 struct dasd_ccw_req *);
529 /* externals in dasd_devmap.c */
530 extern int dasd_max_devindex;
531 extern int dasd_probeonly;
532 extern int dasd_autodetect;
534 int dasd_devmap_init(void);
535 void dasd_devmap_exit(void);
537 struct dasd_device *dasd_create_device(struct ccw_device *);
538 void dasd_delete_device(struct dasd_device *);
540 int dasd_get_feature(struct ccw_device *, int);
541 int dasd_set_feature(struct ccw_device *, int, int);
543 int dasd_add_sysfs_files(struct ccw_device *);
544 void dasd_remove_sysfs_files(struct ccw_device *);
546 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
547 struct dasd_device *dasd_device_from_devindex(int);
549 int dasd_parse(void);
550 int dasd_busid_known(char *);
552 /* externals in dasd_gendisk.c */
553 int dasd_gendisk_init(void);
554 void dasd_gendisk_exit(void);
555 int dasd_gendisk_alloc(struct dasd_device *);
556 void dasd_gendisk_free(struct dasd_device *);
557 int dasd_scan_partitions(struct dasd_device *);
558 void dasd_destroy_partitions(struct dasd_device *);
560 /* externals in dasd_ioctl.c */
561 int dasd_ioctl_init(void);
562 void dasd_ioctl_exit(void);
563 int dasd_ioctl_no_register(struct module *, int, dasd_ioctl_fn_t);
564 int dasd_ioctl_no_unregister(struct module *, int, dasd_ioctl_fn_t);
565 int dasd_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
566 long dasd_compat_ioctl(struct file *, unsigned int, unsigned long);
568 /* externals in dasd_proc.c */
569 int dasd_proc_init(void);
570 void dasd_proc_exit(void);
572 /* externals in dasd_erp.c */
573 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
574 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
575 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
576 struct dasd_device *);
577 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
578 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
579 void dasd_log_ccw(struct dasd_ccw_req *, int, __u32);
581 /* externals in dasd_3370_erp.c */
582 dasd_era_t dasd_3370_erp_examine(struct dasd_ccw_req *, struct irb *);
584 /* externals in dasd_3990_erp.c */
585 dasd_era_t dasd_3990_erp_examine(struct dasd_ccw_req *, struct irb *);
586 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
588 /* externals in dasd_9336_erp.c */
589 dasd_era_t dasd_9336_erp_examine(struct dasd_ccw_req *, struct irb *);
591 /* externals in dasd_9336_erp.c */
592 dasd_era_t dasd_9343_erp_examine(struct dasd_ccw_req *, struct irb *);
593 struct dasd_ccw_req *dasd_9343_erp_action(struct dasd_ccw_req *);
595 #endif /* __KERNEL__ */
600 * Overrides for Emacs so that we follow Linus's tabbing style.
601 * Emacs will notice this stuff at the end of the file and automatically
602 * adjust the settings for this buffer only. This must remain at the end
604 * ---------------------------------------------------------------------------
607 * c-brace-imaginary-offset: 0
609 * c-argdecl-indent: 4
611 * c-continued-statement-offset: 4
612 * c-continued-brace-offset: 0
613 * indent-tabs-mode: 1