summaryrefslogtreecommitdiff
path: root/drivers/staging/sxg/sxgdbg.h
blob: e613a972b3d071adb0b4a03c72573dfa7efb5f68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/**************************************************************************
 *
 * Copyright © 2000-2008 Alacritech, Inc.  All rights reserved.
 *
 * $Id: sxgdbg.h,v 1.1 2008/06/27 12:49:28 mook Exp $
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY ALACRITECH, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ALACRITECH, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation
 * are those of the authors and should not be interpreted as representing
 * official policies, either expressed or implied, of Alacritech, Inc.
 *
 **************************************************************************/

/*
 * FILENAME: sxgdbg.h
 *
 * All debug and assertion-based definitions and macros are included
 * in this file for the SXGOSS driver.
 */
#ifndef _SXG_DEBUG_H_
#define _SXG_DEBUG_H_

#define ATKDBG  1
#define ATK_TRACE_ENABLED 0

#define DBG_ERROR(n, args...)	printk(KERN_WARNING n, ##args)

#ifdef ASSERT
#undef ASSERT
#endif

#define SXG_ASSERT_ENABLED
#ifdef SXG_ASSERT_ENABLED
#ifndef ASSERT
#define ASSERT(a)                                                          \
    {                                                                      \
        if (!(a)) {                                                        \
            DBG_ERROR("ASSERT() Failure: file %s, function %s  line %d\n", \
                __FILE__, __func__, __LINE__);                             \
        }                                                                  \
    }
#endif
#else
#ifndef ASSERT
#define ASSERT(a)
#endif
#endif /* SXG_ASSERT_ENABLED  */


#ifdef ATKDBG
/*
 *  Global for timer granularity; every driver must have an instance
 *  of this initialized to 0
 */

extern ulong ATKTimerDiv;

/*
 * trace_entry -
 *
 * This structure defines an entry in the trace buffer.  The
 * first few fields mean the same from entry to entry, while
 * the meaning of last several fields change to suit the
 * needs of the trace entry.  Typically they are function call
 * parameters.
 */
struct trace_entry {
        char      	name[8];/* 8 character name - like 's'i'm'b'a'r'c'v' */
        u32   		time;  /* Current clock tic */
        unsigned char   cpu;   /* Current CPU */
        unsigned char   irql;  /* Current IRQL */
        unsigned char   driver;/* The driver which added the trace call */
	/* pad to 4 byte boundary - will probably get used */
        unsigned char   pad2;
        u32		arg1;           /* Caller arg1 */
        u32		arg2;           /* Caller arg2 */
        u32		arg3;           /* Caller arg3 */
        u32		arg4;           /* Caller arg4 */
};

/* Driver types for driver field in struct trace_entry */
#define TRACE_SXG             1
#define TRACE_VPCI            2
#define TRACE_SLIC            3

#define TRACE_ENTRIES   1024

struct sxg_trace_buffer {
	/* aid for windbg extension */
	unsigned int            size;
	unsigned int            in;                    /* Where to add */
	unsigned int            level;                 /* Current Trace level */
	spinlock_t		lock;                  /* For MP tracing */
	struct trace_entry	entries[TRACE_ENTRIES];/* The circular buffer */
};

/*
 * The trace levels
 *
 * XXX At the moment I am only defining critical, important, and noisy.
 * I am leaving room for more if anyone wants them.
 */
#define TRACE_NONE              0   /* For trace level - if no tracing wanted */
#define TRACE_CRITICAL          1   /* minimal tracing - only critical stuff */
#define TRACE_IMPORTANT         5   /* more tracing - anything important */
#define TRACE_NOISY             10  /* Everything in the world */


/* The macros themselves */
#if ATK_TRACE_ENABLED
#define SXG_TRACE_INIT(buffer, tlevel)				\
{								\
	memset((buffer), 0, sizeof(struct sxg_trace_buffer));	\
	(buffer)->level = (tlevel);				\
	(buffer)->size = TRACE_ENTRIES;				\
	spin_lock_init(&(buffer)->lock);			\
}
#else
#define SXG_TRACE_INIT(buffer, tlevel)
#endif

/*The trace macro.  This is active only if ATK_TRACE_ENABLED is set. */
#if ATK_TRACE_ENABLED
#define SXG_TRACE(tdriver, buffer, tlevel, tname, a1, a2, a3, a4) {        \
        if ((buffer) && ((buffer)->level >= (tlevel))) {                   \
                unsigned int            trace_irql = 0;/* ?????? FIX THIS */\
                unsigned int            trace_len;                          \
                struct trace_entry	*trace_entry;			    \
                struct timeval  timev;                                      \
		if(spin_trylock(&(buffer)->lock))	{		     \
	                trace_entry = &(buffer)->entries[(buffer)->in];      \
        	        do_gettimeofday(&timev);                             \
                	                                                     \
	                memset(trace_entry->name, 0, 8);                     \
        	        trace_len = strlen(tname);                           \
	                trace_len = trace_len > 8 ? 8 : trace_len;           \
        	        memcpy(trace_entry->name, (tname), trace_len);       \
	                trace_entry->time = timev.tv_usec;                   \
			trace_entry->cpu = (unsigned char)(smp_processor_id() & 0xFF);\
	                trace_entry->driver = (tdriver);                     \
        	        trace_entry->irql = trace_irql;                      \
	                trace_entry->arg1 = (ulong)(a1);                     \
        	        trace_entry->arg2 = (ulong)(a2);                     \
	                trace_entry->arg3 = (ulong)(a3);                     \
        	        trace_entry->arg4 = (ulong)(a4);                     \
	                                                                     \
        	        (buffer)->in++;                                      \
                	if ((buffer)->in == TRACE_ENTRIES)                   \
	                        (buffer)->in = 0;                            \
        	                                                             \
			spin_unlock(&(buffer)->lock);                        \
 	       	}                                                            \
	}								     \
}
#else
#define SXG_TRACE(tdriver, buffer, tlevel, tname, a1, a2, a3, a4)
#endif

#endif

#endif  /*  _SXG_DEBUG_H_  */