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