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