1719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett/***************************************************************************** 2719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 3719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett AudioScience HPI driver 4719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett Copyright (C) 1997-2010 AudioScience Inc. <support@audioscience.com> 5719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 6719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett This program is free software; you can redistribute it and/or modify 7719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett it under the terms of version 2 of the GNU General Public License as 8719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett published by the Free Software Foundation; 9719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 10719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett This program is distributed in the hope that it will be useful, 11719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett but WITHOUT ANY WARRANTY; without even the implied warranty of 12719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett GNU General Public License for more details. 14719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 15719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett You should have received a copy of the GNU General Public License 16719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett along with this program; if not, write to the Free Software 17719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 18719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 19719f82d3987aad4cc9f46d19c35f362672545cadEliot BlennerhassettDebug macros. 20719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 21719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett*****************************************************************************/ 22719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 23719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#ifndef _HPIDEBUG_H 24719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define _HPIDEBUG_H 25719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 26719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#include "hpi_internal.h" 27719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 28719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett/* Define debugging levels. */ 29719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettenum { HPI_DEBUG_LEVEL_ERROR = 0, /* always log errors */ 30719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett HPI_DEBUG_LEVEL_WARNING = 1, 31719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett HPI_DEBUG_LEVEL_NOTICE = 2, 32719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett HPI_DEBUG_LEVEL_INFO = 3, 33719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett HPI_DEBUG_LEVEL_DEBUG = 4, 34719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett HPI_DEBUG_LEVEL_VERBOSE = 5 /* same printk level as DEBUG */ 35719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett}; 36719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 37719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define HPI_DEBUG_LEVEL_DEFAULT HPI_DEBUG_LEVEL_NOTICE 38719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 39719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett/* an OS can define an extra flag string that is appended to 40f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett the start of each message, eg see linux kernel hpios.h */ 41719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 42719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#ifdef SOURCEFILE_NAME 43719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define FILE_LINE SOURCEFILE_NAME ":" __stringify(__LINE__) " " 44719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#else 45719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define FILE_LINE __FILE__ ":" __stringify(__LINE__) " " 46719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#endif 47719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 48719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define HPI_DEBUG_ASSERT(expression) \ 49719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett do { \ 50f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett if (!(expression)) { \ 51f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett printk(KERN_ERR FILE_LINE \ 52f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett "ASSERT " __stringify(expression)); \ 53719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } \ 54719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } while (0) 55719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 56719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define HPI_DEBUG_LOG(level, ...) \ 57719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett do { \ 58719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett if (hpi_debug_level >= HPI_DEBUG_LEVEL_##level) { \ 59719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett printk(HPI_DEBUG_FLAG_##level \ 60719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett FILE_LINE __VA_ARGS__); \ 61719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } \ 62719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } while (0) 63719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 64719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettvoid hpi_debug_init(void); 65719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettint hpi_debug_level_set(int level); 66719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettint hpi_debug_level_get(void); 67719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett/* needed by Linux driver for dynamic debug level changes */ 68719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettextern int hpi_debug_level; 69719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 70719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettvoid hpi_debug_message(struct hpi_message *phm, char *sz_fileline); 71719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 72719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassettvoid hpi_debug_data(u16 *pdata, u32 len); 73719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 74f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett#define HPI_DEBUG_DATA(pdata, len) \ 75f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett do { \ 76719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett if (hpi_debug_level >= HPI_DEBUG_LEVEL_VERBOSE) \ 77719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett hpi_debug_data(pdata, len); \ 78719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } while (0) 79719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 80f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett#define HPI_DEBUG_MESSAGE(level, phm) \ 81f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett do { \ 82f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett if (hpi_debug_level >= HPI_DEBUG_LEVEL_##level) { \ 831528fbb5dcb5089652147bc6b76aa1f15e50c078Eliot Blennerhassett hpi_debug_message(phm, HPI_DEBUG_FLAG_##level \ 84f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett FILE_LINE __stringify(level)); \ 85f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett } \ 86719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } while (0) 87719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 88f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett#define HPI_DEBUG_RESPONSE(phr) \ 89f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett do { \ 901528fbb5dcb5089652147bc6b76aa1f15e50c078Eliot Blennerhassett if (((hpi_debug_level >= HPI_DEBUG_LEVEL_DEBUG) && \ 911528fbb5dcb5089652147bc6b76aa1f15e50c078Eliot Blennerhassett (phr->error)) ||\ 92f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett (hpi_debug_level >= HPI_DEBUG_LEVEL_VERBOSE)) \ 931528fbb5dcb5089652147bc6b76aa1f15e50c078Eliot Blennerhassett printk(KERN_DEBUG "HPI_RES%d,%d,%d\n", \ 94f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett phr->version, phr->error, phr->specific_error); \ 95719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett } while (0) 96719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 97719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#ifndef compile_time_assert 98719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#define compile_time_assert(cond, msg) \ 99719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett typedef char msg[(cond) ? 1 : -1] 100719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett#endif 101719f82d3987aad4cc9f46d19c35f362672545cadEliot Blennerhassett 102f0dcad41ac2956851e6b2d31762d1edc61ede949Eliot Blennerhassett#endif /* _HPIDEBUG_H_ */ 103