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