third_party/lwip/repo/lwip/src/include/lwip/init.h

   1 /**
   2  * @file
   3  * lwIP initialization API
   4  */
   5
   6 /*
   7  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without modification,
  11  * are permitted provided that the following conditions are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright notice,
  14  *    this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  *    this list of conditions and the following disclaimer in the documentation
  17  *    and/or other materials provided with the distribution.
  18  * 3. The name of the author may not be used to endorse or promote products
  19  *    derived from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  30  * OF SUCH DAMAGE.
  31  *
  32  * This file is part of the lwIP TCP/IP stack.
  33  *
  34  * Author: Adam Dunkels <adam@sics.se>
  35  *
  36  */
  37 #ifndef LWIP_HDR_INIT_H
  38 #define LWIP_HDR_INIT_H
  39
  40 #include "lwip/opt.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /**
  47  * @defgroup lwip_version Version
  48  * @ingroup lwip
  49  * @{
  50  */
  51
  52 /** X.x.x: Major version of the stack */
  53 #define LWIP_VERSION_MAJOR      2
  54 /** x.X.x: Minor version of the stack */
  55 #define LWIP_VERSION_MINOR      0
  56 /** x.x.X: Revision of the stack */
  57 #define LWIP_VERSION_REVISION   3
  58 /** For release candidates, this is set to 1..254
  59   * For official releases, this is set to 255 (LWIP_RC_RELEASE)
  60   * For development versions (Git), this is set to 0 (LWIP_RC_DEVELOPMENT) */
  61 #define LWIP_VERSION_RC         LWIP_RC_RELEASE
  62
  63 /** LWIP_VERSION_RC is set to LWIP_RC_RELEASE for official releases */
  64 #define LWIP_RC_RELEASE         255
  65 /** LWIP_VERSION_RC is set to LWIP_RC_DEVELOPMENT for Git versions */
  66 #define LWIP_RC_DEVELOPMENT     0
  67
  68 #define LWIP_VERSION_IS_RELEASE     (LWIP_VERSION_RC == LWIP_RC_RELEASE)
  69 #define LWIP_VERSION_IS_DEVELOPMENT (LWIP_VERSION_RC == LWIP_RC_DEVELOPMENT)
  70 #define LWIP_VERSION_IS_RC          ((LWIP_VERSION_RC != LWIP_RC_RELEASE) && (LWIP_VERSION_RC != LWIP_RC_DEVELOPMENT))
  71
  72 /* Some helper defines to get a version string */
  73 #define LWIP_VERSTR2(x) #x
  74 #define LWIP_VERSTR(x) LWIP_VERSTR2(x)
  75 #if LWIP_VERSION_IS_RELEASE
  76 #define LWIP_VERSION_STRING_SUFFIX ""
  77 #elif LWIP_VERSION_IS_DEVELOPMENT
  78 #define LWIP_VERSION_STRING_SUFFIX "d"
  79 #else
  80 #define LWIP_VERSION_STRING_SUFFIX "rc" LWIP_VERSTR(LWIP_VERSION_RC)
  81 #endif
  82
  83 /** Provides the version of the stack */
  84 #define LWIP_VERSION   (((u32_t)LWIP_VERSION_MAJOR) << 24   | ((u32_t)LWIP_VERSION_MINOR) << 16 | \
  85                         ((u32_t)LWIP_VERSION_REVISION) << 8 | ((u32_t)LWIP_VERSION_RC))
  86 /** Provides the version of the stack as string */
  87 #define LWIP_VERSION_STRING     LWIP_VERSTR(LWIP_VERSION_MAJOR) "." LWIP_VERSTR(LWIP_VERSION_MINOR) "." LWIP_VERSTR(LWIP_VERSION_REVISION) LWIP_VERSION_STRING_SUFFIX
  88
  89 /**
  90  * @}
  91  */
  92
  93 /* Modules initialization */
  94 void lwip_init(void);
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100 #endif /* LWIP_HDR_INIT_H */