Hiroh Satoh / keyboard Featured

ble nano hid over gatt

Dependencies:   BLE_API mbed-dev nRF51822

HIDServiceBase.cpp@83:2e940d154f8b, 2016-09-04 (annotated)

Committer:
cho45
Date:
Sun Sep 04 01:12:45 2016 +0900
Revision:
83:2e940d154f8b
Parent:
82:af52d37b1946
Child:
85:e526a89a0674
reformat

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cho45 54:899fc2b0a76b 1 /* mbed Microcontroller Library
cho45 54:899fc2b0a76b 2 * Copyright (c) 2015 ARM Limited
cho45 54:899fc2b0a76b 3 *
cho45 54:899fc2b0a76b 4 * Licensed under the Apache License, Version 2.0 (the "License");
cho45 54:899fc2b0a76b 5 * you may not use this file except in compliance with the License.
cho45 54:899fc2b0a76b 6 * You may obtain a copy of the License at
cho45 54:899fc2b0a76b 7 *
cho45 54:899fc2b0a76b 8 * http://www.apache.org/licenses/LICENSE-2.0
cho45 54:899fc2b0a76b 9 *
cho45 54:899fc2b0a76b 10 * Unless required by applicable law or agreed to in writing, software
cho45 54:899fc2b0a76b 11 * distributed under the License is distributed on an "AS IS" BASIS,
cho45 54:899fc2b0a76b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
cho45 54:899fc2b0a76b 13 * See the License for the specific language governing permissions and
cho45 54:899fc2b0a76b 14 * limitations under the License.
cho45 54:899fc2b0a76b 15 */
cho45 54:899fc2b0a76b 16
cho45 54:899fc2b0a76b 17 #include "mbed.h"
cho45 79:0095bfb18c57 18 #include "config.h"
cho45 54:899fc2b0a76b 19 #include "HIDServiceBase.h"
cho45 54:899fc2b0a76b 20
cho45 75:351d7ffe81d1 21 static const report_reference_t inputReportReferenceData = { 0, INPUT_REPORT };
cho45 75:351d7ffe81d1 22 static const GattAttribute inputReportReferenceDescriptor(BLE_UUID_DESCRIPTOR_REPORT_REFERENCE, (uint8_t *)&inputReportReferenceData, 2, 2, false);
cho45 75:351d7ffe81d1 23 static const GattAttribute * inputReportDescriptors[] = {
cho45 83:2e940d154f8b 24 &inputReportReferenceDescriptor,
cho45 75:351d7ffe81d1 25 };
cho45 75:351d7ffe81d1 26
cho45 75:351d7ffe81d1 27 static const report_reference_t outputReportReferenceData = { 0, OUTPUT_REPORT };
cho45 75:351d7ffe81d1 28 static const GattAttribute outputReportReferenceDescriptor(BLE_UUID_DESCRIPTOR_REPORT_REFERENCE, (uint8_t *)&outputReportReferenceData, 2, 2, false);
cho45 75:351d7ffe81d1 29 static const GattAttribute * outputReportDescriptors[] = {
cho45 83:2e940d154f8b 30 &outputReportReferenceDescriptor,
cho45 75:351d7ffe81d1 31 };
cho45 75:351d7ffe81d1 32
cho45 83:2e940d154f8b 33
cho45 75:351d7ffe81d1 34 static const report_reference_t featureReportReferenceData = { 0, FEATURE_REPORT };
cho45 75:351d7ffe81d1 35 static const GattAttribute featureReportReferenceDescriptor(BLE_UUID_DESCRIPTOR_REPORT_REFERENCE, (uint8_t *)&featureReportReferenceData, 2, 2, false);
cho45 75:351d7ffe81d1 36 static const GattAttribute * featureReportDescriptors[] = {
cho45 83:2e940d154f8b 37 &featureReportReferenceDescriptor,
cho45 75:351d7ffe81d1 38 };
cho45 75:351d7ffe81d1 39
cho45 75:351d7ffe81d1 40 static const HID_information_t HID_information = {HID_VERSION_1_11, 0x00, 0x03};
cho45 75:351d7ffe81d1 41
cho45 83:2e940d154f8b 42 HIDServiceBase::HIDServiceBase(
cho45 83:2e940d154f8b 43 BLE &_ble,
cho45 83:2e940d154f8b 44 report_map_t reportMap,
cho45 83:2e940d154f8b 45 uint8_t reportMapSize,
cho45 83:2e940d154f8b 46 report_t inputReport,
cho45 83:2e940d154f8b 47 report_t outputReport,
cho45 83:2e940d154f8b 48 report_t featureReport,
cho45 83:2e940d154f8b 49 uint8_t inputReportLength,
cho45 83:2e940d154f8b 50 uint8_t outputReportLength,
cho45 83:2e940d154f8b 51 uint8_t featureReportLength
cho45 83:2e940d154f8b 52 ) :
cho45 83:2e940d154f8b 53
cho45 83:2e940d154f8b 54 ble(_ble),
cho45 83:2e940d154f8b 55 connected (false),
cho45 83:2e940d154f8b 56 reportMapLength(reportMapSize),
cho45 54:899fc2b0a76b 57
cho45 83:2e940d154f8b 58 inputReport(inputReport),
cho45 83:2e940d154f8b 59 outputReport(outputReport),
cho45 83:2e940d154f8b 60 featureReport(featureReport),
cho45 83:2e940d154f8b 61
cho45 83:2e940d154f8b 62 inputReportLength(inputReportLength),
cho45 83:2e940d154f8b 63 outputReportLength(outputReportLength),
cho45 83:2e940d154f8b 64 featureReportLength(featureReportLength),
cho45 54:899fc2b0a76b 65
cho45 83:2e940d154f8b 66 protocolMode(REPORT_PROTOCOL),
cho45 54:899fc2b0a76b 67
cho45 83:2e940d154f8b 68 protocolModeCharacteristic(
cho45 83:2e940d154f8b 69 GattCharacteristic::UUID_PROTOCOL_MODE_CHAR, &protocolMode, 1, 1,
cho45 83:2e940d154f8b 70 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 83:2e940d154f8b 71 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE
cho45 83:2e940d154f8b 72 ),
cho45 54:899fc2b0a76b 73
cho45 83:2e940d154f8b 74 inputReportCharacteristic(
cho45 83:2e940d154f8b 75 GattCharacteristic::UUID_REPORT_CHAR,
cho45 83:2e940d154f8b 76 (uint8_t *)inputReport, inputReportLength, inputReportLength,
cho45 83:2e940d154f8b 77 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 83:2e940d154f8b 78 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY
cho45 83:2e940d154f8b 79 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE,
cho45 83:2e940d154f8b 80 const_cast<GattAttribute**>(inputReportDescriptors), 1
cho45 83:2e940d154f8b 81 ),
cho45 54:899fc2b0a76b 82
cho45 83:2e940d154f8b 83 outputReportCharacteristic(
cho45 83:2e940d154f8b 84 GattCharacteristic::UUID_REPORT_CHAR,
cho45 83:2e940d154f8b 85 (uint8_t *)outputReport, outputReportLength, outputReportLength,
cho45 83:2e940d154f8b 86 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 83:2e940d154f8b 87 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE
cho45 83:2e940d154f8b 88 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE,
cho45 83:2e940d154f8b 89 const_cast<GattAttribute**>(outputReportDescriptors), 1
cho45 83:2e940d154f8b 90 ),
cho45 54:899fc2b0a76b 91
cho45 83:2e940d154f8b 92 featureReportCharacteristic(
cho45 83:2e940d154f8b 93 GattCharacteristic::UUID_REPORT_CHAR,
cho45 83:2e940d154f8b 94 (uint8_t *)featureReport, featureReportLength, featureReportLength,
cho45 83:2e940d154f8b 95 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 83:2e940d154f8b 96 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE,
cho45 83:2e940d154f8b 97 const_cast<GattAttribute**>(featureReportDescriptors), 1
cho45 83:2e940d154f8b 98 ),
cho45 54:899fc2b0a76b 99
cho45 83:2e940d154f8b 100 /*
cho45 83:2e940d154f8b 101 * We need to set reportMap content as const, in order to let the compiler put it into flash
cho45 83:2e940d154f8b 102 * instead of RAM. The characteristic is read-only so it won't be written, but
cho45 83:2e940d154f8b 103 * GattCharacteristic constructor takes non-const arguments only. Hence the cast.
cho45 83:2e940d154f8b 104 */
cho45 83:2e940d154f8b 105 reportMapCharacteristic(
cho45 83:2e940d154f8b 106 GattCharacteristic::UUID_REPORT_MAP_CHAR,
cho45 83:2e940d154f8b 107 const_cast<uint8_t*>(reportMap), reportMapLength, reportMapLength,
cho45 83:2e940d154f8b 108 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ,
cho45 83:2e940d154f8b 109 NULL, 0
cho45 83:2e940d154f8b 110 ),
cho45 54:899fc2b0a76b 111
cho45 83:2e940d154f8b 112 HIDInformationCharacteristic(
cho45 83:2e940d154f8b 113 GattCharacteristic::UUID_HID_INFORMATION_CHAR,
cho45 83:2e940d154f8b 114 const_cast<HID_information_t*>(&HID_information)
cho45 83:2e940d154f8b 115 ),
cho45 83:2e940d154f8b 116
cho45 83:2e940d154f8b 117 HIDControlPointCharacteristic(
cho45 83:2e940d154f8b 118 GattCharacteristic::UUID_HID_CONTROL_POINT_CHAR,
cho45 83:2e940d154f8b 119 &controlPointCommand, 1, 1,
cho45 83:2e940d154f8b 120 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE
cho45 83:2e940d154f8b 121 )
cho45 54:899fc2b0a76b 122 {
cho45 79:0095bfb18c57 123 }
cho45 54:899fc2b0a76b 124
cho45 79:0095bfb18c57 125 void HIDServiceBase::init(void) {
cho45 79:0095bfb18c57 126 static GattCharacteristic *characteristics[] = {
cho45 79:0095bfb18c57 127 &HIDInformationCharacteristic,
cho45 79:0095bfb18c57 128 &reportMapCharacteristic,
cho45 79:0095bfb18c57 129 &protocolModeCharacteristic,
cho45 79:0095bfb18c57 130 &HIDControlPointCharacteristic,
cho45 79:0095bfb18c57 131 NULL,
cho45 79:0095bfb18c57 132 NULL,
cho45 79:0095bfb18c57 133 NULL,
cho45 79:0095bfb18c57 134 NULL,
cho45 79:0095bfb18c57 135 NULL
cho45 79:0095bfb18c57 136 };
cho45 54:899fc2b0a76b 137
cho45 79:0095bfb18c57 138 uint8_t charIndex = 4;
cho45 79:0095bfb18c57 139 /*
cho45 79:0095bfb18c57 140 * Report characteristics are optional, and depend on the reportMap descriptor
cho45 79:0095bfb18c57 141 * Note: at least one should be present, but we don't check that at the moment.
cho45 79:0095bfb18c57 142 */
cho45 79:0095bfb18c57 143 if (inputReportLength)
cho45 79:0095bfb18c57 144 characteristics[charIndex++] = &inputReportCharacteristic;
cho45 79:0095bfb18c57 145 if (outputReportLength)
cho45 79:0095bfb18c57 146 characteristics[charIndex++] = &outputReportCharacteristic;
cho45 79:0095bfb18c57 147 if (featureReportLength)
cho45 79:0095bfb18c57 148 characteristics[charIndex++] = &featureReportCharacteristic;
cho45 79:0095bfb18c57 149
cho45 79:0095bfb18c57 150 addExtraCharacteristics(characteristics, charIndex);
cho45 54:899fc2b0a76b 151
cho45 79:0095bfb18c57 152 DEBUG_PRINTF_BLE("new GattService %d\r\n", charIndex);
cho45 79:0095bfb18c57 153 GattService service(GattService::UUID_HUMAN_INTERFACE_DEVICE_SERVICE, characteristics, charIndex);
cho45 54:899fc2b0a76b 154
cho45 79:0095bfb18c57 155 ble.gattServer().addService(service);
cho45 54:899fc2b0a76b 156
cho45 79:0095bfb18c57 157 ble.gap().onConnection(this, &HIDServiceBase::onConnection);
cho45 79:0095bfb18c57 158 ble.gap().onDisconnection(this, &HIDServiceBase::onDisconnection);
cho45 54:899fc2b0a76b 159
cho45 79:0095bfb18c57 160 ble.gattServer().onDataSent(this, &HIDServiceBase::onDataSent);
cho45 79:0095bfb18c57 161 ble.gattServer().onDataWritten(this, &HIDServiceBase::onDataWritten);
cho45 54:899fc2b0a76b 162
cho45 79:0095bfb18c57 163 SecurityManager::SecurityMode_t securityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM;
cho45 79:0095bfb18c57 164 protocolModeCharacteristic.requireSecurity(securityMode);
cho45 79:0095bfb18c57 165 reportMapCharacteristic.requireSecurity(securityMode);
cho45 79:0095bfb18c57 166 inputReportCharacteristic.requireSecurity(securityMode);
cho45 79:0095bfb18c57 167 outputReportCharacteristic.requireSecurity(securityMode);
cho45 79:0095bfb18c57 168 featureReportCharacteristic.requireSecurity(securityMode);
cho45 54:899fc2b0a76b 169 }
cho45 54:899fc2b0a76b 170
cho45 54:899fc2b0a76b 171 void HIDServiceBase::onDataSent(unsigned count) {
cho45 54:899fc2b0a76b 172 }
cho45 54:899fc2b0a76b 173
cho45 79:0095bfb18c57 174 void HIDServiceBase::onDataWritten(const GattWriteCallbackParams *params) {
cho45 79:0095bfb18c57 175 }
cho45 79:0095bfb18c57 176
cho45 79:0095bfb18c57 177 void HIDServiceBase::addExtraCharacteristics(GattCharacteristic** characteristics, uint8_t& charIndex) {
cho45 79:0095bfb18c57 178 }
cho45 54:899fc2b0a76b 179
cho45 54:899fc2b0a76b 180 ble_error_t HIDServiceBase::send(const report_t report) {
cho45 83:2e940d154f8b 181 return ble.gattServer().write(
cho45 83:2e940d154f8b 182 inputReportCharacteristic.getValueHandle(),
cho45 83:2e940d154f8b 183 report,
cho45 83:2e940d154f8b 184 inputReportLength
cho45 83:2e940d154f8b 185 );
cho45 54:899fc2b0a76b 186 }
cho45 54:899fc2b0a76b 187
cho45 54:899fc2b0a76b 188 ble_error_t HIDServiceBase::read(report_t report) {
cho45 83:2e940d154f8b 189 // TODO. For the time being, we'll just have HID input reports...
cho45 83:2e940d154f8b 190 return BLE_ERROR_NOT_IMPLEMENTED;
cho45 54:899fc2b0a76b 191 }
cho45 54:899fc2b0a76b 192
cho45 83:2e940d154f8b 193 void HIDServiceBase::onConnection(const Gap::ConnectionCallbackParams_t *params) {
cho45 83:2e940d154f8b 194 this->connected = true;
cho45 54:899fc2b0a76b 195 }
cho45 54:899fc2b0a76b 196
cho45 83:2e940d154f8b 197 void HIDServiceBase::onDisconnection(const Gap::DisconnectionCallbackParams_t *params) {
cho45 83:2e940d154f8b 198 this->connected = false;
cho45 75:351d7ffe81d1 199 }