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 <asm/ccwdev.h>
57 #include <linux/workqueue.h>
58 #include <asm/debug.h>
60 #include <asm/idals.h>
63 * SECTION: Type definitions
68 dasd_era_fatal
= -1, /* no chance to recover */
69 dasd_era_none
= 0, /* don't recover, everything alright */
70 dasd_era_msg
= 1, /* don't recover, just report... */
71 dasd_era_recover
= 2 /* recovery action recommended */
74 /* BIT DEFINITIONS FOR SENSE DATA */
75 #define DASD_SENSE_BIT_0 0x80
76 #define DASD_SENSE_BIT_1 0x40
77 #define DASD_SENSE_BIT_2 0x20
78 #define DASD_SENSE_BIT_3 0x10
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 list
; /* list_head for request queueing. */
155 /* Where to execute what... */
156 struct dasd_device
*device
; /* device the request is for */
157 struct ccw1
*cpaddr
; /* address of channel program */
158 char status
; /* status of this request */
159 short retries
; /* A retry counter */
160 unsigned long flags
; /* flags of this request */
163 unsigned long starttime
; /* jiffies time of request start */
164 int expires
; /* expiration period in jiffies */
165 char lpm
; /* logical path mask */
166 void *data
; /* pointer to data area */
168 /* these are important for recovering erroneous requests */
169 struct irb irb
; /* device status in case of an error */
170 struct dasd_ccw_req
*refers
; /* ERP-chain queueing. */
171 void *function
; /* originating ERP action */
173 /* these are for statistics only */
174 unsigned long long buildclk
; /* TOD-clock of request generation */
175 unsigned long long startclk
; /* TOD-clock of request start */
176 unsigned long long stopclk
; /* TOD-clock of request interrupt */
177 unsigned long long endclk
; /* TOD-clock of request termination */
179 /* Callback that is called after reaching final status. */
180 void (*callback
)(struct dasd_ccw_req
*, void *data
);
185 * dasd_ccw_req -> status can be:
187 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
188 #define DASD_CQR_QUEUED 0x01 /* request is queued to be processed */
189 #define DASD_CQR_IN_IO 0x02 /* request is currently in IO */
190 #define DASD_CQR_DONE 0x03 /* request is completed successfully */
191 #define DASD_CQR_ERROR 0x04 /* request is completed with error */
192 #define DASD_CQR_FAILED 0x05 /* request is finally failed */
193 #define DASD_CQR_CLEAR 0x06 /* request is clear pending */
195 /* per dasd_ccw_req flags */
196 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */
197 #define DASD_CQR_FLAGS_FAILFAST 1 /* FAILFAST */
199 /* Signature for error recovery functions. */
200 typedef struct dasd_ccw_req
*(*dasd_erp_fn_t
) (struct dasd_ccw_req
*);
203 * the struct dasd_discipline is
204 * sth like a table of virtual functions, if you think of dasd_eckd
206 * no, currently we are not planning to reimplement the driver in C++
208 struct dasd_discipline
{
209 struct module
*owner
;
210 char ebcname
[8]; /* a name used for tagging and printks */
211 char name
[8]; /* a name used for tagging and printks */
212 int max_blocks
; /* maximum number of blocks to be chained */
214 struct list_head list
; /* used for list of disciplines */
217 * Device recognition functions. check_device is used to verify
218 * the sense data and the information returned by read device
219 * characteristics. It returns 0 if the discipline can be used
220 * for the device in question.
221 * do_analysis is used in the step from device state "basic" to
222 * state "accept". It returns 0 if the device can be made ready,
223 * it returns -EMEDIUMTYPE if the device can't be made ready or
224 * -EAGAIN if do_analysis started a ccw that needs to complete
225 * before the analysis may be repeated.
227 int (*check_device
)(struct dasd_device
*);
228 int (*do_analysis
) (struct dasd_device
*);
231 * Device operation functions. build_cp creates a ccw chain for
232 * a block device request, start_io starts the request and
233 * term_IO cancels it (e.g. in case of a timeout). format_device
234 * returns a ccw chain to be used to format the device.
236 struct dasd_ccw_req
*(*build_cp
) (struct dasd_device
*,
238 int (*start_IO
) (struct dasd_ccw_req
*);
239 int (*term_IO
) (struct dasd_ccw_req
*);
240 struct dasd_ccw_req
*(*format_device
) (struct dasd_device
*,
241 struct format_data_t
*);
242 int (*free_cp
) (struct dasd_ccw_req
*, struct request
*);
244 * Error recovery functions. examine_error() returns a value that
245 * indicates what to do for an error condition. If examine_error()
246 * returns 'dasd_era_recover' erp_action() is called to create a
247 * special error recovery ccw. erp_postaction() is called after
248 * an error recovery ccw has finished its execution. dump_sense
249 * is called for every error condition to print the sense data
252 dasd_era_t(*examine_error
) (struct dasd_ccw_req
*, struct irb
*);
253 dasd_erp_fn_t(*erp_action
) (struct dasd_ccw_req
*);
254 dasd_erp_fn_t(*erp_postaction
) (struct dasd_ccw_req
*);
255 void (*dump_sense
) (struct dasd_device
*, struct dasd_ccw_req
*,
258 /* i/o control functions. */
259 int (*fill_geometry
) (struct dasd_device
*, struct hd_geometry
*);
260 int (*fill_info
) (struct dasd_device
*, struct dasd_information2_t
*);
261 int (*ioctl
) (struct dasd_device
*, unsigned int, void __user
*);
264 extern struct dasd_discipline
*dasd_diag_discipline_pointer
;
267 * Unique identifier for dasd device.
278 * Notification numbers for extended error reporting notifications:
279 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
280 * eer pointer) is freed. The error reporting module needs to do all necessary
282 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
284 #define DASD_EER_DISABLE 0
285 #define DASD_EER_TRIGGER 1
287 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
288 #define DASD_EER_FATALERROR 1
289 #define DASD_EER_NOPATH 2
290 #define DASD_EER_STATECHANGE 3
291 #define DASD_EER_PPRCSUSPEND 4
294 /* Block device stuff. */
296 request_queue_t
*request_queue
;
297 spinlock_t request_queue_lock
;
298 struct block_device
*bdev
;
299 unsigned int devindex
;
300 unsigned long blocks
; /* size of volume in blocks */
301 unsigned int bp_block
; /* bytes per block */
302 unsigned int s2b_shift
; /* log2 (bp_block/512) */
303 unsigned long flags
; /* per device flags */
304 unsigned short features
; /* copy of devmap-features (read-only!) */
306 /* extended error reporting stuff (eer) */
307 struct dasd_ccw_req
*eer_cqr
;
309 /* Device discipline stuff. */
310 struct dasd_discipline
*discipline
;
311 struct dasd_discipline
*base_discipline
;
314 /* Device state and target state. */
316 int stopped
; /* device (ccw_device_start) was stopped */
318 /* Open and reference count. */
322 /* ccw queue and memory for static ccw/erp buffers. */
323 struct list_head ccw_queue
;
327 struct list_head ccw_chunks
;
328 struct list_head erp_chunks
;
330 atomic_t tasklet_scheduled
;
331 struct tasklet_struct tasklet
;
332 struct work_struct kick_work
;
333 struct timer_list timer
;
335 debug_info_t
*debug_area
;
337 struct ccw_device
*cdev
;
339 #ifdef CONFIG_DASD_PROFILE
340 struct dasd_profile_info_t profile
;
344 /* reasons why device (ccw_device_start) was stopped */
345 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
346 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
347 #define DASD_STOPPED_PENDING 4 /* long busy */
348 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
349 #define DASD_STOPPED_DC_EIO 16 /* disconnected, return -EIO */
351 /* per device flags */
352 #define DASD_FLAG_DSC_ERROR 2 /* return -EIO when disconnected */
353 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
354 #define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
355 #define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
357 void dasd_put_device_wake(struct dasd_device
*);
360 * Reference count inliners
363 dasd_get_device(struct dasd_device
*device
)
365 atomic_inc(&device
->ref_count
);
369 dasd_put_device(struct dasd_device
*device
)
371 if (atomic_dec_return(&device
->ref_count
) == 0)
372 dasd_put_device_wake(device
);
376 * The static memory in ccw_mem and erp_mem is managed by a sorted
377 * list of free memory chunks.
381 struct list_head list
;
383 } __attribute__ ((aligned(8)));
386 dasd_init_chunklist(struct list_head
*chunk_list
, void *mem
,
389 struct dasd_mchunk
*chunk
;
391 INIT_LIST_HEAD(chunk_list
);
392 chunk
= (struct dasd_mchunk
*) mem
;
393 chunk
->size
= size
- sizeof(struct dasd_mchunk
);
394 list_add(&chunk
->list
, chunk_list
);
398 dasd_alloc_chunk(struct list_head
*chunk_list
, unsigned long size
)
400 struct dasd_mchunk
*chunk
, *tmp
;
402 size
= (size
+ 7L) & -8L;
403 list_for_each_entry(chunk
, chunk_list
, list
) {
404 if (chunk
->size
< size
)
406 if (chunk
->size
> size
+ sizeof(struct dasd_mchunk
)) {
407 char *endaddr
= (char *) (chunk
+ 1) + chunk
->size
;
408 tmp
= (struct dasd_mchunk
*) (endaddr
- size
) - 1;
410 chunk
->size
-= size
+ sizeof(struct dasd_mchunk
);
413 list_del(&chunk
->list
);
414 return (void *) (chunk
+ 1);
420 dasd_free_chunk(struct list_head
*chunk_list
, void *mem
)
422 struct dasd_mchunk
*chunk
, *tmp
;
423 struct list_head
*p
, *left
;
425 chunk
= (struct dasd_mchunk
*)
426 ((char *) mem
- sizeof(struct dasd_mchunk
));
427 /* Find out the left neighbour in chunk_list. */
429 list_for_each(p
, chunk_list
) {
430 if (list_entry(p
, struct dasd_mchunk
, list
) > chunk
)
434 /* Try to merge with right neighbour = next element from left. */
435 if (left
->next
!= chunk_list
) {
436 tmp
= list_entry(left
->next
, struct dasd_mchunk
, list
);
437 if ((char *) (chunk
+ 1) + chunk
->size
== (char *) tmp
) {
438 list_del(&tmp
->list
);
439 chunk
->size
+= tmp
->size
+ sizeof(struct dasd_mchunk
);
442 /* Try to merge with left neighbour. */
443 if (left
!= chunk_list
) {
444 tmp
= list_entry(left
, struct dasd_mchunk
, list
);
445 if ((char *) (tmp
+ 1) + tmp
->size
== (char *) chunk
) {
446 tmp
->size
+= chunk
->size
+ sizeof(struct dasd_mchunk
);
450 __list_add(&chunk
->list
, left
, left
->next
);
454 * Check if bsize is in { 512, 1024, 2048, 4096 }
457 dasd_check_blocksize(int bsize
)
459 if (bsize
< 512 || bsize
> 4096 || (bsize
& (bsize
- 1)) != 0)
464 /* externals in dasd.c */
465 #define DASD_PROFILE_ON 1
466 #define DASD_PROFILE_OFF 0
468 extern debug_info_t
*dasd_debug_area
;
469 extern struct dasd_profile_info_t dasd_global_profile
;
470 extern unsigned int dasd_profile_level
;
471 extern struct block_device_operations dasd_device_operations
;
473 extern struct kmem_cache
*dasd_page_cache
;
475 struct dasd_ccw_req
*
476 dasd_kmalloc_request(char *, int, int, struct dasd_device
*);
477 struct dasd_ccw_req
*
478 dasd_smalloc_request(char *, int, int, struct dasd_device
*);
479 void dasd_kfree_request(struct dasd_ccw_req
*, struct dasd_device
*);
480 void dasd_sfree_request(struct dasd_ccw_req
*, struct dasd_device
*);
483 dasd_kmalloc_set_cda(struct ccw1
*ccw
, void *cda
, struct dasd_device
*device
)
485 return set_normalized_cda(ccw
, cda
);
488 struct dasd_device
*dasd_alloc_device(void);
489 void dasd_free_device(struct dasd_device
*);
491 void dasd_enable_device(struct dasd_device
*);
492 void dasd_set_target_state(struct dasd_device
*, int);
493 void dasd_kick_device(struct dasd_device
*);
495 void dasd_add_request_head(struct dasd_ccw_req
*);
496 void dasd_add_request_tail(struct dasd_ccw_req
*);
497 int dasd_start_IO(struct dasd_ccw_req
*);
498 int dasd_term_IO(struct dasd_ccw_req
*);
499 void dasd_schedule_bh(struct dasd_device
*);
500 int dasd_sleep_on(struct dasd_ccw_req
*);
501 int dasd_sleep_on_immediatly(struct dasd_ccw_req
*);
502 int dasd_sleep_on_interruptible(struct dasd_ccw_req
*);
503 void dasd_set_timer(struct dasd_device
*, int);
504 void dasd_clear_timer(struct dasd_device
*);
505 int dasd_cancel_req(struct dasd_ccw_req
*);
506 int dasd_generic_probe (struct ccw_device
*, struct dasd_discipline
*);
507 void dasd_generic_remove (struct ccw_device
*cdev
);
508 int dasd_generic_set_online(struct ccw_device
*, struct dasd_discipline
*);
509 int dasd_generic_set_offline (struct ccw_device
*cdev
);
510 int dasd_generic_notify(struct ccw_device
*, int);
512 int dasd_generic_read_dev_chars(struct dasd_device
*, char *, void **, int);
514 /* externals in dasd_devmap.c */
515 extern int dasd_max_devindex
;
516 extern int dasd_probeonly
;
517 extern int dasd_autodetect
;
518 extern int dasd_nopav
;
520 int dasd_devmap_init(void);
521 void dasd_devmap_exit(void);
523 struct dasd_device
*dasd_create_device(struct ccw_device
*);
524 void dasd_delete_device(struct dasd_device
*);
526 int dasd_get_uid(struct ccw_device
*, struct dasd_uid
*);
527 int dasd_set_uid(struct ccw_device
*, struct dasd_uid
*);
528 int dasd_get_feature(struct ccw_device
*, int);
529 int dasd_set_feature(struct ccw_device
*, int, int);
531 int dasd_add_sysfs_files(struct ccw_device
*);
532 void dasd_remove_sysfs_files(struct ccw_device
*);
534 struct dasd_device
*dasd_device_from_cdev(struct ccw_device
*);
535 struct dasd_device
*dasd_device_from_cdev_locked(struct ccw_device
*);
536 struct dasd_device
*dasd_device_from_devindex(int);
538 int dasd_parse(void);
539 int dasd_busid_known(char *);
541 /* externals in dasd_gendisk.c */
542 int dasd_gendisk_init(void);
543 void dasd_gendisk_exit(void);
544 int dasd_gendisk_alloc(struct dasd_device
*);
545 void dasd_gendisk_free(struct dasd_device
*);
546 int dasd_scan_partitions(struct dasd_device
*);
547 void dasd_destroy_partitions(struct dasd_device
*);
549 /* externals in dasd_ioctl.c */
550 int dasd_ioctl(struct inode
*, struct file
*, unsigned int, unsigned long);
551 long dasd_compat_ioctl(struct file
*, unsigned int, unsigned long);
553 /* externals in dasd_proc.c */
554 int dasd_proc_init(void);
555 void dasd_proc_exit(void);
557 /* externals in dasd_erp.c */
558 struct dasd_ccw_req
*dasd_default_erp_action(struct dasd_ccw_req
*);
559 struct dasd_ccw_req
*dasd_default_erp_postaction(struct dasd_ccw_req
*);
560 struct dasd_ccw_req
*dasd_alloc_erp_request(char *, int, int,
561 struct dasd_device
*);
562 void dasd_free_erp_request(struct dasd_ccw_req
*, struct dasd_device
*);
563 void dasd_log_sense(struct dasd_ccw_req
*, struct irb
*);
565 /* externals in dasd_3370_erp.c */
566 dasd_era_t
dasd_3370_erp_examine(struct dasd_ccw_req
*, struct irb
*);
568 /* externals in dasd_3990_erp.c */
569 dasd_era_t
dasd_3990_erp_examine(struct dasd_ccw_req
*, struct irb
*);
570 struct dasd_ccw_req
*dasd_3990_erp_action(struct dasd_ccw_req
*);
572 /* externals in dasd_9336_erp.c */
573 dasd_era_t
dasd_9336_erp_examine(struct dasd_ccw_req
*, struct irb
*);
575 /* externals in dasd_9336_erp.c */
576 dasd_era_t
dasd_9343_erp_examine(struct dasd_ccw_req
*, struct irb
*);
577 struct dasd_ccw_req
*dasd_9343_erp_action(struct dasd_ccw_req
*);
579 /* externals in dasd_eer.c */
580 #ifdef CONFIG_DASD_EER
581 int dasd_eer_init(void);
582 void dasd_eer_exit(void);
583 int dasd_eer_enable(struct dasd_device
*);
584 void dasd_eer_disable(struct dasd_device
*);
585 void dasd_eer_write(struct dasd_device
*, struct dasd_ccw_req
*cqr
,
587 void dasd_eer_snss(struct dasd_device
*);
589 static inline int dasd_eer_enabled(struct dasd_device
*device
)
591 return device
->eer_cqr
!= NULL
;
594 #define dasd_eer_init() (0)
595 #define dasd_eer_exit() do { } while (0)
596 #define dasd_eer_enable(d) (0)
597 #define dasd_eer_disable(d) do { } while (0)
598 #define dasd_eer_write(d,c,i) do { } while (0)
599 #define dasd_eer_snss(d) do { } while (0)
600 #define dasd_eer_enabled(d) (0)
601 #endif /* CONFIG_DASD_ERR */
603 #endif /* __KERNEL__ */