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 * Copyright IBM Corp. 1999, 2009
15 /* 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)
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.
24 * unfmt: the device could not be analyzed (format is unknown).
25 * ready: partition detection is done and the device is can do block io.
26 * online: the device accepts requests from the block device queue.
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.
42 #define DASD_STATE_NEW 0
43 #define DASD_STATE_KNOWN 1
44 #define DASD_STATE_BASIC 2
45 #define DASD_STATE_UNFMT 3
46 #define DASD_STATE_READY 4
47 #define DASD_STATE_ONLINE 5
49 #include <linux/module.h>
50 #include <linux/wait.h>
51 #include <linux/blkdev.h>
52 #include <linux/genhd.h>
53 #include <linux/hdreg.h>
54 #include <linux/interrupt.h>
55 #include <linux/log2.h>
56 #include <asm/ccwdev.h>
57 #include <linux/workqueue.h>
58 #include <asm/debug.h>
60 #include <asm/idals.h>
63 * SECTION: Type definitions
68 /* BIT DEFINITIONS FOR SENSE DATA */
69 #define DASD_SENSE_BIT_0 0x80
70 #define DASD_SENSE_BIT_1 0x40
71 #define DASD_SENSE_BIT_2 0x20
72 #define DASD_SENSE_BIT_3 0x10
74 /* BIT DEFINITIONS FOR SIM SENSE */
75 #define DASD_SIM_SENSE 0x0F
76 #define DASD_SIM_MSG_TO_OP 0x03
77 #define DASD_SIM_LOG 0x0C
80 * SECTION: MACROs for klogd and s390 debug feature (dbf)
82 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
84 debug_sprintf_event(d_device->debug_area, \
90 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
92 debug_sprintf_exception(d_device->debug_area, \
98 #define DBF_EVENT(d_level, d_str, d_data...)\
100 debug_sprintf_event(dasd_debug_area, \
106 #define DBF_EXC(d_level, d_str, d_data...)\
108 debug_sprintf_exception(dasd_debug_area, \
114 /* limit size for an errorstring */
115 #define ERRORLENGTH 30
117 /* definition of dbf debug levels */
118 #define DBF_EMERG 0 /* system is unusable */
119 #define DBF_ALERT 1 /* action must be taken immediately */
120 #define DBF_CRIT 2 /* critical conditions */
121 #define DBF_ERR 3 /* error conditions */
122 #define DBF_WARNING 4 /* warning conditions */
123 #define DBF_NOTICE 5 /* normal but significant condition */
124 #define DBF_INFO 6 /* informational */
125 #define DBF_DEBUG 6 /* debug-level messages */
127 /* messages to be written via klogd and dbf */
128 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
130 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
131 dev_name(&d_device->cdev->dev), d_args); \
132 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
135 #define MESSAGE(d_loglevel,d_string,d_args...)\
137 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
138 DBF_EVENT(DBF_ALERT, d_string, d_args); \
141 /* messages to be written via klogd only */
142 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
144 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
145 dev_name(&d_device->cdev->dev), d_args); \
148 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
150 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
153 struct dasd_ccw_req {
154 unsigned int magic; /* Eye catcher */
155 struct list_head devlist; /* for dasd_device request queue */
156 struct list_head blocklist; /* for dasd_block request queue */
158 /* Where to execute what... */
159 struct dasd_block *block; /* the originating block device */
160 struct dasd_device *memdev; /* the device used to allocate this */
161 struct dasd_device *startdev; /* device the request is started on */
162 void *cpaddr; /* address of ccw or tcw */
163 unsigned char cpmode; /* 0 = cmd mode, 1 = itcw */
164 char status; /* status of this request */
165 short retries; /* A retry counter */
166 unsigned long flags; /* flags of this request */
169 unsigned long starttime; /* jiffies time of request start */
170 int expires; /* expiration period in jiffies */
171 char lpm; /* logical path mask */
172 void *data; /* pointer to data area */
174 /* these are important for recovering erroneous requests */
175 int intrc; /* internal error, e.g. from start_IO */
176 struct irb irb; /* device status in case of an error */
177 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
178 void *function; /* originating ERP action */
180 /* these are for statistics only */
181 unsigned long long buildclk; /* TOD-clock of request generation */
182 unsigned long long startclk; /* TOD-clock of request start */
183 unsigned long long stopclk; /* TOD-clock of request interrupt */
184 unsigned long long endclk; /* TOD-clock of request termination */
186 /* Callback that is called after reaching final status. */
187 void (*callback)(struct dasd_ccw_req *, void *data);
192 * dasd_ccw_req -> status can be:
194 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
195 #define DASD_CQR_DONE 0x01 /* request is completed successfully */
196 #define DASD_CQR_NEED_ERP 0x02 /* request needs recovery action */
197 #define DASD_CQR_IN_ERP 0x03 /* request is in recovery */
198 #define DASD_CQR_FAILED 0x04 /* request is finally failed */
199 #define DASD_CQR_TERMINATED 0x05 /* request was stopped by driver */
201 #define DASD_CQR_QUEUED 0x80 /* request is queued to be processed */
202 #define DASD_CQR_IN_IO 0x81 /* request is currently in IO */
203 #define DASD_CQR_ERROR 0x82 /* request is completed with error */
204 #define DASD_CQR_CLEAR_PENDING 0x83 /* request is clear pending */
205 #define DASD_CQR_CLEARED 0x84 /* request was cleared */
206 #define DASD_CQR_SUCCESS 0x85 /* request was successful */
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. uncheck_device is called during
235 * device shutdown to deregister a device from its discipline.
237 int (*check_device) (struct dasd_device *);
238 void (*uncheck_device) (struct dasd_device *);
241 * do_analysis is used in the step from device state "basic" to
242 * state "accept". It returns 0 if the device can be made ready,
243 * it returns -EMEDIUMTYPE if the device can't be made ready or
244 * -EAGAIN if do_analysis started a ccw that needs to complete
245 * before the analysis may be repeated.
247 int (*do_analysis) (struct dasd_block *);
250 * Last things to do when a device is set online, and first things
251 * when it is set offline.
253 int (*ready_to_online) (struct dasd_device *);
254 int (*online_to_ready) (struct dasd_device *);
257 * Device operation functions. build_cp creates a ccw chain for
258 * a block device request, start_io starts the request and
259 * term_IO cancels it (e.g. in case of a timeout). format_device
260 * returns a ccw chain to be used to format the device.
261 * handle_terminated_request allows to examine a cqr and prepare
264 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
267 int (*start_IO) (struct dasd_ccw_req *);
268 int (*term_IO) (struct dasd_ccw_req *);
269 void (*handle_terminated_request) (struct dasd_ccw_req *);
270 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
271 struct format_data_t *);
272 int (*free_cp) (struct dasd_ccw_req *, struct request *);
275 * Error recovery functions. examine_error() returns a value that
276 * indicates what to do for an error condition. If examine_error()
277 * returns 'dasd_era_recover' erp_action() is called to create a
278 * special error recovery ccw. erp_postaction() is called after
279 * an error recovery ccw has finished its execution. dump_sense
280 * is called for every error condition to print the sense data
283 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
284 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
285 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
287 void (*dump_sense_dbf) (struct dasd_device *, struct dasd_ccw_req *,
288 struct irb *, char *);
290 void (*handle_unsolicited_interrupt) (struct dasd_device *,
293 /* i/o control functions. */
294 int (*fill_geometry) (struct dasd_block *, struct hd_geometry *);
295 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
296 int (*ioctl) (struct dasd_block *, unsigned int, void __user *);
298 /* suspend/resume functions */
299 int (*freeze) (struct dasd_device *);
300 int (*restore) (struct dasd_device *);
303 extern struct dasd_discipline *dasd_diag_discipline_pointer;
306 * Unique identifier for dasd device.
308 #define UA_NOT_CONFIGURED 0x00
309 #define UA_BASE_DEVICE 0x01
310 #define UA_BASE_PAV_ALIAS 0x02
311 #define UA_HYPER_PAV_ALIAS 0x03
324 * Notification numbers for extended error reporting notifications:
325 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
326 * eer pointer) is freed. The error reporting module needs to do all necessary
328 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
330 #define DASD_EER_DISABLE 0
331 #define DASD_EER_TRIGGER 1
333 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
334 #define DASD_EER_FATALERROR 1
335 #define DASD_EER_NOPATH 2
336 #define DASD_EER_STATECHANGE 3
337 #define DASD_EER_PPRCSUSPEND 4
340 /* Block device stuff. */
341 struct dasd_block *block;
343 unsigned int devindex;
344 unsigned long flags; /* per device flags */
345 unsigned short features; /* copy of devmap-features (read-only!) */
347 /* extended error reporting stuff (eer) */
348 struct dasd_ccw_req *eer_cqr;
350 /* Device discipline stuff. */
351 struct dasd_discipline *discipline;
352 struct dasd_discipline *base_discipline;
355 /* Device state and target state. */
357 int stopped; /* device (ccw_device_start) was stopped */
359 /* reference count. */
362 /* ccw queue and memory for static ccw/erp buffers. */
363 struct list_head ccw_queue;
367 struct list_head ccw_chunks;
368 struct list_head erp_chunks;
370 atomic_t tasklet_scheduled;
371 struct tasklet_struct tasklet;
372 struct work_struct kick_work;
373 struct work_struct restore_device;
374 struct timer_list timer;
376 debug_info_t *debug_area;
378 struct ccw_device *cdev;
380 /* hook for alias management */
381 struct list_head alias_list;
385 /* Block device stuff. */
387 struct request_queue *request_queue;
388 spinlock_t request_queue_lock;
389 struct block_device *bdev;
392 unsigned long long blocks; /* size of volume in blocks */
393 unsigned int bp_block; /* bytes per block */
394 unsigned int s2b_shift; /* log2 (bp_block/512) */
396 struct dasd_device *base;
397 struct list_head ccw_queue;
398 spinlock_t queue_lock;
400 atomic_t tasklet_scheduled;
401 struct tasklet_struct tasklet;
402 struct timer_list timer;
404 #ifdef CONFIG_DASD_PROFILE
405 struct dasd_profile_info_t profile;
411 /* reasons why device (ccw_device_start) was stopped */
412 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
413 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
414 #define DASD_STOPPED_PENDING 4 /* long busy */
415 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
416 #define DASD_STOPPED_SU 16 /* summary unit check handling */
417 #define DASD_STOPPED_PM 32 /* pm state transition */
418 #define DASD_UNRESUMED_PM 64 /* pm resume failed state */
420 /* per device flags */
421 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
422 #define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
423 #define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
425 void dasd_put_device_wake(struct dasd_device *);
428 * Reference count inliners
431 dasd_get_device(struct dasd_device *device)
433 atomic_inc(&device->ref_count);
437 dasd_put_device(struct dasd_device *device)
439 if (atomic_dec_return(&device->ref_count) == 0)
440 dasd_put_device_wake(device);
444 * The static memory in ccw_mem and erp_mem is managed by a sorted
445 * list of free memory chunks.
449 struct list_head list;
451 } __attribute__ ((aligned(8)));
454 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
457 struct dasd_mchunk *chunk;
459 INIT_LIST_HEAD(chunk_list);
460 chunk = (struct dasd_mchunk *) mem;
461 chunk->size = size - sizeof(struct dasd_mchunk);
462 list_add(&chunk->list, chunk_list);
466 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
468 struct dasd_mchunk *chunk, *tmp;
470 size = (size + 7L) & -8L;
471 list_for_each_entry(chunk, chunk_list, list) {
472 if (chunk->size < size)
474 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
475 char *endaddr = (char *) (chunk + 1) + chunk->size;
476 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
478 chunk->size -= size + sizeof(struct dasd_mchunk);
481 list_del(&chunk->list);
482 return (void *) (chunk + 1);
488 dasd_free_chunk(struct list_head *chunk_list, void *mem)
490 struct dasd_mchunk *chunk, *tmp;
491 struct list_head *p, *left;
493 chunk = (struct dasd_mchunk *)
494 ((char *) mem - sizeof(struct dasd_mchunk));
495 /* Find out the left neighbour in chunk_list. */
497 list_for_each(p, chunk_list) {
498 if (list_entry(p, struct dasd_mchunk, list) > chunk)
502 /* Try to merge with right neighbour = next element from left. */
503 if (left->next != chunk_list) {
504 tmp = list_entry(left->next, struct dasd_mchunk, list);
505 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
506 list_del(&tmp->list);
507 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
510 /* Try to merge with left neighbour. */
511 if (left != chunk_list) {
512 tmp = list_entry(left, struct dasd_mchunk, list);
513 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
514 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
518 __list_add(&chunk->list, left, left->next);
522 * Check if bsize is in { 512, 1024, 2048, 4096 }
525 dasd_check_blocksize(int bsize)
527 if (bsize < 512 || bsize > 4096 || !is_power_of_2(bsize))
532 /* externals in dasd.c */
533 #define DASD_PROFILE_ON 1
534 #define DASD_PROFILE_OFF 0
536 extern debug_info_t *dasd_debug_area;
537 extern struct dasd_profile_info_t dasd_global_profile;
538 extern unsigned int dasd_profile_level;
539 extern struct block_device_operations dasd_device_operations;
541 extern struct kmem_cache *dasd_page_cache;
543 struct dasd_ccw_req *
544 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
545 struct dasd_ccw_req *
546 dasd_smalloc_request(char *, int, int, struct dasd_device *);
547 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
548 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
551 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
553 return set_normalized_cda(ccw, cda);
556 struct dasd_device *dasd_alloc_device(void);
557 void dasd_free_device(struct dasd_device *);
559 struct dasd_block *dasd_alloc_block(void);
560 void dasd_free_block(struct dasd_block *);
562 void dasd_enable_device(struct dasd_device *);
563 void dasd_set_target_state(struct dasd_device *, int);
564 void dasd_kick_device(struct dasd_device *);
565 void dasd_restore_device(struct dasd_device *);
567 void dasd_add_request_head(struct dasd_ccw_req *);
568 void dasd_add_request_tail(struct dasd_ccw_req *);
569 int dasd_start_IO(struct dasd_ccw_req *);
570 int dasd_term_IO(struct dasd_ccw_req *);
571 void dasd_schedule_device_bh(struct dasd_device *);
572 void dasd_schedule_block_bh(struct dasd_block *);
573 int dasd_sleep_on(struct dasd_ccw_req *);
574 int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
575 int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
576 void dasd_device_set_timer(struct dasd_device *, int);
577 void dasd_device_clear_timer(struct dasd_device *);
578 void dasd_block_set_timer(struct dasd_block *, int);
579 void dasd_block_clear_timer(struct dasd_block *);
580 int dasd_cancel_req(struct dasd_ccw_req *);
581 int dasd_flush_device_queue(struct dasd_device *);
582 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
583 void dasd_generic_remove (struct ccw_device *cdev);
584 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
585 int dasd_generic_set_offline (struct ccw_device *cdev);
586 int dasd_generic_notify(struct ccw_device *, int);
587 void dasd_generic_handle_state_change(struct dasd_device *);
588 int dasd_generic_pm_freeze(struct ccw_device *);
589 int dasd_generic_restore_device(struct ccw_device *);
591 int dasd_generic_read_dev_chars(struct dasd_device *, char *, void *, int);
592 char *dasd_get_sense(struct irb *);
594 /* externals in dasd_devmap.c */
595 extern int dasd_max_devindex;
596 extern int dasd_probeonly;
597 extern int dasd_autodetect;
598 extern int dasd_nopav;
599 extern int dasd_nofcx;
601 int dasd_devmap_init(void);
602 void dasd_devmap_exit(void);
604 struct dasd_device *dasd_create_device(struct ccw_device *);
605 void dasd_delete_device(struct dasd_device *);
607 int dasd_get_uid(struct ccw_device *, struct dasd_uid *);
608 int dasd_set_uid(struct ccw_device *, struct dasd_uid *);
609 int dasd_get_feature(struct ccw_device *, int);
610 int dasd_set_feature(struct ccw_device *, int, int);
612 int dasd_add_sysfs_files(struct ccw_device *);
613 void dasd_remove_sysfs_files(struct ccw_device *);
615 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
616 struct dasd_device *dasd_device_from_cdev_locked(struct ccw_device *);
617 struct dasd_device *dasd_device_from_devindex(int);
619 int dasd_parse(void);
620 int dasd_busid_known(const char *);
622 /* externals in dasd_gendisk.c */
623 int dasd_gendisk_init(void);
624 void dasd_gendisk_exit(void);
625 int dasd_gendisk_alloc(struct dasd_block *);
626 void dasd_gendisk_free(struct dasd_block *);
627 int dasd_scan_partitions(struct dasd_block *);
628 void dasd_destroy_partitions(struct dasd_block *);
630 /* externals in dasd_ioctl.c */
631 int dasd_ioctl(struct block_device *, fmode_t, unsigned int, unsigned long);
633 /* externals in dasd_proc.c */
634 int dasd_proc_init(void);
635 void dasd_proc_exit(void);
637 /* externals in dasd_erp.c */
638 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
639 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
640 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int,
641 struct dasd_device *);
642 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
643 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
644 void dasd_log_sense_dbf(struct dasd_ccw_req *cqr, struct irb *irb);
646 /* externals in dasd_3990_erp.c */
647 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
648 void dasd_3990_erp_handle_sim(struct dasd_device *, char *);
650 /* externals in dasd_eer.c */
651 #ifdef CONFIG_DASD_EER
652 int dasd_eer_init(void);
653 void dasd_eer_exit(void);
654 int dasd_eer_enable(struct dasd_device *);
655 void dasd_eer_disable(struct dasd_device *);
656 void dasd_eer_write(struct dasd_device *, struct dasd_ccw_req *cqr,
658 void dasd_eer_snss(struct dasd_device *);
660 static inline int dasd_eer_enabled(struct dasd_device *device)
662 return device->eer_cqr != NULL;
665 #define dasd_eer_init() (0)
666 #define dasd_eer_exit() do { } while (0)
667 #define dasd_eer_enable(d) (0)
668 #define dasd_eer_disable(d) do { } while (0)
669 #define dasd_eer_write(d,c,i) do { } while (0)
670 #define dasd_eer_snss(d) do { } while (0)
671 #define dasd_eer_enabled(d) (0)
672 #endif /* CONFIG_DASD_ERR */
674 #endif /* __KERNEL__ */