drivers/message/i2o/i2o_block.c

   1 /*
   2  *      Block OSM
   3  *
   4  *      Copyright (C) 1999-2002 Red Hat Software
   5  *
   6  *      Written by Alan Cox, Building Number Three Ltd
   7  *
   8  *      This program is free software; you can redistribute it and/or modify it
   9  *      under the terms of the GNU General Public License as published by the
  10  *      Free Software Foundation; either version 2 of the License, or (at your
  11  *      option) any later version.
  12  *
  13  *      This program is distributed in the hope that it will be useful, but
  14  *      WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *      General Public License for more details.
  17  *
  18  *      For the purpose of avoiding doubt the preferred form of the work
  19  *      for making modifications shall be a standards compliant form such
  20  *      gzipped tar and not one requiring a proprietary or patent encumbered
  21  *      tool to unpack.
  22  *
  23  *      Fixes/additions:
  24  *              Steve Ralston:
  25  *                      Multiple device handling error fixes,
  26  *                      Added a queue depth.
  27  *              Alan Cox:
  28  *                      FC920 has an rmw bug. Dont or in the end marker.
  29  *                      Removed queue walk, fixed for 64bitness.
  30  *                      Rewrote much of the code over time
  31  *                      Added indirect block lists
  32  *                      Handle 64K limits on many controllers
  33  *                      Don't use indirects on the Promise (breaks)
  34  *                      Heavily chop down the queue depths
  35  *              Deepak Saxena:
  36  *                      Independent queues per IOP
  37  *                      Support for dynamic device creation/deletion
  38  *                      Code cleanup
  39  *                      Support for larger I/Os through merge* functions
  40  *                      (taken from DAC960 driver)
  41  *              Boji T Kannanthanam:
  42  *                      Set the I2O Block devices to be detected in increasing
  43  *                      order of TIDs during boot.
  44  *                      Search and set the I2O block device that we boot off
  45  *                      from as the first device to be claimed (as /dev/i2o/hda)
  46  *                      Properly attach/detach I2O gendisk structure from the
  47  *                      system gendisk list. The I2O block devices now appear in
  48  *                      /proc/partitions.
  49  *              Markus Lidel <Markus.Lidel@shadowconnect.com>:
  50  *                      Minor bugfixes for 2.6.
  51  */
  52
  53 #include <linux/module.h>
  54 #include <linux/i2o.h>
  55
  56 #include <linux/mempool.h>
  57
  58 #include <linux/genhd.h>
  59 #include <linux/blkdev.h>
  60 #include <linux/hdreg.h>
  61
  62 #include <scsi/scsi.h>
  63
  64 #include "i2o_block.h"
  65
  66 #define OSM_NAME        "block-osm"
  67 #define OSM_VERSION     "1.325"
  68 #define OSM_DESCRIPTION "I2O Block Device OSM"
  69
  70 static struct i2o_driver i2o_block_driver;
  71
  72 /* global Block OSM request mempool */
  73 static struct i2o_block_mempool i2o_blk_req_pool;
  74
  75 /* Block OSM class handling definition */
  76 static struct i2o_class_id i2o_block_class_id[] = {
  77         {I2O_CLASS_RANDOM_BLOCK_STORAGE},
  78         {I2O_CLASS_END}
  79 };
  80
  81 /**
  82  *      i2o_block_device_free - free the memory of the I2O Block device
  83  *      @dev: I2O Block device, which should be cleaned up
  84  *
  85  *      Frees the request queue, gendisk and the i2o_block_device structure.
  86  */
  87 static void i2o_block_device_free(struct i2o_block_device *dev)
  88 {
  89         blk_cleanup_queue(dev->gd->queue);
  90
  91         put_disk(dev->gd);
  92
  93         kfree(dev);
  94 };
  95
  96 /**
  97  *      i2o_block_remove - remove the I2O Block device from the system again
  98  *      @dev: I2O Block device which should be removed
  99  *
 100  *      Remove gendisk from system and free all allocated memory.
 101  *
 102  *      Always returns 0.
 103  */
 104 static int i2o_block_remove(struct device *dev)
 105 {
 106         struct i2o_device *i2o_dev = to_i2o_device(dev);
 107         struct i2o_block_device *i2o_blk_dev = dev_get_drvdata(dev);
 108
 109         osm_info("device removed (TID: %03x): %s\n", i2o_dev->lct_data.tid,
 110                  i2o_blk_dev->gd->disk_name);
 111
 112         i2o_event_register(i2o_dev, &i2o_block_driver, 0, 0);
 113
 114         del_gendisk(i2o_blk_dev->gd);
 115
 116         dev_set_drvdata(dev, NULL);
 117
 118         i2o_device_claim_release(i2o_dev);
 119
 120         i2o_block_device_free(i2o_blk_dev);
 121
 122         return 0;
 123 };
 124
 125 /**
 126  *      i2o_block_device flush - Flush all dirty data of I2O device dev
 127  *      @dev: I2O device which should be flushed
 128  *
 129  *      Flushes all dirty data on device dev.
 130  *
 131  *      Returns 0 on success or negative error code on failure.
 132  */
 133 static int i2o_block_device_flush(struct i2o_device *dev)
 134 {
 135         struct i2o_message *msg;
 136
 137         msg = i2o_msg_get_wait(dev->iop, I2O_TIMEOUT_MESSAGE_GET);
 138         if (IS_ERR(msg))
 139                 return PTR_ERR(msg);
 140
 141         msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
 142         msg->u.head[1] =
 143             cpu_to_le32(I2O_CMD_BLOCK_CFLUSH << 24 | HOST_TID << 12 | dev->
 144                         lct_data.tid);
 145         msg->body[0] = cpu_to_le32(60 << 16);
 146         osm_debug("Flushing...\n");
 147
 148         return i2o_msg_post_wait(dev->iop, msg, 60);
 149 };
 150
 151 /**
 152  *      i2o_block_issue_flush - device-flush interface for block-layer
 153  *      @queue: the request queue of the device which should be flushed
 154  *      @disk: gendisk
 155  *      @error_sector: error offset
 156  *
 157  *      Helper function to provide flush functionality to block-layer.
 158  *
 159  *      Returns 0 on success or negative error code on failure.
 160  */
 161
 162 static int i2o_block_issue_flush(request_queue_t * queue, struct gendisk *disk,
 163                                  sector_t * error_sector)
 164 {
 165         struct i2o_block_device *i2o_blk_dev = queue->queuedata;
 166         int rc = -ENODEV;
 167
 168         if (likely(i2o_blk_dev))
 169                 rc = i2o_block_device_flush(i2o_blk_dev->i2o_dev);
 170
 171         return rc;
 172 }
 173
 174 /**
 175  *      i2o_block_device_mount - Mount (load) the media of device dev
 176  *      @dev: I2O device which should receive the mount request
 177  *      @media_id: Media Identifier
 178  *
 179  *      Load a media into drive. Identifier should be set to -1, because the
 180  *      spec does not support any other value.
 181  *
 182  *      Returns 0 on success or negative error code on failure.
 183  */
 184 static int i2o_block_device_mount(struct i2o_device *dev, u32 media_id)
 185 {
 186         struct i2o_message *msg;
 187
 188         msg = i2o_msg_get_wait(dev->iop, I2O_TIMEOUT_MESSAGE_GET);
 189         if (IS_ERR(msg))
 190                 return PTR_ERR(msg);
 191
 192         msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
 193         msg->u.head[1] =
 194             cpu_to_le32(I2O_CMD_BLOCK_MMOUNT << 24 | HOST_TID << 12 | dev->
 195                         lct_data.tid);
 196         msg->body[0] = cpu_to_le32(-1);
 197         msg->body[1] = cpu_to_le32(0x00000000);
 198         osm_debug("Mounting...\n");
 199
 200         return i2o_msg_post_wait(dev->iop, msg, 2);
 201 };
 202
 203 /**
 204  *      i2o_block_device_lock - Locks the media of device dev
 205  *      @dev: I2O device which should receive the lock request
 206  *      @media_id: Media Identifier
 207  *
 208  *      Lock media of device dev to prevent removal. The media identifier
 209  *      should be set to -1, because the spec does not support any other value.
 210  *
 211  *      Returns 0 on success or negative error code on failure.
 212  */
 213 static int i2o_block_device_lock(struct i2o_device *dev, u32 media_id)
 214 {
 215         struct i2o_message *msg;
 216
 217         msg = i2o_msg_get_wait(dev->iop, I2O_TIMEOUT_MESSAGE_GET);
 218         if (IS_ERR(msg) == I2O_QUEUE_EMPTY)
 219                 return PTR_ERR(msg);
 220
 221         msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
 222         msg->u.head[1] =
 223             cpu_to_le32(I2O_CMD_BLOCK_MLOCK << 24 | HOST_TID << 12 | dev->
 224                         lct_data.tid);
 225         msg->body[0] = cpu_to_le32(-1);
 226         osm_debug("Locking...\n");
 227
 228         return i2o_msg_post_wait(dev->iop, msg, 2);
 229 };
 230
 231 /**
 232  *      i2o_block_device_unlock - Unlocks the media of device dev
 233  *      @dev: I2O device which should receive the unlocked request
 234  *      @media_id: Media Identifier
 235  *
 236  *      Unlocks the media in device dev. The media identifier should be set to
 237  *      -1, because the spec does not support any other value.
 238  *
 239  *      Returns 0 on success or negative error code on failure.
 240  */
 241 static int i2o_block_device_unlock(struct i2o_device *dev, u32 media_id)
 242 {
 243         struct i2o_message *msg;
 244
 245         msg = i2o_msg_get_wait(dev->iop, I2O_TIMEOUT_MESSAGE_GET);
 246         if (IS_ERR(msg))
 247                 return PTR_ERR(msg);
 248
 249         msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
 250         msg->u.head[1] =
 251             cpu_to_le32(I2O_CMD_BLOCK_MUNLOCK << 24 | HOST_TID << 12 | dev->
 252                         lct_data.tid);
 253         msg->body[0] = cpu_to_le32(media_id);
 254         osm_debug("Unlocking...\n");
 255
 256         return i2o_msg_post_wait(dev->iop, msg, 2);
 257 };
 258
 259 /**
 260  *      i2o_block_device_power - Power management for device dev
 261  *      @dev: I2O device which should receive the power management request
 262  *      @operation: Operation which should be send
 263  *
 264  *      Send a power management request to the device dev.
 265  *
 266  *      Returns 0 on success or negative error code on failure.
 267  */
 268 static int i2o_block_device_power(struct i2o_block_device *dev, u8 op)
 269 {
 270         struct i2o_device *i2o_dev = dev->i2o_dev;
 271         struct i2o_controller *c = i2o_dev->iop;
 272         struct i2o_message *msg;
 273         int rc;
 274
 275         msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
 276         if (IS_ERR(msg))
 277                 return PTR_ERR(msg);
 278
 279         msg->u.head[0] = cpu_to_le32(FOUR_WORD_MSG_SIZE | SGL_OFFSET_0);
 280         msg->u.head[1] =
 281             cpu_to_le32(I2O_CMD_BLOCK_POWER << 24 | HOST_TID << 12 | i2o_dev->
 282                         lct_data.tid);
 283         msg->body[0] = cpu_to_le32(op << 24);
 284         osm_debug("Power...\n");
 285
 286         rc = i2o_msg_post_wait(c, msg, 60);
 287         if (!rc)
 288                 dev->power = op;
 289
 290         return rc;
 291 };
 292
 293 /**
 294  *      i2o_block_request_alloc - Allocate an I2O block request struct
 295  *
 296  *      Allocates an I2O block request struct and initialize the list.
 297  *
 298  *      Returns a i2o_block_request pointer on success or negative error code
 299  *      on failure.
 300  */
 301 static inline struct i2o_block_request *i2o_block_request_alloc(void)
 302 {
 303         struct i2o_block_request *ireq;
 304
 305         ireq = mempool_alloc(i2o_blk_req_pool.pool, GFP_ATOMIC);
 306         if (!ireq)
 307                 return ERR_PTR(-ENOMEM);
 308
 309         INIT_LIST_HEAD(&ireq->queue);
 310
 311         return ireq;
 312 };
 313
 314 /**
 315  *      i2o_block_request_free - Frees a I2O block request
 316  *      @ireq: I2O block request which should be freed
 317  *
 318  *      Fres the allocated memory (give it back to the request mempool).
 319  */
 320 static inline void i2o_block_request_free(struct i2o_block_request *ireq)
 321 {
 322         mempool_free(ireq, i2o_blk_req_pool.pool);
 323 };
 324
 325 /**
 326  *      i2o_block_sglist_alloc - Allocate the SG list and map it
 327  *      @c: I2O controller to which the request belongs
 328  *      @ireq: I2O block request
 329  *
 330  *      Builds the SG list and map it to be accessable by the controller.
 331  *
 332  *      Returns 0 on failure or 1 on success.
 333  */
 334 static inline int i2o_block_sglist_alloc(struct i2o_controller *c,
 335                                          struct i2o_block_request *ireq,
 336                                          u32 ** mptr)
 337 {
 338         int nents;
 339         enum dma_data_direction direction;
 340
 341         ireq->dev = &c->pdev->dev;
 342         nents = blk_rq_map_sg(ireq->req->q, ireq->req, ireq->sg_table);
 343
 344         if (rq_data_dir(ireq->req) == READ)
 345                 direction = PCI_DMA_FROMDEVICE;
 346         else
 347                 direction = PCI_DMA_TODEVICE;
 348
 349         ireq->sg_nents = nents;
 350
 351         return i2o_dma_map_sg(c, ireq->sg_table, nents, direction, mptr);
 352 };
 353
 354 /**
 355  *      i2o_block_sglist_free - Frees the SG list
 356  *      @ireq: I2O block request from which the SG should be freed
 357  *
 358  *      Frees the SG list from the I2O block request.
 359  */
 360 static inline void i2o_block_sglist_free(struct i2o_block_request *ireq)
 361 {
 362         enum dma_data_direction direction;
 363
 364         if (rq_data_dir(ireq->req) == READ)
 365                 direction = PCI_DMA_FROMDEVICE;
 366         else
 367                 direction = PCI_DMA_TODEVICE;
 368
 369         dma_unmap_sg(ireq->dev, ireq->sg_table, ireq->sg_nents, direction);
 370 };
 371
 372 /**
 373  *      i2o_block_prep_req_fn - Allocates I2O block device specific struct
 374  *      @q: request queue for the request
 375  *      @req: the request to prepare
 376  *
 377  *      Allocate the necessary i2o_block_request struct and connect it to
 378  *      the request. This is needed that we not loose the SG list later on.
 379  *
 380  *      Returns BLKPREP_OK on success or BLKPREP_DEFER on failure.
 381  */
 382 static int i2o_block_prep_req_fn(struct request_queue *q, struct request *req)
 383 {
 384         struct i2o_block_device *i2o_blk_dev = q->queuedata;
 385         struct i2o_block_request *ireq;
 386
 387         if (unlikely(!i2o_blk_dev)) {
 388                 osm_err("block device already removed\n");
 389                 return BLKPREP_KILL;
 390         }
 391
 392         /* request is already processed by us, so return */
 393         if (req->flags & REQ_SPECIAL) {
 394                 osm_debug("REQ_SPECIAL already set!\n");
 395                 req->flags |= REQ_DONTPREP;
 396                 return BLKPREP_OK;
 397         }
 398
 399         /* connect the i2o_block_request to the request */
 400         if (!req->special) {
 401                 ireq = i2o_block_request_alloc();
 402                 if (unlikely(IS_ERR(ireq))) {
 403                         osm_debug("unable to allocate i2o_block_request!\n");
 404                         return BLKPREP_DEFER;
 405                 }
 406
 407                 ireq->i2o_blk_dev = i2o_blk_dev;
 408                 req->special = ireq;
 409                 ireq->req = req;
 410         } else
 411                 ireq = req->special;
 412
 413         /* do not come back here */
 414         req->flags |= REQ_DONTPREP | REQ_SPECIAL;
 415
 416         return BLKPREP_OK;
 417 };
 418
 419 /**
 420  *      i2o_block_delayed_request_fn - delayed request queue function
 421  *      delayed_request: the delayed request with the queue to start
 422  *
 423  *      If the request queue is stopped for a disk, and there is no open
 424  *      request, a new event is created, which calls this function to start
 425  *      the queue after I2O_BLOCK_REQUEST_TIME. Otherwise the queue will never
 426  *      be started again.
 427  */
 428 static void i2o_block_delayed_request_fn(void *delayed_request)
 429 {
 430         struct i2o_block_delayed_request *dreq = delayed_request;
 431         struct request_queue *q = dreq->queue;
 432         unsigned long flags;
 433
 434         spin_lock_irqsave(q->queue_lock, flags);
 435         blk_start_queue(q);
 436         spin_unlock_irqrestore(q->queue_lock, flags);
 437         kfree(dreq);
 438 };
 439
 440 /**
 441  *      i2o_block_end_request - Post-processing of completed commands
 442  *      @req: request which should be completed
 443  *      @uptodate: 1 for success, 0 for I/O error, < 0 for specific error
 444  *      @nr_bytes: number of bytes to complete
 445  *
 446  *      Mark the request as complete. The lock must not be held when entering.
 447  *
 448  */
 449 static void i2o_block_end_request(struct request *req, int uptodate,
 450                                   int nr_bytes)
 451 {
 452         struct i2o_block_request *ireq = req->special;
 453         struct i2o_block_device *dev = ireq->i2o_blk_dev;
 454         request_queue_t *q = req->q;
 455         unsigned long flags;
 456
 457         if (end_that_request_chunk(req, uptodate, nr_bytes)) {
 458                 int leftover = (req->hard_nr_sectors << KERNEL_SECTOR_SHIFT);
 459
 460                 if (blk_pc_request(req))
 461                         leftover = req->data_len;
 462
 463                 if (end_io_error(uptodate))
 464                         end_that_request_chunk(req, 0, leftover);
 465         }
 466
 467         add_disk_randomness(req->rq_disk);
 468
 469         spin_lock_irqsave(q->queue_lock, flags);
 470
 471         end_that_request_last(req);
 472
 473         if (likely(dev)) {
 474                 dev->open_queue_depth--;
 475                 list_del(&ireq->queue);
 476         }
 477
 478         blk_start_queue(q);
 479
 480         spin_unlock_irqrestore(q->queue_lock, flags);
 481
 482         i2o_block_sglist_free(ireq);
 483         i2o_block_request_free(ireq);
 484 };
 485
 486 /**
 487  *      i2o_block_reply - Block OSM reply handler.
 488  *      @c: I2O controller from which the message arrives
 489  *      @m: message id of reply
 490  *      qmsg: the actuall I2O message reply
 491  *
 492  *      This function gets all the message replies.
 493  *
 494  */
 495 static int i2o_block_reply(struct i2o_controller *c, u32 m,
 496                            struct i2o_message *msg)
 497 {
 498         struct request *req;
 499         int uptodate = 1;
 500
 501         req = i2o_cntxt_list_get(c, le32_to_cpu(msg->u.s.tcntxt));
 502         if (unlikely(!req)) {
 503                 osm_err("NULL reply received!\n");
 504                 return -1;
 505         }
 506
 507         /*
 508          *      Lets see what is cooking. We stuffed the
 509          *      request in the context.
 510          */
 511
 512         if ((le32_to_cpu(msg->body[0]) >> 24) != 0) {
 513                 u32 status = le32_to_cpu(msg->body[0]);
 514                 /*
 515                  *      Device not ready means two things. One is that the
 516                  *      the thing went offline (but not a removal media)
 517                  *
 518                  *      The second is that you have a SuperTrak 100 and the
 519                  *      firmware got constipated. Unlike standard i2o card
 520                  *      setups the supertrak returns an error rather than
 521                  *      blocking for the timeout in these cases.
 522                  *
 523                  *      Don't stick a supertrak100 into cache aggressive modes
 524                  */
 525
 526                 osm_err("TID %03x error status: 0x%02x, detailed status: "
 527                         "0x%04x\n", (le32_to_cpu(msg->u.head[1]) >> 12 & 0xfff),
 528                         status >> 24, status & 0xffff);
 529
 530                 req->errors++;
 531
 532                 uptodate = 0;
 533         }
 534
 535         i2o_block_end_request(req, uptodate, le32_to_cpu(msg->body[1]));
 536
 537         return 1;
 538 };
 539
 540 static void i2o_block_event(struct i2o_event *evt)
 541 {
 542         osm_debug("event received\n");
 543         kfree(evt);
 544 };
 545
 546 /*
 547  *      SCSI-CAM for ioctl geometry mapping
 548  *      Duplicated with SCSI - this should be moved into somewhere common
 549  *      perhaps genhd ?
 550  *
 551  * LBA -> CHS mapping table taken from:
 552  *
 553  * "Incorporating the I2O Architecture into BIOS for Intel Architecture
 554  *  Platforms"
 555  *
 556  * This is an I2O document that is only available to I2O members,
 557  * not developers.
 558  *
 559  * From my understanding, this is how all the I2O cards do this
 560  *
 561  * Disk Size      | Sectors | Heads | Cylinders
 562  * ---------------+---------+-------+-------------------
 563  * 1 < X <= 528M  | 63      | 16    | X/(63 * 16 * 512)
 564  * 528M < X <= 1G | 63      | 32    | X/(63 * 32 * 512)
 565  * 1 < X <528M    | 63      | 16    | X/(63 * 16 * 512)
 566  * 1 < X <528M    | 63      | 16    | X/(63 * 16 * 512)
 567  *
 568  */
 569 #define BLOCK_SIZE_528M         1081344
 570 #define BLOCK_SIZE_1G           2097152
 571 #define BLOCK_SIZE_21G          4403200
 572 #define BLOCK_SIZE_42G          8806400
 573 #define BLOCK_SIZE_84G          17612800
 574
 575 static void i2o_block_biosparam(unsigned long capacity, unsigned short *cyls,
 576                                 unsigned char *hds, unsigned char *secs)
 577 {
 578         unsigned long heads, sectors, cylinders;
 579
 580         sectors = 63L;          /* Maximize sectors per track */
 581         if (capacity <= BLOCK_SIZE_528M)
 582                 heads = 16;
 583         else if (capacity <= BLOCK_SIZE_1G)
 584                 heads = 32;
 585         else if (capacity <= BLOCK_SIZE_21G)
 586                 heads = 64;
 587         else if (capacity <= BLOCK_SIZE_42G)
 588                 heads = 128;
 589         else
 590                 heads = 255;
 591
 592         cylinders = (unsigned long)capacity / (heads * sectors);
 593
 594         *cyls = (unsigned short)cylinders;      /* Stuff return values */
 595         *secs = (unsigned char)sectors;
 596         *hds = (unsigned char)heads;
 597 }
 598
 599 /**
 600  *      i2o_block_open - Open the block device
 601  *
 602  *      Power up the device, mount and lock the media. This function is called,
 603  *      if the block device is opened for access.
 604  *
 605  *      Returns 0 on success or negative error code on failure.
 606  */
 607 static int i2o_block_open(struct inode *inode, struct file *file)
 608 {
 609         struct i2o_block_device *dev = inode->i_bdev->bd_disk->private_data;
 610
 611         if (!dev->i2o_dev)
 612                 return -ENODEV;
 613
 614         if (dev->power > 0x1f)
 615                 i2o_block_device_power(dev, 0x02);
 616
 617         i2o_block_device_mount(dev->i2o_dev, -1);
 618
 619         i2o_block_device_lock(dev->i2o_dev, -1);
 620
 621         osm_debug("Ready.\n");
 622
 623         return 0;
 624 };
 625
 626 /**
 627  *      i2o_block_release - Release the I2O block device
 628  *
 629  *      Unlock and unmount the media, and power down the device. Gets called if
 630  *      the block device is closed.
 631  *
 632  *      Returns 0 on success or negative error code on failure.
 633  */
 634 static int i2o_block_release(struct inode *inode, struct file *file)
 635 {
 636         struct gendisk *disk = inode->i_bdev->bd_disk;
 637         struct i2o_block_device *dev = disk->private_data;
 638         u8 operation;
 639
 640         /*
 641          * This is to deail with the case of an application
 642          * opening a device and then the device dissapears while
 643          * it's in use, and then the application tries to release
 644          * it.  ex: Unmounting a deleted RAID volume at reboot.
 645          * If we send messages, it will just cause FAILs since
 646          * the TID no longer exists.
 647          */
 648         if (!dev->i2o_dev)
 649                 return 0;
 650
 651         i2o_block_device_flush(dev->i2o_dev);
 652
 653         i2o_block_device_unlock(dev->i2o_dev, -1);
 654
 655         if (dev->flags & (1 << 3 | 1 << 4))     /* Removable */
 656                 operation = 0x21;
 657         else
 658                 operation = 0x24;
 659
 660         i2o_block_device_power(dev, operation);
 661
 662         return 0;
 663 }
 664
 665 /**
 666  *      i2o_block_ioctl - Issue device specific ioctl calls.
 667  *      @cmd: ioctl command
 668  *      @arg: arg
 669  *
 670  *      Handles ioctl request for the block device.
 671  *
 672  *      Return 0 on success or negative error on failure.
 673  */
 674 static int i2o_block_ioctl(struct inode *inode, struct file *file,
 675                            unsigned int cmd, unsigned long arg)
 676 {
 677         struct gendisk *disk = inode->i_bdev->bd_disk;
 678         struct i2o_block_device *dev = disk->private_data;
 679         void __user *argp = (void __user *)arg;
 680
 681         /* Anyone capable of this syscall can do *real bad* things */
 682
 683         if (!capable(CAP_SYS_ADMIN))
 684                 return -EPERM;
 685
 686         switch (cmd) {
 687         case HDIO_GETGEO:
 688                 {
 689                         struct hd_geometry g;
 690                         i2o_block_biosparam(get_capacity(disk),
 691                                             &g.cylinders, &g.heads, &g.sectors);
 692                         g.start = get_start_sect(inode->i_bdev);
 693                         return copy_to_user(argp, &g, sizeof(g)) ? -EFAULT : 0;
 694                 }
 695
 696         case BLKI2OGRSTRAT:
 697                 return put_user(dev->rcache, (int __user *)arg);
 698         case BLKI2OGWSTRAT:
 699                 return put_user(dev->wcache, (int __user *)arg);
 700         case BLKI2OSRSTRAT:
 701                 if (arg < 0 || arg > CACHE_SMARTFETCH)
 702                         return -EINVAL;
 703                 dev->rcache = arg;
 704                 break;
 705         case BLKI2OSWSTRAT:
 706                 if (arg != 0
 707                     && (arg < CACHE_WRITETHROUGH || arg > CACHE_SMARTBACK))
 708                         return -EINVAL;
 709                 dev->wcache = arg;
 710                 break;
 711         }
 712         return -ENOTTY;
 713 };
 714
 715 /**
 716  *      i2o_block_media_changed - Have we seen a media change?
 717  *      @disk: gendisk which should be verified
 718  *
 719  *      Verifies if the media has changed.
 720  *
 721  *      Returns 1 if the media was changed or 0 otherwise.
 722  */
 723 static int i2o_block_media_changed(struct gendisk *disk)
 724 {
 725         struct i2o_block_device *p = disk->private_data;
 726
 727         if (p->media_change_flag) {
 728                 p->media_change_flag = 0;
 729                 return 1;
 730         }
 731         return 0;
 732 }
 733
 734 /**
 735  *      i2o_block_transfer - Transfer a request to/from the I2O controller
 736  *      @req: the request which should be transfered
 737  *
 738  *      This function converts the request into a I2O message. The necessary
 739  *      DMA buffers are allocated and after everything is setup post the message
 740  *      to the I2O controller. No cleanup is done by this function. It is done
 741  *      on the interrupt side when the reply arrives.
 742  *
 743  *      Return 0 on success or negative error code on failure.
 744  */
 745 static int i2o_block_transfer(struct request *req)
 746 {
 747         struct i2o_block_device *dev = req->rq_disk->private_data;
 748         struct i2o_controller *c;
 749         int tid = dev->i2o_dev->lct_data.tid;
 750         struct i2o_message *msg;
 751         u32 *mptr;
 752         struct i2o_block_request *ireq = req->special;
 753         u32 tcntxt;
 754         u32 sgl_offset = SGL_OFFSET_8;
 755         u32 ctl_flags = 0x00000000;
 756         int rc;
 757         u32 cmd;
 758
 759         if (unlikely(!dev->i2o_dev)) {
 760                 osm_err("transfer to removed drive\n");
 761                 rc = -ENODEV;
 762                 goto exit;
 763         }
 764
 765         c = dev->i2o_dev->iop;
 766
 767         msg = i2o_msg_get(c);
 768         if (IS_ERR(msg)) {
 769                 rc = PTR_ERR(msg);
 770                 goto exit;
 771         }
 772
 773         tcntxt = i2o_cntxt_list_add(c, req);
 774         if (!tcntxt) {
 775                 rc = -ENOMEM;
 776                 goto nop_msg;
 777         }
 778
 779         msg->u.s.icntxt = cpu_to_le32(i2o_block_driver.context);
 780         msg->u.s.tcntxt = cpu_to_le32(tcntxt);
 781
 782         mptr = &msg->body[0];
 783
 784         if (rq_data_dir(req) == READ) {
 785                 cmd = I2O_CMD_BLOCK_READ << 24;
 786
 787                 switch (dev->rcache) {
 788                 case CACHE_PREFETCH:
 789                         ctl_flags = 0x201F0008;
 790                         break;
 791
 792                 case CACHE_SMARTFETCH:
 793                         if (req->nr_sectors > 16)
 794                                 ctl_flags = 0x201F0008;
 795                         else
 796                                 ctl_flags = 0x001F0000;
 797                         break;
 798
 799                 default:
 800                         break;
 801                 }
 802         } else {
 803                 cmd = I2O_CMD_BLOCK_WRITE << 24;
 804
 805                 switch (dev->wcache) {
 806                 case CACHE_WRITETHROUGH:
 807                         ctl_flags = 0x001F0008;
 808                         break;
 809                 case CACHE_WRITEBACK:
 810                         ctl_flags = 0x001F0010;
 811                         break;
 812                 case CACHE_SMARTBACK:
 813                         if (req->nr_sectors > 16)
 814                                 ctl_flags = 0x001F0004;
 815                         else
 816                                 ctl_flags = 0x001F0010;
 817                         break;
 818                 case CACHE_SMARTTHROUGH:
 819                         if (req->nr_sectors > 16)
 820                                 ctl_flags = 0x001F0004;
 821                         else
 822                                 ctl_flags = 0x001F0010;
 823                 default:
 824                         break;
 825                 }
 826         }
 827
 828 #ifdef CONFIG_I2O_EXT_ADAPTEC
 829         if (c->adaptec) {
 830                 u8 cmd[10];
 831                 u32 scsi_flags;
 832                 u16 hwsec = queue_hardsect_size(req->q) >> KERNEL_SECTOR_SHIFT;
 833
 834                 memset(cmd, 0, 10);
 835
 836                 sgl_offset = SGL_OFFSET_12;
 837
 838                 msg->u.head[1] =
 839                     cpu_to_le32(I2O_CMD_PRIVATE << 24 | HOST_TID << 12 | tid);
 840
 841                 *mptr++ = cpu_to_le32(I2O_VENDOR_DPT << 16 | I2O_CMD_SCSI_EXEC);
 842                 *mptr++ = cpu_to_le32(tid);
 843
 844                 /*
 845                  * ENABLE_DISCONNECT
 846                  * SIMPLE_TAG
 847                  * RETURN_SENSE_DATA_IN_REPLY_MESSAGE_FRAME
 848                  */
 849                 if (rq_data_dir(req) == READ) {
 850                         cmd[0] = READ_10;
 851                         scsi_flags = 0x60a0000a;
 852                 } else {
 853                         cmd[0] = WRITE_10;
 854                         scsi_flags = 0xa0a0000a;
 855                 }
 856
 857                 *mptr++ = cpu_to_le32(scsi_flags);
 858
 859                 *((u32 *) & cmd[2]) = cpu_to_be32(req->sector * hwsec);
 860                 *((u16 *) & cmd[7]) = cpu_to_be16(req->nr_sectors * hwsec);
 861
 862                 memcpy(mptr, cmd, 10);
 863                 mptr += 4;
 864                 *mptr++ = cpu_to_le32(req->nr_sectors << KERNEL_SECTOR_SHIFT);
 865         } else
 866 #endif
 867         {
 868                 msg->u.head[1] = cpu_to_le32(cmd | HOST_TID << 12 | tid);
 869                 *mptr++ = cpu_to_le32(ctl_flags);
 870                 *mptr++ = cpu_to_le32(req->nr_sectors << KERNEL_SECTOR_SHIFT);
 871                 *mptr++ =
 872                     cpu_to_le32((u32) (req->sector << KERNEL_SECTOR_SHIFT));
 873                 *mptr++ =
 874                     cpu_to_le32(req->sector >> (32 - KERNEL_SECTOR_SHIFT));
 875         }
 876
 877         if (!i2o_block_sglist_alloc(c, ireq, &mptr)) {
 878                 rc = -ENOMEM;
 879                 goto context_remove;
 880         }
 881
 882         msg->u.head[0] =
 883             cpu_to_le32(I2O_MESSAGE_SIZE(mptr - &msg->u.head[0]) | sgl_offset);
 884
 885         list_add_tail(&ireq->queue, &dev->open_queue);
 886         dev->open_queue_depth++;
 887
 888         i2o_msg_post(c, msg);
 889
 890         return 0;
 891
 892       context_remove:
 893         i2o_cntxt_list_remove(c, req);
 894
 895       nop_msg:
 896         i2o_msg_nop(c, msg);
 897
 898       exit:
 899         return rc;
 900 };
 901
 902 /**
 903  *      i2o_block_request_fn - request queue handling function
 904  *      q: request queue from which the request could be fetched
 905  *
 906  *      Takes the next request from the queue, transfers it and if no error
 907  *      occurs dequeue it from the queue. On arrival of the reply the message
 908  *      will be processed further. If an error occurs requeue the request.
 909  */
 910 static void i2o_block_request_fn(struct request_queue *q)
 911 {
 912         struct request *req;
 913
 914         while (!blk_queue_plugged(q)) {
 915                 req = elv_next_request(q);
 916                 if (!req)
 917                         break;
 918
 919                 if (blk_fs_request(req)) {
 920                         struct i2o_block_delayed_request *dreq;
 921                         struct i2o_block_request *ireq = req->special;
 922                         unsigned int queue_depth;
 923
 924                         queue_depth = ireq->i2o_blk_dev->open_queue_depth;
 925
 926                         if (queue_depth < I2O_BLOCK_MAX_OPEN_REQUESTS) {
 927                                 if (!i2o_block_transfer(req)) {
 928                                         blkdev_dequeue_request(req);
 929                                         continue;
 930                                 } else
 931                                         osm_info("transfer error\n");
 932                         }
 933
 934                         if (queue_depth)
 935                                 break;
 936
 937                         /* stop the queue and retry later */
 938                         dreq = kmalloc(sizeof(*dreq), GFP_ATOMIC);
 939                         if (!dreq)
 940                                 continue;
 941
 942                         dreq->queue = q;
 943                         INIT_WORK(&dreq->work, i2o_block_delayed_request_fn,
 944                                   dreq);
 945
 946                         if (!queue_delayed_work(i2o_block_driver.event_queue,
 947                                                 &dreq->work,
 948                                                 I2O_BLOCK_RETRY_TIME))
 949                                 kfree(dreq);
 950                         else {
 951                                 blk_stop_queue(q);
 952                                 break;
 953                         }
 954                 } else
 955                         end_request(req, 0);
 956         }
 957 };
 958
 959 /* I2O Block device operations definition */
 960 static struct block_device_operations i2o_block_fops = {
 961         .owner = THIS_MODULE,
 962         .open = i2o_block_open,
 963         .release = i2o_block_release,
 964         .ioctl = i2o_block_ioctl,
 965         .media_changed = i2o_block_media_changed
 966 };
 967
 968 /**
 969  *      i2o_block_device_alloc - Allocate memory for a I2O Block device
 970  *
 971  *      Allocate memory for the i2o_block_device struct, gendisk and request
 972  *      queue and initialize them as far as no additional information is needed.
 973  *
 974  *      Returns a pointer to the allocated I2O Block device on succes or a
 975  *      negative error code on failure.
 976  */
 977 static struct i2o_block_device *i2o_block_device_alloc(void)
 978 {
 979         struct i2o_block_device *dev;
 980         struct gendisk *gd;
 981         struct request_queue *queue;
 982         int rc;
 983
 984         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 985         if (!dev) {
 986                 osm_err("Insufficient memory to allocate I2O Block disk.\n");
 987                 rc = -ENOMEM;
 988                 goto exit;
 989         }
 990
 991         INIT_LIST_HEAD(&dev->open_queue);
 992         spin_lock_init(&dev->lock);
 993         dev->rcache = CACHE_PREFETCH;
 994         dev->wcache = CACHE_WRITEBACK;
 995
 996         /* allocate a gendisk with 16 partitions */
 997         gd = alloc_disk(16);
 998         if (!gd) {
 999                 osm_err("Insufficient memory to allocate gendisk.\n");
1000                 rc = -ENOMEM;
1001                 goto cleanup_dev;
1002         }
1003
1004         /* initialize the request queue */
1005         queue = blk_init_queue(i2o_block_request_fn, &dev->lock);
1006         if (!queue) {
1007                 osm_err("Insufficient memory to allocate request queue.\n");
1008                 rc = -ENOMEM;
1009                 goto cleanup_queue;
1010         }
1011
1012         blk_queue_prep_rq(queue, i2o_block_prep_req_fn);
1013         blk_queue_issue_flush_fn(queue, i2o_block_issue_flush);
1014
1015         gd->major = I2O_MAJOR;
1016         gd->queue = queue;
1017         gd->fops = &i2o_block_fops;
1018         gd->private_data = dev;
1019
1020         dev->gd = gd;
1021
1022         return dev;
1023
1024       cleanup_queue:
1025         put_disk(gd);
1026
1027       cleanup_dev:
1028         kfree(dev);
1029
1030       exit:
1031         return ERR_PTR(rc);
1032 };
1033
1034 /**
1035  *      i2o_block_probe - verify if dev is a I2O Block device and install it
1036  *      @dev: device to verify if it is a I2O Block device
1037  *
1038  *      We only verify if the user_tid of the device is 0xfff and then install
1039  *      the device. Otherwise it is used by some other device (e. g. RAID).
1040  *
1041  *      Returns 0 on success or negative error code on failure.
1042  */
1043 static int i2o_block_probe(struct device *dev)
1044 {
1045         struct i2o_device *i2o_dev = to_i2o_device(dev);
1046         struct i2o_controller *c = i2o_dev->iop;
1047         struct i2o_block_device *i2o_blk_dev;
1048         struct gendisk *gd;
1049         struct request_queue *queue;
1050         static int unit = 0;
1051         int rc;
1052         u64 size;
1053         u32 blocksize;
1054         u16 body_size = 4;
1055         u16 power;
1056         unsigned short max_sectors;
1057
1058 #ifdef CONFIG_I2O_EXT_ADAPTEC
1059         if (c->adaptec)
1060                 body_size = 8;
1061 #endif
1062
1063         if (c->limit_sectors)
1064                 max_sectors = I2O_MAX_SECTORS_LIMITED;
1065         else
1066                 max_sectors = I2O_MAX_SECTORS;
1067
1068         /* skip devices which are used by IOP */
1069         if (i2o_dev->lct_data.user_tid != 0xfff) {
1070                 osm_debug("skipping used device %03x\n", i2o_dev->lct_data.tid);
1071                 return -ENODEV;
1072         }
1073
1074         if (i2o_device_claim(i2o_dev)) {
1075                 osm_warn("Unable to claim device. Installation aborted\n");
1076                 rc = -EFAULT;
1077                 goto exit;
1078         }
1079
1080         i2o_blk_dev = i2o_block_device_alloc();
1081         if (IS_ERR(i2o_blk_dev)) {
1082                 osm_err("could not alloc a new I2O block device");
1083                 rc = PTR_ERR(i2o_blk_dev);
1084                 goto claim_release;
1085         }
1086
1087         i2o_blk_dev->i2o_dev = i2o_dev;
1088         dev_set_drvdata(dev, i2o_blk_dev);
1089
1090         /* setup gendisk */
1091         gd = i2o_blk_dev->gd;
1092         gd->first_minor = unit << 4;
1093         sprintf(gd->disk_name, "i2o/hd%c", 'a' + unit);
1094         sprintf(gd->devfs_name, "i2o/hd%c", 'a' + unit);
1095         gd->driverfs_dev = &i2o_dev->device;
1096
1097         /* setup request queue */
1098         queue = gd->queue;
1099         queue->queuedata = i2o_blk_dev;
1100
1101         blk_queue_max_phys_segments(queue, I2O_MAX_PHYS_SEGMENTS);
1102         blk_queue_max_sectors(queue, max_sectors);
1103         blk_queue_max_hw_segments(queue, i2o_sg_tablesize(c, body_size));
1104
1105         osm_debug("max sectors = %d\n", queue->max_phys_segments);
1106         osm_debug("phys segments = %d\n", queue->max_sectors);
1107         osm_debug("max hw segments = %d\n", queue->max_hw_segments);
1108
1109         /*
1110          *      Ask for the current media data. If that isn't supported
1111          *      then we ask for the device capacity data
1112          */
1113         if (!i2o_parm_field_get(i2o_dev, 0x0004, 1, &blocksize, 4) ||
1114             !i2o_parm_field_get(i2o_dev, 0x0000, 3, &blocksize, 4)) {
1115                 blk_queue_hardsect_size(queue, le32_to_cpu(blocksize));
1116         } else
1117                 osm_warn("unable to get blocksize of %s\n", gd->disk_name);
1118
1119         if (!i2o_parm_field_get(i2o_dev, 0x0004, 0, &size, 8) ||
1120             !i2o_parm_field_get(i2o_dev, 0x0000, 4, &size, 8)) {
1121                 set_capacity(gd, le64_to_cpu(size) >> KERNEL_SECTOR_SHIFT);
1122         } else
1123                 osm_warn("could not get size of %s\n", gd->disk_name);
1124
1125         if (!i2o_parm_field_get(i2o_dev, 0x0000, 2, &power, 2))
1126                 i2o_blk_dev->power = power;
1127
1128         i2o_event_register(i2o_dev, &i2o_block_driver, 0, 0xffffffff);
1129
1130         add_disk(gd);
1131
1132         unit++;
1133
1134         osm_info("device added (TID: %03x): %s\n", i2o_dev->lct_data.tid,
1135                  i2o_blk_dev->gd->disk_name);
1136
1137         return 0;
1138
1139       claim_release:
1140         i2o_device_claim_release(i2o_dev);
1141
1142       exit:
1143         return rc;
1144 };
1145
1146 /* Block OSM driver struct */
1147 static struct i2o_driver i2o_block_driver = {
1148         .name = OSM_NAME,
1149         .event = i2o_block_event,
1150         .reply = i2o_block_reply,
1151         .classes = i2o_block_class_id,
1152         .driver = {
1153                    .probe = i2o_block_probe,
1154                    .remove = i2o_block_remove,
1155                    },
1156 };
1157
1158 /**
1159  *      i2o_block_init - Block OSM initialization function
1160  *
1161  *      Allocate the slab and mempool for request structs, registers i2o_block
1162  *      block device and finally register the Block OSM in the I2O core.
1163  *
1164  *      Returns 0 on success or negative error code on failure.
1165  */
1166 static int __init i2o_block_init(void)
1167 {
1168         int rc;
1169         int size;
1170
1171         printk(KERN_INFO OSM_DESCRIPTION " v" OSM_VERSION "\n");
1172
1173         /* Allocate request mempool and slab */
1174         size = sizeof(struct i2o_block_request);
1175         i2o_blk_req_pool.slab = kmem_cache_create("i2o_block_req", size, 0,
1176                                                   SLAB_HWCACHE_ALIGN, NULL,
1177                                                   NULL);
1178         if (!i2o_blk_req_pool.slab) {
1179                 osm_err("can't init request slab\n");
1180                 rc = -ENOMEM;
1181                 goto exit;
1182         }
1183
1184         i2o_blk_req_pool.pool = mempool_create(I2O_BLOCK_REQ_MEMPOOL_SIZE,
1185                                                mempool_alloc_slab,
1186                                                mempool_free_slab,
1187                                                i2o_blk_req_pool.slab);
1188         if (!i2o_blk_req_pool.pool) {
1189                 osm_err("can't init request mempool\n");
1190                 rc = -ENOMEM;
1191                 goto free_slab;
1192         }
1193
1194         /* Register the block device interfaces */
1195         rc = register_blkdev(I2O_MAJOR, "i2o_block");
1196         if (rc) {
1197                 osm_err("unable to register block device\n");
1198                 goto free_mempool;
1199         }
1200 #ifdef MODULE
1201         osm_info("registered device at major %d\n", I2O_MAJOR);
1202 #endif
1203
1204         /* Register Block OSM into I2O core */
1205         rc = i2o_driver_register(&i2o_block_driver);
1206         if (rc) {
1207                 osm_err("Could not register Block driver\n");
1208                 goto unregister_blkdev;
1209         }
1210
1211         return 0;
1212
1213       unregister_blkdev:
1214         unregister_blkdev(I2O_MAJOR, "i2o_block");
1215
1216       free_mempool:
1217         mempool_destroy(i2o_blk_req_pool.pool);
1218
1219       free_slab:
1220         kmem_cache_destroy(i2o_blk_req_pool.slab);
1221
1222       exit:
1223         return rc;
1224 };
1225
1226 /**
1227  *      i2o_block_exit - Block OSM exit function
1228  *
1229  *      Unregisters Block OSM from I2O core, unregisters i2o_block block device
1230  *      and frees the mempool and slab.
1231  */
1232 static void __exit i2o_block_exit(void)
1233 {
1234         /* Unregister I2O Block OSM from I2O core */
1235         i2o_driver_unregister(&i2o_block_driver);
1236
1237         /* Unregister block device */
1238         unregister_blkdev(I2O_MAJOR, "i2o_block");
1239
1240         /* Free request mempool and slab */
1241         mempool_destroy(i2o_blk_req_pool.pool);
1242         kmem_cache_destroy(i2o_blk_req_pool.slab);
1243 };
1244
1245 MODULE_AUTHOR("Red Hat");
1246 MODULE_LICENSE("GPL");
1247 MODULE_DESCRIPTION(OSM_DESCRIPTION);
1248 MODULE_VERSION(OSM_VERSION);
1249
1250 module_init(i2o_block_init);
1251 module_exit(i2o_block_exit);