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_VBLUNO51/TOOLCHAIN_ARM_STD/nordic_common.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_TY51822R3/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/libraries/util/nordic_common.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 143:86740a56073b | 1 | /* |
AnnaBridge | 143:86740a56073b | 2 | * Copyright (c) 2008 Nordic Semiconductor ASA |
AnnaBridge | 143:86740a56073b | 3 | * All rights reserved. |
AnnaBridge | 143:86740a56073b | 4 | * |
AnnaBridge | 143:86740a56073b | 5 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 143:86740a56073b | 6 | * are permitted provided that the following conditions are met: |
AnnaBridge | 143:86740a56073b | 7 | * |
AnnaBridge | 143:86740a56073b | 8 | * 1. Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 143:86740a56073b | 9 | * of conditions and the following disclaimer. |
AnnaBridge | 143:86740a56073b | 10 | * |
AnnaBridge | 143:86740a56073b | 11 | * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA |
AnnaBridge | 143:86740a56073b | 12 | * integrated circuit in a product or a software update for such product, must reproduce |
AnnaBridge | 143:86740a56073b | 13 | * the above copyright notice, this list of conditions and the following disclaimer in |
AnnaBridge | 143:86740a56073b | 14 | * the documentation and/or other materials provided with the distribution. |
AnnaBridge | 143:86740a56073b | 15 | * |
AnnaBridge | 143:86740a56073b | 16 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be |
AnnaBridge | 143:86740a56073b | 17 | * used to endorse or promote products derived from this software without specific prior |
AnnaBridge | 143:86740a56073b | 18 | * written permission. |
AnnaBridge | 143:86740a56073b | 19 | * |
AnnaBridge | 143:86740a56073b | 20 | * 4. This software, with or without modification, must only be used with a |
AnnaBridge | 143:86740a56073b | 21 | * Nordic Semiconductor ASA integrated circuit. |
AnnaBridge | 143:86740a56073b | 22 | * |
AnnaBridge | 143:86740a56073b | 23 | * 5. Any software provided in binary or object form under this license must not be reverse |
AnnaBridge | 143:86740a56073b | 24 | * engineered, decompiled, modified and/or disassembled. |
AnnaBridge | 143:86740a56073b | 25 | * |
AnnaBridge | 143:86740a56073b | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 143:86740a56073b | 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 143:86740a56073b | 28 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 143:86740a56073b | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 143:86740a56073b | 30 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 143:86740a56073b | 31 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 143:86740a56073b | 32 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 143:86740a56073b | 33 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 143:86740a56073b | 34 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 143:86740a56073b | 35 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 143:86740a56073b | 36 | * |
AnnaBridge | 143:86740a56073b | 37 | */ |
AnnaBridge | 143:86740a56073b | 38 | |
AnnaBridge | 143:86740a56073b | 39 | |
AnnaBridge | 143:86740a56073b | 40 | /** @file |
AnnaBridge | 143:86740a56073b | 41 | * @brief Common defines and macros for firmware developed by Nordic Semiconductor. |
AnnaBridge | 143:86740a56073b | 42 | */ |
AnnaBridge | 143:86740a56073b | 43 | |
AnnaBridge | 143:86740a56073b | 44 | #ifndef NORDIC_COMMON_H__ |
AnnaBridge | 143:86740a56073b | 45 | #define NORDIC_COMMON_H__ |
AnnaBridge | 143:86740a56073b | 46 | |
AnnaBridge | 143:86740a56073b | 47 | /** The upper 8 bits of a 32 bit value */ |
AnnaBridge | 143:86740a56073b | 48 | //lint -emacro(572,MSB) // Suppress warning 572 "Excessive shift value" |
AnnaBridge | 143:86740a56073b | 49 | #define MSB_32(a) (((a) & 0xFF000000) >> 24) |
AnnaBridge | 143:86740a56073b | 50 | /** The lower 8 bits (of a 32 bit value) */ |
AnnaBridge | 143:86740a56073b | 51 | #define LSB_32(a) ((a) & 0x000000FF) |
AnnaBridge | 143:86740a56073b | 52 | |
AnnaBridge | 143:86740a56073b | 53 | /** The upper 8 bits of a 16 bit value */ |
AnnaBridge | 143:86740a56073b | 54 | //lint -emacro(572,MSB_16) // Suppress warning 572 "Excessive shift value" |
AnnaBridge | 143:86740a56073b | 55 | #define MSB_16(a) (((a) & 0xFF00) >> 8) |
AnnaBridge | 143:86740a56073b | 56 | /** The lower 8 bits (of a 16 bit value) */ |
AnnaBridge | 143:86740a56073b | 57 | #define LSB_16(a) ((a) & 0x00FF) |
AnnaBridge | 143:86740a56073b | 58 | |
AnnaBridge | 143:86740a56073b | 59 | /** Leaves the minimum of the two 32-bit arguments */ |
AnnaBridge | 143:86740a56073b | 60 | /*lint -emacro(506, MIN) */ /* Suppress "Constant value Boolean */ |
AnnaBridge | 143:86740a56073b | 61 | #define MIN(a, b) ((a) < (b) ? (a) : (b)) |
AnnaBridge | 143:86740a56073b | 62 | /** Leaves the maximum of the two 32-bit arguments */ |
AnnaBridge | 143:86740a56073b | 63 | /*lint -emacro(506, MAX) */ /* Suppress "Constant value Boolean */ |
AnnaBridge | 143:86740a56073b | 64 | #define MAX(a, b) ((a) < (b) ? (b) : (a)) |
AnnaBridge | 143:86740a56073b | 65 | |
AnnaBridge | 143:86740a56073b | 66 | /** Concatenates two parameters. Useful as a second level of indirection, |
AnnaBridge | 143:86740a56073b | 67 | * when a parameter can be macro itself. */ |
AnnaBridge | 143:86740a56073b | 68 | #define CONCAT_2(p1, p2) p1##p2 |
AnnaBridge | 143:86740a56073b | 69 | /** Concatenates three parameters. Useful as a second level of indirection, |
AnnaBridge | 143:86740a56073b | 70 | * when a parameter can be macro itself. */ |
AnnaBridge | 143:86740a56073b | 71 | #define CONCAT_3(p1, p2, p3) p1##p2##p3 |
AnnaBridge | 143:86740a56073b | 72 | |
AnnaBridge | 143:86740a56073b | 73 | /**@brief Set a bit in the uint32 word. |
AnnaBridge | 143:86740a56073b | 74 | * |
AnnaBridge | 143:86740a56073b | 75 | * @param[in] W Word whose bit is being set. |
AnnaBridge | 143:86740a56073b | 76 | * @param[in] B Bit number in the word to be set. |
AnnaBridge | 143:86740a56073b | 77 | */ |
AnnaBridge | 143:86740a56073b | 78 | #define SET_BIT(W,B) ((W) |= (uint32_t)(1U << (B))) |
AnnaBridge | 143:86740a56073b | 79 | |
AnnaBridge | 143:86740a56073b | 80 | |
AnnaBridge | 143:86740a56073b | 81 | /**@brief Clears a bit in the uint32 word. |
AnnaBridge | 143:86740a56073b | 82 | * |
AnnaBridge | 143:86740a56073b | 83 | * @param[in] W Word whose bit is to be cleared. |
AnnaBridge | 143:86740a56073b | 84 | * @param[in] B Bit number in the word to be cleared. |
AnnaBridge | 143:86740a56073b | 85 | */ |
AnnaBridge | 143:86740a56073b | 86 | #define CLR_BIT(W, B) ((W) &= (~((uint32_t)1 << (B)))) |
AnnaBridge | 143:86740a56073b | 87 | |
AnnaBridge | 143:86740a56073b | 88 | |
AnnaBridge | 143:86740a56073b | 89 | /**@brief Checks if a bit is set. |
AnnaBridge | 143:86740a56073b | 90 | * |
AnnaBridge | 143:86740a56073b | 91 | * @param[in] W Word whose bit is to be checked. |
AnnaBridge | 143:86740a56073b | 92 | * @param[in] B Bit number in the word to be checked. |
AnnaBridge | 143:86740a56073b | 93 | * |
AnnaBridge | 143:86740a56073b | 94 | * @retval 1 if bit is set. |
AnnaBridge | 143:86740a56073b | 95 | * @retval 0 if bit is not set. |
AnnaBridge | 143:86740a56073b | 96 | */ |
AnnaBridge | 143:86740a56073b | 97 | #define IS_SET(W,B) (((W) >> (B)) & 1) |
AnnaBridge | 143:86740a56073b | 98 | |
AnnaBridge | 143:86740a56073b | 99 | #define BIT_0 0x01 /**< The value of bit 0 */ |
AnnaBridge | 143:86740a56073b | 100 | #define BIT_1 0x02 /**< The value of bit 1 */ |
AnnaBridge | 143:86740a56073b | 101 | #define BIT_2 0x04 /**< The value of bit 2 */ |
AnnaBridge | 143:86740a56073b | 102 | #define BIT_3 0x08 /**< The value of bit 3 */ |
AnnaBridge | 143:86740a56073b | 103 | #define BIT_4 0x10 /**< The value of bit 4 */ |
AnnaBridge | 143:86740a56073b | 104 | #define BIT_5 0x20 /**< The value of bit 5 */ |
AnnaBridge | 143:86740a56073b | 105 | #define BIT_6 0x40 /**< The value of bit 6 */ |
AnnaBridge | 143:86740a56073b | 106 | #define BIT_7 0x80 /**< The value of bit 7 */ |
AnnaBridge | 143:86740a56073b | 107 | #define BIT_8 0x0100 /**< The value of bit 8 */ |
AnnaBridge | 143:86740a56073b | 108 | #define BIT_9 0x0200 /**< The value of bit 9 */ |
AnnaBridge | 143:86740a56073b | 109 | #define BIT_10 0x0400 /**< The value of bit 10 */ |
AnnaBridge | 143:86740a56073b | 110 | #define BIT_11 0x0800 /**< The value of bit 11 */ |
AnnaBridge | 143:86740a56073b | 111 | #define BIT_12 0x1000 /**< The value of bit 12 */ |
AnnaBridge | 143:86740a56073b | 112 | #define BIT_13 0x2000 /**< The value of bit 13 */ |
AnnaBridge | 143:86740a56073b | 113 | #define BIT_14 0x4000 /**< The value of bit 14 */ |
AnnaBridge | 143:86740a56073b | 114 | #define BIT_15 0x8000 /**< The value of bit 15 */ |
AnnaBridge | 143:86740a56073b | 115 | #define BIT_16 0x00010000 /**< The value of bit 16 */ |
AnnaBridge | 143:86740a56073b | 116 | #define BIT_17 0x00020000 /**< The value of bit 17 */ |
AnnaBridge | 143:86740a56073b | 117 | #define BIT_18 0x00040000 /**< The value of bit 18 */ |
AnnaBridge | 143:86740a56073b | 118 | #define BIT_19 0x00080000 /**< The value of bit 19 */ |
AnnaBridge | 143:86740a56073b | 119 | #define BIT_20 0x00100000 /**< The value of bit 20 */ |
AnnaBridge | 143:86740a56073b | 120 | #define BIT_21 0x00200000 /**< The value of bit 21 */ |
AnnaBridge | 143:86740a56073b | 121 | #define BIT_22 0x00400000 /**< The value of bit 22 */ |
AnnaBridge | 143:86740a56073b | 122 | #define BIT_23 0x00800000 /**< The value of bit 23 */ |
AnnaBridge | 143:86740a56073b | 123 | #define BIT_24 0x01000000 /**< The value of bit 24 */ |
AnnaBridge | 143:86740a56073b | 124 | #define BIT_25 0x02000000 /**< The value of bit 25 */ |
AnnaBridge | 143:86740a56073b | 125 | #define BIT_26 0x04000000 /**< The value of bit 26 */ |
AnnaBridge | 143:86740a56073b | 126 | #define BIT_27 0x08000000 /**< The value of bit 27 */ |
AnnaBridge | 143:86740a56073b | 127 | #define BIT_28 0x10000000 /**< The value of bit 28 */ |
AnnaBridge | 143:86740a56073b | 128 | #define BIT_29 0x20000000 /**< The value of bit 29 */ |
AnnaBridge | 143:86740a56073b | 129 | #define BIT_30 0x40000000 /**< The value of bit 30 */ |
AnnaBridge | 143:86740a56073b | 130 | #define BIT_31 0x80000000 /**< The value of bit 31 */ |
AnnaBridge | 143:86740a56073b | 131 | |
AnnaBridge | 143:86740a56073b | 132 | #define UNUSED_VARIABLE(X) ((void)(X)) |
AnnaBridge | 143:86740a56073b | 133 | #define UNUSED_PARAMETER(X) UNUSED_VARIABLE(X) |
AnnaBridge | 143:86740a56073b | 134 | #define UNUSED_RETURN_VALUE(X) UNUSED_VARIABLE(X) |
AnnaBridge | 143:86740a56073b | 135 | |
AnnaBridge | 143:86740a56073b | 136 | #endif // NORDIC_COMMON_H__ |