mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_WALLBOT_BLE/TOOLCHAIN_GCC_ARM/app_util.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
AnnaBridge 156:ff21514d8981 2 *
AnnaBridge 156:ff21514d8981 3 * The information contained herein is property of Nordic Semiconductor ASA.
AnnaBridge 156:ff21514d8981 4 * Terms and conditions of usage are described in detail in NORDIC
AnnaBridge 156:ff21514d8981 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
AnnaBridge 156:ff21514d8981 6 *
AnnaBridge 156:ff21514d8981 7 * Licensees are granted free, non-transferable use of the information. NO
AnnaBridge 156:ff21514d8981 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
AnnaBridge 156:ff21514d8981 9 * the file.
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 */
AnnaBridge 156:ff21514d8981 12
AnnaBridge 156:ff21514d8981 13 /** @file
AnnaBridge 156:ff21514d8981 14 *
AnnaBridge 156:ff21514d8981 15 * @defgroup app_util Utility Functions and Definitions
AnnaBridge 156:ff21514d8981 16 * @{
AnnaBridge 156:ff21514d8981 17 * @ingroup app_common
AnnaBridge 156:ff21514d8981 18 *
AnnaBridge 156:ff21514d8981 19 * @brief Various types and definitions available to all applications.
AnnaBridge 156:ff21514d8981 20 */
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #ifndef APP_UTIL_H__
AnnaBridge 156:ff21514d8981 23 #define APP_UTIL_H__
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 #include <stdint.h>
AnnaBridge 156:ff21514d8981 26 #include <stdbool.h>
AnnaBridge 156:ff21514d8981 27 #include "compiler_abstraction.h"
AnnaBridge 156:ff21514d8981 28
AnnaBridge 156:ff21514d8981 29 enum
AnnaBridge 156:ff21514d8981 30 {
AnnaBridge 156:ff21514d8981 31 UNIT_0_625_MS = 625, /**< Number of microseconds in 0.625 milliseconds. */
AnnaBridge 156:ff21514d8981 32 UNIT_1_25_MS = 1250, /**< Number of microseconds in 1.25 milliseconds. */
AnnaBridge 156:ff21514d8981 33 UNIT_10_MS = 10000 /**< Number of microseconds in 10 milliseconds. */
AnnaBridge 156:ff21514d8981 34 };
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 /**@brief Macro for doing static (i.e. compile time) assertion.
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * @note If the assertion fails when compiling using Keil, the compiler will report error message
AnnaBridge 156:ff21514d8981 39 * "error: #94: the size of an array must be greater than zero" (while gcc will list the
AnnaBridge 156:ff21514d8981 40 * symbol static_assert_failed, making the error message more readable).
AnnaBridge 156:ff21514d8981 41 * If the supplied expression can not be evaluated at compile time, Keil will report
AnnaBridge 156:ff21514d8981 42 * "error: #28: expression must have a constant value".
AnnaBridge 156:ff21514d8981 43 *
AnnaBridge 156:ff21514d8981 44 * @note The macro is intentionally implemented not using do while(0), allowing it to be used
AnnaBridge 156:ff21514d8981 45 * outside function blocks (e.g. close to global type- and variable declarations).
AnnaBridge 156:ff21514d8981 46 * If used in a code block, it must be used before any executable code in this block.
AnnaBridge 156:ff21514d8981 47 *
AnnaBridge 156:ff21514d8981 48 * @param[in] EXPR Constant expression to be verified.
AnnaBridge 156:ff21514d8981 49 */
AnnaBridge 156:ff21514d8981 50
AnnaBridge 156:ff21514d8981 51 #if defined(__GNUC__)
AnnaBridge 156:ff21514d8981 52 #define STATIC_ASSERT(EXPR) typedef char __attribute__((unused)) static_assert_failed[(EXPR) ? 1 : -1]
AnnaBridge 156:ff21514d8981 53 #elif defined(__ICCARM__)
AnnaBridge 156:ff21514d8981 54 #define STATIC_ASSERT(EXPR) extern char static_assert_failed[(EXPR) ? 1 : -1]
AnnaBridge 156:ff21514d8981 55 #else
AnnaBridge 156:ff21514d8981 56 #define STATIC_ASSERT(EXPR) typedef char static_assert_failed[(EXPR) ? 1 : -1]
AnnaBridge 156:ff21514d8981 57 #endif
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 /**@brief type for holding an encoded (i.e. little endian) 16 bit unsigned integer. */
AnnaBridge 156:ff21514d8981 61 typedef uint8_t uint16_le_t[2];
AnnaBridge 156:ff21514d8981 62
AnnaBridge 156:ff21514d8981 63 /**@brief type for holding an encoded (i.e. little endian) 32 bit unsigned integer. */
AnnaBridge 156:ff21514d8981 64 typedef uint8_t uint32_le_t[4];
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 /**@brief Byte array type. */
AnnaBridge 156:ff21514d8981 67 typedef struct
AnnaBridge 156:ff21514d8981 68 {
AnnaBridge 156:ff21514d8981 69 uint16_t size; /**< Number of array entries. */
AnnaBridge 156:ff21514d8981 70 uint8_t * p_data; /**< Pointer to array entries. */
AnnaBridge 156:ff21514d8981 71 } uint8_array_t;
AnnaBridge 156:ff21514d8981 72
AnnaBridge 156:ff21514d8981 73 /**@brief Perform rounded integer division (as opposed to truncating the result).
AnnaBridge 156:ff21514d8981 74 *
AnnaBridge 156:ff21514d8981 75 * @param[in] A Numerator.
AnnaBridge 156:ff21514d8981 76 * @param[in] B Denominator.
AnnaBridge 156:ff21514d8981 77 *
AnnaBridge 156:ff21514d8981 78 * @return Rounded (integer) result of dividing A by B.
AnnaBridge 156:ff21514d8981 79 */
AnnaBridge 156:ff21514d8981 80 #define ROUNDED_DIV(A, B) (((A) + ((B) / 2)) / (B))
AnnaBridge 156:ff21514d8981 81
AnnaBridge 156:ff21514d8981 82 /**@brief Check if the integer provided is a power of two.
AnnaBridge 156:ff21514d8981 83 *
AnnaBridge 156:ff21514d8981 84 * @param[in] A Number to be tested.
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 156:ff21514d8981 86 * @return true if value is power of two.
AnnaBridge 156:ff21514d8981 87 * @return false if value not power of two.
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 #define IS_POWER_OF_TWO(A) ( ((A) != 0) && ((((A) - 1) & (A)) == 0) )
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /**@brief To convert milliseconds to ticks.
AnnaBridge 156:ff21514d8981 92 * @param[in] TIME Number of milliseconds to convert.
AnnaBridge 156:ff21514d8981 93 * @param[in] RESOLUTION Unit to be converted to in [us/ticks].
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95 #define MSEC_TO_UNITS(TIME, RESOLUTION) (((TIME) * 1000) / (RESOLUTION))
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97
AnnaBridge 156:ff21514d8981 98 /**@brief Perform integer division, making sure the result is rounded up.
AnnaBridge 156:ff21514d8981 99 *
AnnaBridge 156:ff21514d8981 100 * @details One typical use for this is to compute the number of objects with size B is needed to
AnnaBridge 156:ff21514d8981 101 * hold A number of bytes.
AnnaBridge 156:ff21514d8981 102 *
AnnaBridge 156:ff21514d8981 103 * @param[in] A Numerator.
AnnaBridge 156:ff21514d8981 104 * @param[in] B Denominator.
AnnaBridge 156:ff21514d8981 105 *
AnnaBridge 156:ff21514d8981 106 * @return Integer result of dividing A by B, rounded up.
AnnaBridge 156:ff21514d8981 107 */
AnnaBridge 156:ff21514d8981 108 #define CEIL_DIV(A, B) \
AnnaBridge 156:ff21514d8981 109 /*lint -save -e573 */ \
AnnaBridge 156:ff21514d8981 110 ((((A) - 1) / (B)) + 1) \
AnnaBridge 156:ff21514d8981 111 /*lint -restore */
AnnaBridge 156:ff21514d8981 112
AnnaBridge 156:ff21514d8981 113 /**@brief Function for encoding a uint16 value.
AnnaBridge 156:ff21514d8981 114 *
AnnaBridge 156:ff21514d8981 115 * @param[in] value Value to be encoded.
AnnaBridge 156:ff21514d8981 116 * @param[out] p_encoded_data Buffer where the encoded data is to be written.
AnnaBridge 156:ff21514d8981 117 *
AnnaBridge 156:ff21514d8981 118 * @return Number of bytes written.
AnnaBridge 156:ff21514d8981 119 */
AnnaBridge 156:ff21514d8981 120 static __INLINE uint8_t uint16_encode(uint16_t value, uint8_t * p_encoded_data)
AnnaBridge 156:ff21514d8981 121 {
AnnaBridge 156:ff21514d8981 122 p_encoded_data[0] = (uint8_t) ((value & 0x00FF) >> 0);
AnnaBridge 156:ff21514d8981 123 p_encoded_data[1] = (uint8_t) ((value & 0xFF00) >> 8);
AnnaBridge 156:ff21514d8981 124 return sizeof(uint16_t);
AnnaBridge 156:ff21514d8981 125 }
AnnaBridge 156:ff21514d8981 126
AnnaBridge 156:ff21514d8981 127 /**@brief Function for encoding a uint32 value.
AnnaBridge 156:ff21514d8981 128 *
AnnaBridge 156:ff21514d8981 129 * @param[in] value Value to be encoded.
AnnaBridge 156:ff21514d8981 130 * @param[out] p_encoded_data Buffer where the encoded data is to be written.
AnnaBridge 156:ff21514d8981 131 *
AnnaBridge 156:ff21514d8981 132 * @return Number of bytes written.
AnnaBridge 156:ff21514d8981 133 */
AnnaBridge 156:ff21514d8981 134 static __INLINE uint8_t uint32_encode(uint32_t value, uint8_t * p_encoded_data)
AnnaBridge 156:ff21514d8981 135 {
AnnaBridge 156:ff21514d8981 136 p_encoded_data[0] = (uint8_t) ((value & 0x000000FF) >> 0);
AnnaBridge 156:ff21514d8981 137 p_encoded_data[1] = (uint8_t) ((value & 0x0000FF00) >> 8);
AnnaBridge 156:ff21514d8981 138 p_encoded_data[2] = (uint8_t) ((value & 0x00FF0000) >> 16);
AnnaBridge 156:ff21514d8981 139 p_encoded_data[3] = (uint8_t) ((value & 0xFF000000) >> 24);
AnnaBridge 156:ff21514d8981 140 return sizeof(uint32_t);
AnnaBridge 156:ff21514d8981 141 }
AnnaBridge 156:ff21514d8981 142
AnnaBridge 156:ff21514d8981 143 /**@brief Function for decoding a uint16 value.
AnnaBridge 156:ff21514d8981 144 *
AnnaBridge 156:ff21514d8981 145 * @param[in] p_encoded_data Buffer where the encoded data is stored.
AnnaBridge 156:ff21514d8981 146 *
AnnaBridge 156:ff21514d8981 147 * @return Decoded value.
AnnaBridge 156:ff21514d8981 148 */
AnnaBridge 156:ff21514d8981 149 static __INLINE uint16_t uint16_decode(const uint8_t * p_encoded_data)
AnnaBridge 156:ff21514d8981 150 {
AnnaBridge 156:ff21514d8981 151 return ( (((uint16_t)((uint8_t *)p_encoded_data)[0])) |
AnnaBridge 156:ff21514d8981 152 (((uint16_t)((uint8_t *)p_encoded_data)[1]) << 8 ));
AnnaBridge 156:ff21514d8981 153 }
AnnaBridge 156:ff21514d8981 154
AnnaBridge 156:ff21514d8981 155 /**@brief Function for decoding a uint32 value.
AnnaBridge 156:ff21514d8981 156 *
AnnaBridge 156:ff21514d8981 157 * @param[in] p_encoded_data Buffer where the encoded data is stored.
AnnaBridge 156:ff21514d8981 158 *
AnnaBridge 156:ff21514d8981 159 * @return Decoded value.
AnnaBridge 156:ff21514d8981 160 */
AnnaBridge 156:ff21514d8981 161 static __INLINE uint32_t uint32_decode(const uint8_t * p_encoded_data)
AnnaBridge 156:ff21514d8981 162 {
AnnaBridge 156:ff21514d8981 163 return ( (((uint32_t)((uint8_t *)p_encoded_data)[0]) << 0) |
AnnaBridge 156:ff21514d8981 164 (((uint32_t)((uint8_t *)p_encoded_data)[1]) << 8) |
AnnaBridge 156:ff21514d8981 165 (((uint32_t)((uint8_t *)p_encoded_data)[2]) << 16) |
AnnaBridge 156:ff21514d8981 166 (((uint32_t)((uint8_t *)p_encoded_data)[3]) << 24 ));
AnnaBridge 156:ff21514d8981 167 }
AnnaBridge 156:ff21514d8981 168
AnnaBridge 156:ff21514d8981 169 /** @brief Function for converting the input voltage (in milli volts) into percentage of 3.0 Volts.
AnnaBridge 156:ff21514d8981 170 *
AnnaBridge 156:ff21514d8981 171 * @details The calculation is based on a linearized version of the battery's discharge
AnnaBridge 156:ff21514d8981 172 * curve. 3.0V returns 100% battery level. The limit for power failure is 2.1V and
AnnaBridge 156:ff21514d8981 173 * is considered to be the lower boundary.
AnnaBridge 156:ff21514d8981 174 *
AnnaBridge 156:ff21514d8981 175 * The discharge curve for CR2032 is non-linear. In this model it is split into
AnnaBridge 156:ff21514d8981 176 * 4 linear sections:
AnnaBridge 156:ff21514d8981 177 * - Section 1: 3.0V - 2.9V = 100% - 42% (58% drop on 100 mV)
AnnaBridge 156:ff21514d8981 178 * - Section 2: 2.9V - 2.74V = 42% - 18% (24% drop on 160 mV)
AnnaBridge 156:ff21514d8981 179 * - Section 3: 2.74V - 2.44V = 18% - 6% (12% drop on 300 mV)
AnnaBridge 156:ff21514d8981 180 * - Section 4: 2.44V - 2.1V = 6% - 0% (6% drop on 340 mV)
AnnaBridge 156:ff21514d8981 181 *
AnnaBridge 156:ff21514d8981 182 * These numbers are by no means accurate. Temperature and
AnnaBridge 156:ff21514d8981 183 * load in the actual application is not accounted for!
AnnaBridge 156:ff21514d8981 184 *
AnnaBridge 156:ff21514d8981 185 * @param[in] mvolts The voltage in mV
AnnaBridge 156:ff21514d8981 186 *
AnnaBridge 156:ff21514d8981 187 * @return Battery level in percent.
AnnaBridge 156:ff21514d8981 188 */
AnnaBridge 156:ff21514d8981 189 static __INLINE uint8_t battery_level_in_percent(const uint16_t mvolts)
AnnaBridge 156:ff21514d8981 190 {
AnnaBridge 156:ff21514d8981 191 uint8_t battery_level;
AnnaBridge 156:ff21514d8981 192
AnnaBridge 156:ff21514d8981 193 if (mvolts >= 3000)
AnnaBridge 156:ff21514d8981 194 {
AnnaBridge 156:ff21514d8981 195 battery_level = 100;
AnnaBridge 156:ff21514d8981 196 }
AnnaBridge 156:ff21514d8981 197 else if (mvolts > 2900)
AnnaBridge 156:ff21514d8981 198 {
AnnaBridge 156:ff21514d8981 199 battery_level = 100 - ((3000 - mvolts) * 58) / 100;
AnnaBridge 156:ff21514d8981 200 }
AnnaBridge 156:ff21514d8981 201 else if (mvolts > 2740)
AnnaBridge 156:ff21514d8981 202 {
AnnaBridge 156:ff21514d8981 203 battery_level = 42 - ((2900 - mvolts) * 24) / 160;
AnnaBridge 156:ff21514d8981 204 }
AnnaBridge 156:ff21514d8981 205 else if (mvolts > 2440)
AnnaBridge 156:ff21514d8981 206 {
AnnaBridge 156:ff21514d8981 207 battery_level = 18 - ((2740 - mvolts) * 12) / 300;
AnnaBridge 156:ff21514d8981 208 }
AnnaBridge 156:ff21514d8981 209 else if (mvolts > 2100)
AnnaBridge 156:ff21514d8981 210 {
AnnaBridge 156:ff21514d8981 211 battery_level = 6 - ((2440 - mvolts) * 6) / 340;
AnnaBridge 156:ff21514d8981 212 }
AnnaBridge 156:ff21514d8981 213 else
AnnaBridge 156:ff21514d8981 214 {
AnnaBridge 156:ff21514d8981 215 battery_level = 0;
AnnaBridge 156:ff21514d8981 216 }
AnnaBridge 156:ff21514d8981 217
AnnaBridge 156:ff21514d8981 218 return battery_level;
AnnaBridge 156:ff21514d8981 219 }
AnnaBridge 156:ff21514d8981 220
AnnaBridge 156:ff21514d8981 221 /**@brief Function for checking if a pointer value is aligned to a 4 byte boundary.
AnnaBridge 156:ff21514d8981 222 *
AnnaBridge 156:ff21514d8981 223 * @param[in] p Pointer value to be checked.
AnnaBridge 156:ff21514d8981 224 *
AnnaBridge 156:ff21514d8981 225 * @return TRUE if pointer is aligned to a 4 byte boundary, FALSE otherwise.
AnnaBridge 156:ff21514d8981 226 */
AnnaBridge 156:ff21514d8981 227 static __INLINE bool is_word_aligned(void * p)
AnnaBridge 156:ff21514d8981 228 {
AnnaBridge 156:ff21514d8981 229 return (((uintptr_t)p & 0x03) == 0);
AnnaBridge 156:ff21514d8981 230 }
AnnaBridge 156:ff21514d8981 231
AnnaBridge 156:ff21514d8981 232 #endif // APP_UTIL_H__
AnnaBridge 156:ff21514d8981 233
AnnaBridge 156:ff21514d8981 234 /** @} */