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
76 * SECTION: MACROs for klogd and s390 debug feature (dbf)
78 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
80 debug_sprintf_event(d_device->debug_area, \
86 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
88 debug_sprintf_exception(d_device->debug_area, \
94 #define DBF_EVENT(d_level, d_str, d_data...)\
96 debug_sprintf_event(dasd_debug_area, \
102 #define DBF_EXC(d_level, d_str, d_data...)\
104 debug_sprintf_exception(dasd_debug_area, \
110 /* definition of dbf debug levels */
111 #define DBF_EMERG 0 /* system is unusable */
112 #define DBF_ALERT 1 /* action must be taken immediately */
113 #define DBF_CRIT 2 /* critical conditions */
114 #define DBF_ERR 3 /* error conditions */
115 #define DBF_WARNING 4 /* warning conditions */
116 #define DBF_NOTICE 5 /* normal but significant condition */
117 #define DBF_INFO 6 /* informational */
118 #define DBF_DEBUG 6 /* debug-level messages */
120 /* messages to be written via klogd and dbf */
121 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
123 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
124 d_device->cdev->dev.bus_id, d_args); \
125 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
128 #define MESSAGE(d_loglevel,d_string,d_args...)\
130 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
131 DBF_EVENT(DBF_ALERT, d_string, d_args); \
134 /* messages to be written via klogd only */
135 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
137 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
138 d_device->cdev->dev.bus_id, d_args); \
141 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
143 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
146 struct dasd_ccw_req
{
147 unsigned int magic
; /* Eye catcher */
148 struct list_head devlist
; /* for dasd_device request queue */
149 struct list_head blocklist
; /* for dasd_block request queue */
151 /* Where to execute what... */
152 struct dasd_block
*block
; /* the originating block device */
153 struct dasd_device
*memdev
; /* the device used to allocate this */
154 struct dasd_device
*startdev
; /* device the request is started on */
155 struct ccw1
*cpaddr
; /* address of channel program */
156 char status
; /* status of this request */
157 short retries
; /* A retry counter */
158 unsigned long flags
; /* flags of this request */
161 unsigned long starttime
; /* jiffies time of request start */
162 int expires
; /* expiration period in jiffies */
163 char lpm
; /* logical path mask */
164 void *data
; /* pointer to data area */
166 /* these are important for recovering erroneous requests */
167 struct irb irb
; /* device status in case of an error */
168 struct dasd_ccw_req
*refers
; /* ERP-chain queueing. */
169 void *function
; /* originating ERP action */
171 /* these are for statistics only */
172 unsigned long long buildclk
; /* TOD-clock of request generation */
173 unsigned long long startclk
; /* TOD-clock of request start */
174 unsigned long long stopclk
; /* TOD-clock of request interrupt */
175 unsigned long long endclk
; /* TOD-clock of request termination */
177 /* Callback that is called after reaching final status. */
178 void (*callback
)(struct dasd_ccw_req
*, void *data
);
183 * dasd_ccw_req -> status can be:
185 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
186 #define DASD_CQR_DONE 0x01 /* request is completed successfully */
187 #define DASD_CQR_NEED_ERP 0x02 /* request needs recovery action */
188 #define DASD_CQR_IN_ERP 0x03 /* request is in recovery */
189 #define DASD_CQR_FAILED 0x04 /* request is finally failed */
190 #define DASD_CQR_TERMINATED 0x05 /* request was stopped by driver */
192 #define DASD_CQR_QUEUED 0x80 /* request is queued to be processed */
193 #define DASD_CQR_IN_IO 0x81 /* request is currently in IO */
194 #define DASD_CQR_ERROR 0x82 /* request is completed with error */
195 #define DASD_CQR_CLEAR_PENDING 0x83 /* request is clear pending */
196 #define DASD_CQR_CLEARED 0x84 /* request was cleared */
197 #define DASD_CQR_SUCCESS 0x85 /* request was successfull */
200 /* per dasd_ccw_req flags */
201 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
202 #define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
204 /* Signature for error recovery functions. */
205 typedef struct dasd_ccw_req
*(*dasd_erp_fn_t
) (struct dasd_ccw_req
*);
208 * the struct dasd_discipline is
209 * sth like a table of virtual functions, if you think of dasd_eckd
211 * no, currently we are not planning to reimplement the driver in C++
213 struct dasd_discipline
{
214 struct module
*owner
;
215 char ebcname
[8]; /* a name used for tagging and printks */
216 char name
[8]; /* a name used for tagging and printks */
217 int max_blocks
; /* maximum number of blocks to be chained */
219 struct list_head list
; /* used for list of disciplines */
222 * Device recognition functions. check_device is used to verify
223 * the sense data and the information returned by read device
224 * characteristics. It returns 0 if the discipline can be used
225 * for the device in question. uncheck_device is called during
226 * device shutdown to deregister a device from its discipline.
228 int (*check_device
) (struct dasd_device
*);
229 void (*uncheck_device
) (struct dasd_device
*);
232 * do_analysis is used in the step from device state "basic" to
233 * state "accept". It returns 0 if the device can be made ready,
234 * it returns -EMEDIUMTYPE if the device can't be made ready or
235 * -EAGAIN if do_analysis started a ccw that needs to complete
236 * before the analysis may be repeated.
238 int (*do_analysis
) (struct dasd_block
*);
241 * Last things to do when a device is set online, and first things
242 * when it is set offline.
244 int (*ready_to_online
) (struct dasd_device
*);
245 int (*online_to_ready
) (struct dasd_device
*);
248 * Device operation functions. build_cp creates a ccw chain for
249 * a block device request, start_io starts the request and
250 * term_IO cancels it (e.g. in case of a timeout). format_device
251 * returns a ccw chain to be used to format the device.
252 * handle_terminated_request allows to examine a cqr and prepare
255 struct dasd_ccw_req
*(*build_cp
) (struct dasd_device
*,
258 int (*start_IO
) (struct dasd_ccw_req
*);
259 int (*term_IO
) (struct dasd_ccw_req
*);
260 void (*handle_terminated_request
) (struct dasd_ccw_req
*);
261 struct dasd_ccw_req
*(*format_device
) (struct dasd_device
*,
262 struct format_data_t
*);
263 int (*free_cp
) (struct dasd_ccw_req
*, struct request
*);
266 * Error recovery functions. examine_error() returns a value that
267 * indicates what to do for an error condition. If examine_error()
268 * returns 'dasd_era_recover' erp_action() is called to create a
269 * special error recovery ccw. erp_postaction() is called after
270 * an error recovery ccw has finished its execution. dump_sense
271 * is called for every error condition to print the sense data
274 dasd_erp_fn_t(*erp_action
) (struct dasd_ccw_req
*);
275 dasd_erp_fn_t(*erp_postaction
) (struct dasd_ccw_req
*);
276 void (*dump_sense
) (struct dasd_device
*, struct dasd_ccw_req
*,
279 void (*handle_unsolicited_interrupt
) (struct dasd_device
*,
282 /* i/o control functions. */
283 int (*fill_geometry
) (struct dasd_block
*, struct hd_geometry
*);
284 int (*fill_info
) (struct dasd_device
*, struct dasd_information2_t
*);
285 int (*ioctl
) (struct dasd_block
*, unsigned int, void __user
*);
288 extern struct dasd_discipline
*dasd_diag_discipline_pointer
;
291 * Unique identifier for dasd device.
293 #define UA_NOT_CONFIGURED 0x00
294 #define UA_BASE_DEVICE 0x01
295 #define UA_BASE_PAV_ALIAS 0x02
296 #define UA_HYPER_PAV_ALIAS 0x03
308 * Notification numbers for extended error reporting notifications:
309 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
310 * eer pointer) is freed. The error reporting module needs to do all necessary
312 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
314 #define DASD_EER_DISABLE 0
315 #define DASD_EER_TRIGGER 1
317 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
318 #define DASD_EER_FATALERROR 1
319 #define DASD_EER_NOPATH 2
320 #define DASD_EER_STATECHANGE 3
321 #define DASD_EER_PPRCSUSPEND 4
324 /* Block device stuff. */
325 struct dasd_block
*block
;
327 unsigned int devindex
;
328 unsigned long flags
; /* per device flags */
329 unsigned short features
; /* copy of devmap-features (read-only!) */
331 /* extended error reporting stuff (eer) */
332 struct dasd_ccw_req
*eer_cqr
;
334 /* Device discipline stuff. */
335 struct dasd_discipline
*discipline
;
336 struct dasd_discipline
*base_discipline
;
339 /* Device state and target state. */
341 int stopped
; /* device (ccw_device_start) was stopped */
343 /* reference count. */
346 /* ccw queue and memory for static ccw/erp buffers. */
347 struct list_head ccw_queue
;
351 struct list_head ccw_chunks
;
352 struct list_head erp_chunks
;
354 atomic_t tasklet_scheduled
;
355 struct tasklet_struct tasklet
;
356 struct work_struct kick_work
;
357 struct timer_list timer
;
359 debug_info_t
*debug_area
;
361 struct ccw_device
*cdev
;
363 /* hook for alias management */
364 struct list_head alias_list
;
368 /* Block device stuff. */
370 struct request_queue
*request_queue
;
371 spinlock_t request_queue_lock
;
372 struct block_device
*bdev
;
375 unsigned long blocks
; /* size of volume in blocks */
376 unsigned int bp_block
; /* bytes per block */
377 unsigned int s2b_shift
; /* log2 (bp_block/512) */
379 struct dasd_device
*base
;
380 struct list_head ccw_queue
;
381 spinlock_t queue_lock
;
383 atomic_t tasklet_scheduled
;
384 struct tasklet_struct tasklet
;
385 struct timer_list timer
;
387 #ifdef CONFIG_DASD_PROFILE
388 struct dasd_profile_info_t profile
;
394 /* reasons why device (ccw_device_start) was stopped */
395 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
396 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
397 #define DASD_STOPPED_PENDING 4 /* long busy */
398 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
399 #define DASD_STOPPED_SU 16 /* summary unit check handling */
401 /* per device flags */
402 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
403 #define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
404 #define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
406 void dasd_put_device_wake(struct dasd_device
*);
409 * Reference count inliners
412 dasd_get_device(struct dasd_device
*device
)
414 atomic_inc(&device
->ref_count
);
418 dasd_put_device(struct dasd_device
*device
)
420 if (atomic_dec_return(&device
->ref_count
) == 0)
421 dasd_put_device_wake(device
);
425 * The static memory in ccw_mem and erp_mem is managed by a sorted
426 * list of free memory chunks.
430 struct list_head list
;
432 } __attribute__ ((aligned(8)));
435 dasd_init_chunklist(struct list_head
*chunk_list
, void *mem
,
438 struct dasd_mchunk
*chunk
;
440 INIT_LIST_HEAD(chunk_list
);
441 chunk
= (struct dasd_mchunk
*) mem
;
442 chunk
->size
= size
- sizeof(struct dasd_mchunk
);
443 list_add(&chunk
->list
, chunk_list
);
447 dasd_alloc_chunk(struct list_head
*chunk_list
, unsigned long size
)
449 struct dasd_mchunk
*chunk
, *tmp
;
451 size
= (size
+ 7L) & -8L;
452 list_for_each_entry(chunk
, chunk_list
, list
) {
453 if (chunk
->size
< size
)
455 if (chunk
->size
> size
+ sizeof(struct dasd_mchunk
)) {
456 char *endaddr
= (char *) (chunk
+ 1) + chunk
->size
;
457 tmp
= (struct dasd_mchunk
*) (endaddr
- size
) - 1;
459 chunk
->size
-= size
+ sizeof(struct dasd_mchunk
);
462 list_del(&chunk
->list
);
463 return (void *) (chunk
+ 1);
469 dasd_free_chunk(struct list_head
*chunk_list
, void *mem
)
471 struct dasd_mchunk
*chunk
, *tmp
;
472 struct list_head
*p
, *left
;
474 chunk
= (struct dasd_mchunk
*)
475 ((char *) mem
- sizeof(struct dasd_mchunk
));
476 /* Find out the left neighbour in chunk_list. */
478 list_for_each(p
, chunk_list
) {
479 if (list_entry(p
, struct dasd_mchunk
, list
) > chunk
)
483 /* Try to merge with right neighbour = next element from left. */
484 if (left
->next
!= chunk_list
) {
485 tmp
= list_entry(left
->next
, struct dasd_mchunk
, list
);
486 if ((char *) (chunk
+ 1) + chunk
->size
== (char *) tmp
) {
487 list_del(&tmp
->list
);
488 chunk
->size
+= tmp
->size
+ sizeof(struct dasd_mchunk
);
491 /* Try to merge with left neighbour. */
492 if (left
!= chunk_list
) {
493 tmp
= list_entry(left
, struct dasd_mchunk
, list
);
494 if ((char *) (tmp
+ 1) + tmp
->size
== (char *) chunk
) {
495 tmp
->size
+= chunk
->size
+ sizeof(struct dasd_mchunk
);
499 __list_add(&chunk
->list
, left
, left
->next
);
503 * Check if bsize is in { 512, 1024, 2048, 4096 }
506 dasd_check_blocksize(int bsize
)
508 if (bsize
< 512 || bsize
> 4096 || !is_power_of_2(bsize
))
513 /* externals in dasd.c */
514 #define DASD_PROFILE_ON 1
515 #define DASD_PROFILE_OFF 0
517 extern debug_info_t
*dasd_debug_area
;
518 extern struct dasd_profile_info_t dasd_global_profile
;
519 extern unsigned int dasd_profile_level
;
520 extern struct block_device_operations dasd_device_operations
;
522 extern struct kmem_cache
*dasd_page_cache
;
524 struct dasd_ccw_req
*
525 dasd_kmalloc_request(char *, int, int, struct dasd_device
*);
526 struct dasd_ccw_req
*
527 dasd_smalloc_request(char *, int, int, struct dasd_device
*);
528 void dasd_kfree_request(struct dasd_ccw_req
*, struct dasd_device
*);
529 void dasd_sfree_request(struct dasd_ccw_req
*, struct dasd_device
*);
532 dasd_kmalloc_set_cda(struct ccw1
*ccw
, void *cda
, struct dasd_device
*device
)
534 return set_normalized_cda(ccw
, cda
);
537 struct dasd_device
*dasd_alloc_device(void);
538 void dasd_free_device(struct dasd_device
*);
540 struct dasd_block
*dasd_alloc_block(void);
541 void dasd_free_block(struct dasd_block
*);
543 void dasd_enable_device(struct dasd_device
*);
544 void dasd_set_target_state(struct dasd_device
*, int);
545 void dasd_kick_device(struct dasd_device
*);
547 void dasd_add_request_head(struct dasd_ccw_req
*);
548 void dasd_add_request_tail(struct dasd_ccw_req
*);
549 int dasd_start_IO(struct dasd_ccw_req
*);
550 int dasd_term_IO(struct dasd_ccw_req
*);
551 void dasd_schedule_device_bh(struct dasd_device
*);
552 void dasd_schedule_block_bh(struct dasd_block
*);
553 int dasd_sleep_on(struct dasd_ccw_req
*);
554 int dasd_sleep_on_immediatly(struct dasd_ccw_req
*);
555 int dasd_sleep_on_interruptible(struct dasd_ccw_req
*);
556 void dasd_device_set_timer(struct dasd_device
*, int);
557 void dasd_device_clear_timer(struct dasd_device
*);
558 void dasd_block_set_timer(struct dasd_block
*, int);
559 void dasd_block_clear_timer(struct dasd_block
*);
560 int dasd_cancel_req(struct dasd_ccw_req
*);
561 int dasd_flush_device_queue(struct dasd_device
*);
562 int dasd_generic_probe (struct ccw_device
*, struct dasd_discipline
*);
563 void dasd_generic_remove (struct ccw_device
*cdev
);
564 int dasd_generic_set_online(struct ccw_device
*, struct dasd_discipline
*);
565 int dasd_generic_set_offline (struct ccw_device
*cdev
);
566 int dasd_generic_notify(struct ccw_device
*, int);
567 void dasd_generic_handle_state_change(struct dasd_device
*);
569 int dasd_generic_read_dev_chars(struct dasd_device
*, char *, void **, int);
571 /* externals in dasd_devmap.c */
572 extern int dasd_max_devindex
;
573 extern int dasd_probeonly
;
574 extern int dasd_autodetect
;
575 extern int dasd_nopav
;
577 int dasd_devmap_init(void);
578 void dasd_devmap_exit(void);
580 struct dasd_device
*dasd_create_device(struct ccw_device
*);
581 void dasd_delete_device(struct dasd_device
*);
583 int dasd_get_uid(struct ccw_device
*, struct dasd_uid
*);
584 int dasd_set_uid(struct ccw_device
*, struct dasd_uid
*);
585 int dasd_get_feature(struct ccw_device
*, int);
586 int dasd_set_feature(struct ccw_device
*, int, int);
588 int dasd_add_sysfs_files(struct ccw_device
*);
589 void dasd_remove_sysfs_files(struct ccw_device
*);
591 struct dasd_device
*dasd_device_from_cdev(struct ccw_device
*);
592 struct dasd_device
*dasd_device_from_cdev_locked(struct ccw_device
*);
593 struct dasd_device
*dasd_device_from_devindex(int);
595 int dasd_parse(void);
596 int dasd_busid_known(char *);
598 /* externals in dasd_gendisk.c */
599 int dasd_gendisk_init(void);
600 void dasd_gendisk_exit(void);
601 int dasd_gendisk_alloc(struct dasd_block
*);
602 void dasd_gendisk_free(struct dasd_block
*);
603 int dasd_scan_partitions(struct dasd_block
*);
604 void dasd_destroy_partitions(struct dasd_block
*);
606 /* externals in dasd_ioctl.c */
607 int dasd_ioctl(struct inode
*, struct file
*, unsigned int, unsigned long);
608 long dasd_compat_ioctl(struct file
*, unsigned int, unsigned long);
610 /* externals in dasd_proc.c */
611 int dasd_proc_init(void);
612 void dasd_proc_exit(void);
614 /* externals in dasd_erp.c */
615 struct dasd_ccw_req
*dasd_default_erp_action(struct dasd_ccw_req
*);
616 struct dasd_ccw_req
*dasd_default_erp_postaction(struct dasd_ccw_req
*);
617 struct dasd_ccw_req
*dasd_alloc_erp_request(char *, int, int,
618 struct dasd_device
*);
619 void dasd_free_erp_request(struct dasd_ccw_req
*, struct dasd_device
*);
620 void dasd_log_sense(struct dasd_ccw_req
*, struct irb
*);
622 /* externals in dasd_3990_erp.c */
623 struct dasd_ccw_req
*dasd_3990_erp_action(struct dasd_ccw_req
*);
625 /* externals in dasd_eer.c */
626 #ifdef CONFIG_DASD_EER
627 int dasd_eer_init(void);
628 void dasd_eer_exit(void);
629 int dasd_eer_enable(struct dasd_device
*);
630 void dasd_eer_disable(struct dasd_device
*);
631 void dasd_eer_write(struct dasd_device
*, struct dasd_ccw_req
*cqr
,
633 void dasd_eer_snss(struct dasd_device
*);
635 static inline int dasd_eer_enabled(struct dasd_device
*device
)
637 return device
->eer_cqr
!= NULL
;
640 #define dasd_eer_init() (0)
641 #define dasd_eer_exit() do { } while (0)
642 #define dasd_eer_enable(d) (0)
643 #define dasd_eer_disable(d) do { } while (0)
644 #define dasd_eer_write(d,c,i) do { } while (0)
645 #define dasd_eer_snss(d) do { } while (0)
646 #define dasd_eer_enabled(d) (0)
647 #endif /* CONFIG_DASD_ERR */
649 #endif /* __KERNEL__ */