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 "lwip/arch.h"
36
37/** lower two bits indicate debug level
38 * - 0 off
39 * - 1 warning
40 * - 2 serious
41 * - 3 severe
42 */
43#define LWIP_DBG_LEVEL_OFF     0x00
44#define LWIP_DBG_LEVEL_WARNING 0x01     /* bad checksums, dropped packets, ... */
45#define LWIP_DBG_LEVEL_SERIOUS 0x02     /* memory allocation failures, ... */
46#define LWIP_DBG_LEVEL_SEVERE  0x03
47#define LWIP_DBG_MASK_LEVEL    0x03
48
49/** flag for LWIP_DEBUGF to enable that debug message */
50#define LWIP_DBG_ON            0x80U
51/** flag for LWIP_DEBUGF to disable that debug message */
52#define LWIP_DBG_OFF           0x00U
53
54/** flag for LWIP_DEBUGF indicating a tracing message (to follow program flow) */
55#define LWIP_DBG_TRACE         0x40U
56/** flag for LWIP_DEBUGF indicating a state debug message (to follow module states) */
57#define LWIP_DBG_STATE         0x20U
58/** flag for LWIP_DEBUGF indicating newly added code, not thoroughly tested yet */
59#define LWIP_DBG_FRESH         0x10U
60/** flag for LWIP_DEBUGF to halt after printing this debug message */
61#define LWIP_DBG_HALT          0x08U
62
63#ifndef LWIP_NOASSERT
64#define LWIP_ASSERT(message, assertion) do { if(!(assertion)) \
65  LWIP_PLATFORM_ASSERT(message); } while(0)
66#else                           /* LWIP_NOASSERT */
67#define LWIP_ASSERT(message, assertion)
68#endif                          /* LWIP_NOASSERT */
69
70/** if "expression" isn't true, then print "message" and execute "handler" expression */
71#ifndef LWIP_ERROR
72#define LWIP_ERROR(message, expression, handler) do { if (!(expression)) { \
73  LWIP_PLATFORM_ASSERT(message); handler;}} while(0)
74#endif                          /* LWIP_ERROR */
75
76//#define LWIP_DEBUG 1
77#ifdef LWIP_DEBUG
78/** print debug message only if debug message type is enabled...
79 *  AND is of correct type AND is at least LWIP_DBG_LEVEL
80 */
81
82/*
83#define LWIP_DEBUGF(debug, message) do { \
84                                 LWIP_PLATFORM_DIAG(message); \
85                                } while(0)
86
87#else                          // LWIP_DEBUG
88#define LWIP_DEBUGF(debug, message)
89#endif                          // LWIP_DEBUG
90*/
91
92#define LWIP_DEBUGF(debug, message) do { \
93                               if ( \
94                                   ((debug) & LWIP_DBG_ON) && \
95                                   ((debug) & LWIP_DBG_TYPES_ON) && \
96                                   ((s16_t)((debug) & LWIP_DBG_MASK_LEVEL) >= LWIP_DBG_MIN_LEVEL)) { \
97                                 LWIP_PLATFORM_DIAG(message); \
98                                 if ((debug) & LWIP_DBG_HALT) { \
99                                   while(1); \
100                                 } \
101                               } \
102                             } while(0)
103
104#else                          // LWIP_DEBUG
105#define LWIP_DEBUGF(debug, message)
106#endif                          // LWIP_DEBUG
107
108#endif                          /* __LWIP_DEBUG_H__ */
109