x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / drivers / scsi / ibmvscsi / ibmvscsi.c
blob07c23bbd968c51f7b2d4624ca8b092f23caeeba6
1 /* ------------------------------------------------------------
2 * ibmvscsi.c
3 * (C) Copyright IBM Corporation 1994, 2004
4 * Authors: Colin DeVilbiss (devilbis@us.ibm.com)
5 * Santiago Leon (santil@us.ibm.com)
6 * Dave Boutcher (sleddog@us.ibm.com)
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 * USA
23 * ------------------------------------------------------------
24 * Emulation of a SCSI host adapter for Virtual I/O devices
26 * This driver supports the SCSI adapter implemented by the IBM
27 * Power5 firmware. That SCSI adapter is not a physical adapter,
28 * but allows Linux SCSI peripheral drivers to directly
29 * access devices in another logical partition on the physical system.
31 * The virtual adapter(s) are present in the open firmware device
32 * tree just like real adapters.
34 * One of the capabilities provided on these systems is the ability
35 * to DMA between partitions. The architecture states that for VSCSI,
36 * the server side is allowed to DMA to and from the client. The client
37 * is never trusted to DMA to or from the server directly.
39 * Messages are sent between partitions on a "Command/Response Queue"
40 * (CRQ), which is just a buffer of 16 byte entries in the receiver's
41 * Senders cannot access the buffer directly, but send messages by
42 * making a hypervisor call and passing in the 16 bytes. The hypervisor
43 * puts the message in the next 16 byte space in round-robin fashion,
44 * turns on the high order bit of the message (the valid bit), and
45 * generates an interrupt to the receiver (if interrupts are turned on.)
46 * The receiver just turns off the valid bit when they have copied out
47 * the message.
49 * The VSCSI client builds a SCSI Remote Protocol (SRP) Information Unit
50 * (IU) (as defined in the T10 standard available at www.t10.org), gets
51 * a DMA address for the message, and sends it to the server as the
52 * payload of a CRQ message. The server DMAs the SRP IU and processes it,
53 * including doing any additional data transfers. When it is done, it
54 * DMAs the SRP response back to the same address as the request came from,
55 * and sends a CRQ message back to inform the client that the request has
56 * completed.
58 * TODO: This is currently pretty tied to the IBM pSeries hypervisor
59 * interfaces. It would be really nice to abstract this above an RDMA
60 * layer.
63 #include <linux/module.h>
64 #include <linux/moduleparam.h>
65 #include <linux/dma-mapping.h>
66 #include <linux/delay.h>
67 #include <linux/slab.h>
68 #include <linux/of.h>
69 #include <linux/pm.h>
70 #include <linux/kthread.h>
71 #include <asm/firmware.h>
72 #include <asm/vio.h>
73 #include <scsi/scsi.h>
74 #include <scsi/scsi_cmnd.h>
75 #include <scsi/scsi_host.h>
76 #include <scsi/scsi_device.h>
77 #include <scsi/scsi_transport_srp.h>
78 #include "ibmvscsi.h"
80 /* The values below are somewhat arbitrary default values, but
81 * OS/400 will use 3 busses (disks, CDs, tapes, I think.)
82 * Note that there are 3 bits of channel value, 6 bits of id, and
83 * 5 bits of LUN.
85 static int max_id = 64;
86 static int max_channel = 3;
87 static int init_timeout = 300;
88 static int login_timeout = 60;
89 static int info_timeout = 30;
90 static int abort_timeout = 60;
91 static int reset_timeout = 60;
92 static int max_requests = IBMVSCSI_MAX_REQUESTS_DEFAULT;
93 static int max_events = IBMVSCSI_MAX_REQUESTS_DEFAULT + 2;
94 static int fast_fail = 1;
95 static int client_reserve = 1;
96 static char partition_name[96] = "UNKNOWN";
97 static unsigned int partition_number = -1;
98 static LIST_HEAD(ibmvscsi_head);
99 static DEFINE_SPINLOCK(ibmvscsi_driver_lock);
101 static struct scsi_transport_template *ibmvscsi_transport_template;
103 #define IBMVSCSI_VERSION "1.5.9"
105 MODULE_DESCRIPTION("IBM Virtual SCSI");
106 MODULE_AUTHOR("Dave Boutcher");
107 MODULE_LICENSE("GPL");
108 MODULE_VERSION(IBMVSCSI_VERSION);
110 module_param_named(max_id, max_id, int, S_IRUGO | S_IWUSR);
111 MODULE_PARM_DESC(max_id, "Largest ID value for each channel [Default=64]");
112 module_param_named(max_channel, max_channel, int, S_IRUGO | S_IWUSR);
113 MODULE_PARM_DESC(max_channel, "Largest channel value [Default=3]");
114 module_param_named(init_timeout, init_timeout, int, S_IRUGO | S_IWUSR);
115 MODULE_PARM_DESC(init_timeout, "Initialization timeout in seconds");
116 module_param_named(max_requests, max_requests, int, S_IRUGO);
117 MODULE_PARM_DESC(max_requests, "Maximum requests for this adapter");
118 module_param_named(fast_fail, fast_fail, int, S_IRUGO | S_IWUSR);
119 MODULE_PARM_DESC(fast_fail, "Enable fast fail. [Default=1]");
120 module_param_named(client_reserve, client_reserve, int, S_IRUGO );
121 MODULE_PARM_DESC(client_reserve, "Attempt client managed reserve/release");
123 static void ibmvscsi_handle_crq(struct viosrp_crq *crq,
124 struct ibmvscsi_host_data *hostdata);
126 /* ------------------------------------------------------------
127 * Routines for managing the command/response queue
130 * ibmvscsi_handle_event: - Interrupt handler for crq events
131 * @irq: number of irq to handle, not used
132 * @dev_instance: ibmvscsi_host_data of host that received interrupt
134 * Disables interrupts and schedules srp_task
135 * Always returns IRQ_HANDLED
137 static irqreturn_t ibmvscsi_handle_event(int irq, void *dev_instance)
139 struct ibmvscsi_host_data *hostdata =
140 (struct ibmvscsi_host_data *)dev_instance;
141 vio_disable_interrupts(to_vio_dev(hostdata->dev));
142 tasklet_schedule(&hostdata->srp_task);
143 return IRQ_HANDLED;
147 * release_crq_queue: - Deallocates data and unregisters CRQ
148 * @queue: crq_queue to initialize and register
149 * @host_data: ibmvscsi_host_data of host
151 * Frees irq, deallocates a page for messages, unmaps dma, and unregisters
152 * the crq with the hypervisor.
154 static void ibmvscsi_release_crq_queue(struct crq_queue *queue,
155 struct ibmvscsi_host_data *hostdata,
156 int max_requests)
158 long rc = 0;
159 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
160 free_irq(vdev->irq, (void *)hostdata);
161 tasklet_kill(&hostdata->srp_task);
162 do {
163 if (rc)
164 msleep(100);
165 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
166 } while ((rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
167 dma_unmap_single(hostdata->dev,
168 queue->msg_token,
169 queue->size * sizeof(*queue->msgs), DMA_BIDIRECTIONAL);
170 free_page((unsigned long)queue->msgs);
174 * crq_queue_next_crq: - Returns the next entry in message queue
175 * @queue: crq_queue to use
177 * Returns pointer to next entry in queue, or NULL if there are no new
178 * entried in the CRQ.
180 static struct viosrp_crq *crq_queue_next_crq(struct crq_queue *queue)
182 struct viosrp_crq *crq;
183 unsigned long flags;
185 spin_lock_irqsave(&queue->lock, flags);
186 crq = &queue->msgs[queue->cur];
187 if (crq->valid != VIOSRP_CRQ_FREE) {
188 if (++queue->cur == queue->size)
189 queue->cur = 0;
191 /* Ensure the read of the valid bit occurs before reading any
192 * other bits of the CRQ entry
194 rmb();
195 } else
196 crq = NULL;
197 spin_unlock_irqrestore(&queue->lock, flags);
199 return crq;
203 * ibmvscsi_send_crq: - Send a CRQ
204 * @hostdata: the adapter
205 * @word1: the first 64 bits of the data
206 * @word2: the second 64 bits of the data
208 static int ibmvscsi_send_crq(struct ibmvscsi_host_data *hostdata,
209 u64 word1, u64 word2)
211 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
214 * Ensure the command buffer is flushed to memory before handing it
215 * over to the VIOS to prevent it from fetching any stale data.
217 mb();
218 return plpar_hcall_norets(H_SEND_CRQ, vdev->unit_address, word1, word2);
222 * ibmvscsi_task: - Process srps asynchronously
223 * @data: ibmvscsi_host_data of host
225 static void ibmvscsi_task(void *data)
227 struct ibmvscsi_host_data *hostdata = (struct ibmvscsi_host_data *)data;
228 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
229 struct viosrp_crq *crq;
230 int done = 0;
232 while (!done) {
233 /* Pull all the valid messages off the CRQ */
234 while ((crq = crq_queue_next_crq(&hostdata->queue)) != NULL) {
235 ibmvscsi_handle_crq(crq, hostdata);
236 crq->valid = VIOSRP_CRQ_FREE;
237 wmb();
240 vio_enable_interrupts(vdev);
241 crq = crq_queue_next_crq(&hostdata->queue);
242 if (crq != NULL) {
243 vio_disable_interrupts(vdev);
244 ibmvscsi_handle_crq(crq, hostdata);
245 crq->valid = VIOSRP_CRQ_FREE;
246 wmb();
247 } else {
248 done = 1;
253 static void gather_partition_info(void)
255 const char *ppartition_name;
256 const __be32 *p_number_ptr;
258 /* Retrieve information about this partition */
259 if (!of_root)
260 return;
262 of_node_get(of_root);
264 ppartition_name = of_get_property(of_root, "ibm,partition-name", NULL);
265 if (ppartition_name)
266 strlcpy(partition_name, ppartition_name,
267 sizeof(partition_name));
268 p_number_ptr = of_get_property(of_root, "ibm,partition-no", NULL);
269 if (p_number_ptr)
270 partition_number = of_read_number(p_number_ptr, 1);
271 of_node_put(of_root);
274 static void set_adapter_info(struct ibmvscsi_host_data *hostdata)
276 memset(&hostdata->madapter_info, 0x00,
277 sizeof(hostdata->madapter_info));
279 dev_info(hostdata->dev, "SRP_VERSION: %s\n", SRP_VERSION);
280 strcpy(hostdata->madapter_info.srp_version, SRP_VERSION);
282 strncpy(hostdata->madapter_info.partition_name, partition_name,
283 sizeof(hostdata->madapter_info.partition_name));
285 hostdata->madapter_info.partition_number =
286 cpu_to_be32(partition_number);
288 hostdata->madapter_info.mad_version = cpu_to_be32(SRP_MAD_VERSION_1);
289 hostdata->madapter_info.os_type = cpu_to_be32(SRP_MAD_OS_LINUX);
293 * reset_crq_queue: - resets a crq after a failure
294 * @queue: crq_queue to initialize and register
295 * @hostdata: ibmvscsi_host_data of host
298 static int ibmvscsi_reset_crq_queue(struct crq_queue *queue,
299 struct ibmvscsi_host_data *hostdata)
301 int rc = 0;
302 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
304 /* Close the CRQ */
305 do {
306 if (rc)
307 msleep(100);
308 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
309 } while ((rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
311 /* Clean out the queue */
312 memset(queue->msgs, 0x00, PAGE_SIZE);
313 queue->cur = 0;
315 set_adapter_info(hostdata);
317 /* And re-open it again */
318 rc = plpar_hcall_norets(H_REG_CRQ,
319 vdev->unit_address,
320 queue->msg_token, PAGE_SIZE);
321 if (rc == H_CLOSED) {
322 /* Adapter is good, but other end is not ready */
323 dev_warn(hostdata->dev, "Partner adapter not ready\n");
324 } else if (rc != 0) {
325 dev_warn(hostdata->dev, "couldn't register crq--rc 0x%x\n", rc);
327 return rc;
331 * initialize_crq_queue: - Initializes and registers CRQ with hypervisor
332 * @queue: crq_queue to initialize and register
333 * @hostdata: ibmvscsi_host_data of host
335 * Allocates a page for messages, maps it for dma, and registers
336 * the crq with the hypervisor.
337 * Returns zero on success.
339 static int ibmvscsi_init_crq_queue(struct crq_queue *queue,
340 struct ibmvscsi_host_data *hostdata,
341 int max_requests)
343 int rc;
344 int retrc;
345 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
347 queue->msgs = (struct viosrp_crq *)get_zeroed_page(GFP_KERNEL);
349 if (!queue->msgs)
350 goto malloc_failed;
351 queue->size = PAGE_SIZE / sizeof(*queue->msgs);
353 queue->msg_token = dma_map_single(hostdata->dev, queue->msgs,
354 queue->size * sizeof(*queue->msgs),
355 DMA_BIDIRECTIONAL);
357 if (dma_mapping_error(hostdata->dev, queue->msg_token))
358 goto map_failed;
360 gather_partition_info();
361 set_adapter_info(hostdata);
363 retrc = rc = plpar_hcall_norets(H_REG_CRQ,
364 vdev->unit_address,
365 queue->msg_token, PAGE_SIZE);
366 if (rc == H_RESOURCE)
367 /* maybe kexecing and resource is busy. try a reset */
368 rc = ibmvscsi_reset_crq_queue(queue,
369 hostdata);
371 if (rc == H_CLOSED) {
372 /* Adapter is good, but other end is not ready */
373 dev_warn(hostdata->dev, "Partner adapter not ready\n");
374 retrc = 0;
375 } else if (rc != 0) {
376 dev_warn(hostdata->dev, "Error %d opening adapter\n", rc);
377 goto reg_crq_failed;
380 queue->cur = 0;
381 spin_lock_init(&queue->lock);
383 tasklet_init(&hostdata->srp_task, (void *)ibmvscsi_task,
384 (unsigned long)hostdata);
386 if (request_irq(vdev->irq,
387 ibmvscsi_handle_event,
388 0, "ibmvscsi", (void *)hostdata) != 0) {
389 dev_err(hostdata->dev, "couldn't register irq 0x%x\n",
390 vdev->irq);
391 goto req_irq_failed;
394 rc = vio_enable_interrupts(vdev);
395 if (rc != 0) {
396 dev_err(hostdata->dev, "Error %d enabling interrupts!!!\n", rc);
397 goto req_irq_failed;
400 return retrc;
402 req_irq_failed:
403 tasklet_kill(&hostdata->srp_task);
404 rc = 0;
405 do {
406 if (rc)
407 msleep(100);
408 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
409 } while ((rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
410 reg_crq_failed:
411 dma_unmap_single(hostdata->dev,
412 queue->msg_token,
413 queue->size * sizeof(*queue->msgs), DMA_BIDIRECTIONAL);
414 map_failed:
415 free_page((unsigned long)queue->msgs);
416 malloc_failed:
417 return -1;
421 * reenable_crq_queue: - reenables a crq after
422 * @queue: crq_queue to initialize and register
423 * @hostdata: ibmvscsi_host_data of host
426 static int ibmvscsi_reenable_crq_queue(struct crq_queue *queue,
427 struct ibmvscsi_host_data *hostdata)
429 int rc = 0;
430 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
432 /* Re-enable the CRQ */
433 do {
434 if (rc)
435 msleep(100);
436 rc = plpar_hcall_norets(H_ENABLE_CRQ, vdev->unit_address);
437 } while ((rc == H_IN_PROGRESS) || (rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
439 if (rc)
440 dev_err(hostdata->dev, "Error %d enabling adapter\n", rc);
441 return rc;
444 /* ------------------------------------------------------------
445 * Routines for the event pool and event structs
448 * initialize_event_pool: - Allocates and initializes the event pool for a host
449 * @pool: event_pool to be initialized
450 * @size: Number of events in pool
451 * @hostdata: ibmvscsi_host_data who owns the event pool
453 * Returns zero on success.
455 static int initialize_event_pool(struct event_pool *pool,
456 int size, struct ibmvscsi_host_data *hostdata)
458 int i;
460 pool->size = size;
461 pool->next = 0;
462 pool->events = kcalloc(pool->size, sizeof(*pool->events), GFP_KERNEL);
463 if (!pool->events)
464 return -ENOMEM;
466 pool->iu_storage =
467 dma_alloc_coherent(hostdata->dev,
468 pool->size * sizeof(*pool->iu_storage),
469 &pool->iu_token, 0);
470 if (!pool->iu_storage) {
471 kfree(pool->events);
472 return -ENOMEM;
475 for (i = 0; i < pool->size; ++i) {
476 struct srp_event_struct *evt = &pool->events[i];
477 memset(&evt->crq, 0x00, sizeof(evt->crq));
478 atomic_set(&evt->free, 1);
479 evt->crq.valid = VIOSRP_CRQ_CMD_RSP;
480 evt->crq.IU_length = cpu_to_be16(sizeof(*evt->xfer_iu));
481 evt->crq.IU_data_ptr = cpu_to_be64(pool->iu_token +
482 sizeof(*evt->xfer_iu) * i);
483 evt->xfer_iu = pool->iu_storage + i;
484 evt->hostdata = hostdata;
485 evt->ext_list = NULL;
486 evt->ext_list_token = 0;
489 return 0;
493 * release_event_pool: - Frees memory of an event pool of a host
494 * @pool: event_pool to be released
495 * @hostdata: ibmvscsi_host_data who owns the even pool
497 * Returns zero on success.
499 static void release_event_pool(struct event_pool *pool,
500 struct ibmvscsi_host_data *hostdata)
502 int i, in_use = 0;
503 for (i = 0; i < pool->size; ++i) {
504 if (atomic_read(&pool->events[i].free) != 1)
505 ++in_use;
506 if (pool->events[i].ext_list) {
507 dma_free_coherent(hostdata->dev,
508 SG_ALL * sizeof(struct srp_direct_buf),
509 pool->events[i].ext_list,
510 pool->events[i].ext_list_token);
513 if (in_use)
514 dev_warn(hostdata->dev, "releasing event pool with %d "
515 "events still in use?\n", in_use);
516 kfree(pool->events);
517 dma_free_coherent(hostdata->dev,
518 pool->size * sizeof(*pool->iu_storage),
519 pool->iu_storage, pool->iu_token);
523 * valid_event_struct: - Determines if event is valid.
524 * @pool: event_pool that contains the event
525 * @evt: srp_event_struct to be checked for validity
527 * Returns zero if event is invalid, one otherwise.
529 static int valid_event_struct(struct event_pool *pool,
530 struct srp_event_struct *evt)
532 int index = evt - pool->events;
533 if (index < 0 || index >= pool->size) /* outside of bounds */
534 return 0;
535 if (evt != pool->events + index) /* unaligned */
536 return 0;
537 return 1;
541 * ibmvscsi_free-event_struct: - Changes status of event to "free"
542 * @pool: event_pool that contains the event
543 * @evt: srp_event_struct to be modified
546 static void free_event_struct(struct event_pool *pool,
547 struct srp_event_struct *evt)
549 if (!valid_event_struct(pool, evt)) {
550 dev_err(evt->hostdata->dev, "Freeing invalid event_struct %p "
551 "(not in pool %p)\n", evt, pool->events);
552 return;
554 if (atomic_inc_return(&evt->free) != 1) {
555 dev_err(evt->hostdata->dev, "Freeing event_struct %p "
556 "which is not in use!\n", evt);
557 return;
562 * get_evt_struct: - Gets the next free event in pool
563 * @pool: event_pool that contains the events to be searched
565 * Returns the next event in "free" state, and NULL if none are free.
566 * Note that no synchronization is done here, we assume the host_lock
567 * will syncrhonze things.
569 static struct srp_event_struct *get_event_struct(struct event_pool *pool)
571 int i;
572 int poolsize = pool->size;
573 int offset = pool->next;
575 for (i = 0; i < poolsize; i++) {
576 offset = (offset + 1) % poolsize;
577 if (!atomic_dec_if_positive(&pool->events[offset].free)) {
578 pool->next = offset;
579 return &pool->events[offset];
583 printk(KERN_ERR "ibmvscsi: found no event struct in pool!\n");
584 return NULL;
588 * init_event_struct: Initialize fields in an event struct that are always
589 * required.
590 * @evt: The event
591 * @done: Routine to call when the event is responded to
592 * @format: SRP or MAD format
593 * @timeout: timeout value set in the CRQ
595 static void init_event_struct(struct srp_event_struct *evt_struct,
596 void (*done) (struct srp_event_struct *),
597 u8 format,
598 int timeout)
600 evt_struct->cmnd = NULL;
601 evt_struct->cmnd_done = NULL;
602 evt_struct->sync_srp = NULL;
603 evt_struct->crq.format = format;
604 evt_struct->crq.timeout = cpu_to_be16(timeout);
605 evt_struct->done = done;
608 /* ------------------------------------------------------------
609 * Routines for receiving SCSI responses from the hosting partition
613 * set_srp_direction: Set the fields in the srp related to data
614 * direction and number of buffers based on the direction in
615 * the scsi_cmnd and the number of buffers
617 static void set_srp_direction(struct scsi_cmnd *cmd,
618 struct srp_cmd *srp_cmd,
619 int numbuf)
621 u8 fmt;
623 if (numbuf == 0)
624 return;
626 if (numbuf == 1)
627 fmt = SRP_DATA_DESC_DIRECT;
628 else {
629 fmt = SRP_DATA_DESC_INDIRECT;
630 numbuf = min(numbuf, MAX_INDIRECT_BUFS);
632 if (cmd->sc_data_direction == DMA_TO_DEVICE)
633 srp_cmd->data_out_desc_cnt = numbuf;
634 else
635 srp_cmd->data_in_desc_cnt = numbuf;
638 if (cmd->sc_data_direction == DMA_TO_DEVICE)
639 srp_cmd->buf_fmt = fmt << 4;
640 else
641 srp_cmd->buf_fmt = fmt;
645 * unmap_cmd_data: - Unmap data pointed in srp_cmd based on the format
646 * @cmd: srp_cmd whose additional_data member will be unmapped
647 * @dev: device for which the memory is mapped
650 static void unmap_cmd_data(struct srp_cmd *cmd,
651 struct srp_event_struct *evt_struct,
652 struct device *dev)
654 u8 out_fmt, in_fmt;
656 out_fmt = cmd->buf_fmt >> 4;
657 in_fmt = cmd->buf_fmt & ((1U << 4) - 1);
659 if (out_fmt == SRP_NO_DATA_DESC && in_fmt == SRP_NO_DATA_DESC)
660 return;
662 if (evt_struct->cmnd)
663 scsi_dma_unmap(evt_struct->cmnd);
666 static int map_sg_list(struct scsi_cmnd *cmd, int nseg,
667 struct srp_direct_buf *md)
669 int i;
670 struct scatterlist *sg;
671 u64 total_length = 0;
673 scsi_for_each_sg(cmd, sg, nseg, i) {
674 struct srp_direct_buf *descr = md + i;
675 descr->va = cpu_to_be64(sg_dma_address(sg));
676 descr->len = cpu_to_be32(sg_dma_len(sg));
677 descr->key = 0;
678 total_length += sg_dma_len(sg);
680 return total_length;
684 * map_sg_data: - Maps dma for a scatterlist and initializes decriptor fields
685 * @cmd: Scsi_Cmnd with the scatterlist
686 * @srp_cmd: srp_cmd that contains the memory descriptor
687 * @dev: device for which to map dma memory
689 * Called by map_data_for_srp_cmd() when building srp cmd from scsi cmd.
690 * Returns 1 on success.
692 static int map_sg_data(struct scsi_cmnd *cmd,
693 struct srp_event_struct *evt_struct,
694 struct srp_cmd *srp_cmd, struct device *dev)
697 int sg_mapped;
698 u64 total_length = 0;
699 struct srp_direct_buf *data =
700 (struct srp_direct_buf *) srp_cmd->add_data;
701 struct srp_indirect_buf *indirect =
702 (struct srp_indirect_buf *) data;
704 sg_mapped = scsi_dma_map(cmd);
705 if (!sg_mapped)
706 return 1;
707 else if (sg_mapped < 0)
708 return 0;
710 set_srp_direction(cmd, srp_cmd, sg_mapped);
712 /* special case; we can use a single direct descriptor */
713 if (sg_mapped == 1) {
714 map_sg_list(cmd, sg_mapped, data);
715 return 1;
718 indirect->table_desc.va = 0;
719 indirect->table_desc.len = cpu_to_be32(sg_mapped *
720 sizeof(struct srp_direct_buf));
721 indirect->table_desc.key = 0;
723 if (sg_mapped <= MAX_INDIRECT_BUFS) {
724 total_length = map_sg_list(cmd, sg_mapped,
725 &indirect->desc_list[0]);
726 indirect->len = cpu_to_be32(total_length);
727 return 1;
730 /* get indirect table */
731 if (!evt_struct->ext_list) {
732 evt_struct->ext_list = (struct srp_direct_buf *)
733 dma_alloc_coherent(dev,
734 SG_ALL * sizeof(struct srp_direct_buf),
735 &evt_struct->ext_list_token, 0);
736 if (!evt_struct->ext_list) {
737 if (!firmware_has_feature(FW_FEATURE_CMO))
738 sdev_printk(KERN_ERR, cmd->device,
739 "Can't allocate memory "
740 "for indirect table\n");
741 scsi_dma_unmap(cmd);
742 return 0;
746 total_length = map_sg_list(cmd, sg_mapped, evt_struct->ext_list);
748 indirect->len = cpu_to_be32(total_length);
749 indirect->table_desc.va = cpu_to_be64(evt_struct->ext_list_token);
750 indirect->table_desc.len = cpu_to_be32(sg_mapped *
751 sizeof(indirect->desc_list[0]));
752 memcpy(indirect->desc_list, evt_struct->ext_list,
753 MAX_INDIRECT_BUFS * sizeof(struct srp_direct_buf));
754 return 1;
758 * map_data_for_srp_cmd: - Calls functions to map data for srp cmds
759 * @cmd: struct scsi_cmnd with the memory to be mapped
760 * @srp_cmd: srp_cmd that contains the memory descriptor
761 * @dev: dma device for which to map dma memory
763 * Called by scsi_cmd_to_srp_cmd() when converting scsi cmds to srp cmds
764 * Returns 1 on success.
766 static int map_data_for_srp_cmd(struct scsi_cmnd *cmd,
767 struct srp_event_struct *evt_struct,
768 struct srp_cmd *srp_cmd, struct device *dev)
770 switch (cmd->sc_data_direction) {
771 case DMA_FROM_DEVICE:
772 case DMA_TO_DEVICE:
773 break;
774 case DMA_NONE:
775 return 1;
776 case DMA_BIDIRECTIONAL:
777 sdev_printk(KERN_ERR, cmd->device,
778 "Can't map DMA_BIDIRECTIONAL to read/write\n");
779 return 0;
780 default:
781 sdev_printk(KERN_ERR, cmd->device,
782 "Unknown data direction 0x%02x; can't map!\n",
783 cmd->sc_data_direction);
784 return 0;
787 return map_sg_data(cmd, evt_struct, srp_cmd, dev);
791 * purge_requests: Our virtual adapter just shut down. purge any sent requests
792 * @hostdata: the adapter
794 static void purge_requests(struct ibmvscsi_host_data *hostdata, int error_code)
796 struct srp_event_struct *evt;
797 unsigned long flags;
799 spin_lock_irqsave(hostdata->host->host_lock, flags);
800 while (!list_empty(&hostdata->sent)) {
801 evt = list_first_entry(&hostdata->sent, struct srp_event_struct, list);
802 list_del(&evt->list);
803 del_timer(&evt->timer);
805 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
806 if (evt->cmnd) {
807 evt->cmnd->result = (error_code << 16);
808 unmap_cmd_data(&evt->iu.srp.cmd, evt,
809 evt->hostdata->dev);
810 if (evt->cmnd_done)
811 evt->cmnd_done(evt->cmnd);
812 } else if (evt->done && evt->crq.format != VIOSRP_MAD_FORMAT &&
813 evt->iu.srp.login_req.opcode != SRP_LOGIN_REQ)
814 evt->done(evt);
815 free_event_struct(&evt->hostdata->pool, evt);
816 spin_lock_irqsave(hostdata->host->host_lock, flags);
818 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
822 * ibmvscsi_reset_host - Reset the connection to the server
823 * @hostdata: struct ibmvscsi_host_data to reset
825 static void ibmvscsi_reset_host(struct ibmvscsi_host_data *hostdata)
827 scsi_block_requests(hostdata->host);
828 atomic_set(&hostdata->request_limit, 0);
830 purge_requests(hostdata, DID_ERROR);
831 hostdata->reset_crq = 1;
832 wake_up(&hostdata->work_wait_q);
836 * ibmvscsi_timeout - Internal command timeout handler
837 * @evt_struct: struct srp_event_struct that timed out
839 * Called when an internally generated command times out
841 static void ibmvscsi_timeout(struct srp_event_struct *evt_struct)
843 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
845 dev_err(hostdata->dev, "Command timed out (%x). Resetting connection\n",
846 evt_struct->iu.srp.cmd.opcode);
848 ibmvscsi_reset_host(hostdata);
852 /* ------------------------------------------------------------
853 * Routines for sending and receiving SRPs
856 * ibmvscsi_send_srp_event: - Transforms event to u64 array and calls send_crq()
857 * @evt_struct: evt_struct to be sent
858 * @hostdata: ibmvscsi_host_data of host
859 * @timeout: timeout in seconds - 0 means do not time command
861 * Returns the value returned from ibmvscsi_send_crq(). (Zero for success)
862 * Note that this routine assumes that host_lock is held for synchronization
864 static int ibmvscsi_send_srp_event(struct srp_event_struct *evt_struct,
865 struct ibmvscsi_host_data *hostdata,
866 unsigned long timeout)
868 __be64 *crq_as_u64 = (__be64 *)&evt_struct->crq;
869 int request_status = 0;
870 int rc;
871 int srp_req = 0;
873 /* If we have exhausted our request limit, just fail this request,
874 * unless it is for a reset or abort.
875 * Note that there are rare cases involving driver generated requests
876 * (such as task management requests) that the mid layer may think we
877 * can handle more requests (can_queue) when we actually can't
879 if (evt_struct->crq.format == VIOSRP_SRP_FORMAT) {
880 srp_req = 1;
881 request_status =
882 atomic_dec_if_positive(&hostdata->request_limit);
883 /* If request limit was -1 when we started, it is now even
884 * less than that
886 if (request_status < -1)
887 goto send_error;
888 /* Otherwise, we may have run out of requests. */
889 /* If request limit was 0 when we started the adapter is in the
890 * process of performing a login with the server adapter, or
891 * we may have run out of requests.
893 else if (request_status == -1 &&
894 evt_struct->iu.srp.login_req.opcode != SRP_LOGIN_REQ)
895 goto send_busy;
896 /* Abort and reset calls should make it through.
897 * Nothing except abort and reset should use the last two
898 * slots unless we had two or less to begin with.
900 else if (request_status < 2 &&
901 evt_struct->iu.srp.cmd.opcode != SRP_TSK_MGMT) {
902 /* In the case that we have less than two requests
903 * available, check the server limit as a combination
904 * of the request limit and the number of requests
905 * in-flight (the size of the send list). If the
906 * server limit is greater than 2, return busy so
907 * that the last two are reserved for reset and abort.
909 int server_limit = request_status;
910 struct srp_event_struct *tmp_evt;
912 list_for_each_entry(tmp_evt, &hostdata->sent, list) {
913 server_limit++;
916 if (server_limit > 2)
917 goto send_busy;
921 /* Copy the IU into the transfer area */
922 *evt_struct->xfer_iu = evt_struct->iu;
923 evt_struct->xfer_iu->srp.rsp.tag = (u64)evt_struct;
925 /* Add this to the sent list. We need to do this
926 * before we actually send
927 * in case it comes back REALLY fast
929 list_add_tail(&evt_struct->list, &hostdata->sent);
931 init_timer(&evt_struct->timer);
932 if (timeout) {
933 evt_struct->timer.data = (unsigned long) evt_struct;
934 evt_struct->timer.expires = jiffies + (timeout * HZ);
935 evt_struct->timer.function = (void (*)(unsigned long))ibmvscsi_timeout;
936 add_timer(&evt_struct->timer);
939 rc = ibmvscsi_send_crq(hostdata, be64_to_cpu(crq_as_u64[0]),
940 be64_to_cpu(crq_as_u64[1]));
941 if (rc != 0) {
942 list_del(&evt_struct->list);
943 del_timer(&evt_struct->timer);
945 /* If send_crq returns H_CLOSED, return SCSI_MLQUEUE_HOST_BUSY.
946 * Firmware will send a CRQ with a transport event (0xFF) to
947 * tell this client what has happened to the transport. This
948 * will be handled in ibmvscsi_handle_crq()
950 if (rc == H_CLOSED) {
951 dev_warn(hostdata->dev, "send warning. "
952 "Receive queue closed, will retry.\n");
953 goto send_busy;
955 dev_err(hostdata->dev, "send error %d\n", rc);
956 if (srp_req)
957 atomic_inc(&hostdata->request_limit);
958 goto send_error;
961 return 0;
963 send_busy:
964 unmap_cmd_data(&evt_struct->iu.srp.cmd, evt_struct, hostdata->dev);
966 free_event_struct(&hostdata->pool, evt_struct);
967 if (srp_req && request_status != -1)
968 atomic_inc(&hostdata->request_limit);
969 return SCSI_MLQUEUE_HOST_BUSY;
971 send_error:
972 unmap_cmd_data(&evt_struct->iu.srp.cmd, evt_struct, hostdata->dev);
974 if (evt_struct->cmnd != NULL) {
975 evt_struct->cmnd->result = DID_ERROR << 16;
976 evt_struct->cmnd_done(evt_struct->cmnd);
977 } else if (evt_struct->done)
978 evt_struct->done(evt_struct);
980 free_event_struct(&hostdata->pool, evt_struct);
981 return 0;
985 * handle_cmd_rsp: - Handle responses from commands
986 * @evt_struct: srp_event_struct to be handled
988 * Used as a callback by when sending scsi cmds.
989 * Gets called by ibmvscsi_handle_crq()
991 static void handle_cmd_rsp(struct srp_event_struct *evt_struct)
993 struct srp_rsp *rsp = &evt_struct->xfer_iu->srp.rsp;
994 struct scsi_cmnd *cmnd = evt_struct->cmnd;
996 if (unlikely(rsp->opcode != SRP_RSP)) {
997 if (printk_ratelimit())
998 dev_warn(evt_struct->hostdata->dev,
999 "bad SRP RSP type %#02x\n", rsp->opcode);
1002 if (cmnd) {
1003 cmnd->result |= rsp->status;
1004 if (((cmnd->result >> 1) & 0x1f) == CHECK_CONDITION)
1005 memcpy(cmnd->sense_buffer,
1006 rsp->data,
1007 be32_to_cpu(rsp->sense_data_len));
1008 unmap_cmd_data(&evt_struct->iu.srp.cmd,
1009 evt_struct,
1010 evt_struct->hostdata->dev);
1012 if (rsp->flags & SRP_RSP_FLAG_DOOVER)
1013 scsi_set_resid(cmnd,
1014 be32_to_cpu(rsp->data_out_res_cnt));
1015 else if (rsp->flags & SRP_RSP_FLAG_DIOVER)
1016 scsi_set_resid(cmnd, be32_to_cpu(rsp->data_in_res_cnt));
1019 if (evt_struct->cmnd_done)
1020 evt_struct->cmnd_done(cmnd);
1024 * lun_from_dev: - Returns the lun of the scsi device
1025 * @dev: struct scsi_device
1028 static inline u16 lun_from_dev(struct scsi_device *dev)
1030 return (0x2 << 14) | (dev->id << 8) | (dev->channel << 5) | dev->lun;
1034 * ibmvscsi_queue: - The queuecommand function of the scsi template
1035 * @cmd: struct scsi_cmnd to be executed
1036 * @done: Callback function to be called when cmd is completed
1038 static int ibmvscsi_queuecommand_lck(struct scsi_cmnd *cmnd,
1039 void (*done) (struct scsi_cmnd *))
1041 struct srp_cmd *srp_cmd;
1042 struct srp_event_struct *evt_struct;
1043 struct srp_indirect_buf *indirect;
1044 struct ibmvscsi_host_data *hostdata = shost_priv(cmnd->device->host);
1045 u16 lun = lun_from_dev(cmnd->device);
1046 u8 out_fmt, in_fmt;
1048 cmnd->result = (DID_OK << 16);
1049 evt_struct = get_event_struct(&hostdata->pool);
1050 if (!evt_struct)
1051 return SCSI_MLQUEUE_HOST_BUSY;
1053 /* Set up the actual SRP IU */
1054 srp_cmd = &evt_struct->iu.srp.cmd;
1055 memset(srp_cmd, 0x00, SRP_MAX_IU_LEN);
1056 srp_cmd->opcode = SRP_CMD;
1057 memcpy(srp_cmd->cdb, cmnd->cmnd, sizeof(srp_cmd->cdb));
1058 int_to_scsilun(lun, &srp_cmd->lun);
1060 if (!map_data_for_srp_cmd(cmnd, evt_struct, srp_cmd, hostdata->dev)) {
1061 if (!firmware_has_feature(FW_FEATURE_CMO))
1062 sdev_printk(KERN_ERR, cmnd->device,
1063 "couldn't convert cmd to srp_cmd\n");
1064 free_event_struct(&hostdata->pool, evt_struct);
1065 return SCSI_MLQUEUE_HOST_BUSY;
1068 init_event_struct(evt_struct,
1069 handle_cmd_rsp,
1070 VIOSRP_SRP_FORMAT,
1071 cmnd->request->timeout/HZ);
1073 evt_struct->cmnd = cmnd;
1074 evt_struct->cmnd_done = done;
1076 /* Fix up dma address of the buffer itself */
1077 indirect = (struct srp_indirect_buf *) srp_cmd->add_data;
1078 out_fmt = srp_cmd->buf_fmt >> 4;
1079 in_fmt = srp_cmd->buf_fmt & ((1U << 4) - 1);
1080 if ((in_fmt == SRP_DATA_DESC_INDIRECT ||
1081 out_fmt == SRP_DATA_DESC_INDIRECT) &&
1082 indirect->table_desc.va == 0) {
1083 indirect->table_desc.va =
1084 cpu_to_be64(be64_to_cpu(evt_struct->crq.IU_data_ptr) +
1085 offsetof(struct srp_cmd, add_data) +
1086 offsetof(struct srp_indirect_buf, desc_list));
1089 return ibmvscsi_send_srp_event(evt_struct, hostdata, 0);
1092 static DEF_SCSI_QCMD(ibmvscsi_queuecommand)
1094 /* ------------------------------------------------------------
1095 * Routines for driver initialization
1099 * map_persist_bufs: - Pre-map persistent data for adapter logins
1100 * @hostdata: ibmvscsi_host_data of host
1102 * Map the capabilities and adapter info DMA buffers to avoid runtime failures.
1103 * Return 1 on error, 0 on success.
1105 static int map_persist_bufs(struct ibmvscsi_host_data *hostdata)
1108 hostdata->caps_addr = dma_map_single(hostdata->dev, &hostdata->caps,
1109 sizeof(hostdata->caps), DMA_BIDIRECTIONAL);
1111 if (dma_mapping_error(hostdata->dev, hostdata->caps_addr)) {
1112 dev_err(hostdata->dev, "Unable to map capabilities buffer!\n");
1113 return 1;
1116 hostdata->adapter_info_addr = dma_map_single(hostdata->dev,
1117 &hostdata->madapter_info,
1118 sizeof(hostdata->madapter_info),
1119 DMA_BIDIRECTIONAL);
1120 if (dma_mapping_error(hostdata->dev, hostdata->adapter_info_addr)) {
1121 dev_err(hostdata->dev, "Unable to map adapter info buffer!\n");
1122 dma_unmap_single(hostdata->dev, hostdata->caps_addr,
1123 sizeof(hostdata->caps), DMA_BIDIRECTIONAL);
1124 return 1;
1127 return 0;
1131 * unmap_persist_bufs: - Unmap persistent data needed for adapter logins
1132 * @hostdata: ibmvscsi_host_data of host
1134 * Unmap the capabilities and adapter info DMA buffers
1136 static void unmap_persist_bufs(struct ibmvscsi_host_data *hostdata)
1138 dma_unmap_single(hostdata->dev, hostdata->caps_addr,
1139 sizeof(hostdata->caps), DMA_BIDIRECTIONAL);
1141 dma_unmap_single(hostdata->dev, hostdata->adapter_info_addr,
1142 sizeof(hostdata->madapter_info), DMA_BIDIRECTIONAL);
1146 * login_rsp: - Handle response to SRP login request
1147 * @evt_struct: srp_event_struct with the response
1149 * Used as a "done" callback by when sending srp_login. Gets called
1150 * by ibmvscsi_handle_crq()
1152 static void login_rsp(struct srp_event_struct *evt_struct)
1154 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1155 switch (evt_struct->xfer_iu->srp.login_rsp.opcode) {
1156 case SRP_LOGIN_RSP: /* it worked! */
1157 break;
1158 case SRP_LOGIN_REJ: /* refused! */
1159 dev_info(hostdata->dev, "SRP_LOGIN_REJ reason %u\n",
1160 evt_struct->xfer_iu->srp.login_rej.reason);
1161 /* Login failed. */
1162 atomic_set(&hostdata->request_limit, -1);
1163 return;
1164 default:
1165 dev_err(hostdata->dev, "Invalid login response typecode 0x%02x!\n",
1166 evt_struct->xfer_iu->srp.login_rsp.opcode);
1167 /* Login failed. */
1168 atomic_set(&hostdata->request_limit, -1);
1169 return;
1172 dev_info(hostdata->dev, "SRP_LOGIN succeeded\n");
1173 hostdata->client_migrated = 0;
1175 /* Now we know what the real request-limit is.
1176 * This value is set rather than added to request_limit because
1177 * request_limit could have been set to -1 by this client.
1179 atomic_set(&hostdata->request_limit,
1180 be32_to_cpu(evt_struct->xfer_iu->srp.login_rsp.req_lim_delta));
1182 /* If we had any pending I/Os, kick them */
1183 scsi_unblock_requests(hostdata->host);
1187 * send_srp_login: - Sends the srp login
1188 * @hostdata: ibmvscsi_host_data of host
1190 * Returns zero if successful.
1192 static int send_srp_login(struct ibmvscsi_host_data *hostdata)
1194 int rc;
1195 unsigned long flags;
1196 struct srp_login_req *login;
1197 struct srp_event_struct *evt_struct = get_event_struct(&hostdata->pool);
1199 BUG_ON(!evt_struct);
1200 init_event_struct(evt_struct, login_rsp,
1201 VIOSRP_SRP_FORMAT, login_timeout);
1203 login = &evt_struct->iu.srp.login_req;
1204 memset(login, 0, sizeof(*login));
1205 login->opcode = SRP_LOGIN_REQ;
1206 login->req_it_iu_len = cpu_to_be32(sizeof(union srp_iu));
1207 login->req_buf_fmt = cpu_to_be16(SRP_BUF_FORMAT_DIRECT |
1208 SRP_BUF_FORMAT_INDIRECT);
1210 spin_lock_irqsave(hostdata->host->host_lock, flags);
1211 /* Start out with a request limit of 0, since this is negotiated in
1212 * the login request we are just sending and login requests always
1213 * get sent by the driver regardless of request_limit.
1215 atomic_set(&hostdata->request_limit, 0);
1217 rc = ibmvscsi_send_srp_event(evt_struct, hostdata, login_timeout * 2);
1218 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1219 dev_info(hostdata->dev, "sent SRP login\n");
1220 return rc;
1224 * capabilities_rsp: - Handle response to MAD adapter capabilities request
1225 * @evt_struct: srp_event_struct with the response
1227 * Used as a "done" callback by when sending adapter_info.
1229 static void capabilities_rsp(struct srp_event_struct *evt_struct)
1231 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1233 if (evt_struct->xfer_iu->mad.capabilities.common.status) {
1234 dev_err(hostdata->dev, "error 0x%X getting capabilities info\n",
1235 evt_struct->xfer_iu->mad.capabilities.common.status);
1236 } else {
1237 if (hostdata->caps.migration.common.server_support !=
1238 cpu_to_be16(SERVER_SUPPORTS_CAP))
1239 dev_info(hostdata->dev, "Partition migration not supported\n");
1241 if (client_reserve) {
1242 if (hostdata->caps.reserve.common.server_support ==
1243 cpu_to_be16(SERVER_SUPPORTS_CAP))
1244 dev_info(hostdata->dev, "Client reserve enabled\n");
1245 else
1246 dev_info(hostdata->dev, "Client reserve not supported\n");
1250 send_srp_login(hostdata);
1254 * send_mad_capabilities: - Sends the mad capabilities request
1255 * and stores the result so it can be retrieved with
1256 * @hostdata: ibmvscsi_host_data of host
1258 static void send_mad_capabilities(struct ibmvscsi_host_data *hostdata)
1260 struct viosrp_capabilities *req;
1261 struct srp_event_struct *evt_struct;
1262 unsigned long flags;
1263 struct device_node *of_node = hostdata->dev->of_node;
1264 const char *location;
1266 evt_struct = get_event_struct(&hostdata->pool);
1267 BUG_ON(!evt_struct);
1269 init_event_struct(evt_struct, capabilities_rsp,
1270 VIOSRP_MAD_FORMAT, info_timeout);
1272 req = &evt_struct->iu.mad.capabilities;
1273 memset(req, 0, sizeof(*req));
1275 hostdata->caps.flags = cpu_to_be32(CAP_LIST_SUPPORTED);
1276 if (hostdata->client_migrated)
1277 hostdata->caps.flags |= cpu_to_be32(CLIENT_MIGRATED);
1279 strncpy(hostdata->caps.name, dev_name(&hostdata->host->shost_gendev),
1280 sizeof(hostdata->caps.name));
1281 hostdata->caps.name[sizeof(hostdata->caps.name) - 1] = '\0';
1283 location = of_get_property(of_node, "ibm,loc-code", NULL);
1284 location = location ? location : dev_name(hostdata->dev);
1285 strncpy(hostdata->caps.loc, location, sizeof(hostdata->caps.loc));
1286 hostdata->caps.loc[sizeof(hostdata->caps.loc) - 1] = '\0';
1288 req->common.type = cpu_to_be32(VIOSRP_CAPABILITIES_TYPE);
1289 req->buffer = cpu_to_be64(hostdata->caps_addr);
1291 hostdata->caps.migration.common.cap_type =
1292 cpu_to_be32(MIGRATION_CAPABILITIES);
1293 hostdata->caps.migration.common.length =
1294 cpu_to_be16(sizeof(hostdata->caps.migration));
1295 hostdata->caps.migration.common.server_support =
1296 cpu_to_be16(SERVER_SUPPORTS_CAP);
1297 hostdata->caps.migration.ecl = cpu_to_be32(1);
1299 if (client_reserve) {
1300 hostdata->caps.reserve.common.cap_type =
1301 cpu_to_be32(RESERVATION_CAPABILITIES);
1302 hostdata->caps.reserve.common.length =
1303 cpu_to_be16(sizeof(hostdata->caps.reserve));
1304 hostdata->caps.reserve.common.server_support =
1305 cpu_to_be16(SERVER_SUPPORTS_CAP);
1306 hostdata->caps.reserve.type =
1307 cpu_to_be32(CLIENT_RESERVE_SCSI_2);
1308 req->common.length =
1309 cpu_to_be16(sizeof(hostdata->caps));
1310 } else
1311 req->common.length = cpu_to_be16(sizeof(hostdata->caps) -
1312 sizeof(hostdata->caps.reserve));
1314 spin_lock_irqsave(hostdata->host->host_lock, flags);
1315 if (ibmvscsi_send_srp_event(evt_struct, hostdata, info_timeout * 2))
1316 dev_err(hostdata->dev, "couldn't send CAPABILITIES_REQ!\n");
1317 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1321 * fast_fail_rsp: - Handle response to MAD enable fast fail
1322 * @evt_struct: srp_event_struct with the response
1324 * Used as a "done" callback by when sending enable fast fail. Gets called
1325 * by ibmvscsi_handle_crq()
1327 static void fast_fail_rsp(struct srp_event_struct *evt_struct)
1329 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1330 u16 status = be16_to_cpu(evt_struct->xfer_iu->mad.fast_fail.common.status);
1332 if (status == VIOSRP_MAD_NOT_SUPPORTED)
1333 dev_err(hostdata->dev, "fast_fail not supported in server\n");
1334 else if (status == VIOSRP_MAD_FAILED)
1335 dev_err(hostdata->dev, "fast_fail request failed\n");
1336 else if (status != VIOSRP_MAD_SUCCESS)
1337 dev_err(hostdata->dev, "error 0x%X enabling fast_fail\n", status);
1339 send_mad_capabilities(hostdata);
1343 * init_host - Start host initialization
1344 * @hostdata: ibmvscsi_host_data of host
1346 * Returns zero if successful.
1348 static int enable_fast_fail(struct ibmvscsi_host_data *hostdata)
1350 int rc;
1351 unsigned long flags;
1352 struct viosrp_fast_fail *fast_fail_mad;
1353 struct srp_event_struct *evt_struct;
1355 if (!fast_fail) {
1356 send_mad_capabilities(hostdata);
1357 return 0;
1360 evt_struct = get_event_struct(&hostdata->pool);
1361 BUG_ON(!evt_struct);
1363 init_event_struct(evt_struct, fast_fail_rsp, VIOSRP_MAD_FORMAT, info_timeout);
1365 fast_fail_mad = &evt_struct->iu.mad.fast_fail;
1366 memset(fast_fail_mad, 0, sizeof(*fast_fail_mad));
1367 fast_fail_mad->common.type = cpu_to_be32(VIOSRP_ENABLE_FAST_FAIL);
1368 fast_fail_mad->common.length = cpu_to_be16(sizeof(*fast_fail_mad));
1370 spin_lock_irqsave(hostdata->host->host_lock, flags);
1371 rc = ibmvscsi_send_srp_event(evt_struct, hostdata, info_timeout * 2);
1372 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1373 return rc;
1377 * adapter_info_rsp: - Handle response to MAD adapter info request
1378 * @evt_struct: srp_event_struct with the response
1380 * Used as a "done" callback by when sending adapter_info. Gets called
1381 * by ibmvscsi_handle_crq()
1383 static void adapter_info_rsp(struct srp_event_struct *evt_struct)
1385 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1387 if (evt_struct->xfer_iu->mad.adapter_info.common.status) {
1388 dev_err(hostdata->dev, "error %d getting adapter info\n",
1389 evt_struct->xfer_iu->mad.adapter_info.common.status);
1390 } else {
1391 dev_info(hostdata->dev, "host srp version: %s, "
1392 "host partition %s (%d), OS %d, max io %u\n",
1393 hostdata->madapter_info.srp_version,
1394 hostdata->madapter_info.partition_name,
1395 be32_to_cpu(hostdata->madapter_info.partition_number),
1396 be32_to_cpu(hostdata->madapter_info.os_type),
1397 be32_to_cpu(hostdata->madapter_info.port_max_txu[0]));
1399 if (hostdata->madapter_info.port_max_txu[0])
1400 hostdata->host->max_sectors =
1401 be32_to_cpu(hostdata->madapter_info.port_max_txu[0]) >> 9;
1403 if (be32_to_cpu(hostdata->madapter_info.os_type) == SRP_MAD_OS_AIX &&
1404 strcmp(hostdata->madapter_info.srp_version, "1.6a") <= 0) {
1405 dev_err(hostdata->dev, "host (Ver. %s) doesn't support large transfers\n",
1406 hostdata->madapter_info.srp_version);
1407 dev_err(hostdata->dev, "limiting scatterlists to %d\n",
1408 MAX_INDIRECT_BUFS);
1409 hostdata->host->sg_tablesize = MAX_INDIRECT_BUFS;
1412 if (be32_to_cpu(hostdata->madapter_info.os_type) == SRP_MAD_OS_AIX) {
1413 enable_fast_fail(hostdata);
1414 return;
1418 send_srp_login(hostdata);
1422 * send_mad_adapter_info: - Sends the mad adapter info request
1423 * and stores the result so it can be retrieved with
1424 * sysfs. We COULD consider causing a failure if the
1425 * returned SRP version doesn't match ours.
1426 * @hostdata: ibmvscsi_host_data of host
1428 * Returns zero if successful.
1430 static void send_mad_adapter_info(struct ibmvscsi_host_data *hostdata)
1432 struct viosrp_adapter_info *req;
1433 struct srp_event_struct *evt_struct;
1434 unsigned long flags;
1436 evt_struct = get_event_struct(&hostdata->pool);
1437 BUG_ON(!evt_struct);
1439 init_event_struct(evt_struct,
1440 adapter_info_rsp,
1441 VIOSRP_MAD_FORMAT,
1442 info_timeout);
1444 req = &evt_struct->iu.mad.adapter_info;
1445 memset(req, 0x00, sizeof(*req));
1447 req->common.type = cpu_to_be32(VIOSRP_ADAPTER_INFO_TYPE);
1448 req->common.length = cpu_to_be16(sizeof(hostdata->madapter_info));
1449 req->buffer = cpu_to_be64(hostdata->adapter_info_addr);
1451 spin_lock_irqsave(hostdata->host->host_lock, flags);
1452 if (ibmvscsi_send_srp_event(evt_struct, hostdata, info_timeout * 2))
1453 dev_err(hostdata->dev, "couldn't send ADAPTER_INFO_REQ!\n");
1454 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1458 * init_adapter: Start virtual adapter initialization sequence
1461 static void init_adapter(struct ibmvscsi_host_data *hostdata)
1463 send_mad_adapter_info(hostdata);
1467 * sync_completion: Signal that a synchronous command has completed
1468 * Note that after returning from this call, the evt_struct is freed.
1469 * the caller waiting on this completion shouldn't touch the evt_struct
1470 * again.
1472 static void sync_completion(struct srp_event_struct *evt_struct)
1474 /* copy the response back */
1475 if (evt_struct->sync_srp)
1476 *evt_struct->sync_srp = *evt_struct->xfer_iu;
1478 complete(&evt_struct->comp);
1482 * ibmvscsi_abort: Abort a command...from scsi host template
1483 * send this over to the server and wait synchronously for the response
1485 static int ibmvscsi_eh_abort_handler(struct scsi_cmnd *cmd)
1487 struct ibmvscsi_host_data *hostdata = shost_priv(cmd->device->host);
1488 struct srp_tsk_mgmt *tsk_mgmt;
1489 struct srp_event_struct *evt;
1490 struct srp_event_struct *tmp_evt, *found_evt;
1491 union viosrp_iu srp_rsp;
1492 int rsp_rc;
1493 unsigned long flags;
1494 u16 lun = lun_from_dev(cmd->device);
1495 unsigned long wait_switch = 0;
1497 /* First, find this command in our sent list so we can figure
1498 * out the correct tag
1500 spin_lock_irqsave(hostdata->host->host_lock, flags);
1501 wait_switch = jiffies + (init_timeout * HZ);
1502 do {
1503 found_evt = NULL;
1504 list_for_each_entry(tmp_evt, &hostdata->sent, list) {
1505 if (tmp_evt->cmnd == cmd) {
1506 found_evt = tmp_evt;
1507 break;
1511 if (!found_evt) {
1512 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1513 return SUCCESS;
1516 evt = get_event_struct(&hostdata->pool);
1517 if (evt == NULL) {
1518 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1519 sdev_printk(KERN_ERR, cmd->device,
1520 "failed to allocate abort event\n");
1521 return FAILED;
1524 init_event_struct(evt,
1525 sync_completion,
1526 VIOSRP_SRP_FORMAT,
1527 abort_timeout);
1529 tsk_mgmt = &evt->iu.srp.tsk_mgmt;
1531 /* Set up an abort SRP command */
1532 memset(tsk_mgmt, 0x00, sizeof(*tsk_mgmt));
1533 tsk_mgmt->opcode = SRP_TSK_MGMT;
1534 int_to_scsilun(lun, &tsk_mgmt->lun);
1535 tsk_mgmt->tsk_mgmt_func = SRP_TSK_ABORT_TASK;
1536 tsk_mgmt->task_tag = (u64) found_evt;
1538 evt->sync_srp = &srp_rsp;
1540 init_completion(&evt->comp);
1541 rsp_rc = ibmvscsi_send_srp_event(evt, hostdata, abort_timeout * 2);
1543 if (rsp_rc != SCSI_MLQUEUE_HOST_BUSY)
1544 break;
1546 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1547 msleep(10);
1548 spin_lock_irqsave(hostdata->host->host_lock, flags);
1549 } while (time_before(jiffies, wait_switch));
1551 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1553 if (rsp_rc != 0) {
1554 sdev_printk(KERN_ERR, cmd->device,
1555 "failed to send abort() event. rc=%d\n", rsp_rc);
1556 return FAILED;
1559 sdev_printk(KERN_INFO, cmd->device,
1560 "aborting command. lun 0x%llx, tag 0x%llx\n",
1561 (((u64) lun) << 48), (u64) found_evt);
1563 wait_for_completion(&evt->comp);
1565 /* make sure we got a good response */
1566 if (unlikely(srp_rsp.srp.rsp.opcode != SRP_RSP)) {
1567 if (printk_ratelimit())
1568 sdev_printk(KERN_WARNING, cmd->device, "abort bad SRP RSP type %d\n",
1569 srp_rsp.srp.rsp.opcode);
1570 return FAILED;
1573 if (srp_rsp.srp.rsp.flags & SRP_RSP_FLAG_RSPVALID)
1574 rsp_rc = *((int *)srp_rsp.srp.rsp.data);
1575 else
1576 rsp_rc = srp_rsp.srp.rsp.status;
1578 if (rsp_rc) {
1579 if (printk_ratelimit())
1580 sdev_printk(KERN_WARNING, cmd->device,
1581 "abort code %d for task tag 0x%llx\n",
1582 rsp_rc, tsk_mgmt->task_tag);
1583 return FAILED;
1586 /* Because we dropped the spinlock above, it's possible
1587 * The event is no longer in our list. Make sure it didn't
1588 * complete while we were aborting
1590 spin_lock_irqsave(hostdata->host->host_lock, flags);
1591 found_evt = NULL;
1592 list_for_each_entry(tmp_evt, &hostdata->sent, list) {
1593 if (tmp_evt->cmnd == cmd) {
1594 found_evt = tmp_evt;
1595 break;
1599 if (found_evt == NULL) {
1600 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1601 sdev_printk(KERN_INFO, cmd->device, "aborted task tag 0x%llx completed\n",
1602 tsk_mgmt->task_tag);
1603 return SUCCESS;
1606 sdev_printk(KERN_INFO, cmd->device, "successfully aborted task tag 0x%llx\n",
1607 tsk_mgmt->task_tag);
1609 cmd->result = (DID_ABORT << 16);
1610 list_del(&found_evt->list);
1611 unmap_cmd_data(&found_evt->iu.srp.cmd, found_evt,
1612 found_evt->hostdata->dev);
1613 free_event_struct(&found_evt->hostdata->pool, found_evt);
1614 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1615 atomic_inc(&hostdata->request_limit);
1616 return SUCCESS;
1620 * ibmvscsi_eh_device_reset_handler: Reset a single LUN...from scsi host
1621 * template send this over to the server and wait synchronously for the
1622 * response
1624 static int ibmvscsi_eh_device_reset_handler(struct scsi_cmnd *cmd)
1626 struct ibmvscsi_host_data *hostdata = shost_priv(cmd->device->host);
1627 struct srp_tsk_mgmt *tsk_mgmt;
1628 struct srp_event_struct *evt;
1629 struct srp_event_struct *tmp_evt, *pos;
1630 union viosrp_iu srp_rsp;
1631 int rsp_rc;
1632 unsigned long flags;
1633 u16 lun = lun_from_dev(cmd->device);
1634 unsigned long wait_switch = 0;
1636 spin_lock_irqsave(hostdata->host->host_lock, flags);
1637 wait_switch = jiffies + (init_timeout * HZ);
1638 do {
1639 evt = get_event_struct(&hostdata->pool);
1640 if (evt == NULL) {
1641 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1642 sdev_printk(KERN_ERR, cmd->device,
1643 "failed to allocate reset event\n");
1644 return FAILED;
1647 init_event_struct(evt,
1648 sync_completion,
1649 VIOSRP_SRP_FORMAT,
1650 reset_timeout);
1652 tsk_mgmt = &evt->iu.srp.tsk_mgmt;
1654 /* Set up a lun reset SRP command */
1655 memset(tsk_mgmt, 0x00, sizeof(*tsk_mgmt));
1656 tsk_mgmt->opcode = SRP_TSK_MGMT;
1657 int_to_scsilun(lun, &tsk_mgmt->lun);
1658 tsk_mgmt->tsk_mgmt_func = SRP_TSK_LUN_RESET;
1660 evt->sync_srp = &srp_rsp;
1662 init_completion(&evt->comp);
1663 rsp_rc = ibmvscsi_send_srp_event(evt, hostdata, reset_timeout * 2);
1665 if (rsp_rc != SCSI_MLQUEUE_HOST_BUSY)
1666 break;
1668 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1669 msleep(10);
1670 spin_lock_irqsave(hostdata->host->host_lock, flags);
1671 } while (time_before(jiffies, wait_switch));
1673 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1675 if (rsp_rc != 0) {
1676 sdev_printk(KERN_ERR, cmd->device,
1677 "failed to send reset event. rc=%d\n", rsp_rc);
1678 return FAILED;
1681 sdev_printk(KERN_INFO, cmd->device, "resetting device. lun 0x%llx\n",
1682 (((u64) lun) << 48));
1684 wait_for_completion(&evt->comp);
1686 /* make sure we got a good response */
1687 if (unlikely(srp_rsp.srp.rsp.opcode != SRP_RSP)) {
1688 if (printk_ratelimit())
1689 sdev_printk(KERN_WARNING, cmd->device, "reset bad SRP RSP type %d\n",
1690 srp_rsp.srp.rsp.opcode);
1691 return FAILED;
1694 if (srp_rsp.srp.rsp.flags & SRP_RSP_FLAG_RSPVALID)
1695 rsp_rc = *((int *)srp_rsp.srp.rsp.data);
1696 else
1697 rsp_rc = srp_rsp.srp.rsp.status;
1699 if (rsp_rc) {
1700 if (printk_ratelimit())
1701 sdev_printk(KERN_WARNING, cmd->device,
1702 "reset code %d for task tag 0x%llx\n",
1703 rsp_rc, tsk_mgmt->task_tag);
1704 return FAILED;
1707 /* We need to find all commands for this LUN that have not yet been
1708 * responded to, and fail them with DID_RESET
1710 spin_lock_irqsave(hostdata->host->host_lock, flags);
1711 list_for_each_entry_safe(tmp_evt, pos, &hostdata->sent, list) {
1712 if ((tmp_evt->cmnd) && (tmp_evt->cmnd->device == cmd->device)) {
1713 if (tmp_evt->cmnd)
1714 tmp_evt->cmnd->result = (DID_RESET << 16);
1715 list_del(&tmp_evt->list);
1716 unmap_cmd_data(&tmp_evt->iu.srp.cmd, tmp_evt,
1717 tmp_evt->hostdata->dev);
1718 free_event_struct(&tmp_evt->hostdata->pool,
1719 tmp_evt);
1720 atomic_inc(&hostdata->request_limit);
1721 if (tmp_evt->cmnd_done)
1722 tmp_evt->cmnd_done(tmp_evt->cmnd);
1723 else if (tmp_evt->done)
1724 tmp_evt->done(tmp_evt);
1727 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1728 return SUCCESS;
1732 * ibmvscsi_eh_host_reset_handler - Reset the connection to the server
1733 * @cmd: struct scsi_cmnd having problems
1735 static int ibmvscsi_eh_host_reset_handler(struct scsi_cmnd *cmd)
1737 unsigned long wait_switch = 0;
1738 struct ibmvscsi_host_data *hostdata = shost_priv(cmd->device->host);
1740 dev_err(hostdata->dev, "Resetting connection due to error recovery\n");
1742 ibmvscsi_reset_host(hostdata);
1744 for (wait_switch = jiffies + (init_timeout * HZ);
1745 time_before(jiffies, wait_switch) &&
1746 atomic_read(&hostdata->request_limit) < 2;) {
1748 msleep(10);
1751 if (atomic_read(&hostdata->request_limit) <= 0)
1752 return FAILED;
1754 return SUCCESS;
1758 * ibmvscsi_handle_crq: - Handles and frees received events in the CRQ
1759 * @crq: Command/Response queue
1760 * @hostdata: ibmvscsi_host_data of host
1763 static void ibmvscsi_handle_crq(struct viosrp_crq *crq,
1764 struct ibmvscsi_host_data *hostdata)
1766 long rc;
1767 unsigned long flags;
1768 /* The hypervisor copies our tag value here so no byteswapping */
1769 struct srp_event_struct *evt_struct =
1770 (__force struct srp_event_struct *)crq->IU_data_ptr;
1771 switch (crq->valid) {
1772 case VIOSRP_CRQ_INIT_RSP: /* initialization */
1773 switch (crq->format) {
1774 case VIOSRP_CRQ_INIT: /* Initialization message */
1775 dev_info(hostdata->dev, "partner initialized\n");
1776 /* Send back a response */
1777 rc = ibmvscsi_send_crq(hostdata, 0xC002000000000000LL, 0);
1778 if (rc == 0) {
1779 /* Now login */
1780 init_adapter(hostdata);
1781 } else {
1782 dev_err(hostdata->dev, "Unable to send init rsp. rc=%ld\n", rc);
1785 break;
1786 case VIOSRP_CRQ_INIT_COMPLETE: /* Initialization response */
1787 dev_info(hostdata->dev, "partner initialization complete\n");
1789 /* Now login */
1790 init_adapter(hostdata);
1791 break;
1792 default:
1793 dev_err(hostdata->dev, "unknown crq message type: %d\n", crq->format);
1795 return;
1796 case VIOSRP_CRQ_XPORT_EVENT: /* Hypervisor telling us the connection is closed */
1797 scsi_block_requests(hostdata->host);
1798 atomic_set(&hostdata->request_limit, 0);
1799 if (crq->format == 0x06) {
1800 /* We need to re-setup the interpartition connection */
1801 dev_info(hostdata->dev, "Re-enabling adapter!\n");
1802 hostdata->client_migrated = 1;
1803 hostdata->reenable_crq = 1;
1804 purge_requests(hostdata, DID_REQUEUE);
1805 wake_up(&hostdata->work_wait_q);
1806 } else {
1807 dev_err(hostdata->dev, "Virtual adapter failed rc %d!\n",
1808 crq->format);
1809 ibmvscsi_reset_host(hostdata);
1811 return;
1812 case VIOSRP_CRQ_CMD_RSP: /* real payload */
1813 break;
1814 default:
1815 dev_err(hostdata->dev, "got an invalid message type 0x%02x\n",
1816 crq->valid);
1817 return;
1820 /* The only kind of payload CRQs we should get are responses to
1821 * things we send. Make sure this response is to something we
1822 * actually sent
1824 if (!valid_event_struct(&hostdata->pool, evt_struct)) {
1825 dev_err(hostdata->dev, "returned correlation_token 0x%p is invalid!\n",
1826 evt_struct);
1827 return;
1830 if (atomic_read(&evt_struct->free)) {
1831 dev_err(hostdata->dev, "received duplicate correlation_token 0x%p!\n",
1832 evt_struct);
1833 return;
1836 if (crq->format == VIOSRP_SRP_FORMAT)
1837 atomic_add(be32_to_cpu(evt_struct->xfer_iu->srp.rsp.req_lim_delta),
1838 &hostdata->request_limit);
1840 del_timer(&evt_struct->timer);
1842 if ((crq->status != VIOSRP_OK && crq->status != VIOSRP_OK2) && evt_struct->cmnd)
1843 evt_struct->cmnd->result = DID_ERROR << 16;
1844 if (evt_struct->done)
1845 evt_struct->done(evt_struct);
1846 else
1847 dev_err(hostdata->dev, "returned done() is NULL; not running it!\n");
1850 * Lock the host_lock before messing with these structures, since we
1851 * are running in a task context
1853 spin_lock_irqsave(evt_struct->hostdata->host->host_lock, flags);
1854 list_del(&evt_struct->list);
1855 free_event_struct(&evt_struct->hostdata->pool, evt_struct);
1856 spin_unlock_irqrestore(evt_struct->hostdata->host->host_lock, flags);
1860 * ibmvscsi_slave_configure: Set the "allow_restart" flag for each disk.
1861 * @sdev: struct scsi_device device to configure
1863 * Enable allow_restart for a device if it is a disk. Adjust the
1864 * queue_depth here also as is required by the documentation for
1865 * struct scsi_host_template.
1867 static int ibmvscsi_slave_configure(struct scsi_device *sdev)
1869 struct Scsi_Host *shost = sdev->host;
1870 unsigned long lock_flags = 0;
1872 spin_lock_irqsave(shost->host_lock, lock_flags);
1873 if (sdev->type == TYPE_DISK) {
1874 sdev->allow_restart = 1;
1875 blk_queue_rq_timeout(sdev->request_queue, 120 * HZ);
1877 spin_unlock_irqrestore(shost->host_lock, lock_flags);
1878 return 0;
1882 * ibmvscsi_change_queue_depth - Change the device's queue depth
1883 * @sdev: scsi device struct
1884 * @qdepth: depth to set
1885 * @reason: calling context
1887 * Return value:
1888 * actual depth set
1890 static int ibmvscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
1892 if (qdepth > IBMVSCSI_MAX_CMDS_PER_LUN)
1893 qdepth = IBMVSCSI_MAX_CMDS_PER_LUN;
1894 return scsi_change_queue_depth(sdev, qdepth);
1897 /* ------------------------------------------------------------
1898 * sysfs attributes
1900 static ssize_t show_host_vhost_loc(struct device *dev,
1901 struct device_attribute *attr, char *buf)
1903 struct Scsi_Host *shost = class_to_shost(dev);
1904 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1905 int len;
1907 len = snprintf(buf, sizeof(hostdata->caps.loc), "%s\n",
1908 hostdata->caps.loc);
1909 return len;
1912 static struct device_attribute ibmvscsi_host_vhost_loc = {
1913 .attr = {
1914 .name = "vhost_loc",
1915 .mode = S_IRUGO,
1917 .show = show_host_vhost_loc,
1920 static ssize_t show_host_vhost_name(struct device *dev,
1921 struct device_attribute *attr, char *buf)
1923 struct Scsi_Host *shost = class_to_shost(dev);
1924 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1925 int len;
1927 len = snprintf(buf, sizeof(hostdata->caps.name), "%s\n",
1928 hostdata->caps.name);
1929 return len;
1932 static struct device_attribute ibmvscsi_host_vhost_name = {
1933 .attr = {
1934 .name = "vhost_name",
1935 .mode = S_IRUGO,
1937 .show = show_host_vhost_name,
1940 static ssize_t show_host_srp_version(struct device *dev,
1941 struct device_attribute *attr, char *buf)
1943 struct Scsi_Host *shost = class_to_shost(dev);
1944 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1945 int len;
1947 len = snprintf(buf, PAGE_SIZE, "%s\n",
1948 hostdata->madapter_info.srp_version);
1949 return len;
1952 static struct device_attribute ibmvscsi_host_srp_version = {
1953 .attr = {
1954 .name = "srp_version",
1955 .mode = S_IRUGO,
1957 .show = show_host_srp_version,
1960 static ssize_t show_host_partition_name(struct device *dev,
1961 struct device_attribute *attr,
1962 char *buf)
1964 struct Scsi_Host *shost = class_to_shost(dev);
1965 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1966 int len;
1968 len = snprintf(buf, PAGE_SIZE, "%s\n",
1969 hostdata->madapter_info.partition_name);
1970 return len;
1973 static struct device_attribute ibmvscsi_host_partition_name = {
1974 .attr = {
1975 .name = "partition_name",
1976 .mode = S_IRUGO,
1978 .show = show_host_partition_name,
1981 static ssize_t show_host_partition_number(struct device *dev,
1982 struct device_attribute *attr,
1983 char *buf)
1985 struct Scsi_Host *shost = class_to_shost(dev);
1986 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1987 int len;
1989 len = snprintf(buf, PAGE_SIZE, "%d\n",
1990 be32_to_cpu(hostdata->madapter_info.partition_number));
1991 return len;
1994 static struct device_attribute ibmvscsi_host_partition_number = {
1995 .attr = {
1996 .name = "partition_number",
1997 .mode = S_IRUGO,
1999 .show = show_host_partition_number,
2002 static ssize_t show_host_mad_version(struct device *dev,
2003 struct device_attribute *attr, char *buf)
2005 struct Scsi_Host *shost = class_to_shost(dev);
2006 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
2007 int len;
2009 len = snprintf(buf, PAGE_SIZE, "%d\n",
2010 be32_to_cpu(hostdata->madapter_info.mad_version));
2011 return len;
2014 static struct device_attribute ibmvscsi_host_mad_version = {
2015 .attr = {
2016 .name = "mad_version",
2017 .mode = S_IRUGO,
2019 .show = show_host_mad_version,
2022 static ssize_t show_host_os_type(struct device *dev,
2023 struct device_attribute *attr, char *buf)
2025 struct Scsi_Host *shost = class_to_shost(dev);
2026 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
2027 int len;
2029 len = snprintf(buf, PAGE_SIZE, "%d\n",
2030 be32_to_cpu(hostdata->madapter_info.os_type));
2031 return len;
2034 static struct device_attribute ibmvscsi_host_os_type = {
2035 .attr = {
2036 .name = "os_type",
2037 .mode = S_IRUGO,
2039 .show = show_host_os_type,
2042 static ssize_t show_host_config(struct device *dev,
2043 struct device_attribute *attr, char *buf)
2045 return 0;
2048 static struct device_attribute ibmvscsi_host_config = {
2049 .attr = {
2050 .name = "config",
2051 .mode = S_IRUGO,
2053 .show = show_host_config,
2056 static struct device_attribute *ibmvscsi_attrs[] = {
2057 &ibmvscsi_host_vhost_loc,
2058 &ibmvscsi_host_vhost_name,
2059 &ibmvscsi_host_srp_version,
2060 &ibmvscsi_host_partition_name,
2061 &ibmvscsi_host_partition_number,
2062 &ibmvscsi_host_mad_version,
2063 &ibmvscsi_host_os_type,
2064 &ibmvscsi_host_config,
2065 NULL
2068 /* ------------------------------------------------------------
2069 * SCSI driver registration
2071 static struct scsi_host_template driver_template = {
2072 .module = THIS_MODULE,
2073 .name = "IBM POWER Virtual SCSI Adapter " IBMVSCSI_VERSION,
2074 .proc_name = "ibmvscsi",
2075 .queuecommand = ibmvscsi_queuecommand,
2076 .eh_timed_out = srp_timed_out,
2077 .eh_abort_handler = ibmvscsi_eh_abort_handler,
2078 .eh_device_reset_handler = ibmvscsi_eh_device_reset_handler,
2079 .eh_host_reset_handler = ibmvscsi_eh_host_reset_handler,
2080 .slave_configure = ibmvscsi_slave_configure,
2081 .change_queue_depth = ibmvscsi_change_queue_depth,
2082 .cmd_per_lun = IBMVSCSI_CMDS_PER_LUN_DEFAULT,
2083 .can_queue = IBMVSCSI_MAX_REQUESTS_DEFAULT,
2084 .this_id = -1,
2085 .sg_tablesize = SG_ALL,
2086 .use_clustering = ENABLE_CLUSTERING,
2087 .shost_attrs = ibmvscsi_attrs,
2091 * ibmvscsi_get_desired_dma - Calculate IO memory desired by the driver
2093 * @vdev: struct vio_dev for the device whose desired IO mem is to be returned
2095 * Return value:
2096 * Number of bytes of IO data the driver will need to perform well.
2098 static unsigned long ibmvscsi_get_desired_dma(struct vio_dev *vdev)
2100 /* iu_storage data allocated in initialize_event_pool */
2101 unsigned long desired_io = max_events * sizeof(union viosrp_iu);
2103 /* add io space for sg data */
2104 desired_io += (IBMVSCSI_MAX_SECTORS_DEFAULT * 512 *
2105 IBMVSCSI_CMDS_PER_LUN_DEFAULT);
2107 return desired_io;
2110 static void ibmvscsi_do_work(struct ibmvscsi_host_data *hostdata)
2112 int rc;
2113 char *action = "reset";
2115 if (hostdata->reset_crq) {
2116 smp_rmb();
2117 hostdata->reset_crq = 0;
2119 rc = ibmvscsi_reset_crq_queue(&hostdata->queue, hostdata);
2120 if (!rc)
2121 rc = ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0);
2122 vio_enable_interrupts(to_vio_dev(hostdata->dev));
2123 } else if (hostdata->reenable_crq) {
2124 smp_rmb();
2125 action = "enable";
2126 rc = ibmvscsi_reenable_crq_queue(&hostdata->queue, hostdata);
2127 hostdata->reenable_crq = 0;
2128 if (!rc)
2129 rc = ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0);
2130 } else
2131 return;
2133 if (rc) {
2134 atomic_set(&hostdata->request_limit, -1);
2135 dev_err(hostdata->dev, "error after %s\n", action);
2138 scsi_unblock_requests(hostdata->host);
2141 static int ibmvscsi_work_to_do(struct ibmvscsi_host_data *hostdata)
2143 if (kthread_should_stop())
2144 return 1;
2145 else if (hostdata->reset_crq) {
2146 smp_rmb();
2147 return 1;
2148 } else if (hostdata->reenable_crq) {
2149 smp_rmb();
2150 return 1;
2153 return 0;
2156 static int ibmvscsi_work(void *data)
2158 struct ibmvscsi_host_data *hostdata = data;
2159 int rc;
2161 set_user_nice(current, MIN_NICE);
2163 while (1) {
2164 rc = wait_event_interruptible(hostdata->work_wait_q,
2165 ibmvscsi_work_to_do(hostdata));
2167 BUG_ON(rc);
2169 if (kthread_should_stop())
2170 break;
2172 ibmvscsi_do_work(hostdata);
2175 return 0;
2179 * Called by bus code for each adapter
2181 static int ibmvscsi_probe(struct vio_dev *vdev, const struct vio_device_id *id)
2183 struct ibmvscsi_host_data *hostdata;
2184 struct Scsi_Host *host;
2185 struct device *dev = &vdev->dev;
2186 struct srp_rport_identifiers ids;
2187 struct srp_rport *rport;
2188 unsigned long wait_switch = 0;
2189 int rc;
2191 dev_set_drvdata(&vdev->dev, NULL);
2193 host = scsi_host_alloc(&driver_template, sizeof(*hostdata));
2194 if (!host) {
2195 dev_err(&vdev->dev, "couldn't allocate host data\n");
2196 goto scsi_host_alloc_failed;
2199 host->transportt = ibmvscsi_transport_template;
2200 hostdata = shost_priv(host);
2201 memset(hostdata, 0x00, sizeof(*hostdata));
2202 INIT_LIST_HEAD(&hostdata->sent);
2203 init_waitqueue_head(&hostdata->work_wait_q);
2204 hostdata->host = host;
2205 hostdata->dev = dev;
2206 atomic_set(&hostdata->request_limit, -1);
2207 hostdata->host->max_sectors = IBMVSCSI_MAX_SECTORS_DEFAULT;
2209 if (map_persist_bufs(hostdata)) {
2210 dev_err(&vdev->dev, "couldn't map persistent buffers\n");
2211 goto persist_bufs_failed;
2214 hostdata->work_thread = kthread_run(ibmvscsi_work, hostdata, "%s_%d",
2215 "ibmvscsi", host->host_no);
2217 if (IS_ERR(hostdata->work_thread)) {
2218 dev_err(&vdev->dev, "couldn't initialize kthread. rc=%ld\n",
2219 PTR_ERR(hostdata->work_thread));
2220 goto init_crq_failed;
2223 rc = ibmvscsi_init_crq_queue(&hostdata->queue, hostdata, max_events);
2224 if (rc != 0 && rc != H_RESOURCE) {
2225 dev_err(&vdev->dev, "couldn't initialize crq. rc=%d\n", rc);
2226 goto kill_kthread;
2228 if (initialize_event_pool(&hostdata->pool, max_events, hostdata) != 0) {
2229 dev_err(&vdev->dev, "couldn't initialize event pool\n");
2230 goto init_pool_failed;
2233 host->max_lun = IBMVSCSI_MAX_LUN;
2234 host->max_id = max_id;
2235 host->max_channel = max_channel;
2236 host->max_cmd_len = 16;
2238 dev_info(dev,
2239 "Maximum ID: %d Maximum LUN: %llu Maximum Channel: %d\n",
2240 host->max_id, host->max_lun, host->max_channel);
2242 if (scsi_add_host(hostdata->host, hostdata->dev))
2243 goto add_host_failed;
2245 /* we don't have a proper target_port_id so let's use the fake one */
2246 memcpy(ids.port_id, hostdata->madapter_info.partition_name,
2247 sizeof(ids.port_id));
2248 ids.roles = SRP_RPORT_ROLE_TARGET;
2249 rport = srp_rport_add(host, &ids);
2250 if (IS_ERR(rport))
2251 goto add_srp_port_failed;
2253 /* Try to send an initialization message. Note that this is allowed
2254 * to fail if the other end is not acive. In that case we don't
2255 * want to scan
2257 if (ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0) == 0
2258 || rc == H_RESOURCE) {
2260 * Wait around max init_timeout secs for the adapter to finish
2261 * initializing. When we are done initializing, we will have a
2262 * valid request_limit. We don't want Linux scanning before
2263 * we are ready.
2265 for (wait_switch = jiffies + (init_timeout * HZ);
2266 time_before(jiffies, wait_switch) &&
2267 atomic_read(&hostdata->request_limit) < 2;) {
2269 msleep(10);
2272 /* if we now have a valid request_limit, initiate a scan */
2273 if (atomic_read(&hostdata->request_limit) > 0)
2274 scsi_scan_host(host);
2277 dev_set_drvdata(&vdev->dev, hostdata);
2278 spin_lock(&ibmvscsi_driver_lock);
2279 list_add_tail(&hostdata->host_list, &ibmvscsi_head);
2280 spin_unlock(&ibmvscsi_driver_lock);
2281 return 0;
2283 add_srp_port_failed:
2284 scsi_remove_host(hostdata->host);
2285 add_host_failed:
2286 release_event_pool(&hostdata->pool, hostdata);
2287 init_pool_failed:
2288 ibmvscsi_release_crq_queue(&hostdata->queue, hostdata, max_events);
2289 kill_kthread:
2290 kthread_stop(hostdata->work_thread);
2291 init_crq_failed:
2292 unmap_persist_bufs(hostdata);
2293 persist_bufs_failed:
2294 scsi_host_put(host);
2295 scsi_host_alloc_failed:
2296 return -1;
2299 static int ibmvscsi_remove(struct vio_dev *vdev)
2301 struct ibmvscsi_host_data *hostdata = dev_get_drvdata(&vdev->dev);
2302 unsigned long flags;
2304 srp_remove_host(hostdata->host);
2305 scsi_remove_host(hostdata->host);
2307 purge_requests(hostdata, DID_ERROR);
2309 spin_lock_irqsave(hostdata->host->host_lock, flags);
2310 release_event_pool(&hostdata->pool, hostdata);
2311 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
2313 ibmvscsi_release_crq_queue(&hostdata->queue, hostdata,
2314 max_events);
2316 kthread_stop(hostdata->work_thread);
2317 unmap_persist_bufs(hostdata);
2319 spin_lock(&ibmvscsi_driver_lock);
2320 list_del(&hostdata->host_list);
2321 spin_unlock(&ibmvscsi_driver_lock);
2323 scsi_host_put(hostdata->host);
2325 return 0;
2329 * ibmvscsi_resume: Resume from suspend
2330 * @dev: device struct
2332 * We may have lost an interrupt across suspend/resume, so kick the
2333 * interrupt handler
2335 static int ibmvscsi_resume(struct device *dev)
2337 struct ibmvscsi_host_data *hostdata = dev_get_drvdata(dev);
2338 vio_disable_interrupts(to_vio_dev(hostdata->dev));
2339 tasklet_schedule(&hostdata->srp_task);
2341 return 0;
2345 * ibmvscsi_device_table: Used by vio.c to match devices in the device tree we
2346 * support.
2348 static const struct vio_device_id ibmvscsi_device_table[] = {
2349 {"vscsi", "IBM,v-scsi"},
2350 { "", "" }
2352 MODULE_DEVICE_TABLE(vio, ibmvscsi_device_table);
2354 static const struct dev_pm_ops ibmvscsi_pm_ops = {
2355 .resume = ibmvscsi_resume
2358 static struct vio_driver ibmvscsi_driver = {
2359 .id_table = ibmvscsi_device_table,
2360 .probe = ibmvscsi_probe,
2361 .remove = ibmvscsi_remove,
2362 .get_desired_dma = ibmvscsi_get_desired_dma,
2363 .name = "ibmvscsi",
2364 .pm = &ibmvscsi_pm_ops,
2367 static struct srp_function_template ibmvscsi_transport_functions = {
2370 int __init ibmvscsi_module_init(void)
2372 int ret;
2374 /* Ensure we have two requests to do error recovery */
2375 driver_template.can_queue = max_requests;
2376 max_events = max_requests + 2;
2378 if (!firmware_has_feature(FW_FEATURE_VIO))
2379 return -ENODEV;
2381 ibmvscsi_transport_template =
2382 srp_attach_transport(&ibmvscsi_transport_functions);
2383 if (!ibmvscsi_transport_template)
2384 return -ENOMEM;
2386 ret = vio_register_driver(&ibmvscsi_driver);
2387 if (ret)
2388 srp_release_transport(ibmvscsi_transport_template);
2389 return ret;
2392 void __exit ibmvscsi_module_exit(void)
2394 vio_unregister_driver(&ibmvscsi_driver);
2395 srp_release_transport(ibmvscsi_transport_template);
2398 module_init(ibmvscsi_module_init);
2399 module_exit(ibmvscsi_module_exit);