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