cbcd8d72965e4fdc273c05eadb5b83fe6bceb9be
1 /*******************************
2 * file: hplib_ver.h
3 * purpose: hplib version information
4 **************************************************************
5 * @file hplib_ver.h
6 *
7 * @brief DESCRIPTION: hplib 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.
42 ******************************/
44 #ifndef __HPLIB_VER__
45 #define __HPLIB_VER__
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
52 /**
53 * @def HPLIB_VERSION_ID
54 * This is the HPLIB Version. Versions numbers are encoded in the following
55 * format:
56 * 0xAABBCCDD -> Arch (AA); API Changes (BB); Major (CC); Minor (DD)
57 */
58 #define HPLIB_VERSION_ID (0x01010003)
60 /**
61 * @def HPLIB_VERSION_STR
62 * This is the version string which describes the HPLIB along with the
63 * date and build information.
64 */
65 #define HPLIB_VERSION_STR "HPLIB Revision: 01.01.00.03"
67 /**
68 * @ingroup hplib_gen_functions
69 * @brief hplib_mGetVersion API used to get version of HPLIB
70 *
71 * @details This API used to get version of hplib
72 * @retval int version of hplib
73 */
74 static inline int hplib_getVersion(void)
75 {
76 return HPLIB_VERSION_ID;
77 }
79 /**
80 * @ingroup hplib_gen_functions
81 * @brief hplib_mGetVersionString API used to get version string of HPLIB
82 *
83 * @details This API used to get version string of hplib
84 * @retval char version string of hplib
85 */
86 static inline char * hplib_getVersionString(void) { return HPLIB_VERSION_STR;}
88 #ifdef __cplusplus
89 }
90 #endif
93 #endif