FreeRTOS/Common/ethernet/lwIP/include/lwip/debug.h

   1 /*
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without modification,
   6  * are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25  * OF SUCH DAMAGE.
  26  *
  27  * This file is part of the lwIP TCP/IP stack.
  28  *
  29  * Author: Adam Dunkels <adam@sics.se>
  30  *
  31  */
  32 #ifndef __LWIP_DEBUG_H__
  33 #define __LWIP_DEBUG_H__
  34
  35 #include "arch/cc.h"
  36
  37 /** lower two bits indicate debug level
  38  * - 0 off
  39  * - 1 warning
  40  * - 2 serious
  41  * - 3 severe
  42  */
  43
  44 #define DBG_LEVEL_OFF     0
  45 #define DBG_LEVEL_WARNING 1  /* bad checksums, dropped packets, ... */
  46 #define DBG_LEVEL_SERIOUS 2  /* memory allocation failures, ... */
  47 #define DBG_LEVEL_SEVERE  3  /* */
  48 #define DBG_MASK_LEVEL    3
  49
  50 /** flag for LWIP_DEBUGF to enable that debug message */
  51 #define DBG_ON  0x80U
  52 /** flag for LWIP_DEBUGF to disable that debug message */
  53 #define DBG_OFF 0x00U
  54
  55 /** flag for LWIP_DEBUGF indicating a tracing message (to follow program flow) */
  56 #define DBG_TRACE   0x40U
  57 /** flag for LWIP_DEBUGF indicating a state debug message (to follow module states) */
  58 #define DBG_STATE   0x20U
  59 /** flag for LWIP_DEBUGF indicating newly added code, not thoroughly tested yet */
  60 #define DBG_FRESH   0x10U
  61 /** flag for LWIP_DEBUGF to halt after printing this debug message */
  62 #define DBG_HALT    0x08U
  63
  64 #ifndef LWIP_NOASSERT
  65 #  define LWIP_ASSERT(x,y) do { if(!(y)) LWIP_PLATFORM_ASSERT(x); } while(0)
  66 #else
  67 #  define LWIP_ASSERT(x,y)
  68 #endif
  69
  70 #ifdef LWIP_DEBUG
  71 /** print debug message only if debug message type is enabled...
  72  *  AND is of correct type AND is at least DBG_LEVEL
  73  */
  74 #  define LWIP_DEBUGF(debug,x) do { if (((debug) & DBG_ON) && ((debug) & DBG_TYPES_ON) && ((s16_t)((debug) & DBG_MASK_LEVEL) >= DBG_MIN_LEVEL)) { LWIP_PLATFORM_DIAG(x); if ((debug) & DBG_HALT) while(1); } } while(0)
  75 #  define LWIP_ERROR(x)   do { LWIP_PLATFORM_DIAG(x); } while(0)
  76 #else /* LWIP_DEBUG */
  77 #  define LWIP_DEBUGF(debug,x)
  78 #  define LWIP_ERROR(x)
  79 #endif /* LWIP_DEBUG */
  80
  81 #endif /* __LWIP_DEBUG_H__ */
  82
  83
  84
  85
  86
  87