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