ti/runtime/netapi/netapi_ver.h

   1 /*******************************
   2  * file: netapi_ver.h
   3  * purpose: netapi version information
   4  **************************************************************
   5  * @file netapi.h
   6  *
   7  * @brief DESCRIPTION:  netapi version information for user space transport
   8  *               library
   9  *
  10  * REVISION HISTORY:
  11  *
  12  *  Copyright (c) Texas Instruments Incorporated 2013
  13  *
  14  *  Redistribution and use in source and binary forms, with or without
  15  *  modification, are permitted provided that the following conditions
  16  *  are met:
  17  *
  18  *    Redistributions of source code must retain the above copyright
  19  *    notice, this list of conditions and the following disclaimer.
  20  *
  21  *    Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the
  24  *    distribution.
  25  *
  26  *    Neither the name of Texas Instruments Incorporated nor the names of
  27  *    its contributors may be used to endorse or promote products derived
  28  *    from this software without specific prior written permission.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  31  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  32  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  33  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  34  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  36  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  37  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  38  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  39  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  40  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  41
  42  ******************************/
  43
  44 #ifndef __NETAPI_ERR__
  45 #define __NETAPI_ERR__
  46 /**
  47  * @def NETAPI_VERSION_ID
  48  *      This is the NETAPI Version. Versions numbers are encoded in the following
  49  *      format:
  50  *              0xAABBCCDD -> Arch (AA); API Changes (BB); Major (CC); Minor (DD)
  51  */
  52 #define NETAPI_VERSION_ID                   (0x01000007)
  53
  54 /**
  55  * @def NETAPI_VERSION_STR
  56  *      This is the version string which describes the NETAPI along with the
  57  *      date and build information.
  58  */
  59 #define NETAPI_VERSION_STR      "NETAPI Revision: 01.00.00.07"
  60
  61 /**
  62  *  @ingroup netapi_gen_functions
  63  *  @brief netapi_mGetVersion  API used to get version of NETAPI
  64  *
  65  *  @details This  API used to get version of netapi
  66  *  @retval     int version of netapi
  67  *  @pre        @ref netapi_init
  68  */
  69 static inline int netapi_getVersion(void)
  70 {
  71 return NETAPI_VERSION_ID;
  72 }
  73
  74 /**
  75  *  @ingroup netapi_gen_functions
  76  *  @brief netapi_mGetVersionString  API used to get version string of NETAPI
  77  *
  78  *  @details This  API used to get version string of netapi
  79  *  @retval     char version string of netapi
  80  *  @pre        @ref netapi_init
  81  */
  82 static inline char * netapi_getVersionString(void) { return NETAPI_VERSION_STR;}
  83 #endif