1 /* Copyright (c) 2012 - 2015 UNISYS CORPORATION
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or (at
7 * your option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
12 * NON INFRINGEMENT. See the GNU General Public License for more
16 #include <linux/debugfs.h>
17 #include <linux/skbuff.h>
18 #include <linux/kthread.h>
19 #include <scsi/scsi.h>
20 #include <scsi/scsi_host.h>
21 #include <scsi/scsi_cmnd.h>
22 #include <scsi/scsi_device.h>
25 #include "iochannel.h"
27 /* The Send and Receive Buffers of the IO Queue may both be full */
29 #define IOS_ERROR_THRESHOLD 1000
30 /* MAX_BUF = 6 lines x 10 MAXVHBA x 80 characters
31 * = 4800 bytes ~ 2^13 = 8192 bytes
34 #define MAX_PENDING_REQUESTS (MIN_NUMSIGNALS * 2)
35 #define VISORHBA_ERROR_COUNT 30
36 #define VISORHBA_OPEN_MAX 1
38 static int visorhba_queue_command_lck(struct scsi_cmnd *scsicmd,
39 void (*visorhba_cmnd_done)
40 (struct scsi_cmnd *));
42 static DEF_SCSI_QCMD(visorhba_queue_command)
44 #define visorhba_queue_command visorhba_queue_command_lck
46 static int visorhba_probe(struct visor_device *dev);
47 static void visorhba_remove(struct visor_device *dev);
48 static int visorhba_pause(struct visor_device *dev,
49 visorbus_state_complete_func complete_func);
50 static int visorhba_resume(struct visor_device *dev,
51 visorbus_state_complete_func complete_func);
53 static ssize_t info_debugfs_read(struct file *file, char __user *buf,
54 size_t len, loff_t *offset);
55 static struct dentry *visorhba_debugfs_dir;
56 static const struct file_operations debugfs_info_fops = {
57 .read = info_debugfs_read,
60 /* GUIDS for HBA channel type supported by this driver */
61 static struct visor_channeltype_descriptor visorhba_channel_types[] = {
62 /* Note that the only channel type we expect to be reported by the
63 * bus driver is the SPAR_VHBA channel.
65 { SPAR_VHBA_CHANNEL_PROTOCOL_UUID, "sparvhba" },
66 { NULL_UUID_LE, NULL }
69 /* This is used to tell the visor bus driver which types of visor devices
70 * we support, and what functions to call when a visor device that we support
71 * is attached or removed.
73 static struct visor_driver visorhba_driver = {
76 .channel_types = visorhba_channel_types,
77 .probe = visorhba_probe,
78 .remove = visorhba_remove,
79 .pause = visorhba_pause,
80 .resume = visorhba_resume,
81 .channel_interrupt = NULL,
83 MODULE_DEVICE_TABLE(visorbus, visorhba_channel_types);
84 MODULE_ALIAS("visorbus:" SPAR_VHBA_CHANNEL_PROTOCOL_UUID_STR);
86 struct visor_thread_info {
87 struct task_struct *task;
88 struct completion has_stopped;
92 struct visordisk_info {
94 u32 channel, id, lun; /* Disk Path */
95 atomic_t ios_threshold;
97 struct visordisk_info *next;
101 struct uiscmdrsp cmdrsp;
102 void *sent; /* The Data being tracked */
103 char cmdtype; /* Type of pointer that is being stored */
106 /* Work Data for dar_work_queue */
107 struct diskaddremove {
108 u8 add; /* 0-remove, 1-add */
109 struct Scsi_Host *shost; /* Scsi Host for this visorhba instance */
110 u32 channel, id, lun; /* Disk Path */
111 struct diskaddremove *next;
114 /* Each scsi_host has a host_data area that contains this struct. */
115 struct visorhba_devdata {
116 struct Scsi_Host *scsihost;
117 struct visor_device *dev;
118 struct list_head dev_info_list;
119 /* Tracks the requests that have been forwarded to
120 * the IOVM and haven't returned yet
122 struct scsipending pending[MAX_PENDING_REQUESTS];
123 /* Start search for next pending free slot here */
124 unsigned int nextinsert;
125 spinlock_t privlock; /* lock to protect data in devdata */
127 bool serverchangingstate;
128 unsigned long long acquire_failed_cnt;
129 unsigned long long interrupts_rcvd;
130 unsigned long long interrupts_notme;
131 unsigned long long interrupts_disabled;
132 u64 __iomem *flags_addr;
133 atomic_t interrupt_rcvd;
134 wait_queue_head_t rsp_queue;
135 struct visordisk_info head;
136 unsigned int max_buff_len;
138 struct visor_thread_info threadinfo;
142 struct visorhba_devices_open {
143 struct visorhba_devdata *devdata;
146 static struct visorhba_devices_open visorhbas_open[VISORHBA_OPEN_MAX];
148 #define for_each_vdisk_match(iter, list, match) \
149 for (iter = &list->head; iter->next; iter = iter->next) \
150 if ((iter->channel == match->channel) && \
151 (iter->id == match->id) && \
152 (iter->lun == match->lun))
154 * visor_thread_start - starts a thread for the device
155 * @thrinfo: The thread to start
156 * @threadfn: Function the thread starts
157 * @thrcontext: Context to pass to the thread, i.e. devdata
158 * @name: string describing name of thread
160 * Starts a thread for the device.
162 * Return 0 on success;
164 static int visor_thread_start(struct visor_thread_info *thrinfo,
165 int (*threadfn)(void *),
166 void *thrcontext, char *name)
168 /* used to stop the thread */
169 init_completion(&thrinfo->has_stopped);
170 thrinfo->task = kthread_run(threadfn, thrcontext, "%s", name);
171 if (IS_ERR(thrinfo->task)) {
173 return PTR_ERR(thrinfo->task);
175 thrinfo->id = thrinfo->task->pid;
180 * add_scsipending_entry - save off io command that is pending in
182 * @devdata: Pointer to devdata
183 * @cmdtype: Specifies the type of command pending
184 * @new: The command to be saved
186 * Saves off the io command that is being handled by the Service
187 * Partition so that it can be handled when it completes. If new is
188 * NULL it is assumed the entry refers only to the cmdrsp.
189 * Returns insert_location where entry was added,
190 * SCSI_MLQUEUE_DEVICE_BUSY if it can't
192 static int add_scsipending_entry(struct visorhba_devdata *devdata,
193 char cmdtype, void *new)
196 struct scsipending *entry;
199 spin_lock_irqsave(&devdata->privlock, flags);
200 insert_location = devdata->nextinsert;
201 while (devdata->pending[insert_location].sent) {
202 insert_location = (insert_location + 1) % MAX_PENDING_REQUESTS;
203 if (insert_location == (int)devdata->nextinsert) {
204 spin_unlock_irqrestore(&devdata->privlock, flags);
209 entry = &devdata->pending[insert_location];
210 memset(&entry->cmdrsp, 0, sizeof(entry->cmdrsp));
211 entry->cmdtype = cmdtype;
214 else /* wants to send cmdrsp */
215 entry->sent = &entry->cmdrsp;
216 devdata->nextinsert = (insert_location + 1) % MAX_PENDING_REQUESTS;
217 spin_unlock_irqrestore(&devdata->privlock, flags);
219 return insert_location;
223 * del_scsipending_enty - removes an entry from the pending array
224 * @devdata: Device holding the pending array
225 * @del: Entry to remove
227 * Removes the entry pointed at by del and returns it.
228 * Returns the scsipending entry pointed at
230 static void *del_scsipending_ent(struct visorhba_devdata *devdata,
236 if (del < MAX_PENDING_REQUESTS) {
237 spin_lock_irqsave(&devdata->privlock, flags);
238 sent = devdata->pending[del].sent;
240 devdata->pending[del].cmdtype = 0;
241 devdata->pending[del].sent = NULL;
242 spin_unlock_irqrestore(&devdata->privlock, flags);
249 * get_scsipending_cmdrsp - return the cmdrsp stored in a pending entry
250 * #ddata: Device holding the pending array
251 * @ent: Entry that stores the cmdrsp
253 * Each scsipending entry has a cmdrsp in it. The cmdrsp is only valid
254 * if the "sent" field is not NULL
255 * Returns a pointer to the cmdrsp.
257 static struct uiscmdrsp *get_scsipending_cmdrsp(struct visorhba_devdata *ddata,
260 if (ddata->pending[ent].sent)
261 return &ddata->pending[ent].cmdrsp;
267 * forward_taskmgmt_command - send taskmegmt command to the Service
269 * @tasktype: Type of taskmgmt command
270 * @scsidev: Scsidev that issued command
272 * Create a cmdrsp packet and send it to the Serivce Partition
273 * that will service this request.
274 * Returns whether the command was queued successfully or not.
276 static int forward_taskmgmt_command(enum task_mgmt_types tasktype,
277 struct scsi_cmnd *scsicmd)
279 struct uiscmdrsp *cmdrsp;
280 struct scsi_device *scsidev = scsicmd->device;
281 struct visorhba_devdata *devdata =
282 (struct visorhba_devdata *)scsidev->host->hostdata;
283 int notifyresult = 0xffff;
284 wait_queue_head_t notifyevent;
287 if (devdata->serverdown || devdata->serverchangingstate)
290 scsicmd_id = add_scsipending_entry(devdata, CMD_SCSITASKMGMT_TYPE,
295 cmdrsp = get_scsipending_cmdrsp(devdata, scsicmd_id);
297 init_waitqueue_head(¬ifyevent);
299 /* issue TASK_MGMT_ABORT_TASK */
300 cmdrsp->cmdtype = CMD_SCSITASKMGMT_TYPE;
301 /* specify the event that has to be triggered when this */
302 /* cmd is complete */
303 cmdrsp->scsitaskmgmt.notify_handle = (u64)¬ifyevent;
304 cmdrsp->scsitaskmgmt.notifyresult_handle = (u64)¬ifyresult;
306 /* save destination */
307 cmdrsp->scsitaskmgmt.tasktype = tasktype;
308 cmdrsp->scsitaskmgmt.vdest.channel = scsidev->channel;
309 cmdrsp->scsitaskmgmt.vdest.id = scsidev->id;
310 cmdrsp->scsitaskmgmt.vdest.lun = scsidev->lun;
311 cmdrsp->scsitaskmgmt.handle = scsicmd_id;
313 if (!visorchannel_signalinsert(devdata->dev->visorchannel,
316 goto err_del_scsipending_ent;
318 /* It can take the Service Partition up to 35 seconds to complete
319 * an IO in some cases, so wait 45 seconds and error out
321 if (!wait_event_timeout(notifyevent, notifyresult != 0xffff,
322 msecs_to_jiffies(45000)))
323 goto err_del_scsipending_ent;
325 if (tasktype == TASK_MGMT_ABORT_TASK)
326 scsicmd->result = (DID_ABORT << 16);
328 scsicmd->result = (DID_RESET << 16);
330 scsicmd->scsi_done(scsicmd);
334 err_del_scsipending_ent:
335 del_scsipending_ent(devdata, scsicmd_id);
340 * visorhba_abort_handler - Send TASK_MGMT_ABORT_TASK
341 * @scsicmd: The scsicmd that needs aborted
343 * Returns SUCCESS if inserted, failure otherwise
346 static int visorhba_abort_handler(struct scsi_cmnd *scsicmd)
348 /* issue TASK_MGMT_ABORT_TASK */
349 struct scsi_device *scsidev;
350 struct visordisk_info *vdisk;
351 struct visorhba_devdata *devdata;
353 scsidev = scsicmd->device;
354 devdata = (struct visorhba_devdata *)scsidev->host->hostdata;
355 for_each_vdisk_match(vdisk, devdata, scsidev) {
356 if (atomic_read(&vdisk->error_count) < VISORHBA_ERROR_COUNT)
357 atomic_inc(&vdisk->error_count);
359 atomic_set(&vdisk->ios_threshold, IOS_ERROR_THRESHOLD);
361 return forward_taskmgmt_command(TASK_MGMT_ABORT_TASK, scsicmd);
365 * visorhba_device_reset_handler - Send TASK_MGMT_LUN_RESET
366 * @scsicmd: The scsicmd that needs aborted
368 * Returns SUCCESS if inserted, failure otherwise
370 static int visorhba_device_reset_handler(struct scsi_cmnd *scsicmd)
372 /* issue TASK_MGMT_LUN_RESET */
373 struct scsi_device *scsidev;
374 struct visordisk_info *vdisk;
375 struct visorhba_devdata *devdata;
377 scsidev = scsicmd->device;
378 devdata = (struct visorhba_devdata *)scsidev->host->hostdata;
379 for_each_vdisk_match(vdisk, devdata, scsidev) {
380 if (atomic_read(&vdisk->error_count) < VISORHBA_ERROR_COUNT)
381 atomic_inc(&vdisk->error_count);
383 atomic_set(&vdisk->ios_threshold, IOS_ERROR_THRESHOLD);
385 return forward_taskmgmt_command(TASK_MGMT_LUN_RESET, scsicmd);
389 * visorhba_bus_reset_handler - Send TASK_MGMT_TARGET_RESET for each
391 * @scsicmd: The scsicmd that needs aborted
395 static int visorhba_bus_reset_handler(struct scsi_cmnd *scsicmd)
397 struct scsi_device *scsidev;
398 struct visordisk_info *vdisk;
399 struct visorhba_devdata *devdata;
401 scsidev = scsicmd->device;
402 devdata = (struct visorhba_devdata *)scsidev->host->hostdata;
403 for_each_vdisk_match(vdisk, devdata, scsidev) {
404 if (atomic_read(&vdisk->error_count) < VISORHBA_ERROR_COUNT)
405 atomic_inc(&vdisk->error_count);
407 atomic_set(&vdisk->ios_threshold, IOS_ERROR_THRESHOLD);
409 return forward_taskmgmt_command(TASK_MGMT_BUS_RESET, scsicmd);
413 * visorhba_host_reset_handler - Not supported
414 * @scsicmd: The scsicmd that needs aborted
416 * Not supported, return SUCCESS
420 visorhba_host_reset_handler(struct scsi_cmnd *scsicmd)
422 /* issue TASK_MGMT_TARGET_RESET for each target on each bus for host */
428 * @shp: Scsi host that is requesting information
430 * Returns string with info
432 static const char *visorhba_get_info(struct Scsi_Host *shp)
434 /* Return version string */
439 * visorhba_queue_command_lck -- queues command to the Service Partition
440 * @scsicmd: Command to be queued
441 * @vsiorhba_cmnd_done: Done command to call when scsicmd is returned
443 * Queues to scsicmd to the ServicePartition after converting it to a
444 * uiscmdrsp structure.
446 * Returns success if queued to the Service Partition, otherwise
450 visorhba_queue_command_lck(struct scsi_cmnd *scsicmd,
451 void (*visorhba_cmnd_done)(struct scsi_cmnd *))
453 struct uiscmdrsp *cmdrsp;
454 struct scsi_device *scsidev = scsicmd->device;
456 unsigned char *cdb = scsicmd->cmnd;
457 struct Scsi_Host *scsihost = scsidev->host;
459 struct visorhba_devdata *devdata =
460 (struct visorhba_devdata *)scsihost->hostdata;
461 struct scatterlist *sg = NULL;
462 struct scatterlist *sglist = NULL;
464 if (devdata->serverdown || devdata->serverchangingstate)
465 return SCSI_MLQUEUE_DEVICE_BUSY;
467 insert_location = add_scsipending_entry(devdata, CMD_SCSI_TYPE,
470 if (insert_location < 0)
471 return SCSI_MLQUEUE_DEVICE_BUSY;
473 cmdrsp = get_scsipending_cmdrsp(devdata, insert_location);
475 cmdrsp->cmdtype = CMD_SCSI_TYPE;
476 /* save the pending insertion location. Deletion from pending
477 * will return the scsicmd pointer for completion
479 cmdrsp->scsi.handle = insert_location;
481 /* save done function that we have call when cmd is complete */
482 scsicmd->scsi_done = visorhba_cmnd_done;
483 /* save destination */
484 cmdrsp->scsi.vdest.channel = scsidev->channel;
485 cmdrsp->scsi.vdest.id = scsidev->id;
486 cmdrsp->scsi.vdest.lun = scsidev->lun;
488 cmdrsp->scsi.data_dir = scsicmd->sc_data_direction;
489 memcpy(cmdrsp->scsi.cmnd, cdb, MAX_CMND_SIZE);
491 cmdrsp->scsi.bufflen = scsi_bufflen(scsicmd);
493 /* keep track of the max buffer length so far. */
494 if (cmdrsp->scsi.bufflen > devdata->max_buff_len)
495 devdata->max_buff_len = cmdrsp->scsi.bufflen;
497 if (scsi_sg_count(scsicmd) > MAX_PHYS_INFO)
498 goto err_del_scsipending_ent;
500 /* convert buffer to phys information */
501 /* buffer is scatterlist - copy it out */
502 sglist = scsi_sglist(scsicmd);
504 for_each_sg(sglist, sg, scsi_sg_count(scsicmd), i) {
505 cmdrsp->scsi.gpi_list[i].address = sg_phys(sg);
506 cmdrsp->scsi.gpi_list[i].length = sg->length;
508 cmdrsp->scsi.guest_phys_entries = scsi_sg_count(scsicmd);
510 if (!visorchannel_signalinsert(devdata->dev->visorchannel,
513 /* queue must be full and we aren't going to wait */
514 goto err_del_scsipending_ent;
518 err_del_scsipending_ent:
519 del_scsipending_ent(devdata, insert_location);
520 return SCSI_MLQUEUE_DEVICE_BUSY;
524 * visorhba_slave_alloc - called when new disk is discovered
527 * Create a new visordisk_info structure and add it to our
530 * Returns success when created, otherwise error.
532 static int visorhba_slave_alloc(struct scsi_device *scsidev)
534 /* this is called by the midlayer before scan for new devices --
535 * LLD can alloc any struct & do init if needed.
537 struct visordisk_info *vdisk;
538 struct visordisk_info *tmpvdisk;
539 struct visorhba_devdata *devdata;
540 struct Scsi_Host *scsihost = (struct Scsi_Host *)scsidev->host;
542 devdata = (struct visorhba_devdata *)scsihost->hostdata;
544 return 0; /* even though we errored, treat as success */
546 for_each_vdisk_match(vdisk, devdata, scsidev)
547 return 0; /* already allocated return success */
549 tmpvdisk = kzalloc(sizeof(*tmpvdisk), GFP_ATOMIC);
553 tmpvdisk->channel = scsidev->channel;
554 tmpvdisk->id = scsidev->id;
555 tmpvdisk->lun = scsidev->lun;
556 vdisk->next = tmpvdisk;
561 * visorhba_slave_destroy - disk is going away
562 * @scsidev: scsi device going away
564 * Disk is going away, clean up resources.
567 static void visorhba_slave_destroy(struct scsi_device *scsidev)
569 /* midlevel calls this after device has been quiesced and
570 * before it is to be deleted.
572 struct visordisk_info *vdisk, *delvdisk;
573 struct visorhba_devdata *devdata;
574 struct Scsi_Host *scsihost = (struct Scsi_Host *)scsidev->host;
576 devdata = (struct visorhba_devdata *)scsihost->hostdata;
577 for_each_vdisk_match(vdisk, devdata, scsidev) {
578 delvdisk = vdisk->next;
579 vdisk->next = delvdisk->next;
585 static struct scsi_host_template visorhba_driver_template = {
586 .name = "Unisys Visor HBA",
587 .info = visorhba_get_info,
588 .queuecommand = visorhba_queue_command,
589 .eh_abort_handler = visorhba_abort_handler,
590 .eh_device_reset_handler = visorhba_device_reset_handler,
591 .eh_bus_reset_handler = visorhba_bus_reset_handler,
592 .eh_host_reset_handler = visorhba_host_reset_handler,
594 #define visorhba_MAX_CMNDS 128
595 .can_queue = visorhba_MAX_CMNDS,
598 .slave_alloc = visorhba_slave_alloc,
599 .slave_destroy = visorhba_slave_destroy,
600 .use_clustering = ENABLE_CLUSTERING,
604 * info_debugfs_read - debugfs interface to dump visorhba states
606 * @buf: buffer to send back to user
607 * @len: len that can be written to buf
608 * @offset: offset into buf
610 * Dumps information about the visorhba driver and devices
611 * TODO: Make this per vhba
614 static ssize_t info_debugfs_read(struct file *file, char __user *buf,
615 size_t len, loff_t *offset)
617 ssize_t bytes_read = 0;
621 struct visorhba_devdata *devdata;
626 vbuf = kzalloc(len, GFP_KERNEL);
630 for (i = 0; i < VISORHBA_OPEN_MAX; i++) {
631 if (!visorhbas_open[i].devdata)
634 devdata = visorhbas_open[i].devdata;
636 str_pos += scnprintf(vbuf + str_pos,
637 len - str_pos, "max_buff_len:%u\n",
638 devdata->max_buff_len);
640 str_pos += scnprintf(vbuf + str_pos, len - str_pos,
641 "\ninterrupts_rcvd = %llu, interrupts_disabled = %llu\n",
642 devdata->interrupts_rcvd,
643 devdata->interrupts_disabled);
644 str_pos += scnprintf(vbuf + str_pos,
645 len - str_pos, "\ninterrupts_notme = %llu,\n",
646 devdata->interrupts_notme);
647 phys_flags_addr = virt_to_phys((__force void *)
648 devdata->flags_addr);
649 str_pos += scnprintf(vbuf + str_pos, len - str_pos,
650 "flags_addr = %p, phys_flags_addr=0x%016llx, FeatureFlags=%llu\n",
651 devdata->flags_addr, phys_flags_addr,
652 (__le64)readq(devdata->flags_addr));
653 str_pos += scnprintf(vbuf + str_pos,
654 len - str_pos, "acquire_failed_cnt:%llu\n",
655 devdata->acquire_failed_cnt);
656 str_pos += scnprintf(vbuf + str_pos, len - str_pos, "\n");
659 bytes_read = simple_read_from_buffer(buf, len, offset, vbuf, str_pos);
665 * visorhba_serverdown_complete - Called when we are done cleaning up
667 * @work: work structure for this serverdown request
669 * Called when we are done cleanning up from serverdown, stop processing
670 * queue, fail pending IOs.
671 * Returns void when finished cleaning up
673 static void visorhba_serverdown_complete(struct visorhba_devdata *devdata)
676 struct scsipending *pendingdel = NULL;
677 struct scsi_cmnd *scsicmd = NULL;
678 struct uiscmdrsp *cmdrsp;
681 /* Stop using the IOVM response queue (queue should be drained
684 kthread_stop(devdata->threadinfo.task);
686 /* Fail commands that weren't completed */
687 spin_lock_irqsave(&devdata->privlock, flags);
688 for (i = 0; i < MAX_PENDING_REQUESTS; i++) {
689 pendingdel = &devdata->pending[i];
690 switch (pendingdel->cmdtype) {
692 scsicmd = pendingdel->sent;
693 scsicmd->result = DID_RESET << 16;
694 if (scsicmd->scsi_done)
695 scsicmd->scsi_done(scsicmd);
697 case CMD_SCSITASKMGMT_TYPE:
698 cmdrsp = pendingdel->sent;
699 cmdrsp->scsitaskmgmt.notifyresult_handle
701 wake_up_all((wait_queue_head_t *)
702 cmdrsp->scsitaskmgmt.notify_handle);
704 case CMD_VDISKMGMT_TYPE:
705 cmdrsp = pendingdel->sent;
706 cmdrsp->vdiskmgmt.notifyresult_handle
708 wake_up_all((wait_queue_head_t *)
709 cmdrsp->vdiskmgmt.notify_handle);
714 pendingdel->cmdtype = 0;
715 pendingdel->sent = NULL;
717 spin_unlock_irqrestore(&devdata->privlock, flags);
719 devdata->serverdown = true;
720 devdata->serverchangingstate = false;
724 * visorhba_serverdown - Got notified that the IOVM is down
725 * @devdata: visorhba that is being serviced by downed IOVM.
727 * Something happened to the IOVM, return immediately and
728 * schedule work cleanup work.
729 * Return SUCCESS or EINVAL
731 static int visorhba_serverdown(struct visorhba_devdata *devdata)
733 if (!devdata->serverdown && !devdata->serverchangingstate) {
734 devdata->serverchangingstate = true;
735 visorhba_serverdown_complete(devdata);
736 } else if (devdata->serverchangingstate) {
743 * do_scsi_linuxstat - scsi command returned linuxstat
744 * @cmdrsp: response from IOVM
745 * @scsicmd: Command issued.
747 * Don't log errors for disk-not-present inquiries
751 do_scsi_linuxstat(struct uiscmdrsp *cmdrsp, struct scsi_cmnd *scsicmd)
753 struct visorhba_devdata *devdata;
754 struct visordisk_info *vdisk;
755 struct scsi_device *scsidev;
757 scsidev = scsicmd->device;
758 memcpy(scsicmd->sense_buffer, cmdrsp->scsi.sensebuf, MAX_SENSE_SIZE);
760 /* Do not log errors for disk-not-present inquiries */
761 if ((cmdrsp->scsi.cmnd[0] == INQUIRY) &&
762 (host_byte(cmdrsp->scsi.linuxstat) == DID_NO_CONNECT) &&
763 (cmdrsp->scsi.addlstat == ADDL_SEL_TIMEOUT))
765 /* Okay see what our error_count is here.... */
766 devdata = (struct visorhba_devdata *)scsidev->host->hostdata;
767 for_each_vdisk_match(vdisk, devdata, scsidev) {
768 if (atomic_read(&vdisk->error_count) < VISORHBA_ERROR_COUNT) {
769 atomic_inc(&vdisk->error_count);
770 atomic_set(&vdisk->ios_threshold, IOS_ERROR_THRESHOLD);
776 * do_scsi_nolinuxstat - scsi command didn't have linuxstat
777 * @cmdrsp: response from IOVM
778 * @scsicmd: Command issued.
780 * Handle response when no linuxstat was returned
784 do_scsi_nolinuxstat(struct uiscmdrsp *cmdrsp, struct scsi_cmnd *scsicmd)
786 struct scsi_device *scsidev;
787 unsigned char buf[36];
788 struct scatterlist *sg;
791 char *this_page_orig;
793 struct visordisk_info *vdisk;
794 struct visorhba_devdata *devdata;
796 scsidev = scsicmd->device;
797 if ((cmdrsp->scsi.cmnd[0] == INQUIRY) &&
798 (cmdrsp->scsi.bufflen >= MIN_INQUIRY_RESULT_LEN)) {
799 if (cmdrsp->scsi.no_disk_result == 0)
802 /* Linux scsi code wants a device at Lun 0
803 * to issue report luns, but we don't want
804 * a disk there so we'll present a processor
807 SET_NO_DISK_INQUIRY_RESULT(buf, cmdrsp->scsi.bufflen,
809 DEV_DISK_CAPABLE_NOT_PRESENT,
812 if (scsi_sg_count(scsicmd) == 0) {
813 memcpy(scsi_sglist(scsicmd), buf,
814 cmdrsp->scsi.bufflen);
818 sg = scsi_sglist(scsicmd);
819 for (i = 0; i < scsi_sg_count(scsicmd); i++) {
820 this_page_orig = kmap_atomic(sg_page(sg + i));
821 this_page = (void *)((unsigned long)this_page_orig |
823 memcpy(this_page, buf + bufind, sg[i].length);
824 kunmap_atomic(this_page_orig);
827 devdata = (struct visorhba_devdata *)scsidev->host->hostdata;
828 for_each_vdisk_match(vdisk, devdata, scsidev) {
829 if (atomic_read(&vdisk->ios_threshold) > 0) {
830 atomic_dec(&vdisk->ios_threshold);
831 if (atomic_read(&vdisk->ios_threshold) == 0)
832 atomic_set(&vdisk->error_count, 0);
839 * complete_scsi_command - complete a scsi command
840 * @uiscmdrsp: Response from Service Partition
841 * @scsicmd: The scsi command
843 * Response returned by the Service Partition, finish it and send
844 * completion to the scsi midlayer.
848 complete_scsi_command(struct uiscmdrsp *cmdrsp, struct scsi_cmnd *scsicmd)
850 /* take what we need out of cmdrsp and complete the scsicmd */
851 scsicmd->result = cmdrsp->scsi.linuxstat;
852 if (cmdrsp->scsi.linuxstat)
853 do_scsi_linuxstat(cmdrsp, scsicmd);
855 do_scsi_nolinuxstat(cmdrsp, scsicmd);
857 scsicmd->scsi_done(scsicmd);
860 /* DELETE VDISK TASK MGMT COMMANDS */
861 static inline void complete_vdiskmgmt_command(struct uiscmdrsp *cmdrsp)
863 /* copy the result of the taskmgmt and
864 * wake up the error handler that is waiting for this
866 cmdrsp->vdiskmgmt.notifyresult_handle = cmdrsp->vdiskmgmt.result;
867 wake_up_all((wait_queue_head_t *)cmdrsp->vdiskmgmt.notify_handle);
871 * complete_taskmgmt_command - complete task management
872 * @cmdrsp: Response from the IOVM
874 * Service Partition returned the result of the task management
875 * command. Wake up anyone waiting for it.
878 static inline void complete_taskmgmt_command(struct uiscmdrsp *cmdrsp)
880 /* copy the result of the taskgmgt and
881 * wake up the error handler that is waiting for this
883 cmdrsp->vdiskmgmt.notifyresult_handle = cmdrsp->vdiskmgmt.result;
884 wake_up_all((wait_queue_head_t *)cmdrsp->scsitaskmgmt.notify_handle);
887 static struct work_struct dar_work_queue;
888 static struct diskaddremove *dar_work_queue_head;
889 static spinlock_t dar_work_queue_lock; /* Lock to protet dar_work_queue_head */
890 static unsigned short dar_work_queue_sched;
893 * queue_disk_add_remove - IOSP has sent us a add/remove request
894 * @dar: disk add/remove request
896 * Queue the work needed to add/remove a disk.
899 static inline void queue_disk_add_remove(struct diskaddremove *dar)
903 spin_lock_irqsave(&dar_work_queue_lock, flags);
904 if (!dar_work_queue_head) {
905 dar_work_queue_head = dar;
908 dar->next = dar_work_queue_head;
909 dar_work_queue_head = dar;
911 if (!dar_work_queue_sched) {
912 schedule_work(&dar_work_queue);
913 dar_work_queue_sched = 1;
915 spin_unlock_irqrestore(&dar_work_queue_lock, flags);
919 * process_disk_notify - IOSP has sent a process disk notify event
921 * @cmdrsp: Response from the IOSP
923 * Queue it to the work queue.
926 static void process_disk_notify(struct Scsi_Host *shost,
927 struct uiscmdrsp *cmdrsp)
929 struct diskaddremove *dar;
931 dar = kzalloc(sizeof(*dar), GFP_ATOMIC);
933 dar->add = cmdrsp->disknotify.add;
935 dar->channel = cmdrsp->disknotify.channel;
936 dar->id = cmdrsp->disknotify.id;
937 dar->lun = cmdrsp->disknotify.lun;
938 queue_disk_add_remove(dar);
943 * drain_queue - pull responses out of iochannel
944 * @cmdrsp: Response from the IOSP
945 * @devdata: device that owns this iochannel
947 * Pulls responses out of the iochannel and process the responses.
951 drain_queue(struct uiscmdrsp *cmdrsp, struct visorhba_devdata *devdata)
953 struct scsi_cmnd *scsicmd;
954 struct Scsi_Host *shost = devdata->scsihost;
957 if (!visorchannel_signalremove(devdata->dev->visorchannel,
960 break; /* queue empty */
962 if (cmdrsp->cmdtype == CMD_SCSI_TYPE) {
963 /* scsicmd location is returned by the
966 scsicmd = del_scsipending_ent(devdata,
967 cmdrsp->scsi.handle);
970 /* complete the orig cmd */
971 complete_scsi_command(cmdrsp, scsicmd);
972 } else if (cmdrsp->cmdtype == CMD_SCSITASKMGMT_TYPE) {
973 if (!del_scsipending_ent(devdata,
974 cmdrsp->scsitaskmgmt.handle))
976 complete_taskmgmt_command(cmdrsp);
977 } else if (cmdrsp->cmdtype == CMD_NOTIFYGUEST_TYPE) {
978 /* The vHba pointer has no meaning in a
979 * guest partition. Let's be safe and set it
980 * to NULL now. Do not use it here!
982 cmdrsp->disknotify.v_hba = NULL;
983 process_disk_notify(shost, cmdrsp);
984 } else if (cmdrsp->cmdtype == CMD_VDISKMGMT_TYPE) {
985 if (!del_scsipending_ent(devdata,
986 cmdrsp->vdiskmgmt.handle))
988 complete_vdiskmgmt_command(cmdrsp);
990 /* cmdrsp is now available for resuse */
995 * process_incoming_rsps - Process responses from IOSP
996 * @v: void pointer to visorhba_devdata
998 * Main function for the thread that processes the responses
999 * from the IO Service Partition. When the queue is empty, wait
1000 * to check to see if it is full again.
1002 static int process_incoming_rsps(void *v)
1004 struct visorhba_devdata *devdata = v;
1005 struct uiscmdrsp *cmdrsp = NULL;
1006 const int size = sizeof(*cmdrsp);
1008 cmdrsp = kmalloc(size, GFP_ATOMIC);
1013 if (kthread_should_stop())
1015 wait_event_interruptible_timeout(
1016 devdata->rsp_queue, (atomic_read(
1017 &devdata->interrupt_rcvd) == 1),
1018 msecs_to_jiffies(devdata->thread_wait_ms));
1020 drain_queue(cmdrsp, devdata);
1027 * visorhba_pause - function to handle visorbus pause messages
1028 * @dev: device that is pausing.
1029 * @complete_func: function to call when finished
1031 * Something has happened to the IO Service Partition that is
1032 * handling this device. Quiet this device and reset commands
1033 * so that the Service Partition can be corrected.
1036 static int visorhba_pause(struct visor_device *dev,
1037 visorbus_state_complete_func complete_func)
1039 struct visorhba_devdata *devdata = dev_get_drvdata(&dev->device);
1041 visorhba_serverdown(devdata);
1042 complete_func(dev, 0);
1047 * visorhba_resume - function called when the IO Service Partition is back
1048 * @dev: device that is pausing.
1049 * @complete_func: function to call when finished
1051 * Yay! The IO Service Partition is back, the channel has been wiped
1052 * so lets re-establish connection and start processing responses.
1053 * Returns 0 on success, error on failure.
1055 static int visorhba_resume(struct visor_device *dev,
1056 visorbus_state_complete_func complete_func)
1058 struct visorhba_devdata *devdata;
1060 devdata = dev_get_drvdata(&dev->device);
1064 if (devdata->serverdown && !devdata->serverchangingstate)
1065 devdata->serverchangingstate = 1;
1067 visor_thread_start(&devdata->threadinfo, process_incoming_rsps,
1068 devdata, "vhba_incming");
1070 devdata->serverdown = false;
1071 devdata->serverchangingstate = false;
1077 * visorhba_probe - device has been discovered, do acquire
1078 * @dev: visor_device that was discovered
1080 * A new HBA was discovered, do the initial connections of it.
1081 * Return 0 on success, otherwise error.
1083 static int visorhba_probe(struct visor_device *dev)
1085 struct Scsi_Host *scsihost;
1086 struct vhba_config_max max;
1087 struct visorhba_devdata *devdata = NULL;
1088 int i, err, channel_offset;
1091 scsihost = scsi_host_alloc(&visorhba_driver_template,
1096 channel_offset = offsetof(struct spar_io_channel_protocol,
1098 err = visorbus_read_channel(dev, channel_offset, &max,
1099 sizeof(struct vhba_config_max));
1101 goto err_scsi_host_put;
1103 scsihost->max_id = (unsigned)max.max_id;
1104 scsihost->max_lun = (unsigned)max.max_lun;
1105 scsihost->cmd_per_lun = (unsigned)max.cmd_per_lun;
1106 scsihost->max_sectors =
1107 (unsigned short)(max.max_io_size >> 9);
1108 scsihost->sg_tablesize =
1109 (unsigned short)(max.max_io_size / PAGE_SIZE);
1110 if (scsihost->sg_tablesize > MAX_PHYS_INFO)
1111 scsihost->sg_tablesize = MAX_PHYS_INFO;
1112 err = scsi_add_host(scsihost, &dev->device);
1114 goto err_scsi_host_put;
1116 devdata = (struct visorhba_devdata *)scsihost->hostdata;
1117 for (i = 0; i < VISORHBA_OPEN_MAX; i++) {
1118 if (!visorhbas_open[i].devdata) {
1119 visorhbas_open[i].devdata = devdata;
1125 dev_set_drvdata(&dev->device, devdata);
1127 init_waitqueue_head(&devdata->rsp_queue);
1128 spin_lock_init(&devdata->privlock);
1129 devdata->serverdown = false;
1130 devdata->serverchangingstate = false;
1131 devdata->scsihost = scsihost;
1133 channel_offset = offsetof(struct spar_io_channel_protocol,
1134 channel_header.features);
1135 err = visorbus_read_channel(dev, channel_offset, &features, 8);
1137 goto err_scsi_remove_host;
1138 features |= ULTRA_IO_CHANNEL_IS_POLLING;
1139 err = visorbus_write_channel(dev, channel_offset, &features, 8);
1141 goto err_scsi_remove_host;
1143 devdata->thread_wait_ms = 2;
1144 visor_thread_start(&devdata->threadinfo, process_incoming_rsps,
1145 devdata, "vhba_incoming");
1147 scsi_scan_host(scsihost);
1151 err_scsi_remove_host:
1152 scsi_remove_host(scsihost);
1155 scsi_host_put(scsihost);
1160 * visorhba_remove - remove a visorhba device
1161 * @dev: Device to remove
1163 * Removes the visorhba device.
1166 static void visorhba_remove(struct visor_device *dev)
1168 struct visorhba_devdata *devdata = dev_get_drvdata(&dev->device);
1169 struct Scsi_Host *scsihost = NULL;
1174 scsihost = devdata->scsihost;
1175 kthread_stop(devdata->threadinfo.task);
1176 scsi_remove_host(scsihost);
1177 scsi_host_put(scsihost);
1179 dev_set_drvdata(&dev->device, NULL);
1183 * visorhba_init - driver init routine
1185 * Initialize the visorhba driver and register it with visorbus
1186 * to handle s-Par virtual host bus adapter.
1188 static int visorhba_init(void)
1193 visorhba_debugfs_dir = debugfs_create_dir("visorhba", NULL);
1194 if (!visorhba_debugfs_dir)
1197 ret = debugfs_create_file("info", S_IRUSR, visorhba_debugfs_dir, NULL,
1198 &debugfs_info_fops);
1202 goto cleanup_debugfs;
1205 rc = visorbus_register_visor_driver(&visorhba_driver);
1207 goto cleanup_debugfs;
1212 debugfs_remove_recursive(visorhba_debugfs_dir);
1218 * visorhba_cleanup - driver exit routine
1220 * Unregister driver from the bus and free up memory.
1222 static void visorhba_exit(void)
1224 visorbus_unregister_visor_driver(&visorhba_driver);
1225 debugfs_remove_recursive(visorhba_debugfs_dir);
1228 module_init(visorhba_init);
1229 module_exit(visorhba_exit);
1231 MODULE_AUTHOR("Unisys");
1232 MODULE_LICENSE("GPL");
1233 MODULE_DESCRIPTION("s-Par hba driver");