Linux 4.16.11
[linux/fpc-iii.git] / drivers / scsi / ibmvscsi / ibmvscsi.c
blob17df76f0be3c5212798f106539ccea6883fbe495
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[97] = "UNKNOWN";
97 static unsigned int partition_number = -1;
98 static LIST_HEAD(ibmvscsi_head);
100 static struct scsi_transport_template *ibmvscsi_transport_template;
102 #define IBMVSCSI_VERSION "1.5.9"
104 MODULE_DESCRIPTION("IBM Virtual SCSI");
105 MODULE_AUTHOR("Dave Boutcher");
106 MODULE_LICENSE("GPL");
107 MODULE_VERSION(IBMVSCSI_VERSION);
109 module_param_named(max_id, max_id, int, S_IRUGO | S_IWUSR);
110 MODULE_PARM_DESC(max_id, "Largest ID value for each channel [Default=64]");
111 module_param_named(max_channel, max_channel, int, S_IRUGO | S_IWUSR);
112 MODULE_PARM_DESC(max_channel, "Largest channel value [Default=3]");
113 module_param_named(init_timeout, init_timeout, int, S_IRUGO | S_IWUSR);
114 MODULE_PARM_DESC(init_timeout, "Initialization timeout in seconds");
115 module_param_named(max_requests, max_requests, int, S_IRUGO);
116 MODULE_PARM_DESC(max_requests, "Maximum requests for this adapter");
117 module_param_named(fast_fail, fast_fail, int, S_IRUGO | S_IWUSR);
118 MODULE_PARM_DESC(fast_fail, "Enable fast fail. [Default=1]");
119 module_param_named(client_reserve, client_reserve, int, S_IRUGO );
120 MODULE_PARM_DESC(client_reserve, "Attempt client managed reserve/release");
122 static void ibmvscsi_handle_crq(struct viosrp_crq *crq,
123 struct ibmvscsi_host_data *hostdata);
125 /* ------------------------------------------------------------
126 * Routines for managing the command/response queue
129 * ibmvscsi_handle_event: - Interrupt handler for crq events
130 * @irq: number of irq to handle, not used
131 * @dev_instance: ibmvscsi_host_data of host that received interrupt
133 * Disables interrupts and schedules srp_task
134 * Always returns IRQ_HANDLED
136 static irqreturn_t ibmvscsi_handle_event(int irq, void *dev_instance)
138 struct ibmvscsi_host_data *hostdata =
139 (struct ibmvscsi_host_data *)dev_instance;
140 vio_disable_interrupts(to_vio_dev(hostdata->dev));
141 tasklet_schedule(&hostdata->srp_task);
142 return IRQ_HANDLED;
146 * release_crq_queue: - Deallocates data and unregisters CRQ
147 * @queue: crq_queue to initialize and register
148 * @host_data: ibmvscsi_host_data of host
150 * Frees irq, deallocates a page for messages, unmaps dma, and unregisters
151 * the crq with the hypervisor.
153 static void ibmvscsi_release_crq_queue(struct crq_queue *queue,
154 struct ibmvscsi_host_data *hostdata,
155 int max_requests)
157 long rc = 0;
158 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
159 free_irq(vdev->irq, (void *)hostdata);
160 tasklet_kill(&hostdata->srp_task);
161 do {
162 if (rc)
163 msleep(100);
164 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
165 } while ((rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
166 dma_unmap_single(hostdata->dev,
167 queue->msg_token,
168 queue->size * sizeof(*queue->msgs), DMA_BIDIRECTIONAL);
169 free_page((unsigned long)queue->msgs);
173 * crq_queue_next_crq: - Returns the next entry in message queue
174 * @queue: crq_queue to use
176 * Returns pointer to next entry in queue, or NULL if there are no new
177 * entried in the CRQ.
179 static struct viosrp_crq *crq_queue_next_crq(struct crq_queue *queue)
181 struct viosrp_crq *crq;
182 unsigned long flags;
184 spin_lock_irqsave(&queue->lock, flags);
185 crq = &queue->msgs[queue->cur];
186 if (crq->valid != VIOSRP_CRQ_FREE) {
187 if (++queue->cur == queue->size)
188 queue->cur = 0;
190 /* Ensure the read of the valid bit occurs before reading any
191 * other bits of the CRQ entry
193 rmb();
194 } else
195 crq = NULL;
196 spin_unlock_irqrestore(&queue->lock, flags);
198 return crq;
202 * ibmvscsi_send_crq: - Send a CRQ
203 * @hostdata: the adapter
204 * @word1: the first 64 bits of the data
205 * @word2: the second 64 bits of the data
207 static int ibmvscsi_send_crq(struct ibmvscsi_host_data *hostdata,
208 u64 word1, u64 word2)
210 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
213 * Ensure the command buffer is flushed to memory before handing it
214 * over to the VIOS to prevent it from fetching any stale data.
216 mb();
217 return plpar_hcall_norets(H_SEND_CRQ, vdev->unit_address, word1, word2);
221 * ibmvscsi_task: - Process srps asynchronously
222 * @data: ibmvscsi_host_data of host
224 static void ibmvscsi_task(void *data)
226 struct ibmvscsi_host_data *hostdata = (struct ibmvscsi_host_data *)data;
227 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
228 struct viosrp_crq *crq;
229 int done = 0;
231 while (!done) {
232 /* Pull all the valid messages off the CRQ */
233 while ((crq = crq_queue_next_crq(&hostdata->queue)) != NULL) {
234 ibmvscsi_handle_crq(crq, hostdata);
235 crq->valid = VIOSRP_CRQ_FREE;
236 wmb();
239 vio_enable_interrupts(vdev);
240 crq = crq_queue_next_crq(&hostdata->queue);
241 if (crq != NULL) {
242 vio_disable_interrupts(vdev);
243 ibmvscsi_handle_crq(crq, hostdata);
244 crq->valid = VIOSRP_CRQ_FREE;
245 wmb();
246 } else {
247 done = 1;
252 static void gather_partition_info(void)
254 const char *ppartition_name;
255 const __be32 *p_number_ptr;
257 /* Retrieve information about this partition */
258 if (!of_root)
259 return;
261 of_node_get(of_root);
263 ppartition_name = of_get_property(of_root, "ibm,partition-name", NULL);
264 if (ppartition_name)
265 strncpy(partition_name, ppartition_name,
266 sizeof(partition_name));
267 p_number_ptr = of_get_property(of_root, "ibm,partition-no", NULL);
268 if (p_number_ptr)
269 partition_number = of_read_number(p_number_ptr, 1);
270 of_node_put(of_root);
273 static void set_adapter_info(struct ibmvscsi_host_data *hostdata)
275 memset(&hostdata->madapter_info, 0x00,
276 sizeof(hostdata->madapter_info));
278 dev_info(hostdata->dev, "SRP_VERSION: %s\n", SRP_VERSION);
279 strcpy(hostdata->madapter_info.srp_version, SRP_VERSION);
281 strncpy(hostdata->madapter_info.partition_name, partition_name,
282 sizeof(hostdata->madapter_info.partition_name));
284 hostdata->madapter_info.partition_number =
285 cpu_to_be32(partition_number);
287 hostdata->madapter_info.mad_version = cpu_to_be32(SRP_MAD_VERSION_1);
288 hostdata->madapter_info.os_type = cpu_to_be32(SRP_MAD_OS_LINUX);
292 * reset_crq_queue: - resets a crq after a failure
293 * @queue: crq_queue to initialize and register
294 * @hostdata: ibmvscsi_host_data of host
297 static int ibmvscsi_reset_crq_queue(struct crq_queue *queue,
298 struct ibmvscsi_host_data *hostdata)
300 int rc = 0;
301 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
303 /* Close the CRQ */
304 do {
305 if (rc)
306 msleep(100);
307 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
308 } while ((rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
310 /* Clean out the queue */
311 memset(queue->msgs, 0x00, PAGE_SIZE);
312 queue->cur = 0;
314 set_adapter_info(hostdata);
316 /* And re-open it again */
317 rc = plpar_hcall_norets(H_REG_CRQ,
318 vdev->unit_address,
319 queue->msg_token, PAGE_SIZE);
320 if (rc == H_CLOSED) {
321 /* Adapter is good, but other end is not ready */
322 dev_warn(hostdata->dev, "Partner adapter not ready\n");
323 } else if (rc != 0) {
324 dev_warn(hostdata->dev, "couldn't register crq--rc 0x%x\n", rc);
326 return rc;
330 * initialize_crq_queue: - Initializes and registers CRQ with hypervisor
331 * @queue: crq_queue to initialize and register
332 * @hostdata: ibmvscsi_host_data of host
334 * Allocates a page for messages, maps it for dma, and registers
335 * the crq with the hypervisor.
336 * Returns zero on success.
338 static int ibmvscsi_init_crq_queue(struct crq_queue *queue,
339 struct ibmvscsi_host_data *hostdata,
340 int max_requests)
342 int rc;
343 int retrc;
344 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
346 queue->msgs = (struct viosrp_crq *)get_zeroed_page(GFP_KERNEL);
348 if (!queue->msgs)
349 goto malloc_failed;
350 queue->size = PAGE_SIZE / sizeof(*queue->msgs);
352 queue->msg_token = dma_map_single(hostdata->dev, queue->msgs,
353 queue->size * sizeof(*queue->msgs),
354 DMA_BIDIRECTIONAL);
356 if (dma_mapping_error(hostdata->dev, queue->msg_token))
357 goto map_failed;
359 gather_partition_info();
360 set_adapter_info(hostdata);
362 retrc = rc = plpar_hcall_norets(H_REG_CRQ,
363 vdev->unit_address,
364 queue->msg_token, PAGE_SIZE);
365 if (rc == H_RESOURCE)
366 /* maybe kexecing and resource is busy. try a reset */
367 rc = ibmvscsi_reset_crq_queue(queue,
368 hostdata);
370 if (rc == H_CLOSED) {
371 /* Adapter is good, but other end is not ready */
372 dev_warn(hostdata->dev, "Partner adapter not ready\n");
373 retrc = 0;
374 } else if (rc != 0) {
375 dev_warn(hostdata->dev, "Error %d opening adapter\n", rc);
376 goto reg_crq_failed;
379 queue->cur = 0;
380 spin_lock_init(&queue->lock);
382 tasklet_init(&hostdata->srp_task, (void *)ibmvscsi_task,
383 (unsigned long)hostdata);
385 if (request_irq(vdev->irq,
386 ibmvscsi_handle_event,
387 0, "ibmvscsi", (void *)hostdata) != 0) {
388 dev_err(hostdata->dev, "couldn't register irq 0x%x\n",
389 vdev->irq);
390 goto req_irq_failed;
393 rc = vio_enable_interrupts(vdev);
394 if (rc != 0) {
395 dev_err(hostdata->dev, "Error %d enabling interrupts!!!\n", rc);
396 goto req_irq_failed;
399 return retrc;
401 req_irq_failed:
402 tasklet_kill(&hostdata->srp_task);
403 rc = 0;
404 do {
405 if (rc)
406 msleep(100);
407 rc = plpar_hcall_norets(H_FREE_CRQ, vdev->unit_address);
408 } while ((rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
409 reg_crq_failed:
410 dma_unmap_single(hostdata->dev,
411 queue->msg_token,
412 queue->size * sizeof(*queue->msgs), DMA_BIDIRECTIONAL);
413 map_failed:
414 free_page((unsigned long)queue->msgs);
415 malloc_failed:
416 return -1;
420 * reenable_crq_queue: - reenables a crq after
421 * @queue: crq_queue to initialize and register
422 * @hostdata: ibmvscsi_host_data of host
425 static int ibmvscsi_reenable_crq_queue(struct crq_queue *queue,
426 struct ibmvscsi_host_data *hostdata)
428 int rc = 0;
429 struct vio_dev *vdev = to_vio_dev(hostdata->dev);
431 /* Re-enable the CRQ */
432 do {
433 if (rc)
434 msleep(100);
435 rc = plpar_hcall_norets(H_ENABLE_CRQ, vdev->unit_address);
436 } while ((rc == H_IN_PROGRESS) || (rc == H_BUSY) || (H_IS_LONG_BUSY(rc)));
438 if (rc)
439 dev_err(hostdata->dev, "Error %d enabling adapter\n", rc);
440 return rc;
443 /* ------------------------------------------------------------
444 * Routines for the event pool and event structs
447 * initialize_event_pool: - Allocates and initializes the event pool for a host
448 * @pool: event_pool to be initialized
449 * @size: Number of events in pool
450 * @hostdata: ibmvscsi_host_data who owns the event pool
452 * Returns zero on success.
454 static int initialize_event_pool(struct event_pool *pool,
455 int size, struct ibmvscsi_host_data *hostdata)
457 int i;
459 pool->size = size;
460 pool->next = 0;
461 pool->events = kcalloc(pool->size, sizeof(*pool->events), GFP_KERNEL);
462 if (!pool->events)
463 return -ENOMEM;
465 pool->iu_storage =
466 dma_alloc_coherent(hostdata->dev,
467 pool->size * sizeof(*pool->iu_storage),
468 &pool->iu_token, 0);
469 if (!pool->iu_storage) {
470 kfree(pool->events);
471 return -ENOMEM;
474 for (i = 0; i < pool->size; ++i) {
475 struct srp_event_struct *evt = &pool->events[i];
476 memset(&evt->crq, 0x00, sizeof(evt->crq));
477 atomic_set(&evt->free, 1);
478 evt->crq.valid = VIOSRP_CRQ_CMD_RSP;
479 evt->crq.IU_length = cpu_to_be16(sizeof(*evt->xfer_iu));
480 evt->crq.IU_data_ptr = cpu_to_be64(pool->iu_token +
481 sizeof(*evt->xfer_iu) * i);
482 evt->xfer_iu = pool->iu_storage + i;
483 evt->hostdata = hostdata;
484 evt->ext_list = NULL;
485 evt->ext_list_token = 0;
488 return 0;
492 * release_event_pool: - Frees memory of an event pool of a host
493 * @pool: event_pool to be released
494 * @hostdata: ibmvscsi_host_data who owns the even pool
496 * Returns zero on success.
498 static void release_event_pool(struct event_pool *pool,
499 struct ibmvscsi_host_data *hostdata)
501 int i, in_use = 0;
502 for (i = 0; i < pool->size; ++i) {
503 if (atomic_read(&pool->events[i].free) != 1)
504 ++in_use;
505 if (pool->events[i].ext_list) {
506 dma_free_coherent(hostdata->dev,
507 SG_ALL * sizeof(struct srp_direct_buf),
508 pool->events[i].ext_list,
509 pool->events[i].ext_list_token);
512 if (in_use)
513 dev_warn(hostdata->dev, "releasing event pool with %d "
514 "events still in use?\n", in_use);
515 kfree(pool->events);
516 dma_free_coherent(hostdata->dev,
517 pool->size * sizeof(*pool->iu_storage),
518 pool->iu_storage, pool->iu_token);
522 * valid_event_struct: - Determines if event is valid.
523 * @pool: event_pool that contains the event
524 * @evt: srp_event_struct to be checked for validity
526 * Returns zero if event is invalid, one otherwise.
528 static int valid_event_struct(struct event_pool *pool,
529 struct srp_event_struct *evt)
531 int index = evt - pool->events;
532 if (index < 0 || index >= pool->size) /* outside of bounds */
533 return 0;
534 if (evt != pool->events + index) /* unaligned */
535 return 0;
536 return 1;
540 * ibmvscsi_free-event_struct: - Changes status of event to "free"
541 * @pool: event_pool that contains the event
542 * @evt: srp_event_struct to be modified
545 static void free_event_struct(struct event_pool *pool,
546 struct srp_event_struct *evt)
548 if (!valid_event_struct(pool, evt)) {
549 dev_err(evt->hostdata->dev, "Freeing invalid event_struct %p "
550 "(not in pool %p)\n", evt, pool->events);
551 return;
553 if (atomic_inc_return(&evt->free) != 1) {
554 dev_err(evt->hostdata->dev, "Freeing event_struct %p "
555 "which is not in use!\n", evt);
556 return;
561 * get_evt_struct: - Gets the next free event in pool
562 * @pool: event_pool that contains the events to be searched
564 * Returns the next event in "free" state, and NULL if none are free.
565 * Note that no synchronization is done here, we assume the host_lock
566 * will syncrhonze things.
568 static struct srp_event_struct *get_event_struct(struct event_pool *pool)
570 int i;
571 int poolsize = pool->size;
572 int offset = pool->next;
574 for (i = 0; i < poolsize; i++) {
575 offset = (offset + 1) % poolsize;
576 if (!atomic_dec_if_positive(&pool->events[offset].free)) {
577 pool->next = offset;
578 return &pool->events[offset];
582 printk(KERN_ERR "ibmvscsi: found no event struct in pool!\n");
583 return NULL;
587 * init_event_struct: Initialize fields in an event struct that are always
588 * required.
589 * @evt: The event
590 * @done: Routine to call when the event is responded to
591 * @format: SRP or MAD format
592 * @timeout: timeout value set in the CRQ
594 static void init_event_struct(struct srp_event_struct *evt_struct,
595 void (*done) (struct srp_event_struct *),
596 u8 format,
597 int timeout)
599 evt_struct->cmnd = NULL;
600 evt_struct->cmnd_done = NULL;
601 evt_struct->sync_srp = NULL;
602 evt_struct->crq.format = format;
603 evt_struct->crq.timeout = cpu_to_be16(timeout);
604 evt_struct->done = done;
607 /* ------------------------------------------------------------
608 * Routines for receiving SCSI responses from the hosting partition
612 * set_srp_direction: Set the fields in the srp related to data
613 * direction and number of buffers based on the direction in
614 * the scsi_cmnd and the number of buffers
616 static void set_srp_direction(struct scsi_cmnd *cmd,
617 struct srp_cmd *srp_cmd,
618 int numbuf)
620 u8 fmt;
622 if (numbuf == 0)
623 return;
625 if (numbuf == 1)
626 fmt = SRP_DATA_DESC_DIRECT;
627 else {
628 fmt = SRP_DATA_DESC_INDIRECT;
629 numbuf = min(numbuf, MAX_INDIRECT_BUFS);
631 if (cmd->sc_data_direction == DMA_TO_DEVICE)
632 srp_cmd->data_out_desc_cnt = numbuf;
633 else
634 srp_cmd->data_in_desc_cnt = numbuf;
637 if (cmd->sc_data_direction == DMA_TO_DEVICE)
638 srp_cmd->buf_fmt = fmt << 4;
639 else
640 srp_cmd->buf_fmt = fmt;
644 * unmap_cmd_data: - Unmap data pointed in srp_cmd based on the format
645 * @cmd: srp_cmd whose additional_data member will be unmapped
646 * @dev: device for which the memory is mapped
649 static void unmap_cmd_data(struct srp_cmd *cmd,
650 struct srp_event_struct *evt_struct,
651 struct device *dev)
653 u8 out_fmt, in_fmt;
655 out_fmt = cmd->buf_fmt >> 4;
656 in_fmt = cmd->buf_fmt & ((1U << 4) - 1);
658 if (out_fmt == SRP_NO_DATA_DESC && in_fmt == SRP_NO_DATA_DESC)
659 return;
661 if (evt_struct->cmnd)
662 scsi_dma_unmap(evt_struct->cmnd);
665 static int map_sg_list(struct scsi_cmnd *cmd, int nseg,
666 struct srp_direct_buf *md)
668 int i;
669 struct scatterlist *sg;
670 u64 total_length = 0;
672 scsi_for_each_sg(cmd, sg, nseg, i) {
673 struct srp_direct_buf *descr = md + i;
674 descr->va = cpu_to_be64(sg_dma_address(sg));
675 descr->len = cpu_to_be32(sg_dma_len(sg));
676 descr->key = 0;
677 total_length += sg_dma_len(sg);
679 return total_length;
683 * map_sg_data: - Maps dma for a scatterlist and initializes decriptor fields
684 * @cmd: Scsi_Cmnd with the scatterlist
685 * @srp_cmd: srp_cmd that contains the memory descriptor
686 * @dev: device for which to map dma memory
688 * Called by map_data_for_srp_cmd() when building srp cmd from scsi cmd.
689 * Returns 1 on success.
691 static int map_sg_data(struct scsi_cmnd *cmd,
692 struct srp_event_struct *evt_struct,
693 struct srp_cmd *srp_cmd, struct device *dev)
696 int sg_mapped;
697 u64 total_length = 0;
698 struct srp_direct_buf *data =
699 (struct srp_direct_buf *) srp_cmd->add_data;
700 struct srp_indirect_buf *indirect =
701 (struct srp_indirect_buf *) data;
703 sg_mapped = scsi_dma_map(cmd);
704 if (!sg_mapped)
705 return 1;
706 else if (sg_mapped < 0)
707 return 0;
709 set_srp_direction(cmd, srp_cmd, sg_mapped);
711 /* special case; we can use a single direct descriptor */
712 if (sg_mapped == 1) {
713 map_sg_list(cmd, sg_mapped, data);
714 return 1;
717 indirect->table_desc.va = 0;
718 indirect->table_desc.len = cpu_to_be32(sg_mapped *
719 sizeof(struct srp_direct_buf));
720 indirect->table_desc.key = 0;
722 if (sg_mapped <= MAX_INDIRECT_BUFS) {
723 total_length = map_sg_list(cmd, sg_mapped,
724 &indirect->desc_list[0]);
725 indirect->len = cpu_to_be32(total_length);
726 return 1;
729 /* get indirect table */
730 if (!evt_struct->ext_list) {
731 evt_struct->ext_list = (struct srp_direct_buf *)
732 dma_alloc_coherent(dev,
733 SG_ALL * sizeof(struct srp_direct_buf),
734 &evt_struct->ext_list_token, 0);
735 if (!evt_struct->ext_list) {
736 if (!firmware_has_feature(FW_FEATURE_CMO))
737 sdev_printk(KERN_ERR, cmd->device,
738 "Can't allocate memory "
739 "for indirect table\n");
740 scsi_dma_unmap(cmd);
741 return 0;
745 total_length = map_sg_list(cmd, sg_mapped, evt_struct->ext_list);
747 indirect->len = cpu_to_be32(total_length);
748 indirect->table_desc.va = cpu_to_be64(evt_struct->ext_list_token);
749 indirect->table_desc.len = cpu_to_be32(sg_mapped *
750 sizeof(indirect->desc_list[0]));
751 memcpy(indirect->desc_list, evt_struct->ext_list,
752 MAX_INDIRECT_BUFS * sizeof(struct srp_direct_buf));
753 return 1;
757 * map_data_for_srp_cmd: - Calls functions to map data for srp cmds
758 * @cmd: struct scsi_cmnd with the memory to be mapped
759 * @srp_cmd: srp_cmd that contains the memory descriptor
760 * @dev: dma device for which to map dma memory
762 * Called by scsi_cmd_to_srp_cmd() when converting scsi cmds to srp cmds
763 * Returns 1 on success.
765 static int map_data_for_srp_cmd(struct scsi_cmnd *cmd,
766 struct srp_event_struct *evt_struct,
767 struct srp_cmd *srp_cmd, struct device *dev)
769 switch (cmd->sc_data_direction) {
770 case DMA_FROM_DEVICE:
771 case DMA_TO_DEVICE:
772 break;
773 case DMA_NONE:
774 return 1;
775 case DMA_BIDIRECTIONAL:
776 sdev_printk(KERN_ERR, cmd->device,
777 "Can't map DMA_BIDIRECTIONAL to read/write\n");
778 return 0;
779 default:
780 sdev_printk(KERN_ERR, cmd->device,
781 "Unknown data direction 0x%02x; can't map!\n",
782 cmd->sc_data_direction);
783 return 0;
786 return map_sg_data(cmd, evt_struct, srp_cmd, dev);
790 * purge_requests: Our virtual adapter just shut down. purge any sent requests
791 * @hostdata: the adapter
793 static void purge_requests(struct ibmvscsi_host_data *hostdata, int error_code)
795 struct srp_event_struct *evt;
796 unsigned long flags;
798 spin_lock_irqsave(hostdata->host->host_lock, flags);
799 while (!list_empty(&hostdata->sent)) {
800 evt = list_first_entry(&hostdata->sent, struct srp_event_struct, list);
801 list_del(&evt->list);
802 del_timer(&evt->timer);
804 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
805 if (evt->cmnd) {
806 evt->cmnd->result = (error_code << 16);
807 unmap_cmd_data(&evt->iu.srp.cmd, evt,
808 evt->hostdata->dev);
809 if (evt->cmnd_done)
810 evt->cmnd_done(evt->cmnd);
811 } else if (evt->done && evt->crq.format != VIOSRP_MAD_FORMAT &&
812 evt->iu.srp.login_req.opcode != SRP_LOGIN_REQ)
813 evt->done(evt);
814 free_event_struct(&evt->hostdata->pool, evt);
815 spin_lock_irqsave(hostdata->host->host_lock, flags);
817 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
821 * ibmvscsi_reset_host - Reset the connection to the server
822 * @hostdata: struct ibmvscsi_host_data to reset
824 static void ibmvscsi_reset_host(struct ibmvscsi_host_data *hostdata)
826 scsi_block_requests(hostdata->host);
827 atomic_set(&hostdata->request_limit, 0);
829 purge_requests(hostdata, DID_ERROR);
830 hostdata->reset_crq = 1;
831 wake_up(&hostdata->work_wait_q);
835 * ibmvscsi_timeout - Internal command timeout handler
836 * @evt_struct: struct srp_event_struct that timed out
838 * Called when an internally generated command times out
840 static void ibmvscsi_timeout(struct timer_list *t)
842 struct srp_event_struct *evt_struct = from_timer(evt_struct, t, timer);
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 timer_setup(&evt_struct->timer, ibmvscsi_timeout, 0);
932 if (timeout) {
933 evt_struct->timer.expires = jiffies + (timeout * HZ);
934 add_timer(&evt_struct->timer);
937 rc = ibmvscsi_send_crq(hostdata, be64_to_cpu(crq_as_u64[0]),
938 be64_to_cpu(crq_as_u64[1]));
939 if (rc != 0) {
940 list_del(&evt_struct->list);
941 del_timer(&evt_struct->timer);
943 /* If send_crq returns H_CLOSED, return SCSI_MLQUEUE_HOST_BUSY.
944 * Firmware will send a CRQ with a transport event (0xFF) to
945 * tell this client what has happened to the transport. This
946 * will be handled in ibmvscsi_handle_crq()
948 if (rc == H_CLOSED) {
949 dev_warn(hostdata->dev, "send warning. "
950 "Receive queue closed, will retry.\n");
951 goto send_busy;
953 dev_err(hostdata->dev, "send error %d\n", rc);
954 if (srp_req)
955 atomic_inc(&hostdata->request_limit);
956 goto send_error;
959 return 0;
961 send_busy:
962 unmap_cmd_data(&evt_struct->iu.srp.cmd, evt_struct, hostdata->dev);
964 free_event_struct(&hostdata->pool, evt_struct);
965 if (srp_req && request_status != -1)
966 atomic_inc(&hostdata->request_limit);
967 return SCSI_MLQUEUE_HOST_BUSY;
969 send_error:
970 unmap_cmd_data(&evt_struct->iu.srp.cmd, evt_struct, hostdata->dev);
972 if (evt_struct->cmnd != NULL) {
973 evt_struct->cmnd->result = DID_ERROR << 16;
974 evt_struct->cmnd_done(evt_struct->cmnd);
975 } else if (evt_struct->done)
976 evt_struct->done(evt_struct);
978 free_event_struct(&hostdata->pool, evt_struct);
979 return 0;
983 * handle_cmd_rsp: - Handle responses from commands
984 * @evt_struct: srp_event_struct to be handled
986 * Used as a callback by when sending scsi cmds.
987 * Gets called by ibmvscsi_handle_crq()
989 static void handle_cmd_rsp(struct srp_event_struct *evt_struct)
991 struct srp_rsp *rsp = &evt_struct->xfer_iu->srp.rsp;
992 struct scsi_cmnd *cmnd = evt_struct->cmnd;
994 if (unlikely(rsp->opcode != SRP_RSP)) {
995 if (printk_ratelimit())
996 dev_warn(evt_struct->hostdata->dev,
997 "bad SRP RSP type %#02x\n", rsp->opcode);
1000 if (cmnd) {
1001 cmnd->result |= rsp->status;
1002 if (((cmnd->result >> 1) & 0x1f) == CHECK_CONDITION)
1003 memcpy(cmnd->sense_buffer,
1004 rsp->data,
1005 be32_to_cpu(rsp->sense_data_len));
1006 unmap_cmd_data(&evt_struct->iu.srp.cmd,
1007 evt_struct,
1008 evt_struct->hostdata->dev);
1010 if (rsp->flags & SRP_RSP_FLAG_DOOVER)
1011 scsi_set_resid(cmnd,
1012 be32_to_cpu(rsp->data_out_res_cnt));
1013 else if (rsp->flags & SRP_RSP_FLAG_DIOVER)
1014 scsi_set_resid(cmnd, be32_to_cpu(rsp->data_in_res_cnt));
1017 if (evt_struct->cmnd_done)
1018 evt_struct->cmnd_done(cmnd);
1022 * lun_from_dev: - Returns the lun of the scsi device
1023 * @dev: struct scsi_device
1026 static inline u16 lun_from_dev(struct scsi_device *dev)
1028 return (0x2 << 14) | (dev->id << 8) | (dev->channel << 5) | dev->lun;
1032 * ibmvscsi_queue: - The queuecommand function of the scsi template
1033 * @cmd: struct scsi_cmnd to be executed
1034 * @done: Callback function to be called when cmd is completed
1036 static int ibmvscsi_queuecommand_lck(struct scsi_cmnd *cmnd,
1037 void (*done) (struct scsi_cmnd *))
1039 struct srp_cmd *srp_cmd;
1040 struct srp_event_struct *evt_struct;
1041 struct srp_indirect_buf *indirect;
1042 struct ibmvscsi_host_data *hostdata = shost_priv(cmnd->device->host);
1043 u16 lun = lun_from_dev(cmnd->device);
1044 u8 out_fmt, in_fmt;
1046 cmnd->result = (DID_OK << 16);
1047 evt_struct = get_event_struct(&hostdata->pool);
1048 if (!evt_struct)
1049 return SCSI_MLQUEUE_HOST_BUSY;
1051 /* Set up the actual SRP IU */
1052 srp_cmd = &evt_struct->iu.srp.cmd;
1053 memset(srp_cmd, 0x00, SRP_MAX_IU_LEN);
1054 srp_cmd->opcode = SRP_CMD;
1055 memcpy(srp_cmd->cdb, cmnd->cmnd, sizeof(srp_cmd->cdb));
1056 int_to_scsilun(lun, &srp_cmd->lun);
1058 if (!map_data_for_srp_cmd(cmnd, evt_struct, srp_cmd, hostdata->dev)) {
1059 if (!firmware_has_feature(FW_FEATURE_CMO))
1060 sdev_printk(KERN_ERR, cmnd->device,
1061 "couldn't convert cmd to srp_cmd\n");
1062 free_event_struct(&hostdata->pool, evt_struct);
1063 return SCSI_MLQUEUE_HOST_BUSY;
1066 init_event_struct(evt_struct,
1067 handle_cmd_rsp,
1068 VIOSRP_SRP_FORMAT,
1069 cmnd->request->timeout/HZ);
1071 evt_struct->cmnd = cmnd;
1072 evt_struct->cmnd_done = done;
1074 /* Fix up dma address of the buffer itself */
1075 indirect = (struct srp_indirect_buf *) srp_cmd->add_data;
1076 out_fmt = srp_cmd->buf_fmt >> 4;
1077 in_fmt = srp_cmd->buf_fmt & ((1U << 4) - 1);
1078 if ((in_fmt == SRP_DATA_DESC_INDIRECT ||
1079 out_fmt == SRP_DATA_DESC_INDIRECT) &&
1080 indirect->table_desc.va == 0) {
1081 indirect->table_desc.va =
1082 cpu_to_be64(be64_to_cpu(evt_struct->crq.IU_data_ptr) +
1083 offsetof(struct srp_cmd, add_data) +
1084 offsetof(struct srp_indirect_buf, desc_list));
1087 return ibmvscsi_send_srp_event(evt_struct, hostdata, 0);
1090 static DEF_SCSI_QCMD(ibmvscsi_queuecommand)
1092 /* ------------------------------------------------------------
1093 * Routines for driver initialization
1097 * map_persist_bufs: - Pre-map persistent data for adapter logins
1098 * @hostdata: ibmvscsi_host_data of host
1100 * Map the capabilities and adapter info DMA buffers to avoid runtime failures.
1101 * Return 1 on error, 0 on success.
1103 static int map_persist_bufs(struct ibmvscsi_host_data *hostdata)
1106 hostdata->caps_addr = dma_map_single(hostdata->dev, &hostdata->caps,
1107 sizeof(hostdata->caps), DMA_BIDIRECTIONAL);
1109 if (dma_mapping_error(hostdata->dev, hostdata->caps_addr)) {
1110 dev_err(hostdata->dev, "Unable to map capabilities buffer!\n");
1111 return 1;
1114 hostdata->adapter_info_addr = dma_map_single(hostdata->dev,
1115 &hostdata->madapter_info,
1116 sizeof(hostdata->madapter_info),
1117 DMA_BIDIRECTIONAL);
1118 if (dma_mapping_error(hostdata->dev, hostdata->adapter_info_addr)) {
1119 dev_err(hostdata->dev, "Unable to map adapter info buffer!\n");
1120 dma_unmap_single(hostdata->dev, hostdata->caps_addr,
1121 sizeof(hostdata->caps), DMA_BIDIRECTIONAL);
1122 return 1;
1125 return 0;
1129 * unmap_persist_bufs: - Unmap persistent data needed for adapter logins
1130 * @hostdata: ibmvscsi_host_data of host
1132 * Unmap the capabilities and adapter info DMA buffers
1134 static void unmap_persist_bufs(struct ibmvscsi_host_data *hostdata)
1136 dma_unmap_single(hostdata->dev, hostdata->caps_addr,
1137 sizeof(hostdata->caps), DMA_BIDIRECTIONAL);
1139 dma_unmap_single(hostdata->dev, hostdata->adapter_info_addr,
1140 sizeof(hostdata->madapter_info), DMA_BIDIRECTIONAL);
1144 * login_rsp: - Handle response to SRP login request
1145 * @evt_struct: srp_event_struct with the response
1147 * Used as a "done" callback by when sending srp_login. Gets called
1148 * by ibmvscsi_handle_crq()
1150 static void login_rsp(struct srp_event_struct *evt_struct)
1152 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1153 switch (evt_struct->xfer_iu->srp.login_rsp.opcode) {
1154 case SRP_LOGIN_RSP: /* it worked! */
1155 break;
1156 case SRP_LOGIN_REJ: /* refused! */
1157 dev_info(hostdata->dev, "SRP_LOGIN_REJ reason %u\n",
1158 evt_struct->xfer_iu->srp.login_rej.reason);
1159 /* Login failed. */
1160 atomic_set(&hostdata->request_limit, -1);
1161 return;
1162 default:
1163 dev_err(hostdata->dev, "Invalid login response typecode 0x%02x!\n",
1164 evt_struct->xfer_iu->srp.login_rsp.opcode);
1165 /* Login failed. */
1166 atomic_set(&hostdata->request_limit, -1);
1167 return;
1170 dev_info(hostdata->dev, "SRP_LOGIN succeeded\n");
1171 hostdata->client_migrated = 0;
1173 /* Now we know what the real request-limit is.
1174 * This value is set rather than added to request_limit because
1175 * request_limit could have been set to -1 by this client.
1177 atomic_set(&hostdata->request_limit,
1178 be32_to_cpu(evt_struct->xfer_iu->srp.login_rsp.req_lim_delta));
1180 /* If we had any pending I/Os, kick them */
1181 scsi_unblock_requests(hostdata->host);
1185 * send_srp_login: - Sends the srp login
1186 * @hostdata: ibmvscsi_host_data of host
1188 * Returns zero if successful.
1190 static int send_srp_login(struct ibmvscsi_host_data *hostdata)
1192 int rc;
1193 unsigned long flags;
1194 struct srp_login_req *login;
1195 struct srp_event_struct *evt_struct = get_event_struct(&hostdata->pool);
1197 BUG_ON(!evt_struct);
1198 init_event_struct(evt_struct, login_rsp,
1199 VIOSRP_SRP_FORMAT, login_timeout);
1201 login = &evt_struct->iu.srp.login_req;
1202 memset(login, 0, sizeof(*login));
1203 login->opcode = SRP_LOGIN_REQ;
1204 login->req_it_iu_len = cpu_to_be32(sizeof(union srp_iu));
1205 login->req_buf_fmt = cpu_to_be16(SRP_BUF_FORMAT_DIRECT |
1206 SRP_BUF_FORMAT_INDIRECT);
1208 spin_lock_irqsave(hostdata->host->host_lock, flags);
1209 /* Start out with a request limit of 0, since this is negotiated in
1210 * the login request we are just sending and login requests always
1211 * get sent by the driver regardless of request_limit.
1213 atomic_set(&hostdata->request_limit, 0);
1215 rc = ibmvscsi_send_srp_event(evt_struct, hostdata, login_timeout * 2);
1216 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1217 dev_info(hostdata->dev, "sent SRP login\n");
1218 return rc;
1222 * capabilities_rsp: - Handle response to MAD adapter capabilities request
1223 * @evt_struct: srp_event_struct with the response
1225 * Used as a "done" callback by when sending adapter_info.
1227 static void capabilities_rsp(struct srp_event_struct *evt_struct)
1229 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1231 if (evt_struct->xfer_iu->mad.capabilities.common.status) {
1232 dev_err(hostdata->dev, "error 0x%X getting capabilities info\n",
1233 evt_struct->xfer_iu->mad.capabilities.common.status);
1234 } else {
1235 if (hostdata->caps.migration.common.server_support !=
1236 cpu_to_be16(SERVER_SUPPORTS_CAP))
1237 dev_info(hostdata->dev, "Partition migration not supported\n");
1239 if (client_reserve) {
1240 if (hostdata->caps.reserve.common.server_support ==
1241 cpu_to_be16(SERVER_SUPPORTS_CAP))
1242 dev_info(hostdata->dev, "Client reserve enabled\n");
1243 else
1244 dev_info(hostdata->dev, "Client reserve not supported\n");
1248 send_srp_login(hostdata);
1252 * send_mad_capabilities: - Sends the mad capabilities request
1253 * and stores the result so it can be retrieved with
1254 * @hostdata: ibmvscsi_host_data of host
1256 static void send_mad_capabilities(struct ibmvscsi_host_data *hostdata)
1258 struct viosrp_capabilities *req;
1259 struct srp_event_struct *evt_struct;
1260 unsigned long flags;
1261 struct device_node *of_node = hostdata->dev->of_node;
1262 const char *location;
1264 evt_struct = get_event_struct(&hostdata->pool);
1265 BUG_ON(!evt_struct);
1267 init_event_struct(evt_struct, capabilities_rsp,
1268 VIOSRP_MAD_FORMAT, info_timeout);
1270 req = &evt_struct->iu.mad.capabilities;
1271 memset(req, 0, sizeof(*req));
1273 hostdata->caps.flags = cpu_to_be32(CAP_LIST_SUPPORTED);
1274 if (hostdata->client_migrated)
1275 hostdata->caps.flags |= cpu_to_be32(CLIENT_MIGRATED);
1277 strncpy(hostdata->caps.name, dev_name(&hostdata->host->shost_gendev),
1278 sizeof(hostdata->caps.name));
1279 hostdata->caps.name[sizeof(hostdata->caps.name) - 1] = '\0';
1281 location = of_get_property(of_node, "ibm,loc-code", NULL);
1282 location = location ? location : dev_name(hostdata->dev);
1283 strncpy(hostdata->caps.loc, location, sizeof(hostdata->caps.loc));
1284 hostdata->caps.loc[sizeof(hostdata->caps.loc) - 1] = '\0';
1286 req->common.type = cpu_to_be32(VIOSRP_CAPABILITIES_TYPE);
1287 req->buffer = cpu_to_be64(hostdata->caps_addr);
1289 hostdata->caps.migration.common.cap_type =
1290 cpu_to_be32(MIGRATION_CAPABILITIES);
1291 hostdata->caps.migration.common.length =
1292 cpu_to_be16(sizeof(hostdata->caps.migration));
1293 hostdata->caps.migration.common.server_support =
1294 cpu_to_be16(SERVER_SUPPORTS_CAP);
1295 hostdata->caps.migration.ecl = cpu_to_be32(1);
1297 if (client_reserve) {
1298 hostdata->caps.reserve.common.cap_type =
1299 cpu_to_be32(RESERVATION_CAPABILITIES);
1300 hostdata->caps.reserve.common.length =
1301 cpu_to_be16(sizeof(hostdata->caps.reserve));
1302 hostdata->caps.reserve.common.server_support =
1303 cpu_to_be16(SERVER_SUPPORTS_CAP);
1304 hostdata->caps.reserve.type =
1305 cpu_to_be32(CLIENT_RESERVE_SCSI_2);
1306 req->common.length =
1307 cpu_to_be16(sizeof(hostdata->caps));
1308 } else
1309 req->common.length = cpu_to_be16(sizeof(hostdata->caps) -
1310 sizeof(hostdata->caps.reserve));
1312 spin_lock_irqsave(hostdata->host->host_lock, flags);
1313 if (ibmvscsi_send_srp_event(evt_struct, hostdata, info_timeout * 2))
1314 dev_err(hostdata->dev, "couldn't send CAPABILITIES_REQ!\n");
1315 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1319 * fast_fail_rsp: - Handle response to MAD enable fast fail
1320 * @evt_struct: srp_event_struct with the response
1322 * Used as a "done" callback by when sending enable fast fail. Gets called
1323 * by ibmvscsi_handle_crq()
1325 static void fast_fail_rsp(struct srp_event_struct *evt_struct)
1327 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1328 u16 status = be16_to_cpu(evt_struct->xfer_iu->mad.fast_fail.common.status);
1330 if (status == VIOSRP_MAD_NOT_SUPPORTED)
1331 dev_err(hostdata->dev, "fast_fail not supported in server\n");
1332 else if (status == VIOSRP_MAD_FAILED)
1333 dev_err(hostdata->dev, "fast_fail request failed\n");
1334 else if (status != VIOSRP_MAD_SUCCESS)
1335 dev_err(hostdata->dev, "error 0x%X enabling fast_fail\n", status);
1337 send_mad_capabilities(hostdata);
1341 * init_host - Start host initialization
1342 * @hostdata: ibmvscsi_host_data of host
1344 * Returns zero if successful.
1346 static int enable_fast_fail(struct ibmvscsi_host_data *hostdata)
1348 int rc;
1349 unsigned long flags;
1350 struct viosrp_fast_fail *fast_fail_mad;
1351 struct srp_event_struct *evt_struct;
1353 if (!fast_fail) {
1354 send_mad_capabilities(hostdata);
1355 return 0;
1358 evt_struct = get_event_struct(&hostdata->pool);
1359 BUG_ON(!evt_struct);
1361 init_event_struct(evt_struct, fast_fail_rsp, VIOSRP_MAD_FORMAT, info_timeout);
1363 fast_fail_mad = &evt_struct->iu.mad.fast_fail;
1364 memset(fast_fail_mad, 0, sizeof(*fast_fail_mad));
1365 fast_fail_mad->common.type = cpu_to_be32(VIOSRP_ENABLE_FAST_FAIL);
1366 fast_fail_mad->common.length = cpu_to_be16(sizeof(*fast_fail_mad));
1368 spin_lock_irqsave(hostdata->host->host_lock, flags);
1369 rc = ibmvscsi_send_srp_event(evt_struct, hostdata, info_timeout * 2);
1370 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1371 return rc;
1375 * adapter_info_rsp: - Handle response to MAD adapter info request
1376 * @evt_struct: srp_event_struct with the response
1378 * Used as a "done" callback by when sending adapter_info. Gets called
1379 * by ibmvscsi_handle_crq()
1381 static void adapter_info_rsp(struct srp_event_struct *evt_struct)
1383 struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
1385 if (evt_struct->xfer_iu->mad.adapter_info.common.status) {
1386 dev_err(hostdata->dev, "error %d getting adapter info\n",
1387 evt_struct->xfer_iu->mad.adapter_info.common.status);
1388 } else {
1389 dev_info(hostdata->dev, "host srp version: %s, "
1390 "host partition %s (%d), OS %d, max io %u\n",
1391 hostdata->madapter_info.srp_version,
1392 hostdata->madapter_info.partition_name,
1393 be32_to_cpu(hostdata->madapter_info.partition_number),
1394 be32_to_cpu(hostdata->madapter_info.os_type),
1395 be32_to_cpu(hostdata->madapter_info.port_max_txu[0]));
1397 if (hostdata->madapter_info.port_max_txu[0])
1398 hostdata->host->max_sectors =
1399 be32_to_cpu(hostdata->madapter_info.port_max_txu[0]) >> 9;
1401 if (be32_to_cpu(hostdata->madapter_info.os_type) == SRP_MAD_OS_AIX &&
1402 strcmp(hostdata->madapter_info.srp_version, "1.6a") <= 0) {
1403 dev_err(hostdata->dev, "host (Ver. %s) doesn't support large transfers\n",
1404 hostdata->madapter_info.srp_version);
1405 dev_err(hostdata->dev, "limiting scatterlists to %d\n",
1406 MAX_INDIRECT_BUFS);
1407 hostdata->host->sg_tablesize = MAX_INDIRECT_BUFS;
1410 if (be32_to_cpu(hostdata->madapter_info.os_type) == SRP_MAD_OS_AIX) {
1411 enable_fast_fail(hostdata);
1412 return;
1416 send_srp_login(hostdata);
1420 * send_mad_adapter_info: - Sends the mad adapter info request
1421 * and stores the result so it can be retrieved with
1422 * sysfs. We COULD consider causing a failure if the
1423 * returned SRP version doesn't match ours.
1424 * @hostdata: ibmvscsi_host_data of host
1426 * Returns zero if successful.
1428 static void send_mad_adapter_info(struct ibmvscsi_host_data *hostdata)
1430 struct viosrp_adapter_info *req;
1431 struct srp_event_struct *evt_struct;
1432 unsigned long flags;
1434 evt_struct = get_event_struct(&hostdata->pool);
1435 BUG_ON(!evt_struct);
1437 init_event_struct(evt_struct,
1438 adapter_info_rsp,
1439 VIOSRP_MAD_FORMAT,
1440 info_timeout);
1442 req = &evt_struct->iu.mad.adapter_info;
1443 memset(req, 0x00, sizeof(*req));
1445 req->common.type = cpu_to_be32(VIOSRP_ADAPTER_INFO_TYPE);
1446 req->common.length = cpu_to_be16(sizeof(hostdata->madapter_info));
1447 req->buffer = cpu_to_be64(hostdata->adapter_info_addr);
1449 spin_lock_irqsave(hostdata->host->host_lock, flags);
1450 if (ibmvscsi_send_srp_event(evt_struct, hostdata, info_timeout * 2))
1451 dev_err(hostdata->dev, "couldn't send ADAPTER_INFO_REQ!\n");
1452 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1456 * init_adapter: Start virtual adapter initialization sequence
1459 static void init_adapter(struct ibmvscsi_host_data *hostdata)
1461 send_mad_adapter_info(hostdata);
1465 * sync_completion: Signal that a synchronous command has completed
1466 * Note that after returning from this call, the evt_struct is freed.
1467 * the caller waiting on this completion shouldn't touch the evt_struct
1468 * again.
1470 static void sync_completion(struct srp_event_struct *evt_struct)
1472 /* copy the response back */
1473 if (evt_struct->sync_srp)
1474 *evt_struct->sync_srp = *evt_struct->xfer_iu;
1476 complete(&evt_struct->comp);
1480 * ibmvscsi_abort: Abort a command...from scsi host template
1481 * send this over to the server and wait synchronously for the response
1483 static int ibmvscsi_eh_abort_handler(struct scsi_cmnd *cmd)
1485 struct ibmvscsi_host_data *hostdata = shost_priv(cmd->device->host);
1486 struct srp_tsk_mgmt *tsk_mgmt;
1487 struct srp_event_struct *evt;
1488 struct srp_event_struct *tmp_evt, *found_evt;
1489 union viosrp_iu srp_rsp;
1490 int rsp_rc;
1491 unsigned long flags;
1492 u16 lun = lun_from_dev(cmd->device);
1493 unsigned long wait_switch = 0;
1495 /* First, find this command in our sent list so we can figure
1496 * out the correct tag
1498 spin_lock_irqsave(hostdata->host->host_lock, flags);
1499 wait_switch = jiffies + (init_timeout * HZ);
1500 do {
1501 found_evt = NULL;
1502 list_for_each_entry(tmp_evt, &hostdata->sent, list) {
1503 if (tmp_evt->cmnd == cmd) {
1504 found_evt = tmp_evt;
1505 break;
1509 if (!found_evt) {
1510 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1511 return SUCCESS;
1514 evt = get_event_struct(&hostdata->pool);
1515 if (evt == NULL) {
1516 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1517 sdev_printk(KERN_ERR, cmd->device,
1518 "failed to allocate abort event\n");
1519 return FAILED;
1522 init_event_struct(evt,
1523 sync_completion,
1524 VIOSRP_SRP_FORMAT,
1525 abort_timeout);
1527 tsk_mgmt = &evt->iu.srp.tsk_mgmt;
1529 /* Set up an abort SRP command */
1530 memset(tsk_mgmt, 0x00, sizeof(*tsk_mgmt));
1531 tsk_mgmt->opcode = SRP_TSK_MGMT;
1532 int_to_scsilun(lun, &tsk_mgmt->lun);
1533 tsk_mgmt->tsk_mgmt_func = SRP_TSK_ABORT_TASK;
1534 tsk_mgmt->task_tag = (u64) found_evt;
1536 evt->sync_srp = &srp_rsp;
1538 init_completion(&evt->comp);
1539 rsp_rc = ibmvscsi_send_srp_event(evt, hostdata, abort_timeout * 2);
1541 if (rsp_rc != SCSI_MLQUEUE_HOST_BUSY)
1542 break;
1544 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1545 msleep(10);
1546 spin_lock_irqsave(hostdata->host->host_lock, flags);
1547 } while (time_before(jiffies, wait_switch));
1549 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1551 if (rsp_rc != 0) {
1552 sdev_printk(KERN_ERR, cmd->device,
1553 "failed to send abort() event. rc=%d\n", rsp_rc);
1554 return FAILED;
1557 sdev_printk(KERN_INFO, cmd->device,
1558 "aborting command. lun 0x%llx, tag 0x%llx\n",
1559 (((u64) lun) << 48), (u64) found_evt);
1561 wait_for_completion(&evt->comp);
1563 /* make sure we got a good response */
1564 if (unlikely(srp_rsp.srp.rsp.opcode != SRP_RSP)) {
1565 if (printk_ratelimit())
1566 sdev_printk(KERN_WARNING, cmd->device, "abort bad SRP RSP type %d\n",
1567 srp_rsp.srp.rsp.opcode);
1568 return FAILED;
1571 if (srp_rsp.srp.rsp.flags & SRP_RSP_FLAG_RSPVALID)
1572 rsp_rc = *((int *)srp_rsp.srp.rsp.data);
1573 else
1574 rsp_rc = srp_rsp.srp.rsp.status;
1576 if (rsp_rc) {
1577 if (printk_ratelimit())
1578 sdev_printk(KERN_WARNING, cmd->device,
1579 "abort code %d for task tag 0x%llx\n",
1580 rsp_rc, tsk_mgmt->task_tag);
1581 return FAILED;
1584 /* Because we dropped the spinlock above, it's possible
1585 * The event is no longer in our list. Make sure it didn't
1586 * complete while we were aborting
1588 spin_lock_irqsave(hostdata->host->host_lock, flags);
1589 found_evt = NULL;
1590 list_for_each_entry(tmp_evt, &hostdata->sent, list) {
1591 if (tmp_evt->cmnd == cmd) {
1592 found_evt = tmp_evt;
1593 break;
1597 if (found_evt == NULL) {
1598 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1599 sdev_printk(KERN_INFO, cmd->device, "aborted task tag 0x%llx completed\n",
1600 tsk_mgmt->task_tag);
1601 return SUCCESS;
1604 sdev_printk(KERN_INFO, cmd->device, "successfully aborted task tag 0x%llx\n",
1605 tsk_mgmt->task_tag);
1607 cmd->result = (DID_ABORT << 16);
1608 list_del(&found_evt->list);
1609 unmap_cmd_data(&found_evt->iu.srp.cmd, found_evt,
1610 found_evt->hostdata->dev);
1611 free_event_struct(&found_evt->hostdata->pool, found_evt);
1612 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1613 atomic_inc(&hostdata->request_limit);
1614 return SUCCESS;
1618 * ibmvscsi_eh_device_reset_handler: Reset a single LUN...from scsi host
1619 * template send this over to the server and wait synchronously for the
1620 * response
1622 static int ibmvscsi_eh_device_reset_handler(struct scsi_cmnd *cmd)
1624 struct ibmvscsi_host_data *hostdata = shost_priv(cmd->device->host);
1625 struct srp_tsk_mgmt *tsk_mgmt;
1626 struct srp_event_struct *evt;
1627 struct srp_event_struct *tmp_evt, *pos;
1628 union viosrp_iu srp_rsp;
1629 int rsp_rc;
1630 unsigned long flags;
1631 u16 lun = lun_from_dev(cmd->device);
1632 unsigned long wait_switch = 0;
1634 spin_lock_irqsave(hostdata->host->host_lock, flags);
1635 wait_switch = jiffies + (init_timeout * HZ);
1636 do {
1637 evt = get_event_struct(&hostdata->pool);
1638 if (evt == NULL) {
1639 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1640 sdev_printk(KERN_ERR, cmd->device,
1641 "failed to allocate reset event\n");
1642 return FAILED;
1645 init_event_struct(evt,
1646 sync_completion,
1647 VIOSRP_SRP_FORMAT,
1648 reset_timeout);
1650 tsk_mgmt = &evt->iu.srp.tsk_mgmt;
1652 /* Set up a lun reset SRP command */
1653 memset(tsk_mgmt, 0x00, sizeof(*tsk_mgmt));
1654 tsk_mgmt->opcode = SRP_TSK_MGMT;
1655 int_to_scsilun(lun, &tsk_mgmt->lun);
1656 tsk_mgmt->tsk_mgmt_func = SRP_TSK_LUN_RESET;
1658 evt->sync_srp = &srp_rsp;
1660 init_completion(&evt->comp);
1661 rsp_rc = ibmvscsi_send_srp_event(evt, hostdata, reset_timeout * 2);
1663 if (rsp_rc != SCSI_MLQUEUE_HOST_BUSY)
1664 break;
1666 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1667 msleep(10);
1668 spin_lock_irqsave(hostdata->host->host_lock, flags);
1669 } while (time_before(jiffies, wait_switch));
1671 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1673 if (rsp_rc != 0) {
1674 sdev_printk(KERN_ERR, cmd->device,
1675 "failed to send reset event. rc=%d\n", rsp_rc);
1676 return FAILED;
1679 sdev_printk(KERN_INFO, cmd->device, "resetting device. lun 0x%llx\n",
1680 (((u64) lun) << 48));
1682 wait_for_completion(&evt->comp);
1684 /* make sure we got a good response */
1685 if (unlikely(srp_rsp.srp.rsp.opcode != SRP_RSP)) {
1686 if (printk_ratelimit())
1687 sdev_printk(KERN_WARNING, cmd->device, "reset bad SRP RSP type %d\n",
1688 srp_rsp.srp.rsp.opcode);
1689 return FAILED;
1692 if (srp_rsp.srp.rsp.flags & SRP_RSP_FLAG_RSPVALID)
1693 rsp_rc = *((int *)srp_rsp.srp.rsp.data);
1694 else
1695 rsp_rc = srp_rsp.srp.rsp.status;
1697 if (rsp_rc) {
1698 if (printk_ratelimit())
1699 sdev_printk(KERN_WARNING, cmd->device,
1700 "reset code %d for task tag 0x%llx\n",
1701 rsp_rc, tsk_mgmt->task_tag);
1702 return FAILED;
1705 /* We need to find all commands for this LUN that have not yet been
1706 * responded to, and fail them with DID_RESET
1708 spin_lock_irqsave(hostdata->host->host_lock, flags);
1709 list_for_each_entry_safe(tmp_evt, pos, &hostdata->sent, list) {
1710 if ((tmp_evt->cmnd) && (tmp_evt->cmnd->device == cmd->device)) {
1711 if (tmp_evt->cmnd)
1712 tmp_evt->cmnd->result = (DID_RESET << 16);
1713 list_del(&tmp_evt->list);
1714 unmap_cmd_data(&tmp_evt->iu.srp.cmd, tmp_evt,
1715 tmp_evt->hostdata->dev);
1716 free_event_struct(&tmp_evt->hostdata->pool,
1717 tmp_evt);
1718 atomic_inc(&hostdata->request_limit);
1719 if (tmp_evt->cmnd_done)
1720 tmp_evt->cmnd_done(tmp_evt->cmnd);
1721 else if (tmp_evt->done)
1722 tmp_evt->done(tmp_evt);
1725 spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1726 return SUCCESS;
1730 * ibmvscsi_eh_host_reset_handler - Reset the connection to the server
1731 * @cmd: struct scsi_cmnd having problems
1733 static int ibmvscsi_eh_host_reset_handler(struct scsi_cmnd *cmd)
1735 unsigned long wait_switch = 0;
1736 struct ibmvscsi_host_data *hostdata = shost_priv(cmd->device->host);
1738 dev_err(hostdata->dev, "Resetting connection due to error recovery\n");
1740 ibmvscsi_reset_host(hostdata);
1742 for (wait_switch = jiffies + (init_timeout * HZ);
1743 time_before(jiffies, wait_switch) &&
1744 atomic_read(&hostdata->request_limit) < 2;) {
1746 msleep(10);
1749 if (atomic_read(&hostdata->request_limit) <= 0)
1750 return FAILED;
1752 return SUCCESS;
1756 * ibmvscsi_handle_crq: - Handles and frees received events in the CRQ
1757 * @crq: Command/Response queue
1758 * @hostdata: ibmvscsi_host_data of host
1761 static void ibmvscsi_handle_crq(struct viosrp_crq *crq,
1762 struct ibmvscsi_host_data *hostdata)
1764 long rc;
1765 unsigned long flags;
1766 /* The hypervisor copies our tag value here so no byteswapping */
1767 struct srp_event_struct *evt_struct =
1768 (__force struct srp_event_struct *)crq->IU_data_ptr;
1769 switch (crq->valid) {
1770 case VIOSRP_CRQ_INIT_RSP: /* initialization */
1771 switch (crq->format) {
1772 case VIOSRP_CRQ_INIT: /* Initialization message */
1773 dev_info(hostdata->dev, "partner initialized\n");
1774 /* Send back a response */
1775 rc = ibmvscsi_send_crq(hostdata, 0xC002000000000000LL, 0);
1776 if (rc == 0) {
1777 /* Now login */
1778 init_adapter(hostdata);
1779 } else {
1780 dev_err(hostdata->dev, "Unable to send init rsp. rc=%ld\n", rc);
1783 break;
1784 case VIOSRP_CRQ_INIT_COMPLETE: /* Initialization response */
1785 dev_info(hostdata->dev, "partner initialization complete\n");
1787 /* Now login */
1788 init_adapter(hostdata);
1789 break;
1790 default:
1791 dev_err(hostdata->dev, "unknown crq message type: %d\n", crq->format);
1793 return;
1794 case VIOSRP_CRQ_XPORT_EVENT: /* Hypervisor telling us the connection is closed */
1795 scsi_block_requests(hostdata->host);
1796 atomic_set(&hostdata->request_limit, 0);
1797 if (crq->format == 0x06) {
1798 /* We need to re-setup the interpartition connection */
1799 dev_info(hostdata->dev, "Re-enabling adapter!\n");
1800 hostdata->client_migrated = 1;
1801 hostdata->reenable_crq = 1;
1802 purge_requests(hostdata, DID_REQUEUE);
1803 wake_up(&hostdata->work_wait_q);
1804 } else {
1805 dev_err(hostdata->dev, "Virtual adapter failed rc %d!\n",
1806 crq->format);
1807 ibmvscsi_reset_host(hostdata);
1809 return;
1810 case VIOSRP_CRQ_CMD_RSP: /* real payload */
1811 break;
1812 default:
1813 dev_err(hostdata->dev, "got an invalid message type 0x%02x\n",
1814 crq->valid);
1815 return;
1818 /* The only kind of payload CRQs we should get are responses to
1819 * things we send. Make sure this response is to something we
1820 * actually sent
1822 if (!valid_event_struct(&hostdata->pool, evt_struct)) {
1823 dev_err(hostdata->dev, "returned correlation_token 0x%p is invalid!\n",
1824 evt_struct);
1825 return;
1828 if (atomic_read(&evt_struct->free)) {
1829 dev_err(hostdata->dev, "received duplicate correlation_token 0x%p!\n",
1830 evt_struct);
1831 return;
1834 if (crq->format == VIOSRP_SRP_FORMAT)
1835 atomic_add(be32_to_cpu(evt_struct->xfer_iu->srp.rsp.req_lim_delta),
1836 &hostdata->request_limit);
1838 del_timer(&evt_struct->timer);
1840 if ((crq->status != VIOSRP_OK && crq->status != VIOSRP_OK2) && evt_struct->cmnd)
1841 evt_struct->cmnd->result = DID_ERROR << 16;
1842 if (evt_struct->done)
1843 evt_struct->done(evt_struct);
1844 else
1845 dev_err(hostdata->dev, "returned done() is NULL; not running it!\n");
1848 * Lock the host_lock before messing with these structures, since we
1849 * are running in a task context
1851 spin_lock_irqsave(evt_struct->hostdata->host->host_lock, flags);
1852 list_del(&evt_struct->list);
1853 free_event_struct(&evt_struct->hostdata->pool, evt_struct);
1854 spin_unlock_irqrestore(evt_struct->hostdata->host->host_lock, flags);
1858 * ibmvscsi_slave_configure: Set the "allow_restart" flag for each disk.
1859 * @sdev: struct scsi_device device to configure
1861 * Enable allow_restart for a device if it is a disk. Adjust the
1862 * queue_depth here also as is required by the documentation for
1863 * struct scsi_host_template.
1865 static int ibmvscsi_slave_configure(struct scsi_device *sdev)
1867 struct Scsi_Host *shost = sdev->host;
1868 unsigned long lock_flags = 0;
1870 spin_lock_irqsave(shost->host_lock, lock_flags);
1871 if (sdev->type == TYPE_DISK) {
1872 sdev->allow_restart = 1;
1873 blk_queue_rq_timeout(sdev->request_queue, 120 * HZ);
1875 spin_unlock_irqrestore(shost->host_lock, lock_flags);
1876 return 0;
1880 * ibmvscsi_change_queue_depth - Change the device's queue depth
1881 * @sdev: scsi device struct
1882 * @qdepth: depth to set
1883 * @reason: calling context
1885 * Return value:
1886 * actual depth set
1888 static int ibmvscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
1890 if (qdepth > IBMVSCSI_MAX_CMDS_PER_LUN)
1891 qdepth = IBMVSCSI_MAX_CMDS_PER_LUN;
1892 return scsi_change_queue_depth(sdev, qdepth);
1895 /* ------------------------------------------------------------
1896 * sysfs attributes
1898 static ssize_t show_host_vhost_loc(struct device *dev,
1899 struct device_attribute *attr, char *buf)
1901 struct Scsi_Host *shost = class_to_shost(dev);
1902 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1903 int len;
1905 len = snprintf(buf, sizeof(hostdata->caps.loc), "%s\n",
1906 hostdata->caps.loc);
1907 return len;
1910 static struct device_attribute ibmvscsi_host_vhost_loc = {
1911 .attr = {
1912 .name = "vhost_loc",
1913 .mode = S_IRUGO,
1915 .show = show_host_vhost_loc,
1918 static ssize_t show_host_vhost_name(struct device *dev,
1919 struct device_attribute *attr, char *buf)
1921 struct Scsi_Host *shost = class_to_shost(dev);
1922 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1923 int len;
1925 len = snprintf(buf, sizeof(hostdata->caps.name), "%s\n",
1926 hostdata->caps.name);
1927 return len;
1930 static struct device_attribute ibmvscsi_host_vhost_name = {
1931 .attr = {
1932 .name = "vhost_name",
1933 .mode = S_IRUGO,
1935 .show = show_host_vhost_name,
1938 static ssize_t show_host_srp_version(struct device *dev,
1939 struct device_attribute *attr, char *buf)
1941 struct Scsi_Host *shost = class_to_shost(dev);
1942 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1943 int len;
1945 len = snprintf(buf, PAGE_SIZE, "%s\n",
1946 hostdata->madapter_info.srp_version);
1947 return len;
1950 static struct device_attribute ibmvscsi_host_srp_version = {
1951 .attr = {
1952 .name = "srp_version",
1953 .mode = S_IRUGO,
1955 .show = show_host_srp_version,
1958 static ssize_t show_host_partition_name(struct device *dev,
1959 struct device_attribute *attr,
1960 char *buf)
1962 struct Scsi_Host *shost = class_to_shost(dev);
1963 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1964 int len;
1966 len = snprintf(buf, PAGE_SIZE, "%s\n",
1967 hostdata->madapter_info.partition_name);
1968 return len;
1971 static struct device_attribute ibmvscsi_host_partition_name = {
1972 .attr = {
1973 .name = "partition_name",
1974 .mode = S_IRUGO,
1976 .show = show_host_partition_name,
1979 static ssize_t show_host_partition_number(struct device *dev,
1980 struct device_attribute *attr,
1981 char *buf)
1983 struct Scsi_Host *shost = class_to_shost(dev);
1984 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
1985 int len;
1987 len = snprintf(buf, PAGE_SIZE, "%d\n",
1988 be32_to_cpu(hostdata->madapter_info.partition_number));
1989 return len;
1992 static struct device_attribute ibmvscsi_host_partition_number = {
1993 .attr = {
1994 .name = "partition_number",
1995 .mode = S_IRUGO,
1997 .show = show_host_partition_number,
2000 static ssize_t show_host_mad_version(struct device *dev,
2001 struct device_attribute *attr, char *buf)
2003 struct Scsi_Host *shost = class_to_shost(dev);
2004 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
2005 int len;
2007 len = snprintf(buf, PAGE_SIZE, "%d\n",
2008 be32_to_cpu(hostdata->madapter_info.mad_version));
2009 return len;
2012 static struct device_attribute ibmvscsi_host_mad_version = {
2013 .attr = {
2014 .name = "mad_version",
2015 .mode = S_IRUGO,
2017 .show = show_host_mad_version,
2020 static ssize_t show_host_os_type(struct device *dev,
2021 struct device_attribute *attr, char *buf)
2023 struct Scsi_Host *shost = class_to_shost(dev);
2024 struct ibmvscsi_host_data *hostdata = shost_priv(shost);
2025 int len;
2027 len = snprintf(buf, PAGE_SIZE, "%d\n",
2028 be32_to_cpu(hostdata->madapter_info.os_type));
2029 return len;
2032 static struct device_attribute ibmvscsi_host_os_type = {
2033 .attr = {
2034 .name = "os_type",
2035 .mode = S_IRUGO,
2037 .show = show_host_os_type,
2040 static ssize_t show_host_config(struct device *dev,
2041 struct device_attribute *attr, char *buf)
2043 return 0;
2046 static struct device_attribute ibmvscsi_host_config = {
2047 .attr = {
2048 .name = "config",
2049 .mode = S_IRUGO,
2051 .show = show_host_config,
2054 static struct device_attribute *ibmvscsi_attrs[] = {
2055 &ibmvscsi_host_vhost_loc,
2056 &ibmvscsi_host_vhost_name,
2057 &ibmvscsi_host_srp_version,
2058 &ibmvscsi_host_partition_name,
2059 &ibmvscsi_host_partition_number,
2060 &ibmvscsi_host_mad_version,
2061 &ibmvscsi_host_os_type,
2062 &ibmvscsi_host_config,
2063 NULL
2066 /* ------------------------------------------------------------
2067 * SCSI driver registration
2069 static struct scsi_host_template driver_template = {
2070 .module = THIS_MODULE,
2071 .name = "IBM POWER Virtual SCSI Adapter " IBMVSCSI_VERSION,
2072 .proc_name = "ibmvscsi",
2073 .queuecommand = ibmvscsi_queuecommand,
2074 .eh_timed_out = srp_timed_out,
2075 .eh_abort_handler = ibmvscsi_eh_abort_handler,
2076 .eh_device_reset_handler = ibmvscsi_eh_device_reset_handler,
2077 .eh_host_reset_handler = ibmvscsi_eh_host_reset_handler,
2078 .slave_configure = ibmvscsi_slave_configure,
2079 .change_queue_depth = ibmvscsi_change_queue_depth,
2080 .cmd_per_lun = IBMVSCSI_CMDS_PER_LUN_DEFAULT,
2081 .can_queue = IBMVSCSI_MAX_REQUESTS_DEFAULT,
2082 .this_id = -1,
2083 .sg_tablesize = SG_ALL,
2084 .use_clustering = ENABLE_CLUSTERING,
2085 .shost_attrs = ibmvscsi_attrs,
2089 * ibmvscsi_get_desired_dma - Calculate IO memory desired by the driver
2091 * @vdev: struct vio_dev for the device whose desired IO mem is to be returned
2093 * Return value:
2094 * Number of bytes of IO data the driver will need to perform well.
2096 static unsigned long ibmvscsi_get_desired_dma(struct vio_dev *vdev)
2098 /* iu_storage data allocated in initialize_event_pool */
2099 unsigned long desired_io = max_events * sizeof(union viosrp_iu);
2101 /* add io space for sg data */
2102 desired_io += (IBMVSCSI_MAX_SECTORS_DEFAULT * 512 *
2103 IBMVSCSI_CMDS_PER_LUN_DEFAULT);
2105 return desired_io;
2108 static void ibmvscsi_do_work(struct ibmvscsi_host_data *hostdata)
2110 int rc;
2111 char *action = "reset";
2113 if (hostdata->reset_crq) {
2114 smp_rmb();
2115 hostdata->reset_crq = 0;
2117 rc = ibmvscsi_reset_crq_queue(&hostdata->queue, hostdata);
2118 if (!rc)
2119 rc = ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0);
2120 vio_enable_interrupts(to_vio_dev(hostdata->dev));
2121 } else if (hostdata->reenable_crq) {
2122 smp_rmb();
2123 action = "enable";
2124 rc = ibmvscsi_reenable_crq_queue(&hostdata->queue, hostdata);
2125 hostdata->reenable_crq = 0;
2126 if (!rc)
2127 rc = ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0);
2128 } else
2129 return;
2131 if (rc) {
2132 atomic_set(&hostdata->request_limit, -1);
2133 dev_err(hostdata->dev, "error after %s\n", action);
2136 scsi_unblock_requests(hostdata->host);
2139 static int ibmvscsi_work_to_do(struct ibmvscsi_host_data *hostdata)
2141 if (kthread_should_stop())
2142 return 1;
2143 else if (hostdata->reset_crq) {
2144 smp_rmb();
2145 return 1;
2146 } else if (hostdata->reenable_crq) {
2147 smp_rmb();
2148 return 1;
2151 return 0;
2154 static int ibmvscsi_work(void *data)
2156 struct ibmvscsi_host_data *hostdata = data;
2157 int rc;
2159 set_user_nice(current, MIN_NICE);
2161 while (1) {
2162 rc = wait_event_interruptible(hostdata->work_wait_q,
2163 ibmvscsi_work_to_do(hostdata));
2165 BUG_ON(rc);
2167 if (kthread_should_stop())
2168 break;
2170 ibmvscsi_do_work(hostdata);
2173 return 0;
2177 * Called by bus code for each adapter
2179 static int ibmvscsi_probe(struct vio_dev *vdev, const struct vio_device_id *id)
2181 struct ibmvscsi_host_data *hostdata;
2182 struct Scsi_Host *host;
2183 struct device *dev = &vdev->dev;
2184 struct srp_rport_identifiers ids;
2185 struct srp_rport *rport;
2186 unsigned long wait_switch = 0;
2187 int rc;
2189 dev_set_drvdata(&vdev->dev, NULL);
2191 host = scsi_host_alloc(&driver_template, sizeof(*hostdata));
2192 if (!host) {
2193 dev_err(&vdev->dev, "couldn't allocate host data\n");
2194 goto scsi_host_alloc_failed;
2197 host->transportt = ibmvscsi_transport_template;
2198 hostdata = shost_priv(host);
2199 memset(hostdata, 0x00, sizeof(*hostdata));
2200 INIT_LIST_HEAD(&hostdata->sent);
2201 init_waitqueue_head(&hostdata->work_wait_q);
2202 hostdata->host = host;
2203 hostdata->dev = dev;
2204 atomic_set(&hostdata->request_limit, -1);
2205 hostdata->host->max_sectors = IBMVSCSI_MAX_SECTORS_DEFAULT;
2207 if (map_persist_bufs(hostdata)) {
2208 dev_err(&vdev->dev, "couldn't map persistent buffers\n");
2209 goto persist_bufs_failed;
2212 hostdata->work_thread = kthread_run(ibmvscsi_work, hostdata, "%s_%d",
2213 "ibmvscsi", host->host_no);
2215 if (IS_ERR(hostdata->work_thread)) {
2216 dev_err(&vdev->dev, "couldn't initialize kthread. rc=%ld\n",
2217 PTR_ERR(hostdata->work_thread));
2218 goto init_crq_failed;
2221 rc = ibmvscsi_init_crq_queue(&hostdata->queue, hostdata, max_events);
2222 if (rc != 0 && rc != H_RESOURCE) {
2223 dev_err(&vdev->dev, "couldn't initialize crq. rc=%d\n", rc);
2224 goto kill_kthread;
2226 if (initialize_event_pool(&hostdata->pool, max_events, hostdata) != 0) {
2227 dev_err(&vdev->dev, "couldn't initialize event pool\n");
2228 goto init_pool_failed;
2231 host->max_lun = IBMVSCSI_MAX_LUN;
2232 host->max_id = max_id;
2233 host->max_channel = max_channel;
2234 host->max_cmd_len = 16;
2236 dev_info(dev,
2237 "Maximum ID: %d Maximum LUN: %llu Maximum Channel: %d\n",
2238 host->max_id, host->max_lun, host->max_channel);
2240 if (scsi_add_host(hostdata->host, hostdata->dev))
2241 goto add_host_failed;
2243 /* we don't have a proper target_port_id so let's use the fake one */
2244 memcpy(ids.port_id, hostdata->madapter_info.partition_name,
2245 sizeof(ids.port_id));
2246 ids.roles = SRP_RPORT_ROLE_TARGET;
2247 rport = srp_rport_add(host, &ids);
2248 if (IS_ERR(rport))
2249 goto add_srp_port_failed;
2251 /* Try to send an initialization message. Note that this is allowed
2252 * to fail if the other end is not acive. In that case we don't
2253 * want to scan
2255 if (ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0) == 0
2256 || rc == H_RESOURCE) {
2258 * Wait around max init_timeout secs for the adapter to finish
2259 * initializing. When we are done initializing, we will have a
2260 * valid request_limit. We don't want Linux scanning before
2261 * we are ready.
2263 for (wait_switch = jiffies + (init_timeout * HZ);
2264 time_before(jiffies, wait_switch) &&
2265 atomic_read(&hostdata->request_limit) < 2;) {
2267 msleep(10);
2270 /* if we now have a valid request_limit, initiate a scan */
2271 if (atomic_read(&hostdata->request_limit) > 0)
2272 scsi_scan_host(host);
2275 dev_set_drvdata(&vdev->dev, hostdata);
2276 list_add_tail(&hostdata->host_list, &ibmvscsi_head);
2277 return 0;
2279 add_srp_port_failed:
2280 scsi_remove_host(hostdata->host);
2281 add_host_failed:
2282 release_event_pool(&hostdata->pool, hostdata);
2283 init_pool_failed:
2284 ibmvscsi_release_crq_queue(&hostdata->queue, hostdata, max_events);
2285 kill_kthread:
2286 kthread_stop(hostdata->work_thread);
2287 init_crq_failed:
2288 unmap_persist_bufs(hostdata);
2289 persist_bufs_failed:
2290 scsi_host_put(host);
2291 scsi_host_alloc_failed:
2292 return -1;
2295 static int ibmvscsi_remove(struct vio_dev *vdev)
2297 struct ibmvscsi_host_data *hostdata = dev_get_drvdata(&vdev->dev);
2298 list_del(&hostdata->host_list);
2299 unmap_persist_bufs(hostdata);
2300 release_event_pool(&hostdata->pool, hostdata);
2301 ibmvscsi_release_crq_queue(&hostdata->queue, hostdata,
2302 max_events);
2304 kthread_stop(hostdata->work_thread);
2305 srp_remove_host(hostdata->host);
2306 scsi_remove_host(hostdata->host);
2307 scsi_host_put(hostdata->host);
2309 return 0;
2313 * ibmvscsi_resume: Resume from suspend
2314 * @dev: device struct
2316 * We may have lost an interrupt across suspend/resume, so kick the
2317 * interrupt handler
2319 static int ibmvscsi_resume(struct device *dev)
2321 struct ibmvscsi_host_data *hostdata = dev_get_drvdata(dev);
2322 vio_disable_interrupts(to_vio_dev(hostdata->dev));
2323 tasklet_schedule(&hostdata->srp_task);
2325 return 0;
2329 * ibmvscsi_device_table: Used by vio.c to match devices in the device tree we
2330 * support.
2332 static const struct vio_device_id ibmvscsi_device_table[] = {
2333 {"vscsi", "IBM,v-scsi"},
2334 { "", "" }
2336 MODULE_DEVICE_TABLE(vio, ibmvscsi_device_table);
2338 static const struct dev_pm_ops ibmvscsi_pm_ops = {
2339 .resume = ibmvscsi_resume
2342 static struct vio_driver ibmvscsi_driver = {
2343 .id_table = ibmvscsi_device_table,
2344 .probe = ibmvscsi_probe,
2345 .remove = ibmvscsi_remove,
2346 .get_desired_dma = ibmvscsi_get_desired_dma,
2347 .name = "ibmvscsi",
2348 .pm = &ibmvscsi_pm_ops,
2351 static struct srp_function_template ibmvscsi_transport_functions = {
2354 int __init ibmvscsi_module_init(void)
2356 int ret;
2358 /* Ensure we have two requests to do error recovery */
2359 driver_template.can_queue = max_requests;
2360 max_events = max_requests + 2;
2362 if (!firmware_has_feature(FW_FEATURE_VIO))
2363 return -ENODEV;
2365 ibmvscsi_transport_template =
2366 srp_attach_transport(&ibmvscsi_transport_functions);
2367 if (!ibmvscsi_transport_template)
2368 return -ENOMEM;
2370 ret = vio_register_driver(&ibmvscsi_driver);
2371 if (ret)
2372 srp_release_transport(ibmvscsi_transport_template);
2373 return ret;
2376 void __exit ibmvscsi_module_exit(void)
2378 vio_unregister_driver(&ibmvscsi_driver);
2379 srp_release_transport(ibmvscsi_transport_template);
2382 module_init(ibmvscsi_module_init);
2383 module_exit(ibmvscsi_module_exit);