1 /* Target based USB-Gadget
3 * UAS protocol handling, target callbacks, configfs handling,
4 * BBB (USB Mass Storage Class Bulk-Only (BBB) and Transport protocol handling.
6 * Author: Sebastian Andrzej Siewior <bigeasy at linutronix dot de>
7 * License: GPLv2 as published by FSF.
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/string.h>
13 #include <linux/configfs.h>
14 #include <linux/ctype.h>
15 #include <linux/usb/ch9.h>
16 #include <linux/usb/composite.h>
17 #include <linux/usb/gadget.h>
18 #include <linux/usb/storage.h>
19 #include <scsi/scsi.h>
20 #include <scsi/scsi_tcq.h>
21 #include <target/target_core_base.h>
22 #include <target/target_core_fabric.h>
23 #include <target/target_core_fabric_configfs.h>
24 #include <target/target_core_configfs.h>
25 #include <target/configfs_macros.h>
26 #include <asm/unaligned.h>
28 #include "tcm_usb_gadget.h"
30 USB_GADGET_COMPOSITE_OPTIONS();
32 static const struct target_core_fabric_ops usbg_ops;
34 static inline struct f_uas *to_f_uas(struct usb_function *f)
36 return container_of(f, struct f_uas, function);
39 static void usbg_cmd_release(struct kref *);
41 static inline void usbg_cleanup_cmd(struct usbg_cmd *cmd)
43 kref_put(&cmd->ref, usbg_cmd_release);
46 /* Start bot.c code */
48 static int bot_enqueue_cmd_cbw(struct f_uas *fu)
52 if (fu->flags & USBG_BOT_CMD_PEND)
55 ret = usb_ep_queue(fu->ep_out, fu->cmd.req, GFP_ATOMIC);
57 fu->flags |= USBG_BOT_CMD_PEND;
61 static void bot_status_complete(struct usb_ep *ep, struct usb_request *req)
63 struct usbg_cmd *cmd = req->context;
64 struct f_uas *fu = cmd->fu;
66 usbg_cleanup_cmd(cmd);
67 if (req->status < 0) {
68 pr_err("ERR %s(%d)\n", __func__, __LINE__);
72 /* CSW completed, wait for next CBW */
73 bot_enqueue_cmd_cbw(fu);
76 static void bot_enqueue_sense_code(struct f_uas *fu, struct usbg_cmd *cmd)
78 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
81 unsigned int csw_stat;
83 csw_stat = cmd->csw_code;
86 * We can't send SENSE as a response. So we take ASC & ASCQ from our
87 * sense buffer and queue it and hope the host sends a REQUEST_SENSE
88 * command where it learns why we failed.
90 sense = cmd->sense_iu.sense;
92 csw->Tag = cmd->bot_tag;
93 csw->Status = csw_stat;
94 fu->bot_status.req->context = cmd;
95 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_ATOMIC);
97 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
100 static void bot_err_compl(struct usb_ep *ep, struct usb_request *req)
102 struct usbg_cmd *cmd = req->context;
103 struct f_uas *fu = cmd->fu;
106 pr_err("ERR %s(%d)\n", __func__, __LINE__);
109 if (cmd->data_len > ep->maxpacket) {
110 req->length = ep->maxpacket;
111 cmd->data_len -= ep->maxpacket;
113 req->length = cmd->data_len;
117 usb_ep_queue(ep, req, GFP_ATOMIC);
120 bot_enqueue_sense_code(fu, cmd);
123 static void bot_send_bad_status(struct usbg_cmd *cmd)
125 struct f_uas *fu = cmd->fu;
126 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
127 struct usb_request *req;
130 csw->Residue = cpu_to_le32(cmd->data_len);
135 req = fu->bot_req_in;
138 req = fu->bot_req_out;
141 if (cmd->data_len > fu->ep_in->maxpacket) {
142 req->length = ep->maxpacket;
143 cmd->data_len -= ep->maxpacket;
145 req->length = cmd->data_len;
148 req->complete = bot_err_compl;
150 req->buf = fu->cmd.buf;
151 usb_ep_queue(ep, req, GFP_KERNEL);
153 bot_enqueue_sense_code(fu, cmd);
157 static int bot_send_status(struct usbg_cmd *cmd, bool moved_data)
159 struct f_uas *fu = cmd->fu;
160 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
163 if (cmd->se_cmd.scsi_status == SAM_STAT_GOOD) {
164 if (!moved_data && cmd->data_len) {
166 * the host wants to move data, we don't. Fill / empty
167 * the pipe and then send the csw with reside set.
169 cmd->csw_code = US_BULK_STAT_OK;
170 bot_send_bad_status(cmd);
174 csw->Tag = cmd->bot_tag;
175 csw->Residue = cpu_to_le32(0);
176 csw->Status = US_BULK_STAT_OK;
177 fu->bot_status.req->context = cmd;
179 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_KERNEL);
181 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
183 cmd->csw_code = US_BULK_STAT_FAIL;
184 bot_send_bad_status(cmd);
190 * Called after command (no data transfer) or after the write (to device)
191 * operation is completed
193 static int bot_send_status_response(struct usbg_cmd *cmd)
195 bool moved_data = false;
199 return bot_send_status(cmd, moved_data);
202 /* Read request completed, now we have to send the CSW */
203 static void bot_read_compl(struct usb_ep *ep, struct usb_request *req)
205 struct usbg_cmd *cmd = req->context;
208 pr_err("ERR %s(%d)\n", __func__, __LINE__);
210 bot_send_status(cmd, true);
213 static int bot_send_read_response(struct usbg_cmd *cmd)
215 struct f_uas *fu = cmd->fu;
216 struct se_cmd *se_cmd = &cmd->se_cmd;
217 struct usb_gadget *gadget = fuas_to_gadget(fu);
220 if (!cmd->data_len) {
221 cmd->csw_code = US_BULK_STAT_PHASE;
222 bot_send_bad_status(cmd);
226 if (!gadget->sg_supported) {
227 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
231 sg_copy_to_buffer(se_cmd->t_data_sg,
232 se_cmd->t_data_nents,
234 se_cmd->data_length);
236 fu->bot_req_in->buf = cmd->data_buf;
238 fu->bot_req_in->buf = NULL;
239 fu->bot_req_in->num_sgs = se_cmd->t_data_nents;
240 fu->bot_req_in->sg = se_cmd->t_data_sg;
243 fu->bot_req_in->complete = bot_read_compl;
244 fu->bot_req_in->length = se_cmd->data_length;
245 fu->bot_req_in->context = cmd;
246 ret = usb_ep_queue(fu->ep_in, fu->bot_req_in, GFP_ATOMIC);
248 pr_err("%s(%d)\n", __func__, __LINE__);
252 static void usbg_data_write_cmpl(struct usb_ep *, struct usb_request *);
253 static int usbg_prepare_w_request(struct usbg_cmd *, struct usb_request *);
255 static int bot_send_write_request(struct usbg_cmd *cmd)
257 struct f_uas *fu = cmd->fu;
258 struct se_cmd *se_cmd = &cmd->se_cmd;
259 struct usb_gadget *gadget = fuas_to_gadget(fu);
262 init_completion(&cmd->write_complete);
265 if (!cmd->data_len) {
266 cmd->csw_code = US_BULK_STAT_PHASE;
270 if (!gadget->sg_supported) {
271 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_KERNEL);
275 fu->bot_req_out->buf = cmd->data_buf;
277 fu->bot_req_out->buf = NULL;
278 fu->bot_req_out->num_sgs = se_cmd->t_data_nents;
279 fu->bot_req_out->sg = se_cmd->t_data_sg;
282 fu->bot_req_out->complete = usbg_data_write_cmpl;
283 fu->bot_req_out->length = se_cmd->data_length;
284 fu->bot_req_out->context = cmd;
286 ret = usbg_prepare_w_request(cmd, fu->bot_req_out);
289 ret = usb_ep_queue(fu->ep_out, fu->bot_req_out, GFP_KERNEL);
291 pr_err("%s(%d)\n", __func__, __LINE__);
293 wait_for_completion(&cmd->write_complete);
294 target_execute_cmd(se_cmd);
299 static int bot_submit_command(struct f_uas *, void *, unsigned int);
301 static void bot_cmd_complete(struct usb_ep *ep, struct usb_request *req)
303 struct f_uas *fu = req->context;
306 fu->flags &= ~USBG_BOT_CMD_PEND;
311 ret = bot_submit_command(fu, req->buf, req->actual);
313 pr_err("%s(%d): %d\n", __func__, __LINE__, ret);
316 static int bot_prepare_reqs(struct f_uas *fu)
320 fu->bot_req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
324 fu->bot_req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
325 if (!fu->bot_req_out)
328 fu->cmd.req = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
332 fu->bot_status.req = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
333 if (!fu->bot_status.req)
336 fu->bot_status.req->buf = &fu->bot_status.csw;
337 fu->bot_status.req->length = US_BULK_CS_WRAP_LEN;
338 fu->bot_status.req->complete = bot_status_complete;
339 fu->bot_status.csw.Signature = cpu_to_le32(US_BULK_CS_SIGN);
341 fu->cmd.buf = kmalloc(fu->ep_out->maxpacket, GFP_KERNEL);
345 fu->cmd.req->complete = bot_cmd_complete;
346 fu->cmd.req->buf = fu->cmd.buf;
347 fu->cmd.req->length = fu->ep_out->maxpacket;
348 fu->cmd.req->context = fu;
350 ret = bot_enqueue_cmd_cbw(fu);
358 usb_ep_free_request(fu->ep_in, fu->bot_status.req);
360 usb_ep_free_request(fu->ep_out, fu->cmd.req);
363 usb_ep_free_request(fu->ep_out, fu->bot_req_out);
364 fu->bot_req_out = NULL;
366 usb_ep_free_request(fu->ep_in, fu->bot_req_in);
367 fu->bot_req_in = NULL;
369 pr_err("BOT: endpoint setup failed\n");
373 static void bot_cleanup_old_alt(struct f_uas *fu)
375 if (!(fu->flags & USBG_ENABLED))
378 usb_ep_disable(fu->ep_in);
379 usb_ep_disable(fu->ep_out);
384 usb_ep_free_request(fu->ep_in, fu->bot_req_in);
385 usb_ep_free_request(fu->ep_out, fu->bot_req_out);
386 usb_ep_free_request(fu->ep_out, fu->cmd.req);
387 usb_ep_free_request(fu->ep_out, fu->bot_status.req);
391 fu->bot_req_in = NULL;
392 fu->bot_req_out = NULL;
394 fu->bot_status.req = NULL;
398 static void bot_set_alt(struct f_uas *fu)
400 struct usb_function *f = &fu->function;
401 struct usb_gadget *gadget = f->config->cdev->gadget;
404 fu->flags = USBG_IS_BOT;
406 config_ep_by_speed(gadget, f, fu->ep_in);
407 ret = usb_ep_enable(fu->ep_in);
411 config_ep_by_speed(gadget, f, fu->ep_out);
412 ret = usb_ep_enable(fu->ep_out);
416 ret = bot_prepare_reqs(fu);
419 fu->flags |= USBG_ENABLED;
420 pr_info("Using the BOT protocol\n");
423 usb_ep_disable(fu->ep_out);
425 usb_ep_disable(fu->ep_in);
427 fu->flags = USBG_IS_BOT;
430 static int usbg_bot_setup(struct usb_function *f,
431 const struct usb_ctrlrequest *ctrl)
433 struct f_uas *fu = to_f_uas(f);
434 struct usb_composite_dev *cdev = f->config->cdev;
435 u16 w_value = le16_to_cpu(ctrl->wValue);
436 u16 w_length = le16_to_cpu(ctrl->wLength);
440 switch (ctrl->bRequest) {
441 case US_BULK_GET_MAX_LUN:
442 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_CLASS |
443 USB_RECIP_INTERFACE))
450 luns = atomic_read(&fu->tpg->tpg_port_count);
452 pr_err("No LUNs configured?\n");
456 * If 4 LUNs are present we return 3 i.e. LUN 0..3 can be
457 * accessed. The upper limit is 0xf
461 pr_info_once("Limiting the number of luns to 16\n");
464 ret_lun = cdev->req->buf;
466 cdev->req->length = 1;
467 return usb_ep_queue(cdev->gadget->ep0, cdev->req, GFP_ATOMIC);
470 case US_BULK_RESET_REQUEST:
471 /* XXX maybe we should remove previous requests for IN + OUT */
472 bot_enqueue_cmd_cbw(fu);
479 /* Start uas.c code */
481 static void uasp_cleanup_one_stream(struct f_uas *fu, struct uas_stream *stream)
483 /* We have either all three allocated or none */
487 usb_ep_free_request(fu->ep_in, stream->req_in);
488 usb_ep_free_request(fu->ep_out, stream->req_out);
489 usb_ep_free_request(fu->ep_status, stream->req_status);
491 stream->req_in = NULL;
492 stream->req_out = NULL;
493 stream->req_status = NULL;
496 static void uasp_free_cmdreq(struct f_uas *fu)
498 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
504 static void uasp_cleanup_old_alt(struct f_uas *fu)
508 if (!(fu->flags & USBG_ENABLED))
511 usb_ep_disable(fu->ep_in);
512 usb_ep_disable(fu->ep_out);
513 usb_ep_disable(fu->ep_status);
514 usb_ep_disable(fu->ep_cmd);
516 for (i = 0; i < UASP_SS_EP_COMP_NUM_STREAMS; i++)
517 uasp_cleanup_one_stream(fu, &fu->stream[i]);
518 uasp_free_cmdreq(fu);
521 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req);
523 static int uasp_prepare_r_request(struct usbg_cmd *cmd)
525 struct se_cmd *se_cmd = &cmd->se_cmd;
526 struct f_uas *fu = cmd->fu;
527 struct usb_gadget *gadget = fuas_to_gadget(fu);
528 struct uas_stream *stream = cmd->stream;
530 if (!gadget->sg_supported) {
531 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
535 sg_copy_to_buffer(se_cmd->t_data_sg,
536 se_cmd->t_data_nents,
538 se_cmd->data_length);
540 stream->req_in->buf = cmd->data_buf;
542 stream->req_in->buf = NULL;
543 stream->req_in->num_sgs = se_cmd->t_data_nents;
544 stream->req_in->sg = se_cmd->t_data_sg;
547 stream->req_in->complete = uasp_status_data_cmpl;
548 stream->req_in->length = se_cmd->data_length;
549 stream->req_in->context = cmd;
551 cmd->state = UASP_SEND_STATUS;
555 static void uasp_prepare_status(struct usbg_cmd *cmd)
557 struct se_cmd *se_cmd = &cmd->se_cmd;
558 struct sense_iu *iu = &cmd->sense_iu;
559 struct uas_stream *stream = cmd->stream;
561 cmd->state = UASP_QUEUE_COMMAND;
562 iu->iu_id = IU_ID_STATUS;
563 iu->tag = cpu_to_be16(cmd->tag);
566 * iu->status_qual = cpu_to_be16(STATUS QUALIFIER SAM-4. Where R U?);
568 iu->len = cpu_to_be16(se_cmd->scsi_sense_length);
569 iu->status = se_cmd->scsi_status;
570 stream->req_status->context = cmd;
571 stream->req_status->length = se_cmd->scsi_sense_length + 16;
572 stream->req_status->buf = iu;
573 stream->req_status->complete = uasp_status_data_cmpl;
576 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req)
578 struct usbg_cmd *cmd = req->context;
579 struct uas_stream *stream = cmd->stream;
580 struct f_uas *fu = cmd->fu;
586 switch (cmd->state) {
588 ret = uasp_prepare_r_request(cmd);
591 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
593 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
596 case UASP_RECEIVE_DATA:
597 ret = usbg_prepare_w_request(cmd, stream->req_out);
600 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
602 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
605 case UASP_SEND_STATUS:
606 uasp_prepare_status(cmd);
607 ret = usb_ep_queue(fu->ep_status, stream->req_status,
610 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
613 case UASP_QUEUE_COMMAND:
614 usbg_cleanup_cmd(cmd);
615 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
624 usbg_cleanup_cmd(cmd);
627 static int uasp_send_status_response(struct usbg_cmd *cmd)
629 struct f_uas *fu = cmd->fu;
630 struct uas_stream *stream = cmd->stream;
631 struct sense_iu *iu = &cmd->sense_iu;
633 iu->tag = cpu_to_be16(cmd->tag);
634 stream->req_status->complete = uasp_status_data_cmpl;
635 stream->req_status->context = cmd;
637 uasp_prepare_status(cmd);
638 return usb_ep_queue(fu->ep_status, stream->req_status, GFP_ATOMIC);
641 static int uasp_send_read_response(struct usbg_cmd *cmd)
643 struct f_uas *fu = cmd->fu;
644 struct uas_stream *stream = cmd->stream;
645 struct sense_iu *iu = &cmd->sense_iu;
650 iu->tag = cpu_to_be16(cmd->tag);
651 if (fu->flags & USBG_USE_STREAMS) {
653 ret = uasp_prepare_r_request(cmd);
656 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
658 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
659 kfree(cmd->data_buf);
660 cmd->data_buf = NULL;
665 iu->iu_id = IU_ID_READ_READY;
666 iu->tag = cpu_to_be16(cmd->tag);
668 stream->req_status->complete = uasp_status_data_cmpl;
669 stream->req_status->context = cmd;
671 cmd->state = UASP_SEND_DATA;
672 stream->req_status->buf = iu;
673 stream->req_status->length = sizeof(struct iu);
675 ret = usb_ep_queue(fu->ep_status, stream->req_status,
678 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
684 static int uasp_send_write_request(struct usbg_cmd *cmd)
686 struct f_uas *fu = cmd->fu;
687 struct se_cmd *se_cmd = &cmd->se_cmd;
688 struct uas_stream *stream = cmd->stream;
689 struct sense_iu *iu = &cmd->sense_iu;
692 init_completion(&cmd->write_complete);
695 iu->tag = cpu_to_be16(cmd->tag);
697 if (fu->flags & USBG_USE_STREAMS) {
699 ret = usbg_prepare_w_request(cmd, stream->req_out);
702 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
704 pr_err("%s(%d)\n", __func__, __LINE__);
708 iu->iu_id = IU_ID_WRITE_READY;
709 iu->tag = cpu_to_be16(cmd->tag);
711 stream->req_status->complete = uasp_status_data_cmpl;
712 stream->req_status->context = cmd;
714 cmd->state = UASP_RECEIVE_DATA;
715 stream->req_status->buf = iu;
716 stream->req_status->length = sizeof(struct iu);
718 ret = usb_ep_queue(fu->ep_status, stream->req_status,
721 pr_err("%s(%d)\n", __func__, __LINE__);
724 wait_for_completion(&cmd->write_complete);
725 target_execute_cmd(se_cmd);
730 static int usbg_submit_command(struct f_uas *, void *, unsigned int);
732 static void uasp_cmd_complete(struct usb_ep *ep, struct usb_request *req)
734 struct f_uas *fu = req->context;
740 ret = usbg_submit_command(fu, req->buf, req->actual);
742 * Once we tune for performance enqueue the command req here again so
743 * we can receive a second command while we processing this one. Pay
744 * attention to properly sync STAUS endpoint with DATA IN + OUT so you
749 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
752 static int uasp_alloc_stream_res(struct f_uas *fu, struct uas_stream *stream)
754 stream->req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
758 stream->req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
759 if (!stream->req_out)
762 stream->req_status = usb_ep_alloc_request(fu->ep_status, GFP_KERNEL);
763 if (!stream->req_status)
768 usb_ep_free_request(fu->ep_status, stream->req_status);
769 stream->req_status = NULL;
771 usb_ep_free_request(fu->ep_out, stream->req_out);
772 stream->req_out = NULL;
777 static int uasp_alloc_cmd(struct f_uas *fu)
779 fu->cmd.req = usb_ep_alloc_request(fu->ep_cmd, GFP_KERNEL);
783 fu->cmd.buf = kmalloc(fu->ep_cmd->maxpacket, GFP_KERNEL);
787 fu->cmd.req->complete = uasp_cmd_complete;
788 fu->cmd.req->buf = fu->cmd.buf;
789 fu->cmd.req->length = fu->ep_cmd->maxpacket;
790 fu->cmd.req->context = fu;
794 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
799 static void uasp_setup_stream_res(struct f_uas *fu, int max_streams)
803 for (i = 0; i < max_streams; i++) {
804 struct uas_stream *s = &fu->stream[i];
806 s->req_in->stream_id = i + 1;
807 s->req_out->stream_id = i + 1;
808 s->req_status->stream_id = i + 1;
812 static int uasp_prepare_reqs(struct f_uas *fu)
818 if (fu->flags & USBG_USE_STREAMS)
819 max_streams = UASP_SS_EP_COMP_NUM_STREAMS;
823 for (i = 0; i < max_streams; i++) {
824 ret = uasp_alloc_stream_res(fu, &fu->stream[i]);
829 ret = uasp_alloc_cmd(fu);
831 goto err_free_stream;
832 uasp_setup_stream_res(fu, max_streams);
834 ret = usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
836 goto err_free_stream;
841 uasp_free_cmdreq(fu);
846 uasp_cleanup_one_stream(fu, &fu->stream[i - 1]);
850 pr_err("UASP: endpoint setup failed\n");
854 static void uasp_set_alt(struct f_uas *fu)
856 struct usb_function *f = &fu->function;
857 struct usb_gadget *gadget = f->config->cdev->gadget;
860 fu->flags = USBG_IS_UAS;
862 if (gadget->speed == USB_SPEED_SUPER)
863 fu->flags |= USBG_USE_STREAMS;
865 config_ep_by_speed(gadget, f, fu->ep_in);
866 ret = usb_ep_enable(fu->ep_in);
870 config_ep_by_speed(gadget, f, fu->ep_out);
871 ret = usb_ep_enable(fu->ep_out);
875 config_ep_by_speed(gadget, f, fu->ep_cmd);
876 ret = usb_ep_enable(fu->ep_cmd);
879 config_ep_by_speed(gadget, f, fu->ep_status);
880 ret = usb_ep_enable(fu->ep_status);
884 ret = uasp_prepare_reqs(fu);
887 fu->flags |= USBG_ENABLED;
889 pr_info("Using the UAS protocol\n");
892 usb_ep_disable(fu->ep_status);
894 usb_ep_disable(fu->ep_cmd);
896 usb_ep_disable(fu->ep_out);
898 usb_ep_disable(fu->ep_in);
903 static int get_cmd_dir(const unsigned char *cdb)
915 case SERVICE_ACTION_IN_16:
917 case PERSISTENT_RESERVE_IN:
918 case SECURITY_PROTOCOL_IN:
919 case ACCESS_CONTROL_IN:
921 case READ_BLOCK_LIMITS:
925 case READ_FORMAT_CAPACITIES:
927 ret = DMA_FROM_DEVICE;
937 case WRITE_VERIFY_12:
938 case PERSISTENT_RESERVE_OUT:
939 case MAINTENANCE_OUT:
940 case SECURITY_PROTOCOL_OUT:
941 case ACCESS_CONTROL_OUT:
944 case ALLOW_MEDIUM_REMOVAL:
945 case TEST_UNIT_READY:
946 case SYNCHRONIZE_CACHE:
953 case WRITE_FILEMARKS:
957 pr_warn("target: Unknown data direction for SCSI Opcode "
964 static void usbg_data_write_cmpl(struct usb_ep *ep, struct usb_request *req)
966 struct usbg_cmd *cmd = req->context;
967 struct se_cmd *se_cmd = &cmd->se_cmd;
969 if (req->status < 0) {
970 pr_err("%s() state %d transfer failed\n", __func__, cmd->state);
974 if (req->num_sgs == 0) {
975 sg_copy_from_buffer(se_cmd->t_data_sg,
976 se_cmd->t_data_nents,
978 se_cmd->data_length);
981 complete(&cmd->write_complete);
985 usbg_cleanup_cmd(cmd);
988 static int usbg_prepare_w_request(struct usbg_cmd *cmd, struct usb_request *req)
990 struct se_cmd *se_cmd = &cmd->se_cmd;
991 struct f_uas *fu = cmd->fu;
992 struct usb_gadget *gadget = fuas_to_gadget(fu);
994 if (!gadget->sg_supported) {
995 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
999 req->buf = cmd->data_buf;
1002 req->num_sgs = se_cmd->t_data_nents;
1003 req->sg = se_cmd->t_data_sg;
1006 req->complete = usbg_data_write_cmpl;
1007 req->length = se_cmd->data_length;
1012 static int usbg_send_status_response(struct se_cmd *se_cmd)
1014 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1016 struct f_uas *fu = cmd->fu;
1018 if (fu->flags & USBG_IS_BOT)
1019 return bot_send_status_response(cmd);
1021 return uasp_send_status_response(cmd);
1024 static int usbg_send_write_request(struct se_cmd *se_cmd)
1026 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1028 struct f_uas *fu = cmd->fu;
1030 if (fu->flags & USBG_IS_BOT)
1031 return bot_send_write_request(cmd);
1033 return uasp_send_write_request(cmd);
1036 static int usbg_send_read_response(struct se_cmd *se_cmd)
1038 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1040 struct f_uas *fu = cmd->fu;
1042 if (fu->flags & USBG_IS_BOT)
1043 return bot_send_read_response(cmd);
1045 return uasp_send_read_response(cmd);
1048 static void usbg_cmd_work(struct work_struct *work)
1050 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1051 struct se_cmd *se_cmd;
1052 struct tcm_usbg_nexus *tv_nexus;
1053 struct usbg_tpg *tpg;
1056 se_cmd = &cmd->se_cmd;
1058 tv_nexus = tpg->tpg_nexus;
1059 dir = get_cmd_dir(cmd->cmd_buf);
1061 transport_init_se_cmd(se_cmd,
1062 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1063 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1064 cmd->prio_attr, cmd->sense_iu.sense);
1068 if (target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1069 cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1070 0, cmd->prio_attr, dir, TARGET_SCF_UNKNOWN_SIZE) < 0)
1076 transport_send_check_condition_and_sense(se_cmd,
1077 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1078 usbg_cleanup_cmd(cmd);
1081 static int usbg_submit_command(struct f_uas *fu,
1082 void *cmdbuf, unsigned int len)
1084 struct command_iu *cmd_iu = cmdbuf;
1085 struct usbg_cmd *cmd;
1086 struct usbg_tpg *tpg;
1087 struct se_cmd *se_cmd;
1088 struct tcm_usbg_nexus *tv_nexus;
1092 if (cmd_iu->iu_id != IU_ID_COMMAND) {
1093 pr_err("Unsupported type %d\n", cmd_iu->iu_id);
1097 cmd = kzalloc(sizeof *cmd, GFP_ATOMIC);
1103 /* XXX until I figure out why I can't free in on complete */
1104 kref_init(&cmd->ref);
1105 kref_get(&cmd->ref);
1108 cmd_len = (cmd_iu->len & ~0x3) + 16;
1109 if (cmd_len > USBG_MAX_CMD)
1112 memcpy(cmd->cmd_buf, cmd_iu->cdb, cmd_len);
1114 cmd->tag = be16_to_cpup(&cmd_iu->tag);
1115 if (fu->flags & USBG_USE_STREAMS) {
1116 if (cmd->tag > UASP_SS_EP_COMP_NUM_STREAMS)
1119 cmd->stream = &fu->stream[0];
1121 cmd->stream = &fu->stream[cmd->tag - 1];
1123 cmd->stream = &fu->stream[0];
1126 tv_nexus = tpg->tpg_nexus;
1128 pr_err("Missing nexus, ignoring command\n");
1132 switch (cmd_iu->prio_attr & 0x7) {
1134 cmd->prio_attr = TCM_HEAD_TAG;
1136 case UAS_ORDERED_TAG:
1137 cmd->prio_attr = TCM_ORDERED_TAG;
1140 cmd->prio_attr = TCM_ACA_TAG;
1143 pr_debug_once("Unsupported prio_attr: %02x.\n",
1145 case UAS_SIMPLE_TAG:
1146 cmd->prio_attr = TCM_SIMPLE_TAG;
1150 se_cmd = &cmd->se_cmd;
1151 cmd->unpacked_lun = scsilun_to_int(&cmd_iu->lun);
1153 INIT_WORK(&cmd->work, usbg_cmd_work);
1154 ret = queue_work(tpg->workqueue, &cmd->work);
1164 static void bot_cmd_work(struct work_struct *work)
1166 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1167 struct se_cmd *se_cmd;
1168 struct tcm_usbg_nexus *tv_nexus;
1169 struct usbg_tpg *tpg;
1172 se_cmd = &cmd->se_cmd;
1174 tv_nexus = tpg->tpg_nexus;
1175 dir = get_cmd_dir(cmd->cmd_buf);
1177 transport_init_se_cmd(se_cmd,
1178 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1179 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1180 cmd->prio_attr, cmd->sense_iu.sense);
1184 if (target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1185 cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1186 cmd->data_len, cmd->prio_attr, dir, 0) < 0)
1192 transport_send_check_condition_and_sense(se_cmd,
1193 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1194 usbg_cleanup_cmd(cmd);
1197 static int bot_submit_command(struct f_uas *fu,
1198 void *cmdbuf, unsigned int len)
1200 struct bulk_cb_wrap *cbw = cmdbuf;
1201 struct usbg_cmd *cmd;
1202 struct usbg_tpg *tpg;
1203 struct se_cmd *se_cmd;
1204 struct tcm_usbg_nexus *tv_nexus;
1208 if (cbw->Signature != cpu_to_le32(US_BULK_CB_SIGN)) {
1209 pr_err("Wrong signature on CBW\n");
1213 pr_err("Wrong length for CBW\n");
1217 cmd_len = cbw->Length;
1218 if (cmd_len < 1 || cmd_len > 16)
1221 cmd = kzalloc(sizeof *cmd, GFP_ATOMIC);
1227 /* XXX until I figure out why I can't free in on complete */
1228 kref_init(&cmd->ref);
1229 kref_get(&cmd->ref);
1233 memcpy(cmd->cmd_buf, cbw->CDB, cmd_len);
1235 cmd->bot_tag = cbw->Tag;
1237 tv_nexus = tpg->tpg_nexus;
1239 pr_err("Missing nexus, ignoring command\n");
1243 cmd->prio_attr = TCM_SIMPLE_TAG;
1244 se_cmd = &cmd->se_cmd;
1245 cmd->unpacked_lun = cbw->Lun;
1246 cmd->is_read = cbw->Flags & US_BULK_FLAG_IN ? 1 : 0;
1247 cmd->data_len = le32_to_cpu(cbw->DataTransferLength);
1249 INIT_WORK(&cmd->work, bot_cmd_work);
1250 ret = queue_work(tpg->workqueue, &cmd->work);
1260 /* Start fabric.c code */
1262 static int usbg_check_true(struct se_portal_group *se_tpg)
1267 static int usbg_check_false(struct se_portal_group *se_tpg)
1272 static char *usbg_get_fabric_name(void)
1274 return "usb_gadget";
1277 static u8 usbg_get_fabric_proto_ident(struct se_portal_group *se_tpg)
1279 struct usbg_tpg *tpg = container_of(se_tpg,
1280 struct usbg_tpg, se_tpg);
1281 struct usbg_tport *tport = tpg->tport;
1284 switch (tport->tport_proto_id) {
1285 case SCSI_PROTOCOL_SAS:
1287 proto_id = sas_get_fabric_proto_ident(se_tpg);
1294 static char *usbg_get_fabric_wwn(struct se_portal_group *se_tpg)
1296 struct usbg_tpg *tpg = container_of(se_tpg,
1297 struct usbg_tpg, se_tpg);
1298 struct usbg_tport *tport = tpg->tport;
1300 return &tport->tport_name[0];
1303 static u16 usbg_get_tag(struct se_portal_group *se_tpg)
1305 struct usbg_tpg *tpg = container_of(se_tpg,
1306 struct usbg_tpg, se_tpg);
1307 return tpg->tport_tpgt;
1310 static u32 usbg_get_pr_transport_id(
1311 struct se_portal_group *se_tpg,
1312 struct se_node_acl *se_nacl,
1313 struct t10_pr_registration *pr_reg,
1317 struct usbg_tpg *tpg = container_of(se_tpg,
1318 struct usbg_tpg, se_tpg);
1319 struct usbg_tport *tport = tpg->tport;
1322 switch (tport->tport_proto_id) {
1323 case SCSI_PROTOCOL_SAS:
1325 ret = sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1333 static u32 usbg_get_pr_transport_id_len(
1334 struct se_portal_group *se_tpg,
1335 struct se_node_acl *se_nacl,
1336 struct t10_pr_registration *pr_reg,
1339 struct usbg_tpg *tpg = container_of(se_tpg,
1340 struct usbg_tpg, se_tpg);
1341 struct usbg_tport *tport = tpg->tport;
1344 switch (tport->tport_proto_id) {
1345 case SCSI_PROTOCOL_SAS:
1347 ret = sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1355 static char *usbg_parse_pr_out_transport_id(
1356 struct se_portal_group *se_tpg,
1359 char **port_nexus_ptr)
1361 struct usbg_tpg *tpg = container_of(se_tpg,
1362 struct usbg_tpg, se_tpg);
1363 struct usbg_tport *tport = tpg->tport;
1366 switch (tport->tport_proto_id) {
1367 case SCSI_PROTOCOL_SAS:
1369 tid = sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1376 static struct se_node_acl *usbg_alloc_fabric_acl(struct se_portal_group *se_tpg)
1378 return kzalloc(sizeof(struct se_node_acl), GFP_KERNEL);
1381 static void usbg_release_fabric_acl(
1382 struct se_portal_group *se_tpg,
1383 struct se_node_acl *se_nacl)
1388 static u32 usbg_tpg_get_inst_index(struct se_portal_group *se_tpg)
1393 static void usbg_cmd_release(struct kref *ref)
1395 struct usbg_cmd *cmd = container_of(ref, struct usbg_cmd,
1398 transport_generic_free_cmd(&cmd->se_cmd, 0);
1401 static void usbg_release_cmd(struct se_cmd *se_cmd)
1403 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1405 kfree(cmd->data_buf);
1410 static int usbg_shutdown_session(struct se_session *se_sess)
1415 static void usbg_close_session(struct se_session *se_sess)
1420 static u32 usbg_sess_get_index(struct se_session *se_sess)
1426 * XXX Error recovery: return != 0 if we expect writes. Dunno when that could be
1428 static int usbg_write_pending_status(struct se_cmd *se_cmd)
1433 static void usbg_set_default_node_attrs(struct se_node_acl *nacl)
1438 static u32 usbg_get_task_tag(struct se_cmd *se_cmd)
1440 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1442 struct f_uas *fu = cmd->fu;
1444 if (fu->flags & USBG_IS_BOT)
1445 return le32_to_cpu(cmd->bot_tag);
1450 static int usbg_get_cmd_state(struct se_cmd *se_cmd)
1455 static void usbg_queue_tm_rsp(struct se_cmd *se_cmd)
1459 static void usbg_aborted_task(struct se_cmd *se_cmd)
1464 static const char *usbg_check_wwn(const char *name)
1469 n = strstr(name, "naa.");
1474 if (len == 0 || len > USBG_NAMELEN - 1)
1479 static int usbg_init_nodeacl(struct se_node_acl *se_nacl, const char *name)
1481 if (!usbg_check_wwn(name))
1486 struct usbg_tpg *the_only_tpg_I_currently_have;
1488 static struct se_portal_group *usbg_make_tpg(
1490 struct config_group *group,
1493 struct usbg_tport *tport = container_of(wwn, struct usbg_tport,
1495 struct usbg_tpg *tpg;
1499 if (strstr(name, "tpgt_") != name)
1500 return ERR_PTR(-EINVAL);
1501 if (kstrtoul(name + 5, 0, &tpgt) || tpgt > UINT_MAX)
1502 return ERR_PTR(-EINVAL);
1503 if (the_only_tpg_I_currently_have) {
1504 pr_err("Until the gadget framework can't handle multiple\n");
1505 pr_err("gadgets, you can't do this here.\n");
1506 return ERR_PTR(-EBUSY);
1509 tpg = kzalloc(sizeof(struct usbg_tpg), GFP_KERNEL);
1511 return ERR_PTR(-ENOMEM);
1512 mutex_init(&tpg->tpg_mutex);
1513 atomic_set(&tpg->tpg_port_count, 0);
1514 tpg->workqueue = alloc_workqueue("tcm_usb_gadget", 0, 1);
1515 if (!tpg->workqueue) {
1521 tpg->tport_tpgt = tpgt;
1523 ret = core_tpg_register(&usbg_ops, wwn, &tpg->se_tpg, tpg,
1524 TRANSPORT_TPG_TYPE_NORMAL);
1526 destroy_workqueue(tpg->workqueue);
1530 the_only_tpg_I_currently_have = tpg;
1531 return &tpg->se_tpg;
1534 static void usbg_drop_tpg(struct se_portal_group *se_tpg)
1536 struct usbg_tpg *tpg = container_of(se_tpg,
1537 struct usbg_tpg, se_tpg);
1539 core_tpg_deregister(se_tpg);
1540 destroy_workqueue(tpg->workqueue);
1542 the_only_tpg_I_currently_have = NULL;
1545 static struct se_wwn *usbg_make_tport(
1546 struct target_fabric_configfs *tf,
1547 struct config_group *group,
1550 struct usbg_tport *tport;
1551 const char *wnn_name;
1554 wnn_name = usbg_check_wwn(name);
1556 return ERR_PTR(-EINVAL);
1558 tport = kzalloc(sizeof(struct usbg_tport), GFP_KERNEL);
1560 return ERR_PTR(-ENOMEM);
1561 tport->tport_wwpn = wwpn;
1562 snprintf(tport->tport_name, sizeof(tport->tport_name), "%s", wnn_name);
1563 return &tport->tport_wwn;
1566 static void usbg_drop_tport(struct se_wwn *wwn)
1568 struct usbg_tport *tport = container_of(wwn,
1569 struct usbg_tport, tport_wwn);
1574 * If somebody feels like dropping the version property, go ahead.
1576 static ssize_t usbg_wwn_show_attr_version(
1577 struct target_fabric_configfs *tf,
1580 return sprintf(page, "usb-gadget fabric module\n");
1582 TF_WWN_ATTR_RO(usbg, version);
1584 static struct configfs_attribute *usbg_wwn_attrs[] = {
1585 &usbg_wwn_version.attr,
1589 static ssize_t tcm_usbg_tpg_show_enable(
1590 struct se_portal_group *se_tpg,
1593 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1595 return snprintf(page, PAGE_SIZE, "%u\n", tpg->gadget_connect);
1598 static int usbg_attach(struct usbg_tpg *);
1599 static void usbg_detach(struct usbg_tpg *);
1601 static ssize_t tcm_usbg_tpg_store_enable(
1602 struct se_portal_group *se_tpg,
1606 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1610 ret = kstrtoul(page, 0, &op);
1616 if (op && tpg->gadget_connect)
1618 if (!op && !tpg->gadget_connect)
1622 ret = usbg_attach(tpg);
1628 tpg->gadget_connect = op;
1632 TF_TPG_BASE_ATTR(tcm_usbg, enable, S_IRUGO | S_IWUSR);
1634 static ssize_t tcm_usbg_tpg_show_nexus(
1635 struct se_portal_group *se_tpg,
1638 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1639 struct tcm_usbg_nexus *tv_nexus;
1642 mutex_lock(&tpg->tpg_mutex);
1643 tv_nexus = tpg->tpg_nexus;
1648 ret = snprintf(page, PAGE_SIZE, "%s\n",
1649 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1651 mutex_unlock(&tpg->tpg_mutex);
1655 static int tcm_usbg_make_nexus(struct usbg_tpg *tpg, char *name)
1657 struct se_portal_group *se_tpg;
1658 struct tcm_usbg_nexus *tv_nexus;
1661 mutex_lock(&tpg->tpg_mutex);
1662 if (tpg->tpg_nexus) {
1664 pr_debug("tpg->tpg_nexus already exists\n");
1667 se_tpg = &tpg->se_tpg;
1670 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1673 tv_nexus->tvn_se_sess = transport_init_session(TARGET_PROT_NORMAL);
1674 if (IS_ERR(tv_nexus->tvn_se_sess))
1678 * Since we are running in 'demo mode' this call with generate a
1679 * struct se_node_acl for the tcm_vhost struct se_portal_group with
1680 * the SCSI Initiator port name of the passed configfs group 'name'.
1682 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1684 if (!tv_nexus->tvn_se_sess->se_node_acl) {
1685 pr_debug("core_tpg_check_initiator_node_acl() failed"
1690 * Now register the TCM vHost virtual I_T Nexus as active.
1692 transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1693 tv_nexus->tvn_se_sess, tv_nexus);
1694 tpg->tpg_nexus = tv_nexus;
1695 mutex_unlock(&tpg->tpg_mutex);
1699 transport_free_session(tv_nexus->tvn_se_sess);
1703 mutex_unlock(&tpg->tpg_mutex);
1707 static int tcm_usbg_drop_nexus(struct usbg_tpg *tpg)
1709 struct se_session *se_sess;
1710 struct tcm_usbg_nexus *tv_nexus;
1713 mutex_lock(&tpg->tpg_mutex);
1714 tv_nexus = tpg->tpg_nexus;
1718 se_sess = tv_nexus->tvn_se_sess;
1722 if (atomic_read(&tpg->tpg_port_count)) {
1724 pr_err("Unable to remove Host I_T Nexus with"
1725 " active TPG port count: %d\n",
1726 atomic_read(&tpg->tpg_port_count));
1730 pr_debug("Removing I_T Nexus to Initiator Port: %s\n",
1731 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1733 * Release the SCSI I_T Nexus to the emulated vHost Target Port
1735 transport_deregister_session(tv_nexus->tvn_se_sess);
1736 tpg->tpg_nexus = NULL;
1741 mutex_unlock(&tpg->tpg_mutex);
1745 static ssize_t tcm_usbg_tpg_store_nexus(
1746 struct se_portal_group *se_tpg,
1750 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1751 unsigned char i_port[USBG_NAMELEN], *ptr;
1754 if (!strncmp(page, "NULL", 4)) {
1755 ret = tcm_usbg_drop_nexus(tpg);
1756 return (!ret) ? count : ret;
1758 if (strlen(page) >= USBG_NAMELEN) {
1759 pr_err("Emulated NAA Sas Address: %s, exceeds"
1760 " max: %d\n", page, USBG_NAMELEN);
1763 snprintf(i_port, USBG_NAMELEN, "%s", page);
1765 ptr = strstr(i_port, "naa.");
1767 pr_err("Missing 'naa.' prefix\n");
1771 if (i_port[strlen(i_port) - 1] == '\n')
1772 i_port[strlen(i_port) - 1] = '\0';
1774 ret = tcm_usbg_make_nexus(tpg, &i_port[4]);
1779 TF_TPG_BASE_ATTR(tcm_usbg, nexus, S_IRUGO | S_IWUSR);
1781 static struct configfs_attribute *usbg_base_attrs[] = {
1782 &tcm_usbg_tpg_enable.attr,
1783 &tcm_usbg_tpg_nexus.attr,
1787 static int usbg_port_link(struct se_portal_group *se_tpg, struct se_lun *lun)
1789 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1791 atomic_inc(&tpg->tpg_port_count);
1792 smp_mb__after_atomic();
1796 static void usbg_port_unlink(struct se_portal_group *se_tpg,
1797 struct se_lun *se_lun)
1799 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1801 atomic_dec(&tpg->tpg_port_count);
1802 smp_mb__after_atomic();
1805 static int usbg_check_stop_free(struct se_cmd *se_cmd)
1807 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1810 kref_put(&cmd->ref, usbg_cmd_release);
1814 static const struct target_core_fabric_ops usbg_ops = {
1815 .module = THIS_MODULE,
1816 .name = "usb_gadget",
1817 .get_fabric_name = usbg_get_fabric_name,
1818 .get_fabric_proto_ident = usbg_get_fabric_proto_ident,
1819 .tpg_get_wwn = usbg_get_fabric_wwn,
1820 .tpg_get_tag = usbg_get_tag,
1821 .tpg_get_pr_transport_id = usbg_get_pr_transport_id,
1822 .tpg_get_pr_transport_id_len = usbg_get_pr_transport_id_len,
1823 .tpg_parse_pr_out_transport_id = usbg_parse_pr_out_transport_id,
1824 .tpg_check_demo_mode = usbg_check_true,
1825 .tpg_check_demo_mode_cache = usbg_check_false,
1826 .tpg_check_demo_mode_write_protect = usbg_check_false,
1827 .tpg_check_prod_mode_write_protect = usbg_check_false,
1828 .tpg_alloc_fabric_acl = usbg_alloc_fabric_acl,
1829 .tpg_release_fabric_acl = usbg_release_fabric_acl,
1830 .tpg_get_inst_index = usbg_tpg_get_inst_index,
1831 .release_cmd = usbg_release_cmd,
1832 .shutdown_session = usbg_shutdown_session,
1833 .close_session = usbg_close_session,
1834 .sess_get_index = usbg_sess_get_index,
1835 .sess_get_initiator_sid = NULL,
1836 .write_pending = usbg_send_write_request,
1837 .write_pending_status = usbg_write_pending_status,
1838 .set_default_node_attributes = usbg_set_default_node_attrs,
1839 .get_task_tag = usbg_get_task_tag,
1840 .get_cmd_state = usbg_get_cmd_state,
1841 .queue_data_in = usbg_send_read_response,
1842 .queue_status = usbg_send_status_response,
1843 .queue_tm_rsp = usbg_queue_tm_rsp,
1844 .aborted_task = usbg_aborted_task,
1845 .check_stop_free = usbg_check_stop_free,
1847 .fabric_make_wwn = usbg_make_tport,
1848 .fabric_drop_wwn = usbg_drop_tport,
1849 .fabric_make_tpg = usbg_make_tpg,
1850 .fabric_drop_tpg = usbg_drop_tpg,
1851 .fabric_post_link = usbg_port_link,
1852 .fabric_pre_unlink = usbg_port_unlink,
1853 .fabric_init_nodeacl = usbg_init_nodeacl,
1855 .tfc_wwn_attrs = usbg_wwn_attrs,
1856 .tfc_tpg_base_attrs = usbg_base_attrs,
1859 /* Start gadget.c code */
1861 static struct usb_interface_descriptor bot_intf_desc = {
1862 .bLength = sizeof(bot_intf_desc),
1863 .bDescriptorType = USB_DT_INTERFACE,
1865 .bAlternateSetting = USB_G_ALT_INT_BBB,
1866 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1867 .bInterfaceSubClass = USB_SC_SCSI,
1868 .bInterfaceProtocol = USB_PR_BULK,
1871 static struct usb_interface_descriptor uasp_intf_desc = {
1872 .bLength = sizeof(uasp_intf_desc),
1873 .bDescriptorType = USB_DT_INTERFACE,
1875 .bAlternateSetting = USB_G_ALT_INT_UAS,
1876 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1877 .bInterfaceSubClass = USB_SC_SCSI,
1878 .bInterfaceProtocol = USB_PR_UAS,
1881 static struct usb_endpoint_descriptor uasp_bi_desc = {
1882 .bLength = USB_DT_ENDPOINT_SIZE,
1883 .bDescriptorType = USB_DT_ENDPOINT,
1884 .bEndpointAddress = USB_DIR_IN,
1885 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1886 .wMaxPacketSize = cpu_to_le16(512),
1889 static struct usb_endpoint_descriptor uasp_fs_bi_desc = {
1890 .bLength = USB_DT_ENDPOINT_SIZE,
1891 .bDescriptorType = USB_DT_ENDPOINT,
1892 .bEndpointAddress = USB_DIR_IN,
1893 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1896 static struct usb_pipe_usage_descriptor uasp_bi_pipe_desc = {
1897 .bLength = sizeof(uasp_bi_pipe_desc),
1898 .bDescriptorType = USB_DT_PIPE_USAGE,
1899 .bPipeID = DATA_IN_PIPE_ID,
1902 static struct usb_endpoint_descriptor uasp_ss_bi_desc = {
1903 .bLength = USB_DT_ENDPOINT_SIZE,
1904 .bDescriptorType = USB_DT_ENDPOINT,
1905 .bEndpointAddress = USB_DIR_IN,
1906 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1907 .wMaxPacketSize = cpu_to_le16(1024),
1910 static struct usb_ss_ep_comp_descriptor uasp_bi_ep_comp_desc = {
1911 .bLength = sizeof(uasp_bi_ep_comp_desc),
1912 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1914 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1915 .wBytesPerInterval = 0,
1918 static struct usb_ss_ep_comp_descriptor bot_bi_ep_comp_desc = {
1919 .bLength = sizeof(bot_bi_ep_comp_desc),
1920 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1924 static struct usb_endpoint_descriptor uasp_bo_desc = {
1925 .bLength = USB_DT_ENDPOINT_SIZE,
1926 .bDescriptorType = USB_DT_ENDPOINT,
1927 .bEndpointAddress = USB_DIR_OUT,
1928 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1929 .wMaxPacketSize = cpu_to_le16(512),
1932 static struct usb_endpoint_descriptor uasp_fs_bo_desc = {
1933 .bLength = USB_DT_ENDPOINT_SIZE,
1934 .bDescriptorType = USB_DT_ENDPOINT,
1935 .bEndpointAddress = USB_DIR_OUT,
1936 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1939 static struct usb_pipe_usage_descriptor uasp_bo_pipe_desc = {
1940 .bLength = sizeof(uasp_bo_pipe_desc),
1941 .bDescriptorType = USB_DT_PIPE_USAGE,
1942 .bPipeID = DATA_OUT_PIPE_ID,
1945 static struct usb_endpoint_descriptor uasp_ss_bo_desc = {
1946 .bLength = USB_DT_ENDPOINT_SIZE,
1947 .bDescriptorType = USB_DT_ENDPOINT,
1948 .bEndpointAddress = USB_DIR_OUT,
1949 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1950 .wMaxPacketSize = cpu_to_le16(0x400),
1953 static struct usb_ss_ep_comp_descriptor uasp_bo_ep_comp_desc = {
1954 .bLength = sizeof(uasp_bo_ep_comp_desc),
1955 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1956 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1959 static struct usb_ss_ep_comp_descriptor bot_bo_ep_comp_desc = {
1960 .bLength = sizeof(bot_bo_ep_comp_desc),
1961 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1964 static struct usb_endpoint_descriptor uasp_status_desc = {
1965 .bLength = USB_DT_ENDPOINT_SIZE,
1966 .bDescriptorType = USB_DT_ENDPOINT,
1967 .bEndpointAddress = USB_DIR_IN,
1968 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1969 .wMaxPacketSize = cpu_to_le16(512),
1972 static struct usb_endpoint_descriptor uasp_fs_status_desc = {
1973 .bLength = USB_DT_ENDPOINT_SIZE,
1974 .bDescriptorType = USB_DT_ENDPOINT,
1975 .bEndpointAddress = USB_DIR_IN,
1976 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1979 static struct usb_pipe_usage_descriptor uasp_status_pipe_desc = {
1980 .bLength = sizeof(uasp_status_pipe_desc),
1981 .bDescriptorType = USB_DT_PIPE_USAGE,
1982 .bPipeID = STATUS_PIPE_ID,
1985 static struct usb_endpoint_descriptor uasp_ss_status_desc = {
1986 .bLength = USB_DT_ENDPOINT_SIZE,
1987 .bDescriptorType = USB_DT_ENDPOINT,
1988 .bEndpointAddress = USB_DIR_IN,
1989 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1990 .wMaxPacketSize = cpu_to_le16(1024),
1993 static struct usb_ss_ep_comp_descriptor uasp_status_in_ep_comp_desc = {
1994 .bLength = sizeof(uasp_status_in_ep_comp_desc),
1995 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
1996 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
1999 static struct usb_endpoint_descriptor uasp_cmd_desc = {
2000 .bLength = USB_DT_ENDPOINT_SIZE,
2001 .bDescriptorType = USB_DT_ENDPOINT,
2002 .bEndpointAddress = USB_DIR_OUT,
2003 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2004 .wMaxPacketSize = cpu_to_le16(512),
2007 static struct usb_endpoint_descriptor uasp_fs_cmd_desc = {
2008 .bLength = USB_DT_ENDPOINT_SIZE,
2009 .bDescriptorType = USB_DT_ENDPOINT,
2010 .bEndpointAddress = USB_DIR_OUT,
2011 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2014 static struct usb_pipe_usage_descriptor uasp_cmd_pipe_desc = {
2015 .bLength = sizeof(uasp_cmd_pipe_desc),
2016 .bDescriptorType = USB_DT_PIPE_USAGE,
2017 .bPipeID = CMD_PIPE_ID,
2020 static struct usb_endpoint_descriptor uasp_ss_cmd_desc = {
2021 .bLength = USB_DT_ENDPOINT_SIZE,
2022 .bDescriptorType = USB_DT_ENDPOINT,
2023 .bEndpointAddress = USB_DIR_OUT,
2024 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2025 .wMaxPacketSize = cpu_to_le16(1024),
2028 static struct usb_ss_ep_comp_descriptor uasp_cmd_comp_desc = {
2029 .bLength = sizeof(uasp_cmd_comp_desc),
2030 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2033 static struct usb_descriptor_header *uasp_fs_function_desc[] = {
2034 (struct usb_descriptor_header *) &bot_intf_desc,
2035 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
2036 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
2038 (struct usb_descriptor_header *) &uasp_intf_desc,
2039 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
2040 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2041 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
2042 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2043 (struct usb_descriptor_header *) &uasp_fs_status_desc,
2044 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2045 (struct usb_descriptor_header *) &uasp_fs_cmd_desc,
2046 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2050 static struct usb_descriptor_header *uasp_hs_function_desc[] = {
2051 (struct usb_descriptor_header *) &bot_intf_desc,
2052 (struct usb_descriptor_header *) &uasp_bi_desc,
2053 (struct usb_descriptor_header *) &uasp_bo_desc,
2055 (struct usb_descriptor_header *) &uasp_intf_desc,
2056 (struct usb_descriptor_header *) &uasp_bi_desc,
2057 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2058 (struct usb_descriptor_header *) &uasp_bo_desc,
2059 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2060 (struct usb_descriptor_header *) &uasp_status_desc,
2061 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2062 (struct usb_descriptor_header *) &uasp_cmd_desc,
2063 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2067 static struct usb_descriptor_header *uasp_ss_function_desc[] = {
2068 (struct usb_descriptor_header *) &bot_intf_desc,
2069 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
2070 (struct usb_descriptor_header *) &bot_bi_ep_comp_desc,
2071 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
2072 (struct usb_descriptor_header *) &bot_bo_ep_comp_desc,
2074 (struct usb_descriptor_header *) &uasp_intf_desc,
2075 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
2076 (struct usb_descriptor_header *) &uasp_bi_ep_comp_desc,
2077 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2078 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
2079 (struct usb_descriptor_header *) &uasp_bo_ep_comp_desc,
2080 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2081 (struct usb_descriptor_header *) &uasp_ss_status_desc,
2082 (struct usb_descriptor_header *) &uasp_status_in_ep_comp_desc,
2083 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2084 (struct usb_descriptor_header *) &uasp_ss_cmd_desc,
2085 (struct usb_descriptor_header *) &uasp_cmd_comp_desc,
2086 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2090 #define UAS_VENDOR_ID 0x0525 /* NetChip */
2091 #define UAS_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */
2093 static struct usb_device_descriptor usbg_device_desc = {
2094 .bLength = sizeof(usbg_device_desc),
2095 .bDescriptorType = USB_DT_DEVICE,
2096 .bcdUSB = cpu_to_le16(0x0200),
2097 .bDeviceClass = USB_CLASS_PER_INTERFACE,
2098 .idVendor = cpu_to_le16(UAS_VENDOR_ID),
2099 .idProduct = cpu_to_le16(UAS_PRODUCT_ID),
2100 .bNumConfigurations = 1,
2103 static struct usb_string usbg_us_strings[] = {
2104 [USB_GADGET_MANUFACTURER_IDX].s = "Target Manufactor",
2105 [USB_GADGET_PRODUCT_IDX].s = "Target Product",
2106 [USB_GADGET_SERIAL_IDX].s = "000000000001",
2107 [USB_G_STR_CONFIG].s = "default config",
2108 [USB_G_STR_INT_UAS].s = "USB Attached SCSI",
2109 [USB_G_STR_INT_BBB].s = "Bulk Only Transport",
2113 static struct usb_gadget_strings usbg_stringtab = {
2115 .strings = usbg_us_strings,
2118 static struct usb_gadget_strings *usbg_strings[] = {
2123 static int guas_unbind(struct usb_composite_dev *cdev)
2128 static struct usb_configuration usbg_config_driver = {
2129 .label = "Linux Target",
2130 .bConfigurationValue = 1,
2131 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
2134 static void give_back_ep(struct usb_ep **pep)
2136 struct usb_ep *ep = *pep;
2139 ep->driver_data = NULL;
2142 static int usbg_bind(struct usb_configuration *c, struct usb_function *f)
2144 struct f_uas *fu = to_f_uas(f);
2145 struct usb_gadget *gadget = c->cdev->gadget;
2150 iface = usb_interface_id(c, f);
2154 bot_intf_desc.bInterfaceNumber = iface;
2155 uasp_intf_desc.bInterfaceNumber = iface;
2157 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bi_desc,
2158 &uasp_bi_ep_comp_desc);
2162 ep->driver_data = fu;
2165 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bo_desc,
2166 &uasp_bo_ep_comp_desc);
2169 ep->driver_data = fu;
2172 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_status_desc,
2173 &uasp_status_in_ep_comp_desc);
2176 ep->driver_data = fu;
2179 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_cmd_desc,
2180 &uasp_cmd_comp_desc);
2183 ep->driver_data = fu;
2186 /* Assume endpoint addresses are the same for both speeds */
2187 uasp_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2188 uasp_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2189 uasp_status_desc.bEndpointAddress =
2190 uasp_ss_status_desc.bEndpointAddress;
2191 uasp_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2193 uasp_fs_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2194 uasp_fs_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2195 uasp_fs_status_desc.bEndpointAddress =
2196 uasp_ss_status_desc.bEndpointAddress;
2197 uasp_fs_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2199 ret = usb_assign_descriptors(f, uasp_fs_function_desc,
2200 uasp_hs_function_desc, uasp_ss_function_desc);
2206 pr_err("Can't claim all required eps\n");
2208 give_back_ep(&fu->ep_in);
2209 give_back_ep(&fu->ep_out);
2210 give_back_ep(&fu->ep_status);
2211 give_back_ep(&fu->ep_cmd);
2215 static void usbg_unbind(struct usb_configuration *c, struct usb_function *f)
2217 struct f_uas *fu = to_f_uas(f);
2219 usb_free_all_descriptors(f);
2223 struct guas_setup_wq {
2224 struct work_struct work;
2229 static void usbg_delayed_set_alt(struct work_struct *wq)
2231 struct guas_setup_wq *work = container_of(wq, struct guas_setup_wq,
2233 struct f_uas *fu = work->fu;
2234 int alt = work->alt;
2238 if (fu->flags & USBG_IS_BOT)
2239 bot_cleanup_old_alt(fu);
2240 if (fu->flags & USBG_IS_UAS)
2241 uasp_cleanup_old_alt(fu);
2243 if (alt == USB_G_ALT_INT_BBB)
2245 else if (alt == USB_G_ALT_INT_UAS)
2247 usb_composite_setup_continue(fu->function.config->cdev);
2250 static int usbg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2252 struct f_uas *fu = to_f_uas(f);
2254 if ((alt == USB_G_ALT_INT_BBB) || (alt == USB_G_ALT_INT_UAS)) {
2255 struct guas_setup_wq *work;
2257 work = kmalloc(sizeof(*work), GFP_ATOMIC);
2260 INIT_WORK(&work->work, usbg_delayed_set_alt);
2263 schedule_work(&work->work);
2264 return USB_GADGET_DELAYED_STATUS;
2269 static void usbg_disable(struct usb_function *f)
2271 struct f_uas *fu = to_f_uas(f);
2273 if (fu->flags & USBG_IS_UAS)
2274 uasp_cleanup_old_alt(fu);
2275 else if (fu->flags & USBG_IS_BOT)
2276 bot_cleanup_old_alt(fu);
2280 static int usbg_setup(struct usb_function *f,
2281 const struct usb_ctrlrequest *ctrl)
2283 struct f_uas *fu = to_f_uas(f);
2285 if (!(fu->flags & USBG_IS_BOT))
2288 return usbg_bot_setup(f, ctrl);
2291 static int usbg_cfg_bind(struct usb_configuration *c)
2296 fu = kzalloc(sizeof(*fu), GFP_KERNEL);
2299 fu->function.name = "Target Function";
2300 fu->function.bind = usbg_bind;
2301 fu->function.unbind = usbg_unbind;
2302 fu->function.set_alt = usbg_set_alt;
2303 fu->function.setup = usbg_setup;
2304 fu->function.disable = usbg_disable;
2305 fu->tpg = the_only_tpg_I_currently_have;
2307 bot_intf_desc.iInterface = usbg_us_strings[USB_G_STR_INT_BBB].id;
2308 uasp_intf_desc.iInterface = usbg_us_strings[USB_G_STR_INT_UAS].id;
2310 ret = usb_add_function(c, &fu->function);
2320 static int usb_target_bind(struct usb_composite_dev *cdev)
2324 ret = usb_string_ids_tab(cdev, usbg_us_strings);
2328 usbg_device_desc.iManufacturer =
2329 usbg_us_strings[USB_GADGET_MANUFACTURER_IDX].id;
2330 usbg_device_desc.iProduct = usbg_us_strings[USB_GADGET_PRODUCT_IDX].id;
2331 usbg_device_desc.iSerialNumber =
2332 usbg_us_strings[USB_GADGET_SERIAL_IDX].id;
2333 usbg_config_driver.iConfiguration =
2334 usbg_us_strings[USB_G_STR_CONFIG].id;
2336 ret = usb_add_config(cdev, &usbg_config_driver,
2340 usb_composite_overwrite_options(cdev, &coverwrite);
2344 static __refdata struct usb_composite_driver usbg_driver = {
2346 .dev = &usbg_device_desc,
2347 .strings = usbg_strings,
2348 .max_speed = USB_SPEED_SUPER,
2349 .bind = usb_target_bind,
2350 .unbind = guas_unbind,
2353 static int usbg_attach(struct usbg_tpg *tpg)
2355 return usb_composite_probe(&usbg_driver);
2358 static void usbg_detach(struct usbg_tpg *tpg)
2360 usb_composite_unregister(&usbg_driver);
2363 static int __init usb_target_gadget_init(void)
2365 return target_register_template(&usbg_ops);
2367 module_init(usb_target_gadget_init);
2369 static void __exit usb_target_gadget_exit(void)
2371 target_unregister_template(&usbg_ops);
2373 module_exit(usb_target_gadget_exit);
2375 MODULE_AUTHOR("Sebastian Andrzej Siewior <bigeasy@linutronix.de>");
2376 MODULE_DESCRIPTION("usb-gadget fabric");
2377 MODULE_LICENSE("GPL v2");