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 <scsi/scsi.h>
40 #include <scsi/scsi_device.h>
41 #include <scsi/scsi_cmnd.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_tcq.h>
45 #include <target/target_core_base.h>
46 #include <target/target_core_device.h>
47 #include <target/target_core_transport.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_VIRUTAL_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 = (struct pscsi_hba_virt *)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_VIRUTAL_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.
354 dev = transport_add_device_to_core_hba(hba, &pscsi_template,
355 se_dev, dev_flags, pdv,
356 &dev_limits, NULL, NULL);
363 * Locate VPD WWN Information used for various purposes within
364 * the Storage Engine.
366 if (!pscsi_get_inquiry_vpd_serial(sd, &se_dev->t10_wwn)) {
368 * If VPD Unit Serial returned GOOD status, try
369 * VPD Device Identification page (0x83).
371 pscsi_get_inquiry_vpd_device_ident(sd, &se_dev->t10_wwn);
375 * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
377 if (sd->type == TYPE_TAPE)
378 pscsi_tape_read_blocksize(dev, sd);
382 static void *pscsi_allocate_virtdevice(struct se_hba *hba, const char *name)
384 struct pscsi_dev_virt *pdv;
386 pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
388 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
391 pdv->pdv_se_hba = hba;
393 pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
398 * Called with struct Scsi_Host->host_lock called.
400 static struct se_device *pscsi_create_type_disk(
401 struct scsi_device *sd,
402 struct pscsi_dev_virt *pdv,
403 struct se_subsystem_dev *se_dev,
405 __releases(sh->host_lock)
407 struct se_device *dev;
408 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)pdv->pdv_se_hba->hba_ptr;
409 struct Scsi_Host *sh = sd->host;
410 struct block_device *bd;
413 if (scsi_device_get(sd)) {
414 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
415 sh->host_no, sd->channel, sd->id, sd->lun);
416 spin_unlock_irq(sh->host_lock);
419 spin_unlock_irq(sh->host_lock);
421 * Claim exclusive struct block_device access to struct scsi_device
422 * for TYPE_DISK using supplied udev_path
424 bd = blkdev_get_by_path(se_dev->se_dev_udev_path,
425 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
427 pr_err("pSCSI: blkdev_get_by_path() failed\n");
433 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
435 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
439 pr_debug("CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%d\n",
440 phv->phv_host_id, sh->host_no, sd->channel, sd->id, sd->lun);
446 * Called with struct Scsi_Host->host_lock called.
448 static struct se_device *pscsi_create_type_rom(
449 struct scsi_device *sd,
450 struct pscsi_dev_virt *pdv,
451 struct se_subsystem_dev *se_dev,
453 __releases(sh->host_lock)
455 struct se_device *dev;
456 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)pdv->pdv_se_hba->hba_ptr;
457 struct Scsi_Host *sh = sd->host;
460 if (scsi_device_get(sd)) {
461 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
462 sh->host_no, sd->channel, sd->id, sd->lun);
463 spin_unlock_irq(sh->host_lock);
466 spin_unlock_irq(sh->host_lock);
468 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
473 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
474 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
475 sd->channel, sd->id, sd->lun);
481 *Called with struct Scsi_Host->host_lock called.
483 static struct se_device *pscsi_create_type_other(
484 struct scsi_device *sd,
485 struct pscsi_dev_virt *pdv,
486 struct se_subsystem_dev *se_dev,
488 __releases(sh->host_lock)
490 struct se_device *dev;
491 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)pdv->pdv_se_hba->hba_ptr;
492 struct Scsi_Host *sh = sd->host;
495 spin_unlock_irq(sh->host_lock);
496 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
500 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
501 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
502 sd->channel, sd->id, sd->lun);
507 static struct se_device *pscsi_create_virtdevice(
509 struct se_subsystem_dev *se_dev,
512 struct pscsi_dev_virt *pdv = (struct pscsi_dev_virt *)p;
513 struct se_device *dev;
514 struct scsi_device *sd;
515 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)hba->hba_ptr;
516 struct Scsi_Host *sh = phv->phv_lld_host;
517 int legacy_mode_enable = 0;
520 pr_err("Unable to locate struct pscsi_dev_virt"
522 return ERR_PTR(-EINVAL);
525 * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
526 * struct Scsi_Host we will need to bring the TCM/pSCSI object online
529 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
530 pr_err("pSCSI: Unable to locate struct"
531 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
532 return ERR_PTR(-ENODEV);
535 * For the newer PHV_VIRUTAL_HOST_ID struct scsi_device
536 * reference, we enforce that udev_path has been set
538 if (!(se_dev->su_dev_flags & SDF_USING_UDEV_PATH)) {
539 pr_err("pSCSI: udev_path attribute has not"
540 " been set before ENABLE=1\n");
541 return ERR_PTR(-EINVAL);
544 * If no scsi_host_id= was passed for PHV_VIRUTAL_HOST_ID,
545 * use the original TCM hba ID to reference Linux/SCSI Host No
546 * and enable for PHV_LLD_SCSI_HOST_NO mode.
548 if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
549 spin_lock(&hba->device_lock);
550 if (!list_empty(&hba->hba_dev_list)) {
551 pr_err("pSCSI: Unable to set hba_mode"
552 " with active devices\n");
553 spin_unlock(&hba->device_lock);
554 return ERR_PTR(-EEXIST);
556 spin_unlock(&hba->device_lock);
558 if (pscsi_pmode_enable_hba(hba, 1) != 1)
559 return ERR_PTR(-ENODEV);
561 legacy_mode_enable = 1;
562 hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
563 sh = phv->phv_lld_host;
565 sh = scsi_host_lookup(pdv->pdv_host_id);
567 pr_err("pSCSI: Unable to locate"
568 " pdv_host_id: %d\n", pdv->pdv_host_id);
569 return (struct se_device *) sh;
573 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID) {
574 pr_err("pSCSI: PHV_VIRUTAL_HOST_ID set while"
575 " struct Scsi_Host exists\n");
576 return ERR_PTR(-EEXIST);
580 spin_lock_irq(sh->host_lock);
581 list_for_each_entry(sd, &sh->__devices, siblings) {
582 if ((pdv->pdv_channel_id != sd->channel) ||
583 (pdv->pdv_target_id != sd->id) ||
584 (pdv->pdv_lun_id != sd->lun))
587 * Functions will release the held struct scsi_host->host_lock
588 * before calling calling pscsi_add_device_to_list() to register
589 * struct scsi_device with target_core_mod.
593 dev = pscsi_create_type_disk(sd, pdv, se_dev, hba);
596 dev = pscsi_create_type_rom(sd, pdv, se_dev, hba);
599 dev = pscsi_create_type_other(sd, pdv, se_dev, hba);
604 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
606 else if (legacy_mode_enable) {
607 pscsi_pmode_enable_hba(hba, 0);
608 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
611 return ERR_PTR(-ENODEV);
615 spin_unlock_irq(sh->host_lock);
617 pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
618 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id);
620 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
622 else if (legacy_mode_enable) {
623 pscsi_pmode_enable_hba(hba, 0);
624 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
627 return ERR_PTR(-ENODEV);
630 /* pscsi_free_device(): (Part of se_subsystem_api_t template)
634 static void pscsi_free_device(void *p)
636 struct pscsi_dev_virt *pdv = p;
637 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
638 struct scsi_device *sd = pdv->pdv_sd;
642 * Release exclusive pSCSI internal struct block_device claim for
643 * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
645 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
646 blkdev_put(pdv->pdv_bd,
647 FMODE_WRITE|FMODE_READ|FMODE_EXCL);
651 * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
652 * to struct Scsi_Host now.
654 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
655 (phv->phv_lld_host != NULL))
656 scsi_host_put(phv->phv_lld_host);
658 if ((sd->type == TYPE_DISK) || (sd->type == TYPE_ROM))
667 static inline struct pscsi_plugin_task *PSCSI_TASK(struct se_task *task)
669 return container_of(task, struct pscsi_plugin_task, pscsi_task);
673 /* pscsi_transport_complete():
677 static int pscsi_transport_complete(struct se_task *task)
679 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
680 struct scsi_device *sd = pdv->pdv_sd;
682 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
683 unsigned char *cdb = &pt->pscsi_cdb[0];
685 result = pt->pscsi_result;
687 * Hack to make sure that Write-Protect modepage is set if R/O mode is
690 if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
691 (status_byte(result) << 1) == SAM_STAT_GOOD) {
692 if (!task->task_se_cmd->se_deve)
693 goto after_mode_sense;
695 if (task->task_se_cmd->se_deve->lun_flags &
696 TRANSPORT_LUNFLAGS_READ_ONLY) {
697 unsigned char *buf = transport_kmap_first_data_page(task->task_se_cmd);
699 if (cdb[0] == MODE_SENSE_10) {
700 if (!(buf[3] & 0x80))
703 if (!(buf[2] & 0x80))
707 transport_kunmap_first_data_page(task->task_se_cmd);
712 if (sd->type != TYPE_TAPE)
713 goto after_mode_select;
716 * Hack to correctly obtain the initiator requested blocksize for
717 * TYPE_TAPE. Since this value is dependent upon each tape media,
718 * struct scsi_device->sector_size will not contain the correct value
719 * by default, so we go ahead and set it so
720 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
723 if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
724 (status_byte(result) << 1) == SAM_STAT_GOOD) {
726 struct scatterlist *sg = task->task_sg;
730 buf = sg_virt(&sg[0]);
732 pr_err("Unable to get buf for scatterlist\n");
733 goto after_mode_select;
736 if (cdb[0] == MODE_SELECT)
739 bdl = (buf[6] << 8) | (buf[7]);
742 goto after_mode_select;
744 if (cdb[0] == MODE_SELECT)
745 blocksize = (buf[9] << 16) | (buf[10] << 8) |
748 blocksize = (buf[13] << 16) | (buf[14] << 8) |
751 sd->sector_size = blocksize;
755 if (status_byte(result) & CHECK_CONDITION)
761 static struct se_task *
762 pscsi_alloc_task(unsigned char *cdb)
764 struct pscsi_plugin_task *pt;
767 * Dynamically alloc cdb space, since it may be larger than
768 * TCM_MAX_COMMAND_SIZE
770 pt = kzalloc(sizeof(*pt) + scsi_command_size(cdb), GFP_KERNEL);
772 pr_err("Unable to allocate struct pscsi_plugin_task\n");
776 return &pt->pscsi_task;
779 static inline void pscsi_blk_init_request(
780 struct se_task *task,
781 struct pscsi_plugin_task *pt,
786 * Defined as "scsi command" in include/linux/blkdev.h.
788 req->cmd_type = REQ_TYPE_BLOCK_PC;
790 * For the extra BIDI-COMMAND READ struct request we do not
791 * need to setup the remaining structure members
796 * Setup the done function pointer for struct request,
797 * also set the end_io_data pointer.to struct se_task.
799 req->end_io = pscsi_req_done;
800 req->end_io_data = task;
802 * Load the referenced struct se_task's SCSI CDB into
803 * include/linux/blkdev.h:struct request->cmd
805 req->cmd_len = scsi_command_size(pt->pscsi_cdb);
806 req->cmd = &pt->pscsi_cdb[0];
808 * Setup pointer for outgoing sense data.
810 req->sense = &pt->pscsi_sense[0];
815 * Used for pSCSI data payloads for all *NON* SCF_SCSI_DATA_SG_IO_CDB
817 static int pscsi_blk_get_request(struct se_task *task)
819 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
820 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
822 pt->pscsi_req = blk_get_request(pdv->pdv_sd->request_queue,
823 (task->task_data_direction == DMA_TO_DEVICE),
825 if (!pt->pscsi_req || IS_ERR(pt->pscsi_req)) {
826 pr_err("PSCSI: blk_get_request() failed: %ld\n",
827 IS_ERR(pt->pscsi_req));
828 return PYX_TRANSPORT_LU_COMM_FAILURE;
831 * Setup the newly allocated struct request for REQ_TYPE_BLOCK_PC,
832 * and setup rq callback, CDB and sense.
834 pscsi_blk_init_request(task, pt, pt->pscsi_req, 0);
838 /* pscsi_do_task(): (Part of se_subsystem_api_t template)
842 static int pscsi_do_task(struct se_task *task)
844 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
845 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
847 * Set the struct request->timeout value based on peripheral
848 * device type from SCSI.
850 if (pdv->pdv_sd->type == TYPE_DISK)
851 pt->pscsi_req->timeout = PS_TIMEOUT_DISK;
853 pt->pscsi_req->timeout = PS_TIMEOUT_OTHER;
855 pt->pscsi_req->retries = PS_RETRY;
857 * Queue the struct request into the struct scsi_device->request_queue.
858 * Also check for HEAD_OF_QUEUE SAM TASK attr from received se_cmd
861 blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, pt->pscsi_req,
862 (task->task_se_cmd->sam_task_attr == MSG_HEAD_TAG),
865 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
868 static void pscsi_free_task(struct se_task *task)
870 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
873 * We do not release the bio(s) here associated with this task, as
874 * this is handled by bio_put() and pscsi_bi_endio().
880 Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
881 Opt_scsi_lun_id, Opt_err
884 static match_table_t tokens = {
885 {Opt_scsi_host_id, "scsi_host_id=%d"},
886 {Opt_scsi_channel_id, "scsi_channel_id=%d"},
887 {Opt_scsi_target_id, "scsi_target_id=%d"},
888 {Opt_scsi_lun_id, "scsi_lun_id=%d"},
892 static ssize_t pscsi_set_configfs_dev_params(struct se_hba *hba,
893 struct se_subsystem_dev *se_dev,
897 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
898 struct pscsi_hba_virt *phv = hba->hba_ptr;
899 char *orig, *ptr, *opts;
900 substring_t args[MAX_OPT_ARGS];
901 int ret = 0, arg, token;
903 opts = kstrdup(page, GFP_KERNEL);
909 while ((ptr = strsep(&opts, ",")) != NULL) {
913 token = match_token(ptr, tokens, args);
915 case Opt_scsi_host_id:
916 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
917 pr_err("PSCSI[%d]: Unable to accept"
918 " scsi_host_id while phv_mode =="
919 " PHV_LLD_SCSI_HOST_NO\n",
924 match_int(args, &arg);
925 pdv->pdv_host_id = arg;
926 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
927 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
928 pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
930 case Opt_scsi_channel_id:
931 match_int(args, &arg);
932 pdv->pdv_channel_id = arg;
933 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
934 " ID: %d\n", phv->phv_host_id,
935 pdv->pdv_channel_id);
936 pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
938 case Opt_scsi_target_id:
939 match_int(args, &arg);
940 pdv->pdv_target_id = arg;
941 pr_debug("PSCSI[%d]: Referencing SCSI Target"
942 " ID: %d\n", phv->phv_host_id,
944 pdv->pdv_flags |= PDF_HAS_TARGET_ID;
946 case Opt_scsi_lun_id:
947 match_int(args, &arg);
948 pdv->pdv_lun_id = arg;
949 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
950 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
951 pdv->pdv_flags |= PDF_HAS_LUN_ID;
960 return (!ret) ? count : ret;
963 static ssize_t pscsi_check_configfs_dev_params(
965 struct se_subsystem_dev *se_dev)
967 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
969 if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
970 !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
971 !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
972 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
973 " scsi_lun_id= parameters\n");
980 static ssize_t pscsi_show_configfs_dev_params(struct se_hba *hba,
981 struct se_subsystem_dev *se_dev,
984 struct pscsi_hba_virt *phv = hba->hba_ptr;
985 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
986 struct scsi_device *sd = pdv->pdv_sd;
987 unsigned char host_id[16];
991 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
992 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
994 snprintf(host_id, 16, "PHBA Mode");
996 bl = sprintf(b, "SCSI Device Bus Location:"
997 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
998 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
1002 bl += sprintf(b + bl, " ");
1003 bl += sprintf(b + bl, "Vendor: ");
1004 for (i = 0; i < 8; i++) {
1005 if (ISPRINT(sd->vendor[i])) /* printable character? */
1006 bl += sprintf(b + bl, "%c", sd->vendor[i]);
1008 bl += sprintf(b + bl, " ");
1010 bl += sprintf(b + bl, " Model: ");
1011 for (i = 0; i < 16; i++) {
1012 if (ISPRINT(sd->model[i])) /* printable character ? */
1013 bl += sprintf(b + bl, "%c", sd->model[i]);
1015 bl += sprintf(b + bl, " ");
1017 bl += sprintf(b + bl, " Rev: ");
1018 for (i = 0; i < 4; i++) {
1019 if (ISPRINT(sd->rev[i])) /* printable character ? */
1020 bl += sprintf(b + bl, "%c", sd->rev[i]);
1022 bl += sprintf(b + bl, " ");
1024 bl += sprintf(b + bl, "\n");
1029 static void pscsi_bi_endio(struct bio *bio, int error)
1034 static inline struct bio *pscsi_get_bio(int sg_num)
1038 * Use bio_malloc() following the comment in for bio -> struct request
1039 * in block/blk-core.c:blk_make_request()
1041 bio = bio_kmalloc(GFP_KERNEL, sg_num);
1043 pr_err("PSCSI: bio_kmalloc() failed\n");
1046 bio->bi_end_io = pscsi_bi_endio;
1051 static int __pscsi_map_SG(
1052 struct se_task *task,
1053 struct scatterlist *task_sg,
1057 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1058 struct pscsi_dev_virt *pdv = task->se_dev->dev_ptr;
1059 struct bio *bio = NULL, *hbio = NULL, *tbio = NULL;
1061 struct scatterlist *sg;
1062 u32 data_len = task->task_size, i, len, bytes, off;
1063 int nr_pages = (task->task_size + task_sg[0].offset +
1064 PAGE_SIZE - 1) >> PAGE_SHIFT;
1065 int nr_vecs = 0, rc, ret = PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES;
1066 int rw = (task->task_data_direction == DMA_TO_DEVICE);
1068 if (!task->task_size)
1071 * For SCF_SCSI_DATA_SG_IO_CDB, Use fs/bio.c:bio_add_page() to setup
1072 * the bio_vec maplist from task->task_sg ->
1073 * struct scatterlist memory. The struct se_task->task_sg[] currently needs
1074 * to be attached to struct bios for submission to Linux/SCSI using
1075 * struct request to struct scsi_device->request_queue.
1077 * Note that this will be changing post v2.6.28 as Target_Core_Mod/pSCSI
1078 * is ported to upstream SCSI passthrough functionality that accepts
1079 * struct scatterlist->page_link or struct page as a paraemeter.
1081 pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
1083 for_each_sg(task_sg, sg, task_sg_num, i) {
1088 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
1091 while (len > 0 && data_len > 0) {
1092 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
1093 bytes = min(bytes, data_len);
1096 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
1097 nr_pages -= nr_vecs;
1099 * Calls bio_kmalloc() and sets bio->bi_end_io()
1101 bio = pscsi_get_bio(nr_vecs);
1106 bio->bi_rw |= REQ_WRITE;
1108 pr_debug("PSCSI: Allocated bio: %p,"
1109 " dir: %s nr_vecs: %d\n", bio,
1110 (rw) ? "rw" : "r", nr_vecs);
1112 * Set *hbio pointer to handle the case:
1113 * nr_pages > BIO_MAX_PAGES, where additional
1114 * bios need to be added to complete a given
1120 tbio = tbio->bi_next = bio;
1123 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
1124 " bio: %p page: %p len: %d off: %d\n", i, bio,
1127 rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
1128 bio, page, bytes, off);
1132 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
1133 bio->bi_vcnt, nr_vecs);
1135 if (bio->bi_vcnt > nr_vecs) {
1136 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
1137 " %d i: %d bio: %p, allocating another"
1138 " bio\n", bio->bi_vcnt, i, bio);
1140 * Clear the pointer so that another bio will
1141 * be allocated with pscsi_get_bio() above, the
1142 * current bio has already been set *tbio and
1155 * Setup the primary pt->pscsi_req used for non BIDI and BIDI-COMMAND
1156 * primary SCSI WRITE poayload mapped for struct se_task->task_sg[]
1160 * Starting with v2.6.31, call blk_make_request() passing in *hbio to
1161 * allocate the pSCSI task a struct request.
1163 pt->pscsi_req = blk_make_request(pdv->pdv_sd->request_queue,
1165 if (!pt->pscsi_req) {
1166 pr_err("pSCSI: blk_make_request() failed\n");
1170 * Setup the newly allocated struct request for REQ_TYPE_BLOCK_PC,
1171 * and setup rq callback, CDB and sense.
1173 pscsi_blk_init_request(task, pt, pt->pscsi_req, 0);
1175 return task->task_sg_nents;
1178 * Setup the secondary pt->pscsi_req->next_rq used for the extra BIDI-COMMAND
1179 * SCSI READ paylaod mapped for struct se_task->task_sg_bidi[]
1181 pt->pscsi_req->next_rq = blk_make_request(pdv->pdv_sd->request_queue,
1183 if (!pt->pscsi_req->next_rq) {
1184 pr_err("pSCSI: blk_make_request() failed for BIDI\n");
1187 pscsi_blk_init_request(task, pt, pt->pscsi_req->next_rq, 1);
1189 return task->task_sg_nents;
1193 hbio = hbio->bi_next;
1194 bio->bi_next = NULL;
1201 * pSCSI maps both ->map_control_SG() and ->map_data_SG() to a single call.
1203 static int pscsi_map_SG(struct se_task *task)
1208 * Setup the main struct request for the task->task_sg[] payload
1211 ret = __pscsi_map_SG(task, task->task_sg, task->task_sg_nents, 0);
1212 if (ret >= 0 && task->task_sg_bidi) {
1214 * If present, set up the extra BIDI-COMMAND SCSI READ
1215 * struct request and payload.
1217 ret = __pscsi_map_SG(task, task->task_sg_bidi,
1218 task->task_sg_nents, 1);
1222 return PYX_TRANSPORT_LU_COMM_FAILURE;
1226 static int pscsi_CDB_none(struct se_task *task)
1228 return pscsi_blk_get_request(task);
1235 static unsigned char *pscsi_get_cdb(struct se_task *task)
1237 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1239 return pt->pscsi_cdb;
1242 /* pscsi_get_sense_buffer():
1246 static unsigned char *pscsi_get_sense_buffer(struct se_task *task)
1248 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1250 return (unsigned char *)&pt->pscsi_sense[0];
1253 /* pscsi_get_device_rev():
1257 static u32 pscsi_get_device_rev(struct se_device *dev)
1259 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1260 struct scsi_device *sd = pdv->pdv_sd;
1262 return (sd->scsi_level - 1) ? sd->scsi_level - 1 : 1;
1265 /* pscsi_get_device_type():
1269 static u32 pscsi_get_device_type(struct se_device *dev)
1271 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1272 struct scsi_device *sd = pdv->pdv_sd;
1277 static sector_t pscsi_get_blocks(struct se_device *dev)
1279 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1281 if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1282 return pdv->pdv_bd->bd_part->nr_sects;
1288 /* pscsi_handle_SAM_STATUS_failures():
1292 static inline void pscsi_process_SAM_status(
1293 struct se_task *task,
1294 struct pscsi_plugin_task *pt)
1296 task->task_scsi_status = status_byte(pt->pscsi_result);
1297 if (task->task_scsi_status) {
1298 task->task_scsi_status <<= 1;
1299 pr_debug("PSCSI Status Byte exception at task: %p CDB:"
1300 " 0x%02x Result: 0x%08x\n", task, pt->pscsi_cdb[0],
1304 switch (host_byte(pt->pscsi_result)) {
1306 transport_complete_task(task, (!task->task_scsi_status));
1309 pr_debug("PSCSI Host Byte exception at task: %p CDB:"
1310 " 0x%02x Result: 0x%08x\n", task, pt->pscsi_cdb[0],
1312 task->task_scsi_status = SAM_STAT_CHECK_CONDITION;
1313 task->task_error_status = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1314 task->task_se_cmd->transport_error_status =
1315 PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
1316 transport_complete_task(task, 0);
1321 static void pscsi_req_done(struct request *req, int uptodate)
1323 struct se_task *task = req->end_io_data;
1324 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1326 pt->pscsi_result = req->errors;
1327 pt->pscsi_resid = req->resid_len;
1329 pscsi_process_SAM_status(task, pt);
1331 * Release BIDI-READ if present
1333 if (req->next_rq != NULL)
1334 __blk_put_request(req->q, req->next_rq);
1336 __blk_put_request(req->q, req);
1337 pt->pscsi_req = NULL;
1340 static struct se_subsystem_api pscsi_template = {
1342 .owner = THIS_MODULE,
1343 .transport_type = TRANSPORT_PLUGIN_PHBA_PDEV,
1344 .cdb_none = pscsi_CDB_none,
1345 .map_control_SG = pscsi_map_SG,
1346 .map_data_SG = pscsi_map_SG,
1347 .attach_hba = pscsi_attach_hba,
1348 .detach_hba = pscsi_detach_hba,
1349 .pmode_enable_hba = pscsi_pmode_enable_hba,
1350 .allocate_virtdevice = pscsi_allocate_virtdevice,
1351 .create_virtdevice = pscsi_create_virtdevice,
1352 .free_device = pscsi_free_device,
1353 .transport_complete = pscsi_transport_complete,
1354 .alloc_task = pscsi_alloc_task,
1355 .do_task = pscsi_do_task,
1356 .free_task = pscsi_free_task,
1357 .check_configfs_dev_params = pscsi_check_configfs_dev_params,
1358 .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1359 .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1360 .get_cdb = pscsi_get_cdb,
1361 .get_sense_buffer = pscsi_get_sense_buffer,
1362 .get_device_rev = pscsi_get_device_rev,
1363 .get_device_type = pscsi_get_device_type,
1364 .get_blocks = pscsi_get_blocks,
1367 static int __init pscsi_module_init(void)
1369 return transport_subsystem_register(&pscsi_template);
1372 static void pscsi_module_exit(void)
1374 transport_subsystem_release(&pscsi_template);
1377 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1378 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1379 MODULE_LICENSE("GPL");
1381 module_init(pscsi_module_init);
1382 module_exit(pscsi_module_exit);