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_IAR/sdk_mapped_flags.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/sdk_mapped_flags.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) 2015 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 | #ifndef SDK_MAPPED_FLAGS_H__ |
AnnaBridge | 143:86740a56073b | 41 | #define SDK_MAPPED_FLAGS_H__ |
AnnaBridge | 143:86740a56073b | 42 | |
AnnaBridge | 143:86740a56073b | 43 | #include <stdint.h> |
AnnaBridge | 143:86740a56073b | 44 | #include <stdbool.h> |
AnnaBridge | 143:86740a56073b | 45 | #include "app_util.h" |
AnnaBridge | 143:86740a56073b | 46 | #include "compiler_abstraction.h" |
AnnaBridge | 143:86740a56073b | 47 | |
AnnaBridge | 143:86740a56073b | 48 | /** |
AnnaBridge | 143:86740a56073b | 49 | * @file |
AnnaBridge | 143:86740a56073b | 50 | * @defgroup sdk_mapped_flags Mapped flags |
AnnaBridge | 143:86740a56073b | 51 | * @ingroup app_common |
AnnaBridge | 143:86740a56073b | 52 | * @{ |
AnnaBridge | 143:86740a56073b | 53 | * @brief Module for writing and reading flags that are associated |
AnnaBridge | 143:86740a56073b | 54 | * with keys. |
AnnaBridge | 143:86740a56073b | 55 | * |
AnnaBridge | 143:86740a56073b | 56 | * @details The flags are represented as bits in a bitmap called a <i>flag collection</i>. The keys |
AnnaBridge | 143:86740a56073b | 57 | * are uint16_t. Each flag collection contains all flags of the same type, one flag for |
AnnaBridge | 143:86740a56073b | 58 | * each key. |
AnnaBridge | 143:86740a56073b | 59 | * |
AnnaBridge | 143:86740a56073b | 60 | * The mapped flags module does not keep the flag states, nor the list of keys. These are |
AnnaBridge | 143:86740a56073b | 61 | * provided in the API calls. A key's index in the key list determines which bit in the |
AnnaBridge | 143:86740a56073b | 62 | * flag collection is associated with it. This module does not ever edit the key list, and |
AnnaBridge | 143:86740a56073b | 63 | * does not edit flags except in function calls that take the flag collection as a pointer. |
AnnaBridge | 143:86740a56073b | 64 | * |
AnnaBridge | 143:86740a56073b | 65 | */ |
AnnaBridge | 143:86740a56073b | 66 | |
AnnaBridge | 143:86740a56073b | 67 | #define SDK_MAPPED_FLAGS_N_KEYS 8 /**< The number of keys to keep flags for. This is also the number of flags in a flag collection. If changing this value, you might also need change the width of the sdk_mapped_flags_t type. */ |
AnnaBridge | 143:86740a56073b | 68 | #define SDK_MAPPED_FLAGS_N_KEYS_PER_BYTE 8 /**< The number of flags that fit in one byte. */ |
AnnaBridge | 143:86740a56073b | 69 | #define SDK_MAPPED_FLAGS_INVALID_INDEX 0xFFFF /**< A flag index guaranteed to be invalid. */ |
AnnaBridge | 143:86740a56073b | 70 | |
AnnaBridge | 143:86740a56073b | 71 | typedef uint8_t sdk_mapped_flags_t; /**< The bitmap to hold flags. Each flag is one bit, and each bit represents the flag state associated with one key. */ |
AnnaBridge | 143:86740a56073b | 72 | |
AnnaBridge | 143:86740a56073b | 73 | |
AnnaBridge | 143:86740a56073b | 74 | // Test whether the flag collection type is large enough to hold all the flags. If this fails, |
AnnaBridge | 143:86740a56073b | 75 | // reduce SDK_MAPPED_FLAGS_N_KEYS or increase the size of sdk_mapped_flags_t. |
AnnaBridge | 143:86740a56073b | 76 | STATIC_ASSERT(( |
AnnaBridge | 143:86740a56073b | 77 | sizeof(sdk_mapped_flags_t)*SDK_MAPPED_FLAGS_N_KEYS_PER_BYTE) >= SDK_MAPPED_FLAGS_N_KEYS); |
AnnaBridge | 143:86740a56073b | 78 | |
AnnaBridge | 143:86740a56073b | 79 | |
AnnaBridge | 143:86740a56073b | 80 | /**@brief Type used to present a subset of the registered keys. |
AnnaBridge | 143:86740a56073b | 81 | */ |
AnnaBridge | 143:86740a56073b | 82 | typedef struct |
AnnaBridge | 143:86740a56073b | 83 | { |
AnnaBridge | 143:86740a56073b | 84 | uint32_t len; /**< The length of the list. */ |
AnnaBridge | 143:86740a56073b | 85 | uint16_t flag_keys[SDK_MAPPED_FLAGS_N_KEYS]; /**< The list of keys. */ |
AnnaBridge | 143:86740a56073b | 86 | } sdk_mapped_flags_key_list_t; |
AnnaBridge | 143:86740a56073b | 87 | |
AnnaBridge | 143:86740a56073b | 88 | |
AnnaBridge | 143:86740a56073b | 89 | /**@brief Function for getting the first index at which the flag is true in the provided |
AnnaBridge | 143:86740a56073b | 90 | * collection. |
AnnaBridge | 143:86740a56073b | 91 | * |
AnnaBridge | 143:86740a56073b | 92 | * @param[in] flags The flag collection to search for a flag set to true. |
AnnaBridge | 143:86740a56073b | 93 | * |
AnnaBridge | 143:86740a56073b | 94 | * @return The first index that has its flag set to true. If none were found, the |
AnnaBridge | 143:86740a56073b | 95 | * function returns @ref SDK_MAPPED_FLAGS_INVALID_INDEX. |
AnnaBridge | 143:86740a56073b | 96 | */ |
AnnaBridge | 143:86740a56073b | 97 | uint16_t sdk_mapped_flags_first_key_index_get(sdk_mapped_flags_t flags); |
AnnaBridge | 143:86740a56073b | 98 | |
AnnaBridge | 143:86740a56073b | 99 | |
AnnaBridge | 143:86740a56073b | 100 | /**@brief Function for updating the state of a flag. |
AnnaBridge | 143:86740a56073b | 101 | * |
AnnaBridge | 143:86740a56073b | 102 | * @param[in] p_keys The list of associated keys (assumed to have a length of |
AnnaBridge | 143:86740a56073b | 103 | * @ref SDK_MAPPED_FLAGS_N_KEYS). |
AnnaBridge | 143:86740a56073b | 104 | * @param[out] p_flags The flag collection to modify. |
AnnaBridge | 143:86740a56073b | 105 | * @param[in] key The key to modify the flag of. |
AnnaBridge | 143:86740a56073b | 106 | * @param[in] value The state to set the flag to. |
AnnaBridge | 143:86740a56073b | 107 | */ |
AnnaBridge | 143:86740a56073b | 108 | void sdk_mapped_flags_update_by_key(uint16_t * p_keys, |
AnnaBridge | 143:86740a56073b | 109 | sdk_mapped_flags_t * p_flags, |
AnnaBridge | 143:86740a56073b | 110 | uint16_t key, |
AnnaBridge | 143:86740a56073b | 111 | bool value); |
AnnaBridge | 143:86740a56073b | 112 | |
AnnaBridge | 143:86740a56073b | 113 | |
AnnaBridge | 143:86740a56073b | 114 | /**@brief Function for updating the state of the same flag in multiple flag collections. |
AnnaBridge | 143:86740a56073b | 115 | * |
AnnaBridge | 143:86740a56073b | 116 | * @details The key and value are the same for all flag collections in the p_flags array. |
AnnaBridge | 143:86740a56073b | 117 | * |
AnnaBridge | 143:86740a56073b | 118 | * @param[in] p_keys The list of associated keys (assumed to have a length of |
AnnaBridge | 143:86740a56073b | 119 | * @ref SDK_MAPPED_FLAGS_N_KEYS). |
AnnaBridge | 143:86740a56073b | 120 | * @param[out] p_flags The flag collections to modify. |
AnnaBridge | 143:86740a56073b | 121 | * @param[out] n_flag_collections The number of flag collections in p_flags. |
AnnaBridge | 143:86740a56073b | 122 | * @param[in] key The key to modify the flag of. |
AnnaBridge | 143:86740a56073b | 123 | * @param[in] value The state to set the flag to. |
AnnaBridge | 143:86740a56073b | 124 | */ |
AnnaBridge | 143:86740a56073b | 125 | void sdk_mapped_flags_bulk_update_by_key(uint16_t * p_keys, |
AnnaBridge | 143:86740a56073b | 126 | sdk_mapped_flags_t * p_flags, |
AnnaBridge | 143:86740a56073b | 127 | uint32_t n_flag_collections, |
AnnaBridge | 143:86740a56073b | 128 | uint16_t key, |
AnnaBridge | 143:86740a56073b | 129 | bool value); |
AnnaBridge | 143:86740a56073b | 130 | |
AnnaBridge | 143:86740a56073b | 131 | |
AnnaBridge | 143:86740a56073b | 132 | /**@brief Function for getting the state of a specific flag. |
AnnaBridge | 143:86740a56073b | 133 | * |
AnnaBridge | 143:86740a56073b | 134 | * @param[in] p_keys The list of associated keys (assumed to have a length of |
AnnaBridge | 143:86740a56073b | 135 | * @ref SDK_MAPPED_FLAGS_N_KEYS). |
AnnaBridge | 143:86740a56073b | 136 | * @param[in] flags The flag collection to read from. |
AnnaBridge | 143:86740a56073b | 137 | * @param[in] key The key to get the flag for. |
AnnaBridge | 143:86740a56073b | 138 | * |
AnnaBridge | 143:86740a56073b | 139 | * @return The state of the flag. |
AnnaBridge | 143:86740a56073b | 140 | */ |
AnnaBridge | 143:86740a56073b | 141 | bool sdk_mapped_flags_get_by_key(uint16_t * p_keys, sdk_mapped_flags_t flags, uint16_t key); |
AnnaBridge | 143:86740a56073b | 142 | |
AnnaBridge | 143:86740a56073b | 143 | |
AnnaBridge | 143:86740a56073b | 144 | /**@brief Function for getting a list of all keys that have a specific flag set to true. |
AnnaBridge | 143:86740a56073b | 145 | * |
AnnaBridge | 143:86740a56073b | 146 | * @param[in] p_keys The list of associated keys (assumed to have a length of |
AnnaBridge | 143:86740a56073b | 147 | * @ref SDK_MAPPED_FLAGS_N_KEYS). |
AnnaBridge | 143:86740a56073b | 148 | * @param[in] flags The flag collection to search. |
AnnaBridge | 143:86740a56073b | 149 | * |
AnnaBridge | 143:86740a56073b | 150 | * @return The list of keys. |
AnnaBridge | 143:86740a56073b | 151 | */ |
AnnaBridge | 143:86740a56073b | 152 | sdk_mapped_flags_key_list_t sdk_mapped_flags_key_list_get(uint16_t * p_keys, |
AnnaBridge | 143:86740a56073b | 153 | sdk_mapped_flags_t flags); |
AnnaBridge | 143:86740a56073b | 154 | |
AnnaBridge | 143:86740a56073b | 155 | |
AnnaBridge | 143:86740a56073b | 156 | /**@brief Function for getting the number of keys that have a specific flag set to true. |
AnnaBridge | 143:86740a56073b | 157 | * |
AnnaBridge | 143:86740a56073b | 158 | * @param[in] flags The flag collection to search. |
AnnaBridge | 143:86740a56073b | 159 | * |
AnnaBridge | 143:86740a56073b | 160 | * @return The number of keys. |
AnnaBridge | 143:86740a56073b | 161 | */ |
AnnaBridge | 143:86740a56073b | 162 | uint32_t sdk_mapped_flags_n_flags_set(sdk_mapped_flags_t flags); |
AnnaBridge | 143:86740a56073b | 163 | |
AnnaBridge | 143:86740a56073b | 164 | |
AnnaBridge | 143:86740a56073b | 165 | /**@brief Function for querying whether any flags in the collection are set. |
AnnaBridge | 143:86740a56073b | 166 | * |
AnnaBridge | 143:86740a56073b | 167 | * @param[in] flags The flag collection to query. |
AnnaBridge | 143:86740a56073b | 168 | * |
AnnaBridge | 143:86740a56073b | 169 | * @retval true If one or more flags are set to true. |
AnnaBridge | 143:86740a56073b | 170 | * @retval false Otherwise. |
AnnaBridge | 143:86740a56073b | 171 | */ |
AnnaBridge | 143:86740a56073b | 172 | static __INLINE bool sdk_mapped_flags_any_set(sdk_mapped_flags_t flags) |
AnnaBridge | 143:86740a56073b | 173 | { |
AnnaBridge | 143:86740a56073b | 174 | return (flags != 0); |
AnnaBridge | 143:86740a56073b | 175 | } |
AnnaBridge | 143:86740a56073b | 176 | |
AnnaBridge | 143:86740a56073b | 177 | |
AnnaBridge | 143:86740a56073b | 178 | /** @} */ |
AnnaBridge | 143:86740a56073b | 179 | |
AnnaBridge | 143:86740a56073b | 180 | #endif /* SDK_MAPPED_FLAGS_H__ */ |