target/linux/generic/files/crypto/ocf/kirkwood/mvHal/common/mvDebug.h

   1 /*******************************************************************************
   2 Copyright (C) Marvell International Ltd. and its affiliates
   3
   4 This software file (the "File") is owned and distributed by Marvell
   5 International Ltd. and/or its affiliates ("Marvell") under the following
   6 alternative licensing terms.  Once you have made an election to distribute the
   7 File under one of the following license alternatives, please (i) delete this
   8 introductory statement regarding license alternatives, (ii) delete the two
   9 license alternatives that you have not elected to use and (iii) preserve the
  10 Marvell copyright notice above.
  11
  12 ********************************************************************************
  13 Marvell Commercial License Option
  14
  15 If you received this File from Marvell and you have entered into a commercial
  16 license agreement (a "Commercial License") with Marvell, the File is licensed
  17 to you under the terms of the applicable Commercial License.
  18
  19 ********************************************************************************
  20 Marvell GPL License Option
  21
  22 If you received this File from Marvell, you may opt to use, redistribute and/or
  23 modify this File in accordance with the terms and conditions of the General
  24 Public License Version 2, June 1991 (the "GPL License"), a copy of which is
  25 available along with the File in the license.txt file or by writing to the Free
  26 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or
  27 on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
  28
  29 THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
  30 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
  31 DISCLAIMED.  The GPL License provides additional details about this warranty
  32 disclaimer.
  33 ********************************************************************************
  34 Marvell BSD License Option
  35
  36 If you received this File from Marvell, you may opt to use, redistribute and/or
  37 modify this File under the following licensing terms.
  38 Redistribution and use in source and binary forms, with or without modification,
  39 are permitted provided that the following conditions are met:
  40
  41     *   Redistributions of source code must retain the above copyright notice,
  42             this list of conditions and the following disclaimer.
  43
  44     *   Redistributions in binary form must reproduce the above copyright
  45         notice, this list of conditions and the following disclaimer in the
  46         documentation and/or other materials provided with the distribution.
  47
  48     *   Neither the name of Marvell nor the names of its contributors may be
  49         used to endorse or promote products derived from this software without
  50         specific prior written permission.
  51
  52 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  53 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  54 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  55 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  56 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  57 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  58 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  59 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  60 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  61 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  62
  63 *******************************************************************************/
  64
  65
  66
  67 #ifndef __INCmvDebugh
  68 #define __INCmvDebugh
  69
  70 /* includes */
  71 #include "mvTypes.h"
  72
  73 typedef enum
  74 {
  75     MV_MODULE_INVALID  = -1,
  76     MV_MODULE_ETH      = 0,
  77     MV_MODULE_IDMA,
  78     MV_MODULE_XOR,
  79     MV_MODULE_TWASI,
  80     MV_MODULE_MGI,
  81     MV_MODULE_USB,
  82     MV_MODULE_CESA,
  83
  84     MV_MODULE_MAX
  85 }MV_MODULE_ID;
  86
  87 /* Define generic flags useful for most of modules */
  88 #define MV_DEBUG_FLAG_ALL   (0)
  89 #define MV_DEBUG_FLAG_INIT  (1 << 0)
  90 #define MV_DEBUG_FLAG_RX    (1 << 1)
  91 #define MV_DEBUG_FLAG_TX    (1 << 2)
  92 #define MV_DEBUG_FLAG_ERR   (1 << 3)
  93 #define MV_DEBUG_FLAG_TRACE (1 << 4)
  94 #define MV_DEBUG_FLAG_DUMP  (1 << 5)
  95 #define MV_DEBUG_FLAG_CACHE (1 << 6)
  96 #define MV_DEBUG_FLAG_IOCTL (1 << 7)
  97 #define MV_DEBUG_FLAG_STATS (1 << 8)
  98
  99 extern MV_U32  mvDebug;
 100 extern MV_U32  mvDebugModules[MV_MODULE_MAX];
 101
 102 #ifdef MV_DEBUG
 103 # define MV_DEBUG_PRINT(module, flags, msg)     mvOsPrintf msg
 104 # define MV_DEBUG_CODE(module, flags, code)     code
 105 #elif defined(MV_RT_DEBUG)
 106 # define MV_DEBUG_PRINT(module, flags, msg)                    \
 107     if( (mvDebug & (1<<(module))) &&                           \
 108         ((mvDebugModules[(module)] & (flags)) == (flags)) )    \
 109         mvOsPrintf msg
 110 # define MV_DEBUG_CODE(module, flags, code)                    \
 111     if( (mvDebug & (1<<(module))) &&                           \
 112         ((mvDebugModules[(module)] & (flags)) == (flags)) )    \
 113         code
 114 #else
 115 # define MV_DEBUG_PRINT(module, flags, msg)
 116 # define MV_DEBUG_CODE(module, flags, code)
 117 #endif
 118
 119
 120
 121 /* typedefs */
 122
 123 /*  time measurement structure used to check how much time pass between
 124  *  two points
 125  */
 126 typedef struct {
 127     char            name[20];   /* name of the entry */
 128     unsigned long   begin;      /* time measured on begin point */
 129     unsigned long   end;        /* time measured on end point */
 130     unsigned long   total;      /* Accumulated time */
 131     unsigned long   left;       /* The rest measurement actions */
 132     unsigned long   count;      /* Maximum measurement actions */
 133     unsigned long   min;        /* Minimum time from begin to end */
 134     unsigned long   max;        /* Maximum time from begin to end */
 135 } MV_DEBUG_TIMES;
 136
 137
 138 /* mvDebug.h API list */
 139
 140 /****** Error Recording ******/
 141
 142 /* Dump memory in specific format:
 143  * address: X1X1X1X1 X2X2X2X2 ... X8X8X8X8
 144  */
 145 void mvDebugMemDump(void* addr, int size, int access);
 146
 147 void mvDebugPrintBufInfo(BUF_INFO* pBufInfo, int size, int access);
 148
 149 void mvDebugPrintPktInfo(MV_PKT_INFO* pPktInfo, int size, int access);
 150
 151 void    mvDebugPrintIpAddr(MV_U32 ipAddr);
 152
 153 void mvDebugPrintMacAddr(const MV_U8* pMacAddr);
 154
 155 /**** There are three functions deals with MV_DEBUG_TIMES structure ****/
 156
 157 /* Reset MV_DEBUG_TIMES entry */
 158 void mvDebugResetTimeEntry(MV_DEBUG_TIMES* pTimeEntry, int count, char* name);
 159
 160 /* Update MV_DEBUG_TIMES entry */
 161 void mvDebugUpdateTimeEntry(MV_DEBUG_TIMES* pTimeEntry);
 162
 163 /* Print out MV_DEBUG_TIMES entry */
 164 void mvDebugPrintTimeEntry(MV_DEBUG_TIMES* pTimeEntry, MV_BOOL isTitle);
 165
 166
 167 /******** General ***********/
 168
 169 /* Change value of mvDebugPrint global variable */
 170
 171 void    mvDebugInit(void);
 172 void    mvDebugModuleEnable(MV_MODULE_ID module, MV_BOOL isEnable);
 173 void    mvDebugModuleSetFlags(MV_MODULE_ID module, MV_U32 flags);
 174 void    mvDebugModuleClearFlags(MV_MODULE_ID module, MV_U32 flags);
 175
 176
 177 #endif /* __INCmvDebug.h */
 178