aboutsummaryrefslogtreecommitdiffstats
path: root/arduino/cores/nRF5/common_func.h
diff options
context:
space:
mode:
authorClyne Sullivan <tullivan99@gmail.com>2019-02-28 17:04:22 -0500
committerClyne Sullivan <tullivan99@gmail.com>2019-02-28 17:04:22 -0500
commitd6869d1ec4bd24cd2c3eafa534f0849b25ec5607 (patch)
tree79e54ed27b39c31864895535d11399708d5a45c0 /arduino/cores/nRF5/common_func.h
parent614ee97bf3a2270c413527a7f35c54cbecd9e601 (diff)
added basic code
Diffstat (limited to 'arduino/cores/nRF5/common_func.h')
-rwxr-xr-xarduino/cores/nRF5/common_func.h286
1 files changed, 286 insertions, 0 deletions
diff --git a/arduino/cores/nRF5/common_func.h b/arduino/cores/nRF5/common_func.h
new file mode 100755
index 0000000..6862dab
--- /dev/null
+++ b/arduino/cores/nRF5/common_func.h
@@ -0,0 +1,286 @@
+/**************************************************************************/
+/*!
+ @file common_func.h
+ @author hathach (tinyusb.org)
+
+ @section LICENSE
+
+ Software License Agreement (BSD License)
+
+ Copyright (c) 2018, Adafruit Industries (adafruit.com)
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ 3. Neither the name of the copyright holders nor the
+ names of its contributors may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+/**************************************************************************/
+
+#ifndef _COMMON_FUNC_H_
+#define _COMMON_FUNC_H_
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+#define COMMENT_OUT(x)
+
+#define memclr(buffer, size) memset(buffer, 0, size)
+#define varclr(_var) memclr(_var, sizeof(*(_var)))
+#define arrclr(_arr) memclr(_arr, sizeof(_arr))
+
+#define arrcount(_arr) ( sizeof(_arr) / sizeof(_arr[0]) )
+
+#define __swap32(x) __REV(x) ///< built-in function to swap Endian of 32-bit number
+#define __swap16(u16) ((uint16_t) __REV16(u16)) ///< built-in function to swap Endian of 16-bit number
+
+#ifndef __cplusplus
+#ifndef max
+#define max(a, b) ((a) > (b) ? (a) : (b))
+#endif // max
+#ifndef min
+#define min(a, b) ((a) < (b) ? (a) : (b))
+#endif // min
+#endif // __cplusplus
+
+#define maxof(a,b) max(a, b)
+#define minof(a,b) min(a, b)
+
+/*------------------------------------------------------------------*/
+/* Count number of arguments of __VA_ARGS__
+ * - reference https://groups.google.com/forum/#!topic/comp.std.c/d-6Mj5Lko_s
+ * - _GET_NTH_ARG() takes args >= N (64) but only expand to Nth one (64th)
+ * - _RSEQ_N() is reverse sequential to N to add padding to have
+ * Nth position is the same as the number of arguments
+ * - ##__VA_ARGS__ is used to deal with 0 paramerter (swallows comma)
+ *------------------------------------------------------------------*/
+#define VA_ARGS_NUM(...) NARG_(_0, ##__VA_ARGS__,_RSEQ_N())
+#define NARG_(...) _GET_NTH_ARG(__VA_ARGS__)
+#define _GET_NTH_ARG( \
+ _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
+ _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
+ _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
+ _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
+ _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
+ _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
+ _61,_62,_63,N,...) N
+#define _RSEQ_N() \
+ 62,61,60, \
+ 59,58,57,56,55,54,53,52,51,50, \
+ 49,48,47,46,45,44,43,42,41,40, \
+ 39,38,37,36,35,34,33,32,31,30, \
+ 29,28,27,26,25,24,23,22,21,20, \
+ 19,18,17,16,15,14,13,12,11,10, \
+ 9,8,7,6,5,4,3,2,1,0
+
+//--------------------------------------------------------------------+
+// MACROS
+//--------------------------------------------------------------------+
+#define U16_HIGH(u16) ((uint8_t) (((u16) >> 8) & 0x00ff))
+#define U16_LOW(u16) ((uint8_t) ((u16) & 0x00ff))
+#define U16_BYTES_BE(u16) U16_HIGH(u16), U16_LOW(u16)
+#define U16_BYTES_LE(u16) U16_LOW(u16), U16_HIGH(u16)
+
+#define U32_BYTE1(u32) ((uint8_t) (((u32) >> 24) & 0x000000ff)) // MSB
+#define U32_BYTE2(u32) ((uint8_t) (((u32) >> 16) & 0x000000ff))
+#define U32_BYTE3(u32) ((uint8_t) (((u32) >> 8) & 0x000000ff))
+#define U32_BYTE4(u32) ((uint8_t) ((u32) & 0x000000ff)) // LSB
+
+#define U32_FROM_U8(b1, b2, b3, b4) ((uint32_t) (((b1) << 24) + ((b2) << 16) + ((b3) << 8) + (b4)))
+#define U32_FROM_U16(high, low) ((uint32_t) (((high) << 16) | (low)))
+#define U16_FROM_U8(high, low) ((uint32_t) (((high) << 8) | (low)))
+
+#define U32_BYTES_BE(u32) U32_BYTE1(u32), U32_BYTE2(u32), U32_BYTE3(u32), U32_BYTE4(u32)
+#define U32_BYTES_LE(u32) U32_BYTE4(u32), U32_BYTE3(u32), U32_BYTE2(u32), U32_BYTE1(u32)
+
+#define SWAP16(x) ((uint16_t)(((x) << 8) | (((x) & 0xff00) >> 8)))
+
+//--------------------------------------------------------------------+
+// DEBUG HELPER
+//--------------------------------------------------------------------+
+#if CFG_DEBUG == 2
+ #define malloc_named( name, size ) ({ printf("[malloc] %s : %d\r\n", name, size); malloc(size); })
+#else
+ #define malloc_named( name, size ) malloc ( size )
+#endif
+
+const char* dbg_err_str(int32_t err_id); // TODO move to other place
+
+#if CFG_DEBUG
+#define LOG_LV1(...) ADALOG(__VA_ARGS__)
+#define LOG_LV1_BUFFER(...) ADALOG_BUFFER(__VA_ARGS__)
+#else
+#define LOG_LV1(...)
+#define LOG_LV1_BUFFER(...)
+#endif
+
+#if CFG_DEBUG >= 2
+#define LOG_LV2(...) ADALOG(__VA_ARGS__)
+#define LOG_LV2_BUFFER(...) ADALOG_BUFFER(__VA_ARGS__)
+#else
+#define LOG_LV2(...)
+#define LOG_LV2_BUFFER(...)
+#endif
+
+#if CFG_DEBUG
+
+#define PRINT_LOCATION() printf("%s: %d:\n", __PRETTY_FUNCTION__, __LINE__)
+#define PRINT_MESS(x) printf("%s: %d: %s \n" , __FUNCTION__, __LINE__, (char*)(x))
+#define PRTNT_HEAP() if (CFG_DEBUG == 3) printf("\n%s: %d: Heap free: %d\n", __FUNCTION__, __LINE__, util_heap_get_free_size())
+#define PRINT_STR(x) printf("%s: %d: " #x " = %s\n" , __FUNCTION__, __LINE__, (char*)(x) )
+#define PRINT_INT(x) printf("%s: %d: " #x " = %ld\n" , __FUNCTION__, __LINE__, (uint32_t) (x) )
+
+#define PRINT_HEX(x) \
+ do {\
+ printf("%s: %d: " #x " = 0x", __PRETTY_FUNCTION__, __LINE__);\
+ char fmt[] = "%00X\n";\
+ fmt[2] += 2*sizeof(x); /* Hex with correct size */\
+ printf(fmt, (x) );\
+ }while(0)
+
+#define PRINT_BUFFER(buf, n) \
+ do {\
+ uint8_t const* p8 = (uint8_t const*) (buf);\
+ printf(#buf ": ");\
+ for(uint32_t i=0; i<(n); i++) printf("%02x ", p8[i]);\
+ printf("\n");\
+ }while(0)
+
+#define ADALOG(tag, ...) \
+ do { \
+ if ( tag ) printf("[%-6s] ", tag);\
+ printf(__VA_ARGS__);\
+ printf("\n");\
+ }while(0)
+
+#define ADALOG_BUFFER(_tag, _buf, _n) \
+ do {\
+ if ( _tag ) printf("%-6s: len = %d\n", _tag, _n);\
+ dbgDumpMemory(_buf, 1, _n, true);\
+ }while(0)
+
+#else
+
+#define PRINT_LOCATION()
+#define PRINT_MESS(x)
+#define PRTNT_HEAP()
+#define PRINT_STR(x)
+#define PRINT_INT(x)
+#define PRINT_HEX(x)
+#define PRINT_BUFFER(buf, n)
+#define ADALOG(...)
+
+#endif
+
+//--------------------------------------------------------------------+
+// INLINE FUNCTION
+//--------------------------------------------------------------------+
+/// Checks is all values in the supplied array are zero
+static inline bool mem_test_zero(void const* buffer, uint32_t size)
+{
+ uint8_t const* p_mem = (uint8_t const*) buffer;
+ for(uint32_t i=0; i<size; i++) if (p_mem[i] != 0) return false;
+ return true;
+}
+
+//------------- Min, Max -------------//
+static inline uint8_t min8 (uint8_t x, uint8_t y) { return (x < y) ? x : y; }
+static inline uint16_t min16(uint16_t x, uint16_t y) { return (x < y) ? x : y; }
+static inline uint32_t min32(uint32_t x, uint32_t y) { return (x < y) ? x : y; }
+
+static inline uint8_t max8 (uint8_t x, uint8_t y) { return (x > y) ? x : y; }
+static inline uint16_t max16(uint16_t x, uint16_t y) { return (x > y) ? x : y; }
+static inline uint32_t max32(uint32_t x, uint32_t y) { return (x > y) ? x : y; }
+
+//------------- Conversion -------------//
+/// form an uint32_t from 4 x uint8_t
+static inline uint32_t u32_from_u8(uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4)
+{
+ return (b1 << 24) + (b2 << 16) + (b3 << 8) + b4;
+}
+
+static inline uint16_t u32_high_u16(uint32_t u32)
+{
+ return (uint16_t) ((u32 >> 16) & 0xffff);
+}
+
+static inline uint16_t u32_low_u16(uint32_t u32)
+{
+ return (uint16_t) (u32 & 0xffff);
+}
+
+static inline uint16_t u16_from_u8(uint8_t b1, uint8_t b2)
+{
+ return (b1 << 8) + b2;
+}
+
+static inline uint8_t u16_high_u8(uint16_t u16)
+{
+ return (uint8_t) ((u16 >> 8) & 0x00ff);
+}
+
+static inline uint8_t u16_low_u8(uint16_t u16)
+{
+ return (uint8_t) (u16 & 0x00ff);
+}
+
+//------------- Align -------------//
+static inline uint32_t align32 (uint32_t value)
+{
+ return (value & 0xFFFFFFE0UL);
+}
+
+static inline uint32_t align16 (uint32_t value)
+{
+ return (value & 0xFFFFFFF0UL);
+}
+
+static inline uint32_t align4 (uint32_t value)
+{
+ return (value & 0xFFFFFFFCUL);
+}
+
+static inline uint32_t align_n (uint32_t alignment, uint32_t value)
+{
+ return value & (~(alignment-1));
+}
+
+static inline uint32_t align4k (uint32_t value)
+{
+ return (value & 0xFFFFF000UL);
+}
+
+static inline uint32_t offset4k(uint32_t value)
+{
+ return (value & 0xFFFUL);
+}
+
+//------------- Mathematics -------------//
+static inline bool is_within(uint32_t lower, uint32_t value, uint32_t upper)
+{
+ return (lower <= value) && (value <= upper);
+}
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _COMMON_FUNC_H_ */