Matthew Lister / BLE_API

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.

ble/services/DFUService.h@970:b3e45745026d, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:35 2015 +0000
Revision:
970:b3e45745026d
Parent:
969:61f13bc8edbf
Child:
971:acf895ac7ae4
Synchronized with git rev 183a572f

Author: Liyou Zhou

Styling changes.

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 970:b3e45745026d 23 extern "C" {
rgrover1 970:b3e45745026d 24 #include "dfu_app_handler.h"
rgrover1 970:b3e45745026d 25 }
rgrover1 712:b04b5db36865 26
rgrover1 712:b04b5db36865 27 extern const uint8_t DFUServiceBaseUUID[];
rgrover1 712:b04b5db36865 28 extern const uint16_t DFUServiceShortUUID;
rgrover1 712:b04b5db36865 29 extern const uint16_t DFUServiceControlCharacteristicShortUUID;
rgrover1 712:b04b5db36865 30
rgrover1 712:b04b5db36865 31 extern const uint8_t DFUServiceUUID[];
rgrover1 712:b04b5db36865 32 extern const uint8_t DFUServiceControlCharacteristicUUID[];
rgrover1 712:b04b5db36865 33 extern const uint8_t DFUServicePacketCharacteristicUUID[];
rgrover1 712:b04b5db36865 34
rgrover1 712:b04b5db36865 35 /**
rgrover1 712:b04b5db36865 36 * @class DFUService
rgrover1 712:b04b5db36865 37 * @brief Device Firmware Update Service.
rgrover1 712:b04b5db36865 38 */
rgrover1 712:b04b5db36865 39 class DFUService {
rgrover1 712:b04b5db36865 40 public:
rgrover1 712:b04b5db36865 41 /**
rgrover1 952:8a6c287de1be 42 * @brief Signature for the handover callback. The application may provide such a
rgrover1 952:8a6c287de1be 43 * callback when setting up the DFU service, in which case it will be
rgrover1 712:b04b5db36865 44 * invoked before handing control over to the bootloader.
rgrover1 712:b04b5db36865 45 */
rgrover1 712:b04b5db36865 46 typedef void (*ResetPrepare_t)(void);
rgrover1 712:b04b5db36865 47
rgrover1 712:b04b5db36865 48 public:
rgrover1 712:b04b5db36865 49 /**
rgrover1 952:8a6c287de1be 50 * @brief Adds Device Firmware Update service to an existing ble object.
rgrover1 712:b04b5db36865 51 *
rgrover1 712:b04b5db36865 52 * @param[ref] _ble
rgrover1 712:b04b5db36865 53 * BLE object for the underlying controller.
rgrover1 712:b04b5db36865 54 * @param[in] _handoverCallback
rgrover1 952:8a6c287de1be 55 * Application specific handover callback.
rgrover1 712:b04b5db36865 56 */
rgrover1 712:b04b5db36865 57 DFUService(BLE &_ble, ResetPrepare_t _handoverCallback = NULL) :
rgrover1 712:b04b5db36865 58 ble(_ble),
rgrover1 712:b04b5db36865 59 controlPoint(DFUServiceControlCharacteristicUUID, controlBytes, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
rgrover1 712:b04b5db36865 60 packet(DFUServicePacketCharacteristicUUID, packetBytes, SIZEOF_PACKET_BYTES, SIZEOF_PACKET_BYTES,
rgrover1 712:b04b5db36865 61 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE),
rgrover1 712:b04b5db36865 62 controlBytes(),
rgrover1 712:b04b5db36865 63 packetBytes() {
rgrover1 952:8a6c287de1be 64 static bool serviceAdded = false; /* We should only ever need to add the DFU service once. */
rgrover1 712:b04b5db36865 65 if (serviceAdded) {
rgrover1 712:b04b5db36865 66 return;
rgrover1 712:b04b5db36865 67 }
rgrover1 712:b04b5db36865 68
rgrover1 952:8a6c287de1be 69 /* Set an initial value for control bytes so that the application's DFUService can
rgrover1 712:b04b5db36865 70 * be distinguished from the real DFU service provided by the bootloader. */
rgrover1 712:b04b5db36865 71 controlBytes[0] = 0xFF;
rgrover1 712:b04b5db36865 72 controlBytes[1] = 0xFF;
rgrover1 712:b04b5db36865 73
rgrover1 712:b04b5db36865 74 GattCharacteristic *dfuChars[] = {&controlPoint, &packet};
rgrover1 712:b04b5db36865 75 GattService dfuService(DFUServiceUUID, dfuChars, sizeof(dfuChars) / sizeof(GattCharacteristic *));
rgrover1 712:b04b5db36865 76
rgrover1 712:b04b5db36865 77 ble.addService(dfuService);
rgrover1 712:b04b5db36865 78 handoverCallback = _handoverCallback;
rgrover1 712:b04b5db36865 79 serviceAdded = true;
rgrover1 712:b04b5db36865 80
rgrover1 712:b04b5db36865 81 ble.onDataWritten(this, &DFUService::onDataWritten);
rgrover1 712:b04b5db36865 82 }
rgrover1 712:b04b5db36865 83
rgrover1 712:b04b5db36865 84 /**
rgrover1 952:8a6c287de1be 85 * @brief get the handle for the value attribute of the control characteristic.
rgrover1 712:b04b5db36865 86 */
rgrover1 712:b04b5db36865 87 uint16_t getControlHandle(void) const {
rgrover1 712:b04b5db36865 88 return controlPoint.getValueHandle();
rgrover1 712:b04b5db36865 89 }
rgrover1 712:b04b5db36865 90
rgrover1 712:b04b5db36865 91 /**
rgrover1 712:b04b5db36865 92 * @brief This callback allows the DFU service to receive the initial trigger to
rgrover1 952:8a6c287de1be 93 * handover control to the bootloader; but first the application is given a
rgrover1 712:b04b5db36865 94 * chance to clean up.
rgrover1 712:b04b5db36865 95 *
rgrover1 712:b04b5db36865 96 * @param[in] params
rgrover1 712:b04b5db36865 97 * Information about the characterisitc being updated.
rgrover1 712:b04b5db36865 98 */
rgrover1 712:b04b5db36865 99 virtual void onDataWritten(const GattWriteCallbackParams *params) {
rgrover1 712:b04b5db36865 100 if (params->handle == controlPoint.getValueHandle()) {
rgrover1 952:8a6c287de1be 101 /* At present, writing anything will do the trick--this needs to be improved. */
rgrover1 712:b04b5db36865 102 if (handoverCallback) {
rgrover1 712:b04b5db36865 103 handoverCallback();
rgrover1 712:b04b5db36865 104 }
rgrover1 712:b04b5db36865 105
rgrover1 970:b3e45745026d 106 // Call bootloader_start implicitly trough a event handler call
rgrover1 970:b3e45745026d 107 // it is a work around for bootloader_start not being public in sdk 8.1
rgrover1 970:b3e45745026d 108 ble_dfu_t p_dfu;
rgrover1 970:b3e45745026d 109 ble_dfu_evt_t p_evt;
rgrover1 970:b3e45745026d 110
rgrover1 970:b3e45745026d 111 p_dfu.conn_handle = params->connHandle;
rgrover1 970:b3e45745026d 112 p_evt.ble_dfu_evt_type = BLE_DFU_START;
rgrover1 970:b3e45745026d 113
rgrover1 970:b3e45745026d 114 dfu_app_on_dfu_evt(&p_dfu, &p_evt);
rgrover1 712:b04b5db36865 115 }
rgrover1 712:b04b5db36865 116 }
rgrover1 712:b04b5db36865 117
rgrover1 712:b04b5db36865 118 protected:
rgrover1 712:b04b5db36865 119 static const unsigned SIZEOF_CONTROL_BYTES = 2;
rgrover1 712:b04b5db36865 120 static const unsigned SIZEOF_PACKET_BYTES = 20;
rgrover1 712:b04b5db36865 121
rgrover1 712:b04b5db36865 122 protected:
rgrover1 712:b04b5db36865 123 BLE &ble;
rgrover1 712:b04b5db36865 124
rgrover1 952:8a6c287de1be 125 /**< Writing to the control characteristic triggers the handover to dfu-
rgrover1 952:8a6c287de1be 126 * bootloader. At present, writing anything will do the trick--this needs
rgrover1 712:b04b5db36865 127 * to be improved. */
rgrover1 712:b04b5db36865 128 WriteOnlyArrayGattCharacteristic<uint8_t, SIZEOF_CONTROL_BYTES> controlPoint;
rgrover1 712:b04b5db36865 129
rgrover1 952:8a6c287de1be 130 /**< The packet characteristic in this service doesn't do anything meaningful, but
rgrover1 952:8a6c287de1be 131 * is only a placeholder to mimic the corresponding characteristic in the
rgrover1 712:b04b5db36865 132 * actual DFU service implemented by the bootloader. Without this, some
rgrover1 952:8a6c287de1be 133 * FOTA clients might get confused as service definitions change after
rgrover1 712:b04b5db36865 134 * handing control over to the bootloader. */
rgrover1 712:b04b5db36865 135 GattCharacteristic packet;
rgrover1 712:b04b5db36865 136
rgrover1 712:b04b5db36865 137 uint8_t controlBytes[SIZEOF_CONTROL_BYTES];
rgrover1 712:b04b5db36865 138 uint8_t packetBytes[SIZEOF_PACKET_BYTES];
rgrover1 712:b04b5db36865 139
rgrover1 952:8a6c287de1be 140 static ResetPrepare_t handoverCallback; /**< application specific handover callback. */
rgrover1 712:b04b5db36865 141 };
rgrover1 712:b04b5db36865 142
rgrover1 712:b04b5db36865 143 #endif /* #ifndef __BLE_DFU_SERVICE_H__*/