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/ratelimit.h>
39 #include <linux/module.h>
40 #include <asm/unaligned.h>
42 #include <scsi/scsi.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_cmnd.h>
45 #include <scsi/scsi_host.h>
46 #include <scsi/scsi_tcq.h>
48 #include <target/target_core_base.h>
49 #include <target/target_core_backend.h>
51 #include "target_core_alua.h"
52 #include "target_core_pscsi.h"
54 #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
56 static struct se_subsystem_api pscsi_template
;
58 static int pscsi_execute_cmd(struct se_cmd
*cmd
);
59 static void pscsi_req_done(struct request
*, int);
61 /* pscsi_attach_hba():
63 * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
64 * from the passed SCSI Host ID.
66 static int pscsi_attach_hba(struct se_hba
*hba
, u32 host_id
)
68 struct pscsi_hba_virt
*phv
;
70 phv
= kzalloc(sizeof(struct pscsi_hba_virt
), GFP_KERNEL
);
72 pr_err("Unable to allocate struct pscsi_hba_virt\n");
75 phv
->phv_host_id
= host_id
;
76 phv
->phv_mode
= PHV_VIRTUAL_HOST_ID
;
80 pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
81 " Generic Target Core Stack %s\n", hba
->hba_id
,
82 PSCSI_VERSION
, TARGET_CORE_MOD_VERSION
);
83 pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
89 static void pscsi_detach_hba(struct se_hba
*hba
)
91 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
92 struct Scsi_Host
*scsi_host
= phv
->phv_lld_host
;
95 scsi_host_put(scsi_host
);
97 pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
98 " Generic Target Core\n", hba
->hba_id
,
99 (scsi_host
->hostt
->name
) ? (scsi_host
->hostt
->name
) :
102 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
103 " from Generic Target Core\n", hba
->hba_id
);
109 static int pscsi_pmode_enable_hba(struct se_hba
*hba
, unsigned long mode_flag
)
111 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
112 struct Scsi_Host
*sh
= phv
->phv_lld_host
;
114 * Release the struct Scsi_Host
120 phv
->phv_lld_host
= NULL
;
121 phv
->phv_mode
= PHV_VIRTUAL_HOST_ID
;
123 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
124 " %s\n", hba
->hba_id
, (sh
->hostt
->name
) ?
125 (sh
->hostt
->name
) : "Unknown");
131 * Otherwise, locate struct Scsi_Host from the original passed
132 * pSCSI Host ID and enable for phba mode
134 sh
= scsi_host_lookup(phv
->phv_host_id
);
136 pr_err("pSCSI: Unable to locate SCSI Host for"
137 " phv_host_id: %d\n", phv
->phv_host_id
);
141 phv
->phv_lld_host
= sh
;
142 phv
->phv_mode
= PHV_LLD_SCSI_HOST_NO
;
144 pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
145 hba
->hba_id
, (sh
->hostt
->name
) ? (sh
->hostt
->name
) : "Unknown");
150 static void pscsi_tape_read_blocksize(struct se_device
*dev
,
151 struct scsi_device
*sdev
)
153 unsigned char cdb
[MAX_COMMAND_SIZE
], *buf
;
156 buf
= kzalloc(12, GFP_KERNEL
);
160 memset(cdb
, 0, MAX_COMMAND_SIZE
);
162 cdb
[4] = 0x0c; /* 12 bytes */
164 ret
= scsi_execute_req(sdev
, cdb
, DMA_FROM_DEVICE
, buf
, 12, NULL
,
170 * If MODE_SENSE still returns zero, set the default value to 1024.
172 sdev
->sector_size
= (buf
[9] << 16) | (buf
[10] << 8) | (buf
[11]);
173 if (!sdev
->sector_size
)
174 sdev
->sector_size
= 1024;
180 pscsi_set_inquiry_info(struct scsi_device
*sdev
, struct t10_wwn
*wwn
)
184 if (sdev
->inquiry_len
< INQUIRY_LEN
)
191 * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
193 memcpy(&wwn
->vendor
[0], &buf
[8], sizeof(wwn
->vendor
));
194 memcpy(&wwn
->model
[0], &buf
[16], sizeof(wwn
->model
));
195 memcpy(&wwn
->revision
[0], &buf
[32], sizeof(wwn
->revision
));
199 pscsi_get_inquiry_vpd_serial(struct scsi_device
*sdev
, struct t10_wwn
*wwn
)
201 unsigned char cdb
[MAX_COMMAND_SIZE
], *buf
;
204 buf
= kzalloc(INQUIRY_VPD_SERIAL_LEN
, GFP_KERNEL
);
208 memset(cdb
, 0, MAX_COMMAND_SIZE
);
210 cdb
[1] = 0x01; /* Query VPD */
211 cdb
[2] = 0x80; /* Unit Serial Number */
212 cdb
[3] = (INQUIRY_VPD_SERIAL_LEN
>> 8) & 0xff;
213 cdb
[4] = (INQUIRY_VPD_SERIAL_LEN
& 0xff);
215 ret
= scsi_execute_req(sdev
, cdb
, DMA_FROM_DEVICE
, buf
,
216 INQUIRY_VPD_SERIAL_LEN
, NULL
, HZ
, 1, NULL
);
220 snprintf(&wwn
->unit_serial
[0], INQUIRY_VPD_SERIAL_LEN
, "%s", &buf
[4]);
222 wwn
->t10_sub_dev
->su_dev_flags
|= SDF_FIRMWARE_VPD_UNIT_SERIAL
;
233 pscsi_get_inquiry_vpd_device_ident(struct scsi_device
*sdev
,
236 unsigned char cdb
[MAX_COMMAND_SIZE
], *buf
, *page_83
;
237 int ident_len
, page_len
, off
= 4, ret
;
240 buf
= kzalloc(INQUIRY_VPD_SERIAL_LEN
, GFP_KERNEL
);
244 memset(cdb
, 0, MAX_COMMAND_SIZE
);
246 cdb
[1] = 0x01; /* Query VPD */
247 cdb
[2] = 0x83; /* Device Identifier */
248 cdb
[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN
>> 8) & 0xff;
249 cdb
[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN
& 0xff);
251 ret
= scsi_execute_req(sdev
, cdb
, DMA_FROM_DEVICE
, buf
,
252 INQUIRY_VPD_DEVICE_IDENTIFIER_LEN
,
257 page_len
= (buf
[2] << 8) | buf
[3];
258 while (page_len
> 0) {
259 /* Grab a pointer to the Identification descriptor */
261 ident_len
= page_83
[3];
263 pr_err("page_83[3]: identifier"
267 pr_debug("T10 VPD Identifer Length: %d\n", ident_len
);
269 vpd
= kzalloc(sizeof(struct t10_vpd
), GFP_KERNEL
);
271 pr_err("Unable to allocate memory for"
272 " struct t10_vpd\n");
275 INIT_LIST_HEAD(&vpd
->vpd_list
);
277 transport_set_vpd_proto_id(vpd
, page_83
);
278 transport_set_vpd_assoc(vpd
, page_83
);
280 if (transport_set_vpd_ident_type(vpd
, page_83
) < 0) {
281 off
+= (ident_len
+ 4);
282 page_len
-= (ident_len
+ 4);
286 if (transport_set_vpd_ident(vpd
, page_83
) < 0) {
287 off
+= (ident_len
+ 4);
288 page_len
-= (ident_len
+ 4);
293 list_add_tail(&vpd
->vpd_list
, &wwn
->t10_vpd_list
);
294 off
+= (ident_len
+ 4);
295 page_len
-= (ident_len
+ 4);
302 /* pscsi_add_device_to_list():
306 static struct se_device
*pscsi_add_device_to_list(
308 struct se_subsystem_dev
*se_dev
,
309 struct pscsi_dev_virt
*pdv
,
310 struct scsi_device
*sd
,
313 struct se_device
*dev
;
314 struct se_dev_limits dev_limits
;
315 struct request_queue
*q
;
316 struct queue_limits
*limits
;
318 memset(&dev_limits
, 0, sizeof(struct se_dev_limits
));
320 if (!sd
->queue_depth
) {
321 sd
->queue_depth
= PSCSI_DEFAULT_QUEUEDEPTH
;
323 pr_err("Set broken SCSI Device %d:%d:%d"
324 " queue_depth to %d\n", sd
->channel
, sd
->id
,
325 sd
->lun
, sd
->queue_depth
);
328 * Setup the local scope queue_limits from struct request_queue->limits
329 * to pass into transport_add_device_to_core_hba() as struct se_dev_limits.
331 q
= sd
->request_queue
;
332 limits
= &dev_limits
.limits
;
333 limits
->logical_block_size
= sd
->sector_size
;
334 limits
->max_hw_sectors
= min_t(int, sd
->host
->max_sectors
, queue_max_hw_sectors(q
));
335 limits
->max_sectors
= min_t(int, sd
->host
->max_sectors
, queue_max_sectors(q
));
336 dev_limits
.hw_queue_depth
= sd
->queue_depth
;
337 dev_limits
.queue_depth
= sd
->queue_depth
;
339 * Setup our standard INQUIRY info into se_dev->t10_wwn
341 pscsi_set_inquiry_info(sd
, &se_dev
->t10_wwn
);
344 * Set the pointer pdv->pdv_sd to from passed struct scsi_device,
345 * which has already been referenced with Linux SCSI code with
346 * scsi_device_get() in this file's pscsi_create_virtdevice().
348 * The passthrough operations called by the transport_add_device_*
349 * function below will require this pointer to be set for passthroug
352 * For the shutdown case in pscsi_free_device(), this struct
353 * scsi_device reference is released with Linux SCSI code
354 * 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
, 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 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
394 pdv
->pdv_se_hba
= hba
;
396 pr_debug("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
= 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 pr_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 pr_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 pr_debug("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
= pdv
->pdv_se_hba
->hba_ptr
;
460 struct Scsi_Host
*sh
= sd
->host
;
463 if (scsi_device_get(sd
)) {
464 pr_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 pr_debug("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
= 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 pr_debug("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
= p
;
516 struct se_device
*dev
;
517 struct scsi_device
*sd
;
518 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
519 struct Scsi_Host
*sh
= phv
->phv_lld_host
;
520 int legacy_mode_enable
= 0;
523 pr_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 pr_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_VIRTUAL_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 pr_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_VIRTUAL_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 pr_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 pr_err("pSCSI: Unable to locate"
571 " pdv_host_id: %d\n", pdv
->pdv_host_id
);
576 if (phv
->phv_mode
== PHV_VIRTUAL_HOST_ID
) {
577 pr_err("pSCSI: PHV_VIRTUAL_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_VIRTUAL_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 pr_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_VIRTUAL_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 void pscsi_transport_complete(struct se_cmd
*cmd
, struct scatterlist
*sg
,
671 unsigned char *sense_buffer
)
673 struct pscsi_dev_virt
*pdv
= cmd
->se_dev
->dev_ptr
;
674 struct scsi_device
*sd
= pdv
->pdv_sd
;
676 struct pscsi_plugin_task
*pt
= cmd
->priv
;
679 * Special case for REPORT_LUNs handling where pscsi_plugin_task has
680 * not been allocated because TCM is handling the emulation directly.
685 cdb
= &pt
->pscsi_cdb
[0];
686 result
= pt
->pscsi_result
;
688 * Hack to make sure that Write-Protect modepage is set if R/O mode is
691 if (!cmd
->se_deve
|| !cmd
->data_length
)
692 goto after_mode_sense
;
694 if (((cdb
[0] == MODE_SENSE
) || (cdb
[0] == MODE_SENSE_10
)) &&
695 (status_byte(result
) << 1) == SAM_STAT_GOOD
) {
696 if (cmd
->se_deve
->lun_flags
& TRANSPORT_LUNFLAGS_READ_ONLY
) {
697 unsigned char *buf
= transport_kmap_data_sg(cmd
);
699 if (cdb
[0] == MODE_SENSE_10
) {
700 if (!(buf
[3] & 0x80))
703 if (!(buf
[2] & 0x80))
707 transport_kunmap_data_sg(cmd
);
712 if (sd
->type
!= TYPE_TAPE
|| !cmd
->data_length
)
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
) {
729 buf
= sg_virt(&sg
[0]);
731 pr_err("Unable to get buf for scatterlist\n");
732 goto after_mode_select
;
735 if (cdb
[0] == MODE_SELECT
)
738 bdl
= (buf
[6] << 8) | (buf
[7]);
741 goto after_mode_select
;
743 if (cdb
[0] == MODE_SELECT
)
744 blocksize
= (buf
[9] << 16) | (buf
[10] << 8) |
747 blocksize
= (buf
[13] << 16) | (buf
[14] << 8) |
750 sd
->sector_size
= blocksize
;
754 if (sense_buffer
&& (status_byte(result
) & CHECK_CONDITION
)) {
755 memcpy(sense_buffer
, pt
->pscsi_sense
, TRANSPORT_SENSE_BUFFER
);
756 cmd
->se_cmd_flags
|= SCF_TRANSPORT_TASK_SENSE
;
761 Opt_scsi_host_id
, Opt_scsi_channel_id
, Opt_scsi_target_id
,
762 Opt_scsi_lun_id
, Opt_err
765 static match_table_t tokens
= {
766 {Opt_scsi_host_id
, "scsi_host_id=%d"},
767 {Opt_scsi_channel_id
, "scsi_channel_id=%d"},
768 {Opt_scsi_target_id
, "scsi_target_id=%d"},
769 {Opt_scsi_lun_id
, "scsi_lun_id=%d"},
773 static ssize_t
pscsi_set_configfs_dev_params(struct se_hba
*hba
,
774 struct se_subsystem_dev
*se_dev
,
778 struct pscsi_dev_virt
*pdv
= se_dev
->se_dev_su_ptr
;
779 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
780 char *orig
, *ptr
, *opts
;
781 substring_t args
[MAX_OPT_ARGS
];
782 int ret
= 0, arg
, token
;
784 opts
= kstrdup(page
, GFP_KERNEL
);
790 while ((ptr
= strsep(&opts
, ",\n")) != NULL
) {
794 token
= match_token(ptr
, tokens
, args
);
796 case Opt_scsi_host_id
:
797 if (phv
->phv_mode
== PHV_LLD_SCSI_HOST_NO
) {
798 pr_err("PSCSI[%d]: Unable to accept"
799 " scsi_host_id while phv_mode =="
800 " PHV_LLD_SCSI_HOST_NO\n",
805 match_int(args
, &arg
);
806 pdv
->pdv_host_id
= arg
;
807 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
808 " %d\n", phv
->phv_host_id
, pdv
->pdv_host_id
);
809 pdv
->pdv_flags
|= PDF_HAS_VIRT_HOST_ID
;
811 case Opt_scsi_channel_id
:
812 match_int(args
, &arg
);
813 pdv
->pdv_channel_id
= arg
;
814 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
815 " ID: %d\n", phv
->phv_host_id
,
816 pdv
->pdv_channel_id
);
817 pdv
->pdv_flags
|= PDF_HAS_CHANNEL_ID
;
819 case Opt_scsi_target_id
:
820 match_int(args
, &arg
);
821 pdv
->pdv_target_id
= arg
;
822 pr_debug("PSCSI[%d]: Referencing SCSI Target"
823 " ID: %d\n", phv
->phv_host_id
,
825 pdv
->pdv_flags
|= PDF_HAS_TARGET_ID
;
827 case Opt_scsi_lun_id
:
828 match_int(args
, &arg
);
829 pdv
->pdv_lun_id
= arg
;
830 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
831 " %d\n", phv
->phv_host_id
, pdv
->pdv_lun_id
);
832 pdv
->pdv_flags
|= PDF_HAS_LUN_ID
;
841 return (!ret
) ? count
: ret
;
844 static ssize_t
pscsi_check_configfs_dev_params(
846 struct se_subsystem_dev
*se_dev
)
848 struct pscsi_dev_virt
*pdv
= se_dev
->se_dev_su_ptr
;
850 if (!(pdv
->pdv_flags
& PDF_HAS_CHANNEL_ID
) ||
851 !(pdv
->pdv_flags
& PDF_HAS_TARGET_ID
) ||
852 !(pdv
->pdv_flags
& PDF_HAS_LUN_ID
)) {
853 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
854 " scsi_lun_id= parameters\n");
861 static ssize_t
pscsi_show_configfs_dev_params(struct se_hba
*hba
,
862 struct se_subsystem_dev
*se_dev
,
865 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
866 struct pscsi_dev_virt
*pdv
= se_dev
->se_dev_su_ptr
;
867 struct scsi_device
*sd
= pdv
->pdv_sd
;
868 unsigned char host_id
[16];
872 if (phv
->phv_mode
== PHV_VIRTUAL_HOST_ID
)
873 snprintf(host_id
, 16, "%d", pdv
->pdv_host_id
);
875 snprintf(host_id
, 16, "PHBA Mode");
877 bl
= sprintf(b
, "SCSI Device Bus Location:"
878 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
879 pdv
->pdv_channel_id
, pdv
->pdv_target_id
, pdv
->pdv_lun_id
,
883 bl
+= sprintf(b
+ bl
, " ");
884 bl
+= sprintf(b
+ bl
, "Vendor: ");
885 for (i
= 0; i
< 8; i
++) {
886 if (ISPRINT(sd
->vendor
[i
])) /* printable character? */
887 bl
+= sprintf(b
+ bl
, "%c", sd
->vendor
[i
]);
889 bl
+= sprintf(b
+ bl
, " ");
891 bl
+= sprintf(b
+ bl
, " Model: ");
892 for (i
= 0; i
< 16; i
++) {
893 if (ISPRINT(sd
->model
[i
])) /* printable character ? */
894 bl
+= sprintf(b
+ bl
, "%c", sd
->model
[i
]);
896 bl
+= sprintf(b
+ bl
, " ");
898 bl
+= sprintf(b
+ bl
, " Rev: ");
899 for (i
= 0; i
< 4; i
++) {
900 if (ISPRINT(sd
->rev
[i
])) /* printable character ? */
901 bl
+= sprintf(b
+ bl
, "%c", sd
->rev
[i
]);
903 bl
+= sprintf(b
+ bl
, " ");
905 bl
+= sprintf(b
+ bl
, "\n");
910 static void pscsi_bi_endio(struct bio
*bio
, int error
)
915 static inline struct bio
*pscsi_get_bio(int sg_num
)
919 * Use bio_malloc() following the comment in for bio -> struct request
920 * in block/blk-core.c:blk_make_request()
922 bio
= bio_kmalloc(GFP_KERNEL
, sg_num
);
924 pr_err("PSCSI: bio_kmalloc() failed\n");
927 bio
->bi_end_io
= pscsi_bi_endio
;
932 static int pscsi_map_sg(struct se_cmd
*cmd
, struct scatterlist
*sgl
,
933 u32 sgl_nents
, enum dma_data_direction data_direction
,
936 struct pscsi_dev_virt
*pdv
= cmd
->se_dev
->dev_ptr
;
937 struct bio
*bio
= NULL
, *tbio
= NULL
;
939 struct scatterlist
*sg
;
940 u32 data_len
= cmd
->data_length
, i
, len
, bytes
, off
;
941 int nr_pages
= (cmd
->data_length
+ sgl
[0].offset
+
942 PAGE_SIZE
- 1) >> PAGE_SHIFT
;
944 int rw
= (data_direction
== DMA_TO_DEVICE
);
948 pr_debug("PSCSI: nr_pages: %d\n", nr_pages
);
950 for_each_sg(sgl
, sg
, sgl_nents
, i
) {
955 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i
,
958 while (len
> 0 && data_len
> 0) {
959 bytes
= min_t(unsigned int, len
, PAGE_SIZE
- off
);
960 bytes
= min(bytes
, data_len
);
963 nr_vecs
= min_t(int, BIO_MAX_PAGES
, nr_pages
);
966 * Calls bio_kmalloc() and sets bio->bi_end_io()
968 bio
= pscsi_get_bio(nr_vecs
);
973 bio
->bi_rw
|= REQ_WRITE
;
975 pr_debug("PSCSI: Allocated bio: %p,"
976 " dir: %s nr_vecs: %d\n", bio
,
977 (rw
) ? "rw" : "r", nr_vecs
);
979 * Set *hbio pointer to handle the case:
980 * nr_pages > BIO_MAX_PAGES, where additional
981 * bios need to be added to complete a given
987 tbio
= tbio
->bi_next
= bio
;
990 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
991 " bio: %p page: %p len: %d off: %d\n", i
, bio
,
994 rc
= bio_add_pc_page(pdv
->pdv_sd
->request_queue
,
995 bio
, page
, bytes
, off
);
999 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
1000 bio
->bi_vcnt
, nr_vecs
);
1002 if (bio
->bi_vcnt
> nr_vecs
) {
1003 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
1004 " %d i: %d bio: %p, allocating another"
1005 " bio\n", bio
->bi_vcnt
, i
, bio
);
1007 * Clear the pointer so that another bio will
1008 * be allocated with pscsi_get_bio() above, the
1009 * current bio has already been set *tbio and
1026 *hbio
= (*hbio
)->bi_next
;
1027 bio
->bi_next
= NULL
;
1028 bio_endio(bio
, 0); /* XXX: should be error */
1030 cmd
->scsi_sense_reason
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1035 * Clear a lun set in the cdb if the initiator talking to use spoke
1036 * and old standards version, as we can't assume the underlying device
1037 * won't choke up on it.
1039 static inline void pscsi_clear_cdb_lun(unsigned char *cdb
)
1042 case READ_10
: /* SBC - RDProtect */
1043 case READ_12
: /* SBC - RDProtect */
1044 case READ_16
: /* SBC - RDProtect */
1045 case SEND_DIAGNOSTIC
: /* SPC - SELF-TEST Code */
1046 case VERIFY
: /* SBC - VRProtect */
1047 case VERIFY_16
: /* SBC - VRProtect */
1048 case WRITE_VERIFY
: /* SBC - VRProtect */
1049 case WRITE_VERIFY_12
: /* SBC - VRProtect */
1050 case MAINTENANCE_IN
: /* SPC - Parameter Data Format for SA RTPG */
1053 cdb
[1] &= 0x1f; /* clear logical unit number */
1058 static int pscsi_parse_cdb(struct se_cmd
*cmd
)
1060 unsigned char *cdb
= cmd
->t_task_cdb
;
1061 unsigned int dummy_size
;
1064 if (cmd
->se_cmd_flags
& SCF_BIDI
) {
1065 cmd
->se_cmd_flags
|= SCF_SCSI_CDB_EXCEPTION
;
1066 cmd
->scsi_sense_reason
= TCM_UNSUPPORTED_SCSI_OPCODE
;
1070 pscsi_clear_cdb_lun(cdb
);
1073 * For REPORT LUNS we always need to emulate the response, for everything
1074 * else the default for pSCSI is to pass the command to the underlying
1075 * LLD / physical hardware.
1079 ret
= spc_parse_cdb(cmd
, &dummy_size
);
1092 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
1095 cmd
->execute_cmd
= pscsi_execute_cmd
;
1102 static int pscsi_execute_cmd(struct se_cmd
*cmd
)
1104 struct scatterlist
*sgl
= cmd
->t_data_sg
;
1105 u32 sgl_nents
= cmd
->t_data_nents
;
1106 enum dma_data_direction data_direction
= cmd
->data_direction
;
1107 struct pscsi_dev_virt
*pdv
= cmd
->se_dev
->dev_ptr
;
1108 struct pscsi_plugin_task
*pt
;
1109 struct request
*req
;
1114 * Dynamically alloc cdb space, since it may be larger than
1115 * TCM_MAX_COMMAND_SIZE
1117 pt
= kzalloc(sizeof(*pt
) + scsi_command_size(cmd
->t_task_cdb
), GFP_KERNEL
);
1119 cmd
->scsi_sense_reason
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1124 memcpy(pt
->pscsi_cdb
, cmd
->t_task_cdb
,
1125 scsi_command_size(cmd
->t_task_cdb
));
1128 req
= blk_get_request(pdv
->pdv_sd
->request_queue
,
1129 (data_direction
== DMA_TO_DEVICE
),
1131 if (!req
|| IS_ERR(req
)) {
1132 pr_err("PSCSI: blk_get_request() failed: %ld\n",
1133 req
? IS_ERR(req
) : -ENOMEM
);
1134 cmd
->scsi_sense_reason
=
1135 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1139 BUG_ON(!cmd
->data_length
);
1141 ret
= pscsi_map_sg(cmd
, sgl
, sgl_nents
, data_direction
, &hbio
);
1143 cmd
->scsi_sense_reason
=
1144 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1148 req
= blk_make_request(pdv
->pdv_sd
->request_queue
, hbio
,
1151 pr_err("pSCSI: blk_make_request() failed\n");
1156 req
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1157 req
->end_io
= pscsi_req_done
;
1158 req
->end_io_data
= cmd
;
1159 req
->cmd_len
= scsi_command_size(pt
->pscsi_cdb
);
1160 req
->cmd
= &pt
->pscsi_cdb
[0];
1161 req
->sense
= &pt
->pscsi_sense
[0];
1163 if (pdv
->pdv_sd
->type
== TYPE_DISK
)
1164 req
->timeout
= PS_TIMEOUT_DISK
;
1166 req
->timeout
= PS_TIMEOUT_OTHER
;
1167 req
->retries
= PS_RETRY
;
1169 blk_execute_rq_nowait(pdv
->pdv_sd
->request_queue
, NULL
, req
,
1170 (cmd
->sam_task_attr
== MSG_HEAD_TAG
),
1177 struct bio
*bio
= hbio
;
1178 hbio
= hbio
->bi_next
;
1179 bio
->bi_next
= NULL
;
1180 bio_endio(bio
, 0); /* XXX: should be error */
1182 cmd
->scsi_sense_reason
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1188 /* pscsi_get_device_rev():
1192 static u32
pscsi_get_device_rev(struct se_device
*dev
)
1194 struct pscsi_dev_virt
*pdv
= dev
->dev_ptr
;
1195 struct scsi_device
*sd
= pdv
->pdv_sd
;
1197 return (sd
->scsi_level
- 1) ? sd
->scsi_level
- 1 : 1;
1200 /* pscsi_get_device_type():
1204 static u32
pscsi_get_device_type(struct se_device
*dev
)
1206 struct pscsi_dev_virt
*pdv
= dev
->dev_ptr
;
1207 struct scsi_device
*sd
= pdv
->pdv_sd
;
1212 static sector_t
pscsi_get_blocks(struct se_device
*dev
)
1214 struct pscsi_dev_virt
*pdv
= dev
->dev_ptr
;
1216 if (pdv
->pdv_bd
&& pdv
->pdv_bd
->bd_part
)
1217 return pdv
->pdv_bd
->bd_part
->nr_sects
;
1223 static void pscsi_req_done(struct request
*req
, int uptodate
)
1225 struct se_cmd
*cmd
= req
->end_io_data
;
1226 struct pscsi_plugin_task
*pt
= cmd
->priv
;
1228 pt
->pscsi_result
= req
->errors
;
1229 pt
->pscsi_resid
= req
->resid_len
;
1231 cmd
->scsi_status
= status_byte(pt
->pscsi_result
) << 1;
1232 if (cmd
->scsi_status
) {
1233 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1234 " 0x%02x Result: 0x%08x\n", cmd
, pt
->pscsi_cdb
[0],
1238 switch (host_byte(pt
->pscsi_result
)) {
1240 target_complete_cmd(cmd
, cmd
->scsi_status
);
1243 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1244 " 0x%02x Result: 0x%08x\n", cmd
, pt
->pscsi_cdb
[0],
1246 cmd
->scsi_sense_reason
= TCM_UNSUPPORTED_SCSI_OPCODE
;
1247 target_complete_cmd(cmd
, SAM_STAT_CHECK_CONDITION
);
1251 __blk_put_request(req
->q
, req
);
1255 static struct se_subsystem_api pscsi_template
= {
1257 .owner
= THIS_MODULE
,
1258 .transport_type
= TRANSPORT_PLUGIN_PHBA_PDEV
,
1259 .attach_hba
= pscsi_attach_hba
,
1260 .detach_hba
= pscsi_detach_hba
,
1261 .pmode_enable_hba
= pscsi_pmode_enable_hba
,
1262 .allocate_virtdevice
= pscsi_allocate_virtdevice
,
1263 .create_virtdevice
= pscsi_create_virtdevice
,
1264 .free_device
= pscsi_free_device
,
1265 .transport_complete
= pscsi_transport_complete
,
1266 .parse_cdb
= pscsi_parse_cdb
,
1267 .check_configfs_dev_params
= pscsi_check_configfs_dev_params
,
1268 .set_configfs_dev_params
= pscsi_set_configfs_dev_params
,
1269 .show_configfs_dev_params
= pscsi_show_configfs_dev_params
,
1270 .get_device_rev
= pscsi_get_device_rev
,
1271 .get_device_type
= pscsi_get_device_type
,
1272 .get_blocks
= pscsi_get_blocks
,
1275 static int __init
pscsi_module_init(void)
1277 return transport_subsystem_register(&pscsi_template
);
1280 static void pscsi_module_exit(void)
1282 transport_subsystem_release(&pscsi_template
);
1285 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1286 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1287 MODULE_LICENSE("GPL");
1289 module_init(pscsi_module_init
);
1290 module_exit(pscsi_module_exit
);