1 // SPDX-License-Identifier: GPL-2.0
2 /* Target based USB-Gadget
4 * UAS protocol handling, target callbacks, configfs handling,
5 * BBB (USB Mass Storage Class Bulk-Only (BBB) and Transport protocol handling.
7 * Author: Sebastian Andrzej Siewior <bigeasy at linutronix dot de>
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_tcq.h>
20 #include <target/target_core_base.h>
21 #include <target/target_core_fabric.h>
22 #include <asm/unaligned.h>
28 #define TPG_INSTANCES 1
31 struct usb_function_instance *func_inst;
35 static struct tpg_instance tpg_instances[TPG_INSTANCES];
37 static DEFINE_MUTEX(tpg_instances_lock);
39 static inline struct f_uas *to_f_uas(struct usb_function *f)
41 return container_of(f, struct f_uas, function);
44 /* Start bot.c code */
46 static int bot_enqueue_cmd_cbw(struct f_uas *fu)
50 if (fu->flags & USBG_BOT_CMD_PEND)
53 ret = usb_ep_queue(fu->ep_out, fu->cmd.req, GFP_ATOMIC);
55 fu->flags |= USBG_BOT_CMD_PEND;
59 static void bot_status_complete(struct usb_ep *ep, struct usb_request *req)
61 struct usbg_cmd *cmd = req->context;
62 struct f_uas *fu = cmd->fu;
64 transport_generic_free_cmd(&cmd->se_cmd, 0);
65 if (req->status < 0) {
66 pr_err("ERR %s(%d)\n", __func__, __LINE__);
70 /* CSW completed, wait for next CBW */
71 bot_enqueue_cmd_cbw(fu);
74 static void bot_enqueue_sense_code(struct f_uas *fu, struct usbg_cmd *cmd)
76 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
78 unsigned int csw_stat;
80 csw_stat = cmd->csw_code;
81 csw->Tag = cmd->bot_tag;
82 csw->Status = csw_stat;
83 fu->bot_status.req->context = cmd;
84 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_ATOMIC);
86 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
89 static void bot_err_compl(struct usb_ep *ep, struct usb_request *req)
91 struct usbg_cmd *cmd = req->context;
92 struct f_uas *fu = cmd->fu;
95 pr_err("ERR %s(%d)\n", __func__, __LINE__);
98 if (cmd->data_len > ep->maxpacket) {
99 req->length = ep->maxpacket;
100 cmd->data_len -= ep->maxpacket;
102 req->length = cmd->data_len;
106 usb_ep_queue(ep, req, GFP_ATOMIC);
109 bot_enqueue_sense_code(fu, cmd);
112 static void bot_send_bad_status(struct usbg_cmd *cmd)
114 struct f_uas *fu = cmd->fu;
115 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
116 struct usb_request *req;
119 csw->Residue = cpu_to_le32(cmd->data_len);
124 req = fu->bot_req_in;
127 req = fu->bot_req_out;
130 if (cmd->data_len > fu->ep_in->maxpacket) {
131 req->length = ep->maxpacket;
132 cmd->data_len -= ep->maxpacket;
134 req->length = cmd->data_len;
137 req->complete = bot_err_compl;
139 req->buf = fu->cmd.buf;
140 usb_ep_queue(ep, req, GFP_KERNEL);
142 bot_enqueue_sense_code(fu, cmd);
146 static int bot_send_status(struct usbg_cmd *cmd, bool moved_data)
148 struct f_uas *fu = cmd->fu;
149 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
152 if (cmd->se_cmd.scsi_status == SAM_STAT_GOOD) {
153 if (!moved_data && cmd->data_len) {
155 * the host wants to move data, we don't. Fill / empty
156 * the pipe and then send the csw with reside set.
158 cmd->csw_code = US_BULK_STAT_OK;
159 bot_send_bad_status(cmd);
163 csw->Tag = cmd->bot_tag;
164 csw->Residue = cpu_to_le32(0);
165 csw->Status = US_BULK_STAT_OK;
166 fu->bot_status.req->context = cmd;
168 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_KERNEL);
170 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
172 cmd->csw_code = US_BULK_STAT_FAIL;
173 bot_send_bad_status(cmd);
179 * Called after command (no data transfer) or after the write (to device)
180 * operation is completed
182 static int bot_send_status_response(struct usbg_cmd *cmd)
184 bool moved_data = false;
188 return bot_send_status(cmd, moved_data);
191 /* Read request completed, now we have to send the CSW */
192 static void bot_read_compl(struct usb_ep *ep, struct usb_request *req)
194 struct usbg_cmd *cmd = req->context;
197 pr_err("ERR %s(%d)\n", __func__, __LINE__);
199 bot_send_status(cmd, true);
202 static int bot_send_read_response(struct usbg_cmd *cmd)
204 struct f_uas *fu = cmd->fu;
205 struct se_cmd *se_cmd = &cmd->se_cmd;
206 struct usb_gadget *gadget = fuas_to_gadget(fu);
209 if (!cmd->data_len) {
210 cmd->csw_code = US_BULK_STAT_PHASE;
211 bot_send_bad_status(cmd);
215 if (!gadget->sg_supported) {
216 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
220 sg_copy_to_buffer(se_cmd->t_data_sg,
221 se_cmd->t_data_nents,
223 se_cmd->data_length);
225 fu->bot_req_in->buf = cmd->data_buf;
227 fu->bot_req_in->buf = NULL;
228 fu->bot_req_in->num_sgs = se_cmd->t_data_nents;
229 fu->bot_req_in->sg = se_cmd->t_data_sg;
232 fu->bot_req_in->complete = bot_read_compl;
233 fu->bot_req_in->length = se_cmd->data_length;
234 fu->bot_req_in->context = cmd;
235 ret = usb_ep_queue(fu->ep_in, fu->bot_req_in, GFP_ATOMIC);
237 pr_err("%s(%d)\n", __func__, __LINE__);
241 static void usbg_data_write_cmpl(struct usb_ep *, struct usb_request *);
242 static int usbg_prepare_w_request(struct usbg_cmd *, struct usb_request *);
244 static int bot_send_write_request(struct usbg_cmd *cmd)
246 struct f_uas *fu = cmd->fu;
247 struct se_cmd *se_cmd = &cmd->se_cmd;
248 struct usb_gadget *gadget = fuas_to_gadget(fu);
251 init_completion(&cmd->write_complete);
254 if (!cmd->data_len) {
255 cmd->csw_code = US_BULK_STAT_PHASE;
259 if (!gadget->sg_supported) {
260 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_KERNEL);
264 fu->bot_req_out->buf = cmd->data_buf;
266 fu->bot_req_out->buf = NULL;
267 fu->bot_req_out->num_sgs = se_cmd->t_data_nents;
268 fu->bot_req_out->sg = se_cmd->t_data_sg;
271 fu->bot_req_out->complete = usbg_data_write_cmpl;
272 fu->bot_req_out->length = se_cmd->data_length;
273 fu->bot_req_out->context = cmd;
275 ret = usbg_prepare_w_request(cmd, fu->bot_req_out);
278 ret = usb_ep_queue(fu->ep_out, fu->bot_req_out, GFP_KERNEL);
280 pr_err("%s(%d)\n", __func__, __LINE__);
282 wait_for_completion(&cmd->write_complete);
283 target_execute_cmd(se_cmd);
288 static int bot_submit_command(struct f_uas *, void *, unsigned int);
290 static void bot_cmd_complete(struct usb_ep *ep, struct usb_request *req)
292 struct f_uas *fu = req->context;
295 fu->flags &= ~USBG_BOT_CMD_PEND;
300 ret = bot_submit_command(fu, req->buf, req->actual);
302 pr_err("%s(%d): %d\n", __func__, __LINE__, ret);
305 static int bot_prepare_reqs(struct f_uas *fu)
309 fu->bot_req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
313 fu->bot_req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
314 if (!fu->bot_req_out)
317 fu->cmd.req = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
321 fu->bot_status.req = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
322 if (!fu->bot_status.req)
325 fu->bot_status.req->buf = &fu->bot_status.csw;
326 fu->bot_status.req->length = US_BULK_CS_WRAP_LEN;
327 fu->bot_status.req->complete = bot_status_complete;
328 fu->bot_status.csw.Signature = cpu_to_le32(US_BULK_CS_SIGN);
330 fu->cmd.buf = kmalloc(fu->ep_out->maxpacket, GFP_KERNEL);
334 fu->cmd.req->complete = bot_cmd_complete;
335 fu->cmd.req->buf = fu->cmd.buf;
336 fu->cmd.req->length = fu->ep_out->maxpacket;
337 fu->cmd.req->context = fu;
339 ret = bot_enqueue_cmd_cbw(fu);
347 usb_ep_free_request(fu->ep_in, fu->bot_status.req);
349 usb_ep_free_request(fu->ep_out, fu->cmd.req);
352 usb_ep_free_request(fu->ep_out, fu->bot_req_out);
353 fu->bot_req_out = NULL;
355 usb_ep_free_request(fu->ep_in, fu->bot_req_in);
356 fu->bot_req_in = NULL;
358 pr_err("BOT: endpoint setup failed\n");
362 static void bot_cleanup_old_alt(struct f_uas *fu)
364 if (!(fu->flags & USBG_ENABLED))
367 usb_ep_disable(fu->ep_in);
368 usb_ep_disable(fu->ep_out);
373 usb_ep_free_request(fu->ep_in, fu->bot_req_in);
374 usb_ep_free_request(fu->ep_out, fu->bot_req_out);
375 usb_ep_free_request(fu->ep_out, fu->cmd.req);
376 usb_ep_free_request(fu->ep_in, fu->bot_status.req);
380 fu->bot_req_in = NULL;
381 fu->bot_req_out = NULL;
383 fu->bot_status.req = NULL;
387 static void bot_set_alt(struct f_uas *fu)
389 struct usb_function *f = &fu->function;
390 struct usb_gadget *gadget = f->config->cdev->gadget;
393 fu->flags = USBG_IS_BOT;
395 config_ep_by_speed(gadget, f, fu->ep_in);
396 ret = usb_ep_enable(fu->ep_in);
400 config_ep_by_speed(gadget, f, fu->ep_out);
401 ret = usb_ep_enable(fu->ep_out);
405 ret = bot_prepare_reqs(fu);
408 fu->flags |= USBG_ENABLED;
409 pr_info("Using the BOT protocol\n");
412 usb_ep_disable(fu->ep_out);
414 usb_ep_disable(fu->ep_in);
416 fu->flags = USBG_IS_BOT;
419 static int usbg_bot_setup(struct usb_function *f,
420 const struct usb_ctrlrequest *ctrl)
422 struct f_uas *fu = to_f_uas(f);
423 struct usb_composite_dev *cdev = f->config->cdev;
424 u16 w_value = le16_to_cpu(ctrl->wValue);
425 u16 w_length = le16_to_cpu(ctrl->wLength);
429 switch (ctrl->bRequest) {
430 case US_BULK_GET_MAX_LUN:
431 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_CLASS |
432 USB_RECIP_INTERFACE))
439 luns = atomic_read(&fu->tpg->tpg_port_count);
441 pr_err("No LUNs configured?\n");
445 * If 4 LUNs are present we return 3 i.e. LUN 0..3 can be
446 * accessed. The upper limit is 0xf
450 pr_info_once("Limiting the number of luns to 16\n");
453 ret_lun = cdev->req->buf;
455 cdev->req->length = 1;
456 return usb_ep_queue(cdev->gadget->ep0, cdev->req, GFP_ATOMIC);
458 case US_BULK_RESET_REQUEST:
459 /* XXX maybe we should remove previous requests for IN + OUT */
460 bot_enqueue_cmd_cbw(fu);
466 /* Start uas.c code */
468 static void uasp_cleanup_one_stream(struct f_uas *fu, struct uas_stream *stream)
470 /* We have either all three allocated or none */
474 usb_ep_free_request(fu->ep_in, stream->req_in);
475 usb_ep_free_request(fu->ep_out, stream->req_out);
476 usb_ep_free_request(fu->ep_status, stream->req_status);
478 stream->req_in = NULL;
479 stream->req_out = NULL;
480 stream->req_status = NULL;
483 static void uasp_free_cmdreq(struct f_uas *fu)
485 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
491 static void uasp_cleanup_old_alt(struct f_uas *fu)
495 if (!(fu->flags & USBG_ENABLED))
498 usb_ep_disable(fu->ep_in);
499 usb_ep_disable(fu->ep_out);
500 usb_ep_disable(fu->ep_status);
501 usb_ep_disable(fu->ep_cmd);
503 for (i = 0; i < UASP_SS_EP_COMP_NUM_STREAMS; i++)
504 uasp_cleanup_one_stream(fu, &fu->stream[i]);
505 uasp_free_cmdreq(fu);
508 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req);
510 static int uasp_prepare_r_request(struct usbg_cmd *cmd)
512 struct se_cmd *se_cmd = &cmd->se_cmd;
513 struct f_uas *fu = cmd->fu;
514 struct usb_gadget *gadget = fuas_to_gadget(fu);
515 struct uas_stream *stream = cmd->stream;
517 if (!gadget->sg_supported) {
518 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
522 sg_copy_to_buffer(se_cmd->t_data_sg,
523 se_cmd->t_data_nents,
525 se_cmd->data_length);
527 stream->req_in->buf = cmd->data_buf;
529 stream->req_in->buf = NULL;
530 stream->req_in->num_sgs = se_cmd->t_data_nents;
531 stream->req_in->sg = se_cmd->t_data_sg;
534 stream->req_in->complete = uasp_status_data_cmpl;
535 stream->req_in->length = se_cmd->data_length;
536 stream->req_in->context = cmd;
538 cmd->state = UASP_SEND_STATUS;
542 static void uasp_prepare_status(struct usbg_cmd *cmd)
544 struct se_cmd *se_cmd = &cmd->se_cmd;
545 struct sense_iu *iu = &cmd->sense_iu;
546 struct uas_stream *stream = cmd->stream;
548 cmd->state = UASP_QUEUE_COMMAND;
549 iu->iu_id = IU_ID_STATUS;
550 iu->tag = cpu_to_be16(cmd->tag);
553 * iu->status_qual = cpu_to_be16(STATUS QUALIFIER SAM-4. Where R U?);
555 iu->len = cpu_to_be16(se_cmd->scsi_sense_length);
556 iu->status = se_cmd->scsi_status;
557 stream->req_status->context = cmd;
558 stream->req_status->length = se_cmd->scsi_sense_length + 16;
559 stream->req_status->buf = iu;
560 stream->req_status->complete = uasp_status_data_cmpl;
563 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req)
565 struct usbg_cmd *cmd = req->context;
566 struct uas_stream *stream = cmd->stream;
567 struct f_uas *fu = cmd->fu;
573 switch (cmd->state) {
575 ret = uasp_prepare_r_request(cmd);
578 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
580 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
583 case UASP_RECEIVE_DATA:
584 ret = usbg_prepare_w_request(cmd, stream->req_out);
587 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
589 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
592 case UASP_SEND_STATUS:
593 uasp_prepare_status(cmd);
594 ret = usb_ep_queue(fu->ep_status, stream->req_status,
597 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
600 case UASP_QUEUE_COMMAND:
601 transport_generic_free_cmd(&cmd->se_cmd, 0);
602 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
611 transport_generic_free_cmd(&cmd->se_cmd, 0);
614 static int uasp_send_status_response(struct usbg_cmd *cmd)
616 struct f_uas *fu = cmd->fu;
617 struct uas_stream *stream = cmd->stream;
618 struct sense_iu *iu = &cmd->sense_iu;
620 iu->tag = cpu_to_be16(cmd->tag);
621 stream->req_status->complete = uasp_status_data_cmpl;
622 stream->req_status->context = cmd;
624 uasp_prepare_status(cmd);
625 return usb_ep_queue(fu->ep_status, stream->req_status, GFP_ATOMIC);
628 static int uasp_send_read_response(struct usbg_cmd *cmd)
630 struct f_uas *fu = cmd->fu;
631 struct uas_stream *stream = cmd->stream;
632 struct sense_iu *iu = &cmd->sense_iu;
637 iu->tag = cpu_to_be16(cmd->tag);
638 if (fu->flags & USBG_USE_STREAMS) {
640 ret = uasp_prepare_r_request(cmd);
643 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
645 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
646 kfree(cmd->data_buf);
647 cmd->data_buf = NULL;
652 iu->iu_id = IU_ID_READ_READY;
653 iu->tag = cpu_to_be16(cmd->tag);
655 stream->req_status->complete = uasp_status_data_cmpl;
656 stream->req_status->context = cmd;
658 cmd->state = UASP_SEND_DATA;
659 stream->req_status->buf = iu;
660 stream->req_status->length = sizeof(struct iu);
662 ret = usb_ep_queue(fu->ep_status, stream->req_status,
665 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
671 static int uasp_send_write_request(struct usbg_cmd *cmd)
673 struct f_uas *fu = cmd->fu;
674 struct se_cmd *se_cmd = &cmd->se_cmd;
675 struct uas_stream *stream = cmd->stream;
676 struct sense_iu *iu = &cmd->sense_iu;
679 init_completion(&cmd->write_complete);
682 iu->tag = cpu_to_be16(cmd->tag);
684 if (fu->flags & USBG_USE_STREAMS) {
686 ret = usbg_prepare_w_request(cmd, stream->req_out);
689 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
691 pr_err("%s(%d)\n", __func__, __LINE__);
695 iu->iu_id = IU_ID_WRITE_READY;
696 iu->tag = cpu_to_be16(cmd->tag);
698 stream->req_status->complete = uasp_status_data_cmpl;
699 stream->req_status->context = cmd;
701 cmd->state = UASP_RECEIVE_DATA;
702 stream->req_status->buf = iu;
703 stream->req_status->length = sizeof(struct iu);
705 ret = usb_ep_queue(fu->ep_status, stream->req_status,
708 pr_err("%s(%d)\n", __func__, __LINE__);
711 wait_for_completion(&cmd->write_complete);
712 target_execute_cmd(se_cmd);
717 static int usbg_submit_command(struct f_uas *, void *, unsigned int);
719 static void uasp_cmd_complete(struct usb_ep *ep, struct usb_request *req)
721 struct f_uas *fu = req->context;
727 ret = usbg_submit_command(fu, req->buf, req->actual);
729 * Once we tune for performance enqueue the command req here again so
730 * we can receive a second command while we processing this one. Pay
731 * attention to properly sync STAUS endpoint with DATA IN + OUT so you
736 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
739 static int uasp_alloc_stream_res(struct f_uas *fu, struct uas_stream *stream)
741 stream->req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
745 stream->req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
746 if (!stream->req_out)
749 stream->req_status = usb_ep_alloc_request(fu->ep_status, GFP_KERNEL);
750 if (!stream->req_status)
756 usb_ep_free_request(fu->ep_out, stream->req_out);
757 stream->req_out = NULL;
759 usb_ep_free_request(fu->ep_in, stream->req_in);
760 stream->req_in = NULL;
765 static int uasp_alloc_cmd(struct f_uas *fu)
767 fu->cmd.req = usb_ep_alloc_request(fu->ep_cmd, GFP_KERNEL);
771 fu->cmd.buf = kmalloc(fu->ep_cmd->maxpacket, GFP_KERNEL);
775 fu->cmd.req->complete = uasp_cmd_complete;
776 fu->cmd.req->buf = fu->cmd.buf;
777 fu->cmd.req->length = fu->ep_cmd->maxpacket;
778 fu->cmd.req->context = fu;
782 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
787 static void uasp_setup_stream_res(struct f_uas *fu, int max_streams)
791 for (i = 0; i < max_streams; i++) {
792 struct uas_stream *s = &fu->stream[i];
794 s->req_in->stream_id = i + 1;
795 s->req_out->stream_id = i + 1;
796 s->req_status->stream_id = i + 1;
800 static int uasp_prepare_reqs(struct f_uas *fu)
806 if (fu->flags & USBG_USE_STREAMS)
807 max_streams = UASP_SS_EP_COMP_NUM_STREAMS;
811 for (i = 0; i < max_streams; i++) {
812 ret = uasp_alloc_stream_res(fu, &fu->stream[i]);
817 ret = uasp_alloc_cmd(fu);
819 goto err_free_stream;
820 uasp_setup_stream_res(fu, max_streams);
822 ret = usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
824 goto err_free_stream;
829 uasp_free_cmdreq(fu);
834 uasp_cleanup_one_stream(fu, &fu->stream[i - 1]);
838 pr_err("UASP: endpoint setup failed\n");
842 static void uasp_set_alt(struct f_uas *fu)
844 struct usb_function *f = &fu->function;
845 struct usb_gadget *gadget = f->config->cdev->gadget;
848 fu->flags = USBG_IS_UAS;
850 if (gadget->speed == USB_SPEED_SUPER)
851 fu->flags |= USBG_USE_STREAMS;
853 config_ep_by_speed(gadget, f, fu->ep_in);
854 ret = usb_ep_enable(fu->ep_in);
858 config_ep_by_speed(gadget, f, fu->ep_out);
859 ret = usb_ep_enable(fu->ep_out);
863 config_ep_by_speed(gadget, f, fu->ep_cmd);
864 ret = usb_ep_enable(fu->ep_cmd);
867 config_ep_by_speed(gadget, f, fu->ep_status);
868 ret = usb_ep_enable(fu->ep_status);
872 ret = uasp_prepare_reqs(fu);
875 fu->flags |= USBG_ENABLED;
877 pr_info("Using the UAS protocol\n");
880 usb_ep_disable(fu->ep_status);
882 usb_ep_disable(fu->ep_cmd);
884 usb_ep_disable(fu->ep_out);
886 usb_ep_disable(fu->ep_in);
891 static int get_cmd_dir(const unsigned char *cdb)
903 case SERVICE_ACTION_IN_16:
905 case PERSISTENT_RESERVE_IN:
906 case SECURITY_PROTOCOL_IN:
907 case ACCESS_CONTROL_IN:
909 case READ_BLOCK_LIMITS:
913 case READ_FORMAT_CAPACITIES:
915 ret = DMA_FROM_DEVICE;
925 case WRITE_VERIFY_12:
926 case PERSISTENT_RESERVE_OUT:
927 case MAINTENANCE_OUT:
928 case SECURITY_PROTOCOL_OUT:
929 case ACCESS_CONTROL_OUT:
932 case ALLOW_MEDIUM_REMOVAL:
933 case TEST_UNIT_READY:
934 case SYNCHRONIZE_CACHE:
941 case WRITE_FILEMARKS:
945 #define CMD_DIR_MSG "target: Unknown data direction for SCSI Opcode 0x%02x\n"
946 pr_warn(CMD_DIR_MSG, cdb[0]);
953 static void usbg_data_write_cmpl(struct usb_ep *ep, struct usb_request *req)
955 struct usbg_cmd *cmd = req->context;
956 struct se_cmd *se_cmd = &cmd->se_cmd;
958 if (req->status < 0) {
959 pr_err("%s() state %d transfer failed\n", __func__, cmd->state);
963 if (req->num_sgs == 0) {
964 sg_copy_from_buffer(se_cmd->t_data_sg,
965 se_cmd->t_data_nents,
967 se_cmd->data_length);
970 complete(&cmd->write_complete);
974 transport_generic_free_cmd(&cmd->se_cmd, 0);
977 static int usbg_prepare_w_request(struct usbg_cmd *cmd, struct usb_request *req)
979 struct se_cmd *se_cmd = &cmd->se_cmd;
980 struct f_uas *fu = cmd->fu;
981 struct usb_gadget *gadget = fuas_to_gadget(fu);
983 if (!gadget->sg_supported) {
984 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
988 req->buf = cmd->data_buf;
991 req->num_sgs = se_cmd->t_data_nents;
992 req->sg = se_cmd->t_data_sg;
995 req->complete = usbg_data_write_cmpl;
996 req->length = se_cmd->data_length;
1001 static int usbg_send_status_response(struct se_cmd *se_cmd)
1003 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1005 struct f_uas *fu = cmd->fu;
1007 if (fu->flags & USBG_IS_BOT)
1008 return bot_send_status_response(cmd);
1010 return uasp_send_status_response(cmd);
1013 static int usbg_send_write_request(struct se_cmd *se_cmd)
1015 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1017 struct f_uas *fu = cmd->fu;
1019 if (fu->flags & USBG_IS_BOT)
1020 return bot_send_write_request(cmd);
1022 return uasp_send_write_request(cmd);
1025 static int usbg_send_read_response(struct se_cmd *se_cmd)
1027 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1029 struct f_uas *fu = cmd->fu;
1031 if (fu->flags & USBG_IS_BOT)
1032 return bot_send_read_response(cmd);
1034 return uasp_send_read_response(cmd);
1037 static void usbg_cmd_work(struct work_struct *work)
1039 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1040 struct se_cmd *se_cmd;
1041 struct tcm_usbg_nexus *tv_nexus;
1042 struct usbg_tpg *tpg;
1043 int dir, flags = (TARGET_SCF_UNKNOWN_SIZE | TARGET_SCF_ACK_KREF);
1045 se_cmd = &cmd->se_cmd;
1047 tv_nexus = tpg->tpg_nexus;
1048 dir = get_cmd_dir(cmd->cmd_buf);
1050 transport_init_se_cmd(se_cmd,
1051 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1052 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1053 cmd->prio_attr, cmd->sense_iu.sense);
1057 if (target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess, cmd->cmd_buf,
1058 cmd->sense_iu.sense, cmd->unpacked_lun, 0,
1059 cmd->prio_attr, dir, flags) < 0)
1065 transport_send_check_condition_and_sense(se_cmd,
1066 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1067 transport_generic_free_cmd(&cmd->se_cmd, 0);
1070 static struct usbg_cmd *usbg_get_cmd(struct f_uas *fu,
1071 struct tcm_usbg_nexus *tv_nexus, u32 scsi_tag)
1073 struct se_session *se_sess = tv_nexus->tvn_se_sess;
1074 struct usbg_cmd *cmd;
1077 tag = sbitmap_queue_get(&se_sess->sess_tag_pool, &cpu);
1079 return ERR_PTR(-ENOMEM);
1081 cmd = &((struct usbg_cmd *)se_sess->sess_cmd_map)[tag];
1082 memset(cmd, 0, sizeof(*cmd));
1083 cmd->se_cmd.map_tag = tag;
1084 cmd->se_cmd.map_cpu = cpu;
1085 cmd->se_cmd.tag = cmd->tag = scsi_tag;
1091 static void usbg_release_cmd(struct se_cmd *);
1093 static int usbg_submit_command(struct f_uas *fu,
1094 void *cmdbuf, unsigned int len)
1096 struct command_iu *cmd_iu = cmdbuf;
1097 struct usbg_cmd *cmd;
1098 struct usbg_tpg *tpg = fu->tpg;
1099 struct tcm_usbg_nexus *tv_nexus;
1103 if (cmd_iu->iu_id != IU_ID_COMMAND) {
1104 pr_err("Unsupported type %d\n", cmd_iu->iu_id);
1108 tv_nexus = tpg->tpg_nexus;
1110 pr_err("Missing nexus, ignoring command\n");
1114 cmd_len = (cmd_iu->len & ~0x3) + 16;
1115 if (cmd_len > USBG_MAX_CMD)
1118 scsi_tag = be16_to_cpup(&cmd_iu->tag);
1119 cmd = usbg_get_cmd(fu, tv_nexus, scsi_tag);
1121 pr_err("usbg_get_cmd failed\n");
1124 memcpy(cmd->cmd_buf, cmd_iu->cdb, cmd_len);
1126 if (fu->flags & USBG_USE_STREAMS) {
1127 if (cmd->tag > UASP_SS_EP_COMP_NUM_STREAMS)
1130 cmd->stream = &fu->stream[0];
1132 cmd->stream = &fu->stream[cmd->tag - 1];
1134 cmd->stream = &fu->stream[0];
1137 switch (cmd_iu->prio_attr & 0x7) {
1139 cmd->prio_attr = TCM_HEAD_TAG;
1141 case UAS_ORDERED_TAG:
1142 cmd->prio_attr = TCM_ORDERED_TAG;
1145 cmd->prio_attr = TCM_ACA_TAG;
1148 pr_debug_once("Unsupported prio_attr: %02x.\n",
1151 case UAS_SIMPLE_TAG:
1152 cmd->prio_attr = TCM_SIMPLE_TAG;
1156 cmd->unpacked_lun = scsilun_to_int(&cmd_iu->lun);
1158 INIT_WORK(&cmd->work, usbg_cmd_work);
1159 queue_work(tpg->workqueue, &cmd->work);
1163 usbg_release_cmd(&cmd->se_cmd);
1167 static void bot_cmd_work(struct work_struct *work)
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;
1175 se_cmd = &cmd->se_cmd;
1177 tv_nexus = tpg->tpg_nexus;
1178 dir = get_cmd_dir(cmd->cmd_buf);
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);
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)
1195 transport_send_check_condition_and_sense(se_cmd,
1196 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1197 transport_generic_free_cmd(&cmd->se_cmd, 0);
1200 static int bot_submit_command(struct f_uas *fu,
1201 void *cmdbuf, unsigned int len)
1203 struct bulk_cb_wrap *cbw = cmdbuf;
1204 struct usbg_cmd *cmd;
1205 struct usbg_tpg *tpg = fu->tpg;
1206 struct tcm_usbg_nexus *tv_nexus;
1209 if (cbw->Signature != cpu_to_le32(US_BULK_CB_SIGN)) {
1210 pr_err("Wrong signature on CBW\n");
1214 pr_err("Wrong length for CBW\n");
1218 cmd_len = cbw->Length;
1219 if (cmd_len < 1 || cmd_len > 16)
1222 tv_nexus = tpg->tpg_nexus;
1224 pr_err("Missing nexus, ignoring command\n");
1228 cmd = usbg_get_cmd(fu, tv_nexus, cbw->Tag);
1230 pr_err("usbg_get_cmd failed\n");
1233 memcpy(cmd->cmd_buf, cbw->CDB, cmd_len);
1235 cmd->bot_tag = cbw->Tag;
1236 cmd->prio_attr = TCM_SIMPLE_TAG;
1237 cmd->unpacked_lun = cbw->Lun;
1238 cmd->is_read = cbw->Flags & US_BULK_FLAG_IN ? 1 : 0;
1239 cmd->data_len = le32_to_cpu(cbw->DataTransferLength);
1240 cmd->se_cmd.tag = le32_to_cpu(cmd->bot_tag);
1242 INIT_WORK(&cmd->work, bot_cmd_work);
1243 queue_work(tpg->workqueue, &cmd->work);
1248 /* Start fabric.c code */
1250 static int usbg_check_true(struct se_portal_group *se_tpg)
1255 static int usbg_check_false(struct se_portal_group *se_tpg)
1260 static char *usbg_get_fabric_name(void)
1262 return "usb_gadget";
1265 static char *usbg_get_fabric_wwn(struct se_portal_group *se_tpg)
1267 struct usbg_tpg *tpg = container_of(se_tpg,
1268 struct usbg_tpg, se_tpg);
1269 struct usbg_tport *tport = tpg->tport;
1271 return &tport->tport_name[0];
1274 static u16 usbg_get_tag(struct se_portal_group *se_tpg)
1276 struct usbg_tpg *tpg = container_of(se_tpg,
1277 struct usbg_tpg, se_tpg);
1278 return tpg->tport_tpgt;
1281 static u32 usbg_tpg_get_inst_index(struct se_portal_group *se_tpg)
1286 static void usbg_release_cmd(struct se_cmd *se_cmd)
1288 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1290 struct se_session *se_sess = se_cmd->se_sess;
1292 kfree(cmd->data_buf);
1293 target_free_tag(se_sess, se_cmd);
1296 static u32 usbg_sess_get_index(struct se_session *se_sess)
1302 * XXX Error recovery: return != 0 if we expect writes. Dunno when that could be
1304 static int usbg_write_pending_status(struct se_cmd *se_cmd)
1309 static void usbg_set_default_node_attrs(struct se_node_acl *nacl)
1313 static int usbg_get_cmd_state(struct se_cmd *se_cmd)
1318 static void usbg_queue_tm_rsp(struct se_cmd *se_cmd)
1322 static void usbg_aborted_task(struct se_cmd *se_cmd)
1326 static const char *usbg_check_wwn(const char *name)
1331 n = strstr(name, "naa.");
1336 if (len == 0 || len > USBG_NAMELEN - 1)
1341 static int usbg_init_nodeacl(struct se_node_acl *se_nacl, const char *name)
1343 if (!usbg_check_wwn(name))
1348 static struct se_portal_group *usbg_make_tpg(struct se_wwn *wwn,
1351 struct usbg_tport *tport = container_of(wwn, struct usbg_tport,
1353 struct usbg_tpg *tpg;
1356 struct f_tcm_opts *opts;
1359 if (strstr(name, "tpgt_") != name)
1360 return ERR_PTR(-EINVAL);
1361 if (kstrtoul(name + 5, 0, &tpgt) || tpgt > UINT_MAX)
1362 return ERR_PTR(-EINVAL);
1364 mutex_lock(&tpg_instances_lock);
1365 for (i = 0; i < TPG_INSTANCES; ++i)
1366 if (tpg_instances[i].func_inst && !tpg_instances[i].tpg)
1368 if (i == TPG_INSTANCES)
1371 opts = container_of(tpg_instances[i].func_inst, struct f_tcm_opts,
1373 mutex_lock(&opts->dep_lock);
1377 if (opts->has_dep) {
1378 if (!try_module_get(opts->dependent))
1381 ret = configfs_depend_item_unlocked(
1382 wwn->wwn_group.cg_subsys,
1383 &opts->func_inst.group.cg_item);
1388 tpg = kzalloc(sizeof(struct usbg_tpg), GFP_KERNEL);
1392 mutex_init(&tpg->tpg_mutex);
1393 atomic_set(&tpg->tpg_port_count, 0);
1394 tpg->workqueue = alloc_workqueue("tcm_usb_gadget", 0, 1);
1395 if (!tpg->workqueue)
1399 tpg->tport_tpgt = tpgt;
1402 * SPC doesn't assign a protocol identifier for USB-SCSI, so we
1403 * pretend to be SAS..
1405 ret = core_tpg_register(wwn, &tpg->se_tpg, SCSI_PROTOCOL_SAS);
1407 goto free_workqueue;
1409 tpg_instances[i].tpg = tpg;
1410 tpg->fi = tpg_instances[i].func_inst;
1411 mutex_unlock(&opts->dep_lock);
1412 mutex_unlock(&tpg_instances_lock);
1413 return &tpg->se_tpg;
1416 destroy_workqueue(tpg->workqueue);
1421 module_put(opts->dependent);
1423 configfs_undepend_item_unlocked(&opts->func_inst.group.cg_item);
1425 mutex_unlock(&opts->dep_lock);
1427 mutex_unlock(&tpg_instances_lock);
1429 return ERR_PTR(ret);
1432 static int tcm_usbg_drop_nexus(struct usbg_tpg *);
1434 static void usbg_drop_tpg(struct se_portal_group *se_tpg)
1436 struct usbg_tpg *tpg = container_of(se_tpg,
1437 struct usbg_tpg, se_tpg);
1439 struct f_tcm_opts *opts;
1441 tcm_usbg_drop_nexus(tpg);
1442 core_tpg_deregister(se_tpg);
1443 destroy_workqueue(tpg->workqueue);
1445 mutex_lock(&tpg_instances_lock);
1446 for (i = 0; i < TPG_INSTANCES; ++i)
1447 if (tpg_instances[i].tpg == tpg)
1449 if (i < TPG_INSTANCES) {
1450 tpg_instances[i].tpg = NULL;
1451 opts = container_of(tpg_instances[i].func_inst,
1452 struct f_tcm_opts, func_inst);
1453 mutex_lock(&opts->dep_lock);
1455 module_put(opts->dependent);
1457 configfs_undepend_item_unlocked(
1458 &opts->func_inst.group.cg_item);
1459 mutex_unlock(&opts->dep_lock);
1461 mutex_unlock(&tpg_instances_lock);
1466 static struct se_wwn *usbg_make_tport(
1467 struct target_fabric_configfs *tf,
1468 struct config_group *group,
1471 struct usbg_tport *tport;
1472 const char *wnn_name;
1475 wnn_name = usbg_check_wwn(name);
1477 return ERR_PTR(-EINVAL);
1479 tport = kzalloc(sizeof(struct usbg_tport), GFP_KERNEL);
1481 return ERR_PTR(-ENOMEM);
1483 tport->tport_wwpn = wwpn;
1484 snprintf(tport->tport_name, sizeof(tport->tport_name), "%s", wnn_name);
1485 return &tport->tport_wwn;
1488 static void usbg_drop_tport(struct se_wwn *wwn)
1490 struct usbg_tport *tport = container_of(wwn,
1491 struct usbg_tport, tport_wwn);
1496 * If somebody feels like dropping the version property, go ahead.
1498 static ssize_t usbg_wwn_version_show(struct config_item *item, char *page)
1500 return sprintf(page, "usb-gadget fabric module\n");
1503 CONFIGFS_ATTR_RO(usbg_wwn_, version);
1505 static struct configfs_attribute *usbg_wwn_attrs[] = {
1506 &usbg_wwn_attr_version,
1510 static ssize_t tcm_usbg_tpg_enable_show(struct config_item *item, char *page)
1512 struct se_portal_group *se_tpg = to_tpg(item);
1513 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1515 return snprintf(page, PAGE_SIZE, "%u\n", tpg->gadget_connect);
1518 static int usbg_attach(struct usbg_tpg *);
1519 static void usbg_detach(struct usbg_tpg *);
1521 static ssize_t tcm_usbg_tpg_enable_store(struct config_item *item,
1522 const char *page, size_t count)
1524 struct se_portal_group *se_tpg = to_tpg(item);
1525 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1529 ret = strtobool(page, &op);
1533 if ((op && tpg->gadget_connect) || (!op && !tpg->gadget_connect))
1537 ret = usbg_attach(tpg);
1543 tpg->gadget_connect = op;
1548 static ssize_t tcm_usbg_tpg_nexus_show(struct config_item *item, char *page)
1550 struct se_portal_group *se_tpg = to_tpg(item);
1551 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1552 struct tcm_usbg_nexus *tv_nexus;
1555 mutex_lock(&tpg->tpg_mutex);
1556 tv_nexus = tpg->tpg_nexus;
1561 ret = snprintf(page, PAGE_SIZE, "%s\n",
1562 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1564 mutex_unlock(&tpg->tpg_mutex);
1568 static int usbg_alloc_sess_cb(struct se_portal_group *se_tpg,
1569 struct se_session *se_sess, void *p)
1571 struct usbg_tpg *tpg = container_of(se_tpg,
1572 struct usbg_tpg, se_tpg);
1578 static int tcm_usbg_make_nexus(struct usbg_tpg *tpg, char *name)
1580 struct tcm_usbg_nexus *tv_nexus;
1583 mutex_lock(&tpg->tpg_mutex);
1584 if (tpg->tpg_nexus) {
1586 pr_debug("tpg->tpg_nexus already exists\n");
1590 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1596 tv_nexus->tvn_se_sess = target_setup_session(&tpg->se_tpg,
1597 USB_G_DEFAULT_SESSION_TAGS,
1598 sizeof(struct usbg_cmd),
1599 TARGET_PROT_NORMAL, name,
1600 tv_nexus, usbg_alloc_sess_cb);
1601 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1602 #define MAKE_NEXUS_MSG "core_tpg_check_initiator_node_acl() failed for %s\n"
1603 pr_debug(MAKE_NEXUS_MSG, name);
1604 #undef MAKE_NEXUS_MSG
1605 ret = PTR_ERR(tv_nexus->tvn_se_sess);
1610 mutex_unlock(&tpg->tpg_mutex);
1614 static int tcm_usbg_drop_nexus(struct usbg_tpg *tpg)
1616 struct se_session *se_sess;
1617 struct tcm_usbg_nexus *tv_nexus;
1620 mutex_lock(&tpg->tpg_mutex);
1621 tv_nexus = tpg->tpg_nexus;
1625 se_sess = tv_nexus->tvn_se_sess;
1629 if (atomic_read(&tpg->tpg_port_count)) {
1631 #define MSG "Unable to remove Host I_T Nexus with active TPG port count: %d\n"
1632 pr_err(MSG, atomic_read(&tpg->tpg_port_count));
1637 pr_debug("Removing I_T Nexus to Initiator Port: %s\n",
1638 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1640 * Release the SCSI I_T Nexus to the emulated vHost Target Port
1642 target_remove_session(se_sess);
1643 tpg->tpg_nexus = NULL;
1648 mutex_unlock(&tpg->tpg_mutex);
1652 static ssize_t tcm_usbg_tpg_nexus_store(struct config_item *item,
1653 const char *page, size_t count)
1655 struct se_portal_group *se_tpg = to_tpg(item);
1656 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1657 unsigned char i_port[USBG_NAMELEN], *ptr;
1660 if (!strncmp(page, "NULL", 4)) {
1661 ret = tcm_usbg_drop_nexus(tpg);
1662 return (!ret) ? count : ret;
1664 if (strlen(page) >= USBG_NAMELEN) {
1666 #define NEXUS_STORE_MSG "Emulated NAA Sas Address: %s, exceeds max: %d\n"
1667 pr_err(NEXUS_STORE_MSG, page, USBG_NAMELEN);
1668 #undef NEXUS_STORE_MSG
1671 snprintf(i_port, USBG_NAMELEN, "%s", page);
1673 ptr = strstr(i_port, "naa.");
1675 pr_err("Missing 'naa.' prefix\n");
1679 if (i_port[strlen(i_port) - 1] == '\n')
1680 i_port[strlen(i_port) - 1] = '\0';
1682 ret = tcm_usbg_make_nexus(tpg, &i_port[0]);
1688 CONFIGFS_ATTR(tcm_usbg_tpg_, enable);
1689 CONFIGFS_ATTR(tcm_usbg_tpg_, nexus);
1691 static struct configfs_attribute *usbg_base_attrs[] = {
1692 &tcm_usbg_tpg_attr_enable,
1693 &tcm_usbg_tpg_attr_nexus,
1697 static int usbg_port_link(struct se_portal_group *se_tpg, struct se_lun *lun)
1699 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1701 atomic_inc(&tpg->tpg_port_count);
1702 smp_mb__after_atomic();
1706 static void usbg_port_unlink(struct se_portal_group *se_tpg,
1707 struct se_lun *se_lun)
1709 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1711 atomic_dec(&tpg->tpg_port_count);
1712 smp_mb__after_atomic();
1715 static int usbg_check_stop_free(struct se_cmd *se_cmd)
1717 return target_put_sess_cmd(se_cmd);
1720 static const struct target_core_fabric_ops usbg_ops = {
1721 .module = THIS_MODULE,
1722 .name = "usb_gadget",
1723 .get_fabric_name = usbg_get_fabric_name,
1724 .tpg_get_wwn = usbg_get_fabric_wwn,
1725 .tpg_get_tag = usbg_get_tag,
1726 .tpg_check_demo_mode = usbg_check_true,
1727 .tpg_check_demo_mode_cache = usbg_check_false,
1728 .tpg_check_demo_mode_write_protect = usbg_check_false,
1729 .tpg_check_prod_mode_write_protect = usbg_check_false,
1730 .tpg_get_inst_index = usbg_tpg_get_inst_index,
1731 .release_cmd = usbg_release_cmd,
1732 .sess_get_index = usbg_sess_get_index,
1733 .sess_get_initiator_sid = NULL,
1734 .write_pending = usbg_send_write_request,
1735 .write_pending_status = usbg_write_pending_status,
1736 .set_default_node_attributes = usbg_set_default_node_attrs,
1737 .get_cmd_state = usbg_get_cmd_state,
1738 .queue_data_in = usbg_send_read_response,
1739 .queue_status = usbg_send_status_response,
1740 .queue_tm_rsp = usbg_queue_tm_rsp,
1741 .aborted_task = usbg_aborted_task,
1742 .check_stop_free = usbg_check_stop_free,
1744 .fabric_make_wwn = usbg_make_tport,
1745 .fabric_drop_wwn = usbg_drop_tport,
1746 .fabric_make_tpg = usbg_make_tpg,
1747 .fabric_drop_tpg = usbg_drop_tpg,
1748 .fabric_post_link = usbg_port_link,
1749 .fabric_pre_unlink = usbg_port_unlink,
1750 .fabric_init_nodeacl = usbg_init_nodeacl,
1752 .tfc_wwn_attrs = usbg_wwn_attrs,
1753 .tfc_tpg_base_attrs = usbg_base_attrs,
1756 /* Start gadget.c code */
1758 static struct usb_interface_descriptor bot_intf_desc = {
1759 .bLength = sizeof(bot_intf_desc),
1760 .bDescriptorType = USB_DT_INTERFACE,
1762 .bAlternateSetting = USB_G_ALT_INT_BBB,
1763 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1764 .bInterfaceSubClass = USB_SC_SCSI,
1765 .bInterfaceProtocol = USB_PR_BULK,
1768 static struct usb_interface_descriptor uasp_intf_desc = {
1769 .bLength = sizeof(uasp_intf_desc),
1770 .bDescriptorType = USB_DT_INTERFACE,
1772 .bAlternateSetting = USB_G_ALT_INT_UAS,
1773 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1774 .bInterfaceSubClass = USB_SC_SCSI,
1775 .bInterfaceProtocol = USB_PR_UAS,
1778 static struct usb_endpoint_descriptor uasp_bi_desc = {
1779 .bLength = USB_DT_ENDPOINT_SIZE,
1780 .bDescriptorType = USB_DT_ENDPOINT,
1781 .bEndpointAddress = USB_DIR_IN,
1782 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1783 .wMaxPacketSize = cpu_to_le16(512),
1786 static struct usb_endpoint_descriptor uasp_fs_bi_desc = {
1787 .bLength = USB_DT_ENDPOINT_SIZE,
1788 .bDescriptorType = USB_DT_ENDPOINT,
1789 .bEndpointAddress = USB_DIR_IN,
1790 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1793 static struct usb_pipe_usage_descriptor uasp_bi_pipe_desc = {
1794 .bLength = sizeof(uasp_bi_pipe_desc),
1795 .bDescriptorType = USB_DT_PIPE_USAGE,
1796 .bPipeID = DATA_IN_PIPE_ID,
1799 static struct usb_endpoint_descriptor uasp_ss_bi_desc = {
1800 .bLength = USB_DT_ENDPOINT_SIZE,
1801 .bDescriptorType = USB_DT_ENDPOINT,
1802 .bEndpointAddress = USB_DIR_IN,
1803 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1804 .wMaxPacketSize = cpu_to_le16(1024),
1807 static struct usb_ss_ep_comp_descriptor uasp_bi_ep_comp_desc = {
1808 .bLength = sizeof(uasp_bi_ep_comp_desc),
1809 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1811 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1812 .wBytesPerInterval = 0,
1815 static struct usb_ss_ep_comp_descriptor bot_bi_ep_comp_desc = {
1816 .bLength = sizeof(bot_bi_ep_comp_desc),
1817 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1821 static struct usb_endpoint_descriptor uasp_bo_desc = {
1822 .bLength = USB_DT_ENDPOINT_SIZE,
1823 .bDescriptorType = USB_DT_ENDPOINT,
1824 .bEndpointAddress = USB_DIR_OUT,
1825 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1826 .wMaxPacketSize = cpu_to_le16(512),
1829 static struct usb_endpoint_descriptor uasp_fs_bo_desc = {
1830 .bLength = USB_DT_ENDPOINT_SIZE,
1831 .bDescriptorType = USB_DT_ENDPOINT,
1832 .bEndpointAddress = USB_DIR_OUT,
1833 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1836 static struct usb_pipe_usage_descriptor uasp_bo_pipe_desc = {
1837 .bLength = sizeof(uasp_bo_pipe_desc),
1838 .bDescriptorType = USB_DT_PIPE_USAGE,
1839 .bPipeID = DATA_OUT_PIPE_ID,
1842 static struct usb_endpoint_descriptor uasp_ss_bo_desc = {
1843 .bLength = USB_DT_ENDPOINT_SIZE,
1844 .bDescriptorType = USB_DT_ENDPOINT,
1845 .bEndpointAddress = USB_DIR_OUT,
1846 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1847 .wMaxPacketSize = cpu_to_le16(0x400),
1850 static struct usb_ss_ep_comp_descriptor uasp_bo_ep_comp_desc = {
1851 .bLength = sizeof(uasp_bo_ep_comp_desc),
1852 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1853 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1856 static struct usb_ss_ep_comp_descriptor bot_bo_ep_comp_desc = {
1857 .bLength = sizeof(bot_bo_ep_comp_desc),
1858 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1861 static struct usb_endpoint_descriptor uasp_status_desc = {
1862 .bLength = USB_DT_ENDPOINT_SIZE,
1863 .bDescriptorType = USB_DT_ENDPOINT,
1864 .bEndpointAddress = USB_DIR_IN,
1865 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1866 .wMaxPacketSize = cpu_to_le16(512),
1869 static struct usb_endpoint_descriptor uasp_fs_status_desc = {
1870 .bLength = USB_DT_ENDPOINT_SIZE,
1871 .bDescriptorType = USB_DT_ENDPOINT,
1872 .bEndpointAddress = USB_DIR_IN,
1873 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1876 static struct usb_pipe_usage_descriptor uasp_status_pipe_desc = {
1877 .bLength = sizeof(uasp_status_pipe_desc),
1878 .bDescriptorType = USB_DT_PIPE_USAGE,
1879 .bPipeID = STATUS_PIPE_ID,
1882 static struct usb_endpoint_descriptor uasp_ss_status_desc = {
1883 .bLength = USB_DT_ENDPOINT_SIZE,
1884 .bDescriptorType = USB_DT_ENDPOINT,
1885 .bEndpointAddress = USB_DIR_IN,
1886 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1887 .wMaxPacketSize = cpu_to_le16(1024),
1890 static struct usb_ss_ep_comp_descriptor uasp_status_in_ep_comp_desc = {
1891 .bLength = sizeof(uasp_status_in_ep_comp_desc),
1892 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1893 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1896 static struct usb_endpoint_descriptor uasp_cmd_desc = {
1897 .bLength = USB_DT_ENDPOINT_SIZE,
1898 .bDescriptorType = USB_DT_ENDPOINT,
1899 .bEndpointAddress = USB_DIR_OUT,
1900 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1901 .wMaxPacketSize = cpu_to_le16(512),
1904 static struct usb_endpoint_descriptor uasp_fs_cmd_desc = {
1905 .bLength = USB_DT_ENDPOINT_SIZE,
1906 .bDescriptorType = USB_DT_ENDPOINT,
1907 .bEndpointAddress = USB_DIR_OUT,
1908 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1911 static struct usb_pipe_usage_descriptor uasp_cmd_pipe_desc = {
1912 .bLength = sizeof(uasp_cmd_pipe_desc),
1913 .bDescriptorType = USB_DT_PIPE_USAGE,
1914 .bPipeID = CMD_PIPE_ID,
1917 static struct usb_endpoint_descriptor uasp_ss_cmd_desc = {
1918 .bLength = USB_DT_ENDPOINT_SIZE,
1919 .bDescriptorType = USB_DT_ENDPOINT,
1920 .bEndpointAddress = USB_DIR_OUT,
1921 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1922 .wMaxPacketSize = cpu_to_le16(1024),
1925 static struct usb_ss_ep_comp_descriptor uasp_cmd_comp_desc = {
1926 .bLength = sizeof(uasp_cmd_comp_desc),
1927 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1930 static struct usb_descriptor_header *uasp_fs_function_desc[] = {
1931 (struct usb_descriptor_header *) &bot_intf_desc,
1932 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
1933 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
1935 (struct usb_descriptor_header *) &uasp_intf_desc,
1936 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
1937 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
1938 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
1939 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
1940 (struct usb_descriptor_header *) &uasp_fs_status_desc,
1941 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
1942 (struct usb_descriptor_header *) &uasp_fs_cmd_desc,
1943 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
1947 static struct usb_descriptor_header *uasp_hs_function_desc[] = {
1948 (struct usb_descriptor_header *) &bot_intf_desc,
1949 (struct usb_descriptor_header *) &uasp_bi_desc,
1950 (struct usb_descriptor_header *) &uasp_bo_desc,
1952 (struct usb_descriptor_header *) &uasp_intf_desc,
1953 (struct usb_descriptor_header *) &uasp_bi_desc,
1954 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
1955 (struct usb_descriptor_header *) &uasp_bo_desc,
1956 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
1957 (struct usb_descriptor_header *) &uasp_status_desc,
1958 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
1959 (struct usb_descriptor_header *) &uasp_cmd_desc,
1960 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
1964 static struct usb_descriptor_header *uasp_ss_function_desc[] = {
1965 (struct usb_descriptor_header *) &bot_intf_desc,
1966 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
1967 (struct usb_descriptor_header *) &bot_bi_ep_comp_desc,
1968 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
1969 (struct usb_descriptor_header *) &bot_bo_ep_comp_desc,
1971 (struct usb_descriptor_header *) &uasp_intf_desc,
1972 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
1973 (struct usb_descriptor_header *) &uasp_bi_ep_comp_desc,
1974 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
1975 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
1976 (struct usb_descriptor_header *) &uasp_bo_ep_comp_desc,
1977 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
1978 (struct usb_descriptor_header *) &uasp_ss_status_desc,
1979 (struct usb_descriptor_header *) &uasp_status_in_ep_comp_desc,
1980 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
1981 (struct usb_descriptor_header *) &uasp_ss_cmd_desc,
1982 (struct usb_descriptor_header *) &uasp_cmd_comp_desc,
1983 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
1987 static struct usb_string tcm_us_strings[] = {
1988 [USB_G_STR_INT_UAS].s = "USB Attached SCSI",
1989 [USB_G_STR_INT_BBB].s = "Bulk Only Transport",
1993 static struct usb_gadget_strings tcm_stringtab = {
1995 .strings = tcm_us_strings,
1998 static struct usb_gadget_strings *tcm_strings[] = {
2003 static int tcm_bind(struct usb_configuration *c, struct usb_function *f)
2005 struct f_uas *fu = to_f_uas(f);
2006 struct usb_string *us;
2007 struct usb_gadget *gadget = c->cdev->gadget;
2009 struct f_tcm_opts *opts;
2013 opts = container_of(f->fi, struct f_tcm_opts, func_inst);
2015 mutex_lock(&opts->dep_lock);
2016 if (!opts->can_attach) {
2017 mutex_unlock(&opts->dep_lock);
2020 mutex_unlock(&opts->dep_lock);
2021 us = usb_gstrings_attach(c->cdev, tcm_strings,
2022 ARRAY_SIZE(tcm_us_strings));
2025 bot_intf_desc.iInterface = us[USB_G_STR_INT_BBB].id;
2026 uasp_intf_desc.iInterface = us[USB_G_STR_INT_UAS].id;
2028 iface = usb_interface_id(c, f);
2032 bot_intf_desc.bInterfaceNumber = iface;
2033 uasp_intf_desc.bInterfaceNumber = iface;
2035 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bi_desc,
2036 &uasp_bi_ep_comp_desc);
2042 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bo_desc,
2043 &uasp_bo_ep_comp_desc);
2048 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_status_desc,
2049 &uasp_status_in_ep_comp_desc);
2054 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_cmd_desc,
2055 &uasp_cmd_comp_desc);
2060 /* Assume endpoint addresses are the same for both speeds */
2061 uasp_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2062 uasp_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2063 uasp_status_desc.bEndpointAddress =
2064 uasp_ss_status_desc.bEndpointAddress;
2065 uasp_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2067 uasp_fs_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2068 uasp_fs_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2069 uasp_fs_status_desc.bEndpointAddress =
2070 uasp_ss_status_desc.bEndpointAddress;
2071 uasp_fs_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2073 ret = usb_assign_descriptors(f, uasp_fs_function_desc,
2074 uasp_hs_function_desc, uasp_ss_function_desc,
2075 uasp_ss_function_desc);
2081 pr_err("Can't claim all required eps\n");
2086 struct guas_setup_wq {
2087 struct work_struct work;
2092 static void tcm_delayed_set_alt(struct work_struct *wq)
2094 struct guas_setup_wq *work = container_of(wq, struct guas_setup_wq,
2096 struct f_uas *fu = work->fu;
2097 int alt = work->alt;
2101 if (fu->flags & USBG_IS_BOT)
2102 bot_cleanup_old_alt(fu);
2103 if (fu->flags & USBG_IS_UAS)
2104 uasp_cleanup_old_alt(fu);
2106 if (alt == USB_G_ALT_INT_BBB)
2108 else if (alt == USB_G_ALT_INT_UAS)
2110 usb_composite_setup_continue(fu->function.config->cdev);
2113 static int tcm_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2115 struct f_uas *fu = to_f_uas(f);
2117 if ((alt == USB_G_ALT_INT_BBB) || (alt == USB_G_ALT_INT_UAS)) {
2118 struct guas_setup_wq *work;
2120 work = kmalloc(sizeof(*work), GFP_ATOMIC);
2123 INIT_WORK(&work->work, tcm_delayed_set_alt);
2126 schedule_work(&work->work);
2127 return USB_GADGET_DELAYED_STATUS;
2132 static void tcm_disable(struct usb_function *f)
2134 struct f_uas *fu = to_f_uas(f);
2136 if (fu->flags & USBG_IS_UAS)
2137 uasp_cleanup_old_alt(fu);
2138 else if (fu->flags & USBG_IS_BOT)
2139 bot_cleanup_old_alt(fu);
2143 static int tcm_setup(struct usb_function *f,
2144 const struct usb_ctrlrequest *ctrl)
2146 struct f_uas *fu = to_f_uas(f);
2148 if (!(fu->flags & USBG_IS_BOT))
2151 return usbg_bot_setup(f, ctrl);
2154 static inline struct f_tcm_opts *to_f_tcm_opts(struct config_item *item)
2156 return container_of(to_config_group(item), struct f_tcm_opts,
2160 static void tcm_attr_release(struct config_item *item)
2162 struct f_tcm_opts *opts = to_f_tcm_opts(item);
2164 usb_put_function_instance(&opts->func_inst);
2167 static struct configfs_item_operations tcm_item_ops = {
2168 .release = tcm_attr_release,
2171 static const struct config_item_type tcm_func_type = {
2172 .ct_item_ops = &tcm_item_ops,
2173 .ct_owner = THIS_MODULE,
2176 static void tcm_free_inst(struct usb_function_instance *f)
2178 struct f_tcm_opts *opts;
2181 opts = container_of(f, struct f_tcm_opts, func_inst);
2183 mutex_lock(&tpg_instances_lock);
2184 for (i = 0; i < TPG_INSTANCES; ++i)
2185 if (tpg_instances[i].func_inst == f)
2187 if (i < TPG_INSTANCES)
2188 tpg_instances[i].func_inst = NULL;
2189 mutex_unlock(&tpg_instances_lock);
2194 static int tcm_register_callback(struct usb_function_instance *f)
2196 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2198 mutex_lock(&opts->dep_lock);
2199 opts->can_attach = true;
2200 mutex_unlock(&opts->dep_lock);
2205 static void tcm_unregister_callback(struct usb_function_instance *f)
2207 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2209 mutex_lock(&opts->dep_lock);
2210 unregister_gadget_item(opts->
2211 func_inst.group.cg_item.ci_parent->ci_parent);
2212 opts->can_attach = false;
2213 mutex_unlock(&opts->dep_lock);
2216 static int usbg_attach(struct usbg_tpg *tpg)
2218 struct usb_function_instance *f = tpg->fi;
2219 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2221 if (opts->tcm_register_callback)
2222 return opts->tcm_register_callback(f);
2227 static void usbg_detach(struct usbg_tpg *tpg)
2229 struct usb_function_instance *f = tpg->fi;
2230 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2232 if (opts->tcm_unregister_callback)
2233 opts->tcm_unregister_callback(f);
2236 static int tcm_set_name(struct usb_function_instance *f, const char *name)
2238 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2240 pr_debug("tcm: Activating %s\n", name);
2242 mutex_lock(&opts->dep_lock);
2244 mutex_unlock(&opts->dep_lock);
2249 static struct usb_function_instance *tcm_alloc_inst(void)
2251 struct f_tcm_opts *opts;
2255 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
2257 return ERR_PTR(-ENOMEM);
2259 mutex_lock(&tpg_instances_lock);
2260 for (i = 0; i < TPG_INSTANCES; ++i)
2261 if (!tpg_instances[i].func_inst)
2264 if (i == TPG_INSTANCES) {
2265 mutex_unlock(&tpg_instances_lock);
2267 return ERR_PTR(-EBUSY);
2269 tpg_instances[i].func_inst = &opts->func_inst;
2270 mutex_unlock(&tpg_instances_lock);
2272 mutex_init(&opts->dep_lock);
2273 opts->func_inst.set_inst_name = tcm_set_name;
2274 opts->func_inst.free_func_inst = tcm_free_inst;
2275 opts->tcm_register_callback = tcm_register_callback;
2276 opts->tcm_unregister_callback = tcm_unregister_callback;
2278 config_group_init_type_name(&opts->func_inst.group, "",
2281 return &opts->func_inst;
2284 static void tcm_free(struct usb_function *f)
2286 struct f_uas *tcm = to_f_uas(f);
2291 static void tcm_unbind(struct usb_configuration *c, struct usb_function *f)
2293 usb_free_all_descriptors(f);
2296 static struct usb_function *tcm_alloc(struct usb_function_instance *fi)
2301 mutex_lock(&tpg_instances_lock);
2302 for (i = 0; i < TPG_INSTANCES; ++i)
2303 if (tpg_instances[i].func_inst == fi)
2305 if (i == TPG_INSTANCES) {
2306 mutex_unlock(&tpg_instances_lock);
2307 return ERR_PTR(-ENODEV);
2310 fu = kzalloc(sizeof(*fu), GFP_KERNEL);
2312 mutex_unlock(&tpg_instances_lock);
2313 return ERR_PTR(-ENOMEM);
2316 fu->function.name = "Target Function";
2317 fu->function.bind = tcm_bind;
2318 fu->function.unbind = tcm_unbind;
2319 fu->function.set_alt = tcm_set_alt;
2320 fu->function.setup = tcm_setup;
2321 fu->function.disable = tcm_disable;
2322 fu->function.free_func = tcm_free;
2323 fu->tpg = tpg_instances[i].tpg;
2324 mutex_unlock(&tpg_instances_lock);
2326 return &fu->function;
2329 DECLARE_USB_FUNCTION(tcm, tcm_alloc_inst, tcm_alloc);
2331 static int tcm_init(void)
2335 ret = usb_function_register(&tcmusb_func);
2339 ret = target_register_template(&usbg_ops);
2341 usb_function_unregister(&tcmusb_func);
2345 module_init(tcm_init);
2347 static void tcm_exit(void)
2349 target_unregister_template(&usbg_ops);
2350 usb_function_unregister(&tcmusb_func);
2352 module_exit(tcm_exit);
2354 MODULE_LICENSE("GPL");
2355 MODULE_AUTHOR("Sebastian Andrzej Siewior");