|
| 1 | +/* |
| 2 | + * The MIT License (MIT) |
| 3 | + * |
| 4 | + * Copyright (c) 2024 Eric Gionet ([email protected]) |
| 5 | + * |
| 6 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | + * of this software and associated documentation files (the "Software"), to deal |
| 8 | + * in the Software without restriction, including without limitation the rights |
| 9 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + * copies of the Software, and to permit persons to whom the Software is |
| 11 | + * furnished to do so, subject to the following conditions: |
| 12 | + * The above copyright notice and this permission notice shall be included in all |
| 13 | + * copies or substantial portions of the Software. |
| 14 | + * |
| 15 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 16 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 17 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 18 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 19 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 20 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 21 | + * SOFTWARE. |
| 22 | + */ |
| 23 | + |
| 24 | +/** |
| 25 | + * @file time_into_interval_version.h |
| 26 | + * @defgroup schedule |
| 27 | + * @{ |
| 28 | + * |
| 29 | + * |
| 30 | + * Copyright (c) 2024 Eric Gionet ([email protected]) |
| 31 | + * |
| 32 | + * MIT Licensed as described in the file LICENSE |
| 33 | + */ |
| 34 | +#ifndef __TIME_INTO_INTERVAL_VERSION_H__ |
| 35 | +#define __TIME_INTO_INTERVAL_VERSION_H__ |
| 36 | + |
| 37 | +#include <stdint.h> |
| 38 | + |
| 39 | +#ifdef __cplusplus |
| 40 | +extern "C" { |
| 41 | +#endif |
| 42 | + |
| 43 | +/** |
| 44 | + * public constant definitions |
| 45 | + */ |
| 46 | + |
| 47 | +/** Major version number (X.x.x) */ |
| 48 | +#define TIME_INTO_INTERVAL_FW_VERSION_MAJOR 1 |
| 49 | +/** Minor version number (x.X.x) */ |
| 50 | +#define TIME_INTO_INTERVAL_FW_VERSION_MINOR 1 |
| 51 | +/** Patch version number (x.x.X) */ |
| 52 | +#define TIME_INTO_INTERVAL_FW_VERSION_PATCH 0 |
| 53 | + |
| 54 | + |
| 55 | +/** |
| 56 | + * public macro definitions |
| 57 | + */ |
| 58 | + |
| 59 | +/** |
| 60 | + * Macro to print x parameter as a string i.e. enclose x in double quotes. |
| 61 | + */ |
| 62 | +#define STR_QUOTES( x ) #x |
| 63 | + |
| 64 | +/** |
| 65 | + * Macro to create a string of x parameter with all macros fully expanded. |
| 66 | + */ |
| 67 | +#define STR( x ) STR_QUOTES( x ) |
| 68 | + |
| 69 | +/** |
| 70 | + * Macro to generate current firmware version numbers (major, minor, patch) into a string that is formatted as X.X.X (e.g. 4.0.0). |
| 71 | + */ |
| 72 | +#define TIME_INTO_INTERVAL_FW_VERSION_STR \ |
| 73 | + STR( TIME_INTO_INTERVAL_FW_VERSION_MAJOR ) "." \ |
| 74 | + STR( TIME_INTO_INTERVAL_FW_VERSION_MINOR ) "." \ |
| 75 | + STR( TIME_INTO_INTERVAL_FW_VERSION_PATCH ) |
| 76 | + |
| 77 | +/** |
| 78 | + * Macro to convert firmware version parameters (major, minor, patch numbers) into an integer (`int32_t`) |
| 79 | + * value that can be used for comparison purposes. |
| 80 | + * |
| 81 | + * As an example, [COMPONENT]_FW_VERSION_INT32 >= [COMPONENT]_FW_VERSION_PARAMS_INT32(4, 0, 0). |
| 82 | + */ |
| 83 | +#define TIME_INTO_INTERVAL_FW_VERSION_PARAMS_INT32( major, minor, patch ) \ |
| 84 | + ((major << 16) | (minor << 8) | (patch)) |
| 85 | + |
| 86 | +/** |
| 87 | + * Macro to generate current firmware version numbers (major, minor, patch) as an integer (`int32_t`) value that can |
| 88 | + * be used for comparison purposes. |
| 89 | + * |
| 90 | + * As an example, [COMPONENT]_FW_VERSION_INT32 >= [COMPONENT]_FW_VERSION_PARAMS_INT32(4, 0, 0). |
| 91 | + */ |
| 92 | +#define TIME_INTO_INTERVAL_FW_VERSION_INT32 \ |
| 93 | + TIME_INTO_INTERVAL_FW_VERSION_PARAMS_INT32(TIME_INTO_INTERVAL_FW_VERSION_MAJOR, \ |
| 94 | + TIME_INTO_INTERVAL_FW_VERSION_MINOR, \ |
| 95 | + TIME_INTO_INTERVAL_FW_VERSION_PATCH) |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +#ifdef __cplusplus |
| 102 | +} |
| 103 | +#endif |
| 104 | + |
| 105 | +/**@}*/ |
| 106 | + |
| 107 | +#endif // __TIME_INTO_INTERVAL_VERSION_H__ |
0 commit comments