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 /* we keep old device allocation scheme; IOW, minors are still in 0..255 */
17 #define DASD_PER_MAJOR (1U << (MINORBITS - DASD_PARTN_BITS))
18 #define DASD_PARTN_MASK ((1 << DASD_PARTN_BITS) - 1)
21 * States a dasd device can have:
22 * new: the dasd_device structure is allocated.
23 * known: the discipline for the device is identified.
24 * basic: the device can do basic i/o.
25 * unfmt: the device could not be analyzed (format is unknown).
26 * ready: partition detection is done and the device is can do block io.
27 * online: the device accepts requests from the block device queue.
29 * Things to do for startup state transitions:
30 * new -> known: find discipline for the device and create devfs entries.
31 * known -> basic: request irq line for the device.
32 * basic -> ready: do the initial analysis, e.g. format detection,
33 * do block device setup and detect partitions.
34 * ready -> online: schedule the device tasklet.
35 * Things to do for shutdown state transitions:
36 * online -> ready: just set the new device state.
37 * ready -> basic: flush requests from the block device layer, clear
38 * partition information and reset format information.
39 * basic -> known: terminate all requests and free irq.
40 * known -> new: remove devfs entries and forget discipline.
43 #define DASD_STATE_NEW 0
44 #define DASD_STATE_KNOWN 1
45 #define DASD_STATE_BASIC 2
46 #define DASD_STATE_UNFMT 3
47 #define DASD_STATE_READY 4
48 #define DASD_STATE_ONLINE 5
50 #include <linux/module.h>
51 #include <linux/wait.h>
52 #include <linux/blkdev.h>
53 #include <linux/genhd.h>
54 #include <linux/hdreg.h>
55 #include <linux/interrupt.h>
56 #include <linux/log2.h>
57 #include <asm/ccwdev.h>
58 #include <linux/workqueue.h>
59 #include <asm/debug.h>
61 #include <asm/idals.h>
64 * SECTION: Type definitions
69 /* BIT DEFINITIONS FOR SENSE DATA */
70 #define DASD_SENSE_BIT_0 0x80
71 #define DASD_SENSE_BIT_1 0x40
72 #define DASD_SENSE_BIT_2 0x20
73 #define DASD_SENSE_BIT_3 0x10
75 /* BIT DEFINITIONS FOR SIM SENSE */
76 #define DASD_SIM_SENSE 0x0F
77 #define DASD_SIM_MSG_TO_OP 0x03
78 #define DASD_SIM_LOG 0x0C
81 * SECTION: MACROs for klogd and s390 debug feature (dbf)
83 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
85 debug_sprintf_event(d_device->debug_area, \
91 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
93 debug_sprintf_exception(d_device->debug_area, \
99 #define DBF_EVENT(d_level, d_str, d_data...)\
101 debug_sprintf_event(dasd_debug_area, \
107 #define DBF_EXC(d_level, d_str, d_data...)\
109 debug_sprintf_exception(dasd_debug_area, \
115 /* definition of dbf debug levels */
116 #define DBF_EMERG 0 /* system is unusable */
117 #define DBF_ALERT 1 /* action must be taken immediately */
118 #define DBF_CRIT 2 /* critical conditions */
119 #define DBF_ERR 3 /* error conditions */
120 #define DBF_WARNING 4 /* warning conditions */
121 #define DBF_NOTICE 5 /* normal but significant condition */
122 #define DBF_INFO 6 /* informational */
123 #define DBF_DEBUG 6 /* debug-level messages */
125 /* messages to be written via klogd and dbf */
126 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
128 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
129 d_device->cdev->dev.bus_id, d_args); \
130 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
133 #define MESSAGE(d_loglevel,d_string,d_args...)\
135 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
136 DBF_EVENT(DBF_ALERT, d_string, d_args); \
139 /* messages to be written via klogd only */
140 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
142 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
143 d_device->cdev->dev.bus_id, d_args); \
146 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
148 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
151 struct dasd_ccw_req {
152 unsigned int magic; /* Eye catcher */
153 struct list_head devlist; /* for dasd_device request queue */
154 struct list_head blocklist; /* for dasd_block request queue */
156 /* Where to execute what... */
157 struct dasd_block *block; /* the originating block device */
158 struct dasd_device *memdev; /* the device used to allocate this */
159 struct dasd_device *startdev; /* device the request is started on */
160 struct ccw1 *cpaddr; /* address of channel program */
161 char status; /* status of this request */
162 short retries; /* A retry counter */
163 unsigned long flags; /* flags of this request */
166 unsigned long starttime; /* jiffies time of request start */
167 int expires; /* expiration period in jiffies */
168 char lpm; /* logical path mask */
169 void *data; /* pointer to data area */
171 /* these are important for recovering erroneous requests */
172 struct irb irb; /* device status in case of an error */
173 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
174 void *function; /* originating ERP action */
176 /* these are for statistics only */
177 unsigned long long buildclk; /* TOD-clock of request generation */
178 unsigned long long startclk; /* TOD-clock of request start */
179 unsigned long long stopclk; /* TOD-clock of request interrupt */
180 unsigned long long endclk; /* TOD-clock of request termination */
182 /* Callback that is called after reaching final status. */
183 void (*callback)(struct dasd_ccw_req *, void *data);
188 * dasd_ccw_req -> status can be:
190 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
191 #define DASD_CQR_DONE 0x01 /* request is completed successfully */
192 #define DASD_CQR_NEED_ERP 0x02 /* request needs recovery action */
193 #define DASD_CQR_IN_ERP 0x03 /* request is in recovery */
194 #define DASD_CQR_FAILED 0x04 /* request is finally failed */
195 #define DASD_CQR_TERMINATED 0x05 /* request was stopped by driver */
197 #define DASD_CQR_QUEUED 0x80 /* request is queued to be processed */
198 #define DASD_CQR_IN_IO 0x81 /* request is currently in IO */
199 #define DASD_CQR_ERROR 0x82 /* request is completed with error */
200 #define DASD_CQR_CLEAR_PENDING 0x83 /* request is clear pending */
201 #define DASD_CQR_CLEARED 0x84 /* request was cleared */
202 #define DASD_CQR_SUCCESS 0x85 /* request was successfull */
205 /* per dasd_ccw_req flags */
206 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
207 #define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
209 /* Signature for error recovery functions. */
210 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
213 * the struct dasd_discipline is
214 * sth like a table of virtual functions, if you think of dasd_eckd
216 * no, currently we are not planning to reimplement the driver in C++
218 struct dasd_discipline {
219 struct module *owner;
220 char ebcname[8]; /* a name used for tagging and printks */
221 char name[8]; /* a name used for tagging and printks */
222 int max_blocks; /* maximum number of blocks to be chained */
224 struct list_head list; /* used for list of disciplines */
227 * Device recognition functions. check_device is used to verify
228 * the sense data and the information returned by read device
229 * characteristics. It returns 0 if the discipline can be used
230 * for the device in question. uncheck_device is called during
231 * device shutdown to deregister a device from its discipline.
233 int (*check_device) (struct dasd_device *);
234 void (*uncheck_device) (struct dasd_device *);
237 * do_analysis is used in the step from device state "basic" to
238 * state "accept". It returns 0 if the device can be made ready,
239 * it returns -EMEDIUMTYPE if the device can't be made ready or
240 * -EAGAIN if do_analysis started a ccw that needs to complete
241 * before the analysis may be repeated.
243 int (*do_analysis) (struct dasd_block *);
246 * Last things to do when a device is set online, and first things
247 * when it is set offline.
249 int (*ready_to_online) (struct dasd_device *);
250 int (*online_to_ready) (struct dasd_device *);
253 * Device operation functions. build_cp creates a ccw chain for
254 * a block device request, start_io starts the request and
255 * term_IO cancels it (e.g. in case of a timeout). format_device
256 * returns a ccw chain to be used to format the device.
257 * handle_terminated_request allows to examine a cqr and prepare
260 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
263 int (*start_IO) (struct dasd_ccw_req *);
264 int (*term_IO) (struct dasd_ccw_req *);
265 void (*handle_terminated_request) (struct dasd_ccw_req *);
266 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
267 struct format_data_t *);
268 int (*free_cp) (struct dasd_ccw_req *, struct request *);
271 * Error recovery functions. examine_error() returns a value that
272 * indicates what to do for an error condition. If examine_error()
273 * returns 'dasd_era_recover' erp_action() is called to create a
274 * special error recovery ccw. erp_postaction() is called after
275 * an error recovery ccw has finished its execution. dump_sense
276 * is called for every error condition to print the sense data
279 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
280 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
281 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
284 void (*handle_unsolicited_interrupt) (struct dasd_device *,
287 /* i/o control functions. */
288 int (*fill_geometry) (struct dasd_block *, struct hd_geometry *);
289 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
290 int (*ioctl) (struct dasd_block *, unsigned int, void __user *);
293 extern struct dasd_discipline *dasd_diag_discipline_pointer;
296 * Unique identifier for dasd device.
298 #define UA_NOT_CONFIGURED 0x00
299 #define UA_BASE_DEVICE 0x01
300 #define UA_BASE_PAV_ALIAS 0x02
301 #define UA_HYPER_PAV_ALIAS 0x03
313 * Notification numbers for extended error reporting notifications:
314 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
315 * eer pointer) is freed. The error reporting module needs to do all necessary
317 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
319 #define DASD_EER_DISABLE 0
320 #define DASD_EER_TRIGGER 1
322 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
323 #define DASD_EER_FATALERROR 1
324 #define DASD_EER_NOPATH 2
325 #define DASD_EER_STATECHANGE 3
326 #define DASD_EER_PPRCSUSPEND 4
329 /* Block device stuff. */
330 struct dasd_block *block;
332 unsigned int devindex;
333 unsigned long flags; /* per device flags */
334 unsigned short features; /* copy of devmap-features (read-only!) */
336 /* extended error reporting stuff (eer) */
337 struct dasd_ccw_req *eer_cqr;
339 /* Device discipline stuff. */
340 struct dasd_discipline *discipline;
341 struct dasd_discipline *base_discipline;
344 /* Device state and target state. */
346 int stopped; /* device (ccw_device_start) was stopped */
348 /* reference count. */
351 /* ccw queue and memory for static ccw/erp buffers. */
352 struct list_head ccw_queue;
356 struct list_head ccw_chunks;
357 struct list_head erp_chunks;
359 atomic_t tasklet_scheduled;
360 struct tasklet_struct tasklet;
361 struct work_struct kick_work;
362 struct timer_list timer;
364 debug_info_t *debug_area;
366 struct ccw_device *cdev;
368 /* hook for alias management */
369 struct list_head alias_list;
373 /* Block device stuff. */
375 struct request_queue *request_queue;
376 spinlock_t request_queue_lock;
377 struct block_device *bdev;
380 unsigned long blocks; /* size of volume in blocks */
381 unsigned int bp_block; /* bytes per block */
382 unsigned int s2b_shift; /* log2 (bp_block/512) */
384 struct dasd_device *base;
385 struct list_head ccw_queue;
386 spinlock_t queue_lock;
388 atomic_t tasklet_scheduled;
389 struct tasklet_struct tasklet;
390 struct timer_list timer;
392 #ifdef CONFIG_DASD_PROFILE
393 struct dasd_profile_info_t profile;
399 /* reasons why device (ccw_device_start) was stopped */
400 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
401 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
402 #define DASD_STOPPED_PENDING 4 /* long busy */
403 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
404 #define DASD_STOPPED_SU 16 /* summary unit check handling */
406 /* per device flags */
407 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
408 #define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
409 #define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
411 void dasd_put_device_wake(struct dasd_device *);
414 * Reference count inliners
417 dasd_get_device(struct dasd_device *device)
419 atomic_inc(&device->ref_count);
423 dasd_put_device(struct dasd_device *device)
425 if (atomic_dec_return(&device->ref_count) == 0)
426 dasd_put_device_wake(device);
430 * The static memory in ccw_mem and erp_mem is managed by a sorted
431 * list of free memory chunks.
435 struct list_head list;
437 } __attribute__ ((aligned(8)));
440 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
443 struct dasd_mchunk *chunk;
445 INIT_LIST_HEAD(chunk_list);
446 chunk = (struct dasd_mchunk *) mem;
447 chunk->size = size - sizeof(struct dasd_mchunk);
448 list_add(&chunk->list, chunk_list);
452 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
454 struct dasd_mchunk *chunk, *tmp;
456 size = (size + 7L) & -8L;
457 list_for_each_entry(chunk, chunk_list, list) {
458 if (chunk->size < size)
460 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
461 char *endaddr = (char *) (chunk + 1) + chunk->size;
462 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
464 chunk->size -= size + sizeof(struct dasd_mchunk);
467 list_del(&chunk->list);
468 return (void *) (chunk + 1);
474 dasd_free_chunk(struct list_head *chunk_list, void *mem)
476 struct dasd_mchunk *chunk, *tmp;
477 struct list_head *p, *left;
479 chunk = (struct dasd_mchunk *)
480 ((char *) mem - sizeof(struct dasd_mchunk));
481 /* Find out the left neighbour in chunk_list. */
483 list_for_each(p, chunk_list) {
484 if (list_entry(p, struct dasd_mchunk, list) > chunk)
488 /* Try to merge with right neighbour = next element from left. */
489 if (left->next != chunk_list) {
490 tmp = list_entry(left->next, struct dasd_mchunk, list);
491 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
492 list_del(&tmp->list);
493 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
496 /* Try to merge with left neighbour. */
497 if (left != chunk_list) {
498 tmp = list_entry(left, struct dasd_mchunk, list);
499 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
500 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
504 __list_add(&chunk->list, left, left->next);
508 * Check if bsize is in { 512, 1024, 2048, 4096 }
511 dasd_check_blocksize(int bsize)
513 if (bsize < 512 || bsize > 4096 || !is_power_of_2(bsize))
518 /* externals in dasd.c */
519 #define DASD_PROFILE_ON 1
520 #define DASD_PROFILE_OFF 0
522 extern debug_info_t *dasd_debug_area;
523 extern struct dasd_profile_info_t dasd_global_profile;
524 extern unsigned int dasd_profile_level;
525 extern struct block_device_operations dasd_device_operations;
527 extern struct kmem_cache *dasd_page_cache;
529 struct dasd_ccw_req *
530 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
531 struct dasd_ccw_req *
532 dasd_smalloc_request(char *, int, int, struct dasd_device *);
533 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
534 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
537 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
539 return set_normalized_cda(ccw, cda);
542 struct dasd_device *dasd_alloc_device(void);
543 void dasd_free_device(struct dasd_device *);
545 struct dasd_block *dasd_alloc_block(void);
546 void dasd_free_block(struct dasd_block *);
548 void dasd_enable_device(struct dasd_device *);
549 void dasd_set_target_state(struct dasd_device *, int);
550 void dasd_kick_device(struct dasd_device *);
552 void dasd_add_request_head(struct dasd_ccw_req *);
553 void dasd_add_request_tail(struct dasd_ccw_req *);
554 int dasd_start_IO(struct dasd_ccw_req *);
555 int dasd_term_IO(struct dasd_ccw_req *);
556 void dasd_schedule_device_bh(struct dasd_device *);
557 void dasd_schedule_block_bh(struct dasd_block *);
558 int dasd_sleep_on(struct dasd_ccw_req *);
559 int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
560 int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
561 void dasd_device_set_timer(struct dasd_device *, int);
562 void dasd_device_clear_timer(struct dasd_device *);
563 void dasd_block_set_timer(struct dasd_block *, int);
564 void dasd_block_clear_timer(struct dasd_block *);
565 int dasd_cancel_req(struct dasd_ccw_req *);
566 int dasd_flush_device_queue(struct dasd_device *);
567 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
568 void dasd_generic_remove (struct ccw_device *cdev);
569 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
570 int dasd_generic_set_offline (struct ccw_device *cdev);
571 int dasd_generic_notify(struct ccw_device *, int);
572 void dasd_generic_handle_state_change(struct dasd_device *);
574 int dasd_generic_read_dev_chars(struct dasd_device *, char *, void **, int);
576 /* externals in dasd_devmap.c */
577 extern int dasd_max_devindex;
578 extern int dasd_probeonly;
579 extern int dasd_autodetect;
580 extern int dasd_nopav;
582 int dasd_devmap_init(void);
583 void dasd_devmap_exit(void);
585 struct dasd_device *dasd_create_device(struct ccw_device *);
586 void dasd_delete_device(struct dasd_device *);
588 int dasd_get_uid(struct ccw_device *, struct dasd_uid *);
589 int dasd_set_uid(struct ccw_device *, struct dasd_uid *);
590 int dasd_get_feature(struct ccw_device *, int);
591 int dasd_set_feature(struct ccw_device *, int, int);
593 int dasd_add_sysfs_files(struct ccw_device *);
594 void dasd_remove_sysfs_files(struct ccw_device *);
596 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
597 struct dasd_device *dasd_device_from_cdev_locked(struct ccw_device *);
598 struct dasd_device *dasd_device_from_devindex(int);
600 int dasd_parse(void);
601 int dasd_busid_known(const char *);
603 /* externals in dasd_gendisk.c */
604 int dasd_gendisk_init(void);
605 void dasd_gendisk_exit(void);
606 int dasd_gendisk_alloc(struct dasd_block *);
607 void dasd_gendisk_free(struct dasd_block *);
608 int dasd_scan_partitions(struct dasd_block *);
609 void dasd_destroy_partitions(struct dasd_block *);
611 /* externals in dasd_ioctl.c */
612 int dasd_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
613 long dasd_compat_ioctl(struct file *, unsigned int, unsigned long);
615 /* externals in dasd_proc.c */
616 int dasd_proc_init(void);
617 void dasd_proc_exit(void);
619 /* externals in dasd_erp.c */
620 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
621 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
622 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
623 struct dasd_device *);
624 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
625 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
627 /* externals in dasd_3990_erp.c */
628 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
629 void dasd_3990_erp_handle_sim(struct dasd_device *, char *);
631 /* externals in dasd_eer.c */
632 #ifdef CONFIG_DASD_EER
633 int dasd_eer_init(void);
634 void dasd_eer_exit(void);
635 int dasd_eer_enable(struct dasd_device *);
636 void dasd_eer_disable(struct dasd_device *);
637 void dasd_eer_write(struct dasd_device *, struct dasd_ccw_req *cqr,
639 void dasd_eer_snss(struct dasd_device *);
641 static inline int dasd_eer_enabled(struct dasd_device *device)
643 return device->eer_cqr != NULL;
646 #define dasd_eer_init() (0)
647 #define dasd_eer_exit() do { } while (0)
648 #define dasd_eer_enable(d) (0)
649 #define dasd_eer_disable(d) do { } while (0)
650 #define dasd_eer_write(d,c,i) do { } while (0)
651 #define dasd_eer_snss(d) do { } while (0)
652 #define dasd_eer_enabled(d) (0)
653 #endif /* CONFIG_DASD_ERR */
655 #endif /* __KERNEL__ */