2 * This program is free software; you can redistribute it and/or modify it
3 * under the terms of the GNU General Public License as published by the
4 * Free Software Foundation; either version 2, or (at your option) any
7 * This program is distributed in the hope that it will be useful, but
8 * WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * General Public License for more details.
12 * For the avoidance of doubt the "preferred form" of this code is one which
13 * is in an open non patent encumbered format. Where cryptographic key signing
14 * forms part of the process of creating an executable the information
15 * including keys needed to generate an equivalently functional executable
16 * are deemed to be part of the source code.
18 * Complications for I2O scsi
20 * o Each (bus,lun) is a logical device in I2O. We keep a map
21 * table. We spoof failed selection for unmapped units
22 * o Request sense buffers can come back for free.
23 * o Scatter gather is a bit dynamic. We have to investigate at
25 * o Some of our resources are dynamically shared. The i2o core
26 * needs a message reservation protocol to avoid swap v net
27 * deadlocking. We need to back off queue requests.
29 * In general the firmware wants to help. Where its help isn't performance
30 * useful we just ignore the aid. Its not worth the code in truth.
34 * Scatter gather now works
35 * Markus Lidel <Markus.Lidel@shadowconnect.com>:
36 * Minor fixes for 2.6.
40 * Fix the resource management problems.
43 #include <linux/module.h>
44 #include <linux/kernel.h>
45 #include <linux/types.h>
46 #include <linux/string.h>
47 #include <linux/ioport.h>
48 #include <linux/jiffies.h>
49 #include <linux/interrupt.h>
50 #include <linux/timer.h>
51 #include <linux/delay.h>
52 #include <linux/proc_fs.h>
53 #include <linux/prefetch.h>
54 #include <linux/pci.h>
55 #include <linux/blkdev.h>
56 #include <linux/i2o.h>
57 #include <linux/scatterlist.h>
60 #include <asm/system.h>
62 #include <asm/atomic.h>
64 #include <scsi/scsi.h>
65 #include <scsi/scsi_host.h>
66 #include <scsi/scsi_device.h>
67 #include <scsi/scsi_cmnd.h>
70 #define OSM_NAME "scsi-osm"
71 #define OSM_VERSION "1.316"
72 #define OSM_DESCRIPTION "I2O SCSI Peripheral OSM"
74 static struct i2o_driver i2o_scsi_driver;
76 static unsigned int i2o_scsi_max_id = 16;
77 static unsigned int i2o_scsi_max_lun = 255;
79 struct i2o_scsi_host {
80 struct Scsi_Host *scsi_host; /* pointer to the SCSI host */
81 struct i2o_controller *iop; /* pointer to the I2O controller */
82 unsigned int lun; /* lun's used for block devices */
83 struct i2o_device *channel[0]; /* channel->i2o_dev mapping table */
86 static struct scsi_host_template i2o_scsi_host_template;
88 #define I2O_SCSI_CAN_QUEUE 4
90 /* SCSI OSM class handling definition */
91 static struct i2o_class_id i2o_scsi_class_id[] = {
92 {I2O_CLASS_SCSI_PERIPHERAL},
96 static struct i2o_scsi_host *i2o_scsi_host_alloc(struct i2o_controller *c)
98 struct i2o_scsi_host *i2o_shost;
99 struct i2o_device *i2o_dev;
100 struct Scsi_Host *scsi_host;
107 #ifdef CONFIG_I2O_EXT_ADAPTEC
112 list_for_each_entry(i2o_dev, &c->devices, list)
113 if (i2o_dev->lct_data.class_id == I2O_CLASS_BUS_ADAPTER) {
114 if (!i2o_parm_field_get(i2o_dev, 0x0000, 0, &type, 1)
115 && (type == 0x01)) /* SCSI bus */
120 osm_warn("no channels found on %s\n", c->name);
121 return ERR_PTR(-EFAULT);
124 size = max_channel * sizeof(struct i2o_device *)
125 + sizeof(struct i2o_scsi_host);
127 scsi_host = scsi_host_alloc(&i2o_scsi_host_template, size);
129 osm_warn("Could not allocate SCSI host\n");
130 return ERR_PTR(-ENOMEM);
133 scsi_host->max_channel = max_channel - 1;
134 scsi_host->max_id = i2o_scsi_max_id;
135 scsi_host->max_lun = i2o_scsi_max_lun;
136 scsi_host->this_id = c->unit;
137 scsi_host->sg_tablesize = i2o_sg_tablesize(c, body_size);
139 i2o_shost = (struct i2o_scsi_host *)scsi_host->hostdata;
140 i2o_shost->scsi_host = scsi_host;
145 list_for_each_entry(i2o_dev, &c->devices, list)
146 if (i2o_dev->lct_data.class_id == I2O_CLASS_BUS_ADAPTER) {
147 if (!i2o_parm_field_get(i2o_dev, 0x0000, 0, &type, 1)
148 && (type == 0x01)) /* only SCSI bus */
149 i2o_shost->channel[i++] = i2o_dev;
151 if (i >= max_channel)
159 * i2o_scsi_get_host - Get an I2O SCSI host
160 * @c: I2O controller to for which to get the SCSI host
162 * If the I2O controller already exists as SCSI host, the SCSI host
163 * is returned, otherwise the I2O controller is added to the SCSI
166 * Returns pointer to the I2O SCSI host on success or NULL on failure.
168 static struct i2o_scsi_host *i2o_scsi_get_host(struct i2o_controller *c)
170 return c->driver_data[i2o_scsi_driver.context];
174 * i2o_scsi_remove - Remove I2O device from SCSI core
175 * @dev: device which should be removed
177 * Removes the I2O device from the SCSI core again.
179 * Returns 0 on success.
181 static int i2o_scsi_remove(struct device *dev)
183 struct i2o_device *i2o_dev = to_i2o_device(dev);
184 struct i2o_controller *c = i2o_dev->iop;
185 struct i2o_scsi_host *i2o_shost;
186 struct scsi_device *scsi_dev;
188 osm_info("device removed (TID: %03x)\n", i2o_dev->lct_data.tid);
190 i2o_shost = i2o_scsi_get_host(c);
192 shost_for_each_device(scsi_dev, i2o_shost->scsi_host)
193 if (scsi_dev->hostdata == i2o_dev) {
194 sysfs_remove_link(&i2o_dev->device.kobj, "scsi");
195 scsi_remove_device(scsi_dev);
196 scsi_device_put(scsi_dev);
204 * i2o_scsi_probe - verify if dev is a I2O SCSI device and install it
205 * @dev: device to verify if it is a I2O SCSI device
207 * Retrieve channel, id and lun for I2O device. If everthing goes well
208 * register the I2O device as SCSI device on the I2O SCSI controller.
210 * Returns 0 on success or negative error code on failure.
212 static int i2o_scsi_probe(struct device *dev)
214 struct i2o_device *i2o_dev = to_i2o_device(dev);
215 struct i2o_controller *c = i2o_dev->iop;
216 struct i2o_scsi_host *i2o_shost;
217 struct Scsi_Host *scsi_host;
218 struct i2o_device *parent;
219 struct scsi_device *scsi_dev;
225 i2o_shost = i2o_scsi_get_host(c);
229 scsi_host = i2o_shost->scsi_host;
231 switch (i2o_dev->lct_data.class_id) {
232 case I2O_CLASS_RANDOM_BLOCK_STORAGE:
233 case I2O_CLASS_EXECUTIVE:
234 #ifdef CONFIG_I2O_EXT_ADAPTEC
237 struct i2o_device *d = i2o_shost->channel[0];
239 if (!i2o_parm_field_get(d, 0x0000, 0, &type, 1)
240 && (type == 0x01)) /* SCSI bus */
241 if (!i2o_parm_field_get(d, 0x0200, 4, &id, 4)) {
243 if (i2o_dev->lct_data.class_id ==
244 I2O_CLASS_RANDOM_BLOCK_STORAGE)
246 cpu_to_le64(i2o_shost->
255 case I2O_CLASS_SCSI_PERIPHERAL:
256 if (i2o_parm_field_get(i2o_dev, 0x0000, 3, &id, 4))
259 if (i2o_parm_field_get(i2o_dev, 0x0000, 4, &lun, 8))
262 parent = i2o_iop_find_device(c, i2o_dev->lct_data.parent_tid);
264 osm_warn("can not find parent of device %03x\n",
265 i2o_dev->lct_data.tid);
269 for (i = 0; i <= i2o_shost->scsi_host->max_channel; i++)
270 if (i2o_shost->channel[i] == parent)
279 osm_warn("can not find channel of device %03x\n",
280 i2o_dev->lct_data.tid);
284 if (le32_to_cpu(id) >= scsi_host->max_id) {
285 osm_warn("SCSI device id (%d) >= max_id of I2O host (%d)",
286 le32_to_cpu(id), scsi_host->max_id);
290 if (le64_to_cpu(lun) >= scsi_host->max_lun) {
291 osm_warn("SCSI device lun (%lu) >= max_lun of I2O host (%d)",
292 (long unsigned int)le64_to_cpu(lun),
298 __scsi_add_device(i2o_shost->scsi_host, channel, le32_to_cpu(id),
299 le64_to_cpu(lun), i2o_dev);
301 if (IS_ERR(scsi_dev)) {
302 osm_warn("can not add SCSI device %03x\n",
303 i2o_dev->lct_data.tid);
304 return PTR_ERR(scsi_dev);
307 rc = sysfs_create_link(&i2o_dev->device.kobj,
308 &scsi_dev->sdev_gendev.kobj, "scsi");
312 osm_info("device added (TID: %03x) channel: %d, id: %d, lun: %ld\n",
313 i2o_dev->lct_data.tid, channel, le32_to_cpu(id),
314 (long unsigned int)le64_to_cpu(lun));
319 scsi_remove_device(scsi_dev);
323 static const char *i2o_scsi_info(struct Scsi_Host *SChost)
325 struct i2o_scsi_host *hostdata;
326 hostdata = (struct i2o_scsi_host *)SChost->hostdata;
327 return hostdata->iop->name;
331 * i2o_scsi_reply - SCSI OSM message reply handler
332 * @c: controller issuing the reply
333 * @m: message id for flushing
334 * @msg: the message from the controller
336 * Process reply messages (interrupts in normal scsi controller think).
337 * We can get a variety of messages to process. The normal path is
338 * scsi command completions. We must also deal with IOP failures,
339 * the reply to a bus reset and the reply to a LUN query.
341 * Returns 0 on success and if the reply should not be flushed or > 0
342 * on success and if the reply should be flushed. Returns negative error
343 * code on failure and if the reply should be flushed.
345 static int i2o_scsi_reply(struct i2o_controller *c, u32 m,
346 struct i2o_message *msg)
348 struct scsi_cmnd *cmd;
352 cmd = i2o_cntxt_list_get(c, le32_to_cpu(msg->u.s.tcntxt));
353 if (unlikely(!cmd)) {
354 osm_err("NULL reply received!\n");
359 * Low byte is device status, next is adapter status,
360 * (then one byte reserved), then request status.
362 error = le32_to_cpu(msg->body[0]);
364 osm_debug("Completed %ld\n", cmd->serial_number);
366 cmd->result = error & 0xff;
368 * if DeviceStatus is not SCSI_SUCCESS copy over the sense data and let
369 * the SCSI layer handle the error
372 memcpy(cmd->sense_buffer, &msg->body[3],
373 min(sizeof(cmd->sense_buffer), (size_t) 40));
375 /* only output error code if AdapterStatus is not HBA_SUCCESS */
376 if ((error >> 8) & 0xff)
377 osm_err("SCSI error %08x\n", error);
381 dma_unmap_sg(dev, cmd->request_buffer, cmd->use_sg,
382 cmd->sc_data_direction);
383 else if (cmd->SCp.dma_handle)
384 dma_unmap_single(dev, cmd->SCp.dma_handle, cmd->request_bufflen,
385 cmd->sc_data_direction);
393 * i2o_scsi_notify_device_add - Retrieve notifications of added devices
394 * @i2o_dev: the I2O device which was added
396 * If a I2O device is added we catch the notification, because I2O classes
397 * other then SCSI peripheral will not be received through
400 static void i2o_scsi_notify_device_add(struct i2o_device *i2o_dev)
402 switch (i2o_dev->lct_data.class_id) {
403 case I2O_CLASS_EXECUTIVE:
404 case I2O_CLASS_RANDOM_BLOCK_STORAGE:
405 i2o_scsi_probe(&i2o_dev->device);
414 * i2o_scsi_notify_device_remove - Retrieve notifications of removed
416 * @i2o_dev: the I2O device which was removed
418 * If a I2O device is removed, we catch the notification to remove the
419 * corresponding SCSI device.
421 static void i2o_scsi_notify_device_remove(struct i2o_device *i2o_dev)
423 switch (i2o_dev->lct_data.class_id) {
424 case I2O_CLASS_EXECUTIVE:
425 case I2O_CLASS_RANDOM_BLOCK_STORAGE:
426 i2o_scsi_remove(&i2o_dev->device);
435 * i2o_scsi_notify_controller_add - Retrieve notifications of added
437 * @c: the controller which was added
439 * If a I2O controller is added, we catch the notification to add a
440 * corresponding Scsi_Host.
442 static void i2o_scsi_notify_controller_add(struct i2o_controller *c)
444 struct i2o_scsi_host *i2o_shost;
447 i2o_shost = i2o_scsi_host_alloc(c);
448 if (IS_ERR(i2o_shost)) {
449 osm_err("Could not initialize SCSI host\n");
453 rc = scsi_add_host(i2o_shost->scsi_host, &c->device);
455 osm_err("Could not add SCSI host\n");
456 scsi_host_put(i2o_shost->scsi_host);
460 c->driver_data[i2o_scsi_driver.context] = i2o_shost;
462 osm_debug("new I2O SCSI host added\n");
466 * i2o_scsi_notify_controller_remove - Retrieve notifications of removed
468 * @c: the controller which was removed
470 * If a I2O controller is removed, we catch the notification to remove the
471 * corresponding Scsi_Host.
473 static void i2o_scsi_notify_controller_remove(struct i2o_controller *c)
475 struct i2o_scsi_host *i2o_shost;
476 i2o_shost = i2o_scsi_get_host(c);
480 c->driver_data[i2o_scsi_driver.context] = NULL;
482 scsi_remove_host(i2o_shost->scsi_host);
483 scsi_host_put(i2o_shost->scsi_host);
484 osm_debug("I2O SCSI host removed\n");
487 /* SCSI OSM driver struct */
488 static struct i2o_driver i2o_scsi_driver = {
490 .reply = i2o_scsi_reply,
491 .classes = i2o_scsi_class_id,
492 .notify_device_add = i2o_scsi_notify_device_add,
493 .notify_device_remove = i2o_scsi_notify_device_remove,
494 .notify_controller_add = i2o_scsi_notify_controller_add,
495 .notify_controller_remove = i2o_scsi_notify_controller_remove,
497 .probe = i2o_scsi_probe,
498 .remove = i2o_scsi_remove,
503 * i2o_scsi_queuecommand - queue a SCSI command
504 * @SCpnt: scsi command pointer
505 * @done: callback for completion
507 * Issue a scsi command asynchronously. Return 0 on success or 1 if
508 * we hit an error (normally message queue congestion). The only
509 * minor complication here is that I2O deals with the device addressing
510 * so we have to map the bus/dev/lun back to an I2O handle as well
511 * as faking absent devices ourself.
513 * Locks: takes the controller lock on error path only
516 static int i2o_scsi_queuecommand(struct scsi_cmnd *SCpnt,
517 void (*done) (struct scsi_cmnd *))
519 struct i2o_controller *c;
520 struct i2o_device *i2o_dev;
522 struct i2o_message *msg;
526 * RETURN_SENSE_DATA_IN_REPLY_MESSAGE_FRAME
528 u32 scsi_flags = 0x20a00000;
531 u32 cmd = I2O_CMD_SCSI_EXEC << 24;
535 * Do the incoming paperwork
537 i2o_dev = SCpnt->device->hostdata;
540 SCpnt->scsi_done = done;
542 if (unlikely(!i2o_dev)) {
543 osm_warn("no I2O device in request\n");
544 SCpnt->result = DID_NO_CONNECT << 16;
549 tid = i2o_dev->lct_data.tid;
551 osm_debug("qcmd: Tid = %03x\n", tid);
552 osm_debug("Real scsi messages.\n");
555 * Put together a scsi execscb message
557 switch (SCpnt->sc_data_direction) {
560 sgl_offset = SGL_OFFSET_0;
563 case PCI_DMA_TODEVICE:
564 /* DATA OUT (iop-->dev) */
565 scsi_flags |= 0x80000000;
566 sgl_offset = SGL_OFFSET_10;
569 case PCI_DMA_FROMDEVICE:
570 /* DATA IN (iop<--dev) */
571 scsi_flags |= 0x40000000;
572 sgl_offset = SGL_OFFSET_10;
576 /* Unknown - kill the command */
577 SCpnt->result = DID_NO_CONNECT << 16;
583 * Obtain an I2O message. If there are none free then
584 * throw it back to the scsi layer
587 msg = i2o_msg_get(c);
589 rc = SCSI_MLQUEUE_HOST_BUSY;
593 mptr = &msg->body[0];
595 #if 0 /* this code can't work */
596 #ifdef CONFIG_I2O_EXT_ADAPTEC
600 if (SCpnt->sc_request && SCpnt->sc_request->upper_private_data) {
601 i2o_sg_io_hdr_t __user *usr_ptr =
602 ((Sg_request *) (SCpnt->sc_request->
603 upper_private_data))->header.
607 get_user(adpt_flags, &usr_ptr->flags);
610 switch (i2o_dev->lct_data.class_id) {
611 case I2O_CLASS_EXECUTIVE:
612 case I2O_CLASS_RANDOM_BLOCK_STORAGE:
613 /* interpret flag has to be set for executive */
614 adpt_flags ^= I2O_DPT_SG_FLAG_INTERPRET;
622 * for Adaptec controllers we use the PRIVATE command, because
623 * the normal SCSI EXEC doesn't support all SCSI commands on
624 * all controllers (for example READ CAPACITY).
626 if (sgl_offset == SGL_OFFSET_10)
627 sgl_offset = SGL_OFFSET_12;
628 cmd = I2O_CMD_PRIVATE << 24;
629 *mptr++ = cpu_to_le32(I2O_VENDOR_DPT << 16 | I2O_CMD_SCSI_EXEC);
630 *mptr++ = cpu_to_le32(adpt_flags | tid);
635 msg->u.head[1] = cpu_to_le32(cmd | HOST_TID << 12 | tid);
636 msg->u.s.icntxt = cpu_to_le32(i2o_scsi_driver.context);
638 /* We want the SCSI control block back */
639 msg->u.s.tcntxt = cpu_to_le32(i2o_cntxt_list_add(c, SCpnt));
643 * Intermittant observations of msg frame word data corruption
644 * observed on msg[4] after:
645 * WRITE, READ-MODIFY-WRITE
646 * operations. 19990606 -sralston
648 * (Hence we build this word via tag. Its good practice anyway
649 * we don't want fetches over PCI needlessly)
652 /* Attach tags to the devices */
654 if(SCpnt->device->tagged_supported) {
655 if(SCpnt->tag == HEAD_OF_QUEUE_TAG)
656 scsi_flags |= 0x01000000;
657 else if(SCpnt->tag == ORDERED_QUEUE_TAG)
658 scsi_flags |= 0x01800000;
662 *mptr++ = cpu_to_le32(scsi_flags | SCpnt->cmd_len);
664 /* Write SCSI command into the message - always 16 byte block */
665 memcpy(mptr, SCpnt->cmnd, 16);
668 if (sgl_offset != SGL_OFFSET_0) {
669 /* write size of data addressed by SGL */
670 *mptr++ = cpu_to_le32(SCpnt->request_bufflen);
672 /* Now fill in the SGList and command */
674 if (!i2o_dma_map_sg(c, SCpnt->request_buffer,
676 SCpnt->sc_data_direction, &mptr))
679 SCpnt->SCp.dma_handle =
680 i2o_dma_map_single(c, SCpnt->request_buffer,
681 SCpnt->request_bufflen,
682 SCpnt->sc_data_direction, &mptr);
683 if (dma_mapping_error(SCpnt->SCp.dma_handle))
688 /* Stick the headers on */
690 cpu_to_le32(I2O_MESSAGE_SIZE(mptr - &msg->u.head[0]) | sgl_offset);
692 /* Queue the message */
693 i2o_msg_post(c, msg);
695 osm_debug("Issued %ld\n", SCpnt->serial_number);
708 * i2o_scsi_abort - abort a running command
709 * @SCpnt: command to abort
711 * Ask the I2O controller to abort a command. This is an asynchrnous
712 * process and our callback handler will see the command complete with an
713 * aborted message if it succeeds.
715 * Returns 0 if the command is successfully aborted or negative error code
718 static int i2o_scsi_abort(struct scsi_cmnd *SCpnt)
720 struct i2o_device *i2o_dev;
721 struct i2o_controller *c;
722 struct i2o_message *msg;
726 osm_warn("Aborting command block.\n");
728 i2o_dev = SCpnt->device->hostdata;
730 tid = i2o_dev->lct_data.tid;
732 msg = i2o_msg_get_wait(c, I2O_TIMEOUT_MESSAGE_GET);
734 return SCSI_MLQUEUE_HOST_BUSY;
736 msg->u.head[0] = cpu_to_le32(FIVE_WORD_MSG_SIZE | SGL_OFFSET_0);
738 cpu_to_le32(I2O_CMD_SCSI_ABORT << 24 | HOST_TID << 12 | tid);
739 msg->body[0] = cpu_to_le32(i2o_cntxt_list_get_ptr(c, SCpnt));
741 if (!i2o_msg_post_wait(c, msg, I2O_TIMEOUT_SCSI_SCB_ABORT))
748 * i2o_scsi_bios_param - Invent disk geometry
750 * @dev: block layer device
751 * @capacity: size in sectors
752 * @ip: geometry array
754 * This is anyones guess quite frankly. We use the same rules everyone
755 * else appears to and hope. It seems to work.
758 static int i2o_scsi_bios_param(struct scsi_device *sdev,
759 struct block_device *dev, sector_t capacity,
765 ip[0] = 64; /* heads */
766 ip[1] = 32; /* sectors */
767 if ((ip[2] = size >> 11) > 1024) { /* cylinders, test for big disk */
768 ip[0] = 255; /* heads */
769 ip[1] = 63; /* sectors */
770 ip[2] = size / (255 * 63); /* cylinders */
775 static struct scsi_host_template i2o_scsi_host_template = {
776 .proc_name = OSM_NAME,
777 .name = OSM_DESCRIPTION,
778 .info = i2o_scsi_info,
779 .queuecommand = i2o_scsi_queuecommand,
780 .eh_abort_handler = i2o_scsi_abort,
781 .bios_param = i2o_scsi_bios_param,
782 .can_queue = I2O_SCSI_CAN_QUEUE,
785 .use_clustering = ENABLE_CLUSTERING,
789 * i2o_scsi_init - SCSI OSM initialization function
791 * Register SCSI OSM into I2O core.
793 * Returns 0 on success or negative error code on failure.
795 static int __init i2o_scsi_init(void)
799 printk(KERN_INFO OSM_DESCRIPTION " v" OSM_VERSION "\n");
801 /* Register SCSI OSM into I2O core */
802 rc = i2o_driver_register(&i2o_scsi_driver);
804 osm_err("Could not register SCSI driver\n");
812 * i2o_scsi_exit - SCSI OSM exit function
814 * Unregisters SCSI OSM from I2O core.
816 static void __exit i2o_scsi_exit(void)
818 /* Unregister I2O SCSI OSM from I2O core */
819 i2o_driver_unregister(&i2o_scsi_driver);
822 MODULE_AUTHOR("Red Hat Software");
823 MODULE_LICENSE("GPL");
824 MODULE_DESCRIPTION(OSM_DESCRIPTION);
825 MODULE_VERSION(OSM_VERSION);
827 module_init(i2o_scsi_init);
828 module_exit(i2o_scsi_exit);