mirror of
https://github.com/tsl0922/EPD-nRF5.git
synced 2026-03-21 12:19:44 +08:00
316 lines
10 KiB
C
316 lines
10 KiB
C
/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
|
|
*
|
|
* The information contained herein is property of Nordic Semiconductor ASA.
|
|
* Terms and conditions of usage are described in detail in NORDIC
|
|
* SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
|
|
*
|
|
* Licensees are granted free, non-transferable use of the information. NO
|
|
* WARRANTY of ANY KIND is provided. This heading must NOT be removed from
|
|
* the file.
|
|
*
|
|
*/
|
|
|
|
/** @file
|
|
*
|
|
* @defgroup app_util Utility Functions and Definitions
|
|
* @{
|
|
* @ingroup app_common
|
|
*
|
|
* @brief Various types and definitions available to all applications.
|
|
*/
|
|
|
|
#ifndef APP_UTIL_H__
|
|
#define APP_UTIL_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "compiler_abstraction.h"
|
|
|
|
enum
|
|
{
|
|
UNIT_0_625_MS = 625, /**< Number of microseconds in 0.625 milliseconds. */
|
|
UNIT_1_25_MS = 1250, /**< Number of microseconds in 1.25 milliseconds. */
|
|
UNIT_10_MS = 10000 /**< Number of microseconds in 10 milliseconds. */
|
|
};
|
|
|
|
|
|
/**@brief Implementation specific macro for delayed macro expansion used in string concatenation
|
|
*
|
|
* @param[in] lhs Left hand side in concatenation
|
|
* @param[in] rhs Right hand side in concatenation
|
|
*/
|
|
#define STRING_CONCATENATE_IMPL(lhs, rhs) lhs ## rhs
|
|
|
|
|
|
/**@brief Macro used to concatenate string using delayed macro expansion
|
|
*
|
|
* @note This macro will delay concatenation until the expressions have been resolved
|
|
*
|
|
* @param[in] lhs Left hand side in concatenation
|
|
* @param[in] rhs Right hand side in concatenation
|
|
*/
|
|
#define STRING_CONCATENATE(lhs, rhs) STRING_CONCATENATE_IMPL(lhs, rhs)
|
|
|
|
|
|
// Disable lint-warnings/errors for STATIC_ASSERT
|
|
//lint --emacro(10,STATIC_ASSERT)
|
|
//lint --emacro(18,STATIC_ASSERT)
|
|
//lint --emacro(19,STATIC_ASSERT)
|
|
//lint --emacro(30,STATIC_ASSERT)
|
|
//lint --emacro(37,STATIC_ASSERT)
|
|
//lint --emacro(42,STATIC_ASSERT)
|
|
//lint --emacro(26,STATIC_ASSERT)
|
|
//lint --emacro(102,STATIC_ASSERT)
|
|
//lint --emacro(533,STATIC_ASSERT)
|
|
//lint --emacro(534,STATIC_ASSERT)
|
|
//lint --emacro(132,STATIC_ASSERT)
|
|
//lint --emacro(414,STATIC_ASSERT)
|
|
//lint --emacro(578,STATIC_ASSERT)
|
|
//lint --emacro(628,STATIC_ASSERT)
|
|
//lint --emacro(648,STATIC_ASSERT)
|
|
//lint --emacro(830,STATIC_ASSERT)
|
|
|
|
|
|
/**@brief Macro for doing static (i.e. compile time) assertion.
|
|
*
|
|
* @note If the EXPR isn't resolvable, then the error message won't be shown.
|
|
*
|
|
* @note The output of STATIC_ASSERT_MSG will be different across different compilers.
|
|
*
|
|
* @param[in] EXPR Constant expression to be verified.
|
|
*/
|
|
#if defined ( __COUNTER__ )
|
|
|
|
#define STATIC_ASSERT(EXPR) \
|
|
;enum { STRING_CONCATENATE(static_assert_, __COUNTER__) = 1/(!!(EXPR)) }
|
|
|
|
#else
|
|
|
|
#define STATIC_ASSERT(EXPR) \
|
|
;enum { STRING_CONCATENATE(assert_line_, __LINE__) = 1/(!!(EXPR)) }
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**@brief type for holding an encoded (i.e. little endian) 16 bit unsigned integer. */
|
|
typedef uint8_t uint16_le_t[2];
|
|
|
|
/**@brief type for holding an encoded (i.e. little endian) 32 bit unsigned integer. */
|
|
typedef uint8_t uint32_le_t[4];
|
|
|
|
/**@brief Byte array type. */
|
|
typedef struct
|
|
{
|
|
uint16_t size; /**< Number of array entries. */
|
|
uint8_t * p_data; /**< Pointer to array entries. */
|
|
} uint8_array_t;
|
|
|
|
/**@brief Perform rounded integer division (as opposed to truncating the result).
|
|
*
|
|
* @param[in] A Numerator.
|
|
* @param[in] B Denominator.
|
|
*
|
|
* @return Rounded (integer) result of dividing A by B.
|
|
*/
|
|
#define ROUNDED_DIV(A, B) (((A) + ((B) / 2)) / (B))
|
|
|
|
/**@brief Check if the integer provided is a power of two.
|
|
*
|
|
* @param[in] A Number to be tested.
|
|
*
|
|
* @return true if value is power of two.
|
|
* @return false if value not power of two.
|
|
*/
|
|
#define IS_POWER_OF_TWO(A) ( ((A) != 0) && ((((A) - 1) & (A)) == 0) )
|
|
|
|
/**@brief To convert milliseconds to ticks.
|
|
* @param[in] TIME Number of milliseconds to convert.
|
|
* @param[in] RESOLUTION Unit to be converted to in [us/ticks].
|
|
*/
|
|
#define MSEC_TO_UNITS(TIME, RESOLUTION) (((TIME) * 1000) / (RESOLUTION))
|
|
|
|
/**@brief Perform integer division, making sure the result is rounded up.
|
|
*
|
|
* @details One typical use for this is to compute the number of objects with size B is needed to
|
|
* hold A number of bytes.
|
|
*
|
|
* @param[in] A Numerator.
|
|
* @param[in] B Denominator.
|
|
*
|
|
* @return Integer result of dividing A by B, rounded up.
|
|
*/
|
|
#define CEIL_DIV(A, B) \
|
|
(((A) + (B) - 1) / (B))
|
|
|
|
/**@brief Function for creating a buffer aligned to 4 bytes.
|
|
*
|
|
* @param[in] NAME Name of the buffor.
|
|
* @param[in] MIN_SIZE Size of this buffor (it will be rounded up to multiples of 4 bytes).
|
|
*/
|
|
#define WORD_ALIGNED_MEM_BUFF(NAME, MIN_SIZE) static uint32_t NAME[CEIL_DIV(MIN_SIZE, sizeof(uint32_t))]
|
|
|
|
/**@brief Function for changing the value unit.
|
|
*
|
|
* @param[in] value Value to be rescaled.
|
|
* @param[in] old_unit_reversal Reversal of the incoming unit.
|
|
* @param[in] new_unit_reversal Reversal of the desired unit.
|
|
*
|
|
* @return Number of bytes written.
|
|
*/
|
|
static __INLINE uint64_t value_rescale(uint32_t value, uint32_t old_unit_reversal, uint16_t new_unit_reversal)
|
|
{
|
|
return (uint64_t)ROUNDED_DIV((uint64_t)value * new_unit_reversal, old_unit_reversal);
|
|
}
|
|
|
|
/**@brief Function for encoding a uint16 value.
|
|
*
|
|
* @param[in] value Value to be encoded.
|
|
* @param[out] p_encoded_data Buffer where the encoded data is to be written.
|
|
*
|
|
* @return Number of bytes written.
|
|
*/
|
|
static __INLINE uint8_t uint16_encode(uint16_t value, uint8_t * p_encoded_data)
|
|
{
|
|
p_encoded_data[0] = (uint8_t) ((value & 0x00FF) >> 0);
|
|
p_encoded_data[1] = (uint8_t) ((value & 0xFF00) >> 8);
|
|
return sizeof(uint16_t);
|
|
}
|
|
|
|
/**@brief Function for encoding a three-byte value.
|
|
*
|
|
* @param[in] value Value to be encoded.
|
|
* @param[out] p_encoded_data Buffer where the encoded data is to be written.
|
|
*
|
|
* @return Number of bytes written.
|
|
*/
|
|
static __INLINE uint8_t uint24_encode(uint32_t value, uint8_t * p_encoded_data)
|
|
{
|
|
p_encoded_data[0] = (uint8_t) ((value & 0x000000FF) >> 0);
|
|
p_encoded_data[1] = (uint8_t) ((value & 0x0000FF00) >> 8);
|
|
p_encoded_data[2] = (uint8_t) ((value & 0x00FF0000) >> 16);
|
|
return 3;
|
|
}
|
|
|
|
/**@brief Function for encoding a uint32 value.
|
|
*
|
|
* @param[in] value Value to be encoded.
|
|
* @param[out] p_encoded_data Buffer where the encoded data is to be written.
|
|
*
|
|
* @return Number of bytes written.
|
|
*/
|
|
static __INLINE uint8_t uint32_encode(uint32_t value, uint8_t * p_encoded_data)
|
|
{
|
|
p_encoded_data[0] = (uint8_t) ((value & 0x000000FF) >> 0);
|
|
p_encoded_data[1] = (uint8_t) ((value & 0x0000FF00) >> 8);
|
|
p_encoded_data[2] = (uint8_t) ((value & 0x00FF0000) >> 16);
|
|
p_encoded_data[3] = (uint8_t) ((value & 0xFF000000) >> 24);
|
|
return sizeof(uint32_t);
|
|
}
|
|
|
|
/**@brief Function for decoding a uint16 value.
|
|
*
|
|
* @param[in] p_encoded_data Buffer where the encoded data is stored.
|
|
*
|
|
* @return Decoded value.
|
|
*/
|
|
static __INLINE uint16_t uint16_decode(const uint8_t * p_encoded_data)
|
|
{
|
|
return ( (((uint16_t)((uint8_t *)p_encoded_data)[0])) |
|
|
(((uint16_t)((uint8_t *)p_encoded_data)[1]) << 8 ));
|
|
}
|
|
|
|
/**@brief Function for decoding a three-byte value.
|
|
*
|
|
* @param[in] p_encoded_data Buffer where the encoded data is stored.
|
|
*
|
|
* @return Decoded value (uint32_t).
|
|
*/
|
|
static __INLINE uint32_t uint24_decode(const uint8_t * p_encoded_data)
|
|
{
|
|
return ( (((uint32_t)((uint8_t *)p_encoded_data)[0]) << 0) |
|
|
(((uint32_t)((uint8_t *)p_encoded_data)[1]) << 8) |
|
|
(((uint32_t)((uint8_t *)p_encoded_data)[2]) << 16));
|
|
}
|
|
|
|
/**@brief Function for decoding a uint32 value.
|
|
*
|
|
* @param[in] p_encoded_data Buffer where the encoded data is stored.
|
|
*
|
|
* @return Decoded value.
|
|
*/
|
|
static __INLINE uint32_t uint32_decode(const uint8_t * p_encoded_data)
|
|
{
|
|
return ( (((uint32_t)((uint8_t *)p_encoded_data)[0]) << 0) |
|
|
(((uint32_t)((uint8_t *)p_encoded_data)[1]) << 8) |
|
|
(((uint32_t)((uint8_t *)p_encoded_data)[2]) << 16) |
|
|
(((uint32_t)((uint8_t *)p_encoded_data)[3]) << 24 ));
|
|
}
|
|
|
|
/** @brief Function for converting the input voltage (in milli volts) into percentage of 3.0 Volts.
|
|
*
|
|
* @details The calculation is based on a linearized version of the battery's discharge
|
|
* curve. 3.0V returns 100% battery level. The limit for power failure is 2.1V and
|
|
* is considered to be the lower boundary.
|
|
*
|
|
* The discharge curve for CR2032 is non-linear. In this model it is split into
|
|
* 4 linear sections:
|
|
* - Section 1: 3.0V - 2.9V = 100% - 42% (58% drop on 100 mV)
|
|
* - Section 2: 2.9V - 2.74V = 42% - 18% (24% drop on 160 mV)
|
|
* - Section 3: 2.74V - 2.44V = 18% - 6% (12% drop on 300 mV)
|
|
* - Section 4: 2.44V - 2.1V = 6% - 0% (6% drop on 340 mV)
|
|
*
|
|
* These numbers are by no means accurate. Temperature and
|
|
* load in the actual application is not accounted for!
|
|
*
|
|
* @param[in] mvolts The voltage in mV
|
|
*
|
|
* @return Battery level in percent.
|
|
*/
|
|
static __INLINE uint8_t battery_level_in_percent(const uint16_t mvolts)
|
|
{
|
|
uint8_t battery_level;
|
|
|
|
if (mvolts >= 3000)
|
|
{
|
|
battery_level = 100;
|
|
}
|
|
else if (mvolts > 2900)
|
|
{
|
|
battery_level = 100 - ((3000 - mvolts) * 58) / 100;
|
|
}
|
|
else if (mvolts > 2740)
|
|
{
|
|
battery_level = 42 - ((2900 - mvolts) * 24) / 160;
|
|
}
|
|
else if (mvolts > 2440)
|
|
{
|
|
battery_level = 18 - ((2740 - mvolts) * 12) / 300;
|
|
}
|
|
else if (mvolts > 2100)
|
|
{
|
|
battery_level = 6 - ((2440 - mvolts) * 6) / 340;
|
|
}
|
|
else
|
|
{
|
|
battery_level = 0;
|
|
}
|
|
|
|
return battery_level;
|
|
}
|
|
|
|
/**@brief Function for checking if a pointer value is aligned to a 4 byte boundary.
|
|
*
|
|
* @param[in] p Pointer value to be checked.
|
|
*
|
|
* @return TRUE if pointer is aligned to a 4 byte boundary, FALSE otherwise.
|
|
*/
|
|
static __INLINE bool is_word_aligned(void const* p)
|
|
{
|
|
return (((uintptr_t)p & 0x03) == 0);
|
|
}
|
|
|
|
#endif // APP_UTIL_H__
|
|
|
|
/** @} */
|