Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2c4cbe6e authored by Felipe Balbi's avatar Felipe Balbi
Browse files

usb: dwc3: add tracepoints to aid debugging 



When we're debugging hard-to-reproduce and time-sensitive
use cases, printk() poses too much overhead. That's when
the kernel's tracing infrastructure comes into play.

This patch implements a few initial tracepoints for the
dwc3 driver. More traces can be added as necessary in order
to ease the task of debugging dwc3.

Reviewed-by: default avatarPaul Zimmerman <paulz@synopsys.com>
Signed-off-by: default avatarFelipe Balbi <balbi@ti.com>
parent 3ece0ec4

drivers/usb/dwc3/Makefile

+4 −1
Original line number Diff line number Diff line 
# define_trace.h needs to know how to find our header

CFLAGS_trace.o				:= -I$(src)



ccflags-$(CONFIG_USB_DWC3_DEBUG)	:= -DDEBUG

ccflags-$(CONFIG_USB_DWC3_VERBOSE)	+= -DVERBOSE_DEBUG



obj-$(CONFIG_USB_DWC3)			+= dwc3.o



dwc3-y					:= core.o

dwc3-y					:= core.o debug.o trace.o



ifneq ($(filter y,$(CONFIG_USB_DWC3_HOST) $(CONFIG_USB_DWC3_DUAL_ROLE)),)

	dwc3-y				+= host.o

drivers/usb/dwc3/core.h

+2 −0
Original line number Diff line number Diff line
@@ -33,6 +33,8 @@ 


#include <linux/phy/phy.h>



#define DWC3_MSG_MAX	500



/* Global constants */

#define DWC3_EP0_BOUNCE_SIZE	512

#define DWC3_ENDPOINTS_NUM	32

drivers/usb/dwc3/debug.c

0 → 100644
+32 −0
Original line number Diff line number Diff line 
/**

 * debug.c - DesignWare USB3 DRD Controller Debug/Trace Support

 *

 * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com

 *

 * Author: Felipe Balbi <balbi@ti.com>

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2  of

 * the License as published by the Free Software Foundation.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 */



#include "debug.h"



void dwc3_trace(void (*trace)(struct va_format *), const char *fmt, ...)

{

	struct va_format vaf;

	va_list args;



	va_start(args, fmt);

	vaf.fmt = fmt;

	vaf.va = &args;



	trace(&vaf);



	va_end(args);

}

drivers/usb/dwc3/debug.h

+2 −0
Original line number Diff line number Diff line
@@ -214,6 +214,8 @@ static inline const char *dwc3_gadget_event_type_string(u8 event) 
	}

}



void dwc3_trace(void (*trace)(struct va_format *), const char *fmt, ...);



#ifdef CONFIG_DEBUG_FS

extern int dwc3_debugfs_init(struct dwc3 *);

extern void dwc3_debugfs_exit(struct dwc3 *);

drivers/usb/dwc3/ep0.c

+36 −28
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ static int dwc3_ep0_start_trans(struct dwc3 *dwc, u8 epnum, dma_addr_t buf_dma, 


	dep = dwc->eps[epnum];

	if (dep->flags & DWC3_EP_BUSY) {

		dev_vdbg(dwc->dev, "%s: still busy\n", dep->name);

		dwc3_trace(trace_dwc3_ep0, "%s still busy", dep->name);

		return 0;

	}
@@ -89,7 +89,8 @@ static int dwc3_ep0_start_trans(struct dwc3 *dwc, u8 epnum, dma_addr_t buf_dma, 
	ret = dwc3_send_gadget_ep_cmd(dwc, dep->number,

			DWC3_DEPCMD_STARTTRANSFER, &params);

	if (ret < 0) {

		dev_dbg(dwc->dev, "failed to send STARTTRANSFER command\n");

		dwc3_trace(trace_dwc3_ep0, "%s STARTTRANSFER failed",

				dep->name);

		return ret;

	}
@@ -154,7 +155,8 @@ static int __dwc3_gadget_ep0_queue(struct dwc3_ep *dep, 
		if (dwc->ep0state == EP0_STATUS_PHASE)

			__dwc3_ep0_do_control_status(dwc, dwc->eps[direction]);

		else

			dev_dbg(dwc->dev, "too early for delayed status\n");

			dwc3_trace(trace_dwc3_ep0,

					"too early for delayed status");



		return 0;

	}
@@ -218,7 +220,8 @@ int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request, 


	spin_lock_irqsave(&dwc->lock, flags);

	if (!dep->endpoint.desc) {

		dev_dbg(dwc->dev, "trying to queue request %p to disabled %s\n",

		dwc3_trace(trace_dwc3_ep0,

				"trying to queue request %p to disabled %s",

				request, dep->name);

		ret = -ESHUTDOWN;

		goto out;
@@ -230,7 +233,8 @@ int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request, 
		goto out;

	}



	dev_vdbg(dwc->dev, "queueing request %p to %s length %d, state '%s'\n",

	dwc3_trace(trace_dwc3_ep0,

			"queueing request %p to %s length %d state '%s'",

			request, dep->name, request->length,

			dwc3_ep0_state_string(dwc->ep0state));
@@ -486,12 +490,13 @@ static int dwc3_ep0_set_address(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl) 


	addr = le16_to_cpu(ctrl->wValue);

	if (addr > 127) {

		dev_dbg(dwc->dev, "invalid device address %d\n", addr);

		dwc3_trace(trace_dwc3_ep0, "invalid device address %d", addr);

		return -EINVAL;

	}



	if (state == USB_STATE_CONFIGURED) {

		dev_dbg(dwc->dev, "trying to set address when configured\n");

		dwc3_trace(trace_dwc3_ep0,

				"trying to set address when configured");

		return -EINVAL;

	}
@@ -557,7 +562,7 @@ static int dwc3_ep0_set_config(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl) 
			dwc3_writel(dwc->regs, DWC3_DCTL, reg);



			dwc->resize_fifos = true;

			dev_dbg(dwc->dev, "resize fifos flag SET\n");

			dwc3_trace(trace_dwc3_ep0, "resize FIFOs flag SET");

		}

		break;
@@ -681,35 +686,35 @@ static int dwc3_ep0_std_request(struct dwc3 *dwc, struct usb_ctrlrequest *ctrl) 


	switch (ctrl->bRequest) {

	case USB_REQ_GET_STATUS:

		dev_vdbg(dwc->dev, "USB_REQ_GET_STATUS\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_GET_STATUS\n");

		ret = dwc3_ep0_handle_status(dwc, ctrl);

		break;

	case USB_REQ_CLEAR_FEATURE:

		dev_vdbg(dwc->dev, "USB_REQ_CLEAR_FEATURE\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_CLEAR_FEATURE\n");

		ret = dwc3_ep0_handle_feature(dwc, ctrl, 0);

		break;

	case USB_REQ_SET_FEATURE:

		dev_vdbg(dwc->dev, "USB_REQ_SET_FEATURE\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_SET_FEATURE\n");

		ret = dwc3_ep0_handle_feature(dwc, ctrl, 1);

		break;

	case USB_REQ_SET_ADDRESS:

		dev_vdbg(dwc->dev, "USB_REQ_SET_ADDRESS\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_SET_ADDRESS\n");

		ret = dwc3_ep0_set_address(dwc, ctrl);

		break;

	case USB_REQ_SET_CONFIGURATION:

		dev_vdbg(dwc->dev, "USB_REQ_SET_CONFIGURATION\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_SET_CONFIGURATION\n");

		ret = dwc3_ep0_set_config(dwc, ctrl);

		break;

	case USB_REQ_SET_SEL:

		dev_vdbg(dwc->dev, "USB_REQ_SET_SEL\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_SET_SEL\n");

		ret = dwc3_ep0_set_sel(dwc, ctrl);

		break;

	case USB_REQ_SET_ISOCH_DELAY:

		dev_vdbg(dwc->dev, "USB_REQ_SET_ISOCH_DELAY\n");

		dwc3_trace(trace_dwc3_ep0, "USB_REQ_SET_ISOCH_DELAY\n");

		ret = dwc3_ep0_set_isoch_delay(dwc, ctrl);

		break;

	default:

		dev_vdbg(dwc->dev, "Forwarding to gadget driver\n");

		dwc3_trace(trace_dwc3_ep0, "Forwarding to gadget driver\n");

		ret = dwc3_ep0_delegate_req(dwc, ctrl);

		break;

	}
@@ -727,6 +732,8 @@ static void dwc3_ep0_inspect_setup(struct dwc3 *dwc, 
	if (!dwc->gadget_driver)

		goto out;



	trace_dwc3_ctrl_req(ctrl);



	len = le16_to_cpu(ctrl->wLength);

	if (!len) {

		dwc->three_stage_setup = false;
@@ -775,7 +782,7 @@ static void dwc3_ep0_complete_data(struct dwc3 *dwc, 


	status = DWC3_TRB_SIZE_TRBSTS(trb->size);

	if (status == DWC3_TRBSTS_SETUP_PENDING) {

		dev_dbg(dwc->dev, "Setup Pending received\n");

		dwc3_trace(trace_dwc3_ep0, "Setup Pending received");



		if (r)

			dwc3_gadget_giveback(ep0, r, -ECONNRESET);
@@ -835,7 +842,7 @@ static void dwc3_ep0_complete_status(struct dwc3 *dwc, 


		ret = dwc3_gadget_set_test_mode(dwc, dwc->test_mode_nr);

		if (ret < 0) {

			dev_dbg(dwc->dev, "Invalid Test #%d\n",

			dwc3_trace(trace_dwc3_ep0, "Invalid Test #%d",

					dwc->test_mode_nr);

			dwc3_ep0_stall_and_restart(dwc);

			return;
@@ -844,7 +851,7 @@ static void dwc3_ep0_complete_status(struct dwc3 *dwc, 


	status = DWC3_TRB_SIZE_TRBSTS(trb->size);

	if (status == DWC3_TRBSTS_SETUP_PENDING)

		dev_dbg(dwc->dev, "Setup Pending received\n");

		dwc3_trace(trace_dwc3_ep0, "Setup Pending received\n");



	dwc->ep0state = EP0_SETUP_PHASE;

	dwc3_ep0_out_start(dwc);
@@ -861,17 +868,17 @@ static void dwc3_ep0_xfer_complete(struct dwc3 *dwc, 


	switch (dwc->ep0state) {

	case EP0_SETUP_PHASE:

		dev_vdbg(dwc->dev, "Inspecting Setup Bytes\n");

		dwc3_trace(trace_dwc3_ep0, "Setup Phase");

		dwc3_ep0_inspect_setup(dwc, event);

		break;



	case EP0_DATA_PHASE:

		dev_vdbg(dwc->dev, "Data Phase\n");

		dwc3_trace(trace_dwc3_ep0, "Data Phase");

		dwc3_ep0_complete_data(dwc, event);

		break;



	case EP0_STATUS_PHASE:

		dev_vdbg(dwc->dev, "Status Phase\n");

		dwc3_trace(trace_dwc3_ep0, "Status Phase");

		dwc3_ep0_complete_status(dwc, event);

		break;

	default:
@@ -947,7 +954,7 @@ static int dwc3_ep0_start_control_status(struct dwc3_ep *dep) 
static void __dwc3_ep0_do_control_status(struct dwc3 *dwc, struct dwc3_ep *dep)

{

	if (dwc->resize_fifos) {

		dev_dbg(dwc->dev, "starting to resize fifos\n");

		dwc3_trace(trace_dwc3_ep0, "Resizing FIFOs");

		dwc3_gadget_resize_tx_fifos(dwc);

		dwc->resize_fifos = 0;

	}
@@ -988,7 +995,7 @@ static void dwc3_ep0_xfernotready(struct dwc3 *dwc, 


	switch (event->status) {

	case DEPEVT_STATUS_CONTROL_DATA:

		dev_vdbg(dwc->dev, "Control Data\n");

		dwc3_trace(trace_dwc3_ep0, "Control Data");



		/*

		 * We already have a DATA transfer in the controller's cache,
@@ -1002,7 +1009,8 @@ static void dwc3_ep0_xfernotready(struct dwc3 *dwc, 
		if (dwc->ep0_expect_in != event->endpoint_number) {

			struct dwc3_ep	*dep = dwc->eps[dwc->ep0_expect_in];



			dev_vdbg(dwc->dev, "Wrong direction for Data phase\n");

			dwc3_trace(trace_dwc3_ep0,

					"Wrong direction for Data phase");

			dwc3_ep0_end_control_data(dwc, dep);

			dwc3_ep0_stall_and_restart(dwc);

			return;
@@ -1014,13 +1022,13 @@ static void dwc3_ep0_xfernotready(struct dwc3 *dwc, 
		if (dwc->ep0_next_event != DWC3_EP0_NRDY_STATUS)

			return;



		dev_vdbg(dwc->dev, "Control Status\n");

		dwc3_trace(trace_dwc3_ep0, "Control Status");



		dwc->ep0state = EP0_STATUS_PHASE;



		if (dwc->delayed_status) {

			WARN_ON_ONCE(event->endpoint_number != 1);

			dev_vdbg(dwc->dev, "Mass Storage delayed status\n");

			dwc3_trace(trace_dwc3_ep0, "Delayed Status");

			return;

		}
@@ -1033,7 +1041,7 @@ void dwc3_ep0_interrupt(struct dwc3 *dwc, 
{

	u8			epnum = event->endpoint_number;



	dev_dbg(dwc->dev, "%s while ep%d%s in state '%s'\n",

	dwc3_trace(trace_dwc3_ep0, "%s while ep%d%s in state '%s'",

			dwc3_ep_event_string(event->endpoint_event),

			epnum >> 1, (epnum & 1) ? "in" : "out",

			dwc3_ep0_state_string(dwc->ep0state));