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_and_alt(gadget, f, fu->ep_in, USB_G_ALT_INT_BBB);
396 ret = usb_ep_enable(fu->ep_in);
400 config_ep_by_speed_and_alt(gadget, f, fu->ep_out, USB_G_ALT_INT_BBB);
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->is_last = 1;
535 stream->req_in->complete = uasp_status_data_cmpl;
536 stream->req_in->length = se_cmd->data_length;
537 stream->req_in->context = cmd;
539 cmd->state = UASP_SEND_STATUS;
543 static void uasp_prepare_status(struct usbg_cmd *cmd)
545 struct se_cmd *se_cmd = &cmd->se_cmd;
546 struct sense_iu *iu = &cmd->sense_iu;
547 struct uas_stream *stream = cmd->stream;
549 cmd->state = UASP_QUEUE_COMMAND;
550 iu->iu_id = IU_ID_STATUS;
551 iu->tag = cpu_to_be16(cmd->tag);
554 * iu->status_qual = cpu_to_be16(STATUS QUALIFIER SAM-4. Where R U?);
556 iu->len = cpu_to_be16(se_cmd->scsi_sense_length);
557 iu->status = se_cmd->scsi_status;
558 stream->req_status->is_last = 1;
559 stream->req_status->context = cmd;
560 stream->req_status->length = se_cmd->scsi_sense_length + 16;
561 stream->req_status->buf = iu;
562 stream->req_status->complete = uasp_status_data_cmpl;
565 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req)
567 struct usbg_cmd *cmd = req->context;
568 struct uas_stream *stream = cmd->stream;
569 struct f_uas *fu = cmd->fu;
575 switch (cmd->state) {
577 ret = uasp_prepare_r_request(cmd);
580 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
582 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
585 case UASP_RECEIVE_DATA:
586 ret = usbg_prepare_w_request(cmd, stream->req_out);
589 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
591 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
594 case UASP_SEND_STATUS:
595 uasp_prepare_status(cmd);
596 ret = usb_ep_queue(fu->ep_status, stream->req_status,
599 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
602 case UASP_QUEUE_COMMAND:
603 transport_generic_free_cmd(&cmd->se_cmd, 0);
604 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
613 transport_generic_free_cmd(&cmd->se_cmd, 0);
616 static int uasp_send_status_response(struct usbg_cmd *cmd)
618 struct f_uas *fu = cmd->fu;
619 struct uas_stream *stream = cmd->stream;
620 struct sense_iu *iu = &cmd->sense_iu;
622 iu->tag = cpu_to_be16(cmd->tag);
623 stream->req_status->complete = uasp_status_data_cmpl;
624 stream->req_status->context = cmd;
626 uasp_prepare_status(cmd);
627 return usb_ep_queue(fu->ep_status, stream->req_status, GFP_ATOMIC);
630 static int uasp_send_read_response(struct usbg_cmd *cmd)
632 struct f_uas *fu = cmd->fu;
633 struct uas_stream *stream = cmd->stream;
634 struct sense_iu *iu = &cmd->sense_iu;
639 iu->tag = cpu_to_be16(cmd->tag);
640 if (fu->flags & USBG_USE_STREAMS) {
642 ret = uasp_prepare_r_request(cmd);
645 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
647 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
648 kfree(cmd->data_buf);
649 cmd->data_buf = NULL;
654 iu->iu_id = IU_ID_READ_READY;
655 iu->tag = cpu_to_be16(cmd->tag);
657 stream->req_status->complete = uasp_status_data_cmpl;
658 stream->req_status->context = cmd;
660 cmd->state = UASP_SEND_DATA;
661 stream->req_status->buf = iu;
662 stream->req_status->length = sizeof(struct iu);
664 ret = usb_ep_queue(fu->ep_status, stream->req_status,
667 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
673 static int uasp_send_write_request(struct usbg_cmd *cmd)
675 struct f_uas *fu = cmd->fu;
676 struct se_cmd *se_cmd = &cmd->se_cmd;
677 struct uas_stream *stream = cmd->stream;
678 struct sense_iu *iu = &cmd->sense_iu;
681 init_completion(&cmd->write_complete);
684 iu->tag = cpu_to_be16(cmd->tag);
686 if (fu->flags & USBG_USE_STREAMS) {
688 ret = usbg_prepare_w_request(cmd, stream->req_out);
691 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
693 pr_err("%s(%d)\n", __func__, __LINE__);
697 iu->iu_id = IU_ID_WRITE_READY;
698 iu->tag = cpu_to_be16(cmd->tag);
700 stream->req_status->complete = uasp_status_data_cmpl;
701 stream->req_status->context = cmd;
703 cmd->state = UASP_RECEIVE_DATA;
704 stream->req_status->buf = iu;
705 stream->req_status->length = sizeof(struct iu);
707 ret = usb_ep_queue(fu->ep_status, stream->req_status,
710 pr_err("%s(%d)\n", __func__, __LINE__);
713 wait_for_completion(&cmd->write_complete);
714 target_execute_cmd(se_cmd);
719 static int usbg_submit_command(struct f_uas *, void *, unsigned int);
721 static void uasp_cmd_complete(struct usb_ep *ep, struct usb_request *req)
723 struct f_uas *fu = req->context;
729 ret = usbg_submit_command(fu, req->buf, req->actual);
731 * Once we tune for performance enqueue the command req here again so
732 * we can receive a second command while we processing this one. Pay
733 * attention to properly sync STAUS endpoint with DATA IN + OUT so you
738 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
741 static int uasp_alloc_stream_res(struct f_uas *fu, struct uas_stream *stream)
743 stream->req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
747 stream->req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
748 if (!stream->req_out)
751 stream->req_status = usb_ep_alloc_request(fu->ep_status, GFP_KERNEL);
752 if (!stream->req_status)
758 usb_ep_free_request(fu->ep_out, stream->req_out);
759 stream->req_out = NULL;
761 usb_ep_free_request(fu->ep_in, stream->req_in);
762 stream->req_in = NULL;
767 static int uasp_alloc_cmd(struct f_uas *fu)
769 fu->cmd.req = usb_ep_alloc_request(fu->ep_cmd, GFP_KERNEL);
773 fu->cmd.buf = kmalloc(fu->ep_cmd->maxpacket, GFP_KERNEL);
777 fu->cmd.req->complete = uasp_cmd_complete;
778 fu->cmd.req->buf = fu->cmd.buf;
779 fu->cmd.req->length = fu->ep_cmd->maxpacket;
780 fu->cmd.req->context = fu;
784 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
789 static void uasp_setup_stream_res(struct f_uas *fu, int max_streams)
793 for (i = 0; i < max_streams; i++) {
794 struct uas_stream *s = &fu->stream[i];
796 s->req_in->stream_id = i + 1;
797 s->req_out->stream_id = i + 1;
798 s->req_status->stream_id = i + 1;
802 static int uasp_prepare_reqs(struct f_uas *fu)
808 if (fu->flags & USBG_USE_STREAMS)
809 max_streams = UASP_SS_EP_COMP_NUM_STREAMS;
813 for (i = 0; i < max_streams; i++) {
814 ret = uasp_alloc_stream_res(fu, &fu->stream[i]);
819 ret = uasp_alloc_cmd(fu);
821 goto err_free_stream;
822 uasp_setup_stream_res(fu, max_streams);
824 ret = usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
826 goto err_free_stream;
831 uasp_free_cmdreq(fu);
836 uasp_cleanup_one_stream(fu, &fu->stream[i - 1]);
840 pr_err("UASP: endpoint setup failed\n");
844 static void uasp_set_alt(struct f_uas *fu)
846 struct usb_function *f = &fu->function;
847 struct usb_gadget *gadget = f->config->cdev->gadget;
850 fu->flags = USBG_IS_UAS;
852 if (gadget->speed >= USB_SPEED_SUPER)
853 fu->flags |= USBG_USE_STREAMS;
855 config_ep_by_speed_and_alt(gadget, f, fu->ep_in, USB_G_ALT_INT_UAS);
856 ret = usb_ep_enable(fu->ep_in);
860 config_ep_by_speed_and_alt(gadget, f, fu->ep_out, USB_G_ALT_INT_UAS);
861 ret = usb_ep_enable(fu->ep_out);
865 config_ep_by_speed_and_alt(gadget, f, fu->ep_cmd, USB_G_ALT_INT_UAS);
866 ret = usb_ep_enable(fu->ep_cmd);
869 config_ep_by_speed_and_alt(gadget, f, fu->ep_status, USB_G_ALT_INT_UAS);
870 ret = usb_ep_enable(fu->ep_status);
874 ret = uasp_prepare_reqs(fu);
877 fu->flags |= USBG_ENABLED;
879 pr_info("Using the UAS protocol\n");
882 usb_ep_disable(fu->ep_status);
884 usb_ep_disable(fu->ep_cmd);
886 usb_ep_disable(fu->ep_out);
888 usb_ep_disable(fu->ep_in);
893 static int get_cmd_dir(const unsigned char *cdb)
905 case SERVICE_ACTION_IN_16:
907 case PERSISTENT_RESERVE_IN:
908 case SECURITY_PROTOCOL_IN:
909 case ACCESS_CONTROL_IN:
911 case READ_BLOCK_LIMITS:
915 case READ_FORMAT_CAPACITIES:
917 ret = DMA_FROM_DEVICE;
927 case WRITE_VERIFY_12:
928 case PERSISTENT_RESERVE_OUT:
929 case MAINTENANCE_OUT:
930 case SECURITY_PROTOCOL_OUT:
931 case ACCESS_CONTROL_OUT:
934 case ALLOW_MEDIUM_REMOVAL:
935 case TEST_UNIT_READY:
936 case SYNCHRONIZE_CACHE:
943 case WRITE_FILEMARKS:
947 #define CMD_DIR_MSG "target: Unknown data direction for SCSI Opcode 0x%02x\n"
948 pr_warn(CMD_DIR_MSG, cdb[0]);
955 static void usbg_data_write_cmpl(struct usb_ep *ep, struct usb_request *req)
957 struct usbg_cmd *cmd = req->context;
958 struct se_cmd *se_cmd = &cmd->se_cmd;
960 if (req->status < 0) {
961 pr_err("%s() state %d transfer failed\n", __func__, cmd->state);
965 if (req->num_sgs == 0) {
966 sg_copy_from_buffer(se_cmd->t_data_sg,
967 se_cmd->t_data_nents,
969 se_cmd->data_length);
972 complete(&cmd->write_complete);
976 transport_generic_free_cmd(&cmd->se_cmd, 0);
979 static int usbg_prepare_w_request(struct usbg_cmd *cmd, struct usb_request *req)
981 struct se_cmd *se_cmd = &cmd->se_cmd;
982 struct f_uas *fu = cmd->fu;
983 struct usb_gadget *gadget = fuas_to_gadget(fu);
985 if (!gadget->sg_supported) {
986 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
990 req->buf = cmd->data_buf;
993 req->num_sgs = se_cmd->t_data_nents;
994 req->sg = se_cmd->t_data_sg;
998 req->complete = usbg_data_write_cmpl;
999 req->length = se_cmd->data_length;
1004 static int usbg_send_status_response(struct se_cmd *se_cmd)
1006 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1008 struct f_uas *fu = cmd->fu;
1010 if (fu->flags & USBG_IS_BOT)
1011 return bot_send_status_response(cmd);
1013 return uasp_send_status_response(cmd);
1016 static int usbg_send_write_request(struct se_cmd *se_cmd)
1018 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1020 struct f_uas *fu = cmd->fu;
1022 if (fu->flags & USBG_IS_BOT)
1023 return bot_send_write_request(cmd);
1025 return uasp_send_write_request(cmd);
1028 static int usbg_send_read_response(struct se_cmd *se_cmd)
1030 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1032 struct f_uas *fu = cmd->fu;
1034 if (fu->flags & USBG_IS_BOT)
1035 return bot_send_read_response(cmd);
1037 return uasp_send_read_response(cmd);
1040 static void usbg_cmd_work(struct work_struct *work)
1042 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1043 struct se_cmd *se_cmd;
1044 struct tcm_usbg_nexus *tv_nexus;
1045 struct usbg_tpg *tpg;
1046 int dir, flags = (TARGET_SCF_UNKNOWN_SIZE | TARGET_SCF_ACK_KREF);
1048 se_cmd = &cmd->se_cmd;
1050 tv_nexus = tpg->tpg_nexus;
1051 dir = get_cmd_dir(cmd->cmd_buf);
1053 __target_init_cmd(se_cmd,
1054 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1055 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1056 cmd->prio_attr, cmd->sense_iu.sense,
1057 cmd->unpacked_lun, NULL);
1061 target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess, cmd->cmd_buf,
1062 cmd->sense_iu.sense, cmd->unpacked_lun, 0,
1063 cmd->prio_attr, dir, flags);
1067 transport_send_check_condition_and_sense(se_cmd,
1068 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1069 transport_generic_free_cmd(&cmd->se_cmd, 0);
1072 static struct usbg_cmd *usbg_get_cmd(struct f_uas *fu,
1073 struct tcm_usbg_nexus *tv_nexus, u32 scsi_tag)
1075 struct se_session *se_sess = tv_nexus->tvn_se_sess;
1076 struct usbg_cmd *cmd;
1079 tag = sbitmap_queue_get(&se_sess->sess_tag_pool, &cpu);
1081 return ERR_PTR(-ENOMEM);
1083 cmd = &((struct usbg_cmd *)se_sess->sess_cmd_map)[tag];
1084 memset(cmd, 0, sizeof(*cmd));
1085 cmd->se_cmd.map_tag = tag;
1086 cmd->se_cmd.map_cpu = cpu;
1087 cmd->se_cmd.tag = cmd->tag = scsi_tag;
1093 static void usbg_release_cmd(struct se_cmd *);
1095 static int usbg_submit_command(struct f_uas *fu,
1096 void *cmdbuf, unsigned int len)
1098 struct command_iu *cmd_iu = cmdbuf;
1099 struct usbg_cmd *cmd;
1100 struct usbg_tpg *tpg = fu->tpg;
1101 struct tcm_usbg_nexus *tv_nexus;
1105 if (cmd_iu->iu_id != IU_ID_COMMAND) {
1106 pr_err("Unsupported type %d\n", cmd_iu->iu_id);
1110 tv_nexus = tpg->tpg_nexus;
1112 pr_err("Missing nexus, ignoring command\n");
1116 cmd_len = (cmd_iu->len & ~0x3) + 16;
1117 if (cmd_len > USBG_MAX_CMD)
1120 scsi_tag = be16_to_cpup(&cmd_iu->tag);
1121 cmd = usbg_get_cmd(fu, tv_nexus, scsi_tag);
1123 pr_err("usbg_get_cmd failed\n");
1126 memcpy(cmd->cmd_buf, cmd_iu->cdb, cmd_len);
1128 if (fu->flags & USBG_USE_STREAMS) {
1129 if (cmd->tag > UASP_SS_EP_COMP_NUM_STREAMS)
1132 cmd->stream = &fu->stream[0];
1134 cmd->stream = &fu->stream[cmd->tag - 1];
1136 cmd->stream = &fu->stream[0];
1139 switch (cmd_iu->prio_attr & 0x7) {
1141 cmd->prio_attr = TCM_HEAD_TAG;
1143 case UAS_ORDERED_TAG:
1144 cmd->prio_attr = TCM_ORDERED_TAG;
1147 cmd->prio_attr = TCM_ACA_TAG;
1150 pr_debug_once("Unsupported prio_attr: %02x.\n",
1153 case UAS_SIMPLE_TAG:
1154 cmd->prio_attr = TCM_SIMPLE_TAG;
1158 cmd->unpacked_lun = scsilun_to_int(&cmd_iu->lun);
1160 INIT_WORK(&cmd->work, usbg_cmd_work);
1161 queue_work(tpg->workqueue, &cmd->work);
1165 usbg_release_cmd(&cmd->se_cmd);
1169 static void bot_cmd_work(struct work_struct *work)
1171 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1172 struct se_cmd *se_cmd;
1173 struct tcm_usbg_nexus *tv_nexus;
1174 struct usbg_tpg *tpg;
1177 se_cmd = &cmd->se_cmd;
1179 tv_nexus = tpg->tpg_nexus;
1180 dir = get_cmd_dir(cmd->cmd_buf);
1182 __target_init_cmd(se_cmd,
1183 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1184 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1185 cmd->prio_attr, cmd->sense_iu.sense,
1186 cmd->unpacked_lun, NULL);
1190 target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1191 cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1192 cmd->data_len, cmd->prio_attr, dir, 0);
1196 transport_send_check_condition_and_sense(se_cmd,
1197 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1198 transport_generic_free_cmd(&cmd->se_cmd, 0);
1201 static int bot_submit_command(struct f_uas *fu,
1202 void *cmdbuf, unsigned int len)
1204 struct bulk_cb_wrap *cbw = cmdbuf;
1205 struct usbg_cmd *cmd;
1206 struct usbg_tpg *tpg = fu->tpg;
1207 struct tcm_usbg_nexus *tv_nexus;
1210 if (cbw->Signature != cpu_to_le32(US_BULK_CB_SIGN)) {
1211 pr_err("Wrong signature on CBW\n");
1215 pr_err("Wrong length for CBW\n");
1219 cmd_len = cbw->Length;
1220 if (cmd_len < 1 || cmd_len > 16)
1223 tv_nexus = tpg->tpg_nexus;
1225 pr_err("Missing nexus, ignoring command\n");
1229 cmd = usbg_get_cmd(fu, tv_nexus, cbw->Tag);
1231 pr_err("usbg_get_cmd failed\n");
1234 memcpy(cmd->cmd_buf, cbw->CDB, cmd_len);
1236 cmd->bot_tag = cbw->Tag;
1237 cmd->prio_attr = TCM_SIMPLE_TAG;
1238 cmd->unpacked_lun = cbw->Lun;
1239 cmd->is_read = cbw->Flags & US_BULK_FLAG_IN ? 1 : 0;
1240 cmd->data_len = le32_to_cpu(cbw->DataTransferLength);
1241 cmd->se_cmd.tag = le32_to_cpu(cmd->bot_tag);
1243 INIT_WORK(&cmd->work, bot_cmd_work);
1244 queue_work(tpg->workqueue, &cmd->work);
1249 /* Start fabric.c code */
1251 static int usbg_check_true(struct se_portal_group *se_tpg)
1256 static char *usbg_get_fabric_wwn(struct se_portal_group *se_tpg)
1258 struct usbg_tpg *tpg = container_of(se_tpg,
1259 struct usbg_tpg, se_tpg);
1260 struct usbg_tport *tport = tpg->tport;
1262 return &tport->tport_name[0];
1265 static u16 usbg_get_tag(struct se_portal_group *se_tpg)
1267 struct usbg_tpg *tpg = container_of(se_tpg,
1268 struct usbg_tpg, se_tpg);
1269 return tpg->tport_tpgt;
1272 static void usbg_release_cmd(struct se_cmd *se_cmd)
1274 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1276 struct se_session *se_sess = se_cmd->se_sess;
1278 kfree(cmd->data_buf);
1279 target_free_tag(se_sess, se_cmd);
1282 static void usbg_queue_tm_rsp(struct se_cmd *se_cmd)
1286 static void usbg_aborted_task(struct se_cmd *se_cmd)
1290 static const char *usbg_check_wwn(const char *name)
1295 n = strstr(name, "naa.");
1300 if (len == 0 || len > USBG_NAMELEN - 1)
1305 static int usbg_init_nodeacl(struct se_node_acl *se_nacl, const char *name)
1307 if (!usbg_check_wwn(name))
1312 static struct se_portal_group *usbg_make_tpg(struct se_wwn *wwn,
1315 struct usbg_tport *tport = container_of(wwn, struct usbg_tport,
1317 struct usbg_tpg *tpg;
1320 struct f_tcm_opts *opts;
1323 if (strstr(name, "tpgt_") != name)
1324 return ERR_PTR(-EINVAL);
1325 if (kstrtoul(name + 5, 0, &tpgt) || tpgt > UINT_MAX)
1326 return ERR_PTR(-EINVAL);
1328 mutex_lock(&tpg_instances_lock);
1329 for (i = 0; i < TPG_INSTANCES; ++i)
1330 if (tpg_instances[i].func_inst && !tpg_instances[i].tpg)
1332 if (i == TPG_INSTANCES)
1335 opts = container_of(tpg_instances[i].func_inst, struct f_tcm_opts,
1337 mutex_lock(&opts->dep_lock);
1341 if (opts->has_dep) {
1342 if (!try_module_get(opts->dependent))
1345 ret = configfs_depend_item_unlocked(
1346 wwn->wwn_group.cg_subsys,
1347 &opts->func_inst.group.cg_item);
1352 tpg = kzalloc(sizeof(struct usbg_tpg), GFP_KERNEL);
1356 mutex_init(&tpg->tpg_mutex);
1357 atomic_set(&tpg->tpg_port_count, 0);
1358 tpg->workqueue = alloc_workqueue("tcm_usb_gadget", 0, 1);
1359 if (!tpg->workqueue)
1363 tpg->tport_tpgt = tpgt;
1366 * SPC doesn't assign a protocol identifier for USB-SCSI, so we
1367 * pretend to be SAS..
1369 ret = core_tpg_register(wwn, &tpg->se_tpg, SCSI_PROTOCOL_SAS);
1371 goto free_workqueue;
1373 tpg_instances[i].tpg = tpg;
1374 tpg->fi = tpg_instances[i].func_inst;
1375 mutex_unlock(&opts->dep_lock);
1376 mutex_unlock(&tpg_instances_lock);
1377 return &tpg->se_tpg;
1380 destroy_workqueue(tpg->workqueue);
1385 module_put(opts->dependent);
1387 configfs_undepend_item_unlocked(&opts->func_inst.group.cg_item);
1389 mutex_unlock(&opts->dep_lock);
1391 mutex_unlock(&tpg_instances_lock);
1393 return ERR_PTR(ret);
1396 static int tcm_usbg_drop_nexus(struct usbg_tpg *);
1398 static void usbg_drop_tpg(struct se_portal_group *se_tpg)
1400 struct usbg_tpg *tpg = container_of(se_tpg,
1401 struct usbg_tpg, se_tpg);
1403 struct f_tcm_opts *opts;
1405 tcm_usbg_drop_nexus(tpg);
1406 core_tpg_deregister(se_tpg);
1407 destroy_workqueue(tpg->workqueue);
1409 mutex_lock(&tpg_instances_lock);
1410 for (i = 0; i < TPG_INSTANCES; ++i)
1411 if (tpg_instances[i].tpg == tpg)
1413 if (i < TPG_INSTANCES) {
1414 tpg_instances[i].tpg = NULL;
1415 opts = container_of(tpg_instances[i].func_inst,
1416 struct f_tcm_opts, func_inst);
1417 mutex_lock(&opts->dep_lock);
1419 module_put(opts->dependent);
1421 configfs_undepend_item_unlocked(
1422 &opts->func_inst.group.cg_item);
1423 mutex_unlock(&opts->dep_lock);
1425 mutex_unlock(&tpg_instances_lock);
1430 static struct se_wwn *usbg_make_tport(
1431 struct target_fabric_configfs *tf,
1432 struct config_group *group,
1435 struct usbg_tport *tport;
1436 const char *wnn_name;
1439 wnn_name = usbg_check_wwn(name);
1441 return ERR_PTR(-EINVAL);
1443 tport = kzalloc(sizeof(struct usbg_tport), GFP_KERNEL);
1445 return ERR_PTR(-ENOMEM);
1447 tport->tport_wwpn = wwpn;
1448 snprintf(tport->tport_name, sizeof(tport->tport_name), "%s", wnn_name);
1449 return &tport->tport_wwn;
1452 static void usbg_drop_tport(struct se_wwn *wwn)
1454 struct usbg_tport *tport = container_of(wwn,
1455 struct usbg_tport, tport_wwn);
1460 * If somebody feels like dropping the version property, go ahead.
1462 static ssize_t usbg_wwn_version_show(struct config_item *item, char *page)
1464 return sprintf(page, "usb-gadget fabric module\n");
1467 CONFIGFS_ATTR_RO(usbg_wwn_, version);
1469 static struct configfs_attribute *usbg_wwn_attrs[] = {
1470 &usbg_wwn_attr_version,
1474 static int usbg_attach(struct usbg_tpg *);
1475 static void usbg_detach(struct usbg_tpg *);
1477 static int usbg_enable_tpg(struct se_portal_group *se_tpg, bool enable)
1479 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1483 ret = usbg_attach(tpg);
1489 tpg->gadget_connect = enable;
1494 static ssize_t tcm_usbg_tpg_nexus_show(struct config_item *item, char *page)
1496 struct se_portal_group *se_tpg = to_tpg(item);
1497 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1498 struct tcm_usbg_nexus *tv_nexus;
1501 mutex_lock(&tpg->tpg_mutex);
1502 tv_nexus = tpg->tpg_nexus;
1507 ret = snprintf(page, PAGE_SIZE, "%s\n",
1508 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1510 mutex_unlock(&tpg->tpg_mutex);
1514 static int usbg_alloc_sess_cb(struct se_portal_group *se_tpg,
1515 struct se_session *se_sess, void *p)
1517 struct usbg_tpg *tpg = container_of(se_tpg,
1518 struct usbg_tpg, se_tpg);
1524 static int tcm_usbg_make_nexus(struct usbg_tpg *tpg, char *name)
1526 struct tcm_usbg_nexus *tv_nexus;
1529 mutex_lock(&tpg->tpg_mutex);
1530 if (tpg->tpg_nexus) {
1532 pr_debug("tpg->tpg_nexus already exists\n");
1536 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1542 tv_nexus->tvn_se_sess = target_setup_session(&tpg->se_tpg,
1543 USB_G_DEFAULT_SESSION_TAGS,
1544 sizeof(struct usbg_cmd),
1545 TARGET_PROT_NORMAL, name,
1546 tv_nexus, usbg_alloc_sess_cb);
1547 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1548 #define MAKE_NEXUS_MSG "core_tpg_check_initiator_node_acl() failed for %s\n"
1549 pr_debug(MAKE_NEXUS_MSG, name);
1550 #undef MAKE_NEXUS_MSG
1551 ret = PTR_ERR(tv_nexus->tvn_se_sess);
1556 mutex_unlock(&tpg->tpg_mutex);
1560 static int tcm_usbg_drop_nexus(struct usbg_tpg *tpg)
1562 struct se_session *se_sess;
1563 struct tcm_usbg_nexus *tv_nexus;
1566 mutex_lock(&tpg->tpg_mutex);
1567 tv_nexus = tpg->tpg_nexus;
1571 se_sess = tv_nexus->tvn_se_sess;
1575 if (atomic_read(&tpg->tpg_port_count)) {
1577 #define MSG "Unable to remove Host I_T Nexus with active TPG port count: %d\n"
1578 pr_err(MSG, atomic_read(&tpg->tpg_port_count));
1583 pr_debug("Removing I_T Nexus to Initiator Port: %s\n",
1584 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1586 * Release the SCSI I_T Nexus to the emulated vHost Target Port
1588 target_remove_session(se_sess);
1589 tpg->tpg_nexus = NULL;
1594 mutex_unlock(&tpg->tpg_mutex);
1598 static ssize_t tcm_usbg_tpg_nexus_store(struct config_item *item,
1599 const char *page, size_t count)
1601 struct se_portal_group *se_tpg = to_tpg(item);
1602 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1603 unsigned char i_port[USBG_NAMELEN], *ptr;
1606 if (!strncmp(page, "NULL", 4)) {
1607 ret = tcm_usbg_drop_nexus(tpg);
1608 return (!ret) ? count : ret;
1610 if (strlen(page) >= USBG_NAMELEN) {
1612 #define NEXUS_STORE_MSG "Emulated NAA Sas Address: %s, exceeds max: %d\n"
1613 pr_err(NEXUS_STORE_MSG, page, USBG_NAMELEN);
1614 #undef NEXUS_STORE_MSG
1617 snprintf(i_port, USBG_NAMELEN, "%s", page);
1619 ptr = strstr(i_port, "naa.");
1621 pr_err("Missing 'naa.' prefix\n");
1625 if (i_port[strlen(i_port) - 1] == '\n')
1626 i_port[strlen(i_port) - 1] = '\0';
1628 ret = tcm_usbg_make_nexus(tpg, &i_port[0]);
1634 CONFIGFS_ATTR(tcm_usbg_tpg_, nexus);
1636 static struct configfs_attribute *usbg_base_attrs[] = {
1637 &tcm_usbg_tpg_attr_nexus,
1641 static int usbg_port_link(struct se_portal_group *se_tpg, struct se_lun *lun)
1643 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1645 atomic_inc(&tpg->tpg_port_count);
1646 smp_mb__after_atomic();
1650 static void usbg_port_unlink(struct se_portal_group *se_tpg,
1651 struct se_lun *se_lun)
1653 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1655 atomic_dec(&tpg->tpg_port_count);
1656 smp_mb__after_atomic();
1659 static int usbg_check_stop_free(struct se_cmd *se_cmd)
1661 return target_put_sess_cmd(se_cmd);
1664 static const struct target_core_fabric_ops usbg_ops = {
1665 .module = THIS_MODULE,
1666 .fabric_name = "usb_gadget",
1667 .tpg_get_wwn = usbg_get_fabric_wwn,
1668 .tpg_get_tag = usbg_get_tag,
1669 .tpg_check_demo_mode = usbg_check_true,
1670 .release_cmd = usbg_release_cmd,
1671 .sess_get_initiator_sid = NULL,
1672 .write_pending = usbg_send_write_request,
1673 .queue_data_in = usbg_send_read_response,
1674 .queue_status = usbg_send_status_response,
1675 .queue_tm_rsp = usbg_queue_tm_rsp,
1676 .aborted_task = usbg_aborted_task,
1677 .check_stop_free = usbg_check_stop_free,
1679 .fabric_make_wwn = usbg_make_tport,
1680 .fabric_drop_wwn = usbg_drop_tport,
1681 .fabric_make_tpg = usbg_make_tpg,
1682 .fabric_enable_tpg = usbg_enable_tpg,
1683 .fabric_drop_tpg = usbg_drop_tpg,
1684 .fabric_post_link = usbg_port_link,
1685 .fabric_pre_unlink = usbg_port_unlink,
1686 .fabric_init_nodeacl = usbg_init_nodeacl,
1688 .tfc_wwn_attrs = usbg_wwn_attrs,
1689 .tfc_tpg_base_attrs = usbg_base_attrs,
1691 .default_submit_type = TARGET_DIRECT_SUBMIT,
1692 .direct_submit_supp = 1,
1695 /* Start gadget.c code */
1697 static struct usb_interface_descriptor bot_intf_desc = {
1698 .bLength = sizeof(bot_intf_desc),
1699 .bDescriptorType = USB_DT_INTERFACE,
1701 .bAlternateSetting = USB_G_ALT_INT_BBB,
1702 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1703 .bInterfaceSubClass = USB_SC_SCSI,
1704 .bInterfaceProtocol = USB_PR_BULK,
1707 static struct usb_interface_descriptor uasp_intf_desc = {
1708 .bLength = sizeof(uasp_intf_desc),
1709 .bDescriptorType = USB_DT_INTERFACE,
1711 .bAlternateSetting = USB_G_ALT_INT_UAS,
1712 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1713 .bInterfaceSubClass = USB_SC_SCSI,
1714 .bInterfaceProtocol = USB_PR_UAS,
1717 static struct usb_endpoint_descriptor uasp_bi_desc = {
1718 .bLength = USB_DT_ENDPOINT_SIZE,
1719 .bDescriptorType = USB_DT_ENDPOINT,
1720 .bEndpointAddress = USB_DIR_IN,
1721 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1722 .wMaxPacketSize = cpu_to_le16(512),
1725 static struct usb_endpoint_descriptor uasp_fs_bi_desc = {
1726 .bLength = USB_DT_ENDPOINT_SIZE,
1727 .bDescriptorType = USB_DT_ENDPOINT,
1728 .bEndpointAddress = USB_DIR_IN,
1729 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1732 static struct usb_pipe_usage_descriptor uasp_bi_pipe_desc = {
1733 .bLength = sizeof(uasp_bi_pipe_desc),
1734 .bDescriptorType = USB_DT_PIPE_USAGE,
1735 .bPipeID = DATA_IN_PIPE_ID,
1738 static struct usb_endpoint_descriptor uasp_ss_bi_desc = {
1739 .bLength = USB_DT_ENDPOINT_SIZE,
1740 .bDescriptorType = USB_DT_ENDPOINT,
1741 .bEndpointAddress = USB_DIR_IN,
1742 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1743 .wMaxPacketSize = cpu_to_le16(1024),
1746 static struct usb_ss_ep_comp_descriptor uasp_bi_ep_comp_desc = {
1747 .bLength = sizeof(uasp_bi_ep_comp_desc),
1748 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1750 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1751 .wBytesPerInterval = 0,
1754 static struct usb_ss_ep_comp_descriptor bot_bi_ep_comp_desc = {
1755 .bLength = sizeof(bot_bi_ep_comp_desc),
1756 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1760 static struct usb_endpoint_descriptor uasp_bo_desc = {
1761 .bLength = USB_DT_ENDPOINT_SIZE,
1762 .bDescriptorType = USB_DT_ENDPOINT,
1763 .bEndpointAddress = USB_DIR_OUT,
1764 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1765 .wMaxPacketSize = cpu_to_le16(512),
1768 static struct usb_endpoint_descriptor uasp_fs_bo_desc = {
1769 .bLength = USB_DT_ENDPOINT_SIZE,
1770 .bDescriptorType = USB_DT_ENDPOINT,
1771 .bEndpointAddress = USB_DIR_OUT,
1772 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1775 static struct usb_pipe_usage_descriptor uasp_bo_pipe_desc = {
1776 .bLength = sizeof(uasp_bo_pipe_desc),
1777 .bDescriptorType = USB_DT_PIPE_USAGE,
1778 .bPipeID = DATA_OUT_PIPE_ID,
1781 static struct usb_endpoint_descriptor uasp_ss_bo_desc = {
1782 .bLength = USB_DT_ENDPOINT_SIZE,
1783 .bDescriptorType = USB_DT_ENDPOINT,
1784 .bEndpointAddress = USB_DIR_OUT,
1785 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1786 .wMaxPacketSize = cpu_to_le16(0x400),
1789 static struct usb_ss_ep_comp_descriptor uasp_bo_ep_comp_desc = {
1790 .bLength = sizeof(uasp_bo_ep_comp_desc),
1791 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1792 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1795 static struct usb_ss_ep_comp_descriptor bot_bo_ep_comp_desc = {
1796 .bLength = sizeof(bot_bo_ep_comp_desc),
1797 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1800 static struct usb_endpoint_descriptor uasp_status_desc = {
1801 .bLength = USB_DT_ENDPOINT_SIZE,
1802 .bDescriptorType = USB_DT_ENDPOINT,
1803 .bEndpointAddress = USB_DIR_IN,
1804 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1805 .wMaxPacketSize = cpu_to_le16(512),
1808 static struct usb_endpoint_descriptor uasp_fs_status_desc = {
1809 .bLength = USB_DT_ENDPOINT_SIZE,
1810 .bDescriptorType = USB_DT_ENDPOINT,
1811 .bEndpointAddress = USB_DIR_IN,
1812 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1815 static struct usb_pipe_usage_descriptor uasp_status_pipe_desc = {
1816 .bLength = sizeof(uasp_status_pipe_desc),
1817 .bDescriptorType = USB_DT_PIPE_USAGE,
1818 .bPipeID = STATUS_PIPE_ID,
1821 static struct usb_endpoint_descriptor uasp_ss_status_desc = {
1822 .bLength = USB_DT_ENDPOINT_SIZE,
1823 .bDescriptorType = USB_DT_ENDPOINT,
1824 .bEndpointAddress = USB_DIR_IN,
1825 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1826 .wMaxPacketSize = cpu_to_le16(1024),
1829 static struct usb_ss_ep_comp_descriptor uasp_status_in_ep_comp_desc = {
1830 .bLength = sizeof(uasp_status_in_ep_comp_desc),
1831 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1832 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1835 static struct usb_endpoint_descriptor uasp_cmd_desc = {
1836 .bLength = USB_DT_ENDPOINT_SIZE,
1837 .bDescriptorType = USB_DT_ENDPOINT,
1838 .bEndpointAddress = USB_DIR_OUT,
1839 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1840 .wMaxPacketSize = cpu_to_le16(512),
1843 static struct usb_endpoint_descriptor uasp_fs_cmd_desc = {
1844 .bLength = USB_DT_ENDPOINT_SIZE,
1845 .bDescriptorType = USB_DT_ENDPOINT,
1846 .bEndpointAddress = USB_DIR_OUT,
1847 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1850 static struct usb_pipe_usage_descriptor uasp_cmd_pipe_desc = {
1851 .bLength = sizeof(uasp_cmd_pipe_desc),
1852 .bDescriptorType = USB_DT_PIPE_USAGE,
1853 .bPipeID = CMD_PIPE_ID,
1856 static struct usb_endpoint_descriptor uasp_ss_cmd_desc = {
1857 .bLength = USB_DT_ENDPOINT_SIZE,
1858 .bDescriptorType = USB_DT_ENDPOINT,
1859 .bEndpointAddress = USB_DIR_OUT,
1860 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1861 .wMaxPacketSize = cpu_to_le16(1024),
1864 static struct usb_ss_ep_comp_descriptor uasp_cmd_comp_desc = {
1865 .bLength = sizeof(uasp_cmd_comp_desc),
1866 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1869 static struct usb_descriptor_header *uasp_fs_function_desc[] = {
1870 (struct usb_descriptor_header *) &bot_intf_desc,
1871 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
1872 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
1874 (struct usb_descriptor_header *) &uasp_intf_desc,
1875 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
1876 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
1877 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
1878 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
1879 (struct usb_descriptor_header *) &uasp_fs_status_desc,
1880 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
1881 (struct usb_descriptor_header *) &uasp_fs_cmd_desc,
1882 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
1886 static struct usb_descriptor_header *uasp_hs_function_desc[] = {
1887 (struct usb_descriptor_header *) &bot_intf_desc,
1888 (struct usb_descriptor_header *) &uasp_bi_desc,
1889 (struct usb_descriptor_header *) &uasp_bo_desc,
1891 (struct usb_descriptor_header *) &uasp_intf_desc,
1892 (struct usb_descriptor_header *) &uasp_bi_desc,
1893 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
1894 (struct usb_descriptor_header *) &uasp_bo_desc,
1895 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
1896 (struct usb_descriptor_header *) &uasp_status_desc,
1897 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
1898 (struct usb_descriptor_header *) &uasp_cmd_desc,
1899 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
1903 static struct usb_descriptor_header *uasp_ss_function_desc[] = {
1904 (struct usb_descriptor_header *) &bot_intf_desc,
1905 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
1906 (struct usb_descriptor_header *) &bot_bi_ep_comp_desc,
1907 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
1908 (struct usb_descriptor_header *) &bot_bo_ep_comp_desc,
1910 (struct usb_descriptor_header *) &uasp_intf_desc,
1911 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
1912 (struct usb_descriptor_header *) &uasp_bi_ep_comp_desc,
1913 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
1914 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
1915 (struct usb_descriptor_header *) &uasp_bo_ep_comp_desc,
1916 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
1917 (struct usb_descriptor_header *) &uasp_ss_status_desc,
1918 (struct usb_descriptor_header *) &uasp_status_in_ep_comp_desc,
1919 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
1920 (struct usb_descriptor_header *) &uasp_ss_cmd_desc,
1921 (struct usb_descriptor_header *) &uasp_cmd_comp_desc,
1922 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
1926 static struct usb_string tcm_us_strings[] = {
1927 [USB_G_STR_INT_UAS].s = "USB Attached SCSI",
1928 [USB_G_STR_INT_BBB].s = "Bulk Only Transport",
1932 static struct usb_gadget_strings tcm_stringtab = {
1934 .strings = tcm_us_strings,
1937 static struct usb_gadget_strings *tcm_strings[] = {
1942 static int tcm_bind(struct usb_configuration *c, struct usb_function *f)
1944 struct f_uas *fu = to_f_uas(f);
1945 struct usb_string *us;
1946 struct usb_gadget *gadget = c->cdev->gadget;
1948 struct f_tcm_opts *opts;
1952 opts = container_of(f->fi, struct f_tcm_opts, func_inst);
1954 mutex_lock(&opts->dep_lock);
1955 if (!opts->can_attach) {
1956 mutex_unlock(&opts->dep_lock);
1959 mutex_unlock(&opts->dep_lock);
1960 us = usb_gstrings_attach(c->cdev, tcm_strings,
1961 ARRAY_SIZE(tcm_us_strings));
1964 bot_intf_desc.iInterface = us[USB_G_STR_INT_BBB].id;
1965 uasp_intf_desc.iInterface = us[USB_G_STR_INT_UAS].id;
1967 iface = usb_interface_id(c, f);
1971 bot_intf_desc.bInterfaceNumber = iface;
1972 uasp_intf_desc.bInterfaceNumber = iface;
1974 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bi_desc,
1975 &uasp_bi_ep_comp_desc);
1981 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bo_desc,
1982 &uasp_bo_ep_comp_desc);
1987 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_status_desc,
1988 &uasp_status_in_ep_comp_desc);
1993 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_cmd_desc,
1994 &uasp_cmd_comp_desc);
1999 /* Assume endpoint addresses are the same for both speeds */
2000 uasp_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2001 uasp_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2002 uasp_status_desc.bEndpointAddress =
2003 uasp_ss_status_desc.bEndpointAddress;
2004 uasp_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2006 uasp_fs_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2007 uasp_fs_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2008 uasp_fs_status_desc.bEndpointAddress =
2009 uasp_ss_status_desc.bEndpointAddress;
2010 uasp_fs_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2012 ret = usb_assign_descriptors(f, uasp_fs_function_desc,
2013 uasp_hs_function_desc, uasp_ss_function_desc,
2014 uasp_ss_function_desc);
2020 pr_err("Can't claim all required eps\n");
2025 struct guas_setup_wq {
2026 struct work_struct work;
2031 static void tcm_delayed_set_alt(struct work_struct *wq)
2033 struct guas_setup_wq *work = container_of(wq, struct guas_setup_wq,
2035 struct f_uas *fu = work->fu;
2036 int alt = work->alt;
2040 if (fu->flags & USBG_IS_BOT)
2041 bot_cleanup_old_alt(fu);
2042 if (fu->flags & USBG_IS_UAS)
2043 uasp_cleanup_old_alt(fu);
2045 if (alt == USB_G_ALT_INT_BBB)
2047 else if (alt == USB_G_ALT_INT_UAS)
2049 usb_composite_setup_continue(fu->function.config->cdev);
2052 static int tcm_get_alt(struct usb_function *f, unsigned intf)
2054 if (intf == bot_intf_desc.bInterfaceNumber)
2055 return USB_G_ALT_INT_BBB;
2056 if (intf == uasp_intf_desc.bInterfaceNumber)
2057 return USB_G_ALT_INT_UAS;
2062 static int tcm_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2064 struct f_uas *fu = to_f_uas(f);
2066 if ((alt == USB_G_ALT_INT_BBB) || (alt == USB_G_ALT_INT_UAS)) {
2067 struct guas_setup_wq *work;
2069 work = kmalloc(sizeof(*work), GFP_ATOMIC);
2072 INIT_WORK(&work->work, tcm_delayed_set_alt);
2075 schedule_work(&work->work);
2076 return USB_GADGET_DELAYED_STATUS;
2081 static void tcm_disable(struct usb_function *f)
2083 struct f_uas *fu = to_f_uas(f);
2085 if (fu->flags & USBG_IS_UAS)
2086 uasp_cleanup_old_alt(fu);
2087 else if (fu->flags & USBG_IS_BOT)
2088 bot_cleanup_old_alt(fu);
2092 static int tcm_setup(struct usb_function *f,
2093 const struct usb_ctrlrequest *ctrl)
2095 struct f_uas *fu = to_f_uas(f);
2097 if (!(fu->flags & USBG_IS_BOT))
2100 return usbg_bot_setup(f, ctrl);
2103 static inline struct f_tcm_opts *to_f_tcm_opts(struct config_item *item)
2105 return container_of(to_config_group(item), struct f_tcm_opts,
2109 static void tcm_attr_release(struct config_item *item)
2111 struct f_tcm_opts *opts = to_f_tcm_opts(item);
2113 usb_put_function_instance(&opts->func_inst);
2116 static struct configfs_item_operations tcm_item_ops = {
2117 .release = tcm_attr_release,
2120 static const struct config_item_type tcm_func_type = {
2121 .ct_item_ops = &tcm_item_ops,
2122 .ct_owner = THIS_MODULE,
2125 static void tcm_free_inst(struct usb_function_instance *f)
2127 struct f_tcm_opts *opts;
2130 opts = container_of(f, struct f_tcm_opts, func_inst);
2132 mutex_lock(&tpg_instances_lock);
2133 for (i = 0; i < TPG_INSTANCES; ++i)
2134 if (tpg_instances[i].func_inst == f)
2136 if (i < TPG_INSTANCES)
2137 tpg_instances[i].func_inst = NULL;
2138 mutex_unlock(&tpg_instances_lock);
2143 static int tcm_register_callback(struct usb_function_instance *f)
2145 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2147 mutex_lock(&opts->dep_lock);
2148 opts->can_attach = true;
2149 mutex_unlock(&opts->dep_lock);
2154 static void tcm_unregister_callback(struct usb_function_instance *f)
2156 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2158 mutex_lock(&opts->dep_lock);
2159 unregister_gadget_item(opts->
2160 func_inst.group.cg_item.ci_parent->ci_parent);
2161 opts->can_attach = false;
2162 mutex_unlock(&opts->dep_lock);
2165 static int usbg_attach(struct usbg_tpg *tpg)
2167 struct usb_function_instance *f = tpg->fi;
2168 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2170 if (opts->tcm_register_callback)
2171 return opts->tcm_register_callback(f);
2176 static void usbg_detach(struct usbg_tpg *tpg)
2178 struct usb_function_instance *f = tpg->fi;
2179 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2181 if (opts->tcm_unregister_callback)
2182 opts->tcm_unregister_callback(f);
2185 static int tcm_set_name(struct usb_function_instance *f, const char *name)
2187 struct f_tcm_opts *opts = container_of(f, struct f_tcm_opts, func_inst);
2189 pr_debug("tcm: Activating %s\n", name);
2191 mutex_lock(&opts->dep_lock);
2193 mutex_unlock(&opts->dep_lock);
2198 static struct usb_function_instance *tcm_alloc_inst(void)
2200 struct f_tcm_opts *opts;
2204 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
2206 return ERR_PTR(-ENOMEM);
2208 mutex_lock(&tpg_instances_lock);
2209 for (i = 0; i < TPG_INSTANCES; ++i)
2210 if (!tpg_instances[i].func_inst)
2213 if (i == TPG_INSTANCES) {
2214 mutex_unlock(&tpg_instances_lock);
2216 return ERR_PTR(-EBUSY);
2218 tpg_instances[i].func_inst = &opts->func_inst;
2219 mutex_unlock(&tpg_instances_lock);
2221 mutex_init(&opts->dep_lock);
2222 opts->func_inst.set_inst_name = tcm_set_name;
2223 opts->func_inst.free_func_inst = tcm_free_inst;
2224 opts->tcm_register_callback = tcm_register_callback;
2225 opts->tcm_unregister_callback = tcm_unregister_callback;
2227 config_group_init_type_name(&opts->func_inst.group, "",
2230 return &opts->func_inst;
2233 static void tcm_free(struct usb_function *f)
2235 struct f_uas *tcm = to_f_uas(f);
2240 static void tcm_unbind(struct usb_configuration *c, struct usb_function *f)
2242 usb_free_all_descriptors(f);
2245 static struct usb_function *tcm_alloc(struct usb_function_instance *fi)
2250 mutex_lock(&tpg_instances_lock);
2251 for (i = 0; i < TPG_INSTANCES; ++i)
2252 if (tpg_instances[i].func_inst == fi)
2254 if (i == TPG_INSTANCES) {
2255 mutex_unlock(&tpg_instances_lock);
2256 return ERR_PTR(-ENODEV);
2259 fu = kzalloc(sizeof(*fu), GFP_KERNEL);
2261 mutex_unlock(&tpg_instances_lock);
2262 return ERR_PTR(-ENOMEM);
2265 fu->function.name = "Target Function";
2266 fu->function.bind = tcm_bind;
2267 fu->function.unbind = tcm_unbind;
2268 fu->function.set_alt = tcm_set_alt;
2269 fu->function.get_alt = tcm_get_alt;
2270 fu->function.setup = tcm_setup;
2271 fu->function.disable = tcm_disable;
2272 fu->function.free_func = tcm_free;
2273 fu->tpg = tpg_instances[i].tpg;
2274 mutex_unlock(&tpg_instances_lock);
2276 return &fu->function;
2279 DECLARE_USB_FUNCTION(tcm, tcm_alloc_inst, tcm_alloc);
2281 static int __init tcm_init(void)
2285 ret = usb_function_register(&tcmusb_func);
2289 ret = target_register_template(&usbg_ops);
2291 usb_function_unregister(&tcmusb_func);
2295 module_init(tcm_init);
2297 static void __exit tcm_exit(void)
2299 target_unregister_template(&usbg_ops);
2300 usb_function_unregister(&tcmusb_func);
2302 module_exit(tcm_exit);
2304 MODULE_LICENSE("GPL");
2305 MODULE_AUTHOR("Sebastian Andrzej Siewior");