Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

ble/services/DFUService.h@712:b04b5db36865, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:29 2015 +0100
Revision:
712:b04b5db36865
Child:
935:e9b595e6b0ed
Synchronized with git rev 75beb803

Author: Rohit Grover

switch to a yotta layout

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 712:b04b5db36865 1 /* mbed Microcontroller Library
rgrover1 712:b04b5db36865 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 712:b04b5db36865 3 *
rgrover1 712:b04b5db36865 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 712:b04b5db36865 5 * you may not use this file except in compliance with the License.
rgrover1 712:b04b5db36865 6 * You may obtain a copy of the License at
rgrover1 712:b04b5db36865 7 *
rgrover1 712:b04b5db36865 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 712:b04b5db36865 9 *
rgrover1 712:b04b5db36865 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 712:b04b5db36865 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 712:b04b5db36865 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 712:b04b5db36865 13 * See the License for the specific language governing permissions and
rgrover1 712:b04b5db36865 14 * limitations under the License.
rgrover1 712:b04b5db36865 15 */
rgrover1 712:b04b5db36865 16
rgrover1 712:b04b5db36865 17 #ifndef __BLE_DFU_SERVICE_H__
rgrover1 712:b04b5db36865 18 #define __BLE_DFU_SERVICE_H__
rgrover1 712:b04b5db36865 19
rgrover1 712:b04b5db36865 20 #include "ble/BLE.h"
rgrover1 712:b04b5db36865 21 #include "ble/UUID.h"
rgrover1 712:b04b5db36865 22
rgrover1 712:b04b5db36865 23 extern "C" void bootloader_start(void);
rgrover1 712:b04b5db36865 24
rgrover1 712:b04b5db36865 25 extern const uint8_t DFUServiceBaseUUID[];
rgrover1 712:b04b5db36865 26 extern const uint16_t DFUServiceShortUUID;
rgrover1 712:b04b5db36865 27 extern const uint16_t DFUServiceControlCharacteristicShortUUID;
rgrover1 712:b04b5db36865 28
rgrover1 712:b04b5db36865 29 extern const uint8_t DFUServiceUUID[];
rgrover1 712:b04b5db36865 30 extern const uint8_t DFUServiceControlCharacteristicUUID[];
rgrover1 712:b04b5db36865 31 extern const uint8_t DFUServicePacketCharacteristicUUID[];
rgrover1 712:b04b5db36865 32
rgrover1 712:b04b5db36865 33 /**
rgrover1 712:b04b5db36865 34 * @class DFUService
rgrover1 712:b04b5db36865 35 * @brief Device Firmware Update Service.
rgrover1 712:b04b5db36865 36 */
rgrover1 712:b04b5db36865 37 class DFUService {
rgrover1 712:b04b5db36865 38 public:
rgrover1 712:b04b5db36865 39 /**
rgrover1 712:b04b5db36865 40 * @brief Signature for the handover callback. The application may provide such a
rgrover1 712:b04b5db36865 41 * callback when setting up the DFU service, in which case it will be
rgrover1 712:b04b5db36865 42 * invoked before handing control over to the bootloader.
rgrover1 712:b04b5db36865 43 */
rgrover1 712:b04b5db36865 44 typedef void (*ResetPrepare_t)(void);
rgrover1 712:b04b5db36865 45
rgrover1 712:b04b5db36865 46 public:
rgrover1 712:b04b5db36865 47 /**
rgrover1 712:b04b5db36865 48 * @brief Adds Device Firmware Update service to an existing ble object.
rgrover1 712:b04b5db36865 49 *
rgrover1 712:b04b5db36865 50 * @param[ref] _ble
rgrover1 712:b04b5db36865 51 * BLE object for the underlying controller.
rgrover1 712:b04b5db36865 52 * @param[in] _handoverCallback
rgrover1 712:b04b5db36865 53 * Application specific handover callback.
rgrover1 712:b04b5db36865 54 */
rgrover1 712:b04b5db36865 55 DFUService(BLE &_ble, ResetPrepare_t _handoverCallback = NULL) :
rgrover1 712:b04b5db36865 56 ble(_ble),
rgrover1 712:b04b5db36865 57 controlPoint(DFUServiceControlCharacteristicUUID, controlBytes, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
rgrover1 712:b04b5db36865 58 packet(DFUServicePacketCharacteristicUUID, packetBytes, SIZEOF_PACKET_BYTES, SIZEOF_PACKET_BYTES,
rgrover1 712:b04b5db36865 59 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE),
rgrover1 712:b04b5db36865 60 controlBytes(),
rgrover1 712:b04b5db36865 61 packetBytes() {
rgrover1 712:b04b5db36865 62 static bool serviceAdded = false; /* We should only ever need to add the DFU service once. */
rgrover1 712:b04b5db36865 63 if (serviceAdded) {
rgrover1 712:b04b5db36865 64 return;
rgrover1 712:b04b5db36865 65 }
rgrover1 712:b04b5db36865 66
rgrover1 712:b04b5db36865 67 /* Set an initial value for control bytes so that the application's DFUService can
rgrover1 712:b04b5db36865 68 * be distinguished from the real DFU service provided by the bootloader. */
rgrover1 712:b04b5db36865 69 controlBytes[0] = 0xFF;
rgrover1 712:b04b5db36865 70 controlBytes[1] = 0xFF;
rgrover1 712:b04b5db36865 71
rgrover1 712:b04b5db36865 72 GattCharacteristic *dfuChars[] = {&controlPoint, &packet};
rgrover1 712:b04b5db36865 73 GattService dfuService(DFUServiceUUID, dfuChars, sizeof(dfuChars) / sizeof(GattCharacteristic *));
rgrover1 712:b04b5db36865 74
rgrover1 712:b04b5db36865 75 ble.addService(dfuService);
rgrover1 712:b04b5db36865 76 handoverCallback = _handoverCallback;
rgrover1 712:b04b5db36865 77 serviceAdded = true;
rgrover1 712:b04b5db36865 78
rgrover1 712:b04b5db36865 79 ble.onDataWritten(this, &DFUService::onDataWritten);
rgrover1 712:b04b5db36865 80 }
rgrover1 712:b04b5db36865 81
rgrover1 712:b04b5db36865 82 /**
rgrover1 712:b04b5db36865 83 * @brief get the handle for the value attribute of the control characteristic.
rgrover1 712:b04b5db36865 84 */
rgrover1 712:b04b5db36865 85 uint16_t getControlHandle(void) const {
rgrover1 712:b04b5db36865 86 return controlPoint.getValueHandle();
rgrover1 712:b04b5db36865 87 }
rgrover1 712:b04b5db36865 88
rgrover1 712:b04b5db36865 89 /**
rgrover1 712:b04b5db36865 90 * @brief This callback allows the DFU service to receive the initial trigger to
rgrover1 712:b04b5db36865 91 * handover control to the bootloader; but first the application is given a
rgrover1 712:b04b5db36865 92 * chance to clean up.
rgrover1 712:b04b5db36865 93 *
rgrover1 712:b04b5db36865 94 * @param[in] params
rgrover1 712:b04b5db36865 95 * Information about the characterisitc being updated.
rgrover1 712:b04b5db36865 96 */
rgrover1 712:b04b5db36865 97 virtual void onDataWritten(const GattWriteCallbackParams *params) {
rgrover1 712:b04b5db36865 98 if (params->handle == controlPoint.getValueHandle()) {
rgrover1 712:b04b5db36865 99 /* At present, writing anything will do the trick--this needs to be improved. */
rgrover1 712:b04b5db36865 100 if (handoverCallback) {
rgrover1 712:b04b5db36865 101 handoverCallback();
rgrover1 712:b04b5db36865 102 }
rgrover1 712:b04b5db36865 103
rgrover1 712:b04b5db36865 104 bootloader_start();
rgrover1 712:b04b5db36865 105 }
rgrover1 712:b04b5db36865 106 }
rgrover1 712:b04b5db36865 107
rgrover1 712:b04b5db36865 108 protected:
rgrover1 712:b04b5db36865 109 static const unsigned SIZEOF_CONTROL_BYTES = 2;
rgrover1 712:b04b5db36865 110 static const unsigned SIZEOF_PACKET_BYTES = 20;
rgrover1 712:b04b5db36865 111
rgrover1 712:b04b5db36865 112 protected:
rgrover1 712:b04b5db36865 113 BLE &ble;
rgrover1 712:b04b5db36865 114
rgrover1 712:b04b5db36865 115 /**< Writing to the control characteristic triggers the handover to dfu-
rgrover1 712:b04b5db36865 116 * bootloader. At present, writing anything will do the trick--this needs
rgrover1 712:b04b5db36865 117 * to be improved. */
rgrover1 712:b04b5db36865 118 WriteOnlyArrayGattCharacteristic<uint8_t, SIZEOF_CONTROL_BYTES> controlPoint;
rgrover1 712:b04b5db36865 119
rgrover1 712:b04b5db36865 120 /**< The packet characteristic in this service doesn't do anything meaningful, but
rgrover1 712:b04b5db36865 121 * is only a placeholder to mimic the corresponding characteristic in the
rgrover1 712:b04b5db36865 122 * actual DFU service implemented by the bootloader. Without this, some
rgrover1 712:b04b5db36865 123 * FOTA clients might get confused as service definitions change after
rgrover1 712:b04b5db36865 124 * handing control over to the bootloader. */
rgrover1 712:b04b5db36865 125 GattCharacteristic packet;
rgrover1 712:b04b5db36865 126
rgrover1 712:b04b5db36865 127 uint8_t controlBytes[SIZEOF_CONTROL_BYTES];
rgrover1 712:b04b5db36865 128 uint8_t packetBytes[SIZEOF_PACKET_BYTES];
rgrover1 712:b04b5db36865 129
rgrover1 712:b04b5db36865 130 static ResetPrepare_t handoverCallback; /**< application specific handover callback. */
rgrover1 712:b04b5db36865 131 };
rgrover1 712:b04b5db36865 132
rgrover1 712:b04b5db36865 133 #endif /* #ifndef __BLE_DFU_SERVICE_H__*/