1 /*******************************************************************************
2 * Filename: target_core_pscsi.c
4 * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
6 * Copyright (c) 2003, 2004, 2005 PyX Technologies, Inc.
7 * Copyright (c) 2005, 2006, 2007 SBE, Inc.
8 * Copyright (c) 2007-2010 Rising Tide Systems
9 * Copyright (c) 2008-2010 Linux-iSCSI.org
11 * Nicholas A. Bellinger <nab@kernel.org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 ******************************************************************************/
29 #include <linux/version.h>
30 #include <linux/string.h>
31 #include <linux/parser.h>
32 #include <linux/timer.h>
33 #include <linux/blkdev.h>
34 #include <linux/blk_types.h>
35 #include <linux/slab.h>
36 #include <linux/spinlock.h>
37 #include <linux/genhd.h>
38 #include <linux/cdrom.h>
39 #include <linux/file.h>
40 #include <scsi/scsi.h>
41 #include <scsi/scsi_device.h>
42 #include <scsi/scsi_cmnd.h>
43 #include <scsi/scsi_host.h>
44 #include <scsi/scsi_tcq.h>
46 #include <target/target_core_base.h>
47 #include <target/target_core_device.h>
48 #include <target/target_core_transport.h>
50 #include "target_core_pscsi.h"
52 #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
54 static struct se_subsystem_api pscsi_template;
56 static void pscsi_req_done(struct request *, int);
58 /* pscsi_attach_hba():
60 * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
61 * from the passed SCSI Host ID.
63 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
65 struct pscsi_hba_virt *phv;
67 phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
69 printk(KERN_ERR "Unable to allocate struct pscsi_hba_virt\n");
72 phv->phv_host_id = host_id;
73 phv->phv_mode = PHV_VIRUTAL_HOST_ID;
75 hba->hba_ptr = (void *)phv;
77 printk(KERN_INFO "CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
78 " Generic Target Core Stack %s\n", hba->hba_id,
79 PSCSI_VERSION, TARGET_CORE_MOD_VERSION);
80 printk(KERN_INFO "CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
86 static void pscsi_detach_hba(struct se_hba *hba)
88 struct pscsi_hba_virt *phv = hba->hba_ptr;
89 struct Scsi_Host *scsi_host = phv->phv_lld_host;
92 scsi_host_put(scsi_host);
94 printk(KERN_INFO "CORE_HBA[%d] - Detached SCSI HBA: %s from"
95 " Generic Target Core\n", hba->hba_id,
96 (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
99 printk(KERN_INFO "CORE_HBA[%d] - Detached Virtual SCSI HBA"
100 " from Generic Target Core\n", hba->hba_id);
106 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
108 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)hba->hba_ptr;
109 struct Scsi_Host *sh = phv->phv_lld_host;
111 * Release the struct Scsi_Host
117 phv->phv_lld_host = NULL;
118 phv->phv_mode = PHV_VIRUTAL_HOST_ID;
120 printk(KERN_INFO "CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
121 " %s\n", hba->hba_id, (sh->hostt->name) ?
122 (sh->hostt->name) : "Unknown");
128 * Otherwise, locate struct Scsi_Host from the original passed
129 * pSCSI Host ID and enable for phba mode
131 sh = scsi_host_lookup(phv->phv_host_id);
133 printk(KERN_ERR "pSCSI: Unable to locate SCSI Host for"
134 " phv_host_id: %d\n", phv->phv_host_id);
138 phv->phv_lld_host = sh;
139 phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
141 printk(KERN_INFO "CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
142 hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
147 static void pscsi_tape_read_blocksize(struct se_device *dev,
148 struct scsi_device *sdev)
150 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
153 buf = kzalloc(12, GFP_KERNEL);
157 memset(cdb, 0, MAX_COMMAND_SIZE);
159 cdb[4] = 0x0c; /* 12 bytes */
161 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
167 * If MODE_SENSE still returns zero, set the default value to 1024.
169 sdev->sector_size = (buf[9] << 16) | (buf[10] << 8) | (buf[11]);
170 if (!sdev->sector_size)
171 sdev->sector_size = 1024;
177 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
181 if (sdev->inquiry_len < INQUIRY_LEN)
188 * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
190 memcpy(&wwn->vendor[0], &buf[8], sizeof(wwn->vendor));
191 memcpy(&wwn->model[0], &buf[16], sizeof(wwn->model));
192 memcpy(&wwn->revision[0], &buf[32], sizeof(wwn->revision));
196 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
198 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
201 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
205 memset(cdb, 0, MAX_COMMAND_SIZE);
207 cdb[1] = 0x01; /* Query VPD */
208 cdb[2] = 0x80; /* Unit Serial Number */
209 cdb[3] = (INQUIRY_VPD_SERIAL_LEN >> 8) & 0xff;
210 cdb[4] = (INQUIRY_VPD_SERIAL_LEN & 0xff);
212 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
213 INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
217 snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
219 wwn->t10_sub_dev->su_dev_flags |= SDF_FIRMWARE_VPD_UNIT_SERIAL;
230 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
233 unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
234 int ident_len, page_len, off = 4, ret;
237 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
241 memset(cdb, 0, MAX_COMMAND_SIZE);
243 cdb[1] = 0x01; /* Query VPD */
244 cdb[2] = 0x83; /* Device Identifier */
245 cdb[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN >> 8) & 0xff;
246 cdb[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN & 0xff);
248 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
249 INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
254 page_len = (buf[2] << 8) | buf[3];
255 while (page_len > 0) {
256 /* Grab a pointer to the Identification descriptor */
258 ident_len = page_83[3];
260 printk(KERN_ERR "page_83[3]: identifier"
264 printk(KERN_INFO "T10 VPD Identifer Length: %d\n", ident_len);
266 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
268 printk(KERN_ERR "Unable to allocate memory for"
269 " struct t10_vpd\n");
272 INIT_LIST_HEAD(&vpd->vpd_list);
274 transport_set_vpd_proto_id(vpd, page_83);
275 transport_set_vpd_assoc(vpd, page_83);
277 if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
278 off += (ident_len + 4);
279 page_len -= (ident_len + 4);
283 if (transport_set_vpd_ident(vpd, page_83) < 0) {
284 off += (ident_len + 4);
285 page_len -= (ident_len + 4);
290 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
291 off += (ident_len + 4);
292 page_len -= (ident_len + 4);
299 /* pscsi_add_device_to_list():
303 static struct se_device *pscsi_add_device_to_list(
305 struct se_subsystem_dev *se_dev,
306 struct pscsi_dev_virt *pdv,
307 struct scsi_device *sd,
310 struct se_device *dev;
311 struct se_dev_limits dev_limits;
312 struct request_queue *q;
313 struct queue_limits *limits;
315 memset(&dev_limits, 0, sizeof(struct se_dev_limits));
317 if (!sd->queue_depth) {
318 sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
320 printk(KERN_ERR "Set broken SCSI Device %d:%d:%d"
321 " queue_depth to %d\n", sd->channel, sd->id,
322 sd->lun, sd->queue_depth);
325 * Setup the local scope queue_limits from struct request_queue->limits
326 * to pass into transport_add_device_to_core_hba() as struct se_dev_limits.
328 q = sd->request_queue;
329 limits = &dev_limits.limits;
330 limits->logical_block_size = sd->sector_size;
331 limits->max_hw_sectors = (sd->host->max_sectors > queue_max_hw_sectors(q)) ?
332 queue_max_hw_sectors(q) : sd->host->max_sectors;
333 limits->max_sectors = (sd->host->max_sectors > queue_max_sectors(q)) ?
334 queue_max_sectors(q) : sd->host->max_sectors;
335 dev_limits.hw_queue_depth = sd->queue_depth;
336 dev_limits.queue_depth = sd->queue_depth;
338 * Setup our standard INQUIRY info into se_dev->t10_wwn
340 pscsi_set_inquiry_info(sd, &se_dev->t10_wwn);
343 * Set the pointer pdv->pdv_sd to from passed struct scsi_device,
344 * which has already been referenced with Linux SCSI code with
345 * scsi_device_get() in this file's pscsi_create_virtdevice().
347 * The passthrough operations called by the transport_add_device_*
348 * function below will require this pointer to be set for passthroug
351 * For the shutdown case in pscsi_free_device(), this struct
352 * scsi_device reference is released with Linux SCSI code
353 * scsi_device_put() and the pdv->pdv_sd cleared.
357 dev = transport_add_device_to_core_hba(hba, &pscsi_template,
358 se_dev, dev_flags, (void *)pdv,
359 &dev_limits, NULL, NULL);
366 * Locate VPD WWN Information used for various purposes within
367 * the Storage Engine.
369 if (!pscsi_get_inquiry_vpd_serial(sd, &se_dev->t10_wwn)) {
371 * If VPD Unit Serial returned GOOD status, try
372 * VPD Device Identification page (0x83).
374 pscsi_get_inquiry_vpd_device_ident(sd, &se_dev->t10_wwn);
378 * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
380 if (sd->type == TYPE_TAPE)
381 pscsi_tape_read_blocksize(dev, sd);
385 static void *pscsi_allocate_virtdevice(struct se_hba *hba, const char *name)
387 struct pscsi_dev_virt *pdv;
389 pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
391 printk(KERN_ERR "Unable to allocate memory for struct pscsi_dev_virt\n");
394 pdv->pdv_se_hba = hba;
396 printk(KERN_INFO "PSCSI: Allocated pdv: %p for %s\n", pdv, name);
401 * Called with struct Scsi_Host->host_lock called.
403 static struct se_device *pscsi_create_type_disk(
404 struct scsi_device *sd,
405 struct pscsi_dev_virt *pdv,
406 struct se_subsystem_dev *se_dev,
408 __releases(sh->host_lock)
410 struct se_device *dev;
411 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)pdv->pdv_se_hba->hba_ptr;
412 struct Scsi_Host *sh = sd->host;
413 struct block_device *bd;
416 if (scsi_device_get(sd)) {
417 printk(KERN_ERR "scsi_device_get() failed for %d:%d:%d:%d\n",
418 sh->host_no, sd->channel, sd->id, sd->lun);
419 spin_unlock_irq(sh->host_lock);
422 spin_unlock_irq(sh->host_lock);
424 * Claim exclusive struct block_device access to struct scsi_device
425 * for TYPE_DISK using supplied udev_path
427 bd = blkdev_get_by_path(se_dev->se_dev_udev_path,
428 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
430 printk(KERN_ERR "pSCSI: blkdev_get_by_path() failed\n");
436 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
438 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
442 printk(KERN_INFO "CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%d\n",
443 phv->phv_host_id, sh->host_no, sd->channel, sd->id, sd->lun);
449 * Called with struct Scsi_Host->host_lock called.
451 static struct se_device *pscsi_create_type_rom(
452 struct scsi_device *sd,
453 struct pscsi_dev_virt *pdv,
454 struct se_subsystem_dev *se_dev,
456 __releases(sh->host_lock)
458 struct se_device *dev;
459 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)pdv->pdv_se_hba->hba_ptr;
460 struct Scsi_Host *sh = sd->host;
463 if (scsi_device_get(sd)) {
464 printk(KERN_ERR "scsi_device_get() failed for %d:%d:%d:%d\n",
465 sh->host_no, sd->channel, sd->id, sd->lun);
466 spin_unlock_irq(sh->host_lock);
469 spin_unlock_irq(sh->host_lock);
471 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
476 printk(KERN_INFO "CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
477 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
478 sd->channel, sd->id, sd->lun);
484 *Called with struct Scsi_Host->host_lock called.
486 static struct se_device *pscsi_create_type_other(
487 struct scsi_device *sd,
488 struct pscsi_dev_virt *pdv,
489 struct se_subsystem_dev *se_dev,
491 __releases(sh->host_lock)
493 struct se_device *dev;
494 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)pdv->pdv_se_hba->hba_ptr;
495 struct Scsi_Host *sh = sd->host;
498 spin_unlock_irq(sh->host_lock);
499 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
503 printk(KERN_INFO "CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
504 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
505 sd->channel, sd->id, sd->lun);
510 static struct se_device *pscsi_create_virtdevice(
512 struct se_subsystem_dev *se_dev,
515 struct pscsi_dev_virt *pdv = (struct pscsi_dev_virt *)p;
516 struct se_device *dev;
517 struct scsi_device *sd;
518 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)hba->hba_ptr;
519 struct Scsi_Host *sh = phv->phv_lld_host;
520 int legacy_mode_enable = 0;
523 printk(KERN_ERR "Unable to locate struct pscsi_dev_virt"
525 return ERR_PTR(-EINVAL);
528 * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
529 * struct Scsi_Host we will need to bring the TCM/pSCSI object online
532 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
533 printk(KERN_ERR "pSCSI: Unable to locate struct"
534 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
535 return ERR_PTR(-ENODEV);
538 * For the newer PHV_VIRUTAL_HOST_ID struct scsi_device
539 * reference, we enforce that udev_path has been set
541 if (!(se_dev->su_dev_flags & SDF_USING_UDEV_PATH)) {
542 printk(KERN_ERR "pSCSI: udev_path attribute has not"
543 " been set before ENABLE=1\n");
544 return ERR_PTR(-EINVAL);
547 * If no scsi_host_id= was passed for PHV_VIRUTAL_HOST_ID,
548 * use the original TCM hba ID to reference Linux/SCSI Host No
549 * and enable for PHV_LLD_SCSI_HOST_NO mode.
551 if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
552 spin_lock(&hba->device_lock);
553 if (!(list_empty(&hba->hba_dev_list))) {
554 printk(KERN_ERR "pSCSI: Unable to set hba_mode"
555 " with active devices\n");
556 spin_unlock(&hba->device_lock);
557 return ERR_PTR(-EEXIST);
559 spin_unlock(&hba->device_lock);
561 if (pscsi_pmode_enable_hba(hba, 1) != 1)
562 return ERR_PTR(-ENODEV);
564 legacy_mode_enable = 1;
565 hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
566 sh = phv->phv_lld_host;
568 sh = scsi_host_lookup(pdv->pdv_host_id);
570 printk(KERN_ERR "pSCSI: Unable to locate"
571 " pdv_host_id: %d\n", pdv->pdv_host_id);
572 return (struct se_device *) sh;
576 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID) {
577 printk(KERN_ERR "pSCSI: PHV_VIRUTAL_HOST_ID set while"
578 " struct Scsi_Host exists\n");
579 return ERR_PTR(-EEXIST);
583 spin_lock_irq(sh->host_lock);
584 list_for_each_entry(sd, &sh->__devices, siblings) {
585 if ((pdv->pdv_channel_id != sd->channel) ||
586 (pdv->pdv_target_id != sd->id) ||
587 (pdv->pdv_lun_id != sd->lun))
590 * Functions will release the held struct scsi_host->host_lock
591 * before calling calling pscsi_add_device_to_list() to register
592 * struct scsi_device with target_core_mod.
596 dev = pscsi_create_type_disk(sd, pdv, se_dev, hba);
599 dev = pscsi_create_type_rom(sd, pdv, se_dev, hba);
602 dev = pscsi_create_type_other(sd, pdv, se_dev, hba);
607 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
609 else if (legacy_mode_enable) {
610 pscsi_pmode_enable_hba(hba, 0);
611 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
614 return ERR_PTR(-ENODEV);
618 spin_unlock_irq(sh->host_lock);
620 printk(KERN_ERR "pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
621 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id);
623 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
625 else if (legacy_mode_enable) {
626 pscsi_pmode_enable_hba(hba, 0);
627 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
630 return ERR_PTR(-ENODEV);
633 /* pscsi_free_device(): (Part of se_subsystem_api_t template)
637 static void pscsi_free_device(void *p)
639 struct pscsi_dev_virt *pdv = p;
640 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
641 struct scsi_device *sd = pdv->pdv_sd;
645 * Release exclusive pSCSI internal struct block_device claim for
646 * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
648 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
649 blkdev_put(pdv->pdv_bd,
650 FMODE_WRITE|FMODE_READ|FMODE_EXCL);
654 * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
655 * to struct Scsi_Host now.
657 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
658 (phv->phv_lld_host != NULL))
659 scsi_host_put(phv->phv_lld_host);
661 if ((sd->type == TYPE_DISK) || (sd->type == TYPE_ROM))
670 static inline struct pscsi_plugin_task *PSCSI_TASK(struct se_task *task)
672 return container_of(task, struct pscsi_plugin_task, pscsi_task);
676 /* pscsi_transport_complete():
680 static int pscsi_transport_complete(struct se_task *task)
682 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
683 struct scsi_device *sd = pdv->pdv_sd;
685 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
686 unsigned char *cdb = &pt->pscsi_cdb[0];
688 result = pt->pscsi_result;
690 * Hack to make sure that Write-Protect modepage is set if R/O mode is
693 if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
694 (status_byte(result) << 1) == SAM_STAT_GOOD) {
695 if (!task->task_se_cmd->se_deve)
696 goto after_mode_sense;
698 if (task->task_se_cmd->se_deve->lun_flags &
699 TRANSPORT_LUNFLAGS_READ_ONLY) {
700 unsigned char *buf = task->task_se_cmd->t_task->t_task_buf;
702 if (cdb[0] == MODE_SENSE_10) {
703 if (!(buf[3] & 0x80))
706 if (!(buf[2] & 0x80))
713 if (sd->type != TYPE_TAPE)
714 goto after_mode_select;
717 * Hack to correctly obtain the initiator requested blocksize for
718 * TYPE_TAPE. Since this value is dependent upon each tape media,
719 * struct scsi_device->sector_size will not contain the correct value
720 * by default, so we go ahead and set it so
721 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
724 if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
725 (status_byte(result) << 1) == SAM_STAT_GOOD) {
727 struct scatterlist *sg = task->task_sg;
731 buf = sg_virt(&sg[0]);
733 printk(KERN_ERR "Unable to get buf for scatterlist\n");
734 goto after_mode_select;
737 if (cdb[0] == MODE_SELECT)
740 bdl = (buf[6] << 8) | (buf[7]);
743 goto after_mode_select;
745 if (cdb[0] == MODE_SELECT)
746 blocksize = (buf[9] << 16) | (buf[10] << 8) |
749 blocksize = (buf[13] << 16) | (buf[14] << 8) |
752 sd->sector_size = blocksize;
756 if (status_byte(result) & CHECK_CONDITION)
762 static struct se_task *
763 pscsi_alloc_task(struct se_cmd *cmd)
765 struct pscsi_plugin_task *pt;
766 unsigned char *cdb = cmd->t_task->t_task_cdb;
768 pt = kzalloc(sizeof(struct pscsi_plugin_task), GFP_KERNEL);
770 printk(KERN_ERR "Unable to allocate struct pscsi_plugin_task\n");
775 * If TCM Core is signaling a > TCM_MAX_COMMAND_SIZE allocation,
776 * allocate the extended CDB buffer for per struct se_task context
779 if (cmd->t_task->t_task_cdb != cmd->t_task->__t_task_cdb) {
781 pt->pscsi_cdb = kzalloc(scsi_command_size(cdb), GFP_KERNEL);
782 if (!(pt->pscsi_cdb)) {
783 printk(KERN_ERR "pSCSI: Unable to allocate extended"
789 pt->pscsi_cdb = &pt->__pscsi_cdb[0];
791 return &pt->pscsi_task;
794 static inline void pscsi_blk_init_request(
795 struct se_task *task,
796 struct pscsi_plugin_task *pt,
801 * Defined as "scsi command" in include/linux/blkdev.h.
803 req->cmd_type = REQ_TYPE_BLOCK_PC;
805 * For the extra BIDI-COMMAND READ struct request we do not
806 * need to setup the remaining structure members
811 * Setup the done function pointer for struct request,
812 * also set the end_io_data pointer.to struct se_task.
814 req->end_io = pscsi_req_done;
815 req->end_io_data = (void *)task;
817 * Load the referenced struct se_task's SCSI CDB into
818 * include/linux/blkdev.h:struct request->cmd
820 req->cmd_len = scsi_command_size(pt->pscsi_cdb);
821 req->cmd = &pt->pscsi_cdb[0];
823 * Setup pointer for outgoing sense data.
825 req->sense = (void *)&pt->pscsi_sense[0];
830 * Used for pSCSI data payloads for all *NON* SCF_SCSI_DATA_SG_IO_CDB
832 static int pscsi_blk_get_request(struct se_task *task)
834 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
835 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
837 pt->pscsi_req = blk_get_request(pdv->pdv_sd->request_queue,
838 (task->task_data_direction == DMA_TO_DEVICE),
840 if (!(pt->pscsi_req) || IS_ERR(pt->pscsi_req)) {
841 printk(KERN_ERR "PSCSI: blk_get_request() failed: %ld\n",
842 IS_ERR(pt->pscsi_req));
843 return PYX_TRANSPORT_LU_COMM_FAILURE;
846 * Setup the newly allocated struct request for REQ_TYPE_BLOCK_PC,
847 * and setup rq callback, CDB and sense.
849 pscsi_blk_init_request(task, pt, pt->pscsi_req, 0);
853 /* pscsi_do_task(): (Part of se_subsystem_api_t template)
857 static int pscsi_do_task(struct se_task *task)
859 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
860 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
862 * Set the struct request->timeout value based on peripheral
863 * device type from SCSI.
865 if (pdv->pdv_sd->type == TYPE_DISK)
866 pt->pscsi_req->timeout = PS_TIMEOUT_DISK;
868 pt->pscsi_req->timeout = PS_TIMEOUT_OTHER;
870 pt->pscsi_req->retries = PS_RETRY;
872 * Queue the struct request into the struct scsi_device->request_queue.
873 * Also check for HEAD_OF_QUEUE SAM TASK attr from received se_cmd
876 blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, pt->pscsi_req,
877 (task->task_se_cmd->sam_task_attr == MSG_HEAD_TAG),
880 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
883 static void pscsi_free_task(struct se_task *task)
885 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
886 struct se_cmd *cmd = task->task_se_cmd;
889 * Release the extended CDB allocation from pscsi_alloc_task()
892 if (cmd->t_task->t_task_cdb != cmd->t_task->__t_task_cdb)
893 kfree(pt->pscsi_cdb);
895 * We do not release the bio(s) here associated with this task, as
896 * this is handled by bio_put() and pscsi_bi_endio().
902 Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
903 Opt_scsi_lun_id, Opt_err
906 static match_table_t tokens = {
907 {Opt_scsi_host_id, "scsi_host_id=%d"},
908 {Opt_scsi_channel_id, "scsi_channel_id=%d"},
909 {Opt_scsi_target_id, "scsi_target_id=%d"},
910 {Opt_scsi_lun_id, "scsi_lun_id=%d"},
914 static ssize_t pscsi_set_configfs_dev_params(struct se_hba *hba,
915 struct se_subsystem_dev *se_dev,
919 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
920 struct pscsi_hba_virt *phv = hba->hba_ptr;
921 char *orig, *ptr, *opts;
922 substring_t args[MAX_OPT_ARGS];
923 int ret = 0, arg, token;
925 opts = kstrdup(page, GFP_KERNEL);
931 while ((ptr = strsep(&opts, ",")) != NULL) {
935 token = match_token(ptr, tokens, args);
937 case Opt_scsi_host_id:
938 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
939 printk(KERN_ERR "PSCSI[%d]: Unable to accept"
940 " scsi_host_id while phv_mode =="
941 " PHV_LLD_SCSI_HOST_NO\n",
946 match_int(args, &arg);
947 pdv->pdv_host_id = arg;
948 printk(KERN_INFO "PSCSI[%d]: Referencing SCSI Host ID:"
949 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
950 pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
952 case Opt_scsi_channel_id:
953 match_int(args, &arg);
954 pdv->pdv_channel_id = arg;
955 printk(KERN_INFO "PSCSI[%d]: Referencing SCSI Channel"
956 " ID: %d\n", phv->phv_host_id,
957 pdv->pdv_channel_id);
958 pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
960 case Opt_scsi_target_id:
961 match_int(args, &arg);
962 pdv->pdv_target_id = arg;
963 printk(KERN_INFO "PSCSI[%d]: Referencing SCSI Target"
964 " ID: %d\n", phv->phv_host_id,
966 pdv->pdv_flags |= PDF_HAS_TARGET_ID;
968 case Opt_scsi_lun_id:
969 match_int(args, &arg);
970 pdv->pdv_lun_id = arg;
971 printk(KERN_INFO "PSCSI[%d]: Referencing SCSI LUN ID:"
972 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
973 pdv->pdv_flags |= PDF_HAS_LUN_ID;
982 return (!ret) ? count : ret;
985 static ssize_t pscsi_check_configfs_dev_params(
987 struct se_subsystem_dev *se_dev)
989 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
991 if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
992 !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
993 !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
994 printk(KERN_ERR "Missing scsi_channel_id=, scsi_target_id= and"
995 " scsi_lun_id= parameters\n");
1002 static ssize_t pscsi_show_configfs_dev_params(struct se_hba *hba,
1003 struct se_subsystem_dev *se_dev,
1006 struct pscsi_hba_virt *phv = hba->hba_ptr;
1007 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
1008 struct scsi_device *sd = pdv->pdv_sd;
1009 unsigned char host_id[16];
1013 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
1014 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
1016 snprintf(host_id, 16, "PHBA Mode");
1018 bl = sprintf(b, "SCSI Device Bus Location:"
1019 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
1020 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
1024 bl += sprintf(b + bl, " ");
1025 bl += sprintf(b + bl, "Vendor: ");
1026 for (i = 0; i < 8; i++) {
1027 if (ISPRINT(sd->vendor[i])) /* printable character? */
1028 bl += sprintf(b + bl, "%c", sd->vendor[i]);
1030 bl += sprintf(b + bl, " ");
1032 bl += sprintf(b + bl, " Model: ");
1033 for (i = 0; i < 16; i++) {
1034 if (ISPRINT(sd->model[i])) /* printable character ? */
1035 bl += sprintf(b + bl, "%c", sd->model[i]);
1037 bl += sprintf(b + bl, " ");
1039 bl += sprintf(b + bl, " Rev: ");
1040 for (i = 0; i < 4; i++) {
1041 if (ISPRINT(sd->rev[i])) /* printable character ? */
1042 bl += sprintf(b + bl, "%c", sd->rev[i]);
1044 bl += sprintf(b + bl, " ");
1046 bl += sprintf(b + bl, "\n");
1051 static void pscsi_bi_endio(struct bio *bio, int error)
1056 static inline struct bio *pscsi_get_bio(struct pscsi_dev_virt *pdv, int sg_num)
1060 * Use bio_malloc() following the comment in for bio -> struct request
1061 * in block/blk-core.c:blk_make_request()
1063 bio = bio_kmalloc(GFP_KERNEL, sg_num);
1065 printk(KERN_ERR "PSCSI: bio_kmalloc() failed\n");
1068 bio->bi_end_io = pscsi_bi_endio;
1074 #define DEBUG_PSCSI(x...) printk(x)
1076 #define DEBUG_PSCSI(x...)
1079 static int __pscsi_map_task_SG(
1080 struct se_task *task,
1081 struct scatterlist *task_sg,
1085 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1086 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
1087 struct bio *bio = NULL, *hbio = NULL, *tbio = NULL;
1089 struct scatterlist *sg;
1090 u32 data_len = task->task_size, i, len, bytes, off;
1091 int nr_pages = (task->task_size + task_sg[0].offset +
1092 PAGE_SIZE - 1) >> PAGE_SHIFT;
1093 int nr_vecs = 0, rc, ret = PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
1094 int rw = (task->task_data_direction == DMA_TO_DEVICE);
1096 if (!task->task_size)
1099 * For SCF_SCSI_DATA_SG_IO_CDB, Use fs/bio.c:bio_add_page() to setup
1100 * the bio_vec maplist from TC< struct se_mem -> task->task_sg ->
1101 * struct scatterlist memory. The struct se_task->task_sg[] currently needs
1102 * to be attached to struct bios for submission to Linux/SCSI using
1103 * struct request to struct scsi_device->request_queue.
1105 * Note that this will be changing post v2.6.28 as Target_Core_Mod/pSCSI
1106 * is ported to upstream SCSI passthrough functionality that accepts
1107 * struct scatterlist->page_link or struct page as a paraemeter.
1109 DEBUG_PSCSI("PSCSI: nr_pages: %d\n", nr_pages);
1111 for_each_sg(task_sg, sg, task_sg_num, i) {
1116 DEBUG_PSCSI("PSCSI: i: %d page: %p len: %d off: %d\n", i,
1119 while (len > 0 && data_len > 0) {
1120 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
1121 bytes = min(bytes, data_len);
1124 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
1125 nr_pages -= nr_vecs;
1127 * Calls bio_kmalloc() and sets bio->bi_end_io()
1129 bio = pscsi_get_bio(pdv, nr_vecs);
1134 bio->bi_rw |= REQ_WRITE;
1136 DEBUG_PSCSI("PSCSI: Allocated bio: %p,"
1137 " dir: %s nr_vecs: %d\n", bio,
1138 (rw) ? "rw" : "r", nr_vecs);
1140 * Set *hbio pointer to handle the case:
1141 * nr_pages > BIO_MAX_PAGES, where additional
1142 * bios need to be added to complete a given
1148 tbio = tbio->bi_next = bio;
1151 DEBUG_PSCSI("PSCSI: Calling bio_add_pc_page() i: %d"
1152 " bio: %p page: %p len: %d off: %d\n", i, bio,
1155 rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
1156 bio, page, bytes, off);
1160 DEBUG_PSCSI("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
1161 bio->bi_vcnt, nr_vecs);
1163 if (bio->bi_vcnt > nr_vecs) {
1164 DEBUG_PSCSI("PSCSI: Reached bio->bi_vcnt max:"
1165 " %d i: %d bio: %p, allocating another"
1166 " bio\n", bio->bi_vcnt, i, bio);
1168 * Clear the pointer so that another bio will
1169 * be allocated with pscsi_get_bio() above, the
1170 * current bio has already been set *tbio and
1183 * Setup the primary pt->pscsi_req used for non BIDI and BIDI-COMMAND
1184 * primary SCSI WRITE poayload mapped for struct se_task->task_sg[]
1188 * Starting with v2.6.31, call blk_make_request() passing in *hbio to
1189 * allocate the pSCSI task a struct request.
1191 pt->pscsi_req = blk_make_request(pdv->pdv_sd->request_queue,
1193 if (!(pt->pscsi_req)) {
1194 printk(KERN_ERR "pSCSI: blk_make_request() failed\n");
1198 * Setup the newly allocated struct request for REQ_TYPE_BLOCK_PC,
1199 * and setup rq callback, CDB and sense.
1201 pscsi_blk_init_request(task, pt, pt->pscsi_req, 0);
1203 return task->task_sg_num;
1206 * Setup the secondary pt->pscsi_req->next_rq used for the extra BIDI-COMMAND
1207 * SCSI READ paylaod mapped for struct se_task->task_sg_bidi[]
1209 pt->pscsi_req->next_rq = blk_make_request(pdv->pdv_sd->request_queue,
1211 if (!(pt->pscsi_req->next_rq)) {
1212 printk(KERN_ERR "pSCSI: blk_make_request() failed for BIDI\n");
1215 pscsi_blk_init_request(task, pt, pt->pscsi_req->next_rq, 1);
1217 return task->task_sg_num;
1221 hbio = hbio->bi_next;
1222 bio->bi_next = NULL;
1228 static int pscsi_map_task_SG(struct se_task *task)
1233 * Setup the main struct request for the task->task_sg[] payload
1236 ret = __pscsi_map_task_SG(task, task->task_sg, task->task_sg_num, 0);
1237 if (ret >= 0 && task->task_sg_bidi) {
1239 * If present, set up the extra BIDI-COMMAND SCSI READ
1240 * struct request and payload.
1242 ret = __pscsi_map_task_SG(task, task->task_sg_bidi,
1243 task->task_sg_num, 1);
1247 return PYX_TRANSPORT_LU_COMM_FAILURE;
1251 /* pscsi_map_task_non_SG():
1255 static int pscsi_map_task_non_SG(struct se_task *task)
1257 struct se_cmd *cmd = task->task_se_cmd;
1258 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1259 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
1262 if (pscsi_blk_get_request(task) < 0)
1263 return PYX_TRANSPORT_LU_COMM_FAILURE;
1265 if (!task->task_size)
1268 ret = blk_rq_map_kern(pdv->pdv_sd->request_queue,
1269 pt->pscsi_req, cmd->t_task->t_task_buf,
1270 task->task_size, GFP_KERNEL);
1272 printk(KERN_ERR "PSCSI: blk_rq_map_kern() failed: %d\n", ret);
1273 return PYX_TRANSPORT_LU_COMM_FAILURE;
1278 static int pscsi_CDB_none(struct se_task *task)
1280 return pscsi_blk_get_request(task);
1287 static unsigned char *pscsi_get_cdb(struct se_task *task)
1289 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1291 return pt->pscsi_cdb;
1294 /* pscsi_get_sense_buffer():
1298 static unsigned char *pscsi_get_sense_buffer(struct se_task *task)
1300 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1302 return (unsigned char *)&pt->pscsi_sense[0];
1305 /* pscsi_get_device_rev():
1309 static u32 pscsi_get_device_rev(struct se_device *dev)
1311 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1312 struct scsi_device *sd = pdv->pdv_sd;
1314 return (sd->scsi_level - 1) ? sd->scsi_level - 1 : 1;
1317 /* pscsi_get_device_type():
1321 static u32 pscsi_get_device_type(struct se_device *dev)
1323 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1324 struct scsi_device *sd = pdv->pdv_sd;
1329 static sector_t pscsi_get_blocks(struct se_device *dev)
1331 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1333 if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1334 return pdv->pdv_bd->bd_part->nr_sects;
1340 /* pscsi_handle_SAM_STATUS_failures():
1344 static inline void pscsi_process_SAM_status(
1345 struct se_task *task,
1346 struct pscsi_plugin_task *pt)
1348 task->task_scsi_status = status_byte(pt->pscsi_result);
1349 if ((task->task_scsi_status)) {
1350 task->task_scsi_status <<= 1;
1351 printk(KERN_INFO "PSCSI Status Byte exception at task: %p CDB:"
1352 " 0x%02x Result: 0x%08x\n", task, pt->pscsi_cdb[0],
1356 switch (host_byte(pt->pscsi_result)) {
1358 transport_complete_task(task, (!task->task_scsi_status));
1361 printk(KERN_INFO "PSCSI Host Byte exception at task: %p CDB:"
1362 " 0x%02x Result: 0x%08x\n", task, pt->pscsi_cdb[0],
1364 task->task_scsi_status = SAM_STAT_CHECK_CONDITION;
1365 task->task_error_status = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1366 task->task_se_cmd->transport_error_status =
1367 PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1368 transport_complete_task(task, 0);
1373 static void pscsi_req_done(struct request *req, int uptodate)
1375 struct se_task *task = req->end_io_data;
1376 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1378 pt->pscsi_result = req->errors;
1379 pt->pscsi_resid = req->resid_len;
1381 pscsi_process_SAM_status(task, pt);
1383 * Release BIDI-READ if present
1385 if (req->next_rq != NULL)
1386 __blk_put_request(req->q, req->next_rq);
1388 __blk_put_request(req->q, req);
1389 pt->pscsi_req = NULL;
1392 static struct se_subsystem_api pscsi_template = {
1394 .owner = THIS_MODULE,
1395 .transport_type = TRANSPORT_PLUGIN_PHBA_PDEV,
1396 .cdb_none = pscsi_CDB_none,
1397 .map_task_non_SG = pscsi_map_task_non_SG,
1398 .map_task_SG = pscsi_map_task_SG,
1399 .attach_hba = pscsi_attach_hba,
1400 .detach_hba = pscsi_detach_hba,
1401 .pmode_enable_hba = pscsi_pmode_enable_hba,
1402 .allocate_virtdevice = pscsi_allocate_virtdevice,
1403 .create_virtdevice = pscsi_create_virtdevice,
1404 .free_device = pscsi_free_device,
1405 .transport_complete = pscsi_transport_complete,
1406 .alloc_task = pscsi_alloc_task,
1407 .do_task = pscsi_do_task,
1408 .free_task = pscsi_free_task,
1409 .check_configfs_dev_params = pscsi_check_configfs_dev_params,
1410 .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1411 .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1412 .get_cdb = pscsi_get_cdb,
1413 .get_sense_buffer = pscsi_get_sense_buffer,
1414 .get_device_rev = pscsi_get_device_rev,
1415 .get_device_type = pscsi_get_device_type,
1416 .get_blocks = pscsi_get_blocks,
1419 static int __init pscsi_module_init(void)
1421 return transport_subsystem_register(&pscsi_template);
1424 static void pscsi_module_exit(void)
1426 transport_subsystem_release(&pscsi_template);
1429 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1430 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1431 MODULE_LICENSE("GPL");
1433 module_init(pscsi_module_init);
1434 module_exit(pscsi_module_exit);