drivers/usb/gadget/tcm_usb_gadget.c

   1 /* Target based USB-Gadget
   2  *
   3  * UAS protocol handling, target callbacks, configfs handling,
   4  * BBB (USB Mass Storage Class Bulk-Only (BBB) and Transport protocol handling.
   5  *
   6  * Author: Sebastian Andrzej Siewior <bigeasy at linutronix dot de>
   7  * License: GPLv2 as published by FSF.
   8  */
   9 #include <linux/kernel.h>
  10 #include <linux/module.h>
  11 #include <linux/types.h>
  12 #include <linux/string.h>
  13 #include <linux/configfs.h>
  14 #include <linux/ctype.h>
  15 #include <linux/usb/ch9.h>
  16 #include <linux/usb/composite.h>
  17 #include <linux/usb/gadget.h>
  18 #include <linux/usb/storage.h>
  19 #include <scsi/scsi.h>
  20 #include <scsi/scsi_tcq.h>
  21 #include <target/target_core_base.h>
  22 #include <target/target_core_fabric.h>
  23 #include <target/target_core_fabric_configfs.h>
  24 #include <target/target_core_configfs.h>
  25 #include <target/configfs_macros.h>
  26 #include <asm/unaligned.h>
  27
  28 #include "usbstring.c"
  29 #include "epautoconf.c"
  30 #include "config.c"
  31 #include "composite.c"
  32
  33 #include "tcm_usb_gadget.h"
  34
  35 static struct target_fabric_configfs *usbg_fabric_configfs;
  36
  37 static inline struct f_uas *to_f_uas(struct usb_function *f)
  38 {
  39         return container_of(f, struct f_uas, function);
  40 }
  41
  42 static void usbg_cmd_release(struct kref *);
  43
  44 static inline void usbg_cleanup_cmd(struct usbg_cmd *cmd)
  45 {
  46         kref_put(&cmd->ref, usbg_cmd_release);
  47 }
  48
  49 /* Start bot.c code */
  50
  51 static int bot_enqueue_cmd_cbw(struct f_uas *fu)
  52 {
  53         int ret;
  54
  55         if (fu->flags & USBG_BOT_CMD_PEND)
  56                 return 0;
  57
  58         ret = usb_ep_queue(fu->ep_out, fu->cmd.req, GFP_ATOMIC);
  59         if (!ret)
  60                 fu->flags |= USBG_BOT_CMD_PEND;
  61         return ret;
  62 }
  63
  64 static void bot_status_complete(struct usb_ep *ep, struct usb_request *req)
  65 {
  66         struct usbg_cmd *cmd = req->context;
  67         struct f_uas *fu = cmd->fu;
  68
  69         usbg_cleanup_cmd(cmd);
  70         if (req->status < 0) {
  71                 pr_err("ERR %s(%d)\n", __func__, __LINE__);
  72                 return;
  73         }
  74
  75         /* CSW completed, wait for next CBW */
  76         bot_enqueue_cmd_cbw(fu);
  77 }
  78
  79 static void bot_enqueue_sense_code(struct f_uas *fu, struct usbg_cmd *cmd)
  80 {
  81         struct bulk_cs_wrap *csw = &fu->bot_status.csw;
  82         int ret;
  83         u8 *sense;
  84         unsigned int csw_stat;
  85
  86         csw_stat = cmd->csw_code;
  87
  88         /*
  89          * We can't send SENSE as a response. So we take ASC & ASCQ from our
  90          * sense buffer and queue it and hope the host sends a REQUEST_SENSE
  91          * command where it learns why we failed.
  92          */
  93         sense = cmd->sense_iu.sense;
  94
  95         csw->Tag = cmd->bot_tag;
  96         csw->Status = csw_stat;
  97         fu->bot_status.req->context = cmd;
  98         ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_ATOMIC);
  99         if (ret)
 100                 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
 101 }
 102
 103 static void bot_err_compl(struct usb_ep *ep, struct usb_request *req)
 104 {
 105         struct usbg_cmd *cmd = req->context;
 106         struct f_uas *fu = cmd->fu;
 107
 108         if (req->status < 0)
 109                 pr_err("ERR %s(%d)\n", __func__, __LINE__);
 110
 111         if (cmd->data_len) {
 112                 if (cmd->data_len > ep->maxpacket) {
 113                         req->length = ep->maxpacket;
 114                         cmd->data_len -= ep->maxpacket;
 115                 } else {
 116                         req->length = cmd->data_len;
 117                         cmd->data_len = 0;
 118                 }
 119
 120                 usb_ep_queue(ep, req, GFP_ATOMIC);
 121                 return ;
 122         }
 123         bot_enqueue_sense_code(fu, cmd);
 124 }
 125
 126 static void bot_send_bad_status(struct usbg_cmd *cmd)
 127 {
 128         struct f_uas *fu = cmd->fu;
 129         struct bulk_cs_wrap *csw = &fu->bot_status.csw;
 130         struct usb_request *req;
 131         struct usb_ep *ep;
 132
 133         csw->Residue = cpu_to_le32(cmd->data_len);
 134
 135         if (cmd->data_len) {
 136                 if (cmd->is_read) {
 137                         ep = fu->ep_in;
 138                         req = fu->bot_req_in;
 139                 } else {
 140                         ep = fu->ep_out;
 141                         req = fu->bot_req_out;
 142                 }
 143
 144                 if (cmd->data_len > fu->ep_in->maxpacket) {
 145                         req->length = ep->maxpacket;
 146                         cmd->data_len -= ep->maxpacket;
 147                 } else {
 148                         req->length = cmd->data_len;
 149                         cmd->data_len = 0;
 150                 }
 151                 req->complete = bot_err_compl;
 152                 req->context = cmd;
 153                 req->buf = fu->cmd.buf;
 154                 usb_ep_queue(ep, req, GFP_KERNEL);
 155         } else {
 156                 bot_enqueue_sense_code(fu, cmd);
 157         }
 158 }
 159
 160 static int bot_send_status(struct usbg_cmd *cmd, bool moved_data)
 161 {
 162         struct f_uas *fu = cmd->fu;
 163         struct bulk_cs_wrap *csw = &fu->bot_status.csw;
 164         int ret;
 165
 166         if (cmd->se_cmd.scsi_status == SAM_STAT_GOOD) {
 167                 if (!moved_data && cmd->data_len) {
 168                         /*
 169                          * the host wants to move data, we don't. Fill / empty
 170                          * the pipe and then send the csw with reside set.
 171                          */
 172                         cmd->csw_code = US_BULK_STAT_OK;
 173                         bot_send_bad_status(cmd);
 174                         return 0;
 175                 }
 176
 177                 csw->Tag = cmd->bot_tag;
 178                 csw->Residue = cpu_to_le32(0);
 179                 csw->Status = US_BULK_STAT_OK;
 180                 fu->bot_status.req->context = cmd;
 181
 182                 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_KERNEL);
 183                 if (ret)
 184                         pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
 185         } else {
 186                 cmd->csw_code = US_BULK_STAT_FAIL;
 187                 bot_send_bad_status(cmd);
 188         }
 189         return 0;
 190 }
 191
 192 /*
 193  * Called after command (no data transfer) or after the write (to device)
 194  * operation is completed
 195  */
 196 static int bot_send_status_response(struct usbg_cmd *cmd)
 197 {
 198         bool moved_data = false;
 199
 200         if (!cmd->is_read)
 201                 moved_data = true;
 202         return bot_send_status(cmd, moved_data);
 203 }
 204
 205 /* Read request completed, now we have to send the CSW */
 206 static void bot_read_compl(struct usb_ep *ep, struct usb_request *req)
 207 {
 208         struct usbg_cmd *cmd = req->context;
 209
 210         if (req->status < 0)
 211                 pr_err("ERR %s(%d)\n", __func__, __LINE__);
 212
 213         bot_send_status(cmd, true);
 214 }
 215
 216 static int bot_send_read_response(struct usbg_cmd *cmd)
 217 {
 218         struct f_uas *fu = cmd->fu;
 219         struct se_cmd *se_cmd = &cmd->se_cmd;
 220         struct usb_gadget *gadget = fuas_to_gadget(fu);
 221         int ret;
 222
 223         if (!cmd->data_len) {
 224                 cmd->csw_code = US_BULK_STAT_PHASE;
 225                 bot_send_bad_status(cmd);
 226                 return 0;
 227         }
 228
 229         if (!gadget->sg_supported) {
 230                 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
 231                 if (!cmd->data_buf)
 232                         return -ENOMEM;
 233
 234                 sg_copy_to_buffer(se_cmd->t_data_sg,
 235                                 se_cmd->t_data_nents,
 236                                 cmd->data_buf,
 237                                 se_cmd->data_length);
 238
 239                 fu->bot_req_in->buf = cmd->data_buf;
 240         } else {
 241                 fu->bot_req_in->buf = NULL;
 242                 fu->bot_req_in->num_sgs = se_cmd->t_data_nents;
 243                 fu->bot_req_in->sg = se_cmd->t_data_sg;
 244         }
 245
 246         fu->bot_req_in->complete = bot_read_compl;
 247         fu->bot_req_in->length = se_cmd->data_length;
 248         fu->bot_req_in->context = cmd;
 249         ret = usb_ep_queue(fu->ep_in, fu->bot_req_in, GFP_ATOMIC);
 250         if (ret)
 251                 pr_err("%s(%d)\n", __func__, __LINE__);
 252         return 0;
 253 }
 254
 255 static void usbg_data_write_cmpl(struct usb_ep *, struct usb_request *);
 256 static int usbg_prepare_w_request(struct usbg_cmd *, struct usb_request *);
 257
 258 static int bot_send_write_request(struct usbg_cmd *cmd)
 259 {
 260         struct f_uas *fu = cmd->fu;
 261         struct se_cmd *se_cmd = &cmd->se_cmd;
 262         struct usb_gadget *gadget = fuas_to_gadget(fu);
 263         int ret;
 264
 265         init_completion(&cmd->write_complete);
 266         cmd->fu = fu;
 267
 268         if (!cmd->data_len) {
 269                 cmd->csw_code = US_BULK_STAT_PHASE;
 270                 return -EINVAL;
 271         }
 272
 273         if (!gadget->sg_supported) {
 274                 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_KERNEL);
 275                 if (!cmd->data_buf)
 276                         return -ENOMEM;
 277
 278                 fu->bot_req_out->buf = cmd->data_buf;
 279         } else {
 280                 fu->bot_req_out->buf = NULL;
 281                 fu->bot_req_out->num_sgs = se_cmd->t_data_nents;
 282                 fu->bot_req_out->sg = se_cmd->t_data_sg;
 283         }
 284
 285         fu->bot_req_out->complete = usbg_data_write_cmpl;
 286         fu->bot_req_out->length = se_cmd->data_length;
 287         fu->bot_req_out->context = cmd;
 288
 289         ret = usbg_prepare_w_request(cmd, fu->bot_req_out);
 290         if (ret)
 291                 goto cleanup;
 292         ret = usb_ep_queue(fu->ep_out, fu->bot_req_out, GFP_KERNEL);
 293         if (ret)
 294                 pr_err("%s(%d)\n", __func__, __LINE__);
 295
 296         wait_for_completion(&cmd->write_complete);
 297         target_execute_cmd(se_cmd);
 298 cleanup:
 299         return ret;
 300 }
 301
 302 static int bot_submit_command(struct f_uas *, void *, unsigned int);
 303
 304 static void bot_cmd_complete(struct usb_ep *ep, struct usb_request *req)
 305 {
 306         struct f_uas *fu = req->context;
 307         int ret;
 308
 309         fu->flags &= ~USBG_BOT_CMD_PEND;
 310
 311         if (req->status < 0)
 312                 return;
 313
 314         ret = bot_submit_command(fu, req->buf, req->actual);
 315         if (ret)
 316                 pr_err("%s(%d): %d\n", __func__, __LINE__, ret);
 317 }
 318
 319 static int bot_prepare_reqs(struct f_uas *fu)
 320 {
 321         int ret;
 322
 323         fu->bot_req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
 324         if (!fu->bot_req_in)
 325                 goto err;
 326
 327         fu->bot_req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
 328         if (!fu->bot_req_out)
 329                 goto err_out;
 330
 331         fu->cmd.req = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
 332         if (!fu->cmd.req)
 333                 goto err_cmd;
 334
 335         fu->bot_status.req = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
 336         if (!fu->bot_status.req)
 337                 goto err_sts;
 338
 339         fu->bot_status.req->buf = &fu->bot_status.csw;
 340         fu->bot_status.req->length = US_BULK_CS_WRAP_LEN;
 341         fu->bot_status.req->complete = bot_status_complete;
 342         fu->bot_status.csw.Signature = cpu_to_le32(US_BULK_CS_SIGN);
 343
 344         fu->cmd.buf = kmalloc(fu->ep_out->maxpacket, GFP_KERNEL);
 345         if (!fu->cmd.buf)
 346                 goto err_buf;
 347
 348         fu->cmd.req->complete = bot_cmd_complete;
 349         fu->cmd.req->buf = fu->cmd.buf;
 350         fu->cmd.req->length = fu->ep_out->maxpacket;
 351         fu->cmd.req->context = fu;
 352
 353         ret = bot_enqueue_cmd_cbw(fu);
 354         if (ret)
 355                 goto err_queue;
 356         return 0;
 357 err_queue:
 358         kfree(fu->cmd.buf);
 359         fu->cmd.buf = NULL;
 360 err_buf:
 361         usb_ep_free_request(fu->ep_in, fu->bot_status.req);
 362 err_sts:
 363         usb_ep_free_request(fu->ep_out, fu->cmd.req);
 364         fu->cmd.req = NULL;
 365 err_cmd:
 366         usb_ep_free_request(fu->ep_out, fu->bot_req_out);
 367         fu->bot_req_out = NULL;
 368 err_out:
 369         usb_ep_free_request(fu->ep_in, fu->bot_req_in);
 370         fu->bot_req_in = NULL;
 371 err:
 372         pr_err("BOT: endpoint setup failed\n");
 373         return -ENOMEM;
 374 }
 375
 376 void bot_cleanup_old_alt(struct f_uas *fu)
 377 {
 378         if (!(fu->flags & USBG_ENABLED))
 379                 return;
 380
 381         usb_ep_disable(fu->ep_in);
 382         usb_ep_disable(fu->ep_out);
 383
 384         if (!fu->bot_req_in)
 385                 return;
 386
 387         usb_ep_free_request(fu->ep_in, fu->bot_req_in);
 388         usb_ep_free_request(fu->ep_out, fu->bot_req_out);
 389         usb_ep_free_request(fu->ep_out, fu->cmd.req);
 390         usb_ep_free_request(fu->ep_out, fu->bot_status.req);
 391
 392         kfree(fu->cmd.buf);
 393
 394         fu->bot_req_in = NULL;
 395         fu->bot_req_out = NULL;
 396         fu->cmd.req = NULL;
 397         fu->bot_status.req = NULL;
 398         fu->cmd.buf = NULL;
 399 }
 400
 401 static void bot_set_alt(struct f_uas *fu)
 402 {
 403         struct usb_function *f = &fu->function;
 404         struct usb_gadget *gadget = f->config->cdev->gadget;
 405         int ret;
 406
 407         fu->flags = USBG_IS_BOT;
 408
 409         config_ep_by_speed(gadget, f, fu->ep_in);
 410         ret = usb_ep_enable(fu->ep_in);
 411         if (ret)
 412                 goto err_b_in;
 413
 414         config_ep_by_speed(gadget, f, fu->ep_out);
 415         ret = usb_ep_enable(fu->ep_out);
 416         if (ret)
 417                 goto err_b_out;
 418
 419         ret = bot_prepare_reqs(fu);
 420         if (ret)
 421                 goto err_wq;
 422         fu->flags |= USBG_ENABLED;
 423         pr_info("Using the BOT protocol\n");
 424         return;
 425 err_wq:
 426         usb_ep_disable(fu->ep_out);
 427 err_b_out:
 428         usb_ep_disable(fu->ep_in);
 429 err_b_in:
 430         fu->flags = USBG_IS_BOT;
 431 }
 432
 433 static int usbg_bot_setup(struct usb_function *f,
 434                 const struct usb_ctrlrequest *ctrl)
 435 {
 436         struct f_uas *fu = to_f_uas(f);
 437         struct usb_composite_dev *cdev = f->config->cdev;
 438         u16 w_value = le16_to_cpu(ctrl->wValue);
 439         u16 w_length = le16_to_cpu(ctrl->wLength);
 440         int luns;
 441         u8 *ret_lun;
 442
 443         switch (ctrl->bRequest) {
 444         case US_BULK_GET_MAX_LUN:
 445                 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_CLASS |
 446                                         USB_RECIP_INTERFACE))
 447                         return -ENOTSUPP;
 448
 449                 if (w_length < 1)
 450                         return -EINVAL;
 451                 if (w_value != 0)
 452                         return -EINVAL;
 453                 luns = atomic_read(&fu->tpg->tpg_port_count);
 454                 if (!luns) {
 455                         pr_err("No LUNs configured?\n");
 456                         return -EINVAL;
 457                 }
 458                 /*
 459                  * If 4 LUNs are present we return 3 i.e. LUN 0..3 can be
 460                  * accessed. The upper limit is 0xf
 461                  */
 462                 luns--;
 463                 if (luns > 0xf) {
 464                         pr_info_once("Limiting the number of luns to 16\n");
 465                         luns = 0xf;
 466                 }
 467                 ret_lun = cdev->req->buf;
 468                 *ret_lun = luns;
 469                 cdev->req->length = 1;
 470                 return usb_ep_queue(cdev->gadget->ep0, cdev->req, GFP_ATOMIC);
 471                 break;
 472
 473         case US_BULK_RESET_REQUEST:
 474                 /* XXX maybe we should remove previous requests for IN + OUT */
 475                 bot_enqueue_cmd_cbw(fu);
 476                 return 0;
 477                 break;
 478         };
 479         return -ENOTSUPP;
 480 }
 481
 482 /* Start uas.c code */
 483
 484 static void uasp_cleanup_one_stream(struct f_uas *fu, struct uas_stream *stream)
 485 {
 486         /* We have either all three allocated or none */
 487         if (!stream->req_in)
 488                 return;
 489
 490         usb_ep_free_request(fu->ep_in, stream->req_in);
 491         usb_ep_free_request(fu->ep_out, stream->req_out);
 492         usb_ep_free_request(fu->ep_status, stream->req_status);
 493
 494         stream->req_in = NULL;
 495         stream->req_out = NULL;
 496         stream->req_status = NULL;
 497 }
 498
 499 static void uasp_free_cmdreq(struct f_uas *fu)
 500 {
 501         usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
 502         kfree(fu->cmd.buf);
 503         fu->cmd.req = NULL;
 504         fu->cmd.buf = NULL;
 505 }
 506
 507 static void uasp_cleanup_old_alt(struct f_uas *fu)
 508 {
 509         int i;
 510
 511         if (!(fu->flags & USBG_ENABLED))
 512                 return;
 513
 514         usb_ep_disable(fu->ep_in);
 515         usb_ep_disable(fu->ep_out);
 516         usb_ep_disable(fu->ep_status);
 517         usb_ep_disable(fu->ep_cmd);
 518
 519         for (i = 0; i < UASP_SS_EP_COMP_NUM_STREAMS; i++)
 520                 uasp_cleanup_one_stream(fu, &fu->stream[i]);
 521         uasp_free_cmdreq(fu);
 522 }
 523
 524 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req);
 525
 526 static int uasp_prepare_r_request(struct usbg_cmd *cmd)
 527 {
 528         struct se_cmd *se_cmd = &cmd->se_cmd;
 529         struct f_uas *fu = cmd->fu;
 530         struct usb_gadget *gadget = fuas_to_gadget(fu);
 531         struct uas_stream *stream = cmd->stream;
 532
 533         if (!gadget->sg_supported) {
 534                 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
 535                 if (!cmd->data_buf)
 536                         return -ENOMEM;
 537
 538                 sg_copy_to_buffer(se_cmd->t_data_sg,
 539                                 se_cmd->t_data_nents,
 540                                 cmd->data_buf,
 541                                 se_cmd->data_length);
 542
 543                 stream->req_in->buf = cmd->data_buf;
 544         } else {
 545                 stream->req_in->buf = NULL;
 546                 stream->req_in->num_sgs = se_cmd->t_data_nents;
 547                 stream->req_in->sg = se_cmd->t_data_sg;
 548         }
 549
 550         stream->req_in->complete = uasp_status_data_cmpl;
 551         stream->req_in->length = se_cmd->data_length;
 552         stream->req_in->context = cmd;
 553
 554         cmd->state = UASP_SEND_STATUS;
 555         return 0;
 556 }
 557
 558 static void uasp_prepare_status(struct usbg_cmd *cmd)
 559 {
 560         struct se_cmd *se_cmd = &cmd->se_cmd;
 561         struct sense_iu *iu = &cmd->sense_iu;
 562         struct uas_stream *stream = cmd->stream;
 563
 564         cmd->state = UASP_QUEUE_COMMAND;
 565         iu->iu_id = IU_ID_STATUS;
 566         iu->tag = cpu_to_be16(cmd->tag);
 567
 568         /*
 569          * iu->status_qual = cpu_to_be16(STATUS QUALIFIER SAM-4. Where R U?);
 570          */
 571         iu->len = cpu_to_be16(se_cmd->scsi_sense_length);
 572         iu->status = se_cmd->scsi_status;
 573         stream->req_status->context = cmd;
 574         stream->req_status->length = se_cmd->scsi_sense_length + 16;
 575         stream->req_status->buf = iu;
 576         stream->req_status->complete = uasp_status_data_cmpl;
 577 }
 578
 579 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req)
 580 {
 581         struct usbg_cmd *cmd = req->context;
 582         struct uas_stream *stream = cmd->stream;
 583         struct f_uas *fu = cmd->fu;
 584         int ret;
 585
 586         if (req->status < 0)
 587                 goto cleanup;
 588
 589         switch (cmd->state) {
 590         case UASP_SEND_DATA:
 591                 ret = uasp_prepare_r_request(cmd);
 592                 if (ret)
 593                         goto cleanup;
 594                 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
 595                 if (ret)
 596                         pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
 597                 break;
 598
 599         case UASP_RECEIVE_DATA:
 600                 ret = usbg_prepare_w_request(cmd, stream->req_out);
 601                 if (ret)
 602                         goto cleanup;
 603                 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
 604                 if (ret)
 605                         pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
 606                 break;
 607
 608         case UASP_SEND_STATUS:
 609                 uasp_prepare_status(cmd);
 610                 ret = usb_ep_queue(fu->ep_status, stream->req_status,
 611                                 GFP_ATOMIC);
 612                 if (ret)
 613                         pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
 614                 break;
 615
 616         case UASP_QUEUE_COMMAND:
 617                 usbg_cleanup_cmd(cmd);
 618                 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
 619                 break;
 620
 621         default:
 622                 BUG();
 623         };
 624         return;
 625
 626 cleanup:
 627         usbg_cleanup_cmd(cmd);
 628 }
 629
 630 static int uasp_send_status_response(struct usbg_cmd *cmd)
 631 {
 632         struct f_uas *fu = cmd->fu;
 633         struct uas_stream *stream = cmd->stream;
 634         struct sense_iu *iu = &cmd->sense_iu;
 635
 636         iu->tag = cpu_to_be16(cmd->tag);
 637         stream->req_status->complete = uasp_status_data_cmpl;
 638         stream->req_status->context = cmd;
 639         cmd->fu = fu;
 640         uasp_prepare_status(cmd);
 641         return usb_ep_queue(fu->ep_status, stream->req_status, GFP_ATOMIC);
 642 }
 643
 644 static int uasp_send_read_response(struct usbg_cmd *cmd)
 645 {
 646         struct f_uas *fu = cmd->fu;
 647         struct uas_stream *stream = cmd->stream;
 648         struct sense_iu *iu = &cmd->sense_iu;
 649         int ret;
 650
 651         cmd->fu = fu;
 652
 653         iu->tag = cpu_to_be16(cmd->tag);
 654         if (fu->flags & USBG_USE_STREAMS) {
 655
 656                 ret = uasp_prepare_r_request(cmd);
 657                 if (ret)
 658                         goto out;
 659                 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
 660                 if (ret) {
 661                         pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
 662                         kfree(cmd->data_buf);
 663                         cmd->data_buf = NULL;
 664                 }
 665
 666         } else {
 667
 668                 iu->iu_id = IU_ID_READ_READY;
 669                 iu->tag = cpu_to_be16(cmd->tag);
 670
 671                 stream->req_status->complete = uasp_status_data_cmpl;
 672                 stream->req_status->context = cmd;
 673
 674                 cmd->state = UASP_SEND_DATA;
 675                 stream->req_status->buf = iu;
 676                 stream->req_status->length = sizeof(struct iu);
 677
 678                 ret = usb_ep_queue(fu->ep_status, stream->req_status,
 679                                 GFP_ATOMIC);
 680                 if (ret)
 681                         pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
 682         }
 683 out:
 684         return ret;
 685 }
 686
 687 static int uasp_send_write_request(struct usbg_cmd *cmd)
 688 {
 689         struct f_uas *fu = cmd->fu;
 690         struct se_cmd *se_cmd = &cmd->se_cmd;
 691         struct uas_stream *stream = cmd->stream;
 692         struct sense_iu *iu = &cmd->sense_iu;
 693         int ret;
 694
 695         init_completion(&cmd->write_complete);
 696         cmd->fu = fu;
 697
 698         iu->tag = cpu_to_be16(cmd->tag);
 699
 700         if (fu->flags & USBG_USE_STREAMS) {
 701
 702                 ret = usbg_prepare_w_request(cmd, stream->req_out);
 703                 if (ret)
 704                         goto cleanup;
 705                 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
 706                 if (ret)
 707                         pr_err("%s(%d)\n", __func__, __LINE__);
 708
 709         } else {
 710
 711                 iu->iu_id = IU_ID_WRITE_READY;
 712                 iu->tag = cpu_to_be16(cmd->tag);
 713
 714                 stream->req_status->complete = uasp_status_data_cmpl;
 715                 stream->req_status->context = cmd;
 716
 717                 cmd->state = UASP_RECEIVE_DATA;
 718                 stream->req_status->buf = iu;
 719                 stream->req_status->length = sizeof(struct iu);
 720
 721                 ret = usb_ep_queue(fu->ep_status, stream->req_status,
 722                                 GFP_ATOMIC);
 723                 if (ret)
 724                         pr_err("%s(%d)\n", __func__, __LINE__);
 725         }
 726
 727         wait_for_completion(&cmd->write_complete);
 728         target_execute_cmd(se_cmd);
 729 cleanup:
 730         return ret;
 731 }
 732
 733 static int usbg_submit_command(struct f_uas *, void *, unsigned int);
 734
 735 static void uasp_cmd_complete(struct usb_ep *ep, struct usb_request *req)
 736 {
 737         struct f_uas *fu = req->context;
 738         int ret;
 739
 740         if (req->status < 0)
 741                 return;
 742
 743         ret = usbg_submit_command(fu, req->buf, req->actual);
 744         /*
 745          * Once we tune for performance enqueue the command req here again so
 746          * we can receive a second command while we processing this one. Pay
 747          * attention to properly sync STAUS endpoint with DATA IN + OUT so you
 748          * don't break HS.
 749          */
 750         if (!ret)
 751                 return;
 752         usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
 753 }
 754
 755 static int uasp_alloc_stream_res(struct f_uas *fu, struct uas_stream *stream)
 756 {
 757         stream->req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
 758         if (!stream->req_in)
 759                 goto out;
 760
 761         stream->req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
 762         if (!stream->req_out)
 763                 goto err_out;
 764
 765         stream->req_status = usb_ep_alloc_request(fu->ep_status, GFP_KERNEL);
 766         if (!stream->req_status)
 767                 goto err_sts;
 768
 769         return 0;
 770 err_sts:
 771         usb_ep_free_request(fu->ep_status, stream->req_status);
 772         stream->req_status = NULL;
 773 err_out:
 774         usb_ep_free_request(fu->ep_out, stream->req_out);
 775         stream->req_out = NULL;
 776 out:
 777         return -ENOMEM;
 778 }
 779
 780 static int uasp_alloc_cmd(struct f_uas *fu)
 781 {
 782         fu->cmd.req = usb_ep_alloc_request(fu->ep_cmd, GFP_KERNEL);
 783         if (!fu->cmd.req)
 784                 goto err;
 785
 786         fu->cmd.buf = kmalloc(fu->ep_cmd->maxpacket, GFP_KERNEL);
 787         if (!fu->cmd.buf)
 788                 goto err_buf;
 789
 790         fu->cmd.req->complete = uasp_cmd_complete;
 791         fu->cmd.req->buf = fu->cmd.buf;
 792         fu->cmd.req->length = fu->ep_cmd->maxpacket;
 793         fu->cmd.req->context = fu;
 794         return 0;
 795
 796 err_buf:
 797         usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
 798 err:
 799         return -ENOMEM;
 800 }
 801
 802 static void uasp_setup_stream_res(struct f_uas *fu, int max_streams)
 803 {
 804         int i;
 805
 806         for (i = 0; i < max_streams; i++) {
 807                 struct uas_stream *s = &fu->stream[i];
 808
 809                 s->req_in->stream_id = i + 1;
 810                 s->req_out->stream_id = i + 1;
 811                 s->req_status->stream_id = i + 1;
 812         }
 813 }
 814
 815 static int uasp_prepare_reqs(struct f_uas *fu)
 816 {
 817         int ret;
 818         int i;
 819         int max_streams;
 820
 821         if (fu->flags & USBG_USE_STREAMS)
 822                 max_streams = UASP_SS_EP_COMP_NUM_STREAMS;
 823         else
 824                 max_streams = 1;
 825
 826         for (i = 0; i < max_streams; i++) {
 827                 ret = uasp_alloc_stream_res(fu, &fu->stream[i]);
 828                 if (ret)
 829                         goto err_cleanup;
 830         }
 831
 832         ret = uasp_alloc_cmd(fu);
 833         if (ret)
 834                 goto err_free_stream;
 835         uasp_setup_stream_res(fu, max_streams);
 836
 837         ret = usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
 838         if (ret)
 839                 goto err_free_stream;
 840
 841         return 0;
 842
 843 err_free_stream:
 844         uasp_free_cmdreq(fu);
 845
 846 err_cleanup:
 847         if (i) {
 848                 do {
 849                         uasp_cleanup_one_stream(fu, &fu->stream[i - 1]);
 850                         i--;
 851                 } while (i);
 852         }
 853         pr_err("UASP: endpoint setup failed\n");
 854         return ret;
 855 }
 856
 857 static void uasp_set_alt(struct f_uas *fu)
 858 {
 859         struct usb_function *f = &fu->function;
 860         struct usb_gadget *gadget = f->config->cdev->gadget;
 861         int ret;
 862
 863         fu->flags = USBG_IS_UAS;
 864
 865         if (gadget->speed == USB_SPEED_SUPER)
 866                 fu->flags |= USBG_USE_STREAMS;
 867
 868         config_ep_by_speed(gadget, f, fu->ep_in);
 869         ret = usb_ep_enable(fu->ep_in);
 870         if (ret)
 871                 goto err_b_in;
 872
 873         config_ep_by_speed(gadget, f, fu->ep_out);
 874         ret = usb_ep_enable(fu->ep_out);
 875         if (ret)
 876                 goto err_b_out;
 877
 878         config_ep_by_speed(gadget, f, fu->ep_cmd);
 879         ret = usb_ep_enable(fu->ep_cmd);
 880         if (ret)
 881                 goto err_cmd;
 882         config_ep_by_speed(gadget, f, fu->ep_status);
 883         ret = usb_ep_enable(fu->ep_status);
 884         if (ret)
 885                 goto err_status;
 886
 887         ret = uasp_prepare_reqs(fu);
 888         if (ret)
 889                 goto err_wq;
 890         fu->flags |= USBG_ENABLED;
 891
 892         pr_info("Using the UAS protocol\n");
 893         return;
 894 err_wq:
 895         usb_ep_disable(fu->ep_status);
 896 err_status:
 897         usb_ep_disable(fu->ep_cmd);
 898 err_cmd:
 899         usb_ep_disable(fu->ep_out);
 900 err_b_out:
 901         usb_ep_disable(fu->ep_in);
 902 err_b_in:
 903         fu->flags = 0;
 904 }
 905
 906 static int get_cmd_dir(const unsigned char *cdb)
 907 {
 908         int ret;
 909
 910         switch (cdb[0]) {
 911         case READ_6:
 912         case READ_10:
 913         case READ_12:
 914         case READ_16:
 915         case INQUIRY:
 916         case MODE_SENSE:
 917         case MODE_SENSE_10:
 918         case SERVICE_ACTION_IN:
 919         case MAINTENANCE_IN:
 920         case PERSISTENT_RESERVE_IN:
 921         case SECURITY_PROTOCOL_IN:
 922         case ACCESS_CONTROL_IN:
 923         case REPORT_LUNS:
 924         case READ_BLOCK_LIMITS:
 925         case READ_POSITION:
 926         case READ_CAPACITY:
 927         case READ_TOC:
 928         case READ_FORMAT_CAPACITIES:
 929         case REQUEST_SENSE:
 930                 ret = DMA_FROM_DEVICE;
 931                 break;
 932
 933         case WRITE_6:
 934         case WRITE_10:
 935         case WRITE_12:
 936         case WRITE_16:
 937         case MODE_SELECT:
 938         case MODE_SELECT_10:
 939         case WRITE_VERIFY:
 940         case WRITE_VERIFY_12:
 941         case PERSISTENT_RESERVE_OUT:
 942         case MAINTENANCE_OUT:
 943         case SECURITY_PROTOCOL_OUT:
 944         case ACCESS_CONTROL_OUT:
 945                 ret = DMA_TO_DEVICE;
 946                 break;
 947         case ALLOW_MEDIUM_REMOVAL:
 948         case TEST_UNIT_READY:
 949         case SYNCHRONIZE_CACHE:
 950         case START_STOP:
 951         case ERASE:
 952         case REZERO_UNIT:
 953         case SEEK_10:
 954         case SPACE:
 955         case VERIFY:
 956         case WRITE_FILEMARKS:
 957                 ret = DMA_NONE;
 958                 break;
 959         default:
 960                 pr_warn("target: Unknown data direction for SCSI Opcode "
 961                                 "0x%02x\n", cdb[0]);
 962                 ret = -EINVAL;
 963         }
 964         return ret;
 965 }
 966
 967 static void usbg_data_write_cmpl(struct usb_ep *ep, struct usb_request *req)
 968 {
 969         struct usbg_cmd *cmd = req->context;
 970         struct se_cmd *se_cmd = &cmd->se_cmd;
 971
 972         if (req->status < 0) {
 973                 pr_err("%s() state %d transfer failed\n", __func__, cmd->state);
 974                 goto cleanup;
 975         }
 976
 977         if (req->num_sgs == 0) {
 978                 sg_copy_from_buffer(se_cmd->t_data_sg,
 979                                 se_cmd->t_data_nents,
 980                                 cmd->data_buf,
 981                                 se_cmd->data_length);
 982         }
 983
 984         complete(&cmd->write_complete);
 985         return;
 986
 987 cleanup:
 988         usbg_cleanup_cmd(cmd);
 989 }
 990
 991 static int usbg_prepare_w_request(struct usbg_cmd *cmd, struct usb_request *req)
 992 {
 993         struct se_cmd *se_cmd = &cmd->se_cmd;
 994         struct f_uas *fu = cmd->fu;
 995         struct usb_gadget *gadget = fuas_to_gadget(fu);
 996
 997         if (!gadget->sg_supported) {
 998                 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
 999                 if (!cmd->data_buf)
1000                         return -ENOMEM;
1001
1002                 req->buf = cmd->data_buf;
1003         } else {
1004                 req->buf = NULL;
1005                 req->num_sgs = se_cmd->t_data_nents;
1006                 req->sg = se_cmd->t_data_sg;
1007         }
1008
1009         req->complete = usbg_data_write_cmpl;
1010         req->length = se_cmd->data_length;
1011         req->context = cmd;
1012         return 0;
1013 }
1014
1015 static int usbg_send_status_response(struct se_cmd *se_cmd)
1016 {
1017         struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1018                         se_cmd);
1019         struct f_uas *fu = cmd->fu;
1020
1021         if (fu->flags & USBG_IS_BOT)
1022                 return bot_send_status_response(cmd);
1023         else
1024                 return uasp_send_status_response(cmd);
1025 }
1026
1027 static int usbg_send_write_request(struct se_cmd *se_cmd)
1028 {
1029         struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1030                         se_cmd);
1031         struct f_uas *fu = cmd->fu;
1032
1033         if (fu->flags & USBG_IS_BOT)
1034                 return bot_send_write_request(cmd);
1035         else
1036                 return uasp_send_write_request(cmd);
1037 }
1038
1039 static int usbg_send_read_response(struct se_cmd *se_cmd)
1040 {
1041         struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1042                         se_cmd);
1043         struct f_uas *fu = cmd->fu;
1044
1045         if (fu->flags & USBG_IS_BOT)
1046                 return bot_send_read_response(cmd);
1047         else
1048                 return uasp_send_read_response(cmd);
1049 }
1050
1051 static void usbg_cmd_work(struct work_struct *work)
1052 {
1053         struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1054         struct se_cmd *se_cmd;
1055         struct tcm_usbg_nexus *tv_nexus;
1056         struct usbg_tpg *tpg;
1057         int dir;
1058
1059         se_cmd = &cmd->se_cmd;
1060         tpg = cmd->fu->tpg;
1061         tv_nexus = tpg->tpg_nexus;
1062         dir = get_cmd_dir(cmd->cmd_buf);
1063         if (dir < 0) {
1064                 transport_init_se_cmd(se_cmd,
1065                                 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1066                                 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1067                                 cmd->prio_attr, cmd->sense_iu.sense);
1068                 goto out;
1069         }
1070
1071         if (target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1072                         cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1073                         0, cmd->prio_attr, dir, TARGET_SCF_UNKNOWN_SIZE) < 0)
1074                 goto out;
1075
1076         return;
1077
1078 out:
1079         transport_send_check_condition_and_sense(se_cmd,
1080                         TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1081         usbg_cleanup_cmd(cmd);
1082 }
1083
1084 static int usbg_submit_command(struct f_uas *fu,
1085                 void *cmdbuf, unsigned int len)
1086 {
1087         struct command_iu *cmd_iu = cmdbuf;
1088         struct usbg_cmd *cmd;
1089         struct usbg_tpg *tpg;
1090         struct se_cmd *se_cmd;
1091         struct tcm_usbg_nexus *tv_nexus;
1092         u32 cmd_len;
1093         int ret;
1094
1095         if (cmd_iu->iu_id != IU_ID_COMMAND) {
1096                 pr_err("Unsupported type %d\n", cmd_iu->iu_id);
1097                 return -EINVAL;
1098         }
1099
1100         cmd = kzalloc(sizeof *cmd, GFP_ATOMIC);
1101         if (!cmd)
1102                 return -ENOMEM;
1103
1104         cmd->fu = fu;
1105
1106         /* XXX until I figure out why I can't free in on complete */
1107         kref_init(&cmd->ref);
1108         kref_get(&cmd->ref);
1109
1110         tpg = fu->tpg;
1111         cmd_len = (cmd_iu->len & ~0x3) + 16;
1112         if (cmd_len > USBG_MAX_CMD)
1113                 goto err;
1114
1115         memcpy(cmd->cmd_buf, cmd_iu->cdb, cmd_len);
1116
1117         cmd->tag = be16_to_cpup(&cmd_iu->tag);
1118         if (fu->flags & USBG_USE_STREAMS) {
1119                 if (cmd->tag > UASP_SS_EP_COMP_NUM_STREAMS)
1120                         goto err;
1121                 if (!cmd->tag)
1122                         cmd->stream = &fu->stream[0];
1123                 else
1124                         cmd->stream = &fu->stream[cmd->tag - 1];
1125         } else {
1126                 cmd->stream = &fu->stream[0];
1127         }
1128
1129         tv_nexus = tpg->tpg_nexus;
1130         if (!tv_nexus) {
1131                 pr_err("Missing nexus, ignoring command\n");
1132                 goto err;
1133         }
1134
1135         switch (cmd_iu->prio_attr & 0x7) {
1136         case UAS_HEAD_TAG:
1137                 cmd->prio_attr = MSG_HEAD_TAG;
1138                 break;
1139         case UAS_ORDERED_TAG:
1140                 cmd->prio_attr = MSG_ORDERED_TAG;
1141                 break;
1142         case UAS_ACA:
1143                 cmd->prio_attr = MSG_ACA_TAG;
1144                 break;
1145         default:
1146                 pr_debug_once("Unsupported prio_attr: %02x.\n",
1147                                 cmd_iu->prio_attr);
1148         case UAS_SIMPLE_TAG:
1149                 cmd->prio_attr = MSG_SIMPLE_TAG;
1150                 break;
1151         }
1152
1153         se_cmd = &cmd->se_cmd;
1154         cmd->unpacked_lun = scsilun_to_int(&cmd_iu->lun);
1155
1156         INIT_WORK(&cmd->work, usbg_cmd_work);
1157         ret = queue_work(tpg->workqueue, &cmd->work);
1158         if (ret < 0)
1159                 goto err;
1160
1161         return 0;
1162 err:
1163         kfree(cmd);
1164         return -EINVAL;
1165 }
1166
1167 static void bot_cmd_work(struct work_struct *work)
1168 {
1169         struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1170         struct se_cmd *se_cmd;
1171         struct tcm_usbg_nexus *tv_nexus;
1172         struct usbg_tpg *tpg;
1173         int dir;
1174
1175         se_cmd = &cmd->se_cmd;
1176         tpg = cmd->fu->tpg;
1177         tv_nexus = tpg->tpg_nexus;
1178         dir = get_cmd_dir(cmd->cmd_buf);
1179         if (dir < 0) {
1180                 transport_init_se_cmd(se_cmd,
1181                                 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1182                                 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1183                                 cmd->prio_attr, cmd->sense_iu.sense);
1184                 goto out;
1185         }
1186
1187         if (target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1188                         cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1189                         cmd->data_len, cmd->prio_attr, dir, 0) < 0)
1190                 goto out;
1191
1192         return;
1193
1194 out:
1195         transport_send_check_condition_and_sense(se_cmd,
1196                                 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1197         usbg_cleanup_cmd(cmd);
1198 }
1199
1200 static int bot_submit_command(struct f_uas *fu,
1201                 void *cmdbuf, unsigned int len)
1202 {
1203         struct bulk_cb_wrap *cbw = cmdbuf;
1204         struct usbg_cmd *cmd;
1205         struct usbg_tpg *tpg;
1206         struct se_cmd *se_cmd;
1207         struct tcm_usbg_nexus *tv_nexus;
1208         u32 cmd_len;
1209         int ret;
1210
1211         if (cbw->Signature != cpu_to_le32(US_BULK_CB_SIGN)) {
1212                 pr_err("Wrong signature on CBW\n");
1213                 return -EINVAL;
1214         }
1215         if (len != 31) {
1216                 pr_err("Wrong length for CBW\n");
1217                 return -EINVAL;
1218         }
1219
1220         cmd_len = cbw->Length;
1221         if (cmd_len < 1 || cmd_len > 16)
1222                 return -EINVAL;
1223
1224         cmd = kzalloc(sizeof *cmd, GFP_ATOMIC);
1225         if (!cmd)
1226                 return -ENOMEM;
1227
1228         cmd->fu = fu;
1229
1230         /* XXX until I figure out why I can't free in on complete */
1231         kref_init(&cmd->ref);
1232         kref_get(&cmd->ref);
1233
1234         tpg = fu->tpg;
1235
1236         memcpy(cmd->cmd_buf, cbw->CDB, cmd_len);
1237
1238         cmd->bot_tag = cbw->Tag;
1239
1240         tv_nexus = tpg->tpg_nexus;
1241         if (!tv_nexus) {
1242                 pr_err("Missing nexus, ignoring command\n");
1243                 goto err;
1244         }
1245
1246         cmd->prio_attr = MSG_SIMPLE_TAG;
1247         se_cmd = &cmd->se_cmd;
1248         cmd->unpacked_lun = cbw->Lun;
1249         cmd->is_read = cbw->Flags & US_BULK_FLAG_IN ? 1 : 0;
1250         cmd->data_len = le32_to_cpu(cbw->DataTransferLength);
1251
1252         INIT_WORK(&cmd->work, bot_cmd_work);
1253         ret = queue_work(tpg->workqueue, &cmd->work);
1254         if (ret < 0)
1255                 goto err;
1256
1257         return 0;
1258 err:
1259         kfree(cmd);
1260         return -EINVAL;
1261 }
1262
1263 /* Start fabric.c code */
1264
1265 static int usbg_check_true(struct se_portal_group *se_tpg)
1266 {
1267         return 1;
1268 }
1269
1270 static int usbg_check_false(struct se_portal_group *se_tpg)
1271 {
1272         return 0;
1273 }
1274
1275 static char *usbg_get_fabric_name(void)
1276 {
1277         return "usb_gadget";
1278 }
1279
1280 static u8 usbg_get_fabric_proto_ident(struct se_portal_group *se_tpg)
1281 {
1282         struct usbg_tpg *tpg = container_of(se_tpg,
1283                                 struct usbg_tpg, se_tpg);
1284         struct usbg_tport *tport = tpg->tport;
1285         u8 proto_id;
1286
1287         switch (tport->tport_proto_id) {
1288         case SCSI_PROTOCOL_SAS:
1289         default:
1290                 proto_id = sas_get_fabric_proto_ident(se_tpg);
1291                 break;
1292         }
1293
1294         return proto_id;
1295 }
1296
1297 static char *usbg_get_fabric_wwn(struct se_portal_group *se_tpg)
1298 {
1299         struct usbg_tpg *tpg = container_of(se_tpg,
1300                                 struct usbg_tpg, se_tpg);
1301         struct usbg_tport *tport = tpg->tport;
1302
1303         return &tport->tport_name[0];
1304 }
1305
1306 static u16 usbg_get_tag(struct se_portal_group *se_tpg)
1307 {
1308         struct usbg_tpg *tpg = container_of(se_tpg,
1309                                 struct usbg_tpg, se_tpg);
1310         return tpg->tport_tpgt;
1311 }
1312
1313 static u32 usbg_get_default_depth(struct se_portal_group *se_tpg)
1314 {
1315         return 1;
1316 }
1317
1318 static u32 usbg_get_pr_transport_id(
1319         struct se_portal_group *se_tpg,
1320         struct se_node_acl *se_nacl,
1321         struct t10_pr_registration *pr_reg,
1322         int *format_code,
1323         unsigned char *buf)
1324 {
1325         struct usbg_tpg *tpg = container_of(se_tpg,
1326                                 struct usbg_tpg, se_tpg);
1327         struct usbg_tport *tport = tpg->tport;
1328         int ret = 0;
1329
1330         switch (tport->tport_proto_id) {
1331         case SCSI_PROTOCOL_SAS:
1332         default:
1333                 ret = sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1334                                         format_code, buf);
1335                 break;
1336         }
1337
1338         return ret;
1339 }
1340
1341 static u32 usbg_get_pr_transport_id_len(
1342         struct se_portal_group *se_tpg,
1343         struct se_node_acl *se_nacl,
1344         struct t10_pr_registration *pr_reg,
1345         int *format_code)
1346 {
1347         struct usbg_tpg *tpg = container_of(se_tpg,
1348                                 struct usbg_tpg, se_tpg);
1349         struct usbg_tport *tport = tpg->tport;
1350         int ret = 0;
1351
1352         switch (tport->tport_proto_id) {
1353         case SCSI_PROTOCOL_SAS:
1354         default:
1355                 ret = sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1356                                         format_code);
1357                 break;
1358         }
1359
1360         return ret;
1361 }
1362
1363 static char *usbg_parse_pr_out_transport_id(
1364         struct se_portal_group *se_tpg,
1365         const char *buf,
1366         u32 *out_tid_len,
1367         char **port_nexus_ptr)
1368 {
1369         struct usbg_tpg *tpg = container_of(se_tpg,
1370                                 struct usbg_tpg, se_tpg);
1371         struct usbg_tport *tport = tpg->tport;
1372         char *tid = NULL;
1373
1374         switch (tport->tport_proto_id) {
1375         case SCSI_PROTOCOL_SAS:
1376         default:
1377                 tid = sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1378                                         port_nexus_ptr);
1379         }
1380
1381         return tid;
1382 }
1383
1384 static struct se_node_acl *usbg_alloc_fabric_acl(struct se_portal_group *se_tpg)
1385 {
1386         struct usbg_nacl *nacl;
1387
1388         nacl = kzalloc(sizeof(struct usbg_nacl), GFP_KERNEL);
1389         if (!nacl) {
1390                 printk(KERN_ERR "Unable to alocate struct usbg_nacl\n");
1391                 return NULL;
1392         }
1393
1394         return &nacl->se_node_acl;
1395 }
1396
1397 static void usbg_release_fabric_acl(
1398         struct se_portal_group *se_tpg,
1399         struct se_node_acl *se_nacl)
1400 {
1401         struct usbg_nacl *nacl = container_of(se_nacl,
1402                         struct usbg_nacl, se_node_acl);
1403         kfree(nacl);
1404 }
1405
1406 static u32 usbg_tpg_get_inst_index(struct se_portal_group *se_tpg)
1407 {
1408         return 1;
1409 }
1410
1411 static void usbg_cmd_release(struct kref *ref)
1412 {
1413         struct usbg_cmd *cmd = container_of(ref, struct usbg_cmd,
1414                         ref);
1415
1416         transport_generic_free_cmd(&cmd->se_cmd, 0);
1417 }
1418
1419 static void usbg_release_cmd(struct se_cmd *se_cmd)
1420 {
1421         struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1422                         se_cmd);
1423         kfree(cmd->data_buf);
1424         kfree(cmd);
1425         return;
1426 }
1427
1428 static int usbg_shutdown_session(struct se_session *se_sess)
1429 {
1430         return 0;
1431 }
1432
1433 static void usbg_close_session(struct se_session *se_sess)
1434 {
1435         return;
1436 }
1437
1438 static u32 usbg_sess_get_index(struct se_session *se_sess)
1439 {
1440         return 0;
1441 }
1442
1443 /*
1444  * XXX Error recovery: return != 0 if we expect writes. Dunno when that could be
1445  */
1446 static int usbg_write_pending_status(struct se_cmd *se_cmd)
1447 {
1448         return 0;
1449 }
1450
1451 static void usbg_set_default_node_attrs(struct se_node_acl *nacl)
1452 {
1453         return;
1454 }
1455
1456 static u32 usbg_get_task_tag(struct se_cmd *se_cmd)
1457 {
1458         struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1459                         se_cmd);
1460         struct f_uas *fu = cmd->fu;
1461
1462         if (fu->flags & USBG_IS_BOT)
1463                 return le32_to_cpu(cmd->bot_tag);
1464         else
1465                 return cmd->tag;
1466 }
1467
1468 static int usbg_get_cmd_state(struct se_cmd *se_cmd)
1469 {
1470         return 0;
1471 }
1472
1473 static int usbg_queue_tm_rsp(struct se_cmd *se_cmd)
1474 {
1475         return 0;
1476 }
1477
1478 static const char *usbg_check_wwn(const char *name)
1479 {
1480         const char *n;
1481         unsigned int len;
1482
1483         n = strstr(name, "naa.");
1484         if (!n)
1485                 return NULL;
1486         n += 4;
1487         len = strlen(n);
1488         if (len == 0 || len > USBG_NAMELEN - 1)
1489                 return NULL;
1490         return n;
1491 }
1492
1493 static struct se_node_acl *usbg_make_nodeacl(
1494         struct se_portal_group *se_tpg,
1495         struct config_group *group,
1496         const char *name)
1497 {
1498         struct se_node_acl *se_nacl, *se_nacl_new;
1499         struct usbg_nacl *nacl;
1500         u64 wwpn = 0;
1501         u32 nexus_depth;
1502         const char *wnn_name;
1503
1504         wnn_name = usbg_check_wwn(name);
1505         if (!wnn_name)
1506                 return ERR_PTR(-EINVAL);
1507         se_nacl_new = usbg_alloc_fabric_acl(se_tpg);
1508         if (!(se_nacl_new))
1509                 return ERR_PTR(-ENOMEM);
1510
1511         nexus_depth = 1;
1512         /*
1513          * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1514          * when converting a NodeACL from demo mode -> explict
1515          */
1516         se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,
1517                                 name, nexus_depth);
1518         if (IS_ERR(se_nacl)) {
1519                 usbg_release_fabric_acl(se_tpg, se_nacl_new);
1520                 return se_nacl;
1521         }
1522         /*
1523          * Locate our struct usbg_nacl and set the FC Nport WWPN
1524          */
1525         nacl = container_of(se_nacl, struct usbg_nacl, se_node_acl);
1526         nacl->iport_wwpn = wwpn;
1527         snprintf(nacl->iport_name, sizeof(nacl->iport_name), "%s", name);
1528         return se_nacl;
1529 }
1530
1531 static void usbg_drop_nodeacl(struct se_node_acl *se_acl)
1532 {
1533         struct usbg_nacl *nacl = container_of(se_acl,
1534                                 struct usbg_nacl, se_node_acl);
1535         core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);
1536         kfree(nacl);
1537 }
1538
1539 struct usbg_tpg *the_only_tpg_I_currently_have;
1540
1541 static struct se_portal_group *usbg_make_tpg(
1542         struct se_wwn *wwn,
1543         struct config_group *group,
1544         const char *name)
1545 {
1546         struct usbg_tport *tport = container_of(wwn, struct usbg_tport,
1547                         tport_wwn);
1548         struct usbg_tpg *tpg;
1549         unsigned long tpgt;
1550         int ret;
1551
1552         if (strstr(name, "tpgt_") != name)
1553                 return ERR_PTR(-EINVAL);
1554         if (kstrtoul(name + 5, 0, &tpgt) || tpgt > UINT_MAX)
1555                 return ERR_PTR(-EINVAL);
1556         if (the_only_tpg_I_currently_have) {
1557                 pr_err("Until the gadget framework can't handle multiple\n");
1558                 pr_err("gadgets, you can't do this here.\n");
1559                 return ERR_PTR(-EBUSY);
1560         }
1561
1562         tpg = kzalloc(sizeof(struct usbg_tpg), GFP_KERNEL);
1563         if (!tpg) {
1564                 printk(KERN_ERR "Unable to allocate struct usbg_tpg");
1565                 return ERR_PTR(-ENOMEM);
1566         }
1567         mutex_init(&tpg->tpg_mutex);
1568         atomic_set(&tpg->tpg_port_count, 0);
1569         tpg->workqueue = alloc_workqueue("tcm_usb_gadget", 0, 1);
1570         if (!tpg->workqueue) {
1571                 kfree(tpg);
1572                 return NULL;
1573         }
1574
1575         tpg->tport = tport;
1576         tpg->tport_tpgt = tpgt;
1577
1578         ret = core_tpg_register(&usbg_fabric_configfs->tf_ops, wwn,
1579                                 &tpg->se_tpg, tpg,
1580                                 TRANSPORT_TPG_TYPE_NORMAL);
1581         if (ret < 0) {
1582                 destroy_workqueue(tpg->workqueue);
1583                 kfree(tpg);
1584                 return NULL;
1585         }
1586         the_only_tpg_I_currently_have = tpg;
1587         return &tpg->se_tpg;
1588 }
1589
1590 static void usbg_drop_tpg(struct se_portal_group *se_tpg)
1591 {
1592         struct usbg_tpg *tpg = container_of(se_tpg,
1593                                 struct usbg_tpg, se_tpg);
1594
1595         core_tpg_deregister(se_tpg);
1596         destroy_workqueue(tpg->workqueue);
1597         kfree(tpg);
1598         the_only_tpg_I_currently_have = NULL;
1599 }
1600
1601 static struct se_wwn *usbg_make_tport(
1602         struct target_fabric_configfs *tf,
1603         struct config_group *group,
1604         const char *name)
1605 {
1606         struct usbg_tport *tport;
1607         const char *wnn_name;
1608         u64 wwpn = 0;
1609
1610         wnn_name = usbg_check_wwn(name);
1611         if (!wnn_name)
1612                 return ERR_PTR(-EINVAL);
1613
1614         tport = kzalloc(sizeof(struct usbg_tport), GFP_KERNEL);
1615         if (!(tport)) {
1616                 printk(KERN_ERR "Unable to allocate struct usbg_tport");
1617                 return ERR_PTR(-ENOMEM);
1618         }
1619         tport->tport_wwpn = wwpn;
1620         snprintf(tport->tport_name, sizeof(tport->tport_name), wnn_name);
1621         return &tport->tport_wwn;
1622 }
1623
1624 static void usbg_drop_tport(struct se_wwn *wwn)
1625 {
1626         struct usbg_tport *tport = container_of(wwn,
1627                                 struct usbg_tport, tport_wwn);
1628         kfree(tport);
1629 }
1630
1631 /*
1632  * If somebody feels like dropping the version property, go ahead.
1633  */
1634 static ssize_t usbg_wwn_show_attr_version(
1635         struct target_fabric_configfs *tf,
1636         char *page)
1637 {
1638         return sprintf(page, "usb-gadget fabric module\n");
1639 }
1640 TF_WWN_ATTR_RO(usbg, version);
1641
1642 static struct configfs_attribute *usbg_wwn_attrs[] = {
1643         &usbg_wwn_version.attr,
1644         NULL,
1645 };
1646
1647 static ssize_t tcm_usbg_tpg_show_enable(
1648                 struct se_portal_group *se_tpg,
1649                 char *page)
1650 {
1651         struct usbg_tpg  *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1652
1653         return snprintf(page, PAGE_SIZE, "%u\n", tpg->gadget_connect);
1654 }
1655
1656 static int usbg_attach(struct usbg_tpg *);
1657 static void usbg_detach(struct usbg_tpg *);
1658
1659 static ssize_t tcm_usbg_tpg_store_enable(
1660                 struct se_portal_group *se_tpg,
1661                 const char *page,
1662                 size_t count)
1663 {
1664         struct usbg_tpg  *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1665         unsigned long op;
1666         ssize_t ret;
1667
1668         ret = kstrtoul(page, 0, &op);
1669         if (ret < 0)
1670                 return -EINVAL;
1671         if (op > 1)
1672                 return -EINVAL;
1673
1674         if (op && tpg->gadget_connect)
1675                 goto out;
1676         if (!op && !tpg->gadget_connect)
1677                 goto out;
1678
1679         if (op) {
1680                 ret = usbg_attach(tpg);
1681                 if (ret)
1682                         goto out;
1683         } else {
1684                 usbg_detach(tpg);
1685         }
1686         tpg->gadget_connect = op;
1687 out:
1688         return count;
1689 }
1690 TF_TPG_BASE_ATTR(tcm_usbg, enable, S_IRUGO | S_IWUSR);
1691
1692 static ssize_t tcm_usbg_tpg_show_nexus(
1693                 struct se_portal_group *se_tpg,
1694                 char *page)
1695 {
1696         struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1697         struct tcm_usbg_nexus *tv_nexus;
1698         ssize_t ret;
1699
1700         mutex_lock(&tpg->tpg_mutex);
1701         tv_nexus = tpg->tpg_nexus;
1702         if (!tv_nexus) {
1703                 ret = -ENODEV;
1704                 goto out;
1705         }
1706         ret = snprintf(page, PAGE_SIZE, "%s\n",
1707                         tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1708 out:
1709         mutex_unlock(&tpg->tpg_mutex);
1710         return ret;
1711 }
1712
1713 static int tcm_usbg_make_nexus(struct usbg_tpg *tpg, char *name)
1714 {
1715         struct se_portal_group *se_tpg;
1716         struct tcm_usbg_nexus *tv_nexus;
1717         int ret;
1718
1719         mutex_lock(&tpg->tpg_mutex);
1720         if (tpg->tpg_nexus) {
1721                 ret = -EEXIST;
1722                 pr_debug("tpg->tpg_nexus already exists\n");
1723                 goto err_unlock;
1724         }
1725         se_tpg = &tpg->se_tpg;
1726
1727         ret = -ENOMEM;
1728         tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1729         if (!tv_nexus) {
1730                 pr_err("Unable to allocate struct tcm_vhost_nexus\n");
1731                 goto err_unlock;
1732         }
1733         tv_nexus->tvn_se_sess = transport_init_session();
1734         if (IS_ERR(tv_nexus->tvn_se_sess))
1735                 goto err_free;
1736
1737         /*
1738          * Since we are running in 'demo mode' this call with generate a
1739          * struct se_node_acl for the tcm_vhost struct se_portal_group with
1740          * the SCSI Initiator port name of the passed configfs group 'name'.
1741          */
1742         tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1743                         se_tpg, name);
1744         if (!tv_nexus->tvn_se_sess->se_node_acl) {
1745                 pr_debug("core_tpg_check_initiator_node_acl() failed"
1746                                 " for %s\n", name);
1747                 goto err_session;
1748         }
1749         /*
1750          * Now register the TCM vHost virtual I_T Nexus as active with the
1751          * call to __transport_register_session()
1752          */
1753         __transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1754                         tv_nexus->tvn_se_sess, tv_nexus);
1755         tpg->tpg_nexus = tv_nexus;
1756         mutex_unlock(&tpg->tpg_mutex);
1757         return 0;
1758
1759 err_session:
1760         transport_free_session(tv_nexus->tvn_se_sess);
1761 err_free:
1762         kfree(tv_nexus);
1763 err_unlock:
1764         mutex_unlock(&tpg->tpg_mutex);
1765         return ret;
1766 }
1767
1768 static int tcm_usbg_drop_nexus(struct usbg_tpg *tpg)
1769 {
1770         struct se_session *se_sess;
1771         struct tcm_usbg_nexus *tv_nexus;
1772         int ret = -ENODEV;
1773
1774         mutex_lock(&tpg->tpg_mutex);
1775         tv_nexus = tpg->tpg_nexus;
1776         if (!tv_nexus)
1777                 goto out;
1778
1779         se_sess = tv_nexus->tvn_se_sess;
1780         if (!se_sess)
1781                 goto out;
1782
1783         if (atomic_read(&tpg->tpg_port_count)) {
1784                 ret = -EPERM;
1785                 pr_err("Unable to remove Host I_T Nexus with"
1786                                 " active TPG port count: %d\n",
1787                                 atomic_read(&tpg->tpg_port_count));
1788                 goto out;
1789         }
1790
1791         pr_debug("Removing I_T Nexus to Initiator Port: %s\n",
1792                         tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1793         /*
1794          * Release the SCSI I_T Nexus to the emulated vHost Target Port
1795          */
1796         transport_deregister_session(tv_nexus->tvn_se_sess);
1797         tpg->tpg_nexus = NULL;
1798
1799         kfree(tv_nexus);
1800 out:
1801         mutex_unlock(&tpg->tpg_mutex);
1802         return 0;
1803 }
1804
1805 static ssize_t tcm_usbg_tpg_store_nexus(
1806                 struct se_portal_group *se_tpg,
1807                 const char *page,
1808                 size_t count)
1809 {
1810         struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1811         unsigned char i_port[USBG_NAMELEN], *ptr;
1812         int ret;
1813
1814         if (!strncmp(page, "NULL", 4)) {
1815                 ret = tcm_usbg_drop_nexus(tpg);
1816                 return (!ret) ? count : ret;
1817         }
1818         if (strlen(page) > USBG_NAMELEN) {
1819                 pr_err("Emulated NAA Sas Address: %s, exceeds"
1820                                 " max: %d\n", page, USBG_NAMELEN);
1821                 return -EINVAL;
1822         }
1823         snprintf(i_port, USBG_NAMELEN, "%s", page);
1824
1825         ptr = strstr(i_port, "naa.");
1826         if (!ptr) {
1827                 pr_err("Missing 'naa.' prefix\n");
1828                 return -EINVAL;
1829         }
1830
1831         if (i_port[strlen(i_port) - 1] == '\n')
1832                 i_port[strlen(i_port) - 1] = '\0';
1833
1834         ret = tcm_usbg_make_nexus(tpg, &i_port[4]);
1835         if (ret < 0)
1836                 return ret;
1837         return count;
1838 }
1839 TF_TPG_BASE_ATTR(tcm_usbg, nexus, S_IRUGO | S_IWUSR);
1840
1841 static struct configfs_attribute *usbg_base_attrs[] = {
1842         &tcm_usbg_tpg_enable.attr,
1843         &tcm_usbg_tpg_nexus.attr,
1844         NULL,
1845 };
1846
1847 static int usbg_port_link(struct se_portal_group *se_tpg, struct se_lun *lun)
1848 {
1849         struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1850
1851         atomic_inc(&tpg->tpg_port_count);
1852         smp_mb__after_atomic_inc();
1853         return 0;
1854 }
1855
1856 static void usbg_port_unlink(struct se_portal_group *se_tpg,
1857                 struct se_lun *se_lun)
1858 {
1859         struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1860
1861         atomic_dec(&tpg->tpg_port_count);
1862         smp_mb__after_atomic_dec();
1863 }
1864
1865 static int usbg_check_stop_free(struct se_cmd *se_cmd)
1866 {
1867         struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1868                         se_cmd);
1869
1870         kref_put(&cmd->ref, usbg_cmd_release);
1871         return 1;
1872 }
1873
1874 static struct target_core_fabric_ops usbg_ops = {
1875         .get_fabric_name                = usbg_get_fabric_name,
1876         .get_fabric_proto_ident         = usbg_get_fabric_proto_ident,
1877         .tpg_get_wwn                    = usbg_get_fabric_wwn,
1878         .tpg_get_tag                    = usbg_get_tag,
1879         .tpg_get_default_depth          = usbg_get_default_depth,
1880         .tpg_get_pr_transport_id        = usbg_get_pr_transport_id,
1881         .tpg_get_pr_transport_id_len    = usbg_get_pr_transport_id_len,
1882         .tpg_parse_pr_out_transport_id  = usbg_parse_pr_out_transport_id,
1883         .tpg_check_demo_mode            = usbg_check_true,
1884         .tpg_check_demo_mode_cache      = usbg_check_false,
1885         .tpg_check_demo_mode_write_protect = usbg_check_false,
1886         .tpg_check_prod_mode_write_protect = usbg_check_false,
1887         .tpg_alloc_fabric_acl           = usbg_alloc_fabric_acl,
1888         .tpg_release_fabric_acl         = usbg_release_fabric_acl,
1889         .tpg_get_inst_index             = usbg_tpg_get_inst_index,
1890         .release_cmd                    = usbg_release_cmd,
1891         .shutdown_session               = usbg_shutdown_session,
1892         .close_session                  = usbg_close_session,
1893         .sess_get_index                 = usbg_sess_get_index,
1894         .sess_get_initiator_sid         = NULL,
1895         .write_pending                  = usbg_send_write_request,
1896         .write_pending_status           = usbg_write_pending_status,
1897         .set_default_node_attributes    = usbg_set_default_node_attrs,
1898         .get_task_tag                   = usbg_get_task_tag,
1899         .get_cmd_state                  = usbg_get_cmd_state,
1900         .queue_data_in                  = usbg_send_read_response,
1901         .queue_status                   = usbg_send_status_response,
1902         .queue_tm_rsp                   = usbg_queue_tm_rsp,
1903         .check_stop_free                = usbg_check_stop_free,
1904
1905         .fabric_make_wwn                = usbg_make_tport,
1906         .fabric_drop_wwn                = usbg_drop_tport,
1907         .fabric_make_tpg                = usbg_make_tpg,
1908         .fabric_drop_tpg                = usbg_drop_tpg,
1909         .fabric_post_link               = usbg_port_link,
1910         .fabric_pre_unlink              = usbg_port_unlink,
1911         .fabric_make_np                 = NULL,
1912         .fabric_drop_np                 = NULL,
1913         .fabric_make_nodeacl            = usbg_make_nodeacl,
1914         .fabric_drop_nodeacl            = usbg_drop_nodeacl,
1915 };
1916
1917 static int usbg_register_configfs(void)
1918 {
1919         struct target_fabric_configfs *fabric;
1920         int ret;
1921
1922         fabric = target_fabric_configfs_init(THIS_MODULE, "usb_gadget");
1923         if (IS_ERR(fabric)) {
1924                 printk(KERN_ERR "target_fabric_configfs_init() failed\n");
1925                 return PTR_ERR(fabric);
1926         }
1927
1928         fabric->tf_ops = usbg_ops;
1929         TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = usbg_wwn_attrs;
1930         TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = usbg_base_attrs;
1931         TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
1932         TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
1933         TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
1934         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_base_cit.ct_attrs = NULL;
1935         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
1936         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
1937         TF_CIT_TMPL(fabric)->tfc_tpg_nacl_param_cit.ct_attrs = NULL;
1938         ret = target_fabric_configfs_register(fabric);
1939         if (ret < 0) {
1940                 printk(KERN_ERR "target_fabric_configfs_register() failed"
1941                                 " for usb-gadget\n");
1942                 return ret;
1943         }
1944         usbg_fabric_configfs = fabric;
1945         return 0;
1946 };
1947
1948 static void usbg_deregister_configfs(void)
1949 {
1950         if (!(usbg_fabric_configfs))
1951                 return;
1952
1953         target_fabric_configfs_deregister(usbg_fabric_configfs);
1954         usbg_fabric_configfs = NULL;
1955 };
1956
1957 /* Start gadget.c code */
1958
1959 static struct usb_interface_descriptor bot_intf_desc = {
1960         .bLength =              sizeof(bot_intf_desc),
1961         .bDescriptorType =      USB_DT_INTERFACE,
1962         .bNumEndpoints =        2,
1963         .bAlternateSetting =    USB_G_ALT_INT_BBB,
1964         .bInterfaceClass =      USB_CLASS_MASS_STORAGE,
1965         .bInterfaceSubClass =   USB_SC_SCSI,
1966         .bInterfaceProtocol =   USB_PR_BULK,
1967         .iInterface =           USB_G_STR_INT_UAS,
1968 };
1969
1970 static struct usb_interface_descriptor uasp_intf_desc = {
1971         .bLength =              sizeof(uasp_intf_desc),
1972         .bDescriptorType =      USB_DT_INTERFACE,
1973         .bNumEndpoints =        4,
1974         .bAlternateSetting =    USB_G_ALT_INT_UAS,
1975         .bInterfaceClass =      USB_CLASS_MASS_STORAGE,
1976         .bInterfaceSubClass =   USB_SC_SCSI,
1977         .bInterfaceProtocol =   USB_PR_UAS,
1978         .iInterface =           USB_G_STR_INT_BBB,
1979 };
1980
1981 static struct usb_endpoint_descriptor uasp_bi_desc = {
1982         .bLength =              USB_DT_ENDPOINT_SIZE,
1983         .bDescriptorType =      USB_DT_ENDPOINT,
1984         .bEndpointAddress =     USB_DIR_IN,
1985         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
1986         .wMaxPacketSize =       cpu_to_le16(512),
1987 };
1988
1989 static struct usb_endpoint_descriptor uasp_fs_bi_desc = {
1990         .bLength =              USB_DT_ENDPOINT_SIZE,
1991         .bDescriptorType =      USB_DT_ENDPOINT,
1992         .bEndpointAddress =     USB_DIR_IN,
1993         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
1994 };
1995
1996 static struct usb_pipe_usage_descriptor uasp_bi_pipe_desc = {
1997         .bLength =              sizeof(uasp_bi_pipe_desc),
1998         .bDescriptorType =      USB_DT_PIPE_USAGE,
1999         .bPipeID =              DATA_IN_PIPE_ID,
2000 };
2001
2002 static struct usb_endpoint_descriptor uasp_ss_bi_desc = {
2003         .bLength =              USB_DT_ENDPOINT_SIZE,
2004         .bDescriptorType =      USB_DT_ENDPOINT,
2005         .bEndpointAddress =     USB_DIR_IN,
2006         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2007         .wMaxPacketSize =       cpu_to_le16(1024),
2008 };
2009
2010 static struct usb_ss_ep_comp_descriptor uasp_bi_ep_comp_desc = {
2011         .bLength =              sizeof(uasp_bi_ep_comp_desc),
2012         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
2013         .bMaxBurst =            0,
2014         .bmAttributes =         UASP_SS_EP_COMP_LOG_STREAMS,
2015         .wBytesPerInterval =    0,
2016 };
2017
2018 static struct usb_ss_ep_comp_descriptor bot_bi_ep_comp_desc = {
2019         .bLength =              sizeof(bot_bi_ep_comp_desc),
2020         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
2021         .bMaxBurst =            0,
2022 };
2023
2024 static struct usb_endpoint_descriptor uasp_bo_desc = {
2025         .bLength =              USB_DT_ENDPOINT_SIZE,
2026         .bDescriptorType =      USB_DT_ENDPOINT,
2027         .bEndpointAddress =     USB_DIR_OUT,
2028         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2029         .wMaxPacketSize =       cpu_to_le16(512),
2030 };
2031
2032 static struct usb_endpoint_descriptor uasp_fs_bo_desc = {
2033         .bLength =              USB_DT_ENDPOINT_SIZE,
2034         .bDescriptorType =      USB_DT_ENDPOINT,
2035         .bEndpointAddress =     USB_DIR_OUT,
2036         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2037 };
2038
2039 static struct usb_pipe_usage_descriptor uasp_bo_pipe_desc = {
2040         .bLength =              sizeof(uasp_bo_pipe_desc),
2041         .bDescriptorType =      USB_DT_PIPE_USAGE,
2042         .bPipeID =              DATA_OUT_PIPE_ID,
2043 };
2044
2045 static struct usb_endpoint_descriptor uasp_ss_bo_desc = {
2046         .bLength =              USB_DT_ENDPOINT_SIZE,
2047         .bDescriptorType =      USB_DT_ENDPOINT,
2048         .bEndpointAddress =     USB_DIR_OUT,
2049         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2050         .wMaxPacketSize =       cpu_to_le16(0x400),
2051 };
2052
2053 static struct usb_ss_ep_comp_descriptor uasp_bo_ep_comp_desc = {
2054         .bLength =              sizeof(uasp_bo_ep_comp_desc),
2055         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
2056         .bmAttributes =         UASP_SS_EP_COMP_LOG_STREAMS,
2057 };
2058
2059 static struct usb_ss_ep_comp_descriptor bot_bo_ep_comp_desc = {
2060         .bLength =              sizeof(bot_bo_ep_comp_desc),
2061         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
2062 };
2063
2064 static struct usb_endpoint_descriptor uasp_status_desc = {
2065         .bLength =              USB_DT_ENDPOINT_SIZE,
2066         .bDescriptorType =      USB_DT_ENDPOINT,
2067         .bEndpointAddress =     USB_DIR_IN,
2068         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2069         .wMaxPacketSize =       cpu_to_le16(512),
2070 };
2071
2072 static struct usb_endpoint_descriptor uasp_fs_status_desc = {
2073         .bLength =              USB_DT_ENDPOINT_SIZE,
2074         .bDescriptorType =      USB_DT_ENDPOINT,
2075         .bEndpointAddress =     USB_DIR_IN,
2076         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2077 };
2078
2079 static struct usb_pipe_usage_descriptor uasp_status_pipe_desc = {
2080         .bLength =              sizeof(uasp_status_pipe_desc),
2081         .bDescriptorType =      USB_DT_PIPE_USAGE,
2082         .bPipeID =              STATUS_PIPE_ID,
2083 };
2084
2085 static struct usb_endpoint_descriptor uasp_ss_status_desc = {
2086         .bLength =              USB_DT_ENDPOINT_SIZE,
2087         .bDescriptorType =      USB_DT_ENDPOINT,
2088         .bEndpointAddress =     USB_DIR_IN,
2089         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2090         .wMaxPacketSize =       cpu_to_le16(1024),
2091 };
2092
2093 static struct usb_ss_ep_comp_descriptor uasp_status_in_ep_comp_desc = {
2094         .bLength =              sizeof(uasp_status_in_ep_comp_desc),
2095         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
2096         .bmAttributes =         UASP_SS_EP_COMP_LOG_STREAMS,
2097 };
2098
2099 static struct usb_endpoint_descriptor uasp_cmd_desc = {
2100         .bLength =              USB_DT_ENDPOINT_SIZE,
2101         .bDescriptorType =      USB_DT_ENDPOINT,
2102         .bEndpointAddress =     USB_DIR_OUT,
2103         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2104         .wMaxPacketSize =       cpu_to_le16(512),
2105 };
2106
2107 static struct usb_endpoint_descriptor uasp_fs_cmd_desc = {
2108         .bLength =              USB_DT_ENDPOINT_SIZE,
2109         .bDescriptorType =      USB_DT_ENDPOINT,
2110         .bEndpointAddress =     USB_DIR_OUT,
2111         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2112 };
2113
2114 static struct usb_pipe_usage_descriptor uasp_cmd_pipe_desc = {
2115         .bLength =              sizeof(uasp_cmd_pipe_desc),
2116         .bDescriptorType =      USB_DT_PIPE_USAGE,
2117         .bPipeID =              CMD_PIPE_ID,
2118 };
2119
2120 static struct usb_endpoint_descriptor uasp_ss_cmd_desc = {
2121         .bLength =              USB_DT_ENDPOINT_SIZE,
2122         .bDescriptorType =      USB_DT_ENDPOINT,
2123         .bEndpointAddress =     USB_DIR_OUT,
2124         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
2125         .wMaxPacketSize =       cpu_to_le16(1024),
2126 };
2127
2128 static struct usb_ss_ep_comp_descriptor uasp_cmd_comp_desc = {
2129         .bLength =              sizeof(uasp_cmd_comp_desc),
2130         .bDescriptorType =      USB_DT_SS_ENDPOINT_COMP,
2131 };
2132
2133 static struct usb_descriptor_header *uasp_fs_function_desc[] = {
2134         (struct usb_descriptor_header *) &bot_intf_desc,
2135         (struct usb_descriptor_header *) &uasp_fs_bi_desc,
2136         (struct usb_descriptor_header *) &uasp_fs_bo_desc,
2137
2138         (struct usb_descriptor_header *) &uasp_intf_desc,
2139         (struct usb_descriptor_header *) &uasp_fs_bi_desc,
2140         (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2141         (struct usb_descriptor_header *) &uasp_fs_bo_desc,
2142         (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2143         (struct usb_descriptor_header *) &uasp_fs_status_desc,
2144         (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2145         (struct usb_descriptor_header *) &uasp_fs_cmd_desc,
2146         (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2147 };
2148
2149 static struct usb_descriptor_header *uasp_hs_function_desc[] = {
2150         (struct usb_descriptor_header *) &bot_intf_desc,
2151         (struct usb_descriptor_header *) &uasp_bi_desc,
2152         (struct usb_descriptor_header *) &uasp_bo_desc,
2153
2154         (struct usb_descriptor_header *) &uasp_intf_desc,
2155         (struct usb_descriptor_header *) &uasp_bi_desc,
2156         (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2157         (struct usb_descriptor_header *) &uasp_bo_desc,
2158         (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2159         (struct usb_descriptor_header *) &uasp_status_desc,
2160         (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2161         (struct usb_descriptor_header *) &uasp_cmd_desc,
2162         (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2163         NULL,
2164 };
2165
2166 static struct usb_descriptor_header *uasp_ss_function_desc[] = {
2167         (struct usb_descriptor_header *) &bot_intf_desc,
2168         (struct usb_descriptor_header *) &uasp_ss_bi_desc,
2169         (struct usb_descriptor_header *) &bot_bi_ep_comp_desc,
2170         (struct usb_descriptor_header *) &uasp_ss_bo_desc,
2171         (struct usb_descriptor_header *) &bot_bo_ep_comp_desc,
2172
2173         (struct usb_descriptor_header *) &uasp_intf_desc,
2174         (struct usb_descriptor_header *) &uasp_ss_bi_desc,
2175         (struct usb_descriptor_header *) &uasp_bi_ep_comp_desc,
2176         (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2177         (struct usb_descriptor_header *) &uasp_ss_bo_desc,
2178         (struct usb_descriptor_header *) &uasp_bo_ep_comp_desc,
2179         (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2180         (struct usb_descriptor_header *) &uasp_ss_status_desc,
2181         (struct usb_descriptor_header *) &uasp_status_in_ep_comp_desc,
2182         (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2183         (struct usb_descriptor_header *) &uasp_ss_cmd_desc,
2184         (struct usb_descriptor_header *) &uasp_cmd_comp_desc,
2185         (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2186         NULL,
2187 };
2188
2189 #define UAS_VENDOR_ID   0x0525  /* NetChip */
2190 #define UAS_PRODUCT_ID  0xa4a5  /* Linux-USB File-backed Storage Gadget */
2191
2192 static struct usb_device_descriptor usbg_device_desc = {
2193         .bLength =              sizeof(usbg_device_desc),
2194         .bDescriptorType =      USB_DT_DEVICE,
2195         .bcdUSB =               cpu_to_le16(0x0200),
2196         .bDeviceClass =         USB_CLASS_PER_INTERFACE,
2197         .idVendor =             cpu_to_le16(UAS_VENDOR_ID),
2198         .idProduct =            cpu_to_le16(UAS_PRODUCT_ID),
2199         .iManufacturer =        USB_G_STR_MANUFACTOR,
2200         .iProduct =             USB_G_STR_PRODUCT,
2201         .iSerialNumber =        USB_G_STR_SERIAL,
2202
2203         .bNumConfigurations =   1,
2204 };
2205
2206 static struct usb_string        usbg_us_strings[] = {
2207         { USB_G_STR_MANUFACTOR, "Target Manufactor"},
2208         { USB_G_STR_PRODUCT,    "Target Product"},
2209         { USB_G_STR_SERIAL,     "000000000001"},
2210         { USB_G_STR_CONFIG,     "default config"},
2211         { USB_G_STR_INT_UAS,    "USB Attached SCSI"},
2212         { USB_G_STR_INT_BBB,    "Bulk Only Transport"},
2213         { },
2214 };
2215
2216 static struct usb_gadget_strings usbg_stringtab = {
2217         .language = 0x0409,
2218         .strings = usbg_us_strings,
2219 };
2220
2221 static struct usb_gadget_strings *usbg_strings[] = {
2222         &usbg_stringtab,
2223         NULL,
2224 };
2225
2226 static int guas_unbind(struct usb_composite_dev *cdev)
2227 {
2228         return 0;
2229 }
2230
2231 static struct usb_configuration usbg_config_driver = {
2232         .label                  = "Linux Target",
2233         .bConfigurationValue    = 1,
2234         .iConfiguration         = USB_G_STR_CONFIG,
2235         .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
2236 };
2237
2238 static void give_back_ep(struct usb_ep **pep)
2239 {
2240         struct usb_ep *ep = *pep;
2241         if (!ep)
2242                 return;
2243         ep->driver_data = NULL;
2244 }
2245
2246 static int usbg_bind(struct usb_configuration *c, struct usb_function *f)
2247 {
2248         struct f_uas            *fu = to_f_uas(f);
2249         struct usb_gadget       *gadget = c->cdev->gadget;
2250         struct usb_ep           *ep;
2251         int                     iface;
2252
2253         iface = usb_interface_id(c, f);
2254         if (iface < 0)
2255                 return iface;
2256
2257         bot_intf_desc.bInterfaceNumber = iface;
2258         uasp_intf_desc.bInterfaceNumber = iface;
2259         fu->iface = iface;
2260         ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bi_desc,
2261                         &uasp_bi_ep_comp_desc);
2262         if (!ep)
2263                 goto ep_fail;
2264
2265         ep->driver_data = fu;
2266         fu->ep_in = ep;
2267
2268         ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bo_desc,
2269                         &uasp_bo_ep_comp_desc);
2270         if (!ep)
2271                 goto ep_fail;
2272         ep->driver_data = fu;
2273         fu->ep_out = ep;
2274
2275         ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_status_desc,
2276                         &uasp_status_in_ep_comp_desc);
2277         if (!ep)
2278                 goto ep_fail;
2279         ep->driver_data = fu;
2280         fu->ep_status = ep;
2281
2282         ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_cmd_desc,
2283                         &uasp_cmd_comp_desc);
2284         if (!ep)
2285                 goto ep_fail;
2286         ep->driver_data = fu;
2287         fu->ep_cmd = ep;
2288
2289         /* Assume endpoint addresses are the same for both speeds */
2290         uasp_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2291         uasp_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2292         uasp_status_desc.bEndpointAddress =
2293                 uasp_ss_status_desc.bEndpointAddress;
2294         uasp_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2295
2296         uasp_fs_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2297         uasp_fs_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2298         uasp_fs_status_desc.bEndpointAddress =
2299                 uasp_ss_status_desc.bEndpointAddress;
2300         uasp_fs_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2301
2302         return 0;
2303 ep_fail:
2304         pr_err("Can't claim all required eps\n");
2305
2306         give_back_ep(&fu->ep_in);
2307         give_back_ep(&fu->ep_out);
2308         give_back_ep(&fu->ep_status);
2309         give_back_ep(&fu->ep_cmd);
2310         return -ENOTSUPP;
2311 }
2312
2313 static void usbg_unbind(struct usb_configuration *c, struct usb_function *f)
2314 {
2315         struct f_uas *fu = to_f_uas(f);
2316
2317         kfree(fu);
2318 }
2319
2320 struct guas_setup_wq {
2321         struct work_struct work;
2322         struct f_uas *fu;
2323         unsigned int alt;
2324 };
2325
2326 static void usbg_delayed_set_alt(struct work_struct *wq)
2327 {
2328         struct guas_setup_wq *work = container_of(wq, struct guas_setup_wq,
2329                         work);
2330         struct f_uas *fu = work->fu;
2331         int alt = work->alt;
2332
2333         kfree(work);
2334
2335         if (fu->flags & USBG_IS_BOT)
2336                 bot_cleanup_old_alt(fu);
2337         if (fu->flags & USBG_IS_UAS)
2338                 uasp_cleanup_old_alt(fu);
2339
2340         if (alt == USB_G_ALT_INT_BBB)
2341                 bot_set_alt(fu);
2342         else if (alt == USB_G_ALT_INT_UAS)
2343                 uasp_set_alt(fu);
2344         usb_composite_setup_continue(fu->function.config->cdev);
2345 }
2346
2347 static int usbg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2348 {
2349         struct f_uas *fu = to_f_uas(f);
2350
2351         if ((alt == USB_G_ALT_INT_BBB) || (alt == USB_G_ALT_INT_UAS)) {
2352                 struct guas_setup_wq *work;
2353
2354                 work = kmalloc(sizeof(*work), GFP_ATOMIC);
2355                 if (!work)
2356                         return -ENOMEM;
2357                 INIT_WORK(&work->work, usbg_delayed_set_alt);
2358                 work->fu = fu;
2359                 work->alt = alt;
2360                 schedule_work(&work->work);
2361                 return USB_GADGET_DELAYED_STATUS;
2362         }
2363         return -EOPNOTSUPP;
2364 }
2365
2366 static void usbg_disable(struct usb_function *f)
2367 {
2368         struct f_uas *fu = to_f_uas(f);
2369
2370         if (fu->flags & USBG_IS_UAS)
2371                 uasp_cleanup_old_alt(fu);
2372         else if (fu->flags & USBG_IS_BOT)
2373                 bot_cleanup_old_alt(fu);
2374         fu->flags = 0;
2375 }
2376
2377 static int usbg_setup(struct usb_function *f,
2378                 const struct usb_ctrlrequest *ctrl)
2379 {
2380         struct f_uas *fu = to_f_uas(f);
2381
2382         if (!(fu->flags & USBG_IS_BOT))
2383                 return -EOPNOTSUPP;
2384
2385         return usbg_bot_setup(f, ctrl);
2386 }
2387
2388 static int usbg_cfg_bind(struct usb_configuration *c)
2389 {
2390         struct f_uas *fu;
2391         int ret;
2392
2393         fu = kzalloc(sizeof(*fu), GFP_KERNEL);
2394         if (!fu)
2395                 return -ENOMEM;
2396         fu->function.name = "Target Function";
2397         fu->function.descriptors = uasp_fs_function_desc;
2398         fu->function.hs_descriptors = uasp_hs_function_desc;
2399         fu->function.ss_descriptors = uasp_ss_function_desc;
2400         fu->function.bind = usbg_bind;
2401         fu->function.unbind = usbg_unbind;
2402         fu->function.set_alt = usbg_set_alt;
2403         fu->function.setup = usbg_setup;
2404         fu->function.disable = usbg_disable;
2405         fu->tpg = the_only_tpg_I_currently_have;
2406
2407         ret = usb_add_function(c, &fu->function);
2408         if (ret)
2409                 goto err;
2410
2411         return 0;
2412 err:
2413         kfree(fu);
2414         return ret;
2415 }
2416
2417 static int usb_target_bind(struct usb_composite_dev *cdev)
2418 {
2419         int ret;
2420
2421         ret = usb_add_config(cdev, &usbg_config_driver,
2422                         usbg_cfg_bind);
2423         return 0;
2424 }
2425
2426 static struct usb_composite_driver usbg_driver = {
2427         .name           = "g_target",
2428         .dev            = &usbg_device_desc,
2429         .strings        = usbg_strings,
2430         .max_speed      = USB_SPEED_SUPER,
2431         .unbind         = guas_unbind,
2432 };
2433
2434 static int usbg_attach(struct usbg_tpg *tpg)
2435 {
2436         return usb_composite_probe(&usbg_driver, usb_target_bind);
2437 }
2438
2439 static void usbg_detach(struct usbg_tpg *tpg)
2440 {
2441         usb_composite_unregister(&usbg_driver);
2442 }
2443
2444 static int __init usb_target_gadget_init(void)
2445 {
2446         int ret;
2447
2448         ret = usbg_register_configfs();
2449         return ret;
2450 }
2451 module_init(usb_target_gadget_init);
2452
2453 static void __exit usb_target_gadget_exit(void)
2454 {
2455         usbg_deregister_configfs();
2456 }
2457 module_exit(usb_target_gadget_exit);
2458
2459 MODULE_AUTHOR("Sebastian Andrzej Siewior <bigeasy@linutronix.de>");
2460 MODULE_DESCRIPTION("usb-gadget fabric");
2461 MODULE_LICENSE("GPL v2");