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
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
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_gadget_hs_link_string - returns highspeed and below link name
121 * @link_state: link state code
123 static inline const char *
124 dwc3_gadget_hs_link_string(enum dwc3_link_state link_state
)
126 switch (link_state
) {
127 case DWC3_LINK_STATE_U0
:
129 case DWC3_LINK_STATE_U2
:
131 case DWC3_LINK_STATE_U3
:
133 case DWC3_LINK_STATE_SS_DIS
:
134 return "Disconnected";
135 case DWC3_LINK_STATE_RX_DET
:
136 return "Early Suspend";
137 case DWC3_LINK_STATE_RECOV
:
139 case DWC3_LINK_STATE_RESET
:
141 case DWC3_LINK_STATE_RESUME
:
144 return "UNKNOWN link state\n";
149 * dwc3_trb_type_string - returns TRB type as a string
150 * @type: the type of the TRB
152 static inline const char *dwc3_trb_type_string(unsigned int type
)
155 case DWC3_TRBCTL_NORMAL
:
157 case DWC3_TRBCTL_CONTROL_SETUP
:
159 case DWC3_TRBCTL_CONTROL_STATUS2
:
161 case DWC3_TRBCTL_CONTROL_STATUS3
:
163 case DWC3_TRBCTL_CONTROL_DATA
:
165 case DWC3_TRBCTL_ISOCHRONOUS_FIRST
:
167 case DWC3_TRBCTL_ISOCHRONOUS
:
169 case DWC3_TRBCTL_LINK_TRB
:
176 static inline const char *dwc3_ep0_state_string(enum dwc3_ep0_state state
)
179 case EP0_UNCONNECTED
:
180 return "Unconnected";
181 case EP0_SETUP_PHASE
:
182 return "Setup Phase";
185 case EP0_STATUS_PHASE
:
186 return "Status Phase";
193 * dwc3_gadget_event_string - returns event name
194 * @event: the event code
196 static inline const char *
197 dwc3_gadget_event_string(char *str
, const struct dwc3_event_devt
*event
)
199 enum dwc3_link_state state
= event
->event_info
& DWC3_LINK_STATE_MASK
;
201 switch (event
->type
) {
202 case DWC3_DEVICE_EVENT_DISCONNECT
:
203 sprintf(str
, "Disconnect: [%s]",
204 dwc3_gadget_link_string(state
));
206 case DWC3_DEVICE_EVENT_RESET
:
207 sprintf(str
, "Reset [%s]", dwc3_gadget_link_string(state
));
209 case DWC3_DEVICE_EVENT_CONNECT_DONE
:
210 sprintf(str
, "Connection Done [%s]",
211 dwc3_gadget_link_string(state
));
213 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE
:
214 sprintf(str
, "Link Change [%s]",
215 dwc3_gadget_link_string(state
));
217 case DWC3_DEVICE_EVENT_WAKEUP
:
218 sprintf(str
, "WakeUp [%s]", dwc3_gadget_link_string(state
));
220 case DWC3_DEVICE_EVENT_EOPF
:
221 sprintf(str
, "End-Of-Frame [%s]",
222 dwc3_gadget_link_string(state
));
224 case DWC3_DEVICE_EVENT_SOF
:
225 sprintf(str
, "Start-Of-Frame [%s]",
226 dwc3_gadget_link_string(state
));
228 case DWC3_DEVICE_EVENT_ERRATIC_ERROR
:
229 sprintf(str
, "Erratic Error [%s]",
230 dwc3_gadget_link_string(state
));
232 case DWC3_DEVICE_EVENT_CMD_CMPL
:
233 sprintf(str
, "Command Complete [%s]",
234 dwc3_gadget_link_string(state
));
236 case DWC3_DEVICE_EVENT_OVERFLOW
:
237 sprintf(str
, "Overflow [%s]", dwc3_gadget_link_string(state
));
240 sprintf(str
, "UNKNOWN");
246 static inline void dwc3_decode_get_status(__u8 t
, __u16 i
, __u16 l
, char *str
)
248 switch (t
& USB_RECIP_MASK
) {
249 case USB_RECIP_INTERFACE
:
250 sprintf(str
, "Get Interface Status(Intf = %d, Length = %d)",
253 case USB_RECIP_ENDPOINT
:
254 sprintf(str
, "Get Endpoint Status(ep%d%s)",
256 i
& USB_DIR_IN
? "in" : "out");
261 static inline void dwc3_decode_set_clear_feature(__u8 t
, __u8 b
, __u16 v
,
264 switch (t
& USB_RECIP_MASK
) {
265 case USB_RECIP_DEVICE
:
266 sprintf(str
, "%s Device Feature(%s%s)",
267 b
== USB_REQ_CLEAR_FEATURE
? "Clear" : "Set",
270 case USB_DEVICE_SELF_POWERED
:
273 case USB_DEVICE_REMOTE_WAKEUP
:
276 case USB_DEVICE_TEST_MODE
:
282 v
== USB_DEVICE_TEST_MODE
?
292 s
= ": TEST_SE0_NAK";
298 s
= ": TEST_FORCE_EN";
304 case USB_RECIP_INTERFACE
:
305 sprintf(str
, "%s Interface Feature(%s)",
306 b
== USB_REQ_CLEAR_FEATURE
? "Clear" : "Set",
307 v
== USB_INTRF_FUNC_SUSPEND
?
308 "Function Suspend" : "UNKNOWN");
310 case USB_RECIP_ENDPOINT
:
311 sprintf(str
, "%s Endpoint Feature(%s ep%d%s)",
312 b
== USB_REQ_CLEAR_FEATURE
? "Clear" : "Set",
313 v
== USB_ENDPOINT_HALT
? "Halt" : "UNKNOWN",
315 i
& USB_DIR_IN
? "in" : "out");
320 static inline void dwc3_decode_set_address(__u16 v
, char *str
)
322 sprintf(str
, "Set Address(Addr = %02x)", v
);
325 static inline void dwc3_decode_get_set_descriptor(__u8 t
, __u8 b
, __u16 v
,
326 __u16 i
, __u16 l
, char *str
)
328 sprintf(str
, "%s %s Descriptor(Index = %d, Length = %d)",
329 b
== USB_REQ_GET_DESCRIPTOR
? "Get" : "Set",
341 case USB_DT_INTERFACE
:
344 case USB_DT_ENDPOINT
:
347 case USB_DT_DEVICE_QUALIFIER
:
348 s
= "Device Qualifier";
350 case USB_DT_OTHER_SPEED_CONFIG
:
351 s
= "Other Speed Config";
353 case USB_DT_INTERFACE_POWER
:
354 s
= "Interface Power";
362 case USB_DT_INTERFACE_ASSOCIATION
:
363 s
= "Interface Association";
368 case USB_DT_DEVICE_CAPABILITY
:
369 s
= "Device Capability";
371 case USB_DT_PIPE_USAGE
:
374 case USB_DT_SS_ENDPOINT_COMP
:
375 s
= "SS Endpoint Companion";
377 case USB_DT_SSP_ISOC_ENDPOINT_COMP
:
378 s
= "SSP Isochronous Endpoint Companion";
383 } s
; }), v
& 0xff, l
);
387 static inline void dwc3_decode_get_configuration(__u16 l
, char *str
)
389 sprintf(str
, "Get Configuration(Length = %d)", l
);
392 static inline void dwc3_decode_set_configuration(__u8 v
, char *str
)
394 sprintf(str
, "Set Configuration(Config = %d)", v
);
397 static inline void dwc3_decode_get_intf(__u16 i
, __u16 l
, char *str
)
399 sprintf(str
, "Get Interface(Intf = %d, Length = %d)", i
, l
);
402 static inline void dwc3_decode_set_intf(__u8 v
, __u16 i
, char *str
)
404 sprintf(str
, "Set Interface(Intf = %d, Alt.Setting = %d)", i
, v
);
407 static inline void dwc3_decode_synch_frame(__u16 i
, __u16 l
, char *str
)
409 sprintf(str
, "Synch Frame(Endpoint = %d, Length = %d)", i
, l
);
412 static inline void dwc3_decode_set_sel(__u16 l
, char *str
)
414 sprintf(str
, "Set SEL(Length = %d)", l
);
417 static inline void dwc3_decode_set_isoch_delay(__u8 v
, char *str
)
419 sprintf(str
, "Set Isochronous Delay(Delay = %d ns)", v
);
423 * dwc3_decode_ctrl - returns a string represetion of ctrl request
425 static inline const char *dwc3_decode_ctrl(char *str
, __u8 bRequestType
,
426 __u8 bRequest
, __u16 wValue
, __u16 wIndex
, __u16 wLength
)
429 case USB_REQ_GET_STATUS
:
430 dwc3_decode_get_status(bRequestType
, wIndex
, wLength
, str
);
432 case USB_REQ_CLEAR_FEATURE
:
433 case USB_REQ_SET_FEATURE
:
434 dwc3_decode_set_clear_feature(bRequestType
, bRequest
, wValue
,
437 case USB_REQ_SET_ADDRESS
:
438 dwc3_decode_set_address(wValue
, str
);
440 case USB_REQ_GET_DESCRIPTOR
:
441 case USB_REQ_SET_DESCRIPTOR
:
442 dwc3_decode_get_set_descriptor(bRequestType
, bRequest
, wValue
,
443 wIndex
, wLength
, str
);
445 case USB_REQ_GET_CONFIGURATION
:
446 dwc3_decode_get_configuration(wLength
, str
);
448 case USB_REQ_SET_CONFIGURATION
:
449 dwc3_decode_set_configuration(wValue
, str
);
451 case USB_REQ_GET_INTERFACE
:
452 dwc3_decode_get_intf(wIndex
, wLength
, str
);
454 case USB_REQ_SET_INTERFACE
:
455 dwc3_decode_set_intf(wValue
, wIndex
, str
);
457 case USB_REQ_SYNCH_FRAME
:
458 dwc3_decode_synch_frame(wIndex
, wLength
, str
);
460 case USB_REQ_SET_SEL
:
461 dwc3_decode_set_sel(wLength
, str
);
463 case USB_REQ_SET_ISOCH_DELAY
:
464 dwc3_decode_set_isoch_delay(wValue
, str
);
467 sprintf(str
, "%02x %02x %02x %02x %02x %02x %02x %02x",
468 bRequestType
, bRequest
,
469 cpu_to_le16(wValue
) & 0xff,
470 cpu_to_le16(wValue
) >> 8,
471 cpu_to_le16(wIndex
) & 0xff,
472 cpu_to_le16(wIndex
) >> 8,
473 cpu_to_le16(wLength
) & 0xff,
474 cpu_to_le16(wLength
) >> 8);
481 * dwc3_ep_event_string - returns event name
482 * @event: then event code
484 static inline const char *
485 dwc3_ep_event_string(char *str
, const struct dwc3_event_depevt
*event
,
488 u8 epnum
= event
->endpoint_number
;
493 ret
= sprintf(str
, "ep%d%s: ", epnum
>> 1,
494 (epnum
& 1) ? "in" : "out");
498 switch (event
->endpoint_event
) {
499 case DWC3_DEPEVT_XFERCOMPLETE
:
500 strcat(str
, "Transfer Complete");
504 sprintf(str
+ len
, " [%s]", dwc3_ep0_state_string(ep0state
));
506 case DWC3_DEPEVT_XFERINPROGRESS
:
507 strcat(str
, "Transfer In-Progress");
509 case DWC3_DEPEVT_XFERNOTREADY
:
510 strcat(str
, "Transfer Not Ready");
511 status
= event
->status
& DEPEVT_STATUS_TRANSFER_ACTIVE
;
512 strcat(str
, status
? " (Active)" : " (Not Active)");
514 /* Control Endpoints */
516 int phase
= DEPEVT_STATUS_CONTROL_PHASE(event
->status
);
519 case DEPEVT_STATUS_CONTROL_DATA
:
520 strcat(str
, " [Data Phase]");
522 case DEPEVT_STATUS_CONTROL_STATUS
:
523 strcat(str
, " [Status Phase]");
527 case DWC3_DEPEVT_RXTXFIFOEVT
:
530 case DWC3_DEPEVT_STREAMEVT
:
531 status
= event
->status
;
534 case DEPEVT_STREAMEVT_FOUND
:
535 sprintf(str
+ ret
, " Stream %d Found",
538 case DEPEVT_STREAMEVT_NOTFOUND
:
540 strcat(str
, " Stream Not Found");
545 case DWC3_DEPEVT_EPCMDCMPLT
:
546 strcat(str
, "Endpoint Command Complete");
549 sprintf(str
, "UNKNOWN");
556 * dwc3_gadget_event_type_string - return event name
557 * @event: the event code
559 static inline const char *dwc3_gadget_event_type_string(u8 event
)
562 case DWC3_DEVICE_EVENT_DISCONNECT
:
564 case DWC3_DEVICE_EVENT_RESET
:
566 case DWC3_DEVICE_EVENT_CONNECT_DONE
:
567 return "Connect Done";
568 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE
:
569 return "Link Status Change";
570 case DWC3_DEVICE_EVENT_WAKEUP
:
572 case DWC3_DEVICE_EVENT_HIBER_REQ
:
573 return "Hibernation";
574 case DWC3_DEVICE_EVENT_EOPF
:
575 return "End of Periodic Frame";
576 case DWC3_DEVICE_EVENT_SOF
:
577 return "Start of Frame";
578 case DWC3_DEVICE_EVENT_ERRATIC_ERROR
:
579 return "Erratic Error";
580 case DWC3_DEVICE_EVENT_CMD_CMPL
:
581 return "Command Complete";
582 case DWC3_DEVICE_EVENT_OVERFLOW
:
589 static inline const char *dwc3_decode_event(char *str
, u32 event
, u32 ep0state
)
591 const union dwc3_event evt
= (union dwc3_event
) event
;
593 if (evt
.type
.is_devspec
)
594 return dwc3_gadget_event_string(str
, &evt
.devt
);
596 return dwc3_ep_event_string(str
, &evt
.depevt
, ep0state
);
599 static inline const char *dwc3_ep_cmd_status_string(int status
)
606 case DEPEVT_TRANSFER_NO_RESOURCE
:
607 return "No Resource";
608 case DEPEVT_TRANSFER_BUS_EXPIRY
:
615 static inline const char *dwc3_gadget_generic_cmd_status_string(int status
)
630 #ifdef CONFIG_DEBUG_FS
631 extern void dwc3_debugfs_init(struct dwc3
*);
632 extern void dwc3_debugfs_exit(struct dwc3
*);
634 static inline void dwc3_debugfs_init(struct dwc3
*d
)
636 static inline void dwc3_debugfs_exit(struct dwc3
*d
)
639 #endif /* __DWC3_DEBUG_H */