Pedro Correia / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

targets/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/libraries/util/nordic_common.h@186:707f6e361f3e, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 16:45:37 2018 +0100
Revision:
186:707f6e361f3e
Parent:
targets/TARGET_NORDIC/TARGET_NRF5/TARGET_SDK11/libraries/util/nordic_common.h@165:e614a9f1c9e2 
mbed-dev library. Release version 162

Who changed what in which revision?

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