]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/target/target_core_pscsi.c
target: kill struct se_subsystem_dev
[karo-tx-linux.git] / drivers / target / target_core_pscsi.c
1 /*******************************************************************************
2  * Filename:  target_core_pscsi.c
3  *
4  * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
5  *
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
10  *
11  * Nicholas A. Bellinger <nab@kernel.org>
12  *
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.
17  *
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.
22  *
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.
26  *
27  ******************************************************************************/
28
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>
41
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>
47
48 #include <target/target_core_base.h>
49 #include <target/target_core_backend.h>
50
51 #include "target_core_alua.h"
52 #include "target_core_pscsi.h"
53
54 #define ISPRINT(a)  ((a >= ' ') && (a <= '~'))
55
56 static inline struct pscsi_dev_virt *PSCSI_DEV(struct se_device *dev)
57 {
58         return container_of(dev, struct pscsi_dev_virt, dev);
59 }
60
61 static struct se_subsystem_api pscsi_template;
62
63 static int pscsi_execute_cmd(struct se_cmd *cmd);
64 static void pscsi_req_done(struct request *, int);
65
66 /*      pscsi_attach_hba():
67  *
68  *      pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
69  *      from the passed SCSI Host ID.
70  */
71 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
72 {
73         struct pscsi_hba_virt *phv;
74
75         phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
76         if (!phv) {
77                 pr_err("Unable to allocate struct pscsi_hba_virt\n");
78                 return -ENOMEM;
79         }
80         phv->phv_host_id = host_id;
81         phv->phv_mode = PHV_VIRTUAL_HOST_ID;
82
83         hba->hba_ptr = phv;
84
85         pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
86                 " Generic Target Core Stack %s\n", hba->hba_id,
87                 PSCSI_VERSION, TARGET_CORE_MOD_VERSION);
88         pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
89                hba->hba_id);
90
91         return 0;
92 }
93
94 static void pscsi_detach_hba(struct se_hba *hba)
95 {
96         struct pscsi_hba_virt *phv = hba->hba_ptr;
97         struct Scsi_Host *scsi_host = phv->phv_lld_host;
98
99         if (scsi_host) {
100                 scsi_host_put(scsi_host);
101
102                 pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
103                         " Generic Target Core\n", hba->hba_id,
104                         (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
105                         "Unknown");
106         } else
107                 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
108                         " from Generic Target Core\n", hba->hba_id);
109
110         kfree(phv);
111         hba->hba_ptr = NULL;
112 }
113
114 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
115 {
116         struct pscsi_hba_virt *phv = hba->hba_ptr;
117         struct Scsi_Host *sh = phv->phv_lld_host;
118         /*
119          * Release the struct Scsi_Host
120          */
121         if (!mode_flag) {
122                 if (!sh)
123                         return 0;
124
125                 phv->phv_lld_host = NULL;
126                 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
127
128                 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
129                         " %s\n", hba->hba_id, (sh->hostt->name) ?
130                         (sh->hostt->name) : "Unknown");
131
132                 scsi_host_put(sh);
133                 return 0;
134         }
135         /*
136          * Otherwise, locate struct Scsi_Host from the original passed
137          * pSCSI Host ID and enable for phba mode
138          */
139         sh = scsi_host_lookup(phv->phv_host_id);
140         if (IS_ERR(sh)) {
141                 pr_err("pSCSI: Unable to locate SCSI Host for"
142                         " phv_host_id: %d\n", phv->phv_host_id);
143                 return PTR_ERR(sh);
144         }
145
146         phv->phv_lld_host = sh;
147         phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
148
149         pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
150                 hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
151
152         return 1;
153 }
154
155 static void pscsi_tape_read_blocksize(struct se_device *dev,
156                 struct scsi_device *sdev)
157 {
158         unsigned char cdb[MAX_COMMAND_SIZE], *buf;
159         int ret;
160
161         buf = kzalloc(12, GFP_KERNEL);
162         if (!buf)
163                 return;
164
165         memset(cdb, 0, MAX_COMMAND_SIZE);
166         cdb[0] = MODE_SENSE;
167         cdb[4] = 0x0c; /* 12 bytes */
168
169         ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
170                         HZ, 1, NULL);
171         if (ret)
172                 goto out_free;
173
174         /*
175          * If MODE_SENSE still returns zero, set the default value to 1024.
176          */
177         sdev->sector_size = (buf[9] << 16) | (buf[10] << 8) | (buf[11]);
178         if (!sdev->sector_size)
179                 sdev->sector_size = 1024;
180 out_free:
181         kfree(buf);
182 }
183
184 static void
185 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
186 {
187         unsigned char *buf;
188
189         if (sdev->inquiry_len < INQUIRY_LEN)
190                 return;
191
192         buf = sdev->inquiry;
193         if (!buf)
194                 return;
195         /*
196          * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
197          */
198         memcpy(&wwn->vendor[0], &buf[8], sizeof(wwn->vendor));
199         memcpy(&wwn->model[0], &buf[16], sizeof(wwn->model));
200         memcpy(&wwn->revision[0], &buf[32], sizeof(wwn->revision));
201 }
202
203 static int
204 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
205 {
206         unsigned char cdb[MAX_COMMAND_SIZE], *buf;
207         int ret;
208
209         buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
210         if (!buf)
211                 return -ENOMEM;
212
213         memset(cdb, 0, MAX_COMMAND_SIZE);
214         cdb[0] = INQUIRY;
215         cdb[1] = 0x01; /* Query VPD */
216         cdb[2] = 0x80; /* Unit Serial Number */
217         cdb[3] = (INQUIRY_VPD_SERIAL_LEN >> 8) & 0xff;
218         cdb[4] = (INQUIRY_VPD_SERIAL_LEN & 0xff);
219
220         ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
221                               INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
222         if (ret)
223                 goto out_free;
224
225         snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
226
227         wwn->t10_dev->dev_flags |= DF_FIRMWARE_VPD_UNIT_SERIAL;
228
229         kfree(buf);
230         return 0;
231
232 out_free:
233         kfree(buf);
234         return -EPERM;
235 }
236
237 static void
238 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
239                 struct t10_wwn *wwn)
240 {
241         unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
242         int ident_len, page_len, off = 4, ret;
243         struct t10_vpd *vpd;
244
245         buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
246         if (!buf)
247                 return;
248
249         memset(cdb, 0, MAX_COMMAND_SIZE);
250         cdb[0] = INQUIRY;
251         cdb[1] = 0x01; /* Query VPD */
252         cdb[2] = 0x83; /* Device Identifier */
253         cdb[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN >> 8) & 0xff;
254         cdb[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN & 0xff);
255
256         ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
257                               INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
258                               NULL, HZ, 1, NULL);
259         if (ret)
260                 goto out;
261
262         page_len = (buf[2] << 8) | buf[3];
263         while (page_len > 0) {
264                 /* Grab a pointer to the Identification descriptor */
265                 page_83 = &buf[off];
266                 ident_len = page_83[3];
267                 if (!ident_len) {
268                         pr_err("page_83[3]: identifier"
269                                         " length zero!\n");
270                         break;
271                 }
272                 pr_debug("T10 VPD Identifier Length: %d\n", ident_len);
273
274                 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
275                 if (!vpd) {
276                         pr_err("Unable to allocate memory for"
277                                         " struct t10_vpd\n");
278                         goto out;
279                 }
280                 INIT_LIST_HEAD(&vpd->vpd_list);
281
282                 transport_set_vpd_proto_id(vpd, page_83);
283                 transport_set_vpd_assoc(vpd, page_83);
284
285                 if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
286                         off += (ident_len + 4);
287                         page_len -= (ident_len + 4);
288                         kfree(vpd);
289                         continue;
290                 }
291                 if (transport_set_vpd_ident(vpd, page_83) < 0) {
292                         off += (ident_len + 4);
293                         page_len -= (ident_len + 4);
294                         kfree(vpd);
295                         continue;
296                 }
297
298                 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
299                 off += (ident_len + 4);
300                 page_len -= (ident_len + 4);
301         }
302
303 out:
304         kfree(buf);
305 }
306
307 static int pscsi_add_device_to_list(struct se_device *dev,
308                 struct scsi_device *sd)
309 {
310         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
311         struct request_queue *q = sd->request_queue;
312
313         pdv->pdv_sd = sd;
314
315         if (!sd->queue_depth) {
316                 sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
317
318                 pr_err("Set broken SCSI Device %d:%d:%d"
319                         " queue_depth to %d\n", sd->channel, sd->id,
320                                 sd->lun, sd->queue_depth);
321         }
322
323         dev->dev_attrib.hw_block_size = sd->sector_size;
324         dev->dev_attrib.hw_max_sectors =
325                 min_t(int, sd->host->max_sectors, queue_max_hw_sectors(q));
326         dev->dev_attrib.hw_queue_depth = sd->queue_depth;
327
328         /*
329          * Setup our standard INQUIRY info into se_dev->t10_wwn
330          */
331         pscsi_set_inquiry_info(sd, &dev->t10_wwn);
332
333         /*
334          * Locate VPD WWN Information used for various purposes within
335          * the Storage Engine.
336          */
337         if (!pscsi_get_inquiry_vpd_serial(sd, &dev->t10_wwn)) {
338                 /*
339                  * If VPD Unit Serial returned GOOD status, try
340                  * VPD Device Identification page (0x83).
341                  */
342                 pscsi_get_inquiry_vpd_device_ident(sd, &dev->t10_wwn);
343         }
344
345         /*
346          * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
347          */
348         if (sd->type == TYPE_TAPE)
349                 pscsi_tape_read_blocksize(dev, sd);
350         return 0;
351 }
352
353 static struct se_device *pscsi_alloc_device(struct se_hba *hba,
354                 const char *name)
355 {
356         struct pscsi_dev_virt *pdv;
357
358         pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
359         if (!pdv) {
360                 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
361                 return NULL;
362         }
363
364         pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
365         return &pdv->dev;
366 }
367
368 /*
369  * Called with struct Scsi_Host->host_lock called.
370  */
371 static int pscsi_create_type_disk(struct se_device *dev, struct scsi_device *sd)
372         __releases(sh->host_lock)
373 {
374         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
375         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
376         struct Scsi_Host *sh = sd->host;
377         struct block_device *bd;
378         int ret;
379
380         if (scsi_device_get(sd)) {
381                 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
382                         sh->host_no, sd->channel, sd->id, sd->lun);
383                 spin_unlock_irq(sh->host_lock);
384                 return -EIO;
385         }
386         spin_unlock_irq(sh->host_lock);
387         /*
388          * Claim exclusive struct block_device access to struct scsi_device
389          * for TYPE_DISK using supplied udev_path
390          */
391         bd = blkdev_get_by_path(dev->udev_path,
392                                 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
393         if (IS_ERR(bd)) {
394                 pr_err("pSCSI: blkdev_get_by_path() failed\n");
395                 scsi_device_put(sd);
396                 return PTR_ERR(bd);
397         }
398         pdv->pdv_bd = bd;
399
400         ret = pscsi_add_device_to_list(dev, sd);
401         if (ret) {
402                 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
403                 scsi_device_put(sd);
404                 return ret;
405         }
406
407         pr_debug("CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%d\n",
408                 phv->phv_host_id, sh->host_no, sd->channel, sd->id, sd->lun);
409         return 0;
410 }
411
412 /*
413  * Called with struct Scsi_Host->host_lock called.
414  */
415 static int pscsi_create_type_rom(struct se_device *dev, struct scsi_device *sd)
416         __releases(sh->host_lock)
417 {
418         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
419         struct Scsi_Host *sh = sd->host;
420         int ret;
421
422         if (scsi_device_get(sd)) {
423                 pr_err("scsi_device_get() failed for %d:%d:%d:%d\n",
424                         sh->host_no, sd->channel, sd->id, sd->lun);
425                 spin_unlock_irq(sh->host_lock);
426                 return -EIO;
427         }
428         spin_unlock_irq(sh->host_lock);
429
430         ret = pscsi_add_device_to_list(dev, sd);
431         if (ret) {
432                 scsi_device_put(sd);
433                 return ret;
434         }
435         pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
436                 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
437                 sd->channel, sd->id, sd->lun);
438
439         return 0;
440 }
441
442 /*
443  * Called with struct Scsi_Host->host_lock called.
444  */
445 static int pscsi_create_type_other(struct se_device *dev,
446                 struct scsi_device *sd)
447         __releases(sh->host_lock)
448 {
449         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
450         struct Scsi_Host *sh = sd->host;
451         int ret;
452
453         spin_unlock_irq(sh->host_lock);
454         ret = pscsi_add_device_to_list(dev, sd);
455         if (ret)
456                 return ret;
457
458         pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%d\n",
459                 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
460                 sd->channel, sd->id, sd->lun);
461         return 0;
462 }
463
464 int pscsi_configure_device(struct se_device *dev)
465 {
466         struct se_hba *hba = dev->se_hba;
467         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
468         struct scsi_device *sd;
469         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
470         struct Scsi_Host *sh = phv->phv_lld_host;
471         int legacy_mode_enable = 0;
472         int ret;
473
474         if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
475             !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
476             !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
477                 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
478                         " scsi_lun_id= parameters\n");
479                 return -EINVAL;
480         }
481
482         /*
483          * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
484          * struct Scsi_Host we will need to bring the TCM/pSCSI object online
485          */
486         if (!sh) {
487                 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
488                         pr_err("pSCSI: Unable to locate struct"
489                                 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
490                         return -ENODEV;
491                 }
492                 /*
493                  * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
494                  * reference, we enforce that udev_path has been set
495                  */
496                 if (!(dev->dev_flags & DF_USING_UDEV_PATH)) {
497                         pr_err("pSCSI: udev_path attribute has not"
498                                 " been set before ENABLE=1\n");
499                         return -EINVAL;
500                 }
501                 /*
502                  * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
503                  * use the original TCM hba ID to reference Linux/SCSI Host No
504                  * and enable for PHV_LLD_SCSI_HOST_NO mode.
505                  */
506                 if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
507                         if (hba->dev_count) {
508                                 pr_err("pSCSI: Unable to set hba_mode"
509                                         " with active devices\n");
510                                 return -EEXIST;
511                         }
512
513                         if (pscsi_pmode_enable_hba(hba, 1) != 1)
514                                 return -ENODEV;
515
516                         legacy_mode_enable = 1;
517                         hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
518                         sh = phv->phv_lld_host;
519                 } else {
520                         sh = scsi_host_lookup(pdv->pdv_host_id);
521                         if (IS_ERR(sh)) {
522                                 pr_err("pSCSI: Unable to locate"
523                                         " pdv_host_id: %d\n", pdv->pdv_host_id);
524                                 return PTR_ERR(sh);
525                         }
526                 }
527         } else {
528                 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID) {
529                         pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
530                                 " struct Scsi_Host exists\n");
531                         return -EEXIST;
532                 }
533         }
534
535         spin_lock_irq(sh->host_lock);
536         list_for_each_entry(sd, &sh->__devices, siblings) {
537                 if ((pdv->pdv_channel_id != sd->channel) ||
538                     (pdv->pdv_target_id != sd->id) ||
539                     (pdv->pdv_lun_id != sd->lun))
540                         continue;
541                 /*
542                  * Functions will release the held struct scsi_host->host_lock
543                  * before calling calling pscsi_add_device_to_list() to register
544                  * struct scsi_device with target_core_mod.
545                  */
546                 switch (sd->type) {
547                 case TYPE_DISK:
548                         ret = pscsi_create_type_disk(dev, sd);
549                         break;
550                 case TYPE_ROM:
551                         ret = pscsi_create_type_rom(dev, sd);
552                         break;
553                 default:
554                         ret = pscsi_create_type_other(dev, sd);
555                         break;
556                 }
557
558                 if (ret) {
559                         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
560                                 scsi_host_put(sh);
561                         else if (legacy_mode_enable) {
562                                 pscsi_pmode_enable_hba(hba, 0);
563                                 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
564                         }
565                         pdv->pdv_sd = NULL;
566                         return ret;
567                 }
568                 return 0;
569         }
570         spin_unlock_irq(sh->host_lock);
571
572         pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
573                 pdv->pdv_channel_id,  pdv->pdv_target_id, pdv->pdv_lun_id);
574
575         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
576                 scsi_host_put(sh);
577         else if (legacy_mode_enable) {
578                 pscsi_pmode_enable_hba(hba, 0);
579                 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
580         }
581
582         return -ENODEV;
583 }
584
585 static void pscsi_free_device(struct se_device *dev)
586 {
587         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
588         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
589         struct scsi_device *sd = pdv->pdv_sd;
590
591         if (sd) {
592                 /*
593                  * Release exclusive pSCSI internal struct block_device claim for
594                  * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
595                  */
596                 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
597                         blkdev_put(pdv->pdv_bd,
598                                    FMODE_WRITE|FMODE_READ|FMODE_EXCL);
599                         pdv->pdv_bd = NULL;
600                 }
601                 /*
602                  * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
603                  * to struct Scsi_Host now.
604                  */
605                 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
606                     (phv->phv_lld_host != NULL))
607                         scsi_host_put(phv->phv_lld_host);
608
609                 if ((sd->type == TYPE_DISK) || (sd->type == TYPE_ROM))
610                         scsi_device_put(sd);
611
612                 pdv->pdv_sd = NULL;
613         }
614
615         kfree(pdv);
616 }
617
618 static void pscsi_transport_complete(struct se_cmd *cmd, struct scatterlist *sg,
619                                      unsigned char *sense_buffer)
620 {
621         struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
622         struct scsi_device *sd = pdv->pdv_sd;
623         int result;
624         struct pscsi_plugin_task *pt = cmd->priv;
625         unsigned char *cdb;
626         /*
627          * Special case for REPORT_LUNs handling where pscsi_plugin_task has
628          * not been allocated because TCM is handling the emulation directly.
629          */
630         if (!pt)
631                 return;
632
633         cdb = &pt->pscsi_cdb[0];
634         result = pt->pscsi_result;
635         /*
636          * Hack to make sure that Write-Protect modepage is set if R/O mode is
637          * forced.
638          */
639         if (!cmd->se_deve || !cmd->data_length)
640                 goto after_mode_sense;
641
642         if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
643              (status_byte(result) << 1) == SAM_STAT_GOOD) {
644                 if (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY) {
645                         unsigned char *buf = transport_kmap_data_sg(cmd);
646
647                         if (cdb[0] == MODE_SENSE_10) {
648                                 if (!(buf[3] & 0x80))
649                                         buf[3] |= 0x80;
650                         } else {
651                                 if (!(buf[2] & 0x80))
652                                         buf[2] |= 0x80;
653                         }
654
655                         transport_kunmap_data_sg(cmd);
656                 }
657         }
658 after_mode_sense:
659
660         if (sd->type != TYPE_TAPE || !cmd->data_length)
661                 goto after_mode_select;
662
663         /*
664          * Hack to correctly obtain the initiator requested blocksize for
665          * TYPE_TAPE.  Since this value is dependent upon each tape media,
666          * struct scsi_device->sector_size will not contain the correct value
667          * by default, so we go ahead and set it so
668          * TRANSPORT(dev)->get_blockdev() returns the correct value to the
669          * storage engine.
670          */
671         if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
672               (status_byte(result) << 1) == SAM_STAT_GOOD) {
673                 unsigned char *buf;
674                 u16 bdl;
675                 u32 blocksize;
676
677                 buf = sg_virt(&sg[0]);
678                 if (!buf) {
679                         pr_err("Unable to get buf for scatterlist\n");
680                         goto after_mode_select;
681                 }
682
683                 if (cdb[0] == MODE_SELECT)
684                         bdl = (buf[3]);
685                 else
686                         bdl = (buf[6] << 8) | (buf[7]);
687
688                 if (!bdl)
689                         goto after_mode_select;
690
691                 if (cdb[0] == MODE_SELECT)
692                         blocksize = (buf[9] << 16) | (buf[10] << 8) |
693                                         (buf[11]);
694                 else
695                         blocksize = (buf[13] << 16) | (buf[14] << 8) |
696                                         (buf[15]);
697
698                 sd->sector_size = blocksize;
699         }
700 after_mode_select:
701
702         if (sense_buffer && (status_byte(result) & CHECK_CONDITION)) {
703                 memcpy(sense_buffer, pt->pscsi_sense, TRANSPORT_SENSE_BUFFER);
704                 cmd->se_cmd_flags |= SCF_TRANSPORT_TASK_SENSE;
705         }
706 }
707
708 enum {
709         Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
710         Opt_scsi_lun_id, Opt_err
711 };
712
713 static match_table_t tokens = {
714         {Opt_scsi_host_id, "scsi_host_id=%d"},
715         {Opt_scsi_channel_id, "scsi_channel_id=%d"},
716         {Opt_scsi_target_id, "scsi_target_id=%d"},
717         {Opt_scsi_lun_id, "scsi_lun_id=%d"},
718         {Opt_err, NULL}
719 };
720
721 static ssize_t pscsi_set_configfs_dev_params(struct se_device *dev,
722                 const char *page, ssize_t count)
723 {
724         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
725         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
726         char *orig, *ptr, *opts;
727         substring_t args[MAX_OPT_ARGS];
728         int ret = 0, arg, token;
729
730         opts = kstrdup(page, GFP_KERNEL);
731         if (!opts)
732                 return -ENOMEM;
733
734         orig = opts;
735
736         while ((ptr = strsep(&opts, ",\n")) != NULL) {
737                 if (!*ptr)
738                         continue;
739
740                 token = match_token(ptr, tokens, args);
741                 switch (token) {
742                 case Opt_scsi_host_id:
743                         if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
744                                 pr_err("PSCSI[%d]: Unable to accept"
745                                         " scsi_host_id while phv_mode =="
746                                         " PHV_LLD_SCSI_HOST_NO\n",
747                                         phv->phv_host_id);
748                                 ret = -EINVAL;
749                                 goto out;
750                         }
751                         match_int(args, &arg);
752                         pdv->pdv_host_id = arg;
753                         pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
754                                 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
755                         pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
756                         break;
757                 case Opt_scsi_channel_id:
758                         match_int(args, &arg);
759                         pdv->pdv_channel_id = arg;
760                         pr_debug("PSCSI[%d]: Referencing SCSI Channel"
761                                 " ID: %d\n",  phv->phv_host_id,
762                                 pdv->pdv_channel_id);
763                         pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
764                         break;
765                 case Opt_scsi_target_id:
766                         match_int(args, &arg);
767                         pdv->pdv_target_id = arg;
768                         pr_debug("PSCSI[%d]: Referencing SCSI Target"
769                                 " ID: %d\n", phv->phv_host_id,
770                                 pdv->pdv_target_id);
771                         pdv->pdv_flags |= PDF_HAS_TARGET_ID;
772                         break;
773                 case Opt_scsi_lun_id:
774                         match_int(args, &arg);
775                         pdv->pdv_lun_id = arg;
776                         pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
777                                 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
778                         pdv->pdv_flags |= PDF_HAS_LUN_ID;
779                         break;
780                 default:
781                         break;
782                 }
783         }
784
785 out:
786         kfree(orig);
787         return (!ret) ? count : ret;
788 }
789
790 static ssize_t pscsi_show_configfs_dev_params(struct se_device *dev, char *b)
791 {
792         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
793         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
794         struct scsi_device *sd = pdv->pdv_sd;
795         unsigned char host_id[16];
796         ssize_t bl;
797         int i;
798
799         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
800                 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
801         else
802                 snprintf(host_id, 16, "PHBA Mode");
803
804         bl = sprintf(b, "SCSI Device Bus Location:"
805                 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
806                 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
807                 host_id);
808
809         if (sd) {
810                 bl += sprintf(b + bl, "        ");
811                 bl += sprintf(b + bl, "Vendor: ");
812                 for (i = 0; i < 8; i++) {
813                         if (ISPRINT(sd->vendor[i]))   /* printable character? */
814                                 bl += sprintf(b + bl, "%c", sd->vendor[i]);
815                         else
816                                 bl += sprintf(b + bl, " ");
817                 }
818                 bl += sprintf(b + bl, " Model: ");
819                 for (i = 0; i < 16; i++) {
820                         if (ISPRINT(sd->model[i]))   /* printable character ? */
821                                 bl += sprintf(b + bl, "%c", sd->model[i]);
822                         else
823                                 bl += sprintf(b + bl, " ");
824                 }
825                 bl += sprintf(b + bl, " Rev: ");
826                 for (i = 0; i < 4; i++) {
827                         if (ISPRINT(sd->rev[i]))   /* printable character ? */
828                                 bl += sprintf(b + bl, "%c", sd->rev[i]);
829                         else
830                                 bl += sprintf(b + bl, " ");
831                 }
832                 bl += sprintf(b + bl, "\n");
833         }
834         return bl;
835 }
836
837 static void pscsi_bi_endio(struct bio *bio, int error)
838 {
839         bio_put(bio);
840 }
841
842 static inline struct bio *pscsi_get_bio(int sg_num)
843 {
844         struct bio *bio;
845         /*
846          * Use bio_malloc() following the comment in for bio -> struct request
847          * in block/blk-core.c:blk_make_request()
848          */
849         bio = bio_kmalloc(GFP_KERNEL, sg_num);
850         if (!bio) {
851                 pr_err("PSCSI: bio_kmalloc() failed\n");
852                 return NULL;
853         }
854         bio->bi_end_io = pscsi_bi_endio;
855
856         return bio;
857 }
858
859 static int pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl,
860                 u32 sgl_nents, enum dma_data_direction data_direction,
861                 struct bio **hbio)
862 {
863         struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
864         struct bio *bio = NULL, *tbio = NULL;
865         struct page *page;
866         struct scatterlist *sg;
867         u32 data_len = cmd->data_length, i, len, bytes, off;
868         int nr_pages = (cmd->data_length + sgl[0].offset +
869                         PAGE_SIZE - 1) >> PAGE_SHIFT;
870         int nr_vecs = 0, rc;
871         int rw = (data_direction == DMA_TO_DEVICE);
872
873         *hbio = NULL;
874
875         pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
876
877         for_each_sg(sgl, sg, sgl_nents, i) {
878                 page = sg_page(sg);
879                 off = sg->offset;
880                 len = sg->length;
881
882                 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
883                         page, len, off);
884
885                 while (len > 0 && data_len > 0) {
886                         bytes = min_t(unsigned int, len, PAGE_SIZE - off);
887                         bytes = min(bytes, data_len);
888
889                         if (!bio) {
890                                 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
891                                 nr_pages -= nr_vecs;
892                                 /*
893                                  * Calls bio_kmalloc() and sets bio->bi_end_io()
894                                  */
895                                 bio = pscsi_get_bio(nr_vecs);
896                                 if (!bio)
897                                         goto fail;
898
899                                 if (rw)
900                                         bio->bi_rw |= REQ_WRITE;
901
902                                 pr_debug("PSCSI: Allocated bio: %p,"
903                                         " dir: %s nr_vecs: %d\n", bio,
904                                         (rw) ? "rw" : "r", nr_vecs);
905                                 /*
906                                  * Set *hbio pointer to handle the case:
907                                  * nr_pages > BIO_MAX_PAGES, where additional
908                                  * bios need to be added to complete a given
909                                  * command.
910                                  */
911                                 if (!*hbio)
912                                         *hbio = tbio = bio;
913                                 else
914                                         tbio = tbio->bi_next = bio;
915                         }
916
917                         pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
918                                 " bio: %p page: %p len: %d off: %d\n", i, bio,
919                                 page, len, off);
920
921                         rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
922                                         bio, page, bytes, off);
923                         if (rc != bytes)
924                                 goto fail;
925
926                         pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
927                                 bio->bi_vcnt, nr_vecs);
928
929                         if (bio->bi_vcnt > nr_vecs) {
930                                 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
931                                         " %d i: %d bio: %p, allocating another"
932                                         " bio\n", bio->bi_vcnt, i, bio);
933                                 /*
934                                  * Clear the pointer so that another bio will
935                                  * be allocated with pscsi_get_bio() above, the
936                                  * current bio has already been set *tbio and
937                                  * bio->bi_next.
938                                  */
939                                 bio = NULL;
940                         }
941
942                         page++;
943                         len -= bytes;
944                         data_len -= bytes;
945                         off = 0;
946                 }
947         }
948
949         return sgl_nents;
950 fail:
951         while (*hbio) {
952                 bio = *hbio;
953                 *hbio = (*hbio)->bi_next;
954                 bio->bi_next = NULL;
955                 bio_endio(bio, 0);      /* XXX: should be error */
956         }
957         cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
958         return -ENOMEM;
959 }
960
961 /*
962  * Clear a lun set in the cdb if the initiator talking to use spoke
963  * and old standards version, as we can't assume the underlying device
964  * won't choke up on it.
965  */
966 static inline void pscsi_clear_cdb_lun(unsigned char *cdb)
967 {
968         switch (cdb[0]) {
969         case READ_10: /* SBC - RDProtect */
970         case READ_12: /* SBC - RDProtect */
971         case READ_16: /* SBC - RDProtect */
972         case SEND_DIAGNOSTIC: /* SPC - SELF-TEST Code */
973         case VERIFY: /* SBC - VRProtect */
974         case VERIFY_16: /* SBC - VRProtect */
975         case WRITE_VERIFY: /* SBC - VRProtect */
976         case WRITE_VERIFY_12: /* SBC - VRProtect */
977         case MAINTENANCE_IN: /* SPC - Parameter Data Format for SA RTPG */
978                 break;
979         default:
980                 cdb[1] &= 0x1f; /* clear logical unit number */
981                 break;
982         }
983 }
984
985 static int pscsi_parse_cdb(struct se_cmd *cmd)
986 {
987         unsigned char *cdb = cmd->t_task_cdb;
988         unsigned int dummy_size;
989         int ret;
990
991         if (cmd->se_cmd_flags & SCF_BIDI) {
992                 cmd->se_cmd_flags |= SCF_SCSI_CDB_EXCEPTION;
993                 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
994                 return -EINVAL;
995         }
996
997         pscsi_clear_cdb_lun(cdb);
998
999         /*
1000          * For REPORT LUNS we always need to emulate the response, for everything
1001          * else the default for pSCSI is to pass the command to the underlying
1002          * LLD / physical hardware.
1003          */
1004         switch (cdb[0]) {
1005         case REPORT_LUNS:
1006                 ret = spc_parse_cdb(cmd, &dummy_size);
1007                 if (ret)
1008                         return ret;
1009                 break;
1010         case READ_6:
1011         case READ_10:
1012         case READ_12:
1013         case READ_16:
1014         case WRITE_6:
1015         case WRITE_10:
1016         case WRITE_12:
1017         case WRITE_16:
1018         case WRITE_VERIFY:
1019                 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
1020                 /* FALLTHROUGH*/
1021         default:
1022                 cmd->execute_cmd = pscsi_execute_cmd;
1023                 break;
1024         }
1025
1026         return 0;
1027 }
1028
1029 static int pscsi_execute_cmd(struct se_cmd *cmd)
1030 {
1031         struct scatterlist *sgl = cmd->t_data_sg;
1032         u32 sgl_nents = cmd->t_data_nents;
1033         enum dma_data_direction data_direction = cmd->data_direction;
1034         struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
1035         struct pscsi_plugin_task *pt;
1036         struct request *req;
1037         struct bio *hbio;
1038         int ret;
1039
1040         /*
1041          * Dynamically alloc cdb space, since it may be larger than
1042          * TCM_MAX_COMMAND_SIZE
1043          */
1044         pt = kzalloc(sizeof(*pt) + scsi_command_size(cmd->t_task_cdb), GFP_KERNEL);
1045         if (!pt) {
1046                 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1047                 return -ENOMEM;
1048         }
1049         cmd->priv = pt;
1050
1051         memcpy(pt->pscsi_cdb, cmd->t_task_cdb,
1052                 scsi_command_size(cmd->t_task_cdb));
1053
1054         if (!sgl) {
1055                 req = blk_get_request(pdv->pdv_sd->request_queue,
1056                                 (data_direction == DMA_TO_DEVICE),
1057                                 GFP_KERNEL);
1058                 if (!req || IS_ERR(req)) {
1059                         pr_err("PSCSI: blk_get_request() failed: %ld\n",
1060                                         req ? IS_ERR(req) : -ENOMEM);
1061                         cmd->scsi_sense_reason =
1062                                 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1063                         goto fail;
1064                 }
1065         } else {
1066                 BUG_ON(!cmd->data_length);
1067
1068                 ret = pscsi_map_sg(cmd, sgl, sgl_nents, data_direction, &hbio);
1069                 if (ret < 0) {
1070                         cmd->scsi_sense_reason =
1071                                 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1072                         goto fail;
1073                 }
1074
1075                 req = blk_make_request(pdv->pdv_sd->request_queue, hbio,
1076                                        GFP_KERNEL);
1077                 if (IS_ERR(req)) {
1078                         pr_err("pSCSI: blk_make_request() failed\n");
1079                         goto fail_free_bio;
1080                 }
1081         }
1082
1083         req->cmd_type = REQ_TYPE_BLOCK_PC;
1084         req->end_io = pscsi_req_done;
1085         req->end_io_data = cmd;
1086         req->cmd_len = scsi_command_size(pt->pscsi_cdb);
1087         req->cmd = &pt->pscsi_cdb[0];
1088         req->sense = &pt->pscsi_sense[0];
1089         req->sense_len = 0;
1090         if (pdv->pdv_sd->type == TYPE_DISK)
1091                 req->timeout = PS_TIMEOUT_DISK;
1092         else
1093                 req->timeout = PS_TIMEOUT_OTHER;
1094         req->retries = PS_RETRY;
1095
1096         blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
1097                         (cmd->sam_task_attr == MSG_HEAD_TAG),
1098                         pscsi_req_done);
1099
1100         return 0;
1101
1102 fail_free_bio:
1103         while (hbio) {
1104                 struct bio *bio = hbio;
1105                 hbio = hbio->bi_next;
1106                 bio->bi_next = NULL;
1107                 bio_endio(bio, 0);      /* XXX: should be error */
1108         }
1109         cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1110 fail:
1111         kfree(pt);
1112         return -ENOMEM;
1113 }
1114
1115 /*      pscsi_get_device_rev():
1116  *
1117  *
1118  */
1119 static u32 pscsi_get_device_rev(struct se_device *dev)
1120 {
1121         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1122         struct scsi_device *sd = pdv->pdv_sd;
1123
1124         return (sd->scsi_level - 1) ? sd->scsi_level - 1 : 1;
1125 }
1126
1127 /*      pscsi_get_device_type():
1128  *
1129  *
1130  */
1131 static u32 pscsi_get_device_type(struct se_device *dev)
1132 {
1133         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1134         struct scsi_device *sd = pdv->pdv_sd;
1135
1136         return sd->type;
1137 }
1138
1139 static sector_t pscsi_get_blocks(struct se_device *dev)
1140 {
1141         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1142
1143         if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1144                 return pdv->pdv_bd->bd_part->nr_sects;
1145
1146         dump_stack();
1147         return 0;
1148 }
1149
1150 static void pscsi_req_done(struct request *req, int uptodate)
1151 {
1152         struct se_cmd *cmd = req->end_io_data;
1153         struct pscsi_plugin_task *pt = cmd->priv;
1154
1155         pt->pscsi_result = req->errors;
1156         pt->pscsi_resid = req->resid_len;
1157
1158         cmd->scsi_status = status_byte(pt->pscsi_result) << 1;
1159         if (cmd->scsi_status) {
1160                 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1161                         " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1162                         pt->pscsi_result);
1163         }
1164
1165         switch (host_byte(pt->pscsi_result)) {
1166         case DID_OK:
1167                 target_complete_cmd(cmd, cmd->scsi_status);
1168                 break;
1169         default:
1170                 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1171                         " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1172                         pt->pscsi_result);
1173                 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1174                 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
1175                 break;
1176         }
1177
1178         __blk_put_request(req->q, req);
1179         kfree(pt);
1180 }
1181
1182 static struct se_subsystem_api pscsi_template = {
1183         .name                   = "pscsi",
1184         .owner                  = THIS_MODULE,
1185         .transport_type         = TRANSPORT_PLUGIN_PHBA_PDEV,
1186         .attach_hba             = pscsi_attach_hba,
1187         .detach_hba             = pscsi_detach_hba,
1188         .pmode_enable_hba       = pscsi_pmode_enable_hba,
1189         .alloc_device           = pscsi_alloc_device,
1190         .configure_device       = pscsi_configure_device,
1191         .free_device            = pscsi_free_device,
1192         .transport_complete     = pscsi_transport_complete,
1193         .parse_cdb              = pscsi_parse_cdb,
1194         .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1195         .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1196         .get_device_rev         = pscsi_get_device_rev,
1197         .get_device_type        = pscsi_get_device_type,
1198         .get_blocks             = pscsi_get_blocks,
1199 };
1200
1201 static int __init pscsi_module_init(void)
1202 {
1203         return transport_subsystem_register(&pscsi_template);
1204 }
1205
1206 static void pscsi_module_exit(void)
1207 {
1208         transport_subsystem_release(&pscsi_template);
1209 }
1210
1211 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1212 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1213 MODULE_LICENSE("GPL");
1214
1215 module_init(pscsi_module_init);
1216 module_exit(pscsi_module_exit);