git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/ethernet/lwIP_130/src/include/lwip/debug.h

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