xref: /linux/drivers/usb/dwc3/trace.h (revision 6093a688a07da07808f0122f9aa2a3eed250d853)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * trace.h - DesignWare USB3 DRD Controller Trace Support
4  *
5  * Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com
6  *
7  * Author: Felipe Balbi <balbi@ti.com>
8  */
9 
10 #undef TRACE_SYSTEM
11 #define TRACE_SYSTEM dwc3
12 
13 #if !defined(__DWC3_TRACE_H) || defined(TRACE_HEADER_MULTI_READ)
14 #define __DWC3_TRACE_H
15 
16 #include <linux/types.h>
17 #include <linux/tracepoint.h>
18 #include <asm/byteorder.h>
19 #include "core.h"
20 #include "debug.h"
21 
22 DECLARE_EVENT_CLASS(dwc3_log_set_prtcap,
23 	TP_PROTO(u32 mode),
24 	TP_ARGS(mode),
25 	TP_STRUCT__entry(
26 		__field(u32, mode)
27 	),
28 	TP_fast_assign(
29 		__entry->mode = mode;
30 	),
31 	TP_printk("mode %s", dwc3_mode_string(__entry->mode))
32 );
33 
34 DEFINE_EVENT(dwc3_log_set_prtcap, dwc3_set_prtcap,
35 	TP_PROTO(u32 mode),
36 	TP_ARGS(mode)
37 );
38 
39 DECLARE_EVENT_CLASS(dwc3_log_io,
40 	TP_PROTO(void *base, u32 offset, u32 value),
41 	TP_ARGS(base, offset, value),
42 	TP_STRUCT__entry(
43 		__field(void *, base)
44 		__field(u32, offset)
45 		__field(u32, value)
46 	),
47 	TP_fast_assign(
48 		__entry->base = base;
49 		__entry->offset = offset;
50 		__entry->value = value;
51 	),
52 	TP_printk("addr %p offset %04x value %08x",
53 		__entry->base + __entry->offset,
54 		__entry->offset,
55 		__entry->value)
56 );
57 
58 DEFINE_EVENT(dwc3_log_io, dwc3_readl,
59 	TP_PROTO(void __iomem *base, u32 offset, u32 value),
60 	TP_ARGS(base, offset, value)
61 );
62 
63 DEFINE_EVENT(dwc3_log_io, dwc3_writel,
64 	TP_PROTO(void __iomem *base, u32 offset, u32 value),
65 	TP_ARGS(base, offset, value)
66 );
67 
68 DECLARE_EVENT_CLASS(dwc3_log_event,
69 	TP_PROTO(u32 event, struct dwc3 *dwc),
70 	TP_ARGS(event, dwc),
71 	TP_STRUCT__entry(
72 		__field(u32, event)
73 		__field(u32, ep0state)
74 	),
75 	TP_fast_assign(
76 		__entry->event = event;
77 		__entry->ep0state = dwc->ep0state;
78 	),
79 	TP_printk("event (%08x): %s", __entry->event,
80 			dwc3_decode_event(__get_buf(DWC3_MSG_MAX), DWC3_MSG_MAX,
81 					__entry->event, __entry->ep0state))
82 );
83 
84 DEFINE_EVENT(dwc3_log_event, dwc3_event,
85 	TP_PROTO(u32 event, struct dwc3 *dwc),
86 	TP_ARGS(event, dwc)
87 );
88 
89 DECLARE_EVENT_CLASS(dwc3_log_ctrl,
90 	TP_PROTO(struct usb_ctrlrequest *ctrl),
91 	TP_ARGS(ctrl),
92 	TP_STRUCT__entry(
93 		__field(__u8, bRequestType)
94 		__field(__u8, bRequest)
95 		__field(__u16, wValue)
96 		__field(__u16, wIndex)
97 		__field(__u16, wLength)
98 	),
99 	TP_fast_assign(
100 		__entry->bRequestType = ctrl->bRequestType;
101 		__entry->bRequest = ctrl->bRequest;
102 		__entry->wValue = le16_to_cpu(ctrl->wValue);
103 		__entry->wIndex = le16_to_cpu(ctrl->wIndex);
104 		__entry->wLength = le16_to_cpu(ctrl->wLength);
105 	),
106 	TP_printk("%s", usb_decode_ctrl(__get_buf(DWC3_MSG_MAX), DWC3_MSG_MAX,
107 					__entry->bRequestType,
108 					__entry->bRequest, __entry->wValue,
109 					__entry->wIndex, __entry->wLength)
110 	)
111 );
112 
113 DEFINE_EVENT(dwc3_log_ctrl, dwc3_ctrl_req,
114 	TP_PROTO(struct usb_ctrlrequest *ctrl),
115 	TP_ARGS(ctrl)
116 );
117 
118 DECLARE_EVENT_CLASS(dwc3_log_request,
119 	TP_PROTO(struct dwc3_request *req),
120 	TP_ARGS(req),
121 	TP_STRUCT__entry(
122 		__string(name, req->dep->name)
123 		__field(struct dwc3_request *, req)
124 		__field(unsigned int, actual)
125 		__field(unsigned int, length)
126 		__field(int, status)
127 		__field(int, zero)
128 		__field(int, short_not_ok)
129 		__field(int, no_interrupt)
130 	),
131 	TP_fast_assign(
132 		__assign_str(name);
133 		__entry->req = req;
134 		__entry->actual = req->request.actual;
135 		__entry->length = req->request.length;
136 		__entry->status = req->request.status;
137 		__entry->zero = req->request.zero;
138 		__entry->short_not_ok = req->request.short_not_ok;
139 		__entry->no_interrupt = req->request.no_interrupt;
140 	),
141 	TP_printk("%s: req %p length %u/%u %s%s%s ==> %d",
142 		__get_str(name), __entry->req, __entry->actual, __entry->length,
143 		__entry->zero ? "Z" : "z",
144 		__entry->short_not_ok ? "S" : "s",
145 		__entry->no_interrupt ? "i" : "I",
146 		__entry->status
147 	)
148 );
149 
150 DEFINE_EVENT(dwc3_log_request, dwc3_alloc_request,
151 	TP_PROTO(struct dwc3_request *req),
152 	TP_ARGS(req)
153 );
154 
155 DEFINE_EVENT(dwc3_log_request, dwc3_free_request,
156 	TP_PROTO(struct dwc3_request *req),
157 	TP_ARGS(req)
158 );
159 
160 DEFINE_EVENT(dwc3_log_request, dwc3_ep_queue,
161 	TP_PROTO(struct dwc3_request *req),
162 	TP_ARGS(req)
163 );
164 
165 DEFINE_EVENT(dwc3_log_request, dwc3_ep_dequeue,
166 	TP_PROTO(struct dwc3_request *req),
167 	TP_ARGS(req)
168 );
169 
170 DEFINE_EVENT(dwc3_log_request, dwc3_gadget_giveback,
171 	TP_PROTO(struct dwc3_request *req),
172 	TP_ARGS(req)
173 );
174 
175 DECLARE_EVENT_CLASS(dwc3_log_generic_cmd,
176 	TP_PROTO(unsigned int cmd, u32 param, int status),
177 	TP_ARGS(cmd, param, status),
178 	TP_STRUCT__entry(
179 		__field(unsigned int, cmd)
180 		__field(u32, param)
181 		__field(int, status)
182 	),
183 	TP_fast_assign(
184 		__entry->cmd = cmd;
185 		__entry->param = param;
186 		__entry->status = status;
187 	),
188 	TP_printk("cmd '%s' [%x] param %08x --> status: %s",
189 		dwc3_gadget_generic_cmd_string(__entry->cmd),
190 		__entry->cmd, __entry->param,
191 		dwc3_gadget_generic_cmd_status_string(__entry->status)
192 	)
193 );
194 
195 DEFINE_EVENT(dwc3_log_generic_cmd, dwc3_gadget_generic_cmd,
196 	TP_PROTO(unsigned int cmd, u32 param, int status),
197 	TP_ARGS(cmd, param, status)
198 );
199 
200 DECLARE_EVENT_CLASS(dwc3_log_gadget_ep_cmd,
201 	TP_PROTO(struct dwc3_ep *dep, unsigned int cmd,
202 		struct dwc3_gadget_ep_cmd_params *params, int cmd_status),
203 	TP_ARGS(dep, cmd, params, cmd_status),
204 	TP_STRUCT__entry(
205 		__string(name, dep->name)
206 		__field(unsigned int, cmd)
207 		__field(u32, param0)
208 		__field(u32, param1)
209 		__field(u32, param2)
210 		__field(int, cmd_status)
211 	),
212 	TP_fast_assign(
213 		__assign_str(name);
214 		__entry->cmd = cmd;
215 		__entry->param0 = params->param0;
216 		__entry->param1 = params->param1;
217 		__entry->param2 = params->param2;
218 		__entry->cmd_status = cmd_status;
219 	),
220 	TP_printk("%s: cmd '%s' [%x] params %08x %08x %08x --> status: %s",
221 		__get_str(name), dwc3_gadget_ep_cmd_string(__entry->cmd),
222 		__entry->cmd, __entry->param0,
223 		__entry->param1, __entry->param2,
224 		dwc3_ep_cmd_status_string(__entry->cmd_status)
225 	)
226 );
227 
228 DEFINE_EVENT(dwc3_log_gadget_ep_cmd, dwc3_gadget_ep_cmd,
229 	TP_PROTO(struct dwc3_ep *dep, unsigned int cmd,
230 		struct dwc3_gadget_ep_cmd_params *params, int cmd_status),
231 	TP_ARGS(dep, cmd, params, cmd_status)
232 );
233 
234 DECLARE_EVENT_CLASS(dwc3_log_trb,
235 	TP_PROTO(struct dwc3_ep *dep, struct dwc3_trb *trb),
236 	TP_ARGS(dep, trb),
237 	TP_STRUCT__entry(
238 		__string(name, dep->name)
239 		__field(struct dwc3_trb *, trb)
240 		__field(u32, bpl)
241 		__field(u32, bph)
242 		__field(u32, size)
243 		__field(u32, ctrl)
244 		__field(u32, type)
245 		__field(u32, enqueue)
246 		__field(u32, dequeue)
247 	),
248 	TP_fast_assign(
249 		__assign_str(name);
250 		__entry->trb = trb;
251 		__entry->bpl = trb->bpl;
252 		__entry->bph = trb->bph;
253 		__entry->size = trb->size;
254 		__entry->ctrl = trb->ctrl;
255 		__entry->type = usb_endpoint_type(dep->endpoint.desc);
256 		__entry->enqueue = dep->trb_enqueue;
257 		__entry->dequeue = dep->trb_dequeue;
258 	),
259 	TP_printk("%s: trb %p (E%d:D%d) buf %08x%08x size %s%d ctrl %08x sofn %08x (%c%c%c%c:%c%c:%s)",
260 		__get_str(name), __entry->trb, __entry->enqueue,
261 		__entry->dequeue, __entry->bph, __entry->bpl,
262 		({char *s;
263 		int pcm = ((__entry->size >> 24) & 3) + 1;
264 
265 		switch (__entry->type) {
266 		case USB_ENDPOINT_XFER_INT:
267 		case USB_ENDPOINT_XFER_ISOC:
268 			switch (pcm) {
269 			case 1:
270 				s = "1x ";
271 				break;
272 			case 2:
273 				s = "2x ";
274 				break;
275 			case 3:
276 			default:
277 				s = "3x ";
278 				break;
279 			}
280 			break;
281 		default:
282 			s = "";
283 		} s; }),
284 		DWC3_TRB_SIZE_LENGTH(__entry->size), __entry->ctrl,
285 		DWC3_TRB_CTRL_GET_SID_SOFN(__entry->ctrl),
286 		__entry->ctrl & DWC3_TRB_CTRL_HWO ? 'H' : 'h',
287 		__entry->ctrl & DWC3_TRB_CTRL_LST ? 'L' : 'l',
288 		__entry->ctrl & DWC3_TRB_CTRL_CHN ? 'C' : 'c',
289 		__entry->ctrl & DWC3_TRB_CTRL_CSP ? 'S' : 's',
290 		__entry->ctrl & DWC3_TRB_CTRL_ISP_IMI ? 'S' : 's',
291 		__entry->ctrl & DWC3_TRB_CTRL_IOC ? 'C' : 'c',
292 		  dwc3_trb_type_string(DWC3_TRBCTL_TYPE(__entry->ctrl))
293 	)
294 );
295 
296 DEFINE_EVENT(dwc3_log_trb, dwc3_prepare_trb,
297 	TP_PROTO(struct dwc3_ep *dep, struct dwc3_trb *trb),
298 	TP_ARGS(dep, trb)
299 );
300 
301 DEFINE_EVENT(dwc3_log_trb, dwc3_complete_trb,
302 	TP_PROTO(struct dwc3_ep *dep, struct dwc3_trb *trb),
303 	TP_ARGS(dep, trb)
304 );
305 
306 DECLARE_EVENT_CLASS(dwc3_log_ep,
307 	TP_PROTO(struct dwc3_ep *dep),
308 	TP_ARGS(dep),
309 	TP_STRUCT__entry(
310 		__string(name, dep->name)
311 		__field(unsigned int, maxpacket)
312 		__field(unsigned int, maxpacket_limit)
313 		__field(unsigned int, max_streams)
314 		__field(unsigned int, maxburst)
315 		__field(unsigned int, flags)
316 		__field(unsigned int, direction)
317 		__field(u8, trb_enqueue)
318 		__field(u8, trb_dequeue)
319 	),
320 	TP_fast_assign(
321 		__assign_str(name);
322 		__entry->maxpacket = dep->endpoint.maxpacket;
323 		__entry->maxpacket_limit = dep->endpoint.maxpacket_limit;
324 		__entry->max_streams = dep->endpoint.max_streams;
325 		__entry->maxburst = dep->endpoint.maxburst;
326 		__entry->flags = dep->flags;
327 		__entry->direction = dep->direction;
328 		__entry->trb_enqueue = dep->trb_enqueue;
329 		__entry->trb_dequeue = dep->trb_dequeue;
330 	),
331 	TP_printk("%s: mps %d/%d streams %d burst %d ring %d/%d flags %c:%c%c%c%c:%c",
332 		__get_str(name), __entry->maxpacket,
333 		__entry->maxpacket_limit, __entry->max_streams,
334 		__entry->maxburst, __entry->trb_enqueue,
335 		__entry->trb_dequeue,
336 		__entry->flags & DWC3_EP_ENABLED ? 'E' : 'e',
337 		__entry->flags & DWC3_EP_STALL ? 'S' : 's',
338 		__entry->flags & DWC3_EP_WEDGE ? 'W' : 'w',
339 		__entry->flags & DWC3_EP_TRANSFER_STARTED ? 'B' : 'b',
340 		__entry->flags & DWC3_EP_PENDING_REQUEST ? 'P' : 'p',
341 		__entry->direction ? '<' : '>'
342 	)
343 );
344 
345 DEFINE_EVENT(dwc3_log_ep, dwc3_gadget_ep_enable,
346 	TP_PROTO(struct dwc3_ep *dep),
347 	TP_ARGS(dep)
348 );
349 
350 DEFINE_EVENT(dwc3_log_ep, dwc3_gadget_ep_disable,
351 	TP_PROTO(struct dwc3_ep *dep),
352 	TP_ARGS(dep)
353 );
354 
355 #endif /* __DWC3_TRACE_H */
356 
357 /* this part has to be here */
358 
359 #undef TRACE_INCLUDE_PATH
360 #define TRACE_INCLUDE_PATH .
361 
362 #undef TRACE_INCLUDE_FILE
363 #define TRACE_INCLUDE_FILE trace
364 
365 #include <trace/define_trace.h>
366