Varun Bahl / BahlDecrypModified

Updated

Fork of BLE_API by Bluetooth Low Energy

ble/services/DFUService.h@988:4eda0d49b333, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 14:51:22 2015 +0000
Revision:
988:4eda0d49b333
Parent:
987:c1dd85b33cae
Child:
989:017f77f120e1
Synchronized with git rev 2a58ee97

Author: Liyou Zhou

Merge branch 'guard_dfu_files' of github.com:LiyouZhou/ble into guard_dfu_files

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