xref: /openbmc/linux/drivers/scsi/ibmvscsi/ibmvscsi.c (revision 6c0a60ec)
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)
7  *
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.
12  *
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.
17  *
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
22  *
23  * ------------------------------------------------------------
24  * Emulation of a SCSI host adapter for Virtual I/O devices
25  *
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.
30  *
31  * The virtual adapter(s) are present in the open firmware device
32  * tree just like real adapters.
33  *
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.
38  *
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-robbin 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.
48  *
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.
57  *
58  * Note that some of the underlying infrastructure is different between
59  * machines conforming to the "RS/6000 Platform Architecture" (RPA) and
60  * the older iSeries hypervisor models.  To support both, some low level
61  * routines have been broken out into rpa_vscsi.c and iseries_vscsi.c.
62  * The Makefile should pick one, not two, not zero, of these.
63  *
64  * TODO: This is currently pretty tied to the IBM i/pSeries hypervisor
65  * interfaces.  It would be really nice to abstract this above an RDMA
66  * layer.
67  */
68 
69 #include <linux/module.h>
70 #include <linux/moduleparam.h>
71 #include <linux/dma-mapping.h>
72 #include <linux/delay.h>
73 #include <asm/vio.h>
74 #include <scsi/scsi.h>
75 #include <scsi/scsi_cmnd.h>
76 #include <scsi/scsi_host.h>
77 #include <scsi/scsi_device.h>
78 #include "ibmvscsi.h"
79 
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.
84  */
85 static int max_id = 64;
86 static int max_channel = 3;
87 static int init_timeout = 5;
88 static int max_requests = IBMVSCSI_MAX_REQUESTS_DEFAULT;
89 
90 #define IBMVSCSI_VERSION "1.5.8"
91 
92 MODULE_DESCRIPTION("IBM Virtual SCSI");
93 MODULE_AUTHOR("Dave Boutcher");
94 MODULE_LICENSE("GPL");
95 MODULE_VERSION(IBMVSCSI_VERSION);
96 
97 module_param_named(max_id, max_id, int, S_IRUGO | S_IWUSR);
98 MODULE_PARM_DESC(max_id, "Largest ID value for each channel");
99 module_param_named(max_channel, max_channel, int, S_IRUGO | S_IWUSR);
100 MODULE_PARM_DESC(max_channel, "Largest channel value");
101 module_param_named(init_timeout, init_timeout, int, S_IRUGO | S_IWUSR);
102 MODULE_PARM_DESC(init_timeout, "Initialization timeout in seconds");
103 module_param_named(max_requests, max_requests, int, S_IRUGO | S_IWUSR);
104 MODULE_PARM_DESC(max_requests, "Maximum requests for this adapter");
105 
106 /* ------------------------------------------------------------
107  * Routines for the event pool and event structs
108  */
109 /**
110  * initialize_event_pool: - Allocates and initializes the event pool for a host
111  * @pool:	event_pool to be initialized
112  * @size:	Number of events in pool
113  * @hostdata:	ibmvscsi_host_data who owns the event pool
114  *
115  * Returns zero on success.
116 */
117 static int initialize_event_pool(struct event_pool *pool,
118 				 int size, struct ibmvscsi_host_data *hostdata)
119 {
120 	int i;
121 
122 	pool->size = size;
123 	pool->next = 0;
124 	pool->events = kcalloc(pool->size, sizeof(*pool->events), GFP_KERNEL);
125 	if (!pool->events)
126 		return -ENOMEM;
127 
128 	pool->iu_storage =
129 	    dma_alloc_coherent(hostdata->dev,
130 			       pool->size * sizeof(*pool->iu_storage),
131 			       &pool->iu_token, 0);
132 	if (!pool->iu_storage) {
133 		kfree(pool->events);
134 		return -ENOMEM;
135 	}
136 
137 	for (i = 0; i < pool->size; ++i) {
138 		struct srp_event_struct *evt = &pool->events[i];
139 		memset(&evt->crq, 0x00, sizeof(evt->crq));
140 		atomic_set(&evt->free, 1);
141 		evt->crq.valid = 0x80;
142 		evt->crq.IU_length = sizeof(*evt->xfer_iu);
143 		evt->crq.IU_data_ptr = pool->iu_token +
144 			sizeof(*evt->xfer_iu) * i;
145 		evt->xfer_iu = pool->iu_storage + i;
146 		evt->hostdata = hostdata;
147 		evt->ext_list = NULL;
148 		evt->ext_list_token = 0;
149 	}
150 
151 	return 0;
152 }
153 
154 /**
155  * release_event_pool: - Frees memory of an event pool of a host
156  * @pool:	event_pool to be released
157  * @hostdata:	ibmvscsi_host_data who owns the even pool
158  *
159  * Returns zero on success.
160 */
161 static void release_event_pool(struct event_pool *pool,
162 			       struct ibmvscsi_host_data *hostdata)
163 {
164 	int i, in_use = 0;
165 	for (i = 0; i < pool->size; ++i) {
166 		if (atomic_read(&pool->events[i].free) != 1)
167 			++in_use;
168 		if (pool->events[i].ext_list) {
169 			dma_free_coherent(hostdata->dev,
170 				  SG_ALL * sizeof(struct srp_direct_buf),
171 				  pool->events[i].ext_list,
172 				  pool->events[i].ext_list_token);
173 		}
174 	}
175 	if (in_use)
176 		dev_warn(hostdata->dev, "releasing event pool with %d "
177 			 "events still in use?\n", in_use);
178 	kfree(pool->events);
179 	dma_free_coherent(hostdata->dev,
180 			  pool->size * sizeof(*pool->iu_storage),
181 			  pool->iu_storage, pool->iu_token);
182 }
183 
184 /**
185  * valid_event_struct: - Determines if event is valid.
186  * @pool:	event_pool that contains the event
187  * @evt:	srp_event_struct to be checked for validity
188  *
189  * Returns zero if event is invalid, one otherwise.
190 */
191 static int valid_event_struct(struct event_pool *pool,
192 				struct srp_event_struct *evt)
193 {
194 	int index = evt - pool->events;
195 	if (index < 0 || index >= pool->size)	/* outside of bounds */
196 		return 0;
197 	if (evt != pool->events + index)	/* unaligned */
198 		return 0;
199 	return 1;
200 }
201 
202 /**
203  * ibmvscsi_free-event_struct: - Changes status of event to "free"
204  * @pool:	event_pool that contains the event
205  * @evt:	srp_event_struct to be modified
206  *
207 */
208 static void free_event_struct(struct event_pool *pool,
209 				       struct srp_event_struct *evt)
210 {
211 	if (!valid_event_struct(pool, evt)) {
212 		dev_err(evt->hostdata->dev, "Freeing invalid event_struct %p "
213 			"(not in pool %p)\n", evt, pool->events);
214 		return;
215 	}
216 	if (atomic_inc_return(&evt->free) != 1) {
217 		dev_err(evt->hostdata->dev, "Freeing event_struct %p "
218 			"which is not in use!\n", evt);
219 		return;
220 	}
221 }
222 
223 /**
224  * get_evt_struct: - Gets the next free event in pool
225  * @pool:	event_pool that contains the events to be searched
226  *
227  * Returns the next event in "free" state, and NULL if none are free.
228  * Note that no synchronization is done here, we assume the host_lock
229  * will syncrhonze things.
230 */
231 static struct srp_event_struct *get_event_struct(struct event_pool *pool)
232 {
233 	int i;
234 	int poolsize = pool->size;
235 	int offset = pool->next;
236 
237 	for (i = 0; i < poolsize; i++) {
238 		offset = (offset + 1) % poolsize;
239 		if (!atomic_dec_if_positive(&pool->events[offset].free)) {
240 			pool->next = offset;
241 			return &pool->events[offset];
242 		}
243 	}
244 
245 	printk(KERN_ERR "ibmvscsi: found no event struct in pool!\n");
246 	return NULL;
247 }
248 
249 /**
250  * init_event_struct: Initialize fields in an event struct that are always
251  *                    required.
252  * @evt:        The event
253  * @done:       Routine to call when the event is responded to
254  * @format:     SRP or MAD format
255  * @timeout:    timeout value set in the CRQ
256  */
257 static void init_event_struct(struct srp_event_struct *evt_struct,
258 			      void (*done) (struct srp_event_struct *),
259 			      u8 format,
260 			      int timeout)
261 {
262 	evt_struct->cmnd = NULL;
263 	evt_struct->cmnd_done = NULL;
264 	evt_struct->sync_srp = NULL;
265 	evt_struct->crq.format = format;
266 	evt_struct->crq.timeout = timeout;
267 	evt_struct->done = done;
268 }
269 
270 /* ------------------------------------------------------------
271  * Routines for receiving SCSI responses from the hosting partition
272  */
273 
274 /**
275  * set_srp_direction: Set the fields in the srp related to data
276  *     direction and number of buffers based on the direction in
277  *     the scsi_cmnd and the number of buffers
278  */
279 static void set_srp_direction(struct scsi_cmnd *cmd,
280 			      struct srp_cmd *srp_cmd,
281 			      int numbuf)
282 {
283 	u8 fmt;
284 
285 	if (numbuf == 0)
286 		return;
287 
288 	if (numbuf == 1)
289 		fmt = SRP_DATA_DESC_DIRECT;
290 	else {
291 		fmt = SRP_DATA_DESC_INDIRECT;
292 		numbuf = min(numbuf, MAX_INDIRECT_BUFS);
293 
294 		if (cmd->sc_data_direction == DMA_TO_DEVICE)
295 			srp_cmd->data_out_desc_cnt = numbuf;
296 		else
297 			srp_cmd->data_in_desc_cnt = numbuf;
298 	}
299 
300 	if (cmd->sc_data_direction == DMA_TO_DEVICE)
301 		srp_cmd->buf_fmt = fmt << 4;
302 	else
303 		srp_cmd->buf_fmt = fmt;
304 }
305 
306 static void unmap_sg_list(int num_entries,
307 		struct device *dev,
308 		struct srp_direct_buf *md)
309 {
310 	int i;
311 
312 	for (i = 0; i < num_entries; ++i)
313 		dma_unmap_single(dev, md[i].va, md[i].len, DMA_BIDIRECTIONAL);
314 }
315 
316 /**
317  * unmap_cmd_data: - Unmap data pointed in srp_cmd based on the format
318  * @cmd:	srp_cmd whose additional_data member will be unmapped
319  * @dev:	device for which the memory is mapped
320  *
321 */
322 static void unmap_cmd_data(struct srp_cmd *cmd,
323 			   struct srp_event_struct *evt_struct,
324 			   struct device *dev)
325 {
326 	u8 out_fmt, in_fmt;
327 
328 	out_fmt = cmd->buf_fmt >> 4;
329 	in_fmt = cmd->buf_fmt & ((1U << 4) - 1);
330 
331 	if (out_fmt == SRP_NO_DATA_DESC && in_fmt == SRP_NO_DATA_DESC)
332 		return;
333 	else if (out_fmt == SRP_DATA_DESC_DIRECT ||
334 		 in_fmt == SRP_DATA_DESC_DIRECT) {
335 		struct srp_direct_buf *data =
336 			(struct srp_direct_buf *) cmd->add_data;
337 		dma_unmap_single(dev, data->va, data->len, DMA_BIDIRECTIONAL);
338 	} else {
339 		struct srp_indirect_buf *indirect =
340 			(struct srp_indirect_buf *) cmd->add_data;
341 		int num_mapped = indirect->table_desc.len /
342 			sizeof(struct srp_direct_buf);
343 
344 		if (num_mapped <= MAX_INDIRECT_BUFS) {
345 			unmap_sg_list(num_mapped, dev, &indirect->desc_list[0]);
346 			return;
347 		}
348 
349 		unmap_sg_list(num_mapped, dev, evt_struct->ext_list);
350 	}
351 }
352 
353 static int map_sg_list(int num_entries,
354 		       struct scatterlist *sg,
355 		       struct srp_direct_buf *md)
356 {
357 	int i;
358 	u64 total_length = 0;
359 
360 	for (i = 0; i < num_entries; ++i) {
361 		struct srp_direct_buf *descr = md + i;
362 		struct scatterlist *sg_entry = &sg[i];
363 		descr->va = sg_dma_address(sg_entry);
364 		descr->len = sg_dma_len(sg_entry);
365 		descr->key = 0;
366 		total_length += sg_dma_len(sg_entry);
367  	}
368 	return total_length;
369 }
370 
371 /**
372  * map_sg_data: - Maps dma for a scatterlist and initializes decriptor fields
373  * @cmd:	Scsi_Cmnd with the scatterlist
374  * @srp_cmd:	srp_cmd that contains the memory descriptor
375  * @dev:	device for which to map dma memory
376  *
377  * Called by map_data_for_srp_cmd() when building srp cmd from scsi cmd.
378  * Returns 1 on success.
379 */
380 static int map_sg_data(struct scsi_cmnd *cmd,
381 		       struct srp_event_struct *evt_struct,
382 		       struct srp_cmd *srp_cmd, struct device *dev)
383 {
384 
385 	int sg_mapped;
386 	u64 total_length = 0;
387 	struct scatterlist *sg = cmd->request_buffer;
388 	struct srp_direct_buf *data =
389 		(struct srp_direct_buf *) srp_cmd->add_data;
390 	struct srp_indirect_buf *indirect =
391 		(struct srp_indirect_buf *) data;
392 
393 	sg_mapped = dma_map_sg(dev, sg, cmd->use_sg, DMA_BIDIRECTIONAL);
394 
395 	if (sg_mapped == 0)
396 		return 0;
397 
398 	set_srp_direction(cmd, srp_cmd, sg_mapped);
399 
400 	/* special case; we can use a single direct descriptor */
401 	if (sg_mapped == 1) {
402 		data->va = sg_dma_address(&sg[0]);
403 		data->len = sg_dma_len(&sg[0]);
404 		data->key = 0;
405 		return 1;
406 	}
407 
408 	indirect->table_desc.va = 0;
409 	indirect->table_desc.len = sg_mapped * sizeof(struct srp_direct_buf);
410 	indirect->table_desc.key = 0;
411 
412 	if (sg_mapped <= MAX_INDIRECT_BUFS) {
413 		total_length = map_sg_list(sg_mapped, sg,
414 					   &indirect->desc_list[0]);
415 		indirect->len = total_length;
416 		return 1;
417 	}
418 
419 	/* get indirect table */
420 	if (!evt_struct->ext_list) {
421 		evt_struct->ext_list = (struct srp_direct_buf *)
422 			dma_alloc_coherent(dev,
423 					   SG_ALL * sizeof(struct srp_direct_buf),
424 					   &evt_struct->ext_list_token, 0);
425 		if (!evt_struct->ext_list) {
426 			sdev_printk(KERN_ERR, cmd->device,
427 				    "Can't allocate memory for indirect table\n");
428 			return 0;
429 		}
430 	}
431 
432 	total_length = map_sg_list(sg_mapped, sg, evt_struct->ext_list);
433 
434 	indirect->len = total_length;
435 	indirect->table_desc.va = evt_struct->ext_list_token;
436 	indirect->table_desc.len = sg_mapped * sizeof(indirect->desc_list[0]);
437 	memcpy(indirect->desc_list, evt_struct->ext_list,
438 	       MAX_INDIRECT_BUFS * sizeof(struct srp_direct_buf));
439 
440  	return 1;
441 }
442 
443 /**
444  * map_single_data: - Maps memory and initializes memory decriptor fields
445  * @cmd:	struct scsi_cmnd with the memory to be mapped
446  * @srp_cmd:	srp_cmd that contains the memory descriptor
447  * @dev:	device for which to map dma memory
448  *
449  * Called by map_data_for_srp_cmd() when building srp cmd from scsi cmd.
450  * Returns 1 on success.
451 */
452 static int map_single_data(struct scsi_cmnd *cmd,
453 			   struct srp_cmd *srp_cmd, struct device *dev)
454 {
455 	struct srp_direct_buf *data =
456 		(struct srp_direct_buf *) srp_cmd->add_data;
457 
458 	data->va =
459 		dma_map_single(dev, cmd->request_buffer,
460 			       cmd->request_bufflen,
461 			       DMA_BIDIRECTIONAL);
462 	if (dma_mapping_error(data->va)) {
463 		sdev_printk(KERN_ERR, cmd->device,
464 			    "Unable to map request_buffer for command!\n");
465 		return 0;
466 	}
467 	data->len = cmd->request_bufflen;
468 	data->key = 0;
469 
470 	set_srp_direction(cmd, srp_cmd, 1);
471 
472 	return 1;
473 }
474 
475 /**
476  * map_data_for_srp_cmd: - Calls functions to map data for srp cmds
477  * @cmd:	struct scsi_cmnd with the memory to be mapped
478  * @srp_cmd:	srp_cmd that contains the memory descriptor
479  * @dev:	dma device for which to map dma memory
480  *
481  * Called by scsi_cmd_to_srp_cmd() when converting scsi cmds to srp cmds
482  * Returns 1 on success.
483 */
484 static int map_data_for_srp_cmd(struct scsi_cmnd *cmd,
485 				struct srp_event_struct *evt_struct,
486 				struct srp_cmd *srp_cmd, struct device *dev)
487 {
488 	switch (cmd->sc_data_direction) {
489 	case DMA_FROM_DEVICE:
490 	case DMA_TO_DEVICE:
491 		break;
492 	case DMA_NONE:
493 		return 1;
494 	case DMA_BIDIRECTIONAL:
495 		sdev_printk(KERN_ERR, cmd->device,
496 			    "Can't map DMA_BIDIRECTIONAL to read/write\n");
497 		return 0;
498 	default:
499 		sdev_printk(KERN_ERR, cmd->device,
500 			    "Unknown data direction 0x%02x; can't map!\n",
501 			    cmd->sc_data_direction);
502 		return 0;
503 	}
504 
505 	if (!cmd->request_buffer)
506 		return 1;
507 	if (cmd->use_sg)
508 		return map_sg_data(cmd, evt_struct, srp_cmd, dev);
509 	return map_single_data(cmd, srp_cmd, dev);
510 }
511 
512 /* ------------------------------------------------------------
513  * Routines for sending and receiving SRPs
514  */
515 /**
516  * ibmvscsi_send_srp_event: - Transforms event to u64 array and calls send_crq()
517  * @evt_struct:	evt_struct to be sent
518  * @hostdata:	ibmvscsi_host_data of host
519  *
520  * Returns the value returned from ibmvscsi_send_crq(). (Zero for success)
521  * Note that this routine assumes that host_lock is held for synchronization
522 */
523 static int ibmvscsi_send_srp_event(struct srp_event_struct *evt_struct,
524 				   struct ibmvscsi_host_data *hostdata)
525 {
526 	u64 *crq_as_u64 = (u64 *) &evt_struct->crq;
527 	int request_status;
528 	int rc;
529 
530 	/* If we have exhausted our request limit, just fail this request,
531 	 * unless it is for a reset or abort.
532 	 * Note that there are rare cases involving driver generated requests
533 	 * (such as task management requests) that the mid layer may think we
534 	 * can handle more requests (can_queue) when we actually can't
535 	 */
536 	if (evt_struct->crq.format == VIOSRP_SRP_FORMAT) {
537 		request_status =
538 			atomic_dec_if_positive(&hostdata->request_limit);
539 		/* If request limit was -1 when we started, it is now even
540 		 * less than that
541 		 */
542 		if (request_status < -1)
543 			goto send_error;
544 		/* Otherwise, we may have run out of requests. */
545 		/* Abort and reset calls should make it through.
546 		 * Nothing except abort and reset should use the last two
547 		 * slots unless we had two or less to begin with.
548 		 */
549 		else if (request_status < 2 &&
550 		         evt_struct->iu.srp.cmd.opcode != SRP_TSK_MGMT) {
551 			/* In the case that we have less than two requests
552 			 * available, check the server limit as a combination
553 			 * of the request limit and the number of requests
554 			 * in-flight (the size of the send list).  If the
555 			 * server limit is greater than 2, return busy so
556 			 * that the last two are reserved for reset and abort.
557 			 */
558 			int server_limit = request_status;
559 			struct srp_event_struct *tmp_evt;
560 
561 			list_for_each_entry(tmp_evt, &hostdata->sent, list) {
562 				server_limit++;
563 			}
564 
565 			if (server_limit > 2)
566 				goto send_busy;
567 		}
568 	}
569 
570 	/* Copy the IU into the transfer area */
571 	*evt_struct->xfer_iu = evt_struct->iu;
572 	evt_struct->xfer_iu->srp.rsp.tag = (u64)evt_struct;
573 
574 	/* Add this to the sent list.  We need to do this
575 	 * before we actually send
576 	 * in case it comes back REALLY fast
577 	 */
578 	list_add_tail(&evt_struct->list, &hostdata->sent);
579 
580 	if ((rc =
581 	     ibmvscsi_send_crq(hostdata, crq_as_u64[0], crq_as_u64[1])) != 0) {
582 		list_del(&evt_struct->list);
583 
584 		dev_err(hostdata->dev, "send error %d\n", rc);
585 		atomic_inc(&hostdata->request_limit);
586 		goto send_error;
587 	}
588 
589 	return 0;
590 
591  send_busy:
592 	unmap_cmd_data(&evt_struct->iu.srp.cmd, evt_struct, hostdata->dev);
593 
594 	free_event_struct(&hostdata->pool, evt_struct);
595 	atomic_inc(&hostdata->request_limit);
596 	return SCSI_MLQUEUE_HOST_BUSY;
597 
598  send_error:
599 	unmap_cmd_data(&evt_struct->iu.srp.cmd, evt_struct, hostdata->dev);
600 
601 	if (evt_struct->cmnd != NULL) {
602 		evt_struct->cmnd->result = DID_ERROR << 16;
603 		evt_struct->cmnd_done(evt_struct->cmnd);
604 	} else if (evt_struct->done)
605 		evt_struct->done(evt_struct);
606 
607 	free_event_struct(&hostdata->pool, evt_struct);
608 	return 0;
609 }
610 
611 /**
612  * handle_cmd_rsp: -  Handle responses from commands
613  * @evt_struct:	srp_event_struct to be handled
614  *
615  * Used as a callback by when sending scsi cmds.
616  * Gets called by ibmvscsi_handle_crq()
617 */
618 static void handle_cmd_rsp(struct srp_event_struct *evt_struct)
619 {
620 	struct srp_rsp *rsp = &evt_struct->xfer_iu->srp.rsp;
621 	struct scsi_cmnd *cmnd = evt_struct->cmnd;
622 
623 	if (unlikely(rsp->opcode != SRP_RSP)) {
624 		if (printk_ratelimit())
625 			dev_warn(evt_struct->hostdata->dev,
626 				 "bad SRP RSP type %d\n", rsp->opcode);
627 	}
628 
629 	if (cmnd) {
630 		cmnd->result = rsp->status;
631 		if (((cmnd->result >> 1) & 0x1f) == CHECK_CONDITION)
632 			memcpy(cmnd->sense_buffer,
633 			       rsp->data,
634 			       rsp->sense_data_len);
635 		unmap_cmd_data(&evt_struct->iu.srp.cmd,
636 			       evt_struct,
637 			       evt_struct->hostdata->dev);
638 
639 		if (rsp->flags & SRP_RSP_FLAG_DOOVER)
640 			cmnd->resid = rsp->data_out_res_cnt;
641 		else if (rsp->flags & SRP_RSP_FLAG_DIOVER)
642 			cmnd->resid = rsp->data_in_res_cnt;
643 	}
644 
645 	if (evt_struct->cmnd_done)
646 		evt_struct->cmnd_done(cmnd);
647 }
648 
649 /**
650  * lun_from_dev: - Returns the lun of the scsi device
651  * @dev:	struct scsi_device
652  *
653 */
654 static inline u16 lun_from_dev(struct scsi_device *dev)
655 {
656 	return (0x2 << 14) | (dev->id << 8) | (dev->channel << 5) | dev->lun;
657 }
658 
659 /**
660  * ibmvscsi_queue: - The queuecommand function of the scsi template
661  * @cmd:	struct scsi_cmnd to be executed
662  * @done:	Callback function to be called when cmd is completed
663 */
664 static int ibmvscsi_queuecommand(struct scsi_cmnd *cmnd,
665 				 void (*done) (struct scsi_cmnd *))
666 {
667 	struct srp_cmd *srp_cmd;
668 	struct srp_event_struct *evt_struct;
669 	struct srp_indirect_buf *indirect;
670 	struct ibmvscsi_host_data *hostdata =
671 		(struct ibmvscsi_host_data *)&cmnd->device->host->hostdata;
672 	u16 lun = lun_from_dev(cmnd->device);
673 	u8 out_fmt, in_fmt;
674 
675 	evt_struct = get_event_struct(&hostdata->pool);
676 	if (!evt_struct)
677 		return SCSI_MLQUEUE_HOST_BUSY;
678 
679 	/* Set up the actual SRP IU */
680 	srp_cmd = &evt_struct->iu.srp.cmd;
681 	memset(srp_cmd, 0x00, SRP_MAX_IU_LEN);
682 	srp_cmd->opcode = SRP_CMD;
683 	memcpy(srp_cmd->cdb, cmnd->cmnd, sizeof(cmnd->cmnd));
684 	srp_cmd->lun = ((u64) lun) << 48;
685 
686 	if (!map_data_for_srp_cmd(cmnd, evt_struct, srp_cmd, hostdata->dev)) {
687 		sdev_printk(KERN_ERR, cmnd->device, "couldn't convert cmd to srp_cmd\n");
688 		free_event_struct(&hostdata->pool, evt_struct);
689 		return SCSI_MLQUEUE_HOST_BUSY;
690 	}
691 
692 	init_event_struct(evt_struct,
693 			  handle_cmd_rsp,
694 			  VIOSRP_SRP_FORMAT,
695 			  cmnd->timeout_per_command/HZ);
696 
697 	evt_struct->cmnd = cmnd;
698 	evt_struct->cmnd_done = done;
699 
700 	/* Fix up dma address of the buffer itself */
701 	indirect = (struct srp_indirect_buf *) srp_cmd->add_data;
702 	out_fmt = srp_cmd->buf_fmt >> 4;
703 	in_fmt = srp_cmd->buf_fmt & ((1U << 4) - 1);
704 	if ((in_fmt == SRP_DATA_DESC_INDIRECT ||
705 	     out_fmt == SRP_DATA_DESC_INDIRECT) &&
706 	    indirect->table_desc.va == 0) {
707 		indirect->table_desc.va = evt_struct->crq.IU_data_ptr +
708 			offsetof(struct srp_cmd, add_data) +
709 			offsetof(struct srp_indirect_buf, desc_list);
710 	}
711 
712 	return ibmvscsi_send_srp_event(evt_struct, hostdata);
713 }
714 
715 /* ------------------------------------------------------------
716  * Routines for driver initialization
717  */
718 /**
719  * adapter_info_rsp: - Handle response to MAD adapter info request
720  * @evt_struct:	srp_event_struct with the response
721  *
722  * Used as a "done" callback by when sending adapter_info. Gets called
723  * by ibmvscsi_handle_crq()
724 */
725 static void adapter_info_rsp(struct srp_event_struct *evt_struct)
726 {
727 	struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
728 	dma_unmap_single(hostdata->dev,
729 			 evt_struct->iu.mad.adapter_info.buffer,
730 			 evt_struct->iu.mad.adapter_info.common.length,
731 			 DMA_BIDIRECTIONAL);
732 
733 	if (evt_struct->xfer_iu->mad.adapter_info.common.status) {
734 		dev_err(hostdata->dev, "error %d getting adapter info\n",
735 			evt_struct->xfer_iu->mad.adapter_info.common.status);
736 	} else {
737 		dev_info(hostdata->dev, "host srp version: %s, "
738 			 "host partition %s (%d), OS %d, max io %u\n",
739 			 hostdata->madapter_info.srp_version,
740 			 hostdata->madapter_info.partition_name,
741 			 hostdata->madapter_info.partition_number,
742 			 hostdata->madapter_info.os_type,
743 			 hostdata->madapter_info.port_max_txu[0]);
744 
745 		if (hostdata->madapter_info.port_max_txu[0])
746 			hostdata->host->max_sectors =
747 				hostdata->madapter_info.port_max_txu[0] >> 9;
748 
749 		if (hostdata->madapter_info.os_type == 3 &&
750 		    strcmp(hostdata->madapter_info.srp_version, "1.6a") <= 0) {
751 			dev_err(hostdata->dev, "host (Ver. %s) doesn't support large transfers\n",
752 				hostdata->madapter_info.srp_version);
753 			dev_err(hostdata->dev, "limiting scatterlists to %d\n",
754 				MAX_INDIRECT_BUFS);
755 			hostdata->host->sg_tablesize = MAX_INDIRECT_BUFS;
756 		}
757 	}
758 }
759 
760 /**
761  * send_mad_adapter_info: - Sends the mad adapter info request
762  *      and stores the result so it can be retrieved with
763  *      sysfs.  We COULD consider causing a failure if the
764  *      returned SRP version doesn't match ours.
765  * @hostdata:	ibmvscsi_host_data of host
766  *
767  * Returns zero if successful.
768 */
769 static void send_mad_adapter_info(struct ibmvscsi_host_data *hostdata)
770 {
771 	struct viosrp_adapter_info *req;
772 	struct srp_event_struct *evt_struct;
773 	dma_addr_t addr;
774 
775 	evt_struct = get_event_struct(&hostdata->pool);
776 	if (!evt_struct) {
777 		dev_err(hostdata->dev,
778 			"couldn't allocate an event for ADAPTER_INFO_REQ!\n");
779 		return;
780 	}
781 
782 	init_event_struct(evt_struct,
783 			  adapter_info_rsp,
784 			  VIOSRP_MAD_FORMAT,
785 			  init_timeout * HZ);
786 
787 	req = &evt_struct->iu.mad.adapter_info;
788 	memset(req, 0x00, sizeof(*req));
789 
790 	req->common.type = VIOSRP_ADAPTER_INFO_TYPE;
791 	req->common.length = sizeof(hostdata->madapter_info);
792 	req->buffer = addr = dma_map_single(hostdata->dev,
793 					    &hostdata->madapter_info,
794 					    sizeof(hostdata->madapter_info),
795 					    DMA_BIDIRECTIONAL);
796 
797 	if (dma_mapping_error(req->buffer)) {
798 		dev_err(hostdata->dev, "Unable to map request_buffer for adapter_info!\n");
799 		free_event_struct(&hostdata->pool, evt_struct);
800 		return;
801 	}
802 
803 	if (ibmvscsi_send_srp_event(evt_struct, hostdata)) {
804 		dev_err(hostdata->dev, "couldn't send ADAPTER_INFO_REQ!\n");
805 		dma_unmap_single(hostdata->dev,
806 				 addr,
807 				 sizeof(hostdata->madapter_info),
808 				 DMA_BIDIRECTIONAL);
809 	}
810 };
811 
812 /**
813  * login_rsp: - Handle response to SRP login request
814  * @evt_struct:	srp_event_struct with the response
815  *
816  * Used as a "done" callback by when sending srp_login. Gets called
817  * by ibmvscsi_handle_crq()
818 */
819 static void login_rsp(struct srp_event_struct *evt_struct)
820 {
821 	struct ibmvscsi_host_data *hostdata = evt_struct->hostdata;
822 	switch (evt_struct->xfer_iu->srp.login_rsp.opcode) {
823 	case SRP_LOGIN_RSP:	/* it worked! */
824 		break;
825 	case SRP_LOGIN_REJ:	/* refused! */
826 		dev_info(hostdata->dev, "SRP_LOGIN_REJ reason %u\n",
827 			 evt_struct->xfer_iu->srp.login_rej.reason);
828 		/* Login failed.  */
829 		atomic_set(&hostdata->request_limit, -1);
830 		return;
831 	default:
832 		dev_err(hostdata->dev, "Invalid login response typecode 0x%02x!\n",
833 			evt_struct->xfer_iu->srp.login_rsp.opcode);
834 		/* Login failed.  */
835 		atomic_set(&hostdata->request_limit, -1);
836 		return;
837 	}
838 
839 	dev_info(hostdata->dev, "SRP_LOGIN succeeded\n");
840 
841 	if (evt_struct->xfer_iu->srp.login_rsp.req_lim_delta < 0)
842 		dev_err(hostdata->dev, "Invalid request_limit.\n");
843 
844 	/* Now we know what the real request-limit is.
845 	 * This value is set rather than added to request_limit because
846 	 * request_limit could have been set to -1 by this client.
847 	 */
848 	atomic_set(&hostdata->request_limit,
849 		   evt_struct->xfer_iu->srp.login_rsp.req_lim_delta);
850 
851 	/* If we had any pending I/Os, kick them */
852 	scsi_unblock_requests(hostdata->host);
853 
854 	send_mad_adapter_info(hostdata);
855 	return;
856 }
857 
858 /**
859  * send_srp_login: - Sends the srp login
860  * @hostdata:	ibmvscsi_host_data of host
861  *
862  * Returns zero if successful.
863 */
864 static int send_srp_login(struct ibmvscsi_host_data *hostdata)
865 {
866 	int rc;
867 	unsigned long flags;
868 	struct srp_login_req *login;
869 	struct srp_event_struct *evt_struct = get_event_struct(&hostdata->pool);
870 	if (!evt_struct) {
871 		dev_err(hostdata->dev, "couldn't allocate an event for login req!\n");
872 		return FAILED;
873 	}
874 
875 	init_event_struct(evt_struct,
876 			  login_rsp,
877 			  VIOSRP_SRP_FORMAT,
878 			  init_timeout * HZ);
879 
880 	login = &evt_struct->iu.srp.login_req;
881 	memset(login, 0x00, sizeof(struct srp_login_req));
882 	login->opcode = SRP_LOGIN_REQ;
883 	login->req_it_iu_len = sizeof(union srp_iu);
884 	login->req_buf_fmt = SRP_BUF_FORMAT_DIRECT | SRP_BUF_FORMAT_INDIRECT;
885 
886 	spin_lock_irqsave(hostdata->host->host_lock, flags);
887 	/* Start out with a request limit of 1, since this is negotiated in
888 	 * the login request we are just sending
889 	 */
890 	atomic_set(&hostdata->request_limit, 1);
891 
892 	rc = ibmvscsi_send_srp_event(evt_struct, hostdata);
893 	spin_unlock_irqrestore(hostdata->host->host_lock, flags);
894 	dev_info(hostdata->dev, "sent SRP login\n");
895 	return rc;
896 };
897 
898 /**
899  * sync_completion: Signal that a synchronous command has completed
900  * Note that after returning from this call, the evt_struct is freed.
901  * the caller waiting on this completion shouldn't touch the evt_struct
902  * again.
903  */
904 static void sync_completion(struct srp_event_struct *evt_struct)
905 {
906 	/* copy the response back */
907 	if (evt_struct->sync_srp)
908 		*evt_struct->sync_srp = *evt_struct->xfer_iu;
909 
910 	complete(&evt_struct->comp);
911 }
912 
913 /**
914  * ibmvscsi_abort: Abort a command...from scsi host template
915  * send this over to the server and wait synchronously for the response
916  */
917 static int ibmvscsi_eh_abort_handler(struct scsi_cmnd *cmd)
918 {
919 	struct ibmvscsi_host_data *hostdata =
920 	    (struct ibmvscsi_host_data *)cmd->device->host->hostdata;
921 	struct srp_tsk_mgmt *tsk_mgmt;
922 	struct srp_event_struct *evt;
923 	struct srp_event_struct *tmp_evt, *found_evt;
924 	union viosrp_iu srp_rsp;
925 	int rsp_rc;
926 	unsigned long flags;
927 	u16 lun = lun_from_dev(cmd->device);
928 
929 	/* First, find this command in our sent list so we can figure
930 	 * out the correct tag
931 	 */
932 	spin_lock_irqsave(hostdata->host->host_lock, flags);
933 	found_evt = NULL;
934 	list_for_each_entry(tmp_evt, &hostdata->sent, list) {
935 		if (tmp_evt->cmnd == cmd) {
936 			found_evt = tmp_evt;
937 			break;
938 		}
939 	}
940 
941 	if (!found_evt) {
942 		spin_unlock_irqrestore(hostdata->host->host_lock, flags);
943 		return FAILED;
944 	}
945 
946 	evt = get_event_struct(&hostdata->pool);
947 	if (evt == NULL) {
948 		spin_unlock_irqrestore(hostdata->host->host_lock, flags);
949 		sdev_printk(KERN_ERR, cmd->device, "failed to allocate abort event\n");
950 		return FAILED;
951 	}
952 
953 	init_event_struct(evt,
954 			  sync_completion,
955 			  VIOSRP_SRP_FORMAT,
956 			  init_timeout * HZ);
957 
958 	tsk_mgmt = &evt->iu.srp.tsk_mgmt;
959 
960 	/* Set up an abort SRP command */
961 	memset(tsk_mgmt, 0x00, sizeof(*tsk_mgmt));
962 	tsk_mgmt->opcode = SRP_TSK_MGMT;
963 	tsk_mgmt->lun = ((u64) lun) << 48;
964 	tsk_mgmt->tsk_mgmt_func = SRP_TSK_ABORT_TASK;
965 	tsk_mgmt->task_tag = (u64) found_evt;
966 
967 	sdev_printk(KERN_INFO, cmd->device, "aborting command. lun 0x%lx, tag 0x%lx\n",
968 		    tsk_mgmt->lun, tsk_mgmt->task_tag);
969 
970 	evt->sync_srp = &srp_rsp;
971 	init_completion(&evt->comp);
972 	rsp_rc = ibmvscsi_send_srp_event(evt, hostdata);
973 	spin_unlock_irqrestore(hostdata->host->host_lock, flags);
974 	if (rsp_rc != 0) {
975 		sdev_printk(KERN_ERR, cmd->device,
976 			    "failed to send abort() event. rc=%d\n", rsp_rc);
977 		return FAILED;
978 	}
979 
980 	wait_for_completion(&evt->comp);
981 
982 	/* make sure we got a good response */
983 	if (unlikely(srp_rsp.srp.rsp.opcode != SRP_RSP)) {
984 		if (printk_ratelimit())
985 			sdev_printk(KERN_WARNING, cmd->device, "abort bad SRP RSP type %d\n",
986 				    srp_rsp.srp.rsp.opcode);
987 		return FAILED;
988 	}
989 
990 	if (srp_rsp.srp.rsp.flags & SRP_RSP_FLAG_RSPVALID)
991 		rsp_rc = *((int *)srp_rsp.srp.rsp.data);
992 	else
993 		rsp_rc = srp_rsp.srp.rsp.status;
994 
995 	if (rsp_rc) {
996 		if (printk_ratelimit())
997 			sdev_printk(KERN_WARNING, cmd->device,
998 				    "abort code %d for task tag 0x%lx\n",
999 				    rsp_rc, tsk_mgmt->task_tag);
1000 		return FAILED;
1001 	}
1002 
1003 	/* Because we dropped the spinlock above, it's possible
1004 	 * The event is no longer in our list.  Make sure it didn't
1005 	 * complete while we were aborting
1006 	 */
1007 	spin_lock_irqsave(hostdata->host->host_lock, flags);
1008 	found_evt = NULL;
1009 	list_for_each_entry(tmp_evt, &hostdata->sent, list) {
1010 		if (tmp_evt->cmnd == cmd) {
1011 			found_evt = tmp_evt;
1012 			break;
1013 		}
1014 	}
1015 
1016 	if (found_evt == NULL) {
1017 		spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1018 		sdev_printk(KERN_INFO, cmd->device, "aborted task tag 0x%lx completed\n",
1019 			    tsk_mgmt->task_tag);
1020 		return SUCCESS;
1021 	}
1022 
1023 	sdev_printk(KERN_INFO, cmd->device, "successfully aborted task tag 0x%lx\n",
1024 		    tsk_mgmt->task_tag);
1025 
1026 	cmd->result = (DID_ABORT << 16);
1027 	list_del(&found_evt->list);
1028 	unmap_cmd_data(&found_evt->iu.srp.cmd, found_evt,
1029 		       found_evt->hostdata->dev);
1030 	free_event_struct(&found_evt->hostdata->pool, found_evt);
1031 	spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1032 	atomic_inc(&hostdata->request_limit);
1033 	return SUCCESS;
1034 }
1035 
1036 /**
1037  * ibmvscsi_eh_device_reset_handler: Reset a single LUN...from scsi host
1038  * template send this over to the server and wait synchronously for the
1039  * response
1040  */
1041 static int ibmvscsi_eh_device_reset_handler(struct scsi_cmnd *cmd)
1042 {
1043 	struct ibmvscsi_host_data *hostdata =
1044 	    (struct ibmvscsi_host_data *)cmd->device->host->hostdata;
1045 
1046 	struct srp_tsk_mgmt *tsk_mgmt;
1047 	struct srp_event_struct *evt;
1048 	struct srp_event_struct *tmp_evt, *pos;
1049 	union viosrp_iu srp_rsp;
1050 	int rsp_rc;
1051 	unsigned long flags;
1052 	u16 lun = lun_from_dev(cmd->device);
1053 
1054 	spin_lock_irqsave(hostdata->host->host_lock, flags);
1055 	evt = get_event_struct(&hostdata->pool);
1056 	if (evt == NULL) {
1057 		spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1058 		sdev_printk(KERN_ERR, cmd->device, "failed to allocate reset event\n");
1059 		return FAILED;
1060 	}
1061 
1062 	init_event_struct(evt,
1063 			  sync_completion,
1064 			  VIOSRP_SRP_FORMAT,
1065 			  init_timeout * HZ);
1066 
1067 	tsk_mgmt = &evt->iu.srp.tsk_mgmt;
1068 
1069 	/* Set up a lun reset SRP command */
1070 	memset(tsk_mgmt, 0x00, sizeof(*tsk_mgmt));
1071 	tsk_mgmt->opcode = SRP_TSK_MGMT;
1072 	tsk_mgmt->lun = ((u64) lun) << 48;
1073 	tsk_mgmt->tsk_mgmt_func = SRP_TSK_LUN_RESET;
1074 
1075 	sdev_printk(KERN_INFO, cmd->device, "resetting device. lun 0x%lx\n",
1076 		    tsk_mgmt->lun);
1077 
1078 	evt->sync_srp = &srp_rsp;
1079 	init_completion(&evt->comp);
1080 	rsp_rc = ibmvscsi_send_srp_event(evt, hostdata);
1081 	spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1082 	if (rsp_rc != 0) {
1083 		sdev_printk(KERN_ERR, cmd->device,
1084 			    "failed to send reset event. rc=%d\n", rsp_rc);
1085 		return FAILED;
1086 	}
1087 
1088 	wait_for_completion(&evt->comp);
1089 
1090 	/* make sure we got a good response */
1091 	if (unlikely(srp_rsp.srp.rsp.opcode != SRP_RSP)) {
1092 		if (printk_ratelimit())
1093 			sdev_printk(KERN_WARNING, cmd->device, "reset bad SRP RSP type %d\n",
1094 				    srp_rsp.srp.rsp.opcode);
1095 		return FAILED;
1096 	}
1097 
1098 	if (srp_rsp.srp.rsp.flags & SRP_RSP_FLAG_RSPVALID)
1099 		rsp_rc = *((int *)srp_rsp.srp.rsp.data);
1100 	else
1101 		rsp_rc = srp_rsp.srp.rsp.status;
1102 
1103 	if (rsp_rc) {
1104 		if (printk_ratelimit())
1105 			sdev_printk(KERN_WARNING, cmd->device,
1106 				    "reset code %d for task tag 0x%lx\n",
1107 				    rsp_rc, tsk_mgmt->task_tag);
1108 		return FAILED;
1109 	}
1110 
1111 	/* We need to find all commands for this LUN that have not yet been
1112 	 * responded to, and fail them with DID_RESET
1113 	 */
1114 	spin_lock_irqsave(hostdata->host->host_lock, flags);
1115 	list_for_each_entry_safe(tmp_evt, pos, &hostdata->sent, list) {
1116 		if ((tmp_evt->cmnd) && (tmp_evt->cmnd->device == cmd->device)) {
1117 			if (tmp_evt->cmnd)
1118 				tmp_evt->cmnd->result = (DID_RESET << 16);
1119 			list_del(&tmp_evt->list);
1120 			unmap_cmd_data(&tmp_evt->iu.srp.cmd, tmp_evt,
1121 				       tmp_evt->hostdata->dev);
1122 			free_event_struct(&tmp_evt->hostdata->pool,
1123 						   tmp_evt);
1124 			atomic_inc(&hostdata->request_limit);
1125 			if (tmp_evt->cmnd_done)
1126 				tmp_evt->cmnd_done(tmp_evt->cmnd);
1127 			else if (tmp_evt->done)
1128 				tmp_evt->done(tmp_evt);
1129 		}
1130 	}
1131 	spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1132 	return SUCCESS;
1133 }
1134 
1135 /**
1136  * purge_requests: Our virtual adapter just shut down.  purge any sent requests
1137  * @hostdata:    the adapter
1138  */
1139 static void purge_requests(struct ibmvscsi_host_data *hostdata, int error_code)
1140 {
1141 	struct srp_event_struct *tmp_evt, *pos;
1142 	unsigned long flags;
1143 
1144 	spin_lock_irqsave(hostdata->host->host_lock, flags);
1145 	list_for_each_entry_safe(tmp_evt, pos, &hostdata->sent, list) {
1146 		list_del(&tmp_evt->list);
1147 		if (tmp_evt->cmnd) {
1148 			tmp_evt->cmnd->result = (error_code << 16);
1149 			unmap_cmd_data(&tmp_evt->iu.srp.cmd,
1150 				       tmp_evt,
1151 				       tmp_evt->hostdata->dev);
1152 			if (tmp_evt->cmnd_done)
1153 				tmp_evt->cmnd_done(tmp_evt->cmnd);
1154 		} else {
1155 			if (tmp_evt->done) {
1156 				tmp_evt->done(tmp_evt);
1157 			}
1158 		}
1159 		free_event_struct(&tmp_evt->hostdata->pool, tmp_evt);
1160 	}
1161 	spin_unlock_irqrestore(hostdata->host->host_lock, flags);
1162 }
1163 
1164 /**
1165  * ibmvscsi_handle_crq: - Handles and frees received events in the CRQ
1166  * @crq:	Command/Response queue
1167  * @hostdata:	ibmvscsi_host_data of host
1168  *
1169 */
1170 void ibmvscsi_handle_crq(struct viosrp_crq *crq,
1171 			 struct ibmvscsi_host_data *hostdata)
1172 {
1173 	long rc;
1174 	unsigned long flags;
1175 	struct srp_event_struct *evt_struct =
1176 	    (struct srp_event_struct *)crq->IU_data_ptr;
1177 	switch (crq->valid) {
1178 	case 0xC0:		/* initialization */
1179 		switch (crq->format) {
1180 		case 0x01:	/* Initialization message */
1181 			dev_info(hostdata->dev, "partner initialized\n");
1182 			/* Send back a response */
1183 			if ((rc = ibmvscsi_send_crq(hostdata,
1184 						    0xC002000000000000LL, 0)) == 0) {
1185 				/* Now login */
1186 				send_srp_login(hostdata);
1187 			} else {
1188 				dev_err(hostdata->dev, "Unable to send init rsp. rc=%ld\n", rc);
1189 			}
1190 
1191 			break;
1192 		case 0x02:	/* Initialization response */
1193 			dev_info(hostdata->dev, "partner initialization complete\n");
1194 
1195 			/* Now login */
1196 			send_srp_login(hostdata);
1197 			break;
1198 		default:
1199 			dev_err(hostdata->dev, "unknown crq message type: %d\n", crq->format);
1200 		}
1201 		return;
1202 	case 0xFF:	/* Hypervisor telling us the connection is closed */
1203 		scsi_block_requests(hostdata->host);
1204 		atomic_set(&hostdata->request_limit, 0);
1205 		if (crq->format == 0x06) {
1206 			/* We need to re-setup the interpartition connection */
1207 			dev_info(hostdata->dev, "Re-enabling adapter!\n");
1208 			purge_requests(hostdata, DID_REQUEUE);
1209 			if ((ibmvscsi_reenable_crq_queue(&hostdata->queue,
1210 							hostdata)) ||
1211 			    (ibmvscsi_send_crq(hostdata,
1212 					       0xC001000000000000LL, 0))) {
1213 					atomic_set(&hostdata->request_limit,
1214 						   -1);
1215 					dev_err(hostdata->dev, "error after enable\n");
1216 			}
1217 		} else {
1218 			dev_err(hostdata->dev, "Virtual adapter failed rc %d!\n",
1219 				crq->format);
1220 
1221 			purge_requests(hostdata, DID_ERROR);
1222 			if ((ibmvscsi_reset_crq_queue(&hostdata->queue,
1223 							hostdata)) ||
1224 			    (ibmvscsi_send_crq(hostdata,
1225 					       0xC001000000000000LL, 0))) {
1226 					atomic_set(&hostdata->request_limit,
1227 						   -1);
1228 					dev_err(hostdata->dev, "error after reset\n");
1229 			}
1230 		}
1231 		scsi_unblock_requests(hostdata->host);
1232 		return;
1233 	case 0x80:		/* real payload */
1234 		break;
1235 	default:
1236 		dev_err(hostdata->dev, "got an invalid message type 0x%02x\n",
1237 			crq->valid);
1238 		return;
1239 	}
1240 
1241 	/* The only kind of payload CRQs we should get are responses to
1242 	 * things we send. Make sure this response is to something we
1243 	 * actually sent
1244 	 */
1245 	if (!valid_event_struct(&hostdata->pool, evt_struct)) {
1246 		dev_err(hostdata->dev, "returned correlation_token 0x%p is invalid!\n",
1247 		       (void *)crq->IU_data_ptr);
1248 		return;
1249 	}
1250 
1251 	if (atomic_read(&evt_struct->free)) {
1252 		dev_err(hostdata->dev, "received duplicate correlation_token 0x%p!\n",
1253 			(void *)crq->IU_data_ptr);
1254 		return;
1255 	}
1256 
1257 	if (crq->format == VIOSRP_SRP_FORMAT)
1258 		atomic_add(evt_struct->xfer_iu->srp.rsp.req_lim_delta,
1259 			   &hostdata->request_limit);
1260 
1261 	if (evt_struct->done)
1262 		evt_struct->done(evt_struct);
1263 	else
1264 		dev_err(hostdata->dev, "returned done() is NULL; not running it!\n");
1265 
1266 	/*
1267 	 * Lock the host_lock before messing with these structures, since we
1268 	 * are running in a task context
1269 	 */
1270 	spin_lock_irqsave(evt_struct->hostdata->host->host_lock, flags);
1271 	list_del(&evt_struct->list);
1272 	free_event_struct(&evt_struct->hostdata->pool, evt_struct);
1273 	spin_unlock_irqrestore(evt_struct->hostdata->host->host_lock, flags);
1274 }
1275 
1276 /**
1277  * ibmvscsi_get_host_config: Send the command to the server to get host
1278  * configuration data.  The data is opaque to us.
1279  */
1280 static int ibmvscsi_do_host_config(struct ibmvscsi_host_data *hostdata,
1281 				   unsigned char *buffer, int length)
1282 {
1283 	struct viosrp_host_config *host_config;
1284 	struct srp_event_struct *evt_struct;
1285 	dma_addr_t addr;
1286 	int rc;
1287 
1288 	evt_struct = get_event_struct(&hostdata->pool);
1289 	if (!evt_struct) {
1290 		dev_err(hostdata->dev, "couldn't allocate event for HOST_CONFIG!\n");
1291 		return -1;
1292 	}
1293 
1294 	init_event_struct(evt_struct,
1295 			  sync_completion,
1296 			  VIOSRP_MAD_FORMAT,
1297 			  init_timeout * HZ);
1298 
1299 	host_config = &evt_struct->iu.mad.host_config;
1300 
1301 	/* Set up a lun reset SRP command */
1302 	memset(host_config, 0x00, sizeof(*host_config));
1303 	host_config->common.type = VIOSRP_HOST_CONFIG_TYPE;
1304 	host_config->common.length = length;
1305 	host_config->buffer = addr = dma_map_single(hostdata->dev, buffer,
1306 						    length,
1307 						    DMA_BIDIRECTIONAL);
1308 
1309 	if (dma_mapping_error(host_config->buffer)) {
1310 		dev_err(hostdata->dev, "dma_mapping error getting host config\n");
1311 		free_event_struct(&hostdata->pool, evt_struct);
1312 		return -1;
1313 	}
1314 
1315 	init_completion(&evt_struct->comp);
1316 	rc = ibmvscsi_send_srp_event(evt_struct, hostdata);
1317 	if (rc == 0)
1318 		wait_for_completion(&evt_struct->comp);
1319 	dma_unmap_single(hostdata->dev, addr, length, DMA_BIDIRECTIONAL);
1320 
1321 	return rc;
1322 }
1323 
1324 /**
1325  * ibmvscsi_slave_configure: Set the "allow_restart" flag for each disk.
1326  * @sdev:	struct scsi_device device to configure
1327  *
1328  * Enable allow_restart for a device if it is a disk.  Adjust the
1329  * queue_depth here also as is required by the documentation for
1330  * struct scsi_host_template.
1331  */
1332 static int ibmvscsi_slave_configure(struct scsi_device *sdev)
1333 {
1334 	struct Scsi_Host *shost = sdev->host;
1335 	unsigned long lock_flags = 0;
1336 
1337 	spin_lock_irqsave(shost->host_lock, lock_flags);
1338 	if (sdev->type == TYPE_DISK)
1339 		sdev->allow_restart = 1;
1340 	scsi_adjust_queue_depth(sdev, 0, shost->cmd_per_lun);
1341 	spin_unlock_irqrestore(shost->host_lock, lock_flags);
1342 	return 0;
1343 }
1344 
1345 /**
1346  * ibmvscsi_change_queue_depth - Change the device's queue depth
1347  * @sdev:	scsi device struct
1348  * @qdepth:	depth to set
1349  *
1350  * Return value:
1351  * 	actual depth set
1352  **/
1353 static int ibmvscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
1354 {
1355 	if (qdepth > IBMVSCSI_MAX_CMDS_PER_LUN)
1356 		qdepth = IBMVSCSI_MAX_CMDS_PER_LUN;
1357 
1358 	scsi_adjust_queue_depth(sdev, 0, qdepth);
1359 	return sdev->queue_depth;
1360 }
1361 
1362 /* ------------------------------------------------------------
1363  * sysfs attributes
1364  */
1365 static ssize_t show_host_srp_version(struct class_device *class_dev, char *buf)
1366 {
1367 	struct Scsi_Host *shost = class_to_shost(class_dev);
1368 	struct ibmvscsi_host_data *hostdata =
1369 	    (struct ibmvscsi_host_data *)shost->hostdata;
1370 	int len;
1371 
1372 	len = snprintf(buf, PAGE_SIZE, "%s\n",
1373 		       hostdata->madapter_info.srp_version);
1374 	return len;
1375 }
1376 
1377 static struct class_device_attribute ibmvscsi_host_srp_version = {
1378 	.attr = {
1379 		 .name = "srp_version",
1380 		 .mode = S_IRUGO,
1381 		 },
1382 	.show = show_host_srp_version,
1383 };
1384 
1385 static ssize_t show_host_partition_name(struct class_device *class_dev,
1386 					char *buf)
1387 {
1388 	struct Scsi_Host *shost = class_to_shost(class_dev);
1389 	struct ibmvscsi_host_data *hostdata =
1390 	    (struct ibmvscsi_host_data *)shost->hostdata;
1391 	int len;
1392 
1393 	len = snprintf(buf, PAGE_SIZE, "%s\n",
1394 		       hostdata->madapter_info.partition_name);
1395 	return len;
1396 }
1397 
1398 static struct class_device_attribute ibmvscsi_host_partition_name = {
1399 	.attr = {
1400 		 .name = "partition_name",
1401 		 .mode = S_IRUGO,
1402 		 },
1403 	.show = show_host_partition_name,
1404 };
1405 
1406 static ssize_t show_host_partition_number(struct class_device *class_dev,
1407 					  char *buf)
1408 {
1409 	struct Scsi_Host *shost = class_to_shost(class_dev);
1410 	struct ibmvscsi_host_data *hostdata =
1411 	    (struct ibmvscsi_host_data *)shost->hostdata;
1412 	int len;
1413 
1414 	len = snprintf(buf, PAGE_SIZE, "%d\n",
1415 		       hostdata->madapter_info.partition_number);
1416 	return len;
1417 }
1418 
1419 static struct class_device_attribute ibmvscsi_host_partition_number = {
1420 	.attr = {
1421 		 .name = "partition_number",
1422 		 .mode = S_IRUGO,
1423 		 },
1424 	.show = show_host_partition_number,
1425 };
1426 
1427 static ssize_t show_host_mad_version(struct class_device *class_dev, char *buf)
1428 {
1429 	struct Scsi_Host *shost = class_to_shost(class_dev);
1430 	struct ibmvscsi_host_data *hostdata =
1431 	    (struct ibmvscsi_host_data *)shost->hostdata;
1432 	int len;
1433 
1434 	len = snprintf(buf, PAGE_SIZE, "%d\n",
1435 		       hostdata->madapter_info.mad_version);
1436 	return len;
1437 }
1438 
1439 static struct class_device_attribute ibmvscsi_host_mad_version = {
1440 	.attr = {
1441 		 .name = "mad_version",
1442 		 .mode = S_IRUGO,
1443 		 },
1444 	.show = show_host_mad_version,
1445 };
1446 
1447 static ssize_t show_host_os_type(struct class_device *class_dev, char *buf)
1448 {
1449 	struct Scsi_Host *shost = class_to_shost(class_dev);
1450 	struct ibmvscsi_host_data *hostdata =
1451 	    (struct ibmvscsi_host_data *)shost->hostdata;
1452 	int len;
1453 
1454 	len = snprintf(buf, PAGE_SIZE, "%d\n", hostdata->madapter_info.os_type);
1455 	return len;
1456 }
1457 
1458 static struct class_device_attribute ibmvscsi_host_os_type = {
1459 	.attr = {
1460 		 .name = "os_type",
1461 		 .mode = S_IRUGO,
1462 		 },
1463 	.show = show_host_os_type,
1464 };
1465 
1466 static ssize_t show_host_config(struct class_device *class_dev, char *buf)
1467 {
1468 	struct Scsi_Host *shost = class_to_shost(class_dev);
1469 	struct ibmvscsi_host_data *hostdata =
1470 	    (struct ibmvscsi_host_data *)shost->hostdata;
1471 
1472 	/* returns null-terminated host config data */
1473 	if (ibmvscsi_do_host_config(hostdata, buf, PAGE_SIZE) == 0)
1474 		return strlen(buf);
1475 	else
1476 		return 0;
1477 }
1478 
1479 static struct class_device_attribute ibmvscsi_host_config = {
1480 	.attr = {
1481 		 .name = "config",
1482 		 .mode = S_IRUGO,
1483 		 },
1484 	.show = show_host_config,
1485 };
1486 
1487 static struct class_device_attribute *ibmvscsi_attrs[] = {
1488 	&ibmvscsi_host_srp_version,
1489 	&ibmvscsi_host_partition_name,
1490 	&ibmvscsi_host_partition_number,
1491 	&ibmvscsi_host_mad_version,
1492 	&ibmvscsi_host_os_type,
1493 	&ibmvscsi_host_config,
1494 	NULL
1495 };
1496 
1497 /* ------------------------------------------------------------
1498  * SCSI driver registration
1499  */
1500 static struct scsi_host_template driver_template = {
1501 	.module = THIS_MODULE,
1502 	.name = "IBM POWER Virtual SCSI Adapter " IBMVSCSI_VERSION,
1503 	.proc_name = "ibmvscsi",
1504 	.queuecommand = ibmvscsi_queuecommand,
1505 	.eh_abort_handler = ibmvscsi_eh_abort_handler,
1506 	.eh_device_reset_handler = ibmvscsi_eh_device_reset_handler,
1507 	.slave_configure = ibmvscsi_slave_configure,
1508 	.change_queue_depth = ibmvscsi_change_queue_depth,
1509 	.cmd_per_lun = 16,
1510 	.can_queue = IBMVSCSI_MAX_REQUESTS_DEFAULT,
1511 	.this_id = -1,
1512 	.sg_tablesize = SG_ALL,
1513 	.use_clustering = ENABLE_CLUSTERING,
1514 	.shost_attrs = ibmvscsi_attrs,
1515 };
1516 
1517 /**
1518  * Called by bus code for each adapter
1519  */
1520 static int ibmvscsi_probe(struct vio_dev *vdev, const struct vio_device_id *id)
1521 {
1522 	struct ibmvscsi_host_data *hostdata;
1523 	struct Scsi_Host *host;
1524 	struct device *dev = &vdev->dev;
1525 	unsigned long wait_switch = 0;
1526 	int rc;
1527 
1528 	vdev->dev.driver_data = NULL;
1529 
1530 	driver_template.can_queue = max_requests;
1531 	host = scsi_host_alloc(&driver_template, sizeof(*hostdata));
1532 	if (!host) {
1533 		dev_err(&vdev->dev, "couldn't allocate host data\n");
1534 		goto scsi_host_alloc_failed;
1535 	}
1536 
1537 	hostdata = (struct ibmvscsi_host_data *)host->hostdata;
1538 	memset(hostdata, 0x00, sizeof(*hostdata));
1539 	INIT_LIST_HEAD(&hostdata->sent);
1540 	hostdata->host = host;
1541 	hostdata->dev = dev;
1542 	atomic_set(&hostdata->request_limit, -1);
1543 	hostdata->host->max_sectors = 32 * 8; /* default max I/O 32 pages */
1544 
1545 	rc = ibmvscsi_init_crq_queue(&hostdata->queue, hostdata, max_requests);
1546 	if (rc != 0 && rc != H_RESOURCE) {
1547 		dev_err(&vdev->dev, "couldn't initialize crq. rc=%d\n", rc);
1548 		goto init_crq_failed;
1549 	}
1550 	if (initialize_event_pool(&hostdata->pool, max_requests, hostdata) != 0) {
1551 		dev_err(&vdev->dev, "couldn't initialize event pool\n");
1552 		goto init_pool_failed;
1553 	}
1554 
1555 	host->max_lun = 8;
1556 	host->max_id = max_id;
1557 	host->max_channel = max_channel;
1558 
1559 	if (scsi_add_host(hostdata->host, hostdata->dev))
1560 		goto add_host_failed;
1561 
1562 	/* Try to send an initialization message.  Note that this is allowed
1563 	 * to fail if the other end is not acive.  In that case we don't
1564 	 * want to scan
1565 	 */
1566 	if (ibmvscsi_send_crq(hostdata, 0xC001000000000000LL, 0) == 0
1567 	    || rc == H_RESOURCE) {
1568 		/*
1569 		 * Wait around max init_timeout secs for the adapter to finish
1570 		 * initializing. When we are done initializing, we will have a
1571 		 * valid request_limit.  We don't want Linux scanning before
1572 		 * we are ready.
1573 		 */
1574 		for (wait_switch = jiffies + (init_timeout * HZ);
1575 		     time_before(jiffies, wait_switch) &&
1576 		     atomic_read(&hostdata->request_limit) < 2;) {
1577 
1578 			msleep(10);
1579 		}
1580 
1581 		/* if we now have a valid request_limit, initiate a scan */
1582 		if (atomic_read(&hostdata->request_limit) > 0)
1583 			scsi_scan_host(host);
1584 	}
1585 
1586 	vdev->dev.driver_data = hostdata;
1587 	return 0;
1588 
1589       add_host_failed:
1590 	release_event_pool(&hostdata->pool, hostdata);
1591       init_pool_failed:
1592 	ibmvscsi_release_crq_queue(&hostdata->queue, hostdata, max_requests);
1593       init_crq_failed:
1594 	scsi_host_put(host);
1595       scsi_host_alloc_failed:
1596 	return -1;
1597 }
1598 
1599 static int ibmvscsi_remove(struct vio_dev *vdev)
1600 {
1601 	struct ibmvscsi_host_data *hostdata = vdev->dev.driver_data;
1602 	release_event_pool(&hostdata->pool, hostdata);
1603 	ibmvscsi_release_crq_queue(&hostdata->queue, hostdata,
1604 				   max_requests);
1605 
1606 	scsi_remove_host(hostdata->host);
1607 	scsi_host_put(hostdata->host);
1608 
1609 	return 0;
1610 }
1611 
1612 /**
1613  * ibmvscsi_device_table: Used by vio.c to match devices in the device tree we
1614  * support.
1615  */
1616 static struct vio_device_id ibmvscsi_device_table[] __devinitdata = {
1617 	{"vscsi", "IBM,v-scsi"},
1618 	{ "", "" }
1619 };
1620 MODULE_DEVICE_TABLE(vio, ibmvscsi_device_table);
1621 
1622 static struct vio_driver ibmvscsi_driver = {
1623 	.id_table = ibmvscsi_device_table,
1624 	.probe = ibmvscsi_probe,
1625 	.remove = ibmvscsi_remove,
1626 	.driver = {
1627 		.name = "ibmvscsi",
1628 		.owner = THIS_MODULE,
1629 	}
1630 };
1631 
1632 int __init ibmvscsi_module_init(void)
1633 {
1634 	return vio_register_driver(&ibmvscsi_driver);
1635 }
1636 
1637 void __exit ibmvscsi_module_exit(void)
1638 {
1639 	vio_unregister_driver(&ibmvscsi_driver);
1640 }
1641 
1642 module_init(ibmvscsi_module_init);
1643 module_exit(ibmvscsi_module_exit);
1644