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         do {\
 109                 if (\
 110                         (comp & pDM_Odm->DebugComponents) &&\
 111                         (level <= pDM_Odm->DebugLevel ||\
 112                          level == ODM_DBG_SERIOUS)\
 113                 ) {\
 114                         RT_PRINTK fmt;\
 115                 } \
 116         } while (0)
 117
 118 #define ODM_RT_TRACE_F(pDM_Odm, comp, level, fmt)\
 119         do {\
 120                 if (\
 121                         (comp & pDM_Odm->DebugComponents) &&\
 122                         (level <= pDM_Odm->DebugLevel)\
 123                 ) {\
 124                         RT_PRINTK fmt;\
 125                 } \
 126         } while (0)
 127
 128 #define ODM_RT_ASSERT(pDM_Odm, expr, fmt)\
 129         do {\
 130                 if (!expr) {\
 131                         DbgPrint("Assertion failed! %s at ......\n", #expr);\
 132                         DbgPrint(\
 133                                 "      ......%s,%s, line =%d\n",\
 134                                 __FILE__,\
 135                                 __func__,\
 136                                 __LINE__\
 137                         );\
 138                         RT_PRINTK fmt;\
 139                         ASSERT(false);\
 140                 } \
 141         } while (0)
 142 #define ODM_dbg_enter() { DbgPrint("==> %s\n", __func__); }
 143 #define ODM_dbg_exit() { DbgPrint("<== %s\n", __func__); }
 144 #define ODM_dbg_trace(str) { DbgPrint("%s:%s\n", __func__, str); }
 145
 146 #define ODM_PRINT_ADDR(pDM_Odm, comp, level, title_str, ptr)\
 147         do {\
 148                 if (\
 149                         (comp & pDM_Odm->DebugComponents) &&\
 150                         (level <= pDM_Odm->DebugLevel)\
 151                 ) {\
 152                         int __i;\
 153                         u8 *__ptr = (u8 *)ptr;\
 154                         DbgPrint("[ODM] ");\
 155                         DbgPrint(title_str);\
 156                         DbgPrint(" ");\
 157                         for (__i = 0; __i < 6; __i++)\
 158                                 DbgPrint("%02X%s", __ptr[__i], (__i == 5) ? "" : "-");\
 159                         DbgPrint("\n");\
 160                 } \
 161         } while (0)
 162 #else
 163 #define ODM_RT_TRACE(pDM_Odm, comp, level, fmt)         no_printk fmt
 164 #define ODM_RT_TRACE_F(pDM_Odm, comp, level, fmt)       no_printk fmt
 165 #define ODM_RT_ASSERT(pDM_Odm, expr, fmt)               no_printk fmt
 166 #define ODM_dbg_enter()                                 do {} while (0)
 167 #define ODM_dbg_exit()                                  do {} while (0)
 168 #define ODM_dbg_trace(str)                              no_printk("%s", str)
 169 #define ODM_PRINT_ADDR(pDM_Odm, comp, level, title_str, ptr) \
 170         no_printk("%s %p", title_str, ptr)
 171 #endif
 172
 173 void ODM_InitDebugSetting(PDM_ODM_T pDM_Odm);
 174
 175 #endif  /*  __ODM_DBG_H__ */