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 * unfmt: the device could not be analyzed (format is unknown).
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_UNFMT 3
51 #define DASD_STATE_READY 4
52 #define DASD_STATE_ONLINE 5
54 #include <linux/module.h>
55 #include <linux/wait.h>
56 #include <linux/blkdev.h>
57 #include <linux/devfs_fs_kernel.h>
58 #include <linux/genhd.h>
59 #include <linux/hdreg.h>
60 #include <linux/interrupt.h>
61 #include <asm/ccwdev.h>
62 #include <linux/workqueue.h>
63 #include <asm/debug.h>
65 #include <asm/idals.h>
68 * SECTION: Type definitions
72 typedef int (*dasd_ioctl_fn_t) (struct block_device *bdev, int no, long args);
75 struct list_head list;
78 dasd_ioctl_fn_t handler;
82 dasd_era_fatal = -1, /* no chance to recover */
83 dasd_era_none = 0, /* don't recover, everything alright */
84 dasd_era_msg = 1, /* don't recover, just report... */
85 dasd_era_recover = 2 /* recovery action recommended */
88 /* BIT DEFINITIONS FOR SENSE DATA */
89 #define DASD_SENSE_BIT_0 0x80
90 #define DASD_SENSE_BIT_1 0x40
91 #define DASD_SENSE_BIT_2 0x20
92 #define DASD_SENSE_BIT_3 0x10
95 * SECTION: MACROs for klogd and s390 debug feature (dbf)
97 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
99 debug_sprintf_event(d_device->debug_area, \
105 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
107 debug_sprintf_exception(d_device->debug_area, \
113 #define DBF_EVENT(d_level, d_str, d_data...)\
115 debug_sprintf_event(dasd_debug_area, \
121 #define DBF_EXC(d_level, d_str, d_data...)\
123 debug_sprintf_exception(dasd_debug_area, \
129 /* definition of dbf debug levels */
130 #define DBF_EMERG 0 /* system is unusable */
131 #define DBF_ALERT 1 /* action must be taken immediately */
132 #define DBF_CRIT 2 /* critical conditions */
133 #define DBF_ERR 3 /* error conditions */
134 #define DBF_WARNING 4 /* warning conditions */
135 #define DBF_NOTICE 5 /* normal but significant condition */
136 #define DBF_INFO 6 /* informational */
137 #define DBF_DEBUG 6 /* debug-level messages */
139 /* messages to be written via klogd and dbf */
140 #define DEV_MESSAGE(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); \
144 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
147 #define MESSAGE(d_loglevel,d_string,d_args...)\
149 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
150 DBF_EVENT(DBF_ALERT, d_string, d_args); \
153 /* messages to be written via klogd only */
154 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
156 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
157 d_device->cdev->dev.bus_id, d_args); \
160 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
162 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
165 struct dasd_ccw_req {
166 unsigned int magic; /* Eye catcher */
167 struct list_head list; /* list_head for request queueing. */
169 /* Where to execute what... */
170 struct dasd_device *device; /* device the request is for */
171 struct ccw1 *cpaddr; /* address of channel program */
172 char status; /* status of this request */
173 short retries; /* A retry counter */
174 unsigned long flags; /* flags of this request */
177 unsigned long starttime; /* jiffies time of request start */
178 int expires; /* expiration period in jiffies */
179 char lpm; /* logical path mask */
180 void *data; /* pointer to data area */
182 /* these are important for recovering erroneous requests */
183 struct irb irb; /* device status in case of an error */
184 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
185 void *function; /* originating ERP action */
187 /* these are for statistics only */
188 unsigned long long buildclk; /* TOD-clock of request generation */
189 unsigned long long startclk; /* TOD-clock of request start */
190 unsigned long long stopclk; /* TOD-clock of request interrupt */
191 unsigned long long endclk; /* TOD-clock of request termination */
193 /* Callback that is called after reaching final status. */
194 void (*callback)(struct dasd_ccw_req *, void *data);
199 * dasd_ccw_req -> status can be:
201 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
202 #define DASD_CQR_QUEUED 0x01 /* request is queued to be processed */
203 #define DASD_CQR_IN_IO 0x02 /* request is currently in IO */
204 #define DASD_CQR_DONE 0x03 /* request is completed successfully */
205 #define DASD_CQR_ERROR 0x04 /* request is completed with error */
206 #define DASD_CQR_FAILED 0x05 /* request is finally failed */
207 #define DASD_CQR_CLEAR 0x06 /* request is clear pending */
209 /* per dasd_ccw_req flags */
210 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
211 #define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
213 /* Signature for error recovery functions. */
214 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
217 * the struct dasd_discipline is
218 * sth like a table of virtual functions, if you think of dasd_eckd
220 * no, currently we are not planning to reimplement the driver in C++
222 struct dasd_discipline {
223 struct module *owner;
224 char ebcname[8]; /* a name used for tagging and printks */
225 char name[8]; /* a name used for tagging and printks */
226 int max_blocks; /* maximum number of blocks to be chained */
228 struct list_head list; /* used for list of disciplines */
231 * Device recognition functions. check_device is used to verify
232 * the sense data and the information returned by read device
233 * characteristics. It returns 0 if the discipline can be used
234 * for the device in question.
235 * do_analysis is used in the step from device state "basic" to
236 * state "accept". It returns 0 if the device can be made ready,
237 * it returns -EMEDIUMTYPE if the device can't be made ready or
238 * -EAGAIN if do_analysis started a ccw that needs to complete
239 * before the analysis may be repeated.
241 int (*check_device)(struct dasd_device *);
242 int (*do_analysis) (struct dasd_device *);
245 * Device operation functions. build_cp creates a ccw chain for
246 * a block device request, start_io starts the request and
247 * term_IO cancels it (e.g. in case of a timeout). format_device
248 * returns a ccw chain to be used to format the device.
250 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
252 int (*start_IO) (struct dasd_ccw_req *);
253 int (*term_IO) (struct dasd_ccw_req *);
254 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
255 struct format_data_t *);
256 int (*free_cp) (struct dasd_ccw_req *, struct request *);
258 * Error recovery functions. examine_error() returns a value that
259 * indicates what to do for an error condition. If examine_error()
260 * returns 'dasd_era_recover' erp_action() is called to create a
261 * special error recovery ccw. erp_postaction() is called after
262 * an error recovery ccw has finished its execution. dump_sense
263 * is called for every error condition to print the sense data
266 dasd_era_t(*examine_error) (struct dasd_ccw_req *, struct irb *);
267 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
268 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
269 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
272 /* i/o control functions. */
273 int (*fill_geometry) (struct dasd_device *, struct hd_geometry *);
274 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
277 extern struct dasd_discipline *dasd_diag_discipline_pointer;
280 /* Block device stuff. */
282 request_queue_t *request_queue;
283 spinlock_t request_queue_lock;
284 struct block_device *bdev;
285 unsigned int devindex;
286 unsigned long blocks; /* size of volume in blocks */
287 unsigned int bp_block; /* bytes per block */
288 unsigned int s2b_shift; /* log2 (bp_block/512) */
289 unsigned long flags; /* per device flags */
290 unsigned short features; /* copy of devmap-features (read-only!) */
292 /* Device discipline stuff. */
293 struct dasd_discipline *discipline;
294 struct dasd_discipline *base_discipline;
297 /* Device state and target state. */
299 int stopped; /* device (ccw_device_start) was stopped */
301 /* Open and reference count. */
305 /* ccw queue and memory for static ccw/erp buffers. */
306 struct list_head ccw_queue;
310 struct list_head ccw_chunks;
311 struct list_head erp_chunks;
313 atomic_t tasklet_scheduled;
314 struct tasklet_struct tasklet;
315 struct work_struct kick_work;
316 struct timer_list timer;
318 debug_info_t *debug_area;
320 struct ccw_device *cdev;
322 #ifdef CONFIG_DASD_PROFILE
323 struct dasd_profile_info_t profile;
327 /* reasons why device (ccw_device_start) was stopped */
328 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
329 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
330 #define DASD_STOPPED_PENDING 4 /* long busy */
331 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
332 #define DASD_STOPPED_DC_EIO 16 /* disconnected, return -EIO */
334 /* per device flags */
335 #define DASD_FLAG_DSC_ERROR 2 /* return -EIO when disconnected */
336 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
338 void dasd_put_device_wake(struct dasd_device *);
341 * Reference count inliners
344 dasd_get_device(struct dasd_device *device)
346 atomic_inc(&device->ref_count);
350 dasd_put_device(struct dasd_device *device)
352 if (atomic_dec_return(&device->ref_count) == 0)
353 dasd_put_device_wake(device);
357 * The static memory in ccw_mem and erp_mem is managed by a sorted
358 * list of free memory chunks.
362 struct list_head list;
364 } __attribute__ ((aligned(8)));
367 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
370 struct dasd_mchunk *chunk;
372 INIT_LIST_HEAD(chunk_list);
373 chunk = (struct dasd_mchunk *) mem;
374 chunk->size = size - sizeof(struct dasd_mchunk);
375 list_add(&chunk->list, chunk_list);
379 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
381 struct dasd_mchunk *chunk, *tmp;
383 size = (size + 7L) & -8L;
384 list_for_each_entry(chunk, chunk_list, list) {
385 if (chunk->size < size)
387 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
388 char *endaddr = (char *) (chunk + 1) + chunk->size;
389 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
391 chunk->size -= size + sizeof(struct dasd_mchunk);
394 list_del(&chunk->list);
395 return (void *) (chunk + 1);
401 dasd_free_chunk(struct list_head *chunk_list, void *mem)
403 struct dasd_mchunk *chunk, *tmp;
404 struct list_head *p, *left;
406 chunk = (struct dasd_mchunk *)
407 ((char *) mem - sizeof(struct dasd_mchunk));
408 /* Find out the left neighbour in chunk_list. */
410 list_for_each(p, chunk_list) {
411 if (list_entry(p, struct dasd_mchunk, list) > chunk)
415 /* Try to merge with right neighbour = next element from left. */
416 if (left->next != chunk_list) {
417 tmp = list_entry(left->next, struct dasd_mchunk, list);
418 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
419 list_del(&tmp->list);
420 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
423 /* Try to merge with left neighbour. */
424 if (left != chunk_list) {
425 tmp = list_entry(left, struct dasd_mchunk, list);
426 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
427 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
431 __list_add(&chunk->list, left, left->next);
435 * Check if bsize is in { 512, 1024, 2048, 4096 }
438 dasd_check_blocksize(int bsize)
440 if (bsize < 512 || bsize > 4096 || (bsize & (bsize - 1)) != 0)
445 /* externals in dasd.c */
446 #define DASD_PROFILE_ON 1
447 #define DASD_PROFILE_OFF 0
449 extern debug_info_t *dasd_debug_area;
450 extern struct dasd_profile_info_t dasd_global_profile;
451 extern unsigned int dasd_profile_level;
452 extern struct block_device_operations dasd_device_operations;
454 extern kmem_cache_t *dasd_page_cache;
456 struct dasd_ccw_req *
457 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
458 struct dasd_ccw_req *
459 dasd_smalloc_request(char *, int, int, struct dasd_device *);
460 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
461 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
464 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
466 return set_normalized_cda(ccw, cda);
469 struct dasd_device *dasd_alloc_device(void);
470 void dasd_free_device(struct dasd_device *);
472 void dasd_enable_device(struct dasd_device *);
473 void dasd_set_target_state(struct dasd_device *, int);
474 void dasd_kick_device(struct dasd_device *);
476 void dasd_add_request_head(struct dasd_ccw_req *);
477 void dasd_add_request_tail(struct dasd_ccw_req *);
478 int dasd_start_IO(struct dasd_ccw_req *);
479 int dasd_term_IO(struct dasd_ccw_req *);
480 void dasd_schedule_bh(struct dasd_device *);
481 int dasd_sleep_on(struct dasd_ccw_req *);
482 int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
483 int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
484 void dasd_set_timer(struct dasd_device *, int);
485 void dasd_clear_timer(struct dasd_device *);
486 int dasd_cancel_req(struct dasd_ccw_req *);
487 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
488 void dasd_generic_remove (struct ccw_device *cdev);
489 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
490 int dasd_generic_set_offline (struct ccw_device *cdev);
491 int dasd_generic_notify(struct ccw_device *, int);
492 void dasd_generic_auto_online (struct ccw_driver *);
494 /* externals in dasd_devmap.c */
495 extern int dasd_max_devindex;
496 extern int dasd_probeonly;
497 extern int dasd_autodetect;
499 int dasd_devmap_init(void);
500 void dasd_devmap_exit(void);
502 struct dasd_device *dasd_create_device(struct ccw_device *);
503 void dasd_delete_device(struct dasd_device *);
505 int dasd_get_feature(struct ccw_device *, int);
506 int dasd_set_feature(struct ccw_device *, int, int);
508 int dasd_add_sysfs_files(struct ccw_device *);
509 void dasd_remove_sysfs_files(struct ccw_device *);
511 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
512 struct dasd_device *dasd_device_from_devindex(int);
514 int dasd_parse(void);
515 int dasd_busid_known(char *);
517 /* externals in dasd_gendisk.c */
518 int dasd_gendisk_init(void);
519 void dasd_gendisk_exit(void);
520 int dasd_gendisk_alloc(struct dasd_device *);
521 void dasd_gendisk_free(struct dasd_device *);
522 int dasd_scan_partitions(struct dasd_device *);
523 void dasd_destroy_partitions(struct dasd_device *);
525 /* externals in dasd_ioctl.c */
526 int dasd_ioctl_init(void);
527 void dasd_ioctl_exit(void);
528 int dasd_ioctl_no_register(struct module *, int, dasd_ioctl_fn_t);
529 int dasd_ioctl_no_unregister(struct module *, int, dasd_ioctl_fn_t);
530 int dasd_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
531 long dasd_compat_ioctl(struct file *, unsigned int, unsigned long);
533 /* externals in dasd_proc.c */
534 int dasd_proc_init(void);
535 void dasd_proc_exit(void);
537 /* externals in dasd_erp.c */
538 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
539 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
540 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
541 struct dasd_device *);
542 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
543 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
544 void dasd_log_ccw(struct dasd_ccw_req *, int, __u32);
546 /* externals in dasd_3370_erp.c */
547 dasd_era_t dasd_3370_erp_examine(struct dasd_ccw_req *, struct irb *);
549 /* externals in dasd_3990_erp.c */
550 dasd_era_t dasd_3990_erp_examine(struct dasd_ccw_req *, struct irb *);
551 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
553 /* externals in dasd_9336_erp.c */
554 dasd_era_t dasd_9336_erp_examine(struct dasd_ccw_req *, struct irb *);
556 /* externals in dasd_9336_erp.c */
557 dasd_era_t dasd_9343_erp_examine(struct dasd_ccw_req *, struct irb *);
558 struct dasd_ccw_req *dasd_9343_erp_action(struct dasd_ccw_req *);
560 #endif /* __KERNEL__ */
565 * Overrides for Emacs so that we follow Linus's tabbing style.
566 * Emacs will notice this stuff at the end of the file and automatically
567 * adjust the settings for this buffer only. This must remain at the end
569 * ---------------------------------------------------------------------------
572 * c-brace-imaginary-offset: 0
574 * c-argdecl-indent: 4
576 * c-continued-statement-offset: 4
577 * c-continued-brace-offset: 0
578 * indent-tabs-mode: 1