Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/features/FEATURE_BLE/ble/BLEInstanceBase.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
marcozecchini 0:9fca2b23d0ba 1 /* mbed Microcontroller Library
marcozecchini 0:9fca2b23d0ba 2 * Copyright (c) 2006-2013 ARM Limited
marcozecchini 0:9fca2b23d0ba 3 *
marcozecchini 0:9fca2b23d0ba 4 * Licensed under the Apache License, Version 2.0 (the "License");
marcozecchini 0:9fca2b23d0ba 5 * you may not use this file except in compliance with the License.
marcozecchini 0:9fca2b23d0ba 6 * You may obtain a copy of the License at
marcozecchini 0:9fca2b23d0ba 7 *
marcozecchini 0:9fca2b23d0ba 8 * http://www.apache.org/licenses/LICENSE-2.0
marcozecchini 0:9fca2b23d0ba 9 *
marcozecchini 0:9fca2b23d0ba 10 * Unless required by applicable law or agreed to in writing, software
marcozecchini 0:9fca2b23d0ba 11 * distributed under the License is distributed on an "AS IS" BASIS,
marcozecchini 0:9fca2b23d0ba 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
marcozecchini 0:9fca2b23d0ba 13 * See the License for the specific language governing permissions and
marcozecchini 0:9fca2b23d0ba 14 * limitations under the License.
marcozecchini 0:9fca2b23d0ba 15 */
marcozecchini 0:9fca2b23d0ba 16
marcozecchini 0:9fca2b23d0ba 17 /**
marcozecchini 0:9fca2b23d0ba 18 * @file
marcozecchini 0:9fca2b23d0ba 19 */
marcozecchini 0:9fca2b23d0ba 20
marcozecchini 0:9fca2b23d0ba 21 #ifndef MBED_BLE_DEVICE_INSTANCE_BASE__
marcozecchini 0:9fca2b23d0ba 22 #define MBED_BLE_DEVICE_INSTANCE_BASE__
marcozecchini 0:9fca2b23d0ba 23
marcozecchini 0:9fca2b23d0ba 24 #include "Gap.h"
marcozecchini 0:9fca2b23d0ba 25 #include "ble/SecurityManager.h"
marcozecchini 0:9fca2b23d0ba 26 #include "ble/BLE.h"
marcozecchini 0:9fca2b23d0ba 27
marcozecchini 0:9fca2b23d0ba 28 /* Forward declarations. */
marcozecchini 0:9fca2b23d0ba 29 class GattServer;
marcozecchini 0:9fca2b23d0ba 30 class GattClient;
marcozecchini 0:9fca2b23d0ba 31
marcozecchini 0:9fca2b23d0ba 32 /**
marcozecchini 0:9fca2b23d0ba 33 * @addtogroup ble
marcozecchini 0:9fca2b23d0ba 34 * @{
marcozecchini 0:9fca2b23d0ba 35 * @addtogroup porting
marcozecchini 0:9fca2b23d0ba 36 * @{
marcozecchini 0:9fca2b23d0ba 37 */
marcozecchini 0:9fca2b23d0ba 38
marcozecchini 0:9fca2b23d0ba 39 /**
marcozecchini 0:9fca2b23d0ba 40 * Private interface used to implement the BLE class.
marcozecchini 0:9fca2b23d0ba 41 *
marcozecchini 0:9fca2b23d0ba 42 * The BLE class delegates all its abstract operations to an instance of this
marcozecchini 0:9fca2b23d0ba 43 * abstract class, which every vendor port of Mbed BLE shall implement.
marcozecchini 0:9fca2b23d0ba 44 *
marcozecchini 0:9fca2b23d0ba 45 * The vendor port shall also define an implementation of the freestanding function
marcozecchini 0:9fca2b23d0ba 46 * createBLEInstance(). The BLE API uses this singleton function to gain
marcozecchini 0:9fca2b23d0ba 47 * access to a concrete implementation of this class defined in the vendor port.
marcozecchini 0:9fca2b23d0ba 48 *
marcozecchini 0:9fca2b23d0ba 49 * @important This class is part of the porting API and is not meant to be used
marcozecchini 0:9fca2b23d0ba 50 * by end users of BLE API.
marcozecchini 0:9fca2b23d0ba 51 *
marcozecchini 0:9fca2b23d0ba 52 * @see BLE
marcozecchini 0:9fca2b23d0ba 53 */
marcozecchini 0:9fca2b23d0ba 54 class BLEInstanceBase
marcozecchini 0:9fca2b23d0ba 55 {
marcozecchini 0:9fca2b23d0ba 56 public:
marcozecchini 0:9fca2b23d0ba 57 /**
marcozecchini 0:9fca2b23d0ba 58 * Base constructor.
marcozecchini 0:9fca2b23d0ba 59 */
marcozecchini 0:9fca2b23d0ba 60 BLEInstanceBase() {}
marcozecchini 0:9fca2b23d0ba 61
marcozecchini 0:9fca2b23d0ba 62 /**
marcozecchini 0:9fca2b23d0ba 63 * Virtual destructor of the interface.
marcozecchini 0:9fca2b23d0ba 64 */
marcozecchini 0:9fca2b23d0ba 65 virtual ~BLEInstanceBase();
marcozecchini 0:9fca2b23d0ba 66
marcozecchini 0:9fca2b23d0ba 67 /**
marcozecchini 0:9fca2b23d0ba 68 * Process ALL pending events living in the vendor BLE subsystem.
marcozecchini 0:9fca2b23d0ba 69 *
marcozecchini 0:9fca2b23d0ba 70 * Return once all pending events have been consumed.
marcozecchini 0:9fca2b23d0ba 71 *
marcozecchini 0:9fca2b23d0ba 72 * @see BLE::processEvents()
marcozecchini 0:9fca2b23d0ba 73 */
marcozecchini 0:9fca2b23d0ba 74 virtual void processEvents() = 0;
marcozecchini 0:9fca2b23d0ba 75
marcozecchini 0:9fca2b23d0ba 76 /**
marcozecchini 0:9fca2b23d0ba 77 * Signal to BLE that events needing processing are available.
marcozecchini 0:9fca2b23d0ba 78 *
marcozecchini 0:9fca2b23d0ba 79 * The vendor port shall call this function whenever there are events
marcozecchini 0:9fca2b23d0ba 80 * ready to be processed in the internal stack or BLE subsystem. As a result
marcozecchini 0:9fca2b23d0ba 81 * of this call, the callback registered by the end user via
marcozecchini 0:9fca2b23d0ba 82 * BLE::onEventsToProcess will be invoked.
marcozecchini 0:9fca2b23d0ba 83 *
marcozecchini 0:9fca2b23d0ba 84 * @param[in] id: Identifier of the BLE instance, which does have events to
marcozecchini 0:9fca2b23d0ba 85 * ready to be processed.
marcozecchini 0:9fca2b23d0ba 86 */
marcozecchini 0:9fca2b23d0ba 87 void signalEventsToProcess(BLE::InstanceID_t id);
marcozecchini 0:9fca2b23d0ba 88
marcozecchini 0:9fca2b23d0ba 89 /**
marcozecchini 0:9fca2b23d0ba 90 * Start the initialization of the vendor BLE subsystem.
marcozecchini 0:9fca2b23d0ba 91 *
marcozecchini 0:9fca2b23d0ba 92 * Calls to this function are initiated by BLE::init, instanceID identify
marcozecchini 0:9fca2b23d0ba 93 * the BLE instance which issue that call while the initCallback is used to
marcozecchini 0:9fca2b23d0ba 94 * signal asynchronously the completion of the initialization process.
marcozecchini 0:9fca2b23d0ba 95 *
marcozecchini 0:9fca2b23d0ba 96 * @param[in] instanceID Identifier of the BLE instance requesting
marcozecchini 0:9fca2b23d0ba 97 * initialization.
marcozecchini 0:9fca2b23d0ba 98 * @param[in] initCallback Callback which the vendor port shall invoke
marcozecchini 0:9fca2b23d0ba 99 * when the initialization completes.
marcozecchini 0:9fca2b23d0ba 100 *
marcozecchini 0:9fca2b23d0ba 101 * This is an optional parameter set to NULL when not supplied.
marcozecchini 0:9fca2b23d0ba 102 *
marcozecchini 0:9fca2b23d0ba 103 * @return BLE_ERROR_NONE if the initialization procedure started
marcozecchini 0:9fca2b23d0ba 104 * successfully.
marcozecchini 0:9fca2b23d0ba 105 *
marcozecchini 0:9fca2b23d0ba 106 * @post initCallback shall be invoked upon completion of the initialization
marcozecchini 0:9fca2b23d0ba 107 * process.
marcozecchini 0:9fca2b23d0ba 108 *
marcozecchini 0:9fca2b23d0ba 109 * @post hasInitialized() shall return false until the initialization is
marcozecchini 0:9fca2b23d0ba 110 * complete, and it shall return true after succesful completion of the
marcozecchini 0:9fca2b23d0ba 111 * initialization process.
marcozecchini 0:9fca2b23d0ba 112 *
marcozecchini 0:9fca2b23d0ba 113 * @see BLE::init()
marcozecchini 0:9fca2b23d0ba 114 */
marcozecchini 0:9fca2b23d0ba 115 virtual ble_error_t init(
marcozecchini 0:9fca2b23d0ba 116 BLE::InstanceID_t instanceID,
marcozecchini 0:9fca2b23d0ba 117 FunctionPointerWithContext<BLE::InitializationCompleteCallbackContext*> initCallback
marcozecchini 0:9fca2b23d0ba 118 ) = 0;
marcozecchini 0:9fca2b23d0ba 119
marcozecchini 0:9fca2b23d0ba 120 /**
marcozecchini 0:9fca2b23d0ba 121 * Check whether the vendor BLE subsystem has been initialized or not.
marcozecchini 0:9fca2b23d0ba 122 *
marcozecchini 0:9fca2b23d0ba 123 * @return true if the initialization has completed for the vendor BLE
marcozecchini 0:9fca2b23d0ba 124 * subsystem.
marcozecchini 0:9fca2b23d0ba 125 *
marcozecchini 0:9fca2b23d0ba 126 * @note this function is invoked by BLE::hasInitialized()
marcozecchini 0:9fca2b23d0ba 127 *
marcozecchini 0:9fca2b23d0ba 128 * @see BLE::init() BLE::hasInitialized()
marcozecchini 0:9fca2b23d0ba 129 */
marcozecchini 0:9fca2b23d0ba 130 virtual bool hasInitialized(void) const = 0;
marcozecchini 0:9fca2b23d0ba 131
marcozecchini 0:9fca2b23d0ba 132 /**
marcozecchini 0:9fca2b23d0ba 133 * Shutdown the vendor BLE subsystem.
marcozecchini 0:9fca2b23d0ba 134 *
marcozecchini 0:9fca2b23d0ba 135 * This operation includes purging the stack of GATT and GAP state and
marcozecchini 0:9fca2b23d0ba 136 * clearing all state from other BLE components, such as the SecurityManager.
marcozecchini 0:9fca2b23d0ba 137 * Clearing all states may be realized by a call to Gap::reset(),
marcozecchini 0:9fca2b23d0ba 138 * GattClient::reset(), GattServer::reset() and SecurityManager::reset().
marcozecchini 0:9fca2b23d0ba 139 *
marcozecchini 0:9fca2b23d0ba 140 * BLE::init() must be called afterward to reinstantiate services and GAP
marcozecchini 0:9fca2b23d0ba 141 * state.
marcozecchini 0:9fca2b23d0ba 142 *
marcozecchini 0:9fca2b23d0ba 143 * @return BLE_ERROR_NONE if the underlying stack and all other services of
marcozecchini 0:9fca2b23d0ba 144 * the BLE API were shut down correctly.
marcozecchini 0:9fca2b23d0ba 145 *
marcozecchini 0:9fca2b23d0ba 146 * @post hasInitialized() shall return false.
marcozecchini 0:9fca2b23d0ba 147 *
marcozecchini 0:9fca2b23d0ba 148 * @note This function is invoked by BLE::shutdown().
marcozecchini 0:9fca2b23d0ba 149 *
marcozecchini 0:9fca2b23d0ba 150 * @see BLE::shutdown() BLE::init() BLE::hasInitialized() Gap::reset()
marcozecchini 0:9fca2b23d0ba 151 * GattClient::reset() GattServer::reset() SecurityManager::reset() .
marcozecchini 0:9fca2b23d0ba 152 */
marcozecchini 0:9fca2b23d0ba 153 virtual ble_error_t shutdown(void) = 0;
marcozecchini 0:9fca2b23d0ba 154
marcozecchini 0:9fca2b23d0ba 155 /**
marcozecchini 0:9fca2b23d0ba 156 * Fetches a NULL terminated string representation of the underlying BLE
marcozecchini 0:9fca2b23d0ba 157 * vendor subsystem.
marcozecchini 0:9fca2b23d0ba 158 *
marcozecchini 0:9fca2b23d0ba 159 * @return A pointer to the NULL terminated string representation of the
marcozecchini 0:9fca2b23d0ba 160 * underlying BLE stack's version.
marcozecchini 0:9fca2b23d0ba 161 *
marcozecchini 0:9fca2b23d0ba 162 * @see BLE::getVersion()
marcozecchini 0:9fca2b23d0ba 163 */
marcozecchini 0:9fca2b23d0ba 164 virtual const char *getVersion(void) = 0;
marcozecchini 0:9fca2b23d0ba 165
marcozecchini 0:9fca2b23d0ba 166 /**
marcozecchini 0:9fca2b23d0ba 167 * Accessor to the vendor implementation of the Gap interface.
marcozecchini 0:9fca2b23d0ba 168 *
marcozecchini 0:9fca2b23d0ba 169 * @return A reference to a Gap object associated to this BLEInstanceBase
marcozecchini 0:9fca2b23d0ba 170 * instance.
marcozecchini 0:9fca2b23d0ba 171 *
marcozecchini 0:9fca2b23d0ba 172 * @see BLE::gap() Gap
marcozecchini 0:9fca2b23d0ba 173 */
marcozecchini 0:9fca2b23d0ba 174 virtual Gap &getGap(void) = 0;
marcozecchini 0:9fca2b23d0ba 175
marcozecchini 0:9fca2b23d0ba 176 /**
marcozecchini 0:9fca2b23d0ba 177 * Const alternative to getGap().
marcozecchini 0:9fca2b23d0ba 178 *
marcozecchini 0:9fca2b23d0ba 179 * @return A const reference to a Gap object associated to this
marcozecchini 0:9fca2b23d0ba 180 * BLEInstanceBase instance.
marcozecchini 0:9fca2b23d0ba 181 *
marcozecchini 0:9fca2b23d0ba 182 * @see BLE::gap() Gap
marcozecchini 0:9fca2b23d0ba 183 */
marcozecchini 0:9fca2b23d0ba 184 virtual const Gap &getGap(void) const = 0;
marcozecchini 0:9fca2b23d0ba 185
marcozecchini 0:9fca2b23d0ba 186 /**
marcozecchini 0:9fca2b23d0ba 187 * Accessor to the vendor implementation of the GattServer interface.
marcozecchini 0:9fca2b23d0ba 188 *
marcozecchini 0:9fca2b23d0ba 189 * @return A reference to a GattServer object associated to this
marcozecchini 0:9fca2b23d0ba 190 * BLEInstanceBase instance.
marcozecchini 0:9fca2b23d0ba 191 *
marcozecchini 0:9fca2b23d0ba 192 * @see BLE::gattServer() GattServer
marcozecchini 0:9fca2b23d0ba 193 */
marcozecchini 0:9fca2b23d0ba 194 virtual GattServer &getGattServer(void) = 0;
marcozecchini 0:9fca2b23d0ba 195
marcozecchini 0:9fca2b23d0ba 196 /**
marcozecchini 0:9fca2b23d0ba 197 * A const alternative to getGattServer().
marcozecchini 0:9fca2b23d0ba 198 *
marcozecchini 0:9fca2b23d0ba 199 * @return A const reference to a GattServer object associated to this
marcozecchini 0:9fca2b23d0ba 200 * BLEInstanceBase instance.
marcozecchini 0:9fca2b23d0ba 201 *
marcozecchini 0:9fca2b23d0ba 202 * @see BLE::gattServer() GattServer
marcozecchini 0:9fca2b23d0ba 203 */
marcozecchini 0:9fca2b23d0ba 204 virtual const GattServer &getGattServer(void) const = 0;
marcozecchini 0:9fca2b23d0ba 205
marcozecchini 0:9fca2b23d0ba 206 /**
marcozecchini 0:9fca2b23d0ba 207 * Accessor to the vendor implementation of the GattClient interface.
marcozecchini 0:9fca2b23d0ba 208 *
marcozecchini 0:9fca2b23d0ba 209 * @return A reference to a GattClient object associated to this
marcozecchini 0:9fca2b23d0ba 210 * BLEInstanceBase instance.
marcozecchini 0:9fca2b23d0ba 211 *
marcozecchini 0:9fca2b23d0ba 212 * @see BLE::gattClient() GattClient
marcozecchini 0:9fca2b23d0ba 213 */
marcozecchini 0:9fca2b23d0ba 214 virtual GattClient &getGattClient(void) = 0;
marcozecchini 0:9fca2b23d0ba 215
marcozecchini 0:9fca2b23d0ba 216 /**
marcozecchini 0:9fca2b23d0ba 217 * Accessor to the vendor implementation of the SecurityManager interface.
marcozecchini 0:9fca2b23d0ba 218 *
marcozecchini 0:9fca2b23d0ba 219 * @return A reference to a SecurityManager object associated to this
marcozecchini 0:9fca2b23d0ba 220 * BLEInstanceBase instance.
marcozecchini 0:9fca2b23d0ba 221 *
marcozecchini 0:9fca2b23d0ba 222 * @see BLE::securityManager() SecurityManager
marcozecchini 0:9fca2b23d0ba 223 */
marcozecchini 0:9fca2b23d0ba 224 virtual SecurityManager &getSecurityManager(void) = 0;
marcozecchini 0:9fca2b23d0ba 225
marcozecchini 0:9fca2b23d0ba 226 /**
marcozecchini 0:9fca2b23d0ba 227 * A const alternative to getSecurityManager().
marcozecchini 0:9fca2b23d0ba 228 *
marcozecchini 0:9fca2b23d0ba 229 * @return A const reference to a SecurityManager object associated to this
marcozecchini 0:9fca2b23d0ba 230 * BLEInstancebase instance.
marcozecchini 0:9fca2b23d0ba 231 *
marcozecchini 0:9fca2b23d0ba 232 * @see BLE::securityManager() SecurityManager
marcozecchini 0:9fca2b23d0ba 233 */
marcozecchini 0:9fca2b23d0ba 234 virtual const SecurityManager &getSecurityManager(void) const = 0;
marcozecchini 0:9fca2b23d0ba 235
marcozecchini 0:9fca2b23d0ba 236 /**
marcozecchini 0:9fca2b23d0ba 237 * Process pending events present in the vendor subsystem; then, put the MCU
marcozecchini 0:9fca2b23d0ba 238 * to sleep until an external source wakes it up.
marcozecchini 0:9fca2b23d0ba 239 *
marcozecchini 0:9fca2b23d0ba 240 * @important This function is deprecated in the BLE class. It will be
marcozecchini 0:9fca2b23d0ba 241 * removed from this interface once it is removed from BLE.
marcozecchini 0:9fca2b23d0ba 242 *
marcozecchini 0:9fca2b23d0ba 243 * @see BLE::waitForEvent() BLE::processEvents()
marcozecchini 0:9fca2b23d0ba 244 */
marcozecchini 0:9fca2b23d0ba 245 virtual void waitForEvent(void) = 0;
marcozecchini 0:9fca2b23d0ba 246
marcozecchini 0:9fca2b23d0ba 247 private:
marcozecchini 0:9fca2b23d0ba 248 // this class is not a value type.
marcozecchini 0:9fca2b23d0ba 249 // prohibit copy construction and copy assignement
marcozecchini 0:9fca2b23d0ba 250 BLEInstanceBase(const BLEInstanceBase&);
marcozecchini 0:9fca2b23d0ba 251 BLEInstanceBase &operator=(const BLEInstanceBase&);
marcozecchini 0:9fca2b23d0ba 252 };
marcozecchini 0:9fca2b23d0ba 253
marcozecchini 0:9fca2b23d0ba 254 /**
marcozecchini 0:9fca2b23d0ba 255 * Return the instance of the vendor implementation of BLEInstanceBase.
marcozecchini 0:9fca2b23d0ba 256 *
marcozecchini 0:9fca2b23d0ba 257 * @important Contrary to its name, this function does not return a new instance
marcozecchini 0:9fca2b23d0ba 258 * at each call. It rather acts like an accessor to a singleton.
marcozecchini 0:9fca2b23d0ba 259 *
marcozecchini 0:9fca2b23d0ba 260 * @important The vendor library must provide an implementation for this function
marcozecchini 0:9fca2b23d0ba 261 * library. Otherwise, there will be a linker error.
marcozecchini 0:9fca2b23d0ba 262 */
marcozecchini 0:9fca2b23d0ba 263 extern BLEInstanceBase *createBLEInstance(void);
marcozecchini 0:9fca2b23d0ba 264
marcozecchini 0:9fca2b23d0ba 265 /**
marcozecchini 0:9fca2b23d0ba 266 * @}
marcozecchini 0:9fca2b23d0ba 267 * @}
marcozecchini 0:9fca2b23d0ba 268 */
marcozecchini 0:9fca2b23d0ba 269
marcozecchini 0:9fca2b23d0ba 270 #endif // ifndef MBED_BLE_DEVICE_INSTANCE_BASE__