nrf51822/source/nRF5xGattServer.h

105 lines
3.9 KiB
C
Raw Normal View History

2014-07-30 10:36:32 +00:00
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __NRF51822_GATT_SERVER_H__
#define __NRF51822_GATT_SERVER_H__
#include <stddef.h>
#include "ble/blecommon.h"
2014-07-30 10:36:32 +00:00
#include "ble.h" /* nordic ble */
#include "ble/Gap.h"
#include "ble/GattServer.h"
2014-07-30 10:36:32 +00:00
class nRF5xGattServer : public GattServer
2014-07-30 10:36:32 +00:00
{
public:
/* Functions that must be implemented from GattServer */
virtual ble_error_t addService(GattService &);
virtual ble_error_t read(GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP);
virtual ble_error_t read(Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP);
virtual ble_error_t write(GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false);
virtual ble_error_t write(Gap::Handle_t connectionHandle, GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false);
virtual ble_error_t notify(GattAttribute::Handle_t, const uint8_t[], uint16_t);
virtual ble_error_t areUpdatesEnabled(const GattCharacteristic &characteristic, bool *enabledP);
virtual ble_error_t areUpdatesEnabled(Gap::Handle_t connectionHandle, const GattCharacteristic &characteristic, bool *enabledP);
virtual ble_error_t reset(void);
2014-07-30 10:36:32 +00:00
/* nRF51 Functions */
void eventCallback(void);
void hwCallback(ble_evt_t *p_ble_evt);
Improve shutdown to clear BLE API and not just SD Improve the shutdown functionality, such that a call to ble.shutdown() from the user application clears the API and nRF5x state and NOT only the SoftDevice. To achieve this the following changes are introduced: * Add a protected member cleanup() to nRF5xGap, nRF5xGattClient, nRF5xGattServer, nRF5xSecurityManager and nRF5xServiceDiscovery. * Modify the shutdown() implementation in nRF5xn such that it also calls the static member shutdown() exposed by the BLE API in Gap.h, SecurityManager.h, GattClient.h and GattServer.h. * Modify nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager classes so that they dynamically create their respective objects only if needed. Previously the GattClient, GattServer and SecurityManager objects were declared as static, which means that they were always present even though they were not always needed. This increases memory consumption unnecessarily. Furthermore, pointers to the object instances are stored in static members of the classes as specified by the BLE API base classes. This ensures that calls to shutdown do not require calls to getInstance() functions that would otherwise result in undesired memory allocations. * nRF5xGap object is always needed, so this remains allocated statically. But the reference in Gap is pointed to this object. The shutdown procedure is as follows: 1. The user calls ble.shutdown() which executes the code in nRF5xn::shutdown() 1. The SoftDevice is shutdown 1. The static members of Gap.h, SecurityManager.h, GattClient.h and GattServer.h are called to clean up their own state. If at any point an error occur during the last step, BLE_ERROR_INVALID_STATE is returned.
2015-12-11 17:37:58 +00:00
2014-07-30 10:36:32 +00:00
private:
const static unsigned BLE_TOTAL_CHARACTERISTICS = 30;
const static unsigned BLE_TOTAL_DESCRIPTORS = 20;
private:
/**
* resolve a value attribute to its owning characteristic.
* @param valueHandle the value handle to be resolved.
* @return characteristic index if a resolution is found, else -1.
*/
2015-07-02 06:59:44 +00:00
int resolveValueHandleToCharIndex(GattAttribute::Handle_t valueHandle) const {
unsigned charIndex;
for (charIndex = 0; charIndex < characteristicCount; charIndex++) {
if (nrfCharacteristicHandles[charIndex].value_handle == valueHandle) {
return charIndex;
}
}
return -1;
}
/**
* resolve a CCCD attribute handle to its owning characteristic.
* @param cccdHandle the CCCD handle to be resolved.
* @return characteristic index if a resolution is found, else -1.
*/
2015-07-02 06:59:44 +00:00
int resolveCCCDHandleToCharIndex(GattAttribute::Handle_t cccdHandle) const {
unsigned charIndex;
for (charIndex = 0; charIndex < characteristicCount; charIndex++) {
if (nrfCharacteristicHandles[charIndex].cccd_handle == cccdHandle) {
return charIndex;
}
}
return -1;
}
private:
2014-11-18 10:09:48 +00:00
GattCharacteristic *p_characteristics[BLE_TOTAL_CHARACTERISTICS];
ble_gatts_char_handles_t nrfCharacteristicHandles[BLE_TOTAL_CHARACTERISTICS];
GattAttribute *p_descriptors[BLE_TOTAL_DESCRIPTORS];
uint8_t descriptorCount;
uint16_t nrfDescriptorHandles[BLE_TOTAL_DESCRIPTORS];
2014-07-30 10:36:32 +00:00
/*
* Allow instantiation from nRF5xn when required.
*/
friend class nRF5xn;
nRF5xGattServer() : GattServer(), p_characteristics(), nrfCharacteristicHandles(), p_descriptors(), descriptorCount(0), nrfDescriptorHandles() {
/* empty */
}
private:
nRF5xGattServer(const nRF5xGattServer &);
const nRF5xGattServer& operator=(const nRF5xGattServer &);
2014-07-30 10:36:32 +00:00
};
2014-11-18 10:09:48 +00:00
#endif // ifndef __NRF51822_GATT_SERVER_H__