Hiroh Satoh / keyboard Featured

ble nano hid over gatt

Dependencies:   BLE_API mbed-dev nRF51822

HIDServiceBase.cpp@66:a7c6fbe45cf5, 2016-09-01 (annotated)

Committer:
cho45
Date:
Thu Sep 01 19:09:47 2016 +0000
Revision:
66:a7c6fbe45cf5
Parent:
59:2d6c0bff2151
Child:
75:351d7ffe81d1
?????????????????????????????????????????

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 54:899fc2b0a76b 18 #include "HIDServiceBase.h"
cho45 54:899fc2b0a76b 19
cho45 54:899fc2b0a76b 20 HIDServiceBase::HIDServiceBase(BLE &_ble,
cho45 54:899fc2b0a76b 21 report_map_t reportMap,
cho45 54:899fc2b0a76b 22 uint8_t reportMapSize,
cho45 54:899fc2b0a76b 23 report_t inputReport,
cho45 54:899fc2b0a76b 24 report_t outputReport,
cho45 54:899fc2b0a76b 25 report_t featureReport,
cho45 54:899fc2b0a76b 26 uint8_t inputReportLength,
cho45 54:899fc2b0a76b 27 uint8_t outputReportLength,
cho45 54:899fc2b0a76b 28 uint8_t featureReportLength,
cho45 54:899fc2b0a76b 29 uint8_t inputReportTickerDelay) :
cho45 54:899fc2b0a76b 30 ble(_ble),
cho45 54:899fc2b0a76b 31 connected (false),
cho45 54:899fc2b0a76b 32 reportMapLength(reportMapSize),
cho45 54:899fc2b0a76b 33
cho45 54:899fc2b0a76b 34 inputReport(inputReport),
cho45 54:899fc2b0a76b 35 outputReport(outputReport),
cho45 54:899fc2b0a76b 36 featureReport(featureReport),
cho45 54:899fc2b0a76b 37
cho45 54:899fc2b0a76b 38 inputReportLength(inputReportLength),
cho45 54:899fc2b0a76b 39 outputReportLength(outputReportLength),
cho45 54:899fc2b0a76b 40 featureReportLength(featureReportLength),
cho45 54:899fc2b0a76b 41
cho45 54:899fc2b0a76b 42 protocolMode(REPORT_PROTOCOL),
cho45 54:899fc2b0a76b 43
cho45 66:a7c6fbe45cf5 44 inputReportReferenceDescriptor(BLE_UUID_DESCRIPTOR_REPORT_REFERENCE,
cho45 66:a7c6fbe45cf5 45 (uint8_t *)&inputReportReferenceData, 2, 2),
cho45 66:a7c6fbe45cf5 46 outputReportReferenceDescriptor(BLE_UUID_DESCRIPTOR_REPORT_REFERENCE,
cho45 66:a7c6fbe45cf5 47 (uint8_t *)&outputReportReferenceData, 2, 2),
cho45 66:a7c6fbe45cf5 48 featureReportReferenceDescriptor(BLE_UUID_DESCRIPTOR_REPORT_REFERENCE,
cho45 66:a7c6fbe45cf5 49 (uint8_t *)&featureReportReferenceData, 2, 2),
cho45 66:a7c6fbe45cf5 50
cho45 54:899fc2b0a76b 51 protocolModeCharacteristic(GattCharacteristic::UUID_PROTOCOL_MODE_CHAR, &protocolMode, 1, 1,
cho45 54:899fc2b0a76b 52 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 54:899fc2b0a76b 53 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE),
cho45 54:899fc2b0a76b 54
cho45 54:899fc2b0a76b 55 inputReportCharacteristic(GattCharacteristic::UUID_REPORT_CHAR,
cho45 54:899fc2b0a76b 56 (uint8_t *)inputReport, inputReportLength, inputReportLength,
cho45 54:899fc2b0a76b 57 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 54:899fc2b0a76b 58 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY
cho45 54:899fc2b0a76b 59 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE,
cho45 66:a7c6fbe45cf5 60 inputReportDescriptors(), 1),
cho45 54:899fc2b0a76b 61
cho45 54:899fc2b0a76b 62 outputReportCharacteristic(GattCharacteristic::UUID_REPORT_CHAR,
cho45 54:899fc2b0a76b 63 (uint8_t *)outputReport, outputReportLength, outputReportLength,
cho45 54:899fc2b0a76b 64 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 54:899fc2b0a76b 65 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE
cho45 54:899fc2b0a76b 66 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE,
cho45 66:a7c6fbe45cf5 67 outputReportDescriptors(), 1),
cho45 54:899fc2b0a76b 68
cho45 54:899fc2b0a76b 69 featureReportCharacteristic(GattCharacteristic::UUID_REPORT_CHAR,
cho45 54:899fc2b0a76b 70 (uint8_t *)featureReport, featureReportLength, featureReportLength,
cho45 54:899fc2b0a76b 71 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ
cho45 54:899fc2b0a76b 72 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE,
cho45 66:a7c6fbe45cf5 73 featureReportDescriptors(), 1),
cho45 54:899fc2b0a76b 74
cho45 54:899fc2b0a76b 75 /*
cho45 54:899fc2b0a76b 76 * We need to set reportMap content as const, in order to let the compiler put it into flash
cho45 54:899fc2b0a76b 77 * instead of RAM. The characteristic is read-only so it won't be written, but
cho45 54:899fc2b0a76b 78 * GattCharacteristic constructor takes non-const arguments only. Hence the cast.
cho45 54:899fc2b0a76b 79 */
cho45 54:899fc2b0a76b 80 reportMapCharacteristic(GattCharacteristic::UUID_REPORT_MAP_CHAR,
cho45 54:899fc2b0a76b 81 const_cast<uint8_t*>(reportMap), reportMapLength, reportMapLength,
cho45 54:899fc2b0a76b 82 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ,
cho45 59:2d6c0bff2151 83 NULL, 0),
cho45 54:899fc2b0a76b 84
cho45 66:a7c6fbe45cf5 85 HIDInformationCharacteristic(GattCharacteristic::UUID_HID_INFORMATION_CHAR, HIDInformation()),
cho45 54:899fc2b0a76b 86 HIDControlPointCharacteristic(GattCharacteristic::UUID_HID_CONTROL_POINT_CHAR,
cho45 54:899fc2b0a76b 87 &controlPointCommand, 1, 1,
cho45 54:899fc2b0a76b 88 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE),
cho45 54:899fc2b0a76b 89
cho45 54:899fc2b0a76b 90 reportTickerDelay(inputReportTickerDelay),
cho45 54:899fc2b0a76b 91 reportTickerIsActive(false)
cho45 54:899fc2b0a76b 92 {
cho45 54:899fc2b0a76b 93 static GattCharacteristic *characteristics[] = {
cho45 54:899fc2b0a76b 94 &HIDInformationCharacteristic,
cho45 54:899fc2b0a76b 95 &reportMapCharacteristic,
cho45 54:899fc2b0a76b 96 &protocolModeCharacteristic,
cho45 54:899fc2b0a76b 97 &HIDControlPointCharacteristic,
cho45 54:899fc2b0a76b 98 NULL,
cho45 54:899fc2b0a76b 99 NULL,
cho45 54:899fc2b0a76b 100 NULL,
cho45 54:899fc2b0a76b 101 NULL,
cho45 54:899fc2b0a76b 102 NULL
cho45 54:899fc2b0a76b 103 };
cho45 54:899fc2b0a76b 104
cho45 54:899fc2b0a76b 105 unsigned int charIndex = 4;
cho45 54:899fc2b0a76b 106 /*
cho45 54:899fc2b0a76b 107 * Report characteristics are optional, and depend on the reportMap descriptor
cho45 54:899fc2b0a76b 108 * Note: at least one should be present, but we don't check that at the moment.
cho45 54:899fc2b0a76b 109 */
cho45 54:899fc2b0a76b 110 if (inputReportLength)
cho45 54:899fc2b0a76b 111 characteristics[charIndex++] = &inputReportCharacteristic;
cho45 54:899fc2b0a76b 112 if (outputReportLength)
cho45 54:899fc2b0a76b 113 characteristics[charIndex++] = &outputReportCharacteristic;
cho45 54:899fc2b0a76b 114 if (featureReportLength)
cho45 54:899fc2b0a76b 115 characteristics[charIndex++] = &featureReportCharacteristic;
cho45 54:899fc2b0a76b 116
cho45 54:899fc2b0a76b 117 /* TODO: let children add some more characteristics, namely boot keyboard and mouse (They are
cho45 54:899fc2b0a76b 118 * mandatory as per HIDS spec.) Ex:
cho45 54:899fc2b0a76b 119 *
cho45 54:899fc2b0a76b 120 * addExtraCharacteristics(characteristics, int& charIndex);
cho45 54:899fc2b0a76b 121 */
cho45 54:899fc2b0a76b 122
cho45 54:899fc2b0a76b 123 GattService service(GattService::UUID_HUMAN_INTERFACE_DEVICE_SERVICE,
cho45 54:899fc2b0a76b 124 characteristics, charIndex);
cho45 54:899fc2b0a76b 125
cho45 54:899fc2b0a76b 126 ble.gattServer().addService(service);
cho45 54:899fc2b0a76b 127
cho45 54:899fc2b0a76b 128 ble.gap().onConnection(this, &HIDServiceBase::onConnection);
cho45 54:899fc2b0a76b 129 ble.gap().onDisconnection(this, &HIDServiceBase::onDisconnection);
cho45 54:899fc2b0a76b 130
cho45 54:899fc2b0a76b 131 ble.gattServer().onDataSent(this, &HIDServiceBase::onDataSent);
cho45 54:899fc2b0a76b 132
cho45 54:899fc2b0a76b 133 /*
cho45 54:899fc2b0a76b 134 * Change preferred connection params, in order to optimize the notification frequency. Most
cho45 54:899fc2b0a76b 135 * OSes seem to respect this, even though they are not required to.
cho45 54:899fc2b0a76b 136 *
cho45 54:899fc2b0a76b 137 * Some OSes don't handle reconnection well, at the moment, so we set the maximum possible
cho45 54:899fc2b0a76b 138 * timeout, 32 seconds
cho45 54:899fc2b0a76b 139 */
cho45 54:899fc2b0a76b 140 uint16_t minInterval = Gap::MSEC_TO_GAP_DURATION_UNITS(reportTickerDelay / 2);
cho45 54:899fc2b0a76b 141 if (minInterval < 6)
cho45 54:899fc2b0a76b 142 minInterval = 6;
cho45 54:899fc2b0a76b 143 uint16_t maxInterval = minInterval * 2;
cho45 54:899fc2b0a76b 144 Gap::ConnectionParams_t params = {minInterval, maxInterval, 0, 3200};
cho45 54:899fc2b0a76b 145
cho45 54:899fc2b0a76b 146 ble.gap().setPreferredConnectionParams(&params);
cho45 54:899fc2b0a76b 147
cho45 54:899fc2b0a76b 148 SecurityManager::SecurityMode_t securityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM;
cho45 54:899fc2b0a76b 149 protocolModeCharacteristic.requireSecurity(securityMode);
cho45 54:899fc2b0a76b 150 reportMapCharacteristic.requireSecurity(securityMode);
cho45 54:899fc2b0a76b 151 inputReportCharacteristic.requireSecurity(securityMode);
cho45 54:899fc2b0a76b 152 outputReportCharacteristic.requireSecurity(securityMode);
cho45 54:899fc2b0a76b 153 featureReportCharacteristic.requireSecurity(securityMode);
cho45 54:899fc2b0a76b 154 }
cho45 54:899fc2b0a76b 155
cho45 54:899fc2b0a76b 156 void HIDServiceBase::startReportTicker(void) {
cho45 54:899fc2b0a76b 157 if (reportTickerIsActive)
cho45 54:899fc2b0a76b 158 return;
cho45 54:899fc2b0a76b 159 reportTicker.attach_us(this, &HIDServiceBase::sendCallback, reportTickerDelay * 1000);
cho45 54:899fc2b0a76b 160 reportTickerIsActive = true;
cho45 54:899fc2b0a76b 161 }
cho45 54:899fc2b0a76b 162
cho45 54:899fc2b0a76b 163 void HIDServiceBase::stopReportTicker(void) {
cho45 54:899fc2b0a76b 164 reportTicker.detach();
cho45 54:899fc2b0a76b 165 reportTickerIsActive = false;
cho45 54:899fc2b0a76b 166 }
cho45 54:899fc2b0a76b 167
cho45 54:899fc2b0a76b 168 void HIDServiceBase::onDataSent(unsigned count) {
cho45 54:899fc2b0a76b 169 startReportTicker();
cho45 54:899fc2b0a76b 170 }
cho45 54:899fc2b0a76b 171
cho45 66:a7c6fbe45cf5 172 GattAttribute** HIDServiceBase::inputReportDescriptors() {
cho45 66:a7c6fbe45cf5 173 inputReportReferenceData.ID = 0;
cho45 66:a7c6fbe45cf5 174 inputReportReferenceData.type = INPUT_REPORT;
cho45 66:a7c6fbe45cf5 175
cho45 66:a7c6fbe45cf5 176 static GattAttribute * descs[] = {
cho45 66:a7c6fbe45cf5 177 &inputReportReferenceDescriptor,
cho45 66:a7c6fbe45cf5 178 };
cho45 66:a7c6fbe45cf5 179 return descs;
cho45 66:a7c6fbe45cf5 180 }
cho45 66:a7c6fbe45cf5 181
cho45 66:a7c6fbe45cf5 182 GattAttribute** HIDServiceBase::outputReportDescriptors() {
cho45 66:a7c6fbe45cf5 183 outputReportReferenceData.ID = 0;
cho45 66:a7c6fbe45cf5 184 outputReportReferenceData.type = OUTPUT_REPORT;
cho45 66:a7c6fbe45cf5 185
cho45 66:a7c6fbe45cf5 186 static GattAttribute * descs[] = {
cho45 66:a7c6fbe45cf5 187 &outputReportReferenceDescriptor,
cho45 66:a7c6fbe45cf5 188 };
cho45 66:a7c6fbe45cf5 189 return descs;
cho45 66:a7c6fbe45cf5 190 }
cho45 66:a7c6fbe45cf5 191
cho45 66:a7c6fbe45cf5 192 GattAttribute** HIDServiceBase::featureReportDescriptors() {
cho45 66:a7c6fbe45cf5 193 featureReportReferenceData.ID = 0;
cho45 66:a7c6fbe45cf5 194 featureReportReferenceData.type = FEATURE_REPORT;
cho45 66:a7c6fbe45cf5 195
cho45 66:a7c6fbe45cf5 196 static GattAttribute * descs[] = {
cho45 66:a7c6fbe45cf5 197 &featureReportReferenceDescriptor,
cho45 66:a7c6fbe45cf5 198 };
cho45 66:a7c6fbe45cf5 199 return descs;
cho45 66:a7c6fbe45cf5 200 }
cho45 66:a7c6fbe45cf5 201
cho45 66:a7c6fbe45cf5 202 HID_information_t* HIDServiceBase::HIDInformation() {
cho45 66:a7c6fbe45cf5 203 static HID_information_t info = {HID_VERSION_1_11, 0x00, 0x03};
cho45 66:a7c6fbe45cf5 204
cho45 66:a7c6fbe45cf5 205 return &info;
cho45 66:a7c6fbe45cf5 206 }
cho45 54:899fc2b0a76b 207
cho45 54:899fc2b0a76b 208 ble_error_t HIDServiceBase::send(const report_t report) {
cho45 54:899fc2b0a76b 209 return ble.gattServer().write(inputReportCharacteristic.getValueHandle(),
cho45 54:899fc2b0a76b 210 report,
cho45 54:899fc2b0a76b 211 inputReportLength);
cho45 54:899fc2b0a76b 212 }
cho45 54:899fc2b0a76b 213
cho45 54:899fc2b0a76b 214 ble_error_t HIDServiceBase::read(report_t report) {
cho45 54:899fc2b0a76b 215 // TODO. For the time being, we'll just have HID input reports...
cho45 54:899fc2b0a76b 216 return BLE_ERROR_NOT_IMPLEMENTED;
cho45 54:899fc2b0a76b 217 }
cho45 54:899fc2b0a76b 218
cho45 54:899fc2b0a76b 219 void HIDServiceBase::onConnection(const Gap::ConnectionCallbackParams_t *params)
cho45 54:899fc2b0a76b 220 {
cho45 54:899fc2b0a76b 221 this->connected = true;
cho45 54:899fc2b0a76b 222 }
cho45 54:899fc2b0a76b 223
cho45 54:899fc2b0a76b 224 void HIDServiceBase::onDisconnection(const Gap::DisconnectionCallbackParams_t *params)
cho45 54:899fc2b0a76b 225 {
cho45 54:899fc2b0a76b 226 this->connected = false;
cho45 66:a7c6fbe45cf5 227 }