xref: /netbsd/sys/dev/scsipi/scsipi_debug.h (revision bf9ec67e)
1 /*	$NetBSD: scsipi_debug.h,v 1.14 2001/05/30 11:46:34 mrg Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *        This product includes software developed by the NetBSD
22  *        Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #if defined(_KERNEL_OPT)
41 #include "opt_scsipi_debug.h"
42 #endif
43 
44 /*
45  * Originally written by Julian Elischer (julian@tfs.com)
46  */
47 
48 #define	SCSIPI_DB1	0x0001		/* scsi commands, errors, data */
49 #define	SCSIPI_DB2	0x0002		/* routine flow tracking */
50 #define	SCSIPI_DB3	0x0004		/* internal to routine flows */
51 #define	SCSIPI_DB4	0x0008		/* level 4 debugging for this dev */
52 
53 /*
54  * The following options allow us to build a kernel with debugging on
55  * by default for a certain type of device.  We can always enable
56  * debugging on a specific device using an ioctl.
57  */
58 #ifndef SCSIPI_DEBUG_TYPE
59 #define	SCSIPI_DEBUG_TYPE	SCSIPI_BUSTYPE_ATAPI
60 #endif
61 
62 #ifndef SCSIPI_DEBUG_TARGET
63 #define	SCSIPI_DEBUG_TARGET	-1	/* disabled */
64 #endif
65 
66 #ifndef	SCSIPI_DEBUG_LUN
67 #define	SCSIPI_DEBUG_LUN	0
68 #endif
69 
70 /*
71  * Default debugging flags for above.
72  */
73 #ifndef SCSIPI_DEBUG_FLAGS
74 #define	SCSIPI_DEBUG_FLAGS	(SCSIPI_DB1|SCSIPI_DB2|SCSIPI_DB3)
75 #endif
76 
77 #ifdef SCSIPI_DEBUG
78 #define	SC_DEBUG(periph, flags, x)					\
79 do {									\
80 	if ((periph)->periph_dbflags & (flags)) {			\
81 		scsipi_printaddr((periph));				\
82 		printf x ;						\
83 	}								\
84 } while (0)
85 
86 #define	SC_DEBUGN(periph, flags, x)					\
87 do {									\
88 	if ((periph)->periph_dbflags & (flags))				\
89 		printf x ;						\
90 } while (0)
91 #else
92 #define	SC_DEBUG(periph, flags, x)	/* nothing */
93 #define	SC_DEBUGN(periph, flags, x)	/* nothing */
94 #endif
95