target: header reshuffle, part2
[linux/fpc-iii.git] / drivers / target / loopback / tcm_loop.c
blobd427a290e18489d29966a8fa6ec920c9e291b257
1 /*******************************************************************************
3 * This file contains the Linux/SCSI LLD virtual SCSI initiator driver
4 * for emulated SAS initiator ports
6 * © Copyright 2011 RisingTide Systems LLC.
8 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
10 * Author: Nicholas A. Bellinger <nab@risingtidesystems.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 ****************************************************************************/
23 #include <linux/module.h>
24 #include <linux/moduleparam.h>
25 #include <linux/init.h>
26 #include <linux/slab.h>
27 #include <linux/types.h>
28 #include <linux/configfs.h>
29 #include <scsi/scsi.h>
30 #include <scsi/scsi_tcq.h>
31 #include <scsi/scsi_host.h>
32 #include <scsi/scsi_device.h>
33 #include <scsi/scsi_cmnd.h>
35 #include <target/target_core_base.h>
36 #include <target/target_core_fabric.h>
37 #include <target/target_core_fabric_configfs.h>
38 #include <target/target_core_configfs.h>
40 #include "tcm_loop.h"
42 #define to_tcm_loop_hba(hba) container_of(hba, struct tcm_loop_hba, dev)
44 /* Local pointer to allocated TCM configfs fabric module */
45 static struct target_fabric_configfs *tcm_loop_fabric_configfs;
47 static struct kmem_cache *tcm_loop_cmd_cache;
49 static int tcm_loop_hba_no_cnt;
52 * Allocate a tcm_loop cmd descriptor from target_core_mod code
54 * Can be called from interrupt context in tcm_loop_queuecommand() below
56 static struct se_cmd *tcm_loop_allocate_core_cmd(
57 struct tcm_loop_hba *tl_hba,
58 struct se_portal_group *se_tpg,
59 struct scsi_cmnd *sc)
61 struct se_cmd *se_cmd;
62 struct se_session *se_sess;
63 struct tcm_loop_nexus *tl_nexus = tl_hba->tl_nexus;
64 struct tcm_loop_cmd *tl_cmd;
65 int sam_task_attr;
67 if (!tl_nexus) {
68 scmd_printk(KERN_ERR, sc, "TCM_Loop I_T Nexus"
69 " does not exist\n");
70 set_host_byte(sc, DID_ERROR);
71 return NULL;
73 se_sess = tl_nexus->se_sess;
75 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_ATOMIC);
76 if (!tl_cmd) {
77 pr_err("Unable to allocate struct tcm_loop_cmd\n");
78 set_host_byte(sc, DID_ERROR);
79 return NULL;
81 se_cmd = &tl_cmd->tl_se_cmd;
83 * Save the pointer to struct scsi_cmnd *sc
85 tl_cmd->sc = sc;
87 * Locate the SAM Task Attr from struct scsi_cmnd *
89 if (sc->device->tagged_supported) {
90 switch (sc->tag) {
91 case HEAD_OF_QUEUE_TAG:
92 sam_task_attr = MSG_HEAD_TAG;
93 break;
94 case ORDERED_QUEUE_TAG:
95 sam_task_attr = MSG_ORDERED_TAG;
96 break;
97 default:
98 sam_task_attr = MSG_SIMPLE_TAG;
99 break;
101 } else
102 sam_task_attr = MSG_SIMPLE_TAG;
105 * Initialize struct se_cmd descriptor from target_core_mod infrastructure
107 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess,
108 scsi_bufflen(sc), sc->sc_data_direction, sam_task_attr,
109 &tl_cmd->tl_sense_buf[0]);
111 if (scsi_bidi_cmnd(sc))
112 se_cmd->se_cmd_flags |= SCF_BIDI;
115 * Locate the struct se_lun pointer and attach it to struct se_cmd
117 if (transport_lookup_cmd_lun(se_cmd, tl_cmd->sc->device->lun) < 0) {
118 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
119 set_host_byte(sc, DID_NO_CONNECT);
120 return NULL;
123 return se_cmd;
127 * Called by struct target_core_fabric_ops->new_cmd_map()
129 * Always called in process context. A non zero return value
130 * here will signal to handle an exception based on the return code.
132 static int tcm_loop_new_cmd_map(struct se_cmd *se_cmd)
134 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
135 struct tcm_loop_cmd, tl_se_cmd);
136 struct scsi_cmnd *sc = tl_cmd->sc;
137 struct scatterlist *sgl_bidi = NULL;
138 u32 sgl_bidi_count = 0;
139 int ret;
141 * Allocate the necessary tasks to complete the received CDB+data
143 ret = transport_generic_allocate_tasks(se_cmd, sc->cmnd);
144 if (ret != 0)
145 return ret;
147 * For BIDI commands, pass in the extra READ buffer
148 * to transport_generic_map_mem_to_cmd() below..
150 if (se_cmd->se_cmd_flags & SCF_BIDI) {
151 struct scsi_data_buffer *sdb = scsi_in(sc);
153 sgl_bidi = sdb->table.sgl;
154 sgl_bidi_count = sdb->table.nents;
157 * Because some userspace code via scsi-generic do not memset their
158 * associated read buffers, go ahead and do that here for type
159 * SCF_SCSI_CONTROL_SG_IO_CDB. Also note that this is currently
160 * guaranteed to be a single SGL for SCF_SCSI_CONTROL_SG_IO_CDB
161 * by target core in transport_generic_allocate_tasks() ->
162 * transport_generic_cmd_sequencer().
164 if (se_cmd->se_cmd_flags & SCF_SCSI_CONTROL_SG_IO_CDB &&
165 se_cmd->data_direction == DMA_FROM_DEVICE) {
166 struct scatterlist *sg = scsi_sglist(sc);
167 unsigned char *buf = kmap(sg_page(sg)) + sg->offset;
169 if (buf != NULL) {
170 memset(buf, 0, sg->length);
171 kunmap(sg_page(sg));
175 /* Tell the core about our preallocated memory */
176 return transport_generic_map_mem_to_cmd(se_cmd, scsi_sglist(sc),
177 scsi_sg_count(sc), sgl_bidi, sgl_bidi_count);
181 * Called from struct target_core_fabric_ops->check_stop_free()
183 static int tcm_loop_check_stop_free(struct se_cmd *se_cmd)
186 * Do not release struct se_cmd's containing a valid TMR
187 * pointer. These will be released directly in tcm_loop_device_reset()
188 * with transport_generic_free_cmd().
190 if (se_cmd->se_tmr_req)
191 return 0;
193 * Release the struct se_cmd, which will make a callback to release
194 * struct tcm_loop_cmd * in tcm_loop_deallocate_core_cmd()
196 transport_generic_free_cmd(se_cmd, 0);
197 return 1;
200 static void tcm_loop_release_cmd(struct se_cmd *se_cmd)
202 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
203 struct tcm_loop_cmd, tl_se_cmd);
205 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
208 static int tcm_loop_proc_info(struct Scsi_Host *host, char *buffer,
209 char **start, off_t offset,
210 int length, int inout)
212 return sprintf(buffer, "tcm_loop_proc_info()\n");
215 static int tcm_loop_driver_probe(struct device *);
216 static int tcm_loop_driver_remove(struct device *);
218 static int pseudo_lld_bus_match(struct device *dev,
219 struct device_driver *dev_driver)
221 return 1;
224 static struct bus_type tcm_loop_lld_bus = {
225 .name = "tcm_loop_bus",
226 .match = pseudo_lld_bus_match,
227 .probe = tcm_loop_driver_probe,
228 .remove = tcm_loop_driver_remove,
231 static struct device_driver tcm_loop_driverfs = {
232 .name = "tcm_loop",
233 .bus = &tcm_loop_lld_bus,
236 * Used with root_device_register() in tcm_loop_alloc_core_bus() below
238 struct device *tcm_loop_primary;
241 * Copied from drivers/scsi/libfc/fc_fcp.c:fc_change_queue_depth() and
242 * drivers/scsi/libiscsi.c:iscsi_change_queue_depth()
244 static int tcm_loop_change_queue_depth(
245 struct scsi_device *sdev,
246 int depth,
247 int reason)
249 switch (reason) {
250 case SCSI_QDEPTH_DEFAULT:
251 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
252 break;
253 case SCSI_QDEPTH_QFULL:
254 scsi_track_queue_full(sdev, depth);
255 break;
256 case SCSI_QDEPTH_RAMP_UP:
257 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), depth);
258 break;
259 default:
260 return -EOPNOTSUPP;
262 return sdev->queue_depth;
266 * Main entry point from struct scsi_host_template for incoming SCSI CDB+Data
267 * from Linux/SCSI subsystem for SCSI low level device drivers (LLDs)
269 static int tcm_loop_queuecommand(
270 struct Scsi_Host *sh,
271 struct scsi_cmnd *sc)
273 struct se_cmd *se_cmd;
274 struct se_portal_group *se_tpg;
275 struct tcm_loop_hba *tl_hba;
276 struct tcm_loop_tpg *tl_tpg;
278 pr_debug("tcm_loop_queuecommand() %d:%d:%d:%d got CDB: 0x%02x"
279 " scsi_buf_len: %u\n", sc->device->host->host_no,
280 sc->device->id, sc->device->channel, sc->device->lun,
281 sc->cmnd[0], scsi_bufflen(sc));
283 * Locate the tcm_loop_hba_t pointer
285 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
286 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
288 * Ensure that this tl_tpg reference from the incoming sc->device->id
289 * has already been configured via tcm_loop_make_naa_tpg().
291 if (!tl_tpg->tl_hba) {
292 set_host_byte(sc, DID_NO_CONNECT);
293 sc->scsi_done(sc);
294 return 0;
296 se_tpg = &tl_tpg->tl_se_tpg;
298 * Determine the SAM Task Attribute and allocate tl_cmd and
299 * tl_cmd->tl_se_cmd from TCM infrastructure
301 se_cmd = tcm_loop_allocate_core_cmd(tl_hba, se_tpg, sc);
302 if (!se_cmd) {
303 sc->scsi_done(sc);
304 return 0;
307 * Queue up the newly allocated to be processed in TCM thread context.
309 transport_generic_handle_cdb_map(se_cmd);
310 return 0;
314 * Called from SCSI EH process context to issue a LUN_RESET TMR
315 * to struct scsi_device
317 static int tcm_loop_device_reset(struct scsi_cmnd *sc)
319 struct se_cmd *se_cmd = NULL;
320 struct se_portal_group *se_tpg;
321 struct se_session *se_sess;
322 struct tcm_loop_cmd *tl_cmd = NULL;
323 struct tcm_loop_hba *tl_hba;
324 struct tcm_loop_nexus *tl_nexus;
325 struct tcm_loop_tmr *tl_tmr = NULL;
326 struct tcm_loop_tpg *tl_tpg;
327 int ret = FAILED;
329 * Locate the tcm_loop_hba_t pointer
331 tl_hba = *(struct tcm_loop_hba **)shost_priv(sc->device->host);
333 * Locate the tl_nexus and se_sess pointers
335 tl_nexus = tl_hba->tl_nexus;
336 if (!tl_nexus) {
337 pr_err("Unable to perform device reset without"
338 " active I_T Nexus\n");
339 return FAILED;
341 se_sess = tl_nexus->se_sess;
343 * Locate the tl_tpg and se_tpg pointers from TargetID in sc->device->id
345 tl_tpg = &tl_hba->tl_hba_tpgs[sc->device->id];
346 se_tpg = &tl_tpg->tl_se_tpg;
348 tl_cmd = kmem_cache_zalloc(tcm_loop_cmd_cache, GFP_KERNEL);
349 if (!tl_cmd) {
350 pr_err("Unable to allocate memory for tl_cmd\n");
351 return FAILED;
354 tl_tmr = kzalloc(sizeof(struct tcm_loop_tmr), GFP_KERNEL);
355 if (!tl_tmr) {
356 pr_err("Unable to allocate memory for tl_tmr\n");
357 goto release;
359 init_waitqueue_head(&tl_tmr->tl_tmr_wait);
361 se_cmd = &tl_cmd->tl_se_cmd;
363 * Initialize struct se_cmd descriptor from target_core_mod infrastructure
365 transport_init_se_cmd(se_cmd, se_tpg->se_tpg_tfo, se_sess, 0,
366 DMA_NONE, MSG_SIMPLE_TAG,
367 &tl_cmd->tl_sense_buf[0]);
369 * Allocate the LUN_RESET TMR
371 se_cmd->se_tmr_req = core_tmr_alloc_req(se_cmd, tl_tmr,
372 TMR_LUN_RESET, GFP_KERNEL);
373 if (IS_ERR(se_cmd->se_tmr_req))
374 goto release;
376 * Locate the underlying TCM struct se_lun from sc->device->lun
378 if (transport_lookup_tmr_lun(se_cmd, sc->device->lun) < 0)
379 goto release;
381 * Queue the TMR to TCM Core and sleep waiting for tcm_loop_queue_tm_rsp()
382 * to wake us up.
384 transport_generic_handle_tmr(se_cmd);
385 wait_event(tl_tmr->tl_tmr_wait, atomic_read(&tl_tmr->tmr_complete));
387 * The TMR LUN_RESET has completed, check the response status and
388 * then release allocations.
390 ret = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
391 SUCCESS : FAILED;
392 release:
393 if (se_cmd)
394 transport_generic_free_cmd(se_cmd, 1);
395 else
396 kmem_cache_free(tcm_loop_cmd_cache, tl_cmd);
397 kfree(tl_tmr);
398 return ret;
401 static int tcm_loop_slave_alloc(struct scsi_device *sd)
403 set_bit(QUEUE_FLAG_BIDI, &sd->request_queue->queue_flags);
404 return 0;
407 static int tcm_loop_slave_configure(struct scsi_device *sd)
409 return 0;
412 static struct scsi_host_template tcm_loop_driver_template = {
413 .proc_info = tcm_loop_proc_info,
414 .proc_name = "tcm_loopback",
415 .name = "TCM_Loopback",
416 .queuecommand = tcm_loop_queuecommand,
417 .change_queue_depth = tcm_loop_change_queue_depth,
418 .eh_device_reset_handler = tcm_loop_device_reset,
419 .can_queue = TL_SCSI_CAN_QUEUE,
420 .this_id = -1,
421 .sg_tablesize = TL_SCSI_SG_TABLESIZE,
422 .cmd_per_lun = TL_SCSI_CMD_PER_LUN,
423 .max_sectors = TL_SCSI_MAX_SECTORS,
424 .use_clustering = DISABLE_CLUSTERING,
425 .slave_alloc = tcm_loop_slave_alloc,
426 .slave_configure = tcm_loop_slave_configure,
427 .module = THIS_MODULE,
430 static int tcm_loop_driver_probe(struct device *dev)
432 struct tcm_loop_hba *tl_hba;
433 struct Scsi_Host *sh;
434 int error;
436 tl_hba = to_tcm_loop_hba(dev);
438 sh = scsi_host_alloc(&tcm_loop_driver_template,
439 sizeof(struct tcm_loop_hba));
440 if (!sh) {
441 pr_err("Unable to allocate struct scsi_host\n");
442 return -ENODEV;
444 tl_hba->sh = sh;
447 * Assign the struct tcm_loop_hba pointer to struct Scsi_Host->hostdata
449 *((struct tcm_loop_hba **)sh->hostdata) = tl_hba;
451 * Setup single ID, Channel and LUN for now..
453 sh->max_id = 2;
454 sh->max_lun = 0;
455 sh->max_channel = 0;
456 sh->max_cmd_len = TL_SCSI_MAX_CMD_LEN;
458 error = scsi_add_host(sh, &tl_hba->dev);
459 if (error) {
460 pr_err("%s: scsi_add_host failed\n", __func__);
461 scsi_host_put(sh);
462 return -ENODEV;
464 return 0;
467 static int tcm_loop_driver_remove(struct device *dev)
469 struct tcm_loop_hba *tl_hba;
470 struct Scsi_Host *sh;
472 tl_hba = to_tcm_loop_hba(dev);
473 sh = tl_hba->sh;
475 scsi_remove_host(sh);
476 scsi_host_put(sh);
477 return 0;
480 static void tcm_loop_release_adapter(struct device *dev)
482 struct tcm_loop_hba *tl_hba = to_tcm_loop_hba(dev);
484 kfree(tl_hba);
488 * Called from tcm_loop_make_scsi_hba() in tcm_loop_configfs.c
490 static int tcm_loop_setup_hba_bus(struct tcm_loop_hba *tl_hba, int tcm_loop_host_id)
492 int ret;
494 tl_hba->dev.bus = &tcm_loop_lld_bus;
495 tl_hba->dev.parent = tcm_loop_primary;
496 tl_hba->dev.release = &tcm_loop_release_adapter;
497 dev_set_name(&tl_hba->dev, "tcm_loop_adapter_%d", tcm_loop_host_id);
499 ret = device_register(&tl_hba->dev);
500 if (ret) {
501 pr_err("device_register() failed for"
502 " tl_hba->dev: %d\n", ret);
503 return -ENODEV;
506 return 0;
510 * Called from tcm_loop_fabric_init() in tcl_loop_fabric.c to load the emulated
511 * tcm_loop SCSI bus.
513 static int tcm_loop_alloc_core_bus(void)
515 int ret;
517 tcm_loop_primary = root_device_register("tcm_loop_0");
518 if (IS_ERR(tcm_loop_primary)) {
519 pr_err("Unable to allocate tcm_loop_primary\n");
520 return PTR_ERR(tcm_loop_primary);
523 ret = bus_register(&tcm_loop_lld_bus);
524 if (ret) {
525 pr_err("bus_register() failed for tcm_loop_lld_bus\n");
526 goto dev_unreg;
529 ret = driver_register(&tcm_loop_driverfs);
530 if (ret) {
531 pr_err("driver_register() failed for"
532 "tcm_loop_driverfs\n");
533 goto bus_unreg;
536 pr_debug("Initialized TCM Loop Core Bus\n");
537 return ret;
539 bus_unreg:
540 bus_unregister(&tcm_loop_lld_bus);
541 dev_unreg:
542 root_device_unregister(tcm_loop_primary);
543 return ret;
546 static void tcm_loop_release_core_bus(void)
548 driver_unregister(&tcm_loop_driverfs);
549 bus_unregister(&tcm_loop_lld_bus);
550 root_device_unregister(tcm_loop_primary);
552 pr_debug("Releasing TCM Loop Core BUS\n");
555 static char *tcm_loop_get_fabric_name(void)
557 return "loopback";
560 static u8 tcm_loop_get_fabric_proto_ident(struct se_portal_group *se_tpg)
562 struct tcm_loop_tpg *tl_tpg =
563 (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
564 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
566 * tl_proto_id is set at tcm_loop_configfs.c:tcm_loop_make_scsi_hba()
567 * time based on the protocol dependent prefix of the passed configfs group.
569 * Based upon tl_proto_id, TCM_Loop emulates the requested fabric
570 * ProtocolID using target_core_fabric_lib.c symbols.
572 switch (tl_hba->tl_proto_id) {
573 case SCSI_PROTOCOL_SAS:
574 return sas_get_fabric_proto_ident(se_tpg);
575 case SCSI_PROTOCOL_FCP:
576 return fc_get_fabric_proto_ident(se_tpg);
577 case SCSI_PROTOCOL_ISCSI:
578 return iscsi_get_fabric_proto_ident(se_tpg);
579 default:
580 pr_err("Unknown tl_proto_id: 0x%02x, using"
581 " SAS emulation\n", tl_hba->tl_proto_id);
582 break;
585 return sas_get_fabric_proto_ident(se_tpg);
588 static char *tcm_loop_get_endpoint_wwn(struct se_portal_group *se_tpg)
590 struct tcm_loop_tpg *tl_tpg =
591 (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
593 * Return the passed NAA identifier for the SAS Target Port
595 return &tl_tpg->tl_hba->tl_wwn_address[0];
598 static u16 tcm_loop_get_tag(struct se_portal_group *se_tpg)
600 struct tcm_loop_tpg *tl_tpg =
601 (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
603 * This Tag is used when forming SCSI Name identifier in EVPD=1 0x83
604 * to represent the SCSI Target Port.
606 return tl_tpg->tl_tpgt;
609 static u32 tcm_loop_get_default_depth(struct se_portal_group *se_tpg)
611 return 1;
614 static u32 tcm_loop_get_pr_transport_id(
615 struct se_portal_group *se_tpg,
616 struct se_node_acl *se_nacl,
617 struct t10_pr_registration *pr_reg,
618 int *format_code,
619 unsigned char *buf)
621 struct tcm_loop_tpg *tl_tpg =
622 (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
623 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
625 switch (tl_hba->tl_proto_id) {
626 case SCSI_PROTOCOL_SAS:
627 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
628 format_code, buf);
629 case SCSI_PROTOCOL_FCP:
630 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
631 format_code, buf);
632 case SCSI_PROTOCOL_ISCSI:
633 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
634 format_code, buf);
635 default:
636 pr_err("Unknown tl_proto_id: 0x%02x, using"
637 " SAS emulation\n", tl_hba->tl_proto_id);
638 break;
641 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
642 format_code, buf);
645 static u32 tcm_loop_get_pr_transport_id_len(
646 struct se_portal_group *se_tpg,
647 struct se_node_acl *se_nacl,
648 struct t10_pr_registration *pr_reg,
649 int *format_code)
651 struct tcm_loop_tpg *tl_tpg =
652 (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
653 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
655 switch (tl_hba->tl_proto_id) {
656 case SCSI_PROTOCOL_SAS:
657 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
658 format_code);
659 case SCSI_PROTOCOL_FCP:
660 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
661 format_code);
662 case SCSI_PROTOCOL_ISCSI:
663 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
664 format_code);
665 default:
666 pr_err("Unknown tl_proto_id: 0x%02x, using"
667 " SAS emulation\n", tl_hba->tl_proto_id);
668 break;
671 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
672 format_code);
676 * Used for handling SCSI fabric dependent TransportIDs in SPC-3 and above
677 * Persistent Reservation SPEC_I_PT=1 and PROUT REGISTER_AND_MOVE operations.
679 static char *tcm_loop_parse_pr_out_transport_id(
680 struct se_portal_group *se_tpg,
681 const char *buf,
682 u32 *out_tid_len,
683 char **port_nexus_ptr)
685 struct tcm_loop_tpg *tl_tpg =
686 (struct tcm_loop_tpg *)se_tpg->se_tpg_fabric_ptr;
687 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
689 switch (tl_hba->tl_proto_id) {
690 case SCSI_PROTOCOL_SAS:
691 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
692 port_nexus_ptr);
693 case SCSI_PROTOCOL_FCP:
694 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
695 port_nexus_ptr);
696 case SCSI_PROTOCOL_ISCSI:
697 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
698 port_nexus_ptr);
699 default:
700 pr_err("Unknown tl_proto_id: 0x%02x, using"
701 " SAS emulation\n", tl_hba->tl_proto_id);
702 break;
705 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
706 port_nexus_ptr);
710 * Returning (1) here allows for target_core_mod struct se_node_acl to be generated
711 * based upon the incoming fabric dependent SCSI Initiator Port
713 static int tcm_loop_check_demo_mode(struct se_portal_group *se_tpg)
715 return 1;
718 static int tcm_loop_check_demo_mode_cache(struct se_portal_group *se_tpg)
720 return 0;
724 * Allow I_T Nexus full READ-WRITE access without explict Initiator Node ACLs for
725 * local virtual Linux/SCSI LLD passthrough into VM hypervisor guest
727 static int tcm_loop_check_demo_mode_write_protect(struct se_portal_group *se_tpg)
729 return 0;
733 * Because TCM_Loop does not use explict ACLs and MappedLUNs, this will
734 * never be called for TCM_Loop by target_core_fabric_configfs.c code.
735 * It has been added here as a nop for target_fabric_tf_ops_check()
737 static int tcm_loop_check_prod_mode_write_protect(struct se_portal_group *se_tpg)
739 return 0;
742 static struct se_node_acl *tcm_loop_tpg_alloc_fabric_acl(
743 struct se_portal_group *se_tpg)
745 struct tcm_loop_nacl *tl_nacl;
747 tl_nacl = kzalloc(sizeof(struct tcm_loop_nacl), GFP_KERNEL);
748 if (!tl_nacl) {
749 pr_err("Unable to allocate struct tcm_loop_nacl\n");
750 return NULL;
753 return &tl_nacl->se_node_acl;
756 static void tcm_loop_tpg_release_fabric_acl(
757 struct se_portal_group *se_tpg,
758 struct se_node_acl *se_nacl)
760 struct tcm_loop_nacl *tl_nacl = container_of(se_nacl,
761 struct tcm_loop_nacl, se_node_acl);
763 kfree(tl_nacl);
766 static u32 tcm_loop_get_inst_index(struct se_portal_group *se_tpg)
768 return 1;
771 static int tcm_loop_is_state_remove(struct se_cmd *se_cmd)
774 * Assume struct scsi_cmnd is not in remove state..
776 return 0;
779 static int tcm_loop_sess_logged_in(struct se_session *se_sess)
782 * Assume that TL Nexus is always active
784 return 1;
787 static u32 tcm_loop_sess_get_index(struct se_session *se_sess)
789 return 1;
792 static void tcm_loop_set_default_node_attributes(struct se_node_acl *se_acl)
794 return;
797 static u32 tcm_loop_get_task_tag(struct se_cmd *se_cmd)
799 return 1;
802 static int tcm_loop_get_cmd_state(struct se_cmd *se_cmd)
804 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
805 struct tcm_loop_cmd, tl_se_cmd);
807 return tl_cmd->sc_cmd_state;
810 static int tcm_loop_shutdown_session(struct se_session *se_sess)
812 return 0;
815 static void tcm_loop_close_session(struct se_session *se_sess)
817 return;
820 static void tcm_loop_stop_session(
821 struct se_session *se_sess,
822 int sess_sleep,
823 int conn_sleep)
825 return;
828 static void tcm_loop_fall_back_to_erl0(struct se_session *se_sess)
830 return;
833 static int tcm_loop_write_pending(struct se_cmd *se_cmd)
836 * Since Linux/SCSI has already sent down a struct scsi_cmnd
837 * sc->sc_data_direction of DMA_TO_DEVICE with struct scatterlist array
838 * memory, and memory has already been mapped to struct se_cmd->t_mem_list
839 * format with transport_generic_map_mem_to_cmd().
841 * We now tell TCM to add this WRITE CDB directly into the TCM storage
842 * object execution queue.
844 transport_generic_process_write(se_cmd);
845 return 0;
848 static int tcm_loop_write_pending_status(struct se_cmd *se_cmd)
850 return 0;
853 static int tcm_loop_queue_data_in(struct se_cmd *se_cmd)
855 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
856 struct tcm_loop_cmd, tl_se_cmd);
857 struct scsi_cmnd *sc = tl_cmd->sc;
859 pr_debug("tcm_loop_queue_data_in() called for scsi_cmnd: %p"
860 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
862 sc->result = SAM_STAT_GOOD;
863 set_host_byte(sc, DID_OK);
864 sc->scsi_done(sc);
865 return 0;
868 static int tcm_loop_queue_status(struct se_cmd *se_cmd)
870 struct tcm_loop_cmd *tl_cmd = container_of(se_cmd,
871 struct tcm_loop_cmd, tl_se_cmd);
872 struct scsi_cmnd *sc = tl_cmd->sc;
874 pr_debug("tcm_loop_queue_status() called for scsi_cmnd: %p"
875 " cdb: 0x%02x\n", sc, sc->cmnd[0]);
877 if (se_cmd->sense_buffer &&
878 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
879 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE))) {
881 memcpy(sc->sense_buffer, se_cmd->sense_buffer,
882 SCSI_SENSE_BUFFERSIZE);
883 sc->result = SAM_STAT_CHECK_CONDITION;
884 set_driver_byte(sc, DRIVER_SENSE);
885 } else
886 sc->result = se_cmd->scsi_status;
888 set_host_byte(sc, DID_OK);
889 sc->scsi_done(sc);
890 return 0;
893 static int tcm_loop_queue_tm_rsp(struct se_cmd *se_cmd)
895 struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
896 struct tcm_loop_tmr *tl_tmr = se_tmr->fabric_tmr_ptr;
898 * The SCSI EH thread will be sleeping on se_tmr->tl_tmr_wait, go ahead
899 * and wake up the wait_queue_head_t in tcm_loop_device_reset()
901 atomic_set(&tl_tmr->tmr_complete, 1);
902 wake_up(&tl_tmr->tl_tmr_wait);
903 return 0;
906 static u16 tcm_loop_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_length)
908 return 0;
911 static u16 tcm_loop_get_fabric_sense_len(void)
913 return 0;
916 static char *tcm_loop_dump_proto_id(struct tcm_loop_hba *tl_hba)
918 switch (tl_hba->tl_proto_id) {
919 case SCSI_PROTOCOL_SAS:
920 return "SAS";
921 case SCSI_PROTOCOL_FCP:
922 return "FCP";
923 case SCSI_PROTOCOL_ISCSI:
924 return "iSCSI";
925 default:
926 break;
929 return "Unknown";
932 /* Start items for tcm_loop_port_cit */
934 static int tcm_loop_port_link(
935 struct se_portal_group *se_tpg,
936 struct se_lun *lun)
938 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
939 struct tcm_loop_tpg, tl_se_tpg);
940 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
942 atomic_inc(&tl_tpg->tl_tpg_port_count);
943 smp_mb__after_atomic_inc();
945 * Add Linux/SCSI struct scsi_device by HCTL
947 scsi_add_device(tl_hba->sh, 0, tl_tpg->tl_tpgt, lun->unpacked_lun);
949 pr_debug("TCM_Loop_ConfigFS: Port Link Successful\n");
950 return 0;
953 static void tcm_loop_port_unlink(
954 struct se_portal_group *se_tpg,
955 struct se_lun *se_lun)
957 struct scsi_device *sd;
958 struct tcm_loop_hba *tl_hba;
959 struct tcm_loop_tpg *tl_tpg;
961 tl_tpg = container_of(se_tpg, struct tcm_loop_tpg, tl_se_tpg);
962 tl_hba = tl_tpg->tl_hba;
964 sd = scsi_device_lookup(tl_hba->sh, 0, tl_tpg->tl_tpgt,
965 se_lun->unpacked_lun);
966 if (!sd) {
967 pr_err("Unable to locate struct scsi_device for %d:%d:"
968 "%d\n", 0, tl_tpg->tl_tpgt, se_lun->unpacked_lun);
969 return;
972 * Remove Linux/SCSI struct scsi_device by HCTL
974 scsi_remove_device(sd);
975 scsi_device_put(sd);
977 atomic_dec(&tl_tpg->tl_tpg_port_count);
978 smp_mb__after_atomic_dec();
980 pr_debug("TCM_Loop_ConfigFS: Port Unlink Successful\n");
983 /* End items for tcm_loop_port_cit */
985 /* Start items for tcm_loop_nexus_cit */
987 static int tcm_loop_make_nexus(
988 struct tcm_loop_tpg *tl_tpg,
989 const char *name)
991 struct se_portal_group *se_tpg;
992 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
993 struct tcm_loop_nexus *tl_nexus;
994 int ret = -ENOMEM;
996 if (tl_tpg->tl_hba->tl_nexus) {
997 pr_debug("tl_tpg->tl_hba->tl_nexus already exists\n");
998 return -EEXIST;
1000 se_tpg = &tl_tpg->tl_se_tpg;
1002 tl_nexus = kzalloc(sizeof(struct tcm_loop_nexus), GFP_KERNEL);
1003 if (!tl_nexus) {
1004 pr_err("Unable to allocate struct tcm_loop_nexus\n");
1005 return -ENOMEM;
1008 * Initialize the struct se_session pointer
1010 tl_nexus->se_sess = transport_init_session();
1011 if (IS_ERR(tl_nexus->se_sess)) {
1012 ret = PTR_ERR(tl_nexus->se_sess);
1013 goto out;
1016 * Since we are running in 'demo mode' this call with generate a
1017 * struct se_node_acl for the tcm_loop struct se_portal_group with the SCSI
1018 * Initiator port name of the passed configfs group 'name'.
1020 tl_nexus->se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1021 se_tpg, (unsigned char *)name);
1022 if (!tl_nexus->se_sess->se_node_acl) {
1023 transport_free_session(tl_nexus->se_sess);
1024 goto out;
1027 * Now, register the SAS I_T Nexus as active with the call to
1028 * transport_register_session()
1030 __transport_register_session(se_tpg, tl_nexus->se_sess->se_node_acl,
1031 tl_nexus->se_sess, tl_nexus);
1032 tl_tpg->tl_hba->tl_nexus = tl_nexus;
1033 pr_debug("TCM_Loop_ConfigFS: Established I_T Nexus to emulated"
1034 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
1035 name);
1036 return 0;
1038 out:
1039 kfree(tl_nexus);
1040 return ret;
1043 static int tcm_loop_drop_nexus(
1044 struct tcm_loop_tpg *tpg)
1046 struct se_session *se_sess;
1047 struct tcm_loop_nexus *tl_nexus;
1048 struct tcm_loop_hba *tl_hba = tpg->tl_hba;
1050 tl_nexus = tpg->tl_hba->tl_nexus;
1051 if (!tl_nexus)
1052 return -ENODEV;
1054 se_sess = tl_nexus->se_sess;
1055 if (!se_sess)
1056 return -ENODEV;
1058 if (atomic_read(&tpg->tl_tpg_port_count)) {
1059 pr_err("Unable to remove TCM_Loop I_T Nexus with"
1060 " active TPG port count: %d\n",
1061 atomic_read(&tpg->tl_tpg_port_count));
1062 return -EPERM;
1065 pr_debug("TCM_Loop_ConfigFS: Removing I_T Nexus to emulated"
1066 " %s Initiator Port: %s\n", tcm_loop_dump_proto_id(tl_hba),
1067 tl_nexus->se_sess->se_node_acl->initiatorname);
1069 * Release the SCSI I_T Nexus to the emulated SAS Target Port
1071 transport_deregister_session(tl_nexus->se_sess);
1072 tpg->tl_hba->tl_nexus = NULL;
1073 kfree(tl_nexus);
1074 return 0;
1077 /* End items for tcm_loop_nexus_cit */
1079 static ssize_t tcm_loop_tpg_show_nexus(
1080 struct se_portal_group *se_tpg,
1081 char *page)
1083 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1084 struct tcm_loop_tpg, tl_se_tpg);
1085 struct tcm_loop_nexus *tl_nexus;
1086 ssize_t ret;
1088 tl_nexus = tl_tpg->tl_hba->tl_nexus;
1089 if (!tl_nexus)
1090 return -ENODEV;
1092 ret = snprintf(page, PAGE_SIZE, "%s\n",
1093 tl_nexus->se_sess->se_node_acl->initiatorname);
1095 return ret;
1098 static ssize_t tcm_loop_tpg_store_nexus(
1099 struct se_portal_group *se_tpg,
1100 const char *page,
1101 size_t count)
1103 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1104 struct tcm_loop_tpg, tl_se_tpg);
1105 struct tcm_loop_hba *tl_hba = tl_tpg->tl_hba;
1106 unsigned char i_port[TL_WWN_ADDR_LEN], *ptr, *port_ptr;
1107 int ret;
1109 * Shutdown the active I_T nexus if 'NULL' is passed..
1111 if (!strncmp(page, "NULL", 4)) {
1112 ret = tcm_loop_drop_nexus(tl_tpg);
1113 return (!ret) ? count : ret;
1116 * Otherwise make sure the passed virtual Initiator port WWN matches
1117 * the fabric protocol_id set in tcm_loop_make_scsi_hba(), and call
1118 * tcm_loop_make_nexus()
1120 if (strlen(page) >= TL_WWN_ADDR_LEN) {
1121 pr_err("Emulated NAA Sas Address: %s, exceeds"
1122 " max: %d\n", page, TL_WWN_ADDR_LEN);
1123 return -EINVAL;
1125 snprintf(&i_port[0], TL_WWN_ADDR_LEN, "%s", page);
1127 ptr = strstr(i_port, "naa.");
1128 if (ptr) {
1129 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_SAS) {
1130 pr_err("Passed SAS Initiator Port %s does not"
1131 " match target port protoid: %s\n", i_port,
1132 tcm_loop_dump_proto_id(tl_hba));
1133 return -EINVAL;
1135 port_ptr = &i_port[0];
1136 goto check_newline;
1138 ptr = strstr(i_port, "fc.");
1139 if (ptr) {
1140 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_FCP) {
1141 pr_err("Passed FCP Initiator Port %s does not"
1142 " match target port protoid: %s\n", i_port,
1143 tcm_loop_dump_proto_id(tl_hba));
1144 return -EINVAL;
1146 port_ptr = &i_port[3]; /* Skip over "fc." */
1147 goto check_newline;
1149 ptr = strstr(i_port, "iqn.");
1150 if (ptr) {
1151 if (tl_hba->tl_proto_id != SCSI_PROTOCOL_ISCSI) {
1152 pr_err("Passed iSCSI Initiator Port %s does not"
1153 " match target port protoid: %s\n", i_port,
1154 tcm_loop_dump_proto_id(tl_hba));
1155 return -EINVAL;
1157 port_ptr = &i_port[0];
1158 goto check_newline;
1160 pr_err("Unable to locate prefix for emulated Initiator Port:"
1161 " %s\n", i_port);
1162 return -EINVAL;
1164 * Clear any trailing newline for the NAA WWN
1166 check_newline:
1167 if (i_port[strlen(i_port)-1] == '\n')
1168 i_port[strlen(i_port)-1] = '\0';
1170 ret = tcm_loop_make_nexus(tl_tpg, port_ptr);
1171 if (ret < 0)
1172 return ret;
1174 return count;
1177 TF_TPG_BASE_ATTR(tcm_loop, nexus, S_IRUGO | S_IWUSR);
1179 static struct configfs_attribute *tcm_loop_tpg_attrs[] = {
1180 &tcm_loop_tpg_nexus.attr,
1181 NULL,
1184 /* Start items for tcm_loop_naa_cit */
1186 struct se_portal_group *tcm_loop_make_naa_tpg(
1187 struct se_wwn *wwn,
1188 struct config_group *group,
1189 const char *name)
1191 struct tcm_loop_hba *tl_hba = container_of(wwn,
1192 struct tcm_loop_hba, tl_hba_wwn);
1193 struct tcm_loop_tpg *tl_tpg;
1194 char *tpgt_str, *end_ptr;
1195 int ret;
1196 unsigned short int tpgt;
1198 tpgt_str = strstr(name, "tpgt_");
1199 if (!tpgt_str) {
1200 pr_err("Unable to locate \"tpgt_#\" directory"
1201 " group\n");
1202 return ERR_PTR(-EINVAL);
1204 tpgt_str += 5; /* Skip ahead of "tpgt_" */
1205 tpgt = (unsigned short int) simple_strtoul(tpgt_str, &end_ptr, 0);
1207 if (tpgt >= TL_TPGS_PER_HBA) {
1208 pr_err("Passed tpgt: %hu exceeds TL_TPGS_PER_HBA:"
1209 " %u\n", tpgt, TL_TPGS_PER_HBA);
1210 return ERR_PTR(-EINVAL);
1212 tl_tpg = &tl_hba->tl_hba_tpgs[tpgt];
1213 tl_tpg->tl_hba = tl_hba;
1214 tl_tpg->tl_tpgt = tpgt;
1216 * Register the tl_tpg as a emulated SAS TCM Target Endpoint
1218 ret = core_tpg_register(&tcm_loop_fabric_configfs->tf_ops,
1219 wwn, &tl_tpg->tl_se_tpg, tl_tpg,
1220 TRANSPORT_TPG_TYPE_NORMAL);
1221 if (ret < 0)
1222 return ERR_PTR(-ENOMEM);
1224 pr_debug("TCM_Loop_ConfigFS: Allocated Emulated %s"
1225 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1226 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1228 return &tl_tpg->tl_se_tpg;
1231 void tcm_loop_drop_naa_tpg(
1232 struct se_portal_group *se_tpg)
1234 struct se_wwn *wwn = se_tpg->se_tpg_wwn;
1235 struct tcm_loop_tpg *tl_tpg = container_of(se_tpg,
1236 struct tcm_loop_tpg, tl_se_tpg);
1237 struct tcm_loop_hba *tl_hba;
1238 unsigned short tpgt;
1240 tl_hba = tl_tpg->tl_hba;
1241 tpgt = tl_tpg->tl_tpgt;
1243 * Release the I_T Nexus for the Virtual SAS link if present
1245 tcm_loop_drop_nexus(tl_tpg);
1247 * Deregister the tl_tpg as a emulated SAS TCM Target Endpoint
1249 core_tpg_deregister(se_tpg);
1251 tl_tpg->tl_hba = NULL;
1252 tl_tpg->tl_tpgt = 0;
1254 pr_debug("TCM_Loop_ConfigFS: Deallocated Emulated %s"
1255 " Target Port %s,t,0x%04x\n", tcm_loop_dump_proto_id(tl_hba),
1256 config_item_name(&wwn->wwn_group.cg_item), tpgt);
1259 /* End items for tcm_loop_naa_cit */
1261 /* Start items for tcm_loop_cit */
1263 struct se_wwn *tcm_loop_make_scsi_hba(
1264 struct target_fabric_configfs *tf,
1265 struct config_group *group,
1266 const char *name)
1268 struct tcm_loop_hba *tl_hba;
1269 struct Scsi_Host *sh;
1270 char *ptr;
1271 int ret, off = 0;
1273 tl_hba = kzalloc(sizeof(struct tcm_loop_hba), GFP_KERNEL);
1274 if (!tl_hba) {
1275 pr_err("Unable to allocate struct tcm_loop_hba\n");
1276 return ERR_PTR(-ENOMEM);
1279 * Determine the emulated Protocol Identifier and Target Port Name
1280 * based on the incoming configfs directory name.
1282 ptr = strstr(name, "naa.");
1283 if (ptr) {
1284 tl_hba->tl_proto_id = SCSI_PROTOCOL_SAS;
1285 goto check_len;
1287 ptr = strstr(name, "fc.");
1288 if (ptr) {
1289 tl_hba->tl_proto_id = SCSI_PROTOCOL_FCP;
1290 off = 3; /* Skip over "fc." */
1291 goto check_len;
1293 ptr = strstr(name, "iqn.");
1294 if (!ptr) {
1295 pr_err("Unable to locate prefix for emulated Target "
1296 "Port: %s\n", name);
1297 ret = -EINVAL;
1298 goto out;
1300 tl_hba->tl_proto_id = SCSI_PROTOCOL_ISCSI;
1302 check_len:
1303 if (strlen(name) >= TL_WWN_ADDR_LEN) {
1304 pr_err("Emulated NAA %s Address: %s, exceeds"
1305 " max: %d\n", name, tcm_loop_dump_proto_id(tl_hba),
1306 TL_WWN_ADDR_LEN);
1307 ret = -EINVAL;
1308 goto out;
1310 snprintf(&tl_hba->tl_wwn_address[0], TL_WWN_ADDR_LEN, "%s", &name[off]);
1313 * Call device_register(tl_hba->dev) to register the emulated
1314 * Linux/SCSI LLD of type struct Scsi_Host at tl_hba->sh after
1315 * device_register() callbacks in tcm_loop_driver_probe()
1317 ret = tcm_loop_setup_hba_bus(tl_hba, tcm_loop_hba_no_cnt);
1318 if (ret)
1319 goto out;
1321 sh = tl_hba->sh;
1322 tcm_loop_hba_no_cnt++;
1323 pr_debug("TCM_Loop_ConfigFS: Allocated emulated Target"
1324 " %s Address: %s at Linux/SCSI Host ID: %d\n",
1325 tcm_loop_dump_proto_id(tl_hba), name, sh->host_no);
1327 return &tl_hba->tl_hba_wwn;
1328 out:
1329 kfree(tl_hba);
1330 return ERR_PTR(ret);
1333 void tcm_loop_drop_scsi_hba(
1334 struct se_wwn *wwn)
1336 struct tcm_loop_hba *tl_hba = container_of(wwn,
1337 struct tcm_loop_hba, tl_hba_wwn);
1339 pr_debug("TCM_Loop_ConfigFS: Deallocating emulated Target"
1340 " SAS Address: %s at Linux/SCSI Host ID: %d\n",
1341 tl_hba->tl_wwn_address, tl_hba->sh->host_no);
1343 * Call device_unregister() on the original tl_hba->dev.
1344 * tcm_loop_fabric_scsi.c:tcm_loop_release_adapter() will
1345 * release *tl_hba;
1347 device_unregister(&tl_hba->dev);
1350 /* Start items for tcm_loop_cit */
1351 static ssize_t tcm_loop_wwn_show_attr_version(
1352 struct target_fabric_configfs *tf,
1353 char *page)
1355 return sprintf(page, "TCM Loopback Fabric module %s\n", TCM_LOOP_VERSION);
1358 TF_WWN_ATTR_RO(tcm_loop, version);
1360 static struct configfs_attribute *tcm_loop_wwn_attrs[] = {
1361 &tcm_loop_wwn_version.attr,
1362 NULL,
1365 /* End items for tcm_loop_cit */
1367 static int tcm_loop_register_configfs(void)
1369 struct target_fabric_configfs *fabric;
1370 struct config_group *tf_cg;
1371 int ret;
1373 * Set the TCM Loop HBA counter to zero
1375 tcm_loop_hba_no_cnt = 0;
1377 * Register the top level struct config_item_type with TCM core
1379 fabric = target_fabric_configfs_init(THIS_MODULE, "loopback");
1380 if (IS_ERR(fabric)) {
1381 pr_err("tcm_loop_register_configfs() failed!\n");
1382 return PTR_ERR(fabric);
1385 * Setup the fabric API of function pointers used by target_core_mod
1387 fabric->tf_ops.get_fabric_name = &tcm_loop_get_fabric_name;
1388 fabric->tf_ops.get_fabric_proto_ident = &tcm_loop_get_fabric_proto_ident;
1389 fabric->tf_ops.tpg_get_wwn = &tcm_loop_get_endpoint_wwn;
1390 fabric->tf_ops.tpg_get_tag = &tcm_loop_get_tag;
1391 fabric->tf_ops.tpg_get_default_depth = &tcm_loop_get_default_depth;
1392 fabric->tf_ops.tpg_get_pr_transport_id = &tcm_loop_get_pr_transport_id;
1393 fabric->tf_ops.tpg_get_pr_transport_id_len =
1394 &tcm_loop_get_pr_transport_id_len;
1395 fabric->tf_ops.tpg_parse_pr_out_transport_id =
1396 &tcm_loop_parse_pr_out_transport_id;
1397 fabric->tf_ops.tpg_check_demo_mode = &tcm_loop_check_demo_mode;
1398 fabric->tf_ops.tpg_check_demo_mode_cache =
1399 &tcm_loop_check_demo_mode_cache;
1400 fabric->tf_ops.tpg_check_demo_mode_write_protect =
1401 &tcm_loop_check_demo_mode_write_protect;
1402 fabric->tf_ops.tpg_check_prod_mode_write_protect =
1403 &tcm_loop_check_prod_mode_write_protect;
1405 * The TCM loopback fabric module runs in demo-mode to a local
1406 * virtual SCSI device, so fabric dependent initator ACLs are
1407 * not required.
1409 fabric->tf_ops.tpg_alloc_fabric_acl = &tcm_loop_tpg_alloc_fabric_acl;
1410 fabric->tf_ops.tpg_release_fabric_acl =
1411 &tcm_loop_tpg_release_fabric_acl;
1412 fabric->tf_ops.tpg_get_inst_index = &tcm_loop_get_inst_index;
1414 * Used for setting up remaining TCM resources in process context
1416 fabric->tf_ops.new_cmd_map = &tcm_loop_new_cmd_map;
1417 fabric->tf_ops.check_stop_free = &tcm_loop_check_stop_free;
1418 fabric->tf_ops.release_cmd = &tcm_loop_release_cmd;
1419 fabric->tf_ops.shutdown_session = &tcm_loop_shutdown_session;
1420 fabric->tf_ops.close_session = &tcm_loop_close_session;
1421 fabric->tf_ops.stop_session = &tcm_loop_stop_session;
1422 fabric->tf_ops.fall_back_to_erl0 = &tcm_loop_fall_back_to_erl0;
1423 fabric->tf_ops.sess_logged_in = &tcm_loop_sess_logged_in;
1424 fabric->tf_ops.sess_get_index = &tcm_loop_sess_get_index;
1425 fabric->tf_ops.sess_get_initiator_sid = NULL;
1426 fabric->tf_ops.write_pending = &tcm_loop_write_pending;
1427 fabric->tf_ops.write_pending_status = &tcm_loop_write_pending_status;
1429 * Not used for TCM loopback
1431 fabric->tf_ops.set_default_node_attributes =
1432 &tcm_loop_set_default_node_attributes;
1433 fabric->tf_ops.get_task_tag = &tcm_loop_get_task_tag;
1434 fabric->tf_ops.get_cmd_state = &tcm_loop_get_cmd_state;
1435 fabric->tf_ops.queue_data_in = &tcm_loop_queue_data_in;
1436 fabric->tf_ops.queue_status = &tcm_loop_queue_status;
1437 fabric->tf_ops.queue_tm_rsp = &tcm_loop_queue_tm_rsp;
1438 fabric->tf_ops.set_fabric_sense_len = &tcm_loop_set_fabric_sense_len;
1439 fabric->tf_ops.get_fabric_sense_len = &tcm_loop_get_fabric_sense_len;
1440 fabric->tf_ops.is_state_remove = &tcm_loop_is_state_remove;
1442 tf_cg = &fabric->tf_group;
1444 * Setup function pointers for generic logic in target_core_fabric_configfs.c
1446 fabric->tf_ops.fabric_make_wwn = &tcm_loop_make_scsi_hba;
1447 fabric->tf_ops.fabric_drop_wwn = &tcm_loop_drop_scsi_hba;
1448 fabric->tf_ops.fabric_make_tpg = &tcm_loop_make_naa_tpg;
1449 fabric->tf_ops.fabric_drop_tpg = &tcm_loop_drop_naa_tpg;
1451 * fabric_post_link() and fabric_pre_unlink() are used for
1452 * registration and release of TCM Loop Virtual SCSI LUNs.
1454 fabric->tf_ops.fabric_post_link = &tcm_loop_port_link;
1455 fabric->tf_ops.fabric_pre_unlink = &tcm_loop_port_unlink;
1456 fabric->tf_ops.fabric_make_np = NULL;
1457 fabric->tf_ops.fabric_drop_np = NULL;
1459 * Setup default attribute lists for various fabric->tf_cit_tmpl
1461 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = tcm_loop_wwn_attrs;
1462 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = tcm_loop_tpg_attrs;
1463 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
1464 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
1465 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
1467 * Once fabric->tf_ops has been setup, now register the fabric for
1468 * use within TCM
1470 ret = target_fabric_configfs_register(fabric);
1471 if (ret < 0) {
1472 pr_err("target_fabric_configfs_register() for"
1473 " TCM_Loop failed!\n");
1474 target_fabric_configfs_free(fabric);
1475 return -1;
1478 * Setup our local pointer to *fabric.
1480 tcm_loop_fabric_configfs = fabric;
1481 pr_debug("TCM_LOOP[0] - Set fabric ->"
1482 " tcm_loop_fabric_configfs\n");
1483 return 0;
1486 static void tcm_loop_deregister_configfs(void)
1488 if (!tcm_loop_fabric_configfs)
1489 return;
1491 target_fabric_configfs_deregister(tcm_loop_fabric_configfs);
1492 tcm_loop_fabric_configfs = NULL;
1493 pr_debug("TCM_LOOP[0] - Cleared"
1494 " tcm_loop_fabric_configfs\n");
1497 static int __init tcm_loop_fabric_init(void)
1499 int ret;
1501 tcm_loop_cmd_cache = kmem_cache_create("tcm_loop_cmd_cache",
1502 sizeof(struct tcm_loop_cmd),
1503 __alignof__(struct tcm_loop_cmd),
1504 0, NULL);
1505 if (!tcm_loop_cmd_cache) {
1506 pr_debug("kmem_cache_create() for"
1507 " tcm_loop_cmd_cache failed\n");
1508 return -ENOMEM;
1511 ret = tcm_loop_alloc_core_bus();
1512 if (ret)
1513 return ret;
1515 ret = tcm_loop_register_configfs();
1516 if (ret) {
1517 tcm_loop_release_core_bus();
1518 return ret;
1521 return 0;
1524 static void __exit tcm_loop_fabric_exit(void)
1526 tcm_loop_deregister_configfs();
1527 tcm_loop_release_core_bus();
1528 kmem_cache_destroy(tcm_loop_cmd_cache);
1531 MODULE_DESCRIPTION("TCM loopback virtual Linux/SCSI fabric module");
1532 MODULE_AUTHOR("Nicholas A. Bellinger <nab@risingtidesystems.com>");
1533 MODULE_LICENSE("GPL");
1534 module_init(tcm_loop_fabric_init);
1535 module_exit(tcm_loop_fabric_exit);