Hiroh Satoh / keyboard Featured

ble nano hid over gatt

Dependencies:   BLE_API mbed-dev nRF51822

HIDServiceBase.cpp@75:351d7ffe81d1, 2016-09-02 (annotated)

Committer:
cho45
Date:
Fri Sep 02 21:16:15 2016 +0900
Revision:
75:351d7ffe81d1
Parent:
66:a7c6fbe45cf5
Child:
79:0095bfb18c57
update

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