[PATCH] SGI IOC4: Detect IO card variant
[linux-2.6/libata-dev.git] / drivers / s390 / block / dasd_int.h
blobd4b13e300a76db523ad2f263ce2f55023c108e6e
1 /*
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
9 */
11 #ifndef DASD_INT_H
12 #define DASD_INT_H
14 #ifdef __KERNEL__
16 /* erp debugging in dasd.c and dasd_3990_erp.c */
17 #define ERP_DEBUG
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>
64 #include <asm/dasd.h>
65 #include <asm/idals.h>
68 * SECTION: Type definitions
70 struct dasd_device;
72 typedef enum {
73 dasd_era_fatal = -1, /* no chance to recover */
74 dasd_era_none = 0, /* don't recover, everything alright */
75 dasd_era_msg = 1, /* don't recover, just report... */
76 dasd_era_recover = 2 /* recovery action recommended */
77 } dasd_era_t;
79 /* BIT DEFINITIONS FOR SENSE DATA */
80 #define DASD_SENSE_BIT_0 0x80
81 #define DASD_SENSE_BIT_1 0x40
82 #define DASD_SENSE_BIT_2 0x20
83 #define DASD_SENSE_BIT_3 0x10
86 * SECTION: MACROs for klogd and s390 debug feature (dbf)
88 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \
89 do { \
90 debug_sprintf_event(d_device->debug_area, \
91 d_level, \
92 d_str "\n", \
93 d_data); \
94 } while(0)
96 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \
97 do { \
98 debug_sprintf_exception(d_device->debug_area, \
99 d_level, \
100 d_str "\n", \
101 d_data); \
102 } while(0)
104 #define DBF_EVENT(d_level, d_str, d_data...)\
105 do { \
106 debug_sprintf_event(dasd_debug_area, \
107 d_level,\
108 d_str "\n", \
109 d_data); \
110 } while(0)
112 #define DBF_EXC(d_level, d_str, d_data...)\
113 do { \
114 debug_sprintf_exception(dasd_debug_area, \
115 d_level,\
116 d_str "\n", \
117 d_data); \
118 } while(0)
120 /* definition of dbf debug levels */
121 #define DBF_EMERG 0 /* system is unusable */
122 #define DBF_ALERT 1 /* action must be taken immediately */
123 #define DBF_CRIT 2 /* critical conditions */
124 #define DBF_ERR 3 /* error conditions */
125 #define DBF_WARNING 4 /* warning conditions */
126 #define DBF_NOTICE 5 /* normal but significant condition */
127 #define DBF_INFO 6 /* informational */
128 #define DBF_DEBUG 6 /* debug-level messages */
130 /* messages to be written via klogd and dbf */
131 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\
132 do { \
133 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
134 d_device->cdev->dev.bus_id, d_args); \
135 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \
136 } while(0)
138 #define MESSAGE(d_loglevel,d_string,d_args...)\
139 do { \
140 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
141 DBF_EVENT(DBF_ALERT, d_string, d_args); \
142 } while(0)
144 /* messages to be written via klogd only */
145 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\
146 do { \
147 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \
148 d_device->cdev->dev.bus_id, d_args); \
149 } while(0)
151 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\
152 do { \
153 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \
154 } while(0)
156 struct dasd_ccw_req {
157 unsigned int magic; /* Eye catcher */
158 struct list_head list; /* list_head for request queueing. */
160 /* Where to execute what... */
161 struct dasd_device *device; /* device the request is for */
162 struct ccw1 *cpaddr; /* address of channel program */
163 char status; /* status of this request */
164 short retries; /* A retry counter */
165 unsigned long flags; /* flags of this request */
167 /* ... and how */
168 unsigned long starttime; /* jiffies time of request start */
169 int expires; /* expiration period in jiffies */
170 char lpm; /* logical path mask */
171 void *data; /* pointer to data area */
173 /* these are important for recovering erroneous requests */
174 struct irb irb; /* device status in case of an error */
175 struct dasd_ccw_req *refers; /* ERP-chain queueing. */
176 void *function; /* originating ERP action */
178 /* these are for statistics only */
179 unsigned long long buildclk; /* TOD-clock of request generation */
180 unsigned long long startclk; /* TOD-clock of request start */
181 unsigned long long stopclk; /* TOD-clock of request interrupt */
182 unsigned long long endclk; /* TOD-clock of request termination */
184 /* Callback that is called after reaching final status. */
185 void (*callback)(struct dasd_ccw_req *, void *data);
186 void *callback_data;
190 * dasd_ccw_req -> status can be:
192 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */
193 #define DASD_CQR_QUEUED 0x01 /* request is queued to be processed */
194 #define DASD_CQR_IN_IO 0x02 /* request is currently in IO */
195 #define DASD_CQR_DONE 0x03 /* request is completed successfully */
196 #define DASD_CQR_ERROR 0x04 /* request is completed with error */
197 #define DASD_CQR_FAILED 0x05 /* request is finally failed */
198 #define DASD_CQR_CLEAR 0x06 /* request is clear pending */
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
210 * inheriting dasd...
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.
226 * do_analysis is used in the step from device state "basic" to
227 * state "accept". It returns 0 if the device can be made ready,
228 * it returns -EMEDIUMTYPE if the device can't be made ready or
229 * -EAGAIN if do_analysis started a ccw that needs to complete
230 * before the analysis may be repeated.
232 int (*check_device)(struct dasd_device *);
233 int (*do_analysis) (struct dasd_device *);
236 * Device operation functions. build_cp creates a ccw chain for
237 * a block device request, start_io starts the request and
238 * term_IO cancels it (e.g. in case of a timeout). format_device
239 * returns a ccw chain to be used to format the device.
241 struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
242 struct request *);
243 int (*start_IO) (struct dasd_ccw_req *);
244 int (*term_IO) (struct dasd_ccw_req *);
245 struct dasd_ccw_req *(*format_device) (struct dasd_device *,
246 struct format_data_t *);
247 int (*free_cp) (struct dasd_ccw_req *, struct request *);
249 * Error recovery functions. examine_error() returns a value that
250 * indicates what to do for an error condition. If examine_error()
251 * returns 'dasd_era_recover' erp_action() is called to create a
252 * special error recovery ccw. erp_postaction() is called after
253 * an error recovery ccw has finished its execution. dump_sense
254 * is called for every error condition to print the sense data
255 * to the console.
257 dasd_era_t(*examine_error) (struct dasd_ccw_req *, struct irb *);
258 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
259 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
260 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
261 struct irb *);
263 /* i/o control functions. */
264 int (*fill_geometry) (struct dasd_device *, struct hd_geometry *);
265 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
266 int (*ioctl) (struct dasd_device *, unsigned int, void __user *);
269 extern struct dasd_discipline *dasd_diag_discipline_pointer;
272 * Unique identifier for dasd device.
274 struct dasd_uid {
275 __u8 alias;
276 char vendor[4];
277 char serial[15];
278 __u16 ssid;
279 __u8 unit_addr;
283 * Notification numbers for extended error reporting notifications:
284 * The DASD_EER_DISABLE notification is sent before a dasd_device (and it's
285 * eer pointer) is freed. The error reporting module needs to do all necessary
286 * cleanup steps.
287 * The DASD_EER_TRIGGER notification sends the actual error reports (triggers).
289 #define DASD_EER_DISABLE 0
290 #define DASD_EER_TRIGGER 1
292 /* Trigger IDs for extended error reporting DASD_EER_TRIGGER notification */
293 #define DASD_EER_FATALERROR 1
294 #define DASD_EER_NOPATH 2
295 #define DASD_EER_STATECHANGE 3
296 #define DASD_EER_PPRCSUSPEND 4
298 struct dasd_device {
299 /* Block device stuff. */
300 struct gendisk *gdp;
301 request_queue_t *request_queue;
302 spinlock_t request_queue_lock;
303 struct block_device *bdev;
304 unsigned int devindex;
305 unsigned long blocks; /* size of volume in blocks */
306 unsigned int bp_block; /* bytes per block */
307 unsigned int s2b_shift; /* log2 (bp_block/512) */
308 unsigned long flags; /* per device flags */
309 unsigned short features; /* copy of devmap-features (read-only!) */
311 /* extended error reporting stuff (eer) */
312 struct dasd_ccw_req *eer_cqr;
314 /* Device discipline stuff. */
315 struct dasd_discipline *discipline;
316 struct dasd_discipline *base_discipline;
317 char *private;
319 /* Device state and target state. */
320 int state, target;
321 int stopped; /* device (ccw_device_start) was stopped */
323 /* Open and reference count. */
324 atomic_t ref_count;
325 atomic_t open_count;
327 /* ccw queue and memory for static ccw/erp buffers. */
328 struct list_head ccw_queue;
329 spinlock_t mem_lock;
330 void *ccw_mem;
331 void *erp_mem;
332 struct list_head ccw_chunks;
333 struct list_head erp_chunks;
335 atomic_t tasklet_scheduled;
336 struct tasklet_struct tasklet;
337 struct work_struct kick_work;
338 struct timer_list timer;
340 debug_info_t *debug_area;
342 struct ccw_device *cdev;
344 #ifdef CONFIG_DASD_PROFILE
345 struct dasd_profile_info_t profile;
346 #endif
349 /* reasons why device (ccw_device_start) was stopped */
350 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */
351 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */
352 #define DASD_STOPPED_PENDING 4 /* long busy */
353 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */
354 #define DASD_STOPPED_DC_EIO 16 /* disconnected, return -EIO */
356 /* per device flags */
357 #define DASD_FLAG_DSC_ERROR 2 /* return -EIO when disconnected */
358 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */
359 #define DASD_FLAG_EER_SNSS 4 /* A SNSS is required */
360 #define DASD_FLAG_EER_IN_USE 5 /* A SNSS request is running */
362 void dasd_put_device_wake(struct dasd_device *);
365 * Reference count inliners
367 static inline void
368 dasd_get_device(struct dasd_device *device)
370 atomic_inc(&device->ref_count);
373 static inline void
374 dasd_put_device(struct dasd_device *device)
376 if (atomic_dec_return(&device->ref_count) == 0)
377 dasd_put_device_wake(device);
381 * The static memory in ccw_mem and erp_mem is managed by a sorted
382 * list of free memory chunks.
384 struct dasd_mchunk
386 struct list_head list;
387 unsigned long size;
388 } __attribute__ ((aligned(8)));
390 static inline void
391 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
392 unsigned long size)
394 struct dasd_mchunk *chunk;
396 INIT_LIST_HEAD(chunk_list);
397 chunk = (struct dasd_mchunk *) mem;
398 chunk->size = size - sizeof(struct dasd_mchunk);
399 list_add(&chunk->list, chunk_list);
402 static inline void *
403 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
405 struct dasd_mchunk *chunk, *tmp;
407 size = (size + 7L) & -8L;
408 list_for_each_entry(chunk, chunk_list, list) {
409 if (chunk->size < size)
410 continue;
411 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
412 char *endaddr = (char *) (chunk + 1) + chunk->size;
413 tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
414 tmp->size = size;
415 chunk->size -= size + sizeof(struct dasd_mchunk);
416 chunk = tmp;
417 } else
418 list_del(&chunk->list);
419 return (void *) (chunk + 1);
421 return NULL;
424 static inline void
425 dasd_free_chunk(struct list_head *chunk_list, void *mem)
427 struct dasd_mchunk *chunk, *tmp;
428 struct list_head *p, *left;
430 chunk = (struct dasd_mchunk *)
431 ((char *) mem - sizeof(struct dasd_mchunk));
432 /* Find out the left neighbour in chunk_list. */
433 left = chunk_list;
434 list_for_each(p, chunk_list) {
435 if (list_entry(p, struct dasd_mchunk, list) > chunk)
436 break;
437 left = p;
439 /* Try to merge with right neighbour = next element from left. */
440 if (left->next != chunk_list) {
441 tmp = list_entry(left->next, struct dasd_mchunk, list);
442 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
443 list_del(&tmp->list);
444 chunk->size += tmp->size + sizeof(struct dasd_mchunk);
447 /* Try to merge with left neighbour. */
448 if (left != chunk_list) {
449 tmp = list_entry(left, struct dasd_mchunk, list);
450 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
451 tmp->size += chunk->size + sizeof(struct dasd_mchunk);
452 return;
455 __list_add(&chunk->list, left, left->next);
459 * Check if bsize is in { 512, 1024, 2048, 4096 }
461 static inline int
462 dasd_check_blocksize(int bsize)
464 if (bsize < 512 || bsize > 4096 || (bsize & (bsize - 1)) != 0)
465 return -EMEDIUMTYPE;
466 return 0;
469 /* externals in dasd.c */
470 #define DASD_PROFILE_ON 1
471 #define DASD_PROFILE_OFF 0
473 extern debug_info_t *dasd_debug_area;
474 extern struct dasd_profile_info_t dasd_global_profile;
475 extern unsigned int dasd_profile_level;
476 extern struct block_device_operations dasd_device_operations;
478 extern kmem_cache_t *dasd_page_cache;
480 struct dasd_ccw_req *
481 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
482 struct dasd_ccw_req *
483 dasd_smalloc_request(char *, int, int, struct dasd_device *);
484 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
485 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
487 static inline int
488 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
490 return set_normalized_cda(ccw, cda);
493 struct dasd_device *dasd_alloc_device(void);
494 void dasd_free_device(struct dasd_device *);
496 void dasd_enable_device(struct dasd_device *);
497 void dasd_set_target_state(struct dasd_device *, int);
498 void dasd_kick_device(struct dasd_device *);
500 void dasd_add_request_head(struct dasd_ccw_req *);
501 void dasd_add_request_tail(struct dasd_ccw_req *);
502 int dasd_start_IO(struct dasd_ccw_req *);
503 int dasd_term_IO(struct dasd_ccw_req *);
504 void dasd_schedule_bh(struct dasd_device *);
505 int dasd_sleep_on(struct dasd_ccw_req *);
506 int dasd_sleep_on_immediatly(struct dasd_ccw_req *);
507 int dasd_sleep_on_interruptible(struct dasd_ccw_req *);
508 void dasd_set_timer(struct dasd_device *, int);
509 void dasd_clear_timer(struct dasd_device *);
510 int dasd_cancel_req(struct dasd_ccw_req *);
511 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
512 void dasd_generic_remove (struct ccw_device *cdev);
513 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
514 int dasd_generic_set_offline (struct ccw_device *cdev);
515 int dasd_generic_notify(struct ccw_device *, int);
516 void dasd_generic_auto_online (struct ccw_driver *);
518 /* externals in dasd_devmap.c */
519 extern int dasd_max_devindex;
520 extern int dasd_probeonly;
521 extern int dasd_autodetect;
523 int dasd_devmap_init(void);
524 void dasd_devmap_exit(void);
526 struct dasd_device *dasd_create_device(struct ccw_device *);
527 void dasd_delete_device(struct dasd_device *);
529 int dasd_get_uid(struct ccw_device *, struct dasd_uid *);
530 int dasd_set_uid(struct ccw_device *, struct dasd_uid *);
531 int dasd_get_feature(struct ccw_device *, int);
532 int dasd_set_feature(struct ccw_device *, int, int);
534 int dasd_add_sysfs_files(struct ccw_device *);
535 void dasd_remove_sysfs_files(struct ccw_device *);
537 struct dasd_device *dasd_device_from_cdev(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,
589 unsigned int id);
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;
596 #else
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__ */
608 #endif /* DASD_H */
611 * Overrides for Emacs so that we follow Linus's tabbing style.
612 * Emacs will notice this stuff at the end of the file and automatically
613 * adjust the settings for this buffer only. This must remain at the end
614 * of the file.
615 * ---------------------------------------------------------------------------
616 * Local variables:
617 * c-indent-level: 4
618 * c-brace-imaginary-offset: 0
619 * c-brace-offset: -4
620 * c-argdecl-indent: 4
621 * c-label-offset: -4
622 * c-continued-statement-offset: 4
623 * c-continued-brace-offset: 0
624 * indent-tabs-mode: 1
625 * tab-width: 8
626 * End: