xref: /freebsd/sys/dev/usb/usb_debug.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 /* This file contains various factored out debug macros. */
29 
30 #ifndef _USB_DEBUG_H_
31 #define	_USB_DEBUG_H_
32 
33 /* Declare global USB debug variable. */
34 extern int usb_debug;
35 
36 /* Check if USB debugging is enabled. */
37 #ifdef USB_DEBUG_VAR
38 #ifdef USB_DEBUG
39 #define	DPRINTFN(n,fmt,...) do {		\
40   if ((USB_DEBUG_VAR) >= (n)) {			\
41     printf("%s: " fmt,				\
42 	   __FUNCTION__ ,##__VA_ARGS__);	\
43   }						\
44 } while (0)
45 #define	DPRINTF(...)	DPRINTFN(1, __VA_ARGS__)
46 #define	__usbdebug_used
47 #else
48 #define	DPRINTF(...) do { } while (0)
49 #define	DPRINTFN(...) do { } while (0)
50 #define	__usbdebug_used __unused
51 #endif
52 #endif
53 
54 struct usb_interface;
55 struct usb_device;
56 struct usb_endpoint;
57 struct usb_xfer;
58 
59 void	usb_dump_iface(struct usb_interface *iface);
60 void	usb_dump_device(struct usb_device *udev);
61 void	usb_dump_queue(struct usb_endpoint *ep);
62 void	usb_dump_endpoint(struct usb_endpoint *ep);
63 void	usb_dump_xfer(struct usb_xfer *xfer);
64 
65 #ifdef USB_DEBUG
66 extern unsigned usb_port_reset_delay;
67 extern unsigned usb_port_root_reset_delay;
68 extern unsigned usb_port_reset_recovery;
69 extern unsigned usb_port_powerup_delay;
70 extern unsigned usb_port_resume_delay;
71 extern unsigned usb_set_address_settle;
72 extern unsigned usb_resume_delay;
73 extern unsigned usb_resume_wait;
74 extern unsigned usb_resume_recovery;
75 extern unsigned usb_extra_power_up_time;
76 extern unsigned usb_enum_nice_time;
77 #else
78 #define usb_port_reset_delay		USB_PORT_RESET_DELAY
79 #define usb_port_root_reset_delay	USB_PORT_ROOT_RESET_DELAY
80 #define usb_port_reset_recovery		USB_PORT_RESET_RECOVERY
81 #define usb_port_powerup_delay		USB_PORT_POWERUP_DELAY
82 #define usb_port_resume_delay		USB_PORT_RESUME_DELAY
83 #define usb_set_address_settle		USB_SET_ADDRESS_SETTLE
84 #define usb_resume_delay		USB_RESUME_DELAY
85 #define usb_resume_wait			USB_RESUME_WAIT
86 #define usb_resume_recovery		USB_RESUME_RECOVERY
87 #define usb_extra_power_up_time		USB_EXTRA_POWER_UP_TIME
88 #define usb_enum_nice_time		USB_ENUM_NICE_TIME
89 #endif
90 
91 #endif					/* _USB_DEBUG_H_ */
92