ixgbevf: Add fix to VF to handle multi-descriptor buffers
[linux-2.6/cjktty.git] / drivers / target / target_core_pscsi.c
blob5552fa7426bc9b317da906dec2e395bbf854ae78
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);
71 if (!phv) {
72 pr_err("Unable to allocate struct pscsi_hba_virt\n");
73 return -ENOMEM;
75 phv->phv_host_id = host_id;
76 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
78 hba->hba_ptr = phv;
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",
84 hba->hba_id);
86 return 0;
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;
94 if (scsi_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) :
100 "Unknown");
101 } else
102 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
103 " from Generic Target Core\n", hba->hba_id);
105 kfree(phv);
106 hba->hba_ptr = NULL;
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
116 if (!mode_flag) {
117 if (!sh)
118 return 0;
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");
127 scsi_host_put(sh);
128 return 0;
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);
135 if (IS_ERR(sh)) {
136 pr_err("pSCSI: Unable to locate SCSI Host for"
137 " phv_host_id: %d\n", phv->phv_host_id);
138 return PTR_ERR(sh);
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");
147 return 1;
150 static void pscsi_tape_read_blocksize(struct se_device *dev,
151 struct scsi_device *sdev)
153 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
154 int ret;
156 buf = kzalloc(12, GFP_KERNEL);
157 if (!buf)
158 return;
160 memset(cdb, 0, MAX_COMMAND_SIZE);
161 cdb[0] = MODE_SENSE;
162 cdb[4] = 0x0c; /* 12 bytes */
164 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
165 HZ, 1, NULL);
166 if (ret)
167 goto out_free;
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;
175 out_free:
176 kfree(buf);
179 static void
180 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
182 unsigned char *buf;
184 if (sdev->inquiry_len < INQUIRY_LEN)
185 return;
187 buf = sdev->inquiry;
188 if (!buf)
189 return;
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));
198 static int
199 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
201 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
202 int ret;
204 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
205 if (!buf)
206 return -ENOMEM;
208 memset(cdb, 0, MAX_COMMAND_SIZE);
209 cdb[0] = INQUIRY;
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);
217 if (ret)
218 goto out_free;
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;
224 kfree(buf);
225 return 0;
227 out_free:
228 kfree(buf);
229 return -EPERM;
232 static void
233 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
234 struct t10_wwn *wwn)
236 unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
237 int ident_len, page_len, off = 4, ret;
238 struct t10_vpd *vpd;
240 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
241 if (!buf)
242 return;
244 memset(cdb, 0, MAX_COMMAND_SIZE);
245 cdb[0] = INQUIRY;
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,
253 NULL, HZ, 1, NULL);
254 if (ret)
255 goto out;
257 page_len = (buf[2] << 8) | buf[3];
258 while (page_len > 0) {
259 /* Grab a pointer to the Identification descriptor */
260 page_83 = &buf[off];
261 ident_len = page_83[3];
262 if (!ident_len) {
263 pr_err("page_83[3]: identifier"
264 " length zero!\n");
265 break;
267 pr_debug("T10 VPD Identifer Length: %d\n", ident_len);
269 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
270 if (!vpd) {
271 pr_err("Unable to allocate memory for"
272 " struct t10_vpd\n");
273 goto out;
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);
283 kfree(vpd);
284 continue;
286 if (transport_set_vpd_ident(vpd, page_83) < 0) {
287 off += (ident_len + 4);
288 page_len -= (ident_len + 4);
289 kfree(vpd);
290 continue;
293 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
294 off += (ident_len + 4);
295 page_len -= (ident_len + 4);
298 out:
299 kfree(buf);
302 /* pscsi_add_device_to_list():
306 static struct se_device *pscsi_add_device_to_list(
307 struct se_hba *hba,
308 struct se_subsystem_dev *se_dev,
309 struct pscsi_dev_virt *pdv,
310 struct scsi_device *sd,
311 int dev_flags)
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
350 * ops.
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.
356 pdv->pdv_sd = sd;
357 dev = transport_add_device_to_core_hba(hba, &pscsi_template,
358 se_dev, dev_flags, pdv,
359 &dev_limits, NULL, NULL);
360 if (!dev) {
361 pdv->pdv_sd = NULL;
362 return 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);
382 return dev;
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);
390 if (!pdv) {
391 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
392 return NULL;
394 pdv->pdv_se_hba = hba;
396 pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
397 return pdv;
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,
407 struct se_hba *hba)
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;
414 u32 dev_flags = 0;
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);
420 return NULL;
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);
429 if (IS_ERR(bd)) {
430 pr_err("pSCSI: blkdev_get_by_path() failed\n");
431 scsi_device_put(sd);
432 return NULL;
434 pdv->pdv_bd = bd;
436 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
437 if (!dev) {
438 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
439 scsi_device_put(sd);
440 return NULL;
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);
445 return dev;
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,
455 struct se_hba *hba)
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;
461 u32 dev_flags = 0;
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);
467 return NULL;
469 spin_unlock_irq(sh->host_lock);
471 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
472 if (!dev) {
473 scsi_device_put(sd);
474 return NULL;
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);
480 return dev;
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,
490 struct se_hba *hba)
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;
496 u32 dev_flags = 0;
498 spin_unlock_irq(sh->host_lock);
499 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
500 if (!dev)
501 return NULL;
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);
507 return dev;
510 static struct se_device *pscsi_create_virtdevice(
511 struct se_hba *hba,
512 struct se_subsystem_dev *se_dev,
513 void *p)
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;
522 if (!pdv) {
523 pr_err("Unable to locate struct pscsi_dev_virt"
524 " parameter\n");
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
531 if (!sh) {
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;
567 } else {
568 sh = scsi_host_lookup(pdv->pdv_host_id);
569 if (IS_ERR(sh)) {
570 pr_err("pSCSI: Unable to locate"
571 " pdv_host_id: %d\n", pdv->pdv_host_id);
572 return ERR_CAST(sh);
575 } else {
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))
588 continue;
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.
594 switch (sd->type) {
595 case TYPE_DISK:
596 dev = pscsi_create_type_disk(sd, pdv, se_dev, hba);
597 break;
598 case TYPE_ROM:
599 dev = pscsi_create_type_rom(sd, pdv, se_dev, hba);
600 break;
601 default:
602 dev = pscsi_create_type_other(sd, pdv, se_dev, hba);
603 break;
606 if (!dev) {
607 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
608 scsi_host_put(sh);
609 else if (legacy_mode_enable) {
610 pscsi_pmode_enable_hba(hba, 0);
611 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
613 pdv->pdv_sd = NULL;
614 return ERR_PTR(-ENODEV);
616 return dev;
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)
624 scsi_host_put(sh);
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;
643 if (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);
651 pdv->pdv_bd = NULL;
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))
662 scsi_device_put(sd);
664 pdv->pdv_sd = NULL;
667 kfree(pdv);
670 static int pscsi_transport_complete(struct se_cmd *cmd, struct scatterlist *sg)
672 struct pscsi_dev_virt *pdv = cmd->se_dev->dev_ptr;
673 struct scsi_device *sd = pdv->pdv_sd;
674 int result;
675 struct pscsi_plugin_task *pt = cmd->priv;
676 unsigned char *cdb;
678 * Special case for REPORT_LUNs handling where pscsi_plugin_task has
679 * not been allocated because TCM is handling the emulation directly.
681 if (!pt)
682 return 0;
684 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
688 * forced.
690 if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
691 (status_byte(result) << 1) == SAM_STAT_GOOD) {
692 if (!cmd->se_deve)
693 goto after_mode_sense;
695 if (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY) {
696 unsigned char *buf = transport_kmap_data_sg(cmd);
698 if (cdb[0] == MODE_SENSE_10) {
699 if (!(buf[3] & 0x80))
700 buf[3] |= 0x80;
701 } else {
702 if (!(buf[2] & 0x80))
703 buf[2] |= 0x80;
706 transport_kunmap_data_sg(cmd);
709 after_mode_sense:
711 if (sd->type != TYPE_TAPE)
712 goto after_mode_select;
715 * Hack to correctly obtain the initiator requested blocksize for
716 * TYPE_TAPE. Since this value is dependent upon each tape media,
717 * struct scsi_device->sector_size will not contain the correct value
718 * by default, so we go ahead and set it so
719 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
720 * storage engine.
722 if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
723 (status_byte(result) << 1) == SAM_STAT_GOOD) {
724 unsigned char *buf;
725 u16 bdl;
726 u32 blocksize;
728 buf = sg_virt(&sg[0]);
729 if (!buf) {
730 pr_err("Unable to get buf for scatterlist\n");
731 goto after_mode_select;
734 if (cdb[0] == MODE_SELECT)
735 bdl = (buf[3]);
736 else
737 bdl = (buf[6] << 8) | (buf[7]);
739 if (!bdl)
740 goto after_mode_select;
742 if (cdb[0] == MODE_SELECT)
743 blocksize = (buf[9] << 16) | (buf[10] << 8) |
744 (buf[11]);
745 else
746 blocksize = (buf[13] << 16) | (buf[14] << 8) |
747 (buf[15]);
749 sd->sector_size = blocksize;
751 after_mode_select:
753 if (status_byte(result) & CHECK_CONDITION)
754 return 1;
756 return 0;
759 enum {
760 Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
761 Opt_scsi_lun_id, Opt_err
764 static match_table_t tokens = {
765 {Opt_scsi_host_id, "scsi_host_id=%d"},
766 {Opt_scsi_channel_id, "scsi_channel_id=%d"},
767 {Opt_scsi_target_id, "scsi_target_id=%d"},
768 {Opt_scsi_lun_id, "scsi_lun_id=%d"},
769 {Opt_err, NULL}
772 static ssize_t pscsi_set_configfs_dev_params(struct se_hba *hba,
773 struct se_subsystem_dev *se_dev,
774 const char *page,
775 ssize_t count)
777 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
778 struct pscsi_hba_virt *phv = hba->hba_ptr;
779 char *orig, *ptr, *opts;
780 substring_t args[MAX_OPT_ARGS];
781 int ret = 0, arg, token;
783 opts = kstrdup(page, GFP_KERNEL);
784 if (!opts)
785 return -ENOMEM;
787 orig = opts;
789 while ((ptr = strsep(&opts, ",\n")) != NULL) {
790 if (!*ptr)
791 continue;
793 token = match_token(ptr, tokens, args);
794 switch (token) {
795 case Opt_scsi_host_id:
796 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
797 pr_err("PSCSI[%d]: Unable to accept"
798 " scsi_host_id while phv_mode =="
799 " PHV_LLD_SCSI_HOST_NO\n",
800 phv->phv_host_id);
801 ret = -EINVAL;
802 goto out;
804 match_int(args, &arg);
805 pdv->pdv_host_id = arg;
806 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
807 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
808 pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
809 break;
810 case Opt_scsi_channel_id:
811 match_int(args, &arg);
812 pdv->pdv_channel_id = arg;
813 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
814 " ID: %d\n", phv->phv_host_id,
815 pdv->pdv_channel_id);
816 pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
817 break;
818 case Opt_scsi_target_id:
819 match_int(args, &arg);
820 pdv->pdv_target_id = arg;
821 pr_debug("PSCSI[%d]: Referencing SCSI Target"
822 " ID: %d\n", phv->phv_host_id,
823 pdv->pdv_target_id);
824 pdv->pdv_flags |= PDF_HAS_TARGET_ID;
825 break;
826 case Opt_scsi_lun_id:
827 match_int(args, &arg);
828 pdv->pdv_lun_id = arg;
829 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
830 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
831 pdv->pdv_flags |= PDF_HAS_LUN_ID;
832 break;
833 default:
834 break;
838 out:
839 kfree(orig);
840 return (!ret) ? count : ret;
843 static ssize_t pscsi_check_configfs_dev_params(
844 struct se_hba *hba,
845 struct se_subsystem_dev *se_dev)
847 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
849 if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
850 !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
851 !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
852 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
853 " scsi_lun_id= parameters\n");
854 return -EINVAL;
857 return 0;
860 static ssize_t pscsi_show_configfs_dev_params(struct se_hba *hba,
861 struct se_subsystem_dev *se_dev,
862 char *b)
864 struct pscsi_hba_virt *phv = hba->hba_ptr;
865 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
866 struct scsi_device *sd = pdv->pdv_sd;
867 unsigned char host_id[16];
868 ssize_t bl;
869 int i;
871 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
872 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
873 else
874 snprintf(host_id, 16, "PHBA Mode");
876 bl = sprintf(b, "SCSI Device Bus Location:"
877 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
878 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
879 host_id);
881 if (sd) {
882 bl += sprintf(b + bl, " ");
883 bl += sprintf(b + bl, "Vendor: ");
884 for (i = 0; i < 8; i++) {
885 if (ISPRINT(sd->vendor[i])) /* printable character? */
886 bl += sprintf(b + bl, "%c", sd->vendor[i]);
887 else
888 bl += sprintf(b + bl, " ");
890 bl += sprintf(b + bl, " Model: ");
891 for (i = 0; i < 16; i++) {
892 if (ISPRINT(sd->model[i])) /* printable character ? */
893 bl += sprintf(b + bl, "%c", sd->model[i]);
894 else
895 bl += sprintf(b + bl, " ");
897 bl += sprintf(b + bl, " Rev: ");
898 for (i = 0; i < 4; i++) {
899 if (ISPRINT(sd->rev[i])) /* printable character ? */
900 bl += sprintf(b + bl, "%c", sd->rev[i]);
901 else
902 bl += sprintf(b + bl, " ");
904 bl += sprintf(b + bl, "\n");
906 return bl;
909 static void pscsi_bi_endio(struct bio *bio, int error)
911 bio_put(bio);
914 static inline struct bio *pscsi_get_bio(int sg_num)
916 struct bio *bio;
918 * Use bio_malloc() following the comment in for bio -> struct request
919 * in block/blk-core.c:blk_make_request()
921 bio = bio_kmalloc(GFP_KERNEL, sg_num);
922 if (!bio) {
923 pr_err("PSCSI: bio_kmalloc() failed\n");
924 return NULL;
926 bio->bi_end_io = pscsi_bi_endio;
928 return bio;
931 static int pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl,
932 u32 sgl_nents, enum dma_data_direction data_direction,
933 struct bio **hbio)
935 struct pscsi_dev_virt *pdv = cmd->se_dev->dev_ptr;
936 struct bio *bio = NULL, *tbio = NULL;
937 struct page *page;
938 struct scatterlist *sg;
939 u32 data_len = cmd->data_length, i, len, bytes, off;
940 int nr_pages = (cmd->data_length + sgl[0].offset +
941 PAGE_SIZE - 1) >> PAGE_SHIFT;
942 int nr_vecs = 0, rc;
943 int rw = (data_direction == DMA_TO_DEVICE);
945 *hbio = NULL;
947 pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
949 for_each_sg(sgl, sg, sgl_nents, i) {
950 page = sg_page(sg);
951 off = sg->offset;
952 len = sg->length;
954 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
955 page, len, off);
957 while (len > 0 && data_len > 0) {
958 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
959 bytes = min(bytes, data_len);
961 if (!bio) {
962 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
963 nr_pages -= nr_vecs;
965 * Calls bio_kmalloc() and sets bio->bi_end_io()
967 bio = pscsi_get_bio(nr_vecs);
968 if (!bio)
969 goto fail;
971 if (rw)
972 bio->bi_rw |= REQ_WRITE;
974 pr_debug("PSCSI: Allocated bio: %p,"
975 " dir: %s nr_vecs: %d\n", bio,
976 (rw) ? "rw" : "r", nr_vecs);
978 * Set *hbio pointer to handle the case:
979 * nr_pages > BIO_MAX_PAGES, where additional
980 * bios need to be added to complete a given
981 * command.
983 if (!*hbio)
984 *hbio = tbio = bio;
985 else
986 tbio = tbio->bi_next = bio;
989 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
990 " bio: %p page: %p len: %d off: %d\n", i, bio,
991 page, len, off);
993 rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
994 bio, page, bytes, off);
995 if (rc != bytes)
996 goto fail;
998 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
999 bio->bi_vcnt, nr_vecs);
1001 if (bio->bi_vcnt > nr_vecs) {
1002 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
1003 " %d i: %d bio: %p, allocating another"
1004 " bio\n", bio->bi_vcnt, i, bio);
1006 * Clear the pointer so that another bio will
1007 * be allocated with pscsi_get_bio() above, the
1008 * current bio has already been set *tbio and
1009 * bio->bi_next.
1011 bio = NULL;
1014 page++;
1015 len -= bytes;
1016 data_len -= bytes;
1017 off = 0;
1021 return sgl_nents;
1022 fail:
1023 while (*hbio) {
1024 bio = *hbio;
1025 *hbio = (*hbio)->bi_next;
1026 bio->bi_next = NULL;
1027 bio_endio(bio, 0); /* XXX: should be error */
1029 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1030 return -ENOMEM;
1034 * Clear a lun set in the cdb if the initiator talking to use spoke
1035 * and old standards version, as we can't assume the underlying device
1036 * won't choke up on it.
1038 static inline void pscsi_clear_cdb_lun(unsigned char *cdb)
1040 switch (cdb[0]) {
1041 case READ_10: /* SBC - RDProtect */
1042 case READ_12: /* SBC - RDProtect */
1043 case READ_16: /* SBC - RDProtect */
1044 case SEND_DIAGNOSTIC: /* SPC - SELF-TEST Code */
1045 case VERIFY: /* SBC - VRProtect */
1046 case VERIFY_16: /* SBC - VRProtect */
1047 case WRITE_VERIFY: /* SBC - VRProtect */
1048 case WRITE_VERIFY_12: /* SBC - VRProtect */
1049 case MAINTENANCE_IN: /* SPC - Parameter Data Format for SA RTPG */
1050 break;
1051 default:
1052 cdb[1] &= 0x1f; /* clear logical unit number */
1053 break;
1057 static int pscsi_parse_cdb(struct se_cmd *cmd)
1059 unsigned char *cdb = cmd->t_task_cdb;
1060 unsigned int dummy_size;
1061 int ret;
1063 if (cmd->se_cmd_flags & SCF_BIDI) {
1064 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
1065 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1066 return -EINVAL;
1069 pscsi_clear_cdb_lun(cdb);
1072 * For REPORT LUNS we always need to emulate the response, for everything
1073 * else the default for pSCSI is to pass the command to the underlying
1074 * LLD / physical hardware.
1076 switch (cdb[0]) {
1077 case REPORT_LUNS:
1078 ret = spc_parse_cdb(cmd, &dummy_size);
1079 if (ret)
1080 return ret;
1081 break;
1082 case READ_6:
1083 case READ_10:
1084 case READ_12:
1085 case READ_16:
1086 case WRITE_6:
1087 case WRITE_10:
1088 case WRITE_12:
1089 case WRITE_16:
1090 case WRITE_VERIFY:
1091 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
1092 /* FALLTHROUGH*/
1093 default:
1094 cmd->execute_cmd = pscsi_execute_cmd;
1095 break;
1098 return 0;
1101 static int pscsi_execute_cmd(struct se_cmd *cmd)
1103 struct scatterlist *sgl = cmd->t_data_sg;
1104 u32 sgl_nents = cmd->t_data_nents;
1105 enum dma_data_direction data_direction = cmd->data_direction;
1106 struct pscsi_dev_virt *pdv = cmd->se_dev->dev_ptr;
1107 struct pscsi_plugin_task *pt;
1108 struct request *req;
1109 struct bio *hbio;
1110 int ret;
1113 * Dynamically alloc cdb space, since it may be larger than
1114 * TCM_MAX_COMMAND_SIZE
1116 pt = kzalloc(sizeof(*pt) + scsi_command_size(cmd->t_task_cdb), GFP_KERNEL);
1117 if (!pt) {
1118 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1119 return -ENOMEM;
1121 cmd->priv = pt;
1123 memcpy(pt->pscsi_cdb, cmd->t_task_cdb,
1124 scsi_command_size(cmd->t_task_cdb));
1126 if (!sgl) {
1127 req = blk_get_request(pdv->pdv_sd->request_queue,
1128 (data_direction == DMA_TO_DEVICE),
1129 GFP_KERNEL);
1130 if (!req || IS_ERR(req)) {
1131 pr_err("PSCSI: blk_get_request() failed: %ld\n",
1132 req ? IS_ERR(req) : -ENOMEM);
1133 cmd->scsi_sense_reason =
1134 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1135 goto fail;
1137 } else {
1138 BUG_ON(!cmd->data_length);
1140 ret = pscsi_map_sg(cmd, sgl, sgl_nents, data_direction, &hbio);
1141 if (ret < 0) {
1142 cmd->scsi_sense_reason =
1143 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1144 goto fail;
1147 req = blk_make_request(pdv->pdv_sd->request_queue, hbio,
1148 GFP_KERNEL);
1149 if (IS_ERR(req)) {
1150 pr_err("pSCSI: blk_make_request() failed\n");
1151 goto fail_free_bio;
1155 req->cmd_type = REQ_TYPE_BLOCK_PC;
1156 req->end_io = pscsi_req_done;
1157 req->end_io_data = cmd;
1158 req->cmd_len = scsi_command_size(pt->pscsi_cdb);
1159 req->cmd = &pt->pscsi_cdb[0];
1160 req->sense = &pt->pscsi_sense[0];
1161 req->sense_len = 0;
1162 if (pdv->pdv_sd->type == TYPE_DISK)
1163 req->timeout = PS_TIMEOUT_DISK;
1164 else
1165 req->timeout = PS_TIMEOUT_OTHER;
1166 req->retries = PS_RETRY;
1168 blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
1169 (cmd->sam_task_attr == MSG_HEAD_TAG),
1170 pscsi_req_done);
1172 return 0;
1174 fail_free_bio:
1175 while (hbio) {
1176 struct bio *bio = hbio;
1177 hbio = hbio->bi_next;
1178 bio->bi_next = NULL;
1179 bio_endio(bio, 0); /* XXX: should be error */
1181 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1182 fail:
1183 kfree(pt);
1184 return -ENOMEM;
1187 static unsigned char *pscsi_get_sense_buffer(struct se_cmd *cmd)
1189 struct pscsi_plugin_task *pt = cmd->priv;
1191 return pt->pscsi_sense;
1194 /* pscsi_get_device_rev():
1198 static u32 pscsi_get_device_rev(struct se_device *dev)
1200 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1201 struct scsi_device *sd = pdv->pdv_sd;
1203 return (sd->scsi_level - 1) ? sd->scsi_level - 1 : 1;
1206 /* pscsi_get_device_type():
1210 static u32 pscsi_get_device_type(struct se_device *dev)
1212 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1213 struct scsi_device *sd = pdv->pdv_sd;
1215 return sd->type;
1218 static sector_t pscsi_get_blocks(struct se_device *dev)
1220 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1222 if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1223 return pdv->pdv_bd->bd_part->nr_sects;
1225 dump_stack();
1226 return 0;
1229 static void pscsi_req_done(struct request *req, int uptodate)
1231 struct se_cmd *cmd = req->end_io_data;
1232 struct pscsi_plugin_task *pt = cmd->priv;
1234 pt->pscsi_result = req->errors;
1235 pt->pscsi_resid = req->resid_len;
1237 cmd->scsi_status = status_byte(pt->pscsi_result) << 1;
1238 if (cmd->scsi_status) {
1239 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1240 " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1241 pt->pscsi_result);
1244 switch (host_byte(pt->pscsi_result)) {
1245 case DID_OK:
1246 target_complete_cmd(cmd, cmd->scsi_status);
1247 break;
1248 default:
1249 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1250 " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1251 pt->pscsi_result);
1252 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1253 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
1254 break;
1257 __blk_put_request(req->q, req);
1258 kfree(pt);
1261 static struct se_subsystem_api pscsi_template = {
1262 .name = "pscsi",
1263 .owner = THIS_MODULE,
1264 .transport_type = TRANSPORT_PLUGIN_PHBA_PDEV,
1265 .attach_hba = pscsi_attach_hba,
1266 .detach_hba = pscsi_detach_hba,
1267 .pmode_enable_hba = pscsi_pmode_enable_hba,
1268 .allocate_virtdevice = pscsi_allocate_virtdevice,
1269 .create_virtdevice = pscsi_create_virtdevice,
1270 .free_device = pscsi_free_device,
1271 .transport_complete = pscsi_transport_complete,
1272 .parse_cdb = pscsi_parse_cdb,
1273 .check_configfs_dev_params = pscsi_check_configfs_dev_params,
1274 .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1275 .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1276 .get_sense_buffer = pscsi_get_sense_buffer,
1277 .get_device_rev = pscsi_get_device_rev,
1278 .get_device_type = pscsi_get_device_type,
1279 .get_blocks = pscsi_get_blocks,
1282 static int __init pscsi_module_init(void)
1284 return transport_subsystem_register(&pscsi_template);
1287 static void pscsi_module_exit(void)
1289 transport_subsystem_release(&pscsi_template);
1292 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1293 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1294 MODULE_LICENSE("GPL");
1296 module_init(pscsi_module_init);
1297 module_exit(pscsi_module_exit);