target: remove transport_generic_handle_cdb_map
[linux-2.6/cjktty.git] / drivers / usb / gadget / tcm_usb_gadget.c
blob02ace18fca0b6e188d0381a679b7610b7332e285
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.
8 */
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/string.h>
13 #include <linux/configfs.h>
14 #include <linux/ctype.h>
15 #include <linux/usb/ch9.h>
16 #include <linux/usb/composite.h>
17 #include <linux/usb/gadget.h>
18 #include <linux/usb/storage.h>
19 #include <scsi/scsi.h>
20 #include <scsi/scsi_tcq.h>
21 #include <target/target_core_base.h>
22 #include <target/target_core_fabric.h>
23 #include <target/target_core_fabric_configfs.h>
24 #include <target/target_core_configfs.h>
25 #include <target/configfs_macros.h>
26 #include <asm/unaligned.h>
28 #include "usbstring.c"
29 #include "epautoconf.c"
30 #include "config.c"
31 #include "composite.c"
33 #include "tcm_usb_gadget.h"
35 static struct target_fabric_configfs *usbg_fabric_configfs;
37 static inline struct f_uas *to_f_uas(struct usb_function *f)
39 return container_of(f, struct f_uas, function);
42 static void usbg_cmd_release(struct kref *);
44 static inline void usbg_cleanup_cmd(struct usbg_cmd *cmd)
46 kref_put(&cmd->ref, usbg_cmd_release);
49 /* Start bot.c code */
51 static int bot_enqueue_cmd_cbw(struct f_uas *fu)
53 int ret;
55 if (fu->flags & USBG_BOT_CMD_PEND)
56 return 0;
58 ret = usb_ep_queue(fu->ep_out, fu->cmd.req, GFP_ATOMIC);
59 if (!ret)
60 fu->flags |= USBG_BOT_CMD_PEND;
61 return ret;
64 static void bot_status_complete(struct usb_ep *ep, struct usb_request *req)
66 struct usbg_cmd *cmd = req->context;
67 struct f_uas *fu = cmd->fu;
69 usbg_cleanup_cmd(cmd);
70 if (req->status < 0) {
71 pr_err("ERR %s(%d)\n", __func__, __LINE__);
72 return;
75 /* CSW completed, wait for next CBW */
76 bot_enqueue_cmd_cbw(fu);
79 static void bot_enqueue_sense_code(struct f_uas *fu, struct usbg_cmd *cmd)
81 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
82 int ret;
83 u8 *sense;
84 unsigned int csw_stat;
86 csw_stat = cmd->csw_code;
89 * We can't send SENSE as a response. So we take ASC & ASCQ from our
90 * sense buffer and queue it and hope the host sends a REQUEST_SENSE
91 * command where it learns why we failed.
93 sense = cmd->sense_iu.sense;
95 csw->Tag = cmd->bot_tag;
96 csw->Status = csw_stat;
97 fu->bot_status.req->context = cmd;
98 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_ATOMIC);
99 if (ret)
100 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
103 static void bot_err_compl(struct usb_ep *ep, struct usb_request *req)
105 struct usbg_cmd *cmd = req->context;
106 struct f_uas *fu = cmd->fu;
108 if (req->status < 0)
109 pr_err("ERR %s(%d)\n", __func__, __LINE__);
111 if (cmd->data_len) {
112 if (cmd->data_len > ep->maxpacket) {
113 req->length = ep->maxpacket;
114 cmd->data_len -= ep->maxpacket;
115 } else {
116 req->length = cmd->data_len;
117 cmd->data_len = 0;
120 usb_ep_queue(ep, req, GFP_ATOMIC);
121 return ;
123 bot_enqueue_sense_code(fu, cmd);
126 static void bot_send_bad_status(struct usbg_cmd *cmd)
128 struct f_uas *fu = cmd->fu;
129 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
130 struct usb_request *req;
131 struct usb_ep *ep;
133 csw->Residue = cpu_to_le32(cmd->data_len);
135 if (cmd->data_len) {
136 if (cmd->is_read) {
137 ep = fu->ep_in;
138 req = fu->bot_req_in;
139 } else {
140 ep = fu->ep_out;
141 req = fu->bot_req_out;
144 if (cmd->data_len > fu->ep_in->maxpacket) {
145 req->length = ep->maxpacket;
146 cmd->data_len -= ep->maxpacket;
147 } else {
148 req->length = cmd->data_len;
149 cmd->data_len = 0;
151 req->complete = bot_err_compl;
152 req->context = cmd;
153 req->buf = fu->cmd.buf;
154 usb_ep_queue(ep, req, GFP_KERNEL);
155 } else {
156 bot_enqueue_sense_code(fu, cmd);
160 static int bot_send_status(struct usbg_cmd *cmd, bool moved_data)
162 struct f_uas *fu = cmd->fu;
163 struct bulk_cs_wrap *csw = &fu->bot_status.csw;
164 int ret;
166 if (cmd->se_cmd.scsi_status == SAM_STAT_GOOD) {
167 if (!moved_data && cmd->data_len) {
169 * the host wants to move data, we don't. Fill / empty
170 * the pipe and then send the csw with reside set.
172 cmd->csw_code = US_BULK_STAT_OK;
173 bot_send_bad_status(cmd);
174 return 0;
177 csw->Tag = cmd->bot_tag;
178 csw->Residue = cpu_to_le32(0);
179 csw->Status = US_BULK_STAT_OK;
180 fu->bot_status.req->context = cmd;
182 ret = usb_ep_queue(fu->ep_in, fu->bot_status.req, GFP_KERNEL);
183 if (ret)
184 pr_err("%s(%d) ERR: %d\n", __func__, __LINE__, ret);
185 } else {
186 cmd->csw_code = US_BULK_STAT_FAIL;
187 bot_send_bad_status(cmd);
189 return 0;
193 * Called after command (no data transfer) or after the write (to device)
194 * operation is completed
196 static int bot_send_status_response(struct usbg_cmd *cmd)
198 bool moved_data = false;
200 if (!cmd->is_read)
201 moved_data = true;
202 return bot_send_status(cmd, moved_data);
205 /* Read request completed, now we have to send the CSW */
206 static void bot_read_compl(struct usb_ep *ep, struct usb_request *req)
208 struct usbg_cmd *cmd = req->context;
210 if (req->status < 0)
211 pr_err("ERR %s(%d)\n", __func__, __LINE__);
213 bot_send_status(cmd, true);
216 static int bot_send_read_response(struct usbg_cmd *cmd)
218 struct f_uas *fu = cmd->fu;
219 struct se_cmd *se_cmd = &cmd->se_cmd;
220 struct usb_gadget *gadget = fuas_to_gadget(fu);
221 int ret;
223 if (!cmd->data_len) {
224 cmd->csw_code = US_BULK_STAT_PHASE;
225 bot_send_bad_status(cmd);
226 return 0;
229 if (!gadget->sg_supported) {
230 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
231 if (!cmd->data_buf)
232 return -ENOMEM;
234 sg_copy_to_buffer(se_cmd->t_data_sg,
235 se_cmd->t_data_nents,
236 cmd->data_buf,
237 se_cmd->data_length);
239 fu->bot_req_in->buf = cmd->data_buf;
240 } else {
241 fu->bot_req_in->buf = NULL;
242 fu->bot_req_in->num_sgs = se_cmd->t_data_nents;
243 fu->bot_req_in->sg = se_cmd->t_data_sg;
246 fu->bot_req_in->complete = bot_read_compl;
247 fu->bot_req_in->length = se_cmd->data_length;
248 fu->bot_req_in->context = cmd;
249 ret = usb_ep_queue(fu->ep_in, fu->bot_req_in, GFP_ATOMIC);
250 if (ret)
251 pr_err("%s(%d)\n", __func__, __LINE__);
252 return 0;
255 static void usbg_data_write_cmpl(struct usb_ep *, struct usb_request *);
256 static int usbg_prepare_w_request(struct usbg_cmd *, struct usb_request *);
258 static int bot_send_write_request(struct usbg_cmd *cmd)
260 struct f_uas *fu = cmd->fu;
261 struct se_cmd *se_cmd = &cmd->se_cmd;
262 struct usb_gadget *gadget = fuas_to_gadget(fu);
263 int ret;
265 init_completion(&cmd->write_complete);
266 cmd->fu = fu;
268 if (!cmd->data_len) {
269 cmd->csw_code = US_BULK_STAT_PHASE;
270 return -EINVAL;
273 if (!gadget->sg_supported) {
274 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_KERNEL);
275 if (!cmd->data_buf)
276 return -ENOMEM;
278 fu->bot_req_out->buf = cmd->data_buf;
279 } else {
280 fu->bot_req_out->buf = NULL;
281 fu->bot_req_out->num_sgs = se_cmd->t_data_nents;
282 fu->bot_req_out->sg = se_cmd->t_data_sg;
285 fu->bot_req_out->complete = usbg_data_write_cmpl;
286 fu->bot_req_out->length = se_cmd->data_length;
287 fu->bot_req_out->context = cmd;
289 ret = usbg_prepare_w_request(cmd, fu->bot_req_out);
290 if (ret)
291 goto cleanup;
292 ret = usb_ep_queue(fu->ep_out, fu->bot_req_out, GFP_KERNEL);
293 if (ret)
294 pr_err("%s(%d)\n", __func__, __LINE__);
296 wait_for_completion(&cmd->write_complete);
297 target_execute_cmd(se_cmd);
298 cleanup:
299 return ret;
302 static int bot_submit_command(struct f_uas *, void *, unsigned int);
304 static void bot_cmd_complete(struct usb_ep *ep, struct usb_request *req)
306 struct f_uas *fu = req->context;
307 int ret;
309 fu->flags &= ~USBG_BOT_CMD_PEND;
311 if (req->status < 0)
312 return;
314 ret = bot_submit_command(fu, req->buf, req->actual);
315 if (ret)
316 pr_err("%s(%d): %d\n", __func__, __LINE__, ret);
319 static int bot_prepare_reqs(struct f_uas *fu)
321 int ret;
323 fu->bot_req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
324 if (!fu->bot_req_in)
325 goto err;
327 fu->bot_req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
328 if (!fu->bot_req_out)
329 goto err_out;
331 fu->cmd.req = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
332 if (!fu->cmd.req)
333 goto err_cmd;
335 fu->bot_status.req = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
336 if (!fu->bot_status.req)
337 goto err_sts;
339 fu->bot_status.req->buf = &fu->bot_status.csw;
340 fu->bot_status.req->length = US_BULK_CS_WRAP_LEN;
341 fu->bot_status.req->complete = bot_status_complete;
342 fu->bot_status.csw.Signature = cpu_to_le32(US_BULK_CS_SIGN);
344 fu->cmd.buf = kmalloc(fu->ep_out->maxpacket, GFP_KERNEL);
345 if (!fu->cmd.buf)
346 goto err_buf;
348 fu->cmd.req->complete = bot_cmd_complete;
349 fu->cmd.req->buf = fu->cmd.buf;
350 fu->cmd.req->length = fu->ep_out->maxpacket;
351 fu->cmd.req->context = fu;
353 ret = bot_enqueue_cmd_cbw(fu);
354 if (ret)
355 goto err_queue;
356 return 0;
357 err_queue:
358 kfree(fu->cmd.buf);
359 fu->cmd.buf = NULL;
360 err_buf:
361 usb_ep_free_request(fu->ep_in, fu->bot_status.req);
362 err_sts:
363 usb_ep_free_request(fu->ep_out, fu->cmd.req);
364 fu->cmd.req = NULL;
365 err_cmd:
366 usb_ep_free_request(fu->ep_out, fu->bot_req_out);
367 fu->bot_req_out = NULL;
368 err_out:
369 usb_ep_free_request(fu->ep_in, fu->bot_req_in);
370 fu->bot_req_in = NULL;
371 err:
372 pr_err("BOT: endpoint setup failed\n");
373 return -ENOMEM;
376 void bot_cleanup_old_alt(struct f_uas *fu)
378 if (!(fu->flags & USBG_ENABLED))
379 return;
381 usb_ep_disable(fu->ep_in);
382 usb_ep_disable(fu->ep_out);
384 if (!fu->bot_req_in)
385 return;
387 usb_ep_free_request(fu->ep_in, fu->bot_req_in);
388 usb_ep_free_request(fu->ep_out, fu->bot_req_out);
389 usb_ep_free_request(fu->ep_out, fu->cmd.req);
390 usb_ep_free_request(fu->ep_out, fu->bot_status.req);
392 kfree(fu->cmd.buf);
394 fu->bot_req_in = NULL;
395 fu->bot_req_out = NULL;
396 fu->cmd.req = NULL;
397 fu->bot_status.req = NULL;
398 fu->cmd.buf = NULL;
401 static void bot_set_alt(struct f_uas *fu)
403 struct usb_function *f = &fu->function;
404 struct usb_gadget *gadget = f->config->cdev->gadget;
405 int ret;
407 fu->flags = USBG_IS_BOT;
409 config_ep_by_speed(gadget, f, fu->ep_in);
410 ret = usb_ep_enable(fu->ep_in);
411 if (ret)
412 goto err_b_in;
414 config_ep_by_speed(gadget, f, fu->ep_out);
415 ret = usb_ep_enable(fu->ep_out);
416 if (ret)
417 goto err_b_out;
419 ret = bot_prepare_reqs(fu);
420 if (ret)
421 goto err_wq;
422 fu->flags |= USBG_ENABLED;
423 pr_info("Using the BOT protocol\n");
424 return;
425 err_wq:
426 usb_ep_disable(fu->ep_out);
427 err_b_out:
428 usb_ep_disable(fu->ep_in);
429 err_b_in:
430 fu->flags = USBG_IS_BOT;
433 static int usbg_bot_setup(struct usb_function *f,
434 const struct usb_ctrlrequest *ctrl)
436 struct f_uas *fu = to_f_uas(f);
437 struct usb_composite_dev *cdev = f->config->cdev;
438 u16 w_value = le16_to_cpu(ctrl->wValue);
439 u16 w_length = le16_to_cpu(ctrl->wLength);
440 int luns;
441 u8 *ret_lun;
443 switch (ctrl->bRequest) {
444 case US_BULK_GET_MAX_LUN:
445 if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_CLASS |
446 USB_RECIP_INTERFACE))
447 return -ENOTSUPP;
449 if (w_length < 1)
450 return -EINVAL;
451 if (w_value != 0)
452 return -EINVAL;
453 luns = atomic_read(&fu->tpg->tpg_port_count);
454 if (!luns) {
455 pr_err("No LUNs configured?\n");
456 return -EINVAL;
459 * If 4 LUNs are present we return 3 i.e. LUN 0..3 can be
460 * accessed. The upper limit is 0xf
462 luns--;
463 if (luns > 0xf) {
464 pr_info_once("Limiting the number of luns to 16\n");
465 luns = 0xf;
467 ret_lun = cdev->req->buf;
468 *ret_lun = luns;
469 cdev->req->length = 1;
470 return usb_ep_queue(cdev->gadget->ep0, cdev->req, GFP_ATOMIC);
471 break;
473 case US_BULK_RESET_REQUEST:
474 /* XXX maybe we should remove previous requests for IN + OUT */
475 bot_enqueue_cmd_cbw(fu);
476 return 0;
477 break;
479 return -ENOTSUPP;
482 /* Start uas.c code */
484 static void uasp_cleanup_one_stream(struct f_uas *fu, struct uas_stream *stream)
486 /* We have either all three allocated or none */
487 if (!stream->req_in)
488 return;
490 usb_ep_free_request(fu->ep_in, stream->req_in);
491 usb_ep_free_request(fu->ep_out, stream->req_out);
492 usb_ep_free_request(fu->ep_status, stream->req_status);
494 stream->req_in = NULL;
495 stream->req_out = NULL;
496 stream->req_status = NULL;
499 static void uasp_free_cmdreq(struct f_uas *fu)
501 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
502 kfree(fu->cmd.buf);
503 fu->cmd.req = NULL;
504 fu->cmd.buf = NULL;
507 static void uasp_cleanup_old_alt(struct f_uas *fu)
509 int i;
511 if (!(fu->flags & USBG_ENABLED))
512 return;
514 usb_ep_disable(fu->ep_in);
515 usb_ep_disable(fu->ep_out);
516 usb_ep_disable(fu->ep_status);
517 usb_ep_disable(fu->ep_cmd);
519 for (i = 0; i < UASP_SS_EP_COMP_NUM_STREAMS; i++)
520 uasp_cleanup_one_stream(fu, &fu->stream[i]);
521 uasp_free_cmdreq(fu);
524 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req);
526 static int uasp_prepare_r_request(struct usbg_cmd *cmd)
528 struct se_cmd *se_cmd = &cmd->se_cmd;
529 struct f_uas *fu = cmd->fu;
530 struct usb_gadget *gadget = fuas_to_gadget(fu);
531 struct uas_stream *stream = cmd->stream;
533 if (!gadget->sg_supported) {
534 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
535 if (!cmd->data_buf)
536 return -ENOMEM;
538 sg_copy_to_buffer(se_cmd->t_data_sg,
539 se_cmd->t_data_nents,
540 cmd->data_buf,
541 se_cmd->data_length);
543 stream->req_in->buf = cmd->data_buf;
544 } else {
545 stream->req_in->buf = NULL;
546 stream->req_in->num_sgs = se_cmd->t_data_nents;
547 stream->req_in->sg = se_cmd->t_data_sg;
550 stream->req_in->complete = uasp_status_data_cmpl;
551 stream->req_in->length = se_cmd->data_length;
552 stream->req_in->context = cmd;
554 cmd->state = UASP_SEND_STATUS;
555 return 0;
558 static void uasp_prepare_status(struct usbg_cmd *cmd)
560 struct se_cmd *se_cmd = &cmd->se_cmd;
561 struct sense_iu *iu = &cmd->sense_iu;
562 struct uas_stream *stream = cmd->stream;
564 cmd->state = UASP_QUEUE_COMMAND;
565 iu->iu_id = IU_ID_STATUS;
566 iu->tag = cpu_to_be16(cmd->tag);
569 * iu->status_qual = cpu_to_be16(STATUS QUALIFIER SAM-4. Where R U?);
571 iu->len = cpu_to_be16(se_cmd->scsi_sense_length);
572 iu->status = se_cmd->scsi_status;
573 stream->req_status->context = cmd;
574 stream->req_status->length = se_cmd->scsi_sense_length + 16;
575 stream->req_status->buf = iu;
576 stream->req_status->complete = uasp_status_data_cmpl;
579 static void uasp_status_data_cmpl(struct usb_ep *ep, struct usb_request *req)
581 struct usbg_cmd *cmd = req->context;
582 struct uas_stream *stream = cmd->stream;
583 struct f_uas *fu = cmd->fu;
584 int ret;
586 if (req->status < 0)
587 goto cleanup;
589 switch (cmd->state) {
590 case UASP_SEND_DATA:
591 ret = uasp_prepare_r_request(cmd);
592 if (ret)
593 goto cleanup;
594 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
595 if (ret)
596 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
597 break;
599 case UASP_RECEIVE_DATA:
600 ret = usbg_prepare_w_request(cmd, stream->req_out);
601 if (ret)
602 goto cleanup;
603 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
604 if (ret)
605 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
606 break;
608 case UASP_SEND_STATUS:
609 uasp_prepare_status(cmd);
610 ret = usb_ep_queue(fu->ep_status, stream->req_status,
611 GFP_ATOMIC);
612 if (ret)
613 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
614 break;
616 case UASP_QUEUE_COMMAND:
617 usbg_cleanup_cmd(cmd);
618 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
619 break;
621 default:
622 BUG();
624 return;
626 cleanup:
627 usbg_cleanup_cmd(cmd);
630 static int uasp_send_status_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;
636 iu->tag = cpu_to_be16(cmd->tag);
637 stream->req_status->complete = uasp_status_data_cmpl;
638 stream->req_status->context = cmd;
639 cmd->fu = fu;
640 uasp_prepare_status(cmd);
641 return usb_ep_queue(fu->ep_status, stream->req_status, GFP_ATOMIC);
644 static int uasp_send_read_response(struct usbg_cmd *cmd)
646 struct f_uas *fu = cmd->fu;
647 struct uas_stream *stream = cmd->stream;
648 struct sense_iu *iu = &cmd->sense_iu;
649 int ret;
651 cmd->fu = fu;
653 iu->tag = cpu_to_be16(cmd->tag);
654 if (fu->flags & USBG_USE_STREAMS) {
656 ret = uasp_prepare_r_request(cmd);
657 if (ret)
658 goto out;
659 ret = usb_ep_queue(fu->ep_in, stream->req_in, GFP_ATOMIC);
660 if (ret) {
661 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
662 kfree(cmd->data_buf);
663 cmd->data_buf = NULL;
666 } else {
668 iu->iu_id = IU_ID_READ_READY;
669 iu->tag = cpu_to_be16(cmd->tag);
671 stream->req_status->complete = uasp_status_data_cmpl;
672 stream->req_status->context = cmd;
674 cmd->state = UASP_SEND_DATA;
675 stream->req_status->buf = iu;
676 stream->req_status->length = sizeof(struct iu);
678 ret = usb_ep_queue(fu->ep_status, stream->req_status,
679 GFP_ATOMIC);
680 if (ret)
681 pr_err("%s(%d) => %d\n", __func__, __LINE__, ret);
683 out:
684 return ret;
687 static int uasp_send_write_request(struct usbg_cmd *cmd)
689 struct f_uas *fu = cmd->fu;
690 struct se_cmd *se_cmd = &cmd->se_cmd;
691 struct uas_stream *stream = cmd->stream;
692 struct sense_iu *iu = &cmd->sense_iu;
693 int ret;
695 init_completion(&cmd->write_complete);
696 cmd->fu = fu;
698 iu->tag = cpu_to_be16(cmd->tag);
700 if (fu->flags & USBG_USE_STREAMS) {
702 ret = usbg_prepare_w_request(cmd, stream->req_out);
703 if (ret)
704 goto cleanup;
705 ret = usb_ep_queue(fu->ep_out, stream->req_out, GFP_ATOMIC);
706 if (ret)
707 pr_err("%s(%d)\n", __func__, __LINE__);
709 } else {
711 iu->iu_id = IU_ID_WRITE_READY;
712 iu->tag = cpu_to_be16(cmd->tag);
714 stream->req_status->complete = uasp_status_data_cmpl;
715 stream->req_status->context = cmd;
717 cmd->state = UASP_RECEIVE_DATA;
718 stream->req_status->buf = iu;
719 stream->req_status->length = sizeof(struct iu);
721 ret = usb_ep_queue(fu->ep_status, stream->req_status,
722 GFP_ATOMIC);
723 if (ret)
724 pr_err("%s(%d)\n", __func__, __LINE__);
727 wait_for_completion(&cmd->write_complete);
728 target_execute_cmd(se_cmd);
729 cleanup:
730 return ret;
733 static int usbg_submit_command(struct f_uas *, void *, unsigned int);
735 static void uasp_cmd_complete(struct usb_ep *ep, struct usb_request *req)
737 struct f_uas *fu = req->context;
738 int ret;
740 if (req->status < 0)
741 return;
743 ret = usbg_submit_command(fu, req->buf, req->actual);
745 * Once we tune for performance enqueue the command req here again so
746 * we can receive a second command while we processing this one. Pay
747 * attention to properly sync STAUS endpoint with DATA IN + OUT so you
748 * don't break HS.
750 if (!ret)
751 return;
752 usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
755 static int uasp_alloc_stream_res(struct f_uas *fu, struct uas_stream *stream)
757 stream->req_in = usb_ep_alloc_request(fu->ep_in, GFP_KERNEL);
758 if (!stream->req_in)
759 goto out;
761 stream->req_out = usb_ep_alloc_request(fu->ep_out, GFP_KERNEL);
762 if (!stream->req_out)
763 goto err_out;
765 stream->req_status = usb_ep_alloc_request(fu->ep_status, GFP_KERNEL);
766 if (!stream->req_status)
767 goto err_sts;
769 return 0;
770 err_sts:
771 usb_ep_free_request(fu->ep_status, stream->req_status);
772 stream->req_status = NULL;
773 err_out:
774 usb_ep_free_request(fu->ep_out, stream->req_out);
775 stream->req_out = NULL;
776 out:
777 return -ENOMEM;
780 static int uasp_alloc_cmd(struct f_uas *fu)
782 fu->cmd.req = usb_ep_alloc_request(fu->ep_cmd, GFP_KERNEL);
783 if (!fu->cmd.req)
784 goto err;
786 fu->cmd.buf = kmalloc(fu->ep_cmd->maxpacket, GFP_KERNEL);
787 if (!fu->cmd.buf)
788 goto err_buf;
790 fu->cmd.req->complete = uasp_cmd_complete;
791 fu->cmd.req->buf = fu->cmd.buf;
792 fu->cmd.req->length = fu->ep_cmd->maxpacket;
793 fu->cmd.req->context = fu;
794 return 0;
796 err_buf:
797 usb_ep_free_request(fu->ep_cmd, fu->cmd.req);
798 err:
799 return -ENOMEM;
802 static void uasp_setup_stream_res(struct f_uas *fu, int max_streams)
804 int i;
806 for (i = 0; i < max_streams; i++) {
807 struct uas_stream *s = &fu->stream[i];
809 s->req_in->stream_id = i + 1;
810 s->req_out->stream_id = i + 1;
811 s->req_status->stream_id = i + 1;
815 static int uasp_prepare_reqs(struct f_uas *fu)
817 int ret;
818 int i;
819 int max_streams;
821 if (fu->flags & USBG_USE_STREAMS)
822 max_streams = UASP_SS_EP_COMP_NUM_STREAMS;
823 else
824 max_streams = 1;
826 for (i = 0; i < max_streams; i++) {
827 ret = uasp_alloc_stream_res(fu, &fu->stream[i]);
828 if (ret)
829 goto err_cleanup;
832 ret = uasp_alloc_cmd(fu);
833 if (ret)
834 goto err_free_stream;
835 uasp_setup_stream_res(fu, max_streams);
837 ret = usb_ep_queue(fu->ep_cmd, fu->cmd.req, GFP_ATOMIC);
838 if (ret)
839 goto err_free_stream;
841 return 0;
843 err_free_stream:
844 uasp_free_cmdreq(fu);
846 err_cleanup:
847 if (i) {
848 do {
849 uasp_cleanup_one_stream(fu, &fu->stream[i - 1]);
850 i--;
851 } while (i);
853 pr_err("UASP: endpoint setup failed\n");
854 return ret;
857 static void uasp_set_alt(struct f_uas *fu)
859 struct usb_function *f = &fu->function;
860 struct usb_gadget *gadget = f->config->cdev->gadget;
861 int ret;
863 fu->flags = USBG_IS_UAS;
865 if (gadget->speed == USB_SPEED_SUPER)
866 fu->flags |= USBG_USE_STREAMS;
868 config_ep_by_speed(gadget, f, fu->ep_in);
869 ret = usb_ep_enable(fu->ep_in);
870 if (ret)
871 goto err_b_in;
873 config_ep_by_speed(gadget, f, fu->ep_out);
874 ret = usb_ep_enable(fu->ep_out);
875 if (ret)
876 goto err_b_out;
878 config_ep_by_speed(gadget, f, fu->ep_cmd);
879 ret = usb_ep_enable(fu->ep_cmd);
880 if (ret)
881 goto err_cmd;
882 config_ep_by_speed(gadget, f, fu->ep_status);
883 ret = usb_ep_enable(fu->ep_status);
884 if (ret)
885 goto err_status;
887 ret = uasp_prepare_reqs(fu);
888 if (ret)
889 goto err_wq;
890 fu->flags |= USBG_ENABLED;
892 pr_info("Using the UAS protocol\n");
893 return;
894 err_wq:
895 usb_ep_disable(fu->ep_status);
896 err_status:
897 usb_ep_disable(fu->ep_cmd);
898 err_cmd:
899 usb_ep_disable(fu->ep_out);
900 err_b_out:
901 usb_ep_disable(fu->ep_in);
902 err_b_in:
903 fu->flags = 0;
906 static int get_cmd_dir(const unsigned char *cdb)
908 int ret;
910 switch (cdb[0]) {
911 case READ_6:
912 case READ_10:
913 case READ_12:
914 case READ_16:
915 case INQUIRY:
916 case MODE_SENSE:
917 case MODE_SENSE_10:
918 case SERVICE_ACTION_IN:
919 case MAINTENANCE_IN:
920 case PERSISTENT_RESERVE_IN:
921 case SECURITY_PROTOCOL_IN:
922 case ACCESS_CONTROL_IN:
923 case REPORT_LUNS:
924 case READ_BLOCK_LIMITS:
925 case READ_POSITION:
926 case READ_CAPACITY:
927 case READ_TOC:
928 case READ_FORMAT_CAPACITIES:
929 case REQUEST_SENSE:
930 ret = DMA_FROM_DEVICE;
931 break;
933 case WRITE_6:
934 case WRITE_10:
935 case WRITE_12:
936 case WRITE_16:
937 case MODE_SELECT:
938 case MODE_SELECT_10:
939 case WRITE_VERIFY:
940 case WRITE_VERIFY_12:
941 case PERSISTENT_RESERVE_OUT:
942 case MAINTENANCE_OUT:
943 case SECURITY_PROTOCOL_OUT:
944 case ACCESS_CONTROL_OUT:
945 ret = DMA_TO_DEVICE;
946 break;
947 case ALLOW_MEDIUM_REMOVAL:
948 case TEST_UNIT_READY:
949 case SYNCHRONIZE_CACHE:
950 case START_STOP:
951 case ERASE:
952 case REZERO_UNIT:
953 case SEEK_10:
954 case SPACE:
955 case VERIFY:
956 case WRITE_FILEMARKS:
957 ret = DMA_NONE;
958 break;
959 default:
960 pr_warn("target: Unknown data direction for SCSI Opcode "
961 "0x%02x\n", cdb[0]);
962 ret = -EINVAL;
964 return ret;
967 static void usbg_data_write_cmpl(struct usb_ep *ep, struct usb_request *req)
969 struct usbg_cmd *cmd = req->context;
970 struct se_cmd *se_cmd = &cmd->se_cmd;
972 if (req->status < 0) {
973 pr_err("%s() state %d transfer failed\n", __func__, cmd->state);
974 goto cleanup;
977 if (req->num_sgs == 0) {
978 sg_copy_from_buffer(se_cmd->t_data_sg,
979 se_cmd->t_data_nents,
980 cmd->data_buf,
981 se_cmd->data_length);
984 complete(&cmd->write_complete);
985 return;
987 cleanup:
988 usbg_cleanup_cmd(cmd);
991 static int usbg_prepare_w_request(struct usbg_cmd *cmd, struct usb_request *req)
993 struct se_cmd *se_cmd = &cmd->se_cmd;
994 struct f_uas *fu = cmd->fu;
995 struct usb_gadget *gadget = fuas_to_gadget(fu);
997 if (!gadget->sg_supported) {
998 cmd->data_buf = kmalloc(se_cmd->data_length, GFP_ATOMIC);
999 if (!cmd->data_buf)
1000 return -ENOMEM;
1002 req->buf = cmd->data_buf;
1003 } else {
1004 req->buf = NULL;
1005 req->num_sgs = se_cmd->t_data_nents;
1006 req->sg = se_cmd->t_data_sg;
1009 req->complete = usbg_data_write_cmpl;
1010 req->length = se_cmd->data_length;
1011 req->context = cmd;
1012 return 0;
1015 static int usbg_send_status_response(struct se_cmd *se_cmd)
1017 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1018 se_cmd);
1019 struct f_uas *fu = cmd->fu;
1021 if (fu->flags & USBG_IS_BOT)
1022 return bot_send_status_response(cmd);
1023 else
1024 return uasp_send_status_response(cmd);
1027 static int usbg_send_write_request(struct se_cmd *se_cmd)
1029 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1030 se_cmd);
1031 struct f_uas *fu = cmd->fu;
1033 if (fu->flags & USBG_IS_BOT)
1034 return bot_send_write_request(cmd);
1035 else
1036 return uasp_send_write_request(cmd);
1039 static int usbg_send_read_response(struct se_cmd *se_cmd)
1041 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1042 se_cmd);
1043 struct f_uas *fu = cmd->fu;
1045 if (fu->flags & USBG_IS_BOT)
1046 return bot_send_read_response(cmd);
1047 else
1048 return uasp_send_read_response(cmd);
1051 static void usbg_cmd_work(struct work_struct *work)
1053 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1054 struct se_cmd *se_cmd;
1055 struct tcm_usbg_nexus *tv_nexus;
1056 struct usbg_tpg *tpg;
1057 int dir;
1059 se_cmd = &cmd->se_cmd;
1060 tpg = cmd->fu->tpg;
1061 tv_nexus = tpg->tpg_nexus;
1062 dir = get_cmd_dir(cmd->cmd_buf);
1063 if (dir < 0) {
1064 transport_init_se_cmd(se_cmd,
1065 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1066 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1067 cmd->prio_attr, cmd->sense_iu.sense);
1069 transport_send_check_condition_and_sense(se_cmd,
1070 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1071 usbg_cleanup_cmd(cmd);
1072 return;
1075 target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1076 cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1077 0, cmd->prio_attr, dir, TARGET_SCF_UNKNOWN_SIZE);
1080 static int usbg_submit_command(struct f_uas *fu,
1081 void *cmdbuf, unsigned int len)
1083 struct command_iu *cmd_iu = cmdbuf;
1084 struct usbg_cmd *cmd;
1085 struct usbg_tpg *tpg;
1086 struct se_cmd *se_cmd;
1087 struct tcm_usbg_nexus *tv_nexus;
1088 u32 cmd_len;
1089 int ret;
1091 if (cmd_iu->iu_id != IU_ID_COMMAND) {
1092 pr_err("Unsupported type %d\n", cmd_iu->iu_id);
1093 return -EINVAL;
1096 cmd = kzalloc(sizeof *cmd, GFP_ATOMIC);
1097 if (!cmd)
1098 return -ENOMEM;
1100 cmd->fu = fu;
1102 /* XXX until I figure out why I can't free in on complete */
1103 kref_init(&cmd->ref);
1104 kref_get(&cmd->ref);
1106 tpg = fu->tpg;
1107 cmd_len = (cmd_iu->len & ~0x3) + 16;
1108 if (cmd_len > USBG_MAX_CMD)
1109 goto err;
1111 memcpy(cmd->cmd_buf, cmd_iu->cdb, cmd_len);
1113 cmd->tag = be16_to_cpup(&cmd_iu->tag);
1114 if (fu->flags & USBG_USE_STREAMS) {
1115 if (cmd->tag > UASP_SS_EP_COMP_NUM_STREAMS)
1116 goto err;
1117 if (!cmd->tag)
1118 cmd->stream = &fu->stream[0];
1119 else
1120 cmd->stream = &fu->stream[cmd->tag - 1];
1121 } else {
1122 cmd->stream = &fu->stream[0];
1125 tv_nexus = tpg->tpg_nexus;
1126 if (!tv_nexus) {
1127 pr_err("Missing nexus, ignoring command\n");
1128 goto err;
1131 switch (cmd_iu->prio_attr & 0x7) {
1132 case UAS_HEAD_TAG:
1133 cmd->prio_attr = MSG_HEAD_TAG;
1134 break;
1135 case UAS_ORDERED_TAG:
1136 cmd->prio_attr = MSG_ORDERED_TAG;
1137 break;
1138 case UAS_ACA:
1139 cmd->prio_attr = MSG_ACA_TAG;
1140 break;
1141 default:
1142 pr_debug_once("Unsupported prio_attr: %02x.\n",
1143 cmd_iu->prio_attr);
1144 case UAS_SIMPLE_TAG:
1145 cmd->prio_attr = MSG_SIMPLE_TAG;
1146 break;
1149 se_cmd = &cmd->se_cmd;
1150 cmd->unpacked_lun = scsilun_to_int(&cmd_iu->lun);
1152 INIT_WORK(&cmd->work, usbg_cmd_work);
1153 ret = queue_work(tpg->workqueue, &cmd->work);
1154 if (ret < 0)
1155 goto err;
1157 return 0;
1158 err:
1159 kfree(cmd);
1160 return -EINVAL;
1163 static void bot_cmd_work(struct work_struct *work)
1165 struct usbg_cmd *cmd = container_of(work, struct usbg_cmd, work);
1166 struct se_cmd *se_cmd;
1167 struct tcm_usbg_nexus *tv_nexus;
1168 struct usbg_tpg *tpg;
1169 int dir;
1171 se_cmd = &cmd->se_cmd;
1172 tpg = cmd->fu->tpg;
1173 tv_nexus = tpg->tpg_nexus;
1174 dir = get_cmd_dir(cmd->cmd_buf);
1175 if (dir < 0) {
1176 transport_init_se_cmd(se_cmd,
1177 tv_nexus->tvn_se_sess->se_tpg->se_tpg_tfo,
1178 tv_nexus->tvn_se_sess, cmd->data_len, DMA_NONE,
1179 cmd->prio_attr, cmd->sense_iu.sense);
1181 transport_send_check_condition_and_sense(se_cmd,
1182 TCM_UNSUPPORTED_SCSI_OPCODE, 1);
1183 usbg_cleanup_cmd(cmd);
1184 return;
1187 target_submit_cmd(se_cmd, tv_nexus->tvn_se_sess,
1188 cmd->cmd_buf, cmd->sense_iu.sense, cmd->unpacked_lun,
1189 cmd->data_len, cmd->prio_attr, dir, 0);
1192 static int bot_submit_command(struct f_uas *fu,
1193 void *cmdbuf, unsigned int len)
1195 struct bulk_cb_wrap *cbw = cmdbuf;
1196 struct usbg_cmd *cmd;
1197 struct usbg_tpg *tpg;
1198 struct se_cmd *se_cmd;
1199 struct tcm_usbg_nexus *tv_nexus;
1200 u32 cmd_len;
1201 int ret;
1203 if (cbw->Signature != cpu_to_le32(US_BULK_CB_SIGN)) {
1204 pr_err("Wrong signature on CBW\n");
1205 return -EINVAL;
1207 if (len != 31) {
1208 pr_err("Wrong length for CBW\n");
1209 return -EINVAL;
1212 cmd_len = cbw->Length;
1213 if (cmd_len < 1 || cmd_len > 16)
1214 return -EINVAL;
1216 cmd = kzalloc(sizeof *cmd, GFP_ATOMIC);
1217 if (!cmd)
1218 return -ENOMEM;
1220 cmd->fu = fu;
1222 /* XXX until I figure out why I can't free in on complete */
1223 kref_init(&cmd->ref);
1224 kref_get(&cmd->ref);
1226 tpg = fu->tpg;
1228 memcpy(cmd->cmd_buf, cbw->CDB, cmd_len);
1230 cmd->bot_tag = cbw->Tag;
1232 tv_nexus = tpg->tpg_nexus;
1233 if (!tv_nexus) {
1234 pr_err("Missing nexus, ignoring command\n");
1235 goto err;
1238 cmd->prio_attr = MSG_SIMPLE_TAG;
1239 se_cmd = &cmd->se_cmd;
1240 cmd->unpacked_lun = cbw->Lun;
1241 cmd->is_read = cbw->Flags & US_BULK_FLAG_IN ? 1 : 0;
1242 cmd->data_len = le32_to_cpu(cbw->DataTransferLength);
1244 INIT_WORK(&cmd->work, bot_cmd_work);
1245 ret = queue_work(tpg->workqueue, &cmd->work);
1246 if (ret < 0)
1247 goto err;
1249 return 0;
1250 err:
1251 kfree(cmd);
1252 return -EINVAL;
1255 /* Start fabric.c code */
1257 static int usbg_check_true(struct se_portal_group *se_tpg)
1259 return 1;
1262 static int usbg_check_false(struct se_portal_group *se_tpg)
1264 return 0;
1267 static char *usbg_get_fabric_name(void)
1269 return "usb_gadget";
1272 static u8 usbg_get_fabric_proto_ident(struct se_portal_group *se_tpg)
1274 struct usbg_tpg *tpg = container_of(se_tpg,
1275 struct usbg_tpg, se_tpg);
1276 struct usbg_tport *tport = tpg->tport;
1277 u8 proto_id;
1279 switch (tport->tport_proto_id) {
1280 case SCSI_PROTOCOL_SAS:
1281 default:
1282 proto_id = sas_get_fabric_proto_ident(se_tpg);
1283 break;
1286 return proto_id;
1289 static char *usbg_get_fabric_wwn(struct se_portal_group *se_tpg)
1291 struct usbg_tpg *tpg = container_of(se_tpg,
1292 struct usbg_tpg, se_tpg);
1293 struct usbg_tport *tport = tpg->tport;
1295 return &tport->tport_name[0];
1298 static u16 usbg_get_tag(struct se_portal_group *se_tpg)
1300 struct usbg_tpg *tpg = container_of(se_tpg,
1301 struct usbg_tpg, se_tpg);
1302 return tpg->tport_tpgt;
1305 static u32 usbg_get_default_depth(struct se_portal_group *se_tpg)
1307 return 1;
1310 static u32 usbg_get_pr_transport_id(
1311 struct se_portal_group *se_tpg,
1312 struct se_node_acl *se_nacl,
1313 struct t10_pr_registration *pr_reg,
1314 int *format_code,
1315 unsigned char *buf)
1317 struct usbg_tpg *tpg = container_of(se_tpg,
1318 struct usbg_tpg, se_tpg);
1319 struct usbg_tport *tport = tpg->tport;
1320 int ret = 0;
1322 switch (tport->tport_proto_id) {
1323 case SCSI_PROTOCOL_SAS:
1324 default:
1325 ret = sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1326 format_code, buf);
1327 break;
1330 return ret;
1333 static u32 usbg_get_pr_transport_id_len(
1334 struct se_portal_group *se_tpg,
1335 struct se_node_acl *se_nacl,
1336 struct t10_pr_registration *pr_reg,
1337 int *format_code)
1339 struct usbg_tpg *tpg = container_of(se_tpg,
1340 struct usbg_tpg, se_tpg);
1341 struct usbg_tport *tport = tpg->tport;
1342 int ret = 0;
1344 switch (tport->tport_proto_id) {
1345 case SCSI_PROTOCOL_SAS:
1346 default:
1347 ret = sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1348 format_code);
1349 break;
1352 return ret;
1355 static char *usbg_parse_pr_out_transport_id(
1356 struct se_portal_group *se_tpg,
1357 const char *buf,
1358 u32 *out_tid_len,
1359 char **port_nexus_ptr)
1361 struct usbg_tpg *tpg = container_of(se_tpg,
1362 struct usbg_tpg, se_tpg);
1363 struct usbg_tport *tport = tpg->tport;
1364 char *tid = NULL;
1366 switch (tport->tport_proto_id) {
1367 case SCSI_PROTOCOL_SAS:
1368 default:
1369 tid = sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1370 port_nexus_ptr);
1373 return tid;
1376 static struct se_node_acl *usbg_alloc_fabric_acl(struct se_portal_group *se_tpg)
1378 struct usbg_nacl *nacl;
1380 nacl = kzalloc(sizeof(struct usbg_nacl), GFP_KERNEL);
1381 if (!nacl) {
1382 printk(KERN_ERR "Unable to alocate struct usbg_nacl\n");
1383 return NULL;
1386 return &nacl->se_node_acl;
1389 static void usbg_release_fabric_acl(
1390 struct se_portal_group *se_tpg,
1391 struct se_node_acl *se_nacl)
1393 struct usbg_nacl *nacl = container_of(se_nacl,
1394 struct usbg_nacl, se_node_acl);
1395 kfree(nacl);
1398 static u32 usbg_tpg_get_inst_index(struct se_portal_group *se_tpg)
1400 return 1;
1403 static void usbg_cmd_release(struct kref *ref)
1405 struct usbg_cmd *cmd = container_of(ref, struct usbg_cmd,
1406 ref);
1408 transport_generic_free_cmd(&cmd->se_cmd, 0);
1411 static void usbg_release_cmd(struct se_cmd *se_cmd)
1413 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1414 se_cmd);
1415 kfree(cmd->data_buf);
1416 kfree(cmd);
1417 return;
1420 static int usbg_shutdown_session(struct se_session *se_sess)
1422 return 0;
1425 static void usbg_close_session(struct se_session *se_sess)
1427 return;
1430 static u32 usbg_sess_get_index(struct se_session *se_sess)
1432 return 0;
1436 * XXX Error recovery: return != 0 if we expect writes. Dunno when that could be
1438 static int usbg_write_pending_status(struct se_cmd *se_cmd)
1440 return 0;
1443 static void usbg_set_default_node_attrs(struct se_node_acl *nacl)
1445 return;
1448 static u32 usbg_get_task_tag(struct se_cmd *se_cmd)
1450 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1451 se_cmd);
1452 struct f_uas *fu = cmd->fu;
1454 if (fu->flags & USBG_IS_BOT)
1455 return le32_to_cpu(cmd->bot_tag);
1456 else
1457 return cmd->tag;
1460 static int usbg_get_cmd_state(struct se_cmd *se_cmd)
1462 return 0;
1465 static int usbg_queue_tm_rsp(struct se_cmd *se_cmd)
1467 return 0;
1470 static u16 usbg_set_fabric_sense_len(struct se_cmd *se_cmd, u32 sense_length)
1472 return 0;
1475 static u16 usbg_get_fabric_sense_len(void)
1477 return 0;
1480 static const char *usbg_check_wwn(const char *name)
1482 const char *n;
1483 unsigned int len;
1485 n = strstr(name, "naa.");
1486 if (!n)
1487 return NULL;
1488 n += 4;
1489 len = strlen(n);
1490 if (len == 0 || len > USBG_NAMELEN - 1)
1491 return NULL;
1492 return n;
1495 static struct se_node_acl *usbg_make_nodeacl(
1496 struct se_portal_group *se_tpg,
1497 struct config_group *group,
1498 const char *name)
1500 struct se_node_acl *se_nacl, *se_nacl_new;
1501 struct usbg_nacl *nacl;
1502 u64 wwpn = 0;
1503 u32 nexus_depth;
1504 const char *wnn_name;
1506 wnn_name = usbg_check_wwn(name);
1507 if (!wnn_name)
1508 return ERR_PTR(-EINVAL);
1509 se_nacl_new = usbg_alloc_fabric_acl(se_tpg);
1510 if (!(se_nacl_new))
1511 return ERR_PTR(-ENOMEM);
1513 nexus_depth = 1;
1515 * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1516 * when converting a NodeACL from demo mode -> explict
1518 se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,
1519 name, nexus_depth);
1520 if (IS_ERR(se_nacl)) {
1521 usbg_release_fabric_acl(se_tpg, se_nacl_new);
1522 return se_nacl;
1525 * Locate our struct usbg_nacl and set the FC Nport WWPN
1527 nacl = container_of(se_nacl, struct usbg_nacl, se_node_acl);
1528 nacl->iport_wwpn = wwpn;
1529 snprintf(nacl->iport_name, sizeof(nacl->iport_name), "%s", name);
1530 return se_nacl;
1533 static void usbg_drop_nodeacl(struct se_node_acl *se_acl)
1535 struct usbg_nacl *nacl = container_of(se_acl,
1536 struct usbg_nacl, se_node_acl);
1537 core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);
1538 kfree(nacl);
1541 struct usbg_tpg *the_only_tpg_I_currently_have;
1543 static struct se_portal_group *usbg_make_tpg(
1544 struct se_wwn *wwn,
1545 struct config_group *group,
1546 const char *name)
1548 struct usbg_tport *tport = container_of(wwn, struct usbg_tport,
1549 tport_wwn);
1550 struct usbg_tpg *tpg;
1551 unsigned long tpgt;
1552 int ret;
1554 if (strstr(name, "tpgt_") != name)
1555 return ERR_PTR(-EINVAL);
1556 if (kstrtoul(name + 5, 0, &tpgt) || tpgt > UINT_MAX)
1557 return ERR_PTR(-EINVAL);
1558 if (the_only_tpg_I_currently_have) {
1559 pr_err("Until the gadget framework can't handle multiple\n");
1560 pr_err("gadgets, you can't do this here.\n");
1561 return ERR_PTR(-EBUSY);
1564 tpg = kzalloc(sizeof(struct usbg_tpg), GFP_KERNEL);
1565 if (!tpg) {
1566 printk(KERN_ERR "Unable to allocate struct usbg_tpg");
1567 return ERR_PTR(-ENOMEM);
1569 mutex_init(&tpg->tpg_mutex);
1570 atomic_set(&tpg->tpg_port_count, 0);
1571 tpg->workqueue = alloc_workqueue("tcm_usb_gadget", 0, 1);
1572 if (!tpg->workqueue) {
1573 kfree(tpg);
1574 return NULL;
1577 tpg->tport = tport;
1578 tpg->tport_tpgt = tpgt;
1580 ret = core_tpg_register(&usbg_fabric_configfs->tf_ops, wwn,
1581 &tpg->se_tpg, tpg,
1582 TRANSPORT_TPG_TYPE_NORMAL);
1583 if (ret < 0) {
1584 destroy_workqueue(tpg->workqueue);
1585 kfree(tpg);
1586 return NULL;
1588 the_only_tpg_I_currently_have = tpg;
1589 return &tpg->se_tpg;
1592 static void usbg_drop_tpg(struct se_portal_group *se_tpg)
1594 struct usbg_tpg *tpg = container_of(se_tpg,
1595 struct usbg_tpg, se_tpg);
1597 core_tpg_deregister(se_tpg);
1598 destroy_workqueue(tpg->workqueue);
1599 kfree(tpg);
1600 the_only_tpg_I_currently_have = NULL;
1603 static struct se_wwn *usbg_make_tport(
1604 struct target_fabric_configfs *tf,
1605 struct config_group *group,
1606 const char *name)
1608 struct usbg_tport *tport;
1609 const char *wnn_name;
1610 u64 wwpn = 0;
1612 wnn_name = usbg_check_wwn(name);
1613 if (!wnn_name)
1614 return ERR_PTR(-EINVAL);
1616 tport = kzalloc(sizeof(struct usbg_tport), GFP_KERNEL);
1617 if (!(tport)) {
1618 printk(KERN_ERR "Unable to allocate struct usbg_tport");
1619 return ERR_PTR(-ENOMEM);
1621 tport->tport_wwpn = wwpn;
1622 snprintf(tport->tport_name, sizeof(tport->tport_name), wnn_name);
1623 return &tport->tport_wwn;
1626 static void usbg_drop_tport(struct se_wwn *wwn)
1628 struct usbg_tport *tport = container_of(wwn,
1629 struct usbg_tport, tport_wwn);
1630 kfree(tport);
1634 * If somebody feels like dropping the version property, go ahead.
1636 static ssize_t usbg_wwn_show_attr_version(
1637 struct target_fabric_configfs *tf,
1638 char *page)
1640 return sprintf(page, "usb-gadget fabric module\n");
1642 TF_WWN_ATTR_RO(usbg, version);
1644 static struct configfs_attribute *usbg_wwn_attrs[] = {
1645 &usbg_wwn_version.attr,
1646 NULL,
1649 static ssize_t tcm_usbg_tpg_show_enable(
1650 struct se_portal_group *se_tpg,
1651 char *page)
1653 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1655 return snprintf(page, PAGE_SIZE, "%u\n", tpg->gadget_connect);
1658 static int usbg_attach(struct usbg_tpg *);
1659 static void usbg_detach(struct usbg_tpg *);
1661 static ssize_t tcm_usbg_tpg_store_enable(
1662 struct se_portal_group *se_tpg,
1663 const char *page,
1664 size_t count)
1666 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1667 unsigned long op;
1668 ssize_t ret;
1670 ret = kstrtoul(page, 0, &op);
1671 if (ret < 0)
1672 return -EINVAL;
1673 if (op > 1)
1674 return -EINVAL;
1676 if (op && tpg->gadget_connect)
1677 goto out;
1678 if (!op && !tpg->gadget_connect)
1679 goto out;
1681 if (op) {
1682 ret = usbg_attach(tpg);
1683 if (ret)
1684 goto out;
1685 } else {
1686 usbg_detach(tpg);
1688 tpg->gadget_connect = op;
1689 out:
1690 return count;
1692 TF_TPG_BASE_ATTR(tcm_usbg, enable, S_IRUGO | S_IWUSR);
1694 static ssize_t tcm_usbg_tpg_show_nexus(
1695 struct se_portal_group *se_tpg,
1696 char *page)
1698 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1699 struct tcm_usbg_nexus *tv_nexus;
1700 ssize_t ret;
1702 mutex_lock(&tpg->tpg_mutex);
1703 tv_nexus = tpg->tpg_nexus;
1704 if (!tv_nexus) {
1705 ret = -ENODEV;
1706 goto out;
1708 ret = snprintf(page, PAGE_SIZE, "%s\n",
1709 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1710 out:
1711 mutex_unlock(&tpg->tpg_mutex);
1712 return ret;
1715 static int tcm_usbg_make_nexus(struct usbg_tpg *tpg, char *name)
1717 struct se_portal_group *se_tpg;
1718 struct tcm_usbg_nexus *tv_nexus;
1719 int ret;
1721 mutex_lock(&tpg->tpg_mutex);
1722 if (tpg->tpg_nexus) {
1723 ret = -EEXIST;
1724 pr_debug("tpg->tpg_nexus already exists\n");
1725 goto err_unlock;
1727 se_tpg = &tpg->se_tpg;
1729 ret = -ENOMEM;
1730 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1731 if (!tv_nexus) {
1732 pr_err("Unable to allocate struct tcm_vhost_nexus\n");
1733 goto err_unlock;
1735 tv_nexus->tvn_se_sess = transport_init_session();
1736 if (IS_ERR(tv_nexus->tvn_se_sess))
1737 goto err_free;
1740 * Since we are running in 'demo mode' this call with generate a
1741 * struct se_node_acl for the tcm_vhost struct se_portal_group with
1742 * the SCSI Initiator port name of the passed configfs group 'name'.
1744 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1745 se_tpg, name);
1746 if (!tv_nexus->tvn_se_sess->se_node_acl) {
1747 pr_debug("core_tpg_check_initiator_node_acl() failed"
1748 " for %s\n", name);
1749 goto err_session;
1752 * Now register the TCM vHost virtual I_T Nexus as active with the
1753 * call to __transport_register_session()
1755 __transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1756 tv_nexus->tvn_se_sess, tv_nexus);
1757 tpg->tpg_nexus = tv_nexus;
1758 mutex_unlock(&tpg->tpg_mutex);
1759 return 0;
1761 err_session:
1762 transport_free_session(tv_nexus->tvn_se_sess);
1763 err_free:
1764 kfree(tv_nexus);
1765 err_unlock:
1766 mutex_unlock(&tpg->tpg_mutex);
1767 return ret;
1770 static int tcm_usbg_drop_nexus(struct usbg_tpg *tpg)
1772 struct se_session *se_sess;
1773 struct tcm_usbg_nexus *tv_nexus;
1774 int ret = -ENODEV;
1776 mutex_lock(&tpg->tpg_mutex);
1777 tv_nexus = tpg->tpg_nexus;
1778 if (!tv_nexus)
1779 goto out;
1781 se_sess = tv_nexus->tvn_se_sess;
1782 if (!se_sess)
1783 goto out;
1785 if (atomic_read(&tpg->tpg_port_count)) {
1786 ret = -EPERM;
1787 pr_err("Unable to remove Host I_T Nexus with"
1788 " active TPG port count: %d\n",
1789 atomic_read(&tpg->tpg_port_count));
1790 goto out;
1793 pr_debug("Removing I_T Nexus to Initiator Port: %s\n",
1794 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1796 * Release the SCSI I_T Nexus to the emulated vHost Target Port
1798 transport_deregister_session(tv_nexus->tvn_se_sess);
1799 tpg->tpg_nexus = NULL;
1801 kfree(tv_nexus);
1802 out:
1803 mutex_unlock(&tpg->tpg_mutex);
1804 return 0;
1807 static ssize_t tcm_usbg_tpg_store_nexus(
1808 struct se_portal_group *se_tpg,
1809 const char *page,
1810 size_t count)
1812 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1813 unsigned char i_port[USBG_NAMELEN], *ptr;
1814 int ret;
1816 if (!strncmp(page, "NULL", 4)) {
1817 ret = tcm_usbg_drop_nexus(tpg);
1818 return (!ret) ? count : ret;
1820 if (strlen(page) > USBG_NAMELEN) {
1821 pr_err("Emulated NAA Sas Address: %s, exceeds"
1822 " max: %d\n", page, USBG_NAMELEN);
1823 return -EINVAL;
1825 snprintf(i_port, USBG_NAMELEN, "%s", page);
1827 ptr = strstr(i_port, "naa.");
1828 if (!ptr) {
1829 pr_err("Missing 'naa.' prefix\n");
1830 return -EINVAL;
1833 if (i_port[strlen(i_port) - 1] == '\n')
1834 i_port[strlen(i_port) - 1] = '\0';
1836 ret = tcm_usbg_make_nexus(tpg, &i_port[4]);
1837 if (ret < 0)
1838 return ret;
1839 return count;
1841 TF_TPG_BASE_ATTR(tcm_usbg, nexus, S_IRUGO | S_IWUSR);
1843 static struct configfs_attribute *usbg_base_attrs[] = {
1844 &tcm_usbg_tpg_enable.attr,
1845 &tcm_usbg_tpg_nexus.attr,
1846 NULL,
1849 static int usbg_port_link(struct se_portal_group *se_tpg, struct se_lun *lun)
1851 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1853 atomic_inc(&tpg->tpg_port_count);
1854 smp_mb__after_atomic_inc();
1855 return 0;
1858 static void usbg_port_unlink(struct se_portal_group *se_tpg,
1859 struct se_lun *se_lun)
1861 struct usbg_tpg *tpg = container_of(se_tpg, struct usbg_tpg, se_tpg);
1863 atomic_dec(&tpg->tpg_port_count);
1864 smp_mb__after_atomic_dec();
1867 static int usbg_check_stop_free(struct se_cmd *se_cmd)
1869 struct usbg_cmd *cmd = container_of(se_cmd, struct usbg_cmd,
1870 se_cmd);
1872 kref_put(&cmd->ref, usbg_cmd_release);
1873 return 1;
1876 static struct target_core_fabric_ops usbg_ops = {
1877 .get_fabric_name = usbg_get_fabric_name,
1878 .get_fabric_proto_ident = usbg_get_fabric_proto_ident,
1879 .tpg_get_wwn = usbg_get_fabric_wwn,
1880 .tpg_get_tag = usbg_get_tag,
1881 .tpg_get_default_depth = usbg_get_default_depth,
1882 .tpg_get_pr_transport_id = usbg_get_pr_transport_id,
1883 .tpg_get_pr_transport_id_len = usbg_get_pr_transport_id_len,
1884 .tpg_parse_pr_out_transport_id = usbg_parse_pr_out_transport_id,
1885 .tpg_check_demo_mode = usbg_check_true,
1886 .tpg_check_demo_mode_cache = usbg_check_false,
1887 .tpg_check_demo_mode_write_protect = usbg_check_false,
1888 .tpg_check_prod_mode_write_protect = usbg_check_false,
1889 .tpg_alloc_fabric_acl = usbg_alloc_fabric_acl,
1890 .tpg_release_fabric_acl = usbg_release_fabric_acl,
1891 .tpg_get_inst_index = usbg_tpg_get_inst_index,
1892 .release_cmd = usbg_release_cmd,
1893 .shutdown_session = usbg_shutdown_session,
1894 .close_session = usbg_close_session,
1895 .sess_get_index = usbg_sess_get_index,
1896 .sess_get_initiator_sid = NULL,
1897 .write_pending = usbg_send_write_request,
1898 .write_pending_status = usbg_write_pending_status,
1899 .set_default_node_attributes = usbg_set_default_node_attrs,
1900 .get_task_tag = usbg_get_task_tag,
1901 .get_cmd_state = usbg_get_cmd_state,
1902 .queue_data_in = usbg_send_read_response,
1903 .queue_status = usbg_send_status_response,
1904 .queue_tm_rsp = usbg_queue_tm_rsp,
1905 .get_fabric_sense_len = usbg_get_fabric_sense_len,
1906 .set_fabric_sense_len = usbg_set_fabric_sense_len,
1907 .check_stop_free = usbg_check_stop_free,
1909 .fabric_make_wwn = usbg_make_tport,
1910 .fabric_drop_wwn = usbg_drop_tport,
1911 .fabric_make_tpg = usbg_make_tpg,
1912 .fabric_drop_tpg = usbg_drop_tpg,
1913 .fabric_post_link = usbg_port_link,
1914 .fabric_pre_unlink = usbg_port_unlink,
1915 .fabric_make_np = NULL,
1916 .fabric_drop_np = NULL,
1917 .fabric_make_nodeacl = usbg_make_nodeacl,
1918 .fabric_drop_nodeacl = usbg_drop_nodeacl,
1921 static int usbg_register_configfs(void)
1923 struct target_fabric_configfs *fabric;
1924 int ret;
1926 fabric = target_fabric_configfs_init(THIS_MODULE, "usb_gadget");
1927 if (IS_ERR(fabric)) {
1928 printk(KERN_ERR "target_fabric_configfs_init() failed\n");
1929 return PTR_ERR(fabric);
1932 fabric->tf_ops = usbg_ops;
1933 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = usbg_wwn_attrs;
1934 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = usbg_base_attrs;
1935 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
1936 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
1937 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
1938 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_base_cit.ct_attrs = NULL;
1939 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
1940 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
1941 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_param_cit.ct_attrs = NULL;
1942 ret = target_fabric_configfs_register(fabric);
1943 if (ret < 0) {
1944 printk(KERN_ERR "target_fabric_configfs_register() failed"
1945 " for usb-gadget\n");
1946 return ret;
1948 usbg_fabric_configfs = fabric;
1949 return 0;
1952 static void usbg_deregister_configfs(void)
1954 if (!(usbg_fabric_configfs))
1955 return;
1957 target_fabric_configfs_deregister(usbg_fabric_configfs);
1958 usbg_fabric_configfs = NULL;
1961 /* Start gadget.c code */
1963 static struct usb_interface_descriptor bot_intf_desc = {
1964 .bLength = sizeof(bot_intf_desc),
1965 .bDescriptorType = USB_DT_INTERFACE,
1966 .bAlternateSetting = 0,
1967 .bNumEndpoints = 2,
1968 .bAlternateSetting = USB_G_ALT_INT_BBB,
1969 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1970 .bInterfaceSubClass = USB_SC_SCSI,
1971 .bInterfaceProtocol = USB_PR_BULK,
1972 .iInterface = USB_G_STR_INT_UAS,
1975 static struct usb_interface_descriptor uasp_intf_desc = {
1976 .bLength = sizeof(uasp_intf_desc),
1977 .bDescriptorType = USB_DT_INTERFACE,
1978 .bNumEndpoints = 4,
1979 .bAlternateSetting = USB_G_ALT_INT_UAS,
1980 .bInterfaceClass = USB_CLASS_MASS_STORAGE,
1981 .bInterfaceSubClass = USB_SC_SCSI,
1982 .bInterfaceProtocol = USB_PR_UAS,
1983 .iInterface = USB_G_STR_INT_BBB,
1986 static struct usb_endpoint_descriptor uasp_bi_desc = {
1987 .bLength = USB_DT_ENDPOINT_SIZE,
1988 .bDescriptorType = USB_DT_ENDPOINT,
1989 .bEndpointAddress = USB_DIR_IN,
1990 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1991 .wMaxPacketSize = cpu_to_le16(512),
1994 static struct usb_endpoint_descriptor uasp_fs_bi_desc = {
1995 .bLength = USB_DT_ENDPOINT_SIZE,
1996 .bDescriptorType = USB_DT_ENDPOINT,
1997 .bEndpointAddress = USB_DIR_IN,
1998 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2001 static struct usb_pipe_usage_descriptor uasp_bi_pipe_desc = {
2002 .bLength = sizeof(uasp_bi_pipe_desc),
2003 .bDescriptorType = USB_DT_PIPE_USAGE,
2004 .bPipeID = DATA_IN_PIPE_ID,
2007 static struct usb_endpoint_descriptor uasp_ss_bi_desc = {
2008 .bLength = USB_DT_ENDPOINT_SIZE,
2009 .bDescriptorType = USB_DT_ENDPOINT,
2010 .bEndpointAddress = USB_DIR_IN,
2011 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2012 .wMaxPacketSize = cpu_to_le16(1024),
2015 static struct usb_ss_ep_comp_descriptor uasp_bi_ep_comp_desc = {
2016 .bLength = sizeof(uasp_bi_ep_comp_desc),
2017 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2018 .bMaxBurst = 0,
2019 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
2020 .wBytesPerInterval = 0,
2023 static struct usb_ss_ep_comp_descriptor bot_bi_ep_comp_desc = {
2024 .bLength = sizeof(bot_bi_ep_comp_desc),
2025 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2026 .bMaxBurst = 0,
2029 static struct usb_endpoint_descriptor uasp_bo_desc = {
2030 .bLength = USB_DT_ENDPOINT_SIZE,
2031 .bDescriptorType = USB_DT_ENDPOINT,
2032 .bEndpointAddress = USB_DIR_OUT,
2033 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2034 .wMaxPacketSize = cpu_to_le16(512),
2037 static struct usb_endpoint_descriptor uasp_fs_bo_desc = {
2038 .bLength = USB_DT_ENDPOINT_SIZE,
2039 .bDescriptorType = USB_DT_ENDPOINT,
2040 .bEndpointAddress = USB_DIR_OUT,
2041 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2044 static struct usb_pipe_usage_descriptor uasp_bo_pipe_desc = {
2045 .bLength = sizeof(uasp_bo_pipe_desc),
2046 .bDescriptorType = USB_DT_PIPE_USAGE,
2047 .bPipeID = DATA_OUT_PIPE_ID,
2050 static struct usb_endpoint_descriptor uasp_ss_bo_desc = {
2051 .bLength = USB_DT_ENDPOINT_SIZE,
2052 .bDescriptorType = USB_DT_ENDPOINT,
2053 .bEndpointAddress = USB_DIR_OUT,
2054 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2055 .wMaxPacketSize = cpu_to_le16(0x400),
2058 static struct usb_ss_ep_comp_descriptor uasp_bo_ep_comp_desc = {
2059 .bLength = sizeof(uasp_bo_ep_comp_desc),
2060 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2061 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
2064 static struct usb_ss_ep_comp_descriptor bot_bo_ep_comp_desc = {
2065 .bLength = sizeof(bot_bo_ep_comp_desc),
2066 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2069 static struct usb_endpoint_descriptor uasp_status_desc = {
2070 .bLength = USB_DT_ENDPOINT_SIZE,
2071 .bDescriptorType = USB_DT_ENDPOINT,
2072 .bEndpointAddress = USB_DIR_IN,
2073 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2074 .wMaxPacketSize = cpu_to_le16(512),
2077 static struct usb_endpoint_descriptor uasp_fs_status_desc = {
2078 .bLength = USB_DT_ENDPOINT_SIZE,
2079 .bDescriptorType = USB_DT_ENDPOINT,
2080 .bEndpointAddress = USB_DIR_IN,
2081 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2084 static struct usb_pipe_usage_descriptor uasp_status_pipe_desc = {
2085 .bLength = sizeof(uasp_status_pipe_desc),
2086 .bDescriptorType = USB_DT_PIPE_USAGE,
2087 .bPipeID = STATUS_PIPE_ID,
2090 static struct usb_endpoint_descriptor uasp_ss_status_desc = {
2091 .bLength = USB_DT_ENDPOINT_SIZE,
2092 .bDescriptorType = USB_DT_ENDPOINT,
2093 .bEndpointAddress = USB_DIR_IN,
2094 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2095 .wMaxPacketSize = cpu_to_le16(1024),
2098 static struct usb_ss_ep_comp_descriptor uasp_status_in_ep_comp_desc = {
2099 .bLength = sizeof(uasp_status_in_ep_comp_desc),
2100 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2101 .bmAttributes = UASP_SS_EP_COMP_LOG_STREAMS,
2104 static struct usb_endpoint_descriptor uasp_cmd_desc = {
2105 .bLength = USB_DT_ENDPOINT_SIZE,
2106 .bDescriptorType = USB_DT_ENDPOINT,
2107 .bEndpointAddress = USB_DIR_OUT,
2108 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2109 .wMaxPacketSize = cpu_to_le16(512),
2112 static struct usb_endpoint_descriptor uasp_fs_cmd_desc = {
2113 .bLength = USB_DT_ENDPOINT_SIZE,
2114 .bDescriptorType = USB_DT_ENDPOINT,
2115 .bEndpointAddress = USB_DIR_OUT,
2116 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2119 static struct usb_pipe_usage_descriptor uasp_cmd_pipe_desc = {
2120 .bLength = sizeof(uasp_cmd_pipe_desc),
2121 .bDescriptorType = USB_DT_PIPE_USAGE,
2122 .bPipeID = CMD_PIPE_ID,
2125 static struct usb_endpoint_descriptor uasp_ss_cmd_desc = {
2126 .bLength = USB_DT_ENDPOINT_SIZE,
2127 .bDescriptorType = USB_DT_ENDPOINT,
2128 .bEndpointAddress = USB_DIR_OUT,
2129 .bmAttributes = USB_ENDPOINT_XFER_BULK,
2130 .wMaxPacketSize = cpu_to_le16(1024),
2133 static struct usb_ss_ep_comp_descriptor uasp_cmd_comp_desc = {
2134 .bLength = sizeof(uasp_cmd_comp_desc),
2135 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
2138 static struct usb_descriptor_header *uasp_fs_function_desc[] = {
2139 (struct usb_descriptor_header *) &bot_intf_desc,
2140 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
2141 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
2143 (struct usb_descriptor_header *) &uasp_intf_desc,
2144 (struct usb_descriptor_header *) &uasp_fs_bi_desc,
2145 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2146 (struct usb_descriptor_header *) &uasp_fs_bo_desc,
2147 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2148 (struct usb_descriptor_header *) &uasp_fs_status_desc,
2149 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2150 (struct usb_descriptor_header *) &uasp_fs_cmd_desc,
2151 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2154 static struct usb_descriptor_header *uasp_hs_function_desc[] = {
2155 (struct usb_descriptor_header *) &bot_intf_desc,
2156 (struct usb_descriptor_header *) &uasp_bi_desc,
2157 (struct usb_descriptor_header *) &uasp_bo_desc,
2159 (struct usb_descriptor_header *) &uasp_intf_desc,
2160 (struct usb_descriptor_header *) &uasp_bi_desc,
2161 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2162 (struct usb_descriptor_header *) &uasp_bo_desc,
2163 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2164 (struct usb_descriptor_header *) &uasp_status_desc,
2165 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2166 (struct usb_descriptor_header *) &uasp_cmd_desc,
2167 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2168 NULL,
2171 static struct usb_descriptor_header *uasp_ss_function_desc[] = {
2172 (struct usb_descriptor_header *) &bot_intf_desc,
2173 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
2174 (struct usb_descriptor_header *) &bot_bi_ep_comp_desc,
2175 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
2176 (struct usb_descriptor_header *) &bot_bo_ep_comp_desc,
2178 (struct usb_descriptor_header *) &uasp_intf_desc,
2179 (struct usb_descriptor_header *) &uasp_ss_bi_desc,
2180 (struct usb_descriptor_header *) &uasp_bi_ep_comp_desc,
2181 (struct usb_descriptor_header *) &uasp_bi_pipe_desc,
2182 (struct usb_descriptor_header *) &uasp_ss_bo_desc,
2183 (struct usb_descriptor_header *) &uasp_bo_ep_comp_desc,
2184 (struct usb_descriptor_header *) &uasp_bo_pipe_desc,
2185 (struct usb_descriptor_header *) &uasp_ss_status_desc,
2186 (struct usb_descriptor_header *) &uasp_status_in_ep_comp_desc,
2187 (struct usb_descriptor_header *) &uasp_status_pipe_desc,
2188 (struct usb_descriptor_header *) &uasp_ss_cmd_desc,
2189 (struct usb_descriptor_header *) &uasp_cmd_comp_desc,
2190 (struct usb_descriptor_header *) &uasp_cmd_pipe_desc,
2191 NULL,
2194 #define UAS_VENDOR_ID 0x0525 /* NetChip */
2195 #define UAS_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */
2197 static struct usb_device_descriptor usbg_device_desc = {
2198 .bLength = sizeof(usbg_device_desc),
2199 .bDescriptorType = USB_DT_DEVICE,
2200 .bcdUSB = cpu_to_le16(0x0200),
2201 .bDeviceClass = USB_CLASS_PER_INTERFACE,
2202 .idVendor = cpu_to_le16(UAS_VENDOR_ID),
2203 .idProduct = cpu_to_le16(UAS_PRODUCT_ID),
2204 .iManufacturer = USB_G_STR_MANUFACTOR,
2205 .iProduct = USB_G_STR_PRODUCT,
2206 .iSerialNumber = USB_G_STR_SERIAL,
2208 .bNumConfigurations = 1,
2211 static struct usb_string usbg_us_strings[] = {
2212 { USB_G_STR_MANUFACTOR, "Target Manufactor"},
2213 { USB_G_STR_PRODUCT, "Target Product"},
2214 { USB_G_STR_SERIAL, "000000000001"},
2215 { USB_G_STR_CONFIG, "default config"},
2216 { USB_G_STR_INT_UAS, "USB Attached SCSI"},
2217 { USB_G_STR_INT_BBB, "Bulk Only Transport"},
2218 { },
2221 static struct usb_gadget_strings usbg_stringtab = {
2222 .language = 0x0409,
2223 .strings = usbg_us_strings,
2226 static struct usb_gadget_strings *usbg_strings[] = {
2227 &usbg_stringtab,
2228 NULL,
2231 static int guas_unbind(struct usb_composite_dev *cdev)
2233 return 0;
2236 static struct usb_configuration usbg_config_driver = {
2237 .label = "Linux Target",
2238 .bConfigurationValue = 1,
2239 .iConfiguration = USB_G_STR_CONFIG,
2240 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
2243 static void give_back_ep(struct usb_ep **pep)
2245 struct usb_ep *ep = *pep;
2246 if (!ep)
2247 return;
2248 ep->driver_data = NULL;
2251 static int usbg_bind(struct usb_configuration *c, struct usb_function *f)
2253 struct f_uas *fu = to_f_uas(f);
2254 struct usb_gadget *gadget = c->cdev->gadget;
2255 struct usb_ep *ep;
2256 int iface;
2258 iface = usb_interface_id(c, f);
2259 if (iface < 0)
2260 return iface;
2262 bot_intf_desc.bInterfaceNumber = iface;
2263 uasp_intf_desc.bInterfaceNumber = iface;
2264 fu->iface = iface;
2265 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bi_desc,
2266 &uasp_bi_ep_comp_desc);
2267 if (!ep)
2268 goto ep_fail;
2270 ep->driver_data = fu;
2271 fu->ep_in = ep;
2273 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_bo_desc,
2274 &uasp_bo_ep_comp_desc);
2275 if (!ep)
2276 goto ep_fail;
2277 ep->driver_data = fu;
2278 fu->ep_out = ep;
2280 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_status_desc,
2281 &uasp_status_in_ep_comp_desc);
2282 if (!ep)
2283 goto ep_fail;
2284 ep->driver_data = fu;
2285 fu->ep_status = ep;
2287 ep = usb_ep_autoconfig_ss(gadget, &uasp_ss_cmd_desc,
2288 &uasp_cmd_comp_desc);
2289 if (!ep)
2290 goto ep_fail;
2291 ep->driver_data = fu;
2292 fu->ep_cmd = ep;
2294 /* Assume endpoint addresses are the same for both speeds */
2295 uasp_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2296 uasp_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2297 uasp_status_desc.bEndpointAddress =
2298 uasp_ss_status_desc.bEndpointAddress;
2299 uasp_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2301 uasp_fs_bi_desc.bEndpointAddress = uasp_ss_bi_desc.bEndpointAddress;
2302 uasp_fs_bo_desc.bEndpointAddress = uasp_ss_bo_desc.bEndpointAddress;
2303 uasp_fs_status_desc.bEndpointAddress =
2304 uasp_ss_status_desc.bEndpointAddress;
2305 uasp_fs_cmd_desc.bEndpointAddress = uasp_ss_cmd_desc.bEndpointAddress;
2307 return 0;
2308 ep_fail:
2309 pr_err("Can't claim all required eps\n");
2311 give_back_ep(&fu->ep_in);
2312 give_back_ep(&fu->ep_out);
2313 give_back_ep(&fu->ep_status);
2314 give_back_ep(&fu->ep_cmd);
2315 return -ENOTSUPP;
2318 static void usbg_unbind(struct usb_configuration *c, struct usb_function *f)
2320 struct f_uas *fu = to_f_uas(f);
2322 kfree(fu);
2325 struct guas_setup_wq {
2326 struct work_struct work;
2327 struct f_uas *fu;
2328 unsigned int alt;
2331 static void usbg_delayed_set_alt(struct work_struct *wq)
2333 struct guas_setup_wq *work = container_of(wq, struct guas_setup_wq,
2334 work);
2335 struct f_uas *fu = work->fu;
2336 int alt = work->alt;
2338 kfree(work);
2340 if (fu->flags & USBG_IS_BOT)
2341 bot_cleanup_old_alt(fu);
2342 if (fu->flags & USBG_IS_UAS)
2343 uasp_cleanup_old_alt(fu);
2345 if (alt == USB_G_ALT_INT_BBB)
2346 bot_set_alt(fu);
2347 else if (alt == USB_G_ALT_INT_UAS)
2348 uasp_set_alt(fu);
2349 usb_composite_setup_continue(fu->function.config->cdev);
2352 static int usbg_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
2354 struct f_uas *fu = to_f_uas(f);
2356 if ((alt == USB_G_ALT_INT_BBB) || (alt == USB_G_ALT_INT_UAS)) {
2357 struct guas_setup_wq *work;
2359 work = kmalloc(sizeof(*work), GFP_ATOMIC);
2360 if (!work)
2361 return -ENOMEM;
2362 INIT_WORK(&work->work, usbg_delayed_set_alt);
2363 work->fu = fu;
2364 work->alt = alt;
2365 schedule_work(&work->work);
2366 return USB_GADGET_DELAYED_STATUS;
2368 return -EOPNOTSUPP;
2371 static void usbg_disable(struct usb_function *f)
2373 struct f_uas *fu = to_f_uas(f);
2375 if (fu->flags & USBG_IS_UAS)
2376 uasp_cleanup_old_alt(fu);
2377 else if (fu->flags & USBG_IS_BOT)
2378 bot_cleanup_old_alt(fu);
2379 fu->flags = 0;
2382 static int usbg_setup(struct usb_function *f,
2383 const struct usb_ctrlrequest *ctrl)
2385 struct f_uas *fu = to_f_uas(f);
2387 if (!(fu->flags & USBG_IS_BOT))
2388 return -EOPNOTSUPP;
2390 return usbg_bot_setup(f, ctrl);
2393 static int usbg_cfg_bind(struct usb_configuration *c)
2395 struct f_uas *fu;
2396 int ret;
2398 fu = kzalloc(sizeof(*fu), GFP_KERNEL);
2399 if (!fu)
2400 return -ENOMEM;
2401 fu->function.name = "Target Function";
2402 fu->function.descriptors = uasp_fs_function_desc;
2403 fu->function.hs_descriptors = uasp_hs_function_desc;
2404 fu->function.ss_descriptors = uasp_ss_function_desc;
2405 fu->function.bind = usbg_bind;
2406 fu->function.unbind = usbg_unbind;
2407 fu->function.set_alt = usbg_set_alt;
2408 fu->function.setup = usbg_setup;
2409 fu->function.disable = usbg_disable;
2410 fu->tpg = the_only_tpg_I_currently_have;
2412 ret = usb_add_function(c, &fu->function);
2413 if (ret)
2414 goto err;
2416 return 0;
2417 err:
2418 kfree(fu);
2419 return ret;
2422 static int usb_target_bind(struct usb_composite_dev *cdev)
2424 int ret;
2426 ret = usb_add_config(cdev, &usbg_config_driver,
2427 usbg_cfg_bind);
2428 return 0;
2431 static struct usb_composite_driver usbg_driver = {
2432 .name = "g_target",
2433 .dev = &usbg_device_desc,
2434 .strings = usbg_strings,
2435 .max_speed = USB_SPEED_SUPER,
2436 .unbind = guas_unbind,
2439 static int usbg_attach(struct usbg_tpg *tpg)
2441 return usb_composite_probe(&usbg_driver, usb_target_bind);
2444 static void usbg_detach(struct usbg_tpg *tpg)
2446 usb_composite_unregister(&usbg_driver);
2449 static int __init usb_target_gadget_init(void)
2451 int ret;
2453 ret = usbg_register_configfs();
2454 return ret;
2456 module_init(usb_target_gadget_init);
2458 static void __exit usb_target_gadget_exit(void)
2460 usbg_deregister_configfs();
2462 module_exit(usb_target_gadget_exit);
2464 MODULE_AUTHOR("Sebastian Andrzej Siewior <bigeasy@linutronix.de>");
2465 MODULE_DESCRIPTION("usb-gadget fabric");
2466 MODULE_LICENSE("GPL v2");