drivers/s390/block/dasd_int.h

   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.60 $
  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 struct dasd_ccw_req {
 154         unsigned int magic;             /* Eye catcher */
 155         struct list_head list;          /* list_head for request queueing. */
 156
 157         /* Where to execute what... */
 158         struct dasd_device *device;     /* device the request is for */
 159         struct ccw1 *cpaddr;            /* address of channel program */
 160         char status;                    /* status of this request */
 161         short retries;                  /* A retry counter */
 162         unsigned long flags;            /* flags of this request */
 163
 164         /* ... and how */
 165         unsigned long starttime;        /* jiffies time of request start */
 166         int expires;                    /* expiration period in jiffies */
 167         char lpm;                       /* logical path mask */
 168         void *data;                     /* pointer to data area */
 169
 170         /* these are important for recovering erroneous requests          */
 171         struct irb irb;                 /* device status in case of an error */
 172         struct dasd_ccw_req *refers;    /* ERP-chain queueing. */
 173         void *function;                 /* originating ERP action */
 174
 175         /* these are for statistics only */
 176         unsigned long long buildclk;    /* TOD-clock of request generation */
 177         unsigned long long startclk;    /* TOD-clock of request start */
 178         unsigned long long stopclk;     /* TOD-clock of request interrupt */
 179         unsigned long long endclk;      /* TOD-clock of request termination */
 180
 181         /* Callback that is called after reaching final status. */
 182         void (*callback)(struct dasd_ccw_req *, void *data);
 183         void *callback_data;
 184 };
 185
 186 /*
 187  * dasd_ccw_req -> status can be:
 188  */
 189 #define DASD_CQR_FILLED   0x00  /* request is ready to be processed */
 190 #define DASD_CQR_QUEUED   0x01  /* request is queued to be processed */
 191 #define DASD_CQR_IN_IO    0x02  /* request is currently in IO */
 192 #define DASD_CQR_DONE     0x03  /* request is completed successfully */
 193 #define DASD_CQR_ERROR    0x04  /* request is completed with error */
 194 #define DASD_CQR_FAILED   0x05  /* request is finally failed */
 195 #define DASD_CQR_CLEAR    0x06  /* request is clear pending */
 196
 197 /* per dasd_ccw_req flags */
 198 #define DASD_CQR_FLAGS_USE_ERP   0      /* use ERP for this request */
 199
 200 /* Signature for error recovery functions. */
 201 typedef struct dasd_ccw_req *(*dasd_erp_fn_t) (struct dasd_ccw_req *);
 202
 203 /*
 204  * the struct dasd_discipline is
 205  * sth like a table of virtual functions, if you think of dasd_eckd
 206  * inheriting dasd...
 207  * no, currently we are not planning to reimplement the driver in C++
 208  */
 209 struct dasd_discipline {
 210         struct module *owner;
 211         char ebcname[8];        /* a name used for tagging and printks */
 212         char name[8];           /* a name used for tagging and printks */
 213         int max_blocks;         /* maximum number of blocks to be chained */
 214
 215         struct list_head list;  /* used for list of disciplines */
 216
 217         /*
 218          * Device recognition functions. check_device is used to verify
 219          * the sense data and the information returned by read device
 220          * characteristics. It returns 0 if the discipline can be used
 221          * for the device in question.
 222          * do_analysis is used in the step from device state "basic" to
 223          * state "accept". It returns 0 if the device can be made ready,
 224          * it returns -EMEDIUMTYPE if the device can't be made ready or
 225          * -EAGAIN if do_analysis started a ccw that needs to complete
 226          * before the analysis may be repeated.
 227          */
 228         int (*check_device)(struct dasd_device *);
 229         int (*do_analysis) (struct dasd_device *);
 230
 231         /*
 232          * Device operation functions. build_cp creates a ccw chain for
 233          * a block device request, start_io starts the request and
 234          * term_IO cancels it (e.g. in case of a timeout). format_device
 235          * returns a ccw chain to be used to format the device.
 236          */
 237         struct dasd_ccw_req *(*build_cp) (struct dasd_device *,
 238                                           struct request *);
 239         int (*start_IO) (struct dasd_ccw_req *);
 240         int (*term_IO) (struct dasd_ccw_req *);
 241         struct dasd_ccw_req *(*format_device) (struct dasd_device *,
 242                                                struct format_data_t *);
 243
 244         /*
 245          * Error recovery functions. examine_error() returns a value that
 246          * indicates what to do for an error condition. If examine_error()
 247          * returns 'dasd_era_recover' erp_action() is called to create a
 248          * special error recovery ccw. erp_postaction() is called after
 249          * an error recovery ccw has finished its execution. dump_sense
 250          * is called for every error condition to print the sense data
 251          * to the console.
 252          */
 253         dasd_era_t(*examine_error) (struct dasd_ccw_req *, struct irb *);
 254         dasd_erp_fn_t(*erp_action) (struct dasd_ccw_req *);
 255         dasd_erp_fn_t(*erp_postaction) (struct dasd_ccw_req *);
 256         void (*dump_sense) (struct dasd_device *, struct dasd_ccw_req *,
 257                             struct irb *);
 258
 259         /* i/o control functions. */
 260         int (*fill_geometry) (struct dasd_device *, struct hd_geometry *);
 261         int (*fill_info) (struct dasd_device *, struct dasd_information2_t *);
 262 };
 263
 264 extern struct dasd_discipline *dasd_diag_discipline_pointer;
 265
 266 struct dasd_device {
 267         /* Block device stuff. */
 268         struct gendisk *gdp;
 269         request_queue_t *request_queue;
 270         spinlock_t request_queue_lock;
 271         struct block_device *bdev;
 272         unsigned int devindex;
 273         unsigned long blocks;           /* size of volume in blocks */
 274         unsigned int bp_block;          /* bytes per block */
 275         unsigned int s2b_shift;         /* log2 (bp_block/512) */
 276         unsigned long flags;            /* per device flags */
 277
 278         /* Device discipline stuff. */
 279         struct dasd_discipline *discipline;
 280         char *private;
 281
 282         /* Device state and target state. */
 283         int state, target;
 284         int stopped;            /* device (ccw_device_start) was stopped */
 285
 286         /* Open and reference count. */
 287         atomic_t ref_count;
 288         atomic_t open_count;
 289
 290         /* ccw queue and memory for static ccw/erp buffers. */
 291         struct list_head ccw_queue;
 292         spinlock_t mem_lock;
 293         void *ccw_mem;
 294         void *erp_mem;
 295         struct list_head ccw_chunks;
 296         struct list_head erp_chunks;
 297
 298         atomic_t tasklet_scheduled;
 299         struct tasklet_struct tasklet;
 300         struct work_struct kick_work;
 301         struct timer_list timer;
 302
 303         debug_info_t *debug_area;
 304
 305         struct ccw_device *cdev;
 306
 307 #ifdef CONFIG_DASD_PROFILE
 308         struct dasd_profile_info_t profile;
 309 #endif
 310 };
 311
 312 /* reasons why device (ccw_device_start) was stopped */
 313 #define DASD_STOPPED_NOT_ACC 1         /* not accessible */
 314 #define DASD_STOPPED_QUIESCE 2         /* Quiesced */
 315 #define DASD_STOPPED_PENDING 4         /* long busy */
 316 #define DASD_STOPPED_DC_WAIT 8         /* disconnected, wait */
 317 #define DASD_STOPPED_DC_EIO  16        /* disconnected, return -EIO */
 318
 319 /* per device flags */
 320 #define DASD_FLAG_RO            0       /* device is read-only */
 321 #define DASD_FLAG_USE_DIAG      1       /* use diag disciplnie */
 322 #define DASD_FLAG_DSC_ERROR     2       /* return -EIO when disconnected */
 323 #define DASD_FLAG_OFFLINE       3       /* device is in offline processing */
 324
 325 void dasd_put_device_wake(struct dasd_device *);
 326
 327 /*
 328  * Reference count inliners
 329  */
 330 static inline void
 331 dasd_get_device(struct dasd_device *device)
 332 {
 333         atomic_inc(&device->ref_count);
 334 }
 335
 336 static inline void
 337 dasd_put_device(struct dasd_device *device)
 338 {
 339         if (atomic_dec_return(&device->ref_count) == 0)
 340                 dasd_put_device_wake(device);
 341 }
 342
 343 /*
 344  * The static memory in ccw_mem and erp_mem is managed by a sorted
 345  * list of free memory chunks.
 346  */
 347 struct dasd_mchunk
 348 {
 349         struct list_head list;
 350         unsigned long size;
 351 } __attribute__ ((aligned(8)));
 352
 353 static inline void
 354 dasd_init_chunklist(struct list_head *chunk_list, void *mem,
 355                     unsigned long size)
 356 {
 357         struct dasd_mchunk *chunk;
 358
 359         INIT_LIST_HEAD(chunk_list);
 360         chunk = (struct dasd_mchunk *) mem;
 361         chunk->size = size - sizeof(struct dasd_mchunk);
 362         list_add(&chunk->list, chunk_list);
 363 }
 364
 365 static inline void *
 366 dasd_alloc_chunk(struct list_head *chunk_list, unsigned long size)
 367 {
 368         struct dasd_mchunk *chunk, *tmp;
 369
 370         size = (size + 7L) & -8L;
 371         list_for_each_entry(chunk, chunk_list, list) {
 372                 if (chunk->size < size)
 373                         continue;
 374                 if (chunk->size > size + sizeof(struct dasd_mchunk)) {
 375                         char *endaddr = (char *) (chunk + 1) + chunk->size;
 376                         tmp = (struct dasd_mchunk *) (endaddr - size) - 1;
 377                         tmp->size = size;
 378                         chunk->size -= size + sizeof(struct dasd_mchunk);
 379                         chunk = tmp;
 380                 } else
 381                         list_del(&chunk->list);
 382                 return (void *) (chunk + 1);
 383         }
 384         return NULL;
 385 }
 386
 387 static inline void
 388 dasd_free_chunk(struct list_head *chunk_list, void *mem)
 389 {
 390         struct dasd_mchunk *chunk, *tmp;
 391         struct list_head *p, *left;
 392
 393         chunk = (struct dasd_mchunk *)
 394                 ((char *) mem - sizeof(struct dasd_mchunk));
 395         /* Find out the left neighbour in chunk_list. */
 396         left = chunk_list;
 397         list_for_each(p, chunk_list) {
 398                 if (list_entry(p, struct dasd_mchunk, list) > chunk)
 399                         break;
 400                 left = p;
 401         }
 402         /* Try to merge with right neighbour = next element from left. */
 403         if (left->next != chunk_list) {
 404                 tmp = list_entry(left->next, struct dasd_mchunk, list);
 405                 if ((char *) (chunk + 1) + chunk->size == (char *) tmp) {
 406                         list_del(&tmp->list);
 407                         chunk->size += tmp->size + sizeof(struct dasd_mchunk);
 408                 }
 409         }
 410         /* Try to merge with left neighbour. */
 411         if (left != chunk_list) {
 412                 tmp = list_entry(left, struct dasd_mchunk, list);
 413                 if ((char *) (tmp + 1) + tmp->size == (char *) chunk) {
 414                         tmp->size += chunk->size + sizeof(struct dasd_mchunk);
 415                         return;
 416                 }
 417         }
 418         __list_add(&chunk->list, left, left->next);
 419 }
 420
 421 /*
 422  * Check if bsize is in { 512, 1024, 2048, 4096 }
 423  */
 424 static inline int
 425 dasd_check_blocksize(int bsize)
 426 {
 427         if (bsize < 512 || bsize > 4096 || (bsize & (bsize - 1)) != 0)
 428                 return -EMEDIUMTYPE;
 429         return 0;
 430 }
 431
 432 /* externals in dasd.c */
 433 #define DASD_PROFILE_ON  1
 434 #define DASD_PROFILE_OFF 0
 435
 436 extern debug_info_t *dasd_debug_area;
 437 extern struct dasd_profile_info_t dasd_global_profile;
 438 extern unsigned int dasd_profile_level;
 439 extern struct block_device_operations dasd_device_operations;
 440
 441 struct dasd_ccw_req *
 442 dasd_kmalloc_request(char *, int, int, struct dasd_device *);
 443 struct dasd_ccw_req *
 444 dasd_smalloc_request(char *, int, int, struct dasd_device *);
 445 void dasd_kfree_request(struct dasd_ccw_req *, struct dasd_device *);
 446 void dasd_sfree_request(struct dasd_ccw_req *, struct dasd_device *);
 447
 448 static inline int
 449 dasd_kmalloc_set_cda(struct ccw1 *ccw, void *cda, struct dasd_device *device)
 450 {
 451         return set_normalized_cda(ccw, cda);
 452 }
 453
 454 struct dasd_device *dasd_alloc_device(void);
 455 void dasd_free_device(struct dasd_device *);
 456
 457 void dasd_enable_device(struct dasd_device *);
 458 void dasd_set_target_state(struct dasd_device *, int);
 459 void dasd_kick_device(struct dasd_device *);
 460
 461 void dasd_add_request_head(struct dasd_ccw_req *);
 462 void dasd_add_request_tail(struct dasd_ccw_req *);
 463 int  dasd_start_IO(struct dasd_ccw_req *);
 464 int  dasd_term_IO(struct dasd_ccw_req *);
 465 void dasd_schedule_bh(struct dasd_device *);
 466 int  dasd_sleep_on(struct dasd_ccw_req *);
 467 int  dasd_sleep_on_immediatly(struct dasd_ccw_req *);
 468 int  dasd_sleep_on_interruptible(struct dasd_ccw_req *);
 469 void dasd_set_timer(struct dasd_device *, int);
 470 void dasd_clear_timer(struct dasd_device *);
 471 int  dasd_cancel_req(struct dasd_ccw_req *);
 472 int dasd_generic_probe (struct ccw_device *, struct dasd_discipline *);
 473 void dasd_generic_remove (struct ccw_device *cdev);
 474 int dasd_generic_set_online(struct ccw_device *, struct dasd_discipline *);
 475 int dasd_generic_set_offline (struct ccw_device *cdev);
 476 int dasd_generic_notify(struct ccw_device *, int);
 477 void dasd_generic_auto_online (struct ccw_driver *);
 478
 479 /* externals in dasd_devmap.c */
 480 extern int dasd_max_devindex;
 481 extern int dasd_probeonly;
 482 extern int dasd_autodetect;
 483
 484 int dasd_devmap_init(void);
 485 void dasd_devmap_exit(void);
 486
 487 struct dasd_device *dasd_create_device(struct ccw_device *);
 488 void dasd_delete_device(struct dasd_device *);
 489
 490 int dasd_add_sysfs_files(struct ccw_device *);
 491 void dasd_remove_sysfs_files(struct ccw_device *);
 492
 493 struct dasd_device *dasd_device_from_cdev(struct ccw_device *);
 494 struct dasd_device *dasd_device_from_devindex(int);
 495
 496 int dasd_parse(void);
 497 int dasd_busid_known(char *);
 498
 499 /* externals in dasd_gendisk.c */
 500 int  dasd_gendisk_init(void);
 501 void dasd_gendisk_exit(void);
 502 int dasd_gendisk_alloc(struct dasd_device *);
 503 void dasd_gendisk_free(struct dasd_device *);
 504 int dasd_scan_partitions(struct dasd_device *);
 505 void dasd_destroy_partitions(struct dasd_device *);
 506
 507 /* externals in dasd_ioctl.c */
 508 int  dasd_ioctl_init(void);
 509 void dasd_ioctl_exit(void);
 510 int  dasd_ioctl_no_register(struct module *, int, dasd_ioctl_fn_t);
 511 int  dasd_ioctl_no_unregister(struct module *, int, dasd_ioctl_fn_t);
 512 int  dasd_ioctl(struct inode *, struct file *, unsigned int, unsigned long);
 513
 514 /* externals in dasd_proc.c */
 515 int dasd_proc_init(void);
 516 void dasd_proc_exit(void);
 517
 518 /* externals in dasd_erp.c */
 519 struct dasd_ccw_req *dasd_default_erp_action(struct dasd_ccw_req *);
 520 struct dasd_ccw_req *dasd_default_erp_postaction(struct dasd_ccw_req *);
 521 struct dasd_ccw_req *dasd_alloc_erp_request(char *, int, int, struct dasd_device *);
 522 void dasd_free_erp_request(struct dasd_ccw_req *, struct dasd_device *);
 523 void dasd_log_sense(struct dasd_ccw_req *, struct irb *);
 524 void dasd_log_ccw(struct dasd_ccw_req *, int, __u32);
 525
 526 /* externals in dasd_3370_erp.c */
 527 dasd_era_t dasd_3370_erp_examine(struct dasd_ccw_req *, struct irb *);
 528
 529 /* externals in dasd_3990_erp.c */
 530 dasd_era_t dasd_3990_erp_examine(struct dasd_ccw_req *, struct irb *);
 531 struct dasd_ccw_req *dasd_3990_erp_action(struct dasd_ccw_req *);
 532
 533 /* externals in dasd_9336_erp.c */
 534 dasd_era_t dasd_9336_erp_examine(struct dasd_ccw_req *, struct irb *);
 535
 536 /* externals in dasd_9336_erp.c */
 537 dasd_era_t dasd_9343_erp_examine(struct dasd_ccw_req *, struct irb *);
 538 struct dasd_ccw_req *dasd_9343_erp_action(struct dasd_ccw_req *);
 539
 540 #endif                          /* __KERNEL__ */
 541
 542 #endif                          /* DASD_H */
 543
 544 /*
 545  * Overrides for Emacs so that we follow Linus's tabbing style.
 546  * Emacs will notice this stuff at the end of the file and automatically
 547  * adjust the settings for this buffer only.  This must remain at the end
 548  * of the file.
 549  * ---------------------------------------------------------------------------
 550  * Local variables:
 551  * c-indent-level: 4
 552  * c-brace-imaginary-offset: 0
 553  * c-brace-offset: -4
 554  * c-argdecl-indent: 4
 555  * c-label-offset: -4
 556  * c-continued-statement-offset: 4
 557  * c-continued-brace-offset: 0
 558  * indent-tabs-mode: 1
 559  * tab-width: 8
 560  * End:
 561  */