xref: /dragonfly/sys/bus/cam/cam_debug.h (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1 /*
2  * Macros for tracing/loging information in the CAM layer
3  *
4  * Copyright (c) 1997 Justin T. Gibbs.
5  * 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  *    without modification, immediately at the beginning of the file.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
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 FOR
20  * 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  * $FreeBSD: src/sys/cam/cam_debug.h,v 1.6 1999/12/29 04:54:25 peter Exp $
29  * $DragonFly: src/sys/bus/cam/cam_debug.h,v 1.4 2007/11/18 17:53:01 pavalos Exp $
30  */
31 #ifndef   _CAM_CAM_DEBUG_H
32 #define _CAM_CAM_DEBUG_H 1
33 
34 #if defined(CAMDEBUG) && defined(_KERNEL)
35 #include <machine/clock.h>
36 #endif /* CAMDEBUG && _KERNEL */
37 
38 /*
39  * Debugging flags.
40  */
41 typedef enum {
42           CAM_DEBUG_NONE                = 0x00, /* no debugging */
43           CAM_DEBUG_INFO                = 0x01,   /* scsi commands, errors, data */
44           CAM_DEBUG_TRACE               = 0x02,   /* routine flow tracking */
45           CAM_DEBUG_SUBTRACE  = 0x04,   /* internal to routine flows */
46           CAM_DEBUG_CDB                 = 0x08, /* print out SCSI CDBs only */
47           CAM_DEBUG_XPT                 = 0x10,   /* print out xpt scheduling */
48           CAM_DEBUG_PERIPH    = 0x20  /* print out peripheral calls */
49 } cam_debug_flags;
50 
51 #if defined(CAMDEBUG) && defined(_KERNEL)
52 
53 /* Path we want to debug */
54 extern struct cam_path *cam_dpath;
55 /* Current debug levels set */
56 extern u_int32_t cam_dflags;
57 /* Printf delay value (to prevent scrolling) */
58 extern u_int32_t cam_debug_delay;
59 
60 /* Debugging macros. */
61 #define   CAM_DEBUGGED(path, flag)                          \
62           ((cam_dflags & (flag))                                      \
63            && (cam_dpath != NULL)                                     \
64            && (xpt_path_comp(cam_dpath, path) >= 0)         \
65            && (xpt_path_comp(cam_dpath, path) < 2))
66 #define   CAM_DEBUG(path, flag, kprintfargs)                \
67           if ((cam_dflags & (flag))                         \
68            && (cam_dpath != NULL)                                     \
69            && (xpt_path_comp(cam_dpath, path) >= 0)         \
70            && (xpt_path_comp(cam_dpath, path) < 2)) {       \
71                     xpt_print_path(path);                             \
72                     kprintf kprintfargs;                              \
73                     if (cam_debug_delay != 0)               \
74                               DELAY(cam_debug_delay);                 \
75           }
76 #define   CAM_DEBUG_PRINT(flag, kprintfargs)                \
77           if (cam_dflags & (flag)) {                        \
78                     kprintf("cam_debug: ");                           \
79                     kprintf kprintfargs;                              \
80                     if (cam_debug_delay != 0)               \
81                               DELAY(cam_debug_delay);                 \
82           }
83 
84 #else /* !CAMDEBUG || !_KERNEL */
85 
86 #define   CAM_DEBUGGED(A, B)  0
87 #define   CAM_DEBUG(A, B, C)
88 #define   CAM_DEBUG_PRINT(A, B)
89 
90 #endif /* CAMDEBUG && _KERNEL */
91 
92 #endif /* _CAM_CAM_DEBUG_H */
93