Merge branch 'intx' of master.kernel.org:/pub/scm/linux/kernel/git/jgarzik/misc-2.6
[pandora-kernel.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_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  *      @op: Operation to 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  *      Frees 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  *      @mptr: message body pointer
330  *
331  *      Builds the SG list and map it to be accessable by the controller.
332  *
333  *      Returns 0 on failure or 1 on success.
334  */
335 static inline int i2o_block_sglist_alloc(struct i2o_controller *c,
336                                          struct i2o_block_request *ireq,
337                                          u32 ** mptr)
338 {
339         int nents;
340         enum dma_data_direction direction;
341
342         ireq->dev = &c->pdev->dev;
343         nents = blk_rq_map_sg(ireq->req->q, ireq->req, ireq->sg_table);
344
345         if (rq_data_dir(ireq->req) == READ)
346                 direction = PCI_DMA_FROMDEVICE;
347         else
348                 direction = PCI_DMA_TODEVICE;
349
350         ireq->sg_nents = nents;
351
352         return i2o_dma_map_sg(c, ireq->sg_table, nents, direction, mptr);
353 };
354
355 /**
356  *      i2o_block_sglist_free - Frees the SG list
357  *      @ireq: I2O block request from which the SG should be freed
358  *
359  *      Frees the SG list from the I2O block request.
360  */
361 static inline void i2o_block_sglist_free(struct i2o_block_request *ireq)
362 {
363         enum dma_data_direction direction;
364
365         if (rq_data_dir(ireq->req) == READ)
366                 direction = PCI_DMA_FROMDEVICE;
367         else
368                 direction = PCI_DMA_TODEVICE;
369
370         dma_unmap_sg(ireq->dev, ireq->sg_table, ireq->sg_nents, direction);
371 };
372
373 /**
374  *      i2o_block_prep_req_fn - Allocates I2O block device specific struct
375  *      @q: request queue for the request
376  *      @req: the request to prepare
377  *
378  *      Allocate the necessary i2o_block_request struct and connect it to
379  *      the request. This is needed that we not loose the SG list later on.
380  *
381  *      Returns BLKPREP_OK on success or BLKPREP_DEFER on failure.
382  */
383 static int i2o_block_prep_req_fn(struct request_queue *q, struct request *req)
384 {
385         struct i2o_block_device *i2o_blk_dev = q->queuedata;
386         struct i2o_block_request *ireq;
387
388         if (unlikely(!i2o_blk_dev)) {
389                 osm_err("block device already removed\n");
390                 return BLKPREP_KILL;
391         }
392
393         /* request is already processed by us, so return */
394         if (blk_special_request(req)) {
395                 osm_debug("REQ_SPECIAL already set!\n");
396                 req->cmd_flags |= REQ_DONTPREP;
397                 return BLKPREP_OK;
398         }
399
400         /* connect the i2o_block_request to the request */
401         if (!req->special) {
402                 ireq = i2o_block_request_alloc();
403                 if (unlikely(IS_ERR(ireq))) {
404                         osm_debug("unable to allocate i2o_block_request!\n");
405                         return BLKPREP_DEFER;
406                 }
407
408                 ireq->i2o_blk_dev = i2o_blk_dev;
409                 req->special = ireq;
410                 ireq->req = req;
411         } else
412                 ireq = req->special;
413
414         /* do not come back here */
415         req->cmd_type = REQ_TYPE_SPECIAL;
416         req->cmd_flags |= REQ_DONTPREP;
417
418         return BLKPREP_OK;
419 };
420
421 /**
422  *      i2o_block_delayed_request_fn - delayed request queue function
423  *      @work: the delayed request with the queue to start
424  *
425  *      If the request queue is stopped for a disk, and there is no open
426  *      request, a new event is created, which calls this function to start
427  *      the queue after I2O_BLOCK_REQUEST_TIME. Otherwise the queue will never
428  *      be started again.
429  */
430 static void i2o_block_delayed_request_fn(struct work_struct *work)
431 {
432         struct i2o_block_delayed_request *dreq =
433                 container_of(work, struct i2o_block_delayed_request,
434                              work.work);
435         struct request_queue *q = dreq->queue;
436         unsigned long flags;
437
438         spin_lock_irqsave(q->queue_lock, flags);
439         blk_start_queue(q);
440         spin_unlock_irqrestore(q->queue_lock, flags);
441         kfree(dreq);
442 };
443
444 /**
445  *      i2o_block_end_request - Post-processing of completed commands
446  *      @req: request which should be completed
447  *      @uptodate: 1 for success, 0 for I/O error, < 0 for specific error
448  *      @nr_bytes: number of bytes to complete
449  *
450  *      Mark the request as complete. The lock must not be held when entering.
451  *
452  */
453 static void i2o_block_end_request(struct request *req, int uptodate,
454                                   int nr_bytes)
455 {
456         struct i2o_block_request *ireq = req->special;
457         struct i2o_block_device *dev = ireq->i2o_blk_dev;
458         request_queue_t *q = req->q;
459         unsigned long flags;
460
461         if (end_that_request_chunk(req, uptodate, nr_bytes)) {
462                 int leftover = (req->hard_nr_sectors << KERNEL_SECTOR_SHIFT);
463
464                 if (blk_pc_request(req))
465                         leftover = req->data_len;
466
467                 if (end_io_error(uptodate))
468                         end_that_request_chunk(req, 0, leftover);
469         }
470
471         add_disk_randomness(req->rq_disk);
472
473         spin_lock_irqsave(q->queue_lock, flags);
474
475         end_that_request_last(req, uptodate);
476
477         if (likely(dev)) {
478                 dev->open_queue_depth--;
479                 list_del(&ireq->queue);
480         }
481
482         blk_start_queue(q);
483
484         spin_unlock_irqrestore(q->queue_lock, flags);
485
486         i2o_block_sglist_free(ireq);
487         i2o_block_request_free(ireq);
488 };
489
490 /**
491  *      i2o_block_reply - Block OSM reply handler.
492  *      @c: I2O controller from which the message arrives
493  *      @m: message id of reply
494  *      @msg: the actual I2O message reply
495  *
496  *      This function gets all the message replies.
497  *
498  */
499 static int i2o_block_reply(struct i2o_controller *c, u32 m,
500                            struct i2o_message *msg)
501 {
502         struct request *req;
503         int uptodate = 1;
504
505         req = i2o_cntxt_list_get(c, le32_to_cpu(msg->u.s.tcntxt));
506         if (unlikely(!req)) {
507                 osm_err("NULL reply received!\n");
508                 return -1;
509         }
510
511         /*
512          *      Lets see what is cooking. We stuffed the
513          *      request in the context.
514          */
515
516         if ((le32_to_cpu(msg->body[0]) >> 24) != 0) {
517                 u32 status = le32_to_cpu(msg->body[0]);
518                 /*
519                  *      Device not ready means two things. One is that the
520                  *      the thing went offline (but not a removal media)
521                  *
522                  *      The second is that you have a SuperTrak 100 and the
523                  *      firmware got constipated. Unlike standard i2o card
524                  *      setups the supertrak returns an error rather than
525                  *      blocking for the timeout in these cases.
526                  *
527                  *      Don't stick a supertrak100 into cache aggressive modes
528                  */
529
530                 osm_err("TID %03x error status: 0x%02x, detailed status: "
531                         "0x%04x\n", (le32_to_cpu(msg->u.head[1]) >> 12 & 0xfff),
532                         status >> 24, status & 0xffff);
533
534                 req->errors++;
535
536                 uptodate = 0;
537         }
538
539         i2o_block_end_request(req, uptodate, le32_to_cpu(msg->body[1]));
540
541         return 1;
542 };
543
544 static void i2o_block_event(struct work_struct *work)
545 {
546         struct i2o_event *evt = container_of(work, struct i2o_event, work);
547         osm_debug("event received\n");
548         kfree(evt);
549 };
550
551 /*
552  *      SCSI-CAM for ioctl geometry mapping
553  *      Duplicated with SCSI - this should be moved into somewhere common
554  *      perhaps genhd ?
555  *
556  * LBA -> CHS mapping table taken from:
557  *
558  * "Incorporating the I2O Architecture into BIOS for Intel Architecture
559  *  Platforms"
560  *
561  * This is an I2O document that is only available to I2O members,
562  * not developers.
563  *
564  * From my understanding, this is how all the I2O cards do this
565  *
566  * Disk Size      | Sectors | Heads | Cylinders
567  * ---------------+---------+-------+-------------------
568  * 1 < X <= 528M  | 63      | 16    | X/(63 * 16 * 512)
569  * 528M < X <= 1G | 63      | 32    | X/(63 * 32 * 512)
570  * 1 < X <528M    | 63      | 16    | X/(63 * 16 * 512)
571  * 1 < X <528M    | 63      | 16    | X/(63 * 16 * 512)
572  *
573  */
574 #define BLOCK_SIZE_528M         1081344
575 #define BLOCK_SIZE_1G           2097152
576 #define BLOCK_SIZE_21G          4403200
577 #define BLOCK_SIZE_42G          8806400
578 #define BLOCK_SIZE_84G          17612800
579
580 static void i2o_block_biosparam(unsigned long capacity, unsigned short *cyls,
581                                 unsigned char *hds, unsigned char *secs)
582 {
583         unsigned long heads, sectors, cylinders;
584
585         sectors = 63L;          /* Maximize sectors per track */
586         if (capacity <= BLOCK_SIZE_528M)
587                 heads = 16;
588         else if (capacity <= BLOCK_SIZE_1G)
589                 heads = 32;
590         else if (capacity <= BLOCK_SIZE_21G)
591                 heads = 64;
592         else if (capacity <= BLOCK_SIZE_42G)
593                 heads = 128;
594         else
595                 heads = 255;
596
597         cylinders = (unsigned long)capacity / (heads * sectors);
598
599         *cyls = (unsigned short)cylinders;      /* Stuff return values */
600         *secs = (unsigned char)sectors;
601         *hds = (unsigned char)heads;
602 }
603
604 /**
605  *      i2o_block_open - Open the block device
606  *      @inode: inode for block device being opened
607  *      @file: file to open
608  *
609  *      Power up the device, mount and lock the media. This function is called,
610  *      if the block device is opened for access.
611  *
612  *      Returns 0 on success or negative error code on failure.
613  */
614 static int i2o_block_open(struct inode *inode, struct file *file)
615 {
616         struct i2o_block_device *dev = inode->i_bdev->bd_disk->private_data;
617
618         if (!dev->i2o_dev)
619                 return -ENODEV;
620
621         if (dev->power > 0x1f)
622                 i2o_block_device_power(dev, 0x02);
623
624         i2o_block_device_mount(dev->i2o_dev, -1);
625
626         i2o_block_device_lock(dev->i2o_dev, -1);
627
628         osm_debug("Ready.\n");
629
630         return 0;
631 };
632
633 /**
634  *      i2o_block_release - Release the I2O block device
635  *      @inode: inode for block device being released
636  *      @file: file to close
637  *
638  *      Unlock and unmount the media, and power down the device. Gets called if
639  *      the block device is closed.
640  *
641  *      Returns 0 on success or negative error code on failure.
642  */
643 static int i2o_block_release(struct inode *inode, struct file *file)
644 {
645         struct gendisk *disk = inode->i_bdev->bd_disk;
646         struct i2o_block_device *dev = disk->private_data;
647         u8 operation;
648
649         /*
650          * This is to deail with the case of an application
651          * opening a device and then the device dissapears while
652          * it's in use, and then the application tries to release
653          * it.  ex: Unmounting a deleted RAID volume at reboot.
654          * If we send messages, it will just cause FAILs since
655          * the TID no longer exists.
656          */
657         if (!dev->i2o_dev)
658                 return 0;
659
660         i2o_block_device_flush(dev->i2o_dev);
661
662         i2o_block_device_unlock(dev->i2o_dev, -1);
663
664         if (dev->flags & (1 << 3 | 1 << 4))     /* Removable */
665                 operation = 0x21;
666         else
667                 operation = 0x24;
668
669         i2o_block_device_power(dev, operation);
670
671         return 0;
672 }
673
674 static int i2o_block_getgeo(struct block_device *bdev, struct hd_geometry *geo)
675 {
676         i2o_block_biosparam(get_capacity(bdev->bd_disk),
677                             &geo->cylinders, &geo->heads, &geo->sectors);
678         return 0;
679 }
680
681 /**
682  *      i2o_block_ioctl - Issue device specific ioctl calls.
683  *      @inode: inode for block device ioctl
684  *      @file: file for ioctl
685  *      @cmd: ioctl command
686  *      @arg: arg
687  *
688  *      Handles ioctl request for the block device.
689  *
690  *      Return 0 on success or negative error on failure.
691  */
692 static int i2o_block_ioctl(struct inode *inode, struct file *file,
693                            unsigned int cmd, unsigned long arg)
694 {
695         struct gendisk *disk = inode->i_bdev->bd_disk;
696         struct i2o_block_device *dev = disk->private_data;
697
698         /* Anyone capable of this syscall can do *real bad* things */
699
700         if (!capable(CAP_SYS_ADMIN))
701                 return -EPERM;
702
703         switch (cmd) {
704         case BLKI2OGRSTRAT:
705                 return put_user(dev->rcache, (int __user *)arg);
706         case BLKI2OGWSTRAT:
707                 return put_user(dev->wcache, (int __user *)arg);
708         case BLKI2OSRSTRAT:
709                 if (arg < 0 || arg > CACHE_SMARTFETCH)
710                         return -EINVAL;
711                 dev->rcache = arg;
712                 break;
713         case BLKI2OSWSTRAT:
714                 if (arg != 0
715                     && (arg < CACHE_WRITETHROUGH || arg > CACHE_SMARTBACK))
716                         return -EINVAL;
717                 dev->wcache = arg;
718                 break;
719         }
720         return -ENOTTY;
721 };
722
723 /**
724  *      i2o_block_media_changed - Have we seen a media change?
725  *      @disk: gendisk which should be verified
726  *
727  *      Verifies if the media has changed.
728  *
729  *      Returns 1 if the media was changed or 0 otherwise.
730  */
731 static int i2o_block_media_changed(struct gendisk *disk)
732 {
733         struct i2o_block_device *p = disk->private_data;
734
735         if (p->media_change_flag) {
736                 p->media_change_flag = 0;
737                 return 1;
738         }
739         return 0;
740 }
741
742 /**
743  *      i2o_block_transfer - Transfer a request to/from the I2O controller
744  *      @req: the request which should be transfered
745  *
746  *      This function converts the request into a I2O message. The necessary
747  *      DMA buffers are allocated and after everything is setup post the message
748  *      to the I2O controller. No cleanup is done by this function. It is done
749  *      on the interrupt side when the reply arrives.
750  *
751  *      Return 0 on success or negative error code on failure.
752  */
753 static int i2o_block_transfer(struct request *req)
754 {
755         struct i2o_block_device *dev = req->rq_disk->private_data;
756         struct i2o_controller *c;
757         int tid = dev->i2o_dev->lct_data.tid;
758         struct i2o_message *msg;
759         u32 *mptr;
760         struct i2o_block_request *ireq = req->special;
761         u32 tcntxt;
762         u32 sgl_offset = SGL_OFFSET_8;
763         u32 ctl_flags = 0x00000000;
764         int rc;
765         u32 cmd;
766
767         if (unlikely(!dev->i2o_dev)) {
768                 osm_err("transfer to removed drive\n");
769                 rc = -ENODEV;
770                 goto exit;
771         }
772
773         c = dev->i2o_dev->iop;
774
775         msg = i2o_msg_get(c);
776         if (IS_ERR(msg)) {
777                 rc = PTR_ERR(msg);
778                 goto exit;
779         }
780
781         tcntxt = i2o_cntxt_list_add(c, req);
782         if (!tcntxt) {
783                 rc = -ENOMEM;
784                 goto nop_msg;
785         }
786
787         msg->u.s.icntxt = cpu_to_le32(i2o_block_driver.context);
788         msg->u.s.tcntxt = cpu_to_le32(tcntxt);
789
790         mptr = &msg->body[0];
791
792         if (rq_data_dir(req) == READ) {
793                 cmd = I2O_CMD_BLOCK_READ << 24;
794
795                 switch (dev->rcache) {
796                 case CACHE_PREFETCH:
797                         ctl_flags = 0x201F0008;
798                         break;
799
800                 case CACHE_SMARTFETCH:
801                         if (req->nr_sectors > 16)
802                                 ctl_flags = 0x201F0008;
803                         else
804                                 ctl_flags = 0x001F0000;
805                         break;
806
807                 default:
808                         break;
809                 }
810         } else {
811                 cmd = I2O_CMD_BLOCK_WRITE << 24;
812
813                 switch (dev->wcache) {
814                 case CACHE_WRITETHROUGH:
815                         ctl_flags = 0x001F0008;
816                         break;
817                 case CACHE_WRITEBACK:
818                         ctl_flags = 0x001F0010;
819                         break;
820                 case CACHE_SMARTBACK:
821                         if (req->nr_sectors > 16)
822                                 ctl_flags = 0x001F0004;
823                         else
824                                 ctl_flags = 0x001F0010;
825                         break;
826                 case CACHE_SMARTTHROUGH:
827                         if (req->nr_sectors > 16)
828                                 ctl_flags = 0x001F0004;
829                         else
830                                 ctl_flags = 0x001F0010;
831                 default:
832                         break;
833                 }
834         }
835
836 #ifdef CONFIG_I2O_EXT_ADAPTEC
837         if (c->adaptec) {
838                 u8 cmd[10];
839                 u32 scsi_flags;
840                 u16 hwsec = queue_hardsect_size(req->q) >> KERNEL_SECTOR_SHIFT;
841
842                 memset(cmd, 0, 10);
843
844                 sgl_offset = SGL_OFFSET_12;
845
846                 msg->u.head[1] =
847                     cpu_to_le32(I2O_CMD_PRIVATE << 24 | HOST_TID << 12 | tid);
848
849                 *mptr++ = cpu_to_le32(I2O_VENDOR_DPT << 16 | I2O_CMD_SCSI_EXEC);
850                 *mptr++ = cpu_to_le32(tid);
851
852                 /*
853                  * ENABLE_DISCONNECT
854                  * SIMPLE_TAG
855                  * RETURN_SENSE_DATA_IN_REPLY_MESSAGE_FRAME
856                  */
857                 if (rq_data_dir(req) == READ) {
858                         cmd[0] = READ_10;
859                         scsi_flags = 0x60a0000a;
860                 } else {
861                         cmd[0] = WRITE_10;
862                         scsi_flags = 0xa0a0000a;
863                 }
864
865                 *mptr++ = cpu_to_le32(scsi_flags);
866
867                 *((u32 *) & cmd[2]) = cpu_to_be32(req->sector * hwsec);
868                 *((u16 *) & cmd[7]) = cpu_to_be16(req->nr_sectors * hwsec);
869
870                 memcpy(mptr, cmd, 10);
871                 mptr += 4;
872                 *mptr++ = cpu_to_le32(req->nr_sectors << KERNEL_SECTOR_SHIFT);
873         } else
874 #endif
875         {
876                 msg->u.head[1] = cpu_to_le32(cmd | HOST_TID << 12 | tid);
877                 *mptr++ = cpu_to_le32(ctl_flags);
878                 *mptr++ = cpu_to_le32(req->nr_sectors << KERNEL_SECTOR_SHIFT);
879                 *mptr++ =
880                     cpu_to_le32((u32) (req->sector << KERNEL_SECTOR_SHIFT));
881                 *mptr++ =
882                     cpu_to_le32(req->sector >> (32 - KERNEL_SECTOR_SHIFT));
883         }
884
885         if (!i2o_block_sglist_alloc(c, ireq, &mptr)) {
886                 rc = -ENOMEM;
887                 goto context_remove;
888         }
889
890         msg->u.head[0] =
891             cpu_to_le32(I2O_MESSAGE_SIZE(mptr - &msg->u.head[0]) | sgl_offset);
892
893         list_add_tail(&ireq->queue, &dev->open_queue);
894         dev->open_queue_depth++;
895
896         i2o_msg_post(c, msg);
897
898         return 0;
899
900       context_remove:
901         i2o_cntxt_list_remove(c, req);
902
903       nop_msg:
904         i2o_msg_nop(c, msg);
905
906       exit:
907         return rc;
908 };
909
910 /**
911  *      i2o_block_request_fn - request queue handling function
912  *      @q: request queue from which the request could be fetched
913  *
914  *      Takes the next request from the queue, transfers it and if no error
915  *      occurs dequeue it from the queue. On arrival of the reply the message
916  *      will be processed further. If an error occurs requeue the request.
917  */
918 static void i2o_block_request_fn(struct request_queue *q)
919 {
920         struct request *req;
921
922         while (!blk_queue_plugged(q)) {
923                 req = elv_next_request(q);
924                 if (!req)
925                         break;
926
927                 if (blk_fs_request(req)) {
928                         struct i2o_block_delayed_request *dreq;
929                         struct i2o_block_request *ireq = req->special;
930                         unsigned int queue_depth;
931
932                         queue_depth = ireq->i2o_blk_dev->open_queue_depth;
933
934                         if (queue_depth < I2O_BLOCK_MAX_OPEN_REQUESTS) {
935                                 if (!i2o_block_transfer(req)) {
936                                         blkdev_dequeue_request(req);
937                                         continue;
938                                 } else
939                                         osm_info("transfer error\n");
940                         }
941
942                         if (queue_depth)
943                                 break;
944
945                         /* stop the queue and retry later */
946                         dreq = kmalloc(sizeof(*dreq), GFP_ATOMIC);
947                         if (!dreq)
948                                 continue;
949
950                         dreq->queue = q;
951                         INIT_DELAYED_WORK(&dreq->work,
952                                           i2o_block_delayed_request_fn);
953
954                         if (!queue_delayed_work(i2o_block_driver.event_queue,
955                                                 &dreq->work,
956                                                 I2O_BLOCK_RETRY_TIME))
957                                 kfree(dreq);
958                         else {
959                                 blk_stop_queue(q);
960                                 break;
961                         }
962                 } else
963                         end_request(req, 0);
964         }
965 };
966
967 /* I2O Block device operations definition */
968 static struct block_device_operations i2o_block_fops = {
969         .owner = THIS_MODULE,
970         .open = i2o_block_open,
971         .release = i2o_block_release,
972         .ioctl = i2o_block_ioctl,
973         .getgeo = i2o_block_getgeo,
974         .media_changed = i2o_block_media_changed
975 };
976
977 /**
978  *      i2o_block_device_alloc - Allocate memory for a I2O Block device
979  *
980  *      Allocate memory for the i2o_block_device struct, gendisk and request
981  *      queue and initialize them as far as no additional information is needed.
982  *
983  *      Returns a pointer to the allocated I2O Block device on succes or a
984  *      negative error code on failure.
985  */
986 static struct i2o_block_device *i2o_block_device_alloc(void)
987 {
988         struct i2o_block_device *dev;
989         struct gendisk *gd;
990         struct request_queue *queue;
991         int rc;
992
993         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
994         if (!dev) {
995                 osm_err("Insufficient memory to allocate I2O Block disk.\n");
996                 rc = -ENOMEM;
997                 goto exit;
998         }
999
1000         INIT_LIST_HEAD(&dev->open_queue);
1001         spin_lock_init(&dev->lock);
1002         dev->rcache = CACHE_PREFETCH;
1003         dev->wcache = CACHE_WRITEBACK;
1004
1005         /* allocate a gendisk with 16 partitions */
1006         gd = alloc_disk(16);
1007         if (!gd) {
1008                 osm_err("Insufficient memory to allocate gendisk.\n");
1009                 rc = -ENOMEM;
1010                 goto cleanup_dev;
1011         }
1012
1013         /* initialize the request queue */
1014         queue = blk_init_queue(i2o_block_request_fn, &dev->lock);
1015         if (!queue) {
1016                 osm_err("Insufficient memory to allocate request queue.\n");
1017                 rc = -ENOMEM;
1018                 goto cleanup_queue;
1019         }
1020
1021         blk_queue_prep_rq(queue, i2o_block_prep_req_fn);
1022         blk_queue_issue_flush_fn(queue, i2o_block_issue_flush);
1023
1024         gd->major = I2O_MAJOR;
1025         gd->queue = queue;
1026         gd->fops = &i2o_block_fops;
1027         gd->private_data = dev;
1028
1029         dev->gd = gd;
1030
1031         return dev;
1032
1033       cleanup_queue:
1034         put_disk(gd);
1035
1036       cleanup_dev:
1037         kfree(dev);
1038
1039       exit:
1040         return ERR_PTR(rc);
1041 };
1042
1043 /**
1044  *      i2o_block_probe - verify if dev is a I2O Block device and install it
1045  *      @dev: device to verify if it is a I2O Block device
1046  *
1047  *      We only verify if the user_tid of the device is 0xfff and then install
1048  *      the device. Otherwise it is used by some other device (e. g. RAID).
1049  *
1050  *      Returns 0 on success or negative error code on failure.
1051  */
1052 static int i2o_block_probe(struct device *dev)
1053 {
1054         struct i2o_device *i2o_dev = to_i2o_device(dev);
1055         struct i2o_controller *c = i2o_dev->iop;
1056         struct i2o_block_device *i2o_blk_dev;
1057         struct gendisk *gd;
1058         struct request_queue *queue;
1059         static int unit = 0;
1060         int rc;
1061         u64 size;
1062         u32 blocksize;
1063         u16 body_size = 4;
1064         u16 power;
1065         unsigned short max_sectors;
1066
1067 #ifdef CONFIG_I2O_EXT_ADAPTEC
1068         if (c->adaptec)
1069                 body_size = 8;
1070 #endif
1071
1072         if (c->limit_sectors)
1073                 max_sectors = I2O_MAX_SECTORS_LIMITED;
1074         else
1075                 max_sectors = I2O_MAX_SECTORS;
1076
1077         /* skip devices which are used by IOP */
1078         if (i2o_dev->lct_data.user_tid != 0xfff) {
1079                 osm_debug("skipping used device %03x\n", i2o_dev->lct_data.tid);
1080                 return -ENODEV;
1081         }
1082
1083         if (i2o_device_claim(i2o_dev)) {
1084                 osm_warn("Unable to claim device. Installation aborted\n");
1085                 rc = -EFAULT;
1086                 goto exit;
1087         }
1088
1089         i2o_blk_dev = i2o_block_device_alloc();
1090         if (IS_ERR(i2o_blk_dev)) {
1091                 osm_err("could not alloc a new I2O block device");
1092                 rc = PTR_ERR(i2o_blk_dev);
1093                 goto claim_release;
1094         }
1095
1096         i2o_blk_dev->i2o_dev = i2o_dev;
1097         dev_set_drvdata(dev, i2o_blk_dev);
1098
1099         /* setup gendisk */
1100         gd = i2o_blk_dev->gd;
1101         gd->first_minor = unit << 4;
1102         sprintf(gd->disk_name, "i2o/hd%c", 'a' + unit);
1103         gd->driverfs_dev = &i2o_dev->device;
1104
1105         /* setup request queue */
1106         queue = gd->queue;
1107         queue->queuedata = i2o_blk_dev;
1108
1109         blk_queue_max_phys_segments(queue, I2O_MAX_PHYS_SEGMENTS);
1110         blk_queue_max_sectors(queue, max_sectors);
1111         blk_queue_max_hw_segments(queue, i2o_sg_tablesize(c, body_size));
1112
1113         osm_debug("max sectors = %d\n", queue->max_phys_segments);
1114         osm_debug("phys segments = %d\n", queue->max_sectors);
1115         osm_debug("max hw segments = %d\n", queue->max_hw_segments);
1116
1117         /*
1118          *      Ask for the current media data. If that isn't supported
1119          *      then we ask for the device capacity data
1120          */
1121         if (!i2o_parm_field_get(i2o_dev, 0x0004, 1, &blocksize, 4) ||
1122             !i2o_parm_field_get(i2o_dev, 0x0000, 3, &blocksize, 4)) {
1123                 blk_queue_hardsect_size(queue, le32_to_cpu(blocksize));
1124         } else
1125                 osm_warn("unable to get blocksize of %s\n", gd->disk_name);
1126
1127         if (!i2o_parm_field_get(i2o_dev, 0x0004, 0, &size, 8) ||
1128             !i2o_parm_field_get(i2o_dev, 0x0000, 4, &size, 8)) {
1129                 set_capacity(gd, le64_to_cpu(size) >> KERNEL_SECTOR_SHIFT);
1130         } else
1131                 osm_warn("could not get size of %s\n", gd->disk_name);
1132
1133         if (!i2o_parm_field_get(i2o_dev, 0x0000, 2, &power, 2))
1134                 i2o_blk_dev->power = power;
1135
1136         i2o_event_register(i2o_dev, &i2o_block_driver, 0, 0xffffffff);
1137
1138         add_disk(gd);
1139
1140         unit++;
1141
1142         osm_info("device added (TID: %03x): %s\n", i2o_dev->lct_data.tid,
1143                  i2o_blk_dev->gd->disk_name);
1144
1145         return 0;
1146
1147       claim_release:
1148         i2o_device_claim_release(i2o_dev);
1149
1150       exit:
1151         return rc;
1152 };
1153
1154 /* Block OSM driver struct */
1155 static struct i2o_driver i2o_block_driver = {
1156         .name = OSM_NAME,
1157         .event = i2o_block_event,
1158         .reply = i2o_block_reply,
1159         .classes = i2o_block_class_id,
1160         .driver = {
1161                    .probe = i2o_block_probe,
1162                    .remove = i2o_block_remove,
1163                    },
1164 };
1165
1166 /**
1167  *      i2o_block_init - Block OSM initialization function
1168  *
1169  *      Allocate the slab and mempool for request structs, registers i2o_block
1170  *      block device and finally register the Block OSM in the I2O core.
1171  *
1172  *      Returns 0 on success or negative error code on failure.
1173  */
1174 static int __init i2o_block_init(void)
1175 {
1176         int rc;
1177         int size;
1178
1179         printk(KERN_INFO OSM_DESCRIPTION " v" OSM_VERSION "\n");
1180
1181         /* Allocate request mempool and slab */
1182         size = sizeof(struct i2o_block_request);
1183         i2o_blk_req_pool.slab = kmem_cache_create("i2o_block_req", size, 0,
1184                                                   SLAB_HWCACHE_ALIGN, NULL,
1185                                                   NULL);
1186         if (!i2o_blk_req_pool.slab) {
1187                 osm_err("can't init request slab\n");
1188                 rc = -ENOMEM;
1189                 goto exit;
1190         }
1191
1192         i2o_blk_req_pool.pool =
1193                 mempool_create_slab_pool(I2O_BLOCK_REQ_MEMPOOL_SIZE,
1194                                          i2o_blk_req_pool.slab);
1195         if (!i2o_blk_req_pool.pool) {
1196                 osm_err("can't init request mempool\n");
1197                 rc = -ENOMEM;
1198                 goto free_slab;
1199         }
1200
1201         /* Register the block device interfaces */
1202         rc = register_blkdev(I2O_MAJOR, "i2o_block");
1203         if (rc) {
1204                 osm_err("unable to register block device\n");
1205                 goto free_mempool;
1206         }
1207 #ifdef MODULE
1208         osm_info("registered device at major %d\n", I2O_MAJOR);
1209 #endif
1210
1211         /* Register Block OSM into I2O core */
1212         rc = i2o_driver_register(&i2o_block_driver);
1213         if (rc) {
1214                 osm_err("Could not register Block driver\n");
1215                 goto unregister_blkdev;
1216         }
1217
1218         return 0;
1219
1220       unregister_blkdev:
1221         unregister_blkdev(I2O_MAJOR, "i2o_block");
1222
1223       free_mempool:
1224         mempool_destroy(i2o_blk_req_pool.pool);
1225
1226       free_slab:
1227         kmem_cache_destroy(i2o_blk_req_pool.slab);
1228
1229       exit:
1230         return rc;
1231 };
1232
1233 /**
1234  *      i2o_block_exit - Block OSM exit function
1235  *
1236  *      Unregisters Block OSM from I2O core, unregisters i2o_block block device
1237  *      and frees the mempool and slab.
1238  */
1239 static void __exit i2o_block_exit(void)
1240 {
1241         /* Unregister I2O Block OSM from I2O core */
1242         i2o_driver_unregister(&i2o_block_driver);
1243
1244         /* Unregister block device */
1245         unregister_blkdev(I2O_MAJOR, "i2o_block");
1246
1247         /* Free request mempool and slab */
1248         mempool_destroy(i2o_blk_req_pool.pool);
1249         kmem_cache_destroy(i2o_blk_req_pool.slab);
1250 };
1251
1252 MODULE_AUTHOR("Red Hat");
1253 MODULE_LICENSE("GPL");
1254 MODULE_DESCRIPTION(OSM_DESCRIPTION);
1255 MODULE_VERSION(OSM_VERSION);
1256
1257 module_init(i2o_block_init);
1258 module_exit(i2o_block_exit);