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/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
72 dasd_era_fatal = -1, /* no chance to recover */
73 dasd_era_none = 0, /* don't recover, everything alright */
74 dasd_era_msg = 1, /* don't recover, just report... */
75 dasd_era_recover = 2 /* recovery action recommended */
78 /* BIT DEFINITIONS FOR SENSE DATA */
79 #define DASD_SENSE_BIT_0 0x80
80 #define DASD_SENSE_BIT_1 0x40
81 #define DASD_SENSE_BIT_2 0x20
82 #define DASD_SENSE_BIT_3 0x10
85 * SECTION: MACROs for klogd and s390 debug feature (dbf)
87 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
89 debug_sprintf_event(d_device->debug_area, \
95 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
97 debug_sprintf_exception(d_device->debug_area, \
103 #define DBF_EVENT(d_level, d_str, d_data...)\
105 debug_sprintf_event(dasd_debug_area, \
111 #define DBF_EXC(d_level, d_str, d_data...)\
113 debug_sprintf_exception(dasd_debug_area, \
119 /* definition of dbf debug levels */
120 #define DBF_EMERG 0 /* system is unusable */
121 #define DBF_ALERT 1 /* action must be taken immediately */
122 #define DBF_CRIT 2 /* critical conditions */
123 #define DBF_ERR 3 /* error conditions */
124 #define DBF_WARNING 4 /* warning conditions */
125 #define DBF_NOTICE 5 /* normal but significant condition */
126 #define DBF_INFO 6 /* informational */
127 #define DBF_DEBUG 6 /* debug-level messages */
129 /* messages to be written via klogd and dbf */
130 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
132 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
133 d_device->cdev->dev.bus_id, d_args); \
134 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
137 #define MESSAGE(d_loglevel,d_string,d_args...)\
139 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
140 DBF_EVENT(DBF_ALERT, d_string, d_args); \
143 /* messages to be written via klogd only */
144 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
146 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
147 d_device->cdev->dev.bus_id, d_args); \
150 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
152 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
155 struct dasd_ccw_req {
156 unsigned int magic; /* Eye catcher */
157 struct list_head list; /* list_head for request queueing. */
159 /* Where to execute what... */
160 struct dasd_device *device; /* device the request is for */
161 struct ccw1 *cpaddr; /* address of channel program */
162 char status; /* status of this request */
163 short retries; /* A retry counter */
164 unsigned long flags; /* flags of this request */
167 unsigned long starttime; /* jiffies time of request start */
168 int expires; /* expiration period in jiffies */
169 char lpm; /* logical path mask */
170 void *data; /* pointer to data area */
172 /* these are important for recovering erroneous requests */
173 struct irb irb; /* device status in case of an error */
174 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
175 void *function; /* originating ERP action */
177 /* these are for statistics only */
178 unsigned long long buildclk; /* TOD-clock of request generation */
179 unsigned long long startclk; /* TOD-clock of request start */
180 unsigned long long stopclk; /* TOD-clock of request interrupt */
181 unsigned long long endclk; /* TOD-clock of request termination */
183 /* Callback that is called after reaching final status. */
184 void (*callback)(struct dasd_ccw_req *, void *data);
189 * dasd_ccw_req -> status can be:
191 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
192 #define DASD_CQR_QUEUED 0x01 /* request is queued to be processed */
193 #define DASD_CQR_IN_IO 0x02 /* request is currently in IO */
194 #define DASD_CQR_DONE 0x03 /* request is completed successfully */
195 #define DASD_CQR_ERROR 0x04 /* request is completed with error */
196 #define DASD_CQR_FAILED 0x05 /* request is finally failed */
197 #define DASD_CQR_CLEAR 0x06 /* request is clear pending */
199 /* per dasd_ccw_req flags */
200 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
201 #define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
203 /* Signature for error recovery functions. */
204 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
207 * the struct dasd_discipline is
208 * sth like a table of virtual functions, if you think of dasd_eckd
210 * no, currently we are not planning to reimplement the driver in C++
212 struct dasd_discipline {
213 struct module *owner;
214 char ebcname[8]; /* a name used for tagging and printks */
215 char name[8]; /* a name used for tagging and printks */
216 int max_blocks; /* maximum number of blocks to be chained */
218 struct list_head list; /* used for list of disciplines */
221 * Device recognition functions. check_device is used to verify
222 * the sense data and the information returned by read device
223 * characteristics. It returns 0 if the discipline can be used
224 * for the device in question.
225 * do_analysis is used in the step from device state "basic" to
226 * state "accept". It returns 0 if the device can be made ready,
227 * it returns -EMEDIUMTYPE if the device can't be made ready or
228 * -EAGAIN if do_analysis started a ccw that needs to complete
229 * before the analysis may be repeated.
231 int (*check_device)(struct dasd_device *);
232 int (*do_analysis) (struct dasd_device *);
235 * Device operation functions. build_cp creates a ccw chain for
236 * a block device request, start_io starts the request and
237 * term_IO cancels it (e.g. in case of a timeout). format_device
238 * returns a ccw chain to be used to format the device.
240 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
242 int (*start_IO) (struct dasd_ccw_req *);
243 int (*term_IO) (struct dasd_ccw_req *);
244 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
245 struct format_data_t *);
246 int (*free_cp) (struct dasd_ccw_req *, struct request *);
248 * Error recovery functions. examine_error() returns a value that
249 * indicates what to do for an error condition. If examine_error()
250 * returns 'dasd_era_recover' erp_action() is called to create a
251 * special error recovery ccw. erp_postaction() is called after
252 * an error recovery ccw has finished its execution. dump_sense
253 * is called for every error condition to print the sense data
256 dasd_era_t(*examine_error) (struct dasd_ccw_req *, struct irb *);
257 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
258 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
259 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
262 /* i/o control functions. */
263 int (*fill_geometry) (struct dasd_device *, struct hd_geometry *);
264 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
265 int (*ioctl) (struct dasd_device *, unsigned int, void __user *);
268 extern struct dasd_discipline *dasd_diag_discipline_pointer;
271 * Unique identifier for dasd device.
282 * Notification numbers for extended error reporting notifications:
283 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
284 * eer pointer) is freed. The error reporting module needs to do all necessary
286 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
288 #define DASD_EER_DISABLE 0
289 #define DASD_EER_TRIGGER 1
291 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
292 #define DASD_EER_FATALERROR 1
293 #define DASD_EER_NOPATH 2
294 #define DASD_EER_STATECHANGE 3
295 #define DASD_EER_PPRCSUSPEND 4
298 /* Block device stuff. */
300 request_queue_t *request_queue;
301 spinlock_t request_queue_lock;
302 struct block_device *bdev;
303 unsigned int devindex;
304 unsigned long blocks; /* size of volume in blocks */
305 unsigned int bp_block; /* bytes per block */
306 unsigned int s2b_shift; /* log2 (bp_block/512) */
307 unsigned long flags; /* per device flags */
308 unsigned short features; /* copy of devmap-features (read-only!) */
310 /* extended error reporting stuff (eer) */
311 struct dasd_ccw_req *eer_cqr;
313 /* Device discipline stuff. */
314 struct dasd_discipline *discipline;
315 struct dasd_discipline *base_discipline;
318 /* Device state and target state. */
320 int stopped; /* device (ccw_device_start) was stopped */
322 /* Open and reference count. */
326 /* ccw queue and memory for static ccw/erp buffers. */
327 struct list_head ccw_queue;
331 struct list_head ccw_chunks;
332 struct list_head erp_chunks;
334 atomic_t tasklet_scheduled;
335 struct tasklet_struct tasklet;
336 struct work_struct kick_work;
337 struct timer_list timer;
339 debug_info_t *debug_area;
341 struct ccw_device *cdev;
343 #ifdef CONFIG_DASD_PROFILE
344 struct dasd_profile_info_t profile;
348 /* reasons why device (ccw_device_start) was stopped */
349 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
350 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
351 #define DASD_STOPPED_PENDING 4 /* long busy */
352 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
353 #define DASD_STOPPED_DC_EIO 16 /* disconnected, return -EIO */
355 /* per device flags */
356 #define DASD_FLAG_DSC_ERROR 2 /* return -EIO when disconnected */
357 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
358 #define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
359 #define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
361 void dasd_put_device_wake(struct dasd_device *);
364 * Reference count inliners
367 dasd_get_device(struct dasd_device *device)
369 atomic_inc(&device->ref_count);
373 dasd_put_device(struct dasd_device *device)
375 if (atomic_dec_return(&device->ref_count) == 0)
376 dasd_put_device_wake(device);
380 * The static memory in ccw_mem and erp_mem is managed by a sorted
381 * list of free memory chunks.
385 struct list_head list;
387 } __attribute__ ((aligned(8)));
390 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
393 struct dasd_mchunk *chunk;
395 INIT_LIST_HEAD(chunk_list);
396 chunk = (struct dasd_mchunk *) mem;
397 chunk->size = size - sizeof(struct dasd_mchunk);
398 list_add(&chunk->list, chunk_list);
402 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
404 struct dasd_mchunk *chunk, *tmp;
406 size = (size + 7L) & -8L;
407 list_for_each_entry(chunk, chunk_list, list) {
408 if (chunk->size < size)
410 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
411 char *endaddr = (char *) (chunk + 1) + chunk->size;
412 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
414 chunk->size -= size + sizeof(struct dasd_mchunk);
417 list_del(&chunk->list);
418 return (void *) (chunk + 1);
424 dasd_free_chunk(struct list_head *chunk_list, void *mem)
426 struct dasd_mchunk *chunk, *tmp;
427 struct list_head *p, *left;
429 chunk = (struct dasd_mchunk *)
430 ((char *) mem - sizeof(struct dasd_mchunk));
431 /* Find out the left neighbour in chunk_list. */
433 list_for_each(p, chunk_list) {
434 if (list_entry(p, struct dasd_mchunk, list) > chunk)
438 /* Try to merge with right neighbour = next element from left. */
439 if (left->next != chunk_list) {
440 tmp = list_entry(left->next, struct dasd_mchunk, list);
441 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
442 list_del(&tmp->list);
443 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
446 /* Try to merge with left neighbour. */
447 if (left != chunk_list) {
448 tmp = list_entry(left, struct dasd_mchunk, list);
449 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
450 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
454 __list_add(&chunk->list, left, left->next);
458 * Check if bsize is in { 512, 1024, 2048, 4096 }
461 dasd_check_blocksize(int bsize)
463 if (bsize < 512 || bsize > 4096 || (bsize & (bsize - 1)) != 0)
468 /* externals in dasd.c */
469 #define DASD_PROFILE_ON 1
470 #define DASD_PROFILE_OFF 0
472 extern debug_info_t *dasd_debug_area;
473 extern struct dasd_profile_info_t dasd_global_profile;
474 extern unsigned int dasd_profile_level;
475 extern struct block_device_operations dasd_device_operations;
477 extern kmem_cache_t *dasd_page_cache;
479 struct dasd_ccw_req *
480 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
481 struct dasd_ccw_req *
482 dasd_smalloc_request(char *, int, int, struct dasd_device *);
483 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
484 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
487 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
489 return set_normalized_cda(ccw, cda);
492 struct dasd_device *dasd_alloc_device(void);
493 void dasd_free_device(struct dasd_device *);
495 void dasd_enable_device(struct dasd_device *);
496 void dasd_set_target_state(struct dasd_device *, int);
497 void dasd_kick_device(struct dasd_device *);
499 void dasd_add_request_head(struct dasd_ccw_req *);
500 void dasd_add_request_tail(struct dasd_ccw_req *);
501 int dasd_start_IO(struct dasd_ccw_req *);
502 int dasd_term_IO(struct dasd_ccw_req *);
503 void dasd_schedule_bh(struct dasd_device *);
504 int dasd_sleep_on(struct dasd_ccw_req *);
505 int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
506 int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
507 void dasd_set_timer(struct dasd_device *, int);
508 void dasd_clear_timer(struct dasd_device *);
509 int dasd_cancel_req(struct dasd_ccw_req *);
510 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
511 void dasd_generic_remove (struct ccw_device *cdev);
512 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
513 int dasd_generic_set_offline (struct ccw_device *cdev);
514 int dasd_generic_notify(struct ccw_device *, int);
516 /* externals in dasd_devmap.c */
517 extern int dasd_max_devindex;
518 extern int dasd_probeonly;
519 extern int dasd_autodetect;
520 extern int dasd_nopav;
522 int dasd_devmap_init(void);
523 void dasd_devmap_exit(void);
525 struct dasd_device *dasd_create_device(struct ccw_device *);
526 void dasd_delete_device(struct dasd_device *);
528 int dasd_get_uid(struct ccw_device *, struct dasd_uid *);
529 int dasd_set_uid(struct ccw_device *, struct dasd_uid *);
530 int dasd_get_feature(struct ccw_device *, int);
531 int dasd_set_feature(struct ccw_device *, int, int);
533 int dasd_add_sysfs_files(struct ccw_device *);
534 void dasd_remove_sysfs_files(struct ccw_device *);
536 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
537 struct dasd_device *dasd_device_from_cdev_locked(struct ccw_device *);
538 struct dasd_device *dasd_device_from_devindex(int);
540 int dasd_parse(void);
541 int dasd_busid_known(char *);
543 /* externals in dasd_gendisk.c */
544 int dasd_gendisk_init(void);
545 void dasd_gendisk_exit(void);
546 int dasd_gendisk_alloc(struct dasd_device *);
547 void dasd_gendisk_free(struct dasd_device *);
548 int dasd_scan_partitions(struct dasd_device *);
549 void dasd_destroy_partitions(struct dasd_device *);
551 /* externals in dasd_ioctl.c */
552 int dasd_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
553 long dasd_compat_ioctl(struct file *, unsigned int, unsigned long);
555 /* externals in dasd_proc.c */
556 int dasd_proc_init(void);
557 void dasd_proc_exit(void);
559 /* externals in dasd_erp.c */
560 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
561 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
562 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
563 struct dasd_device *);
564 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
565 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
566 void dasd_log_ccw(struct dasd_ccw_req *, int, __u32);
568 /* externals in dasd_3370_erp.c */
569 dasd_era_t dasd_3370_erp_examine(struct dasd_ccw_req *, struct irb *);
571 /* externals in dasd_3990_erp.c */
572 dasd_era_t dasd_3990_erp_examine(struct dasd_ccw_req *, struct irb *);
573 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
575 /* externals in dasd_9336_erp.c */
576 dasd_era_t dasd_9336_erp_examine(struct dasd_ccw_req *, struct irb *);
578 /* externals in dasd_9336_erp.c */
579 dasd_era_t dasd_9343_erp_examine(struct dasd_ccw_req *, struct irb *);
580 struct dasd_ccw_req *dasd_9343_erp_action(struct dasd_ccw_req *);
582 /* externals in dasd_eer.c */
583 #ifdef CONFIG_DASD_EER
584 int dasd_eer_init(void);
585 void dasd_eer_exit(void);
586 int dasd_eer_enable(struct dasd_device *);
587 void dasd_eer_disable(struct dasd_device *);
588 void dasd_eer_write(struct dasd_device *, struct dasd_ccw_req *cqr,
590 void dasd_eer_snss(struct dasd_device *);
592 static inline int dasd_eer_enabled(struct dasd_device *device)
594 return device->eer_cqr != NULL;
597 #define dasd_eer_init() (0)
598 #define dasd_eer_exit() do { } while (0)
599 #define dasd_eer_enable(d) (0)
600 #define dasd_eer_disable(d) do { } while (0)
601 #define dasd_eer_write(d,c,i) do { } while (0)
602 #define dasd_eer_snss(d) do { } while (0)
603 #define dasd_eer_enabled(d) (0)
604 #endif /* CONFIG_DASD_ERR */
606 #endif /* __KERNEL__ */