Arch X / Mbed 2 deprecated BLE_Micro_Release

test firmware for BLE Micro V1.3 1. test io, vcc and ble 2. act as a UART to BLE bridge

Dependencies:   BLE_API Buffer mbed

Fork of BLE_LEDBlinker by Bluetooth Low Energy

nRF51822/source/common/common.h@11:c8cbc4bc2c17, 2015-12-08 (annotated)

Committer:
arch
Date:
Tue Dec 08 06:02:25 2015 +0000
Revision:
11:c8cbc4bc2c17
test firmware for BLE Micro V1.3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
arch 11:c8cbc4bc2c17 1 /**************************************************************************/
arch 11:c8cbc4bc2c17 2 /*!
arch 11:c8cbc4bc2c17 3 @file common.h
arch 11:c8cbc4bc2c17 4 @author hathach (tinyusb.org)
arch 11:c8cbc4bc2c17 5
arch 11:c8cbc4bc2c17 6 @section LICENSE
arch 11:c8cbc4bc2c17 7
arch 11:c8cbc4bc2c17 8 Software License Agreement (BSD License)
arch 11:c8cbc4bc2c17 9
arch 11:c8cbc4bc2c17 10 Copyright (c) 2013, K. Townsend (microBuilder.eu)
arch 11:c8cbc4bc2c17 11 All rights reserved.
arch 11:c8cbc4bc2c17 12
arch 11:c8cbc4bc2c17 13 Redistribution and use in source and binary forms, with or without
arch 11:c8cbc4bc2c17 14 modification, are permitted provided that the following conditions are met:
arch 11:c8cbc4bc2c17 15 1. Redistributions of source code must retain the above copyright
arch 11:c8cbc4bc2c17 16 notice, this list of conditions and the following disclaimer.
arch 11:c8cbc4bc2c17 17 2. Redistributions in binary form must reproduce the above copyright
arch 11:c8cbc4bc2c17 18 notice, this list of conditions and the following disclaimer in the
arch 11:c8cbc4bc2c17 19 documentation and/or other materials provided with the distribution.
arch 11:c8cbc4bc2c17 20 3. Neither the name of the copyright holders nor the
arch 11:c8cbc4bc2c17 21 names of its contributors may be used to endorse or promote products
arch 11:c8cbc4bc2c17 22 derived from this software without specific prior written permission.
arch 11:c8cbc4bc2c17 23
arch 11:c8cbc4bc2c17 24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
arch 11:c8cbc4bc2c17 25 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
arch 11:c8cbc4bc2c17 26 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
arch 11:c8cbc4bc2c17 27 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
arch 11:c8cbc4bc2c17 28 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
arch 11:c8cbc4bc2c17 29 INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
arch 11:c8cbc4bc2c17 30 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND
arch 11:c8cbc4bc2c17 31 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
arch 11:c8cbc4bc2c17 32 INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
arch 11:c8cbc4bc2c17 33 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
arch 11:c8cbc4bc2c17 34 */
arch 11:c8cbc4bc2c17 35 /**************************************************************************/
arch 11:c8cbc4bc2c17 36
arch 11:c8cbc4bc2c17 37 /** \defgroup Group_Common Common Files
arch 11:c8cbc4bc2c17 38 * @{
arch 11:c8cbc4bc2c17 39 *
arch 11:c8cbc4bc2c17 40 * \defgroup Group_CommonH common.h
arch 11:c8cbc4bc2c17 41 *
arch 11:c8cbc4bc2c17 42 * @{
arch 11:c8cbc4bc2c17 43 */
arch 11:c8cbc4bc2c17 44
arch 11:c8cbc4bc2c17 45 #ifndef _COMMON_H_
arch 11:c8cbc4bc2c17 46 #define _COMMON_H_
arch 11:c8cbc4bc2c17 47
arch 11:c8cbc4bc2c17 48 #ifdef __cplusplus
arch 11:c8cbc4bc2c17 49 extern "C" {
arch 11:c8cbc4bc2c17 50 #endif
arch 11:c8cbc4bc2c17 51
arch 11:c8cbc4bc2c17 52 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 53 // INCLUDES
arch 11:c8cbc4bc2c17 54 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 55
arch 11:c8cbc4bc2c17 56 //------------- Standard Header -------------//
arch 11:c8cbc4bc2c17 57 #include <stdint.h>
arch 11:c8cbc4bc2c17 58 #include <stdbool.h>
arch 11:c8cbc4bc2c17 59 #include <stddef.h>
arch 11:c8cbc4bc2c17 60 #include <string.h>
arch 11:c8cbc4bc2c17 61 #include <stdio.h>
arch 11:c8cbc4bc2c17 62
arch 11:c8cbc4bc2c17 63 //------------- General Header -------------//
arch 11:c8cbc4bc2c17 64 #include "projectconfig.h"
arch 11:c8cbc4bc2c17 65 #include "compiler.h"
arch 11:c8cbc4bc2c17 66 #include "assertion.h"
arch 11:c8cbc4bc2c17 67 #include "binary.h"
arch 11:c8cbc4bc2c17 68 #include "ble_error.h"
arch 11:c8cbc4bc2c17 69
arch 11:c8cbc4bc2c17 70 //------------- MCU header -------------//
arch 11:c8cbc4bc2c17 71 //#include "nrf.h"
arch 11:c8cbc4bc2c17 72
arch 11:c8cbc4bc2c17 73 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 74 // TYPEDEFS
arch 11:c8cbc4bc2c17 75 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 76 typedef unsigned char byte_t;
arch 11:c8cbc4bc2c17 77 typedef float float32_t;
arch 11:c8cbc4bc2c17 78 typedef double float64_t;
arch 11:c8cbc4bc2c17 79
arch 11:c8cbc4bc2c17 80 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 81 // MACROS
arch 11:c8cbc4bc2c17 82 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 83 #define STRING_(x) #x // stringify without expand
arch 11:c8cbc4bc2c17 84 #define XSTRING_(x) STRING_(x) // expand then stringify
arch 11:c8cbc4bc2c17 85 #define STRING_CONCAT_(a, b) a##b // concat without expand
arch 11:c8cbc4bc2c17 86 #define XSTRING_CONCAT_(a, b) STRING_CONCAT_(a, b) // expand then concat
arch 11:c8cbc4bc2c17 87
arch 11:c8cbc4bc2c17 88 #define U16_HIGH_U8(u16) ((uint8_t) (((u16) >> 8) & 0x00ff))
arch 11:c8cbc4bc2c17 89 #define U16_LOW_U8(u16) ((uint8_t) ((u16) & 0x00ff))
arch 11:c8cbc4bc2c17 90 #define U16_TO_U8S_BE(u16) U16_HIGH_U8(u16), U16_LOW_U8(u16)
arch 11:c8cbc4bc2c17 91 #define U16_TO_U8S_LE(u16) U16_LOW_U8(u16), U16_HIGH_U8(u16)
arch 11:c8cbc4bc2c17 92
arch 11:c8cbc4bc2c17 93 #define U32_B1_U8(u32) ((uint8_t) (((u32) >> 24) & 0x000000ff)) // MSB
arch 11:c8cbc4bc2c17 94 #define U32_B2_U8(u32) ((uint8_t) (((u32) >> 16) & 0x000000ff))
arch 11:c8cbc4bc2c17 95 #define U32_B3_U8(u32) ((uint8_t) (((u32) >> 8) & 0x000000ff))
arch 11:c8cbc4bc2c17 96 #define U32_B4_U8(u32) ((uint8_t) ((u32) & 0x000000ff)) // LSB
arch 11:c8cbc4bc2c17 97
arch 11:c8cbc4bc2c17 98 #define U32_TO_U8S_BE(u32) U32_B1_U8(u32), U32_B2_U8(u32), U32_B3_U8(u32), U32_B4_U8(u32)
arch 11:c8cbc4bc2c17 99 #define U32_TO_U8S_LE(u32) U32_B4_U8(u32), U32_B3_U8(u32), U32_B2_U8(u32), U32_B1_U8(u32)
arch 11:c8cbc4bc2c17 100
arch 11:c8cbc4bc2c17 101 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 102 // INLINE FUNCTION
arch 11:c8cbc4bc2c17 103 //--------------------------------------------------------------------+
arch 11:c8cbc4bc2c17 104 #define memclr_(buffer, size) memset(buffer, 0, size)
arch 11:c8cbc4bc2c17 105
arch 11:c8cbc4bc2c17 106 //------------- Conversion -------------//
arch 11:c8cbc4bc2c17 107 /// form an uint32_t from 4 x uint8_t
arch 11:c8cbc4bc2c17 108 static inline uint32_t u32_from_u8(uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 109 static inline uint32_t u32_from_u8(uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4)
arch 11:c8cbc4bc2c17 110 {
arch 11:c8cbc4bc2c17 111 return (b1 << 24) + (b2 << 16) + (b3 << 8) + b4;
arch 11:c8cbc4bc2c17 112 }
arch 11:c8cbc4bc2c17 113
arch 11:c8cbc4bc2c17 114 static inline uint8_t u16_high_u8(uint16_t u16) ATTR_CONST ATTR_ALWAYS_INLINE;
arch 11:c8cbc4bc2c17 115 static inline uint8_t u16_high_u8(uint16_t u16)
arch 11:c8cbc4bc2c17 116 {
arch 11:c8cbc4bc2c17 117 return (uint8_t) ((u16 >> 8) & 0x00ff);
arch 11:c8cbc4bc2c17 118 }
arch 11:c8cbc4bc2c17 119
arch 11:c8cbc4bc2c17 120 static inline uint8_t u16_low_u8(uint16_t u16) ATTR_CONST ATTR_ALWAYS_INLINE;
arch 11:c8cbc4bc2c17 121 static inline uint8_t u16_low_u8(uint16_t u16)
arch 11:c8cbc4bc2c17 122 {
arch 11:c8cbc4bc2c17 123 return (uint8_t) (u16 & 0x00ff);
arch 11:c8cbc4bc2c17 124 }
arch 11:c8cbc4bc2c17 125
arch 11:c8cbc4bc2c17 126 //------------- Min -------------//
arch 11:c8cbc4bc2c17 127 static inline uint8_t min8_of(uint8_t x, uint8_t y) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 128 static inline uint8_t min8_of(uint8_t x, uint8_t y)
arch 11:c8cbc4bc2c17 129 {
arch 11:c8cbc4bc2c17 130 return (x < y) ? x : y;
arch 11:c8cbc4bc2c17 131 }
arch 11:c8cbc4bc2c17 132
arch 11:c8cbc4bc2c17 133 static inline uint16_t min16_of(uint16_t x, uint16_t y) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 134 static inline uint16_t min16_of(uint16_t x, uint16_t y)
arch 11:c8cbc4bc2c17 135 {
arch 11:c8cbc4bc2c17 136 return (x < y) ? x : y;
arch 11:c8cbc4bc2c17 137 }
arch 11:c8cbc4bc2c17 138
arch 11:c8cbc4bc2c17 139 static inline uint32_t min32_of(uint32_t x, uint32_t y) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 140 static inline uint32_t min32_of(uint32_t x, uint32_t y)
arch 11:c8cbc4bc2c17 141 {
arch 11:c8cbc4bc2c17 142 return (x < y) ? x : y;
arch 11:c8cbc4bc2c17 143 }
arch 11:c8cbc4bc2c17 144
arch 11:c8cbc4bc2c17 145 //------------- Max -------------//
arch 11:c8cbc4bc2c17 146 static inline uint32_t max32_of(uint32_t x, uint32_t y) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 147 static inline uint32_t max32_of(uint32_t x, uint32_t y)
arch 11:c8cbc4bc2c17 148 {
arch 11:c8cbc4bc2c17 149 return (x > y) ? x : y;
arch 11:c8cbc4bc2c17 150 }
arch 11:c8cbc4bc2c17 151
arch 11:c8cbc4bc2c17 152 //------------- Align -------------//
arch 11:c8cbc4bc2c17 153 static inline uint32_t align32 (uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 154 static inline uint32_t align32 (uint32_t value)
arch 11:c8cbc4bc2c17 155 {
arch 11:c8cbc4bc2c17 156 return (value & 0xFFFFFFE0UL);
arch 11:c8cbc4bc2c17 157 }
arch 11:c8cbc4bc2c17 158
arch 11:c8cbc4bc2c17 159 static inline uint32_t align16 (uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 160 static inline uint32_t align16 (uint32_t value)
arch 11:c8cbc4bc2c17 161 {
arch 11:c8cbc4bc2c17 162 return (value & 0xFFFFFFF0UL);
arch 11:c8cbc4bc2c17 163 }
arch 11:c8cbc4bc2c17 164
arch 11:c8cbc4bc2c17 165 static inline uint32_t align_n (uint32_t alignment, uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 166 static inline uint32_t align_n (uint32_t alignment, uint32_t value)
arch 11:c8cbc4bc2c17 167 {
arch 11:c8cbc4bc2c17 168 return value & (~(alignment-1));
arch 11:c8cbc4bc2c17 169 }
arch 11:c8cbc4bc2c17 170
arch 11:c8cbc4bc2c17 171 static inline uint32_t align4k (uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 172 static inline uint32_t align4k (uint32_t value)
arch 11:c8cbc4bc2c17 173 {
arch 11:c8cbc4bc2c17 174 return (value & 0xFFFFF000UL);
arch 11:c8cbc4bc2c17 175 }
arch 11:c8cbc4bc2c17 176
arch 11:c8cbc4bc2c17 177 static inline uint32_t offset4k(uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 178 static inline uint32_t offset4k(uint32_t value)
arch 11:c8cbc4bc2c17 179 {
arch 11:c8cbc4bc2c17 180 return (value & 0xFFFUL);
arch 11:c8cbc4bc2c17 181 }
arch 11:c8cbc4bc2c17 182
arch 11:c8cbc4bc2c17 183 //------------- Mathematics -------------//
arch 11:c8cbc4bc2c17 184 /// inclusive range checking
arch 11:c8cbc4bc2c17 185 static inline bool is_in_range(uint32_t lower, uint32_t value, uint32_t upper) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 186 static inline bool is_in_range(uint32_t lower, uint32_t value, uint32_t upper)
arch 11:c8cbc4bc2c17 187 {
arch 11:c8cbc4bc2c17 188 return (lower <= value) && (value <= upper);
arch 11:c8cbc4bc2c17 189 }
arch 11:c8cbc4bc2c17 190
arch 11:c8cbc4bc2c17 191 /// exclusive range checking
arch 11:c8cbc4bc2c17 192 static inline bool is_in_range_exclusive(uint32_t lower, uint32_t value, uint32_t upper) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 193 static inline bool is_in_range_exclusive(uint32_t lower, uint32_t value, uint32_t upper)
arch 11:c8cbc4bc2c17 194 {
arch 11:c8cbc4bc2c17 195 return (lower < value) && (value < upper);
arch 11:c8cbc4bc2c17 196 }
arch 11:c8cbc4bc2c17 197
arch 11:c8cbc4bc2c17 198 static inline uint8_t log2_of(uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 199 static inline uint8_t log2_of(uint32_t value)
arch 11:c8cbc4bc2c17 200 {
arch 11:c8cbc4bc2c17 201 uint8_t result = 0; // log2 of a value is its MSB's position
arch 11:c8cbc4bc2c17 202
arch 11:c8cbc4bc2c17 203 while (value >>= 1)
arch 11:c8cbc4bc2c17 204 {
arch 11:c8cbc4bc2c17 205 result++;
arch 11:c8cbc4bc2c17 206 }
arch 11:c8cbc4bc2c17 207 return result;
arch 11:c8cbc4bc2c17 208 }
arch 11:c8cbc4bc2c17 209
arch 11:c8cbc4bc2c17 210 // return the number of set bits in value
arch 11:c8cbc4bc2c17 211 static inline uint8_t cardinality_of(uint32_t value) ATTR_ALWAYS_INLINE ATTR_CONST;
arch 11:c8cbc4bc2c17 212 static inline uint8_t cardinality_of(uint32_t value)
arch 11:c8cbc4bc2c17 213 {
arch 11:c8cbc4bc2c17 214 // Brian Kernighan's method goes through as many iterations as there are set bits. So if we have a 32-bit word with only
arch 11:c8cbc4bc2c17 215 // the high bit set, then it will only go once through the loop
arch 11:c8cbc4bc2c17 216 // Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan and Dennis M. Ritchie)
arch 11:c8cbc4bc2c17 217 // mentions this in exercise 2-9. On April 19, 2006 Don Knuth pointed out to me that this method
arch 11:c8cbc4bc2c17 218 // "was first published by Peter Wegner in CACM 3 (1960), 322. (Also discovered independently by Derrick Lehmer and
arch 11:c8cbc4bc2c17 219 // published in 1964 in a book edited by Beckenbach.)"
arch 11:c8cbc4bc2c17 220 uint8_t count;
arch 11:c8cbc4bc2c17 221 for (count = 0; value; count++)
arch 11:c8cbc4bc2c17 222 {
arch 11:c8cbc4bc2c17 223 value &= value - 1; // clear the least significant bit set
arch 11:c8cbc4bc2c17 224 }
arch 11:c8cbc4bc2c17 225
arch 11:c8cbc4bc2c17 226 return count;
arch 11:c8cbc4bc2c17 227 }
arch 11:c8cbc4bc2c17 228
arch 11:c8cbc4bc2c17 229 #ifdef __cplusplus
arch 11:c8cbc4bc2c17 230 }
arch 11:c8cbc4bc2c17 231 #endif
arch 11:c8cbc4bc2c17 232
arch 11:c8cbc4bc2c17 233 #endif /* _COMMON_H_ */
arch 11:c8cbc4bc2c17 234
arch 11:c8cbc4bc2c17 235 /** @} */
arch 11:c8cbc4bc2c17 236 /** @} */