From 56b527925ce64bc0a9ef4b0ca51a1648b6400e04 Mon Sep 17 00:00:00 2001 From: JF Date: Fri, 1 May 2020 17:58:10 +0200 Subject: [PATCH] Clean code of DfuService --- src/Components/Ble/DfuService.cpp | 231 ++++++++++++++++-------------- src/Components/Ble/DfuService.h | 35 ++++- src/sdk_config.h | 6 +- 3 files changed, 160 insertions(+), 112 deletions(-) diff --git a/src/Components/Ble/DfuService.cpp b/src/Components/Ble/DfuService.cpp index 107304a9..bc96dd9b 100644 --- a/src/Components/Ble/DfuService.cpp +++ b/src/Components/Ble/DfuService.cpp @@ -61,8 +61,6 @@ DfuService::DfuService() : void DfuService::Init() { ble_gatts_count_cfg(serviceDefinition); ble_gatts_add_svcs(serviceDefinition); - - } int DfuService::OnServiceData(uint16_t connectionHandle, uint16_t attributeHandle, ble_gatt_access_ctxt *context) { @@ -71,112 +69,137 @@ int DfuService::OnServiceData(uint16_t connectionHandle, uint16_t attributeHandl ble_gatts_find_chr((ble_uuid_t*)&serviceUuid, (ble_uuid_t*)&controlPointCharacteristicUuid, nullptr, &controlPointCharacteristicHandle); ble_gatts_find_chr((ble_uuid_t*)&serviceUuid, (ble_uuid_t*)&revisionCharacteristicUuid, nullptr, &revisionCharacteristicHandle); - /* * o BLE_GATT_ACCESS_OP_READ_CHR - * o BLE_GATT_ACCESS_OP_WRITE_CHR - * o BLE_GATT_ACCESS_OP_READ_DSC - * o BLE_GATT_ACCESS_OP_WRITE_DSC - * */ - - char* op; - switch(context->op) { - case BLE_GATT_ACCESS_OP_READ_CHR: op = "Read Characteristic"; break; - case BLE_GATT_ACCESS_OP_WRITE_CHR: op = "Write Characteristic"; break; - case BLE_GATT_ACCESS_OP_READ_DSC: op = "Read Descriptor"; break; - case BLE_GATT_ACCESS_OP_WRITE_DSC: op = "Write Descriptor"; break; - } - if(attributeHandle == packetCharacteristicHandle) { - NRF_LOG_INFO("[DFU] %s Packet", op); - if(context->op == BLE_GATT_ACCESS_OP_WRITE_CHR) { -// NRF_LOG_INFO("[DFU] -> Write %dB", context->om->om_len); - if(opcode == 1) { - uint8_t data[3]{16, opcode, param}; - NRF_LOG_INFO("[DFU] -> Send notification: {%d, %d, %d}", data[0], data[1], data[2]); - - auto *om = ble_hs_mbuf_from_flat(data, 3); - ble_gattc_notify_custom(connectionHandle, controlPointCharacteristicHandle, om); - } - if(dataMode){ - nbPacketReceived++; - bytesReceived += context->om->om_len; - NRF_LOG_INFO("[DFU] -> Bytes received : %d in %d packets", bytesReceived, nbPacketReceived); - - if((nbPacketReceived % nbPacketsToNotify) == 0) { - uint8_t data[5]{17, (uint8_t)(bytesReceived>>24),(uint8_t)(bytesReceived>>16), (uint8_t)(bytesReceived>>8), (uint8_t)(bytesReceived&0x000000FF) }; - NRF_LOG_INFO("[DFU] -> Send packet notification: %d bytes received",bytesReceived); - - auto *om = ble_hs_mbuf_from_flat(data, 5); - ble_gattc_notify_custom(connectionHandle, controlPointCharacteristicHandle, om); - } - if(bytesReceived == 175280) { - uint8_t data[3]{16, 3, 1}; - NRF_LOG_INFO("[DFU] -> Send packet notification : all bytes received!"); - - auto *om = ble_hs_mbuf_from_flat(data, 3); - ble_gattc_notify_custom(connectionHandle, controlPointCharacteristicHandle, om); - } - } - - } - } else if (attributeHandle == controlPointCharacteristicHandle) { - NRF_LOG_INFO("[DFU] %s ControlPoint", op); - if(context->op == BLE_GATT_ACCESS_OP_WRITE_CHR) { -// NRF_LOG_INFO("[DFU] -> Write %dB {%d, %d}", context->om->om_len, context->om->om_data[0], context->om->om_data[1]); - switch(context->om->om_data[0]) { - case 0x01: {// START DFU - NRF_LOG_INFO("[DFU] -> Start DFU, mode = %d", context->om->om_data[1]); - opcode = 0x01; - param = 1; - } - break; - case 0x02: - NRF_LOG_INFO("[DFU] -> Receive init, state (0=RX, 1=Complete) = %d", context->om->om_data[1]); - opcode = 0x02; - param = context->om->om_data[1]; - if(param == 1) { - uint8_t data[3] {16, opcode, param}; - NRF_LOG_INFO("[DFU] -> Send notification: {%d, %d, %d}", data[0], data[1], data[2]); - - auto *om = ble_hs_mbuf_from_flat(data, 3); - - ble_gattc_notify_custom(connectionHandle, controlPointCharacteristicHandle, om); - } - break; - case 0x08: - nbPacketsToNotify = context->om->om_data[1]; - NRF_LOG_INFO("[DFU] -> Receive Packet Notification Request, nb packet = %d", nbPacketsToNotify); - break; - case 0x03: - NRF_LOG_INFO("[DFU] -> Starting receive firmware"); - dataMode = true; - break; - case 0x04: { - NRF_LOG_INFO("[DFU] -> Validate firmware"); - uint8_t data[3]{16, 4, 1}; - NRF_LOG_INFO("[DFU] -> Send notification: {%d, %d, %d}", data[0], data[1], data[2]); - - auto *om = ble_hs_mbuf_from_flat(data, 3); - - ble_gattc_notify_custom(connectionHandle, controlPointCharacteristicHandle, om); - } - break; - case 0x05: - NRF_LOG_INFO("[DFU] -> Activate image and reset!"); - break; - } - - - } - + if(context->op == BLE_GATT_ACCESS_OP_WRITE_CHR) + return WritePacketHandler(connectionHandle, context->om); + else return 0; + } else if(attributeHandle == controlPointCharacteristicHandle) { + if(context->op == BLE_GATT_ACCESS_OP_WRITE_CHR) + return ControlPointHandler(connectionHandle, context->om); + else return 0; } else if(attributeHandle == revisionCharacteristicHandle) { - NRF_LOG_INFO("[DFU] %s Revision", op); - if(context->op == BLE_GATT_ACCESS_OP_READ_CHR) { - int res = os_mbuf_append(context->om, &revision, 2); - return (res == 0) ? 0 : BLE_ATT_ERR_INSUFFICIENT_RES; - } + if(context->op == BLE_GATT_ACCESS_OP_READ_CHR) + return SendDfuRevision(context->om); + else return 0; } else { - NRF_LOG_INFO("[DFU] Unknown Characteristic : %d - %s", attributeHandle, op); + NRF_LOG_INFO("[DFU] Unknown Characteristic : %d", attributeHandle); + return 0; } +} +int DfuService::SendDfuRevision(os_mbuf *om) const { + int res = os_mbuf_append(om, &revision, sizeof(revision)); + return (res == 0) ? 0 : BLE_ATT_ERR_INSUFFICIENT_RES; +} + +int DfuService::WritePacketHandler(uint16_t connectionHandle, os_mbuf *om) { + switch(state) { + case States::Start: { + uint8_t data[] {16, 1, 1}; + SendNotification(connectionHandle, data, 3); + } + return 0; + case States::Data: { + nbPacketReceived++; + bytesReceived += om->om_len; + NRF_LOG_INFO("[DFU] -> Bytes received : %d in %d packets", bytesReceived, nbPacketReceived); + + if((nbPacketReceived % nbPacketsToNotify) == 0) { + uint8_t data[5]{static_cast(Opcodes::PacketReceiptNotification), + (uint8_t)(bytesReceived>>24u),(uint8_t)(bytesReceived>>16u), (uint8_t)(bytesReceived>>8u), (uint8_t)(bytesReceived&0x000000FFu) }; + NRF_LOG_INFO("[DFU] -> Send packet notification: %d bytes received",bytesReceived); + SendNotification(connectionHandle, data, 5); + } + if(bytesReceived == 175280) { + uint8_t data[3]{static_cast(Opcodes::Response), + static_cast(Opcodes::ReceiveFirmwareImage), + static_cast(ErrorCodes::NoError)}; + NRF_LOG_INFO("[DFU] -> Send packet notification : all bytes received!"); + SendNotification(connectionHandle, data, 3); + state = States::Validate; + } + } + return 0; + default: + // Invalid state + return 0; + } return 0; } + +int DfuService::ControlPointHandler(uint16_t connectionHandle, os_mbuf *om) { + auto opcode = static_cast(om->om_data[0]); + switch(opcode) { + case Opcodes::StartDFU: { + if(state != States::Idle) { + NRF_LOG_INFO("[DFU] -> Start DFU requested, but we are not in Idle state"); + return 0; + } + auto imageType = static_cast(om->om_data[1]); + if(imageType == ImageTypes::Application) { + NRF_LOG_INFO("[DFU] -> Start DFU, mode = Application"); + state = States::Start; + return 0; + } else { + NRF_LOG_INFO("[DFU] -> Start DFU, mode %d not supported!", imageType); + return 0; + } + } + break; + case Opcodes::InitDFUParameters: { + if (state != States::Start) { + NRF_LOG_INFO("[DFU] -> Init DFU requested, but we are not in Start state"); + return 0; + } + bool isInitComplete = (om->om_data[1] != 0); + NRF_LOG_INFO("[DFU] -> Init DFU parameters %s", isInitComplete ? " complete" : " not complete"); + + if (isInitComplete) { + uint8_t data[3]{static_cast(Opcodes::Response), + static_cast(Opcodes::InitDFUParameters), + (isInitComplete ? uint8_t{1} : uint8_t{0})}; + SendNotification(connectionHandle, data, 3); + return 0; + } + } + return 0; + case Opcodes::PacketReceiptNotificationRequest: + nbPacketsToNotify = om->om_data[1]; + NRF_LOG_INFO("[DFU] -> Receive Packet Notification Request, nb packet = %d", nbPacketsToNotify); + return 0; + case Opcodes::ReceiveFirmwareImage: + if(state != States::Start) { + NRF_LOG_INFO("[DFU] -> Receive firmware image requested, but we are not in Start state"); + return 0; + } + NRF_LOG_INFO("[DFU] -> Starting receive firmware"); + state = States::Data; + return 0; + case Opcodes::ValidateFirmware: { + if(state != States::Validate) { + NRF_LOG_INFO("[DFU] -> Validate firmware image requested, but we are not in Data state"); + return 0; + } + NRF_LOG_INFO("[DFU] -> Validate firmware"); + state = States::Validated; + uint8_t data[3]{static_cast(Opcodes::Response), + static_cast(Opcodes::ValidateFirmware), + static_cast(ErrorCodes::NoError)}; + SendNotification(connectionHandle, data, 3); + return 0; + } + case Opcodes::ActivateImageAndReset: + if(state != States::Validated) { + NRF_LOG_INFO("[DFU] -> Activate image and reset requested, but we are not in Validated state"); + return 0; + } + NRF_LOG_INFO("[DFU] -> Activate image and reset!"); + return 0; + default: return 0; + } +} + +void DfuService::SendNotification(uint16_t connectionHandle, const uint8_t *data, const size_t size) { + auto *om = ble_hs_mbuf_from_flat(data, size); + ble_gattc_notify_custom(connectionHandle, controlPointCharacteristicHandle, om); +} diff --git a/src/Components/Ble/DfuService.h b/src/Components/Ble/DfuService.h index bb643632..1b13c00d 100644 --- a/src/Components/Ble/DfuService.h +++ b/src/Components/Ble/DfuService.h @@ -20,8 +20,6 @@ namespace Pinetime { uint16_t revision {0x0008}; - static constexpr uint16_t opcodeInit = 0x0002; - static constexpr ble_uuid128_t serviceUuid { .u { .type = BLE_UUID_TYPE_128}, .value = {0x23, 0xD1, 0xBC, 0xEA, 0x5F, 0x78, 0x23, 0x15, @@ -51,12 +49,39 @@ namespace Pinetime { uint16_t packetCharacteristicHandle; uint16_t controlPointCharacteristicHandle; uint16_t revisionCharacteristicHandle; - uint8_t opcode = 0; - uint8_t param = 0; + + enum class States : uint8_t {Idle, Init, Start, Data, Validate, Validated}; + States state = States::Idle; + + enum class ImageTypes : uint8_t { + NoImage = 0x00, + SoftDevice = 0x01, + Bootloader = 0x02, + SoftDeviceAndBootloader = 0x03, + Application = 0x04 + }; + + enum class Opcodes : uint8_t { + StartDFU = 0x01, + InitDFUParameters = 0x02, + ReceiveFirmwareImage = 0x03, + ValidateFirmware = 0x04, + ActivateImageAndReset = 0x05, + PacketReceiptNotificationRequest = 0x08, + Response = 0x10, + PacketReceiptNotification = 0x11 + }; + + enum class ErrorCodes { NoError = 0x01}; + uint8_t nbPacketsToNotify = 0; uint32_t nbPacketReceived = 0; - bool dataMode = false; uint32_t bytesReceived = 0; + + int SendDfuRevision(os_mbuf *om) const; + void SendNotification(uint16_t connectionHandle, const uint8_t *data, const size_t size); + int WritePacketHandler(uint16_t connectionHandle, os_mbuf *om); + int ControlPointHandler(uint16_t connectionHandle, os_mbuf *om); }; } } \ No newline at end of file diff --git a/src/sdk_config.h b/src/sdk_config.h index 244b21bd..a63eb6fb 100644 --- a/src/sdk_config.h +++ b/src/sdk_config.h @@ -8460,15 +8460,15 @@ // NRF_LOG_ENABLED - nrf_log - Logger //========================================================== #ifndef NRF_LOG_ENABLED -#define NRF_LOG_ENABLED 1 +#define NRF_LOG_ENABLED 0 #endif #ifndef NRF_LOG_BACKEND_RTT_ENABLED -#define NRF_LOG_BACKEND_RTT_ENABLED 1 +#define NRF_LOG_BACKEND_RTT_ENABLED 0 #endif #ifndef NRF_LOG_BACKEND_SERIAL_USES_RTT -#define NRF_LOG_BACKEND_SERIAL_USES_RTT 1 +#define NRF_LOG_BACKEND_SERIAL_USES_RTT 0 #endif // Log message pool - Configuration of log message pool