drivers/staging/rtl8723bs/hal/odm_debug.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12  * more details.
  13  *
  14  ******************************************************************************/
  15
  16 #ifndef __ODM_DBG_H__
  17 #define __ODM_DBG_H__
  18
  19
  20 /*  */
  21 /* Define the debug levels */
  22 /*  */
  23 /* 1.   DBG_TRACE and DBG_LOUD are used for normal cases. */
  24 /* So that, they can help SW engineer to develope or trace states changed */
  25 /* and also help HW enginner to trace every operation to and from HW, */
  26 /* e.g IO, Tx, Rx. */
  27 /*  */
  28 /* 2.   DBG_WARNNING and DBG_SERIOUS are used for unusual or error cases, */
  29 /* which help us to debug SW or HW. */
  30 /*  */
  31 /*  */
  32 /*  */
  33 /* Never used in a call to ODM_RT_TRACE()! */
  34 /*  */
  35 #define ODM_DBG_OFF                                     1
  36
  37 /*  */
  38 /* Fatal bug. */
  39 /* For example, Tx/Rx/IO locked up, OS hangs, memory access violation, */
  40 /* resource allocation failed, unexpected HW behavior, HW BUG and so on. */
  41 /*  */
  42 #define ODM_DBG_SERIOUS                         2
  43
  44 /*  */
  45 /* Abnormal, rare, or unexpeted cases. */
  46 /* For example, */
  47 /* IRP/Packet/OID canceled, */
  48 /* device suprisely unremoved and so on. */
  49 /*  */
  50 #define ODM_DBG_WARNING                         3
  51
  52 /*  */
  53 /* Normal case with useful information about current SW or HW state. */
  54 /* For example, Tx/Rx descriptor to fill, Tx/Rx descriptor completed status, */
  55 /* SW protocol state change, dynamic mechanism state change and so on. */
  56 /*  */
  57 #define ODM_DBG_LOUD                            4
  58
  59 /*  */
  60 /* Normal case with detail execution flow or information. */
  61 /*  */
  62 #define ODM_DBG_TRACE                           5
  63
  64 /*  */
  65 /*  Define the tracing components */
  66 /*  */
  67 /*  */
  68 /* BB Functions */
  69 #define ODM_COMP_DIG                            BIT0
  70 #define ODM_COMP_RA_MASK                        BIT1
  71 #define ODM_COMP_DYNAMIC_TXPWR          BIT2
  72 #define ODM_COMP_FA_CNT                         BIT3
  73 #define ODM_COMP_RSSI_MONITOR           BIT4
  74 #define ODM_COMP_CCK_PD                         BIT5
  75 #define ODM_COMP_ANT_DIV                        BIT6
  76 #define ODM_COMP_PWR_SAVE                       BIT7
  77 #define ODM_COMP_PWR_TRAIN                      BIT8
  78 #define ODM_COMP_RATE_ADAPTIVE          BIT9
  79 #define ODM_COMP_PATH_DIV                       BIT10
  80 #define ODM_COMP_PSD                            BIT11
  81 #define ODM_COMP_DYNAMIC_PRICCA         BIT12
  82 #define ODM_COMP_RXHP                           BIT13
  83 #define ODM_COMP_MP                                     BIT14
  84 #define ODM_COMP_CFO_TRACKING           BIT15
  85 /* MAC Functions */
  86 #define ODM_COMP_EDCA_TURBO                     BIT16
  87 #define ODM_COMP_EARLY_MODE                     BIT17
  88 /* RF Functions */
  89 #define ODM_COMP_TX_PWR_TRACK           BIT24
  90 #define ODM_COMP_RX_GAIN_TRACK          BIT25
  91 #define ODM_COMP_CALIBRATION            BIT26
  92 /* Common Functions */
  93 #define ODM_COMP_COMMON                         BIT30
  94 #define ODM_COMP_INIT                           BIT31
  95
  96 /*------------------------Export Marco Definition---------------------------*/
  97         #define DbgPrint printk
  98         #define RT_PRINTK(fmt, args...)\
  99                 DbgPrint("%s(): " fmt, __func__, ## args)
 100         #define RT_DISP(dbgtype, dbgflag, printstr)
 101
 102 #ifndef ASSERT
 103         #define ASSERT(expr)
 104 #endif
 105
 106 #if DBG
 107 #define ODM_RT_TRACE(pDM_Odm, comp, level, fmt)\
 108         if (\
 109                 (comp & pDM_Odm->DebugComponents) &&\
 110                 (level <= pDM_Odm->DebugLevel || level == ODM_DBG_SERIOUS)\
 111         ) {\
 112                 RT_PRINTK fmt;\
 113         }
 114
 115 #define ODM_RT_TRACE_F(pDM_Odm, comp, level, fmt)\
 116         if (\
 117                 (comp & pDM_Odm->DebugComponents) &&\
 118                 (level <= pDM_Odm->DebugLevel)\
 119         ) {\
 120                 RT_PRINTK fmt;\
 121         }
 122
 123 #define ODM_RT_ASSERT(pDM_Odm, expr, fmt)\
 124         if (!expr) {\
 125                 DbgPrint("Assertion failed! %s at ......\n", #expr);\
 126                 DbgPrint(\
 127                         "      ......%s,%s, line =%d\n",\
 128                         __FILE__,\
 129                         __func__,\
 130                         __LINE__\
 131                 );\
 132                 RT_PRINTK fmt;\
 133                 ASSERT(false);\
 134         }
 135 #define ODM_dbg_enter() { DbgPrint("==> %s\n", __func__); }
 136 #define ODM_dbg_exit() { DbgPrint("<== %s\n", __func__); }
 137 #define ODM_dbg_trace(str) { DbgPrint("%s:%s\n", __func__, str); }
 138
 139 #define ODM_PRINT_ADDR(pDM_Odm, comp, level, title_str, ptr)\
 140         if (\
 141                 (comp & pDM_Odm->DebugComponents) &&\
 142                 (level <= pDM_Odm->DebugLevel)\
 143         ) {\
 144                 int __i;\
 145                 u8 *__ptr = (u8 *)ptr;\
 146                 DbgPrint("[ODM] ");\
 147                 DbgPrint(title_str);\
 148                 DbgPrint(" ");\
 149                 for (__i = 0; __i < 6; __i++)\
 150                         DbgPrint("%02X%s", __ptr[__i], (__i == 5) ? "" : "-");\
 151                 DbgPrint("\n");\
 152         }
 153 #else
 154 #define ODM_RT_TRACE(pDM_Odm, comp, level, fmt)
 155 #define ODM_RT_TRACE_F(pDM_Odm, comp, level, fmt)
 156 #define ODM_RT_ASSERT(pDM_Odm, expr, fmt)
 157 #define ODM_dbg_enter()
 158 #define ODM_dbg_exit()
 159 #define ODM_dbg_trace(str)
 160 #define ODM_PRINT_ADDR(pDM_Odm, comp, level, title_str, ptr)
 161 #endif
 162
 163 void ODM_InitDebugSetting(PDM_ODM_T pDM_Odm);
 164
 165 #endif  /*  __ODM_DBG_H__ */