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