cam_debug.h revision 139743 
121240Swosch/*-
221240Swosch * Macros for tracing/loging information in the CAM layer
321240Swosch *
421240Swosch * Copyright (c) 1997 Justin T. Gibbs.
521240Swosch * All rights reserved.
621240Swosch *
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: head/sys/cam/cam_debug.h 139743 2005-01-05 22:34:37Z imp $
29 */
30#ifndef	_CAM_CAM_DEBUG_H
31#define _CAM_CAM_DEBUG_H 1
32
33#if defined(CAMDEBUG) && defined(_KERNEL)
34#include <machine/clock.h>
35#endif /* CAMDEBUG && _KERNEL */
36
37/*
38 * Debugging flags.
39 */
40typedef enum {
41	CAM_DEBUG_NONE		= 0x00, /* no debugging */
42	CAM_DEBUG_INFO		= 0x01,	/* scsi commands, errors, data */
43	CAM_DEBUG_TRACE		= 0x02,	/* routine flow tracking */
44	CAM_DEBUG_SUBTRACE	= 0x04,	/* internal to routine flows */
45	CAM_DEBUG_CDB		= 0x08, /* print out SCSI CDBs only */
46	CAM_DEBUG_XPT		= 0x10,	/* print out xpt scheduling */
47	CAM_DEBUG_PERIPH	= 0x20  /* print out peripheral calls */
48} cam_debug_flags;
49
50#if defined(CAMDEBUG) && defined(_KERNEL)
51
52/* Path we want to debug */
53extern struct cam_path *cam_dpath;
54/* Current debug levels set */
55extern u_int32_t cam_dflags;
56/* Printf delay value (to prevent scrolling) */
57extern u_int32_t cam_debug_delay;
58
59/* Debugging macros. */
60#define	CAM_DEBUGGED(path, flag)			\
61	((cam_dflags & (flag))				\
62	 && (cam_dpath != NULL)				\
63	 && (xpt_path_comp(cam_dpath, path) >= 0)	\
64	 && (xpt_path_comp(cam_dpath, path) < 2))
65#define	CAM_DEBUG(path, flag, printfargs)		\
66	if ((cam_dflags & (flag))			\
67	 && (cam_dpath != NULL)				\
68	 && (xpt_path_comp(cam_dpath, path) >= 0)	\
69	 && (xpt_path_comp(cam_dpath, path) < 2)) {	\
70		xpt_print_path(path);			\
71 		printf printfargs;			\
72		if (cam_debug_delay != 0)		\
73			DELAY(cam_debug_delay);		\
74	}
75#define	CAM_DEBUG_PRINT(flag, printfargs)		\
76	if (cam_dflags & (flag)) {			\
77		printf("cam_debug: ");			\
78 		printf printfargs;			\
79		if (cam_debug_delay != 0)		\
80			DELAY(cam_debug_delay);		\
81	}
82
83#else /* !CAMDEBUG || !_KERNEL */
84
85#define	CAM_DEBUGGED(A, B)	0
86#define	CAM_DEBUG(A, B, C)
87#define	CAM_DEBUG_PRINT(A, B)
88
89#endif /* CAMDEBUG && _KERNEL */
90
91#endif /* _CAM_CAM_DEBUG_H */
92