1 // SPDX-License-Identifier: GPL-2.0
3 * debug.h - DesignWare USB3 DRD Controller Debug Header
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
11 #ifndef __DWC3_DEBUG_H
12 #define __DWC3_DEBUG_H
17 * dwc3_gadget_ep_cmd_string - returns endpoint command string
20 static inline const char *
21 dwc3_gadget_ep_cmd_string(u8 cmd)
24 case DWC3_DEPCMD_DEPSTARTCFG:
25 return "Start New Configuration";
26 case DWC3_DEPCMD_ENDTRANSFER:
27 return "End Transfer";
28 case DWC3_DEPCMD_UPDATETRANSFER:
29 return "Update Transfer";
30 case DWC3_DEPCMD_STARTTRANSFER:
31 return "Start Transfer";
32 case DWC3_DEPCMD_CLEARSTALL:
34 case DWC3_DEPCMD_SETSTALL:
36 case DWC3_DEPCMD_GETEPSTATE:
37 return "Get Endpoint State";
38 case DWC3_DEPCMD_SETTRANSFRESOURCE:
39 return "Set Endpoint Transfer Resource";
40 case DWC3_DEPCMD_SETEPCONFIG:
41 return "Set Endpoint Configuration";
43 return "UNKNOWN command";
48 * dwc3_gadget_generic_cmd_string - returns generic command string
51 static inline const char *
52 dwc3_gadget_generic_cmd_string(u8 cmd)
55 case DWC3_DGCMD_SET_LMP:
57 case DWC3_DGCMD_SET_PERIODIC_PAR:
58 return "Set Periodic Parameters";
59 case DWC3_DGCMD_XMIT_FUNCTION:
60 return "Transmit Function Wake Device Notification";
61 case DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO:
62 return "Set Scratchpad Buffer Array Address Lo";
63 case DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI:
64 return "Set Scratchpad Buffer Array Address Hi";
65 case DWC3_DGCMD_SELECTED_FIFO_FLUSH:
66 return "Selected FIFO Flush";
67 case DWC3_DGCMD_ALL_FIFO_FLUSH:
68 return "All FIFO Flush";
69 case DWC3_DGCMD_SET_ENDPOINT_NRDY:
70 return "Set Endpoint NRDY";
71 case DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK:
72 return "Run SoC Bus Loopback Test";
79 * dwc3_gadget_link_string - returns link name
80 * @link_state: link state code
82 static inline const char *
83 dwc3_gadget_link_string(enum dwc3_link_state link_state)
86 case DWC3_LINK_STATE_U0:
88 case DWC3_LINK_STATE_U1:
90 case DWC3_LINK_STATE_U2:
92 case DWC3_LINK_STATE_U3:
94 case DWC3_LINK_STATE_SS_DIS:
96 case DWC3_LINK_STATE_RX_DET:
98 case DWC3_LINK_STATE_SS_INACT:
100 case DWC3_LINK_STATE_POLL:
102 case DWC3_LINK_STATE_RECOV:
104 case DWC3_LINK_STATE_HRESET:
106 case DWC3_LINK_STATE_CMPLY:
108 case DWC3_LINK_STATE_LPBK:
110 case DWC3_LINK_STATE_RESET:
112 case DWC3_LINK_STATE_RESUME:
115 return "UNKNOWN link state\n";
120 * dwc3_trb_type_string - returns TRB type as a string
121 * @type: the type of the TRB
123 static inline const char *dwc3_trb_type_string(unsigned int type)
126 case DWC3_TRBCTL_NORMAL:
128 case DWC3_TRBCTL_CONTROL_SETUP:
130 case DWC3_TRBCTL_CONTROL_STATUS2:
132 case DWC3_TRBCTL_CONTROL_STATUS3:
134 case DWC3_TRBCTL_CONTROL_DATA:
136 case DWC3_TRBCTL_ISOCHRONOUS_FIRST:
138 case DWC3_TRBCTL_ISOCHRONOUS:
140 case DWC3_TRBCTL_LINK_TRB:
147 static inline const char *dwc3_ep0_state_string(enum dwc3_ep0_state state)
150 case EP0_UNCONNECTED:
151 return "Unconnected";
152 case EP0_SETUP_PHASE:
153 return "Setup Phase";
156 case EP0_STATUS_PHASE:
157 return "Status Phase";
164 * dwc3_gadget_event_string - returns event name
165 * @event: the event code
167 static inline const char *
168 dwc3_gadget_event_string(char *str, const struct dwc3_event_devt *event)
170 enum dwc3_link_state state = event->event_info & DWC3_LINK_STATE_MASK;
172 switch (event->type) {
173 case DWC3_DEVICE_EVENT_DISCONNECT:
174 sprintf(str, "Disconnect: [%s]",
175 dwc3_gadget_link_string(state));
177 case DWC3_DEVICE_EVENT_RESET:
178 sprintf(str, "Reset [%s]", dwc3_gadget_link_string(state));
180 case DWC3_DEVICE_EVENT_CONNECT_DONE:
181 sprintf(str, "Connection Done [%s]",
182 dwc3_gadget_link_string(state));
184 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
185 sprintf(str, "Link Change [%s]",
186 dwc3_gadget_link_string(state));
188 case DWC3_DEVICE_EVENT_WAKEUP:
189 sprintf(str, "WakeUp [%s]", dwc3_gadget_link_string(state));
191 case DWC3_DEVICE_EVENT_EOPF:
192 sprintf(str, "End-Of-Frame [%s]",
193 dwc3_gadget_link_string(state));
195 case DWC3_DEVICE_EVENT_SOF:
196 sprintf(str, "Start-Of-Frame [%s]",
197 dwc3_gadget_link_string(state));
199 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
200 sprintf(str, "Erratic Error [%s]",
201 dwc3_gadget_link_string(state));
203 case DWC3_DEVICE_EVENT_CMD_CMPL:
204 sprintf(str, "Command Complete [%s]",
205 dwc3_gadget_link_string(state));
207 case DWC3_DEVICE_EVENT_OVERFLOW:
208 sprintf(str, "Overflow [%s]", dwc3_gadget_link_string(state));
211 sprintf(str, "UNKNOWN");
217 static inline void dwc3_decode_get_status(__u8 t, __u16 i, __u16 l, char *str)
219 switch (t & USB_RECIP_MASK) {
220 case USB_RECIP_INTERFACE:
221 sprintf(str, "Get Interface Status(Intf = %d, Length = %d)",
224 case USB_RECIP_ENDPOINT:
225 sprintf(str, "Get Endpoint Status(ep%d%s)",
227 i & USB_DIR_IN ? "in" : "out");
232 static inline void dwc3_decode_set_clear_feature(__u8 t, __u8 b, __u16 v,
235 switch (t & USB_RECIP_MASK) {
236 case USB_RECIP_DEVICE:
237 sprintf(str, "%s Device Feature(%s%s)",
238 b == USB_REQ_CLEAR_FEATURE ? "Clear" : "Set",
241 case USB_DEVICE_SELF_POWERED:
244 case USB_DEVICE_REMOTE_WAKEUP:
247 case USB_DEVICE_TEST_MODE:
250 case USB_DEVICE_U1_ENABLE:
253 case USB_DEVICE_U2_ENABLE:
256 case USB_DEVICE_LTM_ENABLE:
262 v == USB_DEVICE_TEST_MODE ?
272 s = ": TEST_SE0_NAK";
278 s = ": TEST_FORCE_EN";
284 case USB_RECIP_INTERFACE:
285 sprintf(str, "%s Interface Feature(%s)",
286 b == USB_REQ_CLEAR_FEATURE ? "Clear" : "Set",
287 v == USB_INTRF_FUNC_SUSPEND ?
288 "Function Suspend" : "UNKNOWN");
290 case USB_RECIP_ENDPOINT:
291 sprintf(str, "%s Endpoint Feature(%s ep%d%s)",
292 b == USB_REQ_CLEAR_FEATURE ? "Clear" : "Set",
293 v == USB_ENDPOINT_HALT ? "Halt" : "UNKNOWN",
295 i & USB_DIR_IN ? "in" : "out");
300 static inline void dwc3_decode_set_address(__u16 v, char *str)
302 sprintf(str, "Set Address(Addr = %02x)", v);
305 static inline void dwc3_decode_get_set_descriptor(__u8 t, __u8 b, __u16 v,
306 __u16 i, __u16 l, char *str)
308 sprintf(str, "%s %s Descriptor(Index = %d, Length = %d)",
309 b == USB_REQ_GET_DESCRIPTOR ? "Get" : "Set",
321 case USB_DT_INTERFACE:
324 case USB_DT_ENDPOINT:
327 case USB_DT_DEVICE_QUALIFIER:
328 s = "Device Qualifier";
330 case USB_DT_OTHER_SPEED_CONFIG:
331 s = "Other Speed Config";
333 case USB_DT_INTERFACE_POWER:
334 s = "Interface Power";
342 case USB_DT_INTERFACE_ASSOCIATION:
343 s = "Interface Association";
348 case USB_DT_DEVICE_CAPABILITY:
349 s = "Device Capability";
351 case USB_DT_PIPE_USAGE:
354 case USB_DT_SS_ENDPOINT_COMP:
355 s = "SS Endpoint Companion";
357 case USB_DT_SSP_ISOC_ENDPOINT_COMP:
358 s = "SSP Isochronous Endpoint Companion";
363 } s; }), v & 0xff, l);
367 static inline void dwc3_decode_get_configuration(__u16 l, char *str)
369 sprintf(str, "Get Configuration(Length = %d)", l);
372 static inline void dwc3_decode_set_configuration(__u8 v, char *str)
374 sprintf(str, "Set Configuration(Config = %d)", v);
377 static inline void dwc3_decode_get_intf(__u16 i, __u16 l, char *str)
379 sprintf(str, "Get Interface(Intf = %d, Length = %d)", i, l);
382 static inline void dwc3_decode_set_intf(__u8 v, __u16 i, char *str)
384 sprintf(str, "Set Interface(Intf = %d, Alt.Setting = %d)", i, v);
387 static inline void dwc3_decode_synch_frame(__u16 i, __u16 l, char *str)
389 sprintf(str, "Synch Frame(Endpoint = %d, Length = %d)", i, l);
392 static inline void dwc3_decode_set_sel(__u16 l, char *str)
394 sprintf(str, "Set SEL(Length = %d)", l);
397 static inline void dwc3_decode_set_isoch_delay(__u8 v, char *str)
399 sprintf(str, "Set Isochronous Delay(Delay = %d ns)", v);
403 * dwc3_decode_ctrl - returns a string represetion of ctrl request
405 static inline const char *dwc3_decode_ctrl(char *str, __u8 bRequestType,
406 __u8 bRequest, __u16 wValue, __u16 wIndex, __u16 wLength)
409 case USB_REQ_GET_STATUS:
410 dwc3_decode_get_status(bRequestType, wIndex, wLength, str);
412 case USB_REQ_CLEAR_FEATURE:
413 case USB_REQ_SET_FEATURE:
414 dwc3_decode_set_clear_feature(bRequestType, bRequest, wValue,
417 case USB_REQ_SET_ADDRESS:
418 dwc3_decode_set_address(wValue, str);
420 case USB_REQ_GET_DESCRIPTOR:
421 case USB_REQ_SET_DESCRIPTOR:
422 dwc3_decode_get_set_descriptor(bRequestType, bRequest, wValue,
423 wIndex, wLength, str);
425 case USB_REQ_GET_CONFIGURATION:
426 dwc3_decode_get_configuration(wLength, str);
428 case USB_REQ_SET_CONFIGURATION:
429 dwc3_decode_set_configuration(wValue, str);
431 case USB_REQ_GET_INTERFACE:
432 dwc3_decode_get_intf(wIndex, wLength, str);
434 case USB_REQ_SET_INTERFACE:
435 dwc3_decode_set_intf(wValue, wIndex, str);
437 case USB_REQ_SYNCH_FRAME:
438 dwc3_decode_synch_frame(wIndex, wLength, str);
440 case USB_REQ_SET_SEL:
441 dwc3_decode_set_sel(wLength, str);
443 case USB_REQ_SET_ISOCH_DELAY:
444 dwc3_decode_set_isoch_delay(wValue, str);
447 sprintf(str, "%02x %02x %02x %02x %02x %02x %02x %02x",
448 bRequestType, bRequest,
449 cpu_to_le16(wValue) & 0xff,
450 cpu_to_le16(wValue) >> 8,
451 cpu_to_le16(wIndex) & 0xff,
452 cpu_to_le16(wIndex) >> 8,
453 cpu_to_le16(wLength) & 0xff,
454 cpu_to_le16(wLength) >> 8);
461 * dwc3_ep_event_string - returns event name
462 * @event: then event code
464 static inline const char *
465 dwc3_ep_event_string(char *str, const struct dwc3_event_depevt *event,
468 u8 epnum = event->endpoint_number;
473 ret = sprintf(str, "ep%d%s: ", epnum >> 1,
474 (epnum & 1) ? "in" : "out");
478 status = event->status;
480 switch (event->endpoint_event) {
481 case DWC3_DEPEVT_XFERCOMPLETE:
483 sprintf(str + len, "Transfer Complete (%c%c%c)",
484 status & DEPEVT_STATUS_SHORT ? 'S' : 's',
485 status & DEPEVT_STATUS_IOC ? 'I' : 'i',
486 status & DEPEVT_STATUS_LST ? 'L' : 'l');
491 sprintf(str + len, " [%s]", dwc3_ep0_state_string(ep0state));
493 case DWC3_DEPEVT_XFERINPROGRESS:
496 sprintf(str + len, "Transfer In Progress [%d] (%c%c%c)",
498 status & DEPEVT_STATUS_SHORT ? 'S' : 's',
499 status & DEPEVT_STATUS_IOC ? 'I' : 'i',
500 status & DEPEVT_STATUS_LST ? 'M' : 'm');
502 case DWC3_DEPEVT_XFERNOTREADY:
505 sprintf(str + len, "Transfer Not Ready [%d]%s",
507 status & DEPEVT_STATUS_TRANSFER_ACTIVE ?
508 " (Active)" : " (Not Active)");
510 /* Control Endpoints */
512 int phase = DEPEVT_STATUS_CONTROL_PHASE(event->status);
515 case DEPEVT_STATUS_CONTROL_DATA:
516 strcat(str, " [Data Phase]");
518 case DEPEVT_STATUS_CONTROL_STATUS:
519 strcat(str, " [Status Phase]");
523 case DWC3_DEPEVT_RXTXFIFOEVT:
526 case DWC3_DEPEVT_STREAMEVT:
527 status = event->status;
530 case DEPEVT_STREAMEVT_FOUND:
531 sprintf(str + ret, " Stream %d Found",
534 case DEPEVT_STREAMEVT_NOTFOUND:
536 strcat(str, " Stream Not Found");
541 case DWC3_DEPEVT_EPCMDCMPLT:
542 strcat(str, "Endpoint Command Complete");
545 sprintf(str, "UNKNOWN");
552 * dwc3_gadget_event_type_string - return event name
553 * @event: the event code
555 static inline const char *dwc3_gadget_event_type_string(u8 event)
558 case DWC3_DEVICE_EVENT_DISCONNECT:
560 case DWC3_DEVICE_EVENT_RESET:
562 case DWC3_DEVICE_EVENT_CONNECT_DONE:
563 return "Connect Done";
564 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE:
565 return "Link Status Change";
566 case DWC3_DEVICE_EVENT_WAKEUP:
568 case DWC3_DEVICE_EVENT_HIBER_REQ:
569 return "Hibernation";
570 case DWC3_DEVICE_EVENT_EOPF:
571 return "End of Periodic Frame";
572 case DWC3_DEVICE_EVENT_SOF:
573 return "Start of Frame";
574 case DWC3_DEVICE_EVENT_ERRATIC_ERROR:
575 return "Erratic Error";
576 case DWC3_DEVICE_EVENT_CMD_CMPL:
577 return "Command Complete";
578 case DWC3_DEVICE_EVENT_OVERFLOW:
585 static inline const char *dwc3_decode_event(char *str, u32 event, u32 ep0state)
587 const union dwc3_event evt = (union dwc3_event) event;
589 if (evt.type.is_devspec)
590 return dwc3_gadget_event_string(str, &evt.devt);
592 return dwc3_ep_event_string(str, &evt.depevt, ep0state);
595 static inline const char *dwc3_ep_cmd_status_string(int status)
602 case DEPEVT_TRANSFER_NO_RESOURCE:
603 return "No Resource";
604 case DEPEVT_TRANSFER_BUS_EXPIRY:
611 static inline const char *dwc3_gadget_generic_cmd_status_string(int status)
626 #ifdef CONFIG_DEBUG_FS
627 extern void dwc3_debugfs_init(struct dwc3 *);
628 extern void dwc3_debugfs_exit(struct dwc3 *);
630 static inline void dwc3_debugfs_init(struct dwc3 *d)
632 static inline void dwc3_debugfs_exit(struct dwc3 *d)
635 #endif /* __DWC3_DEBUG_H */