]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - drivers/message/i2o/i2o_block.c
[PATCH] beginning of methods conversion
[mirror_ubuntu-zesty-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_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 loose 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 = (req->hard_nr_sectors << 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 * @inode: inode for block device being opened
571 * @file: file to open
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 inode *inode, struct file *file)
579 {
580 struct i2o_block_device *dev = inode->i_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 * @inode: inode for block device being released
600 * @file: file to close
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 inode *inode, struct file *file)
608 {
609 struct gendisk *disk = inode->i_bdev->bd_disk;
610 struct i2o_block_device *dev = disk->private_data;
611 u8 operation;
612
613 /*
614 * This is to deail with the case of an application
615 * opening a device and then the device dissapears while
616 * it's in use, and then the application tries to release
617 * it. ex: Unmounting a deleted RAID volume at reboot.
618 * If we send messages, it will just cause FAILs since
619 * the TID no longer exists.
620 */
621 if (!dev->i2o_dev)
622 return 0;
623
624 i2o_block_device_flush(dev->i2o_dev);
625
626 i2o_block_device_unlock(dev->i2o_dev, -1);
627
628 if (dev->flags & (1 << 3 | 1 << 4)) /* Removable */
629 operation = 0x21;
630 else
631 operation = 0x24;
632
633 i2o_block_device_power(dev, operation);
634
635 return 0;
636 }
637
638 static int i2o_block_getgeo(struct block_device *bdev, struct hd_geometry *geo)
639 {
640 i2o_block_biosparam(get_capacity(bdev->bd_disk),
641 &geo->cylinders, &geo->heads, &geo->sectors);
642 return 0;
643 }
644
645 /**
646 * i2o_block_ioctl - Issue device specific ioctl calls.
647 * @inode: inode for block device ioctl
648 * @file: file for ioctl
649 * @cmd: ioctl command
650 * @arg: arg
651 *
652 * Handles ioctl request for the block device.
653 *
654 * Return 0 on success or negative error on failure.
655 */
656 static int i2o_block_ioctl(struct inode *inode, struct file *file,
657 unsigned int cmd, unsigned long arg)
658 {
659 struct gendisk *disk = inode->i_bdev->bd_disk;
660 struct i2o_block_device *dev = disk->private_data;
661
662 /* Anyone capable of this syscall can do *real bad* things */
663
664 if (!capable(CAP_SYS_ADMIN))
665 return -EPERM;
666
667 switch (cmd) {
668 case BLKI2OGRSTRAT:
669 return put_user(dev->rcache, (int __user *)arg);
670 case BLKI2OGWSTRAT:
671 return put_user(dev->wcache, (int __user *)arg);
672 case BLKI2OSRSTRAT:
673 if (arg < 0 || arg > CACHE_SMARTFETCH)
674 return -EINVAL;
675 dev->rcache = arg;
676 break;
677 case BLKI2OSWSTRAT:
678 if (arg != 0
679 && (arg < CACHE_WRITETHROUGH || arg > CACHE_SMARTBACK))
680 return -EINVAL;
681 dev->wcache = arg;
682 break;
683 }
684 return -ENOTTY;
685 };
686
687 /**
688 * i2o_block_media_changed - Have we seen a media change?
689 * @disk: gendisk which should be verified
690 *
691 * Verifies if the media has changed.
692 *
693 * Returns 1 if the media was changed or 0 otherwise.
694 */
695 static int i2o_block_media_changed(struct gendisk *disk)
696 {
697 struct i2o_block_device *p = disk->private_data;
698
699 if (p->media_change_flag) {
700 p->media_change_flag = 0;
701 return 1;
702 }
703 return 0;
704 }
705
706 /**
707 * i2o_block_transfer - Transfer a request to/from the I2O controller
708 * @req: the request which should be transfered
709 *
710 * This function converts the request into a I2O message. The necessary
711 * DMA buffers are allocated and after everything is setup post the message
712 * to the I2O controller. No cleanup is done by this function. It is done
713 * on the interrupt side when the reply arrives.
714 *
715 * Return 0 on success or negative error code on failure.
716 */
717 static int i2o_block_transfer(struct request *req)
718 {
719 struct i2o_block_device *dev = req->rq_disk->private_data;
720 struct i2o_controller *c;
721 u32 tid = dev->i2o_dev->lct_data.tid;
722 struct i2o_message *msg;
723 u32 *mptr;
724 struct i2o_block_request *ireq = req->special;
725 u32 tcntxt;
726 u32 sgl_offset = SGL_OFFSET_8;
727 u32 ctl_flags = 0x00000000;
728 int rc;
729 u32 cmd;
730
731 if (unlikely(!dev->i2o_dev)) {
732 osm_err("transfer to removed drive\n");
733 rc = -ENODEV;
734 goto exit;
735 }
736
737 c = dev->i2o_dev->iop;
738
739 msg = i2o_msg_get(c);
740 if (IS_ERR(msg)) {
741 rc = PTR_ERR(msg);
742 goto exit;
743 }
744
745 tcntxt = i2o_cntxt_list_add(c, req);
746 if (!tcntxt) {
747 rc = -ENOMEM;
748 goto nop_msg;
749 }
750
751 msg->u.s.icntxt = cpu_to_le32(i2o_block_driver.context);
752 msg->u.s.tcntxt = cpu_to_le32(tcntxt);
753
754 mptr = &msg->body[0];
755
756 if (rq_data_dir(req) == READ) {
757 cmd = I2O_CMD_BLOCK_READ << 24;
758
759 switch (dev->rcache) {
760 case CACHE_PREFETCH:
761 ctl_flags = 0x201F0008;
762 break;
763
764 case CACHE_SMARTFETCH:
765 if (req->nr_sectors > 16)
766 ctl_flags = 0x201F0008;
767 else
768 ctl_flags = 0x001F0000;
769 break;
770
771 default:
772 break;
773 }
774 } else {
775 cmd = I2O_CMD_BLOCK_WRITE << 24;
776
777 switch (dev->wcache) {
778 case CACHE_WRITETHROUGH:
779 ctl_flags = 0x001F0008;
780 break;
781 case CACHE_WRITEBACK:
782 ctl_flags = 0x001F0010;
783 break;
784 case CACHE_SMARTBACK:
785 if (req->nr_sectors > 16)
786 ctl_flags = 0x001F0004;
787 else
788 ctl_flags = 0x001F0010;
789 break;
790 case CACHE_SMARTTHROUGH:
791 if (req->nr_sectors > 16)
792 ctl_flags = 0x001F0004;
793 else
794 ctl_flags = 0x001F0010;
795 default:
796 break;
797 }
798 }
799
800 #ifdef CONFIG_I2O_EXT_ADAPTEC
801 if (c->adaptec) {
802 u8 cmd[10];
803 u32 scsi_flags;
804 u16 hwsec = queue_hardsect_size(req->q) >> KERNEL_SECTOR_SHIFT;
805
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(req->sector * hwsec);
832 *((u16 *) & cmd[7]) = cpu_to_be16(req->nr_sectors * hwsec);
833
834 memcpy(mptr, cmd, 10);
835 mptr += 4;
836 *mptr++ = cpu_to_le32(req->nr_sectors << KERNEL_SECTOR_SHIFT);
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(req->nr_sectors << KERNEL_SECTOR_SHIFT);
843 *mptr++ =
844 cpu_to_le32((u32) (req->sector << KERNEL_SECTOR_SHIFT));
845 *mptr++ =
846 cpu_to_le32(req->sector >> (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 = elv_next_request(q);
888 if (!req)
889 break;
890
891 if (blk_fs_request(req)) {
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 blkdev_dequeue_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 end_request(req, 0);
928 }
929 };
930
931 /* I2O Block device operations definition */
932 static struct block_device_operations i2o_block_fops = {
933 .owner = THIS_MODULE,
934 .__open = i2o_block_open,
935 .__release = i2o_block_release,
936 .__ioctl = i2o_block_ioctl,
937 .getgeo = i2o_block_getgeo,
938 .media_changed = i2o_block_media_changed
939 };
940
941 /**
942 * i2o_block_device_alloc - Allocate memory for a I2O Block device
943 *
944 * Allocate memory for the i2o_block_device struct, gendisk and request
945 * queue and initialize them as far as no additional information is needed.
946 *
947 * Returns a pointer to the allocated I2O Block device on succes or a
948 * negative error code on failure.
949 */
950 static struct i2o_block_device *i2o_block_device_alloc(void)
951 {
952 struct i2o_block_device *dev;
953 struct gendisk *gd;
954 struct request_queue *queue;
955 int rc;
956
957 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
958 if (!dev) {
959 osm_err("Insufficient memory to allocate I2O Block disk.\n");
960 rc = -ENOMEM;
961 goto exit;
962 }
963
964 INIT_LIST_HEAD(&dev->open_queue);
965 spin_lock_init(&dev->lock);
966 dev->rcache = CACHE_PREFETCH;
967 dev->wcache = CACHE_WRITEBACK;
968
969 /* allocate a gendisk with 16 partitions */
970 gd = alloc_disk(16);
971 if (!gd) {
972 osm_err("Insufficient memory to allocate gendisk.\n");
973 rc = -ENOMEM;
974 goto cleanup_dev;
975 }
976
977 /* initialize the request queue */
978 queue = blk_init_queue(i2o_block_request_fn, &dev->lock);
979 if (!queue) {
980 osm_err("Insufficient memory to allocate request queue.\n");
981 rc = -ENOMEM;
982 goto cleanup_queue;
983 }
984
985 blk_queue_prep_rq(queue, i2o_block_prep_req_fn);
986
987 gd->major = I2O_MAJOR;
988 gd->queue = queue;
989 gd->fops = &i2o_block_fops;
990 gd->private_data = dev;
991
992 dev->gd = gd;
993
994 return dev;
995
996 cleanup_queue:
997 put_disk(gd);
998
999 cleanup_dev:
1000 kfree(dev);
1001
1002 exit:
1003 return ERR_PTR(rc);
1004 };
1005
1006 /**
1007 * i2o_block_probe - verify if dev is a I2O Block device and install it
1008 * @dev: device to verify if it is a I2O Block device
1009 *
1010 * We only verify if the user_tid of the device is 0xfff and then install
1011 * the device. Otherwise it is used by some other device (e. g. RAID).
1012 *
1013 * Returns 0 on success or negative error code on failure.
1014 */
1015 static int i2o_block_probe(struct device *dev)
1016 {
1017 struct i2o_device *i2o_dev = to_i2o_device(dev);
1018 struct i2o_controller *c = i2o_dev->iop;
1019 struct i2o_block_device *i2o_blk_dev;
1020 struct gendisk *gd;
1021 struct request_queue *queue;
1022 static int unit = 0;
1023 int rc;
1024 u64 size;
1025 u32 blocksize;
1026 u16 body_size = 4;
1027 u16 power;
1028 unsigned short max_sectors;
1029
1030 #ifdef CONFIG_I2O_EXT_ADAPTEC
1031 if (c->adaptec)
1032 body_size = 8;
1033 #endif
1034
1035 if (c->limit_sectors)
1036 max_sectors = I2O_MAX_SECTORS_LIMITED;
1037 else
1038 max_sectors = I2O_MAX_SECTORS;
1039
1040 /* skip devices which are used by IOP */
1041 if (i2o_dev->lct_data.user_tid != 0xfff) {
1042 osm_debug("skipping used device %03x\n", i2o_dev->lct_data.tid);
1043 return -ENODEV;
1044 }
1045
1046 if (i2o_device_claim(i2o_dev)) {
1047 osm_warn("Unable to claim device. Installation aborted\n");
1048 rc = -EFAULT;
1049 goto exit;
1050 }
1051
1052 i2o_blk_dev = i2o_block_device_alloc();
1053 if (IS_ERR(i2o_blk_dev)) {
1054 osm_err("could not alloc a new I2O block device");
1055 rc = PTR_ERR(i2o_blk_dev);
1056 goto claim_release;
1057 }
1058
1059 i2o_blk_dev->i2o_dev = i2o_dev;
1060 dev_set_drvdata(dev, i2o_blk_dev);
1061
1062 /* setup gendisk */
1063 gd = i2o_blk_dev->gd;
1064 gd->first_minor = unit << 4;
1065 sprintf(gd->disk_name, "i2o/hd%c", 'a' + unit);
1066 gd->driverfs_dev = &i2o_dev->device;
1067
1068 /* setup request queue */
1069 queue = gd->queue;
1070 queue->queuedata = i2o_blk_dev;
1071
1072 blk_queue_max_phys_segments(queue, I2O_MAX_PHYS_SEGMENTS);
1073 blk_queue_max_sectors(queue, max_sectors);
1074 blk_queue_max_hw_segments(queue, i2o_sg_tablesize(c, body_size));
1075
1076 osm_debug("max sectors = %d\n", queue->max_sectors);
1077 osm_debug("phys segments = %d\n", queue->max_phys_segments);
1078 osm_debug("max hw segments = %d\n", queue->max_hw_segments);
1079
1080 /*
1081 * Ask for the current media data. If that isn't supported
1082 * then we ask for the device capacity data
1083 */
1084 if (!i2o_parm_field_get(i2o_dev, 0x0004, 1, &blocksize, 4) ||
1085 !i2o_parm_field_get(i2o_dev, 0x0000, 3, &blocksize, 4)) {
1086 blk_queue_hardsect_size(queue, le32_to_cpu(blocksize));
1087 } else
1088 osm_warn("unable to get blocksize of %s\n", gd->disk_name);
1089
1090 if (!i2o_parm_field_get(i2o_dev, 0x0004, 0, &size, 8) ||
1091 !i2o_parm_field_get(i2o_dev, 0x0000, 4, &size, 8)) {
1092 set_capacity(gd, le64_to_cpu(size) >> KERNEL_SECTOR_SHIFT);
1093 } else
1094 osm_warn("could not get size of %s\n", gd->disk_name);
1095
1096 if (!i2o_parm_field_get(i2o_dev, 0x0000, 2, &power, 2))
1097 i2o_blk_dev->power = power;
1098
1099 i2o_event_register(i2o_dev, &i2o_block_driver, 0, 0xffffffff);
1100
1101 add_disk(gd);
1102
1103 unit++;
1104
1105 osm_info("device added (TID: %03x): %s\n", i2o_dev->lct_data.tid,
1106 i2o_blk_dev->gd->disk_name);
1107
1108 return 0;
1109
1110 claim_release:
1111 i2o_device_claim_release(i2o_dev);
1112
1113 exit:
1114 return rc;
1115 };
1116
1117 /* Block OSM driver struct */
1118 static struct i2o_driver i2o_block_driver = {
1119 .name = OSM_NAME,
1120 .event = i2o_block_event,
1121 .reply = i2o_block_reply,
1122 .classes = i2o_block_class_id,
1123 .driver = {
1124 .probe = i2o_block_probe,
1125 .remove = i2o_block_remove,
1126 },
1127 };
1128
1129 /**
1130 * i2o_block_init - Block OSM initialization function
1131 *
1132 * Allocate the slab and mempool for request structs, registers i2o_block
1133 * block device and finally register the Block OSM in the I2O core.
1134 *
1135 * Returns 0 on success or negative error code on failure.
1136 */
1137 static int __init i2o_block_init(void)
1138 {
1139 int rc;
1140 int size;
1141
1142 printk(KERN_INFO OSM_DESCRIPTION " v" OSM_VERSION "\n");
1143
1144 /* Allocate request mempool and slab */
1145 size = sizeof(struct i2o_block_request);
1146 i2o_blk_req_pool.slab = kmem_cache_create("i2o_block_req", size, 0,
1147 SLAB_HWCACHE_ALIGN, NULL);
1148 if (!i2o_blk_req_pool.slab) {
1149 osm_err("can't init request slab\n");
1150 rc = -ENOMEM;
1151 goto exit;
1152 }
1153
1154 i2o_blk_req_pool.pool =
1155 mempool_create_slab_pool(I2O_BLOCK_REQ_MEMPOOL_SIZE,
1156 i2o_blk_req_pool.slab);
1157 if (!i2o_blk_req_pool.pool) {
1158 osm_err("can't init request mempool\n");
1159 rc = -ENOMEM;
1160 goto free_slab;
1161 }
1162
1163 /* Register the block device interfaces */
1164 rc = register_blkdev(I2O_MAJOR, "i2o_block");
1165 if (rc) {
1166 osm_err("unable to register block device\n");
1167 goto free_mempool;
1168 }
1169 #ifdef MODULE
1170 osm_info("registered device at major %d\n", I2O_MAJOR);
1171 #endif
1172
1173 /* Register Block OSM into I2O core */
1174 rc = i2o_driver_register(&i2o_block_driver);
1175 if (rc) {
1176 osm_err("Could not register Block driver\n");
1177 goto unregister_blkdev;
1178 }
1179
1180 return 0;
1181
1182 unregister_blkdev:
1183 unregister_blkdev(I2O_MAJOR, "i2o_block");
1184
1185 free_mempool:
1186 mempool_destroy(i2o_blk_req_pool.pool);
1187
1188 free_slab:
1189 kmem_cache_destroy(i2o_blk_req_pool.slab);
1190
1191 exit:
1192 return rc;
1193 };
1194
1195 /**
1196 * i2o_block_exit - Block OSM exit function
1197 *
1198 * Unregisters Block OSM from I2O core, unregisters i2o_block block device
1199 * and frees the mempool and slab.
1200 */
1201 static void __exit i2o_block_exit(void)
1202 {
1203 /* Unregister I2O Block OSM from I2O core */
1204 i2o_driver_unregister(&i2o_block_driver);
1205
1206 /* Unregister block device */
1207 unregister_blkdev(I2O_MAJOR, "i2o_block");
1208
1209 /* Free request mempool and slab */
1210 mempool_destroy(i2o_blk_req_pool.pool);
1211 kmem_cache_destroy(i2o_blk_req_pool.slab);
1212 };
1213
1214 MODULE_AUTHOR("Red Hat");
1215 MODULE_LICENSE("GPL");
1216 MODULE_DESCRIPTION(OSM_DESCRIPTION);
1217 MODULE_VERSION(OSM_VERSION);
1218
1219 module_init(i2o_block_init);
1220 module_exit(i2o_block_exit);