[linux-2.6-block.git] / sound / pci / asihpi / hpidebug.h

/*****************************************************************************

    AudioScience HPI driver
    Copyright (C) 1997-2011  AudioScience Inc. <support@audioscience.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of version 2 of the GNU General Public License as
    published by the Free Software Foundation;

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

Debug macros.

*****************************************************************************/

#ifndef _HPIDEBUG_H
#define _HPIDEBUG_H

#include "hpi_internal.h"

/* Define debugging levels.  */
enum { HPI_DEBUG_LEVEL_ERROR = 0,	/* always log errors */
	HPI_DEBUG_LEVEL_WARNING = 1,
	HPI_DEBUG_LEVEL_NOTICE = 2,
	HPI_DEBUG_LEVEL_INFO = 3,
	HPI_DEBUG_LEVEL_DEBUG = 4,
	HPI_DEBUG_LEVEL_VERBOSE = 5	/* same printk level as DEBUG */
};

#define HPI_DEBUG_LEVEL_DEFAULT HPI_DEBUG_LEVEL_NOTICE

/* an OS can define an extra flag string that is appended to
   the start of each message, eg see linux kernel hpios.h */

#ifdef SOURCEFILE_NAME
#define FILE_LINE  SOURCEFILE_NAME ":" __stringify(__LINE__) " "
#else
#define FILE_LINE  __FILE__ ":" __stringify(__LINE__) " "
#endif

#define HPI_DEBUG_ASSERT(expression) \
	do { \
		if (!(expression)) { \
			printk(KERN_ERR  FILE_LINE \
				"ASSERT " __stringify(expression)); \
		} \
	} while (0)

#define HPI_DEBUG_LOG(level, ...) \
	do { \
		if (hpi_debug_level >= HPI_DEBUG_LEVEL_##level) { \
			printk(HPI_DEBUG_FLAG_##level \
			FILE_LINE  __VA_ARGS__); \
		} \
	} while (0)

void hpi_debug_init(void);
int hpi_debug_level_set(int level);
int hpi_debug_level_get(void);
/* needed by Linux driver for dynamic debug level changes */
extern int hpi_debug_level;

void hpi_debug_message(struct hpi_message *phm, char *sz_fileline);

void hpi_debug_data(u16 *pdata, u32 len);

#define HPI_DEBUG_DATA(pdata, len) \
	do { \
		if (hpi_debug_level >= HPI_DEBUG_LEVEL_VERBOSE) \
			hpi_debug_data(pdata, len); \
	} while (0)

#define HPI_DEBUG_MESSAGE(level, phm) \
	do { \
		if (hpi_debug_level >= HPI_DEBUG_LEVEL_##level) { \
			hpi_debug_message(phm, HPI_DEBUG_FLAG_##level \
				FILE_LINE __stringify(level)); \
		} \
	} while (0)

#define HPI_DEBUG_RESPONSE(phr) \
	do { \
		if (((hpi_debug_level >= HPI_DEBUG_LEVEL_DEBUG) && \
			(phr->error)) ||\
		(hpi_debug_level >= HPI_DEBUG_LEVEL_VERBOSE)) \
			printk(KERN_DEBUG "HPI_RES%d,%d,%d\n", \
				phr->version, phr->error, phr->specific_error); \
	} while (0)

#ifndef compile_time_assert
#define compile_time_assert(cond, msg) \
    typedef char msg[(cond) ? 1 : -1]
#endif

#endif				/* _HPIDEBUG_H_  */
Commit	Line	Data
719f82d3 EB	1	/*****************************************************************************
	2
	3	AudioScience HPI driver
40818b62	4	Copyright (C) 1997-2011 AudioScience Inc. <support@audioscience.com>
719f82d3 EB	5
	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of version 2 of the GNU General Public License as
	8	published by the Free Software Foundation;
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the Free Software
	17	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	18
	19	Debug macros.
	20
	21	*****************************************************************************/
	22
	23	#ifndef _HPIDEBUG_H
	24	#define _HPIDEBUG_H
	25
	26	#include "hpi_internal.h"
	27
	28	/* Define debugging levels. */
	29	enum { HPI_DEBUG_LEVEL_ERROR = 0, /* always log errors */
	30	HPI_DEBUG_LEVEL_WARNING = 1,
	31	HPI_DEBUG_LEVEL_NOTICE = 2,
	32	HPI_DEBUG_LEVEL_INFO = 3,
	33	HPI_DEBUG_LEVEL_DEBUG = 4,
	34	HPI_DEBUG_LEVEL_VERBOSE = 5 /* same printk level as DEBUG */
	35	};
	36
	37	#define HPI_DEBUG_LEVEL_DEFAULT HPI_DEBUG_LEVEL_NOTICE
	38
	39	/* an OS can define an extra flag string that is appended to
f0dcad41	40	the start of each message, eg see linux kernel hpios.h */
719f82d3 EB	41
	42	#ifdef SOURCEFILE_NAME
	43	#define FILE_LINE SOURCEFILE_NAME ":" __stringify(__LINE__) " "
	44	#else
	45	#define FILE_LINE __FILE__ ":" __stringify(__LINE__) " "
	46	#endif
	47
719f82d3 EB	48	#define HPI_DEBUG_ASSERT(expression) \
719f82d3 EB	49	do { \
f0dcad41 EB	50	if (!(expression)) { \
	51	printk(KERN_ERR FILE_LINE \
	52	"ASSERT " __stringify(expression)); \
719f82d3 EB	53	} \
	54	} while (0)
	55
	56	#define HPI_DEBUG_LOG(level, ...) \
	57	do { \
	58	if (hpi_debug_level >= HPI_DEBUG_LEVEL_##level) { \
	59	printk(HPI_DEBUG_FLAG_##level \
	60	FILE_LINE __VA_ARGS__); \
	61	} \
	62	} while (0)
	63
	64	void hpi_debug_init(void);
	65	int hpi_debug_level_set(int level);
	66	int hpi_debug_level_get(void);
	67	/* needed by Linux driver for dynamic debug level changes */
	68	extern int hpi_debug_level;
	69
	70	void hpi_debug_message(struct hpi_message phm, char sz_fileline);
	71
	72	void hpi_debug_data(u16 *pdata, u32 len);
	73
f0dcad41 EB	74	#define HPI_DEBUG_DATA(pdata, len) \
f0dcad41 EB	75	do { \
719f82d3 EB	76	if (hpi_debug_level >= HPI_DEBUG_LEVEL_VERBOSE) \
	77	hpi_debug_data(pdata, len); \
	78	} while (0)
	79
f0dcad41 EB	80	#define HPI_DEBUG_MESSAGE(level, phm) \
	81	do { \
	82	if (hpi_debug_level >= HPI_DEBUG_LEVEL_##level) { \
1528fbb5	83	hpi_debug_message(phm, HPI_DEBUG_FLAG_##level \
f0dcad41 EB	84	FILE_LINE __stringify(level)); \
f0dcad41 EB	85	} \
719f82d3 EB	86	} while (0)
719f82d3 EB	87
f0dcad41 EB	88	#define HPI_DEBUG_RESPONSE(phr) \
f0dcad41 EB	89	do { \
1528fbb5 EB	90	if (((hpi_debug_level >= HPI_DEBUG_LEVEL_DEBUG) && \
1528fbb5 EB	91	(phr->error)) \|\|\
f0dcad41	92	(hpi_debug_level >= HPI_DEBUG_LEVEL_VERBOSE)) \
1528fbb5	93	printk(KERN_DEBUG "HPI_RES%d,%d,%d\n", \
f0dcad41	94	phr->version, phr->error, phr->specific_error); \
719f82d3 EB	95	} while (0)
	96
	97	#ifndef compile_time_assert
	98	#define compile_time_assert(cond, msg) \
	99	typedef char msg[(cond) ? 1 : -1]
	100	#endif
	101
f0dcad41	102	#endif /* _HPIDEBUG_H_ */