Sam Musso / BLE_API

I don't know why this is happening.

Fork of BLE_API by Bluetooth Low Energy

services/DFUService.h@243:98f930d14515, 2014-12-09 (annotated)

Committer:
rgrover1
Date:
Tue Dec 09 13:15:19 2014 +0000
Revision:
243:98f930d14515
Parent:
242:0e9201b67e2f
Child:
245:712e0719d7e9
Synchronized with git rev ba5fb7fb

Author: Rohit Grover

minor improvements to documentation.

Who changed what in which revision?

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