1 /*******************************************************************************
2 * Filename: target_core_pscsi.c
4 * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
6 * (c) Copyright 2003-2013 Datera, Inc.
8 * Nicholas A. Bellinger <nab@kernel.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 ******************************************************************************/
26 #include <linux/string.h>
27 #include <linux/parser.h>
28 #include <linux/timer.h>
29 #include <linux/blkdev.h>
30 #include <linux/blk_types.h>
31 #include <linux/slab.h>
32 #include <linux/spinlock.h>
33 #include <linux/genhd.h>
34 #include <linux/cdrom.h>
35 #include <linux/ratelimit.h>
36 #include <linux/module.h>
37 #include <asm/unaligned.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_backend.h>
48 #include "target_core_alua.h"
49 #include "target_core_pscsi.h"
51 #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
53 static inline struct pscsi_dev_virt
*PSCSI_DEV(struct se_device
*dev
)
55 return container_of(dev
, struct pscsi_dev_virt
, dev
);
58 static struct se_subsystem_api pscsi_template
;
60 static sense_reason_t
pscsi_execute_cmd(struct se_cmd
*cmd
);
61 static void pscsi_req_done(struct request
*, int);
63 /* pscsi_attach_hba():
65 * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
66 * from the passed SCSI Host ID.
68 static int pscsi_attach_hba(struct se_hba
*hba
, u32 host_id
)
70 struct pscsi_hba_virt
*phv
;
72 phv
= kzalloc(sizeof(struct pscsi_hba_virt
), GFP_KERNEL
);
74 pr_err("Unable to allocate struct pscsi_hba_virt\n");
77 phv
->phv_host_id
= host_id
;
78 phv
->phv_mode
= PHV_VIRTUAL_HOST_ID
;
82 pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
83 " Generic Target Core Stack %s\n", hba
->hba_id
,
84 PSCSI_VERSION
, TARGET_CORE_MOD_VERSION
);
85 pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
91 static void pscsi_detach_hba(struct se_hba
*hba
)
93 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
94 struct Scsi_Host
*scsi_host
= phv
->phv_lld_host
;
97 scsi_host_put(scsi_host
);
99 pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
100 " Generic Target Core\n", hba
->hba_id
,
101 (scsi_host
->hostt
->name
) ? (scsi_host
->hostt
->name
) :
104 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
105 " from Generic Target Core\n", hba
->hba_id
);
111 static int pscsi_pmode_enable_hba(struct se_hba
*hba
, unsigned long mode_flag
)
113 struct pscsi_hba_virt
*phv
= hba
->hba_ptr
;
114 struct Scsi_Host
*sh
= phv
->phv_lld_host
;
116 * Release the struct Scsi_Host
122 phv
->phv_lld_host
= NULL
;
123 phv
->phv_mode
= PHV_VIRTUAL_HOST_ID
;
125 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
126 " %s\n", hba
->hba_id
, (sh
->hostt
->name
) ?
127 (sh
->hostt
->name
) : "Unknown");
133 * Otherwise, locate struct Scsi_Host from the original passed
134 * pSCSI Host ID and enable for phba mode
136 sh
= scsi_host_lookup(phv
->phv_host_id
);
138 pr_err("pSCSI: Unable to locate SCSI Host for"
139 " phv_host_id: %d\n", phv
->phv_host_id
);
143 phv
->phv_lld_host
= sh
;
144 phv
->phv_mode
= PHV_LLD_SCSI_HOST_NO
;
146 pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
147 hba
->hba_id
, (sh
->hostt
->name
) ? (sh
->hostt
->name
) : "Unknown");
152 static void pscsi_tape_read_blocksize(struct se_device
*dev
,
153 struct scsi_device
*sdev
)
155 unsigned char cdb
[MAX_COMMAND_SIZE
], *buf
;
158 buf
= kzalloc(12, GFP_KERNEL
);
162 memset(cdb
, 0, MAX_COMMAND_SIZE
);
164 cdb
[4] = 0x0c; /* 12 bytes */
166 ret
= scsi_execute_req(sdev
, cdb
, DMA_FROM_DEVICE
, buf
, 12, NULL
,
172 * If MODE_SENSE still returns zero, set the default value to 1024.
174 sdev
->sector_size
= (buf
[9] << 16) | (buf
[10] << 8) | (buf
[11]);
175 if (!sdev
->sector_size
)
176 sdev
->sector_size
= 1024;
182 pscsi_set_inquiry_info(struct scsi_device
*sdev
, struct t10_wwn
*wwn
)
186 if (sdev
->inquiry_len
< INQUIRY_LEN
)
193 * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
195 memcpy(&wwn
->vendor
[0], &buf
[8], sizeof(wwn
->vendor
));
196 memcpy(&wwn
->model
[0], &buf
[16], sizeof(wwn
->model
));
197 memcpy(&wwn
->revision
[0], &buf
[32], sizeof(wwn
->revision
));
201 pscsi_get_inquiry_vpd_serial(struct scsi_device
*sdev
, struct t10_wwn
*wwn
)
203 unsigned char cdb
[MAX_COMMAND_SIZE
], *buf
;
206 buf
= kzalloc(INQUIRY_VPD_SERIAL_LEN
, GFP_KERNEL
);
210 memset(cdb
, 0, MAX_COMMAND_SIZE
);
212 cdb
[1] = 0x01; /* Query VPD */
213 cdb
[2] = 0x80; /* Unit Serial Number */
214 cdb
[3] = (INQUIRY_VPD_SERIAL_LEN
>> 8) & 0xff;
215 cdb
[4] = (INQUIRY_VPD_SERIAL_LEN
& 0xff);
217 ret
= scsi_execute_req(sdev
, cdb
, DMA_FROM_DEVICE
, buf
,
218 INQUIRY_VPD_SERIAL_LEN
, NULL
, HZ
, 1, NULL
);
222 snprintf(&wwn
->unit_serial
[0], INQUIRY_VPD_SERIAL_LEN
, "%s", &buf
[4]);
224 wwn
->t10_dev
->dev_flags
|= DF_FIRMWARE_VPD_UNIT_SERIAL
;
235 pscsi_get_inquiry_vpd_device_ident(struct scsi_device
*sdev
,
238 unsigned char cdb
[MAX_COMMAND_SIZE
], *buf
, *page_83
;
239 int ident_len
, page_len
, off
= 4, ret
;
242 buf
= kzalloc(INQUIRY_VPD_SERIAL_LEN
, GFP_KERNEL
);
246 memset(cdb
, 0, MAX_COMMAND_SIZE
);
248 cdb
[1] = 0x01; /* Query VPD */
249 cdb
[2] = 0x83; /* Device Identifier */
250 cdb
[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN
>> 8) & 0xff;
251 cdb
[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN
& 0xff);
253 ret
= scsi_execute_req(sdev
, cdb
, DMA_FROM_DEVICE
, buf
,
254 INQUIRY_VPD_DEVICE_IDENTIFIER_LEN
,
259 page_len
= (buf
[2] << 8) | buf
[3];
260 while (page_len
> 0) {
261 /* Grab a pointer to the Identification descriptor */
263 ident_len
= page_83
[3];
265 pr_err("page_83[3]: identifier"
269 pr_debug("T10 VPD Identifier Length: %d\n", ident_len
);
271 vpd
= kzalloc(sizeof(struct t10_vpd
), GFP_KERNEL
);
273 pr_err("Unable to allocate memory for"
274 " struct t10_vpd\n");
277 INIT_LIST_HEAD(&vpd
->vpd_list
);
279 transport_set_vpd_proto_id(vpd
, page_83
);
280 transport_set_vpd_assoc(vpd
, page_83
);
282 if (transport_set_vpd_ident_type(vpd
, page_83
) < 0) {
283 off
+= (ident_len
+ 4);
284 page_len
-= (ident_len
+ 4);
288 if (transport_set_vpd_ident(vpd
, page_83
) < 0) {
289 off
+= (ident_len
+ 4);
290 page_len
-= (ident_len
+ 4);
295 list_add_tail(&vpd
->vpd_list
, &wwn
->t10_vpd_list
);
296 off
+= (ident_len
+ 4);
297 page_len
-= (ident_len
+ 4);
304 static int pscsi_add_device_to_list(struct se_device
*dev
,
305 struct scsi_device
*sd
)
307 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
308 struct request_queue
*q
= sd
->request_queue
;
312 if (!sd
->queue_depth
) {
313 sd
->queue_depth
= PSCSI_DEFAULT_QUEUEDEPTH
;
315 pr_err("Set broken SCSI Device %d:%d:%d"
316 " queue_depth to %d\n", sd
->channel
, sd
->id
,
317 sd
->lun
, sd
->queue_depth
);
320 dev
->dev_attrib
.hw_block_size
= sd
->sector_size
;
321 dev
->dev_attrib
.hw_max_sectors
=
322 min_t(int, sd
->host
->max_sectors
, queue_max_hw_sectors(q
));
323 dev
->dev_attrib
.hw_queue_depth
= sd
->queue_depth
;
326 * Setup our standard INQUIRY info into se_dev->t10_wwn
328 pscsi_set_inquiry_info(sd
, &dev
->t10_wwn
);
331 * Locate VPD WWN Information used for various purposes within
332 * the Storage Engine.
334 if (!pscsi_get_inquiry_vpd_serial(sd
, &dev
->t10_wwn
)) {
336 * If VPD Unit Serial returned GOOD status, try
337 * VPD Device Identification page (0x83).
339 pscsi_get_inquiry_vpd_device_ident(sd
, &dev
->t10_wwn
);
343 * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
345 if (sd
->type
== TYPE_TAPE
)
346 pscsi_tape_read_blocksize(dev
, sd
);
350 static struct se_device
*pscsi_alloc_device(struct se_hba
*hba
,
353 struct pscsi_dev_virt
*pdv
;
355 pdv
= kzalloc(sizeof(struct pscsi_dev_virt
), GFP_KERNEL
);
357 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
361 pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv
, name
);
366 * Called with struct Scsi_Host->host_lock called.
368 static int pscsi_create_type_disk(struct se_device
*dev
, struct scsi_device
*sd
)
369 __releases(sh
->host_lock
)
371 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
372 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
373 struct Scsi_Host
*sh
= sd
->host
;
374 struct block_device
*bd
;
377 if (scsi_device_get(sd
)) {
378 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
379 sh
->host_no
, sd
->channel
, sd
->id
, sd
->lun
);
380 spin_unlock_irq(sh
->host_lock
);
383 spin_unlock_irq(sh
->host_lock
);
385 * Claim exclusive struct block_device access to struct scsi_device
386 * for TYPE_DISK using supplied udev_path
388 bd
= blkdev_get_by_path(dev
->udev_path
,
389 FMODE_WRITE
|FMODE_READ
|FMODE_EXCL
, pdv
);
391 pr_err("pSCSI: blkdev_get_by_path() failed\n");
397 ret
= pscsi_add_device_to_list(dev
, sd
);
399 blkdev_put(pdv
->pdv_bd
, FMODE_WRITE
|FMODE_READ
|FMODE_EXCL
);
404 pr_debug("CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%d\n",
405 phv
->phv_host_id
, sh
->host_no
, sd
->channel
, sd
->id
, sd
->lun
);
410 * Called with struct Scsi_Host->host_lock called.
412 static int pscsi_create_type_rom(struct se_device
*dev
, struct scsi_device
*sd
)
413 __releases(sh
->host_lock
)
415 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
416 struct Scsi_Host
*sh
= sd
->host
;
419 if (scsi_device_get(sd
)) {
420 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
421 sh
->host_no
, sd
->channel
, sd
->id
, sd
->lun
);
422 spin_unlock_irq(sh
->host_lock
);
425 spin_unlock_irq(sh
->host_lock
);
427 ret
= pscsi_add_device_to_list(dev
, sd
);
432 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
433 phv
->phv_host_id
, scsi_device_type(sd
->type
), sh
->host_no
,
434 sd
->channel
, sd
->id
, sd
->lun
);
440 * Called with struct Scsi_Host->host_lock called.
442 static int pscsi_create_type_other(struct se_device
*dev
,
443 struct scsi_device
*sd
)
444 __releases(sh
->host_lock
)
446 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
447 struct Scsi_Host
*sh
= sd
->host
;
450 spin_unlock_irq(sh
->host_lock
);
451 ret
= pscsi_add_device_to_list(dev
, sd
);
455 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
456 phv
->phv_host_id
, scsi_device_type(sd
->type
), sh
->host_no
,
457 sd
->channel
, sd
->id
, sd
->lun
);
461 static int pscsi_configure_device(struct se_device
*dev
)
463 struct se_hba
*hba
= dev
->se_hba
;
464 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
465 struct scsi_device
*sd
;
466 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
467 struct Scsi_Host
*sh
= phv
->phv_lld_host
;
468 int legacy_mode_enable
= 0;
471 if (!(pdv
->pdv_flags
& PDF_HAS_CHANNEL_ID
) ||
472 !(pdv
->pdv_flags
& PDF_HAS_TARGET_ID
) ||
473 !(pdv
->pdv_flags
& PDF_HAS_LUN_ID
)) {
474 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
475 " scsi_lun_id= parameters\n");
480 * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
481 * struct Scsi_Host we will need to bring the TCM/pSCSI object online
484 if (phv
->phv_mode
== PHV_LLD_SCSI_HOST_NO
) {
485 pr_err("pSCSI: Unable to locate struct"
486 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
490 * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
491 * reference, we enforce that udev_path has been set
493 if (!(dev
->dev_flags
& DF_USING_UDEV_PATH
)) {
494 pr_err("pSCSI: udev_path attribute has not"
495 " been set before ENABLE=1\n");
499 * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
500 * use the original TCM hba ID to reference Linux/SCSI Host No
501 * and enable for PHV_LLD_SCSI_HOST_NO mode.
503 if (!(pdv
->pdv_flags
& PDF_HAS_VIRT_HOST_ID
)) {
504 if (hba
->dev_count
) {
505 pr_err("pSCSI: Unable to set hba_mode"
506 " with active devices\n");
510 if (pscsi_pmode_enable_hba(hba
, 1) != 1)
513 legacy_mode_enable
= 1;
514 hba
->hba_flags
|= HBA_FLAGS_PSCSI_MODE
;
515 sh
= phv
->phv_lld_host
;
517 sh
= scsi_host_lookup(pdv
->pdv_host_id
);
519 pr_err("pSCSI: Unable to locate"
520 " pdv_host_id: %d\n", pdv
->pdv_host_id
);
525 if (phv
->phv_mode
== PHV_VIRTUAL_HOST_ID
) {
526 pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
527 " struct Scsi_Host exists\n");
532 spin_lock_irq(sh
->host_lock
);
533 list_for_each_entry(sd
, &sh
->__devices
, siblings
) {
534 if ((pdv
->pdv_channel_id
!= sd
->channel
) ||
535 (pdv
->pdv_target_id
!= sd
->id
) ||
536 (pdv
->pdv_lun_id
!= sd
->lun
))
539 * Functions will release the held struct scsi_host->host_lock
540 * before calling calling pscsi_add_device_to_list() to register
541 * struct scsi_device with target_core_mod.
545 ret
= pscsi_create_type_disk(dev
, sd
);
548 ret
= pscsi_create_type_rom(dev
, sd
);
551 ret
= pscsi_create_type_other(dev
, sd
);
556 if (phv
->phv_mode
== PHV_VIRTUAL_HOST_ID
)
558 else if (legacy_mode_enable
) {
559 pscsi_pmode_enable_hba(hba
, 0);
560 hba
->hba_flags
&= ~HBA_FLAGS_PSCSI_MODE
;
567 spin_unlock_irq(sh
->host_lock
);
569 pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh
->host_no
,
570 pdv
->pdv_channel_id
, pdv
->pdv_target_id
, pdv
->pdv_lun_id
);
572 if (phv
->phv_mode
== PHV_VIRTUAL_HOST_ID
)
574 else if (legacy_mode_enable
) {
575 pscsi_pmode_enable_hba(hba
, 0);
576 hba
->hba_flags
&= ~HBA_FLAGS_PSCSI_MODE
;
582 static void pscsi_free_device(struct se_device
*dev
)
584 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
585 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
586 struct scsi_device
*sd
= pdv
->pdv_sd
;
590 * Release exclusive pSCSI internal struct block_device claim for
591 * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
593 if ((sd
->type
== TYPE_DISK
) && pdv
->pdv_bd
) {
594 blkdev_put(pdv
->pdv_bd
,
595 FMODE_WRITE
|FMODE_READ
|FMODE_EXCL
);
599 * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
600 * to struct Scsi_Host now.
602 if ((phv
->phv_mode
== PHV_LLD_SCSI_HOST_NO
) &&
603 (phv
->phv_lld_host
!= NULL
))
604 scsi_host_put(phv
->phv_lld_host
);
606 if ((sd
->type
== TYPE_DISK
) || (sd
->type
== TYPE_ROM
))
615 static void pscsi_transport_complete(struct se_cmd
*cmd
, struct scatterlist
*sg
,
616 unsigned char *sense_buffer
)
618 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(cmd
->se_dev
);
619 struct scsi_device
*sd
= pdv
->pdv_sd
;
621 struct pscsi_plugin_task
*pt
= cmd
->priv
;
624 * Special case for REPORT_LUNs handling where pscsi_plugin_task has
625 * not been allocated because TCM is handling the emulation directly.
630 cdb
= &pt
->pscsi_cdb
[0];
631 result
= pt
->pscsi_result
;
633 * Hack to make sure that Write-Protect modepage is set if R/O mode is
636 if (!cmd
->se_deve
|| !cmd
->data_length
)
637 goto after_mode_sense
;
639 if (((cdb
[0] == MODE_SENSE
) || (cdb
[0] == MODE_SENSE_10
)) &&
640 (status_byte(result
) << 1) == SAM_STAT_GOOD
) {
641 if (cmd
->se_deve
->lun_flags
& TRANSPORT_LUNFLAGS_READ_ONLY
) {
644 buf
= transport_kmap_data_sg(cmd
);
646 ; /* XXX: TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE */
648 if (cdb
[0] == MODE_SENSE_10
) {
649 if (!(buf
[3] & 0x80))
652 if (!(buf
[2] & 0x80))
656 transport_kunmap_data_sg(cmd
);
661 if (sd
->type
!= TYPE_TAPE
|| !cmd
->data_length
)
662 goto after_mode_select
;
665 * Hack to correctly obtain the initiator requested blocksize for
666 * TYPE_TAPE. Since this value is dependent upon each tape media,
667 * struct scsi_device->sector_size will not contain the correct value
668 * by default, so we go ahead and set it so
669 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
672 if (((cdb
[0] == MODE_SELECT
) || (cdb
[0] == MODE_SELECT_10
)) &&
673 (status_byte(result
) << 1) == SAM_STAT_GOOD
) {
678 buf
= sg_virt(&sg
[0]);
680 pr_err("Unable to get buf for scatterlist\n");
681 goto after_mode_select
;
684 if (cdb
[0] == MODE_SELECT
)
687 bdl
= (buf
[6] << 8) | (buf
[7]);
690 goto after_mode_select
;
692 if (cdb
[0] == MODE_SELECT
)
693 blocksize
= (buf
[9] << 16) | (buf
[10] << 8) |
696 blocksize
= (buf
[13] << 16) | (buf
[14] << 8) |
699 sd
->sector_size
= blocksize
;
703 if (sense_buffer
&& (status_byte(result
) & CHECK_CONDITION
)) {
704 memcpy(sense_buffer
, pt
->pscsi_sense
, TRANSPORT_SENSE_BUFFER
);
705 cmd
->se_cmd_flags
|= SCF_TRANSPORT_TASK_SENSE
;
710 Opt_scsi_host_id
, Opt_scsi_channel_id
, Opt_scsi_target_id
,
711 Opt_scsi_lun_id
, Opt_err
714 static match_table_t tokens
= {
715 {Opt_scsi_host_id
, "scsi_host_id=%d"},
716 {Opt_scsi_channel_id
, "scsi_channel_id=%d"},
717 {Opt_scsi_target_id
, "scsi_target_id=%d"},
718 {Opt_scsi_lun_id
, "scsi_lun_id=%d"},
722 static ssize_t
pscsi_set_configfs_dev_params(struct se_device
*dev
,
723 const char *page
, ssize_t count
)
725 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
726 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
727 char *orig
, *ptr
, *opts
;
728 substring_t args
[MAX_OPT_ARGS
];
729 int ret
= 0, arg
, token
;
731 opts
= kstrdup(page
, GFP_KERNEL
);
737 while ((ptr
= strsep(&opts
, ",\n")) != NULL
) {
741 token
= match_token(ptr
, tokens
, args
);
743 case Opt_scsi_host_id
:
744 if (phv
->phv_mode
== PHV_LLD_SCSI_HOST_NO
) {
745 pr_err("PSCSI[%d]: Unable to accept"
746 " scsi_host_id while phv_mode =="
747 " PHV_LLD_SCSI_HOST_NO\n",
752 match_int(args
, &arg
);
753 pdv
->pdv_host_id
= arg
;
754 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
755 " %d\n", phv
->phv_host_id
, pdv
->pdv_host_id
);
756 pdv
->pdv_flags
|= PDF_HAS_VIRT_HOST_ID
;
758 case Opt_scsi_channel_id
:
759 match_int(args
, &arg
);
760 pdv
->pdv_channel_id
= arg
;
761 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
762 " ID: %d\n", phv
->phv_host_id
,
763 pdv
->pdv_channel_id
);
764 pdv
->pdv_flags
|= PDF_HAS_CHANNEL_ID
;
766 case Opt_scsi_target_id
:
767 match_int(args
, &arg
);
768 pdv
->pdv_target_id
= arg
;
769 pr_debug("PSCSI[%d]: Referencing SCSI Target"
770 " ID: %d\n", phv
->phv_host_id
,
772 pdv
->pdv_flags
|= PDF_HAS_TARGET_ID
;
774 case Opt_scsi_lun_id
:
775 match_int(args
, &arg
);
776 pdv
->pdv_lun_id
= arg
;
777 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
778 " %d\n", phv
->phv_host_id
, pdv
->pdv_lun_id
);
779 pdv
->pdv_flags
|= PDF_HAS_LUN_ID
;
788 return (!ret
) ? count
: ret
;
791 static ssize_t
pscsi_show_configfs_dev_params(struct se_device
*dev
, char *b
)
793 struct pscsi_hba_virt
*phv
= dev
->se_hba
->hba_ptr
;
794 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
795 struct scsi_device
*sd
= pdv
->pdv_sd
;
796 unsigned char host_id
[16];
800 if (phv
->phv_mode
== PHV_VIRTUAL_HOST_ID
)
801 snprintf(host_id
, 16, "%d", pdv
->pdv_host_id
);
803 snprintf(host_id
, 16, "PHBA Mode");
805 bl
= sprintf(b
, "SCSI Device Bus Location:"
806 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
807 pdv
->pdv_channel_id
, pdv
->pdv_target_id
, pdv
->pdv_lun_id
,
811 bl
+= sprintf(b
+ bl
, " ");
812 bl
+= sprintf(b
+ bl
, "Vendor: ");
813 for (i
= 0; i
< 8; i
++) {
814 if (ISPRINT(sd
->vendor
[i
])) /* printable character? */
815 bl
+= sprintf(b
+ bl
, "%c", sd
->vendor
[i
]);
817 bl
+= sprintf(b
+ bl
, " ");
819 bl
+= sprintf(b
+ bl
, " Model: ");
820 for (i
= 0; i
< 16; i
++) {
821 if (ISPRINT(sd
->model
[i
])) /* printable character ? */
822 bl
+= sprintf(b
+ bl
, "%c", sd
->model
[i
]);
824 bl
+= sprintf(b
+ bl
, " ");
826 bl
+= sprintf(b
+ bl
, " Rev: ");
827 for (i
= 0; i
< 4; i
++) {
828 if (ISPRINT(sd
->rev
[i
])) /* printable character ? */
829 bl
+= sprintf(b
+ bl
, "%c", sd
->rev
[i
]);
831 bl
+= sprintf(b
+ bl
, " ");
833 bl
+= sprintf(b
+ bl
, "\n");
838 static void pscsi_bi_endio(struct bio
*bio
, int error
)
843 static inline struct bio
*pscsi_get_bio(int nr_vecs
)
847 * Use bio_malloc() following the comment in for bio -> struct request
848 * in block/blk-core.c:blk_make_request()
850 bio
= bio_kmalloc(GFP_KERNEL
, nr_vecs
);
852 pr_err("PSCSI: bio_kmalloc() failed\n");
855 bio
->bi_end_io
= pscsi_bi_endio
;
860 static sense_reason_t
861 pscsi_map_sg(struct se_cmd
*cmd
, struct scatterlist
*sgl
, u32 sgl_nents
,
862 enum dma_data_direction data_direction
, struct bio
**hbio
)
864 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(cmd
->se_dev
);
865 struct bio
*bio
= NULL
, *tbio
= NULL
;
867 struct scatterlist
*sg
;
868 u32 data_len
= cmd
->data_length
, i
, len
, bytes
, off
;
869 int nr_pages
= (cmd
->data_length
+ sgl
[0].offset
+
870 PAGE_SIZE
- 1) >> PAGE_SHIFT
;
872 int rw
= (data_direction
== DMA_TO_DEVICE
);
876 pr_debug("PSCSI: nr_pages: %d\n", nr_pages
);
878 for_each_sg(sgl
, sg
, sgl_nents
, i
) {
883 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i
,
887 * We only have one page of data in each sg element,
888 * we can not cross a page boundary.
890 if (off
+ len
> PAGE_SIZE
)
893 if (len
> 0 && data_len
> 0) {
894 bytes
= min_t(unsigned int, len
, PAGE_SIZE
- off
);
895 bytes
= min(bytes
, data_len
);
898 nr_vecs
= min_t(int, BIO_MAX_PAGES
, nr_pages
);
901 * Calls bio_kmalloc() and sets bio->bi_end_io()
903 bio
= pscsi_get_bio(nr_vecs
);
908 bio
->bi_rw
|= REQ_WRITE
;
910 pr_debug("PSCSI: Allocated bio: %p,"
911 " dir: %s nr_vecs: %d\n", bio
,
912 (rw
) ? "rw" : "r", nr_vecs
);
914 * Set *hbio pointer to handle the case:
915 * nr_pages > BIO_MAX_PAGES, where additional
916 * bios need to be added to complete a given
922 tbio
= tbio
->bi_next
= bio
;
925 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
926 " bio: %p page: %p len: %d off: %d\n", i
, bio
,
929 rc
= bio_add_pc_page(pdv
->pdv_sd
->request_queue
,
930 bio
, page
, bytes
, off
);
934 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
935 bio
->bi_vcnt
, nr_vecs
);
937 if (bio
->bi_vcnt
> nr_vecs
) {
938 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
939 " %d i: %d bio: %p, allocating another"
940 " bio\n", bio
->bi_vcnt
, i
, bio
);
942 * Clear the pointer so that another bio will
943 * be allocated with pscsi_get_bio() above, the
944 * current bio has already been set *tbio and
958 *hbio
= (*hbio
)->bi_next
;
959 bio_endio(bio
, 0); /* XXX: should be error */
961 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
965 * Clear a lun set in the cdb if the initiator talking to use spoke
966 * and old standards version, as we can't assume the underlying device
967 * won't choke up on it.
969 static inline void pscsi_clear_cdb_lun(unsigned char *cdb
)
972 case READ_10
: /* SBC - RDProtect */
973 case READ_12
: /* SBC - RDProtect */
974 case READ_16
: /* SBC - RDProtect */
975 case SEND_DIAGNOSTIC
: /* SPC - SELF-TEST Code */
976 case VERIFY
: /* SBC - VRProtect */
977 case VERIFY_16
: /* SBC - VRProtect */
978 case WRITE_VERIFY
: /* SBC - VRProtect */
979 case WRITE_VERIFY_12
: /* SBC - VRProtect */
980 case MAINTENANCE_IN
: /* SPC - Parameter Data Format for SA RTPG */
983 cdb
[1] &= 0x1f; /* clear logical unit number */
988 static sense_reason_t
989 pscsi_parse_cdb(struct se_cmd
*cmd
)
991 unsigned char *cdb
= cmd
->t_task_cdb
;
993 if (cmd
->se_cmd_flags
& SCF_BIDI
)
994 return TCM_UNSUPPORTED_SCSI_OPCODE
;
996 pscsi_clear_cdb_lun(cdb
);
999 * For REPORT LUNS we always need to emulate the response, for everything
1000 * else the default for pSCSI is to pass the command to the underlying
1001 * LLD / physical hardware.
1005 cmd
->execute_cmd
= spc_emulate_report_luns
;
1016 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
1019 cmd
->execute_cmd
= pscsi_execute_cmd
;
1024 static sense_reason_t
1025 pscsi_execute_cmd(struct se_cmd
*cmd
)
1027 struct scatterlist
*sgl
= cmd
->t_data_sg
;
1028 u32 sgl_nents
= cmd
->t_data_nents
;
1029 enum dma_data_direction data_direction
= cmd
->data_direction
;
1030 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(cmd
->se_dev
);
1031 struct pscsi_plugin_task
*pt
;
1032 struct request
*req
;
1037 * Dynamically alloc cdb space, since it may be larger than
1038 * TCM_MAX_COMMAND_SIZE
1040 pt
= kzalloc(sizeof(*pt
) + scsi_command_size(cmd
->t_task_cdb
), GFP_KERNEL
);
1042 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1046 memcpy(pt
->pscsi_cdb
, cmd
->t_task_cdb
,
1047 scsi_command_size(cmd
->t_task_cdb
));
1050 req
= blk_get_request(pdv
->pdv_sd
->request_queue
,
1051 (data_direction
== DMA_TO_DEVICE
),
1054 pr_err("PSCSI: blk_get_request() failed\n");
1055 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1059 blk_rq_set_block_pc(req
);
1061 BUG_ON(!cmd
->data_length
);
1063 ret
= pscsi_map_sg(cmd
, sgl
, sgl_nents
, data_direction
, &hbio
);
1067 req
= blk_make_request(pdv
->pdv_sd
->request_queue
, hbio
,
1070 pr_err("pSCSI: blk_make_request() failed\n");
1071 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1076 req
->end_io
= pscsi_req_done
;
1077 req
->end_io_data
= cmd
;
1078 req
->cmd_len
= scsi_command_size(pt
->pscsi_cdb
);
1079 req
->cmd
= &pt
->pscsi_cdb
[0];
1080 req
->sense
= &pt
->pscsi_sense
[0];
1082 if (pdv
->pdv_sd
->type
== TYPE_DISK
)
1083 req
->timeout
= PS_TIMEOUT_DISK
;
1085 req
->timeout
= PS_TIMEOUT_OTHER
;
1086 req
->retries
= PS_RETRY
;
1088 blk_execute_rq_nowait(pdv
->pdv_sd
->request_queue
, NULL
, req
,
1089 (cmd
->sam_task_attr
== MSG_HEAD_TAG
),
1096 struct bio
*bio
= hbio
;
1097 hbio
= hbio
->bi_next
;
1098 bio_endio(bio
, 0); /* XXX: should be error */
1100 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1106 /* pscsi_get_device_type():
1110 static u32
pscsi_get_device_type(struct se_device
*dev
)
1112 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
1113 struct scsi_device
*sd
= pdv
->pdv_sd
;
1118 static sector_t
pscsi_get_blocks(struct se_device
*dev
)
1120 struct pscsi_dev_virt
*pdv
= PSCSI_DEV(dev
);
1122 if (pdv
->pdv_bd
&& pdv
->pdv_bd
->bd_part
)
1123 return pdv
->pdv_bd
->bd_part
->nr_sects
;
1129 static void pscsi_req_done(struct request
*req
, int uptodate
)
1131 struct se_cmd
*cmd
= req
->end_io_data
;
1132 struct pscsi_plugin_task
*pt
= cmd
->priv
;
1134 pt
->pscsi_result
= req
->errors
;
1135 pt
->pscsi_resid
= req
->resid_len
;
1137 cmd
->scsi_status
= status_byte(pt
->pscsi_result
) << 1;
1138 if (cmd
->scsi_status
) {
1139 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1140 " 0x%02x Result: 0x%08x\n", cmd
, pt
->pscsi_cdb
[0],
1144 switch (host_byte(pt
->pscsi_result
)) {
1146 target_complete_cmd(cmd
, cmd
->scsi_status
);
1149 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1150 " 0x%02x Result: 0x%08x\n", cmd
, pt
->pscsi_cdb
[0],
1152 target_complete_cmd(cmd
, SAM_STAT_CHECK_CONDITION
);
1156 __blk_put_request(req
->q
, req
);
1160 static struct se_subsystem_api pscsi_template
= {
1162 .owner
= THIS_MODULE
,
1163 .transport_type
= TRANSPORT_PLUGIN_PHBA_PDEV
,
1164 .attach_hba
= pscsi_attach_hba
,
1165 .detach_hba
= pscsi_detach_hba
,
1166 .pmode_enable_hba
= pscsi_pmode_enable_hba
,
1167 .alloc_device
= pscsi_alloc_device
,
1168 .configure_device
= pscsi_configure_device
,
1169 .free_device
= pscsi_free_device
,
1170 .transport_complete
= pscsi_transport_complete
,
1171 .parse_cdb
= pscsi_parse_cdb
,
1172 .set_configfs_dev_params
= pscsi_set_configfs_dev_params
,
1173 .show_configfs_dev_params
= pscsi_show_configfs_dev_params
,
1174 .get_device_type
= pscsi_get_device_type
,
1175 .get_blocks
= pscsi_get_blocks
,
1178 static int __init
pscsi_module_init(void)
1180 return transport_subsystem_register(&pscsi_template
);
1183 static void __exit
pscsi_module_exit(void)
1185 transport_subsystem_release(&pscsi_template
);
1188 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1189 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1190 MODULE_LICENSE("GPL");
1192 module_init(pscsi_module_init
);
1193 module_exit(pscsi_module_exit
);