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 8 * 9 * $Revision: 1.63 $ 10 */ 11 12 #ifndef DASD_INT_H 13 #define DASD_INT_H 14 15 #ifdef __KERNEL__ 16 17 /* erp debugging in dasd.c and dasd_3990_erp.c */ 18 #define ERP_DEBUG 19 20 21 /* we keep old device allocation scheme; IOW, minors are still in 0..255 */ 22 #define DASD_PER_MAJOR (1U << (MINORBITS - DASD_PARTN_BITS)) 23 #define DASD_PARTN_MASK ((1 << DASD_PARTN_BITS) - 1) 24 25 /* 26 * States a dasd device can have: 27 * new: the dasd_device structure is allocated. 28 * known: the discipline for the device is identified. 29 * basic: the device can do basic i/o. 30 * accept: the device is analysed (format is known). 31 * ready: partition detection is done and the device is can do block io. 32 * online: the device accepts requests from the block device queue. 33 * 34 * Things to do for startup state transitions: 35 * new -> known: find discipline for the device and create devfs entries. 36 * known -> basic: request irq line for the device. 37 * basic -> ready: do the initial analysis, e.g. format detection, 38 * do block device setup and detect partitions. 39 * ready -> online: schedule the device tasklet. 40 * Things to do for shutdown state transitions: 41 * online -> ready: just set the new device state. 42 * ready -> basic: flush requests from the block device layer, clear 43 * partition information and reset format information. 44 * basic -> known: terminate all requests and free irq. 45 * known -> new: remove devfs entries and forget discipline. 46 */ 47 48 #define DASD_STATE_NEW 0 49 #define DASD_STATE_KNOWN 1 50 #define DASD_STATE_BASIC 2 51 #define DASD_STATE_READY 3 52 #define DASD_STATE_ONLINE 4 53 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> 66 67 /* 68 * SECTION: Type definitions 69 */ 70 struct dasd_device; 71 72 typedef int (*dasd_ioctl_fn_t) (struct block_device *bdev, int no, long args); 73 74 struct dasd_ioctl { 75 struct list_head list; 76 struct module *owner; 77 int no; 78 dasd_ioctl_fn_t handler; 79 }; 80 81 typedef enum { 82 dasd_era_fatal = -1, /* no chance to recover */ 83 dasd_era_none = 0, /* don't recover, everything alright */ 84 dasd_era_msg = 1, /* don't recover, just report... */ 85 dasd_era_recover = 2 /* recovery action recommended */ 86 } dasd_era_t; 87 88 /* BIT DEFINITIONS FOR SENSE DATA */ 89 #define DASD_SENSE_BIT_0 0x80 90 #define DASD_SENSE_BIT_1 0x40 91 #define DASD_SENSE_BIT_2 0x20 92 #define DASD_SENSE_BIT_3 0x10 93 94 /* 95 * SECTION: MACROs for klogd and s390 debug feature (dbf) 96 */ 97 #define DBF_DEV_EVENT(d_level, d_device, d_str, d_data...) \ 98 do { \ 99 debug_sprintf_event(d_device->debug_area, \ 100 d_level, \ 101 d_str "\n", \ 102 d_data); \ 103 } while(0) 104 105 #define DBF_DEV_EXC(d_level, d_device, d_str, d_data...) \ 106 do { \ 107 debug_sprintf_exception(d_device->debug_area, \ 108 d_level, \ 109 d_str "\n", \ 110 d_data); \ 111 } while(0) 112 113 #define DBF_EVENT(d_level, d_str, d_data...)\ 114 do { \ 115 debug_sprintf_event(dasd_debug_area, \ 116 d_level,\ 117 d_str "\n", \ 118 d_data); \ 119 } while(0) 120 121 #define DBF_EXC(d_level, d_str, d_data...)\ 122 do { \ 123 debug_sprintf_exception(dasd_debug_area, \ 124 d_level,\ 125 d_str "\n", \ 126 d_data); \ 127 } while(0) 128 129 /* definition of dbf debug levels */ 130 #define DBF_EMERG 0 /* system is unusable */ 131 #define DBF_ALERT 1 /* action must be taken immediately */ 132 #define DBF_CRIT 2 /* critical conditions */ 133 #define DBF_ERR 3 /* error conditions */ 134 #define DBF_WARNING 4 /* warning conditions */ 135 #define DBF_NOTICE 5 /* normal but significant condition */ 136 #define DBF_INFO 6 /* informational */ 137 #define DBF_DEBUG 6 /* debug-level messages */ 138 139 /* messages to be written via klogd and dbf */ 140 #define DEV_MESSAGE(d_loglevel,d_device,d_string,d_args...)\ 141 do { \ 142 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \ 143 d_device->cdev->dev.bus_id, d_args); \ 144 DBF_DEV_EVENT(DBF_ALERT, d_device, d_string, d_args); \ 145 } while(0) 146 147 #define MESSAGE(d_loglevel,d_string,d_args...)\ 148 do { \ 149 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \ 150 DBF_EVENT(DBF_ALERT, d_string, d_args); \ 151 } while(0) 152 153 /* messages to be written via klogd only */ 154 #define DEV_MESSAGE_LOG(d_loglevel,d_device,d_string,d_args...)\ 155 do { \ 156 printk(d_loglevel PRINTK_HEADER " %s: " d_string "\n", \ 157 d_device->cdev->dev.bus_id, d_args); \ 158 } while(0) 159 160 #define MESSAGE_LOG(d_loglevel,d_string,d_args...)\ 161 do { \ 162 printk(d_loglevel PRINTK_HEADER " " d_string "\n", d_args); \ 163 } while(0) 164 165 struct dasd_ccw_req { 166 unsigned int magic; /* Eye catcher */ 167 struct list_head list; /* list_head for request queueing. */ 168 169 /* Where to execute what... */ 170 struct dasd_device *device; /* device the request is for */ 171 struct ccw1 *cpaddr; /* address of channel program */ 172 char status; /* status of this request */ 173 short retries; /* A retry counter */ 174 unsigned long flags; /* flags of this request */ 175 176 /* ... and how */ 177 unsigned long starttime; /* jiffies time of request start */ 178 int expires; /* expiration period in jiffies */ 179 char lpm; /* logical path mask */ 180 void *data; /* pointer to data area */ 181 182 /* these are important for recovering erroneous requests */ 183 struct irb irb; /* device status in case of an error */ 184 struct dasd_ccw_req *refers; /* ERP-chain queueing. */ 185 void *function; /* originating ERP action */ 186 187 /* these are for statistics only */ 188 unsigned long long buildclk; /* TOD-clock of request generation */ 189 unsigned long long startclk; /* TOD-clock of request start */ 190 unsigned long long stopclk; /* TOD-clock of request interrupt */ 191 unsigned long long endclk; /* TOD-clock of request termination */ 192 193 /* Callback that is called after reaching final status. */ 194 void (*callback)(struct dasd_ccw_req *, void *data); 195 void *callback_data; 196 }; 197 198 /* 199 * dasd_ccw_req -> status can be: 200 */ 201 #define DASD_CQR_FILLED 0x00 /* request is ready to be processed */ 202 #define DASD_CQR_QUEUED 0x01 /* request is queued to be processed */ 203 #define DASD_CQR_IN_IO 0x02 /* request is currently in IO */ 204 #define DASD_CQR_DONE 0x03 /* request is completed successfully */ 205 #define DASD_CQR_ERROR 0x04 /* request is completed with error */ 206 #define DASD_CQR_FAILED 0x05 /* request is finally failed */ 207 #define DASD_CQR_CLEAR 0x06 /* request is clear pending */ 208 209 /* per dasd_ccw_req flags */ 210 #define DASD_CQR_FLAGS_USE_ERP 0 /* use ERP for this request */ 211 212 /* Signature for error recovery functions. */ 213 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *); 214 215 /* 216 * the struct dasd_discipline is 217 * sth like a table of virtual functions, if you think of dasd_eckd 218 * inheriting dasd... 219 * no, currently we are not planning to reimplement the driver in C++ 220 */ 221 struct dasd_discipline { 222 struct module *owner; 223 char ebcname[8]; /* a name used for tagging and printks */ 224 char name[8]; /* a name used for tagging and printks */ 225 int max_blocks; /* maximum number of blocks to be chained */ 226 227 struct list_head list; /* used for list of disciplines */ 228 229 /* 230 * Device recognition functions. check_device is used to verify 231 * the sense data and the information returned by read device 232 * characteristics. It returns 0 if the discipline can be used 233 * for the device in question. 234 * do_analysis is used in the step from device state "basic" to 235 * state "accept". It returns 0 if the device can be made ready, 236 * it returns -EMEDIUMTYPE if the device can't be made ready or 237 * -EAGAIN if do_analysis started a ccw that needs to complete 238 * before the analysis may be repeated. 239 */ 240 int (*check_device)(struct dasd_device *); 241 int (*do_analysis) (struct dasd_device *); 242 243 /* 244 * Device operation functions. build_cp creates a ccw chain for 245 * a block device request, start_io starts the request and 246 * term_IO cancels it (e.g. in case of a timeout). format_device 247 * returns a ccw chain to be used to format the device. 248 */ 249 struct dasd_ccw_req *(*build_cp) (struct dasd_device *, 250 struct request *); 251 int (*start_IO) (struct dasd_ccw_req *); 252 int (*term_IO) (struct dasd_ccw_req *); 253 struct dasd_ccw_req *(*format_device) (struct dasd_device *, 254 struct format_data_t *); 255 int (*free_cp) (struct dasd_ccw_req *, struct request *); 256 /* 257 * Error recovery functions. examine_error() returns a value that 258 * indicates what to do for an error condition. If examine_error() 259 * returns 'dasd_era_recover' erp_action() is called to create a 260 * special error recovery ccw. erp_postaction() is called after 261 * an error recovery ccw has finished its execution. dump_sense 262 * is called for every error condition to print the sense data 263 * to the console. 264 */ 265 dasd_era_t(*examine_error) (struct dasd_ccw_req *, struct irb *); 266 dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *); 267 dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *); 268 void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *, 269 struct irb *); 270 271 /* i/o control functions. */ 272 int (*fill_geometry) (struct dasd_device *, struct hd_geometry *); 273 int (*fill_info) (struct dasd_device *, struct dasd_information2_t *); 274 }; 275 276 extern struct dasd_discipline *dasd_diag_discipline_pointer; 277 278 struct dasd_device { 279 /* Block device stuff. */ 280 struct gendisk *gdp; 281 request_queue_t *request_queue; 282 spinlock_t request_queue_lock; 283 struct block_device *bdev; 284 unsigned int devindex; 285 unsigned long blocks; /* size of volume in blocks */ 286 unsigned int bp_block; /* bytes per block */ 287 unsigned int s2b_shift; /* log2 (bp_block/512) */ 288 unsigned long flags; /* per device flags */ 289 290 /* Device discipline stuff. */ 291 struct dasd_discipline *discipline; 292 char *private; 293 294 /* Device state and target state. */ 295 int state, target; 296 int stopped; /* device (ccw_device_start) was stopped */ 297 298 /* Open and reference count. */ 299 atomic_t ref_count; 300 atomic_t open_count; 301 302 /* ccw queue and memory for static ccw/erp buffers. */ 303 struct list_head ccw_queue; 304 spinlock_t mem_lock; 305 void *ccw_mem; 306 void *erp_mem; 307 struct list_head ccw_chunks; 308 struct list_head erp_chunks; 309 310 atomic_t tasklet_scheduled; 311 struct tasklet_struct tasklet; 312 struct work_struct kick_work; 313 struct timer_list timer; 314 315 debug_info_t *debug_area; 316 317 struct ccw_device *cdev; 318 319 #ifdef CONFIG_DASD_PROFILE 320 struct dasd_profile_info_t profile; 321 #endif 322 }; 323 324 /* reasons why device (ccw_device_start) was stopped */ 325 #define DASD_STOPPED_NOT_ACC 1 /* not accessible */ 326 #define DASD_STOPPED_QUIESCE 2 /* Quiesced */ 327 #define DASD_STOPPED_PENDING 4 /* long busy */ 328 #define DASD_STOPPED_DC_WAIT 8 /* disconnected, wait */ 329 #define DASD_STOPPED_DC_EIO 16 /* disconnected, return -EIO */ 330 331 /* per device flags */ 332 #define DASD_FLAG_RO 0 /* device is read-only */ 333 #define DASD_FLAG_USE_DIAG 1 /* use diag disciplnie */ 334 #define DASD_FLAG_DSC_ERROR 2 /* return -EIO when disconnected */ 335 #define DASD_FLAG_OFFLINE 3 /* device is in offline processing */ 336 337 void dasd_put_device_wake(struct dasd_device *); 338 339 /* 340 * Reference count inliners 341 */ 342 static inline void 343 dasd_get_device(struct dasd_device *device) 344 { 345 atomic_inc(&device->ref_count); 346 } 347 348 static inline void 349 dasd_put_device(struct dasd_device *device) 350 { 351 if (atomic_dec_return(&device->ref_count) == 0) 352 dasd_put_device_wake(device); 353 } 354 355 /* 356 * The static memory in ccw_mem and erp_mem is managed by a sorted 357 * list of free memory chunks. 358 */ 359 struct dasd_mchunk 360 { 361 struct list_head list; 362 unsigned long size; 363 } __attribute__ ((aligned(8))); 364 365 static inline void 366 dasd_init_chunklist(struct list_head *chunk_list, void *mem, 367 unsigned long size) 368 { 369 struct dasd_mchunk *chunk; 370 371 INIT_LIST_HEAD(chunk_list); 372 chunk = (struct dasd_mchunk *) mem; 373 chunk->size = size - sizeof(struct dasd_mchunk); 374 list_add(&chunk->list, chunk_list); 375 } 376 377 static inline void * 378 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size) 379 { 380 struct dasd_mchunk *chunk, *tmp; 381 382 size = (size + 7L) & -8L; 383 list_for_each_entry(chunk, chunk_list, list) { 384 if (chunk->size < size) 385 continue; 386 if (chunk->size > size + sizeof(struct dasd_mchunk)) { 387 char *endaddr = (char *) (chunk + 1) + chunk->size; 388 tmp = (struct dasd_mchunk *) (endaddr - size) - 1; 389 tmp->size = size; 390 chunk->size -= size + sizeof(struct dasd_mchunk); 391 chunk = tmp; 392 } else 393 list_del(&chunk->list); 394 return (void *) (chunk + 1); 395 } 396 return NULL; 397 } 398 399 static inline void 400 dasd_free_chunk(struct list_head *chunk_list, void *mem) 401 { 402 struct dasd_mchunk *chunk, *tmp; 403 struct list_head *p, *left; 404 405 chunk = (struct dasd_mchunk *) 406 ((char *) mem - sizeof(struct dasd_mchunk)); 407 /* Find out the left neighbour in chunk_list. */ 408 left = chunk_list; 409 list_for_each(p, chunk_list) { 410 if (list_entry(p, struct dasd_mchunk, list) > chunk) 411 break; 412 left = p; 413 } 414 /* Try to merge with right neighbour = next element from left. */ 415 if (left->next != chunk_list) { 416 tmp = list_entry(left->next, struct dasd_mchunk, list); 417 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) { 418 list_del(&tmp->list); 419 chunk->size += tmp->size + sizeof(struct dasd_mchunk); 420 } 421 } 422 /* Try to merge with left neighbour. */ 423 if (left != chunk_list) { 424 tmp = list_entry(left, struct dasd_mchunk, list); 425 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) { 426 tmp->size += chunk->size + sizeof(struct dasd_mchunk); 427 return; 428 } 429 } 430 __list_add(&chunk->list, left, left->next); 431 } 432 433 /* 434 * Check if bsize is in { 512, 1024, 2048, 4096 } 435 */ 436 static inline int 437 dasd_check_blocksize(int bsize) 438 { 439 if (bsize < 512 || bsize > 4096 || (bsize & (bsize - 1)) != 0) 440 return -EMEDIUMTYPE; 441 return 0; 442 } 443 444 /* externals in dasd.c */ 445 #define DASD_PROFILE_ON 1 446 #define DASD_PROFILE_OFF 0 447 448 extern debug_info_t *dasd_debug_area; 449 extern struct dasd_profile_info_t dasd_global_profile; 450 extern unsigned int dasd_profile_level; 451 extern struct block_device_operations dasd_device_operations; 452 453 extern kmem_cache_t *dasd_page_cache; 454 455 struct dasd_ccw_req * 456 dasd_kmalloc_request(char *, int, int, struct dasd_device *); 457 struct dasd_ccw_req * 458 dasd_smalloc_request(char *, int, int, struct dasd_device *); 459 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *); 460 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *); 461 462 static inline int 463 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device) 464 { 465 return set_normalized_cda(ccw, cda); 466 } 467 468 struct dasd_device *dasd_alloc_device(void); 469 void dasd_free_device(struct dasd_device *); 470 471 void dasd_enable_device(struct dasd_device *); 472 void dasd_set_target_state(struct dasd_device *, int); 473 void dasd_kick_device(struct dasd_device *); 474 475 void dasd_add_request_head(struct dasd_ccw_req *); 476 void dasd_add_request_tail(struct dasd_ccw_req *); 477 int dasd_start_IO(struct dasd_ccw_req *); 478 int dasd_term_IO(struct dasd_ccw_req *); 479 void dasd_schedule_bh(struct dasd_device *); 480 int dasd_sleep_on(struct dasd_ccw_req *); 481 int dasd_sleep_on_immediatly(struct dasd_ccw_req *); 482 int dasd_sleep_on_interruptible(struct dasd_ccw_req *); 483 void dasd_set_timer(struct dasd_device *, int); 484 void dasd_clear_timer(struct dasd_device *); 485 int dasd_cancel_req(struct dasd_ccw_req *); 486 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *); 487 void dasd_generic_remove (struct ccw_device *cdev); 488 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *); 489 int dasd_generic_set_offline (struct ccw_device *cdev); 490 int dasd_generic_notify(struct ccw_device *, int); 491 void dasd_generic_auto_online (struct ccw_driver *); 492 493 /* externals in dasd_devmap.c */ 494 extern int dasd_max_devindex; 495 extern int dasd_probeonly; 496 extern int dasd_autodetect; 497 498 int dasd_devmap_init(void); 499 void dasd_devmap_exit(void); 500 501 struct dasd_device *dasd_create_device(struct ccw_device *); 502 void dasd_delete_device(struct dasd_device *); 503 504 int dasd_add_sysfs_files(struct ccw_device *); 505 void dasd_remove_sysfs_files(struct ccw_device *); 506 507 struct dasd_device *dasd_device_from_cdev(struct ccw_device *); 508 struct dasd_device *dasd_device_from_devindex(int); 509 510 int dasd_parse(void); 511 int dasd_busid_known(char *); 512 513 /* externals in dasd_gendisk.c */ 514 int dasd_gendisk_init(void); 515 void dasd_gendisk_exit(void); 516 int dasd_gendisk_alloc(struct dasd_device *); 517 void dasd_gendisk_free(struct dasd_device *); 518 int dasd_scan_partitions(struct dasd_device *); 519 void dasd_destroy_partitions(struct dasd_device *); 520 521 /* externals in dasd_ioctl.c */ 522 int dasd_ioctl_init(void); 523 void dasd_ioctl_exit(void); 524 int dasd_ioctl_no_register(struct module *, int, dasd_ioctl_fn_t); 525 int dasd_ioctl_no_unregister(struct module *, int, dasd_ioctl_fn_t); 526 int dasd_ioctl(struct inode *, struct file *, unsigned int, unsigned long); 527 528 /* externals in dasd_proc.c */ 529 int dasd_proc_init(void); 530 void dasd_proc_exit(void); 531 532 /* externals in dasd_erp.c */ 533 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *); 534 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *); 535 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int, 536 struct dasd_device *); 537 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *); 538 void dasd_log_sense(struct dasd_ccw_req *, struct irb *); 539 void dasd_log_ccw(struct dasd_ccw_req *, int, __u32); 540 541 /* externals in dasd_3370_erp.c */ 542 dasd_era_t dasd_3370_erp_examine(struct dasd_ccw_req *, struct irb *); 543 544 /* externals in dasd_3990_erp.c */ 545 dasd_era_t dasd_3990_erp_examine(struct dasd_ccw_req *, struct irb *); 546 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *); 547 548 /* externals in dasd_9336_erp.c */ 549 dasd_era_t dasd_9336_erp_examine(struct dasd_ccw_req *, struct irb *); 550 551 /* externals in dasd_9336_erp.c */ 552 dasd_era_t dasd_9343_erp_examine(struct dasd_ccw_req *, struct irb *); 553 struct dasd_ccw_req *dasd_9343_erp_action(struct dasd_ccw_req *); 554 555 #endif /* __KERNEL__ */ 556 557 #endif /* DASD_H */ 558 559 /* 560 * Overrides for Emacs so that we follow Linus's tabbing style. 561 * Emacs will notice this stuff at the end of the file and automatically 562 * adjust the settings for this buffer only. This must remain at the end 563 * of the file. 564 * --------------------------------------------------------------------------- 565 * Local variables: 566 * c-indent-level: 4 567 * c-brace-imaginary-offset: 0 568 * c-brace-offset: -4 569 * c-argdecl-indent: 4 570 * c-label-offset: -4 571 * c-continued-statement-offset: 4 572 * c-continued-brace-offset: 0 573 * indent-tabs-mode: 1 574 * tab-width: 8 575 * End: 576 */ 577