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/string.h>
30 #include <linux/parser.h>
31 #include <linux/timer.h>
32 #include <linux/blkdev.h>
33 #include <linux/blk_types.h>
34 #include <linux/slab.h>
35 #include <linux/spinlock.h>
36 #include <linux/genhd.h>
37 #include <linux/cdrom.h>
38 #include <linux/file.h>
39 #include <linux/module.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_backend.h>
49 #include "target_core_pscsi.h"
51 #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
53 static struct se_subsystem_api pscsi_template;
55 static void pscsi_req_done(struct request *, int);
57 /* pscsi_attach_hba():
59 * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
60 * from the passed SCSI Host ID.
62 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
64 struct pscsi_hba_virt *phv;
66 phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
68 pr_err("Unable to allocate struct pscsi_hba_virt\n");
71 phv->phv_host_id = host_id;
72 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
76 pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
77 " Generic Target Core Stack %s\n", hba->hba_id,
78 PSCSI_VERSION, TARGET_CORE_MOD_VERSION);
79 pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
85 static void pscsi_detach_hba(struct se_hba *hba)
87 struct pscsi_hba_virt *phv = hba->hba_ptr;
88 struct Scsi_Host *scsi_host = phv->phv_lld_host;
91 scsi_host_put(scsi_host);
93 pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
94 " Generic Target Core\n", hba->hba_id,
95 (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
98 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
99 " from Generic Target Core\n", hba->hba_id);
105 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
107 struct pscsi_hba_virt *phv = hba->hba_ptr;
108 struct Scsi_Host *sh = phv->phv_lld_host;
110 * Release the struct Scsi_Host
116 phv->phv_lld_host = NULL;
117 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
119 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
120 " %s\n", hba->hba_id, (sh->hostt->name) ?
121 (sh->hostt->name) : "Unknown");
127 * Otherwise, locate struct Scsi_Host from the original passed
128 * pSCSI Host ID and enable for phba mode
130 sh = scsi_host_lookup(phv->phv_host_id);
132 pr_err("pSCSI: Unable to locate SCSI Host for"
133 " phv_host_id: %d\n", phv->phv_host_id);
137 phv->phv_lld_host = sh;
138 phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
140 pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
141 hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
146 static void pscsi_tape_read_blocksize(struct se_device *dev,
147 struct scsi_device *sdev)
149 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
152 buf = kzalloc(12, GFP_KERNEL);
156 memset(cdb, 0, MAX_COMMAND_SIZE);
158 cdb[4] = 0x0c; /* 12 bytes */
160 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
166 * If MODE_SENSE still returns zero, set the default value to 1024.
168 sdev->sector_size = (buf[9] << 16) | (buf[10] << 8) | (buf[11]);
169 if (!sdev->sector_size)
170 sdev->sector_size = 1024;
176 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
180 if (sdev->inquiry_len < INQUIRY_LEN)
187 * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
189 memcpy(&wwn->vendor[0], &buf[8], sizeof(wwn->vendor));
190 memcpy(&wwn->model[0], &buf[16], sizeof(wwn->model));
191 memcpy(&wwn->revision[0], &buf[32], sizeof(wwn->revision));
195 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
197 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
200 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
204 memset(cdb, 0, MAX_COMMAND_SIZE);
206 cdb[1] = 0x01; /* Query VPD */
207 cdb[2] = 0x80; /* Unit Serial Number */
208 cdb[3] = (INQUIRY_VPD_SERIAL_LEN >> 8) & 0xff;
209 cdb[4] = (INQUIRY_VPD_SERIAL_LEN & 0xff);
211 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
212 INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
216 snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
218 wwn->t10_sub_dev->su_dev_flags |= SDF_FIRMWARE_VPD_UNIT_SERIAL;
229 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
232 unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
233 int ident_len, page_len, off = 4, ret;
236 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
240 memset(cdb, 0, MAX_COMMAND_SIZE);
242 cdb[1] = 0x01; /* Query VPD */
243 cdb[2] = 0x83; /* Device Identifier */
244 cdb[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN >> 8) & 0xff;
245 cdb[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN & 0xff);
247 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
248 INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
253 page_len = (buf[2] << 8) | buf[3];
254 while (page_len > 0) {
255 /* Grab a pointer to the Identification descriptor */
257 ident_len = page_83[3];
259 pr_err("page_83[3]: identifier"
263 pr_debug("T10 VPD Identifer Length: %d\n", ident_len);
265 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
267 pr_err("Unable to allocate memory for"
268 " struct t10_vpd\n");
271 INIT_LIST_HEAD(&vpd->vpd_list);
273 transport_set_vpd_proto_id(vpd, page_83);
274 transport_set_vpd_assoc(vpd, page_83);
276 if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
277 off += (ident_len + 4);
278 page_len -= (ident_len + 4);
282 if (transport_set_vpd_ident(vpd, page_83) < 0) {
283 off += (ident_len + 4);
284 page_len -= (ident_len + 4);
289 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
290 off += (ident_len + 4);
291 page_len -= (ident_len + 4);
298 /* pscsi_add_device_to_list():
302 static struct se_device *pscsi_add_device_to_list(
304 struct se_subsystem_dev *se_dev,
305 struct pscsi_dev_virt *pdv,
306 struct scsi_device *sd,
309 struct se_device *dev;
310 struct se_dev_limits dev_limits;
311 struct request_queue *q;
312 struct queue_limits *limits;
314 memset(&dev_limits, 0, sizeof(struct se_dev_limits));
316 if (!sd->queue_depth) {
317 sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
319 pr_err("Set broken SCSI Device %d:%d:%d"
320 " queue_depth to %d\n", sd->channel, sd->id,
321 sd->lun, sd->queue_depth);
324 * Setup the local scope queue_limits from struct request_queue->limits
325 * to pass into transport_add_device_to_core_hba() as struct se_dev_limits.
327 q = sd->request_queue;
328 limits = &dev_limits.limits;
329 limits->logical_block_size = sd->sector_size;
330 limits->max_hw_sectors = min_t(int, sd->host->max_sectors, queue_max_hw_sectors(q));
331 limits->max_sectors = min_t(int, sd->host->max_sectors, queue_max_sectors(q));
332 dev_limits.hw_queue_depth = sd->queue_depth;
333 dev_limits.queue_depth = sd->queue_depth;
335 * Setup our standard INQUIRY info into se_dev->t10_wwn
337 pscsi_set_inquiry_info(sd, &se_dev->t10_wwn);
340 * Set the pointer pdv->pdv_sd to from passed struct scsi_device,
341 * which has already been referenced with Linux SCSI code with
342 * scsi_device_get() in this file's pscsi_create_virtdevice().
344 * The passthrough operations called by the transport_add_device_*
345 * function below will require this pointer to be set for passthroug
348 * For the shutdown case in pscsi_free_device(), this struct
349 * scsi_device reference is released with Linux SCSI code
350 * scsi_device_put() and the pdv->pdv_sd cleared.
353 dev = transport_add_device_to_core_hba(hba, &pscsi_template,
354 se_dev, dev_flags, pdv,
355 &dev_limits, NULL, NULL);
362 * Locate VPD WWN Information used for various purposes within
363 * the Storage Engine.
365 if (!pscsi_get_inquiry_vpd_serial(sd, &se_dev->t10_wwn)) {
367 * If VPD Unit Serial returned GOOD status, try
368 * VPD Device Identification page (0x83).
370 pscsi_get_inquiry_vpd_device_ident(sd, &se_dev->t10_wwn);
374 * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
376 if (sd->type == TYPE_TAPE)
377 pscsi_tape_read_blocksize(dev, sd);
381 static void *pscsi_allocate_virtdevice(struct se_hba *hba, const char *name)
383 struct pscsi_dev_virt *pdv;
385 pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
387 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
390 pdv->pdv_se_hba = hba;
392 pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
397 * Called with struct Scsi_Host->host_lock called.
399 static struct se_device *pscsi_create_type_disk(
400 struct scsi_device *sd,
401 struct pscsi_dev_virt *pdv,
402 struct se_subsystem_dev *se_dev,
404 __releases(sh->host_lock)
406 struct se_device *dev;
407 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
408 struct Scsi_Host *sh = sd->host;
409 struct block_device *bd;
412 if (scsi_device_get(sd)) {
413 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
414 sh->host_no, sd->channel, sd->id, sd->lun);
415 spin_unlock_irq(sh->host_lock);
418 spin_unlock_irq(sh->host_lock);
420 * Claim exclusive struct block_device access to struct scsi_device
421 * for TYPE_DISK using supplied udev_path
423 bd = blkdev_get_by_path(se_dev->se_dev_udev_path,
424 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
426 pr_err("pSCSI: blkdev_get_by_path() failed\n");
432 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
434 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
438 pr_debug("CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%d\n",
439 phv->phv_host_id, sh->host_no, sd->channel, sd->id, sd->lun);
445 * Called with struct Scsi_Host->host_lock called.
447 static struct se_device *pscsi_create_type_rom(
448 struct scsi_device *sd,
449 struct pscsi_dev_virt *pdv,
450 struct se_subsystem_dev *se_dev,
452 __releases(sh->host_lock)
454 struct se_device *dev;
455 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
456 struct Scsi_Host *sh = sd->host;
459 if (scsi_device_get(sd)) {
460 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
461 sh->host_no, sd->channel, sd->id, sd->lun);
462 spin_unlock_irq(sh->host_lock);
465 spin_unlock_irq(sh->host_lock);
467 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
472 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
473 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
474 sd->channel, sd->id, sd->lun);
480 *Called with struct Scsi_Host->host_lock called.
482 static struct se_device *pscsi_create_type_other(
483 struct scsi_device *sd,
484 struct pscsi_dev_virt *pdv,
485 struct se_subsystem_dev *se_dev,
487 __releases(sh->host_lock)
489 struct se_device *dev;
490 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
491 struct Scsi_Host *sh = sd->host;
494 spin_unlock_irq(sh->host_lock);
495 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
499 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
500 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
501 sd->channel, sd->id, sd->lun);
506 static struct se_device *pscsi_create_virtdevice(
508 struct se_subsystem_dev *se_dev,
511 struct pscsi_dev_virt *pdv = p;
512 struct se_device *dev;
513 struct scsi_device *sd;
514 struct pscsi_hba_virt *phv = hba->hba_ptr;
515 struct Scsi_Host *sh = phv->phv_lld_host;
516 int legacy_mode_enable = 0;
519 pr_err("Unable to locate struct pscsi_dev_virt"
521 return ERR_PTR(-EINVAL);
524 * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
525 * struct Scsi_Host we will need to bring the TCM/pSCSI object online
528 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
529 pr_err("pSCSI: Unable to locate struct"
530 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
531 return ERR_PTR(-ENODEV);
534 * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
535 * reference, we enforce that udev_path has been set
537 if (!(se_dev->su_dev_flags & SDF_USING_UDEV_PATH)) {
538 pr_err("pSCSI: udev_path attribute has not"
539 " been set before ENABLE=1\n");
540 return ERR_PTR(-EINVAL);
543 * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
544 * use the original TCM hba ID to reference Linux/SCSI Host No
545 * and enable for PHV_LLD_SCSI_HOST_NO mode.
547 if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
548 spin_lock(&hba->device_lock);
549 if (!list_empty(&hba->hba_dev_list)) {
550 pr_err("pSCSI: Unable to set hba_mode"
551 " with active devices\n");
552 spin_unlock(&hba->device_lock);
553 return ERR_PTR(-EEXIST);
555 spin_unlock(&hba->device_lock);
557 if (pscsi_pmode_enable_hba(hba, 1) != 1)
558 return ERR_PTR(-ENODEV);
560 legacy_mode_enable = 1;
561 hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
562 sh = phv->phv_lld_host;
564 sh = scsi_host_lookup(pdv->pdv_host_id);
566 pr_err("pSCSI: Unable to locate"
567 " pdv_host_id: %d\n", pdv->pdv_host_id);
572 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID) {
573 pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
574 " struct Scsi_Host exists\n");
575 return ERR_PTR(-EEXIST);
579 spin_lock_irq(sh->host_lock);
580 list_for_each_entry(sd, &sh->__devices, siblings) {
581 if ((pdv->pdv_channel_id != sd->channel) ||
582 (pdv->pdv_target_id != sd->id) ||
583 (pdv->pdv_lun_id != sd->lun))
586 * Functions will release the held struct scsi_host->host_lock
587 * before calling calling pscsi_add_device_to_list() to register
588 * struct scsi_device with target_core_mod.
592 dev = pscsi_create_type_disk(sd, pdv, se_dev, hba);
595 dev = pscsi_create_type_rom(sd, pdv, se_dev, hba);
598 dev = pscsi_create_type_other(sd, pdv, se_dev, hba);
603 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
605 else if (legacy_mode_enable) {
606 pscsi_pmode_enable_hba(hba, 0);
607 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
610 return ERR_PTR(-ENODEV);
614 spin_unlock_irq(sh->host_lock);
616 pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
617 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id);
619 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
621 else if (legacy_mode_enable) {
622 pscsi_pmode_enable_hba(hba, 0);
623 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
626 return ERR_PTR(-ENODEV);
629 /* pscsi_free_device(): (Part of se_subsystem_api_t template)
633 static void pscsi_free_device(void *p)
635 struct pscsi_dev_virt *pdv = p;
636 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
637 struct scsi_device *sd = pdv->pdv_sd;
641 * Release exclusive pSCSI internal struct block_device claim for
642 * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
644 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
645 blkdev_put(pdv->pdv_bd,
646 FMODE_WRITE|FMODE_READ|FMODE_EXCL);
650 * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
651 * to struct Scsi_Host now.
653 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
654 (phv->phv_lld_host != NULL))
655 scsi_host_put(phv->phv_lld_host);
657 if ((sd->type == TYPE_DISK) || (sd->type == TYPE_ROM))
666 static int pscsi_transport_complete(struct se_cmd *cmd, struct scatterlist *sg)
668 struct pscsi_dev_virt *pdv = cmd->se_dev->dev_ptr;
669 struct scsi_device *sd = pdv->pdv_sd;
671 struct pscsi_plugin_task *pt = cmd->priv;
672 unsigned char *cdb = &pt->pscsi_cdb[0];
674 result = pt->pscsi_result;
676 * Hack to make sure that Write-Protect modepage is set if R/O mode is
679 if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
680 (status_byte(result) << 1) == SAM_STAT_GOOD) {
682 goto after_mode_sense;
684 if (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY) {
685 unsigned char *buf = transport_kmap_data_sg(cmd);
687 if (cdb[0] == MODE_SENSE_10) {
688 if (!(buf[3] & 0x80))
691 if (!(buf[2] & 0x80))
695 transport_kunmap_data_sg(cmd);
700 if (sd->type != TYPE_TAPE)
701 goto after_mode_select;
704 * Hack to correctly obtain the initiator requested blocksize for
705 * TYPE_TAPE. Since this value is dependent upon each tape media,
706 * struct scsi_device->sector_size will not contain the correct value
707 * by default, so we go ahead and set it so
708 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
711 if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
712 (status_byte(result) << 1) == SAM_STAT_GOOD) {
717 buf = sg_virt(&sg[0]);
719 pr_err("Unable to get buf for scatterlist\n");
720 goto after_mode_select;
723 if (cdb[0] == MODE_SELECT)
726 bdl = (buf[6] << 8) | (buf[7]);
729 goto after_mode_select;
731 if (cdb[0] == MODE_SELECT)
732 blocksize = (buf[9] << 16) | (buf[10] << 8) |
735 blocksize = (buf[13] << 16) | (buf[14] << 8) |
738 sd->sector_size = blocksize;
742 if (status_byte(result) & CHECK_CONDITION)
749 Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
750 Opt_scsi_lun_id, Opt_err
753 static match_table_t tokens = {
754 {Opt_scsi_host_id, "scsi_host_id=%d"},
755 {Opt_scsi_channel_id, "scsi_channel_id=%d"},
756 {Opt_scsi_target_id, "scsi_target_id=%d"},
757 {Opt_scsi_lun_id, "scsi_lun_id=%d"},
761 static ssize_t pscsi_set_configfs_dev_params(struct se_hba *hba,
762 struct se_subsystem_dev *se_dev,
766 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
767 struct pscsi_hba_virt *phv = hba->hba_ptr;
768 char *orig, *ptr, *opts;
769 substring_t args[MAX_OPT_ARGS];
770 int ret = 0, arg, token;
772 opts = kstrdup(page, GFP_KERNEL);
778 while ((ptr = strsep(&opts, ",\n")) != NULL) {
782 token = match_token(ptr, tokens, args);
784 case Opt_scsi_host_id:
785 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
786 pr_err("PSCSI[%d]: Unable to accept"
787 " scsi_host_id while phv_mode =="
788 " PHV_LLD_SCSI_HOST_NO\n",
793 match_int(args, &arg);
794 pdv->pdv_host_id = arg;
795 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
796 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
797 pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
799 case Opt_scsi_channel_id:
800 match_int(args, &arg);
801 pdv->pdv_channel_id = arg;
802 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
803 " ID: %d\n", phv->phv_host_id,
804 pdv->pdv_channel_id);
805 pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
807 case Opt_scsi_target_id:
808 match_int(args, &arg);
809 pdv->pdv_target_id = arg;
810 pr_debug("PSCSI[%d]: Referencing SCSI Target"
811 " ID: %d\n", phv->phv_host_id,
813 pdv->pdv_flags |= PDF_HAS_TARGET_ID;
815 case Opt_scsi_lun_id:
816 match_int(args, &arg);
817 pdv->pdv_lun_id = arg;
818 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
819 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
820 pdv->pdv_flags |= PDF_HAS_LUN_ID;
829 return (!ret) ? count : ret;
832 static ssize_t pscsi_check_configfs_dev_params(
834 struct se_subsystem_dev *se_dev)
836 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
838 if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
839 !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
840 !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
841 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
842 " scsi_lun_id= parameters\n");
849 static ssize_t pscsi_show_configfs_dev_params(struct se_hba *hba,
850 struct se_subsystem_dev *se_dev,
853 struct pscsi_hba_virt *phv = hba->hba_ptr;
854 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
855 struct scsi_device *sd = pdv->pdv_sd;
856 unsigned char host_id[16];
860 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
861 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
863 snprintf(host_id, 16, "PHBA Mode");
865 bl = sprintf(b, "SCSI Device Bus Location:"
866 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
867 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
871 bl += sprintf(b + bl, " ");
872 bl += sprintf(b + bl, "Vendor: ");
873 for (i = 0; i < 8; i++) {
874 if (ISPRINT(sd->vendor[i])) /* printable character? */
875 bl += sprintf(b + bl, "%c", sd->vendor[i]);
877 bl += sprintf(b + bl, " ");
879 bl += sprintf(b + bl, " Model: ");
880 for (i = 0; i < 16; i++) {
881 if (ISPRINT(sd->model[i])) /* printable character ? */
882 bl += sprintf(b + bl, "%c", sd->model[i]);
884 bl += sprintf(b + bl, " ");
886 bl += sprintf(b + bl, " Rev: ");
887 for (i = 0; i < 4; i++) {
888 if (ISPRINT(sd->rev[i])) /* printable character ? */
889 bl += sprintf(b + bl, "%c", sd->rev[i]);
891 bl += sprintf(b + bl, " ");
893 bl += sprintf(b + bl, "\n");
898 static void pscsi_bi_endio(struct bio *bio, int error)
903 static inline struct bio *pscsi_get_bio(int sg_num)
907 * Use bio_malloc() following the comment in for bio -> struct request
908 * in block/blk-core.c:blk_make_request()
910 bio = bio_kmalloc(GFP_KERNEL, sg_num);
912 pr_err("PSCSI: bio_kmalloc() failed\n");
915 bio->bi_end_io = pscsi_bi_endio;
920 static int pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl,
921 u32 sgl_nents, enum dma_data_direction data_direction,
924 struct pscsi_dev_virt *pdv = cmd->se_dev->dev_ptr;
925 struct bio *bio = NULL, *tbio = NULL;
927 struct scatterlist *sg;
928 u32 data_len = cmd->data_length, i, len, bytes, off;
929 int nr_pages = (cmd->data_length + sgl[0].offset +
930 PAGE_SIZE - 1) >> PAGE_SHIFT;
932 int rw = (data_direction == DMA_TO_DEVICE);
936 pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
938 for_each_sg(sgl, sg, sgl_nents, i) {
943 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
946 while (len > 0 && data_len > 0) {
947 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
948 bytes = min(bytes, data_len);
951 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
954 * Calls bio_kmalloc() and sets bio->bi_end_io()
956 bio = pscsi_get_bio(nr_vecs);
961 bio->bi_rw |= REQ_WRITE;
963 pr_debug("PSCSI: Allocated bio: %p,"
964 " dir: %s nr_vecs: %d\n", bio,
965 (rw) ? "rw" : "r", nr_vecs);
967 * Set *hbio pointer to handle the case:
968 * nr_pages > BIO_MAX_PAGES, where additional
969 * bios need to be added to complete a given
975 tbio = tbio->bi_next = bio;
978 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
979 " bio: %p page: %p len: %d off: %d\n", i, bio,
982 rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
983 bio, page, bytes, off);
987 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
988 bio->bi_vcnt, nr_vecs);
990 if (bio->bi_vcnt > nr_vecs) {
991 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
992 " %d i: %d bio: %p, allocating another"
993 " bio\n", bio->bi_vcnt, i, bio);
995 * Clear the pointer so that another bio will
996 * be allocated with pscsi_get_bio() above, the
997 * current bio has already been set *tbio and
1014 *hbio = (*hbio)->bi_next;
1015 bio->bi_next = NULL;
1016 bio_endio(bio, 0); /* XXX: should be error */
1018 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1022 static int pscsi_execute_cmd(struct se_cmd *cmd, struct scatterlist *sgl,
1023 u32 sgl_nents, enum dma_data_direction data_direction)
1025 struct pscsi_dev_virt *pdv = cmd->se_dev->dev_ptr;
1026 struct pscsi_plugin_task *pt;
1027 struct request *req;
1032 * Dynamically alloc cdb space, since it may be larger than
1033 * TCM_MAX_COMMAND_SIZE
1035 pt = kzalloc(sizeof(*pt) + scsi_command_size(cmd->t_task_cdb), GFP_KERNEL);
1037 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1042 memcpy(pt->pscsi_cdb, cmd->t_task_cdb,
1043 scsi_command_size(cmd->t_task_cdb));
1045 if (cmd->se_cmd_flags & SCF_SCSI_NON_DATA_CDB) {
1046 req = blk_get_request(pdv->pdv_sd->request_queue,
1047 (data_direction == DMA_TO_DEVICE),
1049 if (!req || IS_ERR(req)) {
1050 pr_err("PSCSI: blk_get_request() failed: %ld\n",
1051 req ? IS_ERR(req) : -ENOMEM);
1052 cmd->scsi_sense_reason =
1053 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1057 BUG_ON(!cmd->data_length);
1059 ret = pscsi_map_sg(cmd, sgl, sgl_nents, data_direction, &hbio);
1061 cmd->scsi_sense_reason =
1062 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1066 req = blk_make_request(pdv->pdv_sd->request_queue, hbio,
1069 pr_err("pSCSI: blk_make_request() failed\n");
1074 req->cmd_type = REQ_TYPE_BLOCK_PC;
1075 req->end_io = pscsi_req_done;
1076 req->end_io_data = cmd;
1077 req->cmd_len = scsi_command_size(pt->pscsi_cdb);
1078 req->cmd = &pt->pscsi_cdb[0];
1079 req->sense = &pt->pscsi_sense[0];
1081 if (pdv->pdv_sd->type == TYPE_DISK)
1082 req->timeout = PS_TIMEOUT_DISK;
1084 req->timeout = PS_TIMEOUT_OTHER;
1085 req->retries = PS_RETRY;
1087 blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
1088 (cmd->sam_task_attr == MSG_HEAD_TAG),
1095 struct bio *bio = hbio;
1096 hbio = hbio->bi_next;
1097 bio->bi_next = NULL;
1098 bio_endio(bio, 0); /* XXX: should be error */
1100 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1106 static unsigned char *pscsi_get_sense_buffer(struct se_cmd *cmd)
1108 struct pscsi_plugin_task *pt = cmd->priv;
1110 return pt->pscsi_sense;
1113 /* pscsi_get_device_rev():
1117 static u32 pscsi_get_device_rev(struct se_device *dev)
1119 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1120 struct scsi_device *sd = pdv->pdv_sd;
1122 return (sd->scsi_level - 1) ? sd->scsi_level - 1 : 1;
1125 /* pscsi_get_device_type():
1129 static u32 pscsi_get_device_type(struct se_device *dev)
1131 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1132 struct scsi_device *sd = pdv->pdv_sd;
1137 static sector_t pscsi_get_blocks(struct se_device *dev)
1139 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1141 if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1142 return pdv->pdv_bd->bd_part->nr_sects;
1148 static void pscsi_req_done(struct request *req, int uptodate)
1150 struct se_cmd *cmd = req->end_io_data;
1151 struct pscsi_plugin_task *pt = cmd->priv;
1153 pt->pscsi_result = req->errors;
1154 pt->pscsi_resid = req->resid_len;
1156 cmd->scsi_status = status_byte(pt->pscsi_result) << 1;
1157 if (cmd->scsi_status) {
1158 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1159 " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1163 switch (host_byte(pt->pscsi_result)) {
1165 target_complete_cmd(cmd, cmd->scsi_status);
1168 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1169 " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1171 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1172 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
1176 __blk_put_request(req->q, req);
1180 static struct se_subsystem_api pscsi_template = {
1182 .owner = THIS_MODULE,
1183 .transport_type = TRANSPORT_PLUGIN_PHBA_PDEV,
1184 .attach_hba = pscsi_attach_hba,
1185 .detach_hba = pscsi_detach_hba,
1186 .pmode_enable_hba = pscsi_pmode_enable_hba,
1187 .allocate_virtdevice = pscsi_allocate_virtdevice,
1188 .create_virtdevice = pscsi_create_virtdevice,
1189 .free_device = pscsi_free_device,
1190 .transport_complete = pscsi_transport_complete,
1191 .execute_cmd = pscsi_execute_cmd,
1192 .check_configfs_dev_params = pscsi_check_configfs_dev_params,
1193 .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1194 .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1195 .get_sense_buffer = pscsi_get_sense_buffer,
1196 .get_device_rev = pscsi_get_device_rev,
1197 .get_device_type = pscsi_get_device_type,
1198 .get_blocks = pscsi_get_blocks,
1201 static int __init pscsi_module_init(void)
1203 return transport_subsystem_register(&pscsi_template);
1206 static void pscsi_module_exit(void)
1208 transport_subsystem_release(&pscsi_template);
1211 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1212 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1213 MODULE_LICENSE("GPL");
1215 module_init(pscsi_module_init);
1216 module_exit(pscsi_module_exit);